Azure.AI.TextAnalytics Namespace

Classes

AbstractSummaryAction

A set of options used to configure abstractive summarization, including the model version to use, the maximum number of sentences that the resulting summary can have, and more.

AbstractSummaryActionResult

A representation of the result of performing an AbstractSummaryAction on a given set of documents.

AbstractSummaryOperation

A representation of abstractive summarization being performed on a given set of documents as a pageable, long-running operation.

AbstractSummaryOptions

A set of options used to configure abstractive summarization, including the display name to use, the maximum number of sentences that the resulting summary can have, and more.

AbstractSummaryResult

A representation of the result of performing abstractive summarization on a given document.

AbstractSummaryResultCollection

A collection of the results of performing abstractive summarization on a given set of documents.

AgeResolution

Represents the Age entity resolution model.

AnalyzeActionsOperation

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

AnalyzeActionsOptions

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.

AnalyzeActionsResult

The results of executing multiple actions on a set of documents.

AnalyzeHealthcareEntitiesAction

Configurations that allow callers to specify details about how to execute an Analyze Healthcare Entities action in a set of documents. For example, set model version and disable service logging.

AnalyzeHealthcareEntitiesActionResult

The result of the execution of an AnalyzeHealthcareEntitiesAction on the input documents.

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

The result of the analyze healthcare operation, containing the predicted healthcare entities, warning, and relations.

AnalyzeHealthcareEntitiesResultCollection

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

AnalyzeSentimentAction

Configurations that allow callers to specify details about how to execute an Analyze Sentiment action in a set of documents. For example, execute opinion mining, set model version, and more.

AnalyzeSentimentActionResult

The result of the execution of an AnalyzeSentimentAction on the input documents.

AnalyzeSentimentOptions

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

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.

AreaResolution

Represents the area entity resolution model.

BaseResolution

The abstract base class for entity resolutions. Please note BaseResolution is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include AgeResolution, AreaResolution, BooleanResolution, CurrencyResolution, DateTimeResolution, InformationResolution, LengthResolution, NumberResolution, NumericRangeResolution, OrdinalResolution, SpeedResolution, TemperatureResolution, TemporalSpanResolution, VolumeResolution and WeightResolution.

BooleanResolution

A resolution for boolean expressions.

CategorizedEntityCollection

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

ClassificationCategoryCollection

A collection of categories that were used to classify a given document.

ClassifyDocumentOperation

Pageable operation class for classifying single and multiple labels from multiple documents using long running operation.

ClassifyDocumentResult

A representation of the result of performing dynamic classification or custom text classification on a given document.

ClassifyDocumentResultCollection

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

CurrencyResolution

Represents the currency entity resolution model.

DateTimeResolution

A resolution for datetime entity instances.

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 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 https://docs.microsoft.com/azure/cognitive-services/Text-Analytics/how-tos/text-analytics-how-to-sentiment-analysis.

DynamicClassifyDocumentResultCollection

A collection of the results of performing dynamic classification on a given set of documents.

DynamicClassifyOptions

A set of options used to configure dynamic classification.

EntityDataSource

A model representing a reference for the healthcare entity into a specific entity catalog.

ExtractKeyPhrasesAction

Configurations that allow callers to specify details about how to execute an Extract KeyPhrases action in a set of documents. For example, set model version and disable service logging.

ExtractKeyPhrasesActionResult

The result of the execution of an ExtractKeyPhrasesAction on the input documents.

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.

ExtractSummaryAction

A set of options used to configure extractive summarization, including the model version to use, the maximum number of sentences to extract, and more.

ExtractSummaryActionResult

A representation of the result of performing an ExtractSummaryAction on a given set of documents.

ExtractSummaryOperation

A representation of extractive summarization being performed on a given set of documents as a pageable, long-running operation.

ExtractSummaryOptions

A set of options used to configure extractive summarization, including the display name to use, the maximum number of sentences to extract, and more.

ExtractSummaryResult

A representation of the result of performing extractive summarization on a given document.

ExtractSummaryResultCollection

A collection of the results of performing extractive summarization on a given set of documents.

HealthcareEntity

A model which contains information about the detected healthcare entity.

HealthcareEntityAssertion

The HealthcareAssertion.

HealthcareEntityRelation

Determines the relation between the entities.

HealthcareEntityRelationRole

Determines the relation role for the entity.

InformationResolution

Represents the information (data) entity resolution model.

KeyPhraseCollection

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

LengthResolution

Represents the length entity resolution model.

LinkedEntityCollection

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

MultiLabelClassifyAction

Configurations that allow callers to specify details about how to execute a Multi Label Classification action on a set of documents. This corresponds to a Multi Classification task in the Language service. For example, the target project and deployment names are required for a successful custom classification action.

MultiLabelClassifyActionResult

The result of the execution of a MultiLabelClassifyAction on the input documents.

MultiLabelClassifyOptions

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

NumberResolution

A resolution for numeric entity instances.

NumericRangeResolution

represents the resolution of numeric intervals.

OrdinalResolution

A resolution for ordinal numbers entity instances.

PiiEntityCollection

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

RecognizeCustomEntitiesAction

Configurations that allow callers to specify details about how to execute a Recognize Custom Entities action in a set of documents.

RecognizeCustomEntitiesActionResult

The result of the execution of a RecognizeCustomEntitiesAction on the input documents.

RecognizeCustomEntitiesOperation

Pageable operation class for recognizing custom entites from multiple documents using long running operation.

RecognizeCustomEntitiesOptions

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

RecognizeCustomEntitiesResultCollection

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

RecognizeEntitiesAction

Configurations that allow callers to specify details about how to execute a Recognize Entities action in a set of documents. For example, set model version and disable service logging.

RecognizeEntitiesActionResult

The result of the execution of a RecognizeEntitiesAction on the input documents.

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.

RecognizeLinkedEntitiesAction

Configurations that allow callers to specify details about how to execute a Recognize Linked Entities action in a set of documents. For example, set model version and disable service logging.

RecognizeLinkedEntitiesActionResult

The result of the execution of a RecognizeLinkedEntitiesAction on the input documents.

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.

RecognizePiiEntitiesAction

Configurations that allow callers to specify details about how to execute a Recognize PII Entities action in a set of documents. For example, set model version, filter the response entities by a given domain filter, and more.

RecognizePiiEntitiesActionResult

The result of the execution of a RecognizePiiEntitiesAction on the input documents.

RecognizePiiEntitiesOptions

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

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.

SingleLabelClassifyAction

Configurations that allow callers to specify details about how to execute a Single Label Classification action on a set of documents. This corresponds to a Single Label Classification task in the Language service. For example, the target project and deployment names are required for a successful custom classification action.

SingleLabelClassifyActionResult

The result of the execution of a SingleLabelClassifyAction on the input documents.

SingleLabelClassifyOptions

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

SpeedResolution

Represents the speed entity resolution model.

TemperatureResolution

Represents the temperature entity resolution model.

TemporalSpanResolution

represents the resolution of a date and/or time span.

TextAnalyticsActionResult

Base type for results of Text Analytics Actions executed in a set of documents.

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 for Language, which includes 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 Language service 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, whether to include statistics, and more.

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 Language service 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.

VolumeResolution

Represents the volume entity resolution model.

WeightResolution

Represents the weight entity resolution model.

Structs

AbstractiveSummary

A summary produced by the service from a given document.

AgeUnit

The Age Unit of measurement.

AreaUnit

The area Unit of measurement.

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 that was recognized as an entity and categorized accordingly by the service's named entity recognition model and taxonomy. For the list of supported categories and subcategories, see https://learn.microsoft.com/azure/cognitive-services/language-service/named-entity-recognition/concepts/named-entity-categories.

ClassificationCategory

A category that was used to classify a given document.

ClassificationType

Specifies either one or multiple categories per document. Defaults to multi classification which may return more than one class for each document.

DateTimeSubKind

The DateTime SubKind.

DetectedLanguage

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

EntityCategory

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

HealthcareDocumentType

Document type that can be provided as input for Fhir Documents. Expect to have fhirVersion provided when used. Behavior of using None enum is the same as not using the documentType parameter.

HealthcareEntityCategory

Healthcare Entity Category.

HealthcareEntityRelationType

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

InformationUnit

The information (data) Unit of measurement.

LengthUnit

The length Unit of measurement.

LinkedEntity

The LinkedEntity.

LinkedEntityMatch

The Match.

NumberKind

The type of the extracted number entity.

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 Language service is described at https://aka.ms/azsdk/language/pii.

PiiEntityCategory

The PiiCategory.

RangeKind

The kind of range that the resolution object represents.

RelativeTo

The reference point that the ordinal number denotes.

ScriptKind

Identifies the script of the input document.

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 https://docs.microsoft.com/azure/cognitive-services/language-service/sentiment-opinion-mining/overview.

SpeedUnit

The speed Unit of measurement.

SummaryContext

A representation of the text that was used as context by the service to produce a given summary.

SummarySentence

A sentence extracted from a given document as a result of performing extractive summarization on it. The sentence receives a rank score based on its relevance, as determined by the service.

SummarySentencesOrder

The sorting criteria to use for the results of Extractive Summarization.

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".

TemperatureUnit

The temperature Unit of measurement.

TemporalModifier

An optional modifier of a date/time instance.

TextAnalyticsAudience

Cloud audiences available for TextAnalytics.

TextAnalyticsError

Text Analytics Error.

TextAnalyticsErrorCode

Text Analytics error code values.

TextAnalyticsOperationStatus

The status of the task at the mentioned last update time.

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.

VolumeUnit

The Volume Unit of measurement.

WeightUnit

The weight Unit of measurement.

WellKnownFhirVersion

The FHIR Spec version that the result will use to format the fhirBundle. For additional information see https://www.hl7.org/fhir/overview.html.

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.

PiiEntityDomain

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

TextAnalyticsClientOptions.ServiceVersion

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

TextSentiment

The predicted sentiment for a given document.