langchain_openai.llms.azure.AzureOpenAI

注意

AzureOpenAI实现标准的Runnable Interface。🏃

Runnable Interface还具有运行时方法，如with_types、with_retry、assign、bind和更多。

class langchain_openai.llms.azure.AzureOpenAI[source]

基类: BaseOpenAI

Azure特定的OpenAI大型语言模型。

要使用，你应该已安装openaipython包，并将环境变量OPENAI_API_KEY设置为你的API密钥。

可以传递给openai.create调用的任何有效参数都可以传递，即使这些参数在此类中未明确保存。

示例

from langchain_openai import AzureOpenAI

openai = AzureOpenAI(model_name="gpt-3.5-turbo-instruct")
param allowed_special: Union[Literal['all'], AbstractSet[str]] = {}

允许的特殊令牌集合。

param azure_ad_token: Optional[SecretStr] = None

您的 Azure Active Directory 令牌。

如未提供，则自动从环境变量 AZURE_OPENAI_AD_TOKEN 中推断出。

更多信息：https://www.microsoft.com/en-us/security/business/identity-access/microsoft-entra-id.

约束

  • 类型 = 字符串

  • 只写 = True

  • 格式 = 密码

param azure_ad_token_provider: Union[Callable[[], str], None] = None

返回 Azure Active Directory 令牌的函数。

将在每次请求时调用。

param azure_endpoint: Union[str, None] = None

您的 Azure 端点，包括资源。

如未提供，则自动从环境变量 AZURE_OPENAI_ENDPOINT 中推断出。

示例： https://example-resource.azure.openai.com/

param batch_size: int = 20

传递多个文档以生成时的批量大小。

param best_of: int = 1

在服务器端生成 best_of 完成并返回“最佳”的结果。

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

是否缓存响应。

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

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

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

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

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

参数 callback_manager: Optional[BaseCallbackManager] = None

（已弃用）

参数 callbacks: Callbacks = None

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

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

用于计算token的可选编码器。

参数 default_headers: Union[Mapping[str, str], None] = None
参数 default_query: Union[Mapping[str, object], None] = None
参数 deployment_name: Union[str, None] = None (别名: azure_deployment)

模型部署。

如果提供了，则将基本客户端URL设置为包含/deployments/{azure_deployment}。注意：这意味着您将无法使用非部署端点。

参数 disallowed_special: Union[Literal['all'], Collection[str]] = 'all'

不允许的特殊令牌集合。

参数 extra_body: Optional[Mapping[str, Any]] = None

可选的附加JSON属性，在调用OpenAI兼容API（如vLLM）时包含在请求参数中。

参数 frequency_penalty: float = 0

根据频率惩罚重复的令牌。

参数 http_async_client: Union[Any, None] = None

可选的httpx.AsyncClient。仅用于异步调用。如果您还想为同步调用指定自定义客户端，则必须指定http_client。

参数 http_client: Union[Any, None] = None

可选的 httpx.Client。仅供同步调用使用。如果您希望为异步调用自定义客户端，还必须指定 http_async_client。

参数 logit_bias: Optional[Dict[str, float]] [可选]

调整特定令牌被生成的概率。

参数 logprobs: Optional[int] = None

将最可能的输出令牌的日志概率以及选中的令牌上的日志概率包括在内。

参数 max_retries: int = 2

生成时的最大重试次数。

参数 max_tokens: int = 256

在补全中生成最多令牌数。由于提示和模型最大上下文大小，-1 返回尽可能多的令牌。

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

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

参数 model_kwargs: Dict[str, Any] [可选]

包含任何有效的模型参数，这些参数对于 create 调用不是显式指定的。

参数 model_name: str = 'gpt-3.5-turbo-instruct' (别名 'model')

使用的模型名称。

参数 n: int = 1

每个提示生成的完成数量。

参数 openai_api_base: Optional[str] = None (别名 'base_url')

API请求的基础URL路径，如果不使用代理或服务模拟器，则留空。

参数 openai_api_key: Optional[SecretStr] = None (别名 'api_key')

如果没有提供，将从环境变量 AZURE_OPENAI_API_KEY 自动推断。

约束

  • 类型 = 字符串

  • 只写 = True

  • 格式 = 密码

参数 openai_api_type: str = ''

适用于openai <1.0.0版本的支持。

参数 openai_api_version: str = '' (别名 'api_version')

如果没有提供，将从环境变量 OPENAI_API_VERSION 自动推断。

参数 openai_organization: Optional[str] = None (别名 'organization')

如果没有提供，将从环境变量 OPENAI_ORG_ID 自动推断。

param openai_proxy: Optional[str] = None
param presence_penalty: float = 0

惩罚重复的令牌。

param request_timeout: Union[float, Tuple[float, float], Any, None] = None (alias 'timeout')

对 OpenAI 完成API的请求超时。可以是浮点数、httpx.Timeout或None。

param seed: Optional[int] = None

生成的种子。

param streaming: bool = False

是否以流的形式输出结果。

param tags: Optional[List[str]] = None

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

param temperature: float = 0.7

使用的采样温度。

参数 tiktoken_model_name: Optional[str] = None

在使用此类时传递给tiktoken的模型名称。Tiktoken用于计算文档中的令牌数，以限制其不超过某个限制。默认情况下，当设置为None时，将与嵌入模型的名称相同。但是，在某些情况下，您可能希望使用此嵌入类与tiktoken不支持的模型名称。这包括在使用Azure嵌入或在使用许多公开类似OpenAI API但具有不同模型的模型提供者时。在这些情况下，为了避免在调用tiktoken时出现问题，您可以在此处指定要使用的模型名称。

参数 top_p: float = 1

每个步骤中应考虑的令牌的总概率质量。

参数 validate_base_url: bool = True

为了向后兼容。如果传入旧版val openai_api_base，尝试推断它是base_url还是azure_endpoint，并相应地更新。

参数 verbose: bool [Optional]

是否打印输出响应文本。

__call__(prompt: str, stop: Optional[List[str]] = None, callbacks: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager] = None, *, tags: Optional[List[str]] = None, metadata: Optional[Dict[str, Any]] = None, **kwargs: Any) → str

自版本 langchain-core==0.1.7 起已弃用: 请使用 invoke 代替。

检查缓存并在给定的提示和输入上运行LLM。

参数

  • prompt （str） – 要生成的提示。

  • stop （可选[List[str]]） – 在生成时使用的停用词。当模型输出中出现这些子字符串中的任何一个时，输出将截断。

  • callbacks （可选[Union[List[BaseCallbackHandler], BaseCallbackManager]） – 要传递的回调。用于在生成过程中执行附加功能，如记录或流式传输。

  • tags （可选[List[str]]） – 与提示关联的标签列表。

  • 元数据 (可选]Dict[str, Any]) – 与提示关联的元数据。

  • **kwargs (Any) – 任意附加的keyword参数。这些参数通常传递给模型提供商的API调用。

返回

生成的文本。

抛出异常

ValueError – 如果提示不是一个字符串。

返回类型

str

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

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

默认的批处理实现适用于IO密集型的可运行程序。

如果子类能够更高效地批处理，则应覆盖此方法；例如，如果底层可运行程序使用支持批处理模式的API。

参数

  • 输入 (列表[]联合[]PromptValuestr платыSequence[]联合[]BaseMessage платыstr платыDict[]联合[]strAny]]) – Runnable的输入列表。

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

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

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

返回

Runnable的输出列表。

返回类型

Sequence[str]

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

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

参数

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

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

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

  • kwargs (可选[任何类型]) – 传递给Runnable的其他关键字参数。

生成器

一个包含输入和从Runnable得到的输出的索引的元组。

返回类型

AsyncIterator[Tuple[int, 联合[Output, Exception]]]

async agenerate(prompts: List[str], stop: Optional[List[str]] = None, callbacks: Union[List[BaseCallbackHandler], BaseCallbackManager, None, List[Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]]]] = None, *, tags: Optional[Union[List[str], List[List[str]]]] = None, metadata: Optional[Union[Dict[str, Any], List[Dict[str, Any]]]] = None, run_name: Optional[Union[str, List[str]]] = None, run_id: Optional[Union[UUID, List[Optional[UUID]]]] = None, **kwargs: Any) → LLMResult

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

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

想要以下情况时使用此方法：

  1. 利用批量调用，

  2. 需要从模型中获得比仅顶部分数更多的输出，

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

    type

参数

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

  • stop （可选[List[str]]） – 在生成时使用的停用词。当模型输出中出现这些子字符串中的任何一个时，输出将截断。

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

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

  • metadata (可选[联合[字典[字符串，任何类型], 字典列表[字典[字符串，任何类型]]]]]) – 与每个提示关联的元数据字典列表。如果提供，则列表的长度必须与提示列表的长度匹配。

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

  • run_id (可选[联合[UUID, UUID列表[可选[UUID]]]]) – 与每个提示关联的运行ID列表。如果提供，则列表的长度必须与提示列表的长度匹配。

  • **kwargs (Any) – 任意附加的keyword参数。这些参数通常传递给模型提供商的API调用。

返回

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

。

返回类型

LLMResult

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

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

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

想要以下情况时使用此方法：

  1. 利用批量调用，

  2. 需要从模型中获得比仅顶部分数更多的输出，

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

    type

参数

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

  • stop （可选[List[str]]） – 在生成时使用的停用词。当模型输出中出现这些子字符串中的任何一个时，输出将截断。

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

  • **kwargs (Any) – 任意附加的keyword参数。这些参数通常传递给模型提供商的API调用。

返回

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

。

返回类型

LLMResult

async ainvoke(input: Union[PromptValue, str, Sequence[Union[BaseMessage, List[str], Tuple[str, str], str, Dict[str, Any]]]]], config: Optional[RunnableConfig] = None, ;, *, kwargs: Any) → str

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

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

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

参数

  • input (Union[PromptValue, str, Sequence[Union[BaseMessage, List[str], Tuple[str،str], str，Dict[str，Any]]]]) –

  • config (Optional[RunnableConfig]) –

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

  • kwargs (Any)) –

返回类型

str

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

自版本 langchain-core==0.1.7 已弃用: 使用 ainvoke 代替。

参数

  • text (str) –

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

  • kwargs (Any)) –

返回类型

str

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

自版本 langchain-core==0.1.7 已弃用: 使用 ainvoke 代替。

参数

  • messages (List[BaseMessage]) –

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

  • kwargs (Any)) –

返回类型

BaseMessage

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

测试版

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

从可执行对象创建BaseTool。

as_tool将从可执行对象中创建一个包含名称、描述和args_schema的BaseTool。尽可能从runnable.get_input_schema推断架构。或者（例如，如果可执行对象接受字典作为输入且特定字典键未进行类型化），可以直接通过args_schema指定架构。您也可以传递arg_types以仅指定必需的参数和它们的类型。

参数

  • args_schema (可选：类型列表（可选）) - 工具的架构。默认为None。

  • name (可选：str） - 工具的名称。默认为None。

  • description (可选：str） - 工具的描述。默认为None。

  • arg_types (可选：Dict[str, Type]） - 参数名称到类型的字典。默认为None。

返回

BaseTool实例。

返回类型

BaseTool

类型化字典输入

from typing import List
from typing_extensions import TypedDict
from langchain_core.runnables import RunnableLambda

class Args(TypedDict):
    a: int
    b: List[int]

def f(x: Args) -> str:
    return str(x["a"] * max(x["b"]))

runnable = RunnableLambda(f)
as_tool = runnable.as_tool()
as_tool.invoke({"a": 3, "b": [1, 2]})

dict输入，通过args_schema指定架构

from typing import Any, Dict, List
from langchain_core.pydantic_v1 import BaseModel, Field
from langchain_core.runnables import RunnableLambda

def f(x: Dict[str, Any]) -> str:
    return str(x["a"] * max(x["b"]))

class FSchema(BaseModel):
    """Apply a function to an integer and list of integers."""

    a: int = Field(..., description="Integer")
    b: List[int] = Field(..., description="List of ints")

runnable = RunnableLambda(f)
as_tool = runnable.as_tool(FSchema)
as_tool.invoke({"a": 3, "b": [1, 2]})

dict输入，通过arg_types指定架构

from typing import Any, Dict, List
from langchain_core.runnables import RunnableLambda

def f(x: Dict[str, Any]) -> str:
    return str(x["a"] * max(x["b"]))

runnable = RunnableLambda(f)
as_tool = runnable.as_tool(arg_types={"a": int, "b": List[int]})
as_tool.invoke({"a": 3, "b": [1, 2]})

字符串输入

from langchain_core.runnables import RunnableLambda

def f(x: str) -> str:
    return x + "a"

def g(x: str) -> str:
    return x + "z"

runnable = RunnableLambda(f) | g
as_tool = runnable.as_tool()
as_tool.invoke("b")

新功能，版本0.2.14。

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

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

参数

  • 输入（Union）：Runnable的输入。

  • 配置（Optional）：用于Runnable的配置。默认为None。

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

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

生成器

Runnable的输出。

返回类型

AsyncIterator[str]

astream_events(input: Any, config: Optional[RunnableConfig] = None, *, version: Literal['v1', 'v2'], include_names: Optional[Sequence[str]] = None, include_types: Optional[Sequence[str]] = None, include_tags: Optional[Sequence[str]] = None, exclude_names: Optional[Sequence[str]] = None, exclude_types: Optional[Sequence[str]] = None, exclude_tags: Optional[Sequence[str]] = None, **kwargs: Any) → AsyncIterator[Union[StandardStreamEvent, CustomStreamEvent]]

测试版

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

生成事件流。

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

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

  • event：字符串 - 事件名称遵循以下格式：

    格式：on_[runnable_type]_(start|stream|end)。

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

  • run_id: str - 与给定执行的 Runnable 关联的随机生成的 ID。

    the Runnable that emitted the event. A child Runnable that gets invoked as part of the execution of a parent Runnable is assigned its own unique ID.

  • parent_ids: ] - 产生事件的父 Runnable 的 ID。根 Runnable 将有一个空列表。父 ID 的顺序是从根到直接父。

    仅适用于 API 的 v2 版本。API 的 v1 版本将返回空列表。

  • tags: Optional[List[str]] - 产生事件的 Runnable 的标签。

    the event.

  • metadata: Optional[Dict[str, Any]] - 产生事件的 Runnable 的元数据。

    the event.

  • data: Dict[str, Any]

以下表展示了各种链可能发出的某些事件。为了简洁，省略了元数据字段。链定义在表之后。

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

事件

名

块

输入

输出

on_chat_model_start

model 名称

{“messages”: [[SystemMessage, HumanMessage]]}

on_chat_model_stream

model 名称

AIMessageChunk(content="hello")

on_chat_model_end

model 名称

{“messages”: [[SystemMessage, HumanMessage]]}

AIMessageChunk(content="hello world")

on_llm_start

model 名称

{‘input’: ‘hello’}

on_llm_stream

model 名称

"Hello"

on_llm_end

model 名称

"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}

提示:

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 (可选[序列[字符串]]) - 排除与匹配类型相匹配的可运行程序的事件。

  • exclude_tags (可选[序列[字符串]]) - 排除与匹配标签相匹配的可运行程序的事件。

  • kwargs (任何类型) - 传递给可运行程序的额外关键字参数。这些参数将被传递给astream_log，因为astream_event的实现建立在astream_log之上。

生成器

StreamEvents的异步流。

抛出异常

NotImplementedError - 如果版本不是v1或v2。

返回类型

AsyncIterator[Union[StandardStreamEvent, CustomStreamEvent]]

batch(inputs: 列表[Union[PromptValue, str, 序列[Union[BaseMessage, 列表[str], 元组[str, str], 字符串, 字典[字符串, 任何类型]]]]]], config: 可选[Union[RunnableConfig, 列表[RunnableConfig]]]] = None, *, return_exceptions: bool = False, **kwargs: 任何类型) → 列表[字符串]

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

默认的批处理实现适用于IO密集型的可运行程序。

如果子类能够更高效地批处理，则应覆盖此方法；例如，如果底层可运行程序使用支持批处理模式的API。

参数
返回类型

Sequence[str]

batch_as_completed(inputs: Sequence[Input], config: 可选[联合[RunnableConfig, Sequence[RunnableConfig]] = None, *, return_exceptions: bool = False, **kwargs: 可选[Any]) → 迭代器[Tuple[int, 联合[Output, Exception]]]

并行在一系列输入上运行 invokes，按完成顺序yield 返回结果。

参数

  • 输入 (Sequence[Input]) –

  • 配置 (可选[联合[RunnableConfig, Sequence[RunnableConfig]]]) –

  • 是否返回异常 (bool) –

  • kwargs (可选[Any]) –

返回类型

迭代器[Tuple[int, Union[Output, Exception]]]

configurable_alternatives(which: ConfigurableField, *args, 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) – 如果没有选择替代方案，则使用默认键。默认为“默认”。

  • 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
)
create_llm_result(choices: Any, prompts: List[str], params: Dict[str, Any], token_usage: Dict[str, int], *, system_fingerprint: Optional[str] = None) → LLMResult

从选择和提示创建 LLMResult。

参数

  • choices (Any) –

  • prompts (List[str]) –

  • params (Dict[str, Any]) –

  • token_usage (Dict[str, int]) –

  • system_fingerprint (Optional[str]) –

返回类型

LLMResult

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

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

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

想要以下情况时使用此方法：

  1. 利用批量调用，

  2. 需要从模型中获得比仅顶部分数更多的输出，

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

    type

参数

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

  • stop （可选[List[str]]） – 在生成时使用的停用词。当模型输出中出现这些子字符串中的任何一个时，输出将截断。

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

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

  • metadata (可选[联合[字典[字符串，任何类型], 字典列表[字典[字符串，任何类型]]]]]) – 与每个提示关联的元数据字典列表。如果提供，则列表的长度必须与提示列表的长度匹配。

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

  • run_id (可选[联合[UUID, UUID列表[可选[UUID]]]]) – 与每个提示关联的运行ID列表。如果提供，则列表的长度必须与提示列表的长度匹配。

  • **kwargs (Any) – 任意附加的keyword参数。这些参数通常传递给模型提供商的API调用。

返回

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

。

返回类型

LLMResult

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

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

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

想要以下情况时使用此方法：

  1. 利用批量调用，

  2. 需要从模型中获得比仅顶部分数更多的输出，

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

    type

参数

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

  • stop （可选[List[str]]） – 在生成时使用的停用词。当模型输出中出现这些子字符串中的任何一个时，输出将截断。

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

  • **kwargs (Any) – 任意附加的keyword参数。这些参数通常传递给模型提供商的API调用。

返回

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

。

返回类型

LLMResult

get_num_tokens(text: str) → int

获取文本中存在的令牌数量。

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

参数

text (str) – 要令牌化的字符串输入。

返回

文本中的令牌整数数量。

返回类型

int

get_num_tokens_from_messages(messages: List[BaseMessage]) → int

获取消息中的token数量。

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

参数

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

返回

消息中token数量的总和。

返回类型

int

get_sub_prompts(params: Dict[str, Any], prompts: List[str], stop: Optional[List[str]] = None) → List[List[str]]

获取llm调用的子提示。

参数

  • params (Dict[str, Any]) –

  • prompts (List[str]) –

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

返回类型

List[List[str]]

get_token_ids(text: str) → List[int]

使用tiktoken包获取token ID。

参数

text (str) –

返回类型

List[int]

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

将单个输入转换成输出。覆盖以实现。

参数

  • 输入（Union）：Runnable的输入。

  • config (可选：RunnableConfig]) – 在调用可运行项时使用的配置。该配置支持标准键，如 'tags'、'metadata' 用于追踪目的，'max_concurrency' 用于控制并行执行的工作量，以及其他键。请参阅 RunnableConfig 了解更多详情。

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

  • kwargs (Any)) –

返回

Runnable的输出。

返回类型

str

max_tokens_for_prompt(prompt: str) → int

计算对于一个提示可以生成最大token数。

参数

prompt (str) – 传递到模型中的提示。

返回

提示可以生成的最大token数。

返回类型

int

示例

max_tokens = openai.max_token_for_prompt("Tell me a joke.")
静态 modelname_to_contextsize(modelname: str) → int

计算模型可以生成token的最大数量。

参数

modelname (str) – 想要获取上下文大小的模型名称。

返回

最大上下文大小

返回类型

int

示例

max_tokens = openai.modelname_to_contextsize("gpt-3.5-turbo-instruct")
predict(text: str, *, stop: Optional[Sequence[str]] = None, **kwargs: Any) → str

自版本 langchain-core==0.1.7 起已弃用: 请使用 invoke 代替。

参数

  • text (str) –

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

  • kwargs (Any)) –

返回类型

str

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

自版本 langchain-core==0.1.7 起已弃用: 请使用 invoke 代替。

参数

  • messages (List[BaseMessage]) –

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

  • kwargs (Any)) –

返回类型

BaseMessage

save(file_path: Union[Path, str]) → None

保存LLM。

参数

file_path (Union[Path, str]) – 要保存LLM的文件路径。

抛出异常

ValueError – 如果文件路径不是字符串或Path对象。

返回类型

None

示例：.. code-block:: python

llm.save(file_path="path/llm.yaml")

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

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

参数

  • 输入（Union）：Runnable的输入。

  • 配置（Optional）：用于Runnable的配置。默认为None。

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

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

生成器

Runnable的输出。

返回类型

Iterator[str]

to_json() → Union[SerializedConstructor, SerializedNotImplemented]

将Runnable序列化为JSON。

返回

Runnable的JSON序列化表示。

返回类型

联合[SerializedConstructor, SerializedNotImplemented]

with_structured_output(schema: Union[Dict, Type[BaseModel]], **kwargs: Any) → Runnable[Union[PromptValue, str, Sequence[Union[BaseMessage, List[str], Tuple[str, str], str, Dict[str, Any]]], Union[Dict, BaseModel]]

此类未实现。

参数

  • schema (Union[Dict, Type[BaseModel]]) –

  • kwargs (Any)) –

返回类型

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

property max_context_size

获取此模型的最大上下文大小。

使用 AzureOpenAI 的示例