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

Jump to bottom

[Text Analytics] Does not ignore ts-naming options #11506

Closed
wants to merge 3 commits into from
Closed

[Text Analytics] Does not ignore ts-naming options #11506

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1cd61d3
[Text Analytics] Does not ignore ts-naming options
deyaaeldeen Sep 25, 2020
73a1dff
rename instead of addition
deyaaeldeen Sep 25, 2020
ff79da8
update review
deyaaeldeen Sep 25, 2020
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
10 changes: 5 additions & 5 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 @@ -176,9 +176,6 @@ export enum PiiEntityDomainType {
// @public
export type RecognizeCategorizedEntitiesErrorResult = TextAnalyticsErrorResult;

// @public
export type RecognizeCategorizedEntitiesOptions = TextAnalyticsOperationOptions;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removing the type would be breaking change. Someone might be using this type in their code and after updating to the latest, their code will fail to build

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ah right, I am not too bothered by it so will close for now.


// @public
export type RecognizeCategorizedEntitiesResult = RecognizeCategorizedEntitiesSuccessResult | RecognizeCategorizedEntitiesErrorResult;

Expand All @@ -193,6 +190,9 @@ export interface RecognizeCategorizedEntitiesSuccessResult extends TextAnalytics
readonly entities: CategorizedEntity[];
}

// @public
export type RecognizeEntitiesOptions = TextAnalyticsOperationOptions;

// @public
export type RecognizeLinkedEntitiesErrorResult = TextAnalyticsErrorResult;

Expand Down Expand Up @@ -281,8 +281,8 @@ export class TextAnalyticsClient {
readonly endpointUrl: string;
extractKeyPhrases(documents: string[], language?: string, options?: ExtractKeyPhrasesOptions): Promise<ExtractKeyPhrasesResultArray>;
extractKeyPhrases(documents: TextDocumentInput[], options?: ExtractKeyPhrasesOptions): Promise<ExtractKeyPhrasesResultArray>;
recognizeEntities(documents: string[], language?: string, options?: RecognizeCategorizedEntitiesOptions): Promise<RecognizeCategorizedEntitiesResultArray>;
recognizeEntities(documents: TextDocumentInput[], options?: RecognizeCategorizedEntitiesOptions): Promise<RecognizeCategorizedEntitiesResultArray>;
recognizeEntities(documents: string[], language?: string, options?: RecognizeEntitiesOptions): Promise<RecognizeCategorizedEntitiesResultArray>;
recognizeEntities(documents: TextDocumentInput[], options?: RecognizeEntitiesOptions): Promise<RecognizeCategorizedEntitiesResultArray>;
recognizeLinkedEntities(documents: string[], language?: string, options?: RecognizeLinkedEntitiesOptions): Promise<RecognizeLinkedEntitiesResultArray>;
recognizeLinkedEntities(documents: TextDocumentInput[], options?: RecognizeLinkedEntitiesOptions): Promise<RecognizeLinkedEntitiesResultArray>;
recognizePiiEntities(inputs: string[], language?: string, options?: RecognizePiiEntitiesOptions): Promise<RecognizePiiEntitiesResultArray>;
Expand Down
2 changes: 1 addition & 1 deletion sdk/textanalytics/ai-text-analytics/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ export {
TextAnalyticsClient,
TextAnalyticsClientOptions,
DetectLanguageOptions,
RecognizeCategorizedEntitiesOptions,
RecognizeEntitiesOptions,
AnalyzeSentimentOptions,
ExtractKeyPhrasesOptions,
RecognizePiiEntitiesOptions,
Expand Down
17 changes: 7 additions & 10 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 @@ -92,7 +92,7 @@ export type DetectLanguageOptions = TextAnalyticsOperationOptions;
/**
* Options for the recognize entities operation.
*/
export type RecognizeCategorizedEntitiesOptions = TextAnalyticsOperationOptions;
export type RecognizeEntitiesOptions = TextAnalyticsOperationOptions;

/**
* Options for the analyze sentiment operation.
Expand Down Expand Up @@ -331,8 +331,7 @@ export class TextAnalyticsClient {
public async recognizeEntities(
documents: string[],
language?: string,
// eslint-disable-next-line @azure/azure-sdk/ts-naming-options
options?: RecognizeCategorizedEntitiesOptions
options?: RecognizeEntitiesOptions
): Promise<RecognizeCategorizedEntitiesResultArray>;
/**
* Runs a predictive model to identify a collection of named entities
Expand All @@ -347,16 +346,14 @@ export class TextAnalyticsClient {
*/
public async recognizeEntities(
documents: TextDocumentInput[],
// eslint-disable-next-line @azure/azure-sdk/ts-naming-options
options?: RecognizeCategorizedEntitiesOptions
options?: RecognizeEntitiesOptions
): Promise<RecognizeCategorizedEntitiesResultArray>;
public async recognizeEntities(
documents: string[] | TextDocumentInput[],
languageOrOptions?: string | RecognizeCategorizedEntitiesOptions,
// eslint-disable-next-line @azure/azure-sdk/ts-naming-options
options?: RecognizeCategorizedEntitiesOptions
languageOrOptions?: string | RecognizeEntitiesOptions,
options?: RecognizeEntitiesOptions
): Promise<RecognizeCategorizedEntitiesResultArray> {
let realOptions: RecognizeCategorizedEntitiesOptions;
let realOptions: RecognizeEntitiesOptions;
let realInputs: TextDocumentInput[];

if (!Array.isArray(documents) || documents.length === 0) {
Expand All @@ -369,7 +366,7 @@ export class TextAnalyticsClient {
realOptions = options || {};
} else {
realInputs = documents;
realOptions = (languageOrOptions as RecognizeCategorizedEntitiesOptions) || {};
realOptions = (languageOrOptions as RecognizeEntitiesOptions) || {};
}

const { span, updatedOptions: finalOptions } = createSpan(
Expand Down