langchain_core.prompts.chat
.AIMessagePromptTemplate¶
- class langchain_core.prompts.chat.AIMessagePromptTemplate[source]¶
Bases:
_StringImageMessagePromptTemplate
AI消息提示模板。这是AI发送的消息。
Create a new model by parsing and validating input data from keyword arguments.
Raises ValidationError if the input data cannot be parsed to form a valid model.
- param additional_kwargs: dict [Optional]¶
传递给提示模板的额外关键字参数。
- param prompt: Union[langchain_core.prompts.string.StringPromptTemplate, List[Union[langchain_core.prompts.string.StringPromptTemplate, langchain_core.prompts.image.ImagePromptTemplate]]] [Required]¶
提示模板。
- async aformat(**kwargs: Any) BaseMessage ¶
格式化提示模板。
- 参数:
**kwargs: 用于格式化的关键字参数。
- 返回:
格式化后的消息。
- Parameters
kwargs (Any) –
- Return type
- async aformat_messages(**kwargs: Any) List[BaseMessage] ¶
格式化kwargs中的消息。应返回一个BaseMessages列表。
- 参数:
**kwargs:用于格式化的关键字参数。
- 返回:
BaseMessages列表。
- Parameters
kwargs (Any) –
- Return type
List[BaseMessage]
- classmethod construct(_fields_set: Optional[SetStr] = None, **values: Any) Model ¶
Creates a new model setting __dict__ and __fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed. Behaves as if Config.extra = ‘allow’ was set since it adds all passed values
- Parameters
_fields_set (Optional[SetStr]) –
values (Any) –
- Return type
Model
- copy(*, include: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, exclude: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, update: Optional[DictStrAny] = None, deep: bool = False) Model ¶
Duplicate a model, optionally choose which fields to include, exclude and change.
- Parameters
include (Optional[Union[AbstractSetIntStr, MappingIntStrAny]]) – fields to include in new model
exclude (Optional[Union[AbstractSetIntStr, MappingIntStrAny]]) – fields to exclude from new model, as with values this takes precedence over include
update (Optional[DictStrAny]) – values to change/add in the new model. Note: the data is not validated before creating the new model: you should trust this data
deep (bool) – set to True to make a deep copy of the model
self (Model) –
- Returns
new model instance
- Return type
Model
- dict(*, include: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, exclude: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, by_alias: bool = False, skip_defaults: Optional[bool] = None, exclude_unset: bool = False, exclude_defaults: bool = False, exclude_none: bool = False) DictStrAny ¶
Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.
- Parameters
include (Optional[Union[AbstractSetIntStr, MappingIntStrAny]]) –
exclude (Optional[Union[AbstractSetIntStr, MappingIntStrAny]]) –
by_alias (bool) –
skip_defaults (Optional[bool]) –
exclude_unset (bool) –
exclude_defaults (bool) –
exclude_none (bool) –
- Return type
DictStrAny
- format(**kwargs: Any) BaseMessage ¶
格式化提示模板。
- 参数:
**kwargs: 用于格式化的关键字参数。
- 返回:
格式化后的消息。
- Parameters
kwargs (Any) –
- Return type
- format_messages(**kwargs: Any) List[BaseMessage] ¶
格式化kwargs中的消息。
- 参数:
**kwargs:用于格式化的关键字参数。
- 返回:
BaseMessages的列表。
- Parameters
kwargs (Any) –
- Return type
List[BaseMessage]
- classmethod from_orm(obj: Any) Model ¶
- Parameters
obj (Any) –
- Return type
Model
- classmethod from_template(template: Union[str, List[Union[str, _TextTemplateParam, _ImageTemplateParam]]], template_format: str = 'f-string', **kwargs: Any) _StringImageMessagePromptTemplateT ¶
从字符串模板创建一个类。
- 参数:
template: 一个模板。 template_format: 模板的格式。 **kwargs: 传递给构造函数的关键字参数。
- 返回:
此类的一个新实例。
- Parameters
template (Union[str, List[Union[str, _TextTemplateParam, _ImageTemplateParam]]]) –
template_format (str) –
kwargs (Any) –
- Return type
_StringImageMessagePromptTemplateT
- classmethod from_template_file(template_file: Union[str, Path], input_variables: List[str], **kwargs: Any) _StringImageMessagePromptTemplateT ¶
从模板文件创建一个类。
- 参数:
template_file: 模板文件的路径。字符串或路径。 input_variables: 输入变量的列表。 **kwargs: 传递给构造函数的关键字参数。
- 返回:
这个类的一个新实例。
- Parameters
template_file (Union[str, Path]) –
input_variables (List[str]) –
kwargs (Any) –
- Return type
_StringImageMessagePromptTemplateT
- classmethod is_lc_serializable() bool ¶
返回类是否可序列化。
- Return type
bool
- json(*, include: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, exclude: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, by_alias: bool = False, skip_defaults: Optional[bool] = None, exclude_unset: bool = False, exclude_defaults: bool = False, exclude_none: bool = False, encoder: Optional[Callable[[Any], Any]] = None, models_as_dict: bool = True, **dumps_kwargs: Any) unicode ¶
Generate a JSON representation of the model, include and exclude arguments as per dict().
encoder is an optional function to supply as default to json.dumps(), other arguments as per json.dumps().
- Parameters
include (Optional[Union[AbstractSetIntStr, MappingIntStrAny]]) –
exclude (Optional[Union[AbstractSetIntStr, MappingIntStrAny]]) –
by_alias (bool) –
skip_defaults (Optional[bool]) –
exclude_unset (bool) –
exclude_defaults (bool) –
exclude_none (bool) –
encoder (Optional[Callable[[Any], Any]]) –
models_as_dict (bool) –
dumps_kwargs (Any) –
- Return type
unicode
- classmethod lc_id() List[str] ¶
用于序列化目的的此类的唯一标识符。
唯一标识符是一个描述对象路径的字符串列表。
- Return type
List[str]
- classmethod parse_file(path: Union[str, Path], *, content_type: unicode = None, encoding: unicode = 'utf8', proto: Protocol = None, allow_pickle: bool = False) Model ¶
- Parameters
path (Union[str, Path]) –
content_type (unicode) –
encoding (unicode) –
proto (Protocol) –
allow_pickle (bool) –
- Return type
Model
- classmethod parse_obj(obj: Any) Model ¶
- Parameters
obj (Any) –
- Return type
Model
- classmethod parse_raw(b: Union[str, bytes], *, content_type: unicode = None, encoding: unicode = 'utf8', proto: Protocol = None, allow_pickle: bool = False) Model ¶
- Parameters
b (Union[str, bytes]) –
content_type (unicode) –
encoding (unicode) –
proto (Protocol) –
allow_pickle (bool) –
- Return type
Model
- pretty_print() None ¶
- Return type
None
- pretty_repr(html: bool = False) str ¶
可读性强的表示。
- Parameters
html (bool) –
- Return type
str
- classmethod schema(by_alias: bool = True, ref_template: unicode = '#/definitions/{model}') DictStrAny ¶
- Parameters
by_alias (bool) –
ref_template (unicode) –
- Return type
DictStrAny
- classmethod schema_json(*, by_alias: bool = True, ref_template: unicode = '#/definitions/{model}', **dumps_kwargs: Any) unicode ¶
- Parameters
by_alias (bool) –
ref_template (unicode) –
dumps_kwargs (Any) –
- Return type
unicode
- to_json() Union[SerializedConstructor, SerializedNotImplemented] ¶
- Return type
- to_json_not_implemented() SerializedNotImplemented ¶
- Return type
- classmethod update_forward_refs(**localns: Any) None ¶
Try to update ForwardRefs on fields based on this Model, globalns and localns.
- Parameters
localns (Any) –
- Return type
None
- classmethod validate(value: Any) Model ¶
- Parameters
value (Any) –
- Return type
Model
- property input_variables: List[str]¶
这个提示模板的输入变量。
- 返回:
输入变量名称的列表。
- property lc_attributes: Dict¶
需要包含在序列化kwargs中的属性名称列表。
这些属性必须被构造函数接受。
- property lc_secrets: Dict[str, str]¶
构造函数参数名称到秘钥ID的映射。
- 例如,
{“openai_api_key”: “OPENAI_API_KEY”}