github/langchain
1
0
Fork 0
mirror of https://github.com/hwchase17/langchain.git synced 2025-09-10 23:41:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore(openai): apply formatting changes to AzureChatOpenAI (#32848)

Browse Source
This commit is contained in:
ccurme
2025-09-08 09:54:20 -04:00
committed by GitHub
parent 6e2f46d04c
commit 5b0a55ad35
1 changed files with 20 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
libs/partners/openai/langchain_openai/chat_models/azure.py
View File

@@ -479,10 +479,10 @@ class AzureChatOpenAI(BaseChatOpenAI):
Example: ``https://example-resource.azure.openai.com/`` Example: ``https://example-resource.azure.openai.com/``
""" """
deployment_name: Union[str, None] = Field(default=None, alias="azure_deployment") deployment_name: Union[str, None] = Field(default=None, alias="azure_deployment")
"""A model deployment. """A model deployment.
If given sets the base client URL to include ``/deployments/{azure_deployment}`` If given sets the base client URL to include ``/deployments/{azure_deployment}``
.. note:: .. note::
This means you won't be able to use non-deployment endpoints. This means you won't be able to use non-deployment endpoints.
""" """
@@ -512,27 +512,27 @@ class AzureChatOpenAI(BaseChatOpenAI):
""" """
azure_ad_token_provider: Union[Callable[[], str], None] = None azure_ad_token_provider: Union[Callable[[], str], None] = None
"""A function that returns an Azure Active Directory token. """A function that returns an Azure Active Directory token.
Will be invoked on every sync request. For async requests, Will be invoked on every sync request. For async requests,
will be invoked if ``azure_ad_async_token_provider`` is not provided. will be invoked if ``azure_ad_async_token_provider`` is not provided.
""" """
azure_ad_async_token_provider: Union[Callable[[], Awaitable[str]], None] = None azure_ad_async_token_provider: Union[Callable[[], Awaitable[str]], None] = None
"""A function that returns an Azure Active Directory token. """A function that returns an Azure Active Directory token.
Will be invoked on every async request. Will be invoked on every async request.
""" """
model_version: str = "" model_version: str = ""
"""The version of the model (e.g. ``'0125'`` for ``'gpt-3.5-0125'``). """The version of the model (e.g. ``'0125'`` for ``'gpt-3.5-0125'``).
Azure OpenAI doesn't return model version with the response by default so it must Azure OpenAI doesn't return model version with the response by default so it must
be manually specified if you want to use this information downstream, e.g. when be manually specified if you want to use this information downstream, e.g. when
calculating costs. calculating costs.
When you specify the version, it will be appended to the model name in the When you specify the version, it will be appended to the model name in the
response. Setting correct version will help you to calculate the cost properly. response. Setting correct version will help you to calculate the cost properly.
Model version is not validated, so make sure you set it correctly to get the Model version is not validated, so make sure you set it correctly to get the
correct cost. correct cost.
""" """
@@ -547,34 +547,34 @@ class AzureChatOpenAI(BaseChatOpenAI):
""" """
model_name: Optional[str] = Field(default=None, alias="model") # type: ignore[assignment] model_name: Optional[str] = Field(default=None, alias="model") # type: ignore[assignment]
"""Name of the deployed OpenAI model, e.g. ``'gpt-4o'``, ``'gpt-35-turbo'``, etc. """Name of the deployed OpenAI model, e.g. ``'gpt-4o'``, ``'gpt-35-turbo'``, etc.
Distinct from the Azure deployment name, which is set by the Azure user. Distinct from the Azure deployment name, which is set by the Azure user.
Used for tracing and token counting. Used for tracing and token counting.
.. warning:: .. warning::
Does NOT affect completion. Does NOT affect completion.
""" """
disabled_params: Optional[dict[str, Any]] = Field(default=None) disabled_params: Optional[dict[str, Any]] = Field(default=None)
"""Parameters of the OpenAI client or chat.completions endpoint that should be """Parameters of the OpenAI client or chat.completions endpoint that should be
disabled for the given model. disabled for the given model.
Should be specified as ``{"param": None | ['val1', 'val2']}`` where the key is the Should be specified as ``{"param": None | ['val1', 'val2']}`` where the key is the
parameter and the value is either None, meaning that parameter should never be parameter and the value is either None, meaning that parameter should never be
used, or it's a list of disabled values for the parameter. used, or it's a list of disabled values for the parameter.
For example, older models may not support the ``'parallel_tool_calls'`` parameter at For example, older models may not support the ``'parallel_tool_calls'`` parameter at
all, in which case ``disabled_params={"parallel_tool_calls: None}`` can ben passed all, in which case ``disabled_params={"parallel_tool_calls: None}`` can ben passed
in. in.
If a parameter is disabled then it will not be used by default in any methods, e.g. If a parameter is disabled then it will not be used by default in any methods, e.g.
in in
:meth:`~langchain_openai.chat_models.azure.AzureChatOpenAI.with_structured_output`. :meth:`~langchain_openai.chat_models.azure.AzureChatOpenAI.with_structured_output`.
However this does not prevent a user from directly passed in the parameter during However this does not prevent a user from directly passed in the parameter during
invocation. invocation.
By default, unless ``model_name="gpt-4o"`` is specified, then By default, unless ``model_name="gpt-4o"`` is specified, then
``'parallel_tools_calls'`` will be disabled. ``'parallel_tools_calls'`` will be disabled.
""" """