`langchain_community.llms.oci_generative_ai`.OCIGenAI¶

注意

OCIGenAI实现了标准的Runnable Interface。🏃

Runnable Interface除了包含普通的可运行对象方法外，还提供了额外的可运行对象方法，如with_types、with_retry、assign、bind和更多的方法。

class langchain_community.llms.oci_generative_ai.OCIGenAI[source]¶

继承自：LLM、OCIGenAIBase

OCI大语言模型。

为了认证，OCI客户端使用https://docs.oracle.com/en-us/iaas/Content/API/Concepts/sdk_authentication_methods.htm文档中描述的方法。

认证方法通过auth_type传递，可以是以下之一：API_KEY（默认）、SECURITY_TOKEN、INSTANCE_PRINCIPAL、RESOURCE_PRINCIPAL。

确保您有权访问OCI生成AI服务的必要策略（配置文件/角色）。如果您使用特定的配置文件，则必须通过auth_profile参数传递配置文件名称（从~/.oci/config中获得）。

使用时，您必须提供compartment id以及endpoint url和model id作为构造函数的命名参数。

示例

from langchain_community.llms import OCIGenAI

llm = OCIGenAI(
        model_id="MY_MODEL_ID",
        service_endpoint="https://inference.generativeai.us-chicago-1.oci.oraclecloud.com",
        compartment_id="MY_OCID"
    )

param auth_profile: Optional[str] = 'DEFAULT'¶: 在 ~/.oci/config 中配置文件的名称。如果未指定，将使用 DEFAULT。

参数 auth_type: 可选[str] = 'API_KEY'¶

认证类型，可以是

API_KEY, SECURITY_TOKEN, INSTANCE_PRINCIPAL, RESOURCE_PRINCIPAL

如果未指定，将使用 API_KEY。

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

是否缓存响应。

如果为真，将使用全局缓存。
如果为假，将不使用缓存。
如果为 None，将会在已设置全局缓存的情况下使用全局缓存，否则不使用缓存。
如果为 BaseCache 的实例，将使用提供的缓存。

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

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

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

参数 compartment_id : str = None¶: 部分的 OCID。

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

param is_stream: bool = False¶: 是否回传部分进度

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

param model_id: str = None¶: 要调用的模型的ID，例如，cohere.command

param model_kwargs: Optional[Dict] = None¶: 传递给模型的键值参数

param provider: str = None¶: 模型的提供者名称。默认为 None，如果从 model_id 中无法推导出来，则需用户提供

param service_endpoint: str = None¶: 服务端点 URL

param tags: Optional[List[str]] = None¶: 运行跟踪中要添加的标签。

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]]]] = None, *, return_exceptions: bool = False, **kwargs: Any) → List[str]¶

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

批量执行的默认实现适用于I/O密集型可运行实例。

如果子类能够更有效地批量处理，则应重写此方法；例如，如果底层可运行实例使用支持批量模式的API。

参数

inputs (List[Union[PromptValue, str, Sequence[Union[BaseMessage, List[str], Tuple[str, str], str, Dict[str, Any]]]]]) – 向可运行实例传入的输入列表。
config (可选[集合[RunnableConfig, List[RunnableConfig]]]) – 在调用Runnable时使用的配置。该配置支持用于跟踪的标准键，如‘tags’、‘metadata’、用于控制并行工作量的‘max_concurrency’和其他键。请参阅RunnableConfig获取更多详细信息。默认为None。
return_exceptions (布尔值) – 是否返回异常而不是抛出它们。默认为False。
kwargs (任何类型) – 要传递给Runnable的额外关键字参数。

返回值

Runnable的输出列表。

返回类型

List[字符串]

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

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

参数

inputs (序列[输入]) –Runnable的输入列表。
config (可选[集合[RunnableConfig, List[RunnableConfig]]]) – 在调用Runnable时使用的配置。该配置支持用于跟踪的标准键，如‘tags’、‘metadata’、用于控制并行工作量的‘max_concurrency’和其他键。请参阅RunnableConfig获取更多详细信息。默认为None。默认为None。
return_exceptions (布尔值) – 是否返回异常而不是抛出它们。默认为False。
kwargs（《可选项》[任意类型]）- 传递给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[字典[str, 任意类型], 列表[字典[str, 任意类型]]]]) - 与每个提示关联的元数据字典列表。如果提供，列表的长度必须与提示列表的长度匹配。
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 (列表[PromptValue]) – PromptValue 对象的列表。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]]]], *, stop: Optional[List[str]] = 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

异步 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

异步 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 (可选[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]]]]) – 可执行对象的可执行对象输入。
config (Optional[RunnableConfig]) – 用于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，提供有关Runnable进度的实时信息，包括中间结果的事件。

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

event： 字符串 - 事件名称的格式为：
：on_[可执行实体类型]_(start|stream|end)。
name： 字符串 - 创建事件的可执行实体的名称。
run_id： 字符串 - 与给定执行的Runnable相关联的随机生成的ID。
一个作为父Runnable执行部分被调用的子Runnable将被分配一个唯一的ID。
parent_ids： 字符串列表 - 生成事件的父Runnable的ID。
根Runnable将有一个空列表。父ID的顺序是从根到直接父级。仅适用于API的第2版本。API的第1版本将返回一个空列表。
tags： 可选字符串列表 - 创建事件的Runnable的标签。
metadata： 可选字典类型[str, Any] - 创建事件的Runnable的元数据。
data： 字典类型[str, Any]

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

注意此参考表适用于schema的第2版本。

事件	名称	块	输入	输出
on_chat_model_start	[模型名称]		{“messages”：[[系统消息，人类消息]]}
on_chat_model_stream	[模型名称]	AIMessageChunk(content="hello")
on_chat_model_end	[模型名称]		{“messages”：[[系统消息，人类消息]]}	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, …])

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

自定义事件仅在第2版API中可见！

自定义事件的格式如下：

属性	类型	描述
名称	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（任何）- Runnable的输入。
config（可选RunnableConfig）- 用于Runnable的配置。
version（文字[''v1''，''v2'']）- 要使用的schema版本，即''v2''或''v1''。用户应使用''v2''。''v1''是为了向后兼容，将在0.4.0版本中弃用。在API稳定之前不会分配默认值。仅在第2版API中显示自定义事件。
include_names（可选字符串序列）- 仅包含具有匹配名称的runnables的事件。
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。

返回类型

AsyncIterator[Union[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]]]], **kwargs: Any) → List[str]¶

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

批量执行的默认实现适用于I/O密集型可运行实例。

如果子类能够更有效地批量处理，则应重写此方法；例如，如果底层可运行实例使用支持批量模式的API。

参数

inputs (List[Union[PromptValue, str, Sequence[Union[BaseMessage, List[str], Tuple[str, str], str, Dict[str, Any]]]]) –
config (可选[并集[RunnableConfig, Sequence[RunnableConfig]]]) –
return_exceptions (布尔型) –
kwargs (Any) –

返回类型

List[字符串]

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 (可选[并集[RunnableConfig, Sequence[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]Input, Output>¶

动态配置特定可运行字段。

参数: **kwargs (Union[ConfigurableField, ConfigurableFieldSingleOption, ConfigurableFieldMultiOption]) - 要配置的 ConfigurableField 实例的字典。
返回值: 配置字段后的新可运行对象。
返回类型: RunnableSerializable[Input, Output]

from langchain_core.runnables import ConfigurableField
from langchain_openai import ChatOpenAI

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

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

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

generate(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[字典[str, 任意类型], 列表[字典[str, 任意类型]]]]) - 与每个提示关联的元数据字典列表。如果提供，列表的长度必须与提示列表的长度匹配。
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 (列表[PromptValue]) – PromptValue 对象的列表。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_token_ids(text: str) → List[int]¶

返回文本中标记的有序ID。

参数

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

返回值

与文本中的标记对应的ID列表，按照出现的顺序排列。: 在文本中按顺序发生的标记的ID列表。

返回类型

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¶

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

参数

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

返回值

Runnable的输出。

返回类型

str

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

保存(file_path: Union[Path, str]) → None¶

保存LLM。

参数: file_path (Union[Path, str]) – 保存LLM的文件路径。
抛出异常: ValueError – 如果文件路径不是字符串或Path对象。
返回类型: None

示例：.. 代码块:: 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。如果子类支持流式输出，应重写此方法。

参数

input (Union[PromptValue, str, Sequence[Union[BaseMessage, List[str], Tuple[str, str], str, Dict[str, Any]]]]) – 可执行对象的可执行对象输入。
config (Optional[RunnableConfig]) – 用于Runnable的配置。默认为None。
kwargs (任何类型) – 要传递给Runnable的额外关键字参数。
stop (Optional[List[str]]) –

生成

Runnable的输出。

返回类型

Iterator[str]

to_json() → Union[SerializedConstructor, SerializedNotImplemented]¶

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

返回值: 可运行对象的JSON序列化表示。
返回类型: Union[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]]

langchain_community.llms.oci_generative_ai.OCIGenAI¶

使用 OCIGenAI 的示例¶

`langchain_community.llms.oci_generative_ai`.OCIGenAI¶