`langchain_nvidia_ai_endpoints.chat_models`.ChatNVIDIA¶

注意

ChatNVIDIA 实现了标准的 Runnable 接口。 🏃

Runnable 接口 具有在 runnables 上可用的其他方法，例如 with_types, with_retry, assign, bind, get_graph, 以及更多。

class langchain_nvidia_ai_endpoints.chat_models.ChatNVIDIA[源代码]¶

基类： BaseChatModel

NVIDIA 聊天模型。

示例

from langchain_nvidia_ai_endpoints import ChatNVIDIA


model = ChatNVIDIA(model="meta/llama2-70b")
response = model.invoke("Hello")

创建一个新的 NVIDIAChat 聊天模型。

此类提供对 NVIDIA NIM 的聊天访问。默认情况下，它连接到托管的 NIM，但可以使用 base_url 参数配置为连接到本地 NIM。连接到托管的 NIM 需要 API 密钥。

参数

model (str) – 用于聊天的模型。
nvidia_api_key (str) – 用于连接到托管 NIM 的 API 密钥。
api_key (str) – nvidia_api_key 的替代方案。
base_url (str) – 要连接的 NIM 的基本 URL。基本 URL 的格式为 http://host:port
temperature (float) – [0, 1] 范围内的采样温度。
max_tokens (int) – 要生成的最大 token 数。
top_p (float) – 用于分布采样的 Top-p 值。
seed (int) – 用于确定性结果的种子。
stop (list[str]) – 不区分大小写的停止词列表。

API 密钥： - 推荐的提供 API 密钥的方式是通过 NVIDIA_API_KEY

环境变量。

param base_url: str [必需]¶: 用于模型列表和调用的基本 URL

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 max_tokens: Optional[int] = 1024¶: 要生成的最大 token 数

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

param model: Optional[str] = None¶: 要调用的模型名称

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

param seed: Optional[int] = None¶: 用于确定性结果的种子

param stop: Optional[Sequence[str]] = None¶: 停止词（区分大小写）

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

param temperature: Optional[float] = None¶: [0, 1] 范围内的采样温度

param top_p: Optional[float] = None¶: 用于分布采样的 Top-p 值

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

__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: 请使用 invoke 代替。

参数

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

返回类型

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。

参数

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

并行运行 ainvoke 处理输入列表，并在结果完成时生成结果。

参数

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

生成

输入索引和来自 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。

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

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

参数

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 –

返回

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

返回类型

LLMResult

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

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

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

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

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

参数

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

返回类型

BaseMessage

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

Deprecated since version 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¶

Deprecated since version 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¶

Beta

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

从 Runnable 创建一个 BaseTool。

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

参数

args_schema (Optional[Type[BaseModel]]) – 工具的模式。默认为 None。
name (Optional[str]) – 工具的名称。默认为 None。
description (Optional[str]) – 工具的描述。默认为 None。
arg_types (Optional[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: LanguageModelInput, config: Optional[RunnableConfig] = None, *, stop: Optional[List[str]] = None, **kwargs">: Any) → AsyncIterator[BaseMessageChunk]¶

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

参数

input (LanguageModelInput) – Runnable 的输入。
config (Optional[RunnableConfig]) – 用于 Runnable 的配置。默认为 None。
kwargs (Any) – 传递给 Runnable 的其他关键字参数。
stop (Optional[List[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]]¶

Beta

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

生成事件流。

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

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

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

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

注意此参考表适用于模式的 V2 版本。

事件	名称	块	输入	输出
on_chat_model_start	[模型名称]		{“messages”: [[SystemMessage, HumanMessage]]}
on_chat_model_stream	[模型名称]	AIMessageChunk(content=”hello”)
on_chat_model_end	[模型名称]		{“messages”: [[SystemMessage, HumanMessage]]}	AIMessageChunk(content=”hello world”)
on_llm_start	[模型名称]		{‘input’: ‘hello’}
on_llm_stream	[模型名称]	‘Hello’
on_llm_end	[模型名称]		‘Hello human!’
on_chain_start	format_docs
on_chain_stream	format_docs	“hello world!, goodbye world!”
on_chain_end	format_docs		[Document(…)]	“hello world!, goodbye world!”
on_tool_start	some_tool		{“x”: 1, “y”: “2”}
on_tool_end	some_tool			{“x”: 1, “y”: “2”}
on_retriever_start	[检索器名称]		{“query”: “hello”}
on_retriever_end	[检索器名称]		{“query”: “hello”}	[Document(…), ..]
on_prompt_start	[模板名称]		{“question”: “hello”}
on_prompt_end	[模板名称]		{“question”: “hello”}	ChatPromptValue(messages: [SystemMessage, …])

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

自定义事件将仅在 API 的 v2 版本中显示！

自定义事件具有以下格式

属性	类型	描述
名称	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)

参数

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]]) – 仅包括来自具有匹配名称的 runnables 的事件。
include_types (Optional[Sequence[str]]) – 仅包括来自具有匹配类型的 runnables 的事件。
include_tags (Optional[Sequence[str]]) – 仅包括来自具有匹配标签的 runnables 的事件。
exclude_names (Optional[Sequence[str]]) – 排除来自具有匹配名称的 runnables 的事件。
exclude_types (Optional[Sequence[str]]) – 排除来自具有匹配类型的 runnables 的事件。
exclude_tags (Optional[Sequence[str]]) – 排除来自具有匹配标签的 runnables 的事件。
kwargs (Any) – 传递给 Runnable 的其他关键字参数。这些将传递给 astream_log，因为 astream_events 的此实现构建在 astream_log 之上。

生成

StreamEvents 的异步流。

Raises

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。

batch 的默认实现适用于 IO 绑定的 runnables。

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

参数

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

返回类型

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，并在完成时产生结果。

参数

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

返回类型

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

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

参数

functions (Sequence[Union[Dict[str, Any], Type[BaseModel], Callable]]) –
function_call (Optional[str]) –
kwargs (Any) –

返回类型

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', 'none', 'any', 'required'], bool]] = None, **kwargs: Any) → Runnable[Union[PromptValue, str, Sequence[Union[BaseMessage, List[str], Tuple[str, str], str, Dict[str, Any]]]], BaseMessage][source]¶

将工具绑定到模型。

参数

tools (list) – 要绑定到模型的工具列表。
(Optional[Union[dict (tool_choice) –

str,
Literal[“auto”, “none”, “any”, “required”], bool]])

控制工具选择。
“any” 和 “required” - 强制工具调用。“auto” - 让模型决定。“none” - 强制不进行工具调用。字符串或字典 - 强制特定的工具调用。布尔值 - 如果为 True，则强制工具调用；如果为 False，则强制不进行工具调用。

默认为不传递值。
tool_choice (Optional[Union[dict, str, Literal['auto', 'none', 'any', 'required'], bool]]) –
kwargs (Any) –

返回类型

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

:paramstr,

Literal[“auto”, “none”, “any”, “required”], bool]])

控制工具选择。: “any” 和 “required” - 强制工具调用。“auto” - 让模型决定。“none” - 强制不进行工具调用。字符串或字典 - 强制特定的工具调用。布尔值 - 如果为 True，则强制工具调用；如果为 False，则强制不进行工具调用。

默认为不传递值。

参数

**kwargs (Any) – 附加的关键字参数。
tools (Sequence[Union[Dict[str, Any], Type[BaseModel], Callable, BaseTool]]) –
tool_choice (Optional[Union[dict, str, Literal['auto', 'none', 'any', 'required'], bool]]) –
**kwargs –

返回类型

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

参见 https://python.langchain.ac.cn/v0.1/docs/modules/model_io/chat/function_calling/#request-forcing-a-tool-call

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

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

参数

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

返回类型

str

configurable_alternatives(which: ConfigurableField, *, default_key: str = 'default', prefix_keys: bool = False, **kwargs: Union[Runnable, Callable[[], Runnable]]) → RunnableSerializable]¶

配置可在运行时设置的 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]¶

在运行时配置特定的 Runnable 字段。

参数: **kwargs (Union[ConfigurableField, ConfigurableFieldSingleOption, ConfigurableFieldMultiOption]) – 要配置的 ConfigurableField 实例的字典。
返回: 配置了字段的新 Runnable。
返回类型: RunnableSerializable[Input, Output]

from langchain_core.runnables import ConfigurableField
from langchain_openai import ChatOpenAI

model = ChatOpenAI(max_tokens=20).configurable_fields(
    max_tokens=ConfigurableField(
        id="output_token_number",
        name="Max tokens in the output",
        description="The maximum number of tokens in the output",
    )
)

# max_tokens = 20
print(
    "max_tokens_20: ",
    model.invoke("tell me something about chess").content
)

# max_tokens = 200
print("max_tokens_200: ", model.with_config(
    configurable={"output_token_number": 200}
    ).invoke("tell me something about chess").content
)

generate(messages: List]List]BaseMessage]], stop: Optional]List] = None, callbacks: Optional]Union[List]BaseCallbackHandler], BaseCallbackManager]] = None, *, tags: Optional]List] = None, metadata: Optional]Dict[str, Any]] = None, run_name: Optional]str] = None, run_id: Optional]UUID] = None, **kwargs: Any) → LLMResult¶

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

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

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

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

参数

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 –

返回

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

返回类型

LLMResult

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

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

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

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

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

参数

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

返回

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

返回类型

LLMResult

classmethod get_available_models(**kwargs: Any) → List]Model][source]¶

获取与 ChatNVIDIA 兼容的可用模型列表。

参数: kwargs (Any) –
返回类型: List[Model]

get_num_tokens(text: str) → int¶

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

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

参数: text (str) – 要标记化的字符串输入。
返回: 文本中 token 的整数数量。
返回类型: int

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

获取消息中的 token 数量。

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

参数: messages (List[BaseMessage]) – 要标记化的消息输入。
返回: 消息中 token 数量的总和。
返回类型: int

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

返回文本中 token 的有序 id。

参数

text (str) – 要标记化的字符串输入。

返回

与文本中的 token 相对应的 id 列表，按照它们在文本中出现的顺序排列。: 在文本中。

返回类型

List[int]

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

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

参数

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

返回

Runnable 的输出。

返回类型

BaseMessage

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

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

参数

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

返回类型

str

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

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

参数

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

返回类型

BaseMessage

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

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

参数

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

生成

Runnable 的输出。

返回类型

Iterator[BaseMessageChunk]

to_json() → Union[SerializedConstructor, SerializedNotImplemented]¶

将 Runnable 序列化为 JSON。

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

with_structured_output(schema: Union[Dict[str, Any], Type[BaseModel], Type[Enum]], *, 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, Enum]][source]¶

绑定结构化输出模式到模型。

模式可以是 -

表示 JSON 模式的字典
Pydantic 对象
枚举 (Enum)

0. 如果提供字典，模型将返回一个字典。示例： ``` json_schema = {

“title”: “joke”, “description”: “给用户讲的笑话。”, “type”: “object”, “properties”: {

“setup”: {
“type”: “string”, “description”: “笑话的铺垫”,

}, “punchline”: {

“type”: “string”, “description”: “笑话的punchline”,

},

}, “required”: [“setup”, “punchline”],

}

structured_llm = llm.with_structured_output(json_schema) structured_llm.invoke(“给我讲一个关于 NVIDIA 的笑话”) # 输出: {‘setup’: ‘为什么 NVIDIA 破产了？硬件吃光了所有的软件。’, # ‘punchline’: ‘它在他们的主板上咬了一大口。’} ```

如果提供 Pydantic 模式，模型将返回一个 Pydantic 对象。示例

``` from langchain_core.pydantic_v1 import BaseModel, Field class Joke(BaseModel)

setup: str = Field(description=”笑话的铺垫”) punchline: str = Field(description=”笑话的punchline”)

structured_llm = llm.with_structured_output(Joke) structured_llm.invoke(“给我讲一个关于 NVIDIA 的笑话”) # 输出: Joke(setup=’为什么 NVIDIA 破产了？硬件吃光了所有的软件。’, # punchline=’它在他们的主板上咬了一大口。’) ```

如果提供枚举 (Enum)，所有值必须是字符串，模型将返回一个枚举 (Enum) 对象。示例

``` import enum class Choices(enum.Enum)

A = “A” B = “B” C = “C”

structured_llm = llm.with_structured_output(Choices) structured_llm.invoke(“这个列表中的第一个字母是什么？ [X, Y, Z, C]”) # 输出: <Choices.C: ‘C’> ```

关于流式处理的注意事项：与其他流式响应不同，流式块将是逐渐完整的。它们不会是增量。最后一个块将包含完整的响应。

例如，对于字典模式，流式块将是： ``` structured_llm = llm.with_structured_output(json_schema) for chunk in structured_llm.stream(“给我讲一个关于 NVIDIA 的笑话”)

print(chunk)

# 输出: # {} # {‘setup’: ‘’} # {‘setup’: ‘为什么’} # {‘setup’: ‘为什么 did’} # {‘setup’: ‘为什么 did N’} # {‘setup’: ‘为什么 did NVID’} # … # {‘setup’: ‘为什么 NVIDIA 破产了？硬件吃光了所有的软件。’, ‘punchline’: ‘它在他们的主板上咬了一大口’} # {‘setup’: ‘为什么 NVIDIA 破产了？硬件吃光了所有的软件。’, ‘punchline’: ‘它在他们的主板上咬了一大口。’} ```

例如，对于 Pydantic 模式，流式块将是： ``` structured_llm = llm.with_structured_output(Joke) for chunk in structured_llm.stream(“给我讲一个关于 NVIDIA 的笑话”)

print(chunk)

# 输出: # setup=’为什么 NVIDIA 破产了？硬件吃光了所有的软件。’ punchline=’’ # setup=’为什么 NVIDIA 破产了？硬件吃光了所有的软件。’ punchline=’它’ # setup=’为什么 NVIDIA 破产了？硬件吃光了所有的软件。’ punchline=’它 took’ # … # setup=’为什么 NVIDIA 破产了？硬件吃光了所有的软件。’ punchline=’它在他们的主板上咬了一大口’ # setup=’为什么 NVIDIA 破产了？硬件吃光了所有的软件。’ punchline=’它在他们的主板上咬了一大口。’ ```

对于 Pydantic 模式和枚举 (Enum)，如果响应不足以构建对象或无效，则输出将为 None。例如， ``` llm = ChatNVIDIA(max_tokens=1) structured_llm = llm.with_structured_output(Joke) print(structured_llm.invoke(“给我讲一个关于 NVIDIA 的笑话”))

# 输出: None ```

参数

schema (Union[Dict[str, Any], Type[BaseModel], Type[Enum]]) –
include_raw (bool) –
kwargs (Any) –

返回类型

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

property available_models: List[Model]¶: 获取与 ChatNVIDIA 兼容的可用模型列表。

langchain_nvidia_ai_endpoints.chat_models.ChatNVIDIA¶

`langchain_nvidia_ai_endpoints.chat_models`.ChatNVIDIA¶