`langchain_groq.chat_models`.ChatGroq¶

注意 (Note)

ChatGroq 实现了标准的 Runnable Interface。 🏃

Runnable Interface 具有在 runnables 上可用的其他方法，例如 with_types、 with_retry、 assign、 bind、 get_graph 等等。

class langchain_groq.chat_models.ChatGroq[source]¶

基类： BaseChatModel

Groq 聊天大型语言模型 API。

要使用，您应该设置环境变量 GROQ_API_KEY 为您的 API 密钥。

任何可以传递给 groq.create 调用的有效参数都可以传入，即使未在此类上显式保存。
设置 (Setup)
安装 langchain-groq 并设置环境变量 GROQ_API_KEY。
pip install -U langchain-groq
export GROQ_API_KEY="your-api-key"
关键初始化参数 — 完成参数 (Key init args — completion params)

model: str
要使用的 Groq 模型名称。例如 “mixtral-8x7b-32768”。

temperature: float
采样温度。范围从 0.0 到 1.0。

max_tokens: Optional[int]
要生成的最大 token 数。

model_kwargs: Dict[str, Any]
保存任何有效的模型参数以进行 create 调用，但未明确指定。

关键初始化参数 — 客户端参数 (Key init args — client params)

timeout: Union[float, Tuple[float, float], Any, None]
请求超时时间。

max_retries: int
最大重试次数。

api_key: Optional[str]
Groq API 密钥。如果未传入，则将从环境变量 GROQ_API_KEY 中读取。

base_url: Optional[str]
API 请求的基本 URL 路径，如果不使用代理或服务模拟器，请留空。

custom_get_token_ids: Optional[Callable[[str], List[int]]]
用于计算 token 的可选编码器。
请参阅参数部分中支持的初始化参数及其描述的完整列表。
实例化 (Instantiate)
from langchain_groq import ChatGroq

llm = ChatGroq(
    model="mixtral-8x7b-32768",
    temperature=0.0,
    max_retries=2,
    # other params...
)
调用 (Invoke)
messages = [
    ("system", "You are a helpful translator. Translate the user
    sentence to French."),
    ("human", "I love programming."),
]
llm.invoke(messages)
AIMessage(content='The English sentence "I love programming" can
be translated to French as "J'aime programmer". The word
"programming" is translated as "programmer" in French.',
response_metadata={'token_usage': {'completion_tokens': 38,
'prompt_tokens': 28, 'total_tokens': 66, 'completion_time':
0.057975474, 'prompt_time': 0.005366091, 'queue_time': None,
'total_time': 0.063341565}, 'model_name': 'mixtral-8x7b-32768',
'system_fingerprint': 'fp_c5f20b5bb1', 'finish_reason': 'stop',
'logprobs': None}, id='run-ecc71d70-e10c-4b69-8b8c-b8027d95d4b8-0')
流式处理 (Stream)
for chunk in llm.stream(messages):
    print(chunk)
content='' id='run-4e9f926b-73f5-483b-8ef5-09533d925853'
content='The' id='run-4e9f926b-73f5-483b-8ef5-09533d925853'
content=' English' id='run-4e9f926b-73f5-483b-8ef5-09533d925853'
content=' sentence' id='run-4e9f926b-73f5-483b-8ef5-09533d925853'
...
content=' program' id='run-4e9f926b-73f5-483b-8ef5-09533d925853'
content='".' id='run-4e9f926b-73f5-483b-8ef5-09533d925853'
content='' response_metadata={'finish_reason': 'stop'}
id='run-4e9f926b-73f5-483b-8ef5-09533d925853
stream = llm.stream(messages)
full = next(stream)
for chunk in stream:
    full += chunk
full
AIMessageChunk(content='The English sentence "I love programming"
can be translated to French as "J'aime programmer".
Here's the breakdown of the sentence:

“J’aime” 是
法语中 “I love” 的等价表达
“programmer” 是法语
不定式，意为 “to program”

因此，字面翻译是

“我喜欢编程”。然而，在英语中，当我们谈论我们喜欢的活动时，我们经常省略 “to”，法语也是如此。因此，“J’aime programmer” 是用法语表达 “I love programming” 的正确且自然的方式。’, response_metadata={‘finish_reason’: ‘stop’}, id=’run-a3c35ac4-0750-4d08-ac55-bfc63805de76’)

异步 (Async)

await llm.ainvoke(messages)

AIMessage(content='The English sentence "I love programming" can
be translated to French as "J'aime programmer". The word
"programming" is translated as "programmer" in French. I hope
this helps! Let me know if you have any other questions.',
response_metadata={'token_usage': {'completion_tokens': 53,
'prompt_tokens': 28, 'total_tokens': 81, 'completion_time':
0.083623752, 'prompt_time': 0.007365126, 'queue_time': None,
'total_time': 0.090988878}, 'model_name': 'mixtral-8x7b-32768',
'system_fingerprint': 'fp_c5f20b5bb1', 'finish_reason': 'stop',
'logprobs': None}, id='run-897f3391-1bea-42e2-82e0-686e2367bcf8-0')

工具调用 (Tool calling)

from langchain_core.pydantic_v1 import BaseModel, Field

class GetWeather(BaseModel):
    '''Get the current weather in a given location'''

    location: str = Field(..., description="The city and state,
    e.g. San Francisco, CA")

class GetPopulation(BaseModel):
    '''Get the current population in a given location'''

    location: str = Field(..., description="The city and state,
    e.g. San Francisco, CA")

model_with_tools = llm.bind_tools([GetWeather, GetPopulation])
ai_msg = model_with_tools.invoke("What is the population of NY?")
ai_msg.tool_calls

[{'name': 'GetPopulation',
'args': {'location': 'NY'},
'id': 'call_bb8d'}]

有关更多信息，请参阅 ChatGroq.bind_tools() 方法。

结构化输出 (Structured output)

from typing import Optional

from langchain_core.pydantic_v1 import BaseModel, Field

class Joke(BaseModel):
    '''Joke to tell user.'''

    setup: str = Field(description="The setup of the joke")
    punchline: str = Field(description="The punchline to the joke")
    rating: Optional[int] = Field(description="How funny the joke
    is, from 1 to 10")

structured_model = llm.with_structured_output(Joke)
structured_model.invoke("Tell me a joke about cats")

Joke(setup="Why don't cats play poker in the jungle?",
punchline='Too many cheetahs!', rating=None)

有关更多信息，请参阅 ChatGroq.with_structured_output()。

响应元数据 (Response metadata)

ai_msg = llm.invoke(messages)
ai_msg.response_metadata

{'token_usage': {'completion_tokens': 70,
'prompt_tokens': 28,
'total_tokens': 98,
'completion_time': 0.111956391,
'prompt_time': 0.007518279,
'queue_time': None,
'total_time': 0.11947467},
'model_name': 'mixtral-8x7b-32768',
'system_fingerprint': 'fp_c5f20b5bb1',
'finish_reason': 'stop',
'logprobs': None}

param 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¶: 用于计算 token 的可选编码器。

param default_headers: Union[(Mapping[(str, str], None] = None¶

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

param groq_api_base: Optional[(str] = None (别名 'base_url')¶: API 请求的基本 URL 路径，如果不使用代理或服务模拟器，请留空。

param groq_api_key: Optional[(SecretStr] = None (别名 'api_key')¶

如果未提供，则自动从环境变量 GROQ_API_KEY 推断。

约束 (Constraints)

type = string
writeOnly = True
format = password

param groq_proxy: Optional[(str] = None¶

param http_async_client: Union[(Any, None] = None¶: 可选的 httpx.AsyncClient。仅用于异步调用。如果您想要用于同步调用的自定义客户端，则还必须指定 http_client。

param http_client: Union[(Any, None] = None¶: 可选的 httpx.Client。

param max_retries: int = 2¶: 生成时要进行的最大重试次数。

param max_tokens: Optional[(int] = None¶: 要生成的最大 token 数。

param metadata: Optional[(Dict[(str, Any]] = None¶: 要添加到运行轨迹的元数据。

param model_kwargs: Dict[(str, Any] [可选 (Optional)]¶: 保存任何有效的模型参数以进行 create 调用，但未明确指定。

param model_name: str = 'mixtral-8x7b-32768' (别名 'model')¶: 要使用的模型名称。

param n: int = 1¶: 为每个 prompt 生成的聊天完成次数。

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

param request_timeout: Union[(float, Tuple[(float, float], Any, None] = None (别名 'timeout')¶: 对 Groq 完成 API 的请求超时时间。可以是 float、httpx.Timeout 或 None。

param stop: Optional[(Union[(List[(str], str]] = None (别名 'stop_sequences')¶: 默认停止序列。

param streaming: bool = False¶: 是否流式传输结果。

param tags: Optional[(List[(str]] = None¶: 要添加到运行轨迹的标签。

param temperature: float = 0.7¶: 要使用的采样温度。

param verbose: bool [可选 (Optional)]¶: 是否打印输出响应文本。

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

Deprecated since version langchain-core==0.1.7: 自 langchain-core==0.1.7 版本起已弃用: 请改用 invoke。

参数 (Parameters)

messages (List[BaseMessage]) –
stop (Optional[List[str]]) –
callbacks (Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]]) –
kwargs (Any) –

返回类型 (Return type)

BaseMessage

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

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

batch 的默认实现非常适合 IO 绑定的 runnables。

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

参数 (Parameters)

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 的其他关键字参数。

返回 (Returns)

Runnable 的输出列表。

返回类型 (Return type)

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

在一系列输入上并行运行 ainvoke，并在它们完成时产生结果。

参数 (Parameters)

inputs (Sequence[Input]) – Runnable 的输入列表。
config (Optional[Union[RunnableConfig, Sequence[RunnableConfig]]]) – 调用 Runnable 时要使用的配置。该配置支持标准键，如用于跟踪目的的 ‘tags’、‘metadata’，用于控制并行执行量的 ‘max_concurrency’，以及其他键。有关更多详细信息，请参阅 RunnableConfig。默认为 None。默认为 None。
return_exceptions (bool) – 是否返回异常而不是引发异常。默认为 False。
kwargs (Optional[Any]) – 要传递给 Runnable 的其他关键字参数。

产出 (Yields)

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

返回类型 (Return type)

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 的模型。

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

利用批量调用，
需要从模型获得比仅仅是最佳生成值更多的输出，
正在构建与底层语言模型无关的链
类型（例如，纯文本完成模型与聊天模型）。

参数 (Parameters)

messages (List[List[BaseMessage]]) – 消息列表的列表。
stop (Optional[List[str]]) – 生成时使用的停止词。模型输出在首次出现任何这些子字符串时被截断。
callbacks (Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]]) – 要传递的回调。用于在整个生成过程中执行额外的功能，例如日志记录或流式传输。
**kwargs (Any) – 任意额外的关键字参数。这些通常会传递给模型提供商 API 调用。
tags (Optional[List[str]]) –
metadata (Optional[Dict[str, Any]]) –
run_name (Optional[str]) –
run_id (Optional[UUID]) –
**kwargs –

返回 (Returns)

一个 LLMResult，其中包含每个输入的候选 Generations 列表: 提示和额外的模型提供商特定的输出。

返回类型 (Return type)

LLMResult

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

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

此方法应利用批量调用，以用于公开批量 API 的模型。

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

利用批量调用，
需要从模型获得比仅仅是最佳生成值更多的输出，
正在构建与底层语言模型无关的链
类型（例如，纯文本完成模型与聊天模型）。

参数 (Parameters)

prompts (List[PromptValue]) – PromptValues 列表。PromptValue 是一个可以转换为匹配任何语言模型格式的对象（纯文本生成模型的字符串和聊天模型的 BaseMessages）。
stop (Optional[List[str]]) – 生成时使用的停止词。模型输出在首次出现任何这些子字符串时被截断。
callbacks (Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]]) – 要传递的回调。用于在整个生成过程中执行额外的功能，例如日志记录或流式传输。
**kwargs (Any) – 任意额外的关键字参数。这些通常会传递给模型提供商 API 调用。

返回 (Returns)

一个 LLMResult，其中包含每个输入的候选 Generations 列表: 提示和额外的模型提供商特定的输出。

返回类型 (Return type)

LLMResult

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

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

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

如果子类可以异步运行，则应覆盖此方法。

参数 (Parameters)

input (LanguageModelInput) –
config (Optional[RunnableConfig]) –
stop (Optional[List[str]]) –
kwargs (Any) –

返回类型 (Return type)

BaseMessage

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

Deprecated since version langchain-core==0.1.7: 请使用 ainvoke 代替。

参数 (Parameters)

text (str) –
stop (Optional[Sequence[str]]) –
kwargs (Any) –

返回类型 (Return type)

str

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

Deprecated since version langchain-core==0.1.7: 请使用 ainvoke 代替。

参数 (Parameters)

messages (List[BaseMessage]) –
stop (Optional[Sequence[str]]) –
kwargs (Any) –

返回类型 (Return type)

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¶

Beta

此 API 处于 Beta 阶段，未来可能会发生变化。

从 Runnable 创建 BaseTool。

as_tool 将从 Runnable 实例化一个具有名称、描述和 args_schema 的 BaseTool。在可能的情况下，架构是从 runnable.get_input_schema 推断出来的。或者（例如，如果 Runnable 接受 dict 作为输入，并且未键入特定的 dict 键），则可以使用 args_schema 直接指定架构。您还可以传递 arg_types 以仅指定必需的参数及其类型。

参数 (Parameters)

args_schema (Optional[Type[BaseModel]]) – 工具的架构。默认为 None。
name (Optional[str]) – 工具的名称。默认为 None。
description (Optional[str]) – 工具的描述。默认为 None。
arg_types (Optional[Dict[str, Type]]) – 参数名称到类型的字典。默认为 None。

返回 (Returns)

一个 BaseTool 实例。

返回类型 (Return type)

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] = None, *, stop: Optional[List[str]] = None, **kwargs: Any) → AsyncIterator[BaseMessageChunk]¶

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

参数 (Parameters)

input (LanguageModelInput) – Runnable 的输入。
config (Optional[RunnableConfig]) – Runnable 要使用的配置。默认为 None。
kwargs (Any) – 要传递给 Runnable 的其他关键字参数。
stop (Optional[List[str]]) –

产出 (Yields)

Runnable 的输出。

返回类型 (Return type)

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

Beta

此 API 处于 Beta 阶段，未来可能会发生变化。

生成事件流。

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

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

event: str - 事件名称的格式为：
format: on_[runnable_type]_(start|stream|end)。
name: str - 生成事件的 Runnable 的名称。
run_id: str - 随机生成的 ID，与给定 Runnable 执行相关联，该 Runnable 发出事件。作为父 Runnable 执行一部分调用的子 Runnable 将分配其自己的唯一 ID。
Runnable 发出事件。作为父 Runnable 执行的一部分调用的子 Runnable 将分配其自己的唯一 ID。
parent_ids: List[str] - 生成事件的父 runnable 的 ID 列表。根 Runnable 将具有一个空列表。父 ID 的顺序是从根到直接父级。仅适用于 API 的 v2 版本。API 的 v1 版本将返回一个空列表。
generated the event. The root Runnable will have an empty list. The order of the parent IDs is from the root to the immediate parent. Only available for v2 version of the API. The v1 version of the API will return an empty list.
tags: Optional[List[str]] - 生成事件的 Runnable 的标签。
the event.
metadata: Optional[Dict[str, Any]] - 生成事件的 Runnable 的元数据。
that generated the event.
data: Dict[str, Any]

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

注意此参考表适用于架构的 V2 版本。

event	name	chunk	input	output
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 的 v2 版本中显示！

自定义事件具有以下格式

属性	类型	描述
name	str	事件的用户定义名称。
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}

prompt:

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)

参数 (Parameters)

input (Any) – Runnable 的输入。
config (Optional[RunnableConfig]) – Runnable 要使用的配置。
version (Literal['v1', 'v2']) – 要使用的架构版本，v2 或 v1。用户应使用 v2。v1 用于向后兼容，将在 0.4.0 中弃用。在 API 稳定之前，不会分配默认值。自定义事件将仅在 v2 中显示。
include_names (Optional[Sequence[str]]) – 仅包含来自具有匹配名称的 runnable 的事件。
include_types (Optional[Sequence[str]]) – 仅包含来自具有匹配类型的 runnable 的事件。
include_tags (Optional[Sequence[str]]) – 仅包含来自具有匹配标签的 runnable 的事件。
exclude_names (Optional[Sequence[str]]) – 排除来自具有匹配名称的 runnable 的事件。
exclude_types (Optional[Sequence[str]]) – 排除来自具有匹配类型的 runnable 的事件。
exclude_tags (Optional[Sequence[str]]) – 排除来自具有匹配标签的 runnable 的事件。
kwargs (Any) – 要传递给 Runnable 的其他关键字参数。这些将传递给 astream_log，因为此 astream_events 的实现构建在 astream_log 之上。

产出 (Yields)

StreamEvents 的异步流。

Raises

NotImplementedError – 如果版本不是 v1 或 v2，则引发此错误。

返回类型 (Return type)

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。

batch 的默认实现非常适合 IO 绑定的 runnables。

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

参数 (Parameters)

inputs (List[Input]) –
config (Optional[Union[RunnableConfig, List[RunnableConfig]]]) –
return_exceptions (bool) –
kwargs (Optional[Any]) –

返回类型 (Return type)

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

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

参数 (Parameters)

inputs (Sequence[Input]) –
config (Optional[Union[RunnableConfig, Sequence[RunnableConfig]]]) –
return_exceptions (bool) –
kwargs (Optional[Any]) –

返回类型 (Return type)

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

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

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

模型与 OpenAI 函数调用 API 兼容。

注意：建议改用 bind_tools，因为 functions 和: function_call 请求参数已正式弃用。

参数 (Parameters)

functions (Sequence[Union[Dict[str, Any], Type[BaseModel], Callable, BaseTool]]) – 要绑定到此聊天模型的函数定义列表。可以是字典、Pydantic 模型或可调用对象。Pydantic 模型和可调用对象将自动转换为其模式字典表示形式。
function_call (Optional[Union[_FunctionCall, str, Literal['auto', 'none']]]) – 需要模型调用的函数。必须是提供的单个函数的名称，或 “auto” 以自动确定要调用的函数（如果有）。
**kwargs (Any) – 传递给 Runnable 构造函数的任何其他参数。

返回类型 (Return type)

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[BaseModel], Callable, BaseTool]], *, tool_choice: Optional[Union[dict, str, Literal['auto', 'any', 'none']]] = None, **kwargs: Any) → Runnable[Union[PromptValue, str, Sequence]]][source]¶

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

参数 (Parameters)

tools (Sequence[Union[Dict[str, Any], Type[BaseModel], Callable, BaseTool]]) – 要绑定到此聊天模型的工具定义列表。支持 langchain_core.utils.function_calling.convert_to_openai_tool() 处理的任何工具定义。
tool_choice (Optional[Union[dict, str, Literal['auto', 'any', 'none'], bool]]) – 需要模型调用的工具。必须是提供的单个函数的名称，“auto” 以自动确定要调用的函数（可以选择不调用任何函数），“any” 以强制调用某些函数，或以下形式的字典：{“type”: “function”, “function”: {“name”: <<tool_name>>}}。
**kwargs (Any) – 传递给 Runnable 构造函数的任何其他参数。

返回类型 (Return type)

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

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

Deprecated since version langchain-core==0.1.7: 自 langchain-core==0.1.7 版本起已弃用: 请改用 invoke。

参数 (Parameters)

message (str) –
stop (Optional[List[str]]) –
kwargs (Any) –

返回类型 (Return type)

str

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 的备选项。

参数 (Parameters)

which (ConfigurableField) – 将用于选择备选项的 ConfigurableField 实例。
default_key (str) – 如果未选择备选项，则使用的默认键。默认为 “default”。
prefix_keys (bool) – 是否为键添加 ConfigurableField id 前缀。默认为 False。
**kwargs (Union[Runnable[Input, Output], Callable[[], Runnable[Input, Output]]]) – 键到 Runnable 实例或返回 Runnable 实例的可调用对象的字典。

返回 (Returns)

配置了备选项的新 Runnable。

返回类型 (Return type)

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 字段。

参数 (Parameters): **kwargs (Union[ConfigurableField, ConfigurableFieldSingleOption, ConfigurableFieldMultiOption]) – 要配置的 ConfigurableField 实例的字典。
返回 (Returns): 配置了字段的新 Runnable。
返回类型 (Return type): 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 的模型。

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

利用批量调用，
需要从模型获得比仅仅是最佳生成值更多的输出，
正在构建与底层语言模型无关的链
类型（例如，纯文本完成模型与聊天模型）。

参数 (Parameters)

messages (List[List[BaseMessage]]) – 消息列表的列表。
stop (Optional[List[str]]) – 生成时使用的停止词。模型输出在首次出现任何这些子字符串时被截断。
callbacks (Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]]) – 要传递的回调。用于在整个生成过程中执行额外的功能，例如日志记录或流式传输。
**kwargs (Any) – 任意额外的关键字参数。这些通常会传递给模型提供商 API 调用。
tags (Optional[List[str]]) –
metadata (Optional[Dict[str, Any]]) –
run_name (Optional[str]) –
run_id (Optional[UUID]) –
**kwargs –

返回 (Returns)

一个 LLMResult，其中包含每个输入的候选 Generations 列表: 提示和额外的模型提供商特定的输出。

返回类型 (Return type)

LLMResult

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

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

此方法应利用批量调用，以用于公开批量 API 的模型。

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

利用批量调用，
需要从模型获得比仅仅是最佳生成值更多的输出，
正在构建与底层语言模型无关的链
类型（例如，纯文本完成模型与聊天模型）。

参数 (Parameters)

prompts (List[PromptValue]) – PromptValues 列表。PromptValue 是一个可以转换为匹配任何语言模型格式的对象（纯文本生成模型的字符串和聊天模型的 BaseMessages）。
stop (Optional[List[str]]) – 生成时使用的停止词。模型输出在首次出现任何这些子字符串时被截断。
callbacks (Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]]) – 要传递的回调。用于在整个生成过程中执行额外的功能，例如日志记录或流式传输。
**kwargs (Any) – 任意额外的关键字参数。这些通常会传递给模型提供商 API 调用。

返回 (Returns)

一个 LLMResult，其中包含每个输入的候选 Generations 列表: 提示和额外的模型提供商特定的输出。

返回类型 (Return type)

LLMResult

get_num_tokens(text: str) → int¶

获取文本中存在的 token 数量。

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

参数 (Parameters): text (str) – 要进行 token 化的字符串输入。
返回 (Returns): 文本中 token 的整数数量。
返回类型 (Return type): int

get_num_tokens_from_messages(messages: List[BaseMessage]) → int¶

获取消息中的 token 数量。

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

参数 (Parameters): messages (List[BaseMessage]) – 要进行 token 化的消息输入列表。
返回 (Returns): 所有消息的 token 数量总和。
返回类型 (Return type): int

get_token_ids(text: str) → List[int]¶

返回文本中 token 的有序 ID 列表。

参数 (Parameters)

text (str) – 要进行 token 化的字符串输入。

返回 (Returns)

一个 ID 列表，对应于文本中的 token，按照它们在文本中出现的顺序排列: 在文本中。

返回类型 (Return type)

List[int]

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

将单个输入转换为输出。重写此方法以实现自定义逻辑。

参数 (Parameters)

input (LanguageModelInput) – Runnable 的输入。
config (Optional[RunnableConfig]) – 调用 Runnable 时使用的配置。该配置支持标准键，例如用于追踪目的的 ‘tags’、‘metadata’，用于控制并行执行量的 ‘max_concurrency’，以及其他键。请参阅 RunnableConfig 以获取更多详细信息。
stop (Optional[List[str]]) –
kwargs (Any) –

返回 (Returns)

Runnable 的输出。

返回类型 (Return type)

BaseMessage

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

Deprecated since version langchain-core==0.1.7: 自 langchain-core==0.1.7 版本起已弃用: 请改用 invoke。

参数 (Parameters)

text (str) –
stop (Optional[Sequence[str]]) –
kwargs (Any) –

返回类型 (Return type)

str

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

Deprecated since version langchain-core==0.1.7: 自 langchain-core==0.1.7 版本起已弃用: 请改用 invoke。

参数 (Parameters)

messages (List[BaseMessage]) –
stop (Optional[Sequence[str]]) –
kwargs (Any) –

返回类型 (Return type)

BaseMessage

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

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

参数 (Parameters)

input (LanguageModelInput) – Runnable 的输入。
config (Optional[RunnableConfig]) – Runnable 要使用的配置。默认为 None。
kwargs (Any) – 要传递给 Runnable 的其他关键字参数。
stop (Optional[List[str]]) –

产出 (Yields)

Runnable 的输出。

返回类型 (Return type)

Iterator[BaseMessageChunk]

to_json() → Union[SerializedConstructor, SerializedNotImplemented]¶

将 Runnable 序列化为 JSON。

返回 (Returns): Runnable 的 JSON 可序列化表示形式。
返回类型 (Return type): Union[SerializedConstructor, SerializedNotImplemented]

with_structured_output(schema: Optional[Union[Dict, Type[BaseModel]]] = None, *, method: Literal['function_calling', 'json_mode'] = 'function_calling', include_raw: bool = False, **kwargs:: Any) → Runnable[Union[PromptValue, str, Sequence[Union[BaseMessage, List[str], Tuple[str, str], str, Dict[str, Any]]]], Union[Dict, BaseModel]][source]¶

模型包装器，返回根据给定 schema 格式化的输出。

Args

schema

输出 schema。可以作为以下形式传入：

OpenAI 函数/工具 schema，

JSON Schema，

TypedDict 类 (在 0.1.9 版本中添加支持)，

或 Pydantic 类。

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

在 0.1.9 版本中变更: 添加了对 TypedDict 类的支持。

method
用于引导模型生成的方法，可以是 “function_calling” 或 “json_mode”。如果为 “function_calling”，则 schema 将被转换为 OpenAI 函数，并且返回的模型将使用函数调用 API。如果为 “json_mode”，则将使用 OpenAI 的 JSON 模式。请注意，如果使用 “json_mode”，则必须在模型调用中包含将输出格式化为所需 schema 的说明。

include_raw
如果为 False，则仅返回解析后的结构化输出。如果在模型输出解析期间发生错误，则会引发错误。如果为 True，则将返回原始模型响应 (BaseMessage) 和解析后的模型响应。如果在输出解析期间发生错误，也会捕获并返回错误。最终输出始终是一个带有键 “raw”、“parsed” 和 “parsing_error” 的 dict。

返回 (Returns)
一个 Runnable，它接受与 langchain_core.language_models.chat.BaseChatModel 相同的输入。

如果 include_raw 为 False 且 schema 是 Pydantic 类，则 Runnable 输出 schema 的实例（即，一个 Pydantic 对象）。

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

如果 include_raw 为 True，则 Runnable 输出一个带有以下键的 dict

"raw": BaseMessage

"parsed": 如果存在解析错误，则为 None，否则类型取决于上面描述的 schema。

"parsing_error": Optional[BaseException]

示例：schema=Pydantic 类，method=”function_calling”，include_raw=False
from typing import Optional

from langchain_groq import ChatGroq
from langchain_core.pydantic_v1 import BaseModel, Field


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

    answer: str
    # If we provide default values and/or descriptions for fields, these will be passed
    # to the model. This is an important part of improving a model's ability to
    # correctly return structured outputs.
    justification: Optional[str] = Field(
        default=None, description="A justification for the answer."
    )


llm = ChatGroq(model="llama-3.1-405b-reasoning", 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.'
# )
示例：schema=Pydantic 类，method=”function_calling”，include_raw=True
from langchain_groq import ChatGroq
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 = ChatGroq(model="llama-3.1-405b-reasoning", 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
# }
示例：schema=TypedDict 类，method=”function_calling”，include_raw=False
# IMPORTANT: If you are using Python <=3.8, you need to import Annotated
# from typing_extensions, not from typing.
from typing_extensions import Annotated, TypedDict

from langchain_groq import ChatGroq


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

    answer: str
    justification: Annotated[
        Optional[str], None, "A justification for the answer."
    ]


llm = ChatGroq(model="llama-3.1-405b-reasoning", temperature=0)
structured_llm = llm.with_structured_output(AnswerWithJustification)

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.'
# }
示例：schema=OpenAI 函数 schema，method=”function_calling”，include_raw=False
 from langchain_groq import ChatGroq

 oai_schema = {
     'name': 'AnswerWithJustification',
     'description': 'An answer to the user question along with justification for the answer.',
     'parameters': {
         'type': 'object',
         'properties': {
             'answer': {'type': 'string'},
             'justification': {'description': 'A justification for the answer.', 'type': 'string'}
         },
        'required': ['answer']
    }
}

 llm = ChatGroq(model="llama-3.1-405b-reasoning", temperature=0)
 structured_llm = llm.with_structured_output(oai_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.'
 # }
示例：schema=Pydantic 类，method=”json_mode”，include_raw=True
from langchain_groq import ChatGroq
from langchain_core.pydantic_v1 import BaseModel

class AnswerWithJustification(BaseModel):
    answer: str
    justification: str

llm = ChatGroq(model="llama-3.1-405b-reasoning", temperature=0)
structured_llm = llm.with_structured_output(
    AnswerWithJustification,
    method="json_mode",
    include_raw=True
)

structured_llm.invoke(
    "Answer the following question. "
    "Make sure to return a JSON blob with keys 'answer' and 'justification'.

“

“一磅砖头和一磅羽毛哪个更重？”

) # -> { # ‘raw’: AIMessage(content=’{

“answer”: “它们的重量相同。”, “justification”: “一磅砖头和一磅羽毛都重一磅。区别在于材料的体积和密度，而不是重量。”

}’),

# ‘parsed’: AnswerWithJustification(answer=’它们的重量相同。’, justification=’一磅砖头和一磅羽毛都重一磅。区别在于材料的体积和密度，而不是重量。’), # ‘parsing_error’: None # }

示例：schema=None，method=”json_mode”，include_raw=True

structured_llm = llm.with_structured_output(method="json_mode", include_raw=True)

structured_llm.invoke(
    "Answer the following question. "
    "Make sure to return a JSON blob with keys 'answer' and 'justification'.

“: “一磅砖头和一磅羽毛哪个更重？”

) # -> { # ‘raw’: AIMessage(content=’{

“answer”: “它们的重量相同。”, “justification”: “一磅砖头和一磅羽毛都重一磅。区别在于材料的体积和密度，而不是重量。”
}’),: # ‘parsed’: { # ‘answer’: ‘它们的重量相同。’, # ‘justification’: ‘一磅砖头和一磅羽毛都重一磅。区别在于材料的体积和密度，而不是重量。’ # }, # ‘parsing_error’: None # }

参数 (Parameters)

schema (Optional[Union[Dict, Type[BaseModel]]]) –
method (Literal['function_calling', 'json_mode']) –
include_raw (bool) –
kwargs (Any) –

返回类型 (Return type)

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

langchain_groq.chat_models.ChatGroq¶

ChatGroq 使用示例¶

`langchain_groq.chat_models`.ChatGroq¶