Refactor: api_flavor as a field on OpenAI/Azure chat models

Follow the same pattern as UiPathChatAnthropic.vendor_type: add an
api_flavor field to UiPathChatOpenAI, UiPathAzureChatOpenAI, and
UiPathAzureAIChatCompletionsModel. The model_validator sets
api_config.api_flavor from the field, and the request hook reads it.

The factory now passes api_flavor= directly instead of constructing a
full UiPathAPIConfig.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Author: cosminacho

packages/uipath_langchain_client/src/uipath_langchain_client/clients/azure/chat_models.py

@@ -6,6 +6,7 @@
 from uipath_langchain_client.base_client import UiPathBaseChatModel
 from uipath_langchain_client.clients.openai.utils import fix_url_and_api_flavor_header
 from uipath_langchain_client.settings import (
+    ApiFlavor,
     ApiType,
     RoutingMode,
     UiPathAPIConfig,
@@ -31,6 +32,7 @@ class UiPathAzureAIChatCompletionsModel(UiPathBaseChatModel, AzureAIOpenAIApiCha
         vendor_type=VendorType.AZURE,
         freeze_base_url=False,
     )
+    api_flavor: ApiFlavor | str | None = None
 
     # Override fields to avoid env var lookup / validation errors at instantiation
     endpoint: str | None = Field(default="PLACEHOLDER")
@@ -40,6 +42,8 @@ class UiPathAzureAIChatCompletionsModel(UiPathBaseChatModel, AzureAIOpenAIApiCha
 
     @model_validator(mode="after")
     def setup_uipath_client(self) -> Self:
+        if self.api_flavor is not None:
+            self.api_config.api_flavor = self.api_flavor
         base_url = str(self.uipath_sync_client.base_url).rstrip("/")
         locked_flavor = str(self.api_config.api_flavor) if self.api_config.api_flavor else None
 

packages/uipath_langchain_client/src/uipath_langchain_client/clients/openai/chat_models.py

@@ -7,6 +7,7 @@
 from uipath_langchain_client.base_client import UiPathBaseChatModel
 from uipath_langchain_client.clients.openai.utils import fix_url_and_api_flavor_header
 from uipath_langchain_client.settings import (
+    ApiFlavor,
     ApiType,
     RoutingMode,
     UiPathAPIConfig,
@@ -31,6 +32,7 @@ class UiPathChatOpenAI(UiPathBaseChatModel, ChatOpenAI):  # type: ignore[overrid
         api_version="2025-03-01-preview",
         freeze_base_url=False,
     )
+    api_flavor: ApiFlavor | str | None = None
 
     # Override fields to avoid errors when instantiating the class
     openai_api_key: SecretStr | None | Callable[[], str] | Callable[[], Awaitable[str]] = Field(
@@ -39,6 +41,8 @@ class UiPathChatOpenAI(UiPathBaseChatModel, ChatOpenAI):  # type: ignore[overrid
 
     @model_validator(mode="after")
     def setup_uipath_client(self) -> Self:
+        if self.api_flavor is not None:
+            self.api_config.api_flavor = self.api_flavor
         base_url = str(self.uipath_sync_client.base_url).rstrip("/")
         locked_flavor = str(self.api_config.api_flavor) if self.api_config.api_flavor else None
 
@@ -76,6 +80,7 @@ class UiPathAzureChatOpenAI(UiPathBaseChatModel, AzureChatOpenAI):  # type: igno
         api_version="2025-03-01-preview",
         freeze_base_url=False,
     )
+    api_flavor: ApiFlavor | str | None = None
 
     # Override fields to avoid errors when instantiating the class
     azure_endpoint: str | None = Field(default="PLACEHOLDER")
@@ -84,6 +89,8 @@ class UiPathAzureChatOpenAI(UiPathBaseChatModel, AzureChatOpenAI):  # type: igno
 
     @model_validator(mode="after")
     def setup_uipath_client(self) -> Self:
+        if self.api_flavor is not None:
+            self.api_config.api_flavor = self.api_flavor
         base_url = str(self.uipath_sync_client.base_url).rstrip("/")
         locked_flavor = str(self.api_config.api_flavor) if self.api_config.api_flavor else None
 

packages/uipath_langchain_client/src/uipath_langchain_client/factory.py

@@ -30,9 +30,7 @@
     API_FLAVOR_TO_VENDOR_TYPE,
     BYOM_TO_ROUTING_FLAVOR,
     ApiFlavor,
-    ApiType,
     RoutingMode,
-    UiPathAPIConfig,
     UiPathBaseSettings,
     VendorType,
     get_default_client_settings,
@@ -176,18 +174,6 @@ def get_chat_model(
             if api_flavor == ApiFlavor.RESPONSES:
                 model_kwargs["use_responses_api"] = True
 
-            # Lock the api_flavor into the api_config so the request hook
-            # uses it instead of dynamically detecting from the URL path.
-            if api_flavor is not None:
-                model_kwargs["api_config"] = UiPathAPIConfig(
-                    api_type=ApiType.COMPLETIONS,
-                    routing_mode=RoutingMode.PASSTHROUGH,
-                    vendor_type=VendorType.OPENAI,
-                    api_version="2025-03-01-preview",
-                    api_flavor=str(api_flavor),
-                    freeze_base_url=False,
-                )
-
             if is_uipath_owned:
                 from uipath_langchain_client.clients.openai.chat_models import (
                     UiPathAzureChatOpenAI,
@@ -196,6 +182,7 @@ def get_chat_model(
                 return UiPathAzureChatOpenAI(
                     model=model_name,
                     settings=client_settings,
+                    api_flavor=api_flavor,
                     byo_connection_id=byo_connection_id,
                     **model_kwargs,
                 )
@@ -207,6 +194,7 @@ def get_chat_model(
                 return UiPathChatOpenAI(
                     model=model_name,
                     settings=client_settings,
+                    api_flavor=api_flavor,
                     byo_connection_id=byo_connection_id,
                     **model_kwargs,
                 )