langchain_core.prompts.chat.ChatMessagePromptTemplate

class langchain_core.prompts.chat.ChatMessagePromptTemplate

继承自： BaseStringMessagePromptTemplate

聊天消息提示模板。

param additional_kwargs: dict [可选]

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

param prompt: StringPromptTemplate [必须]

字符串提示模板。

param role: str [必须]

消息的角色。

async aformat(**kwargs: Any) → BaseMessage

异步格式化提示模板。

参数

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

返回值

格式化后的消息。

返回类型

BaseMessage

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

从 kwargs 中异步格式化消息。

参数

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

返回值

BaseMessages 的列表。

返回类型

列表[BaseMessage]

format(**kwargs: Any) → BaseMessage

格式化提示模板。

参数

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

返回值

格式化后的消息。

返回类型

BaseMessage

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

从 kwargs 格式化消息。

参数

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

返回值

BaseMessages 的列表。

返回类型

列表[BaseMessage]

classmethod from_template(template: str, template_format: str = 'f-string', partial_variables: Optional[Dict[str, Any]] = None, **kwargs: Any) → MessagePromptTemplateT

从字符串模板创建类。

参数

• template (str) – 模板。

• template_format (str) – 模板的格式。默认为 “f-string”。

• partial_variables (可选[Dict[str, Any]]) –

  可以用来部分填充模板的变量字典。

  例如，如果模板是

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

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

返回值

此类的新的实例。

返回类型

MessagePromptTemplateT

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

根据模板文件创建一个类。

参数

• template_file (Union[str, Path]) – 模板文件的路径。字符串或路径对象。

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

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

返回值

此类的新的实例。

返回类型

MessagePromptTemplateT

pretty_print() → None

打印出人类可读的表示形式。

返回类型

None

pretty_repr(html: bool = False) → str

人类可读表示。

参数

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

返回值

人类可读表示。

返回类型

str

property input_variables: List[str]

此提示模板的输入变量。

返回值

输入变量名称的列表。