Azure.AI.TextAnalytics Namespace

Classes

AnalyzeSentimentOptions

Options that allow callers to specify details about how the operation is run and what information is returned from it by the service.

AnalyzeSentimentResult

The result of the analyze sentiment operation on a single document, containing the predicted sentiment for each sentence as well as for the full document.

AnalyzeSentimentResultCollection

Collection of AnalyzeSentimentResult objects corresponding to a batch of documents, and information about the batch operation.

CategorizedEntityCollection

Collection of CategorizedEntity objects in a document.

DetectLanguageInput

An input to the detect language operation. This object allows the caller to specify a unique document id, as well as the full text of a document and a hint indicating the document's country of origin to assist the Text Analytics predictive model in detecting the document's language.

DetectLanguageResult

The result of the detect language operation on a single document, containing a prediction of what language the document is written in.

DetectLanguageResultCollection

Collection of DetectLanguageResult objects corresponding to a batch of documents, and information about the batch operation.

DocumentSentiment

Overall predicted sentiment and confidence scores for the document. It also includes per-sentence sentiment prediction. For more information regarding text sentiment, see .

ExtractKeyPhrasesResult

The result of the extract key phrases operation on a document.

ExtractKeyPhrasesResultCollection

Collection of ExtractKeyPhrasesResult objects corresponding to a batch of documents, and information about the batch operation.

KeyPhraseCollection

Collection of key phrases present in a document.

LinkedEntityCollection

Collection of LinkedEntity objects in a document.

PiiEntityCollection

Collection of PiiEntity objects in a document.

RecognizeEntitiesResult

The result of the recognize entities operation on a document, containing a collection of the CategorizedEntity objects identified in that document.

RecognizeEntitiesResultCollection

Collection of RecognizeEntitiesResult objects corresponding to a batch of documents, and information about the batch operation.

RecognizeLinkedEntitiesResult

The result of the recognize linked entities operation on a document, containing a collection of the LinkedEntity objects identified in that document.

RecognizeLinkedEntitiesResultCollection

Collection of RecognizeLinkedEntitiesResult objects corresponding to a batch of documents, and information about the batch operation.

RecognizePiiEntitiesOptions

Options that allow callers to specify details about how the operation is run and what information is returned from it by the service.

RecognizePiiEntitiesResult

The result of the recognize PII entities operation on a document, containing a collection of the PiiEntity objects containing Personally Identifiable Information that were found in that document.

RecognizePiiEntitiesResultCollection

Collection of RecognizePiiEntitiesResult objects corresponding to a batch of documents, and information about the batch operation.

SentimentConfidenceScores

Represents the confidence scores between 0 and 1 across all sentiment classes: positive, neutral, negative.

TextAnalyticsClient

The client to use for interacting with the Azure Cognitive Service, Text Analytics.

TextAnalyticsClientOptions

Options that allow to configure the management of the request sent to the service.

TextAnalyticsInput

An input representing an individual text document to be analyzed by the Text Analytics predictive model for a given operation.

TextAnalyticsModelFactory

Model factory that enables mocking for the Text Analytics library.

TextAnalyticsRequestOptions

Options that allow callers to specify details about how the operation is run and what information is returned from it by the service.

TextAnalyticsResult

Base type for results of Text Analytics operations corresponding to a document. If the operation is unsuccessful, the Id and Error properties will be populated, but not others.

TextDocumentBatchStatistics

if showStats=true was specified in the request this field will contain information about the request payload.

TextDocumentInput

An input representing an individual text document to be analyzed by the Text Analytics predictive model for a given operation. The document contains the document's id, the full text of the document, and the language that the document is written in.

Structs

AspectSentiment

Contains the related opinions, predicted sentiment, confidence scores and other information about an aspect of a product. An aspect of a product/service is a key component of that product/service. For example in "The food at Hotel Foo is good", "food" is an aspect of "Hotel Foo".

CategorizedEntity

A word or phrase identified as an entity that can be categorized as known type in a given taxonomy. The set of categories recognized by the Text Analytics service is described at .

DetectedLanguage

A prediction of the language in which a document is written in.

EntityCategory

Gets the entity category inferred by the Text Analytics service's named entity recognition model. The list of available categories is described at Supported entity categories in Named Entity Recognition v3.

LinkedEntity

The LinkedEntity.

LinkedEntityMatch

The Match.

MinedOpinion

A mined opinion object contains opinions extracted from a sentence. It consists of both an aspect that these opinions are about, and the actual opinions themselves.

OpinionSentiment

Contains the predicted sentiment, confidence scores, and other information about the opinion of an aspect. For example, in the sentence "The food is good", the opinion of the aspect 'food' is 'good'.

PiiEntity

A word or phrase identified as a Personally Identifiable Information that can be categorized as known type in a given taxonomy. The set of categories recognized by the Text Analytics service is described at .

SentenceSentiment

The predicted sentiment for a given span of text. For more information regarding text sentiment, see .

TextAnalyticsError

Text Analytics Error.

TextAnalyticsErrorCode

Text Analytics error code values.

TextAnalyticsWarning

Text Analytics Warning.

TextAnalyticsWarningCode

Text Analytics warning code values.

TextDocumentStatistics

if showStats=true was specified in the request this field will contain information about the document payload.

Enums

AdditionalSentimentAnalyses

Additional types of Sentiment Analysis to be applied to the AnalyzeSentiment method, like for example Opinion Mining.

PiiEntityDomainType

The different domains of PII entities that users can filter requests by.

TextAnalyticsClientOptions.ServiceVersion

The versions of the Text Analytics service supported by this client library.

TextSentiment

The predicted sentiment for a given document.