ChatMessagePromptTemplate

class langchain_core.prompts.chat.ChatMessagePromptTemplate

基础类：BaseStringMessagePromptTemplate

聊天消息提示模板。

param additional_kwargs: dict [Optional]

传递给提示模板的额外关键字参数。

param prompt: StringPromptTemplate [Required]

字符串提示模板。

param role: str [Required]

消息的角色。

async aformat(**kwargs: Any) → BaseMessage

异步格式化提示模板。

Parameters:

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

Returns:

格式化消息。

Return type:

BaseMessage

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

从kwargs异步格式化消息。

Parameters:

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

Returns:

基础消息列表。

Return type:

列表[BaseMessage]

format(**kwargs: Any) → BaseMessage

格式化提示模板。

Parameters:

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

Returns:

格式化消息。

Return type:

BaseMessage

format_messages(**kwargs: Any) → list[BaseMessage]

从kwargs格式化消息。

Parameters:

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

Returns:

基础消息列表。

Return type:

列表[BaseMessage]

classmethod from_template(template: str, template_format: Literal['f-string', 'mustache', 'jinja2'] = 'f-string', partial_variables: dict[str, Any] | None = None, **kwargs: Any) → MessagePromptTemplateT

从字符串模板创建一个类。

Parameters:

• template (str) – 一个模板。

• template_format (Literal['f-string', 'mustache', 'jinja2']) – 模板的格式。默认为“f-string”。

• partial_variables (dict[str, Any] | None) –

  一个可以用于部分填充模板的变量字典。

  例如，如果模板是

  ”{variable1} {variable2}”，并且 partial_variables 是 {“variable1”: “foo”}，那么最终的提示将是 “foo {variable2}”。 默认为 None。

• **kwargs (Any) – 传递给构造函数的关键字参数。

Returns:

该类的一个新实例。

Return type:

MessagePromptTemplateT

classmethod from_template_file(template_file: str | Path, input_variables: list[str], **kwargs: Any) → MessagePromptTemplateT

从模板文件创建一个类。

Parameters:

• template_file (str | Path) – 模板文件的路径。可以是字符串或路径。

• input_variables (list[str]) – 输入变量列表。

• **kwargs (Any) – 传递给构造函数的关键字参数。

Returns:

该类的一个新实例。

Return type:

MessagePromptTemplateT

pretty_print() → None

打印一个人类可读的表示。

Return type:

无

pretty_repr(html: bool = False) → str

人类可读的表示。

Parameters:

html (bool) – 是否格式化为HTML。默认为False。

Returns:

人类可读的表示。

Return type:

字符串

property input_variables: list[str]

此提示模板的输入变量。

Returns:

输入变量名称列表。