Skip to content
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.

Sign up for GitHub

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

Jump to bottom

code refactoring 4 #11800

Merged
merged 18 commits into from
Jun 5, 2020
Merged

code refactoring 4 #11800

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
0e8db7f
search method only takes search_text
xiangyan99 Jun 3, 2020
2cb3750
update
xiangyan99 Jun 4, 2020
da6d4f5
Add AzureCliCredential and VSCodeCredential to public API (#11790) (#…
xiangyan99 Jun 4, 2020
902db93
Merge branch 'master' into search_search_method
xiangyan99 Jun 4, 2020
119e4e8
get master (#11823)
xiangyan99 Jun 4, 2020
bf94e32
Merge branch 'master' into search_search_method
xiangyan99 Jun 4, 2020
88f8895
rename AnalyzeText to AnalyzeTextRequest
xiangyan99 Jun 4, 2020
25a0755
fixes
xiangyan99 Jun 4, 2020
d4cf252
update
xiangyan99 Jun 4, 2020
6212964
update changelog
xiangyan99 Jun 4, 2020
af02a00
update
xiangyan99 Jun 4, 2020
0c3f697
add types
xiangyan99 Jun 4, 2020
6376587
update
xiangyan99 Jun 4, 2020
a3f66a8
rename batch methods
xiangyan99 Jun 4, 2020
42e60ec
update
xiangyan99 Jun 5, 2020
13d56f4
update
xiangyan99 Jun 5, 2020
a544404
update
xiangyan99 Jun 5, 2020
a6d0fa7
updates
xiangyan99 Jun 5, 2020
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
6 changes: 3 additions & 3 deletions sdk/search/azure-search-documents/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ client = SearchServiceClient(endpoint="<service endpoint>"

You can use the `SearchClient` you created in the first section above to make a basic search request:
```python
results = client.search(query="spa")
results = client.search(search_text="spa")

print("Hotels containing 'spa' in the name (or other fields):")
for result in results:
Expand Down Expand Up @@ -126,7 +126,7 @@ from azure.core.credentials import AzureKeyCredential
from azure.search.documents import SearchClient
client = SearchClient("<service endpoint>", "<index_name>", AzureKeyCredential("<api key>"))

results = client.search(query="spa")
results = client.search(search_text="spa")

print("Hotels containing 'spa' in the name (or other fields):")
for result in results:
Expand Down Expand Up @@ -257,7 +257,7 @@ client = SearchClient("<service endpoint>", "<index_name>", AzureKeyCredential("
Similarly, `logging_enable` can enable detailed logging for a single operation,
even when it isn't enabled for the client:
```python
result = client.search(query="spa", logging_enable=True)
result = client.search(search_text="spa", logging_enable=True)
```

## Next steps
Expand Down
95 changes: 81 additions & 14 deletions sdk/search/azure-search-documents/azure/search/documents/_internal/_search_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,12 +132,12 @@ def get_document(self, key, selected_fields=None, **kwargs):
return cast(dict, result)

@distributed_trace
def search(self, query, **kwargs):
# type: (Union[str, SearchQuery], **Any) -> SearchItemPaged[dict]
def search(self, search_text, **kwargs):
# type: (str, **Any) -> SearchItemPaged[dict]
"""Search the Azure search index for documents.

:param query: An query for searching the index
:type documents: str or SearchQuery
:param str search_text: A full-text search query expression; Use "*" or omit this parameter to
Copy link
Contributor

@rakshith91 rakshith91 Jun 5, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

by omit this parameter - do you mean search_text is optional? If not, is it by design to not make it optional and use '*' as default value.

match all documents.
:rtype: SearchItemPaged[dict]

.. admonition:: Example:
Expand Down Expand Up @@ -167,14 +167,41 @@ def search(self, query, **kwargs):
:dedent: 4
:caption: Get search result facets.
"""
if isinstance(query, six.string_types):
query = SearchQuery(search_text=query)
elif not isinstance(query, SearchQuery):
raise TypeError(
"Expected a string or SearchQuery for 'query', but got {}".format(
repr(query)
)
)
include_total_result_count = kwargs.pop("include_total_result_count", None)
facets = kwargs.pop("facets", None)
filter_arg = kwargs.pop("filter", None)
highlight_fields = kwargs.pop("highlight_fields", None)
highlight_post_tag = kwargs.pop("highlight_post_tag", None)
highlight_pre_tag = kwargs.pop("highlight_pre_tag", None)
minimum_coverage = kwargs.pop("minimum_coverage", None)
order_by = kwargs.pop("order_by", None)
query_type = kwargs.pop("query_type", None)
scoring_parameters = kwargs.pop("scoring_parameters", None)
scoring_profile = kwargs.pop("scoring_profile", None)
search_fields = kwargs.pop("search_fields", None)
search_mode = kwargs.pop("search_mode", None)
select = kwargs.pop("select", None)
skip = kwargs.pop("skip", None)
top = kwargs.pop("top", None)
query = SearchQuery(
search_text=search_text,
include_total_result_count=include_total_result_count,
facets=facets,
filter=filter_arg,
highlight_fields=highlight_fields,
highlight_post_tag=highlight_post_tag,
highlight_pre_tag=highlight_pre_tag,
minimum_coverage=minimum_coverage,
order_by=order_by,
query_type=query_type,
scoring_parameters=scoring_parameters,
scoring_profile=scoring_profile,
search_fields=search_fields,
search_mode=search_mode,
select=select,
skip=skip,
top=top
)

kwargs["headers"] = self._merge_client_headers(kwargs.get("headers"))
return SearchItemPaged(
Expand All @@ -201,7 +228,28 @@ def suggest(self, search_text, suggester_name, **kwargs):
:dedent: 4
:caption: Get search suggestions.
"""
query = SuggestQuery(search_text=search_text, suggester_name=suggester_name, **kwargs)
filter_arg = kwargs.pop("filter", None)
use_fuzzy_matching = kwargs.pop("use_fuzzy_matching", None)
highlight_post_tag = kwargs.pop("highlight_post_tag", None)
highlight_pre_tag = kwargs.pop("highlight_pre_tag", None)
minimum_coverage = kwargs.pop("minimum_coverage", None)
order_by = kwargs.pop("order_by", None)
search_fields = kwargs.pop("search_fields", None)
select = kwargs.pop("select", None)
top = kwargs.pop("top", None)
query = SuggestQuery(
search_text=search_text,
suggester_name=suggester_name,
filter=filter_arg,
use_fuzzy_matching=use_fuzzy_matching,
highlight_post_tag=highlight_post_tag,
highlight_pre_tag=highlight_pre_tag,
minimum_coverage=minimum_coverage,
order_by=order_by,
search_fields=search_fields,
select=select,
top=top
)

kwargs["headers"] = self._merge_client_headers(kwargs.get("headers"))
response = self._client.documents.suggest_post(
Expand Down Expand Up @@ -229,7 +277,26 @@ def autocomplete(self, search_text, suggester_name, **kwargs):
:dedent: 4
:caption: Get a auto-completions.
"""
query = AutocompleteQuery(search_text=search_text, suggester_name=suggester_name, **kwargs)
autocomplete_mode = kwargs.pop("autocomplete_mode", None)
filter_arg = kwargs.pop("filter", None)
use_fuzzy_matching = kwargs.pop("use_fuzzy_matching", None)
highlight_post_tag = kwargs.pop("highlight_post_tag", None)
highlight_pre_tag = kwargs.pop("highlight_pre_tag", None)
minimum_coverage = kwargs.pop("minimum_coverage", None)
search_fields = kwargs.pop("search_fields", None)
top = kwargs.pop("top", None)
query = AutocompleteQuery(
search_text=search_text,
suggester_name=suggester_name,
autocomplete_mode=autocomplete_mode,
filter=filter_arg,
use_fuzzy_matching=use_fuzzy_matching,
highlight_post_tag=highlight_post_tag,
highlight_pre_tag=highlight_pre_tag,
minimum_coverage=minimum_coverage,
search_fields=search_fields,
top=top
)

kwargs["headers"] = self._merge_client_headers(kwargs.get("headers"))
response = self._client.documents.autocomplete_post(
Expand Down
102 changes: 84 additions & 18 deletions ...earch/azure-search-documents/azure/search/documents/_internal/aio/_search_client_async.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,10 @@
# --------------------------------------------------------------------------
from typing import cast, List, TYPE_CHECKING

import six

from azure.core.tracing.decorator_async import distributed_trace_async
from ._paging import AsyncSearchItemPaged, AsyncSearchPageIterator
from .._generated.aio import SearchIndexClient
from .._generated.models import IndexBatch, IndexingResult, SearchRequest
from .._generated.models import IndexBatch, IndexingResult
from .._index_documents_batch import IndexDocumentsBatch
from .._queries import AutocompleteQuery, SearchQuery, SuggestQuery
from ..._headers_mixin import HeadersMixin
Expand Down Expand Up @@ -104,12 +102,12 @@ async def get_document(self, key, selected_fields=None, **kwargs):
return cast(dict, result)

@distributed_trace_async
async def search(self, query, **kwargs):
# type: (Union[str, SearchQuery], **Any) -> AsyncSearchItemPaged[dict]
async def search(self, search_text, **kwargs):
# type: (str, **Any) -> AsyncSearchItemPaged[dict]
"""Search the Azure search index for documents.

:param query: An query for searching the index
:type documents: str or SearchQuery
:param str search_text: A full-text search query expression; Use "*" or omit this parameter to
match all documents.
:rtype: AsyncSearchItemPaged[dict]

.. admonition:: Example:
Expand Down Expand Up @@ -139,22 +137,50 @@ async def search(self, query, **kwargs):
:dedent: 4
:caption: Get search result facets.
"""
if isinstance(query, six.string_types):
query = SearchQuery(search_text=query)
elif not isinstance(query, SearchQuery):
raise TypeError(
"Expected a string or SearchQuery for 'query', but got {}".format(
repr(query)
)
)
include_total_result_count = kwargs.pop("include_total_result_count", None)
facets = kwargs.pop("facets", None)
filter_arg = kwargs.pop("filter", None)
highlight_fields = kwargs.pop("highlight_fields", None)
highlight_post_tag = kwargs.pop("highlight_post_tag", None)
highlight_pre_tag = kwargs.pop("highlight_pre_tag", None)
minimum_coverage = kwargs.pop("minimum_coverage", None)
order_by = kwargs.pop("order_by", None)
query_type = kwargs.pop("query_type", None)
scoring_parameters = kwargs.pop("scoring_parameters", None)
scoring_profile = kwargs.pop("scoring_profile", None)
search_fields = kwargs.pop("search_fields", None)
search_mode = kwargs.pop("search_mode", None)
select = kwargs.pop("select", None)
skip = kwargs.pop("skip", None)
top = kwargs.pop("top", None)
query = SearchQuery(
search_text=search_text,
include_total_result_count=include_total_result_count,
facets=facets,
filter=filter_arg,
highlight_fields=highlight_fields,
highlight_post_tag=highlight_post_tag,
highlight_pre_tag=highlight_pre_tag,
minimum_coverage=minimum_coverage,
order_by=order_by,
query_type=query_type,
scoring_parameters=scoring_parameters,
scoring_profile=scoring_profile,
search_fields=search_fields,
search_mode=search_mode,
select=select,
skip=skip,
top=top
)
Comment on lines +140 to +174
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit - Is it worth moving this logic onto the SearchQuery class so you don't have to update both the sync/async clients whenever we add a new parameter? I'm not sure how the Python folks typically handle these situations. (Also, we can just file a work item rather for Preview 5 rather than try to fix it today.)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

SearchQuery and AutocompleteQuery, SuggestQuery share one ctor. If we put all of pop operation there, I am afraid it will be messed up.


kwargs["headers"] = self._merge_client_headers(kwargs.get("headers"))
return AsyncSearchItemPaged(
self._client, query, kwargs, page_iterator_class=AsyncSearchPageIterator
)

@distributed_trace_async
async def suggest(self, search_text, suggester_name, **kwargs):
# type: (Union[str, SuggestQuery], **Any) -> List[dict]
# type: (str, str, **Any) -> List[dict]
"""Get search suggestion results from the Azure search index.

:param str search_text: Required. The search text to use to suggest documents. Must be at least 1
Expand All @@ -172,7 +198,28 @@ async def suggest(self, search_text, suggester_name, **kwargs):
:dedent: 4
:caption: Get search suggestions.
"""
query = SuggestQuery(search_text=search_text, suggester_name=suggester_name, **kwargs)
filter_arg = kwargs.pop("filter", None)
use_fuzzy_matching = kwargs.pop("use_fuzzy_matching", None)
highlight_post_tag = kwargs.pop("highlight_post_tag", None)
highlight_pre_tag = kwargs.pop("highlight_pre_tag", None)
minimum_coverage = kwargs.pop("minimum_coverage", None)
order_by = kwargs.pop("order_by", None)
search_fields = kwargs.pop("search_fields", None)
select = kwargs.pop("select", None)
top = kwargs.pop("top", None)
query = SuggestQuery(
search_text=search_text,
suggester_name=suggester_name,
filter=filter_arg,
use_fuzzy_matching=use_fuzzy_matching,
highlight_post_tag=highlight_post_tag,
highlight_pre_tag=highlight_pre_tag,
minimum_coverage=minimum_coverage,
order_by=order_by,
search_fields=search_fields,
select=select,
top=top
)

kwargs["headers"] = self._merge_client_headers(kwargs.get("headers"))
response = await self._client.documents.suggest_post(
Expand Down Expand Up @@ -200,7 +247,26 @@ async def autocomplete(self, search_text, suggester_name, **kwargs):
:dedent: 4
:caption: Get a auto-completions.
"""
query = AutocompleteQuery(search_text=search_text, suggester_name=suggester_name, **kwargs)
autocomplete_mode = kwargs.pop("autocomplete_mode", None)
filter_arg = kwargs.pop("filter", None)
use_fuzzy_matching = kwargs.pop("use_fuzzy_matching", None)
highlight_post_tag = kwargs.pop("highlight_post_tag", None)
highlight_pre_tag = kwargs.pop("highlight_pre_tag", None)
minimum_coverage = kwargs.pop("minimum_coverage", None)
search_fields = kwargs.pop("search_fields", None)
top = kwargs.pop("top", None)
query = AutocompleteQuery(
search_text=search_text,
suggester_name=suggester_name,
autocomplete_mode=autocomplete_mode,
filter=filter_arg,
use_fuzzy_matching=use_fuzzy_matching,
highlight_post_tag=highlight_post_tag,
highlight_pre_tag=highlight_pre_tag,
minimum_coverage=minimum_coverage,
search_fields=search_fields,
top=top
)

kwargs["headers"] = self._merge_client_headers(kwargs.get("headers"))
response = await self._client.documents.autocomplete_post(
Expand Down
2 changes: 1 addition & 1 deletion ...h/azure-search-documents/azure/search/documents/indexes/_internal/_search_index_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -235,7 +235,7 @@ def create_or_update_index(

@distributed_trace
def analyze_text(self, index_name, analyze_request, **kwargs):
# type: (str, AnalyzeRequest, **Any) -> AnalyzeResult
# type: (str, AnalyzeTextRequest, **Any) -> AnalyzeResult
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be AnalyzeTextOptions now, or was that going to come in a separate PR? See #11830.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Already fixed. :)

"""Shows how an analyzer breaks text into tokens.

:param index_name: The name of the index for which to test an analyzer.
Expand Down
6 changes: 3 additions & 3 deletions ...ure-search-documents/azure/search/documents/indexes/_internal/aio/_search_index_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@

if TYPE_CHECKING:
# pylint:disable=unused-import,ungrouped-imports
from .._generated.models import AnalyzeRequest, AnalyzeResult, SearchIndex
from .._generated.models import AnalyzeRequest as AnalyzeTextRequest, AnalyzeResult, SearchIndex
from typing import Any, Dict, List, Union
from azure.core.credentials import AzureKeyCredential

Expand Down Expand Up @@ -239,13 +239,13 @@ async def create_or_update_index(

@distributed_trace_async
async def analyze_text(self, index_name, analyze_request, **kwargs):
# type: (str, AnalyzeRequest, **Any) -> AnalyzeResult
# type: (str, AnalyzeTextRequest, **Any) -> AnalyzeResult
"""Shows how an analyzer breaks text into tokens.

:param index_name: The name of the index for which to test an analyzer.
:type index_name: str
:param analyze_request: The text and analyzer or analysis components to test.
:type analyze_request: :class:`~azure.search.documents.indexes.models.AnalyzeRequest
:type analyze_request: :class:`~azure.search.documents.indexes.models.AnalyzeTextRequest
:return: AnalyzeResult
:rtype: :class:`~azure.search.documents.indexes.models.AnalyzeRequest
:raises: ~azure.core.exceptions.HttpResponseError
Expand Down
4 changes: 2 additions & 2 deletions sdk/search/azure-search-documents/azure/search/documents/indexes/models/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
SearchFieldDataType,
)
from .._internal._generated.models import (
AnalyzeRequest,
AnalyzeRequest as AnalyzeTextRequest,
AnalyzeResult,
AnalyzedTokenInfo,
AsciiFoldingTokenFilter,
Expand Down Expand Up @@ -124,7 +124,7 @@


__all__ = (
"AnalyzeRequest",
"AnalyzeTextRequest",
"AnalyzeResult",
"AnalyzedTokenInfo",
"AsciiFoldingTokenFilter",
Expand Down
2 changes: 0 additions & 2 deletions sdk/search/azure-search-documents/azure/search/documents/models/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,14 +27,12 @@
from .._internal import (
IndexAction,
IndexingResult,
SearchQuery,
odata,
)


__all__ = (
"IndexAction",
"IndexingResult",
"SearchQuery",
"odata",
)
1 change: 0 additions & 1 deletion sdk/search/azure-search-documents/samples/async_samples/sample_crud_operations_async.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@

from azure.core.credentials import AzureKeyCredential
from azure.search.documents.aio import SearchClient
from azure.search.documents.models import SearchQuery

search_client = SearchClient(service_endpoint, index_name, AzureKeyCredential(key))

Expand Down
5 changes: 1 addition & 4 deletions sdk/search/azure-search-documents/samples/async_samples/sample_facet_query_async.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,14 +32,11 @@ async def filter_query():
# [START facet_query_async]
from azure.core.credentials import AzureKeyCredential
from azure.search.documents.aio import SearchClient
from azure.search.documents.models import SearchQuery

search_client = SearchClient(service_endpoint, index_name, AzureKeyCredential(key))

query = SearchQuery(search_text="WiFi", facets=["Category"], top=0)

async with search_client:
results = await search_client.search(query=query)
results = await search_client.search(search_text="WiFi", facets=["Category"], top=0)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks very nice.


facets = await results.get_facets()

Expand Down
Loading