`langchain_core.prompts.string`.StringPromptTemplate¶

注意

StringPromptTemplate 实现了标准的 Runnable Interface 🏃

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

class langchain_core.prompts.string.StringPromptTemplate[source]¶

基类: BasePromptTemplate, ABC

String prompt 提供了暴露 format 方法，该方法返回一个提示。

param input_types: Dict[str, Any] [Optional]¶: 一个指示 prompt 模板期望的变量类型的字典。如果未提供，则假定所有变量都是字符串。

param input_variables: List[str] [Required]¶: 一个必须作为输入值传递给提示的变量的名称列表。

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

参数 optional_variables: List[str]= []¶: optional_variables：表示可选变量的名称列表，用于占位符或MessagePlaceholder。这些变量将自动从提示中推断出来，用户无需提供它们。

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

参数 partial_variables: Mapping[str, Any] [Optional]¶

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

局部变量填充模板，这样您无需每次调用提示时都传入它们。

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

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

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

默认的批处理实现对I/O密集型runnables运行良好。

子类应该在能够更有效地批处理的情况下重写此方法；例如，如果底层的Runnable使用支持批量模式的API。

参数

inputs (][Input]) – 传递给Runnable的输入列表。
config (Optional[Union[RunnableConfig, List[RunnableConfig]]]) – 调用Runnable时使用的配置。配置支持标准键，如‘tags’、‘metadata’用于追踪目的，‘max_concurrency’用于控制并行完成任务的数量，以及其他键。有关详细信息，请参阅RunnableConfig。默认为None。
return_exceptions (bool) – 是否返回异常而不是引发它们。默认为False。
kwargs (Optional[Any]) – 向Runnable传递的额外关键字参数。

返回

从Runnable生成的输出列表。

返回类型

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

在多个输入上并行运行rinvoke，按完成顺序产生结果。

参数

inputs (Sequence[Input]) – Runnable的输入列表。
config (Optional[Union[RunnableConfig, Sequence[RunnableConfig]]]) – 调用Runnable时使用的配置。该配置支持标准键，例如用于跟踪的‘tags’、‘metadata’，控制并行工作量的‘max_concurrency’以及其他键。请参阅RunnableConfig以获取更多详细信息。默认为None。
return_exceptions (bool) – 是否返回异常而不是引发它们。默认为False。
kwargs (Optional[Any]) – 向Runnable传递的额外关键字参数。

产出

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

返回类型

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

async aformat(**kwargs: Any) → FormatOutputType¶

使用输入异步格式化提示。

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

示例

await prompt.aformat(variable1="foo")

async aformat_prompt(**kwargs: Any) → PromptValue[来源]¶

使用输入异步格式化提示。

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

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

异步调用提示。

参数

input (Dict) – Dict，提示的输入。
config (可选[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将从可运行对象实例化一个BaseTool，包括名称、描述和args_schema。在可能的情况下，模式通过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 (Optional[Any]) – 向Runnable传递的额外关键字参数。

产出

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为测试版，未来可能发生变化。

生成事件流。

用于创建对提供有关 Runnable 进展的实时信息的 StreamEvents 的迭代器，包括来自中间结果的 StreamEvents。

StreamEvent 是一个包含以下模式的字典

event: str - 事件名称遵循以下格式：
格式: on_[runnable_type]_(start|stream|end)。
name: str - 生成事件的 Runnable 的名称。
run_id: str - 与给定执行中发射事件的 Runnable 相关的随机生成的 ID。
作为父 Runnable 执行的一部分被调用的子 Runnable 会被分配其自己的唯一 ID。
parent_ids: List[str] - 生成事件的父Runnable的 IDs。
根 Runnable 将有一个空列表。父 IDs 的顺序是从根到直接父。
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”: [[SystemMessage, HumanMessage]]}
on_chat_model_stream	[模型名称]	AIMessageChunk(内容="hello")
on_chat_model_end	[模型名称]		{“messages”: [[SystemMessage, HumanMessage]]}	AIMessageChunk(内容="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		[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	[检索器名称]		{“查询”： “hello”}
on_retriever_end	[检索器名称]		{“查询”： “hello”}	[Document(…), ..]
on_prompt_start	[模板名称]		{“问题”： “hello”}
on_prompt_end	[模板名称]		{“问题”： “hello”}	ChatPromptValue(消息：[SystemMessage, …])

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

自定义事件仅在API的v2版本中才能显示出来！

自定义事件的格式如下

属性	类型	描述
name	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']) – 要使用的模式版本，为v2或v1。用户应使用v2。 v1用于向后兼容，将在0.4.0中弃用。默认值将在API稳定之前不分配。自定义事件仅在v2中显示。
include_names (Optional[Sequence[str]]) – 仅包括具有匹配名称的Runnable的事件。
include_types (Optional[Sequence[str]]) – 仅包括具有匹配类型的Runnable的事件。
include_tags (Optional[Sequence[str]]) – 仅包括具有匹配标签的Runnable的事件。
exclude_names (Optional[Sequence[str]]) – 排除具有匹配名称的Runnable的事件。
exclude_types (Optional[Sequence[str]]) – 排除具有匹配类型的Runnable的事件。
exclude_tags (Optional[Sequence[str]]) – 排除具有匹配标签的Runnable的事件。
kwargs (Any) – 将传递给Runnable的额外关键字参数。这些将被传递给astream_log，因为本实现基于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密集型runnables运行良好。

子类应该在能够更有效地批处理的情况下重写此方法；例如，如果底层的Runnable使用支持批量模式的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]]]¶

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

参数

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
)

abstract format(**kwargs: Any) → FormatOutputType¶

使用输入格式化提示。

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

示例

prompt.format(variable1="foo")

format_prompt(**kwargs: Any) → PromptValue[source]¶

使用输入格式化提示。

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

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

调用提示。

参数

input (Dict) – Dict，提示的输入。
config (可选[RunnableConfig]) – RunnableConfig，提示的配置。

返回

提示的输出。

返回类型

PromptValue

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

返回提示模板的部分。

参数: kwargs (Union[str, Callable[[], str]]) – 字符串、可调用函数或部分的变量。
返回: 提示模板的一部分。
返回类型: BasePromptTemplate

pretty_print() → None[source]¶

打印提示的漂亮表示。

返回类型: 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 (Input) – Runnable 的输入。
config (Optional[RunnableConfig]) – 用于 Runnable 的配置。默认值为 None。
kwargs (Optional[Any]) – 向Runnable传递的额外关键字参数。

产出

Runnable 的输出。

返回类型

Iterator[Output]

to_json() → Union[SerializedConstructor, SerializedNotImplemented]¶

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

返回: 可序列化为JSON的可运行对象表示。
返回类型: Union[SerializedConstructor, SerializedNotImplemented]

langchain_core.prompts.string.StringPromptTemplate¶

`langchain_core.prompts.string`.StringPromptTemplate¶