@azure/ai-language-text 1.1.0-alpha.20221101.3 → 1.1.0-alpha.20221104.3

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

@@ -27,8 +27,6 @@ export declare interface AbstractiveSummarizationAction {
      * The default is the JavaScript's default which is "Utf16CodeUnit".
      */
     stringIndexType?: StringIndexType;
-    /** Control the phrases to be used in the summary. */
-    phraseControls?: PhraseControl[];
 }
 
 /** Options for an abstractive summarization batch action. */
@@ -356,11 +354,11 @@ export declare interface BatchActionState<Kind extends AnalyzeBatchActionName> {
 /**
  * The state of a succeeded batched action.
  */
-export declare interface BatchActionSuccessResult<T extends DocumentDetectedLanguage, Kind extends AnalyzeBatchActionName> extends BatchActionState<Kind> {
+export declare interface BatchActionSuccessResult<T, Kind extends AnalyzeBatchActionName> extends BatchActionState<Kind> {
     /**
      * The list of document results.
      */
-    readonly results: T[];
+    readonly results: WithDetectedLanguage<T>[];
     /**
      * When this action was completed by the service.
      */
@@ -606,23 +604,6 @@ export declare interface DocumentDetectedLanguage {
 /** Defines values for DocumentSentimentLabel. */
 export declare type DocumentSentimentLabel = "positive" | "neutral" | "negative" | "mixed";
 
-/**
- * Defines values for DocumentType. \
- * {@link KnownDocumentType} can be used interchangeably with DocumentType,
- *  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 DocumentType = string;
-
 /** Represents a warning encountered while processing a document. */
 export declare interface DocumentWarning {
     /** Error code. */
@@ -859,7 +840,7 @@ 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?: DocumentType;
+    documentType?: HealthcareDocumentType;
     /**
      * Specifies the measurement unit used to calculate the offset and length properties. For a list of possible values, see {@link KnownStringIndexType}.
      *
@@ -891,6 +872,23 @@ 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.
@@ -1177,28 +1175,6 @@ export declare enum KnownDateTimeSubKind {
     Set = "Set"
 }
 
-/** Known values of {@link DocumentType} that the service accepts. */
-export declare enum KnownDocumentType {
-    /** 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 ErrorCode} that the service accepts. */
 export declare enum KnownErrorCode {
     /** InvalidRequest */
@@ -1255,6 +1231,28 @@ export declare enum KnownFhirVersion {
     "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 */
@@ -2299,17 +2297,6 @@ export declare interface OrdinalResolution extends BaseResolution {
  */
 export declare type PagedAnalyzeBatchResult = PagedAsyncIterableIterator<AnalyzeBatchResult>;
 
-/** Control the phrases to be used in the summary. */
-export declare interface PhraseControl {
-    /** The target phrase to control. */
-    targetPhrase: string;
-    /** The strategy to use in phrase control. */
-    strategy: PhraseControlStrategy;
-}
-
-/** Defines values for PhraseControlStrategy. */
-export declare type PhraseControlStrategy = "encourage" | "discourage" | "disallow";
-
 /**
  * Defines values for PiiEntityCategory. \
  * {@link KnownPiiEntityCategory} can be used interchangeably with PiiEntityCategory,
@@ -2917,6 +2904,8 @@ export declare interface TemporalSpanResolution extends BaseResolution {
     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;
 }
 
 /**
@@ -3606,4 +3595,12 @@ 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 { }