[AutoPR cognitiveservices/data-plane/AutoSuggest] Add Auto Suggest API specification

azure-cognitiveservices-search-autosuggest/azure/cognitiveservices/search/autosuggest/__init__.py

@@ -0,0 +1,18 @@
+# coding=utf-8
+# --------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+#
+# Code generated by Microsoft (R) AutoRest Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is
+# regenerated.
+# --------------------------------------------------------------------------
+
+from .auto_suggest_api import AutoSuggestAPI
+from .version import VERSION
+
+__all__ = ['AutoSuggestAPI']
+
+__version__ = VERSION
+

azure-cognitiveservices-search-autosuggest/azure/cognitiveservices/search/autosuggest/auto_suggest_api.py

@@ -0,0 +1,72 @@
+# coding=utf-8
+# --------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+#
+# Code generated by Microsoft (R) AutoRest Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is
+# regenerated.
+# --------------------------------------------------------------------------
+
+from msrest.service_client import ServiceClient
+from msrest import Configuration, Serializer, Deserializer
+from .version import VERSION
+from .operations.auto_operations import AutoOperations
+from . import models
+
+
+class AutoSuggestAPIConfiguration(Configuration):
+    """Configuration for AutoSuggestAPI
+    Note that all parameters used to create this instance are saved as instance
+    attributes.
+
+    :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):
+
+        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'
+
+        super(AutoSuggestAPIConfiguration, self).__init__(base_url)
+
+        self.add_user_agent('azure-cognitiveservices-search-autosuggest/{}'.format(VERSION))
+
+        self.credentials = credentials
+
+
+class AutoSuggestAPI(object):
+    """The Auto Suggest API lets you send a search query to Bing and get back a list of auto suggestions 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.
+
+    :ivar config: Configuration for client.
+    :vartype config: AutoSuggestAPIConfiguration
+
+    :ivar auto: Auto operations
+    :vartype auto: azure.cognitiveservices.search.autosuggest.operations.AutoOperations
+
+    :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.config = AutoSuggestAPIConfiguration(credentials, base_url)
+        self._client = ServiceClient(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'
+        self._serialize = Serializer(client_models)
+        self._deserialize = Deserializer(client_models)
+
+        self.auto = AutoOperations(
+            self._client, self.config, self._serialize, self._deserialize)

azure-cognitiveservices-search-autosuggest/azure/cognitiveservices/search/autosuggest/models/__init__.py

@@ -0,0 +1,49 @@
+# coding=utf-8
+# --------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+#
+# Code generated by Microsoft (R) AutoRest Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is
+# regenerated.
+# --------------------------------------------------------------------------
+
+try:
+    from .query_py3 import Query
+    from .response_py3 import Response
+    from .query_context_py3 import QueryContext
+    from .suggestions_py3 import Suggestions
+    from .suggestion_group_py3 import SuggestionGroup
+    from .identifiable_py3 import Identifiable
+    from .error_py3 import Error
+    from .error_response_py3 import ErrorResponse, ErrorResponseException
+    from .response_base_py3 import ResponseBase
+except (SyntaxError, ImportError):
+    from .query import Query
+    from .response import Response
+    from .query_context import QueryContext
+    from .suggestions import Suggestions
+    from .suggestion_group import SuggestionGroup
+    from .identifiable import Identifiable
+    from .error import Error
+    from .error_response import ErrorResponse, ErrorResponseException
+    from .response_base import ResponseBase
+from .auto_suggest_api_enums import (
+    ErrorCode,
+    ErrorSubCode,
+)
+
+__all__ = [
+    'Query',
+    'Response',
+    'QueryContext',
+    'Suggestions',
+    'SuggestionGroup',
+    'Identifiable',
+    'Error',
+    'ErrorResponse', 'ErrorResponseException',
+    'ResponseBase',
+    'ErrorCode',
+    'ErrorSubCode',
+]

azure-cognitiveservices-search-autosuggest/azure/cognitiveservices/search/autosuggest/models/auto_suggest_api_enums.py

@@ -0,0 +1,37 @@
+# coding=utf-8
+# --------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+#
+# Code generated by Microsoft (R) AutoRest Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is
+# regenerated.
+# --------------------------------------------------------------------------
+
+from enum import Enum
+
+
+class ErrorCode(str, Enum):
+
+    none = "None"
+    server_error = "ServerError"
+    invalid_request = "InvalidRequest"
+    rate_limit_exceeded = "RateLimitExceeded"
+    invalid_authorization = "InvalidAuthorization"
+    insufficient_authorization = "InsufficientAuthorization"
+
+
+class ErrorSubCode(str, Enum):
+
+    unexpected_error = "UnexpectedError"
+    resource_error = "ResourceError"
+    not_implemented = "NotImplemented"
+    parameter_missing = "ParameterMissing"
+    parameter_invalid_value = "ParameterInvalidValue"
+    http_not_allowed = "HttpNotAllowed"
+    blocked = "Blocked"
+    authorization_missing = "AuthorizationMissing"
+    authorization_redundancy = "AuthorizationRedundancy"
+    authorization_disabled = "AuthorizationDisabled"
+    authorization_expired = "AuthorizationExpired"

azure-cognitiveservices-search-autosuggest/azure/cognitiveservices/search/autosuggest/models/error.py

@@ -0,0 +1,72 @@
+# coding=utf-8
+# --------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+#
+# Code generated by Microsoft (R) AutoRest Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is
+# regenerated.
+# --------------------------------------------------------------------------
+
+from msrest.serialization import Model
+
+
+class Error(Model):
+    """Defines the error that occurred.
+
+    Variables are only populated by the server, and will be ignored when
+    sending a request.
+
+    All required parameters must be populated in order to send to Azure.
+
+    :param code: Required. The error code that identifies the category of
+     error. Possible values include: 'None', 'ServerError', 'InvalidRequest',
+     'RateLimitExceeded', 'InvalidAuthorization', 'InsufficientAuthorization'.
+     Default value: "None" .
+    :type code: str or
+     ~azure.cognitiveservices.search.autosuggest.models.ErrorCode
+    :ivar sub_code: The error code that further helps to identify the error.
+     Possible values include: 'UnexpectedError', 'ResourceError',
+     'NotImplemented', 'ParameterMissing', 'ParameterInvalidValue',
+     'HttpNotAllowed', 'Blocked', 'AuthorizationMissing',
+     'AuthorizationRedundancy', 'AuthorizationDisabled', 'AuthorizationExpired'
+    :vartype sub_code: str or
+     ~azure.cognitiveservices.search.autosuggest.models.ErrorSubCode
+    :param message: Required. A description of the error.
+    :type message: str
+    :ivar more_details: A description that provides additional information
+     about the error.
+    :vartype more_details: str
+    :ivar parameter: The parameter in the request that caused the error.
+    :vartype parameter: str
+    :ivar value: The parameter's value in the request that was not valid.
+    :vartype value: str
+    """
+
+    _validation = {
+        'code': {'required': True},
+        'sub_code': {'readonly': True},
+        'message': {'required': True},
+        'more_details': {'readonly': True},
+        'parameter': {'readonly': True},
+        'value': {'readonly': True},
+    }
+
+    _attribute_map = {
+        'code': {'key': 'code', 'type': 'str'},
+        'sub_code': {'key': 'subCode', 'type': 'str'},
+        'message': {'key': 'message', 'type': 'str'},
+        'more_details': {'key': 'moreDetails', 'type': 'str'},
+        'parameter': {'key': 'parameter', 'type': 'str'},
+        'value': {'key': 'value', 'type': 'str'},
+    }
+
+    def __init__(self, **kwargs):
+        super(Error, self).__init__(**kwargs)
+        self.code = kwargs.get('code', "None")
+        self.sub_code = None
+        self.message = kwargs.get('message', None)
+        self.more_details = None
+        self.parameter = None
+        self.value = None

azure-cognitiveservices-search-autosuggest/azure/cognitiveservices/search/autosuggest/models/error_py3.py

@@ -0,0 +1,72 @@
+# coding=utf-8
+# --------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+#
+# Code generated by Microsoft (R) AutoRest Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is
+# regenerated.
+# --------------------------------------------------------------------------
+
+from msrest.serialization import Model
+
+
+class Error(Model):
+    """Defines the error that occurred.
+
+    Variables are only populated by the server, and will be ignored when
+    sending a request.
+
+    All required parameters must be populated in order to send to Azure.
+
+    :param code: Required. The error code that identifies the category of
+     error. Possible values include: 'None', 'ServerError', 'InvalidRequest',
+     'RateLimitExceeded', 'InvalidAuthorization', 'InsufficientAuthorization'.
+     Default value: "None" .
+    :type code: str or
+     ~azure.cognitiveservices.search.autosuggest.models.ErrorCode
+    :ivar sub_code: The error code that further helps to identify the error.
+     Possible values include: 'UnexpectedError', 'ResourceError',
+     'NotImplemented', 'ParameterMissing', 'ParameterInvalidValue',
+     'HttpNotAllowed', 'Blocked', 'AuthorizationMissing',
+     'AuthorizationRedundancy', 'AuthorizationDisabled', 'AuthorizationExpired'
+    :vartype sub_code: str or
+     ~azure.cognitiveservices.search.autosuggest.models.ErrorSubCode
+    :param message: Required. A description of the error.
+    :type message: str
+    :ivar more_details: A description that provides additional information
+     about the error.
+    :vartype more_details: str
+    :ivar parameter: The parameter in the request that caused the error.
+    :vartype parameter: str
+    :ivar value: The parameter's value in the request that was not valid.
+    :vartype value: str
+    """
+
+    _validation = {
+        'code': {'required': True},
+        'sub_code': {'readonly': True},
+        'message': {'required': True},
+        'more_details': {'readonly': True},
+        'parameter': {'readonly': True},
+        'value': {'readonly': True},
+    }
+
+    _attribute_map = {
+        'code': {'key': 'code', 'type': 'str'},
+        'sub_code': {'key': 'subCode', 'type': 'str'},
+        'message': {'key': 'message', 'type': 'str'},
+        'more_details': {'key': 'moreDetails', 'type': 'str'},
+        'parameter': {'key': 'parameter', 'type': 'str'},
+        'value': {'key': 'value', 'type': 'str'},
+    }
+
+    def __init__(self, *, message: str, code="None", **kwargs) -> None:
+        super(Error, self).__init__(**kwargs)
+        self.code = code
+        self.sub_code = None
+        self.message = message
+        self.more_details = None
+        self.parameter = None
+        self.value = None

azure-cognitiveservices-search-autosuggest/azure/cognitiveservices/search/autosuggest/models/error_response.py

@@ -0,0 +1,61 @@
+# coding=utf-8
+# --------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+#
+# Code generated by Microsoft (R) AutoRest Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is
+# regenerated.
+# --------------------------------------------------------------------------
+
+from .response import Response
+from msrest.exceptions import HttpOperationError
+
+
+class ErrorResponse(Response):
+    """The top-level response that represents a failed request.
+
+    Variables are only populated by the server, and will be ignored when
+    sending a request.
+
+    All required parameters must be populated in order to send to Azure.
+
+    :param _type: Required. Constant filled by server.
+    :type _type: str
+    :ivar id: A String identifier.
+    :vartype id: str
+    :param errors: Required. A list of errors that describe the reasons why
+     the request failed.
+    :type errors:
+     list[~azure.cognitiveservices.search.autosuggest.models.Error]
+    """
+
+    _validation = {
+        '_type': {'required': True},
+        'id': {'readonly': True},
+        'errors': {'required': True},
+    }
+
+    _attribute_map = {
+        '_type': {'key': '_type', 'type': 'str'},
+        'id': {'key': 'id', 'type': 'str'},
+        'errors': {'key': 'errors', 'type': '[Error]'},
+    }
+
+    def __init__(self, **kwargs):
+        super(ErrorResponse, self).__init__(**kwargs)
+        self.errors = kwargs.get('errors', None)
+        self._type = 'ErrorResponse'
+
+
+class ErrorResponseException(HttpOperationError):
+    """Server responsed with exception of type: 'ErrorResponse'.
+
+    :param deserialize: A deserializer
+    :param response: Server response to be deserialized.
+    """
+
+    def __init__(self, deserialize, response, *args):
+
+        super(ErrorResponseException, self).__init__(deserialize, response, 'ErrorResponse', *args)