langchain_core.prompts.few_shot.FewShotChatMessagePromptTemplate

注意

FewShotChatMessagePromptTemplate实现了标准Runnable接口。🏃

Runnable接口具有runnables上的额外方法，如with_types、with_retry、assign、bind和更多。

class langchain_core.prompts.few_shot.FewShotChatMessagePromptTemplate[源代码]

Bases: langchain_core.prompts.chat.BaseChatPromptTemplate, _FewShotPromptTemplateMixin

支持少量示例的聊天提示模板。

该提示模板生成的高层结构是由前缀消息、示例消息和后缀消息组成的消息列表。

这种结构可以用来创建如下的对话，包含中间示例：

系统：你是一个有帮助的人工智能助手。人类：2+2 等于多少？AI: 答案是 4。人类：2+3 等于多少？AI: 答案是 5。人类：4+4 等于多少？

此提示模板可用于生成固定示例列表或根据输入动态选择示例。

示例

具有固定示例列表的提示模板（匹配上述示例对话）

from langchain_core.prompts import (
    FewShotChatMessagePromptTemplate,
    ChatPromptTemplate
)

examples = [
    {"input": "2+2", "output": "4"},
    {"input": "2+3", "output": "5"},
]

example_prompt = ChatPromptTemplate.from_messages(
    [('human', '{input}'), ('ai', '{output}')]
)

few_shot_prompt = FewShotChatMessagePromptTemplate(
    examples=examples,
    # This is a prompt template used to format each individual example.
    example_prompt=example_prompt,
)

final_prompt = ChatPromptTemplate.from_messages(
    [
        ('system', 'You are a helpful AI Assistant'),
        few_shot_prompt,
        ('human', '{input}'),
    ]
)
final_prompt.format(input="What is 4+4?")

具有动态选择示例的提示模板

from langchain_core.prompts import SemanticSimilarityExampleSelector
from langchain_core.embeddings import OpenAIEmbeddings
from langchain_core.vectorstores import Chroma

examples = [
    {"input": "2+2", "output": "4"},
    {"input": "2+3", "output": "5"},
    {"input": "2+4", "output": "6"},
    # ...
]

to_vectorize = [
    " ".join(example.values())
    for example in examples
]
embeddings = OpenAIEmbeddings()
vectorstore = Chroma.from_texts(
    to_vectorize, embeddings, metadatas=examples
)
example_selector = SemanticSimilarityExampleSelector(
    vectorstore=vectorstore
)

from langchain_core import SystemMessage
from langchain_core.prompts import HumanMessagePromptTemplate
from langchain_core.prompts.few_shot import FewShotChatMessagePromptTemplate

few_shot_prompt = FewShotChatMessagePromptTemplate(
    # Which variable(s) will be passed to the example selector.
    input_variables=["input"],
    example_selector=example_selector,
    # Define how each example will be formatted.
    # In this case, each example will become 2 messages:
    # 1 human, and 1 AI
    example_prompt=(
        HumanMessagePromptTemplate.from_template("{input}")
        + AIMessagePromptTemplate.from_template("{output}")
    ),
)
# Define the overall prompt.
final_prompt = (
    SystemMessagePromptTemplate.from_template(
        "You are a helpful AI Assistant"
    )
    + few_shot_prompt
    + HumanMessagePromptTemplate.from_template("{input}")
)
# Show the prompt
print(final_prompt.format_messages(input="What's 3+3?"))  # noqa: T201

# Use within an LLM
from langchain_core.chat_models import ChatAnthropic
chain = final_prompt | ChatAnthropic(model="claude-3-haiku-20240307")
chain.invoke({"input": "What's 3+3?"})
参数 example_prompt: Union[BaseMessagePromptTemplate, BaseChatPromptTemplate] [必填]

格式化每个示例的类。

参数 example_selector: Optional[BaseExampleSelector] = None

用于从示例中选择要格式化到提示中的ExampleSelector。必须提供此或examples中的一个。

参数 examples: Optional[List[dict]] = None

要格式化到提示中的示例。必须提供此或example_selector中的一个。

参数 input_types: Dict[str, Any] [Optional]

提示模板预期的变量类型的字典。如果没有提供，则假定所有变量都是字符串。

参数 input_variables: List[str] [Optional]

提示模板将使用的变量名称列表，如果提供了example_selector。

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

用于跟踪的元数据。

param optional_variables: List[str] = []

optional_variables: 可选变量的名称列表，这些变量用于占位符或MessagePlaceholder。这些变量会自动从提示和用户那里推断出来，因此用户无需提供它们。

param output_parser: Optional[BaseOutputParser] = None

如何解析调用LLM时在此格式提示上的输出。

param partial_variables: Mapping[str, Any] [Optional]

提示模板携带的部分变量字典。

部分变量填充模板，这样每次调用提示时就不需要提供它们。

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

用于追踪的标签。

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

默认实现使用asioyio.run来并行运行invoke。

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

子类如果可以更有效地批量处理，应覆盖此方法；例如，如果底层运行对象使用支持批处理模式的API。

参数

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

  • config (可选[联合[RunnableConfig, 列表[RunnableConfig]]]) – 在调用Runnable时使用的配置。配置支持诸如‘tags’、‘metadata’（用于跟踪目的）、‘max_concurrency’（用于控制并行执行的工作量）等其他键。请参阅RunnableConfig以获取更多详细信息。默认为None。

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

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

返回值

来自Runnable的输出列表。

返回类型

列表[输出]

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的额外关键字参数。

产生结果

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

返回类型

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

async aformat(**kwargs: Any) → str[source]

异步格式化提示，生成一个字符串。

使用此方法生成包含聊天信息的提示的字符串表示形式。

适用于输入到基于字符串的完成语言模型或调试。

参数

**kwargs (Any) – 使用于格式化的关键字参数。

返回值

提示的字符串表示

返回类型

str

async aformat_messages(**kwargs: Any) → List[BaseMessage][source]

异步将 kwargs 格式化为消息列表。

参数

**kwargs (Any) – 用于填充消息模板的关键字参数。

返回值

已填充所有模板变量的格式化消息列表。

返回类型

List[BaseMessage]

async aformat_prompt(**kwargs: Any) → PromptValue

异步格式化提示。应返回一个 PromptValue。

参数

**kwargs (Any) – 使用于格式化的关键字参数。

返回值

提示值。

返回类型

提示值

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

异步调用提示。

参数

  • input (Dict) – 字典，提示的输入。

  • config (Optional[RunnableConfig]) – RunnableConfig，提示的配置。

  • kwargs (Any) –

返回值

提示的输出。

返回类型

提示值

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

测试版

此API为测试版，未来可能会有变化。

从可运行对象创建BaseTool。

as_tool将从Runnable中实例化一个具有名称、描述和args_schema的BaseTool。 wherever 可能，将推断出runnable.get_input_schema中的模式。作为替代（例如，如果Runnable接受字典作为输入，且具体的字典关键字未指定类型），可以使用args_schema直接指定模式。您还可以通过传递arg_types仅指定所需的参数及其类型。

参数

  • args_schema ([Optional][类型[BaseModel]]) – 工具的模式。默认为None。

  • name ([Optional][]) – 工具的名称。默认为None。

  • description ([Optional][]) – 工具的描述。默认为None。

  • arg_types ([Optional][]) – 参数名称到类型的字典。默认为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, config, **kwargs: Optional[Any]) → AsyncIterator[Output]

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

参数

  • input (输入) – Runnable的输入。

  • config ([Optional][]) – 要为Runnable使用的配置。默认为None。

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

产生结果

Runnable的输出。

返回类型

AsyncIterator[输出]

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: 字符串 - 生成事件的Runnable的名称。

  • run_id: 字符串 - 与给定执行关联的随机生成的ID。

    引发事件的Runnable。作为父Runnable执行部分被调用的子Runnable将分配一个唯一的ID。

  • parent_ids: 列表[str] - 生成事件的父Runnable的ID。

    根Runnable将有一个空列表。父ID的顺序是从根到直接父级。仅适用于API的v2版本。API的v1版本将返回空列表。

  • tags: 可选[列表[str]] - 生成事件的Runnable的标记。

  • metadata: 可选[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!，再见世界！”

on_chain_end

格式文档

[Document(…)]

“hello world!，再见世界！”

on_tool_start

某些工具

{“x": 1, "y": "2”}

on_tool_end

某些工具

{“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版本中呈现！

自定义事件具有以下格式

属性

类型

描述

name

str

事件的自定义名称。

数据

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)

某些工具:

@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)
参数

  • 输入 (Any) – Runnable的输入。

  • 配置文件 (可选 [] RunnableConfig) – 要使用的Runnable的配置文件。

  • 版本 (文字 [‘v1’, ‘v2’]) – 要使用的模式版本。用户应使用v2。 v1是为了向后兼容，并在0.4.0中将被弃用。在API稳定之前不会分配默认值。自定义事件仅在v2中呈现。

  • 包含名称 (可选 [] 序列 [] str) – 仅包含具有匹配名称的runnables的事件。

  • 包含类型 (可选 [] 序列 [ str ]) – 仅包含具有匹配类型的runnables的事件。

  • 包含标记 (可选 [] 序列 [ str ]) – 仅包含具有匹配标记的runnables的事件。

  • 排除名称 (可选 [] 序列 [ str ]) – 排除具有匹配名称的runnables的事件。

  • exclude_types (可选[序列[str]]) – 从具有匹配类型的可运行项目排除事件。

  • exclude_tags (可选[序列[str]]) – 从具有匹配标签的可运行项目中排除事件。

  • kwargs (任何) –传递给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]

默认实现以线程池执行程序并行运行invoke。

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

子类如果可以更有效地批量处理，应覆盖此方法；例如，如果底层运行对象使用支持批处理模式的API。

参数

  • inputs (列表[Input]) –

  • config (可选[Union[RunnableConfig, 列表[RunnableConfig]]]) –

  • return_exceptions (布尔值) –

  • kwargs (可选[任何]) –

返回类型

列表[输出]

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 (可选[任何]) –

返回类型

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]

配置在运行时可以设置的运行时替代方案。

参数

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

在运行时配置特定的可运行字段。

参数

**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
)
format(**kwargs: Any) → str[source]

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

使用此方法生成包含聊天信息的提示的字符串表示形式。

适用于输入到基于字符串的完成语言模型或调试。

参数

**kwargs (Any) – 使用于格式化的关键字参数。

返回值

提示的字符串表示

返回类型

str

format_messages(**kwargs: Any) → List[BaseMessage][source]

将 kwargs 格式化为消息列表。

参数

**kwargs (Any) – 用于填充消息模板的关键字参数。

返回值

已填充所有模板变量的格式化消息列表。

返回类型

List[BaseMessage]

format_prompt(**kwargs: Any) → PromptValue

格式化提示。应返回一个PromptValue。

参数

**kwargs (Any) – 使用于格式化的关键字参数。

返回值

提示值。

返回类型

提示值

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

调用提示。

参数

  • input (Dict) – 字典，提示的输入。

  • config (Optional[RunnableConfig]) – RunnableConfig，提示的配置。

返回值

提示的输出。

返回类型

提示值

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

返回提示模板的部分。

参数

kwargs (Union[str, Callable[[], str]]) – 要设置的联合字符串、可调用函数的变量。

返回值

提示模板的部分。

返回类型

BasePromptTemplate

pretty_print() → None

打印可读性表示。

返回类型

None

pretty_repr(html: bool = False) → str[source]

返回提示模板的精美表示。

参数

html (bool) – 是否返回HTML格式的字符串。

返回值

提示模板的精美表示。

返回类型

str

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

保存提示。

参数

file_path (Union[Path, str]) – 保存提示的目录路径。

触发

  • ValueError – 如果提示包含部分变量。

  • ValueError – 如果文件路径不是json或yaml格式。

  • NotImplementedError – 如果提示类型未实现。

返回类型

None

示例：.. code-block:: python

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

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

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

参数

  • input (输入) – Runnable的输入。

  • config ([Optional][]) – 要为Runnable使用的配置。默认为None。

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

产生结果

Runnable的输出。

返回类型

Iterator[Output]

to_json() → Union[SerializedConstructor, SerializedNotImplemented]

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

返回值

可序列化Runnable的JSON表示。

返回类型

Union[SerializedConstructor, SerializedNotImplemented]

使用FewShotChatMessagePromptTemplate的示例