Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Text Analytics] Add links to Custom Text service docs #18424

Merged
merged 2 commits into from
Oct 29, 2021
Merged

[Text Analytics] Add links to Custom Text service docs #18424

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6d237cf
[Text Analytics] Add links to Custom Text service docs
deyaaeldeen Oct 28, 2021
e224705
address feedback
deyaaeldeen Oct 29, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions sdk/textanalytics/ai-text-analytics/samples-dev/customText.ts
View file
Open in desktop
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
3 changes: 2 additions & 1 deletion sdk/textanalytics/ai-text-analytics/src/textAnalyticsAction.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
/**
Expand Down
18 changes: 12 additions & 6 deletions sdk/textanalytics/ai-text-analytics/src/textAnalyticsClient.ts
View file
Open in desktop
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/customfunctionalities}
deyaaeldeen marked this conversation as resolved.
Show resolved Hide resolved
*/
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/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[];
}
Expand Down