langchain Architecture Docs
Home / Function/ _format_ls_structured_output() — langchain Function Reference

_format_ls_structured_output() — langchain Function Reference

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

Function python CoreAbstractions MessageSchema called by 4

Entity Profile

Dependency Diagram

graph TD
  5f652461_f9fa_fdc2_d659_cde32ef53f66["_format_ls_structured_output()"]
  20f4116a_d26d_2a5f_4a10_67af6940e081["chat_models.py"]
  5f652461_f9fa_fdc2_d659_cde32ef53f66 -->|defined in| 20f4116a_d26d_2a5f_4a10_67af6940e081
  7f210df0_4f6a_343c_b4fe_f942048ea776["stream()"]
  7f210df0_4f6a_343c_b4fe_f942048ea776 -->|calls| 5f652461_f9fa_fdc2_d659_cde32ef53f66
  39e8cf9b_1f2e_9a93_e3f1_aaaffdfd70fa["astream()"]
  39e8cf9b_1f2e_9a93_e3f1_aaaffdfd70fa -->|calls| 5f652461_f9fa_fdc2_d659_cde32ef53f66
  fccabb0a_e230_0454_e79d_6a55d54eee3b["generate()"]
  fccabb0a_e230_0454_e79d_6a55d54eee3b -->|calls| 5f652461_f9fa_fdc2_d659_cde32ef53f66
  e539ab1d_5151_8ba1_cfe0_47ef5adc1f67["agenerate()"]
  e539ab1d_5151_8ba1_cfe0_47ef5adc1f67 -->|calls| 5f652461_f9fa_fdc2_d659_cde32ef53f66
  style 5f652461_f9fa_fdc2_d659_cde32ef53f66 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

libs/core/langchain_core/language_models/chat_models.py lines 227–243

def _format_ls_structured_output(ls_structured_output_format: dict | None) -> dict:
    if ls_structured_output_format:
        try:
            ls_structured_output_format_dict = {
                "ls_structured_output_format": {
                    "kwargs": ls_structured_output_format.get("kwargs", {}),
                    "schema": convert_to_json_schema(
                        ls_structured_output_format["schema"]
                    ),
                }
            }
        except ValueError:
            ls_structured_output_format_dict = {}
    else:
        ls_structured_output_format_dict = {}

    return ls_structured_output_format_dict

Domain

Subdomains

Defined In

Called By

Source

Frequently Asked Questions

What does _format_ls_structured_output() do?
_format_ls_structured_output() is a function in the langchain codebase, defined in libs/core/langchain_core/language_models/chat_models.py.
Where is _format_ls_structured_output() defined?
_format_ls_structured_output() is defined in libs/core/langchain_core/language_models/chat_models.py at line 227.
What calls _format_ls_structured_output()?
_format_ls_structured_output() is called by 4 function(s): agenerate, astream, generate, stream.

Analyze Your Own Codebase

Get architecture documentation, dependency graphs, and domain analysis for your codebase in minutes.

Try Supermodel Free