diff --git a/sdk/search/azure-search-documents/azure/search/documents/__init__.py b/sdk/search/azure-search-documents/azure/search/documents/__init__.py index 6649b52bf787..11191c28483a 100644 --- a/sdk/search/azure-search-documents/azure/search/documents/__init__.py +++ b/sdk/search/azure-search-documents/azure/search/documents/__init__.py @@ -29,7 +29,7 @@ IndexAction, IndexDocumentsBatch, IndexingResult, - SearchIndexClient, + SearchClient, SearchItemPaged, SearchQuery, SuggestQuery, @@ -179,7 +179,7 @@ "RegexFlags", "ScoringFunction", "ScoringProfile", - "SearchIndexClient", + "SearchClient", "SearchItemPaged", "SearchQuery", "SearchServiceClient", diff --git a/sdk/search/azure-search-documents/azure/search/documents/_index/__init__.py b/sdk/search/azure-search-documents/azure/search/documents/_index/__init__.py index d43ed7e45817..e92f4d4ea68a 100644 --- a/sdk/search/azure-search-documents/azure/search/documents/_index/__init__.py +++ b/sdk/search/azure-search-documents/azure/search/documents/_index/__init__.py @@ -3,10 +3,10 @@ # Licensed under the MIT License. # ------------------------------------ from ._index_documents_batch import IndexDocumentsBatch # pylint: disable=unused-import -from ._search_index_client import ( # pylint: disable=unused-import +from ._search_client import ( # pylint: disable=unused-import odata, SearchItemPaged, - SearchIndexClient, + SearchClient, ) from ._queries import ( # pylint: disable=unused-import AutocompleteQuery, diff --git a/sdk/search/azure-search-documents/azure/search/documents/_index/_search_index_client.py b/sdk/search/azure-search-documents/azure/search/documents/_index/_search_client.py similarity index 97% rename from sdk/search/azure-search-documents/azure/search/documents/_index/_search_index_client.py rename to sdk/search/azure-search-documents/azure/search/documents/_index/_search_client.py index 467e0be2d0ca..a3f02e5ec4da 100644 --- a/sdk/search/azure-search-documents/azure/search/documents/_index/_search_index_client.py +++ b/sdk/search/azure-search-documents/azure/search/documents/_index/_search_client.py @@ -8,7 +8,7 @@ import six from azure.core.tracing.decorator import distributed_trace -from ._generated import SearchIndexClient as _SearchIndexClient +from ._generated import SearchIndexClient from ._generated.models import IndexBatch, IndexingResult from ._index_documents_batch import IndexDocumentsBatch from ._paging import SearchItemPaged, SearchPageIterator @@ -50,7 +50,7 @@ def odata(statement, **kwargs): return statement.format(**kw) -class SearchIndexClient(HeadersMixin): +class SearchClient(HeadersMixin): """A client to interact with an existing Azure search index. :param endpoint: The URL endpoint of an Azure search service @@ -67,7 +67,7 @@ class SearchIndexClient(HeadersMixin): :end-before: [END create_search_client_with_key] :language: python :dedent: 4 - :caption: Creating the SearchIndexClient with an API key. + :caption: Creating the SearchClient with an API key. """ _ODATA_ACCEPT = "application/json;odata.metadata=none" # type: str @@ -78,19 +78,19 @@ def __init__(self, endpoint, index_name, credential, **kwargs): self._endpoint = endpoint # type: str self._index_name = index_name # type: str self._credential = credential # type: AzureKeyCredential - self._client = _SearchIndexClient( + self._client = SearchIndexClient( endpoint=endpoint, index_name=index_name, sdk_moniker=SDK_MONIKER, **kwargs - ) # type: _SearchIndexClient + ) # type: SearchIndexClient def __repr__(self): # type: () -> str - return "".format( + return "".format( repr(self._endpoint), repr(self._index_name) )[:1024] def close(self): # type: () -> None - """Close the :class:`~azure.search.SearchIndexClient` session. + """Close the :class:`~azure.search.SearchClient` session. """ return self._client.close() @@ -369,7 +369,7 @@ def index_documents(self, batch, **kwargs): return cast(List[IndexingResult], batch_response.results) def __enter__(self): - # type: () -> SearchIndexClient + # type: () -> SearchClient self._client.__enter__() # pylint:disable=no-member return self diff --git a/sdk/search/azure-search-documents/azure/search/documents/_index/aio/__init__.py b/sdk/search/azure-search-documents/azure/search/documents/_index/aio/__init__.py index 3be55b46fa76..a6e0693ac87b 100644 --- a/sdk/search/azure-search-documents/azure/search/documents/_index/aio/__init__.py +++ b/sdk/search/azure-search-documents/azure/search/documents/_index/aio/__init__.py @@ -2,6 +2,6 @@ # Copyright (c) Microsoft Corporation. # Licensed under the MIT License. # ------------------------------------ -from ._search_index_client_async import AsyncSearchItemPaged, SearchIndexClient +from ._search_client_async import AsyncSearchItemPaged, SearchClient -__all__ = ("AsyncSearchItemPaged", "SearchIndexClient") +__all__ = ("AsyncSearchItemPaged", "SearchClient") diff --git a/sdk/search/azure-search-documents/azure/search/documents/_index/aio/_search_index_client_async.py b/sdk/search/azure-search-documents/azure/search/documents/_index/aio/_search_client_async.py similarity index 96% rename from sdk/search/azure-search-documents/azure/search/documents/_index/aio/_search_index_client_async.py rename to sdk/search/azure-search-documents/azure/search/documents/_index/aio/_search_client_async.py index 2176e4ea1506..d960bafa356f 100644 --- a/sdk/search/azure-search-documents/azure/search/documents/_index/aio/_search_index_client_async.py +++ b/sdk/search/azure-search-documents/azure/search/documents/_index/aio/_search_client_async.py @@ -9,7 +9,7 @@ from azure.core.tracing.decorator_async import distributed_trace_async from ._paging import AsyncSearchItemPaged, AsyncSearchPageIterator -from .._generated.aio import SearchIndexClient as _SearchIndexClient +from .._generated.aio import SearchIndexClient from .._generated.models import IndexBatch, IndexingResult, SearchRequest from .._index_documents_batch import IndexDocumentsBatch from .._queries import AutocompleteQuery, SearchQuery, SuggestQuery @@ -22,7 +22,7 @@ from azure.core.credentials import AzureKeyCredential -class SearchIndexClient(HeadersMixin): +class SearchClient(HeadersMixin): """A client to interact with an existing Azure search index. :param endpoint: The URL endpoint of an Azure search service @@ -39,7 +39,7 @@ class SearchIndexClient(HeadersMixin): :end-before: [END create_search_client_with_key_async] :language: python :dedent: 4 - :caption: Creating the SearchIndexClient with an API key. + :caption: Creating the SearchClient with an API key. """ _ODATA_ACCEPT = "application/json;odata.metadata=none" # type: str @@ -50,19 +50,19 @@ def __init__(self, endpoint, index_name, credential, **kwargs): self._endpoint = endpoint # type: str self._index_name = index_name # type: str self._credential = credential # type: AzureKeyCredential - self._client = _SearchIndexClient( + self._client = SearchIndexClient( endpoint=endpoint, index_name=index_name, sdk_moniker=SDK_MONIKER, **kwargs - ) # type: _SearchIndexClient + ) # type: SearchIndexClient def __repr__(self): # type: () -> str - return "".format( + return "".format( repr(self._endpoint), repr(self._index_name) )[:1024] async def close(self): # type: () -> None - """Close the :class:`~azure.search.aio.SearchIndexClient` session. + """Close the :class:`~azure.search.aio.SearchClient` session. """ return await self._client.close() @@ -342,7 +342,7 @@ async def index_documents(self, batch, **kwargs): return cast(List[IndexingResult], batch_response.results) async def __aenter__(self): - # type: () -> SearchIndexClient + # type: () -> SearchClient await self._client.__aenter__() # pylint: disable=no-member return self diff --git a/sdk/search/azure-search-documents/azure/search/documents/aio.py b/sdk/search/azure-search-documents/azure/search/documents/aio.py index 395e4eceb156..626fecfd63b9 100644 --- a/sdk/search/azure-search-documents/azure/search/documents/aio.py +++ b/sdk/search/azure-search-documents/azure/search/documents/aio.py @@ -24,7 +24,7 @@ # # -------------------------------------------------------------------------- -from ._index.aio import AsyncSearchItemPaged, SearchIndexClient +from ._index.aio import AsyncSearchItemPaged, SearchClient from ._service.aio import SearchServiceClient -__all__ = ("AsyncSearchItemPaged", "SearchIndexClient", "SearchServiceClient") +__all__ = ("AsyncSearchItemPaged", "SearchClient", "SearchServiceClient") diff --git a/sdk/search/azure-search-documents/samples/async_samples/sample_authentication_async.py b/sdk/search/azure-search-documents/samples/async_samples/sample_authentication_async.py index ecbafb5b1e4d..66ee638437fb 100644 --- a/sdk/search/azure-search-documents/samples/async_samples/sample_authentication_async.py +++ b/sdk/search/azure-search-documents/samples/async_samples/sample_authentication_async.py @@ -26,12 +26,12 @@ async def authentication_with_api_key_credential_async(): # [START create_search_client_with_key_async] from azure.core.credentials import AzureKeyCredential - from azure.search.documents.aio import SearchIndexClient + from azure.search.documents.aio import SearchClient service_endpoint = os.getenv("AZURE_SEARCH_SERVICE_ENDPOINT") index_name = os.getenv("AZURE_SEARCH_INDEX_NAME") key = os.getenv("AZURE_SEARCH_API_KEY") - search_client = SearchIndexClient(service_endpoint, index_name, AzureKeyCredential(key)) + search_client = SearchClient(service_endpoint, index_name, AzureKeyCredential(key)) # [END create_search_client_with_key_async] async with search_client: diff --git a/sdk/search/azure-search-documents/samples/async_samples/sample_autocomplete_async.py b/sdk/search/azure-search-documents/samples/async_samples/sample_autocomplete_async.py index 05b3b0a52622..6c7f6779efee 100644 --- a/sdk/search/azure-search-documents/samples/async_samples/sample_autocomplete_async.py +++ b/sdk/search/azure-search-documents/samples/async_samples/sample_autocomplete_async.py @@ -31,10 +31,10 @@ async def autocomplete_query(): # [START autocomplete_query_async] from azure.core.credentials import AzureKeyCredential - from azure.search.documents.aio import SearchIndexClient + from azure.search.documents.aio import SearchClient from azure.search.documents import AutocompleteQuery - search_client = SearchIndexClient(service_endpoint, index_name, AzureKeyCredential(key)) + search_client = SearchClient(service_endpoint, index_name, AzureKeyCredential(key)) query = AutocompleteQuery(search_text="bo", suggester_name="sg") diff --git a/sdk/search/azure-search-documents/samples/async_samples/sample_crud_operations_async.py b/sdk/search/azure-search-documents/samples/async_samples/sample_crud_operations_async.py index 475ee05e3432..4ef0e1549c64 100644 --- a/sdk/search/azure-search-documents/samples/async_samples/sample_crud_operations_async.py +++ b/sdk/search/azure-search-documents/samples/async_samples/sample_crud_operations_async.py @@ -28,10 +28,10 @@ key = os.getenv("AZURE_SEARCH_API_KEY") from azure.core.credentials import AzureKeyCredential -from azure.search.documents.aio import SearchIndexClient +from azure.search.documents.aio import SearchClient from azure.search.documents import SearchQuery -search_client = SearchIndexClient(service_endpoint, index_name, AzureKeyCredential(key)) +search_client = SearchClient(service_endpoint, index_name, AzureKeyCredential(key)) async def upload_document(): # [START upload_document_async] diff --git a/sdk/search/azure-search-documents/samples/async_samples/sample_facet_query_async.py b/sdk/search/azure-search-documents/samples/async_samples/sample_facet_query_async.py index 8c85ed4d2ad7..c24c4b3f5f8b 100644 --- a/sdk/search/azure-search-documents/samples/async_samples/sample_facet_query_async.py +++ b/sdk/search/azure-search-documents/samples/async_samples/sample_facet_query_async.py @@ -31,10 +31,10 @@ async def filter_query(): # [START facet_query_async] from azure.core.credentials import AzureKeyCredential - from azure.search.documents.aio import SearchIndexClient + from azure.search.documents.aio import SearchClient from azure.search.documents import SearchQuery - search_client = SearchIndexClient(service_endpoint, index_name, AzureKeyCredential(key)) + search_client = SearchClient(service_endpoint, index_name, AzureKeyCredential(key)) query = SearchQuery(search_text="WiFi", facets=["Category"], top=0) diff --git a/sdk/search/azure-search-documents/samples/async_samples/sample_filter_query_async.py b/sdk/search/azure-search-documents/samples/async_samples/sample_filter_query_async.py index 9f61119013ec..09056cbe54c7 100644 --- a/sdk/search/azure-search-documents/samples/async_samples/sample_filter_query_async.py +++ b/sdk/search/azure-search-documents/samples/async_samples/sample_filter_query_async.py @@ -31,10 +31,10 @@ async def filter_query(): # [START filter_query_async] from azure.core.credentials import AzureKeyCredential - from azure.search.documents.aio import SearchIndexClient + from azure.search.documents.aio import SearchClient from azure.search.documents import SearchQuery - search_client = SearchIndexClient(service_endpoint, index_name, AzureKeyCredential(key)) + search_client = SearchClient(service_endpoint, index_name, AzureKeyCredential(key)) query = SearchQuery(search_text="WiFi") query.filter("Address/StateProvince eq 'FL' and Address/Country eq 'USA'") diff --git a/sdk/search/azure-search-documents/samples/async_samples/sample_get_document_async.py b/sdk/search/azure-search-documents/samples/async_samples/sample_get_document_async.py index 273233e6d519..a859f3d38e08 100644 --- a/sdk/search/azure-search-documents/samples/async_samples/sample_get_document_async.py +++ b/sdk/search/azure-search-documents/samples/async_samples/sample_get_document_async.py @@ -31,9 +31,9 @@ async def autocomplete_query(): # [START get_document_async] from azure.core.credentials import AzureKeyCredential - from azure.search.documents.aio import SearchIndexClient + from azure.search.documents.aio import SearchClient - search_client = SearchIndexClient(service_endpoint, index_name, AzureKeyCredential(key)) + search_client = SearchClient(service_endpoint, index_name, AzureKeyCredential(key)) async with search_client: result = await search_client.get_document(key="23") diff --git a/sdk/search/azure-search-documents/samples/async_samples/sample_simple_query_async.py b/sdk/search/azure-search-documents/samples/async_samples/sample_simple_query_async.py index 5fec53f4c1ad..28810821a5f7 100644 --- a/sdk/search/azure-search-documents/samples/async_samples/sample_simple_query_async.py +++ b/sdk/search/azure-search-documents/samples/async_samples/sample_simple_query_async.py @@ -31,9 +31,9 @@ async def simple_text_query(): # [START simple_query_async] from azure.core.credentials import AzureKeyCredential - from azure.search.documents.aio import SearchIndexClient + from azure.search.documents.aio import SearchClient - search_client = SearchIndexClient(service_endpoint, index_name, AzureKeyCredential(key)) + search_client = SearchClient(service_endpoint, index_name, AzureKeyCredential(key)) async with search_client: results = await search_client.search(query="spa") diff --git a/sdk/search/azure-search-documents/samples/async_samples/sample_suggestions_async.py b/sdk/search/azure-search-documents/samples/async_samples/sample_suggestions_async.py index c41e26435d00..83019cff6022 100644 --- a/sdk/search/azure-search-documents/samples/async_samples/sample_suggestions_async.py +++ b/sdk/search/azure-search-documents/samples/async_samples/sample_suggestions_async.py @@ -31,10 +31,10 @@ async def suggest_query(): # [START suggest_query_async] from azure.core.credentials import AzureKeyCredential - from azure.search.documents.aio import SearchIndexClient + from azure.search.documents.aio import SearchClient from azure.search.documents import SuggestQuery - search_client = SearchIndexClient(service_endpoint, index_name, AzureKeyCredential(key)) + search_client = SearchClient(service_endpoint, index_name, AzureKeyCredential(key)) query = SuggestQuery(search_text="coffee", suggester_name="sg") diff --git a/sdk/search/azure-search-documents/samples/sample_authentication.py b/sdk/search/azure-search-documents/samples/sample_authentication.py index 571c160ab5e4..5a40c7e258f4 100644 --- a/sdk/search/azure-search-documents/samples/sample_authentication.py +++ b/sdk/search/azure-search-documents/samples/sample_authentication.py @@ -26,13 +26,13 @@ def authentication_with_api_key_credential(): # [START create_search_client_with_key] from azure.core.credentials import AzureKeyCredential - from azure.search.documents import SearchIndexClient + from azure.search.documents import SearchClient service_endpoint = os.getenv("AZURE_SEARCH_SERVICE_ENDPOINT") index_name = os.getenv("AZURE_SEARCH_INDEX_NAME") key = os.getenv("AZURE_SEARCH_API_KEY") - search_client = SearchIndexClient(service_endpoint, index_name, AzureKeyCredential(key)) + search_client = SearchClient(service_endpoint, index_name, AzureKeyCredential(key)) # [END create_search_client_with_key] result = search_client.get_document_count() diff --git a/sdk/search/azure-search-documents/samples/sample_autocomplete.py b/sdk/search/azure-search-documents/samples/sample_autocomplete.py index 4c007accd909..1d6ab4d1b69a 100644 --- a/sdk/search/azure-search-documents/samples/sample_autocomplete.py +++ b/sdk/search/azure-search-documents/samples/sample_autocomplete.py @@ -29,9 +29,9 @@ def autocomplete_query(): # [START autocomplete_query] from azure.core.credentials import AzureKeyCredential - from azure.search.documents import AutocompleteQuery, SearchIndexClient + from azure.search.documents import AutocompleteQuery, SearchClient - search_client = SearchIndexClient(service_endpoint, index_name, AzureKeyCredential(key)) + search_client = SearchClient(service_endpoint, index_name, AzureKeyCredential(key)) query = AutocompleteQuery(search_text="bo", suggester_name="sg") diff --git a/sdk/search/azure-search-documents/samples/sample_crud_operations.py b/sdk/search/azure-search-documents/samples/sample_crud_operations.py index 2d3e183594b0..fd96f2c69f66 100644 --- a/sdk/search/azure-search-documents/samples/sample_crud_operations.py +++ b/sdk/search/azure-search-documents/samples/sample_crud_operations.py @@ -27,9 +27,9 @@ key = os.getenv("AZURE_SEARCH_API_KEY") from azure.core.credentials import AzureKeyCredential -from azure.search.documents import SearchIndexClient +from azure.search.documents import SearchClient -search_client = SearchIndexClient(service_endpoint, index_name, AzureKeyCredential(key)) +search_client = SearchClient(service_endpoint, index_name, AzureKeyCredential(key)) def upload_document(): # [START upload_document] diff --git a/sdk/search/azure-search-documents/samples/sample_facet_query.py b/sdk/search/azure-search-documents/samples/sample_facet_query.py index 7e895114a043..bf4a3fb3acc0 100644 --- a/sdk/search/azure-search-documents/samples/sample_facet_query.py +++ b/sdk/search/azure-search-documents/samples/sample_facet_query.py @@ -29,9 +29,9 @@ def filter_query(): # [START facet_query] from azure.core.credentials import AzureKeyCredential - from azure.search.documents import SearchIndexClient, SearchQuery + from azure.search.documents import SearchClient, SearchQuery - search_client = SearchIndexClient(service_endpoint, index_name, AzureKeyCredential(key)) + search_client = SearchClient(service_endpoint, index_name, AzureKeyCredential(key)) query = SearchQuery(search_text="WiFi", facets=["Category"], top=0) diff --git a/sdk/search/azure-search-documents/samples/sample_filter_query.py b/sdk/search/azure-search-documents/samples/sample_filter_query.py index b276254d72d2..7ffd281ee059 100644 --- a/sdk/search/azure-search-documents/samples/sample_filter_query.py +++ b/sdk/search/azure-search-documents/samples/sample_filter_query.py @@ -29,9 +29,9 @@ def filter_query(): # [START filter_query] from azure.core.credentials import AzureKeyCredential - from azure.search.documents import SearchIndexClient, SearchQuery + from azure.search.documents import SearchClient, SearchQuery - search_client = SearchIndexClient(service_endpoint, index_name, AzureKeyCredential(key)) + search_client = SearchClient(service_endpoint, index_name, AzureKeyCredential(key)) query = SearchQuery(search_text="WiFi") query.filter("Address/StateProvince eq 'FL' and Address/Country eq 'USA'") diff --git a/sdk/search/azure-search-documents/samples/sample_get_document.py b/sdk/search/azure-search-documents/samples/sample_get_document.py index 3dea251b7a81..8f9d56721268 100644 --- a/sdk/search/azure-search-documents/samples/sample_get_document.py +++ b/sdk/search/azure-search-documents/samples/sample_get_document.py @@ -29,9 +29,9 @@ def get_document(): # [START get_document] from azure.core.credentials import AzureKeyCredential - from azure.search.documents import SearchIndexClient + from azure.search.documents import SearchClient - search_client = SearchIndexClient(service_endpoint, index_name, AzureKeyCredential(key)) + search_client = SearchClient(service_endpoint, index_name, AzureKeyCredential(key)) result = search_client.get_document(key="23") diff --git a/sdk/search/azure-search-documents/samples/sample_simple_query.py b/sdk/search/azure-search-documents/samples/sample_simple_query.py index da8cec8e924d..3948ae446a76 100644 --- a/sdk/search/azure-search-documents/samples/sample_simple_query.py +++ b/sdk/search/azure-search-documents/samples/sample_simple_query.py @@ -29,9 +29,9 @@ def simple_text_query(): # [START simple_query] from azure.core.credentials import AzureKeyCredential - from azure.search.documents import SearchIndexClient + from azure.search.documents import SearchClient - search_client = SearchIndexClient(service_endpoint, index_name, AzureKeyCredential(key)) + search_client = SearchClient(service_endpoint, index_name, AzureKeyCredential(key)) results = search_client.search(query="spa") diff --git a/sdk/search/azure-search-documents/samples/sample_suggestions.py b/sdk/search/azure-search-documents/samples/sample_suggestions.py index 9a3dc16a400f..a5e708e4b30a 100644 --- a/sdk/search/azure-search-documents/samples/sample_suggestions.py +++ b/sdk/search/azure-search-documents/samples/sample_suggestions.py @@ -29,9 +29,9 @@ def suggest_query(): # [START suggest_query] from azure.core.credentials import AzureKeyCredential - from azure.search.documents import SearchIndexClient, SuggestQuery + from azure.search.documents import SearchClient, SuggestQuery - search_client = SearchIndexClient(service_endpoint, index_name, AzureKeyCredential(key)) + search_client = SearchClient(service_endpoint, index_name, AzureKeyCredential(key)) query = SuggestQuery(search_text="coffee", suggester_name="sg") diff --git a/sdk/search/azure-search-documents/tests/async_tests/test_index_live_async.py b/sdk/search/azure-search-documents/tests/async_tests/test_index_live_async.py index a66038b1fb51..71e0f9e5bafa 100644 --- a/sdk/search/azure-search-documents/tests/async_tests/test_index_live_async.py +++ b/sdk/search/azure-search-documents/tests/async_tests/test_index_live_async.py @@ -29,7 +29,7 @@ SearchQuery, SuggestQuery, ) -from azure.search.documents.aio import SearchIndexClient +from azure.search.documents.aio import SearchClient TIME_TO_SLEEP = 3 @@ -47,13 +47,13 @@ def run(test_class_instance, *args, **kwargs): return run -class SearchIndexClientTestAsync(AzureMgmtTestCase): +class SearchClientTestAsync(AzureMgmtTestCase): @ResourceGroupPreparer(random_name_enabled=True) @SearchServicePreparer(schema=SCHEMA, index_batch=BATCH) async def test_async_get_document_count( self, api_key, endpoint, index_name, **kwargs ): - client = SearchIndexClient( + client = SearchClient( endpoint, index_name, AzureKeyCredential(api_key) ) async with client: @@ -62,7 +62,7 @@ async def test_async_get_document_count( @ResourceGroupPreparer(random_name_enabled=True) @SearchServicePreparer(schema=SCHEMA, index_batch=BATCH) async def test_get_document(self, api_key, endpoint, index_name, **kwargs): - client = SearchIndexClient( + client = SearchClient( endpoint, index_name, AzureKeyCredential(api_key) ) async with client: @@ -76,7 +76,7 @@ async def test_get_document(self, api_key, endpoint, index_name, **kwargs): @ResourceGroupPreparer(random_name_enabled=True) @SearchServicePreparer(schema=SCHEMA, index_batch=BATCH) async def test_get_document_missing(self, api_key, endpoint, index_name, **kwargs): - client = SearchIndexClient( + client = SearchClient( endpoint, index_name, AzureKeyCredential(api_key) ) async with client: @@ -86,7 +86,7 @@ async def test_get_document_missing(self, api_key, endpoint, index_name, **kwarg @ResourceGroupPreparer(random_name_enabled=True) @SearchServicePreparer(schema=SCHEMA, index_batch=BATCH) async def test_get_search_simple(self, api_key, endpoint, index_name, **kwargs): - client = SearchIndexClient( + client = SearchClient( endpoint, index_name, AzureKeyCredential(api_key) ) async with client: @@ -103,7 +103,7 @@ async def test_get_search_simple(self, api_key, endpoint, index_name, **kwargs): @ResourceGroupPreparer(random_name_enabled=True) @SearchServicePreparer(schema=SCHEMA, index_batch=BATCH) async def test_get_search_filter(self, api_key, endpoint, index_name, **kwargs): - client = SearchIndexClient( + client = SearchClient( endpoint, index_name, AzureKeyCredential(api_key) ) @@ -132,7 +132,7 @@ async def test_get_search_filter(self, api_key, endpoint, index_name, **kwargs): @ResourceGroupPreparer(random_name_enabled=True) @SearchServicePreparer(schema=SCHEMA, index_batch=BATCH) async def test_get_search_counts(self, api_key, endpoint, index_name, **kwargs): - client = SearchIndexClient( + client = SearchClient( endpoint, index_name, AzureKeyCredential(api_key) ) @@ -147,7 +147,7 @@ async def test_get_search_counts(self, api_key, endpoint, index_name, **kwargs): @ResourceGroupPreparer(random_name_enabled=True) @SearchServicePreparer(schema=SCHEMA, index_batch=BATCH) async def test_get_search_coverage(self, api_key, endpoint, index_name, **kwargs): - client = SearchIndexClient( + client = SearchClient( endpoint, index_name, AzureKeyCredential(api_key) ) @@ -166,7 +166,7 @@ async def test_get_search_coverage(self, api_key, endpoint, index_name, **kwargs async def test_get_search_facets_none( self, api_key, endpoint, index_name, **kwargs ): - client = SearchIndexClient( + client = SearchClient( endpoint, index_name, AzureKeyCredential(api_key) ) @@ -182,7 +182,7 @@ async def test_get_search_facets_none( async def test_get_search_facets_result( self, api_key, endpoint, index_name, **kwargs ): - client = SearchIndexClient( + client = SearchClient( endpoint, index_name, AzureKeyCredential(api_key) ) @@ -201,7 +201,7 @@ async def test_get_search_facets_result( @ResourceGroupPreparer(random_name_enabled=True) @SearchServicePreparer(schema=SCHEMA, index_batch=BATCH) async def test_autocomplete(self, api_key, endpoint, index_name, **kwargs): - client = SearchIndexClient( + client = SearchClient( endpoint, index_name, AzureKeyCredential(api_key) ) async with client: @@ -212,7 +212,7 @@ async def test_autocomplete(self, api_key, endpoint, index_name, **kwargs): @ResourceGroupPreparer(random_name_enabled=True) @SearchServicePreparer(schema=SCHEMA, index_batch=BATCH) async def test_suggest(self, api_key, endpoint, index_name, **kwargs): - client = SearchIndexClient( + client = SearchClient( endpoint, index_name, AzureKeyCredential(api_key) ) async with client: @@ -226,7 +226,7 @@ async def test_suggest(self, api_key, endpoint, index_name, **kwargs): @ResourceGroupPreparer(random_name_enabled=True) @SearchServicePreparer(schema=SCHEMA, index_batch=BATCH) async def test_upload_documents_new(self, api_key, endpoint, index_name, **kwargs): - client = SearchIndexClient( + client = SearchClient( endpoint, index_name, AzureKeyCredential(api_key) ) DOCUMENTS = [ @@ -256,7 +256,7 @@ async def test_upload_documents_new(self, api_key, endpoint, index_name, **kwarg async def test_upload_documents_existing( self, api_key, endpoint, index_name, **kwargs ): - client = SearchIndexClient( + client = SearchClient( endpoint, index_name, AzureKeyCredential(api_key) ) DOCUMENTS = [ @@ -273,7 +273,7 @@ async def test_upload_documents_existing( async def test_delete_documents_existing( self, api_key, endpoint, index_name, **kwargs ): - client = SearchIndexClient( + client = SearchClient( endpoint, index_name, AzureKeyCredential(api_key) ) async with client: @@ -300,7 +300,7 @@ async def test_delete_documents_existing( async def test_delete_documents_missing( self, api_key, endpoint, index_name, **kwargs ): - client = SearchIndexClient( + client = SearchClient( endpoint, index_name, AzureKeyCredential(api_key) ) async with client: @@ -327,7 +327,7 @@ async def test_delete_documents_missing( async def test_merge_documents_existing( self, api_key, endpoint, index_name, **kwargs ): - client = SearchIndexClient( + client = SearchClient( endpoint, index_name, AzureKeyCredential(api_key) ) async with client: @@ -354,7 +354,7 @@ async def test_merge_documents_existing( async def test_merge_documents_missing( self, api_key, endpoint, index_name, **kwargs ): - client = SearchIndexClient( + client = SearchClient( endpoint, index_name, AzureKeyCredential(api_key) ) async with client: @@ -381,7 +381,7 @@ async def test_merge_documents_missing( async def test_merge_or_upload_documents( self, api_key, endpoint, index_name, **kwargs ): - client = SearchIndexClient( + client = SearchClient( endpoint, index_name, AzureKeyCredential(api_key) ) async with client: diff --git a/sdk/search/azure-search-documents/tests/async_tests/test_service_live_async.py b/sdk/search/azure-search-documents/tests/async_tests/test_service_live_async.py index c1ed98296563..e89c5dadbb87 100644 --- a/sdk/search/azure-search-documents/tests/async_tests/test_service_live_async.py +++ b/sdk/search/azure-search-documents/tests/async_tests/test_service_live_async.py @@ -52,7 +52,7 @@ def run(test_class_instance, *args, **kwargs): return run -class SearchIndexClientTest(AzureMgmtTestCase): +class SearchClientTest(AzureMgmtTestCase): @ResourceGroupPreparer(random_name_enabled=True) @SearchServicePreparer() async def test_get_service_statistics(self, api_key, endpoint, **kwargs): diff --git a/sdk/search/azure-search-documents/tests/search_service_preparer.py b/sdk/search/azure-search-documents/tests/search_service_preparer.py index d5e0bdaf93f0..101f29400d82 100644 --- a/sdk/search/azure-search-documents/tests/search_service_preparer.py +++ b/sdk/search/azure-search-documents/tests/search_service_preparer.py @@ -121,11 +121,11 @@ def create_resource(self, name, **kwargs): # optionally load data into the index if self.index_batch and self.schema: from azure.core.credentials import AzureKeyCredential - from azure.search.documents import SearchIndexClient + from azure.search.documents import SearchClient from azure.search.documents._index._generated.models import IndexBatch batch = IndexBatch.deserialize(self.index_batch) - index_client = SearchIndexClient( + index_client = SearchClient( self.endpoint, self.index_name, AzureKeyCredential(api_key) ) results = index_client.index_documents(batch) diff --git a/sdk/search/azure-search-documents/tests/test_index_live.py b/sdk/search/azure-search-documents/tests/test_index_live.py index e9328871ddb2..686277cc04f5 100644 --- a/sdk/search/azure-search-documents/tests/test_index_live.py +++ b/sdk/search/azure-search-documents/tests/test_index_live.py @@ -22,18 +22,18 @@ from azure.core.credentials import AzureKeyCredential from azure.search.documents import ( AutocompleteQuery, - SearchIndexClient, + SearchClient, SearchQuery, SuggestQuery, ) TIME_TO_SLEEP = 3 -class SearchIndexClientTest(AzureMgmtTestCase): +class SearchClientTest(AzureMgmtTestCase): @ResourceGroupPreparer(random_name_enabled=True) @SearchServicePreparer(schema=SCHEMA, index_batch=BATCH) def test_get_document_count(self, api_key, endpoint, index_name, **kwargs): - client = SearchIndexClient( + client = SearchClient( endpoint, index_name, AzureKeyCredential(api_key) ) assert client.get_document_count() == 10 @@ -41,7 +41,7 @@ def test_get_document_count(self, api_key, endpoint, index_name, **kwargs): @ResourceGroupPreparer(random_name_enabled=True) @SearchServicePreparer(schema=SCHEMA, index_batch=BATCH) def test_get_document(self, api_key, endpoint, index_name, **kwargs): - client = SearchIndexClient( + client = SearchClient( endpoint, index_name, AzureKeyCredential(api_key) ) for hotel_id in range(1, 11): @@ -54,7 +54,7 @@ def test_get_document(self, api_key, endpoint, index_name, **kwargs): @ResourceGroupPreparer(random_name_enabled=True) @SearchServicePreparer(schema=SCHEMA, index_batch=BATCH) def test_get_document_missing(self, api_key, endpoint, index_name, **kwargs): - client = SearchIndexClient( + client = SearchClient( endpoint, index_name, AzureKeyCredential(api_key) ) with pytest.raises(HttpResponseError): @@ -63,7 +63,7 @@ def test_get_document_missing(self, api_key, endpoint, index_name, **kwargs): @ResourceGroupPreparer(random_name_enabled=True) @SearchServicePreparer(schema=SCHEMA, index_batch=BATCH) def test_get_search_simple(self, api_key, endpoint, index_name, **kwargs): - client = SearchIndexClient( + client = SearchClient( endpoint, index_name, AzureKeyCredential(api_key) ) results = list(client.search(query="hotel")) @@ -75,7 +75,7 @@ def test_get_search_simple(self, api_key, endpoint, index_name, **kwargs): @ResourceGroupPreparer(random_name_enabled=True) @SearchServicePreparer(schema=SCHEMA, index_batch=BATCH) def test_get_search_filter(self, api_key, endpoint, index_name, **kwargs): - client = SearchIndexClient( + client = SearchClient( endpoint, index_name, AzureKeyCredential(api_key) ) @@ -101,7 +101,7 @@ def test_get_search_filter(self, api_key, endpoint, index_name, **kwargs): @ResourceGroupPreparer(random_name_enabled=True) @SearchServicePreparer(schema=SCHEMA, index_batch=BATCH) def test_get_search_counts(self, api_key, endpoint, index_name, **kwargs): - client = SearchIndexClient( + client = SearchClient( endpoint, index_name, AzureKeyCredential(api_key) ) @@ -116,7 +116,7 @@ def test_get_search_counts(self, api_key, endpoint, index_name, **kwargs): @ResourceGroupPreparer(random_name_enabled=True) @SearchServicePreparer(schema=SCHEMA, index_batch=BATCH) def test_get_search_coverage(self, api_key, endpoint, index_name, **kwargs): - client = SearchIndexClient( + client = SearchClient( endpoint, index_name, AzureKeyCredential(api_key) ) @@ -133,7 +133,7 @@ def test_get_search_coverage(self, api_key, endpoint, index_name, **kwargs): @ResourceGroupPreparer(random_name_enabled=True) @SearchServicePreparer(schema=SCHEMA, index_batch=BATCH) def test_get_search_facets_none(self, api_key, endpoint, index_name, **kwargs): - client = SearchIndexClient( + client = SearchClient( endpoint, index_name, AzureKeyCredential(api_key) ) @@ -146,7 +146,7 @@ def test_get_search_facets_none(self, api_key, endpoint, index_name, **kwargs): @ResourceGroupPreparer(random_name_enabled=True) @SearchServicePreparer(schema=SCHEMA, index_batch=BATCH) def test_get_search_facets_result(self, api_key, endpoint, index_name, **kwargs): - client = SearchIndexClient( + client = SearchClient( endpoint, index_name, AzureKeyCredential(api_key) ) @@ -164,7 +164,7 @@ def test_get_search_facets_result(self, api_key, endpoint, index_name, **kwargs) @ResourceGroupPreparer(random_name_enabled=True) @SearchServicePreparer(schema=SCHEMA, index_batch=BATCH) def test_autocomplete(self, api_key, endpoint, index_name, **kwargs): - client = SearchIndexClient( + client = SearchClient( endpoint, index_name, AzureKeyCredential(api_key) ) query = AutocompleteQuery(search_text="mot", suggester_name="sg") @@ -174,7 +174,7 @@ def test_autocomplete(self, api_key, endpoint, index_name, **kwargs): @ResourceGroupPreparer(random_name_enabled=True) @SearchServicePreparer(schema=SCHEMA, index_batch=BATCH) def test_suggest(self, api_key, endpoint, index_name, **kwargs): - client = SearchIndexClient( + client = SearchClient( endpoint, index_name, AzureKeyCredential(api_key) ) query = SuggestQuery(search_text="mot", suggester_name="sg") @@ -187,7 +187,7 @@ def test_suggest(self, api_key, endpoint, index_name, **kwargs): @ResourceGroupPreparer(random_name_enabled=True) @SearchServicePreparer(schema=SCHEMA, index_batch=BATCH) def test_upload_documents_new(self, api_key, endpoint, index_name, **kwargs): - client = SearchIndexClient( + client = SearchClient( endpoint, index_name, AzureKeyCredential(api_key) ) DOCUMENTS = [ @@ -213,7 +213,7 @@ def test_upload_documents_new(self, api_key, endpoint, index_name, **kwargs): @ResourceGroupPreparer(random_name_enabled=True) @SearchServicePreparer(schema=SCHEMA, index_batch=BATCH) def test_upload_documents_existing(self, api_key, endpoint, index_name, **kwargs): - client = SearchIndexClient( + client = SearchClient( endpoint, index_name, AzureKeyCredential(api_key) ) DOCUMENTS = [ @@ -227,7 +227,7 @@ def test_upload_documents_existing(self, api_key, endpoint, index_name, **kwargs @ResourceGroupPreparer(random_name_enabled=True) @SearchServicePreparer(schema=SCHEMA, index_batch=BATCH) def test_delete_documents_existing(self, api_key, endpoint, index_name, **kwargs): - client = SearchIndexClient( + client = SearchClient( endpoint, index_name, AzureKeyCredential(api_key) ) results = client.delete_documents([{"hotelId": "3"}, {"hotelId": "4"}]) @@ -249,7 +249,7 @@ def test_delete_documents_existing(self, api_key, endpoint, index_name, **kwargs @ResourceGroupPreparer(random_name_enabled=True) @SearchServicePreparer(schema=SCHEMA, index_batch=BATCH) def test_delete_documents_missing(self, api_key, endpoint, index_name, **kwargs): - client = SearchIndexClient( + client = SearchClient( endpoint, index_name, AzureKeyCredential(api_key) ) results = client.delete_documents([{"hotelId": "1000"}, {"hotelId": "4"}]) @@ -271,7 +271,7 @@ def test_delete_documents_missing(self, api_key, endpoint, index_name, **kwargs) @ResourceGroupPreparer(random_name_enabled=True) @SearchServicePreparer(schema=SCHEMA, index_batch=BATCH) def test_merge_documents_existing(self, api_key, endpoint, index_name, **kwargs): - client = SearchIndexClient( + client = SearchClient( endpoint, index_name, AzureKeyCredential(api_key) ) results = client.merge_documents( @@ -295,7 +295,7 @@ def test_merge_documents_existing(self, api_key, endpoint, index_name, **kwargs) @ResourceGroupPreparer(random_name_enabled=True) @SearchServicePreparer(schema=SCHEMA, index_batch=BATCH) def test_merge_documents_missing(self, api_key, endpoint, index_name, **kwargs): - client = SearchIndexClient( + client = SearchClient( endpoint, index_name, AzureKeyCredential(api_key) ) results = client.merge_documents( @@ -319,7 +319,7 @@ def test_merge_documents_missing(self, api_key, endpoint, index_name, **kwargs): @ResourceGroupPreparer(random_name_enabled=True) @SearchServicePreparer(schema=SCHEMA, index_batch=BATCH) def test_merge_or_upload_documents(self, api_key, endpoint, index_name, **kwargs): - client = SearchIndexClient( + client = SearchClient( endpoint, index_name, AzureKeyCredential(api_key) ) results = client.merge_or_upload_documents( diff --git a/sdk/search/azure-search-documents/tests/test_search_index_client.py b/sdk/search/azure-search-documents/tests/test_search_index_client.py index 77955055f5d2..8817357ee6e1 100644 --- a/sdk/search/azure-search-documents/tests/test_search_index_client.py +++ b/sdk/search/azure-search-documents/tests/test_search_index_client.py @@ -19,12 +19,12 @@ SearchDocumentsResult, SearchResult, ) -from azure.search.documents._index._search_index_client import SearchPageIterator +from azure.search.documents._index._search_client import SearchPageIterator from azure.search.documents import ( AutocompleteQuery, IndexDocumentsBatch, - SearchIndexClient, + SearchClient, SearchQuery, SuggestQuery, odata, @@ -66,9 +66,9 @@ def test_prevent_double_quoting(self): assert odata("foo eq '{foo}'", foo="a string") == "foo eq 'a string'" -class TestSearchIndexClient(object): +class TestSearchClient(object): def test_init(self): - client = SearchIndexClient("endpoint", "index name", CREDENTIAL) + client = SearchClient("endpoint", "index name", CREDENTIAL) assert client._headers == { "api-key": "test_api_key", "Accept": "application/json;odata.metadata=none", @@ -76,7 +76,7 @@ def test_init(self): def test_credential_roll(self): credential = AzureKeyCredential(key="old_api_key") - client = SearchIndexClient("endpoint", "index name", credential) + client = SearchClient("endpoint", "index name", credential) assert client._headers == { "api-key": "old_api_key", "Accept": "application/json;odata.metadata=none", @@ -89,7 +89,7 @@ def test_credential_roll(self): def test_headers_merge(self): credential = AzureKeyCredential(key="test_api_key") - client = SearchIndexClient("endpoint", "index name", credential) + client = SearchClient("endpoint", "index name", credential) orig = {"foo": "bar"} result = client._merge_client_headers(orig) assert result is not orig @@ -100,8 +100,8 @@ def test_headers_merge(self): } def test_repr(self): - client = SearchIndexClient("endpoint", "index name", CREDENTIAL) - assert repr(client) == "".format( + client = SearchClient("endpoint", "index name", CREDENTIAL) + assert repr(client) == "".format( repr("endpoint"), repr("index name") ) @@ -109,7 +109,7 @@ def test_repr(self): "azure.search.documents._index._generated.operations._documents_operations.DocumentsOperations.count" ) def test_get_document_count(self, mock_count): - client = SearchIndexClient("endpoint", "index name", CREDENTIAL) + client = SearchClient("endpoint", "index name", CREDENTIAL) client.get_document_count() assert mock_count.called assert mock_count.call_args[0] == () @@ -121,7 +121,7 @@ def test_get_document_count(self, mock_count): "azure.search.documents._index._generated.operations._documents_operations.DocumentsOperations.get" ) def test_get_document(self, mock_get): - client = SearchIndexClient("endpoint", "index name", CREDENTIAL) + client = SearchClient("endpoint", "index name", CREDENTIAL) client.get_document("some_key") assert mock_get.called assert mock_get.call_args[0] == () @@ -147,7 +147,7 @@ def test_get_document(self, mock_get): "azure.search.documents._index._generated.operations._documents_operations.DocumentsOperations.search_post" ) def test_search_query_argument(self, mock_search_post, query): - client = SearchIndexClient("endpoint", "index name", CREDENTIAL) + client = SearchClient("endpoint", "index name", CREDENTIAL) result = client.search(query) assert isinstance(result, ItemPaged) assert result._page_iterator_class is SearchPageIterator @@ -163,7 +163,7 @@ def test_search_query_argument(self, mock_search_post, query): ) def test_search_bad_argument(self): - client = SearchIndexClient("endpoint", "index name", CREDENTIAL) + client = SearchClient("endpoint", "index name", CREDENTIAL) with pytest.raises(TypeError) as e: client.search(10) assert str(e) == "Expected a SuggestQuery for 'query', but got {}".format( @@ -174,7 +174,7 @@ def test_search_bad_argument(self): "azure.search.documents._index._generated.operations._documents_operations.DocumentsOperations.suggest_post" ) def test_suggest_query_argument(self, mock_suggest_post): - client = SearchIndexClient("endpoint", "index name", CREDENTIAL) + client = SearchClient("endpoint", "index name", CREDENTIAL) result = client.suggest( SuggestQuery(search_text="search text", suggester_name="sg") ) @@ -187,7 +187,7 @@ def test_suggest_query_argument(self, mock_suggest_post): ) def test_suggest_bad_argument(self): - client = SearchIndexClient("endpoint", "index name", CREDENTIAL) + client = SearchClient("endpoint", "index name", CREDENTIAL) with pytest.raises(TypeError) as e: client.suggest("bad_query") assert str(e) == "Expected a SuggestQuery for 'query', but got {}".format( @@ -198,7 +198,7 @@ def test_suggest_bad_argument(self): "azure.search.documents._index._generated.operations._documents_operations.DocumentsOperations.autocomplete_post" ) def test_autocomplete_query_argument(self, mock_autocomplete_post): - client = SearchIndexClient("endpoint", "index name", CREDENTIAL) + client = SearchClient("endpoint", "index name", CREDENTIAL) result = client.autocomplete( AutocompleteQuery(search_text="search text", suggester_name="sg") ) @@ -211,7 +211,7 @@ def test_autocomplete_query_argument(self, mock_autocomplete_post): ) def test_autocomplete_bad_argument(self): - client = SearchIndexClient("endpoint", "index name", CREDENTIAL) + client = SearchClient("endpoint", "index name", CREDENTIAL) with pytest.raises(TypeError) as e: client.autocomplete("bad_query") assert str( @@ -226,9 +226,9 @@ def test_autocomplete_bad_argument(self): @pytest.mark.parametrize("method_name", CRUD_METHOD_NAMES) def test_add_method(self, arg, method_name): with mock.patch.object( - SearchIndexClient, "index_documents", return_value=None + SearchClient, "index_documents", return_value=None ) as mock_index_documents: - client = SearchIndexClient("endpoint", "index name", CREDENTIAL) + client = SearchClient("endpoint", "index name", CREDENTIAL) method = getattr(client, method_name) method(arg, extra="foo") @@ -249,7 +249,7 @@ def test_add_method(self, arg, method_name): "azure.search.documents._index._generated.operations._documents_operations.DocumentsOperations.index" ) def test_index_documents(self, mock_index): - client = SearchIndexClient("endpoint", "index name", CREDENTIAL) + client = SearchClient("endpoint", "index name", CREDENTIAL) batch = IndexDocumentsBatch() batch.add_upload_documents("upload1") diff --git a/sdk/search/azure-search-documents/tests/test_service_live.py b/sdk/search/azure-search-documents/tests/test_service_live.py index 746365839ac1..dac18cb3da68 100644 --- a/sdk/search/azure-search-documents/tests/test_service_live.py +++ b/sdk/search/azure-search-documents/tests/test_service_live.py @@ -34,7 +34,7 @@ BATCH = json.load(open(join(CWD, "hotel_small.json"))) TIME_TO_SLEEP = 5 -class SearchServiceClientTest(AzureMgmtTestCase): +class SearchClientTest(AzureMgmtTestCase): @ResourceGroupPreparer(random_name_enabled=True) @SearchServicePreparer() def test_get_service_statistics(self, api_key, endpoint, **kwargs):