The agent engineering platform.
Python agentsaiai-agentsanthropicchatgptdeepagentsenterpriseframeworkgeminigenerative-ailangchainlanggraphllmmultiagentopen-sourceopenaipydanticpythonragtypescript
docs: ChatOpenAI.with_structured_output nits (#25952)
Bagaturda113f63630f
diff --git a/libs/partners/openai/langchain_openai/chat_models/base.py b/libs/partners/openai/langchain_openai/chat_models/base.pyindex 47c89929ea..4ae2b2b21c 100644--- a/libs/partners/openai/langchain_openai/chat_models/base.py+++ b/libs/partners/openai/langchain_openai/chat_models/base.py@@ -1102,18 +1102,15 @@ class BaseChatOpenAI(BaseChatModel):) -> Runnable[LanguageModelInput, _DictOrPydantic]:"""Model wrapper that returns outputs formatted to match the given schema.- .. versionchanged:: 0.1.21-- Support for ``strict`` argument added.- Support for ``method`` = "json_schema" added.-Args:schema:The output schema. Can be passed in as:- - an OpenAI function/tool schema,- - a JSON Schema,- - a TypedDict class (support added in 0.1.20),- - or a Pydantic class.++ - an OpenAI function/tool schema,+ - a JSON Schema,+ - a TypedDict class (support added in 0.1.20),+ - or a Pydantic class.+If ``schema`` is a Pydantic class then the model output will be aPydantic instance of that class, and the model-generated fields will bevalidated by the Pydantic class. Otherwise the model output will be a@@ -1121,25 +1118,20 @@ class BaseChatOpenAI(BaseChatModel):for more on how to properly specify types and descriptions ofschema fields when specifying a Pydantic or TypedDict class.- .. versionchanged:: 0.1.20-- Added support for TypedDict class.-- method:- The method for steering model generation, one of:- - "function_calling":- Uses OpenAI's tool-calling (formerly called function calling)- API: https://platform.openai.com/docs/guides/function-calling- - "json_schema":- Uses OpenAI's Structured Output API:- https://platform.openai.com/docs/guides/structured-outputs- Supported for "gpt-4o-mini", "gpt-4o-2024-08-06", and later- models.- - "json_mode":- Uses OpenAI's JSON mode. Note that if using JSON mode then you- must include instructions for formatting the output into the- desired schema into the model call:- https://platform.openai.com/docs/guides/structured-outputs/json-mode+ method: The method for steering model generation, one of:++ - "function_calling":+ Uses OpenAI's tool-calling (formerly called function calling)+ API: https://platform.openai.com/docs/guides/function-calling+ - "json_schema":+ Uses OpenAI's Structured Output API: https://platform.openai.com/docs/guides/structured-outputs+ Supported for "gpt-4o-mini", "gpt-4o-2024-08-06", and later+ models.+ - "json_mode":+ Uses OpenAI's JSON mode. Note that if using JSON mode then you+ must include instructions for formatting the output into the+ desired schema into the model call:+ https://platform.openai.com/docs/guides/structured-outputs/json-modeLearn more about the differences between the methods and which modelssupport which methods here:@@ -1147,14 +1139,6 @@ class BaseChatOpenAI(BaseChatModel):- https://platform.openai.com/docs/guides/structured-outputs/structured-outputs-vs-json-mode- https://platform.openai.com/docs/guides/structured-outputs/function-calling-vs-response-format- .. versionchanged:: 0.1.21-- Added support for "json_schema".-- .. note:: Planned breaking change in version `0.2.0`-- ``method`` default will be changed to "json_schema" from- "function_calling".include_raw:If False then only the parsed structured output is returned. Ifan error occurs during model output parsing it will be raised. If True@@ -1163,6 +1147,7 @@ class BaseChatOpenAI(BaseChatModel):will be caught and returned as well. The final output is always a dictwith keys "raw", "parsed", and "parsing_error".strict:+- True:Model output is guaranteed to exactly match the schema.The input schema will also be validated according to@@ -1177,12 +1162,6 @@ class BaseChatOpenAI(BaseChatModel):"function_calling" or "json_mode" defaults to None. Can only benon-null if ``method`` is "function_calling" or "json_schema".- .. versionadded:: 0.1.21-- .. note:: Planned breaking change in version `0.2.0`-- ``strict`` will default to True when ``method`` is- "function_calling" as of version `0.2.0`.kwargs: Additional keyword args aren't supported.Returns:@@ -1196,6 +1175,23 @@ class BaseChatOpenAI(BaseChatModel):- "parsed": None if there was a parsing error, otherwise the type depends on the ``schema`` as described above.- "parsing_error": Optional[BaseException]+ .. versionchanged:: 0.1.20++ Added support for TypedDict class ``schema``.++ .. versionchanged:: 0.1.21++ Support for ``strict`` argument added.+ Support for ``method`` = "json_schema" added.++ .. note:: Planned breaking changes in version `0.2.0`++ - ``method`` default will be changed to "json_schema" from+ "function_calling".+ - ``strict`` will default to True when ``method`` is+ "function_calling" as of version `0.2.0`.++.. dropdown:: Example: schema=Pydantic class, method="function_calling", include_raw=False, strict=TrueNote, OpenAI has a number of restrictions on what types of schemas can be