From 6d237cf36e75181400cb08e7f5dcdf70d8bfc4dd Mon Sep 17 00:00:00 2001 From: Deyaaeldeen Almahallawi Date: Thu, 28 Oct 2021 15:11:14 -0700 Subject: [PATCH 1/2] [Text Analytics] Add links to Custom Text service docs --- .../samples-dev/customText.ts | 1 + .../src/textAnalyticsAction.ts | 3 ++- .../src/textAnalyticsClient.ts | 18 ++++++++++++------ 3 files changed, 15 insertions(+), 7 deletions(-) diff --git a/sdk/textanalytics/ai-text-analytics/samples-dev/customText.ts b/sdk/textanalytics/ai-text-analytics/samples-dev/customText.ts index eef660a87b11..53d41d593c71 100644 --- a/sdk/textanalytics/ai-text-analytics/samples-dev/customText.ts +++ b/sdk/textanalytics/ai-text-analytics/samples-dev/customText.ts @@ -5,6 +5,7 @@ * This sample applies actions for customer-trained models to several documents using * a long-running operation. This functionality uses the generic analysis endpoint, * which provides a way to group several different Text Analytics actions into a single request. + * For more information, please refer to the service documentation: {@link https://aka.ms/azsdk/textanalytics/customfunctionalities} * * @summary applies multiple Custom Text Analytics actions per document * @azsdk-weight 40 diff --git a/sdk/textanalytics/ai-text-analytics/src/textAnalyticsAction.ts b/sdk/textanalytics/ai-text-analytics/src/textAnalyticsAction.ts index 7a35a2280e11..b916bd8c658b 100644 --- a/sdk/textanalytics/ai-text-analytics/src/textAnalyticsAction.ts +++ b/sdk/textanalytics/ai-text-analytics/src/textAnalyticsAction.ts @@ -17,7 +17,8 @@ export interface TextAnalyticsAction { } /** - * The type of a custom text analytics action. + * The type of a custom text analytics action. For more information, please refer + * to the service documentation: {@link https://aka.ms/azsdk/textanalytics/customfunctionalities} */ export interface CustomTextAnalyticsAction { /** diff --git a/sdk/textanalytics/ai-text-analytics/src/textAnalyticsClient.ts b/sdk/textanalytics/ai-text-analytics/src/textAnalyticsClient.ts index fe2a6db3a16b..015909c2d18f 100644 --- a/sdk/textanalytics/ai-text-analytics/src/textAnalyticsClient.ts +++ b/sdk/textanalytics/ai-text-analytics/src/textAnalyticsClient.ts @@ -338,7 +338,8 @@ export interface ExtractSummaryAction extends TextAnalyticsAction { } /** - * Options for a custom recognize entities action. + * Options for a custom recognize entities action. For more information, please refer + * to the service documentation: {@link https://aka.ms/azsdk/textanalytics/customfunctionalities} */ export interface RecognizeCustomEntitiesAction extends CustomTextAnalyticsAction { /** @@ -356,7 +357,8 @@ export interface RecognizeCustomEntitiesAction extends CustomTextAnalyticsAction } /** - * Options for an custom classify document single category action. + * 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 interface SingleCategoryClassifyAction extends CustomTextAnalyticsAction { /** @@ -368,7 +370,8 @@ export interface SingleCategoryClassifyAction extends CustomTextAnalyticsAction } /** - * Options for a custom classify document multi categories action. + * 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 interface MultiCategoryClassifyAction extends CustomTextAnalyticsAction { /** @@ -408,15 +411,18 @@ export interface TextAnalyticsActions { */ extractSummaryActions?: ExtractSummaryAction[]; /** - * A collection of descriptions of custom entity recognition actions. + * A collection of descriptions of custom entity recognition actions. For more information, please refer + * to the service documentation: {@link https://aka.ms/azsdk/textanalytics/customfunctionalities} */ recognizeCustomEntitiesActions?: RecognizeCustomEntitiesAction[]; /** - * A collection of descriptions of custom single classification actions. + * 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. + * 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[]; } From e22470557308a3b5563186b85bc73021f79fd330 Mon Sep 17 00:00:00 2001 From: Deyaaeldeen Almahallawi Date: Fri, 29 Oct 2021 12:30:28 -0700 Subject: [PATCH 2/2] address feedback --- .../ai-text-analytics/src/textAnalyticsAction.ts | 3 +-- .../ai-text-analytics/src/textAnalyticsClient.ts | 4 ++-- 2 files changed, 3 insertions(+), 4 deletions(-) diff --git a/sdk/textanalytics/ai-text-analytics/src/textAnalyticsAction.ts b/sdk/textanalytics/ai-text-analytics/src/textAnalyticsAction.ts index b916bd8c658b..7a35a2280e11 100644 --- a/sdk/textanalytics/ai-text-analytics/src/textAnalyticsAction.ts +++ b/sdk/textanalytics/ai-text-analytics/src/textAnalyticsAction.ts @@ -17,8 +17,7 @@ export interface TextAnalyticsAction { } /** - * The type of a custom text analytics action. For more information, please refer - * to the service documentation: {@link https://aka.ms/azsdk/textanalytics/customfunctionalities} + * The type of a custom text analytics action. */ export interface CustomTextAnalyticsAction { /** diff --git a/sdk/textanalytics/ai-text-analytics/src/textAnalyticsClient.ts b/sdk/textanalytics/ai-text-analytics/src/textAnalyticsClient.ts index 015909c2d18f..a37c3f6c3686 100644 --- a/sdk/textanalytics/ai-text-analytics/src/textAnalyticsClient.ts +++ b/sdk/textanalytics/ai-text-analytics/src/textAnalyticsClient.ts @@ -339,7 +339,7 @@ export interface ExtractSummaryAction extends TextAnalyticsAction { /** * Options for a custom recognize entities action. For more information, please refer - * to the service documentation: {@link https://aka.ms/azsdk/textanalytics/customfunctionalities} + * to the service documentation: {@link https://aka.ms/azsdk/textanalytics/customentityrecognition} */ export interface RecognizeCustomEntitiesAction extends CustomTextAnalyticsAction { /** @@ -412,7 +412,7 @@ export interface TextAnalyticsActions { 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/customfunctionalities} + * to the service documentation: {@link https://aka.ms/azsdk/textanalytics/customentityrecognition} */ recognizeCustomEntitiesActions?: RecognizeCustomEntitiesAction[]; /**