langchain_core.prompts.chat.SystemMessagePromptTemplate

class langchain_core.prompts.chat.SystemMessagePromptTemplate[源代码]

基类:_StringImageMessagePromptTemplate

系统消息提示模板。这是一种不发送给用户的消息。

param additional_kwargs: dict [可选]

传递给提示模板的附加关键字参数。

param prompt: Union[StringPromptTemplate, List[Union[StringPromptTemplate, ImagePromptTemplate]]] [必需]

提示模板。

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: Union[str, List[Union[str, _TextTemplateParam, _ImageTemplateParam]]], template_format: str = 'f-string', *, partial_variables: Optional[Dict[str, Any]] = None, **kwargs: Any) _StringImageMessagePromptTemplateT

根据字符串模板创建一个类。

参数
  • template (Union[str, List[Union[str, _TextTemplateParam, _ImageTemplateParam]]) – 一个模板。

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

  • partial_variables (Optional[Dict[str, Any]]) – 可用于部分替代的变量字典。默认为None。

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

返回

此类的新的实例。

抛出

ValueError – 如果模板不是字符串或字符串列表。

返回类型

_StringImageMessagePromptTemplateT

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

从模板文件创建一个类。

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

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

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

返回

此类的新的实例。

返回类型

_StringImageMessagePromptTemplateT

pretty_print() None

打印可读的表示形式。

返回类型

None

pretty_repr(html: bool = False) str

人类可读的表示。

参数

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

返回

人类可读的表示。

返回类型

str

property input_variables: List[str]

此提示模板的输入变量。

返回

输入变量名称列表。

使用 SystemMessagePromptTemplate 的示例