Skip to content

Search 11.5.0 tsp #38397

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 12 commits into
base: search_11.5.0
Choose a base branch
from
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
Original file line number Diff line number Diff line change
@@ -1,10 +1,15 @@
# coding=utf-8
# --------------------------------------------------------------------------
# Code generated by Microsoft (R) AutoRest Code Generator (autorest: 3.10.2, generator: @autorest/python@6.15.0)
# 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 ._search_index_client import SearchIndexClient
from ._client import SearchClient
from ._version import VERSION

__version__ = VERSION

try:
from ._patch import __all__ as _patch_all
Expand All @@ -14,7 +19,7 @@
from ._patch import patch_sdk as _patch_sdk

__all__ = [
"SearchIndexClient",
"SearchClient",
]
__all__.extend([p for p in _patch_all if p not in __all__])

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,141 @@
# 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 copy import deepcopy
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 ._configuration import SearchClientConfiguration
from ._serialization import Deserializer, Serializer
from .operations import (
DataSourcesOperationsOperations,
DocumentsOperationsOperations,
IndexersOperationsOperations,
IndexesOperationsOperations,
SearchClientOperationsMixin,
SkillsetsOperationsOperations,
SynonymMapsOperationsOperations,
)

if TYPE_CHECKING:
from azure.core.credentials import TokenCredential


class SearchClient(SearchClientOperationsMixin): # pylint: disable=too-many-instance-attributes
"""Client that can be used to manage and query indexes and documents, as well as
manage other resources, on a search service.

:ivar data_sources_operations: DataSourcesOperationsOperations operations
:vartype data_sources_operations:
azure.search.documents.operations.DataSourcesOperationsOperations
:ivar indexers_operations: IndexersOperationsOperations operations
:vartype indexers_operations: azure.search.documents.operations.IndexersOperationsOperations
:ivar skillsets_operations: SkillsetsOperationsOperations operations
:vartype skillsets_operations: azure.search.documents.operations.SkillsetsOperationsOperations
:ivar synonym_maps_operations: SynonymMapsOperationsOperations operations
:vartype synonym_maps_operations:
azure.search.documents.operations.SynonymMapsOperationsOperations
:ivar indexes_operations: IndexesOperationsOperations operations
:vartype indexes_operations: azure.search.documents.operations.IndexesOperationsOperations
:ivar documents_operations: DocumentsOperationsOperations operations
:vartype documents_operations: azure.search.documents.operations.DocumentsOperationsOperations
:param endpoint: Service host. Required.
:type endpoint: str
:param credential: Credential used to authenticate requests to the service. Is either a
AzureKeyCredential type or a TokenCredential 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-07-01".
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:
_endpoint = "{endpoint}"
self._config = SearchClientConfiguration(endpoint=endpoint, credential=credential, **kwargs)
_policies = kwargs.pop("policies", None)
if _policies is None:
_policies = [
policies.RequestIdPolicy(**kwargs),
self._config.headers_policy,
self._config.user_agent_policy,
self._config.proxy_policy,
policies.ContentDecodePolicy(**kwargs),
self._config.redirect_policy,
self._config.retry_policy,
self._config.authentication_policy,
self._config.custom_hook_policy,
self._config.logging_policy,
policies.DistributedTracingPolicy(**kwargs),
policies.SensitiveHeaderCleanupPolicy(**kwargs) if self._config.redirect_policy else None,
self._config.http_logging_policy,
]
self._client: PipelineClient = PipelineClient(base_url=_endpoint, policies=_policies, **kwargs)

self._serialize = Serializer()
self._deserialize = Deserializer()
self._serialize.client_side_validation = False
self.data_sources_operations = DataSourcesOperationsOperations(
self._client, self._config, self._serialize, self._deserialize
)
self.indexers_operations = IndexersOperationsOperations(
self._client, self._config, self._serialize, self._deserialize
)
self.skillsets_operations = SkillsetsOperationsOperations(
self._client, self._config, self._serialize, self._deserialize
)
self.synonym_maps_operations = SynonymMapsOperationsOperations(
self._client, self._config, self._serialize, self._deserialize
)
self.indexes_operations = IndexesOperationsOperations(
self._client, self._config, self._serialize, self._deserialize
)
self.documents_operations = DocumentsOperationsOperations(
self._client, self._config, self._serialize, self._deserialize
)

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)
<HttpResponse: 200 OK>

For more information on this code flow, see https://aka.ms/azsdk/dpcodegen/python/send_request

:param request: The network request you want to make. Required.
: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_copy = deepcopy(request)
path_format_arguments = {
"endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True),
}

request_copy.url = self._client.format_url(request_copy.url, **path_format_arguments)
return self._client.send_request(request_copy, stream=stream, **kwargs) # type: ignore

def close(self) -> None:
self._client.close()

def __enter__(self) -> Self:
self._client.__enter__()
return self

def __exit__(self, *exc_details: Any) -> None:
self._client.__exit__(*exc_details)
Original file line number Diff line number Diff line change
@@ -1,46 +1,62 @@
# coding=utf-8
# --------------------------------------------------------------------------
# Code generated by Microsoft (R) AutoRest Code Generator (autorest: 3.10.2, generator: @autorest/python@6.15.0)
# 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,name-too-long
"""Configuration for SearchIndexClient.

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: 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-07-01". Note that overriding this
default value may result in unsupported behavior.
:param credential: Credential used to authenticate requests to the service. Is either a
AzureKeyCredential type or a TokenCredential 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-07-01".
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:
def __init__(self, endpoint: str, credential: Union[AzureKeyCredential, "TokenCredential"], **kwargs: Any) -> None:
api_version: str = kwargs.pop("api_version", "2024-07-01")

if endpoint is None:
raise ValueError("Parameter 'endpoint' must not be None.")
if index_name is None:
raise ValueError("Parameter 'index_name' must not be None.")
if credential is None:
raise ValueError("Parameter 'credential' must not be None.")

self.endpoint = endpoint
self.index_name = index_name
self.credential = credential
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 +67,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)
Loading
Loading