[ai] Add client info to headers for OpenAI classes (#33820)

* Add client info to headers for OpenAI classes

* Remove unused argument

* Change '/' delimeter to space

* Only log client header, create constant for header field name

* Create constant in azure-ai-generative to avoid ImportError from azure-ai-resources

Author: diondrapeck

sdk/ai/azure-ai-generative/azure/ai/generative/constants/__init__.py

@@ -0,0 +1,5 @@
+# ---------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# ---------------------------------------------------------
+
+__path__ = __import__("pkgutil").extend_path(__path__, __name__)  # type: ignore

sdk/ai/azure-ai-generative/azure/ai/generative/constants/_common.py

@@ -0,0 +1,5 @@
+# ---------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# ---------------------------------------------------------
+
+USER_AGENT_HEADER_KEY = "Client-User-Agent"

sdk/ai/azure-ai-generative/azure/ai/generative/index/_embeddings/openai.py

@@ -6,6 +6,8 @@
 import time
 from typing import Any, Dict, List, Optional
 
+from azure.ai.resources.constants._common import USER_AGENT_HEADER_KEY
+from azure.ai.generative._user_agent import USER_AGENT
 from azure.ai.generative.index._utils.logging import get_logger
 from packaging import version
 
@@ -77,11 +79,13 @@ def __init__(
                     api_key=self.api_key,
                     api_version=self.api_version,
                     azure_endpoint=self.api_base,
+                    default_headers={USER_AGENT_HEADER_KEY: USER_AGENT},
                 )
             else:
                 client = openai.OpenAI(
                     api_key=self.api_key,
                     base_url=self.api_base,
+                    default_headers={USER_AGENT_HEADER_KEY: USER_AGENT},
                 )
 
             self.embedding_client = client.embeddings

sdk/ai/azure-ai-generative/azure/ai/generative/index/_models.py

@@ -8,12 +8,14 @@
 from typing import Dict, Optional, Union
 
 from azure.core.credentials import TokenCredential
+from azure.ai.generative.constants._common import USER_AGENT_HEADER_KEY
 from azure.ai.generative.index._utils.connections import (
     connection_to_credential,
     get_connection_by_id_v2,
     get_connection_credential,
 )
 from azure.ai.generative.index._utils.logging import get_logger
+from azure.ai.generative._user_agent import USER_AGENT
 
 try:
     from azure.ai.resources.entities import BaseConnection
@@ -171,6 +173,7 @@ def init_llm(model_config: dict, **kwargs):
                 openai_api_type=model_config.get("api_type"),
                 openai_api_version=model_config.get("api_version"),
                 max_retries=model_config.get("max_retries", 3),
+                default_headers={USER_AGENT_HEADER_KEY: USER_AGENT},
                 **kwargs
             )  # type: ignore
             if model_config.get("temperature", None) is not None:
@@ -185,6 +188,7 @@ def init_llm(model_config: dict, **kwargs):
                 model_kwargs=model_kwargs,
                 openai_api_key=model_config.get("api_key"),
                 max_retries=model_config.get("max_retries", 3),
+                default_headers={USER_AGENT_HEADER_KEY: USER_AGENT},
                 **kwargs
             )  # type: ignore
             if model_config.get("temperature", None) is not None:
@@ -197,6 +201,7 @@ def init_llm(model_config: dict, **kwargs):
             max_tokens=model_config.get("max_tokens"),
             model_kwargs=model_kwargs,
             openai_api_key=model_config.get("api_key"),
+            default_headers={USER_AGENT_HEADER_KEY: USER_AGENT},
             **kwargs
         )  # type: ignore
         if model_config.get("temperature", None) is not None:

sdk/ai/azure-ai-generative/azure/ai/generative/synthetic/qa.py

@@ -14,9 +14,11 @@
     from typing import Dict, List, Tuple, Any, Union, Optional
     from collections import defaultdict
     from azure.ai.resources.entities import BaseConnection
+    from azure.ai.generative.constants._common import USER_AGENT_HEADER_KEY
     from azure.identity import DefaultAzureCredential
     from azure.ai.generative._telemetry import ActivityType, monitor_with_activity, ActivityLogger
     from azure.core.tracing.decorator import distributed_trace
+    from azure.ai.generative._user_agent import USER_AGENT
 except ImportError as e:
     print("In order to use qa, please install the 'qa_generation' extra of azure-ai-generative")
     raise e
@@ -64,13 +66,15 @@ def _completion_with_retries(*args, **kwargs):
                     client = AzureOpenAI(
                         azure_endpoint = kwargs["api_base"], 
                         api_key=kwargs["api_key"],  
-                        api_version=kwargs["api_version"]
+                        api_version=kwargs["api_version"],
+                        default_headers={USER_AGENT_HEADER_KEY: USER_AGENT},
                     )
                     response = client.chat.completions.create(messages=kwargs["messages"], model=kwargs["deployment_id"], temperature=kwargs["temperature"], max_tokens=kwargs["max_tokens"])
                 else:
                     from openai import OpenAI
                     client = OpenAI(
-                        api_key=kwargs["api_key"],  
+                        api_key=kwargs["api_key"],
+                        default_headers={USER_AGENT_HEADER_KEY: USER_AGENT},  
                     )
                     response = client.chat.completions.create(messages=kwargs["messages"], model=kwargs["model"], temperature=kwargs["temperature"], max_tokens=kwargs["max_tokens"])
                 return response.choices[0].message.content, dict(response.usage)
@@ -97,13 +101,15 @@ async def _completion_with_retries_async(*args, **kwargs):
                     client = AsyncAzureOpenAI(
                         azure_endpoint = kwargs["api_base"], 
                         api_key=kwargs["api_key"],  
-                        api_version=kwargs["api_version"]
+                        api_version=kwargs["api_version"],
+                        default_headers={USER_AGENT_HEADER_KEY: USER_AGENT},
                     )
                     response = await client.chat.completions.create(messages=kwargs["messages"], model=kwargs["deployment_id"], temperature=kwargs["temperature"], max_tokens=kwargs["max_tokens"])
                 else:
                     from openai import AsyncOpenAI
                     client = AsyncOpenAI(
-                        api_key=kwargs["api_key"],  
+                        api_key=kwargs["api_key"],
+                        default_headers={USER_AGENT_HEADER_KEY: USER_AGENT},
                     )
                     response = await client.chat.completions.create(messages=kwargs["messages"], model=kwargs["model"], temperature=kwargs["temperature"], max_tokens=kwargs["max_tokens"])
                 return response.choices[0].message.content, dict(response.usage)

sdk/ai/azure-ai-resources/azure/ai/resources/_index/_embeddings/openai.py

@@ -6,6 +6,8 @@
 import time
 from typing import Any, Dict, List, Optional
 
+from azure.ai.resources.constants._common import USER_AGENT_HEADER_KEY
+from azure.ai.resources._user_agent import USER_AGENT
 from azure.ai.resources._index._utils.logging import get_logger
 from packaging import version
 
@@ -76,11 +78,13 @@ def __init__(
                     api_key=self.api_key,
                     api_version=self.api_version,
                     azure_endpoint=self.api_base,
+                    default_headers={USER_AGENT_HEADER_KEY: USER_AGENT},
                 )
             else:
                 client = openai.OpenAI(
                     api_key=self.api_key,
                     base_url=self.api_base,
+                    default_headers={USER_AGENT_HEADER_KEY: USER_AGENT},
                 )
 
             self.embedding_client = client.embeddings

sdk/ai/azure-ai-resources/azure/ai/resources/constants/_common.py

@@ -5,6 +5,7 @@
 
 DEFAULT_OPEN_AI_CONNECTION_NAME = "Default_AzureOpenAI"
 DEFAULT_CONTENT_SAFETY_CONNECTION_NAME = "Default_AzureAIContentSafety"
+USER_AGENT_HEADER_KEY = "Client-User-Agent"
 
 class AssetTypes:
     """AssetTypes is an enumeration of values for the asset types of a data.