azure.cognitiveservices.language.spellcheck.models module¶
-
exception
azure.cognitiveservices.language.spellcheck.models.
ErrorResponseException
(deserialize, response, *args)[source]¶ Bases:
msrest.exceptions.HttpOperationError
Server responsed with exception of type: ‘ErrorResponse’.
Parameters: - deserialize – A deserializer
- response – Server response to be deserialized.
-
class
azure.cognitiveservices.language.spellcheck.models.
SpellingTokenSuggestion
(*, suggestion: str, **kwargs)[source]¶ Bases:
msrest.serialization.Model
SpellingTokenSuggestion.
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.
Parameters: suggestion (str) – Required.
Variables: - score (float) –
- ping_url_suffix (str) –
-
class
azure.cognitiveservices.language.spellcheck.models.
SpellingFlaggedToken
(*, offset: int, token: str, type='UnknownToken', **kwargs)[source]¶ Bases:
msrest.serialization.Model
SpellingFlaggedToken.
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.
Parameters: - offset (int) – Required.
- token (str) – Required.
- type (str or ErrorType) – Required. Possible values include: ‘UnknownToken’, ‘RepeatedToken’. Default value: “UnknownToken” .
Variables: - suggestions (list[SpellingTokenSuggestion]) –
- ping_url_suffix (str) –
-
class
azure.cognitiveservices.language.spellcheck.models.
SpellCheck
(*, flagged_tokens, **kwargs)[source]¶ Bases:
azure.cognitiveservices.language.spellcheck.models.answer.Answer
SpellCheck.
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.
Parameters: - _type (str) – Required. Constant filled by server.
- flagged_tokens (list[SpellingFlaggedToken]) – Required.
Variables: id (str) – A String identifier.
-
class
azure.cognitiveservices.language.spellcheck.models.
Answer
(**kwargs)[source]¶ Bases:
azure.cognitiveservices.language.spellcheck.models.response.Response
Answer.
You probably want to use the sub-classes and not this class directly. Known sub-classes are: SpellCheck
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.
Parameters: _type (str) – Required. Constant filled by server. Variables: id (str) – A String identifier.
-
class
azure.cognitiveservices.language.spellcheck.models.
Response
(**kwargs)[source]¶ Bases:
azure.cognitiveservices.language.spellcheck.models.identifiable.Identifiable
Defines a response. All schemas that could be returned at the root of a response should inherit from this.
You probably want to use the sub-classes and not this class directly. Known sub-classes are: Answer, ErrorResponse
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.
Parameters: _type (str) – Required. Constant filled by server. Variables: id (str) – A String identifier.
-
class
azure.cognitiveservices.language.spellcheck.models.
Identifiable
(**kwargs)[source]¶ Bases:
azure.cognitiveservices.language.spellcheck.models.response_base.ResponseBase
Defines the identity of a resource.
You probably want to use the sub-classes and not this class directly. Known sub-classes are: Response
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.
Parameters: _type (str) – Required. Constant filled by server. Variables: id (str) – A String identifier.
-
class
azure.cognitiveservices.language.spellcheck.models.
Error
(*, message: str, code='None', **kwargs)[source]¶ Bases:
msrest.serialization.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.
Parameters: - code (str or ErrorCode) – Required. The error code that identifies the category of error. Possible values include: ‘None’, ‘ServerError’, ‘InvalidRequest’, ‘RateLimitExceeded’, ‘InvalidAuthorization’, ‘InsufficientAuthorization’. Default value: “None” .
- message (str) – Required. A description of the error.
Variables: - sub_code (str or ErrorSubCode) – The error code that further helps to identify the error. Possible values include: ‘UnexpectedError’, ‘ResourceError’, ‘NotImplemented’, ‘ParameterMissing’, ‘ParameterInvalidValue’, ‘HttpNotAllowed’, ‘Blocked’, ‘AuthorizationMissing’, ‘AuthorizationRedundancy’, ‘AuthorizationDisabled’, ‘AuthorizationExpired’
- more_details (str) – A description that provides additional information about the error.
- parameter (str) – The parameter in the request that caused the error.
- value (str) – The parameter’s value in the request that was not valid.
-
class
azure.cognitiveservices.language.spellcheck.models.
ErrorResponse
(*, errors, **kwargs)[source]¶ Bases:
azure.cognitiveservices.language.spellcheck.models.response.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.
Parameters: - _type (str) – Required. Constant filled by server.
- errors (list[Error]) – Required. A list of errors that describe the reasons why the request failed.
Variables: id (str) – A String identifier.
-
class
azure.cognitiveservices.language.spellcheck.models.
ResponseBase
(**kwargs)[source]¶ Bases:
msrest.serialization.Model
ResponseBase.
You probably want to use the sub-classes and not this class directly. Known sub-classes are: Identifiable
All required parameters must be populated in order to send to Azure.
Parameters: _type (str) – Required. Constant filled by server.
-
class
azure.cognitiveservices.language.spellcheck.models.
ErrorType
[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
repeated_token
= 'RepeatedToken'¶
-
unknown_token
= 'UnknownToken'¶
-
-
class
azure.cognitiveservices.language.spellcheck.models.
ErrorCode
[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
invalid_request
= 'InvalidRequest'¶
-
none
= 'None'¶
-
rate_limit_exceeded
= 'RateLimitExceeded'¶
-
server_error
= 'ServerError'¶
-
-
class
azure.cognitiveservices.language.spellcheck.models.
ErrorSubCode
[source]¶ Bases:
str
,enum.Enum
An enumeration.
-
blocked
= 'Blocked'¶
-
http_not_allowed
= 'HttpNotAllowed'¶
-
not_implemented
= 'NotImplemented'¶
-
parameter_invalid_value
= 'ParameterInvalidValue'¶
-
parameter_missing
= 'ParameterMissing'¶
-
resource_error
= 'ResourceError'¶
-
unexpected_error
= 'UnexpectedError'¶
-