Skip to content

[Text Analytics] Refine proposed API View #17794

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

Merged
deyaaeldeen merged 2 commits into from
Sep 22, 2021
Merged

[Text Analytics] Refine proposed API View #17794

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
2d74af2
[Text Analytics] Refine proposed API View
deyaaeldeen Sep 22, 2021
bfd563f
update changelog
deyaaeldeen Sep 22, 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`: `customRecognizeEntities`, `customClassifyDocumentSingleCategory`, and `customClassifyDocumentMultiCategories`. 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`, `classifyDocumentSingleCategory`, and `classifyDocumentMultiCategories`. The new actions allow you to use custom models to perform entity recognition and classification actions.

### Breaking Changes

Expand Down
118 changes: 59 additions & 59 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,11 +35,11 @@ export type AnalyzeActionsPollerLike = PollerLike<AnalyzeActionsOperationState,
// @public
export interface AnalyzeActionsResult {
analyzeSentimentResults: AnalyzeSentimentActionResult[];
customClassifyDocumentMultiCategoriesResults: CustomClassifyDocumentMultiCategoriesActionResult[];
customClassifyDocumentSingleCategoryResults: CustomClassifyDocumentSingleCategoryActionResult[];
customRecognizeEntitiesResults: CustomRecognizeEntitiesActionResult[];
classifyDocumentMultiCategoriesResults: ClassifyDocumentMultiCategoriesActionResult[];
classifyDocumentSingleCategoryResults: ClassifyDocumentSingleCategoryActionResult[];
extractKeyPhrasesResults: ExtractKeyPhrasesActionResult[];
extractSummaryResults: ExtractSummaryActionResult[];
recognizeCustomEntitiesResults: RecognizeCustomEntitiesActionResult[];
recognizeEntitiesResults: RecognizeCategorizedEntitiesActionResult[];
recognizeLinkedEntitiesResults: RecognizeLinkedEntitiesActionResult[];
recognizePiiEntitiesResults: RecognizePiiEntitiesActionResult[];
Expand Down Expand Up @@ -143,108 +143,73 @@ export interface ClassificationResult {
}

// @public
export interface CustomClassifyDocumentMultiCategoriesAction extends CustomTextAnalyticsAction {
export interface ClassifyDocumentMultiCategoriesAction extends CustomTextAnalyticsAction {
disableServiceLogs?: boolean;
}

// @public
export type CustomClassifyDocumentMultiCategoriesActionErrorResult = TextAnalyticsActionErrorResult;
export type ClassifyDocumentMultiCategoriesActionErrorResult = TextAnalyticsActionErrorResult;

// @public
export type CustomClassifyDocumentMultiCategoriesActionResult = CustomClassifyDocumentMultiCategoriesActionSuccessResult | CustomClassifyDocumentMultiCategoriesActionErrorResult;
export type ClassifyDocumentMultiCategoriesActionResult = ClassifyDocumentMultiCategoriesActionSuccessResult | ClassifyDocumentMultiCategoriesActionErrorResult;

// @public
export interface CustomClassifyDocumentMultiCategoriesActionSuccessResult extends TextAnalyticsActionSuccessState {
results: CustomClassifyDocumentMultiCategoriesResultArray;
export interface ClassifyDocumentMultiCategoriesActionSuccessResult extends TextAnalyticsActionSuccessState {
results: ClassifyDocumentMultiCategoriesResultArray;
}

// @public
export type CustomClassifyDocumentMultiCategoriesErrorResult = TextAnalyticsErrorResult;
export type ClassifyDocumentMultiCategoriesErrorResult = TextAnalyticsErrorResult;

// @public
export type CustomClassifyDocumentMultiCategoriesResult = CustomClassifyDocumentMultiCategoriesSuccessResult | CustomClassifyDocumentMultiCategoriesErrorResult;
export type ClassifyDocumentMultiCategoriesResult = ClassifyDocumentMultiCategoriesSuccessResult | ClassifyDocumentMultiCategoriesErrorResult;

// @public
export interface CustomClassifyDocumentMultiCategoriesResultArray extends Array<CustomClassifyDocumentMultiCategoriesResult> {
export interface ClassifyDocumentMultiCategoriesResultArray extends Array<ClassifyDocumentMultiCategoriesResult> {
deploymentName: string;
projectName: string;
statistics?: TextDocumentBatchStatistics;
}

// @public
export interface CustomClassifyDocumentMultiCategoriesSuccessResult extends TextAnalyticsSuccessResult {
export interface ClassifyDocumentMultiCategoriesSuccessResult extends TextAnalyticsSuccessResult {
classifications: DocumentClassification[];
}

// @public
export interface CustomClassifyDocumentSingleCategoryAction extends CustomTextAnalyticsAction {
export interface ClassifyDocumentSingleCategoryAction extends CustomTextAnalyticsAction {
disableServiceLogs?: boolean;
}

// @public
export type CustomClassifyDocumentSingleCategoryActionErrorResult = TextAnalyticsActionErrorResult;
export type ClassifyDocumentSingleCategoryActionErrorResult = TextAnalyticsActionErrorResult;

// @public
export type CustomClassifyDocumentSingleCategoryActionResult = CustomClassifyDocumentSingleCategoryActionSuccessResult | CustomClassifyDocumentSingleCategoryActionErrorResult;
export type ClassifyDocumentSingleCategoryActionResult = ClassifyDocumentSingleCategoryActionSuccessResult | ClassifyDocumentSingleCategoryActionErrorResult;

// @public
export interface CustomClassifyDocumentSingleCategoryActionSuccessResult extends TextAnalyticsActionSuccessState {
results: CustomClassifyDocumentSingleCategoryResultArray;
export interface ClassifyDocumentSingleCategoryActionSuccessResult extends TextAnalyticsActionSuccessState {
results: ClassifyDocumentSingleCategoryResultArray;
}

// @public
export type CustomClassifyDocumentSingleCategoryErrorResult = TextAnalyticsErrorResult;
export type ClassifyDocumentSingleCategoryErrorResult = TextAnalyticsErrorResult;

// @public
export type CustomClassifyDocumentSingleCategoryResult = CustomClassifyDocumentSingleCategorySuccessResult | CustomClassifyDocumentSingleCategoryErrorResult;
export type ClassifyDocumentSingleCategoryResult = ClassifyDocumentSingleCategorySuccessResult | ClassifyDocumentSingleCategoryErrorResult;

// @public
export interface CustomClassifyDocumentSingleCategoryResultArray extends Array<CustomClassifyDocumentSingleCategoryResult> {
export interface ClassifyDocumentSingleCategoryResultArray extends Array<ClassifyDocumentSingleCategoryResult> {
deploymentName: string;
projectName: string;
statistics?: TextDocumentBatchStatistics;
}

// @public
export interface CustomClassifyDocumentSingleCategorySuccessResult extends TextAnalyticsSuccessResult {
export interface ClassifyDocumentSingleCategorySuccessResult extends TextAnalyticsSuccessResult {
classification: DocumentClassification;
}

// @public
export interface CustomRecognizeEntitiesAction extends CustomTextAnalyticsAction {
disableServiceLogs?: boolean;
stringIndexType?: StringIndexType;
}

// @public
export type CustomRecognizeEntitiesActionResult = CustomRecongizeEntitiesActionSuccessResult | CustomRecongizeEntitiesActionErrorResult;

// @public
export type CustomRecognizeEntitiesErrorResult = TextAnalyticsErrorResult;

// @public
export type CustomRecognizeEntitiesResult = CustomRecognizeEntitiesSuccessResult | CustomRecognizeEntitiesErrorResult;

// @public
export interface CustomRecognizeEntitiesResultArray extends Array<CustomRecognizeEntitiesResult> {
deploymentName: string;
projectName: string;
statistics?: TextDocumentBatchStatistics;
}

// @public
export interface CustomRecognizeEntitiesSuccessResult extends TextAnalyticsSuccessResult {
entities: CategorizedEntity[];
}

// @public
export type CustomRecongizeEntitiesActionErrorResult = TextAnalyticsActionErrorResult;

// @public
export interface CustomRecongizeEntitiesActionSuccessResult extends TextAnalyticsActionSuccessState {
results: CustomRecognizeEntitiesResultArray;
}

// @public
export interface CustomTextAnalyticsAction {
actionName?: string;
Expand Down Expand Up @@ -630,6 +595,33 @@ export interface RecognizeCategorizedEntitiesSuccessResult extends TextAnalytics
readonly entities: CategorizedEntity[];
}

// @public
export interface RecognizeCustomEntitiesAction extends CustomTextAnalyticsAction {
disableServiceLogs?: boolean;
stringIndexType?: StringIndexType;
}

// @public
export type RecognizeCustomEntitiesActionResult = RecongizeCustomEntitiesActionSuccessResult | RecongizeCustomEntitiesActionErrorResult;

// @public
export type RecognizeCustomEntitiesErrorResult = TextAnalyticsErrorResult;

// @public
export type RecognizeCustomEntitiesResult = RecognizeCustomEntitiesSuccessResult | RecognizeCustomEntitiesErrorResult;

// @public
export interface RecognizeCustomEntitiesResultArray extends Array<RecognizeCustomEntitiesResult> {
deploymentName: string;
projectName: string;
statistics?: TextDocumentBatchStatistics;
}

// @public
export interface RecognizeCustomEntitiesSuccessResult extends TextAnalyticsSuccessResult {
entities: CategorizedEntity[];
}

// @public
export interface RecognizeLinkedEntitiesAction extends TextAnalyticsAction {
disableServiceLogs?: boolean;
Expand Down Expand Up @@ -713,6 +705,14 @@ export interface RecognizePiiEntitiesSuccessResult extends TextAnalyticsSuccessR
redactedText: string;
}

// @public
export type RecongizeCustomEntitiesActionErrorResult = TextAnalyticsActionErrorResult;

// @public
export interface RecongizeCustomEntitiesActionSuccessResult extends TextAnalyticsActionSuccessState {
results: RecognizeCustomEntitiesResultArray;
}

// @public (undocumented)
export interface SentenceAssessment {
confidenceScores: TargetConfidenceScoreLabel;
Expand Down Expand Up @@ -789,11 +789,11 @@ export interface TextAnalyticsActionErrorResult {
// @public
export interface TextAnalyticsActions {
analyzeSentimentActions?: AnalyzeSentimentAction[];
customClassifyDocumentMultiCategoriesActions?: CustomClassifyDocumentMultiCategoriesAction[];
customClassifyDocumentSingleCategoryActions?: CustomClassifyDocumentSingleCategoryAction[];
customRecognizeEntitiesActions?: CustomRecognizeEntitiesAction[];
classifyDocumentMultiCategoriesActions?: ClassifyDocumentMultiCategoriesAction[];
classifyDocumentSingleCategoryActions?: ClassifyDocumentSingleCategoryAction[];
extractKeyPhrasesActions?: ExtractKeyPhrasesAction[];
extractSummaryActions?: ExtractSummaryAction[];
recognizeCustomEntitiesActions?: RecognizeCustomEntitiesAction[];
recognizeEntitiesActions?: RecognizeCategorizedEntitiesAction[];
recognizeLinkedEntitiesActions?: RecognizeLinkedEntitiesAction[];
recognizePiiEntitiesActions?: RecognizePiiEntitiesAction[];
Expand Down
Loading