`langchain_community.chat_models.litellm`.ChatLiteLLM¶

注意

ChatLiteLLM实现了标准《Runnable 接口》。🏃

《Runnable 接口》还提供了额外的运行时可用的方法，例如with_types, with_retry, assign, bind, get_graph等。

class langchain_community.chat_models.litellm.ChatLiteLLM[source]¶

基类: BaseChatModel

使用LiteLLM API的聊天模型。

param anthropic_api_key: Optional[str] = None¶

param api_base: Optional[str] = None¶

param azure_api_key: Optional[str] = None¶

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

是否缓存响应。

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

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

参数 callback_manager: Optional[BaseCallbackManager] = None¶: （已弃用）要添加到运行跟踪的回调管理器。

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

参数 cohere_api_key: Optional[str] = None¶

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

param custom_llm_provider: Optional[str] = None¶

param max_retries: int = 6¶

param max_tokens: Optional[int] = None¶

param metadata: Optional[Dict[str, Any]] = None¶: 将添加到运行动态的元数据。

param model: str = 'gpt-3.5-turbo'¶

param model_kwargs: Dict[str, Any] [可选]¶: 使用此温度进行推理。必须在闭区间 [0.0, 1.0] 内。

param model_name: Optional[str] = None¶: 要使用的模型名称。

param n: int = 1¶: 为每个提示生成聊天完成内容的数量。请注意，如果生成重复项，API 可能不会返回完整的 n 个完成内容。

param openai_api_key: Optional[str] = None¶

param openrouter_api_key: Optional[str] = None¶

param organization: Optional[str] = None¶

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

param replicate_api_key: Optional[str] = None¶

param request_timeout: Optional[Union[float, Tuple[float, float]]] = None¶

param streaming: bool = False¶

参数 tags: 可选[列表[str]] = None¶: 添加到运行跟踪的标签。

参数 temperature: 可选[浮点数] = 1¶

参数 top_k: 可选[整数] = None¶: 使用 top-k 样本解码：考虑最有可能的 top_k 个标记。必须是正数。

参数 top_p: 可选[浮点数] = None¶: 使用 nucleus 样本解码：考虑概率和至少为 top_p 的最小标记集合。必须在闭区间 [0.0, 1.0] 内。

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

__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]]) –
callbacks (可选[联合[列表[BaseCallbackHandler], BaseCallbackManager]]) –
kwargs (任意类型) –

返回类型

BaseMessage

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

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

默认实现的批处理适用于IO绑定runnables。

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

参数

inputs (列表[Input]) – Runnable的输入列表。
config (可选[Union[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, *, return_exceptions: bool = False, **kwargs: Optional[Any]) → AsyncIterator[Tuple[int, Union[Output, Exception]]]¶

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

参数

inputs (Sequence[Input]) – Runnable的输入列表。
config (Optional[Union[RunnableConfig, Sequence[RunnableConfig]]]) – 调用Runnable时使用的配置。配置支持例如’tags’,'metadata’用于跟踪目的，’max_concurrency’用于控制并行执行的工作量，以及其他键。请参阅RunnableConfig以获取详细信息。默认为None。默认为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的模型。

当您想要

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

参数

消息（列表列表 BaseMessage 列表） - 消息列表的列表。
stop （可选列表列表 str ） - 生成时使用的停止词。当模型输出的第一个子串出现时，输出将被截断。
callbacks （可选联合列表列表 BaseCallbackHandler ， BaseCallbackManager 列表 ]） - 需要传递的回调。用于在整个生成过程中执行附加功能，如记录或流式传输。
**kwargs （任意） - 随意附加关键字参数。这些通常传递给模型提供者API调用。
tags （可选列表列表 str ） -
metadata （可选字典 str ，任意） -
run_name （可选 str） -
run_id （可选 UUID） -
**kwargs –

返回

一个LLMResult，它包含每个输入提示的候选生成列表以及额外的模型提供者特定输出。: prompt 和附加模型提供者特定的输出。

返回类型

LLMResult

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

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

此方法应利用分批调用来支持提供分批API的模型。

当您想要

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

参数

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

返回

一个LLMResult，它包含每个输入提示的候选生成列表以及额外的模型提供者特定输出。: prompt 和附加模型提供者特定的输出。

返回类型

LLMResult

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

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

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

子类应该在其可以异步运行时重写此方法。

参数

输入 (LanguageModelInput) –
配置 (Optional[RunnableConfig]) –
stop (可选[列表[str]]) –
kwargs (任意类型) –

返回类型

BaseMessage

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

自 version langchain-core==0.1.7 已弃用：请使用 ainvoke 代替。

参数

文本 (str) –
停止 (Optional[序列[str]]) –
kwargs (任意类型) –

返回类型

str

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

自 version langchain-core==0.1.7 已弃用：请使用 ainvoke 代替。

参数

messages (列表[BaseMessage]) –
停止 (Optional[序列[str]]) –
kwargs (任意类型) –

返回类型

BaseMessage

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

测试版

此API处于测试版，未来可能会有所变化。

从可运行的组件创建BaseTool。

as_tool 将从一个可运行的实体中实例化一个具有名称、描述和 args_schema 的 BaseTool。尽可能从 runnable.get_input_schema 推断出模式。或者（例如，如果 Runnable 以字典作为输入且特定字典键未指定类型），可以直接通过 args_schema 指定模式。您还可以通过 arg_types 仅指定所需参数及其类型。

参数

args_schema (可选）– 工具的模式。默认为 None。
name (可选）– 工具的名称。默认为 None。
description (可选）– 工具的描述。默认为 None。
arg_types (可选）– 参数名称到类型的字典。默认为 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: Optional[RunnableConfig], *, stop: Optional[List[str]], **kwargs: Any) → AsyncIterator[BaseMessageChunk]

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

参数

input （LanguageModelInput）– Runnable 的输入。
config （可选）– 使用于 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，它提供了关于可运行对象進度的实时信息，包括来自中间結果的StreamEvents。

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

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

以下是一个表格，说明了各种链可能发出的一些事件。为了简洁起见，省略了元数据字段。表格后面的定义包括链定义。

注意本参考表是针对该架构的v2版本。

事件	名称	片断	输入	输出
on_chat_model_start	[模型名称]		{“messages”: [[系统消息，人类消息]]}
on_chat_model_stream	[模型名称]	AIMessageChunk(content=”hello”)
on_chat_model_end	[模型名称]		{“messages”: [[系统消息，人类消息]]}	AIMessageChunk(content=”hello world”)
on_llm_start	[模型名称]		{‘input’: ‘hello’}
on_llm_stream	[模型名称]	‘Hello’
on_llm_end	[模型名称]		‘Hello human!’
on_chain_start	format_docs
on_chain_stream	format_docs	“hello world!, goodbye world!”
on_chain_end	format_docs		[Document(…)]	“hello world!, goodbye world!”
on_tool_start	某些工具		{“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	事件的用户定义名称。
数据	任何	与事件关联的数据。这可以是任何东西，尽管我们建议使其具有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)

参数

input (Any) – Runnable的输入。
config (Optional[RunnableConfig]) – 用于Runnable的配置。
version (Literal['v1', 'v2']) – 要使用的架构版本，可以是v2或v1。用户应使用v2。 v1用于向下兼容，将在0.4.0中弃用。
include_names (Optional[Sequence[str]]) – 仅包括具有匹配名称的runnables的事件。
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绑定runnables。

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

参数

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

返回类型

列表[Output]

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

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

参数

inputs (Sequence[Input]) –
config (Optional[Union[RunnableConfig, Sequence[RunnableConfig]]]) –
return_exceptions (bool) –
kwargs (可选[任何类型]) –

返回类型

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

bind_tools(tools: Sequence[Union[Dict[str, Any], Type[BaseModel], Callable, BaseTool]][], **kwargs: Any) → Runnable[Union[PromptValue, str, Sequence[Union[BaseMessage, List[str], Tuple[str, str], str, Dict[str, Any]]], BaseMessage][source]¶

将类似工具的对象绑定到此聊天模型。

LiteLLM期望以OpenAI格式的tools参数。

参数

tools (Sequence[Union[Dict[str, Any], Type[BaseModel], Callable, BaseTool]]) – 要绑定到该聊天模型的一系列工具定义。可以是字典、Pydantic模式、呼叫或BaseTool。Pydantic模式、可调用和BaseTools将被自动转换为它们的方案字典表示形式。
tool_choice – 模型必须调用的工具。必须是单个提供的函数名称或者“auto”以自动确定要调用的函数（如果有），或者一个形式如下：{"type": "function", "function": {"name": "＜tool_name＞"}}的dict。
**kwargs (Any) – 传递给 Runnable 构造器的任何其他参数。

返回类型

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

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

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

参数

message (str) –

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

kwargs (任意类型) –

返回类型

str

completion_with_retry(run_manager: Optional[CallbackManagerForLLMRun], **kwargs: Any) → Any[source]¶

使用 tenacity 进行重试完成调用。

参数

run_manager (Optional[CallbackManagerForLLMRun]) –

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

返回

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

返回类型

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 列表） - 消息列表的列表。

stop （可选列表列表 str ） - 生成时使用的停止词。当模型输出的第一个子串出现时，输出将被截断。

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

**kwargs （任意） - 随意附加关键字参数。这些通常传递给模型提供者API调用。

tags （可选列表列表 str ） -

metadata （可选字典 str ，任意） -

run_name （可选 str） -

run_id （可选 UUID） -

**kwargs –

返回

一个LLMResult，它包含每个输入提示的候选生成列表以及额外的模型提供者特定输出。
prompt 和附加模型提供者特定的输出。

返回类型

LLMResult

generate_prompt(prompts: List[PromptValue], stop: Optional[List[str]] = None, callbacks: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]] = None, **kwargs: Any) → 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列表，按照它们在文本中出现的顺序排列。: （此处重复了第2点，故不重复翻译）

返回类型

List[int]

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

返回

Runnable 的输出。

返回类型

BaseMessage

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

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

参数

文本 (str) –
停止 (Optional[序列[str]]) –
kwargs (任意类型) –

返回类型

str

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

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

参数

messages (列表[BaseMessage]) –
停止 (Optional[序列[str]]) –
kwargs (任意类型) –

返回类型

BaseMessage

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

stream的默认实现，调用invoke。如果子类支持流式输出，则应该覆盖此方法。

参数

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

产出：

Runnable 的输出。

返回类型

Iterator[BaseMessageChunk]

to_json() → Union[SerializedConstructor, SerializedNotImplemented]¶

将可运行对象序列化为JSON。

返回: 可运行对象的JSON序列化表示。
返回类型: 联合【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”键的字典。
kwargs (任意类型) –

返回

接受与 langchain_core.language_models.chat.BaseChatModel 相同输入的 Runnable。

如果 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.'
# }

使用 ChatLiteLLM 的示例

ChatLiteLLM

langchain_community.chat_models.litellm.ChatLiteLLM¶

使用 ChatLiteLLM 的示例

`langchain_community.chat_models.litellm`.ChatLiteLLM¶