langchain_community.chat_models.moonshot.MoonshotChat

注释

月球射击聊天实现了标准 Runnable Interface 接口。 🏃

在 Runnable Interface 上提供了额外的运行时方法，例如 with_types，with_retry，assign，bind，以及更多。

class langchain_community.chat_models.moonshot.MoonshotChat

Bases: MoonshotCommon，ChatOpenAI

月球大型语言模型。

要使用该模型，您需要安装 openai python 包，并将环境变量 MOONSHOT_API_KEY 设置为您的 API 密钥。（Moonshot 的聊天 API 与 OpenAI 的 SDK 兼容。）

参考资料：https://platform.moonshot.cn/docs

示例

from langchain_community.chat_models.moonshot import MoonshotChat

moonshot = MoonshotChat(model="moonshot-v1-8k")

param base_url: str = 'https://api.moonshot.cn/v1'

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

是否缓存响应。

• 如果设置为 true，将使用全局缓存。

• 如果设置为 false，则不会使用缓存。

• 如果设置为 None，当全局缓存已设置时会使用全局缓存，否则不使用缓存。

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

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

参数 callback_manager: Optional[BaseCallbackManager] = None

[已弃用] 用于运行跟踪添加的回调管理器。

参数 callbacks: Callbacks = None

添加到运行跟踪的回调。

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

用于计算令牌的可选编码器。

参数 default_headers: Union[Mapping[str, str], None] = None

param default_query: Union[Mapping[str, object], None] = None

param http_client: Union[Any, None] = None

可选的httpx.Client。

param max_retries: int = 2

生成时的最大重试次数。

param max_tokens: int = 1024

要生成的最大token数。

param metadata: Optional[Dict[str, Any]] = None

添加到运行跟踪的元数据。

param model_kwargs: Dict[str, Any] [Optional]

包含任何有效的模型参数，这些参数在“create”调用时没有明确指定。

param model_name: str = 'moonshot-v1-8k' (别名 'model')

模型名称。可用的模型在此列出：https://platform.moonshot.cn/pricing

param moonshot_api_key: Optional[SecretStr] = None (alias 'api_key')

Moonshot API密钥。在此处获取：https://platform.moonshot.cn/console/api-keys

限制

• 类型 = 字符串

• 只写 = True

• 格式 = 密码

param n: int = 1

为每个提示生成聊天完成的数量。

param openai_api_base: Optional[str] = None (alias 'base_url')

API请求的基础URL路径，如果不使用代理或服务模拟器，请保持空白。

param openai_api_key: Optional[str] = None (alias 'api_key')

如果未提供，将自动从环境变量OPENAI_API_KEY中推断。

param openai_organization: Optional[str] = None (alias 'organization')

如果未提供，将自动从环境变量OPENAI_ORG_ID中推断。

param openai_proxy: Optional[str] = None

param rate_limiter: Optional[BaseRateLimiter] = None

可选请求速率限制器，用于限制请求数量。

param request_timeout: Union[float, Tuple[float, float], Any, None] = None (alias 'timeout')

请求 OpenAI 完成API的超时。可以是浮点数、httpx.Timeout 或 None。

param streaming: bool = False

是否要流式传输结果。

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

要添加到运行跟踪器的标签。

param temperature: float = 0.3

温度参数（值越大，模型越具创意）。

param tiktoken_model_name: Optional[str] = None

在使用此类时，传递给tiktoken的模型名称。tiktoken用于计算文档中的token数量，以将它们限制在某个限制之下。默认情况下，当设置为None时，将与嵌入模型名称相同。但是，在某些情况下，您可能想使用此嵌入类与tiktoken不支持模型名称一起使用。这包括在使用Azure嵌入或使用许多公开类似OpenAI API但具有不同模型之一的模型提供商时。在这些情况下，为了避免当tiktoken被调用时出错，您可以指定在此处使用的模型名称。

参数 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 (可选[列表[str]]) –

• 回调函数 (可选[联合[列表[BaseCallbackHandler], BaseCallbackManager]]) –

• 参数 (任何) –

返回类型

BaseMessage

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

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

默认实现的批量处理对于IO密集型任务运行良好。

子类应覆盖此方法以提高批量效率；例如，如果底层Runnable使用支持批量模式的API。

参数

• inputs (列表[Input]) – Runnable的输入列表。

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

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

• kwargs (可选[任何]) – 用于Runnable的额外关键字参数。

返回值

Runnable的输出列表。

返回类型

列表[Output]

async abatch_as_completed(inputs: Sequence[Input], config: Optional[Union[RunnableConfig, Sequence[RunnableConfig]]] = None, **kwargs: Optional[Any]) → AsyncIterator[Tuple[int, Union[Output, Exception]]]¶

在输入列表上并行运行runnable，在任务完成后返回结果。

参数

• inputs (Sequence[Input]) – Runnable的输入列表。

• config (Optional[Union[RunnableConfig, Sequence[RunnableConfig]]]) – 调用Runnable时使用的配置。配置支持像‘tags’、‘metadata’这样的标准键，用于跟踪目的，支持像‘max_concurrency’这样的键来控制并行工作的数量，以及其他键。请参阅RunnableConfig获取更多详细信息。默认为None。

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

• kwargs (可选[任何]) – 用于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的模型的批量调用。

当您想

1. 利用分批调用，

2. 需要从模型中获得比仅生成值更多的输出，

3. 正在构建对底层语言模型类型（例如，纯文本补全模型与聊天模型）无差别的链。

   类型（例如，纯文本补全模型与聊天模型）。

参数

• 消息（列表[[列表[[BaseMessage]]]]]） - 消息的列表。

• 停止（可选[[列表[[str]]]]]） - 生成时使用的停止词。模型输出将在首次出现任何这些子字符串时截断。

• 回调函数（可选[[联合[[列表[[BaseCallbackHandler]]]], BaseCallbackManager]]]） - 要传递的回调函数。用于在整个生成过程中执行附加功能，如日志记录或流式传输。

• **kwargs（任何） - 任意额外的关键字参数。这些通常传递给模型提供商的API调用。

• 标签（可选[[列表[[str]]]]]） -

• 元数据（可选[[字典[[str, 任何]]]]]） –

• 运行名称（可选[[str]]） –

• 运行ID（可选[[UUID]]） –

• **kwargs –

返回值

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

提示和附加模型提供商特定的输出。

返回类型

LLMResult

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

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

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

当您想

1. 利用分批调用，

2. 需要从模型中获得比仅生成值更多的输出，

3. 正在构建对底层语言模型类型（例如，纯文本补全模型与聊天模型）无差别的链。

   类型（例如，纯文本补全模型与聊天模型）。

参数

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

• 停止（可选[[列表[[str]]]]]） - 生成时使用的停止词。模型输出将在首次出现任何这些子字符串时截断。

• 回调函数（可选[[联合[[列表[[BaseCallbackHandler]]]], BaseCallbackManager]]]） - 要传递的回调函数。用于在整个生成过程中执行附加功能，如日志记录或流式传输。

• **kwargs（任何） - 任意额外的关键字参数。这些通常传递给模型提供商的API调用。

返回值

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

提示和附加模型提供商特定的输出。

返回类型

LLMResult

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

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

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

子类应该覆盖此方法，如果它们能够异步运行。

参数

• input (LanguageModelInput) –

• config (Optional[RunnableConfig]) –

• stop (可选[列表[str]]) –

• 参数 (任何) –

返回类型

BaseMessage

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

自langchain-core==0.1.7版本以来已弃用：使用ainvoke代替。

参数

• text (str) –

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

• 参数 (任何) –

返回类型

str

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

自langchain-core==0.1.7版本以来已弃用：使用ainvoke代替。

参数

• messages (列表[BaseMessage]) –

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

• 参数 (任何) –

返回类型

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 动态实例化一个带有名称、描述以及从 Runnable 中获取的 args_schema 的 BaseTool。尽可能的情况下，schema 通过 runnable.get_input_schema 推断。或者在 Runnable 接受字典作为输入而字典中的特定键没有类型的情况下，可以通过 args_schema直接指定 schema。您还可以通过传递 arg_types 来仅指定所需的参数及其类型。

参数

• args_schema (可选 [类型][BaseModel]) – tool 的 schema。默认为 None。

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

• description (可选 [str]) – tool 的描述。默认为 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 指定 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 指定 schema

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] = None, *, stop : 可选 [str] = None, **kwargs) → AsyncIterator[BaseMessageChunk]

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

参数

• input (LanguageModelInput) – Runnable 的输入。

• config (可选 [RunnableConfig]) – 用于 Runnable 的配置。默认为 None。

• kwargs (任何) – 将传递给 Runnable 的附加关键字参数。

• stop (可选[列表[str]]) –

产出

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，这些事件提供关于Runnable执行进度的实时信息，包括来自中间结果的StreamEvents。

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

• event: str - 事件名称的格式为

  ：on_[runnable_type]_(start|stream|end)。

• name: str - 产生事件的Runnable的名称。

• run_id: str - 与产生事件的Runnable关联的随机生成的ID。被作为父Runnable执行部分调用的子Runnable将被分配其自己的唯一ID。

  该事件。

• parent_ids: List[str] - 产生事件的父Runnable的ID。根Runnable将有一个空列表。父ID的顺序是从根到直接父级。仅适用于API的v2版本。API的v1版本将返回一个空列表。

  产生事件的Runnable。

• tags: Optional[List[str]] - 产生事件的Runnable的标签。

  的事件。

• metadata: Optional[Dict[str, Any]] - 产生事件的Runnable的元数据。

  的事件。

• 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, …])

除了标准事件之外，用户还可以发送自定义事件（下面有示例）。

自定义事件仅在API的< cite>v2版本中公开！

自定义事件具有以下格式

属性	类型	描述
名称	str	事件的用户定义名称。
数据	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']) – 要使用的模式版本，either v2 or 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]]], *, return_exceptions: bool = False, **kwargs: Optional[Any]) → List[Output]

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

默认实现的批量处理对于IO密集型任务运行良好。

子类应覆盖此方法以提高批量效率；例如，如果底层Runnable使用支持批量模式的API。

参数

• inputs (列表[Input]) –

• config (可选[Union[RunnableConfig, 列表[RunnableConfig]]]) –

• return_exceptions (布尔型) –

• kwargs (可选[任意类型]) –

返回类型

列表[Output]

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 (可选[任意类型]) –

返回类型

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

bind_functions(functions: Sequence[Union[Dict[str, Any], Type[BaseModel], Callable]]], function_call: Optional[str] = None, **kwargs: Any) → Runnable[Union[PromptValue, str, Sequence[Union[BaseMessage, List[str], Tuple[str, str], str, Dict[str, Any]]], BaseMessage]¶

将函数（以及其他对象）绑定到此聊天模型。

参数

• functions (Sequence[Union[Dict[str, Any], Type[BaseModel], Callable]]) – 要绑定到此聊天模型的函数定义列表。可以是字典、Pydantic模型或可调用对象。Pydantic模型和可调用对象将被自动转换为它们的模式字典表示形式。

• function_call (Optional[str]) – 要求模型必须调用的函数。必须是提供的单个函数名称或“auto”，以自动确定要调用的函数（如果有）。

• kwargs (Any) – 要传递给Runnable构造函数的任何其他参数。

返回类型

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

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

• 参数 (任何) –

返回类型

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 (可选[列表[str]]) –

• 参数 (任何) –

返回类型

str

completion_with_retry(run_manager: Optional[CallbackManagerForLLMRun] = None, **kwargs: Any) → Any

使用tenacity来重试执行调用。

参数

• run_manager (Optional[CallbackManagerForLLMRun]) –

• 参数 (任何) –

返回类型

Any

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。

返回类型

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(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的模型的批量调用。

当您想

1. 利用分批调用，

2. 需要从模型中获得比仅生成值更多的输出，

3. 正在构建对底层语言模型类型（例如，纯文本补全模型与聊天模型）无差别的链。

   类型（例如，纯文本补全模型与聊天模型）。

参数

• 消息（列表[[列表[[BaseMessage]]]]]） - 消息的列表。

• 停止（可选[[列表[[str]]]]]） - 生成时使用的停止词。模型输出将在首次出现任何这些子字符串时截断。

• 回调函数（可选[[联合[[列表[[BaseCallbackHandler]]]], BaseCallbackManager]]]） - 要传递的回调函数。用于在整个生成过程中执行附加功能，如日志记录或流式传输。

• **kwargs（任何） - 任意额外的关键字参数。这些通常传递给模型提供商的API调用。

• 标签（可选[[列表[[str]]]]]） -

• 元数据（可选[[字典[[str, 任何]]]]]） –

• 运行名称（可选[[str]]） –

• 运行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的模型的批量调用。

当您想

1. 利用分批调用，

2. 需要从模型中获得比仅生成值更多的输出，

3. 正在构建对底层语言模型类型（例如，纯文本补全模型与聊天模型）无差别的链。

   类型（例如，纯文本补全模型与聊天模型）。

参数

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

• 停止（可选[[列表[[str]]]]]） - 生成时使用的停止词。模型输出将在首次出现任何这些子字符串时截断。

• 回调函数（可选[[联合[[列表[[BaseCallbackHandler]]]], BaseCallbackManager]]]） - 要传递的回调函数。用于在整个生成过程中执行附加功能，如日志记录或流式传输。

• **kwargs（任何） - 任意额外的关键字参数。这些通常传递给模型提供商的API调用。

返回值

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

提示和附加模型提供商特定的输出。

返回类型

LLMResult

get_num_tokens(text: str) → int

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

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

参数

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

返回值

文本中的令牌整数数量。

返回类型

int

get_num_tokens_from_messages(messages: List[BaseMessage]) → int

使用 tiktoken 包计算 gpt-3.5-turbo 和 gpt-4 的令牌数量。

官方文档：https://github.com/openai/openai-cookbook/blob/ main/examples/How_to_format_inputs_to_ChatGPT_models.ipynb

参数

messages (列表[BaseMessage]) –

返回类型

int

get_token_ids(text: str) → List[int]

使用 tiktoken 包获取文本中存在的标记。

参数

text (str) –

返回类型

整数列表

invoke(input: LanguageModelInput, config: Optional[RunnableConfig] = None, *, stop: Optional[List[str]] = None, **kwargs: Any) → BaseMessage

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

参数

• input (LanguageModelInput) – Runnable 的输入。

• config (可选[RunnableConfig]) – 在调用可运行时使用配置。此配置支持标准键，如’tags’，‘metadata’用于跟踪目的，‘max_concurrency’用于控制并行执行的工作量，以及其他键。请参阅 RunnableConfig 以获取更多详细信息。

• stop (可选[列表[str]]) –

• 参数 (任何) –

返回值

Runnable 的输出。

返回类型

BaseMessage

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

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

参数

• text (str) –

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

• 参数 (任何) –

返回类型

str

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

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

参数

• messages (列表[BaseMessage]) –

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

• 参数 (任何) –

返回类型

BaseMessage

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

流的基本实现，调用 invoke。如果子类支持流式输出，则应重写此方法。

参数

• input (LanguageModelInput) – Runnable 的输入。

• config (可选 [RunnableConfig]) – 用于 Runnable 的配置。默认为 None。

• kwargs (任何) – 将传递给 Runnable 的附加关键字参数。

• stop (可选[列表[str]]) –

产出

Runnable 的输出。

返回类型

Iterator[BaseMessageChunk]

to_json() → Union[SerializedConstructor, SerializedNotImplemented]

将可运行实体序列化为JSON。

返回值

可运行实体的JSON序列化表示。

返回类型

Union[SerializedConstructor, SerializedNotImplemented]

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

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

参数

• schema (Union[Dict, Type]) –

  输出模式。可以通过以下方式传递：

  • OpenAI 功能/工具模式，

  • JSON 模式，

  • TypedDict 类（0.2.26 版本中增加了支持），

  • 或 Pydantic 类。

  如果 schema 是 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”的字典。

• 参数 (任何) –

返回值

一个可运行的类，其接受的输入与 langchain_core.language_models.chat.BaseChatModel 相同。

如果 include_raw 为 False 且 schema 是 Pydantic 类，Runnable 输出 schema 的实例（即 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.'
# }

使用 MoonshotChat 的示例

• MoonshotChat