ChatMessagePromptTemplate Class — langchain Architecture

Architecture documentation for the ChatMessagePromptTemplate class in chat.py from the langchain codebase.

Class python

Entity Profile

Dependency Diagram

graph TD
  845a4803_caec_c00a_d98b_d3f3d3fae5d8["ChatMessagePromptTemplate"]
  4766cfc7_f772_eccc_6561_2122efd2c5e8["BaseStringMessagePromptTemplate"]
  845a4803_caec_c00a_d98b_d3f3d3fae5d8 -->|extends| 4766cfc7_f772_eccc_6561_2122efd2c5e8
  d735cdf0_4dd6_b10d_3d65_7f753809639d["chat.py"]
  845a4803_caec_c00a_d98b_d3f3d3fae5d8 -->|defined in| d735cdf0_4dd6_b10d_3d65_7f753809639d
  da277d85_ccb4_d225_0110_0e1adda5fb46["format()"]
  845a4803_caec_c00a_d98b_d3f3d3fae5d8 -->|method| da277d85_ccb4_d225_0110_0e1adda5fb46
  d36019e2_748c_4684_2c57_330dbdc419a4["aformat()"]
  845a4803_caec_c00a_d98b_d3f3d3fae5d8 -->|method| d36019e2_748c_4684_2c57_330dbdc419a4

Relationship Graph

Source Code

libs/core/langchain_core/prompts/chat.py lines 353–385

class ChatMessagePromptTemplate(BaseStringMessagePromptTemplate):
    """Chat message prompt template."""

    role: str
    """Role of the message."""

    def format(self, **kwargs: Any) -> BaseMessage:
        """Format the prompt template.

        Args:
            **kwargs: Keyword arguments to use for formatting.

        Returns:
            Formatted message.
        """
        text = self.prompt.format(**kwargs)
        return ChatMessage(
            content=text, role=self.role, additional_kwargs=self.additional_kwargs
        )

    async def aformat(self, **kwargs: Any) -> BaseMessage:
        """Async format the prompt template.

        Args:
            **kwargs: Keyword arguments to use for formatting.

        Returns:
            Formatted message.
        """
        text = await self.prompt.aformat(**kwargs)
        return ChatMessage(
            content=text, role=self.role, additional_kwargs=self.additional_kwargs
        )