Community/Partner: Adding Azure community and partner user agent to better track usage in Python (#29561)

- This pull request includes various changes to add a `user_agent`
parameter to Azure OpenAI, Azure Search and Whisper in the Community and
Partner packages. This helps in identifying the source of API requests
so we can better track usage and help support the community better. I
will also be adding the user_agent to the new `langchain-azure` repo as
well.

- No issue connected or  updated dependencies. 
- Utilises existing tests and docs

---------

Co-authored-by: Erick Friis <[email protected]>

Author: 2 people

libs/community/langchain_community/chat_models/azure_openai.py

@@ -209,7 +209,10 @@ def validate_environment(cls, values: Dict) -> Dict:
                 "base_url": values["openai_api_base"],
                 "timeout": values["request_timeout"],
                 "max_retries": values["max_retries"],
-                "default_headers": values["default_headers"],
+                "default_headers": {
+                    **(values["default_headers"] or {}),
+                    "User-Agent": "langchain-comm-python-azure-openai",
+                },
                 "default_query": values["default_query"],
                 "http_client": values["http_client"],
             }

libs/community/langchain_community/embeddings/azure_openai.py

@@ -163,7 +163,10 @@ def post_init_validator(self) -> Self:
                 "base_url": self.openai_api_base,
                 "timeout": self.request_timeout,
                 "max_retries": self.max_retries,
-                "default_headers": self.default_headers,
+                "default_headers": {
+                    **(self.default_headers or {}),
+                    "User-Agent": "langchain-comm-python-azure-openai",
+                },
                 "default_query": self.default_query,
                 "http_client": self.http_client,
             }

libs/community/langchain_community/llms/openai.py

@@ -924,7 +924,10 @@ def validate_environment(cls, values: Dict) -> Dict:
                 "base_url": values["openai_api_base"],
                 "timeout": values["request_timeout"],
                 "max_retries": values["max_retries"],
-                "default_headers": values["default_headers"],
+                "default_headers": {
+                    **(values["default_headers"] or {}),
+                    "User-Agent": "langchain-comm-python-azure-openai",
+                },
                 "default_query": values["default_query"],
                 "http_client": values["http_client"],
             }

libs/community/langchain_community/vectorstores/azuresearch.py

@@ -94,7 +94,7 @@ def _get_search_client(
     scoring_profiles: Optional[List[ScoringProfile]] = None,
     default_scoring_profile: Optional[str] = None,
     default_fields: Optional[List[SearchField]] = None,
-    user_agent: Optional[str] = "langchain",
+    user_agent: Optional[str] = "langchain-comm-python-azure-search",
     cors_options: Optional[CorsOptions] = None,
     async_: bool = False,
     additional_search_client_options: Optional[Dict[str, Any]] = None,

libs/partners/openai/langchain_openai/chat_models/azure.py

@@ -643,7 +643,10 @@ def validate_environment(self) -> Self:
             "organization": self.openai_organization,
             "base_url": self.openai_api_base,
             "timeout": self.request_timeout,
-            "default_headers": self.default_headers,
+            "default_headers": {
+                **(self.default_headers or {}),
+                "User-Agent": "langchain-partner-python-azure-openai",
+            },
             "default_query": self.default_query,
         }
         if self.max_retries is not None:

libs/partners/openai/langchain_openai/embeddings/azure.py

@@ -198,7 +198,10 @@ def validate_environment(self) -> Self:
             "base_url": self.openai_api_base,
             "timeout": self.request_timeout,
             "max_retries": self.max_retries,
-            "default_headers": self.default_headers,
+            "default_headers": {
+                **(self.default_headers or {}),
+                "User-Agent": "langchain-partner-python-azure-openai",
+            },
             "default_query": self.default_query,
         }
         if not self.client:

libs/partners/openai/langchain_openai/llms/azure.py

@@ -153,7 +153,10 @@ def validate_environment(self) -> Self:
             "base_url": self.openai_api_base,
             "timeout": self.request_timeout,
             "max_retries": self.max_retries,
-            "default_headers": self.default_headers,
+            "default_headers": {
+                **(self.default_headers or {}),
+                "User-Agent": "langchain-partner-python-azure-openai",
+            },
             "default_query": self.default_query,
         }
         if not self.client: