Azure.AI.Language.Text Namespace

Classes

AbstractiveSummarizationActionContent	Supported parameters for the pre-built Abstractive Summarization task.
AbstractiveSummarizationOperationAction	An object representing the task definition for an Abstractive Summarization task.
AbstractiveSummarizationOperationResult	An object representing the results for an Abstractive Summarization task.
AbstractiveSummarizationResult	An object representing the pre-built Abstractive Summarization results of each document.
AbstractiveSummary	An object representing a single summary with context for given document.
AbstractiveSummaryActionResult	An object representing the Abstractive Summarization result of a single document with detected language.
AgeMetadata	Represents the Age entity Metadata model.
AllowOverlapEntityPolicyType	Represents the allow overlap policy. Will apply no post processing logic for the entities. Whatever the model predicts is what will be returned to the user. This allows the user to get a full view of every single model's possible values and apply their own custom logic on entity selection.
AnalyzeTextDynamicClassificationResult	Result for Dynamic Classification task.
AnalyzeTextEntitiesResult	Contains the entity task.
AnalyzeTextEntityLinkingResult	Contains the analyze text Entity linking task result.
AnalyzeTextError	The error response object returned when the service encounters some errors during processing the request.
AnalyzeTextInput	Collection of documents to analyze and a single task to execute. Please note AnalyzeTextInput 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 TextDynamicClassificationInput, TextEntityLinkingInput, TextEntityRecognitionInput, TextKeyPhraseExtractionInput, TextLanguageDetectionInput, TextPiiEntitiesRecognitionInput and TextSentimentAnalysisInput.
AnalyzeTextKeyPhraseResult	Contains the analyze text KeyPhraseExtraction task result.
AnalyzeTextLanguageDetectionResult	Contains the language detection task result for the request.
AnalyzeTextOperationAction	The long running task to be performed by the service on the input documents. Please note AnalyzeTextOperationAction 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 AbstractiveSummarizationOperationAction, CustomAbstractiveSummarizationOperationAction, CustomEntitiesOperationAction, CustomHealthcareOperationAction, CustomMultiLabelClassificationOperationAction, CustomSentimentAnalysisOperationAction, CustomSingleLabelClassificationOperationAction, EntityLinkingOperationAction, EntitiesOperationAction, ExtractiveSummarizationOperationAction, HealthcareOperationAction, KeyPhraseOperationAction, PiiOperationAction and SentimentAnalysisOperationAction.
AnalyzeTextOperationResult	Contains the AnalyzeText long running operation result object. Please note AnalyzeTextOperationResult 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 AbstractiveSummarizationOperationResult, CustomAbstractiveSummarizationOperationResult, CustomEntityRecognitionOperationResult, CustomHealthcareOperationResult, CustomMultiLabelClassificationOperationResult, CustomSentimentAnalysisOperationResult, CustomSingleLabelClassificationOperationResult, EntityLinkingOperationResult, EntityRecognitionOperationResult, ExtractiveSummarizationOperationResult, HealthcareOperationResult, KeyPhraseExtractionOperationResult, PiiEntityRecognitionOperationResult and SentimentOperationResult.
AnalyzeTextOperationState	The object containing the analyze job LRO job state.
AnalyzeTextPiiResult	Contains the analyze text PIIEntityRecognition LRO task.
AnalyzeTextResult	The result object for the analyze task. Please note AnalyzeTextResult 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 AnalyzeTextDynamicClassificationResult, AnalyzeTextEntityLinkingResult, AnalyzeTextEntitiesResult, AnalyzeTextKeyPhraseResult, AnalyzeTextLanguageDetectionResult, AnalyzeTextPiiResult and AnalyzeTextSentimentResult.
AnalyzeTextSentimentResult	Contains the analyze text SentimentAnalysis LRO task result.
AreaMetadata	Represents the Area entity Metadata model.
BaseMetadata	The abstract base class for entity Metadata. Please note BaseMetadata 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 AgeMetadata, AreaMetadata, CurrencyMetadata, DateMetadata, DateTimeMetadata, InformationMetadata, LengthMetadata, NumberMetadata, NumericRangeMetadata, OrdinalMetadata, SpeedMetadata, TemperatureMetadata, TemporalSetMetadata, TemporalSpanMetadata, TimeMetadata, VolumeMetadata and WeightMetadata.
ClassificationActionResult	Contains the classification doc result for the task with detected language.
ClassificationResult	Contains the classification result.
CurrencyMetadata	Represents the Currency ) entity Metadata model.
CustomAbstractiveSummarizationActionContent	Supported parameters for the Custom Abstractive Summarization task.
CustomAbstractiveSummarizationOperationAction	An object representing the task definition for an Custom Abstractive Summarization task.
CustomAbstractiveSummarizationOperationResult	An object representing the results for an Custom Abstractive Summarization task.
CustomAbstractiveSummarizationResult	An object representing the custom summarization results of each document.
CustomEntitiesActionContent	Supported parameters for a Custom Entities task.
CustomEntitiesActionResult	Contains the list of detected custom entities result for the documents along with detected language.
CustomEntitiesOperationAction	Contains the custom text LRO task.
CustomEntityRecognitionOperationResult	Contains the custom entity recognition job result.
CustomHealthcareActionContent	Supported parameters for a custom Healthcare task.
CustomHealthcareActionResult	Contains the document custom healthcare results with detected language.
CustomHealthcareEntity	Contains the custom healthcare entity.
CustomHealthcareOperationAction	Contains the custom healthcare task definition.
CustomHealthcareOperationResult	Contains the custom healthcare job result.
CustomHealthcareResult	Contains the custom healthcare result for the request.
CustomLabelClassificationActionResult	Contains the custom label classification with detected language results.
CustomMultiLabelClassificationActionContent	Supported parameters for a Custom Multi Classification task.
CustomMultiLabelClassificationOperationAction	Use custom models to classify text into multi label taxonomy.
CustomMultiLabelClassificationOperationResult	Contains the custom multi label classification job result.
CustomSentenceSentiment	A document's sentence custom sentiment.
CustomSentimentAnalysisActionContent	Supported parameters for a Custom Sentiment Analysis task.
CustomSentimentAnalysisOperationAction	Use custom models to ease the process of sentiment analysis from documents like product reviews.
CustomSentimentAnalysisOperationResult	Custom Sentiment Analysis Analyze Text long tunning operation result object.
CustomSentimentAnalysisResult	Custom Sentiment analysis results for the input documents.
CustomSentimentAnalysisResultDocument	Custom Sentiment analysis result for a specific document.
CustomSingleLabelClassificationActionContent	Supported parameters for a Custom Single Classification task.
CustomSingleLabelClassificationOperationAction	Use custom models to classify text into single label taxonomy.
CustomSingleLabelClassificationOperationResult	Contains the custom single label classification job result.
DateMetadata	A Metadata for date entity instances.
DateTimeMetadata	A Metadata for datetime entity instances.
DateValue	Represents the date value.
DetectedLanguage	Contains the details of the detected language for the text.
DocumentError	Contains details of errors encountered during a job execution.
DocumentStatistics	if showStats=true was specified in the request this field will contain information about the document payload.
DocumentWarning	Contains the warnings object with warnings encountered for the processed document.
DynamicClassificationActionContent	Supported parameters for a Dynamic Classification task.
DynamicClassificationDocumentResult	Contains the Dynamic Classification document result.
DynamicClassificationResult	Contains the Dynamic Classification result.
EntitiesActionContent	Supported parameters for an Entity Recognition task.
EntitiesDocumentResultWithMetadataDetectedLanguage	Contains the entity recognition task result for the document with metadata and detected language.
EntitiesOperationAction	An object representing the task definition for an Entities Recognition task.
EntitiesResult	Contains the entity recognition task result.
EntityActionResult	Contains the entity recognition task result for the document with detected language.
EntityComponentInformation	This object contains information of the detected entity components. The possible component types may expand in the future. Parsing code should handle unexpected values gracefully Please note EntityComponentInformation 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 LearnedComponent, ListComponent and PrebuiltComponent.
EntityInferenceConfig	The class that houses the inference options allowed for named entity recognition.
EntityLinkingActionContent	Supported parameters for an Entity Linking task.
EntityLinkingActionResult	Entity linking document result with auto language detection.
EntityLinkingMatch	The Match object containing the detected entity text with the offset and the length.
EntityLinkingOperationAction	Contains the analyze text Entity linking LRO task.
EntityLinkingOperationResult	Contains the analyze text Entity linking task LRO result.
EntityLinkingResult	Entity linking result.
EntityOverlapPolicy	The abstract base class for entity OverlapPolicy. Please note EntityOverlapPolicy 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 AllowOverlapEntityPolicyType and MatchLongestEntityPolicyType.
EntityRecognitionOperationResult	Contains the entity recognition job task result.
EntityTag	Entity tag object which contains the name of the tags abd any associated confidence score. Entity Tags are used to express some similarities/affinity between entities.
ExtractedSummaryActionResult	A ranked list of sentences representing the extracted summary.
ExtractedSummarySentence	Represents an extracted sentences from the input document.
ExtractiveSummarizationActionContent	Supported parameters for an Extractive Summarization task.
ExtractiveSummarizationOperationAction	An object representing the task definition for an Extractive Summarization task.
ExtractiveSummarizationOperationResult	An object representing the results for an Extractive Summarization task.
ExtractiveSummarizationResult	An object representing the pre-built Extractive Summarization results of each document.
FhirBundle	JSON bundle containing a FHIR compatible object for consumption in other Healthcare tools. For additional information see https://www.hl7.org/fhir/overview.html.
HealthcareActionContent	Supported parameters for a Healthcare task.
HealthcareActionResult	Result object for the processed Healthcare document with detected language.
HealthcareAssertion	Assertion of the entity.
HealthcareEntity	Healthcare entity extracted from the document.
HealthcareEntityLink	Reference to an entity in known data sources.
HealthcareOperationAction	The long running task to be performed by the service on the Healthcare input documents.
HealthcareOperationResult	Healthcare Analyze Text long tunning operation result object.
HealthcareRelation	Every relation is an entity graph of a certain relationType, where all entities are connected and have specific roles within the relation context.
HealthcareRelationEntity	Entity in the relation.
HealthcareResult	Result object for the processed Healthcare task.
InformationMetadata	Represents the Information (data) entity Metadata model.
InnerErrorModel	An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
KeyPhraseActionContent	Supported parameters for a Key Phrase Extraction task.
KeyPhraseExtractionOperationResult	Contains the analyze text KeyPhraseExtraction LRO task.
KeyPhraseOperationAction	An object representing the task definition for a Key Phrase Extraction task.
KeyPhraseResult	Contains the KeyPhraseResult.
KeyPhrasesActionResult	A ranked list of sentences representing the extracted summary.
LanguageDetectionActionContent	Supported parameters for a Language Detection task.
LanguageDetectionDocumentResult	Contains the language detection for a document.
LanguageDetectionResult	Contains the language detection result for the request.
LanguageDetectionTextInput	Contains the language detection document analysis input.
LanguageInput	Contains the language detection input.
LearnedComponent	This object contains information of the learned component of the detected entity.
LengthMetadata	Represents the Length entity Metadata model.
LinkedEntity	The LinkedEntity object containing the detected entity with the associated sources/links.
ListComponent	This object contains information of the list component of the detected entity.
MatchLongestEntityPolicyType	Represents the Match longest overlap policy. No overlapping entities as far as it is possible. 1. If there are overlapping entities, the longest one will be returned. 2. If the set of characters predicted for 2 or more entities are exactly the same, select the entity that has the higher confidence score.3. If the entity scores are identical, return all entities that are still present after applying the previous rules. 3. If there is partial overlap (as in Hello Text Analytics) follow the above steps starting from 1.
MultiLanguageInput	Contains an input document to be analyzed by the service.
MultiLanguageTextInput	Collection of input documents to be analyzed by the service.
NamedEntity	Defines the detected entity object containing the entity category and entity text detected, etc.
NamedEntityWithMetadata	Entity object with tags and metadata.
NumberMetadata	A metadata for numeric entity instances.
NumericRangeMetadata	represents the Metadata of numeric intervals.
OrdinalMetadata	A metadata for numeric entity instances.
PiiActionContent	Supported parameters for a PII Entities Recognition task.
PiiActionResult	Contains the PII results with detected language.
PiiEntityRecognitionOperationResult	Contains the PII LRO results.
PiiOperationAction	Contains the analyze text PIIEntityRecognition LRO task.
PiiResult	Contains the PiiResult.
PrebuiltComponent	This object contains information of the prebuilt component of the detected entity.
RequestStatistics	if showStats=true was specified in the request this field will contain information about the request payload.
SentenceAssessment	Represents a sentence assessment and the assessments or target objects related to it.
SentenceSentiment	A document's sentence sentiment.
SentenceTarget	Represents a sentence target and the assessments or target objects related to it.
SentimentActionResult	Sentiment analysis per document.
SentimentAnalysisActionContent	Supported parameters for a Sentiment Analysis task.
SentimentAnalysisOperationAction	An object representing the task definition for a Sentiment Analysis task.
SentimentConfidenceScores	Represents the confidence scores between 0 and 1 across all sentiment classes: positive, neutral, negative.
SentimentOperationResult	Contains the Sentiment Analysis LRO results.
SentimentResult	Sentiment analysis results for the input documents.
SpeedMetadata	Represents the Speed entity Metadata model.
SummaryContext	The context of the summary.
TargetConfidenceScoreLabel	Represents the confidence scores across all sentiment classes: positive and negative.
TargetRelation	Represents the relation between assessments and/or targets.
TemperatureMetadata	Represents the Information entity Metadata model.
TemporalSetMetadata	A Metadata for temporal set entity instances.
TemporalSpanMetadata	represents the Metadata of a date and/or time span.
TemporalSpanValues	Temporal span object.
TextActions	Container for the tasks status for the LRO job.
TextAnalysisClient	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 <a href="https://docs.microsoft.com/azure/cognitive-services/language-service/overview">https://docs.microsoft.com/azure/cognitive-services/language-service/overview</a>.0.
TextAnalysisClientBuilderExtensions	Extension methods to add TextAnalysisClient to client builder.
TextAnalysisClientOptions	Client options for TextAnalysisClient.
TextAnalysisModelFactory	Model factory for models.
TextDynamicClassificationInput	Contains the analyze text dynamic classifications input.
TextEntityLinkingInput	Contains the analyze text Entity linking input.
TextEntityRecognitionInput	The entity recognition analyze text input task request.
TextKeyPhraseExtractionInput	Contains the analyze text KeyPhraseExtraction task input.
TextLanguageDetectionInput	Contains the language detection document analysis task input.
TextPiiEntitiesRecognitionInput	Contains the analyze text PIIEntityRecognition task input.
TextSentimentAnalysisInput	Contains the analyze text SentimentAnalysis task input.
TimeMetadata	A Metadata for time entity instances.
VolumeMetadata	Represents the Volume entity Metadata model.
WeightMetadata	Represents the Weight ) entity Metadata model.

Structs

AgeUnit	The Age Unit of measurement.
AnalyzeTextErrorCode	Human-readable error code.
AreaUnit	The area unit of measurement.
ClassificationType	Specifies either one or multiple categories per document. Defaults to multi classification which may return more than one class for each document.
EntityCategory	Contains all the entity categories detected by entity recognition.
ExtractiveSummarizationSortingCriteria	The sorting criteria to use for the results of Extractive Summarization.
FhirVersion	The FHIR Spec version.
HealthcareDocumentType	Document type.
HealthcareEntityCategory	Healthcare Entity Category.
InformationUnit	The information (data) Unit of measurement.
InnerErrorCode	Human-readable error code.
LengthUnit	The length unit of measurement.
NumberKind	The type of the extracted number entity.
PiiCategoriesExclude	(Optional) describes the PII categories to return.
PiiCategory	(Optional) describes the PII categories to return.
PiiDomain	PII domains.
RangeInclusivity	The range inclusiveness of this property property.
RangeKind	The kind of the number range entity.
RedactionCharacter	Optional parameter to use a Custom Character to be used for redaction in PII responses. Default character will be * as before. We allow specific ascii characters for redaction.
RelationType	Type of relation. Examples include: DosageOfMedication or 'FrequencyOfMedication', etc.
RelativeTo	The reference point that the ordinal number denotes.
ScriptCode	Identifies the script of the input document. Maps to the ISO 15924 standard script code.
ScriptKind	Identifies the script of the input document. Maps to the ISO 15924 standard formal name.
SpeedUnit	The speed Unit of measurement.
StringIndexType	Specifies the method used to interpret string offsets. Defaults to Text Elements (Graphemes) according to Unicode v8.0.0. For additional information see https://aka.ms/text-analytics-offsets.
SummaryLengthBucket	Enum that defines the length of the output summaries.
TemperatureUnit	The temperature Unit of measurement.
TemporalModifier	An optional modifier of a date/time instance.
TextActionState	The status of the task at the mentioned last update time.
VolumeUnit	The Volume Unit of measurement.
WarningCode	Defines the list of the warning codes.
WeightUnit	The weight Unit of measurement.

Enums

DocumentSentiment	Predicted sentiment for document (Negative, Neutral, Positive, or Mixed).
HealthcareAssertionAssociation	Describes if the entity is the subject of the text or if it describes someone else.
HealthcareAssertionCertainty	Describes the entities certainty and polarity.
HealthcareAssertionConditionality	Describes any conditionality on the entity.
HealthcareAssertionTemporality	Describes temporal information regarding the entity.
SentenceSentimentValue	The predicted Sentiment for the sentence.
TargetRelationType	The type related to the target.
TextAnalysisClientOptions.ServiceVersion	The version of the service to use.
TokenSentiment	The predicted Sentiment for the sentence.