@azure/ai-text-analytics 5.2.0-alpha.20211026.2 → 5.2.0-alpha.20211103.1

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

@@ -74,6 +74,18 @@ export declare interface AnalyzeActionsResult {
      * Array of the results for each extract summary action.
      */
     extractSummaryResults: ExtractSummaryActionResult[];
+    /**
+     * Array of the results for each recognize custom entities action.
+     */
+    recognizeCustomEntitiesResults: RecognizeCustomEntitiesActionResult[];
+    /**
+     * Array of the results for each custom classify document single category action.
+     */
+    singleCategoryClassifyResults: SingleCategoryClassifyActionResult[];
+    /**
+     * Array of the results for each custom classify document multi category action.
+     */
+    multiCategoryClassifyResults: MultiCategoryClassifyActionResult[];
 }
 
 /**
@@ -290,6 +302,39 @@ export declare interface BeginAnalyzeHealthcareEntitiesOptions extends TextAnaly
 export declare interface CategorizedEntity extends Entity {
 }
 
+/**
+ * A classification result from a custom classify document single category action
+ */
+export declare interface ClassificationCategory extends ClassificationResult {
+}
+
+export declare interface ClassificationResult {
+    /** Classification type. */
+    category: string;
+    /** Confidence score between 0 and 1 of the recognized classification. */
+    confidenceScore: number;
+}
+
+/**
+ * The type of a custom text analytics action.
+ */
+export declare interface CustomTextAnalyticsAction {
+    /**
+     * The project name for the text analytics model used by this operation on this
+     * batch of input documents.
+     */
+    projectName: string;
+    /**
+     * The deployment name for the text analytics model used by this operation on this
+     * batch of input documents.
+     */
+    deploymentName: string;
+    /**
+     * The preferred name for this action.
+     */
+    actionName?: string;
+}
+
 /** Information about the language of a document as identified by the Text Analytics service. */
 export declare interface DetectedLanguage {
     /** Long name of a detected language (e.g. English, French). */
@@ -525,7 +570,7 @@ export declare interface ExtractSummaryAction extends TextAnalyticsAction {
      */
     maxSentenceCount?: number;
     /**
-     * Specifies how to sort the returned sentences. Please refer to {@link KnownSummarySentencesSortBy} for possible values.
+     * Specifies how to sort the returned sentences. Please refer to {@link KnownSummarySentencesOrderBy} for possible values.
      */
     orderBy?: string;
 }
@@ -838,6 +883,83 @@ export declare interface Match {
     length: number;
 }
 
+/**
+ * Options for a custom classify document multi categories action. For more information, please refer
+ * to the service documentation: {@link https://aka.ms/azsdk/textanalytics/customfunctionalities}
+ */
+export declare interface MultiCategoryClassifyAction extends CustomTextAnalyticsAction {
+    /**
+     * If set to true, you opt-out of having your text input logged for troubleshooting. By default, Text Analytics
+     * logs your input text for 48 hours, solely to allow for troubleshooting issues. Setting this parameter to true,
+     * disables input logging and may limit our ability to remediate issues that occur.
+     */
+    disableServiceLogs?: boolean;
+}
+
+/**
+ * The error of a custom classify document multi category action.
+ */
+export declare type MultiCategoryClassifyActionErrorResult = TextAnalyticsActionErrorResult;
+
+/**
+ * The result of a custom classify document multi category action.
+ */
+export declare type MultiCategoryClassifyActionResult = MultiCategoryClassifyActionSuccessResult | MultiCategoryClassifyActionErrorResult;
+
+/**
+ * The results of a succeeded custom classify document multi category action.
+ */
+export declare interface MultiCategoryClassifyActionSuccessResult extends TextAnalyticsActionSuccessState {
+    /**
+     * Array of the results for each custom classify document multi category action.
+     */
+    results: MultiCategoryClassifyResultArray;
+}
+
+/**
+ * An error result from the custom classify document multi category operation on a multi document.
+ */
+export declare type MultiCategoryClassifyErrorResult = TextAnalyticsErrorResult;
+
+/**
+ * The result of the custom classify document multi categories operation on a multi document.
+ */
+export declare type MultiCategoryClassifyResult = MultiCategoryClassifySuccessResult | MultiCategoryClassifyErrorResult;
+
+/**
+ * Array of `MultiCategoryClassifyResult` objects corresponding to a batch of input documents, and
+ * annotated with information about the batch operation.
+ */
+export declare interface MultiCategoryClassifyResultArray extends Array<MultiCategoryClassifyResult> {
+    /**
+     * Statistics about the input document batch and how it was processed
+     * by the service. This property will have a value when includeStatistics is set to true
+     * in the client call.
+     */
+    statistics?: TextDocumentBatchStatistics;
+    /**
+     * The version of the text analytics custom project used by this operation on this
+     * batch of input documents.
+     */
+    projectName: string;
+    /**
+     * The version of the text analytics custom deployment used by this operation on this
+     * batch of input documents.
+     */
+    deploymentName: string;
+}
+
+/**
+ * The result of the custom classify document multi categories operation on a multi document,
+ * containing the result of the classification.
+ */
+export declare interface MultiCategoryClassifySuccessResult extends TextAnalyticsSuccessResult {
+    /**
+     * The collection of classifications in the input document.
+     */
+    classifications: ClassificationCategory[];
+}
+
 /**
  * Metadata information for an analysis poller operation.
  */
@@ -1206,6 +1328,74 @@ export declare interface RecognizeCategorizedEntitiesSuccessResult extends TextA
     readonly entities: CategorizedEntity[];
 }
 
+/**
+ * Options for a custom recognize entities action. For more information, please refer
+ * to the service documentation: {@link https://aka.ms/azsdk/textanalytics/customentityrecognition}
+ */
+export declare interface RecognizeCustomEntitiesAction extends CustomTextAnalyticsAction {
+    /**
+     * Specifies the measurement unit used to calculate the offset and length properties.
+     * Possible units are "TextElements_v8", "UnicodeCodePoint", and "Utf16CodeUnit".
+     * The default is the JavaScript's default which is "Utf16CodeUnit".
+     */
+    stringIndexType?: StringIndexType;
+    /**
+     * If set to true, you opt-out of having your text input logged for troubleshooting. By default, Text Analytics
+     * logs your input text for 48 hours, solely to allow for troubleshooting issues. Setting this parameter to true,
+     * disables input logging and may limit our ability to remediate issues that occur.
+     */
+    disableServiceLogs?: boolean;
+}
+
+/**
+ * The result of a custom recognize entities action.
+ */
+export declare type RecognizeCustomEntitiesActionResult = RecongizeCustomEntitiesActionSuccessResult | RecongizeCustomEntitiesActionErrorResult;
+
+/**
+ * An error result from the recognize custom entities operation on a single document.
+ */
+export declare type RecognizeCustomEntitiesErrorResult = TextAnalyticsErrorResult;
+
+/**
+ * The result of the custom recognize entities operation on a single document.
+ */
+export declare type RecognizeCustomEntitiesResult = RecognizeCustomEntitiesSuccessResult | RecognizeCustomEntitiesErrorResult;
+
+/**
+ * Array of `CustomRecognizeEntitiesResult` objects corresponding to a batch of input documents, and
+ * annotated with information about the batch operation.
+ */
+export declare interface RecognizeCustomEntitiesResultArray extends Array<RecognizeCustomEntitiesResult> {
+    /**
+     * Statistics about the input document batch and how it was processed
+     * by the service. This property will have a value when includeStatistics is set to true
+     * in the client call.
+     */
+    statistics?: TextDocumentBatchStatistics;
+    /**
+     * The version of the text analytics custom project used by this operation on this
+     * batch of input documents.
+     */
+    projectName: string;
+    /**
+     * The version of the text analytics custom deployment used by this operation on this
+     * batch of input documents.
+     */
+    deploymentName: string;
+}
+
+/**
+ * The result of the recognize custom entities operation on a single document,
+ * containing a collection of the entities identified in that document.
+ */
+export declare interface RecognizeCustomEntitiesSuccessResult extends TextAnalyticsSuccessResult {
+    /**
+     * The collection of entities identified in the input document.
+     */
+    entities: CategorizedEntity[];
+}
+
 /**
  * Options for an entities linking action.
  */
@@ -1408,6 +1598,21 @@ export declare interface RecognizePiiEntitiesSuccessResult extends TextAnalytics
     redactedText: string;
 }
 
+/**
+ * The error of a custom recognize entities action.
+ */
+export declare type RecongizeCustomEntitiesActionErrorResult = TextAnalyticsActionErrorResult;
+
+/**
+ * The results of a succeeded custom recognize entities action.
+ */
+export declare interface RecongizeCustomEntitiesActionSuccessResult extends TextAnalyticsActionSuccessState {
+    /**
+     * Array of the results for each custom recognize entities action.
+     */
+    results: RecognizeCustomEntitiesResultArray;
+}
+
 export declare interface SentenceAssessment {
     /** Assessment sentiment in the sentence. */
     sentiment: TokenSentimentValue;
@@ -1466,6 +1671,83 @@ export declare interface SentimentConfidenceScores {
     negative: number;
 }
 
+/**
+ * Options for an custom classify document single category action. For more information, please refer
+ * to the service documentation: {@link https://aka.ms/azsdk/textanalytics/customfunctionalities}
+ */
+export declare interface SingleCategoryClassifyAction extends CustomTextAnalyticsAction {
+    /**
+     * If set to true, you opt-out of having your text input logged for troubleshooting. By default, Text Analytics
+     * logs your input text for 48 hours, solely to allow for troubleshooting issues. Setting this parameter to true,
+     * disables input logging and may limit our ability to remediate issues that occur.
+     */
+    disableServiceLogs?: boolean;
+}
+
+/**
+ * The error of a custom classify document single category action.
+ */
+export declare type SingleCategoryClassifyActionErrorResult = TextAnalyticsActionErrorResult;
+
+/**
+ * The result of a custom classify document single category action.
+ */
+export declare type SingleCategoryClassifyActionResult = SingleCategoryClassifyActionSuccessResult | SingleCategoryClassifyActionErrorResult;
+
+/**
+ * The results of a succeeded custom classify document single category action.
+ */
+export declare interface SingleCategoryClassifyActionSuccessResult extends TextAnalyticsActionSuccessState {
+    /**
+     * Array of the results for each custom classify document single category action.
+     */
+    results: SingleCategoryClassifyResultArray;
+}
+
+/**
+ * An error result from the custom classify document single category operation on a single document.
+ */
+export declare type SingleCategoryClassifyErrorResult = TextAnalyticsErrorResult;
+
+/**
+ * The result of the custom classify document single category operation on a single document.
+ */
+export declare type SingleCategoryClassifyResult = SingleCategoryClassifySuccessResult | SingleCategoryClassifyErrorResult;
+
+/**
+ * Array of `SingleCategoryClassifyResult` objects corresponding to a batch of input documents, and
+ * annotated with information about the batch operation.
+ */
+export declare interface SingleCategoryClassifyResultArray extends Array<SingleCategoryClassifyResult> {
+    /**
+     * Statistics about the input document batch and how it was processed
+     * by the service. This property will have a value when includeStatistics is set to true
+     * in the client call.
+     */
+    statistics?: TextDocumentBatchStatistics;
+    /**
+     * The version of the text analytics custom project used by this operation on this
+     * batch of input documents.
+     */
+    projectName: string;
+    /**
+     * The version of the text analytics custom deployment used by this operation on this
+     * batch of input documents.
+     */
+    deploymentName: string;
+}
+
+/**
+ * The result of the custom classify document single category operation on a single document,
+ * containing the result of the classification.
+ */
+export declare interface SingleCategoryClassifySuccessResult extends TextAnalyticsSuccessResult {
+    /**
+     * The classification result of the input document.
+     */
+    classification: ClassificationCategory;
+}
+
 /**
  * Measurement units that can used to calculate the offset and length properties.
  */
@@ -1523,7 +1805,7 @@ export declare interface TargetSentiment {
 }
 
 /**
- * The type of a text analytics action.
+ * The type of a standard text analytics action.
  */
 export declare interface TextAnalyticsAction {
     /**
@@ -1540,7 +1822,7 @@ export declare interface TextAnalyticsAction {
 /**
  * The error of an analyze batch action.
  */
-export declare interface TextAnalyticsActionErrorResult {
+export declare interface TextAnalyticsActionErrorResult extends TextAnalyticsActionState {
     /**
      * When this action was completed by the service.
      */
@@ -1552,39 +1834,64 @@ export declare interface TextAnalyticsActionErrorResult {
 }
 
 /**
- * Description of collection of actions for the analyze API to perform on input documents. However, currently, the service can accept up to one action only per action type.
+ * Description of collection of actions for the analyze API to perform on input documents.
  */
 export declare interface TextAnalyticsActions {
     /**
-     * A collection of descriptions of entities recognition actions. However, currently, the service can accept up to one action only for `recognizeEntities`.
+     * A collection of descriptions of entities recognition actions.
      */
     recognizeEntitiesActions?: RecognizeCategorizedEntitiesAction[];
     /**
-     * A collection of descriptions of Pii entities recognition actions. However, currently, the service can accept up to one action only for `recognizePiiEntities`.
+     * A collection of descriptions of Pii entities recognition actions.
      */
     recognizePiiEntitiesActions?: RecognizePiiEntitiesAction[];
     /**
-     * A collection of descriptions of key phrases recognition actions. However, currently, the service can accept up to one action only for `extractKeyPhrases`.
+     * A collection of descriptions of key phrases recognition actions.
      */
     extractKeyPhrasesActions?: ExtractKeyPhrasesAction[];
     /**
-     * A collection of descriptions of entities linking actions. However, currently, the service can accept up to one action only for `recognizeLinkedEntities`.
+     * A collection of descriptions of entities linking actions.
      */
     recognizeLinkedEntitiesActions?: RecognizeLinkedEntitiesAction[];
     /**
-     * A collection of descriptions of sentiment analysis actions. However, currently, the service can accept up to one action only for `analyzeSentiment`.
+     * A collection of descriptions of sentiment analysis actions.
      */
     analyzeSentimentActions?: AnalyzeSentimentAction[];
     /**
-     * A collection of descriptions of summarization extraction actions. However, currently, the service can accept up to one action only for `extractSummary`.
+     * A collection of descriptions of summarization extraction actions.
      */
     extractSummaryActions?: ExtractSummaryAction[];
+    /**
+     * A collection of descriptions of custom entity recognition actions. For more information, please refer
+     * to the service documentation: {@link https://aka.ms/azsdk/textanalytics/customentityrecognition}
+     */
+    recognizeCustomEntitiesActions?: RecognizeCustomEntitiesAction[];
+    /**
+     * A collection of descriptions of custom single classification actions. For more information, please refer
+     * to the service documentation: {@link https://aka.ms/azsdk/textanalytics/customfunctionalities}
+     */
+    singleCategoryClassifyActions?: SingleCategoryClassifyAction[];
+    /**
+     * A collection of descriptions of custom multi classification actions. For more information, please refer
+     * to the service documentation: {@link https://aka.ms/azsdk/textanalytics/customfunctionalities}
+     */
+    multiCategoryClassifyActions?: MultiCategoryClassifyAction[];
+}
+
+/**
+ * The state of an action
+ */
+export declare interface TextAnalyticsActionState {
+    /**
+     * The name of the action.
+     */
+    actionName?: string;
 }
 
 /**
  * The state of a succeeded action.
  */
-export declare interface TextAnalyticsActionSuccessState {
+export declare interface TextAnalyticsActionSuccessState extends TextAnalyticsActionState {
     /**
      * When this action was completed by the service.
      */