langchain_anthropic.llms.AnthropicLLM

注意

AnthropicLLM实现了标准 Runnable 接口。 🏃

Runnable 接口 拥有一些在可运行对象上的额外方法，例如 with_types，with_retry，assign，bind，get_graph 等。

class langchain_anthropic.llms.AnthropicLLM[source]

基类: LLM, _AnthropicCommon

Anthropic大语言模型。

使用时，您应该设置环境变量ANTHROPIC_API_KEY为您的API密钥，或将其作为构造函数的命名参数传递。

示例

from langchain_anthropic import AnthropicLLM

model = AnthropicLLM()
param AI_PROMPT: Optional[str] = None
param HUMAN_PROMPT: Optional[str] = None
param anthropic_api_key: Optional[SecretStr] = None
约束

  • 类型 = 字符串

  • writeOnly = True

  • 格式 = 密码

参数 anthropic_api_url: 可选[str] = None
参数 cache: 联合[BaseCache, bool, None] = None

是否缓存响应。

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

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

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

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

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

参数 callback_manager: 可选[BaseCallbackManager] = None

[已弃用]

参数 callbacks :Callbacks = None

添加到运行跟踪的回调函数。

参数 count_tokens: 可选[Callable[[str], int]] = None
参数 custom_get_token_ids: 可选[Callable[[str], List[int]] = None

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

参数 default_request_timeout: Optional[float] = None

对 Anthropic Completion API 请求的超时时间。默认为 600 秒。

参数 max_retries: int = 2

对发送到 Anthropic Completion API 的请求允许的重试次数。

参数 max_tokens_to_sample: int = 1024 (别名 'max_tokens)}

表示每次生成预测的标记数。

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

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

参数 model: str = 'claude-2' (别名 'model_name')}

要使用的模型名称。

参数 model_kwargs: Dict[str, Any] [Optional]
参数 streaming: bool = False

是否流式传输结果。

参数 tags: 可选[列表[str]] = None

添加到运行跟踪的标签。

参数 temperature: 可选[float] = None

非负浮点数，用于调整生成过程中的随机程度。

参数 top_k: 可选[int] = None

每个步骤中考虑的最可能token的数量。

参数 top_p: 可选[float] = None

每个步骤中考虑的token的总概率质量。

参数 verbose: bool [可选]

是否打印响应文本。

__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 - 如果提示（prompt）不是一个字符串。

返回类型

str

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

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

默认的批处理实现适用于I/O密集型运行可数（runnables）。

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

参数

  • inputs (List[Union[PromptValue, str, Sequence[Union[BaseMessage, List[str], Tuple[str, str], str, Dict[str, Any]]]]]) - 可数（Runnable）的输入列表。

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

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

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

返回

Runnable的输出列表。

返回类型

List[str]

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

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

参数

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

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

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

  • kwargs (可选[Any]) – 要传递给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时，应使用此方法进行批处理调用。

当您想

  1. 利用批处理调用时，

  2. 需要更多来自模型的信息，而不仅仅是顶级生成值时，

  3. 您正在构建不受底层语言模型类型影响（例如，纯文本完成模型与聊天模型）的链。

    类型。

参数

  • prompts (列表[str]) – 字符串提示列表。

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

  • callbacks (Union[列表[BaseCallbackHandler], BaseCallbackManager, None, 列表[Optional[Union[列表[BaseCallbackHandler], BaseCallbackManager]]]]) – 要传递的回调。用于在整个生成过程中执行额外功能，例如记录或流。

  • tags (可选[Union[列表[str], 列表[列表[str]]]]]) – 与每个提示关联的标签列表。如果提供，则列表长度必须与提示列表长度匹配。

  • metadata (可选[Union[字典[str, Any], 列表[字典[str, Any]]]]]) – 与每个提示关联的元数据字典列表。如果提供，则列表长度必须与提示列表长度匹配。

  • run_name (可选[Union[str, 列表[str]]]) – 与每个提示关联的运行名称列表。如果提供，则列表长度必须与提示列表长度匹配。

  • run_id (可选[Union[UUID, 列表[Optional[UUID]]]]) – 与每个提示关联的运行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[BaseCallbackHandler,BaseCallbackManager]]]] = None, **kwargs: Any) → LLMResult

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

当模型公开了批处理API时，应使用此方法进行批处理调用。

当您想

  1. 利用批处理调用时，

  2. 需要更多来自模型的信息，而不仅仅是顶级生成值时，

  3. 您正在构建不受底层语言模型类型影响（例如，纯文本完成模型与聊天模型）的链。

    类型。

参数

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

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

  • callbacks (Union[列表[BaseCallbackHandler], BaseCallbackManager, None, 列表[Optional[Union[列表[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]]]], config: Optional[RunnableConfig] = None, *, stop: 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

async 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

async 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的BaseTool。尽可能从runnable.get_input_schema中推断 schemas。如果可能（例如，如果Runnable接收字典作为输入且特定的字典键未指定类型），则可以直接使用args_schema指定架构。您还可以传递arg_types来仅指定所需参数及其类型。

参数

  • args_schema (可选[Type[BaseModel]]) – 工具架构。默认为None。

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

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

  • arg_types (可选[Dict[str, Type]]) – 参数名称与类型的字典。默认为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[Union[BaseMessage, List[str], Tuple[str, str], str, Dict[str, Any]]]]) – Runnable的输入。

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

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

  • 停止 (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的迭代器，这些StreamEvents提供有关Runnable进度（包括中间结果）的实时信息。

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

  • event： str - 事件名称具有以下格式：

    ：on_[可运行类型]_(start|stream|end)。

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

  • run_id： str - 与给定可运行对象执行关联的随机生成ID。作为父可运行对象执行的一部分被调用的子可运行对象会分配其唯一的ID。

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

  • 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

某些工具

{“x”：1，“y”：'2'}

on_tool_end

某些工具

{“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版本中公开！

自定义事件格式如下：

属性

类型

描述

名称

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)

某些工具:

@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）- 可运行对象的输入。

  • 配置（Optional[List[RunnableConfig]]）- 要为可运行对象使用的配置。

  • 版本（Literal['v1', 'v2']）- 要使用的模式版本，要么是v2，要么是v1。用户应使用v2。 v1用于向后兼容性，将在0.4.0版本中弃用。默认值将在API稳定之前不会分配。自定义事件仅在v2中公开。

  • include_names（Optional[Sequence[str]]）- 仅包含具有匹配名称的可运行对象的下拉菜单。

  • include_types (可选[序列[str]]) – 只包含与匹配类型相符的runnables的事件。

  • include_tags (可选[序列[str]]) – 只包含与匹配标签相符的runnables的事件。

  • exclude_names (可选[序列[str]]) – 排除与匹配名称相符的runnables的事件。

  • exclude_types (可选[序列[str]]) – 排除与匹配类型相符的runnables的事件。

  • exclude_tags (可选[序列[str]]) – 排除与匹配标签相符的runnables的事件。

  • kwargs (任意) – 传递给Runnable的额外关键字参数。这些参数将传递给astream_log，因为astream_events的实现是基于astream_log构建的。

生成

StreamEvents的异步流。

引发错误

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

默认实现使用线程池执行者在并行中运行。

默认的批处理实现适用于I/O密集型运行可数（runnables）。

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

参数
返回类型

List[str]

batch_as_completed(inputs: sequence[input], config: 可选[联合[RunnableConfig, sequence[RunnableConfig]]] = None, *, return_exceptions: 布尔 = False, **kwargs: 可选[任何]) → iterator[tuple[int, 联合[output, 异常]]]

在多个输入上并行运行 invoke，按结果完成顺序产生结果。

参数

  • inputs (sequence[input]) –

  • config (可选[联合[RunnableConfig, sequence[RunnableConfig]]]) –

  • return_exceptions (布尔) –

  • kwargs (可选[任何]) –

返回类型

iterator[tuple[int, 联合[output, 异常]]

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实例的callables的字典。

返回

配置替代项的新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]) – 配置的可配置字段实例的字典。

返回

配置字段后的新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
)
convert_prompt(prompt: PromptValue) → str[source]
参数

prompt (PromptValue) –

返回类型

str

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 (Union[列表[BaseCallbackHandler], BaseCallbackManager, None, 列表[Optional[Union[列表[BaseCallbackHandler], BaseCallbackManager]]]]) – 要传递的回调。用于在整个生成过程中执行额外功能，例如记录或流。

  • tags (可选[Union[列表[str], 列表[列表[str]]]]]) – 与每个提示关联的标签列表。如果提供，则列表长度必须与提示列表长度匹配。

  • metadata (可选[Union[字典[str, Any], 列表[字典[str, Any]]]]]) – 与每个提示关联的元数据字典列表。如果提供，则列表长度必须与提示列表长度匹配。

  • run_name (可选[Union[str, 列表[str]]]) – 与每个提示关联的运行名称列表。如果提供，则列表长度必须与提示列表长度匹配。

  • run_id (可选[Union[UUID, 列表[Optional[UUID]]]]) – 与每个提示关联的运行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 ([PromptValue]) – PromptValue 对象的列表。PromptValue 是一个可以转换为任何语言模型格式的对象（纯文本生成模型的字符串和聊天模型的 BaseMessages）。

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

  • callbacks (Union[列表[BaseCallbackHandler], BaseCallbackManager, None, 列表[Optional[Union[列表[BaseCallbackHandler], BaseCallbackManager]]]]) – 要传递的回调。用于在整个生成过程中执行额外功能，例如记录或流。

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

返回

包含每个输入提示的候选生成列表以及与模型提供商特定的额外输出的LLMResult

。

返回类型

LLMResult

get_num_tokens(text: str) → int[source]

计算单词数量。

参数

text (str) –

返回类型

整型

get_num_tokens_from_messages(messages: List[BaseMessage]) → int

获取消息中的标记数量。

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

参数

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

返回

消息中标记数的总和。

返回类型

整型

get_token_ids(text: str) → 列表[int]

返回文本中标记的顺序ID。

参数

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

返回

文本中标记的ID列表，按照在文本中出现的顺序。

返回类型

列表[int]

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

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

参数

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

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

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

  • kwargs (Any) –

返回

Runnable的输出。

返回类型

str

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

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

参数

  • text (str) –

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

  • kwargs (Any) –

返回类型

str

predict_messages(messages: List[BaseMessage], *args, stop: Optional[Sequence[str]] = None, **kwargs) → 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

示例：.. 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]]], 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的额外关键字参数。

  • 停止 (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]]

使用 AnthropicLLM 的示例