`langchain_core.prompts.few_shot`.FewShotPromptTemplate¶

注意

FewShotPromptTemplate 实现了标准 Runnable Interface。🏃

Runnable Interface 有一些额外的、在 runnables 中可用的方法，例如 with_types、with_retry、assign、bind 和 get_graph 等。

class langchain_core.prompts.few_shot.FewShotPromptTemplate[source]¶

基类: _FewShotPromptTemplateMixin, StringPromptTemplate

包含少量示例的提示模板。

初始化少量示例提示模板。

参数 example_prompt: PromptTemplate [必需]¶: 用于格式化单个示例的 PromptTemplate。

参数 example_selector: Optional[BaseExampleSelector] = None¶: 用于选择格式化到提示中的示例的 ExampleSelector。必须提供此选项或示例。

参数 example_separator: str = '\n\n'¶: 用于连接前缀、示例和后缀的字符串分隔符。

参数examples:Optional[List[dict]]=None¶: 格式化到提示中的示例。必须提供此参数或 example_selector。

参数input_types:Dict[str,Any]] [可选]¶: 提示模板期望变量类型的字典。如果没有提供，则假定所有变量均为字符串。

参数input_variables:List[str] [必须]¶: 变量名称的列表，这些变量的值作为输入提供给提示。

参数metadata:Optional[Dict[str,Any]]=None¶: 用于跟踪的元数据。

参数optional_variables:List[str]=[]¶: 可选变量名称列表，对于占位符或 MessagePlaceholder。这些变量从提示中自动推断，用户不必提供。

参数output_parser:Optional[BaseOutputParser=None¶: 如何解析在此格式提示上调用LLM的输出。

参数 partial_variables: Mapping[str, Any] [可选]¶

包含的局部变量字典。

局部变量填充模板，以便在每次调用提示时不需传入这些变量。

参数 prefix: str = ''¶: 放在示例前面的提示模板字符串。

参数 suffix: str [必须]¶: 放在示例后面的提示模板字符串。

参数 tags: Optional[List[str]] = None¶: 用于追踪的标签。

参数 template_format: Literal['f-string', 'jinja2'] = 'f-string'¶: 提示模板的格式。选项有：‘f-string’，‘jinja2’。

参数 validate_template: bool = False¶: 是否尝试验证模板。

async abatch(inputs: List[Input], config: Optional[Union[RunnableConfig, List[RunnableConfig]]] = None, *, return_exceptions: bool = False, **kwargs: Optional[Any]) → List[Output]¶

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

默认的批处理实现适用于 I/O 密集型可运行实体。

子类应根据实际情况覆盖此方法，以实现更有效的批处理；例如，如果基础可运行实体使用的 API 支持批处理模式。

参数

inputs (列表[Input]) – 要传递给可运行实体的输入列表。
config (可选[Union[RunnableConfig, 列表[RunnableConfig]]]) – 在调用可运行实体时使用的配置。该配置支持标准关键字，如‘标签’、‘元数据’用于跟踪目的，‘最大并发’用于控制并行执行的工作量，以及其他关键字。请参阅 RunnableConfig 获取更多详细信息。默认为 None。
return_exceptions (布尔值) – 是否返回异常而不是抛出异常。默认为 False。
kwargs (可选[任何]) – 传递给可运行实体的附加关键字参数。

返回

来自可运行实体的输出列表。

返回类型

列表[Output]

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

在输入列表上并行运行 invoke，在完成时产生结果。

参数

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

产生

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

返回类型

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

async aformat(**kwargs: Any) → str[来源]¶

基于输入异步生成字符串的提示格式化。

使用此方法生成提示的字符串表示。

参数: **kwargs （Any） – 格式化使用的关键字参数。
返回: 提示的字符串表示。
返回类型: str

async aformat_prompt(**kwargs: Any) → PromptValue¶

输入的异步格式提示。

参数: kwargs （Any） – 传递给提示模板的任何参数。
返回: 格式化后的字符串。
返回类型: PromptValue

async ainvoke(input: Dict, config: Optional[RunnableConfig] = None, **kwargs: Any) → PromptValue¶

异步调用提示。

参数

input （Dict） – 输入，提示的输入。
config （Optional[RunnableConfig]） – RunnableConfig，用于提示的配置。
kwargs –

返回

提示的输出。

返回类型

PromptValue

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: Input, config: Optional[RunnableConfig] = None, **kwargs: Optional[Any]) → AsyncIterator[Output]¶

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

参数

input (Input) – Runnable 的输入。
config (Optional[RunnableConfig]) – 用于 Runnable 的配置。默认为 None。
kwargs (可选[任何]) – 传递给可运行实体的附加关键字参数。

产生

Runnable 的输出。

返回类型

AsyncIterator[Output]

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 - 生成事件的 Runnable 的名称。
run_id: str - 与给定执行关联的、随机生成的 ID，表示在发出事件的 Runnable
中。作为父 Runnable 执行一部分的子 Runnable 被分配其自己的唯一 ID。
parent_ids: List[str] - 生成事件的父 Runnable 的 IDs。根 Runnable 将有一个空列表。
父 IDs 的顺序是从根到最近的父。仅适用于 API 的 v2 版本。API 的 v1 版本将返回空列表。
tags: Optional[List[str]] - 生成事件的 Runnable 的标签。
metadata: Optional[Dict[str, Any]] - 生成事件的 Runnable 的元数据。
data: Dict[str, Any]

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

注意此引用表格是针对 v2 版本的模式。

event	name	chunk	input	output
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	格式化文档
on_chain_stream	格式化文档	“hello world!, goodbye world!”
on_chain_end	格式化文档		【文档(…)]	“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’}	【文档(…), ..】
on_prompt_start	【模板名称】		{“question”：’hello’}
on_prompt_end	【模板名称】		{“question”：’hello’}	ChatPromptValue(messages: [SystemMessage, …])

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

自定义事件将仅在API的v2版本中出现！

自定义事件的格式如下

属性	类型	描述
name	str	事件的用户定义名称。
data	Any	与事件关联的数据。这可以是任何东西，尽管我们建议使其为JSON可序列化。

下面显示了与上面显示的标准事件相关的声明

格式化文档:

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 (Optional[Sequence[str]]) – 排除具有匹配类型的runnables的事件。
exclude_tags (Optional[Sequence[str]]) – 排除具有匹配标签的runnables的事件。
kwargs (Any) – 传递给Runnable的额外关键字参数。这些将传递给astream_log，因为此astream_events实现建立在astream_log上。

产生

StreamEvents的异步流。

引发

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

返回类型

AsyncIterator[Union[StandardStreamEvent, CustomStreamEvent]]

batch(inputs: List[Input], config: Optional[Union[RunnableConfig, List[RunnableConfig]]] = None, *, return_exceptions: bool = False, **kwargs: Optional[Any]) → List[Output]¶

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

默认的批处理实现适用于 I/O 密集型可运行实体。

子类应根据实际情况覆盖此方法，以实现更有效的批处理；例如，如果基础可运行实体使用的 API 支持批处理模式。

参数

inputs (列表[输入]) –
config (可选[联合[RunnableConfig, 列表[RunnableConfig]]]) –
return_exceptions (布尔值) –
kwargs (可选[任何]) –

返回类型

列表[Output]

batch_as_completed(inputs: Sequence[Input], config: Optional[Union[RunnableConfig, Sequence[RunnableConfig]]] = None, *, return_exceptions: bool = False, **kwargs: Optional[Any]) → Iterator[Tuple[int, Union[Output, Exception]]]¶

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

参数

inputs (Sequence[Input]) –
config (Optional[Union[RunnableConfig, Sequence[RunnableConfig]]]) –
return_exceptions (布尔值) –
kwargs (可选[任何]) –

返回类型

迭代器[Tuple[int, Union[Output, 异常]]]

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
)

format(**kwargs: Any) → str[source]¶

使用输入生成字符串来格式化提示。

使用此方法生成提示的字符串表示。

参数: **kwargs （Any） – 格式化使用的关键字参数。
返回: 提示的字符串表示。
返回类型: str

format_prompt(**kwargs: Any) → PromptValue¶

使用输入格式化提示。

参数: kwargs （Any） – 传递给提示模板的任何参数。
返回: 格式化后的字符串。
返回类型: PromptValue

invoke(input: Dict, config: Optional[RunnableConfig] = None) → PromptValue¶

调用提示。

参数

input （Dict） – 输入，提示的输入。
config （Optional[RunnableConfig]） – RunnableConfig，用于提示的配置。

返回

提示的输出。

返回类型

PromptValue

partial(**kwargs: Union[str, Callable[[], str]]) → BasePromptTemplate¶

返回提示模板的部分。

参数: kwargs (Union[str, Callable[[], str]]) – 联合[str, Callable[[], str], 设置的部分变量。
返回: 提示模板的部分。
返回类型: BasePromptTemplate

pretty_print() → None¶

打印提示的漂亮表示形式。

返回类型: None

pretty_repr(html: bool = False) → str¶

获取提示的漂亮表示形式。

参数: html (bool) – 是否返回HTML格式的字符串。
返回: 提示的漂亮表示形式。
返回类型: str

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

将提示模板保存到文件。

参数: file_path (Union[Path, str]) – 保存提示模板的路径。
引发: ValueError – 如果提供了example_selector。
返回类型: None

stream(input: Input, config: Optional[RunnableConfig] = None, **kwargs: Optional[Any]) → Iterator[Output]¶

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

参数

input (Input) – Runnable 的输入。
config (Optional[RunnableConfig]) – 用于 Runnable 的配置。默认为 None。
kwargs (可选[任何]) – 传递给可运行实体的附加关键字参数。

产生

Runnable 的输出。

返回类型

Iterator[Output]

to_json() → Union[SerializedConstructor, SerializedNotImplemented]¶

将Runnable序列化为JSON。

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

使用FewShotPromptTemplate的示例¶

langchain_core.prompts.few_shot.FewShotPromptTemplate¶

使用FewShotPromptTemplate的示例¶

`langchain_core.prompts.few_shot`.FewShotPromptTemplate¶