@azure/ai-language-text 1.1.0-alpha.20230411.2 → 1.1.0-alpha.20230508.3

package/types/ai-language-text.d.ts

@@ -105,14 +105,6 @@ export declare interface ActionPrebuilt extends ActionCommon {
     modelVersion?: string;
 }
 
-/** Represents the Age entity resolution model. */
-export declare interface AgeResolution extends BaseResolution, QuantityResolution {
-    /** Polymorphic discriminator, which specifies the different types this object can be */
-    resolutionKind: "AgeResolution";
-    /** The Age Unit of measurement */
-    unit: AgeUnit;
-}
-
 /**
  * Defines values for AgeUnit. \
  * {@link KnownAgeUnit} can be used interchangeably with AgeUnit,
@@ -258,14 +250,6 @@ export declare type AnalyzeResult<ActionName extends AnalyzeActionName> = {
     LanguageDetection: LanguageDetectionResult[];
 }[ActionName];
 
-/** Represents the area entity resolution model. */
-export declare interface AreaResolution extends BaseResolution, QuantityResolution {
-    /** Polymorphic discriminator, which specifies the different types this object can be */
-    resolutionKind: "AreaResolution";
-    /** The area Unit of measurement */
-    unit: AreaUnit;
-}
-
 /**
  * Defines values for AreaUnit. \
  * {@link KnownAreaUnit} can be used interchangeably with AreaUnit,
@@ -305,14 +289,6 @@ export declare interface AssessmentSentiment {
 
 export { AzureKeyCredential }
 
-/** The abstract base class for entity resolutions. */
-export declare interface BaseResolution {
-    /** Polymorphic discriminator, which specifies the different types this object can be */
-    resolutionKind: "AgeResolution" | "VolumeResolution" | "SpeedResolution" | "AreaResolution" | "LengthResolution" | "InformationResolution" | "TemperatureResolution" | "WeightResolution" | "CurrencyResolution" | "BooleanResolution" | "DateTimeResolution" | "NumberResolution" | "OrdinalResolution" | "TemporalSpanResolution" | "NumericRangeResolution";
-}
-
-export declare type BaseResolutionUnion = BaseResolution | AgeResolution | VolumeResolution | SpeedResolution | AreaResolution | LengthResolution | InformationResolution | TemperatureResolution | WeightResolution | CurrencyResolution | BooleanResolution | DateTimeResolution | NumberResolution | OrdinalResolution | TemporalSpanResolution | NumericRangeResolution;
-
 /**
  * The error of an analyze batch action.
  */
@@ -355,7 +331,7 @@ export declare interface BatchActionSuccessResult<T, Kind extends AnalyzeBatchAc
     /**
      * The list of document results.
      */
-    readonly results: WithDetectedLanguage<T>[];
+    readonly results: T[];
     /**
      * When this action was completed by the service.
      */
@@ -380,13 +356,6 @@ export declare interface BeginAnalyzeBatchOptions extends TextAnalysisOperationO
     displayName?: string;
 }
 
-/** A resolution for boolean expressions */
-export declare interface BooleanResolution extends BaseResolution {
-    /** Polymorphic discriminator, which specifies the different types this object can be */
-    resolutionKind: "BooleanResolution";
-    value: boolean;
-}
-
 /** A classification result from a custom classify document single category action */
 export declare interface ClassificationCategory {
     /** Classification type. */
@@ -395,16 +364,6 @@ export declare interface ClassificationCategory {
     confidenceScore: number;
 }
 
-/** Represents the currency entity resolution model. */
-export declare interface CurrencyResolution extends BaseResolution, QuantityResolution {
-    /** Polymorphic discriminator, which specifies the different types this object can be */
-    resolutionKind: "CurrencyResolution";
-    /** The alphabetic code based on another ISO standard, ISO 3166, which lists the codes for country names. The first two letters of the ISO 4217 three-letter code are the same as the code for the country name, and, where possible, the third letter corresponds to the first letter of the currency name. */
-    iso4217?: string;
-    /** The unit of the amount captured in the extracted entity */
-    unit: string;
-}
-
 /**
  * Custom action metadata.
  */
@@ -539,20 +498,6 @@ export declare interface CustomSingleLabelClassificationSuccessResult extends Te
     readonly classifications: ClassificationCategory[];
 }
 
-/** A resolution for datetime entity instances. */
-export declare interface DateTimeResolution extends BaseResolution {
-    /** Polymorphic discriminator, which specifies the different types this object can be */
-    resolutionKind: "DateTimeResolution";
-    /** An extended ISO 8601 date/time representation as described in (https://github.com/Microsoft/Recognizers-Text/blob/master/Patterns/English/English-DateTime.yaml) */
-    timex: string;
-    /** The DateTime SubKind */
-    dateTimeSubKind: DateTimeSubKind;
-    /** The actual time that the extracted text denote. */
-    value: string;
-    /** An optional modifier of a date/time instance. */
-    modifier?: TemporalModifier;
-}
-
 /**
  * Defines values for DateTimeSubKind. \
  * {@link KnownDateTimeSubKind} can be used interchangeably with DateTimeSubKind,
@@ -578,12 +523,6 @@ export declare interface DetectedLanguage {
     script?: ScriptKind;
 }
 
-/** The auto-detected language of the input document. */
-export declare interface DocumentDetectedLanguage {
-    /** If 'language' is set to 'auto' for the document in the request this field will contain a 2 letter ISO 639-1 representation of the language detected for this document. */
-    detectedLanguage?: DetectedLanguage;
-}
-
 /** Defines values for DocumentSentimentLabel. */
 export declare type DocumentSentimentLabel = "positive" | "neutral" | "negative" | "mixed";
 
@@ -713,13 +652,7 @@ export declare interface EntityRecognitionSuccessResult extends TextAnalysisSucc
     /**
      * The collection of entities identified in the input document.
      */
-    readonly entities: EntityWithResolution[];
-}
-
-/** An entity with resolution. */
-export declare interface EntityWithResolution extends Entity {
-    /** The collection of entity resolution objects. */
-    resolutions?: BaseResolutionUnion[];
+    readonly entities: Entity[];
 }
 
 /** Supported parameters for an Extractive Summarization task. */
@@ -780,21 +713,8 @@ export declare interface ExtractiveSummarizationSuccessResult extends TextAnalys
     readonly sentences: SummarySentence[];
 }
 
-/**
- * Defines values for FhirVersion. \
- * {@link KnownFhirVersion} can be used interchangeably with FhirVersion,
- *  this enum contains the known values that the service supports.
- * ### Known values supported by the service
- * **4.0.1**
- */
-export declare type FhirVersion = string;
-
 /** Supported parameters for a Healthcare task. */
 export declare interface HealthcareAction extends ActionPrebuilt {
-    /** The FHIR Spec version that the result will use to format the fhirBundle. For additional information see https://www.hl7.org/fhir/overview.html. */
-    fhirVersion?: FhirVersion;
-    /** Document type that can be provided as input for Fhir Documents. Expect to have fhirVersion provided when used. Behavior of using None enum is the same as not using the documentType parameter. */
-    documentType?: HealthcareDocumentType;
     /**
      * Specifies the measurement unit used to calculate the offset and length properties. For a list of possible values, see {@link KnownStringIndexType}.
      *
@@ -826,23 +746,6 @@ export declare interface HealthcareBatchAction extends AnalyzeBatchActionCommon,
  */
 export declare type HealthcareBatchResult = ActionMetadata & BatchActionResult<HealthcareResult, "Healthcare">;
 
-/**
- * Defines values for HealthcareDocumentType. \
- * {@link KnownHealthcareDocumentType} can be used interchangeably with HealthcareDocumentType,
- *  this enum contains the known values that the service supports.
- * ### Known values supported by the service
- * **None** \
- * **ClinicalTrial** \
- * **DischargeSummary** \
- * **ProgressNote** \
- * **HistoryAndPhysical** \
- * **Consult** \
- * **Imaging** \
- * **Pathology** \
- * **ProcedureNote**
- */
-export declare type HealthcareDocumentType = string;
-
 /**
  * A healthcare entity represented as a node in a directed graph where the edges are
  * a particular type of relationship between the source and target nodes.
@@ -988,19 +891,6 @@ export declare interface HealthcareSuccessResult extends TextAnalysisSuccessResu
      * Relations between healthcare entities.
      */
     readonly entityRelations: HealthcareEntityRelation[];
-    /**
-     * JSON bundle containing a FHIR compatible object for consumption in other
-     * Healthcare tools. For additional information see {@link https://www.hl7.org/fhir/overview.html}.
-     */
-    readonly fhirBundle?: Record<string, any>;
-}
-
-/** Represents the information (data) entity resolution model. */
-export declare interface InformationResolution extends BaseResolution, QuantityResolution {
-    /** Polymorphic discriminator, which specifies the different types this object can be */
-    resolutionKind: "InformationResolution";
-    /** The information (data) Unit of measurement. */
-    unit: InformationUnit;
 }
 
 /**
@@ -1169,36 +1059,6 @@ export declare enum KnownExtractiveSummarizationOrderingCriteria {
     Rank = "Rank"
 }
 
-/**
- * Known values of the {@link HealthcareAction.fhirVersion} parameter.
- */
-export declare enum KnownFhirVersion {
-    /** 4.0.1 */
-    "4.0.1" = "4.0.1"
-}
-
-/** Known values of {@link HealthcareDocumentType} that the service accepts. */
-export declare enum KnownHealthcareDocumentType {
-    /** None */
-    None = "None",
-    /** ClinicalTrial */
-    ClinicalTrial = "ClinicalTrial",
-    /** DischargeSummary */
-    DischargeSummary = "DischargeSummary",
-    /** ProgressNote */
-    ProgressNote = "ProgressNote",
-    /** HistoryAndPhysical */
-    HistoryAndPhysical = "HistoryAndPhysical",
-    /** Consult */
-    Consult = "Consult",
-    /** Imaging */
-    Imaging = "Imaging",
-    /** Pathology */
-    Pathology = "Pathology",
-    /** ProcedureNote */
-    ProcedureNote = "ProcedureNote"
-}
-
 /** Known values of {@link HealthcareEntityCategory} that the service accepts. */
 export declare enum KnownHealthcareEntityCategory {
     /** BodyStructure */
@@ -1809,40 +1669,6 @@ export declare enum KnownRelativeTo {
     Start = "Start"
 }
 
-/** Known values of {@link ResolutionKind} that the service accepts. */
-export declare enum KnownResolutionKind {
-    /** BooleanResolution */
-    BooleanResolution = "BooleanResolution",
-    /** DateTimeResolution */
-    DateTimeResolution = "DateTimeResolution",
-    /** NumberResolution */
-    NumberResolution = "NumberResolution",
-    /** OrdinalResolution */
-    OrdinalResolution = "OrdinalResolution",
-    /** SpeedResolution */
-    SpeedResolution = "SpeedResolution",
-    /** WeightResolution */
-    WeightResolution = "WeightResolution",
-    /** LengthResolution */
-    LengthResolution = "LengthResolution",
-    /** VolumeResolution */
-    VolumeResolution = "VolumeResolution",
-    /** AreaResolution */
-    AreaResolution = "AreaResolution",
-    /** AgeResolution */
-    AgeResolution = "AgeResolution",
-    /** InformationResolution */
-    InformationResolution = "InformationResolution",
-    /** TemperatureResolution */
-    TemperatureResolution = "TemperatureResolution",
-    /** CurrencyResolution */
-    CurrencyResolution = "CurrencyResolution",
-    /** NumericRangeResolution */
-    NumericRangeResolution = "NumericRangeResolution",
-    /** TemporalSpanResolution */
-    TemporalSpanResolution = "TemporalSpanResolution"
-}
-
 /** Known values of {@link ScriptKind} that the service accepts. */
 export declare enum KnownScriptKind {
     /** Latin */
@@ -2111,14 +1937,6 @@ export declare interface LanguageDetectionSuccessResult extends TextAnalysisSucc
     readonly primaryLanguage: DetectedLanguage;
 }
 
-/** Represents the length entity resolution model. */
-export declare interface LengthResolution extends BaseResolution, QuantityResolution {
-    /** Polymorphic discriminator, which specifies the different types this object can be */
-    resolutionKind: "LengthResolution";
-    /** The length Unit of measurement */
-    unit: LengthUnit;
-}
-
 /**
  * Defines values for LengthUnit. \
  * {@link KnownLengthUnit} can be used interchangeably with LengthUnit,
@@ -2188,28 +2006,6 @@ export declare interface Match {
  */
 export declare type NumberKind = string;
 
-/** A resolution for numeric entity instances. */
-export declare interface NumberResolution extends BaseResolution {
-    /** Polymorphic discriminator, which specifies the different types this object can be */
-    resolutionKind: "NumberResolution";
-    /** The type of the extracted number entity. */
-    numberKind: NumberKind;
-    /** A numeric representation of what the extracted text denotes. */
-    value: number;
-}
-
-/** represents the resolution of numeric intervals. */
-export declare interface NumericRangeResolution extends BaseResolution {
-    /** Polymorphic discriminator, which specifies the different types this object can be */
-    resolutionKind: "NumericRangeResolution";
-    /** The kind of range that the resolution object represents. */
-    rangeKind: RangeKind;
-    /** The beginning value of  the interval. */
-    minimum: number;
-    /** The ending value of the interval. */
-    maximum: number;
-}
-
 /**
  * A mined opinion object represents an opinion we've extracted from a sentence.
  * It consists of both a target that these assessments are about, and the actual
@@ -2226,18 +2022,6 @@ export declare interface Opinion {
     readonly assessments: AssessmentSentiment[];
 }
 
-/** A resolution for ordinal numbers entity instances. */
-export declare interface OrdinalResolution extends BaseResolution {
-    /** Polymorphic discriminator, which specifies the different types this object can be */
-    resolutionKind: "OrdinalResolution";
-    /** The offset With respect to the reference (e.g., offset = -1 in "show me the second to last" */
-    offset: string;
-    /** The reference point that the ordinal number denotes. */
-    relativeTo: RelativeTo;
-    /** A simple arithmetic expression that the ordinal denotes. */
-    value: string;
-}
-
 /**
  * Paged results of the {@link TextAnalysisClient.beginAnalyzeBatch} operation.
  */
@@ -2501,12 +2285,6 @@ export declare interface PollerLike<TState extends OperationState<TResult>, TRes
     sendCancellationRequest: () => Promise<void>;
 }
 
-/** Represents resolutions for quantities. */
-export declare interface QuantityResolution {
-    /** The numeric value that the extracted text denotes. */
-    value: number;
-}
-
 /**
  * Defines values for RangeKind. \
  * {@link KnownRangeKind} can be used interchangeably with RangeKind,
@@ -2691,14 +2469,6 @@ export declare interface SentimentConfidenceScores {
     negative: number;
 }
 
-/** Represents the speed entity resolution model. */
-export declare interface SpeedResolution extends BaseResolution, QuantityResolution {
-    /** Polymorphic discriminator, which specifies the different types this object can be */
-    resolutionKind: "SpeedResolution";
-    /** The speed Unit of measurement */
-    unit: SpeedUnit;
-}
-
 /**
  * Defines values for SpeedUnit. \
  * {@link KnownSpeedUnit} can be used interchangeably with SpeedUnit,
@@ -2791,14 +2561,6 @@ export declare interface TargetSentiment {
     readonly length: number;
 }
 
-/** Represents the temperature entity resolution model. */
-export declare interface TemperatureResolution extends BaseResolution, QuantityResolution {
-    /** Polymorphic discriminator, which specifies the different types this object can be */
-    resolutionKind: "TemperatureResolution";
-    /** The temperature Unit of measurement. */
-    unit: TemperatureUnit;
-}
-
 /**
  * Defines values for TemperatureUnit. \
  * {@link KnownTemperatureUnit} can be used interchangeably with TemperatureUnit,
@@ -2838,22 +2600,6 @@ export declare type TemperatureUnit = string;
  */
 export declare type TemporalModifier = string;
 
-/** represents the resolution of a date and/or time span. */
-export declare interface TemporalSpanResolution extends BaseResolution {
-    /** Polymorphic discriminator, which specifies the different types this object can be */
-    resolutionKind: "TemporalSpanResolution";
-    /** An extended ISO 8601 date/time representation as described in (https://github.com/Microsoft/Recognizers-Text/blob/master/Patterns/English/English-DateTime.yaml) */
-    begin?: string;
-    /** An extended ISO 8601 date/time representation as described in (https://github.com/Microsoft/Recognizers-Text/blob/master/Patterns/English/English-DateTime.yaml) */
-    end?: string;
-    /** An optional duration value formatted based on the ISO 8601 (https://en.wikipedia.org/wiki/ISO_8601#Durations) */
-    duration?: string;
-    /** An optional modifier of a date/time instance. */
-    modifier?: TemporalModifier;
-    /** An optional triplet containing the beginning, the end, and the duration all stated as ISO 8601 formatted strings. */
-    timex?: string;
-}
-
 /**
  * A client for interacting with the text analysis features in Azure Cognitive
  * Language Service.
@@ -3459,14 +3205,6 @@ export declare interface TextDocumentStatistics {
 /** Defines values for TokenSentimentLabel. */
 export declare type TokenSentimentLabel = "positive" | "mixed" | "negative";
 
-/** Represents the volume entity resolution model. */
-export declare interface VolumeResolution extends BaseResolution, QuantityResolution {
-    /** Polymorphic discriminator, which specifies the different types this object can be */
-    resolutionKind: "VolumeResolution";
-    /** The Volume Unit of measurement */
-    unit: VolumeUnit;
-}
-
 /**
  * Defines values for VolumeUnit. \
  * {@link KnownVolumeUnit} can be used interchangeably with VolumeUnit,
@@ -3513,14 +3251,6 @@ export declare type VolumeUnit = string;
  */
 export declare type WarningCode = string;
 
-/** Represents the weight entity resolution model. */
-export declare interface WeightResolution extends BaseResolution, QuantityResolution {
-    /** Polymorphic discriminator, which specifies the different types this object can be */
-    resolutionKind: "WeightResolution";
-    /** The weight Unit of measurement. */
-    unit: WeightUnit;
-}
-
 /**
  * Defines values for WeightUnit. \
  * {@link KnownWeightUnit} can be used interchangeably with WeightUnit,
@@ -3545,12 +3275,4 @@ export declare interface WeightResolution extends BaseResolution, QuantityResolu
  */
 export declare type WeightUnit = string;
 
-/**
- * Document results with potentially automatically detected language.
- */
-export declare type WithDetectedLanguage<T> = T & DocumentDetectedLanguage & {
-    /** Indicates whether the default language hint was used */
-    isLanguageDefaulted?: boolean;
-};
-
 export { }