[Text Analytics] address archboard feedback (#18131)

* address archboard feedback * Update sdk/textanalytics/ai-text-analytics/src/multiCategoryClassifyResult.ts Co-authored-by: Krista Pratico <[email protected]> Co-authored-by: Krista Pratico <[email protected]>
Azure · Oct 11, 2021 · 84bdc62 · 84bdc62
1 parent 2f4a95c
commit 84bdc62
Show file tree

Hide file tree

Showing 10 changed files with 196 additions and 204 deletions.
diff --git a/sdk/textanalytics/ai-text-analytics/CHANGELOG.md b/sdk/textanalytics/ai-text-analytics/CHANGELOG.md
@@ -5,7 +5,7 @@
 ### Features Added
 
 - We are now targeting the service's v3.2-preview.2 API as the default instead of v3.2-preview.1.
-- Adding support for a three new actions in `beginAnalyzeActions`: `recognizeCustomEntities`, `classifyDocumentSingleCategory`, and `classifyDocumentMultiCategories`. The new actions allow you to use custom models to perform entity recognition and classification actions.
+- Adding support for a three new actions in `beginAnalyzeActions`: `recognizeCustomEntities`, `singleCategoryClassify`, and `multiCategoryClassify`. The new actions allow you to use custom models to perform entity recognition and classification actions.
 
 ### Breaking Changes
 

diff --git a/sdk/textanalytics/ai-text-analytics/review/ai-text-analytics.api.md b/sdk/textanalytics/ai-text-analytics/review/ai-text-analytics.api.md
@@ -35,14 +35,14 @@ export type AnalyzeActionsPollerLike = PollerLike<AnalyzeActionsOperationState,
 // @public
 export interface AnalyzeActionsResult {
     analyzeSentimentResults: AnalyzeSentimentActionResult[];
-    classifyDocumentMultiCategoriesResults: ClassifyDocumentMultiCategoriesActionResult[];
-    classifyDocumentSingleCategoryResults: ClassifyDocumentSingleCategoryActionResult[];
     extractKeyPhrasesResults: ExtractKeyPhrasesActionResult[];
     extractSummaryResults: ExtractSummaryActionResult[];
+    multiCategoryClassifyResults: MultiCategoryClassifyActionResult[];
     recognizeCustomEntitiesResults: RecognizeCustomEntitiesActionResult[];
     recognizeEntitiesResults: RecognizeCategorizedEntitiesActionResult[];
     recognizeLinkedEntitiesResults: RecognizeLinkedEntitiesActionResult[];
     recognizePiiEntitiesResults: RecognizePiiEntitiesActionResult[];
+    singleCategoryClassifyResults: SingleCategoryClassifyActionResult[];
 }
 
 // @public
@@ -136,80 +136,16 @@ export interface BeginAnalyzeHealthcareEntitiesOptions extends TextAnalyticsOper
 export interface CategorizedEntity extends Entity {
 }
 
+// @public
+export interface ClassificationCategory extends ClassificationResult {
+}
+
 // @public (undocumented)
 export interface ClassificationResult {
     category: string;
     confidenceScore: number;
 }
 
-// @public
-export interface ClassifyDocumentMultiCategoriesAction extends CustomTextAnalyticsAction {
-    disableServiceLogs?: boolean;
-}
-
-// @public
-export type ClassifyDocumentMultiCategoriesActionErrorResult = TextAnalyticsActionErrorResult;
-
-// @public
-export type ClassifyDocumentMultiCategoriesActionResult = ClassifyDocumentMultiCategoriesActionSuccessResult | ClassifyDocumentMultiCategoriesActionErrorResult;
-
-// @public
-export interface ClassifyDocumentMultiCategoriesActionSuccessResult extends TextAnalyticsActionSuccessState {
-    results: ClassifyDocumentMultiCategoriesResultArray;
-}
-
-// @public
-export type ClassifyDocumentMultiCategoriesErrorResult = TextAnalyticsErrorResult;
-
-// @public
-export type ClassifyDocumentMultiCategoriesResult = ClassifyDocumentMultiCategoriesSuccessResult | ClassifyDocumentMultiCategoriesErrorResult;
-
-// @public
-export interface ClassifyDocumentMultiCategoriesResultArray extends Array<ClassifyDocumentMultiCategoriesResult> {
-    deploymentName: string;
-    projectName: string;
-    statistics?: TextDocumentBatchStatistics;
-}
-
-// @public
-export interface ClassifyDocumentMultiCategoriesSuccessResult extends TextAnalyticsSuccessResult {
-    classifications: DocumentClassification[];
-}
-
-// @public
-export interface ClassifyDocumentSingleCategoryAction extends CustomTextAnalyticsAction {
-    disableServiceLogs?: boolean;
-}
-
-// @public
-export type ClassifyDocumentSingleCategoryActionErrorResult = TextAnalyticsActionErrorResult;
-
-// @public
-export type ClassifyDocumentSingleCategoryActionResult = ClassifyDocumentSingleCategoryActionSuccessResult | ClassifyDocumentSingleCategoryActionErrorResult;
-
-// @public
-export interface ClassifyDocumentSingleCategoryActionSuccessResult extends TextAnalyticsActionSuccessState {
-    results: ClassifyDocumentSingleCategoryResultArray;
-}
-
-// @public
-export type ClassifyDocumentSingleCategoryErrorResult = TextAnalyticsErrorResult;
-
-// @public
-export type ClassifyDocumentSingleCategoryResult = ClassifyDocumentSingleCategorySuccessResult | ClassifyDocumentSingleCategoryErrorResult;
-
-// @public
-export interface ClassifyDocumentSingleCategoryResultArray extends Array<ClassifyDocumentSingleCategoryResult> {
-    deploymentName: string;
-    projectName: string;
-    statistics?: TextDocumentBatchStatistics;
-}
-
-// @public
-export interface ClassifyDocumentSingleCategorySuccessResult extends TextAnalyticsSuccessResult {
-    classification: DocumentClassification;
-}
-
 // @public
 export interface CustomTextAnalyticsAction {
     actionName?: string;
@@ -254,10 +190,6 @@ export interface DetectLanguageSuccessResult extends TextAnalyticsSuccessResult
     readonly primaryLanguage: DetectedLanguage;
 }
 
-// @public
-export interface DocumentClassification extends ClassificationResult {
-}
-
 // @public
 export type DocumentSentimentLabel = "positive" | "neutral" | "negative" | "mixed";
 
@@ -512,6 +444,40 @@ export interface Match {
     text: string;
 }
 
+// @public
+export interface MultiCategoryClassifyAction extends CustomTextAnalyticsAction {
+    disableServiceLogs?: boolean;
+}
+
+// @public
+export type MultiCategoryClassifyActionErrorResult = TextAnalyticsActionErrorResult;
+
+// @public
+export type MultiCategoryClassifyActionResult = MultiCategoryClassifyActionSuccessResult | MultiCategoryClassifyActionErrorResult;
+
+// @public
+export interface MultiCategoryClassifyActionSuccessResult extends TextAnalyticsActionSuccessState {
+    results: MultiCategoryClassifyResultArray;
+}
+
+// @public
+export type MultiCategoryClassifyErrorResult = TextAnalyticsErrorResult;
+
+// @public
+export type MultiCategoryClassifyResult = MultiCategoryClassifySuccessResult | MultiCategoryClassifyErrorResult;
+
+// @public
+export interface MultiCategoryClassifyResultArray extends Array<MultiCategoryClassifyResult> {
+    deploymentName: string;
+    projectName: string;
+    statistics?: TextDocumentBatchStatistics;
+}
+
+// @public
+export interface MultiCategoryClassifySuccessResult extends TextAnalyticsSuccessResult {
+    classifications: ClassificationCategory[];
+}
+
 // @public
 export interface OperationMetadata {
     createdOn: Date;
@@ -746,6 +712,40 @@ export interface SentimentConfidenceScores {
     positive: number;
 }
 
+// @public
+export interface SingleCategoryClassifyAction extends CustomTextAnalyticsAction {
+    disableServiceLogs?: boolean;
+}
+
+// @public
+export type SingleCategoryClassifyActionErrorResult = TextAnalyticsActionErrorResult;
+
+// @public
+export type SingleCategoryClassifyActionResult = SingleCategoryClassifyActionSuccessResult | SingleCategoryClassifyActionErrorResult;
+
+// @public
+export interface SingleCategoryClassifyActionSuccessResult extends TextAnalyticsActionSuccessState {
+    results: SingleCategoryClassifyResultArray;
+}
+
+// @public
+export type SingleCategoryClassifyErrorResult = TextAnalyticsErrorResult;
+
+// @public
+export type SingleCategoryClassifyResult = SingleCategoryClassifySuccessResult | SingleCategoryClassifyErrorResult;
+
+// @public
+export interface SingleCategoryClassifyResultArray extends Array<SingleCategoryClassifyResult> {
+    deploymentName: string;
+    projectName: string;
+    statistics?: TextDocumentBatchStatistics;
+}
+
+// @public
+export interface SingleCategoryClassifySuccessResult extends TextAnalyticsSuccessResult {
+    classification: ClassificationCategory;
+}
+
 // @public
 export type StringIndexType = "TextElement_v8" | "UnicodeCodePoint" | "Utf16CodeUnit";
 
@@ -789,14 +789,14 @@ export interface TextAnalyticsActionErrorResult {
 // @public
 export interface TextAnalyticsActions {
     analyzeSentimentActions?: AnalyzeSentimentAction[];
-    classifyDocumentMultiCategoriesActions?: ClassifyDocumentMultiCategoriesAction[];
-    classifyDocumentSingleCategoryActions?: ClassifyDocumentSingleCategoryAction[];
     extractKeyPhrasesActions?: ExtractKeyPhrasesAction[];
     extractSummaryActions?: ExtractSummaryAction[];
+    multiCategoryClassifyActions?: MultiCategoryClassifyAction[];
     recognizeCustomEntitiesActions?: RecognizeCustomEntitiesAction[];
     recognizeEntitiesActions?: RecognizeCategorizedEntitiesAction[];
     recognizeLinkedEntitiesActions?: RecognizeLinkedEntitiesAction[];
     recognizePiiEntitiesActions?: RecognizePiiEntitiesAction[];
+    singleCategoryClassifyActions?: SingleCategoryClassifyAction[];
 }
 
 // @public