`langchain_community.llms.openai`.BaseOpenAI¶

备注

BaseOpenAI实现了标准Runnable 接口。🏃

Runnable接口提供额外的方法，可在Runnable对象上使用，例如with_types、with_retry、assign、bind、get_graph等。

class langchain_community.llms.openai.BaseOpenAI[source]¶

基类：BaseLLM

Base OpenAI大型语言模型类。

初始化OpenAI对象。

param allowed_special : Union[Literal['all'], AbstractSet[str]] = {}¶: 允许的特殊标记的集合。

参数 batch_size: int = 20¶: 当向生成时传入多个文档时使用的批次大小。

参数 best_of: int = 1¶: 在服务器端生成best_of个完成项，并返回“最佳”的结果。

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

是否缓存响应。

如果是true，将使用全局缓存。
如果是false，将不使用缓存。
如果是None，如果已设置全局缓存，则使用全局缓存；否则不使用缓存。
如果是BaseCache的实例，将使用提供的缓存。

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

参数 callback_manager: Optional[BaseCallbackManager] = None¶: （已弃用）

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

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

param default_headers :Union[解析[str, str], None] = None¶

param default_query :Union[解析[str, 对象], None] = None¶

param disallowed_special :Union[宇文['all'], 集合[str] = 'all'¶: 不允许的特殊标记集合。

param frequency_penalty :float = 0¶: 根据频率惩罚重复的标记。

param http_client :Union[任何类型, None] = None¶: 可选的httpx.Client。

param logit_bias :Optional[字典[str, float]] [可选]¶: 调整生成特定标记的概率。

参数 max_retries: int = 2¶: 在生成时尝试的最大次数。

参数 max_tokens: int = 256¶: 在生成完成时的最大词数。返回 -1 则根据提示和模型的最大上下文大小返回尽可能多的词数。

参数 metadata: Optional[Dict[str, Any]] = None¶: 添加到运行跟踪的元数据。

参数 model_kwargs: Dict[str, Any] [Optional]¶: 保存任何对 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[str] = None (别名 'api_key')¶: 如果未提供，将从环境变量 OPENAI_API_KEY 自动推断。

参数 openai_organization: Optional[str] = None (别名 'organization')¶: 如果未提供，将从环境变量 OPENAI_ORG_ID 自动推断。

参数 openai_proxy: Optional[str] = None¶

参数 presence_penalty: float = 0¶: 惩罚重复的标记。

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

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

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

param temperature: float = 0.7¶: 使用何种抽样温度。

param tiktoken_model_name: Optional[str] = None¶: 在类中使用时传递给rikken的模型名称。 rikken用于统计文档中的标记数量，以将其限制在一定范围内。默认情况下，当设置为None时，与嵌入模型名称相同。但是，在某些情况下，您可能希望使用rikken无法支持的模型名称来使用此嵌入类。这可能包括在使用Azure嵌入或在使用众多模型提供者中，这些提供者公开类似OpenAI的API，但使用不同的模型。在这些情况下，为了避免在调用rikken时出错，可以在此处指定一个要使用的模型名称。

param top_p: float = 1¶: 每一步要考虑的标记的总概率质量。

param 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 (Optional[List[str]]) – 生成时要使用的停用词。模型输出在第一个出现这些子字符串的地方截止。
callbacks (Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]]) – 要传递的回调。在生成过程中用于执行附加功能，例如记录或流式处理。
tags (Optional[List[str]]) – 与提示相关联的标签列表。
metadata (Optional[Dict[str, Any]]) – 与提示相关联的元数据。
**kwargs (Any) – 任意额外的关键字参数。这些通常传递给模型提供者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]¶

默认实现通过asyncio.gather并行运行run。

批次的默认实现适用于IO密集型运行。

子类应根据需要覆盖此方法以更高效地批处理；例如，如果底层的Runnable使用支持批处理模式的API。

参数

输入 (列表[联合[PromptValue, str, 序列[联合[BaseMessage, 列表[str], 元组[str, str], str, 字典[str, Any]]]]) – Runnable 函数的输入列表。
配置 (可选[联合[RunnableConfig, 列表[RunnableConfig]]]) – 调用 Runnable 时使用的配置。配置支持标准键如 ' tags'、'metadata' 用于追踪目的，' max_concurrency' 用于控制并行执行的工作量，以及其他键。请参阅 RunnableConfig 获取更多详细信息。默认为 None。
返回异常 (布尔值) – 是否返回异常而不是引发它们。默认为 False。
kwargs (Any) – 传递给 Runnable 的额外关键字参数。

返回

Runnable 的输出列表。

返回类型

列表[str]

异步 abatch_as_completed(inputs: 序列[输入], config: 可选[联合[RunnableConfig, 序列[RunnableConfig]]] = None, *, return_exceptions: 布尔值 = False, **kwargs: 可选[Any]) → 异步迭代器[整数, 联合[输出, 异常]]]

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

参数

inputs (Sequence[输入]) – Runnable 的输入列表。
config (可选[Union[RunnableConfig, Sequence[RunnableConfig]]]) – 调用 Runnable 时使用的配置。该配置支持像 'tags'、'metadata' 这样的标准键，用于跟踪目的，'max_concurrency' 用于控制并行工作量，以及其他键。请参阅 RunnableConfig 了解更多详情。默认为 None。默认为 None。
返回异常 (布尔值) – 是否返回异常而不是引发它们。默认为 False。
kwargs (可选[Any]) – 传递给 Runnable 的额外关键字参数。

生成值

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

返回类型

AsyncIterator[Tuple[int, Union[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 时，该方法应利用批处理调用。

当您想要

利用批处理调用，
需要从模型获取比仅顶生成的值更多的输出时，
构建对底层语言模型类型（例如，纯文本完成模型与聊天模型）无感知的链时。
类型。

参数

prompts (列表[str]) – 字符串提示列表。
stop (Optional[List[str]]) – 生成时要使用的停用词。模型输出在第一个出现这些子字符串的地方截止。
callbacks (Union[列表[BaseCallbackHandler], BaseCallbackManager, None, 列表[可选[Union[列表[BaseCallbackHandler], BaseCallbackManager]]]]) – 要传递的回调。用于在生成过程中执行附加功能，例如日志记录或流式传输。
tags (可选[Union[列表[str], 列表[列表[str]]]]) – 与每个提示关联的标签列表。如果提供，则列表的长度必须与提示列表的长度相同。
metadata (可选[Union[Dict[str, Any], 列表[Dict[str, Any]]]]) – 与每个提示关联的元数据字典列表。如果提供，则列表的长度必须与提示列表的长度相同。
run_name (可选[Union[str, 列表[str]]]) – 与每个提示关联的运行名称列表。如果提供，则列表的长度必须与提示列表的长度相同。
run_id (可选[Union[UUID, 列表[可选[UUID]]]]) – 与每个提示关联的运行 ID 列表。如果提供，则列表的长度必须与提示列表的长度相同。
**kwargs (Any) – 任意额外的关键字参数。这些通常传递给模型提供者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 时，该方法应利用批处理调用。

当您想要

利用批处理调用，
需要从模型获取比仅顶生成的值更多的输出时，
构建对底层语言模型类型（例如，纯文本完成模型与聊天模型）无感知的链时。
类型。

参数

prompts (List[PromptValue]) – PromptValues的列表。PromptValue是可以转换为与任何语言模型格式匹配的对象（纯文本生成模型的字符串和聊天模型的BaseMessages）。
stop (Optional[List[str]]) – 生成时要使用的停用词。模型输出在第一个出现这些子字符串的地方截止。
callbacks (Union[列表[BaseCallbackHandler], BaseCallbackManager, None, 列表[可选[Union[列表[BaseCallbackHandler], BaseCallbackManager]]]]) – 要传递的回调。用于在生成过程中执行附加功能，例如日志记录或流式传输。
**kwargs (Any) – 任意额外的关键字参数。这些通常传递给模型提供者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, *, stop: Optional[List[str]] = None, **kwargs: Any) → str¶

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

默认实现允许在 Runnable 未实现 invoke 的本地异步版本的即使下使用异步代码。

子类如果可以异步运行，应重写此方法。

参数

输入 (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 apredictapredict(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_messagesapredict_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 (可选[Type[BaseModel]]) – 工具的模式。默认为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。子类应在该方法中重写，如果它们支持流输出。

参数

input (Union[PromptValue, str, Sequence[Union[BaseMessage, List[str], Tuple[str, str], str, Dict[str, Any]]]]) – Runnable的输入。
config (Optional[RunnableConfig]) – 为Runnable使用配置。默认为None。
kwargs (Any) – 传递给 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的迭代器，提供有关Runnable进度的实时信息，包括中间结果的事件流。

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

event: str - 事件名称为
格式：on_[可运行类型]_(开始|流|结束)。
name: str - 生成事件的可运行对象名称。
run_id: str - 与给定的可运行对象执行关联的随机生成的ID。
该可运行对象的事件触发者分配了自己的唯一ID。
parent_ids: 列表[str] - 生成事件的父可运行对象的ID。
根可运行对象将有一个空列表。父ID的顺序是从根到直接父级。此字段仅适用于API版本2。API版本1将返回一个空列表。
tags: 可选[列表[str]] - 生成事件的可运行对象的标签。
metadata: 可选[Dict[str, 任何]] - 生成事件的可运行对象的元数据。
data: 字典[str, 任何]

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

注意本参考表针对的是模式版本的V2。

事件	姓名	块	输入	输出
on_chat_model_start	[模型名称]		{“消息”：[[系统消息，人类消息]]}
on_chat_model_stream	[模型名称]	AIMessageChunk(content=“hello”)
on_chat_model_end	[模型名称]		{“消息”：[[系统消息，人类消息]]}	AIMessageChunk(content=“hello world”)
on_llm_start	[模型名称]		{‘输入’：‘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		[文档(…)]	“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	[检索器名称]		{“查询”：”hello”}
on_retriever_end	[检索器名称]		{“查询”：”hello”}	[文档(…)， ..]
on_prompt_start	[模板名称]		{“问题”：”hello”}
on_prompt_end	[模板名称]		{“问题”：”hello”}	ChatPromptValue(messages: [SystemMessage, …])

除了标准事件之外，用户还可以触发自定义事件（见下例）。

自定义事件仅在API的V2版本中呈现！

自定义事件的格式如下

属性	类型	描述
姓名	str	用户定义的事件名称。
数据	任何	与事件关联的数据。这可能是一切，但我们建议使其可序列化为JSON。

以下是与上述标准事件相关的声明

format_docs:

def format_docs(docs: List[Document]) -> str:
    '''Format the docs.'''
    return ", ".join([doc.page_content for doc in docs])

format_docs = RunnableLambda(format_docs)

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)

参数

输入 (任何) - 可运行对象的输入。
配置 (可选[RunnableConfig]) - 为可运行对象使用的配置。
版本 (字面量['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 (任何) – 传递给可运行的附加关键字参数。这些将被传递给astream_log，因为astream_events的实现建立在astream_log之上。

生成值

一个异步流的StreamEvents。

引发

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

返回类型

异步迭代器<联合StandardStreamEvent, CustomStreamEvent]]

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

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

批次的默认实现适用于IO密集型运行。

子类应根据需要覆盖此方法以更高效地批处理；例如，如果底层的Runnable使用支持批处理模式的API。

参数

inputs (List[Union[PromptValue, str, Sequence[Union[BaseMessage, List[str], Tuple[str, str], str, Dict[str, Any]]]]]) –
配置（可选：Union [RunnableConfig，List[RunnableConfig] ]） –
return_exceptions （布尔值） –
kwargs (Any) –

返回类型

列表[str]

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

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

参数

inputs （Sequence[Input]） –
config （可选：Union [RunnableConfig，List[RunnableConfig] ]） –
return_exceptions （布尔值） –
kwargs （可选：Any） –

返回类型

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

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

配置可以在运行时设置的Runnables的备选方案。

参数

which (ConfigurableField) – 用于选择备选方案的ConfigurableField实例。
default_key (str) – 如果未选择任何备选方案时使用的默认键。默认为“default”。
prefix_keys (bool) – 是否使用ConfigurableField的ID作为键前缀。默认为False。
**kwargs (Union[Runnable[Input, Output], Callable[[], Runnable[Input, Output]]]) – 键到Runnable实例或可调用对象的字典，该对象返回Runnable实例。

返回

配置了备选方案的新的Runnable。

返回类型

RunnableSerializable[Input, Output]

from langchain_anthropic import ChatAnthropic
from langchain_core.runnables.utils import ConfigurableField
from langchain_openai import ChatOpenAI

model = ChatAnthropic(
    model_name="claude-3-sonnet-20240229"
).configurable_alternatives(
    ConfigurableField(id="llm"),
    default_key="anthropic",
    openai=ChatOpenAI()
)

# uses the default model ChatAnthropic
print(model.invoke("which organization created you?").content)

# uses ChatOpenAI
print(
    model.with_config(
        configurable={"llm": "openai"}
    ).invoke("which organization created you?").content
)

configurable_fields(**kwargs: Union[ConfigurableField, ConfigurableFieldSingleOption, ConfigurableFieldMultiOption]) → RunnableSerializable[Input, Output]¶

在运行时配置特定的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
)

create_llm_result(choices: Any, prompts: List[str], params: Dict[str, Any], token_usage: Dict[str, int], *, system_fingerprint: Optional[str] = None) → LLMResult[source]¶

从选择和提示中创建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 时，该方法应利用批处理调用。

当您想要

利用批处理调用，
需要从模型获取比仅顶生成的值更多的输出时，
构建对底层语言模型类型（例如，纯文本完成模型与聊天模型）无感知的链时。
类型。

参数

prompts (列表[str]) – 字符串提示列表。
stop (Optional[List[str]]) – 生成时要使用的停用词。模型输出在第一个出现这些子字符串的地方截止。
callbacks (Union[列表[BaseCallbackHandler], BaseCallbackManager, None, 列表[可选[Union[列表[BaseCallbackHandler], BaseCallbackManager]]]]) – 要传递的回调。用于在生成过程中执行附加功能，例如日志记录或流式传输。
tags (可选[Union[列表[str], 列表[列表[str]]]]) – 与每个提示关联的标签列表。如果提供，则列表的长度必须与提示列表的长度相同。
metadata (可选[Union[Dict[str, Any], 列表[Dict[str, Any]]]]) – 与每个提示关联的元数据字典列表。如果提供，则列表的长度必须与提示列表的长度相同。
run_name (可选[Union[str, 列表[str]]]) – 与每个提示关联的运行名称列表。如果提供，则列表的长度必须与提示列表的长度相同。
run_id (可选[Union[UUID, 列表[可选[UUID]]]]) – 与每个提示关联的运行 ID 列表。如果提供，则列表的长度必须与提示列表的长度相同。
**kwargs (Any) – 任意额外的关键字参数。这些通常传递给模型提供者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 时，该方法应利用批处理调用。

当您想要

利用批处理调用，
需要从模型获取比仅顶生成的值更多的输出时，
构建对底层语言模型类型（例如，纯文本完成模型与聊天模型）无感知的链时。
类型。

参数

prompts (List[PromptValue]) – PromptValues的列表。PromptValue是可以转换为与任何语言模型格式匹配的对象（纯文本生成模型的字符串和聊天模型的BaseMessages）。
stop (Optional[List[str]]) – 生成时要使用的停用词。模型输出在第一个出现这些子字符串的地方截止。
callbacks (Union[列表[BaseCallbackHandler], BaseCallbackManager, None, 列表[可选[Union[列表[BaseCallbackHandler], BaseCallbackManager]]]]) – 要传递的回调。用于在生成过程中执行附加功能，例如日志记录或流式传输。
**kwargs (Any) – 任意额外的关键字参数。这些通常传递给模型提供者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_sub_prompts(params: Dict[str, Any], prompts: List[str], stop: Optional[List[str]] = None) → List[List[str]][source]¶

获取llm调用的子提示。

参数

params (Dict[str, Any]) –
prompts (List[str]) –
stop (Optional[List[str]]) –

返回类型

List[List[str]]

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

使用tiktoken包获取令牌ID。

参数: text (str) –
返回类型: List[int]

调用(input: 联合[PromptValue, str, 序列[联合[BaseMessage, 列表[str], 元组[str, str], str, 字典[str, any]]]] ], config: Optional[RunnableConfig] = None, *, 停止: Optional[列表[str]] = None, **kwargs: Any) → str¶

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

参数

input (Union[PromptValue, str, Sequence[Union[BaseMessage, List[str], Tuple[str, str], str, Dict[str, Any]]]]) – Runnable的输入。
config (可选[RunnableConfig]) – 在调用可运行对象时使用的配置。配置支持标准键，如‘tags’，‘metadata’用于跟踪目的，‘max_concurrency’用于控制并行工作量，以及其他键。请参阅RunnableConfig获取更多详细信息。
stop (Optional[List[str]]) –
kwargs (Any) –

返回

Runnable的输出。

返回类型

str

max_tokens_for_prompt(prompt: str) → int[source]¶

计算在提示符中可能生成多少个令牌的最大数量。

参数: prompt (str) – 要传入模型的提示。
返回: 生成提示语时所需生成的最大标记数。
返回类型: int

示例

max_tokens = openai.max_token_for_prompt("Tell me a joke.")

静态 modelname_to_contextsize(modelname: str) → int[source]¶

计算模型可能生成的最大标记数。

参数: 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

示例：

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。子类应该覆盖此方法以支持流式输出。

参数

input (Union[PromptValue, str, Sequence[Union[BaseMessage, List[str], Tuple[str, str], str, Dict[str, Any]]]]) – Runnable的输入。
config (Optional[RunnableConfig]) – 为Runnable使用配置。默认为None。
kwargs (Any) – 传递给 Runnable 的额外关键字参数。
stop (Optional[List[str]]) –

生成值

Runnable的输出。

返回类型

Iterator[str]

to_json() → Union[SerializedConstructor, SerializedNotImplemented]¶

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

返回: 可序列化为JSON的可运行对象。
返回类型: 联合[序列化构造函数, 序列化未实现]

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

属性max_context_size: int¶: 获取此模型的最大上下文大小。

langchain_community.llms.openai.BaseOpenAI¶

`langchain_community.llms.openai`.BaseOpenAI¶