The agent engineering platform.
Python agentsaiai-agentsanthropicchatgptdeepagentsenterpriseframeworkgeminigenerative-ailangchainlanggraphllmmultiagentopen-sourceopenaipydanticpythonragtypescript
openai[patch]: pass through with_structured_output kwargs (#31518)
Bagatur761f8c323180
diff --git a/libs/partners/openai/langchain_openai/chat_models/azure.py b/libs/partners/openai/langchain_openai/chat_models/azure.pyindex 6d9a356a68..42af44fbb3 100644--- a/libs/partners/openai/langchain_openai/chat_models/azure.py+++ b/libs/partners/openai/langchain_openai/chat_models/azure.py@@ -854,7 +854,7 @@ class AzureChatOpenAI(BaseChatOpenAI):"parsed": None,}- kwargs: Additional keyword args aren't supported.+ kwargs: Additional keyword args are passed through to the model.Returns:A Runnable that takes same inputs as a :class:`langchain_core.language_models.chat.BaseChatModel`.@@ -880,6 +880,12 @@ class AzureChatOpenAI(BaseChatOpenAI):``method`` default changed from "function_calling" to "json_schema".+ .. versionchanged:: 0.3.12+ Support for ``tools`` added.++ .. versionchanged:: 0.3.21+ Pass ``kwargs`` through to the model.+.. dropdown:: Example: schema=Pydantic class, method="json_schema", include_raw=False, strict=TrueNote, OpenAI has a number of restrictions on what types of schemas can bediff --git a/libs/partners/openai/langchain_openai/chat_models/base.py b/libs/partners/openai/langchain_openai/chat_models/base.pyindex 73bc4a806c..a3a2c39bbc 100644--- a/libs/partners/openai/langchain_openai/chat_models/base.py+++ b/libs/partners/openai/langchain_openai/chat_models/base.py@@ -1631,7 +1631,7 @@ class BaseChatOpenAI(BaseChatModel):"parsed": None,}- kwargs: Additional keyword args aren't supported.+ kwargs: Additional keyword args are passed through to the model.Returns:A Runnable that takes same inputs as a :class:`langchain_core.language_models.chat.BaseChatModel`.@@ -1655,9 +1655,10 @@ class BaseChatOpenAI(BaseChatModel):.. versionchanged:: 0.3.12Support for ``tools`` added.++ .. versionchanged:: 0.3.21+ Pass ``kwargs`` through to the model.""" # noqa: E501- if kwargs:- raise ValueError(f"Received unsupported arguments {kwargs}")if strict is not None and method == "json_mode":raise ValueError("Argument `strict` is not supported with `method`='json_mode'"@@ -1700,13 +1701,18 @@ class BaseChatOpenAI(BaseChatModel):)tool_name = convert_to_openai_tool(schema)["function"]["name"]bind_kwargs = self._filter_disabled_params(- tool_choice=tool_name,- parallel_tool_calls=False,- strict=strict,- ls_structured_output_format={- "kwargs": {"method": method, "strict": strict},- "schema": schema,- },+ **{+ **dict(+ tool_choice=tool_name,+ parallel_tool_calls=False,+ strict=strict,+ ls_structured_output_format={+ "kwargs": {"method": method, "strict": strict},+ "schema": schema,+ },+ ),+ **kwargs,+ })llm = self.bind_tools([schema], **bind_kwargs)@@ -1721,11 +1727,16 @@ class BaseChatOpenAI(BaseChatModel):)elif method == "json_mode":llm = self.bind(- response_format={"type": "json_object"},- ls_structured_output_format={- "kwargs": {"method": method},- "schema": schema,- },+ **{+ **dict(+ response_format={"type": "json_object"},+ ls_structured_output_format={+ "kwargs": {"method": method},+ "schema": schema,+ },+ ),+ **kwargs,+ })output_parser = (PydanticOutputParser(pydantic_object=schema) # type: ignore[arg-type]@@ -1739,13 +1750,16 @@ class BaseChatOpenAI(BaseChatModel):"Received None.")response_format = _convert_to_openai_response_format(schema, strict=strict)- bind_kwargs = dict(- response_format=response_format,- ls_structured_output_format={- "kwargs": {"method": method, "strict": strict},- "schema": convert_to_openai_tool(schema),- },- )+ bind_kwargs = {+ **dict(+ response_format=response_format,+ ls_structured_output_format={+ "kwargs": {"method": method, "strict": strict},+ "schema": convert_to_openai_tool(schema),+ },+ **kwargs,+ )+ }if tools:bind_kwargs["tools"] = [convert_to_openai_tool(t, strict=strict) for t in tools@@ -2597,7 +2611,7 @@ class ChatOpenAI(BaseChatOpenAI): # type: ignore[override]"parsed": None,}- kwargs: Additional keyword args aren't supported.+ kwargs: Additional keyword args are passed through to the model.Returns:A Runnable that takes same inputs as a :class:`langchain_core.language_models.chat.BaseChatModel`.@@ -2623,6 +2637,12 @@ class ChatOpenAI(BaseChatOpenAI): # type: ignore[override]``method`` default changed from "function_calling" to "json_schema".+ .. versionchanged:: 0.3.12+ Support for ``tools`` added.++ .. versionchanged:: 0.3.21+ Pass ``kwargs`` through to the model.+.. dropdown:: Example: schema=Pydantic class, method="json_schema", include_raw=False, strict=TrueNote, OpenAI has a number of restrictions on what types of schemas can be