azure.cognitiveservices.language.textanalytics.models module

exception azure.cognitiveservices.language.textanalytics.models.ErrorResponseException(deserialize, response, *args)

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.textanalytics.models.MultiLanguageInput(language=None, id=None, text=None)

Bases: msrest.serialization.Model

MultiLanguageInput.

Parameters:

• language (str) – This is the 2 letter ISO 639-1 representation of a language. For example, use “en” for English; “es” for Spanish etc.,
• id (str) – Unique, non-empty document identifier.
• text (str) –

class azure.cognitiveservices.language.textanalytics.models.MultiLanguageBatchInput(documents=None)

Bases: msrest.serialization.Model

MultiLanguageBatchInput.

Parameters:documents (list[MultiLanguageInput]) –

class azure.cognitiveservices.language.textanalytics.models.KeyPhraseBatchResultItem

Bases: msrest.serialization.Model

KeyPhraseBatchResultItem.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

• key_phrases (list[str]) – A list of representative words or phrases. The number of key phrases returned is proportional to the number of words in the input document.
• id (str) – Unique document identifier.

class azure.cognitiveservices.language.textanalytics.models.ErrorRecord(id=None, message=None)

Bases: msrest.serialization.Model

ErrorRecord.

Parameters:

• id (str) – Input document unique identifier the error refers to.
• message (str) – Error message.

class azure.cognitiveservices.language.textanalytics.models.KeyPhraseBatchResult

Bases: msrest.serialization.Model

KeyPhraseBatchResult.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

• documents (list[KeyPhraseBatchResultItem]) –
• errors (list[ErrorRecord]) –

class azure.cognitiveservices.language.textanalytics.models.InternalError(code=None, message=None, inner_error=None)

Bases: msrest.serialization.Model

InternalError.

Parameters:

• code (str) –
• message (str) –
• inner_error (InternalError) –

class azure.cognitiveservices.language.textanalytics.models.ErrorResponse(code=None, message=None, target=None, inner_error=None)

Bases: msrest.serialization.Model

ErrorResponse.

Parameters:

• code (str) –
• message (str) –
• target (str) –
• inner_error (InternalError) –

class azure.cognitiveservices.language.textanalytics.models.Input(id=None, text=None)

Bases: msrest.serialization.Model

Input.

Parameters:

• id (str) – Unique, non-empty document identifier.
• text (str) –

class azure.cognitiveservices.language.textanalytics.models.BatchInput(documents=None)

Bases: msrest.serialization.Model

BatchInput.

Parameters:documents (list[Input]) –

class azure.cognitiveservices.language.textanalytics.models.DetectedLanguage(name=None, iso6391_name=None, score=None)

Bases: msrest.serialization.Model

DetectedLanguage.

Parameters:

• name (str) – Long name of a detected language (e.g. English, French).
• iso6391_name (str) – A two letter representation of the detected language according to the ISO 639-1 standard (e.g. en, fr).
• score (float) – A confidence score between 0 and 1. Scores close to 1 indicate 100% certainty that the identified language is true.

class azure.cognitiveservices.language.textanalytics.models.LanguageBatchResultItem

Bases: msrest.serialization.Model

LanguageBatchResultItem.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

• id (str) – Unique document identifier.
• detected_languages (list[DetectedLanguage]) – A list of extracted languages.

class azure.cognitiveservices.language.textanalytics.models.LanguageBatchResult

Bases: msrest.serialization.Model

LanguageBatchResult.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

• documents (list[LanguageBatchResultItem]) –
• errors (list[ErrorRecord]) –

class azure.cognitiveservices.language.textanalytics.models.SentimentBatchResultItem

Bases: msrest.serialization.Model

SentimentBatchResultItem.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

• score (float) – A decimal number between 0 and 1 denoting the sentiment of the document. A score above 0.7 usually refers to a positive document while a score below 0.3 normally has a negative connotation. Mid values refer to neutral text.
• id (str) – Unique document identifier.

class azure.cognitiveservices.language.textanalytics.models.SentimentBatchResult

Bases: msrest.serialization.Model

SentimentBatchResult.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:

• documents (list[SentimentBatchResultItem]) –
• errors (list[ErrorRecord]) –

class azure.cognitiveservices.language.textanalytics.models.AzureRegions

Bases: enum.Enum

An enumeration.

australiaeast = 'australiaeast'

brazilsouth = 'brazilsouth'

eastasia = 'eastasia'

eastus = 'eastus'

eastus2 = 'eastus2'

northeurope = 'northeurope'

southcentralus = 'southcentralus'

southeastasia = 'southeastasia'

westcentralus = 'westcentralus'

westeurope = 'westeurope'

westus = 'westus'

westus2 = 'westus2'