CodeGen from PR 31462 in Azure/azure-rest-api-specs

Merge 6e8da2bf660c40e4ffe4c2ff83686ad205398675 into 0c98405fdf8f502af169bcc936a54f5194ea33c1

Author: SDKAuto

sdk/search/azure-search-documents/MANIFEST.in

@@ -1,7 +1,7 @@
 include *.md
-include azure/__init__.py
-include azure/search/__init__.py
 include LICENSE
+include azure/search/documents/py.typed
 recursive-include tests *.py
 recursive-include samples *.py *.md
-include azure/search/documents/py.typed
+include azure/__init__.py
+include azure/search/__init__.py

sdk/search/azure-search-documents/_meta.json

@@ -0,0 +1,6 @@
+{
+  "commit": "b07620e90797e507a7400b1bb134b74bbda71b29",
+  "repository_url": "https://github.com/Azure/azure-rest-api-specs",
+  "typespec_src": "specification/search/Azure.Search.Index",
+  "@azure-tools/typespec-python": "0.38.4"
+}

sdk/search/azure-search-documents/apiview-properties.json

@@ -0,0 +1,74 @@
+{
+    "CrossLanguagePackageId": "Search",
+    "CrossLanguageDefinitionId": {
+        "azure.search.documents.models.AutocompleteItem": "Search.AutocompleteItem",
+        "azure.search.documents.models.AutocompleteRequest": "Search.AutocompleteRequest",
+        "azure.search.documents.models.AutocompleteResult": "Search.AutocompleteResult",
+        "azure.search.documents.models.DebugInfo": "Search.DebugInfo",
+        "azure.search.documents.models.DocumentDebugInfo": "Search.DocumentDebugInfo",
+        "azure.search.documents.models.ErrorAdditionalInfo": "Search.ErrorAdditionalInfo",
+        "azure.search.documents.models.ErrorDetail": "Search.ErrorDetail",
+        "azure.search.documents.models.ErrorResponse": "Search.ErrorResponse",
+        "azure.search.documents.models.FacetResult": "Search.FacetResult",
+        "azure.search.documents.models.HybridSearch": "Search.HybridSearch",
+        "azure.search.documents.models.IndexAction": "Search.IndexAction",
+        "azure.search.documents.models.IndexBatch": "Search.IndexBatch",
+        "azure.search.documents.models.IndexDocumentsResult": "Search.IndexDocumentsResult",
+        "azure.search.documents.models.IndexingResult": "Search.IndexingResult",
+        "azure.search.documents.models.LookupDocument": "Search.LookupDocument",
+        "azure.search.documents.models.QueryAnswerResult": "Search.QueryAnswerResult",
+        "azure.search.documents.models.QueryCaptionResult": "Search.QueryCaptionResult",
+        "azure.search.documents.models.QueryResultDocumentRerankerInput": "Search.QueryResultDocumentRerankerInput",
+        "azure.search.documents.models.QueryResultDocumentSemanticField": "Search.QueryResultDocumentSemanticField",
+        "azure.search.documents.models.QueryResultDocumentSubscores": "Search.QueryResultDocumentSubscores",
+        "azure.search.documents.models.QueryRewritesDebugInfo": "Search.QueryRewritesDebugInfo",
+        "azure.search.documents.models.QueryRewritesValuesDebugInfo": "Search.QueryRewritesValuesDebugInfo",
+        "azure.search.documents.models.SearchDocumentsResult": "Search.SearchDocumentsResult",
+        "azure.search.documents.models.SearchRequest": "Search.SearchRequest",
+        "azure.search.documents.models.SearchResult": "Search.SearchResult",
+        "azure.search.documents.models.VectorThreshold": "Search.VectorThreshold",
+        "azure.search.documents.models.SearchScoreThreshold": "Search.SearchScoreThreshold",
+        "azure.search.documents.models.SemanticDebugInfo": "Search.SemanticDebugInfo",
+        "azure.search.documents.models.SingleVectorFieldResult": "Search.SingleVectorFieldResult",
+        "azure.search.documents.models.SuggestDocumentsResult": "Search.SuggestDocumentsResult",
+        "azure.search.documents.models.SuggestRequest": "Search.SuggestRequest",
+        "azure.search.documents.models.SuggestResult": "Search.SuggestResult",
+        "azure.search.documents.models.TextResult": "Search.TextResult",
+        "azure.search.documents.models.VectorQuery": "Search.VectorQuery",
+        "azure.search.documents.models.VectorizableImageBinaryQuery": "Search.VectorizableImageBinaryQuery",
+        "azure.search.documents.models.VectorizableImageUrlQuery": "Search.VectorizableImageUrlQuery",
+        "azure.search.documents.models.VectorizableTextQuery": "Search.VectorizableTextQuery",
+        "azure.search.documents.models.VectorizedQuery": "Search.VectorizedQuery",
+        "azure.search.documents.models.VectorsDebugInfo": "Search.VectorsDebugInfo",
+        "azure.search.documents.models.VectorSimilarityThreshold": "Search.VectorSimilarityThreshold",
+        "azure.search.documents.models.QueryType": "Search.QueryType",
+        "azure.search.documents.models.ScoringStatistics": "Search.ScoringStatistics",
+        "azure.search.documents.models.QueryDebugMode": "Search.QueryDebugMode",
+        "azure.search.documents.models.SearchMode": "Search.SearchMode",
+        "azure.search.documents.models.QueryLanguage": "Search.QueryLanguage",
+        "azure.search.documents.models.QuerySpellerType": "Search.QuerySpellerType",
+        "azure.search.documents.models.SemanticErrorMode": "Search.SemanticErrorMode",
+        "azure.search.documents.models.QueryAnswerType": "Search.QueryAnswerType",
+        "azure.search.documents.models.QueryCaptionType": "Search.QueryCaptionType",
+        "azure.search.documents.models.QueryRewritesType": "Search.QueryRewritesType",
+        "azure.search.documents.models.VectorThresholdKind": "Search.VectorThresholdKind",
+        "azure.search.documents.models.VectorQueryKind": "Search.VectorQueryKind",
+        "azure.search.documents.models.VectorFilterMode": "Search.VectorFilterMode",
+        "azure.search.documents.models.HybridCountAndFacetMode": "Search.HybridCountAndFacetMode",
+        "azure.search.documents.models.SemanticFieldState": "Search.SemanticFieldState",
+        "azure.search.documents.models.SemanticErrorReason": "Search.SemanticErrorReason",
+        "azure.search.documents.models.SemanticSearchResultsType": "Search.SemanticSearchResultsType",
+        "azure.search.documents.models.SemanticQueryRewritesResultType": "Search.SemanticQueryRewritesResultType",
+        "azure.search.documents.models.IndexActionType": "Search.IndexActionType",
+        "azure.search.documents.models.AutocompleteMode": "Search.AutocompleteMode",
+        "azure.search.documents.SearchClient.documents.count": "Search.Documents.count",
+        "azure.search.documents.SearchClient.documents.search_get": "Search.Documents.searchGet",
+        "azure.search.documents.SearchClient.documents.search_post": "Search.Documents.searchPost",
+        "azure.search.documents.SearchClient.documents.get": "Search.Documents.get",
+        "azure.search.documents.SearchClient.documents.suggest_get": "Search.Documents.suggestGet",
+        "azure.search.documents.SearchClient.documents.suggest_post": "Search.Documents.suggestPost",
+        "azure.search.documents.SearchClient.documents.index": "Search.Documents.index",
+        "azure.search.documents.SearchClient.documents.autocomplete_get": "Search.Documents.autocompleteGet",
+        "azure.search.documents.SearchClient.documents.autocomplete_post": "Search.Documents.autocompletePost"
+    }
+}

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

@@ -1,6 +1 @@
-# ------------------------------------
-# Copyright (c) Microsoft Corporation.
-# Licensed under the MIT License.
-# ------------------------------------
-# pylint:disable=missing-docstring
-__path__ = __import__("pkgutil").extend_path(__path__, __name__)
+__path__ = __import__("pkgutil").extend_path(__path__, __name__)  # type: ignore

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

@@ -1,6 +1 @@
-# ------------------------------------
-# Copyright (c) Microsoft Corporation.
-# Licensed under the MIT License.
-# ------------------------------------
-# pylint:disable=missing-docstring
-__path__ = __import__("pkgutil").extend_path(__path__, __name__)
+__path__ = __import__("pkgutil").extend_path(__path__, __name__)  # type: ignore

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

@@ -1,44 +1,32 @@
+# coding=utf-8
 # --------------------------------------------------------------------------
-#
 # Copyright (c) Microsoft Corporation. All rights reserved.
-#
-# The MIT License (MIT)
-#
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the ""Software""), to
-# deal in the Software without restriction, including without limitation the
-# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
-# sell copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
-# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
-# IN THE SOFTWARE.
-#
+# Licensed under the MIT License. See License.txt in the project root for license information.
+# Code generated by Microsoft (R) Python Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is regenerated.
 # --------------------------------------------------------------------------
+# pylint: disable=wrong-import-position
 
-from ._index_documents_batch import IndexDocumentsBatch
-from ._search_documents_error import RequestEntityTooLargeError
-from ._search_client import SearchClient, SearchItemPaged
-from ._search_indexing_buffered_sender import SearchIndexingBufferedSender
-from ._api_versions import ApiVersion
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from ._patch import *  # pylint: disable=unused-wildcard-import
+
+from ._client import SearchClient  # type: ignore
 from ._version import VERSION
 
 __version__ = VERSION
 
+try:
+    from ._patch import __all__ as _patch_all
+    from ._patch import *
+except ImportError:
+    _patch_all = []
+from ._patch import patch_sdk as _patch_sdk
 
-__all__ = (
-    "ApiVersion",
-    "IndexDocumentsBatch",
+__all__ = [
     "SearchClient",
-    "SearchItemPaged",
-    "SearchIndexingBufferedSender",
-    "RequestEntityTooLargeError",
-)
+]
+__all__.extend([p for p in _patch_all if p not in __all__])  # pyright: ignore
+
+_patch_sdk()

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

@@ -1,42 +1,48 @@
 # coding=utf-8
 # --------------------------------------------------------------------------
-# Code generated by Microsoft (R) AutoRest Code Generator (autorest: 3.9.5, generator: @autorest/[email protected])
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+# Code generated by Microsoft (R) Python Code Generator.
 # Changes may cause incorrect behavior and will be lost if the code is regenerated.
 # --------------------------------------------------------------------------
 
 from copy import deepcopy
-from typing import Any
+from typing import Any, TYPE_CHECKING, Union
 from typing_extensions import Self
 
 from azure.core import PipelineClient
+from azure.core.credentials import AzureKeyCredential
 from azure.core.pipeline import policies
 from azure.core.rest import HttpRequest, HttpResponse
 
-from . import models as _models
-from ._configuration import SearchIndexClientConfiguration
+from ._configuration import SearchClientConfiguration
 from ._serialization import Deserializer, Serializer
 from .operations import DocumentsOperations
 
+if TYPE_CHECKING:
+    from azure.core.credentials import TokenCredential
 
-class SearchIndexClient:
+
+class SearchClient:
     """Client that can be used to query an index and upload, merge, or delete documents.
 
     :ivar documents: DocumentsOperations operations
     :vartype documents: azure.search.documents.operations.DocumentsOperations
-    :param endpoint: The endpoint URL of the search service. Required.
+    :param endpoint: Service host. Required.
     :type endpoint: str
-    :param index_name: The name of the index. Required.
-    :type index_name: str
-    :keyword api_version: Api Version. Default value is "2024-11-01-preview". Note that overriding
-     this default value may result in unsupported behavior.
+    :param credential: Credential used to authenticate requests to the service. Is either a key
+     credential type or a token credential type. Required.
+    :type credential: ~azure.core.credentials.AzureKeyCredential or
+     ~azure.core.credentials.TokenCredential
+    :keyword api_version: The API version to use for this operation. Default value is
+     "2024-11-01-preview". Note that overriding this default value may result in unsupported
+     behavior.
     :paramtype api_version: str
     """
 
-    def __init__(  # pylint: disable=missing-client-constructor-parameter-credential
-        self, endpoint: str, index_name: str, **kwargs: Any
-    ) -> None:
-        _endpoint = "{endpoint}/indexes('{indexName}')"
-        self._config = SearchIndexClientConfiguration(endpoint=endpoint, index_name=index_name, **kwargs)
+    def __init__(self, endpoint: str, credential: Union[AzureKeyCredential, "TokenCredential"], **kwargs: Any) -> None:
+        _endpoint = "{endpoint}"
+        self._config = SearchClientConfiguration(endpoint=endpoint, credential=credential, **kwargs)
         _policies = kwargs.pop("policies", None)
         if _policies is None:
             _policies = [
@@ -56,19 +62,18 @@ def __init__(  # pylint: disable=missing-client-constructor-parameter-credential
             ]
         self._client: PipelineClient = PipelineClient(base_url=_endpoint, policies=_policies, **kwargs)
 
-        client_models = {k: v for k, v in _models.__dict__.items() if isinstance(v, type)}
-        self._serialize = Serializer(client_models)
-        self._deserialize = Deserializer(client_models)
+        self._serialize = Serializer()
+        self._deserialize = Deserializer()
         self._serialize.client_side_validation = False
         self.documents = DocumentsOperations(self._client, self._config, self._serialize, self._deserialize)
 
-    def _send_request(self, request: HttpRequest, *, stream: bool = False, **kwargs: Any) -> HttpResponse:
+    def send_request(self, request: HttpRequest, *, stream: bool = False, **kwargs: Any) -> HttpResponse:
         """Runs the network request through the client's chained policies.
 
         >>> from azure.core.rest import HttpRequest
         >>> request = HttpRequest("GET", "https://www.example.org/")
         <HttpRequest [GET], url: 'https://www.example.org/'>
-        >>> response = client._send_request(request)
+        >>> response = client.send_request(request)
         <HttpResponse: 200 OK>
 
         For more information on this code flow, see https://aka.ms/azsdk/dpcodegen/python/send_request
@@ -83,7 +88,6 @@ def _send_request(self, request: HttpRequest, *, stream: bool = False, **kwargs:
         request_copy = deepcopy(request)
         path_format_arguments = {
             "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True),
-            "indexName": self._serialize.url("self._config.index_name", self._config.index_name, "str"),
         }
 
         request_copy.url = self._client.format_url(request_copy.url, **path_format_arguments)

sdk/search/azure-search-documents/azure/search/documents/_generated/_search_index_client.py renamed to sdk/search/azure-search-documents/azure/search/documents/_client.py

@@ -0,0 +1,72 @@
+# 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.
+# Code generated by Microsoft (R) Python Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is regenerated.
+# --------------------------------------------------------------------------
+
+from typing import Any, TYPE_CHECKING, Union
+
+from azure.core.credentials import AzureKeyCredential
+from azure.core.pipeline import policies
+
+from ._version import VERSION
+
+if TYPE_CHECKING:
+    from azure.core.credentials import TokenCredential
+
+
+class SearchClientConfiguration:  # pylint: disable=too-many-instance-attributes
+    """Configuration for SearchClient.
+
+    Note that all parameters used to create this instance are saved as instance
+    attributes.
+
+    :param endpoint: Service host. Required.
+    :type endpoint: str
+    :param credential: Credential used to authenticate requests to the service. Is either a key
+     credential type or a token credential type. Required.
+    :type credential: ~azure.core.credentials.AzureKeyCredential or
+     ~azure.core.credentials.TokenCredential
+    :keyword api_version: The API version to use for this operation. Default value is
+     "2024-11-01-preview". Note that overriding this default value may result in unsupported
+     behavior.
+    :paramtype api_version: str
+    """
+
+    def __init__(self, endpoint: str, credential: Union[AzureKeyCredential, "TokenCredential"], **kwargs: Any) -> None:
+        api_version: str = kwargs.pop("api_version", "2024-11-01-preview")
+
+        if endpoint is None:
+            raise ValueError("Parameter 'endpoint' must not be None.")
+        if credential is None:
+            raise ValueError("Parameter 'credential' must not be None.")
+
+        self.endpoint = endpoint
+        self.credential = credential
+        self.api_version = api_version
+        self.credential_scopes = kwargs.pop("credential_scopes", ["https://search.azure.com/.default"])
+        kwargs.setdefault("sdk_moniker", "search-documents/{}".format(VERSION))
+        self.polling_interval = kwargs.get("polling_interval", 30)
+        self._configure(**kwargs)
+
+    def _infer_policy(self, **kwargs):
+        if isinstance(self.credential, AzureKeyCredential):
+            return policies.AzureKeyCredentialPolicy(self.credential, "api-key", **kwargs)
+        if hasattr(self.credential, "get_token"):
+            return policies.BearerTokenCredentialPolicy(self.credential, *self.credential_scopes, **kwargs)
+        raise TypeError(f"Unsupported credential: {self.credential}")
+
+    def _configure(self, **kwargs: Any) -> None:
+        self.user_agent_policy = kwargs.get("user_agent_policy") or policies.UserAgentPolicy(**kwargs)
+        self.headers_policy = kwargs.get("headers_policy") or policies.HeadersPolicy(**kwargs)
+        self.proxy_policy = kwargs.get("proxy_policy") or policies.ProxyPolicy(**kwargs)
+        self.logging_policy = kwargs.get("logging_policy") or policies.NetworkTraceLoggingPolicy(**kwargs)
+        self.http_logging_policy = kwargs.get("http_logging_policy") or policies.HttpLoggingPolicy(**kwargs)
+        self.custom_hook_policy = kwargs.get("custom_hook_policy") or policies.CustomHookPolicy(**kwargs)
+        self.redirect_policy = kwargs.get("redirect_policy") or policies.RedirectPolicy(**kwargs)
+        self.retry_policy = kwargs.get("retry_policy") or policies.RetryPolicy(**kwargs)
+        self.authentication_policy = kwargs.get("authentication_policy")
+        if self.credential and not self.authentication_policy:
+            self.authentication_policy = self._infer_policy(**kwargs)