[language text] Remove resolution feature from entity recognition (#2…

…5765)
Azure · May 8, 2023 · 935a507 · 935a507
1 parent 1bfcf50
commit 935a507
Show file tree

Hide file tree

Showing 8 changed files with 4 additions and 484 deletions.
diff --git a/sdk/cognitivelanguage/ai-language-text/README.md b/sdk/cognitivelanguage/ai-language-text/README.md
@@ -43,7 +43,6 @@ Please see the [Migration Guide](https://github.com/azure/azure-sdk-for-js/blob/
 To get started, submit a request for access [here](https://aka.ms/applyforgatedsummarizationfeatures).
 * [Script Detection](https://github.com/azure/azure-sdk-for-js/blob/main/sdk/cognitivelanguage/ai-language-text/Samples.md#language-detection)
 * [Automatic Language Detection](https://github.com/azure/azure-sdk-for-js/blob/main/sdk/cognitivelanguage/ai-language-text/Samples.md#automatic-language-detection)
-* [Entity Resolutions](https://github.com/azure/azure-sdk-for-js/blob/main/sdk/cognitivelanguage/ai-language-text/Samples.md#entity-resolutions)
 * [Specifying healthcare document type for better FHIR results](https://github.com/azure/azure-sdk-for-js/blob/main/sdk/cognitivelanguage/ai-language-text/Samples.md#healthcare-analysis)
 
 

diff --git a/sdk/cognitivelanguage/ai-language-text/Samples.md b/sdk/cognitivelanguage/ai-language-text/Samples.md
@@ -2,9 +2,9 @@
 
 For more samples, check out the [`samples-dev` folder](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/cognitivelanguage/ai-language-text/samples-dev)
 
-### Entity Resolutions
+### Entity Recognition
 
-Recognize and categorize entities in text as people, places, organizations, dates/times, quantities, currencies, etc. The latest beta release can resolve entities to standard formats. Resolutions provide predictable formats for common quantifiable types and can normalize values to a single, well-known format.
+Recognize and categorize entities in text as people, places, organizations, dates/times, quantities, currencies, etc.
 
 The `languageCode` parameter is optional. If it is not specified, the default English model will be used.
 
@@ -23,7 +23,6 @@ async function main() {
   const actions = [
     {
       kind: "EntityRecognition",
-      modelVersion: "2022-10-01-preview",
     },
   ];
   const poller = await client.beginAnalyzeBatch(actions, documents, "en");
@@ -46,15 +45,6 @@ async function main() {
       console.log("\tRecognized Entities:");
       for (const entity of result.entities) {
         console.log(`\t- Entity "${entity.text}" of type ${entity.category}`);
-
-        if (entity.resolutions) {
-          console.log("\tRecognized Resolution:");
-          for (const resolution of entity.resolutions) {
-            const { resolutionKind, ...resolutionInfo } = resolution;
-            console.log(`\t- Resolution of type ${resolutionKind}`);
-            console.log(`\t- Resolution information ${JSON.stringify(resolutionInfo)}`);
-          }
-        }
       }
     }
   }

diff --git a/sdk/cognitivelanguage/ai-language-text/review/ai-language-text.api.md b/sdk/cognitivelanguage/ai-language-text/review/ai-language-text.api.md
@@ -65,12 +65,6 @@ export interface ActionPrebuilt extends ActionCommon {
     modelVersion?: string;
 }
 
-// @public
-export interface AgeResolution extends BaseResolution, QuantityResolution {
-    resolutionKind: "AgeResolution";
-    unit: AgeUnit;
-}
-
 // @public
 export type AgeUnit = string;
 
@@ -155,12 +149,6 @@ export type AnalyzeResult<ActionName extends AnalyzeActionName> = {
     LanguageDetection: LanguageDetectionResult[];
 }[ActionName];
 
-// @public
-export interface AreaResolution extends BaseResolution, QuantityResolution {
-    resolutionKind: "AreaResolution";
-    unit: AreaUnit;
-}
-
 // @public
 export type AreaUnit = string;
 
@@ -176,14 +164,6 @@ export interface AssessmentSentiment {
 
 export { AzureKeyCredential }
 
-// @public
-export interface BaseResolution {
-    resolutionKind: "AgeResolution" | "VolumeResolution" | "SpeedResolution" | "AreaResolution" | "LengthResolution" | "InformationResolution" | "TemperatureResolution" | "WeightResolution" | "CurrencyResolution" | "BooleanResolution" | "DateTimeResolution" | "NumberResolution" | "OrdinalResolution" | "TemporalSpanResolution" | "NumericRangeResolution";
-}
-
-// @public (undocumented)
-export type BaseResolutionUnion = BaseResolution | AgeResolution | VolumeResolution | SpeedResolution | AreaResolution | LengthResolution | InformationResolution | TemperatureResolution | WeightResolution | CurrencyResolution | BooleanResolution | DateTimeResolution | NumberResolution | OrdinalResolution | TemporalSpanResolution | NumericRangeResolution;
-
 // @public
 export interface BatchActionErrorResult<Kind extends AnalyzeBatchActionName> extends BatchActionState<Kind> {
     readonly error: TextAnalysisError;
@@ -213,26 +193,12 @@ export interface BeginAnalyzeBatchOptions extends TextAnalysisOperationOptions {
     updateIntervalInMs?: number;
 }
 
-// @public
-export interface BooleanResolution extends BaseResolution {
-    resolutionKind: "BooleanResolution";
-    // (undocumented)
-    value: boolean;
-}
-
 // @public
 export interface ClassificationCategory {
     category: string;
     confidenceScore: number;
 }
 
-// @public
-export interface CurrencyResolution extends BaseResolution, QuantityResolution {
-    iso4217?: string;
-    resolutionKind: "CurrencyResolution";
-    unit: string;
-}
-
 // @public
 export interface CustomActionMetadata {
     readonly deploymentName: string;
@@ -309,15 +275,6 @@ export interface CustomSingleLabelClassificationSuccessResult extends TextAnalys
     readonly classifications: ClassificationCategory[];
 }
 
-// @public
-export interface DateTimeResolution extends BaseResolution {
-    dateTimeSubKind: DateTimeSubKind;
-    modifier?: TemporalModifier;
-    resolutionKind: "DateTimeResolution";
-    timex: string;
-    value: string;
-}
-
 // @public
 export type DateTimeSubKind = string;
 
@@ -413,12 +370,7 @@ export type EntityRecognitionResult = EntityRecognitionSuccessResult | EntityRec
 
 // @public
 export interface EntityRecognitionSuccessResult extends TextAnalysisSuccessResult {
-    readonly entities: EntityWithResolution[];
-}
-
-// @public
-export interface EntityWithResolution extends Entity {
-    resolutions?: BaseResolutionUnion[];
+    readonly entities: Entity[];
 }
 
 // @public
@@ -518,12 +470,6 @@ export interface HealthcareSuccessResult extends TextAnalysisSuccessResult {
     readonly fhirBundle?: Record<string, any>;
 }
 
-// @public
-export interface InformationResolution extends BaseResolution, QuantityResolution {
-    resolutionKind: "InformationResolution";
-    unit: InformationUnit;
-}
-
 // @public
 export type InformationUnit = string;
 
@@ -956,25 +902,6 @@ export enum KnownRelativeTo {
     Start = "Start"
 }
 
-// @public
-export enum KnownResolutionKind {
-    AgeResolution = "AgeResolution",
-    AreaResolution = "AreaResolution",
-    BooleanResolution = "BooleanResolution",
-    CurrencyResolution = "CurrencyResolution",
-    DateTimeResolution = "DateTimeResolution",
-    InformationResolution = "InformationResolution",
-    LengthResolution = "LengthResolution",
-    NumberResolution = "NumberResolution",
-    NumericRangeResolution = "NumericRangeResolution",
-    OrdinalResolution = "OrdinalResolution",
-    SpeedResolution = "SpeedResolution",
-    TemperatureResolution = "TemperatureResolution",
-    TemporalSpanResolution = "TemporalSpanResolution",
-    VolumeResolution = "VolumeResolution",
-    WeightResolution = "WeightResolution"
-}
-
 // @public
 export enum KnownScriptKind {
     Latin = "Latin"
@@ -1143,12 +1070,6 @@ export interface LanguageDetectionSuccessResult extends TextAnalysisSuccessResul
     readonly primaryLanguage: DetectedLanguage;
 }
 
-// @public
-export interface LengthResolution extends BaseResolution, QuantityResolution {
-    resolutionKind: "LengthResolution";
-    unit: LengthUnit;
-}
-
 // @public
 export type LengthUnit = string;
 
@@ -1174,35 +1095,12 @@ export interface Match {
 // @public
 export type NumberKind = string;
 
-// @public
-export interface NumberResolution extends BaseResolution {
-    numberKind: NumberKind;
-    resolutionKind: "NumberResolution";
-    value: number;
-}
-
-// @public
-export interface NumericRangeResolution extends BaseResolution {
-    maximum: number;
-    minimum: number;
-    rangeKind: RangeKind;
-    resolutionKind: "NumericRangeResolution";
-}
-
 // @public
 export interface Opinion {
     readonly assessments: AssessmentSentiment[];
     readonly target: TargetSentiment;
 }
 
-// @public
-export interface OrdinalResolution extends BaseResolution {
-    offset: string;
-    relativeTo: RelativeTo;
-    resolutionKind: "OrdinalResolution";
-    value: string;
-}
-
 // @public
 export type PagedAnalyzeBatchResult = PagedAsyncIterableIterator<AnalyzeBatchResult>;
 
@@ -1244,11 +1142,6 @@ export interface PollerLike<TState extends OperationState<TResult>, TResult> ext
     sendCancellationRequest: () => Promise<void>;
 }
 
-// @public
-export interface QuantityResolution {
-    value: number;
-}
-
 // @public
 export type RangeKind = string;
 
@@ -1313,12 +1206,6 @@ export interface SentimentConfidenceScores {
     positive: number;
 }
 
-// @public
-export interface SpeedResolution extends BaseResolution, QuantityResolution {
-    resolutionKind: "SpeedResolution";
-    unit: SpeedUnit;
-}
-
 // @public
 export type SpeedUnit = string;
 
@@ -1354,28 +1241,12 @@ export interface TargetSentiment {
     readonly text: string;
 }
 
-// @public
-export interface TemperatureResolution extends BaseResolution, QuantityResolution {
-    resolutionKind: "TemperatureResolution";
-    unit: TemperatureUnit;
-}
-
 // @public
 export type TemperatureUnit = string;
 
 // @public
 export type TemporalModifier = string;
 
-// @public
-export interface TemporalSpanResolution extends BaseResolution {
-    begin?: string;
-    duration?: string;
-    end?: string;
-    modifier?: TemporalModifier;
-    resolutionKind: "TemporalSpanResolution";
-    timex?: string;
-}
-
 // @public
 export class TextAnalysisClient {
     constructor(endpointUrl: string, credential: KeyCredential, options?: TextAnalysisClientOptions);
@@ -1447,24 +1318,12 @@ export interface TextDocumentStatistics {
 // @public
 export type TokenSentimentLabel = "positive" | "mixed" | "negative";
 
-// @public
-export interface VolumeResolution extends BaseResolution, QuantityResolution {
-    resolutionKind: "VolumeResolution";
-    unit: VolumeUnit;
-}
-
 // @public
 export type VolumeUnit = string;
 
 // @public
 export type WarningCode = string;
 
-// @public
-export interface WeightResolution extends BaseResolution, QuantityResolution {
-    resolutionKind: "WeightResolution";
-    unit: WeightUnit;
-}
-
 // @public
 export type WeightUnit = string;
 

diff --git a/sdk/cognitivelanguage/ai-language-text/samples-dev/entityResolutions.ts b/sdk/cognitivelanguage/ai-language-text/samples-dev/entityResolutions.ts