From b60389e82e28d63778164b33e889184d45fc775b Mon Sep 17 00:00:00 2001 From: Azure SDK for Python bot Date: Fri, 16 Nov 2018 14:40:58 -0800 Subject: [PATCH 1/4] [AutoPR cognitiveservices/data-plane/AutoSuggest] Description of Autosuggest usage needs improvement. (#3806) * Generated from a242265b3b2b525602ef14bf5bdcd274dd843c75 Description of Autosuggest usage needs improvement. * Packaging update of azure-cognitiveservices-search-autosuggest --- .../MANIFEST.in | 4 ++ .../search/autosuggest/__init__.py | 4 +- ...t_search_api.py => auto_suggest_client.py} | 52 ++++++++++++------- .../search/autosuggest/models/__init__.py | 2 +- ..._enums.py => auto_suggest_client_enums.py} | 0 .../search/autosuggest/version.py | 2 +- .../setup.py | 1 + 7 files changed, 41 insertions(+), 24 deletions(-) rename azure-cognitiveservices-search-autosuggest/azure/cognitiveservices/search/autosuggest/{auto_suggest_search_api.py => auto_suggest_client.py} (89%) rename azure-cognitiveservices-search-autosuggest/azure/cognitiveservices/search/autosuggest/models/{auto_suggest_search_api_enums.py => auto_suggest_client_enums.py} (100%) diff --git a/azure-cognitiveservices-search-autosuggest/MANIFEST.in b/azure-cognitiveservices-search-autosuggest/MANIFEST.in index bb37a2723da..d1c7ea0ea56 100644 --- a/azure-cognitiveservices-search-autosuggest/MANIFEST.in +++ b/azure-cognitiveservices-search-autosuggest/MANIFEST.in @@ -1 +1,5 @@ include *.rst +include azure/__init__.py +include azure/cognitiveservices/__init__.py +include azure/cognitiveservices/search/__init__.py + diff --git a/azure-cognitiveservices-search-autosuggest/azure/cognitiveservices/search/autosuggest/__init__.py b/azure-cognitiveservices-search-autosuggest/azure/cognitiveservices/search/autosuggest/__init__.py index bf825994f24..19d7a4b3f08 100644 --- a/azure-cognitiveservices-search-autosuggest/azure/cognitiveservices/search/autosuggest/__init__.py +++ b/azure-cognitiveservices-search-autosuggest/azure/cognitiveservices/search/autosuggest/__init__.py @@ -9,10 +9,10 @@ # regenerated. # -------------------------------------------------------------------------- -from .auto_suggest_search_api import AutoSuggestSearchAPI +from .auto_suggest_client import AutoSuggestClient from .version import VERSION -__all__ = ['AutoSuggestSearchAPI'] +__all__ = ['AutoSuggestClient'] __version__ = VERSION diff --git a/azure-cognitiveservices-search-autosuggest/azure/cognitiveservices/search/autosuggest/auto_suggest_search_api.py b/azure-cognitiveservices-search-autosuggest/azure/cognitiveservices/search/autosuggest/auto_suggest_client.py similarity index 89% rename from azure-cognitiveservices-search-autosuggest/azure/cognitiveservices/search/autosuggest/auto_suggest_search_api.py rename to azure-cognitiveservices-search-autosuggest/azure/cognitiveservices/search/autosuggest/auto_suggest_client.py index db81c44776f..b8e9711daee 100644 --- a/azure-cognitiveservices-search-autosuggest/azure/cognitiveservices/search/autosuggest/auto_suggest_search_api.py +++ b/azure-cognitiveservices-search-autosuggest/azure/cognitiveservices/search/autosuggest/auto_suggest_client.py @@ -16,49 +16,57 @@ from . import models -class AutoSuggestSearchAPIConfiguration(Configuration): - """Configuration for AutoSuggestSearchAPI +class AutoSuggestClientConfiguration(Configuration): + """Configuration for AutoSuggestClient Note that all parameters used to create this instance are saved as instance attributes. + :param endpoint: Supported Cognitive Services endpoints (protocol and + hostname, for example: "https://westus.api.cognitive.microsoft.com", + "https://api.cognitive.microsoft.com"). + :type endpoint: str :param credentials: Subscription credentials which uniquely identify client subscription. :type credentials: None - :param str base_url: Service URL """ def __init__( - self, credentials, base_url=None): + self, endpoint, credentials): + if endpoint is None: + raise ValueError("Parameter 'endpoint' must not be None.") if credentials is None: raise ValueError("Parameter 'credentials' must not be None.") - if not base_url: - base_url = 'https://api.cognitive.microsoft.com/bing/v7.0' + base_url = '{Endpoint}/bing/v7.0' - super(AutoSuggestSearchAPIConfiguration, self).__init__(base_url) + super(AutoSuggestClientConfiguration, self).__init__(base_url) self.add_user_agent('azure-cognitiveservices-search-autosuggest/{}'.format(VERSION)) + self.endpoint = endpoint self.credentials = credentials -class AutoSuggestSearchAPI(SDKClient): - """The AutoSuggest Search API lets you send a search query to Bing and get back a list of news that are relevant to the search query. This section provides technical details about the query parameters and headers that you use to request news and the JSON response objects that contain them. For examples that show how to make requests, see [Searching the web for AutoSuggest](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-autosuggest-api-v7-reference). +class AutoSuggestClient(SDKClient): + """Autosuggest supplies search terms derived from a root text sent to the service. The terms Autosuggest supplies are related to the root text based on similarity and their frequency or ratings of usefulness in other searches. For examples that show how to use Autosuggest, see [Search using AutoSuggest](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-autosuggest-api-v7-reference). :ivar config: Configuration for client. - :vartype config: AutoSuggestSearchAPIConfiguration + :vartype config: AutoSuggestClientConfiguration + :param endpoint: Supported Cognitive Services endpoints (protocol and + hostname, for example: "https://westus.api.cognitive.microsoft.com", + "https://api.cognitive.microsoft.com"). + :type endpoint: str :param credentials: Subscription credentials which uniquely identify client subscription. :type credentials: None - :param str base_url: Service URL """ def __init__( - self, credentials, base_url=None): + self, endpoint, credentials): - self.config = AutoSuggestSearchAPIConfiguration(credentials, base_url) - super(AutoSuggestSearchAPI, self).__init__(self.config.credentials, self.config) + self.config = AutoSuggestClientConfiguration(endpoint, credentials) + super(AutoSuggestClient, self).__init__(self.config.credentials, self.config) client_models = {k: v for k, v in models.__dict__.items() if isinstance(v, type)} self.api_version = '1.0' @@ -69,9 +77,9 @@ def __init__( def auto_suggest( self, query, accept_language=None, pragma=None, user_agent=None, client_id=None, client_ip=None, location=None, country_code=None, market="en-us", safe_search=None, set_lang=None, response_format=None, custom_headers=None, raw=False, **operation_config): """The AutoSuggest API lets you send a search query to Bing and get back a - list of suggestions. This section provides technical details about the - query parameters and headers that you use to request suggestions and - the JSON response objects that contain them. + list of query suggestions. This section provides technical details + about the query parameters and headers that you use to request + suggestions and the JSON response objects that contain them. :param query: The user's search term. :type query: str @@ -270,6 +278,10 @@ def auto_suggest( # Construct URL url = self.auto_suggest.metadata['url'] + path_format_arguments = { + 'Endpoint': self._serialize.url("self.config.endpoint", self.config.endpoint, 'str', skip_quote=True) + } + url = self._client.format_url(url, **path_format_arguments) # Construct parameters query_parameters = {} @@ -287,7 +299,7 @@ def auto_suggest( # Construct headers header_parameters = {} - header_parameters['Content-Type'] = 'application/json; charset=utf-8' + header_parameters['Accept'] = 'application/json' if custom_headers: header_parameters.update(custom_headers) header_parameters['X-BingApis-SDK'] = self._serialize.header("x_bing_apis_sdk", x_bing_apis_sdk, 'str') @@ -305,8 +317,8 @@ def auto_suggest( header_parameters['X-Search-Location'] = self._serialize.header("location", location, 'str') # Construct and send request - request = self._client.get(url, query_parameters) - response = self._client.send(request, header_parameters, stream=False, **operation_config) + request = self._client.get(url, query_parameters, header_parameters) + response = self._client.send(request, stream=False, **operation_config) if response.status_code not in [200]: raise models.ErrorResponseException(self._deserialize, response) diff --git a/azure-cognitiveservices-search-autosuggest/azure/cognitiveservices/search/autosuggest/models/__init__.py b/azure-cognitiveservices-search-autosuggest/azure/cognitiveservices/search/autosuggest/models/__init__.py index b6aa4ecdb7b..125fffdca21 100644 --- a/azure-cognitiveservices-search-autosuggest/azure/cognitiveservices/search/autosuggest/models/__init__.py +++ b/azure-cognitiveservices-search-autosuggest/azure/cognitiveservices/search/autosuggest/models/__init__.py @@ -39,7 +39,7 @@ from .error_response import ErrorResponse, ErrorResponseException from .creative_work import CreativeWork from .response_base import ResponseBase -from .auto_suggest_search_api_enums import ( +from .auto_suggest_client_enums import ( ScenarioType, SearchKind, ErrorCode, diff --git a/azure-cognitiveservices-search-autosuggest/azure/cognitiveservices/search/autosuggest/models/auto_suggest_search_api_enums.py b/azure-cognitiveservices-search-autosuggest/azure/cognitiveservices/search/autosuggest/models/auto_suggest_client_enums.py similarity index 100% rename from azure-cognitiveservices-search-autosuggest/azure/cognitiveservices/search/autosuggest/models/auto_suggest_search_api_enums.py rename to azure-cognitiveservices-search-autosuggest/azure/cognitiveservices/search/autosuggest/models/auto_suggest_client_enums.py diff --git a/azure-cognitiveservices-search-autosuggest/azure/cognitiveservices/search/autosuggest/version.py b/azure-cognitiveservices-search-autosuggest/azure/cognitiveservices/search/autosuggest/version.py index e0ec669828c..63d89bfb54f 100644 --- a/azure-cognitiveservices-search-autosuggest/azure/cognitiveservices/search/autosuggest/version.py +++ b/azure-cognitiveservices-search-autosuggest/azure/cognitiveservices/search/autosuggest/version.py @@ -9,5 +9,5 @@ # regenerated. # -------------------------------------------------------------------------- -VERSION = "0.1.0" +VERSION = "1.0" diff --git a/azure-cognitiveservices-search-autosuggest/setup.py b/azure-cognitiveservices-search-autosuggest/setup.py index c8d0f0923ee..005c733f465 100644 --- a/azure-cognitiveservices-search-autosuggest/setup.py +++ b/azure-cognitiveservices-search-autosuggest/setup.py @@ -79,6 +79,7 @@ ]), install_requires=[ 'msrest>=0.5.0', + 'msrestazure>=0.4.32,<2.0.0', 'azure-common~=1.1', ], extras_require={ From 7357fd50b1114fc33ac26b49ed911ecec515b57d Mon Sep 17 00:00:00 2001 From: Laurent Mazuel Date: Tue, 8 Jan 2019 13:09:14 -0800 Subject: [PATCH 2/4] Update sdk_packaging.toml --- azure-cognitiveservices-search-autosuggest/sdk_packaging.toml | 1 + 1 file changed, 1 insertion(+) diff --git a/azure-cognitiveservices-search-autosuggest/sdk_packaging.toml b/azure-cognitiveservices-search-autosuggest/sdk_packaging.toml index 8efc5f60b56..729c4c72406 100644 --- a/azure-cognitiveservices-search-autosuggest/sdk_packaging.toml +++ b/azure-cognitiveservices-search-autosuggest/sdk_packaging.toml @@ -4,3 +4,4 @@ package_pprint_name = "Auto Suggest" package_doc_id = "cognitive-services" is_stable = false is_arm = false +need_msrestazure = false From 414079b078ff0d8ba9f4f5ac342ba3da22dbc255 Mon Sep 17 00:00:00 2001 From: azuresdkci Date: Tue, 8 Jan 2019 21:23:15 +0000 Subject: [PATCH 3/4] Packaging update of azure-cognitiveservices-search-autosuggest --- azure-cognitiveservices-search-autosuggest/setup.py | 1 - 1 file changed, 1 deletion(-) diff --git a/azure-cognitiveservices-search-autosuggest/setup.py b/azure-cognitiveservices-search-autosuggest/setup.py index 005c733f465..c8d0f0923ee 100644 --- a/azure-cognitiveservices-search-autosuggest/setup.py +++ b/azure-cognitiveservices-search-autosuggest/setup.py @@ -79,7 +79,6 @@ ]), install_requires=[ 'msrest>=0.5.0', - 'msrestazure>=0.4.32,<2.0.0', 'azure-common~=1.1', ], extras_require={ From 8faf60048242529799eb66b07f484b4dd93975b6 Mon Sep 17 00:00:00 2001 From: Laurent Mazuel Date: Tue, 15 Jan 2019 15:18:13 -0800 Subject: [PATCH 4/4] Update version.py --- .../azure/cognitiveservices/search/autosuggest/version.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/azure-cognitiveservices-search-autosuggest/azure/cognitiveservices/search/autosuggest/version.py b/azure-cognitiveservices-search-autosuggest/azure/cognitiveservices/search/autosuggest/version.py index 63d89bfb54f..53c4c7ea05e 100644 --- a/azure-cognitiveservices-search-autosuggest/azure/cognitiveservices/search/autosuggest/version.py +++ b/azure-cognitiveservices-search-autosuggest/azure/cognitiveservices/search/autosuggest/version.py @@ -9,5 +9,5 @@ # regenerated. # -------------------------------------------------------------------------- -VERSION = "1.0" +VERSION = "2.0.0"