Skip to content
Merged
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
Expand Up @@ -29,7 +29,7 @@
IndexAction,
IndexDocumentsBatch,
IndexingResult,
SearchIndexClient,
SearchClient,
SearchItemPaged,
SearchQuery,
SuggestQuery,
Expand Down Expand Up @@ -179,7 +179,7 @@
"RegexFlags",
"ScoringFunction",
"ScoringProfile",
"SearchIndexClient",
"SearchClient",
"SearchItemPaged",
"SearchQuery",
"SearchServiceClient",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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 "<SearchIndexClient [endpoint={}, index={}]>".format(
return "<SearchClient [endpoint={}, index={}]>".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()
Expand Down Expand Up @@ -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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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")
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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 "<SearchIndexClient [endpoint={}, index={}]>".format(
return "<SearchClient [endpoint={}, index={}]>".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()
Expand Down Expand Up @@ -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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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")
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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")

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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'")
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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")
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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")
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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")

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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()
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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")

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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'")
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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")

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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")

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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")

Expand Down
Loading