supported_usage_metadata_details() — langchain Function Reference

Architecture documentation for the supported_usage_metadata_details() function in chat_models.py from the langchain codebase.

Function python LangChainCore LanguageModelBase

Entity Profile

LangChainCore→ LanguageModelBase→ supported_usage_metadata_details() — langchain Function Reference

Dependency Diagram

graph TD
  3b97b3b1_ffc3_39a6_e671_c8939a9cb3da["supported_usage_metadata_details()"]
  93a85b25_a139_159d_bcf5_03a6e2ed4dd3["ChatModelTests"]
  3b97b3b1_ffc3_39a6_e671_c8939a9cb3da -->|defined in| 93a85b25_a139_159d_bcf5_03a6e2ed4dd3
  style 3b97b3b1_ffc3_39a6_e671_c8939a9cb3da fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

libs/standard-tests/langchain_tests/unit_tests/chat_models.py lines 232–251

    def supported_usage_metadata_details(
        self,
    ) -> dict[
        Literal["invoke", "stream"],
        list[
            Literal[
                "audio_input",
                "audio_output",
                "reasoning_output",
                "cache_read_input",
                "cache_creation_input",
            ]
        ],
    ]:
        """Supported usage metadata details.

        What usage metadata details are emitted in invoke and stream. Only needs to be
        overridden if these details are returned by the model.
        """
        return {"invoke": [], "stream": []}