BaseStringMessagePromptTemplate#
- class langchain_core.prompts.chat.BaseStringMessagePromptTemplate[source]#
Bases:
BaseMessagePromptTemplate,ABCBase class for message prompt templates that use a string prompt template.
- param additional_kwargs: dict [Optional]#
Additional keyword arguments to pass to the prompt template.
- param prompt: StringPromptTemplate [Required]#
String prompt template.
- async aformat(**kwargs: Any) BaseMessage[source]#
Async format the prompt template.
- Parameters:
**kwargs (Any) – Keyword arguments to use for formatting.
- Returns:
Formatted message.
- Return type:
- async aformat_messages(**kwargs: Any) List[BaseMessage][source]#
Async format messages from kwargs.
- Parameters:
**kwargs (Any) – Keyword arguments to use for formatting.
- Returns:
List of BaseMessages.
- Return type:
List[BaseMessage]
- abstract format(**kwargs: Any) BaseMessage[source]#
Format the prompt template.
- Parameters:
**kwargs (Any) – Keyword arguments to use for formatting.
- Returns:
Formatted message.
- Return type:
- format_messages(**kwargs: Any) List[BaseMessage][source]#
Format messages from kwargs.
- Parameters:
**kwargs (Any) – Keyword arguments to use for formatting.
- Returns:
List of BaseMessages.
- Return type:
List[BaseMessage]
- classmethod from_template(template: str, template_format: str = 'f-string', partial_variables: Dict[str, Any] | None = None, **kwargs: Any) MessagePromptTemplateT[source]#
Create a class from a string template.
- Parameters:
template (str) – a template.
template_format (str) – format of the template. Defaults to “f-string”.
partial_variables (Dict[str, Any] | None) –
- A dictionary of variables that can be used to partially
fill in the template. For example, if the template is
”{variable1} {variable2}”, and partial_variables is {“variable1”: “foo”}, then the final prompt will be “foo {variable2}”. Defaults to None.
**kwargs (Any) – keyword arguments to pass to the constructor.
- Returns:
A new instance of this class.
- Return type:
MessagePromptTemplateT
- classmethod from_template_file(template_file: str | Path, input_variables: List[str], **kwargs: Any) MessagePromptTemplateT[source]#
Create a class from a template file.
- Parameters:
template_file (str | Path) – path to a template file. String or Path.
input_variables (List[str]) – list of input variables.
**kwargs (Any) – keyword arguments to pass to the constructor.
- Returns:
A new instance of this class.
- Return type:
MessagePromptTemplateT
- pretty_print() None#
Print a human-readable representation.
- Return type:
None
- pretty_repr(html: bool = False) str[source]#
Human-readable representation.
- Parameters:
html (bool) – Whether to format as HTML. Defaults to False.
- Returns:
Human-readable representation.
- Return type:
str
- property input_variables: List[str]#
Input variables for this prompt template.
- Returns:
List of input variable names.