Azure.AI.TextAnalytics Namespace

Classes

AnalyzeBatchActionsOperation

Pageable operation class for analyzing multiple actions using long running operation.

AnalyzeBatchActionsOptions

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

For example whether to include statistics.

AnalyzeBatchActionsResult

The results of an analyze batch actions operation.

AnalyzeHealthcareEntitiesOperation

Pageable operation class for analyzing multiple healthcare documents using long running operation.

AnalyzeHealthcareEntitiesOptions

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

AnalyzeHealthcareEntitiesResult

AnalyzeHealthcareEntitiesResult.

AnalyzeHealthcareEntitiesResultCollection

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

AnalyzeSentimentOptions

Options that allow callers to specify details about how the operation is run. For example execute opinion mining, set model version, and whether to include statistics.

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, and warnings encountered while processing the 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 .

EntityDataSource

EntityDataSource.

ExtractKeyPhrasesActionResult

ExtractKeyPhrasesActionResult

ExtractKeyPhrasesOptions

Options that allow callers to specify details about how the operation is run. For example set model version and whether to include statistics.

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.

HealthcareEntity

Health care entity class.

HealthcareEntityAssertion

The HealthcareAssertion.

HealthcareEntityRelation

Determines the relation between the entities.

HealthcareEntityRelationRole

Determines the relation role for the entity.

KeyPhraseCollection

Collection of key phrases present in a document, and warnings encountered while processing the document.

LinkedEntityCollection

Collection of LinkedEntity objects in a document, and warnings encountered while processing the document.

PageableOperation<T>

Represents a pageable long-running operation that exposes the results in either synchronous or asynchronous format.

PiiEntityCollection

Collection of PiiEntity objects in a document, and warnings encountered while processing the document.

RecognizeEntitiesActionResult

RecognizeEntitiesActionResult

RecognizeEntitiesOptions

Options that allow callers to specify details about how the operation is run. For example set model version, whether to include statistics.

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.

RecognizeLinkedEntitiesActionResult

Action result class for linked entities

RecognizeLinkedEntitiesOptions

Options that allow callers to specify details about how the operation is run. For example set model version or whether to include statistics.

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.

RecognizePiiEntitiesActionResult

RecognizePiiEntitiesActionResults

RecognizePiiEntitiesOptions

Options that allow callers to specify details about how the operation is run. For example set model version, whether to include statistics, and filter the response entities by a given domain filter.

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.

TextAnalyticsActionDetails

Stores the details for the AnalyzeBatchActionsOperation class.

TextAnalyticsActions

Determines the set of actions that will get executed on the input documents.

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. For example, set a default value for Country hint or Language that will apply to all the client calls. Add logging, add headers to request, etc.

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.

For example set model version, and whether to include statistics.

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

AssessmentSentiment

Contains the predicted sentiment, confidence scores, and other information related to Opinion Mining analysis.

For example, in the sentence "The food is good", the assessment of the target 'food' is 'good'.

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.

HealthcareEntityRelationType

Type of relation. Examples include: DosageOfMedication or 'FrequencyOfMedication', etc.

LinkedEntity

The LinkedEntity.

LinkedEntityMatch

The Match.

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 .

PiiEntityCategory

The PiiCategory.

SentenceOpinion

A sentence opinion object contains assessments extracted from a sentence. It consists of both the target that these assessments are about, and the actual assessment themselves.

SentenceSentiment

The predicted sentiment and other analysis like Opinion mining for each sentence in the corresponding document.

For more information regarding text sentiment, see .

StringIndexType

The StringIndexType.

TargetSentiment

Contains the related assessments, predicted sentiment, confidence scores and other information about a target of a product. A Target of a product/service is a key component of that product/service.

For example in "The food at Hotel Foo is good", "food" is a target of "Hotel Foo".

TextAnalyticsError

Text Analytics Error.

TextAnalyticsErrorCode

Text Analytics error code values.

TextAnalyticsOperationStatus

The State.

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

EntityAssociation

Describes whether the healthcare entity it's on the subject of the document, or if this entity describes someone else in the document. For example, in "The subject's mother has a fever", the "fever" entity is not associated with the subject themselves, but with the subject's mother.

EntityCertainty

Determines the Certainity of the HealthcareEntityAssertion For example, in "The patient may have a fever", the fever entity is not 100% certain, but is instead "PositivePossible".

EntityConditionality

Determines the condition of the HealthcareEntityAssertion. For example, "If the patient has a fever, he has pneumonia", the diagnosis of pneumonia is 'conditional' on whether the patient has a fever.

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.