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] address archboard feedback #18131

Merged
merged 2 commits into from
Oct 11, 2021
+196 −204
Merged

[Text Analytics] address archboard feedback #18131

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0296859
address archboard feedback
deyaaeldeen Oct 11, 2021
3281ec8
Update sdk/textanalytics/ai-text-analytics/src/multiCategoryClassifyR…
deyaaeldeen Oct 11, 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
2 changes: 1 addition & 1 deletion sdk/textanalytics/ai-text-analytics/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
152 changes: 76 additions & 76 deletions sdk/textanalytics/ai-text-analytics/review/ai-text-analytics.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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;
Expand Down Expand Up @@ -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";

Expand Down Expand Up @@ -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;
Expand Down Expand Up @@ -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";

Expand Down Expand Up @@ -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
Expand Down
Loading