add send request method (#34038)

* add send request method

* update

* update

* update

* update

Author: xiangyan99

sdk/search/azure-search-documents/CHANGELOG.md

@@ -1,14 +1,14 @@
 # Release History
 
-## 11.6.0b1 (Unreleased)
+## 11.6.0b1 (2024-01-31)
 
 ### Features Added
 
-- Added `semantic_query` for `Search` method.
-- Added back alias operations to `SearchIndexClient`
+- Added back `semantic_query` for `Search` method.
+- Added back alias operations to `SearchIndexClient`.
+- Added back `AzureOpenAIEmbeddingSkill`, `AzureOpenAIParameters` and `AzureOpenAIVectorizer`.
 - Added back `query_language`, `query_speller`, `semantic_fields` and `debug` for `Search` method.
-
-### Breaking Changes
+- Added `send_request` method for `SearchClient` & `SearchIndexClient` to run a network request using the client's existing pipeline.
 
 ### Bugs Fixed
 

sdk/search/azure-search-documents/azure/search/documents/_generated/models/_search_index_client_enums.py

@@ -276,8 +276,6 @@ class ScoringStatistics(str, Enum, metaclass=CaseInsensitiveEnumMeta):
     """The scoring statistics will be calculated locally for lower latency."""
     GLOBAL = "global"
     """The scoring statistics will be calculated globally for more consistent scoring."""
-    GLOBAL_ENUM = "global"
-    """The scoring statistics will be calculated globally for more consistent scoring."""
 
 
 class SearchMode(str, Enum, metaclass=CaseInsensitiveEnumMeta):

sdk/search/azure-search-documents/azure/search/documents/_headers_mixin.py

@@ -4,17 +4,17 @@
 # license information.
 # --------------------------------------------------------------------------
 
-from typing import Optional, Dict, Any
+from typing import Optional, Dict, Any, MutableMapping
 
 
 class HeadersMixin:
     @property
     def _headers(self) -> Dict[str, Any]:
         return {"api-key": self._credential.key, "Accept": self._ODATA_ACCEPT}  # type: ignore
 
-    def _merge_client_headers(self, headers: Optional[Dict[str, Any]]) -> Optional[Dict[str, Any]]:
+    def _merge_client_headers(self, headers: Optional[MutableMapping[str, str]]) -> MutableMapping[str, str]:
         if self._aad:  # type: ignore
-            return headers
+            return headers or {}
         headers = headers or {}
         combined = self._headers
         combined.update(headers)

sdk/search/azure-search-documents/azure/search/documents/_search_client.py

@@ -5,6 +5,7 @@
 # --------------------------------------------------------------------------
 from typing import cast, List, Any, Union, Dict, Optional
 
+from azure.core.rest import HttpRequest, HttpResponse
 from azure.core.credentials import AzureKeyCredential, TokenCredential
 from azure.core.tracing.decorator import distributed_trace
 from ._api_versions import DEFAULT_VERSION
@@ -705,3 +706,16 @@ def __enter__(self) -> "SearchClient":
 
     def __exit__(self, *args) -> None:
         self._client.__exit__(*args)
+
+    @distributed_trace
+    def send_request(self, request: HttpRequest, *, stream: bool = False, **kwargs) -> HttpResponse:
+        """Runs a network request using the client's existing pipeline.
+
+        :param request: The network request you want to make.
+        :type request: ~azure.core.rest.HttpRequest
+        :keyword bool stream: Whether the response payload will be streamed. Defaults to False.
+        :return: The response of your network call. Does not do error handling on your response.
+        :rtype: ~azure.core.rest.HttpResponse
+        """
+        request.headers = self._merge_client_headers(request.headers)
+        return self._client._send_request(request, stream=stream, **kwargs)  # pylint:disable=protected-access

sdk/search/azure-search-documents/azure/search/documents/aio/_search_client_async.py

@@ -5,6 +5,7 @@
 # --------------------------------------------------------------------------
 from typing import cast, List, Union, Any, Optional, Dict
 
+from azure.core.rest import HttpRequest, AsyncHttpResponse
 from azure.core.credentials import AzureKeyCredential
 from azure.core.credentials_async import AsyncTokenCredential
 from azure.core.tracing.decorator_async import distributed_trace_async
@@ -703,3 +704,16 @@ async def __aenter__(self) -> "SearchClient":
 
     async def __aexit__(self, *args) -> None:
         await self._client.__aexit__(*args)
+
+    @distributed_trace_async
+    async def send_request(self, request: HttpRequest, *, stream: bool = False, **kwargs) -> AsyncHttpResponse:
+        """Runs a network request using the client's existing pipeline.
+
+        :param request: The network request you want to make.
+        :type request: ~azure.core.rest.HttpRequest
+        :keyword bool stream: Whether the response payload will be streamed. Defaults to False.
+        :return: The response of your network call. Does not do error handling on your response.
+        :rtype: ~azure.core.rest.AsyncHttpResponse
+        """
+        request.headers = self._merge_client_headers(request.headers)
+        return await self._client._send_request(request, stream=stream, **kwargs)  # pylint:disable=protected-access

sdk/search/azure-search-documents/azure/search/documents/indexes/_search_index_client.py

@@ -5,6 +5,7 @@
 # --------------------------------------------------------------------------
 from typing import Any, List, Union, Optional, MutableMapping, cast
 
+from azure.core.rest import HttpRequest, HttpResponse
 from azure.core import MatchConditions
 from azure.core.credentials import AzureKeyCredential, TokenCredential
 from azure.core.tracing.decorator import distributed_trace
@@ -614,3 +615,16 @@ def create_or_update_alias(
             alias_name=alias.name, alias=alias, prefer="return=representation", error_map=error_map, **kwargs
         )
         return result  # pylint:disable=protected-access
+
+    @distributed_trace
+    def send_request(self, request: HttpRequest, *, stream: bool = False, **kwargs) -> HttpResponse:
+        """Runs a network request using the client's existing pipeline.
+
+        :param request: The network request you want to make.
+        :type request: ~azure.core.rest.HttpRequest
+        :keyword bool stream: Whether the response payload will be streamed. Defaults to False.
+        :return: The response of your network call. Does not do error handling on your response.
+        :rtype: ~azure.core.rest.HttpResponse
+        """
+        request.headers = self._merge_client_headers(request.headers)
+        return self._client._send_request(request, stream=stream, **kwargs)  # pylint:disable=protected-access

sdk/search/azure-search-documents/azure/search/documents/indexes/aio/_search_index_client.py

@@ -5,6 +5,7 @@
 # --------------------------------------------------------------------------
 from typing import Union, Any, List, Optional, MutableMapping, cast
 
+from azure.core.rest import HttpRequest, AsyncHttpResponse
 from azure.core import MatchConditions
 from azure.core.credentials import AzureKeyCredential
 from azure.core.credentials_async import AsyncTokenCredential
@@ -603,3 +604,16 @@ async def create_or_update_alias(
             alias_name=alias.name, alias=alias, prefer="return=representation", error_map=error_map, **kwargs
         )
         return result  # pylint:disable=protected-access
+
+    @distributed_trace_async
+    async def send_request(self, request: HttpRequest, *, stream: bool = False, **kwargs) -> AsyncHttpResponse:
+        """Runs a network request using the client's existing pipeline.
+
+        :param request: The network request you want to make.
+        :type request: ~azure.core.rest.HttpRequest
+        :keyword bool stream: Whether the response payload will be streamed. Defaults to False.
+        :return: The response of your network call. Does not do error handling on your response.
+        :rtype: ~azure.core.rest.AsyncHttpResponse
+        """
+        request.headers = self._merge_client_headers(request.headers)
+        return await self._client._send_request(request, stream=stream, **kwargs)  # pylint:disable=protected-access

sdk/search/azure-search-documents/samples/async_samples/sample_index_client_send_request_async.py

@@ -0,0 +1,49 @@
+# coding: utf-8
+
+# -------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+# --------------------------------------------------------------------------
+
+"""
+FILE: sample_index_client_send_request_async.py
+
+DESCRIPTION:
+    This sample demonstrates how to make custom HTTP requests through a client pipeline.
+
+USAGE:
+    python sample_index_client_send_request_async.py
+
+    Set the environment variables with your own values before running the sample:
+    1) AZURE_SEARCH_SERVICE_ENDPOINT - the endpoint of your Azure Cognitive Search service
+    2) AZURE_SEARCH_INDEX_NAME - the name of your search index (e.g. "hotels-sample-index")
+    3) AZURE_SEARCH_API_KEY - your search API key
+"""
+
+import asyncio
+import os
+from azure.core.credentials import AzureKeyCredential
+from azure.core.rest import HttpRequest
+from azure.search.documents.indexes.aio import SearchIndexClient
+
+
+async def sample_send_request():
+    endpoint = os.environ["AZURE_SEARCH_SERVICE_ENDPOINT"]
+    index_name = os.environ["AZURE_SEARCH_INDEX_NAME"]
+    key = os.environ["AZURE_SEARCH_API_KEY"]
+
+    client = SearchIndexClient(endpoint, AzureKeyCredential(key))
+
+    # The `send_request` method can send custom HTTP requests that share the client's existing pipeline,
+    # while adding convenience for endpoint construction.
+    request = HttpRequest(method="GET", url=f"/indexes('{index_name}')?api-version=2023-10-01-Preview")
+    async with client:
+        response = await client.send_request(request)
+    response.raise_for_status()
+    response_body = response.json()
+    print(response_body)
+
+
+if __name__ == "__main__":
+    asyncio.run(sample_send_request())

sdk/search/azure-search-documents/samples/async_samples/sample_search_client_send_request_async.py

@@ -0,0 +1,49 @@
+# coding: utf-8
+
+# -------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+# --------------------------------------------------------------------------
+
+"""
+FILE: sample_search_client_send_request_async.py
+
+DESCRIPTION:
+    This sample demonstrates how to make custom HTTP requests through a client pipeline.
+
+USAGE:
+    python sample_search_client_send_request_async.py
+
+    Set the environment variables with your own values before running the sample:
+    1) AZURE_SEARCH_SERVICE_ENDPOINT - the endpoint of your Azure Cognitive Search service
+    2) AZURE_SEARCH_INDEX_NAME - the name of your search index (e.g. "hotels-sample-index")
+    3) AZURE_SEARCH_API_KEY - your search API key
+"""
+
+import asyncio
+import os
+from azure.core.credentials import AzureKeyCredential
+from azure.core.rest import HttpRequest
+from azure.search.documents.aio import SearchClient
+
+
+async def sample_send_request():
+    endpoint = os.environ["AZURE_SEARCH_SERVICE_ENDPOINT"]
+    index_name = os.environ["AZURE_SEARCH_INDEX_NAME"]
+    key = os.environ["AZURE_SEARCH_API_KEY"]
+
+    client = SearchClient(endpoint, index_name, AzureKeyCredential(key))
+
+    # The `send_request` method can send custom HTTP requests that share the client's existing pipeline,
+    # while adding convenience for endpoint construction.
+    request = HttpRequest(method="GET", url=f"/docs/$count?api-version=2023-10-01-Preview")
+    async with client:
+        response = await client.send_request(request)
+    response.raise_for_status()
+    response_body = response.json()
+    print(response_body)
+
+
+if __name__ == "__main__":
+    asyncio.run(sample_send_request())

sdk/search/azure-search-documents/samples/sample_index_client_send_request.py

@@ -0,0 +1,47 @@
+# coding: utf-8
+
+# -------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+# --------------------------------------------------------------------------
+
+"""
+FILE: sample_index_client_send_request.py
+
+DESCRIPTION:
+    This sample demonstrates how to make custom HTTP requests through a client pipeline.
+
+USAGE:
+    python sample_index_client_send_request.py
+
+    Set the environment variables with your own values before running the sample:
+    1) AZURE_SEARCH_SERVICE_ENDPOINT - the endpoint of your Azure Cognitive Search service
+    2) AZURE_SEARCH_INDEX_NAME - the name of your search index (e.g. "hotels-sample-index")
+    3) AZURE_SEARCH_API_KEY - your search API key
+"""
+
+import os
+from azure.core.credentials import AzureKeyCredential
+from azure.core.rest import HttpRequest
+from azure.search.documents.indexes import SearchIndexClient
+
+
+def sample_send_request():
+    endpoint = os.environ["AZURE_SEARCH_SERVICE_ENDPOINT"]
+    index_name = os.environ["AZURE_SEARCH_INDEX_NAME"]
+    key = os.environ["AZURE_SEARCH_API_KEY"]
+
+    client = SearchIndexClient(endpoint, AzureKeyCredential(key))
+
+    # The `send_request` method can send custom HTTP requests that share the client's existing pipeline,
+    # while adding convenience for endpoint construction.
+    request = HttpRequest(method="GET", url=f"/indexes('{index_name}')?api-version=2023-10-01-Preview")
+    response = client.send_request(request)
+    response.raise_for_status()
+    response_body = response.json()
+    print(response_body)
+
+
+if __name__ == "__main__":
+    sample_send_request()