get_format_instructions() — langchain Function Reference

Architecture documentation for the get_format_instructions() function in yaml.py from the langchain codebase.

Function python OutputParsing StreamingParsers calls 1 called by 1

Entity Profile

OutputParsing→ StreamingParsers→ get_format_instructions() — langchain Function Reference

Dependency Diagram

graph TD
  088d2991_fd82_beab_10cb_087a70f2cfa9["get_format_instructions()"]
  ace14fd9_5f64_6948_e02f_713d598d0b6f["YamlOutputParser"]
  088d2991_fd82_beab_10cb_087a70f2cfa9 -->|defined in| ace14fd9_5f64_6948_e02f_713d598d0b6f
  088d2991_fd82_beab_10cb_087a70f2cfa9["get_format_instructions()"]
  088d2991_fd82_beab_10cb_087a70f2cfa9 -->|calls| 088d2991_fd82_beab_10cb_087a70f2cfa9
  088d2991_fd82_beab_10cb_087a70f2cfa9["get_format_instructions()"]
  088d2991_fd82_beab_10cb_087a70f2cfa9 -->|calls| 088d2991_fd82_beab_10cb_087a70f2cfa9
  style 088d2991_fd82_beab_10cb_087a70f2cfa9 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

libs/langchain/langchain_classic/output_parsers/yaml.py lines 47–60

    def get_format_instructions(self) -> str:
        # Copy schema to avoid altering original Pydantic schema.
        schema = dict(self.pydantic_object.model_json_schema().items())

        # Remove extraneous fields.
        reduced_schema = schema
        if "title" in reduced_schema:
            del reduced_schema["title"]
        if "type" in reduced_schema:
            del reduced_schema["type"]
        # Ensure yaml in context is well-formed with double quotes.
        schema_str = json.dumps(reduced_schema)

        return YAML_FORMAT_INSTRUCTIONS.format(schema=schema_str)