models Package

Supported parameters for the pre-built Abstractive Summarization task.

An object representing the task definition for an Abstractive Summarization task.

An object representing the results for an Abstractive Summarization task.

An object representing the pre-built Abstractive Summarization results of each document.

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

An object representing the Abstractive Summarization result of a single document with detected language.

Represents the Age entity Metadata model.

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.

Contains the entity task.

Contains the analyze text Entity linking task result.

The error response object returned when the service encounters some errors during processing the request.

Collection of documents to analyze and a single task to execute.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: TextEntityLinkingInput, TextEntityRecognitionInput, TextKeyPhraseExtractionInput, TextLanguageDetectionInput, TextPiiEntitiesRecognitionInput, TextSentimentAnalysisInput

Contains the analyze text KeyPhraseExtraction task result.

Contains the AnalyzeText long running operation result object.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AbstractiveSummarizationOperationResult, CustomEntityRecognitionOperationResult, CustomMultiLabelClassificationOperationResult, CustomSingleLabelClassificationOperationResult, EntityLinkingOperationResult, EntityRecognitionOperationResult, ExtractiveSummarizationOperationResult, HealthcareLROResult, KeyPhraseExtractionOperationResult, PiiEntityRecognitionOperationResult, SentimentLROResult

Contains the language detection task result for the request.

The long running task to be performed by the service on the input documents.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AbstractiveSummarizationOperationAction, CustomEntitiesLROTask, CustomMultiLabelClassificationOperationAction, CustomSingleLabelClassificationOperationAction, EntityLinkingLROTask, EntitiesLROTask, ExtractiveSummarizationOperationAction, HealthcareLROTask, KeyPhraseLROTask, PiiLROTask, SentimentAnalysisOperationAction

The object containing the analyze job LRO job state.

Contains the analyze text PIIEntityRecognition LRO task.

The result object for the analyze task.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AnalyzeTextEntityLinkingResult, AnalyzeTextEntitiesResult, AnalyzeTextKeyPhraseResult, AnalyzeTextLanguageDetectionResult, AnalyzeTextPiiResult, AnalyzeTextSentimentResult

Contains the analyze text SentimentAnalysis LRO task result.

Represents the Area entity Metadata model.

The abstract base class for entity Metadata.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AgeMetadata, AreaMetadata, CurrencyMetadata, DateMetadata, DateTimeMetadata, InformationMetadata, LengthMetadata, NumberMetadata, NumericRangeMetadata, OrdinalMetadata, SpeedMetadata, TemperatureMetadata, TemporalSetMetadata, TemporalSpanMetadata, TimeMetadata, VolumeMetadata, WeightMetadata

The abstract base class for RedactionPolicy.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: CharacterMaskPolicyType, EntityMaskPolicyType, NoMaskPolicyType

Represents the policy of redacting with a redaction character.

Contains the classification doc result for the task with detected language.

Contains the classification result.

Represents the Currency ) entity Metadata model.

Supported parameters for a Custom Entities task.

Contains the custom text LRO task.

Contains the list of detected custom entities result for the documents.

Contains the entity recognition task result for the document with detected language.

Contains the custom entity recognition job result.

Contains the custom label classification results.

Supported parameters for a Custom Multi Classification task.

Use custom models to classify text into multi label taxonomy.

Contains the custom multi label classification job result.

Supported parameters for a Custom Single Classification task.

Use custom models to classify text into single label taxonomy.

Contains the custom single label classification job result.

A Metadata for date entity instances.

A Metadata for datetime entity instances.

Represents the date value.

Contains the details of the detected language for the text.

Contains details of errors encountered during a job execution.

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

Contains the warnings object with warnings encountered for the processed document.

Supported parameters for an Entity Recognition task.

An object representing the task definition for an Entities Recognition task.

Contains the entity recognition task result.

Contains the entity recognition task result.

Contains the entity recognition task result for the document with metadata and detected language.

Entity documents result with metadata.

The class that houses the inference options allowed for named entity recognition.

Supported parameters for an Entity Linking task.

Entity linking document result with auto language detection.

Contains the analyze text Entity linking LRO task.

The Match object containing the detected entity text with the offset and the length.

Contains the analyze text Entity linking task LRO result.

Entity linking result.

Represents the policy of redacting PII with the entity type.

The abstract base class for entity OverlapPolicy.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: AllowOverlapEntityPolicyType, MatchLongestEntityPolicyType

Contains the entity recognition job task result.

The entity synonyms used to enhance pii entity detection.

Object that allows the user to provide synonyms for context words that to enhance pii entity detection.

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.

Error response.

A ranked list of sentences representing the extracted summary.

Represents an extracted sentences from the input document.

Supported parameters for an Extractive Summarization task.

An object representing the task definition for an Extractive Summarization task.

An object representing the results for an Extractive Summarization task.

An object representing the pre-built Extractive Summarization results of each document.

JSON bundle containing a FHIR compatible object for consumption in other Healthcare tools. For additional information see https://www.hl7.org/fhir/overview.html.

Result object for the processed Healthcare document with detected language.

Assertion of the entity.

Healthcare entity extracted from the document.

Reference to an entity in known data sources.

Healthcare Analyze Text long tunning operation result object.

The long running task to be performed by the service on the Healthcare input documents.

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

Entity in the relation.

Result object for the processed Healthcare task.

Supported parameters for a Healthcare task.

Represents the Information (data) entity Metadata model.

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.

Supported parameters for a Key Phrase Extraction task.

Contains the analyze text KeyPhraseExtraction LRO task.

An object representing the task definition for a Key Phrase Extraction task.

Contains the KeyPhraseResult.

A ranked list of sentences representing the extracted summary.

Supported parameters for a Language Detection task.

Contains the language detection for a document.

Contains the language detection result for the request.

Contains the language detection document analysis input.

Contains the language detection input.

Represents the Length entity Metadata model.

The LinkedEntity object containing the detected entity with the associated sources/links.

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.

Contains an input document to be analyzed by the service.

Collection of input documents to be analyzed by the service.

Defines the detected entity object containing the entity category and entity text detected, etc.

Entity object with tags and metadata.

Represents the policy of not redacting found PII.

A metadata for numeric entity instances.

represents the Metadata of numeric intervals.

A metadata for numeric entity instances.

Supported parameters for a PII Entities Recognition task.

Entity object with tags.

Contains the PII LRO results.

Contains the analyze text PIIEntityRecognition LRO task.

Contains the PiiResult.

Contains the PII results with detected language.

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

Represents a sentence assessment and the assessments or target objects related to it.

A document's sentence sentiment.

Represents a sentence target and the assessments or target objects related to it.

Sentiment analysis per document.

Supported parameters for a Sentiment Analysis task.

An object representing the task definition for a Sentiment Analysis task.

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

Contains the Sentiment Analysis LRO results.

Sentiment analysis results for the input documents.

Represents the Speed entity Metadata model.

The context of the summary.

Represents the confidence scores across all sentiment classes: positive and negative.

Represents the relation between assessments and/or targets.

Represents the Information entity Metadata model.

A Metadata for temporal set entity instances.

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

Temporal span object.

Container for the tasks status for the LRO job.

Contains the analyze text Entity linking input.

The entity recognition analyze text input task request.

Contains the analyze text KeyPhraseExtraction task input.

Contains the language detection document analysis task input.

Contains the analyze text PIIEntityRecognition task input.

Contains the analyze text SentimentAnalysis task input.

A Metadata for time entity instances.

Policy for specific words and terms that should be excluded from detection by the PII detection service.

Represents the Volume entity Metadata model.

Represents the Weight ) entity Metadata model.

The Age Unit of measurement.

Human-readable error code.

The kind of the analyze-text tasks supported.

The kind of the long running analyze text tasks supported.

The kind of the response object returned by the analyze-text long running task.

The kind of the response object returned by the analyze-text task.

The area unit of measurement.

Predicted sentiment for document (Negative, Neutral, Positive, or Mixed).

Contains all the entity categories detected by entity recognition.

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

The FHIR Spec version.

Describes if the entity is the subject of the text or if it describes someone else.

Describes the entities certainty and polarity.

Describes any conditionality on the entity.

Describes temporal information regarding the entity.

Document type.

Healthcare Entity Category.

The information (data) Unit of measurement.

Human-readable error code.

The length unit of measurement.

The entity Metadata object kind.

The type of the extracted number entity.

(Optional) describes the PII categories to return.

(Optional) describes the PII categories to return.

PII domains.

Kinds of overlap policies supported.

The range inclusiveness of this property property.

The kind of the number range entity.

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.

Kinds of redaction policies supported.

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

The reference point that the ordinal number denotes.

Identifies the script of the input document. Maps to the ISO 15924 standard script code.

Identifies the script of the input document. Maps to the ISO 15924 standard formal name.

The predicted Sentiment for the sentence.

The speed Unit of measurement.

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.

Enum that defines the length of the output summaries.

The type related to the target.

The temperature Unit of measurement.

An optional modifier of a date/time instance.

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

The predicted Sentiment for the sentence.

The Volume Unit of measurement.

Defines the list of the warning codes.

The weight Unit of measurement.