Share via


com.azure.ai.textanalytics.models

Package containing the data models for MicrosoftCognitiveLanguageServiceTextAnalysis. The language service API is a suite of natural language processing (NLP) skills built with best-in-class Microsoft machine learning algorithms. The API can be used to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction, language detection and question answering. Further documentation can be found in https://docs.microsoft.com/azure/cognitive-services/language-service/overview.

Classes

AbstractiveSummary

An object representing a single summary with context for given document.

AbstractiveSummaryAction

Configurations that allow callers to specify details about how to execute an abstractive summarization action in a set of documents.

AbstractiveSummaryActionResult

The AbstractiveSummaryActionResult model.

AbstractiveSummaryContext

The AbstractiveSummaryContext model.

AbstractiveSummaryOperationDetail

The AbstractiveSummaryOperationDetail model.

AbstractiveSummaryOptions

Configurations that allow callers to specify details about how to execute an abstractive summarization in a set of documents.

AbstractiveSummaryResult

The AbstractiveSummaryResult model.

AnalyzeActionsOperationDetail

The AnalyzeActionsOperationDetail model.

AnalyzeActionsOptions

The AnalyzeActionsOptions model.

AnalyzeActionsResult

The AnalyzeActionsResult model.

AnalyzeHealthcareEntitiesAction

Configurations that allow callers to specify details about how to execute an healthcare analysis action in a set of documents.

AnalyzeHealthcareEntitiesActionResult

The AnalyzeHealthcareEntitiesActionResult model.

AnalyzeHealthcareEntitiesOperationDetail

The AnalyzeHealthcareEntitiesOperationDetail model.

AnalyzeHealthcareEntitiesOptions

The AnalyzeHealthcareEntitiesOptions model.

AnalyzeHealthcareEntitiesResult

The AnalyzeHealthcareEntitiesResult model.

AnalyzeSentimentAction

Configurations that allow callers to specify details about how to execute an sentiment analysis action in a set of documents.

AnalyzeSentimentActionResult

The AnalyzeSentimentActionResult model.

AnalyzeSentimentOptions

The AnalyzeSentimentOptions model.

AnalyzeSentimentResult

The AnalyzeSentimentResult model.

AssessmentSentiment

The AssessmentSentiment model.

CategorizedEntity

The CategorizedEntity model.

CategorizedEntityCollection

The CategorizedEntityCollection model.

ClassificationCategory

The document classification result which contains the classified category and the confidence score on it.

ClassifyDocumentOperationDetail

The ClassifyDocumentOperationDetail model.

ClassifyDocumentResult

The ClassifyDocumentResult model.

DetectLanguageInput

The DetectLanguageInput model.

DetectLanguageResult

The DetectLanguageResult model.

DetectedLanguage

The DetectedLanguage model.

DocumentSentiment

The DocumentSentiment model that contains sentiment label of a document, confidence score of the sentiment label, and a list of SentenceSentiment.

EntityAssociation

The EntityAssociation model.

EntityCategory

Gets the entity category inferred by the text analytics service's named entity recognition model.

EntityCertainty

The EntityCertainty model.

EntityConditionality

The EntityConditionality model.

EntityDataSource

The EntityDataSource model.

ExtractKeyPhraseResult

The ExtractKeyPhraseResult model.

ExtractKeyPhrasesAction

Configurations that allow callers to specify details about how to execute a key phrases extraction action in a set of documents.

ExtractKeyPhrasesActionResult

The ExtractKeyPhrasesActionResult model.

ExtractiveSummaryAction

Configurations that allow callers to specify details about how to execute an extractive summarization action in a set of documents.

ExtractiveSummaryActionResult

The ExtractiveSummaryActionResult model.

ExtractiveSummaryOperationDetail

The ExtractiveSummaryOperationDetail model.

ExtractiveSummaryOptions

Configurations that allow callers to specify details about how to execute an extractive summarization in a set of documents.

ExtractiveSummaryResult

The ExtractiveSummaryResult model.

ExtractiveSummarySentence

The ExtractiveSummarySentence model.

ExtractiveSummarySentencesOrder

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

HealthcareEntity

The HealthcareEntity model.

HealthcareEntityAssertion

The HealthcareEntityAssertion model.

HealthcareEntityCategory

Healthcare Entity Category.

HealthcareEntityRelation

The HealthcareEntityRelation Every relation is an entity graph of a certain relationType, where all entities are connected and have specific roles within the relation context.

HealthcareEntityRelationRole

The HealthcareEntityRelationRole model.

HealthcareEntityRelationType

Type of relation.

KeyPhrasesCollection

The KeyPhrasesCollection model.

LinkedEntity

The LinkedEntity model.

LinkedEntityCollection

The LinkedEntityCollection model.

LinkedEntityMatch

The LinkedEntityMatch model.

MultiLabelClassifyAction

Configurations that allow callers to specify details about how to execute a multi-label classification action in a set of documents.

MultiLabelClassifyActionResult

The MultiLabelClassifyActionResult is the result for multi-label classification action analysis.

MultiLabelClassifyOptions

The MultiLabelClassifyOptions model.

PiiEntity

The PiiEntity model.

PiiEntityCategory

Gets the PII entity category inferred by the text analytics service's PII entity recognition model.

PiiEntityCollection

The PiiEntityCollection model.

PiiEntityDomain

Defines values for PiiEntityDomain.

RecognizeCustomEntitiesAction

Configurations that allow callers to specify details about how to execute a custom entities recognition action in a set of documents.

RecognizeCustomEntitiesActionResult

The RecognizeCustomEntitiesActionResult model.

RecognizeCustomEntitiesOperationDetail

The RecognizeCustomEntitiesOperationDetail model.

RecognizeCustomEntitiesOptions

The RecognizeCustomEntitiesOptions model.

RecognizeEntitiesAction

Configurations that allow callers to specify details about how to execute an entities recognition action in a set of documents.

RecognizeEntitiesActionResult

The RecognizeEntitiesActionResult model.

RecognizeEntitiesResult

The RecognizeEntitiesResult model.

RecognizeLinkedEntitiesAction

Configurations that allow callers to specify details about how to execute a linked entities recognition action in a set of documents.

RecognizeLinkedEntitiesActionResult

The RecognizeLinkedEntitiesActionResult model.

RecognizeLinkedEntitiesResult

The RecognizeLinkedEntitiesResult model.

RecognizePiiEntitiesAction

Configurations that allow callers to specify details about how to execute a Personally Identifiable Information(PII) entities recognition action in a set of documents.

RecognizePiiEntitiesActionResult

The RecognizePiiEntitiesActionResult model.

RecognizePiiEntitiesOptions

The RecognizePiiEntitiesOptions model.

RecognizePiiEntitiesResult

The RecognizePiiEntitiesResult model.

SentenceOpinion

The SentenceOpinion model.

SentenceSentiment

The SentenceSentiment model that contains a sentiment label of a sentence, confidence scores of the sentiment label, sentence opinions, and offset of sentence within a document.

SentimentConfidenceScores

The SentimentConfidenceScores model

SingleLabelClassifyAction

Configurations that allow callers to specify details about how to execute a single-label classification action in a set of documents.

SingleLabelClassifyActionResult

The SingleLabelClassifyActionResult model.

SingleLabelClassifyOptions

The SingleLabelClassifyOptions model.

TargetSentiment

The TargetSentiment model.

TextAnalyticsActionResult

The TextAnalyticsActionResult model.

TextAnalyticsActions

The TextAnalyticsActions model.

TextAnalyticsError

The TextAnalyticsError model.

TextAnalyticsErrorCode

Defines values for TextAnalyticsErrorCode.

TextAnalyticsException

General exception for Text Analytics related failures.

TextAnalyticsRequestOptions

The TextAnalyticsRequestOptions model.

TextAnalyticsResult

The TextAnalyticsResult model.

TextAnalyticsWarning

The TextAnalyticsWarning model.

TextDocumentBatchStatistics

If isIncludeStatistics() is set to true this class will will contain information about the request payload.

TextDocumentInput

Contains an input document to be analyzed by the service.

TextDocumentStatistics

If isIncludeStatistics() is set to true this class will will contain information about the document payload.

TextSentiment

Defines values for TextSentiment.

WarningCode

Defines values for WarningCode.