`langchain_core.language_models.fake_chat_models`.FakeListChatModel¶

注释

fake_chat_models.FakeListChatModel实现了标准的Runnable接口。🏃

Runnable接口有额外的可以在运行时使用的方法，例如with_types、with_retry、assign、bind和更多。

class langchain_core.language_models.fake_chat_models.FakeListChatModel[source]¶

基类: SimpleChatModel

用于测试目的的假聊天模型。

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

是否缓存响应。

如果为true，将使用全局缓存。
如果为false，将不使用缓存
如果为None，如果没有设置全局缓存，将不使用缓存
如果为BaseCache的实例，将使用提供的缓存。

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

参数 callback_manager: 可选[BaseCallbackManager] = None¶: [弃用] 用于添加到运行跟踪的回调管理器。

参数 callbacks: Callbacks = None¶: 要添加到运行跟踪的回调。

参数 custom_get_token_ids: 可选[Callable[[str], List[int]]] = None¶: 用于计数标记的可选编码器。

参数 error_on_chunk_number: 可选[int] = None¶: 每次调用模型后内部递增。

参数 i: int = 0¶: 按顺序轮流遍历的响应列表。

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

参数 rate_limiter: 可选[BaseRateLimiter] = None¶: 一个可选的请求速率限制器，用于限制请求数量。

参数 responses: List[str] [必填]¶: 按顺序轮流遍历的响应列表。

参数 sleep: 可选[float] = None¶

参数 tags: 可选[List[str]] = None¶: 要添加到运行跟踪的标记。

参数 verbose: bool [可选]¶: 是否打印出响应文本。

__call__(messages: List[BaseMessage], stop: Optional[List[str]]= None, callbacks: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]] = None, **kwargs: Any) → BaseMessage¶

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

参数

messages (列表[BaseMessage]) –
stop (可选[列表[字符串]]) –
callbacks (可选[Union[列表[BaseCallbackHandler], BaseCallbackManager]) –
kwargs (任何) –

返回类型

BaseMessage

asyncabatch(inputs:List[Input], config:Optional[Union[RunnableConfig, List[RunnableConfig]]] = None, *, return_exceptions:bool = False, **kwargs:Optional[Any]) → List[Output]¶

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

默认批处理实现适用于IO密集型runnable。

如果子类能够更有效地分批处理，则应该重写此方法；例如，如果底层Runnable使用支持批处理模式的API。

参数

inputs (列表[输入]) – Runnable的输入列表。
config (可选[Union[RunnableConfig, List[RunnableConfig]]]) – 调用Runnable时使用的配置。该配置支持标准键，如用于跟踪的’tags’、‘metadata’、‘max_concurrency’以控制并行执行的工作量，以及其他键。请参阅RunnableConfig获取更多详细信息。默认为None。
return_exceptions (布尔型) – 是否返回异常而不是抛出异常。默认为False。
kwargs (可选[Any]) – 传递给Runnable的额外关键字参数。

返回

Runnable的输出列表。

返回类型

列表[输出]

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

并行运行 invocate 在一系列输入上，按完成顺序产出结果。

参数

inputs (Sequence[Input]) – Runnable 的输入列表。
config (Optional[Union[RunnableConfig, Sequence[RunnableConfig]]]) – 调用 Runnable 时使用的配置。配置支持标准键，如 ‘tags’、‘metadata’ 用于跟踪目的，‘max_concurrency’ 用于控制并行执行的工作量，以及其他键。请参考 RunnableConfig 了解更多详情。默认为 None。
return_exceptions (布尔型) – 是否返回异常而不是抛出异常。默认为False。
kwargs (可选[Any]) – 传递给Runnable的额外关键字参数。

产出：

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

返回类型

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

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

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

此方法应使用批量调用来利用支持批量API的模型。

当您想要进行以下操作时，请使用此方法：

利用批量调用，
所需模型输出比仅顶级生成值更多，
正在构建对底层语言模型类型（例如，纯文本完成模型与聊天模型）无感知的链。
类型（例如，纯文本完成模型与聊天模型）。

参数

消息 (列表[[列表[BaseMessage]]]) – 消息列表。
停止 (可选[[列表[字符串]]]) – 在生成时可使用的停止词。模型输出将在第一次出现这些子串时被截断。
回调 (可选[[列表[BaseCallbackHandler]， BaseCallbackManager]]) – 传递的回调。用于在生成过程中执行附加功能，例如记录或流式处理。
**kwargs (任意) – 随意额外的关键字参数。通常将这些参数传递给模型提供者API调用。
标签 (可选[[列表[字符串]]]) –
元数据 (可选[[字典[字符串，任意]]]) –
运行名称 (可选[[字符串]]) –
运行ID (可选[[UUID]]) –
**kwargs –

返回

一个LLMResult对象，包含每个输入提示的候选生成列表和附加模型提供者特定的输出。: 提示。

返回类型

LLMResult

异步 agenerate_prompt(prompts: List[PromptValue], stop: Optional[List[字符串]] = None, callbacks: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]] = None, **kwargs: 任意) → LLMResult¶

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

此方法应使用批量调用来利用支持批量API的模型。

当您想要进行以下操作时，请使用此方法：

利用批量调用，
所需模型输出比仅顶级生成值更多，
正在构建对底层语言模型类型（例如，纯文本完成模型与聊天模型）无感知的链。
类型（例如，纯文本完成模型与聊天模型）。

参数

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

返回

一个LLMResult对象，包含每个输入提示的候选生成列表和附加模型提供者特定的输出。: 提示。

返回类型

LLMResult

async ainvoke (Function input : LanguageModelInput, Function config : Optional[ RunnableConfig ] = None, Any *, Optional[ List[ str ] ] ] = None, Any **kwargs: Any): → BaseMessage ¶

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

默认实现允许即使在 Runnable 没有实现 invoke 的本地异步版本的情况下也可以使用异步代码。

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

参数

输入 (LanguageModelInput) –
配置 (Optional[ RunnableConfig ]) –
stop (可选[列表[字符串]]) –
kwargs (任何) –

返回类型

BaseMessage

async apredict (Function text : str, Any *, Optional[ Sequence[ str ] ] ] = None, Any **kwargs: Any): → str¶

已弃用：从 langchain-core==0.1.7 版本开始请使用 ainvoke 代替。

参数

文本 (str) –
停止 (Optional[ Sequence[ str ] ]) –
kwargs (任何) –

返回类型

字符串

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

已弃用：从 langchain-core==0.1.7 版本开始请使用 ainvoke 代替。

参数

messages (列表[BaseMessage]) –
停止 (Optional[ Sequence[ str ] ]) –
kwargs (任何) –

返回类型

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 将从 Runnable 实例化一个带有名称、描述和 args_schema 的 BaseTool。在可能的情况下，架构将从 runnable.get_input_schema 中推断。可替代地（例如，如果 Runnable 接受字典作为输入且特定的字典键未指定类型），可以使用 args_schema 直接指定架构。您还可以传递 arg_types 来仅指定所需的参数及其类型。

参数

args_schema (可选：类型[BaseModel]：) - 工具架构。默认为 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: LanguageModelInput, config: 可选：RunnableConfig], *, stop: 可选：List[str]], **kwargs: Any) → AsyncIterator[BaseMessageChunk]¶

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

参数

input (LanguageModelInput) – Runnable 的输入。
config (可选：RunnableConfig) – 用于Runnable的配置。默认为 None。
kwargs (任何) – 要传递给Runnable的额外关键字参数。
stop (可选[列表[字符串]]) –

产出：

Runnable 的输出。

返回类型

AsyncIterator[BaseMessageChunk]

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提供了关于Runnable进程进度的实时信息，包括中间结果生成的StreamEvents。

StreamEvent是一个具有以下结构的字典

event: str - 事件名称采用以下格式：
格式：on_[runnable_type]_(start|stream|end)。
name: str - 生成事件的可运行对象（Runnable）的名称。
run_id: str - 随机生成的与给定可运行对象(Runnable)执行的关联ID。
emit事件的可运行的子对象在作为父运行对象执行的组成部分被调用时会分配其自己的唯一ID。
parent_ids: List[str] - 产生事件的父运行对象的ID。根Runnable将有一个空列表。
父ID的顺序是从根到直接父。
只有v2版本的API可用。v1版本的API将返回一个空列表。
tags: Optional[List[str]] - 生成事件的运行对象的标签。
metadata: Optional[Dict[str, Any]] - 生成事件的运行对象的元数据。
data: Dict[str, Any]

以下表格描述了一些可能由各种链生成的事件。为了简洁，省略了元数据字段。表格之后包括链定义。

注意此参考表是关于V2版本的模式。

事件	名称	块	输入	输出
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, …])

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

自定义事件仅在有 v2 版本的API！

自定义事件具有以下格式

属性	类型	描述
名称	字符串	用户定义的事件名称。
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)

参数

输入 (Any) – 对可运行对象的输入。
config (Optional[RunnableConfig]) – 用于可运行对象的配置。
版本 (字面量['v1', 'v2']) - 使用模式版本，选择 v2 或 v1。建议用户使用 v2。 v1 用于向后兼容，将在 0.4.0 中弃用。直到 API 稳定，将不会分配默认值。仅在 v2 中暴露自定义事件。
include_names (可选[队列[str]]) - 只包括具有匹配名称的可执行事件。
include_types (可选[队列[str]]) - 只包括具有匹配类型的事件。
include_tags (可选[队列[str]]) - 只包括具有匹配标签的事件。
exclude_names (可选[队列[str]]) - 排除名称匹配的事件。
exclude_types (可选[队列[str]]) - 排除类型匹配的事件。
exclude_tags (可选[队列[str]]) - 排除标签匹配的事件。
kwargs (任何) - 传递给 Runnable 的额外关键字参数。这些将通过 astream_log 传递，因为 astream_events 的实现建立在 astream_log 之上。

产出：

StreamEvents 的异步流。

引发

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

返回类型

AsyncIterator[Union[StandardStreamEvent, CustomStreamEvent]]

batch(inputs: List[Input], config: Optional[Union[RunnableConfig, List[RunnableConfig]]] = None, *, return_exceptions: bool = False, **kwargs: Optional[Any]) → List[Output]¶

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

默认批处理实现适用于IO密集型runnable。

如果子类能够更有效地分批处理，则应该重写此方法；例如，如果底层Runnable使用支持批处理模式的API。

参数

inputs (列表[Input]) –
config (可选[Union[RunnableConfig, 列表[RunnableConfig]]]) –
return_exceptions (布尔值) –
kwargs (可选 [任何类型]) –

返回类型

列表[输出]

batch_as_completed(inputs: Sequences[Input], config: 可选[联合[RunnableConfig, Sequences[RunnableConfig]], *, return_exceptions: 布尔值 = False, **kwargs: 可选[任何类型]) → 迭代器[元组[整数, 联合[输出, 异常]]]]¶

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

参数

inputs (Sequences [输入]) –
config (可选 [联合] [RunnableConfig, Sequences] [RunnableConfig]]) –
return_exceptions (布尔值) –
kwargs (可选 [任何类型]) –

返回类型

迭代器 [ 元组 [ 整数, 联合 [ 输出, 异常 ] ]

bind_tools(tools: Sequence[Union[Dict[str, Any], Type, Callable, BaseTool]]]], **kwargs: Any) → Runnable[LanguageModelInput, BaseMessage]¶: 参数

tools (Sequence[Union[Dict[str, Any], Type, Callable, BaseTool])]) –

kwargs (任何) –

返回类型

Runnable[LanguageModelInput, BaseMessage]

call_as_llm(message: str, stop: Optional[List[str]]] = None, **kwargs: Any) → str¶

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

参数

message (str) –

stop (可选[列表[字符串]]) –

kwargs (任何) –

返回类型

字符串

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

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

参数

**kwargs (Union[ConfigurableField, ConfigurableFieldSingleOption, ConfigurableFieldMultiOption]) - 配置时使用的ConfigurableField实例的字典。

返回

配置字段后的新可运行对象。

返回类型

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(messages: List[List[BaseMessage]], stop: Optional[List[str]] = None, callbacks: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]] = None, *, tags: Optional[List[str]] = None, metadata: Optional[Dict[str, Any]] = None, run_name: Optional[str] = None, run_id: Optional[UUID] = None, **kwargs: Any) → LLMResult¶

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

此方法应使用批量调用来利用支持批量API的模型。

当您想要进行以下操作时，请使用此方法：

利用批量调用，

所需模型输出比仅顶级生成值更多，

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

参数

消息 (列表[[列表[BaseMessage]]]) – 消息列表。

停止 (可选[[列表[字符串]]]) – 在生成时可使用的停止词。模型输出将在第一次出现这些子串时被截断。

回调 (可选[[列表[BaseCallbackHandler]， BaseCallbackManager]]) – 传递的回调。用于在生成过程中执行附加功能，例如记录或流式处理。

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

标签 (可选[[列表[字符串]]]) –

元数据 (可选[[字典[字符串，任意]]]) –

运行名称 (可选[[字符串]]) –

运行ID (可选[[UUID]]) –

**kwargs –

返回

一个LLMResult对象，包含每个输入提示的候选生成列表和附加模型提供者特定的输出。
提示。

返回类型

LLMResult

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

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

此方法应使用批量调用来利用支持批量API的模型。

当您想要进行以下操作时，请使用此方法：

利用批量调用，

所需模型输出比仅顶级生成值更多，

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

参数

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

停止 (可选[[列表[字符串]]]) – 在生成时可使用的停止词。模型输出将在第一次出现这些子串时被截断。

回调 (可选[[列表[BaseCallbackHandler]， BaseCallbackManager]]) – 传递的回调。用于在生成过程中执行附加功能，例如记录或流式处理。

**kwargs (任意) – 随意额外的关键字参数。通常将这些参数传递给模型提供者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: LanguageModelInput, config: Optional[RunnableConfig] = None, *, stop: Optional[List[str]] = None, **kwargs: Any) → BaseMessage¶

将单个输入转换为输出。覆盖以实现。

参数

input (LanguageModelInput) – Runnable 的输入。

config (可选[RunnableConfig]) – 调用Runnable时使用的配置。配置支持诸如‘tags’、‘metadata’（用于跟踪目的）等标准键，‘max_concurrency’（用于控制并行工作数量）和其他键。请参考RunnableConfig获取更多详细信息。

stop (可选[列表[字符串]]) –

kwargs (任何) –

返回

Runnable 的输出。

返回类型

BaseMessage

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

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

参数

文本 (str) –

停止 (Optional[ Sequence[ str ] ]) –

kwargs (任何) –

返回类型

字符串

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

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

参数

messages (列表[BaseMessage]) –

停止 (Optional[ Sequence[ str ] ]) –

kwargs (任何) –

返回类型

BaseMessage

stream(input: LanguageModelInput, config: Optional[RunnableConfig] = None, *, stop: Optional[List[str]] = None, **kwargs: Any) → Iterator[BaseMessageChunk]¶

to_json() → Union[SerializedConstructor, SerializedNotImplemented]¶

将Runnable序列化为JSON。

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

with_structured_output(schema: Union[Dict, Type], *, include_raw: bool = False, **kwargs: Any) → Runnable[LanguageModelInput, Union[Dict, BaseModel]]¶

返回输出格式与给定模式匹配的模型包装器。

参数

模式 (Union[Dict, Type]) –
输出模式。可以通过以下方式传递：
- OpenAI函数/工具模式，
- JSON Schema，
- TypedDict类（在0.2.26中添加支持），
- 或Pydantic类。
如果模式是Pydantic类，那么模型输出将是该类的Pydantic实例，并通过Pydantic类验证生成的字段。否则，模型输出将是一个字典，并且不会进行验证。有关如何在指定Pydantic或TypedDict类时正确指定模式和字段类型的更多信息，请参阅langchain_core.utils.function_calling.convert_to_openai_tool()。

版本0.2.26变更：添加了对TypedDict类的支持。
include_raw (bool) – 如果为False，则仅返回解析后的结构化输出。如果在模型输出解析期间发生错误，将引发错误。如果为True，则返回原始模型响应（一个BaseMessage）和解析的模型响应。如果在输出解析期间发生错误，它将捕获并返回。最终输出始终是一个具有“raw”，“parsed”和“parsing_error”键的字典。
kwargs (任何) –

返回

与langchain_core.language_models.chat.BaseChatModel具有相同输入的Runnable。

如果include_raw为False且模式是Pydantic类，Runnable输出的是模式的实例（即Pydantic对象）。

否则，如果 include_raw 为 False，则 Runnable 输出一个字典。

如果 include_raw 为 True，则 Runnable 输出的字典包含以下键：

"raw"：BaseMessage
"parsed"：如果发生解析错误，则为 None，否则类型取决于上述描述的 schema。
"parsing_error"：Optional[BaseException]

返回类型

Runnable[LanguageModelInput, Union[Dict, BaseModel]]

示例：Pydantic schema（include_raw=False）

from langchain_core.pydantic_v1 import BaseModel

class AnswerWithJustification(BaseModel):
    '''An answer to the user question along with justification for the answer.'''
    answer: str
    justification: str

llm = ChatModel(model="model-name", temperature=0)
structured_llm = llm.with_structured_output(AnswerWithJustification)

structured_llm.invoke("What weighs more a pound of bricks or a pound of feathers")

# -> AnswerWithJustification(
#     answer='They weigh the same',
#     justification='Both a pound of bricks and a pound of feathers weigh one pound. The weight is the same, but the volume or density of the objects may differ.'
# )

示例：Pydantic schema（include_raw=True）

from langchain_core.pydantic_v1 import BaseModel

class AnswerWithJustification(BaseModel):
    '''An answer to the user question along with justification for the answer.'''
    answer: str
    justification: str

llm = ChatModel(model="model-name", temperature=0)
structured_llm = llm.with_structured_output(AnswerWithJustification, include_raw=True)

structured_llm.invoke("What weighs more a pound of bricks or a pound of feathers")
# -> {
#     'raw': AIMessage(content='', additional_kwargs={'tool_calls': [{'id': 'call_Ao02pnFYXD6GN1yzc0uXPsvF', 'function': {'arguments': '{"answer":"They weigh the same.","justification":"Both a pound of bricks and a pound of feathers weigh one pound. The weight is the same, but the volume or density of the objects may differ."}', 'name': 'AnswerWithJustification'}, 'type': 'function'}]}),
#     'parsed': AnswerWithJustification(answer='They weigh the same.', justification='Both a pound of bricks and a pound of feathers weigh one pound. The weight is the same, but the volume or density of the objects may differ.'),
#     'parsing_error': None
# }

示例：Dict schema（include_raw=False）

from langchain_core.pydantic_v1 import BaseModel
from langchain_core.utils.function_calling import convert_to_openai_tool

class AnswerWithJustification(BaseModel):
    '''An answer to the user question along with justification for the answer.'''
    answer: str
    justification: str

dict_schema = convert_to_openai_tool(AnswerWithJustification)
llm = ChatModel(model="model-name", temperature=0)
structured_llm = llm.with_structured_output(dict_schema)

structured_llm.invoke("What weighs more a pound of bricks or a pound of feathers")
# -> {
#     'answer': 'They weigh the same',
#     'justification': 'Both a pound of bricks and a pound of feathers weigh one pound. The weight is the same, but the volume and density of the two substances differ.'
# }

langchain_core.language_models.fake_chat_models.FakeListChatModel¶

`langchain_core.language_models.fake_chat_models`.FakeListChatModel¶