langchain_community.chat_models.huggingface.ChatHuggingFace

注意

ChatHuggingFace 实现了标准 Runnable 接口。🏃

Runnable 接口 具有额外的运行时方法，例如 with_types, with_retry, assign, bind, get_graph 等更多方法。

class langchain_community.chat_models.huggingface.ChatHuggingFace

继承自: BaseChatModel

自版本 0.0.37 开始弃用: 请使用 langchain_huggingface.ChatHuggingFace 代替。

Hugging Face LLM 作为 ChatModel 的包装器。

与 HuggingFaceTextGenInference、HuggingFaceEndpoint 和 HuggingFaceHub LLMs 兼容。

实例化此类时，模型ID将从提供的LLM URL解析，并从HuggingFace Hub加载适当的分词器。

改编自: https://python.langchain.ac.cn/docs/integrations/chat/llama2_chat

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

是否缓存响应。

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

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

• 如果为 None，将使用全局缓存（如果设置），否则不使用缓存。

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

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

param callback_manager: Optional[BaseCallbackManager] = None

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

param callbacks: Callbacks = None

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

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

用于计数的可选编码器。

param llm: Any = None

LLM，必须是 HuggingFaceTextGenInference、HuggingFaceEndpoint 或 HuggingFaceHub 类型。

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

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

param model_id: Optional[str] = None

param rate_limiter: Optional[BaseRateLimiter] = None

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

参数 streaming: 布尔值 = False

参数 system_message: SystemMessage = SystemMessage(content='您是一个有帮助的、尊重的、诚实的助手。')

参数 tags: Optional[List[str]] = None

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

参数 tokenizer: Any = None

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

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

批处理默认实现适合于I/O密集型操作。

如果子类可以实现更有效的批处理，则应重写此方法；例如，如果底层的Runnable使用支持批处理的API。

参数

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

• config (Optional[Union[RunnableConfig, List[RunnableConfig]]]) – 调用Runnable时使用的配置。配置支持用于跟踪的标准密钥，如'tags'、'metadata'，用于控制并行工作量的'max_concurrency'，以及其他密钥。请参阅RunnableConfig获取更多详细信息。默认为None。

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

• kwargs (Optional[Any]) – 将传递给Runnable的附加关键字参数。

返回

从Runnable返回的输出列表。

返回类型

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

并行运行 list 中的 invocations，并在完成时提供结果。

参数

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

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

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

• kwargs (Optional[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¶

以异步方式将一系列提示传递给模型并返回生成结果。

此方法应利用支持批处理调用的模型进行批量调用。

在以下情况下使用此方法：

1. 利用批量调用，

2. 模型不仅需要生成顶部的值，还需要更多的输出。

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

   类型（例如，纯文本完成模型与聊天模型）。

参数

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

• 停止（可选[列表[字符串]]） - 生成时使用的停止词。遇到这些子串中的任何一个，模型输出就会被截断。

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

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

• 标签（可选[列表[字符串]]） -

• 元数据（可选[字典[字符串，任何]]） -

• 运行名称（可选[字符串]） -

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

• **kwargs -

返回

每个输入提示和额外的模型提供者特定输出的候选生成列表的LLMResult

。

返回类型

LLMResult

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

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

此方法应利用支持批处理调用的模型进行批量调用。

在以下情况下使用此方法：

1. 利用批量调用，

2. 模型不仅需要生成顶部的值，还需要更多的输出。

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

   类型（例如，纯文本完成模型与聊天模型）。

参数

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

• 停止（可选[列表[字符串]]） - 生成时使用的停止词。遇到这些子串中的任何一个，模型输出就会被截断。

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

• **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 (可选[列表[字符串]]) –

• kwargs (任何类型) –

返回类型

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

• kwargs (任何类型) –

返回类型

字符串

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

• 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（《可选》）（字符串）- 工具的名称。默认为 None。

• description（《可选》）（字符串）- 工具的描述。默认为 None。

• arg_types（《可选》）（字典《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]})

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

通过 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 加入

（异步）astreamastream(input: LanguageModelInput, config: Optional[RunnableConfig], *, stop: Optional[List[str]] = None, **kwargs: Any) → AsyncIterator[BaseMessageChunk]¶

astream 的默认实现，它调用 ainvoke。子类应该在它们支持流式输出时覆盖此方法。

参数

• input（《语言模型输入》）- Runnable 的输入。

• config（《可选》）（《RunnableConfig》）- 用于 Runnable 的配置。默认为 None。

• kwargs (Any) - 向 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为测试版，未来可能会发生变化。

生成事件流。

用于创建一个迭代器，遍历提供关于 Runnable 进度的实时信息的事件，包括中间结果的 StreamEvents。

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

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

  format: on_[runnable_type]_(start|stream|end).

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

• run_id: str - 与给定执行相关的随机生成的 ID，与发出事件的 Runnable 关联。

  执行作为父 Runnable 执行的一部分调用的子 Runnable 将分配其自己的唯一 ID。

• parent_ids: List[str] - 生成事件的父 Runnable 的 ID。

  根 Runnable 将有一个空列表。父 ID 的顺序是从根到直接父级。仅适用于 API 的 v2 版本。API 的 v1 版本将返回一个空列表。

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

除了标准事件之外，用户还可以调度自定义事件（请参阅以下示例）。

自定义事件仅在 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)

参数

• input (Any) - Runnable 的输入。

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

• 版本 (文字['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]

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

批处理默认实现适合于I/O密集型操作。

如果子类可以实现更有效的批处理，则应重写此方法；例如，如果底层的Runnable使用支持批处理的API。

参数

• inputs (列表[Input]) –

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

• return_exceptions (布尔值) –

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

返回类型

List[Output]

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

在输入列表上并行运行invoke，结果完成时产生。

参数

• inputs (序列[输入]) –

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

• return_exceptions (布尔值) –

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

返回类型

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

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

参数

• tools (序列[联合[字典[字符串, 任何], 类型, 可调用函数, BaseTool]]) –

• kwargs (任何类型) –

返回类型

Runnable[LanguageModelInput, BaseMessage]

call_as_llm(message: str, stop: Optional[列表[字符串]] = None, **kwargs: 任何) → 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]

配置运行时可设定的可替换项。

参数

• 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

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

此方法应利用支持批处理调用的模型进行批量调用。

在以下情况下使用此方法：

1. 利用批量调用，

2. 模型不仅需要生成顶部的值，还需要更多的输出。

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

   类型（例如，纯文本完成模型与聊天模型）。

参数

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

• 停止（可选[列表[字符串]]） - 生成时使用的停止词。遇到这些子串中的任何一个，模型输出就会被截断。

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

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

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

此方法应利用支持批处理调用的模型进行批量调用。

在以下情况下使用此方法：

1. 利用批量调用，

2. 模型不仅需要生成顶部的值，还需要更多的输出。

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

   类型（例如，纯文本完成模型与聊天模型）。

参数

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

• 停止（可选[列表[字符串]]） - 生成时使用的停止词。遇到这些子串中的任何一个，模型输出就会被截断。

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

• **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 列表，按它们在文本中出现的顺序。

。

返回类型

整数列表

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

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

参数

• input（《语言模型输入》）- Runnable 的输入。

• config (可选[RunnableConfig]) – 在调用可运行对象时使用的配置。配置支持标准键，如 '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代替。

参数

• text (str) –

• stop (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]) –

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

• kwargs (任何类型) –

返回类型

BaseMessage

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

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

参数

• input（《语言模型输入》）- Runnable 的输入。

• config（《可选》）（《RunnableConfig》）- 用于 Runnable 的配置。默认为 None。

• kwargs (Any) - 向 Runnable 传递的额外关键字参数。

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

输出

Runnable 的输出。

返回类型

Iterator[BaseMessageChunk]

to_json() → Union[SerializedConstructor, SerializedNotImplemented]¶

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

返回

可序列化为JSON的可执行对象表示。

返回类型

联合[序列化构造函数, 未实现的序列化]

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

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

参数

• schema (Union[Dict, Type]) –

  输出模式。可以传入以下形式：

  • OpenAI函数/工具模式，

  • JSON模式，

  • 类型字典类（支持添加在0.2.26中），

  • 或Pydantic类。

  如果schema是Pydantic类，则模型输出将是该类的Pydantic实例，并且模型生成的字段将使用Pydantic类进行验证。否则，模型输出将是一个字典，不会进行验证。有关如何在指定Pydantic或TypedDict类时正确指定模式字段类型和描述的更多信息，请参阅langchain_core.utils.function_calling.convert_to_openai_tool()。

  自版本0.2.26起更改： 添加了对类型字典类的支持。

• include_raw (bool) – 如果为False，则仅返回解析后的结构化输出。如果在模型输出解析期间发生错误，则将引发错误。如果为True，则同时返回原始模型响应（一个BaseMessage）和解析后的模型响应。如果在输出解析期间发生错误，则将其捕获并返回。最终输出始终是一个具有键“raw”，“parsed”和“parsing_error”的字典。

• kwargs (任何类型) –

返回

一个可运行对象，其输入与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 架构（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 架构（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
# }

示例：字典架构（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.'
# }

使用 ChatHuggingFace 的示例

• Hugging Face