Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion sdk/search/azure-search-documents/assets.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
"AssetsRepo": "Azure/azure-sdk-assets",
"AssetsRepoPrefixPath": "python",
"TagPrefix": "python/search/azure-search-documents",
"Tag": "python/search/azure-search-documents_5fa507ca6f"
"Tag": "python/search/azure-search-documents_3ab3bb866c"
}
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ class ApiVersion(str, Enum, metaclass=CaseInsensitiveEnumMeta):
V2020_06_30 = "2020-06-30"
V2023_11_01 = "2023-11-01"
V2024_07_01 = "2024-07-01"
V2025_08_01_PREVIEW = "2025-08-01-preview"
V2025_11_01_PREVIEW = "2025-11-01-preview"


DEFAULT_VERSION = ApiVersion.V2025_08_01_PREVIEW
DEFAULT_VERSION = ApiVersion.V2025_11_01_PREVIEW
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# 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.
# --------------------------------------------------------------------------
# pylint: disable=wrong-import-position
Expand All @@ -10,7 +12,10 @@
if TYPE_CHECKING:
from ._patch import * # pylint: disable=unused-wildcard-import

from ._search_index_client import SearchIndexClient # type: ignore
from ._client import SearchIndexClient # type: ignore
from ._version import VERSION

__version__ = VERSION

try:
from ._patch import __all__ as _patch_all
Expand Down
Original file line number Diff line number Diff line change
@@ -1,42 +1,54 @@
# 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 ._utils.serialization import Deserializer, Serializer
from .operations import DocumentsOperations

if TYPE_CHECKING:
from azure.core.credentials import TokenCredential


class SearchIndexClient:
"""Client that can be used to query an index and upload, merge, or delete documents.
"""SearchIndexClient.

: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 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
:param index_name: The name of the index. Required.
:type index_name: str
:keyword api_version: Api Version. Default value is "2025-08-01-preview". Note that overriding
this default value may result in unsupported behavior.
:keyword api_version: The API version to use for this operation. Default value is
"2025-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
def __init__(
self, endpoint: str, credential: Union[AzureKeyCredential, "TokenCredential"], index_name: str, **kwargs: Any
) -> None:
_endpoint = "{endpoint}/indexes('{indexName}')"
self._config = SearchIndexClientConfiguration(endpoint=endpoint, index_name=index_name, **kwargs)
_endpoint = "{endpoint}"
self._config = SearchIndexClientConfiguration(
endpoint=endpoint, credential=credential, index_name=index_name, **kwargs
)

_policies = kwargs.pop("policies", None)
if _policies is None:
Expand All @@ -57,19 +69,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
Expand All @@ -84,7 +95,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)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,14 +1,20 @@
# 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 typing import Any
from typing import Any, TYPE_CHECKING, Union

from azure.core.credentials import AzureKeyCredential
from azure.core.pipeline import policies

VERSION = "unknown"
from ._version import VERSION

if TYPE_CHECKING:
from azure.core.credentials import TokenCredential


class SearchIndexClientConfiguration: # pylint: disable=too-many-instance-attributes
Expand All @@ -17,30 +23,48 @@ class SearchIndexClientConfiguration: # pylint: disable=too-many-instance-attri
Note that all parameters used to create this instance are saved as instance
attributes.

:param endpoint: The endpoint URL of the search service. Required.
: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
:param index_name: The name of the index. Required.
:type index_name: str
:keyword api_version: Api Version. Default value is "2025-08-01-preview". Note that overriding
this default value may result in unsupported behavior.
:keyword api_version: The API version to use for this operation. Default value is
"2025-11-01-preview". Note that overriding this default value may result in unsupported
behavior.
:paramtype api_version: str
"""

def __init__(self, endpoint: str, index_name: str, **kwargs: Any) -> None:
api_version: str = kwargs.pop("api_version", "2025-08-01-preview")
def __init__(
self, endpoint: str, credential: Union[AzureKeyCredential, "TokenCredential"], index_name: str, **kwargs: Any
) -> None:
api_version: str = kwargs.pop("api_version", "2025-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.")
if index_name is None:
raise ValueError("Parameter 'index_name' must not be None.")

self.endpoint = endpoint
self.credential = credential
self.index_name = index_name
self.api_version = api_version
kwargs.setdefault("sdk_moniker", "searchindexclient/{}".format(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)
Expand All @@ -51,3 +75,5 @@ def _configure(self, **kwargs: Any) -> None:
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)
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# --------------------------------------------------------------------------
# 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.
# --------------------------------------------------------------------------
Loading
Loading