with_structured_output

The output schema. Can be passed in as:

• An OpenAI function/tool schema,
• A JSON Schema,
• A TypedDict class,
• Or a Pydantic class.

If schema is a Pydantic class then the model output will be a Pydantic instance of that class, and the model-generated fields will be validated by the Pydantic class. Otherwise the model output will be a dict and will not be validated.

See langchain_core.utils.function_calling.convert_to_openai_tool for more on how to properly specify types and descriptions of schema fields when specifying a Pydantic or TypedDict class.

The method for steering model generation, one of:

• 'function_calling': Uses xAI's tool-calling features.
• 'json_schema': Uses xAI's structured output feature.
• 'json_mode': Uses xAI's JSON mode feature.

If False then only the parsed structured output is returned.

If an error occurs during model output parsing it will be raised.

If True then both the raw model response (a BaseMessage) and the parsed model response will be returned.

If an error occurs during output parsing it will be caught and returned as well.

The final output is always a dict with keys 'raw', 'parsed', and 'parsing_error'.