Skip to content

Commit

Permalink
[Text Analytics] Add links to Custom Text service docs (#18424)
Browse files Browse the repository at this point in the history
* [Text Analytics] Add links to Custom Text service docs

* address feedback
  • Loading branch information
deyaaeldeen authored Oct 29, 2021
1 parent 8316621 commit ec1462c
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 6 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
18 changes: 12 additions & 6 deletions sdk/textanalytics/ai-text-analytics/src/textAnalyticsClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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/customentityrecognition}
*/
export interface RecognizeCustomEntitiesAction extends CustomTextAnalyticsAction {
/**
Expand All @@ -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 {
/**
Expand All @@ -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 {
/**
Expand Down Expand Up @@ -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/customentityrecognition}
*/
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[];
}
Expand Down

0 comments on commit ec1462c

Please sign in to comment.