Share via

ErrorModel interface

  • Reference
Package:
@azure/cognitiveservices-spellcheck

Defines the error that occurred.

Properties

code

The error code that identifies the category of error. Possible values include: 'None', 'ServerError', 'InvalidRequest', 'RateLimitExceeded', 'InvalidAuthorization', 'InsufficientAuthorization'. Default value: 'None'.
message

A description of the error.
moreDetails

A description that provides additional information about the error. NOTE: This property will not be serialized. It can only be populated by the server.
parameter

The parameter in the request that caused the error. NOTE: This property will not be serialized. It can only be populated by the server.
subCode

The error code that further helps to identify the error. Possible values include: 'UnexpectedError', 'ResourceError', 'NotImplemented', 'ParameterMissing', 'ParameterInvalidValue', 'HttpNotAllowed', 'Blocked', 'AuthorizationMissing', 'AuthorizationRedundancy', 'AuthorizationDisabled', 'AuthorizationExpired' NOTE: This property will not be serialized. It can only be populated by the server.
value

The parameter's value in the request that was not valid. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

code

The error code that identifies the category of error. Possible values include: 'None', 'ServerError', 'InvalidRequest', 'RateLimitExceeded', 'InvalidAuthorization', 'InsufficientAuthorization'. Default value: 'None'.

code: ErrorCode

Property Value

ErrorCode

message

A description of the error.

message: string

Property Value

string

moreDetails

A description that provides additional information about the error. NOTE: This property will not be serialized. It can only be populated by the server.

moreDetails?: string

Property Value

string

parameter

The parameter in the request that caused the error. NOTE: This property will not be serialized. It can only be populated by the server.

parameter?: string

Property Value

string

subCode

The error code that further helps to identify the error. Possible values include: 'UnexpectedError', 'ResourceError', 'NotImplemented', 'ParameterMissing', 'ParameterInvalidValue', 'HttpNotAllowed', 'Blocked', 'AuthorizationMissing', 'AuthorizationRedundancy', 'AuthorizationDisabled', 'AuthorizationExpired' NOTE: This property will not be serialized. It can only be populated by the server.

subCode?: ErrorSubCode

Property Value

ErrorSubCode

value

The parameter's value in the request that was not valid. NOTE: This property will not be serialized. It can only be populated by the server.

value?: string

Property Value

string