`langchain_community.llms.google_palm`.GooglePalm¶

注意

GooglePalm 实现了标准 Runnable Interface。🏃

该 Runnable Interface 在可运行对象上提供了额外的方法，例如 with_types、with_retry、assign、bind、get_graph 等。

class langchain_community.llms.google_palm.GooglePalm[source]¶

基类: BaseLLM、BaseModel

已弃用：版本 0.0.12 及以后：使用 langchain_google_genai.GoogleGenerativeAI 替代。

已弃用：使用 langchain_google_genai.GoogleGenerativeAI 替代。

Google PaLM 模型。

param cache: Union[BaseCache, bool, None] = None¶

是否缓存响应。

如果是，将使用全局缓存。
如果是，将不使用缓存。
如果是 None，如果全局缓存已设置，则使用全局缓存，否则不使用缓存。
如果为 BaseCache 实例，则使用提供的缓存。

模型流式方法不支持缓存。

param callback_manager: Optional[BaseCallbackManager] = None¶: 【废弃】

param callbacks: Callbacks = None¶: 添加到运行跟踪中的回调函数。

param custom_get_token_ids: Optional[Callable[[str], List[int]]] = None¶: 用于计数令牌的可选编码器。

param google_api_key: Optional[SecretStr] = None¶

约束

类型 = 字符串
写时复制 = True
格式 = 密码

param max_output_tokens: Optional[int] = None¶: 一个候选者中包含的最大令牌数。必须是大于零的数。如果未设置，则默认为64。

param max_retries : int = 6¶: 生成时的最大重试次数。

参数 metadata : Optional[Dict[str, Any]] = None¶: 添加到运行跟踪的元数据。

参数 model_name : str = 'models/text-bison-001'¶: 要使用的数据模型名称。

参数 n : int = 1¶: 对于每个提示生成聊天完成的数量。注意如果产生重复，API可能不会返回完整的n个完成。

参数 tags : Optional[List[str]]>] = None¶: 添加到运行跟踪的标签。

参数 temperature : float = 0.7¶: 以这个温度运行推理。必须在[0.0, 1.0]闭区间内。

参数 top_k : Optional[int] = None¶: 使用top-k采样解码：考虑出现最频繁的top_k个令牌。必须为正数。

参数 top_p : Optional[float] = None¶: 使用核采样解码：考虑概率之和至少为top_p的最小令牌集合。必须在[0.0, 1.0]闭区间内。

param verbose: bool [可选]¶: 是否打印输出文本。

__call__(prompt: str, stop: Optional[List[str]], callbacks: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]], *, tags: Optional[List[str]] = None, metadata: Optional[Dict[str, Any]] = None, **kwargs: Any) → str¶

自langchain-core==0.1.7版本起已弃用: 使用invoke替代。

检查缓存，并在给定的提示和输入上运行LLM。

参数

prompt (str) – 用于生成的提示。
stop (Optional[List[str]]) – 生成时使用的停止词。模型输出在首次出现这些子串之一时截断。
callbacks （可选[联合[列表[BaseCallbackHandler]，BaseCallbackManager]]）– 需要传递的回调。用于在整个生成过程中执行额外的功能，如记录或流式传输。
tags （可选[列表[字符串]]）– 与提示关联的标签列表。
metadata （可选[字典[字符串，任意]]）– 与提示关联的元数据。
**kwargs （任意）– 非任意附加关键字参数。这些通常传递给模型提供者 API 调用。

返回

生成的文本。

引发

ValueError – 如果提示不是字符串。

返回类型

字符串

async abatch(inputs: List[Union[PromptValue, str, Sequence[Union[BaseMessage, List[str], Tuple[str, str], str, Dict[str, Any]]]]], config: Optional[Union[RunnableConfig, List[RunnableConfig]]] = None, *, return_exceptions: bool = False, **kwargs: Any) → List[str]¶

默认实现使用asyncio.gather并行运行ainvoke。

默认批处理实现适用于I/O密集型运行实例。

子类应该覆盖此方法以更有效地批处理；例如，如果底层Runnable使用的API支持批处理模式。

参数

输入 (列表[联合[PromptValue，str，序列[联合[基消息，列表[str]，元组[str，str]，str，字典[str，任何]]]]]) – Runnable 的输入列表。
config (可选[联合[RunnableConfig，列表[RunnableConfig]]]) – 调用 Runnable 时使用的配置。配置支持标准键，如用于跟踪的 'tags' 和 'metadata'，控制并行工作量的 'max_concurrency' 以及其他键。请参阅 RunnableConfig 以获取更多详细信息。默认值为 None。
return_exceptions (bool) – 是否返回异常而不是抛出它们。默认值为 False。
kwargs (任何) – 要传递给 Runnable 的其他关键字参数。

返回

Runnable 的输出列表。

返回类型

str 列表

async abatch_as_completed(inputs: 序列[输入], config: 可选[联合[RunnableConfig, 序列[RunnableConfig]]] = None, *, return_exceptions: bool = False, **kwargs: 可选[任何]) → AsyncIterator[元组[int，联合[输出， Exception]]]¶

在输入列表上并行运行 run，随着结果的完成提供结果。

参数

inputs (序列[输入]) – Runnable 的输入列表。
config (可选[结合[RunnableConfig, Sequence[RunnableConfig]]]) – 在调用Runnable时使用的配置。此配置支持标准键，例如用于追踪的’tags’、‘metadata’，用于控制并行工作的多少的‘max_concurrency’，以及其他键。请参阅RunnableConfig获取更多详细信息。默认为None。默认为None。
return_exceptions (bool) – 是否返回异常而不是抛出它们。默认值为 False。
kwargs (可选[任何]) – 传递给Runnable的额外关键字参数。

生成

一个从Runnable中获取的输入和输出的索引的元组。

返回类型

AsyncIterator[Tuple[int, Union[Output, Exception]]]

async agenerate(prompts: List[str], stop: Optional[List[str]] = None, callbacks: Union[List[BaseCallbackHandler], BaseCallbackManager, None, List[Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]]]] = None, *, tags: Optional[Union[List[str], List[List[str]]]] = None, metadata: Optional[Union[Dict[str, Any], List[Dict[str, Any]]]] = None, run_name: Optional[Union[str, List[str]]] = None, run_id: Optional[Union[UUID, List[Optional[UUID]]]] = None, **kwargs: Any) → LLMResult¶

异步传递一系列提示到一个模型并返回生成内容。

当模型暴露批处理API时，此方法应利用批处理调用。

当您想

利用批处理调用时，
需要比仅输出顶级生成值更多的模型输出时，
构建对底层语言模型类型（例如，纯文本完成模型与聊天模型）不可知的链时。
类型。

参数

prompts (列表[str]) – 字符串提示列表。
stop (Optional[List[str]]) – 生成时使用的停止词。模型输出在首次出现这些子串之一时截断。
callbacks (Union[列表[BaseCallbackHandler], BaseCallbackManager, None, 列表[Optional[Union[列表[BaseCallbackHandler], BaseCallbackManager]]]]) – 通过的回调。用于在整个生成过程中执行额外的功能，例如记录或流。
tags (可选[Union[列表[str], 列表[列表[str]]]]) – 与每个提示关联的标签列表。如果提供，则列表长度必须与提示列表长度匹配。
metadata (可选[Union[Dict[str, Any], 列表[Dict[str, Any]]]]) – 与每个提示关联的元数据字典列表。如果提供，则列表长度必须与提示列表长度匹配。
run_name (可选[Union[str, 列表[str]]]) – 与每个提示关联的运行名称列表。如果提供，则列表长度必须与提示列表长度匹配。
run_id (可选[Union[UUID, 列表[Optional[UUID]]]]) – 与每个提示关联的运行ID列表。如果提供，则列表长度必须与提示列表长度匹配。
**kwargs （任意）– 非任意附加关键字参数。这些通常传递给模型提供者 API 调用。

返回

一个LLMResult，其中包含每个输入提示的候选生成列表和额外的模型提供者特定的输出。

返回类型

LLMResult

async agenerate_prompt(prompts: List[PromptValue], stop: Optional[List[str]] = None, callbacks: Union[List[BaseCallbackHandler], BaseCallbackManager, None, List[Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]]] = None, **kwargs: Any) → LLMResult¶

异步传递一系列提示并返回模型生成结果。

当模型暴露批处理API时，此方法应利用批处理调用。

当您想

利用批处理调用时，
需要比仅输出顶级生成值更多的模型输出时，
构建对底层语言模型类型（例如，纯文本完成模型与聊天模型）不可知的链时。
类型。

参数

prompts (列表[提示值]) – 提示值列表。提示值是一个可以转换成匹配任何语言模型格式的对象（纯文本生成模型为字符串，聊天模型为BaseMessages）。
stop (Optional[List[str]]) – 生成时使用的停止词。模型输出在首次出现这些子串之一时截断。
callbacks (Union[列表[BaseCallbackHandler], BaseCallbackManager, None, 列表[Optional[Union[列表[BaseCallbackHandler], BaseCallbackManager]]]]) – 通过的回调。用于在整个生成过程中执行额外的功能，例如记录或流。
**kwargs （任意）– 非任意附加关键字参数。这些通常传递给模型提供者 API 调用。

返回

一个LLMResult，其中包含每个输入提示的候选生成列表和额外的模型提供者特定的输出。

返回类型

LLMResult

async ainvoke(input: Union[PromptValue, str, Sequence[Union[BaseMessage, List[str], Tuple[str, str], str, Dict[str, Any]]]], Optional[RunnableConfig], *, stop: Optional[List[str]] = None, **kwargs: Any) → str¶

ainvoke 的默认实现，从线程中调用 invoke。

默认实现允许在 Runnable 未实现原生的异步 invoke 版本的情况下使用异步代码。

如果子类可以异步运行，则应重写此方法。

参数

input (Union[PromptValue, str, Sequence[Union[BaseMessage, List[str], Tuple[str, str], str, Dict[str, Any]]]]) –
config (Optional[RunnableConfig]) –
stop (Optional[List[str]]) –
kwargs (Any) –

返回类型

字符串

异步 apredict(text: str, *, stop: Optional[Sequence[str]] = None, **kwargs: Any) → str¶

已废弃，自版本 langchain-core==0.1.7：请使用 ainvoke 替代。

参数

text (str) –
stop (可选[Sequence[str]]) –
kwargs (Any) –

返回类型

字符串

异步 apredict_messages(messages: List[BaseMessage]*, stop: Optional[Sequence[str]] = None, **kwargs: Any) → BaseMessage¶

已废弃，自版本 langchain-core==0.1.7：请使用 ainvoke 替代。

参数

messages (列表[BaseMessage]) –
stop (可选[Sequence[str]]) –
kwargs (Any) –

返回类型

BaseMessage

as_tool(args_schema: Optional[Type[BaseModel]] = None, *, name: Optional[str] = None, description: Optional[str] = None, arg_types: Optional[Dict[str, Type]] = None) → BaseTool¶

测试版

此API目前处于测试版，将来可能会发生变化。

从可运行对象创建BaseTool。

as_tool将从可运行对象中实例化一个名为BaseTool的对象，并提供名称、描述和args_schema。尽可能情况下，模式将从runnable.get_input_schema中推断出来。否则（例如，如果可运行对象接收一个字典作为输入，并且具体的字典键没有指定类型），可以直接使用args_schema来指定模式。您也可以传递arg_types来仅指定所需的参数及其类型。

参数

args_schema（《可选》）（《String》） – 工具的模式。默认值为None。
name（《可选》）（《String》） – 工具的名称。默认值为None。
description（《可选》）（《String》） – 工具的描述。默认值为None。
arg_types（《可选》）（《Dict》） – 参数名称到类型的映射。默认值为None。

返回

BaseTool实例。

返回类型

基工具

类型化字典输入

from typing import List
from typing_extensions import TypedDict
from langchain_core.runnables import RunnableLambda

class Args(TypedDict):
    a: int
    b: List[int]

def f(x: Args) -> str:
    return str(x["a"] * max(x["b"]))

runnable = RunnableLambda(f)
as_tool = runnable.as_tool()
as_tool.invoke({"a": 3, "b": [1, 2]})

使用args_schema指定模式的字典输入

from typing import Any, Dict, List
from langchain_core.pydantic_v1 import BaseModel, Field
from langchain_core.runnables import RunnableLambda

def f(x: Dict[str, Any]) -> str:
    return str(x["a"] * max(x["b"]))

class FSchema(BaseModel):
    """Apply a function to an integer and list of integers."""

    a: int = Field(..., description="Integer")
    b: List[int] = Field(..., description="List of ints")

runnable = RunnableLambda(f)
as_tool = runnable.as_tool(FSchema)
as_tool.invoke({"a": 3, "b": [1, 2]})

使用arg_types指定模式的字典输入

from typing import Any, Dict, List
from langchain_core.runnables import RunnableLambda

def f(x: Dict[str, Any]) -> str:
    return str(x["a"] * max(x["b"]))

runnable = RunnableLambda(f)
as_tool = runnable.as_tool(arg_types={"a": int, "b": List[int]})
as_tool.invoke({"a": 3, "b": [1, 2]})

字符串输入

from langchain_core.runnables import RunnableLambda

def f(x: str) -> str:
    return x + "a"

def g(x: str) -> str:
    return x + "z"

runnable = RunnableLambda(f) | g
as_tool = runnable.as_tool()
as_tool.invoke("b")

版本0.2.14中新引入。

async astream(input: Union[PromptValue, str, Sequence[Union[BaseMessage, List[str], Tuple[str, str], str, Dict[str, Any]]]]], config: Optional[RunnableConfig] = None, *, stop: Optional[List[str]] = None, **kwargs: Any) → AsyncIterator[str]¶

astream 的默认实现，调用 ainvoke。如果子类支持流式输出，则应重写此方法。

参数

input (Union[PromptValue, str, Sequence[Union[BaseMessage, List[str], Tuple[str, str], str, Dict[str, Any]]]]) – Runnable 的输入。
config (Optional[RunnableConfig]) – 要为 Runnable 使用配置。默认为 None。
kwargs (任何) – 要传递给 Runnable 的其他关键字参数。
stop (Optional[List[str]]) –

生成

Runnable 的输出。

返回类型

AsyncIterator[str]

astream_events(input: Any, config: Optional[RunnableConfig] = None, *, version: Literal['v1', 'v2'], include_names: Optional[Sequence[str]] = None, include_types: Optional[Sequence[str]] = None, include_tags: Optional[Sequence[str]] = None, exclude_names: Optional[Sequence[str]] = None, exclude_types: Optional[Sequence[str]] = None, exclude_tags: Optional[Sequence[str]] = None, **kwargs: Any) → AsyncIterator[Union[StandardStreamEvent, CustomStreamEvent]]¶

测试版

此API目前处于测试版，将来可能会发生变化。

生成事件流。

用于创建一个迭代器，该迭代器遍历 StreamEvents，它提供了有关 Runnable 进展的实时信息，包括来自中间结果的 StreamEvents。

StreamEvent 是一个具有以下模式的字典

event: str - 事件名称是
格式：on_[runnable_type]_(启动|stream|结束)。
name： str - 生成事件的 Runnable 的名称。
run_id： str - 与给定执行相关的随机生成的 ID。事件发出的 Runnable 有自己的唯一 ID，当某个 Runnable 被作为父 Runnable 执行的一部分被调用时，会分配一个自己的唯一 ID。
。
parent_ids： 列表[str] - 生成事件的父 Runnable 的 ID。根 Runnable 会有一个空列表。父 ID 的顺序是从根到直接父级。仅适用于 v2 版本的 API。v1 版本的 API 将返回一个空列表。
。
tags： Optional[List[str]] - 生成事件的 Runnable 的标记。
。
metadata： Optional[Dict[str, Any]] - 生成事件的 Runnable 的元数据。
。
data： Dict[str, Any]

以下是可能会由各种链条发出的某些事件的表格。为了简洁，省略了元数据字段。表格下面包括链定义。

注意此参考表适用于架构的 V2 版本。

事件	name	chunk	input	output
on_chat_model_start	[模型名称]		{“messages”: [[系统消息，人工消息]]}
on_chat_model_stream	[模型名称]	AIMessageChunk(content="hello")
on_chat_model_end	[模型名称]		{“messages”: [[系统消息，人工消息]]}	AIMessageChunk(content="hello world")
on_llm_start	[模型名称]		{‘input’: ‘hello’}
on_llm_stream	[模型名称]	‘Hello’
on_llm_end	[模型名称]		‘Hello human!’
on_chain_start	format_docs
on_chain_stream	format_docs	“hello world!, goodbye world!”
on_chain_end	format_docs		[Document(…)]	“hello world!, goodbye world!”
on_tool_start	some_tool		{“x”: 1, “y”: “2”}
on_tool_end	some_tool			{“x”: 1, “y”: “2”}
on_retriever_start	[检索器名称]		{“query”: “hello”}
on_retriever_end	[检索器名称]		{“query”: “hello”}	[Document(…), ..]
on_prompt_start	[模板名称]		{“question”: “hello”}
on_prompt_end	[模板名称]		{“question”: “hello”}	ChatPromptValue(messages: [SystemMessage, …])

除了标准事件外，用户还可以分派自定义事件（见下面的示例）。

自定义事件仅在 v2 版本的 API 中出现！

自定义事件的格式如下：

属性	类型	描述
name	字符串	事件的自定义名称。
data	Any	与事件关联的数据。这可能可以是任何东西，尽管我们建议使其可 JSON 序列化。

以下是与上述标准事件相关的声明

format_docs:

def format_docs(docs: List[Document]) -> str:
    '''Format the docs.'''
    return ", ".join([doc.page_content for doc in docs])

format_docs = RunnableLambda(format_docs)

some_tool:

@tool
def some_tool(x: int, y: str) -> dict:
    '''Some_tool.'''
    return {"x": x, "y": y}

提示:

template = ChatPromptTemplate.from_messages(
    [("system", "You are Cat Agent 007"), ("human", "{question}")]
).with_config({"run_name": "my_template", "tags": ["my_template"]})

示例

from langchain_core.runnables import RunnableLambda

async def reverse(s: str) -> str:
    return s[::-1]

chain = RunnableLambda(func=reverse)

events = [
    event async for event in chain.astream_events("hello", version="v2")
]

# will produce the following events (run_id, and parent_ids
# has been omitted for brevity):
[
    {
        "data": {"input": "hello"},
        "event": "on_chain_start",
        "metadata": {},
        "name": "reverse",
        "tags": [],
    },
    {
        "data": {"chunk": "olleh"},
        "event": "on_chain_stream",
        "metadata": {},
        "name": "reverse",
        "tags": [],
    },
    {
        "data": {"output": "olleh"},
        "event": "on_chain_end",
        "metadata": {},
        "name": "reverse",
        "tags": [],
    },
]

示例：分派自定义事件

from langchain_core.callbacks.manager import (
    adispatch_custom_event,
)
from langchain_core.runnables import RunnableLambda, RunnableConfig
import asyncio


async def slow_thing(some_input: str, config: RunnableConfig) -> str:
    """Do something that takes a long time."""
    await asyncio.sleep(1) # Placeholder for some slow operation
    await adispatch_custom_event(
        "progress_event",
        {"message": "Finished step 1 of 3"},
        config=config # Must be included for python < 3.10
    )
    await asyncio.sleep(1) # Placeholder for some slow operation
    await adispatch_custom_event(
        "progress_event",
        {"message": "Finished step 2 of 3"},
        config=config # Must be included for python < 3.10
    )
    await asyncio.sleep(1) # Placeholder for some slow operation
    return "Done"

slow_thing = RunnableLambda(slow_thing)

async for event in slow_thing.astream_events("some_input", version="v2"):
    print(event)

参数

input （Any） - Runnable 的输入。
config （Optional[RunnableConfig]） - 要用于 Runnable 的配置。
version （Literal['v1', 'v2']） - 要使用的架构版本，无论是 v2 还是 v1。用户应使用 v2。 v1 用于向后兼容性，将在 0.4.0 中弃用。在 API 稳定之前不会分配默认值。自定义事件仅在 v2 中出现。
include_names （Optional[Sequence[str]]） - 仅包括具有匹配名称的 runnables 的事件。
include_types （Optional[Sequence[str]]） - 仅包括具有匹配类型的 runnables 的事件。
include_tags (可选[序列[字符串]]) – 只包含具有匹配标签的可执行程序的事件。
exclude_names (可选[序列[字符串]]) – 排除具有匹配名称的可执行程序的事件。
exclude_types (可选[序列[字符串]]) – 排除具有匹配类型的事件。
exclude_tags (可选[序列[字符串]]) – 排除具有匹配标签的事件。
kwargs (任意) – 传递给Runnable的额外关键字参数。这些将传递给astream_log，因为astream_events的实现基于astream_log。

生成

一个异步的流式事件流。

引发

NotImplementedError – 如果版本不是v1或v2。

返回类型

AsyncIterator[Union[StandardStreamEvent, CustomStreamEvent]]

batch(inputs: List[Union[PromptValue, str, Sequence[Union[BaseMessage, List[str], Tuple[str, str], str, Dict[str, Any]]]]]], config: Optional[Union[RunnableConfig, List[RunnableConfig]]] = None, *, return_exceptions: bool = False, **kwargs: Any) → List[str]¶

默认实现使用线程池执行器并行运行 invoke。

默认批处理实现适用于I/O密集型运行实例。

子类应该覆盖此方法以更有效地批处理；例如，如果底层Runnable使用的API支持批处理模式。

参数

inputs (列表[Union[PromptValue, str, 序列[Union[BaseMessage, 列表[str], 元组[str, str], str, 包含str和的字典]]]]) –
config (可选[Union[RunnableConfig, 列表[RunnableConfig]]]) –
return_exceptions (布尔值) –
kwargs (Any) –

返回类型

str 列表

batch_as_completed(inputs: Sequence[Input], config: Optional[Union[RunnableConfig, Sequence[RunnableConfig]]] = None, *, return_exceptions: bool = False, **kwargs: Optional[Any]) → Iterator[Tuple[int, Union[Output, Exception]]]¶

在输入列表上并行运行调用，按完成顺序产生结果。

参数

inputs (Sequence[Input]) –
config (Optional[Union[RunnableConfig, Sequence[RunnableConfig]]]) –
return_exceptions (布尔值) –
kwargs (Optional[Any]) –

返回类型

Iterator[Tuple[int, Union[Output, Exception]]]

configurable_alternatives(which: ConfigurableField, *, default_key: str = 'default', prefix_keys: bool = False, **kwargs: Union[Runnable[Input, Output], Callable[[], Runnable[Input, Output]]) → RunnableSerializable[Input, Output]¶

配置运行时可设置的替代选项。

参数

which (ConfigurableField) – 将用于选择替代方案的 ConfigurableField 实例。
default_key (str) – 如果未选择替代选项时使用的默认键。默认为“default”。
prefix_keys (bool) – 是否将键前缀与 ConfigurableField id 相关联。默认为 False。
**kwargs (Union[Runnable[Input, Output], Callable[[], Runnable[Input, Output]]]) – 键到可运行实例或返回可运行实例的可调用对象的字典。

返回

配置了替代方案的新的可运行对象。

返回类型

RunnableSerializable[Input, Output]

from langchain_anthropic import ChatAnthropic
from langchain_core.runnables.utils import ConfigurableField
from langchain_openai import ChatOpenAI

model = ChatAnthropic(
    model_name="claude-3-sonnet-20240229"
).configurable_alternatives(
    ConfigurableField(id="llm"),
    default_key="anthropic",
    openai=ChatOpenAI()
)

# uses the default model ChatAnthropic
print(model.invoke("which organization created you?").content)

# uses ChatOpenAI
print(
    model.with_config(
        configurable={"llm": "openai"}
    ).invoke("which organization created you?").content
)

configurable_fields(**kwargs: Union[ConfigurableField, ConfigurableFieldSingleOption, ConfigurableFieldMultiOption]) → RunnableSerializable[Input, Output]¶

运行时配置特定的可运行字段。

参数: **kwargs (Union[ConfigurableField, ConfigurableFieldSingleOption, ConfigurableFieldMultiOption]) – 要配置的可配置字段实例的字典。
返回: 配置字段后的新可运行对象。
返回类型: RunnableSerializable[Input, Output]

from langchain_core.runnables import ConfigurableField
from langchain_openai import ChatOpenAI

model = ChatOpenAI(max_tokens=20).configurable_fields(
    max_tokens=ConfigurableField(
        id="output_token_number",
        name="Max tokens in the output",
        description="The maximum number of tokens in the output",
    )
)

# max_tokens = 20
print(
    "max_tokens_20: ",
    model.invoke("tell me something about chess").content
)

# max_tokens = 200
print("max_tokens_200: ", model.with_config(
    configurable={"output_token_number": 200}
    ).invoke("tell me something about chess").content
)

generate(prompts: List[str], stop: Optional[List[str]] = None, callbacks: Union[List[BaseCallbackHandler], BaseCallbackManager, None, List[Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]]]] = None, *, tags: Optional[Union[List[str], List[List[str]]]] = None, metadata: Optional[Union[Dict[str, Any], List[Dict[str, Any]]]] = None, run_name: Optional[Union[str, List[str]]] = None, run_id: Optional[Union[UUID, List[Optional[UUID]]]] = None, **kwargs: Any) → LLMResult¶

将一系列提示传递给模型并返回生成内容。

当模型暴露批处理API时，此方法应利用批处理调用。

当您想

利用批处理调用时，
需要比仅输出顶级生成值更多的模型输出时，
构建对底层语言模型类型（例如，纯文本完成模型与聊天模型）不可知的链时。
类型。

参数

prompts (列表[str]) – 字符串提示列表。
stop (Optional[List[str]]) – 生成时使用的停止词。模型输出在首次出现这些子串之一时截断。
callbacks (Union[列表[BaseCallbackHandler], BaseCallbackManager, None, 列表[Optional[Union[列表[BaseCallbackHandler], BaseCallbackManager]]]]) – 通过的回调。用于在整个生成过程中执行额外的功能，例如记录或流。
tags (可选[Union[列表[str], 列表[列表[str]]]]) – 与每个提示关联的标签列表。如果提供，则列表长度必须与提示列表长度匹配。
metadata (可选[Union[Dict[str, Any], 列表[Dict[str, Any]]]]) – 与每个提示关联的元数据字典列表。如果提供，则列表长度必须与提示列表长度匹配。
run_name (可选[Union[str, 列表[str]]]) – 与每个提示关联的运行名称列表。如果提供，则列表长度必须与提示列表长度匹配。
run_id (可选[Union[UUID, 列表[Optional[UUID]]]]) – 与每个提示关联的运行ID列表。如果提供，则列表长度必须与提示列表长度匹配。
**kwargs （任意）– 非任意附加关键字参数。这些通常传递给模型提供者 API 调用。

返回

一个LLMResult，其中包含每个输入提示的候选生成列表和额外的模型提供者特定的输出。

返回类型

LLMResult

generate_prompt(prompts: List[PromptValue], stop: Optional[List[str]] = None, callbacks: Union[List[BaseCallbackHandler], BaseCallbackManager, None, List[Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]]]] = None, **kwargs: Any) → LLMResult¶

将一系列提示传递给模型并返回模型生成内容。

当模型暴露批处理API时，此方法应利用批处理调用。

当您想

利用批处理调用时，
需要比仅输出顶级生成值更多的模型输出时，
构建对底层语言模型类型（例如，纯文本完成模型与聊天模型）不可知的链时。
类型。

参数

prompts (列表[提示值]) – 提示值列表。提示值是一个可以转换成匹配任何语言模型格式的对象（纯文本生成模型为字符串，聊天模型为BaseMessages）。
stop (Optional[List[str]]) – 生成时使用的停止词。模型输出在首次出现这些子串之一时截断。
callbacks (Union[列表[BaseCallbackHandler], BaseCallbackManager, None, 列表[Optional[Union[列表[BaseCallbackHandler], BaseCallbackManager]]]]) – 通过的回调。用于在整个生成过程中执行额外的功能，例如记录或流。
**kwargs （任意）– 非任意附加关键字参数。这些通常传递给模型提供者 API 调用。

返回

一个LLMResult，其中包含每个输入提示的候选生成列表和额外的模型提供者特定的输出。

返回类型

LLMResult

get_num_tokens(text: str) → int[source]¶

获取文本中存在的令牌数量。

用于检查输入是否适合模型的上下文窗口。

参数: text (str) – 要分词的字符串输入。
返回: 文本中的令牌整数数量。
返回类型: int

get_num_tokens_from_messages(messages: List[BaseMessage]) → int¶

获取消息中的标记数量。

用于检查输入是否适合模型的上下文窗口。

参数: messages (列表[BaseMessage]) – 要分词的消息输入。
返回: 所有消息中标记数量的总和。
返回类型: int

get_token_ids(text: str) → List[int]¶

返回文本中标记的有序 IDs。

参数

text (str) – 要分词的字符串输入。

返回

按文本中出现的顺序排列的对应于文本中标记的 ID 列表。: 文本中出现的顺序。

返回类型

整数列表

调用(input: 联合[PromptValue, str, Sequence[联合[BaseMessage, List[str], Tuple[str, str], str, Dict[str, Any]]], str, List[str], Tuple[str, str], str, Dict[str, Any]]], config: 可选[RunnableConfig] = None, *, stop: 可选[List[str]] = None, **kwargs: Any) → str¶

将单个输入转换为输出。重写以实现。

参数

input (Union[PromptValue, str, Sequence[Union[BaseMessage, List[str], Tuple[str, str], str, Dict[str, Any]]]]) – Runnable 的输入。
config (可选[RunnableConfig]) – 调用可执行项时要使用的配置。此配置支持用于追踪的标准键如’tags’、‘metadata’，用于控制并行工作的数量的‘max_concurrency’以及其他键。请参阅RunnableConfig获取更多详细信息。
stop (Optional[List[str]]) –
kwargs (Any) –

返回

Runnable 的输出。

返回类型

字符串

predict(text: str, *, stop: Optional[Sequence[str]] = None, **kwargs: Any) → str¶

自langchain-core==0.1.7版本起已弃用: 使用invoke替代。

参数

text (str) –
stop (可选[Sequence[str]]) –
kwargs (Any) –

返回类型

字符串

predict_messages(messages: List[BaseMessage], *, stop: Optional[Sequence[str]] = None, **kwargs: Any) → BaseMessage¶

自langchain-core==0.1.7版本起已弃用: 使用invoke替代。

参数

messages (列表[BaseMessage]) –
stop (可选[Sequence[str]]) –
kwargs (Any) –

返回类型

BaseMessage

save(file_path: Union[Path, str]) → None¶

保存LLM。

参数: file_path (Union[Path, str]) – 保存LLM的文件路径。
引发: ValueError – 如果文件路径不是字符串或Path对象。
返回类型: None

示例：.. code-block:: python

llm.save(file_path="path/llm.yaml")

stream(input: Union[PromptValue, str, Sequence[Union[BaseMessage, List[str], Tuple[str, str], str, Dict[str, Any]]]], config: Optional[RunnableConfig] = None, *, stop: Optional[List[str]] = None, **kwargs: Any) → Iterator[str]¶

stream 的默认实现，它会调用 invoke。子类应覆盖此方法以支持流式输出。

参数

input (Union[PromptValue, str, Sequence[Union[BaseMessage, List[str], Tuple[str, str], str, Dict[str, Any]]]]) – Runnable 的输入。
config (Optional[RunnableConfig]) – 要为 Runnable 使用配置。默认为 None。
kwargs (任何) – 要传递给 Runnable 的其他关键字参数。
stop (Optional[List[str]]) –

生成

Runnable 的输出。

返回类型

Iterator[str]

to_json() → Union[SerializedConstructor, SerializedNotImplemented]¶

将 Runnable 序列化为 JSON。

返回: Runnable 的 JSON 序列化表示。
返回类型: Union[SerializedConstructor, SerializedNotImplemented]

with_structured_output(schema: Union[Dict, Type[BaseModel]], **kwargs: Any) → Runnable[Union[PromptValue, str, Sequence[Union[BaseMessage, List[str], Tuple[str, str], str, Dict[str, Any]]], Union[Dict, BaseModel]]¶

此类未实现。

参数

schema (Union[Dict, Type[BaseModel]]) –
kwargs (Any) –

返回类型

Runnable[Union[PromptValue, str, Sequence[Union[BaseMessage, List[str], Tuple[str, str], str, Dict[str, Any]]]], Union[Dict, BaseModel]]

属性 is_gemini: bool¶: 返回一个模型是否属于 Gemini 系列。

langchain_community.llms.google_palm.GooglePalm¶

`langchain_community.llms.google_palm`.GooglePalm¶