Method●Since v0.1

with_structured_output

Model wrapper that returns outputs formatted to match the given schema.

with_structured_output(
  self,
  schema: _DictOrPydanticClass | None = None,
  *,
  method: Literal['function_calling', 'json_mode', 'json_schema'] = 'function_calling',
  include_raw: bool = False,
  strict: bool | None = None,
  **kwargs: Any = {}
) -> Runnable[LanguageModelInput, _DictOrPydantic]

Parameters

Name	Type	Description
`schema`	`_DictOrPydanticClass \| None`	Default:`None` 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.
`method`	`Literal['function_calling', 'json_mode', 'json_schema']`	Default:`'function_calling'` The method for steering model generation, one of: `'function_calling'`: Uses DeepSeek's tool-calling features. `'json_mode'`: Uses DeepSeek's JSON mode feature.
`include_raw`	`bool`	Default:`False` 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'`.
`strict`	`bool \| None`	Default:`None` Whether to enable strict schema adherence when generating the function call. When set to `True`, DeepSeek will use the beta API endpoint (`https://api.deepseek.com/beta`) for strict schema validation. This ensures model outputs exactly match the defined schema. Note DeepSeek's strict mode requires all object properties to be marked as required in the schema.
`kwargs`	`Any`	Default:`{}` Additional keyword args aren't supported.

View source on GitHub

with_structured_output( self, schema: _DictOrPydanticClass | None = None, *, method: Literal['function_calling', 'json_mode', 'json_schema'] = 'function_calling', include_raw: bool = False, strict: bool | None = None, **kwargs: Any = {} ) -> Runnable[LanguageModelInput, _DictOrPydantic]

Parameters

Name	Type	Description
`schema`	`_DictOrPydanticClass \| None`	Default:`None` 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.
`method`	`Literal['function_calling', 'json_mode', 'json_schema']`	Default:`'function_calling'` The method for steering model generation, one of: `'function_calling'`: Uses DeepSeek's tool-calling features. `'json_mode'`: Uses DeepSeek's JSON mode feature.
`include_raw`	`bool`	Default:`False` 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'`.
`strict`	`bool \| None`	Default:`None` Whether to enable strict schema adherence when generating the function call. When set to `True`, DeepSeek will use the beta API endpoint (`https://api.deepseek.com/beta`) for strict schema validation. This ensures model outputs exactly match the defined schema. Note DeepSeek's strict mode requires all object properties to be marked as required in the schema.
`kwargs`	`Any`	Default:`{}` Additional keyword args aren't supported.

with_structured_output

Parameters

LangChain Assistant

Menu

with_structured_output

Parameters