langchain_core.prompts.prompt
.PromptTemplate¶
注意
PromptTemplate 实现了标准的 Runnable 接口
。 🏃
Runnable 接口
具有在 runnables 上可用的其他方法,例如 with_types
, with_retry
, assign
, bind
, get_graph
等。
- class langchain_core.prompts.prompt.PromptTemplate[source]¶
-
用于语言模型的 Prompt 模板。
Prompt 模板由字符串模板组成。它接受用户的一组参数,这些参数可用于为语言模型生成 prompt。
模板可以使用 f-strings(默认)或 jinja2 语法进行格式化。
- 安全警告:
建议使用 template_format=”f-string” 而不是 template_format=”jinja2”,或者确保永远不要接受来自不受信任来源的 jinja2 模板,因为它们可能导致任意 Python 代码执行。
从 LangChain 0.0.329 版本开始,Jinja2 模板将默认使用 Jinja2 的 SandboxedEnvironment 渲染。这种沙箱化应被视为尽力而为的方法,而不是安全保证,因为它是一种选择退出而不是选择加入的方法。
尽管有沙箱机制,我们仍然建议永远不要使用来自不受信任来源的 jinja2 模板。
示例
from langchain_core.prompts import PromptTemplate # Instantiation using from_template (recommended) prompt = PromptTemplate.from_template("Say {foo}") prompt.format(foo="bar") # Instantiation using initializer prompt = PromptTemplate(template="Say {foo}")
- param input_types: Dict[str, Any] [Optional]¶
提示模板期望的变量类型的字典。如果未提供,则所有变量都假定为字符串。
- param input_variables: List[str] [Required]¶
作为提示输入需要其值的变量名称列表。
- param metadata: Optional[Dict[str, Any]] = None¶
用于追踪的元数据。
- param optional_variables: List[str] = []¶
optional_variables: 用于占位符或 MessagePlaceholder 的可选变量名称列表。这些变量是从 prompt 自动推断出来的,用户无需提供。
- param output_parser: Optional[BaseOutputParser] = None¶
如何解析在此格式化提示上调用 LLM 的输出。
- param partial_variables: Mapping[str, Any] [Optional]¶
提示模板携带的部分变量的字典。
部分变量填充模板,以便您无需在每次调用提示时都传入它们。
- param tags: Optional[List[str]] = None¶
用于追踪的标签。
- param template: str [Required]¶
Prompt 模板。
- param template_format: Literal['f-string', 'mustache', 'jinja2'] = 'f-string'¶
Prompt 模板的格式。选项包括:‘f-string’、‘mustache’、‘jinja2’。
- param 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。
batch 的默认实现适用于 IO 绑定的 runnables。
如果子类可以更有效地进行批处理,则应覆盖此方法;例如,如果底层 Runnable 使用支持批处理模式的 API。
- 参数
inputs (List[Input]) – Runnable 的输入列表。
config (Optional[Union[RunnableConfig, List[RunnableConfig]]]) – 调用 Runnable 时使用的配置。该配置支持诸如 ‘tags’、‘metadata’(用于追踪目的)、‘max_concurrency’(用于控制并行执行多少工作)以及其他键等标准键。有关更多详细信息,请参阅 RunnableConfig。默认为 None。
return_exceptions (bool) – 是否返回异常而不是引发异常。默认为 False。
kwargs (Optional[Any]) – 传递给 Runnable 的其他关键字参数。
- 返回值
来自 Runnable 的输出列表。
- 返回类型
List[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]]] ¶
并行运行 ainvoke 处理输入列表,并在结果完成时生成结果。
- 参数
inputs (Sequence[Input]) – Runnable 的输入列表。
config (Optional[Union[RunnableConfig, Sequence[RunnableConfig]]]) – 调用 Runnable 时使用的配置。该配置支持诸如 ‘tags’、‘metadata’(用于追踪目的)、‘max_concurrency’(用于控制并行执行多少工作)以及其他键等标准键。有关更多详细信息,请参阅 RunnableConfig。默认为 None。默认为 None。
return_exceptions (bool) – 是否返回异常而不是引发异常。默认为 False。
kwargs (Optional[Any]) – 传递给 Runnable 的其他关键字参数。
- Yields
输入索引和 Runnable 输出的元组。
- 返回类型
AsyncIterator[Tuple[int, Union[Output, Exception]]]
- async aformat(**kwargs: Any) FormatOutputType ¶
使用输入异步格式化 prompt。
- 参数
kwargs (Any) – 要传递给 prompt 模板的任何参数。
- 返回值
格式化的字符串。
- 返回类型
FormatOutputType
示例
await prompt.aformat(variable1="foo")
- async aformat_prompt(**kwargs: Any) PromptValue ¶
使用输入异步格式化 prompt。
- 参数
kwargs (Any) – 要传递给 prompt 模板的任何参数。
- 返回值
格式化的字符串。
- 返回类型
- async ainvoke(input: Dict, config: Optional[RunnableConfig] = None, **kwargs: Any) PromptValue ¶
异步调用 prompt。
- 参数
input (Dict) – Dict,prompt 的输入。
config (Optional[RunnableConfig]) – RunnableConfig,prompt 的配置。
kwargs (Any) –
- 返回值
prompt 的输出。
- 返回类型
- as_tool(args_schema: Optional[Type[BaseModel]] = None, *, name: Optional[str] = None, description: Optional[str] = None, arg_types: Optional[Dict[str, Type]] = None) BaseTool ¶
Beta
此 API 处于 Beta 阶段,将来可能会发生变化。
从 Runnable 创建 BaseTool。
as_tool
将从 Runnable 实例化一个具有名称、描述和args_schema
的 BaseTool。在可能的情况下,模式是从runnable.get_input_schema
推断出来的。或者(例如,如果 Runnable 接受 dict 作为输入,并且未键入特定的 dict 键),可以使用args_schema
直接指定模式。您也可以传递arg_types
以仅指定必需的参数及其类型。- 参数
args_schema (Optional[Type[BaseModel]]) – 工具的模式。默认为 None。
name (Optional[str]) – 工具的名称。默认为 None。
description (Optional[str]) – 工具的描述。默认为 None。
arg_types (Optional[Dict[str, Type]]) – 参数名称到类型的字典。默认为 None。
- 返回值
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 的其他关键字参数。
- Yields
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]] ¶
Beta
此 API 处于 Beta 阶段,将来可能会发生变化。
生成事件流。
用于创建一个迭代器,遍历 StreamEvents,这些事件提供关于 Runnable 进度的实时信息,包括来自中间结果的 StreamEvents。
StreamEvent 是一个具有以下模式的字典
event
: str - 事件名称的格式为:格式:on_[runnable_type]_(start|stream|end)。
name
: str - 生成事件的 Runnable 的名称。run_id
: str - 随机生成的 ID,与给定 Runnable 执行的事件相关联。发出事件的 Runnable 的执行。作为父 Runnable 执行一部分调用的子 Runnable 将被分配其自己唯一的 ID。
parent_ids
: List[str] - 生成事件的父 Runnable 的 ID。根 Runnable 将有一个空列表。父 ID 的顺序是从根到直接父级。仅适用于 API 的 v2 版本。API 的 v1 版本将返回一个空列表。
tags
: Optional[List[str]] - 生成事件的 Runnable 的标签。事件。
metadata
: Optional[Dict[str, Any]] - Runnable 的元数据生成事件的 Runnable 的元数据。
data
: Dict[str, Any]
下表说明了各种链可能发出的一些事件。为了简洁起见,元数据字段已从表中省略。链定义已包含在表格之后。
注意 此参考表适用于 V2 版本的架构。
event
name
chunk
input
output
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
[retriever name]
{“query”: “hello”}
on_retriever_end
[retriever name]
{“query”: “hello”}
[Document(…), ..]
on_prompt_start
[template_name]
{“question”: “hello”}
on_prompt_end
[template_name]
{“question”: “hello”}
ChatPromptValue(messages: [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}
prompt:
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_events 的此实现构建在 astream_log 之上。
- Yields
StreamEvents 的异步流。
- Raises
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。
batch 的默认实现适用于 IO 绑定的 runnables。
如果子类可以更有效地进行批处理,则应覆盖此方法;例如,如果底层 Runnable 使用支持批处理模式的 API。
- 参数
inputs (List[Input]) –
config (Optional[Union[RunnableConfig, List[RunnableConfig]]]) –
return_exceptions (bool) –
kwargs (Optional[Any]) –
- 返回类型
List[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 (bool) –
kwargs (Optional[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] ¶
在运行时配置特定的 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) – 要传递给 prompt 模板的任何参数。
- 返回值
格式化的字符串。
- 返回类型
str
- format_prompt(**kwargs: Any) PromptValue ¶
使用输入格式化提示。
- 参数
kwargs (Any) – 要传递给 prompt 模板的任何参数。
- 返回值
格式化的字符串。
- 返回类型
- classmethod from_examples(examples: List[str], suffix: str, input_variables: List[str], example_separator: str = '\n\n', prefix: str = '', **kwargs: Any) PromptTemplate [source]¶
使用前缀和后缀以列表格式获取示例以创建提示。
旨在用作从示例动态创建提示的方法。
- 参数
examples (List[str]) – 要在提示中使用的示例列表。
suffix (str) – 示例列表后要添加的字符串。通常应设置用户的输入。
input_variables (List[str]) – 最终提示模板将期望的变量名称列表。
example_separator (str) – 在示例之间使用的分隔符。默认为两个换行符。
prefix (str) – 应在任何示例之前添加的字符串。通常包括示例。默认为空字符串。
kwargs (Any) –
- 返回值
生成的最终提示。
- 返回类型
- classmethod from_file(template_file: Union[str, Path], input_variables: Optional[List[str]] = None, encoding: Optional[str] = None, **kwargs: Any) PromptTemplate [source]¶
从文件加载提示。
- 参数
template_file (Union[str, Path]) – 包含提示模板的文件的路径。
input_variables (Optional[List[str]]) – [已弃用] 最终提示模板将期望的变量名称列表。默认为 None。
encoding (Optional[str]) – 用于打开模板文件的编码系统。如果未提供,将使用操作系统默认值。
kwargs (Any) –
- 返回类型
input_variables 被忽略,因为 from_file 现在委托给 from_template()。
- 返回值
从文件加载的提示。
- 参数
template_file (Union[str, Path]) –
input_variables (Optional[List[str]]) –
encoding (Optional[str]) –
kwargs (Any) –
- 返回类型
- classmethod from_template(template: str, *, template_format: str = 'f-string', partial_variables: Optional[Dict[str, Any]] = None, **kwargs: Any) PromptTemplate [source]¶
从模板加载提示模板。
- 安全警告:
建议使用 template_format=”f-string” 而不是 template_format=”jinja2”,或者确保永远不要接受来自不受信任来源的 jinja2 模板,因为它们可能导致任意 Python 代码执行。
从 LangChain 0.0.329 版本开始,Jinja2 模板将默认使用 Jinja2 的 SandboxedEnvironment 渲染。这种沙箱化应被视为尽力而为的方法,而不是安全保证,因为它是一种选择退出而不是选择加入的方法。
尽管进行了沙盒处理,但我们建议永远不要使用来自不受信任来源的 jinja2 模板。
- 参数
template (str) – 要加载的模板。
template_format (str) – 模板的格式。对于 jinja2 使用 jinja2,对于 f-strings 使用 f-string 或 None。默认为 f-string。
partial_variables (Optional[Dict[str, Any]]) –
- 可用于部分填充模板的变量字典。
填充模板。例如,如果模板是
“{variable1} {variable2}”,并且 partial_variables 是 {“variable1”: “foo”},则最终提示将为 “foo {variable2}”。默认为 None。
kwargs (Any) – 要传递给提示模板的任何其他参数。
- 返回值
从模板加载的提示模板。
- 返回类型
- invoke(input: Dict, config: Optional[RunnableConfig] = None) PromptValue ¶
调用提示。
- 参数
input (Dict) – Dict,prompt 的输入。
config (Optional[RunnableConfig]) – RunnableConfig,prompt 的配置。
- 返回值
prompt 的输出。
- 返回类型
- partial(**kwargs: Union[str, Callable[[], str]]) BasePromptTemplate ¶
返回提示模板的部分内容。
- 参数
kwargs (Union[str, Callable[[], str]]) – Union[str, Callable[[], str], partial variables to set.
- 返回值
提示模板的局部变量。
- 返回类型
- pretty_print() None ¶
打印提示的精美表示形式。
- 返回类型
None
- pretty_repr(html: bool = False) str ¶
获取提示的精美表示形式。
- 参数
html (bool) – 是否返回 HTML 格式的字符串。
- 返回值
提示的精美表示形式。
- 返回类型
str
- save(file_path: Union[Path, str]) None ¶
保存提示。
- 参数
file_path (Union[Path, str]) – 保存提示的目录路径。
- Raises
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 的其他关键字参数。
- Yields
Runnable 的输出。
- 返回类型
Iterator[Output]
- to_json() Union[SerializedConstructor, SerializedNotImplemented] ¶
将 Runnable 序列化为 JSON 格式。
- 返回值
Runnable 的 JSON 可序列化表示形式。
- 返回类型