@azure/ai-language-text 1.0.0-beta.1 → 1.0.0

package/types/ai-language-text.d.ts

@@ -12,9 +12,9 @@ import { AzureKeyCredential } from '@azure/core-auth';
 import { CommonClientOptions } from '@azure/core-client';
 import { KeyCredential } from '@azure/core-auth';
 import { OperationOptions } from '@azure/core-client';
+import { OperationState } from '@azure/core-lro';
 import { PagedAsyncIterableIterator } from '@azure/core-paging';
-import { PollerLike } from '@azure/core-lro';
-import { PollOperationState } from '@azure/core-lro';
+import { SimplePollerLike } from '@azure/core-lro';
 import { TokenCredential } from '@azure/core-auth';
 
 /** Configuration common to all actions. */
@@ -29,7 +29,9 @@ export declare interface ActionCommon {
 
 /** Parameters object for a text analysis task using custom models. */
 export declare interface ActionCustom extends ActionCommon {
+    /** This field indicates the project name for the model. */
     projectName: string;
+    /** This field indicates the deployment name for the model. */
     deploymentName: string;
 }
 
@@ -81,7 +83,7 @@ export declare type AnalyzeActionParameters<ActionName extends AnalyzeActionName
 /**
  * Batch of actions.
  */
-export declare type AnalyzeBatchAction = EntityLinkingBatchAction | EntityRecognitionBatchAction | KeyPhraseExtractionBatchAction | PiiEntityRecognitionBatchAction | HealthcareBatchAction | ExtractiveSummarizationBatchAction | SentimentAnalysisBatchAction | CustomEntityRecognitionBatchAction | CustomSingleLabelClassificationBatchAction | CustomMultiLabelClassificationBatchAction;
+export declare type AnalyzeBatchAction = EntityLinkingBatchAction | EntityRecognitionBatchAction | KeyPhraseExtractionBatchAction | PiiEntityRecognitionBatchAction | HealthcareBatchAction | SentimentAnalysisBatchAction | CustomEntityRecognitionBatchAction | CustomSingleLabelClassificationBatchAction | CustomMultiLabelClassificationBatchAction;
 
 /**
  * Options common to all batch actions.
@@ -108,7 +110,6 @@ export declare const AnalyzeBatchActionNames: {
     readonly KeyPhraseExtraction: "KeyPhraseExtraction";
     readonly EntityLinking: "EntityLinking";
     readonly Healthcare: "Healthcare";
-    readonly ExtractiveSummarization: "ExtractiveSummarization";
     readonly CustomEntityRecognition: "CustomEntityRecognition";
     readonly CustomSingleLabelClassification: "CustomSingleLabelClassification";
     readonly CustomMultiLabelClassification: "CustomMultiLabelClassification";
@@ -134,10 +135,6 @@ export declare interface AnalyzeBatchOperationMetadata {
      * The time the operation status was last updated.
      */
     readonly modifiedOn: Date;
-    /**
-     * The current status of the operation.
-     */
-    readonly status: OperationStatus;
     /**
      * Number of successfully completed actions.
      */
@@ -159,7 +156,7 @@ export declare interface AnalyzeBatchOperationMetadata {
 /**
  * The state of the begin analyze polling operation.
  */
-export declare interface AnalyzeBatchOperationState extends PollOperationState<PagedAnalyzeBatchResult>, AnalyzeBatchOperationMetadata {
+export declare interface AnalyzeBatchOperationState extends OperationState<PagedAnalyzeBatchResult>, AnalyzeBatchOperationMetadata {
 }
 
 /**
@@ -170,7 +167,7 @@ export declare type AnalyzeBatchPoller = PollerLike<AnalyzeBatchOperationState,
 /**
  * Results of a batch of actions.
  */
-export declare type AnalyzeBatchResult = EntityLinkingBatchResult | EntityRecognitionBatchResult | KeyPhraseExtractionBatchResult | PiiEntityRecognitionBatchResult | SentimentAnalysisBatchResult | HealthcareBatchResult | ExtractiveSummarizationBatchResult | CustomEntityRecognitionBatchResult | CustomSingleLabelClassificationBatchResult | CustomMultiLabelClassificationBatchResult;
+export declare type AnalyzeBatchResult = EntityLinkingBatchResult | EntityRecognitionBatchResult | KeyPhraseExtractionBatchResult | PiiEntityRecognitionBatchResult | SentimentAnalysisBatchResult | HealthcareBatchResult | CustomEntityRecognitionBatchResult | CustomSingleLabelClassificationBatchResult | CustomMultiLabelClassificationBatchResult;
 
 /**
  * The type of results of every action in ${@link AnalyzeActionNames}.
@@ -553,56 +550,8 @@ export declare interface EntityRecognitionSuccessResult extends TextAnalysisSucc
     readonly entities: Entity[];
 }
 
-/** Supported parameters for an Extractive Summarization task. */
-export declare interface ExtractiveSummarizationAction extends ActionPrebuilt {
-    /** The max number of sentences to be part of the summary. */
-    maxSentenceCount?: number;
-    /** The sorting criteria to use for the results of Extractive Summarization. */
-    orderBy?: ExtractiveSummarizationOrderingCriteria;
-    /**
-     * Specifies the measurement unit used to calculate the offset and length properties. For a list of possible values, see {@link KnownStringIndexType}.
-     *
-     * The default is the JavaScript's default which is "Utf16CodeUnit".
-     */
-    stringIndexType?: StringIndexType;
-}
-
-/** Options for an extractive summarization batch action. */
-export declare interface ExtractiveSummarizationBatchAction extends AnalyzeBatchActionCommon, ExtractiveSummarizationAction {
-    /**
-     * The kind of the action.
-     */
-    kind: "ExtractiveSummarization";
-}
-
-/**
- * The result of an extractive summarization batch action.
- */
-export declare type ExtractiveSummarizationBatchResult = ActionMetadata & BatchActionResult<SummarizationExtractionResult, "ExtractiveSummarization">;
-
-/**
- * Defines values for ExtractiveSummarizationOrderingCriteria. \
- * {@link KnownExtractiveSummarizationOrderingCriteria} can be used interchangeably with ExtractiveSummarizationOrderingCriteria,
- *  this enum contains the known values that the service supports.
- * ### Known values supported by the service
- * **Offset**: Indicates that results should be sorted in order of appearance in the text. \
- * **Rank**: Indicates that results should be sorted in order of importance (i.e. rank score) according to the model.
- */
-export declare type ExtractiveSummarizationOrderingCriteria = string;
-
-/**
- * Defines values for FhirVersion. \
- * {@link KnownFhirVersion} can be used interchangeably with FhirVersion,
- *  this enum contains the known values that the service supports.
- * ### Known values supported by the service
- * **4.0.1**
- */
-export declare type FhirVersion = string;
-
 /** Supported parameters for a Healthcare task. */
 export declare interface HealthcareAction extends ActionPrebuilt {
-    /** The FHIR Spec version that the result will use to format the fhirBundle. For additional information see https://www.hl7.org/fhir/overview.html. */
-    fhirVersion?: FhirVersion;
     /**
      * Specifies the measurement unit used to calculate the offset and length properties. For a list of possible values, see {@link KnownStringIndexType}.
      *
@@ -691,32 +640,32 @@ export declare interface HealthcareEntity extends Entity {
  * {@link KnownHealthcareEntityCategory} can be used interchangeably with HealthcareEntityCategory,
  *  this enum contains the known values that the service supports.
  * ### Known values supported by the service
- * **BODY_STRUCTURE** \
- * **AGE** \
- * **GENDER** \
- * **EXAMINATION_NAME** \
- * **DATE** \
- * **DIRECTION** \
- * **FREQUENCY** \
- * **MEASUREMENT_VALUE** \
- * **MEASUREMENT_UNIT** \
- * **RELATIONAL_OPERATOR** \
- * **TIME** \
- * **GENE_OR_PROTEIN** \
- * **VARIANT** \
- * **ADMINISTRATIVE_EVENT** \
- * **CARE_ENVIRONMENT** \
- * **HEALTHCARE_PROFESSION** \
- * **DIAGNOSIS** \
- * **SYMPTOM_OR_SIGN** \
- * **CONDITION_QUALIFIER** \
- * **MEDICATION_CLASS** \
- * **MEDICATION_NAME** \
- * **DOSAGE** \
- * **MEDICATION_FORM** \
- * **MEDICATION_ROUTE** \
- * **FAMILY_RELATION** \
- * **TREATMENT_NAME**
+ * **BodyStructure** \
+ * **Age** \
+ * **Gender** \
+ * **ExaminationName** \
+ * **Date** \
+ * **Direction** \
+ * **Frequency** \
+ * **MeasurementValue** \
+ * **MeasurementUnit** \
+ * **RelationalOperator** \
+ * **Time** \
+ * **GeneOrProtein** \
+ * **Variant** \
+ * **AdministrativeEvent** \
+ * **CareEnvironment** \
+ * **HealthcareProfession** \
+ * **Diagnosis** \
+ * **SymptomOrSign** \
+ * **ConditionQualifier** \
+ * **MedicationClass** \
+ * **MedicationName** \
+ * **Dosage** \
+ * **MedicationForm** \
+ * **MedicationRoute** \
+ * **FamilyRelation** \
+ * **TreatmentName**
  */
 export declare type HealthcareEntityCategory = string;
 
@@ -775,11 +724,6 @@ export declare interface HealthcareSuccessResult extends TextAnalysisSuccessResu
      * Relations between healthcare entities.
      */
     readonly entityRelations: HealthcareEntityRelation[];
-    /**
-     * JSON bundle containing a FHIR compatible object for consumption in other
-     * Healthcare tools. For additional information see {@link https://www.hl7.org/fhir/overview.html}.
-     */
-    readonly fhirBundle?: Record<string, any>;
 }
 
 /** Options for a key phrase recognition action. */
@@ -850,23 +794,15 @@ export declare enum KnownErrorCode {
     /** InternalServerError */
     InternalServerError = "InternalServerError",
     /** ServiceUnavailable */
-    ServiceUnavailable = "ServiceUnavailable"
-}
-
-/** Known values of {@link ExtractiveSummarizationOrderingCriteria} that the service accepts. */
-export declare enum KnownExtractiveSummarizationOrderingCriteria {
-    /** Indicates that results should be sorted in order of appearance in the text. */
-    Offset = "Offset",
-    /** Indicates that results should be sorted in order of importance (i.e. rank score) according to the model. */
-    Rank = "Rank"
-}
-
-/**
- * Known values of the {@link HealthcareAction.fhirVersion} parameter.
- */
-export declare enum KnownFhirVersion {
-    /** 4.0.1 */
-    "4.0.1" = "4.0.1"
+    ServiceUnavailable = "ServiceUnavailable",
+    /** Timeout */
+    Timeout = "Timeout",
+    /** QuotaExceeded */
+    QuotaExceeded = "QuotaExceeded",
+    /** Conflict */
+    Conflict = "Conflict",
+    /** Warning */
+    Warning = "Warning"
 }
 
 /** Known values of {@link InnerErrorCode} that the service accepts. */
@@ -1298,6 +1234,10 @@ export declare const KnownTextAnalysisErrorCode: {
     AzureCognitiveSearchIndexLimitReached: KnownErrorCode.AzureCognitiveSearchIndexLimitReached;
     InternalServerError: KnownErrorCode.InternalServerError;
     ServiceUnavailable: KnownErrorCode.ServiceUnavailable;
+    Timeout: KnownErrorCode.Timeout;
+    QuotaExceeded: KnownErrorCode.QuotaExceeded;
+    Conflict: KnownErrorCode.Conflict;
+    Warning: KnownErrorCode.Warning;
 };
 
 /** Options for a language detection action. */
@@ -1365,9 +1305,6 @@ export declare interface Match {
     length: number;
 }
 
-/** Defines values for OperationStatus. */
-export declare type OperationStatus = "notStarted" | "running" | "succeeded" | "partiallySucceeded" | "failed" | "cancelled" | "cancelling";
-
 /**
  * A mined opinion object represents an opinion we've extracted from a sentence.
  * It consists of both a target that these assessments are about, and the actual
@@ -1637,6 +1574,16 @@ export declare interface PiiEntityRecognitionSuccessResult extends TextAnalysisS
     readonly redactedText: string;
 }
 
+/**
+ * Abstract representation of a poller, intended to expose just the minimal API that the user needs to work with.
+ */
+export declare interface PollerLike<TState extends OperationState<TResult>, TResult> extends SimplePollerLike<TState, TResult> {
+    /**
+     * sends a cancellation request.
+     */
+    sendCancellationRequest: () => Promise<void>;
+}
+
 /**
  * Defines values for RelationType. \
  * {@link KnownRelationType} can be used interchangeably with RelationType,
@@ -1775,8 +1722,11 @@ export declare interface SentimentAnalysisSuccessResult extends TextAnalysisSucc
 
 /** Represents the confidence scores between 0 and 1 across all sentiment classes: positive, neutral, negative. */
 export declare interface SentimentConfidenceScores {
+    /** Confidence score for positive sentiment */
     positive: number;
+    /** Confidence score for neutral sentiment */
     neutral: number;
+    /** Confidence score for negative sentiment */
     negative: number;
 }
 
@@ -1791,42 +1741,11 @@ export declare interface SentimentConfidenceScores {
  */
 export declare type StringIndexType = string;
 
-/**
- * An error result from the extractive summarization action on a single document.
- */
-export declare type SummarizationExtractionErrorResult = TextAnalysisErrorResult;
-
-/**
- * The result of the extractive summarization action on a single document.
- */
-export declare type SummarizationExtractionResult = SummarizationExtractionSuccessResult | SummarizationExtractionErrorResult;
-
-/**
- * The result of the extractive summarization action on a single document,
- * containing a collection of the summary identified in that document.
- */
-export declare interface SummarizationExtractionSuccessResult extends TextAnalysisSuccessResult {
-    /**
-     * A list of sentences composing a summary of the input document.
-     */
-    readonly sentences: SummarySentence[];
-}
-
-/** A sentence that is part of the extracted summary. */
-export declare interface SummarySentence {
-    /** The extracted sentence text. */
-    text: string;
-    /** A double value representing the relevance of the sentence within the summary. Higher values indicate higher importance. */
-    rankScore: number;
-    /** The sentence offset from the start of the document, based on the value of the parameter StringIndexType. */
-    offset: number;
-    /** The length of the sentence. */
-    length: number;
-}
-
-/** Represents the confidence scores across all sentiment classes: positive, neutral, negative. */
+/** Represents the confidence scores across all sentiment classes: positive and negative. */
 export declare interface TargetConfidenceScores {
+    /** Confidence score for positive sentiment */
     positive: number;
+    /** Confidence score for negative sentiment */
     negative: number;
 }
 
@@ -2356,7 +2275,7 @@ export declare interface TextAnalysisClientOptions extends CommonClientOptions {
     /**
      * The version of the Cognitive Language Service API to use.
      */
-    apiVersion?: string;
+    serviceVersion?: string;
 }
 
 /**
@@ -2399,10 +2318,6 @@ export declare interface TextAnalysisOperationOptions extends OperationOptions {
      * If set to true, response will contain input and document level statistics.
      */
     includeStatistics?: boolean;
-    /**
-     * The version of the Cognitive Language Service API to use.
-     */
-    apiVersion?: string;
 }
 
 /**