注意

GemmaVertexAIModelGarden 实现了标准的

class langchain_google_vertexai.gemma.GemmaVertexAIModelGarden

基类:

通过解析和验证关键字参数输入的输入数据来创建一个新的模型。

如果无法将输入数据解析为有效模型，则抛出 ValidationError。

param additional_headers

表示模型调用附加头部的键值字典。

参数 allowed_model_args: Optional[List[str]] = ['temperature', 'top_p', 'top_k', 'max_tokens']¶

允许传递给模型的可选参数。

参数 api_endpoint: Optional[str] = None (别名'base_url')

期望的API端点，例如，us-central1-aiplatform.googleapis.com

参数 api_transport: Optional[str] = None

期望的API传输方法，可以是“grpc”或“rest”。如果定义，将使用vertexai.init中的默认参数。

参数 cache: Union[BaseCache, bool, None] = None

是否缓存响应。

• 如果为真，将使用全局缓存。

• 如果为假，将不使用缓存

• 如果为None，如果没有设置全局缓存，则不使用缓存。

• 如果为BaseCache实例，将使用提供的缓存。

模型流式传输方法当前不支持缓存。

参数 callback_manager: Optional[BaseCallbackManager] = None

已弃用

参数 callbacks : Callbacks= None

要添加到运行跟踪的回调。

参数 client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None

一个回调，返回客户端证书字节和私钥字节

参数 credentials: Any = None

默认的自定义证书（google.auth.credentials.Credentials）的用法

参数 custom_get_token_ids: Optional[Callable[[str], List[int]]] = None

用于计数token的可选编码器。

参数 endpoint_id: str [Required]

模型已部署的端点名称。

参数 full_model_name: Optional[str] = None

模型的端点全名。

参数 location: str = 'us-central1'

调用API时的默认位置。

参数 max_retries: int = 6

生成时的最大重试次数。

参数 metadata: 可选[Dict[str, Any]] = None

要将运行的跟踪记录中添加的元数据。

参数 model_name: 可选[str] = None （别名：model）

底层模型名称。

参数 project: 可选[str] = None

在执行 Vertex API 调用时使用的默认 GCP 项目。

参数 prompt_arg: str = 'prompt'

参数 request_parallelism: int = 5

VertexAI 模型请求允许的并行度数量。

参数 result_arg: 可选[str] = 'generated_text'

如果模型输出预期为字符串，将 result_arg 设置为 None。

参数 single_example_per_request: bool = True

LLM 端点目前只服务请求中的第一个示例。

param stop: Optional[List[str]] = None (alias 'stop_sequences')

在生成时使用的可选停用词列表。

param tags: Optional[List[str]] = None

要将标签添加到运行跟踪中。

param verbose: bool [Optional]

是否打印出响应文本。

__call__(prompt: str, stop: Optional[List[str]] = None, callbacks: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]] = None, *, 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 (Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]]) – 要传递的回调。用于在整个生成过程中执行附加功能，例如记录或流式传输。

• tags (Optional[List[str]]) – 与提示关联的标签列表。

• metadata (Optional[Dict[str, Any]]) – 与提示关联的元数据。

• **kwargs (Any) – 任意额外的关键字参数。通常将这些参数传递给模型提供者API调用。

返回

生成的文本。

引发

ValueError - 如果提示不是一个字符串。

返回类型

str

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]]], *, return_exceptions: bool = False, **kwargs: Any) → List[str]

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

默认批处理实现对于I/O密集型运行函数来说表现良好。

子类应覆盖此方法以实现更高效的批量操作；例如，如果底层运行函数使用支持批量模式的API。

参数

• 输入 (列表[有界联合[PromptValue, str, 序列[有界联合[BaseMessage, str[], 元组[str, str], str, 字典[str, 任何]]]]) – Runnable的可运行输入列表。

• 配置 (可选[有界联合[RunnableConfig, 列表[RunnableConfig]]]) – 调用Runnable时使用的配置。配置支持标准的键，如‘tags’、‘metadata’用于跟踪目的，‘max_concurrency’用于控制并行执行的工作量，以及其他键。请参阅RunnableConfig获取更多详细信息。默认为None。

• 返回异常 (布尔值) – 是否返回异常而不是引发它们。默认为False。

• 关键字参数 (任何) – 传递给Runnable的额外关键字参数。

返回

Runnable的输出列表。

返回类型

str[]

异步 abatch_as_completed(inputs: Sequence[Input], config: Optional[Union[RunnableConfig, Sequence[RunnableConfig]]] = None, *, return_exceptions: bool = False, **kwargs: Optional[Any]) → AsyncIterator[Tuple[int, Union[Output, Exception]]]

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

参数

• 输入 (Sequence[Input]) – Runnable的可运行输入列表。

• config （可选 [ 并集 [ RunnableConfig，Sequence [ RunnableConfig ] ] ]）- 在调用Runnable时使用的配置。该配置支持标准键，如‘tags’、‘metadata’用于跟踪目的，‘max_concurrency’用于控制并行执行的工作量，以及其他键。有关更多详细信息，请参阅RunnableConfig。默认为None。默认为None。

• 返回异常 (布尔值) – 是否返回异常而不是引发它们。默认为False。

• kwargs （可选 [ 任何 ]）- 传递给Runnable的附加关键字参数。

产生

Runnable的输入和输出索引的元组。

返回类型

AsyncIterator [ Tuple [int, 并集 [ 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时，应该使用此方法进行批处理调用。

当你想

1. 利用批量调用时，

2. 需要比顶层生成值更多的模型输出时，

3. 正在构建对底层语言模型类型（例如，纯文本完成模型与聊天模型）无感知的链时。

   类型。

参数

• prompts （列表 [ str ]）- 字符提示列表。

• stop (Optional[List[str]]) – 生成时使用的停用词。当模型输出中首次出现任何这些子字符串时，模型输出将被截断。

• callbacks （并集 [ 列表 [ BaseCallbackHandler ]，BaseCallbackManager，None，列表 [ 可选 [ 并集 [ 列表 [ BaseCallbackHandler ]，BaseCallbackManager ] ] ] ] ]）- 要传递的回调。用于在整个生成过程中执行附加功能，如记录或流。

• tags （可选 [ 并集 [ 列表 [ str ]，列表 [ 列表 [ str ] ] ] ] ] ]）- 与每个prompt关联的标签列表。如果提供，列表的长度必须与提示列表的长度匹配。

• metadata （可选 [ 并集 [ 字典 [ str，Any]，列表 [ 字典 [ str，Any] ] ] ] ]）- 与每个prompt关联的元数据字典列表。如果提供，列表的长度必须与提示列表的长度匹配。

• run_name （可选 [ 并集 [ str，列表 [ str ] ] ] ]）- 与每个prompt关联的运行名列表。如果提供，列表的长度必须与提示列表的长度匹配。

• run_id （可选 [ 并集 [ UUID，列表 [ 可选 [ UUID ] ] ] ] ]）- 与每个prompt关联的运行ID列表。如果提供，列表的长度必须与提示列表的长度匹配。

• **kwargs (Any) – 任意额外的关键字参数。通常将这些参数传递给模型提供者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时，应该使用此方法进行批处理调用。

当你想

1. 利用批量调用时，

2. 需要比顶层生成值更多的模型输出时，

3. 正在构建对底层语言模型类型（例如，纯文本完成模型与聊天模型）无感知的链时。

   类型。

参数

• prompts (列表[提示值]) – 提示值列表。提示值是一个对象，可以转换为与任何语言模型的格式相匹配（纯文本生成模型为字符串，聊天模型为BaseMessages）。

• stop (Optional[List[str]]) – 生成时使用的停用词。当模型输出中首次出现任何这些子字符串时，模型输出将被截断。

• callbacks （并集 [ 列表 [ BaseCallbackHandler ]，BaseCallbackManager，None，列表 [ 可选 [ 并集 [ 列表 [ BaseCallbackHandler ]，BaseCallbackManager ] ] ] ] ]）- 要传递的回调。用于在整个生成过程中执行附加功能，如记录或流。

• **kwargs (Any) – 任意额外的关键字参数。通常将这些参数传递给模型提供者API调用。

返回

LLMResult，包含每个提示的候选生成列表以及附加的模型提供者特定的输出

。

返回类型

LLMResult

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

ainvoke 的默认实现，通过线程调用 invoke。

默认实现允许使用异步代码，即使 Runnable 未实现本地的异步 invoke 版本。

子类应覆盖此方法，如果可以异步运行。

参数

• 输入 (Union[PromptValue, str, Sequence[Union[BaseMessage, List[str], Tuple[str, str], str, Dict[str, Any]]]) –

• 配置 (Optional[RunnableConfig]) –

• 停止 (Optional[List[str]]) –

• kwargs (Any) –

返回类型

str

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

自 langchain-core==0.1.7 版本以来已弃用: 请使用 ainvoke。

参数

• text (str) –

• stop (Optional[Sequence[str]]) –

• kwargs (Any) –

返回类型

str

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

自 langchain-core==0.1.7 版本以来已弃用: 请使用 ainvoke。

参数

• messages (List[BaseMessage]) –

• stop (Optional[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 会从可运行对象实例化一个名为 args_schema、描述和 BaseModel 的 BaseTool。尽可能从 runnable.get_input_schema 推断模式。或者，例如，如果可运行对象以字典作为输入且字典的键未指明类型，可以直接使用 args_schema 指定模式。您还可以通过传递 arg_types 来仅指定所需参数及其类型。

参数

• args_schema (可选[(类型[])]) – 工具的模式。默认为 None。

• name (可选[(str)]) – 工具的名称。默认为 None。

• description (可选[(str)]) – 工具的描述。默认为 None。

• arg_types (可选[(Dict[(str,类型])]) – 参数名称到类型的字典。默认为 None。

返回

BaseTool 实例。

返回类型

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]})

dict 输入，通过 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]})

dict 输入，通过 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[UnionBaseMessage, List[str], Tuplestr, str], str, Dict[str, Any]]]]) – 可运行的输入。

• config (OptionalRunnableConfig]) – 用于可运行的配置。默认为 None。

• 关键字参数 (任何) – 传递给Runnable的额外关键字参数。

• 停止 (Optional[List[str]]) –

产生

可运行的输出。

返回类型

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 的迭代器，包括中间结果的 StreamEvents。

StreamEvent 是一个包含以下模式的字典

• event: str - 事件名称为

  格式：on_[运行时类型]_(开始|流|结束)。

• name：str - 触发事件的可运行对象的名称。

• run_id：str - 与给定可运行对象的执行相关的随机生成的ID。如果一个子可运行对象作为父可运行对象执行的一部分被调用，它会分配一个自己的唯一ID。

  。

• parent_ids：列表[str] - 生成事件的父可运行对象的ID。根可运行对象将有空列表。父ID的顺序是从根到直接父级。仅适用于API的v2版本。API的v1版本将返回空列表。

  。

• tags：Optional[List[str]] - 触发事件的可运行对象的标签。

  。

• metadata：Optional[Dict[str, Any]] - 触发事件的可运行对象的元数据。

  。

• data：Dict[str, Any]

下表显示了各种链可能发出的某些事件，为了简洁起见，省略了元数据字段。链的定义在表格之后。

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

事件	name	chunk	input	output
on_chat_model_start	[模型名称]		{“messages”: [[SystemMessage, HumanMessage]]}
on_chat_model_stream	[模型名称]	AIMessageChunk(content=“hello”)
on_chat_model_end	[模型名称]		{“messages”: [[SystemMessage, HumanMessage]]}	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, …])

除了标准事件外，用户还可以调度自定义事件（见下例）。

仅适用于API的V2版本中的自定义事件！

自定义事件的格式如下

属性	类型	描述
name	str	事件的用户定义名称。
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]]) – 仅包括具有匹配名称的runnable的事件。

• include_types（《可选》） (序列[字符串]]) – 只包含类型匹配的可执行任务的事件。

• include_tags（《可选》） (序列[字符串]]) – 只包含标签匹配的可执行任务的事件。

• exclude_names（《可选》） (序列[字符串]]) – 排除名称匹配的可执行任务的事件。

• exclude_types（《可选》） (序列[字符串]]) – 排除类型匹配的可执行任务的事件。

• exclude_tags（《可选》） (序列[字符串]]) – 排除标签匹配的可执行任务的事件。

• kwargs（《任何》） – 将传递给可执行任务的额外关键字参数。这些将通过astream_log传递，因为astream_events的实现基于astream_log。

产生

StreamEvents的异步流。

引发

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

返回类型

AsyncIterator [联合 [StandardStreamEvent, CustomStreamEvent]]

batch(inputs: List[Union[PromptValue, str, Sequence[Union[BaseMessage, List[str], Tuple[str, str], str, Dict[str, Any]]]]]], *, **kwargs: Any) → List[str]

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

默认批处理实现对于I/O密集型运行函数来说表现良好。

子类应覆盖此方法以实现更高效的批量操作；例如，如果底层运行函数使用支持批量模式的API。

参数

• inputs (List[Union[PromptValue, str, Sequence[Union[BaseMessage, List[str], Tuple[str, str], str, Dict[str, Any]]]]) –

• config (Optional[Union[RunnableConfig, List[RunnableConfig]]]) –

• return_exceptions (bool) –

• 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]]]

在输入列表上并行运行invoke，按完成顺序输出结果。

参数

• inputs (Sequence[Input]) –

• config (Optional[Union[RunnableConfig, Sequence[RunnableConfig]]]) –

• return_exceptions (bool) –

• 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]

配置可以运行时设置的 Runnables 的替代配置。

参数

• which (ConfigurableField) – 用于选择替代方案的 ConfigurableField 实例。

• default_key (str) – 如果未选择替代方案，则使用默认关键字。默认为“default”。

• prefix_keys (bool) – 是否使用 ConfigurableField id 作为键的前缀。默认为 False。

• **kwargs (Union[Runnable[Input, Output], Callable[[], Runnable[Input, Output]]]) – 键到 Runnable 实例或可调用函数的字典，该函数返回 Runnable 实例。

返回

具有配置的替代方案的新的 Runnable 对象。

返回类型

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]¶

在运行时配置特定的Runnable字段。

参数

**kwargs (Union[ConfigurableField, ConfigurableFieldSingleOption, ConfigurableFieldMultiOption]) – 要配置的ConfigurableField实例的字典。

返回

具有配置字段的新的Runnable。

返回类型

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时，应该使用此方法进行批处理调用。

当你想

1. 利用批量调用时，

2. 需要比顶层生成值更多的模型输出时，

3. 正在构建对底层语言模型类型（例如，纯文本完成模型与聊天模型）无感知的链时。

   类型。

参数

• prompts （列表 [ str ]）- 字符提示列表。

• stop (Optional[List[str]]) – 生成时使用的停用词。当模型输出中首次出现任何这些子字符串时，模型输出将被截断。

• callbacks （并集 [ 列表 [ BaseCallbackHandler ]，BaseCallbackManager，None，列表 [ 可选 [ 并集 [ 列表 [ BaseCallbackHandler ]，BaseCallbackManager ] ] ] ] ]）- 要传递的回调。用于在整个生成过程中执行附加功能，如记录或流。

• tags （可选 [ 并集 [ 列表 [ str ]，列表 [ 列表 [ str ] ] ] ] ] ]）- 与每个prompt关联的标签列表。如果提供，列表的长度必须与提示列表的长度匹配。

• metadata （可选 [ 并集 [ 字典 [ str，Any]，列表 [ 字典 [ str，Any] ] ] ] ]）- 与每个prompt关联的元数据字典列表。如果提供，列表的长度必须与提示列表的长度匹配。

• run_name （可选 [ 并集 [ str，列表 [ str ] ] ] ]）- 与每个prompt关联的运行名列表。如果提供，列表的长度必须与提示列表的长度匹配。

• run_id （可选 [ 并集 [ UUID，列表 [ 可选 [ UUID ] ] ] ] ]）- 与每个prompt关联的运行ID列表。如果提供，列表的长度必须与提示列表的长度匹配。

• **kwargs (Any) – 任意额外的关键字参数。通常将这些参数传递给模型提供者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时，应该使用此方法进行批处理调用。

当你想

1. 利用批量调用时，

2. 需要比顶层生成值更多的模型输出时，

3. 正在构建对底层语言模型类型（例如，纯文本完成模型与聊天模型）无感知的链时。

   类型。

参数

• prompts (列表[提示值]) – 提示值列表。提示值是一个对象，可以转换为与任何语言模型的格式相匹配（纯文本生成模型为字符串，聊天模型为BaseMessages）。

• stop (Optional[List[str]]) – 生成时使用的停用词。当模型输出中首次出现任何这些子字符串时，模型输出将被截断。

• callbacks （并集 [ 列表 [ BaseCallbackHandler ]，BaseCallbackManager，None，列表 [ 可选 [ 并集 [ 列表 [ BaseCallbackHandler ]，BaseCallbackManager ] ] ] ] ]）- 要传递的回调。用于在整个生成过程中执行附加功能，如记录或流。

• **kwargs (Any) – 任意额外的关键字参数。通常将这些参数传递给模型提供者API调用。

返回

LLMResult，包含每个提示的候选生成列表以及附加的模型提供者特定的输出

。

返回类型

LLMResult

get_num_tokens(text: str) → int

获取文本中的标记数量。

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

参数

text (str) – 要标记的字符串输入。

返回

文本中标记的整数数量。

返回类型

int

get_num_tokens_from_messages(messages: List[BaseMessage]) → int

获取消息中的令牌数量。

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

参数

messages (List[BaseMessage]) – 要分词的消息输入。

返回

消息中令牌数量的总和。

返回类型

int

get_token_ids(text: str) → List[int]

返回文本中令牌的有序ID。

参数

text (str) – 要标记的字符串输入。

返回

与文本中令牌对应的ID列表，按照它们在文本中出现的顺序。

文本中出现的顺序。

返回类型

[int]

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

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

参数

• input (Union[PromptValue, str, Sequence[UnionBaseMessage, List[str], Tuplestr, str], str, Dict[str, Any]]]]) – 可运行的输入。

• config （可选[RunnableConfig]） – 在调用Runnable时使用的配置。配置支持跟踪目的的标准键，如'tags'、'metadata'，'max_concurrency'以控制并行执行的工作量，以及其他键。有关更多详细信息，请参阅RunnableConfig。

• 停止 (Optional[List[str]]) –

• kwargs (Any) –

返回

可运行的输出。

返回类型

str

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

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

参数

• text (str) –

• stop (Optional[Sequence[str]]) –

• kwargs (Any) –

返回类型

str

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

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

参数

• messages (List[BaseMessage]) –

• stop (Optional[Sequence[str]]) –

• kwargs (Any) –

返回类型

BaseMessage

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

保存LLM。

参数

file_path (Union[Path, str]) – 要保存LLM的文件路径。

引发

ValueError – 如果文件路径不是字符串或Path对象。

返回类型

None

示例：

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[UnionBaseMessage, List[str], Tuplestr, str], str, Dict[str, Any]]]]) – 可运行的输入。

• config (OptionalRunnableConfig]) – 用于可运行的配置。默认为 None。

• 关键字参数 (任何) – 传递给Runnable的额外关键字参数。

• 停止 (Optional[List[str]]) –

产生

可运行的输出。

返回类型

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]]

property async_prediction_client: PredictionServiceAsyncClient

返回 PredictionServiceClient。

property endpoint_path: str

属性 prediction_client: PredictionServiceClient

返回 PredictionServiceClient。

task_executor: ClassVar[可选[Executor]] = FieldInfo(exclude=True, extra={})

使用 GemmaVertexAIModelGarden 的示例

• Google Cloud Vertex AI