`langchain_aws.llms.bedrock`.Bedrock¶

注意

Bedrock实现了标准的Runnable Interface接口。

Runnable Interface接口有额外的可用方法，例如with_types、with_retry、assign、bind、get_graph等。

class langchain_aws.llms.bedrock.Bedrock[source]¶

继承自: BedrockLLM

自版本0.1.0开始弃用: 使用BedrockLLM代替。

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

是否缓存响应。

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

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

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

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

参数 config :Any = None¶: 传递给客户端的可选botocore.config.Config实例。

参数 credentials_profile_name :Optional[str] = None¶: 指定在/.aws/credentials或/.aws/config文件中的配置文件名称，其中包含已指定访问键或角色信息。如果没有指定，将使用默认凭证配置文件，或者在EC2实例上使用IMDS上的凭证。见： https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html

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

参数 endpoint_url :Optional[str] = None¶: 如果不希望默认使用us-east-1端点，则需要此参数。

类型: Optional[Mapping[str, str]]: 包含‘id’和‘version’键的映射。

示例：llm = Bedrock(model_id=”<model_id>”, client=<bedrock_client>,

model_kwargs={}, guardrails={

示例：llm = Bedrock(model_id=”<model_id>”, client=<bedrock_client>,

model_kwargs={}, guardrails={

[

class BedrockAsyncCallbackHandler(AsyncCallbackHandler)

async def on_llm_error(: self,

参数 provider: 可选[str] = None¶: 模型提供者，例如：amazon、cohere、ai21等。如果没有提供，则从模型_id的第一个部分提取提供者，例如在’mazon.titan-text-express-v1’中提取‘amazon’。对于没有提供提供者的模型_id，应该提供此值，例如与ARN相关联的定制和预配模型。

参数 provider_stop_reason_key_map: 字典[str, str] = {'ai21': 'finishReason', 'amazon': 'completionReason', 'anthropic': 'stop_reason', 'cohere': 'finish_reason', 'mistral': 'stop_reason'}¶

参数 provider_stop_sequence_key_name_map: 字典[str, str] = {'ai21': 'stop_sequences', 'amazon': 'stopSequences', 'anthropic': 'stop_sequences', 'cohere': 'stop_sequences', 'mistral': 'stop_sequences'}¶

参数 region_name: 可选[str] = None¶: AWS区域，例如：us-west-2。如果没有在此处提供，则回退到AWS_DEFAULT_REGION环境变量或~/.aws/config中指定的区域。

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

参数 tags: 可选[列表[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 (可选：联合列表[],BaseCallbackHandler[],BaseCallbackManager[]) – 需要传递的回调。用于在整个生成过程中执行附加功能，如日志记录或流式传输。
tags (可选：列表[],str[]) – 与提示相关联的标签列表。
metadata (可选：字典,str, Any) – 与提示相关联的元数据。
**kwargs (任何类型) – 任意的额外关键字参数。这些参数通常传递给模型提供者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。

默认实现的批处理对IO密集型运行程序效果良好。

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

参数

inputs (列表[联合[PromptValue, 字符串, 序列[联合[BaseMessage, 字符串列表, 元组[字符串，字符串], 字符串，字典[字符串，任何]]]]]: 向Runnable提供的输入列表。
config (可选：Union：RunnableConfig， List：RunnableConfig]...) – 在调用Runnable时使用的配置。该配置支持用于跟踪的标准键（如‘tags’、‘metadata’），用于控制并行工作量的‘max_concurrency’，以及其他键。请参阅RunnableConfig以获取更多详细信息。默认为None。
return_exceptions (布尔值) – 是否返回异常而不是抛出。默认为False。
kwargs (任意值) – 要传递给Runnable的附加关键字参数。

返回

Runnable的输出列表。

返回类型

字符串列表

async abatch_as_completed(inputs: Input序列, config: Optional[Union： RunnableConfig， RunnableConfig序列]] = None, *, return_exceptions: bool = False, **kwargs: Optional[任意值]) → 异步迭代器[元组[int， Union： Output， Exception]]¶

对一组输入并行运行ainvoke，按完成顺序产出结果。

参数

inputs (输入序列) – Runnable的输入列表。
config (可选[联合[RunnableConfig, Sequence[RunnableConfig]]]) – 在调用Runnable时使用的配置。配置支持标准键，如'tags'、'metadata'用于跟踪目的，'max_concurrency'用于控制并行工作的量，以及其他键。请参阅RunnableConfig以获取更多详细信息。默认为None。默认为None。
return_exceptions (布尔值) – 是否返回异常而不是抛出。默认为False。
kwargs (可选[任何]) – 传递给Runnable的附加关键字参数。

生成值

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

返回类型

AsyncIterator[Tuple[int, 联合[输出, 异常]]]

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¶

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

此方法应该利用支持批量调用的-model。

当您想要时使用此方法

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

参数

prompts (列表[字符串]) – 字符串提示列表。
stop (Optional[List[str]]) – 生成时使用的停止词。模型输出将在这些子字符串的首次出现处截断。
callbacks (联合[列表[BaseCallbackHandler], BaseCallbackManager, None, 列表[可选[联合[列表[BaseCallbackHandler], BaseCallbackManager]]]]) – 传递的回调。在生成过程中用于执行其他功能，如记录或流。
tags (可选[联合[列表[字符串], 列表[列表[字符串]]]]]) – 与每个提示关联的标签列表。如果提供，列表的长度必须与提示列表的长度匹配。
metadata (可选[联合[字典[字符串, 任何], 列表[字典[字符串, 任何]]]]]) – 与每个提示关联的元数据字典列表。如果提供，列表的长度必须与提示列表的长度匹配。
run_name (可选[联合[字符串, 列表[字符串]]]]) – 与每个提示关联的运行名称列表。如果提供，列表的长度必须与提示列表的长度匹配。
run_id (可选[联合[UUID, 列表[可选[UUID]]]]) – 与每个提示关联的运行ID列表。如果提供，列表的长度必须与提示列表的长度匹配。
**kwargs (任何类型) – 任意的额外关键字参数。这些参数通常传递给模型提供者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¶

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

此方法应该利用支持批量调用的-model。

当您想要时使用此方法

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

参数

prompts (列表[PromptValue]) - 提示值列表。提示值是可以转换为匹配任何语言模型格式的对象（纯文本生成模型的字符串和聊天模型的BaseMessages）。
stop (Optional[List[str]]) – 生成时使用的停止词。模型输出将在这些子字符串的首次出现处截断。
callbacks (联合[列表[BaseCallbackHandler], BaseCallbackManager, None, 列表[可选[联合[列表[BaseCallbackHandler], BaseCallbackManager]]]]) – 传递的回调。在生成过程中用于执行其他功能，如记录或流。
**kwargs (任何类型) – 任意的额外关键字参数。这些参数通常传递给模型提供者API调用。

返回

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

返回类型

LLMResult

async ainvoke(input: Union[PromptValue, str, Sequence[Union[BaseMessage, List[str], Tuple[str, str], str, Dict[str, Any]]]], str, Sequence[Union[BaseMessage, List[str], Tuple[str, str], str, Dict[str, Any]]]], 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]]]]) –
配置 (Optional[RunnableConfig]) –
停止 (Optional[List[str]]) –
关键字参数 (Any) –

返回类型

str

异步 apredict(text: str, *, stop: Optional[列表[str]] = None, **kwargs: Any) → str¶

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

参数

text (str) –
stop (可选列表[[str]]]) –
关键字参数 (Any) –

返回类型

str

异步 apredict_messages(messages: 列表[[BaseMessage], *, stop: Optional[列表[[str]]] = None, **kwargs: Any) → BaseMessage¶

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

参数

messages (列表[[BaseMessage]]) –
stop (可选列表[[str]]]) –
关键字参数 (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 (可选) – 工具的名称。默认为None。
description (可选) – 工具的描述。默认为None。
arg_types (可选) – 一组键为参数名称、值为类型的字典。默认为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]})

通过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]})

通过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, **kwargs: Any*, stop: Optional[List[str]] = None) → 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 (任意值) – 要传递给Runnable的附加关键字参数。
停止 (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进度的实时信息，包括来自中间结果的StreamEvents。

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

event: str - 事件名称的格式为：
on_[runnable_type]_(start|stream|end)。
name: str - 触发事件的可运行对象名称。
run_id: str - 与给定执行关联的随机生成的ID。
例如，当一个子可运行对象在父可运行对象的执行过程中被调用时，将被赋予其唯一的ID。
parent_ids: - 生成事件的父可运行对象的ID。
根可运行对象将有一个空列表。父ID的顺序是从根到直接父级。仅适用于API的v2版本。API的v1版本将返回一个空列表。
tags: Optional[List[str]] - 触发事件的可运行对象的标签。
metadata: Optional[Dict[str, Any]] - 触发事件的可运行对象的元数据。
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}

提示:

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"]) – 要使用的schema版本，可以是v2或v1。用户应使用v2。v1是向后兼容的，将在0.4.0中弃用。在API稳定之前不会分配默认值。自定义事件仅在v2中可见。
include_names (Optional[Sequence[str]]) – 只包含具有匹配名称的可运行对象的事件。
include_types (Optional[Sequence[str]]) – 只包含具有匹配类型的可运行对象的事件。
include_tags (Optional[Sequence[str]]) – 只包含具有匹配标签的可运行对象的事件。
exclude_names (Optional[Sequence[str]]) – 排除具有匹配名称的可运行对象的事件。
exclude_types (可选[序列[str]]) – 从类型匹配的runnables中排除事件。
exclude_tags (可选[序列[str]]) – 从标记匹配的runnables中排除事件。
kwargs (任意) – 传递给Runnable的额外关键字参数。这些将被传递给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]]] = None, *, return_exceptions: bool = False, **kwargs: Any) → List[str]¶

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

默认实现的批处理对IO密集型运行程序效果良好。

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

参数

输入 (列表[联合[PromptValue，str，列表[联合[BaseMessage，列表[str]，元组[str，str]，str，字典[str，Any]]]]]) –
配置 (可选[联合[RunnableConfig，列表[RunnableConfig]]) –
返回异常 (bool) –
关键字参数 (Any) –

返回类型

字符串列表

batch_as_completed(inputs: 列表[输入], config: 可选[联合[RunnableConfig，列表[RunnableConfig]]], *, return_exceptions: bool = False, **kwargs: 可选[Any]) → 迭代器[元组[int，联合[Output，Exception]]]·

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

参数

输入 (列表[输入]) –
配置 (可选[联合[RunnableConfig，列表[RunnableConfig]]) –
返回异常 (bool) –
kwargs (可选[Any]) –

返回类型

迭代器[元组[int，联合[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]¶

配置可运行时设置的运行代理的替代项。

参数

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

返回

配置替代项的新运行代理。

返回类型

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
)

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¶

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

此方法应该利用支持批量调用的-model。

当您想要时使用此方法

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

参数

prompts (列表[字符串]) – 字符串提示列表。
stop (Optional[List[str]]) – 生成时使用的停止词。模型输出将在这些子字符串的首次出现处截断。
callbacks (联合[列表[BaseCallbackHandler], BaseCallbackManager, None, 列表[可选[联合[列表[BaseCallbackHandler], BaseCallbackManager]]]]) – 传递的回调。在生成过程中用于执行其他功能，如记录或流。
tags (可选[联合[列表[字符串], 列表[列表[字符串]]]]]) – 与每个提示关联的标签列表。如果提供，列表的长度必须与提示列表的长度匹配。
metadata (可选[联合[字典[字符串, 任何], 列表[字典[字符串, 任何]]]]]) – 与每个提示关联的元数据字典列表。如果提供，列表的长度必须与提示列表的长度匹配。
run_name (可选[联合[字符串, 列表[字符串]]]]) – 与每个提示关联的运行名称列表。如果提供，列表的长度必须与提示列表的长度匹配。
run_id (可选[联合[UUID, 列表[可选[UUID]]]]) – 与每个提示关联的运行ID列表。如果提供，列表的长度必须与提示列表的长度匹配。
**kwargs (任何类型) – 任意的额外关键字参数。这些参数通常传递给模型提供者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¶

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

此方法应该利用支持批量调用的-model。

当您想要时使用此方法

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

参数

prompts (列表[PromptValue]) - 提示值列表。提示值是可以转换为匹配任何语言模型格式的对象（纯文本生成模型的字符串和聊天模型的BaseMessages）。
stop (Optional[List[str]]) – 生成时使用的停止词。模型输出将在这些子字符串的首次出现处截断。
callbacks (联合[列表[BaseCallbackHandler], BaseCallbackManager, None, 列表[可选[联合[列表[BaseCallbackHandler], BaseCallbackManager]]]]) – 传递的回调。在生成过程中用于执行其他功能，如记录或流。
**kwargs (任何类型) – 任意的额外关键字参数。这些参数通常传递给模型提供者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列表，按其在文本中出现的顺序排列。

返回类型

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]]]]) – Runnable的输入。
config (可选[RunnableConfig]) – 当调用可运行对象时使用的配置。配置支持标准键，如‘tags’、‘metadata’用于追踪目的，‘max_concurrency’用于控制并发的工作量，以及其他键。有关详细信息，请参阅RunnableConfig。
停止 (Optional[List[str]]) –
关键字参数 (Any) –

返回

Runnable的输出。

返回类型

str

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

自langchain-core==0.1.7版本以来已弃用：请使用 invoke 代替。

参数

text (str) –
stop (可选列表[[str]]]) –
关键字参数 (Any) –

返回类型

str

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

自langchain-core==0.1.7版本以来已弃用：请使用 invoke 代替。

参数

messages (列表[[BaseMessage]]) –
stop (可选列表[[str]]]) –
关键字参数 (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。如果子类支持流式输出，则应重写此方法。

参数

input (Union[PromptValue, str, Sequence[Union[BaseMessage, List[str], Tuple[str, str], str, Dict[str, Any]]]]) – Runnable的输入。
config (Optional[RunnableConfig]) – 要使用的Runnable配置。默认为None。
kwargs (任意值) – 要传递给Runnable的附加关键字参数。
停止 (Optional[List[str]]) –

生成值

Runnable的输出。

返回类型

Iterator[str]

to_json() → Union[SerializedConstructor, SerializedNotImplemented]¶

将Runnable序列化为JSON。

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

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]]) –
关键字参数 (Any) –

返回类型

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

langchain_aws.llms.bedrock.Bedrock¶

Bedrock (知识库)的示例使用¶

`langchain_aws.llms.bedrock`.Bedrock¶