aformat() — langchain Function Reference

Architecture documentation for the aformat() function in chat.py from the langchain codebase.

Function python PromptManagement ChatTemplates calls 3 called by 2

Entity Profile

PromptManagement→ ChatTemplates→ aformat() — langchain Function Reference

Dependency Diagram

graph TD
  12501cb5_f260_9904_b738_b5abce848eb3["aformat()"]
  894611e5_5039_7621_4673_821d0b9b6f17["_StringImageMessagePromptTemplate"]
  12501cb5_f260_9904_b738_b5abce848eb3 -->|defined in| 894611e5_5039_7621_4673_821d0b9b6f17
  294ec36d_5c45_aa10_07c1_4936f16dc663["aformat_messages()"]
  294ec36d_5c45_aa10_07c1_4936f16dc663 -->|calls| 12501cb5_f260_9904_b738_b5abce848eb3
  d36019e2_748c_4684_2c57_330dbdc419a4["aformat()"]
  d36019e2_748c_4684_2c57_330dbdc419a4 -->|calls| 12501cb5_f260_9904_b738_b5abce848eb3
  51e4c8c4_03c1_4bf3_6d35_36e10545e164["append()"]
  12501cb5_f260_9904_b738_b5abce848eb3 -->|calls| 51e4c8c4_03c1_4bf3_6d35_36e10545e164
  d36019e2_748c_4684_2c57_330dbdc419a4["aformat()"]
  12501cb5_f260_9904_b738_b5abce848eb3 -->|calls| d36019e2_748c_4684_2c57_330dbdc419a4
  c5487c6c_d88c_b7f9_8f1f_8abaf332a76d["format()"]
  12501cb5_f260_9904_b738_b5abce848eb3 -->|calls| c5487c6c_d88c_b7f9_8f1f_8abaf332a76d
  style 12501cb5_f260_9904_b738_b5abce848eb3 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

libs/core/langchain_core/prompts/chat.py lines 614–643

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

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

        Returns:
            Formatted message.
        """
        if isinstance(self.prompt, StringPromptTemplate):
            text = await self.prompt.aformat(**kwargs)
            return self._msg_class(
                content=text, additional_kwargs=self.additional_kwargs
            )
        content: list = []
        for prompt in self.prompt:
            inputs = {var: kwargs[var] for var in prompt.input_variables}
            if isinstance(prompt, StringPromptTemplate):
                formatted_text: str = await prompt.aformat(**inputs)
                if formatted_text != "":
                    content.append({"type": "text", "text": formatted_text})
            elif isinstance(prompt, ImagePromptTemplate):
                formatted_image: ImageURL = await prompt.aformat(**inputs)
                content.append({"type": "image_url", "image_url": formatted_image})
            elif isinstance(prompt, DictPromptTemplate):
                formatted_dict: dict[str, Any] = prompt.format(**inputs)
                content.append(formatted_dict)
        return self._msg_class(
            content=content, additional_kwargs=self.additional_kwargs
        )