@azure/ai-text-analytics 5.1.1-alpha.20241204.1 → 5.1.1-alpha.20241206.1

package/dist/esm/analyzeActionsResult.d.ts

@@ -0,0 +1,200 @@
+import type { PagedAsyncIterableIterator } from "@azure/core-paging";
+import type { AnalyzeSentimentResultArray } from "./analyzeSentimentResultArray.js";
+import type { ExtractKeyPhrasesResultArray } from "./extractKeyPhrasesResultArray.js";
+import type { AnalyzeJobState as GeneratedResponse, TextDocumentInput } from "./generated/models/index.js";
+import type { RecognizeCategorizedEntitiesResultArray } from "./recognizeCategorizedEntitiesResultArray.js";
+import type { RecognizeLinkedEntitiesResultArray } from "./recognizeLinkedEntitiesResultArray.js";
+import type { RecognizePiiEntitiesResultArray } from "./recognizePiiEntitiesResultArray.js";
+import type { ErrorCode, TextAnalyticsError } from "./textAnalyticsResult.js";
+/**
+ * The results of an analyze Actions operation.
+ */
+export interface AnalyzeActionsResult {
+    /**
+     * Array of the results for each categorized entities recognition action.
+     */
+    recognizeEntitiesResults: RecognizeCategorizedEntitiesActionResult[];
+    /**
+     * Array of the results for each Pii entities recognition action.
+     */
+    recognizePiiEntitiesResults: RecognizePiiEntitiesActionResult[];
+    /**
+     * Array of the results for each key phrases extraction action.
+     */
+    extractKeyPhrasesResults: ExtractKeyPhrasesActionResult[];
+    /**
+     * Array of the results for each linked entities recognition action.
+     */
+    recognizeLinkedEntitiesResults: RecognizeLinkedEntitiesActionResult[];
+    /**
+     * Array of the results for each analyze sentiment action.
+     */
+    analyzeSentimentResults: AnalyzeSentimentActionResult[];
+}
+/**
+ * The state of a succeeded action.
+ */
+export interface TextAnalyticsActionSuccessState {
+    /**
+     * When this action was completed by the service.
+     */
+    readonly completedOn: Date;
+    /**
+     * Discriminant to determine if that this is an error result.
+     */
+    readonly error?: undefined;
+}
+/**
+ * The error of an analyze batch action.
+ */
+export interface TextAnalyticsActionErrorResult {
+    /**
+     * When this action was completed by the service.
+     */
+    readonly failedOn: Date;
+    /**
+     * The Error for this action result.
+     */
+    readonly error: TextAnalyticsError;
+}
+/**
+ * The error of a recognize categorized entities action.
+ */
+export type RecognizeCategorizedEntitiesActionErrorResult = TextAnalyticsActionErrorResult;
+/**
+ * The results of a succeeded recognize categorized entities action.
+ */
+export interface RecognizeCategorizedEntitiesActionSuccessResult extends TextAnalyticsActionSuccessState {
+    /**
+     * Array of the results for each categorized entities recognition action.
+     */
+    results: RecognizeCategorizedEntitiesResultArray;
+}
+/**
+ * The result of a recognize categorized entities action.
+ */
+export type RecognizeCategorizedEntitiesActionResult = RecognizeCategorizedEntitiesActionSuccessResult | RecognizeCategorizedEntitiesActionErrorResult;
+/**
+ * The error of a recognize pii entities action.
+ */
+export type RecognizePiiEntitiesActionErrorResult = TextAnalyticsActionErrorResult;
+/**
+ * The results of a succeeded recognize pii entities action.
+ */
+export interface RecognizePiiEntitiesActionSuccessResult extends TextAnalyticsActionSuccessState {
+    /**
+     * Array of the results for each pii entities recognition action.
+     */
+    results: RecognizePiiEntitiesResultArray;
+}
+/**
+ * The result of a recognize pii entities action.
+ */
+export type RecognizePiiEntitiesActionResult = RecognizePiiEntitiesActionSuccessResult | RecognizePiiEntitiesActionErrorResult;
+/**
+ * The error of a extract key phrases action.
+ */
+export type ExtractKeyPhrasesActionErrorResult = TextAnalyticsActionErrorResult;
+/**
+ * The results of a succeeded extract key phrases action.
+ */
+export interface ExtractKeyPhrasesActionSuccessResult extends TextAnalyticsActionSuccessState {
+    /**
+     * Array of the results for each extract key phrases action.
+     */
+    results: ExtractKeyPhrasesResultArray;
+}
+/**
+ * The result of a extract key phrases action.
+ */
+export type ExtractKeyPhrasesActionResult = ExtractKeyPhrasesActionSuccessResult | ExtractKeyPhrasesActionErrorResult;
+/**
+ * The error of a recognize linked entities action.
+ */
+export type RecognizeLinkedEntitiesActionErrorResult = TextAnalyticsActionErrorResult;
+/**
+ * The results of a succeeded recognize linked entities action.
+ */
+export interface RecognizeLinkedEntitiesActionSuccessResult extends TextAnalyticsActionSuccessState {
+    /**
+     * Array of the results for each linked entities recognition action.
+     */
+    results: RecognizeLinkedEntitiesResultArray;
+}
+/**
+ * The result of a recognize linked entities action.
+ */
+export type RecognizeLinkedEntitiesActionResult = RecognizeLinkedEntitiesActionSuccessResult | RecognizeLinkedEntitiesActionErrorResult;
+/**
+ * The error of an analyze sentiment action.
+ */
+export type AnalyzeSentimentActionErrorResult = TextAnalyticsActionErrorResult;
+/**
+ * The results of a succeeded analyze sentiment action.
+ */
+export interface AnalyzeSentimentActionSuccessResult extends TextAnalyticsActionSuccessState {
+    /**
+     * Array of the results for each analyze sentiment action.
+     */
+    results: AnalyzeSentimentResultArray;
+}
+/**
+ * The result of an analyze sentiment action.
+ */
+export type AnalyzeSentimentActionResult = AnalyzeSentimentActionSuccessResult | AnalyzeSentimentActionErrorResult;
+/**
+ * The results of an analyze Actions operation represented as a paged iterator that
+ * iterates over the results of the requested actions.
+ */
+export type PagedAsyncIterableAnalyzeActionsResult = PagedAsyncIterableIterator<AnalyzeActionsResult, AnalyzeActionsResult>;
+/**
+ * The results of an analyze actions operation represented as a paged iterator that
+ * iterates over the results of the requested actions.
+ */
+export interface PagedAnalyzeActionsResult extends PagedAsyncIterableAnalyzeActionsResult {
+}
+/**
+ * The type of different actions supported by the begin analyze actions operation.
+ * @internal
+ */
+type TextAnalyticsActionType = "RecognizeCategorizedEntities" | "RecognizePiiEntities" | "ExtractKeyPhrases" | "RecognizeLinkedEntities" | "AnalyzeSentiment";
+/**
+ * The type of an action error with the type of the action that erred and its
+ * index in the list of input actions.
+ * @internal
+ */
+interface TextAnalyticsActionError {
+    /**
+     * A code describing the kind of error produced
+     */
+    readonly code: ErrorCode;
+    /**
+     * A message from the service explaining the error
+     */
+    readonly message: string;
+    /**
+     * The type of the action that erred
+     */
+    readonly type: TextAnalyticsActionType;
+    /**
+     * The index of the action that erred in the list of input actions
+     */
+    readonly index: number;
+}
+/**
+ * Converts a service action error to one with the JSON pointer converted to an action index.
+ * @param erredActions - the action error the service sent
+ * @returns an action error with an action type and index
+ * @internal
+ */
+export declare function parseActionError(erredActions: TextAnalyticsError): TextAnalyticsActionError;
+/**
+ * Creates the user-friendly action results object for the begin analyze actions operation.
+ * @param response - the begin analyze actions operation response
+ * @param documents - the list of input documents
+ * @returns - the user-friendly action results object
+ * @internal
+ */
+export declare function createAnalyzeActionsResult(response: GeneratedResponse, documents: TextDocumentInput[]): AnalyzeActionsResult;
+export {};
+//# sourceMappingURL=analyzeActionsResult.d.ts.map

package/dist/esm/analyzeActionsResult.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"analyzeActionsResult.d.ts","sourceRoot":"","sources":["../../src/analyzeActionsResult.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,oBAAoB,CAAC;AACrE,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,kCAAkC,CAAC;AAEpF,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,mCAAmC,CAAC;AAEtF,OAAO,KAAK,EACV,eAAe,IAAI,iBAAiB,EACpC,iBAAiB,EAClB,MAAM,6BAA6B,CAAC;AACrC,OAAO,KAAK,EAAE,uCAAuC,EAAE,MAAM,8CAA8C,CAAC;AAE5G,OAAO,KAAK,EAAE,kCAAkC,EAAE,MAAM,yCAAyC,CAAC;AAElG,OAAO,KAAK,EAAE,+BAA+B,EAAE,MAAM,sCAAsC,CAAC;AAE5F,OAAO,KAAK,EAAE,SAAS,EAAE,kBAAkB,EAAE,MAAM,0BAA0B,CAAC;AAG9E;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,wBAAwB,EAAE,wCAAwC,EAAE,CAAC;IACrE;;OAEG;IACH,2BAA2B,EAAE,gCAAgC,EAAE,CAAC;IAChE;;OAEG;IACH,wBAAwB,EAAE,6BAA6B,EAAE,CAAC;IAC1D;;OAEG;IACH,8BAA8B,EAAE,mCAAmC,EAAE,CAAC;IACtE;;OAEG;IACH,uBAAuB,EAAE,4BAA4B,EAAE,CAAC;CACzD;AAED;;GAEG;AACH,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,IAAI,CAAC;IAC3B;;OAEG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,SAAS,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,IAAI,CAAC;IACxB;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,kBAAkB,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,MAAM,6CAA6C,GAAG,8BAA8B,CAAC;AAE3F;;GAEG;AACH,MAAM,WAAW,+CACf,SAAQ,+BAA+B;IACvC;;OAEG;IACH,OAAO,EAAE,uCAAuC,CAAC;CAClD;AAED;;GAEG;AACH,MAAM,MAAM,wCAAwC,GAChD,+CAA+C,GAC/C,6CAA6C,CAAC;AAElD;;GAEG;AACH,MAAM,MAAM,qCAAqC,GAAG,8BAA8B,CAAC;AAEnF;;GAEG;AACH,MAAM,WAAW,uCAAwC,SAAQ,+BAA+B;IAC9F;;OAEG;IACH,OAAO,EAAE,+BAA+B,CAAC;CAC1C;AAED;;GAEG;AACH,MAAM,MAAM,gCAAgC,GACxC,uCAAuC,GACvC,qCAAqC,CAAC;AAE1C;;GAEG;AACH,MAAM,MAAM,kCAAkC,GAAG,8BAA8B,CAAC;AAEhF;;GAEG;AACH,MAAM,WAAW,oCAAqC,SAAQ,+BAA+B;IAC3F;;OAEG;IACH,OAAO,EAAE,4BAA4B,CAAC;CACvC;AAED;;GAEG;AACH,MAAM,MAAM,6BAA6B,GACrC,oCAAoC,GACpC,kCAAkC,CAAC;AAEvC;;GAEG;AACH,MAAM,MAAM,wCAAwC,GAAG,8BAA8B,CAAC;AAEtF;;GAEG;AACH,MAAM,WAAW,0CACf,SAAQ,+BAA+B;IACvC;;OAEG;IACH,OAAO,EAAE,kCAAkC,CAAC;CAC7C;AAED;;GAEG;AACH,MAAM,MAAM,mCAAmC,GAC3C,0CAA0C,GAC1C,wCAAwC,CAAC;AAE7C;;GAEG;AACH,MAAM,MAAM,iCAAiC,GAAG,8BAA8B,CAAC;AAE/E;;GAEG;AACH,MAAM,WAAW,mCAAoC,SAAQ,+BAA+B;IAC1F;;OAEG;IACH,OAAO,EAAE,2BAA2B,CAAC;CACtC;AAED;;GAEG;AACH,MAAM,MAAM,4BAA4B,GACpC,mCAAmC,GACnC,iCAAiC,CAAC;AAEtC;;;GAGG;AACH,MAAM,MAAM,sCAAsC,GAAG,0BAA0B,CAC7E,oBAAoB,EACpB,oBAAoB,CACrB,CAAC;AAEF;;;GAGG;AACH,MAAM,WAAW,yBAA0B,SAAQ,sCAAsC;CAOxF;AAED;;;GAGG;AACH,KAAK,uBAAuB,GACxB,8BAA8B,GAC9B,sBAAsB,GACtB,mBAAmB,GACnB,yBAAyB,GACzB,kBAAkB,CAAC;AAEvB;;;;GAIG;AACH,UAAU,wBAAwB;IAChC;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC;IACzB;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,uBAAuB,CAAC;IACvC;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;CACxB;AA+BD;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,YAAY,EAAE,kBAAkB,GAAG,wBAAwB,CAqB3F;AAyGD;;;;;;GAMG;AACH,wBAAgB,0BAA0B,CACxC,QAAQ,EAAE,iBAAiB,EAC3B,SAAS,EAAE,iBAAiB,EAAE,GAC7B,oBAAoB,CA8CtB"}

package/dist/esm/analyzeActionsResult.js

@@ -0,0 +1,157 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+import { makeAnalyzeSentimentResultArray } from "./analyzeSentimentResultArray.js";
+import { makeExtractKeyPhrasesResultArray } from "./extractKeyPhrasesResultArray.js";
+import { makeRecognizeCategorizedEntitiesResultArray } from "./recognizeCategorizedEntitiesResultArray.js";
+import { makeRecognizeLinkedEntitiesResultArray } from "./recognizeLinkedEntitiesResultArray.js";
+import { makeRecognizePiiEntitiesResultArray } from "./recognizePiiEntitiesResultArray.js";
+import { intoTextAnalyticsError } from "./textAnalyticsResult.js";
+/**
+ * Converts the service task name (in the JSON pointer in an action error) to an action type name.
+ * @param serviceActionType - The task type name the service uses.
+ * @returns the action type name that the package uses
+ * @internal
+ */
+function convertTaskTypeToActionType(taskType) {
+    switch (taskType) {
+        case "entityRecognitionTasks": {
+            return "RecognizeCategorizedEntities";
+        }
+        case "entityRecognitionPiiTasks": {
+            return "RecognizePiiEntities";
+        }
+        case "keyPhraseExtractionTasks": {
+            return "ExtractKeyPhrases";
+        }
+        case "entityLinkingTasks": {
+            return "RecognizeLinkedEntities";
+        }
+        case "sentimentAnalysisTasks": {
+            return "AnalyzeSentiment";
+        }
+        default: {
+            throw new Error(`unexpected action type from the service: ${taskType}`);
+        }
+    }
+}
+/**
+ * Converts a service action error to one with the JSON pointer converted to an action index.
+ * @param erredActions - the action error the service sent
+ * @returns an action error with an action type and index
+ * @internal
+ */
+export function parseActionError(erredActions) {
+    if (erredActions.target) {
+        const regex = new RegExp(/#\/tasks\/(entityRecognitionTasks|entityRecognitionPiiTasks|keyPhraseExtractionTasks|entityLinkingTasks|sentimentAnalysisTasks)\/(\d+)/);
+        const result = regex.exec(erredActions.target);
+        if (result !== null) {
+            return {
+                code: erredActions.code,
+                message: erredActions.message,
+                index: parseInt(result[2]),
+                type: convertTaskTypeToActionType(result[1]),
+            };
+        }
+        else {
+            throw new Error(`Pointer "${erredActions.target}" is not a valid action pointer`);
+        }
+    }
+    else {
+        throw new Error("expected an error with a target field referencing an action but did not get one");
+    }
+}
+/**
+ * Categorize each action error into a bucket according to its action type.
+ * @param erredActions - list of action errors
+ * @param recognizeEntitiesActionErrors - a list of recognize entities action errors to be filled from the errors list
+ * @param recognizePiiEntitiesActionErrors - a list of recognize pii entities action errors to be filled from the errors list
+ * @param extractKeyPhrasesActionErrors - a list of extract key phrases action errors to be filled from the errors list
+ * @internal
+ */
+function categorizeActionErrors(erredActions, recognizeEntitiesActionErrors, recognizePiiEntitiesActionErrors, extractKeyPhrasesActionErrors, recognizeLinkedEntitiesActionErrors, analyzeSentimentActionErrors) {
+    for (const error of erredActions) {
+        const actionError = parseActionError(error);
+        switch (actionError.type) {
+            case "RecognizeCategorizedEntities": {
+                recognizeEntitiesActionErrors.push(actionError);
+                break;
+            }
+            case "RecognizePiiEntities": {
+                recognizePiiEntitiesActionErrors.push(actionError);
+                break;
+            }
+            case "ExtractKeyPhrases": {
+                extractKeyPhrasesActionErrors.push(actionError);
+                break;
+            }
+            case "RecognizeLinkedEntities": {
+                recognizeLinkedEntitiesActionErrors.push(actionError);
+                break;
+            }
+            case "AnalyzeSentiment": {
+                analyzeSentimentActionErrors.push(actionError);
+                break;
+            }
+        }
+    }
+}
+/**
+ * @internal
+ * @param error - the error the service sent for a task
+ * @param lastUpdateDateTime - the time when this task failed
+ */
+function createErredAction(error, lastUpdateDateTime) {
+    return { error: intoTextAnalyticsError(error), failedOn: lastUpdateDateTime };
+}
+/**
+ * Creates a list of results for any action.
+ * @param documents - list of input documents
+ * @param makeResultsArray - a function to convert the results of a service response to the SDK's one
+ * @param succeededTasks - list of succeeded action results
+ * @param erredActions - list of erred actions
+ * @internal
+ */
+function makeActionResult(documents, makeResultsArray, succeededTasks, erredActions) {
+    let errorIndex = 0;
+    function convertTasksToActions(actions, task) {
+        const { results: actionResults, lastUpdateDateTime } = task;
+        if (actionResults !== undefined) {
+            const recognizeEntitiesResults = makeResultsArray(documents, actionResults);
+            return [
+                ...actions,
+                {
+                    results: recognizeEntitiesResults,
+                    completedOn: lastUpdateDateTime,
+                },
+            ];
+        }
+        else {
+            return [...actions, createErredAction(erredActions[errorIndex++], lastUpdateDateTime)];
+        }
+    }
+    return succeededTasks.reduce(convertTasksToActions, []);
+}
+/**
+ * Creates the user-friendly action results object for the begin analyze actions operation.
+ * @param response - the begin analyze actions operation response
+ * @param documents - the list of input documents
+ * @returns - the user-friendly action results object
+ * @internal
+ */
+export function createAnalyzeActionsResult(response, documents) {
+    var _a, _b, _c, _d, _e, _f;
+    const recognizeEntitiesActionErrors = [];
+    const recognizePiiEntitiesActionErrors = [];
+    const extractKeyPhrasesActionErrors = [];
+    const recognizeLinkedEntitiesActionErrors = [];
+    const analyzeSentimentActionErrors = [];
+    categorizeActionErrors((_a = response === null || response === void 0 ? void 0 : response.errors) !== null && _a !== void 0 ? _a : [], recognizeEntitiesActionErrors, recognizePiiEntitiesActionErrors, extractKeyPhrasesActionErrors, recognizeLinkedEntitiesActionErrors, analyzeSentimentActionErrors);
+    return {
+        recognizeEntitiesResults: makeActionResult(documents, makeRecognizeCategorizedEntitiesResultArray, (_b = response.tasks.entityRecognitionTasks) !== null && _b !== void 0 ? _b : [], recognizeEntitiesActionErrors),
+        recognizePiiEntitiesResults: makeActionResult(documents, makeRecognizePiiEntitiesResultArray, (_c = response.tasks.entityRecognitionPiiTasks) !== null && _c !== void 0 ? _c : [], recognizePiiEntitiesActionErrors),
+        extractKeyPhrasesResults: makeActionResult(documents, makeExtractKeyPhrasesResultArray, (_d = response.tasks.keyPhraseExtractionTasks) !== null && _d !== void 0 ? _d : [], extractKeyPhrasesActionErrors),
+        recognizeLinkedEntitiesResults: makeActionResult(documents, makeRecognizeLinkedEntitiesResultArray, (_e = response.tasks.entityLinkingTasks) !== null && _e !== void 0 ? _e : [], recognizeLinkedEntitiesActionErrors),
+        analyzeSentimentResults: makeActionResult(documents, makeAnalyzeSentimentResultArray, (_f = response.tasks.sentimentAnalysisTasks) !== null && _f !== void 0 ? _f : [], analyzeSentimentActionErrors),
+    };
+}
+//# sourceMappingURL=analyzeActionsResult.js.map

package/dist/esm/analyzeActionsResult.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"analyzeActionsResult.js","sourceRoot":"","sources":["../../src/analyzeActionsResult.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAIlC,OAAO,EAAE,+BAA+B,EAAE,MAAM,kCAAkC,CAAC;AAEnF,OAAO,EAAE,gCAAgC,EAAE,MAAM,mCAAmC,CAAC;AAMrF,OAAO,EAAE,2CAA2C,EAAE,MAAM,8CAA8C,CAAC;AAE3G,OAAO,EAAE,sCAAsC,EAAE,MAAM,yCAAyC,CAAC;AAEjG,OAAO,EAAE,mCAAmC,EAAE,MAAM,sCAAsC,CAAC;AAE3F,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAiOlE;;;;;GAKG;AACH,SAAS,2BAA2B,CAAC,QAAgB;IACnD,QAAQ,QAAQ,EAAE,CAAC;QACjB,KAAK,wBAAwB,CAAC,CAAC,CAAC;YAC9B,OAAO,8BAA8B,CAAC;QACxC,CAAC;QACD,KAAK,2BAA2B,CAAC,CAAC,CAAC;YACjC,OAAO,sBAAsB,CAAC;QAChC,CAAC;QACD,KAAK,0BAA0B,CAAC,CAAC,CAAC;YAChC,OAAO,mBAAmB,CAAC;QAC7B,CAAC;QACD,KAAK,oBAAoB,CAAC,CAAC,CAAC;YAC1B,OAAO,yBAAyB,CAAC;QACnC,CAAC;QACD,KAAK,wBAAwB,CAAC,CAAC,CAAC;YAC9B,OAAO,kBAAkB,CAAC;QAC5B,CAAC;QACD,OAAO,CAAC,CAAC,CAAC;YACR,MAAM,IAAI,KAAK,CAAC,4CAA4C,QAAQ,EAAE,CAAC,CAAC;QAC1E,CAAC;IACH,CAAC;AACH,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,gBAAgB,CAAC,YAAgC;IAC/D,IAAI,YAAY,CAAC,MAAM,EAAE,CAAC;QACxB,MAAM,KAAK,GAAG,IAAI,MAAM,CACtB,wIAAwI,CACzI,CAAC;QACF,MAAM,MAAM,GAAG,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;QAC/C,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;YACpB,OAAO;gBACL,IAAI,EAAE,YAAY,CAAC,IAAI;gBACvB,OAAO,EAAE,YAAY,CAAC,OAAO;gBAC7B,KAAK,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;gBAC1B,IAAI,EAAE,2BAA2B,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;aAC7C,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CAAC,YAAY,YAAY,CAAC,MAAM,iCAAiC,CAAC,CAAC;QACpF,CAAC;IACH,CAAC;SAAM,CAAC;QACN,MAAM,IAAI,KAAK,CACb,iFAAiF,CAClF,CAAC;IACJ,CAAC;AACH,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,sBAAsB,CAC7B,YAAkC,EAClC,6BAAyD,EACzD,gCAA4D,EAC5D,6BAAyD,EACzD,mCAA+D,EAC/D,4BAAwD;IAExD,KAAK,MAAM,KAAK,IAAI,YAAY,EAAE,CAAC;QACjC,MAAM,WAAW,GAAG,gBAAgB,CAAC,KAAK,CAAC,CAAC;QAC5C,QAAQ,WAAW,CAAC,IAAI,EAAE,CAAC;YACzB,KAAK,8BAA8B,CAAC,CAAC,CAAC;gBACpC,6BAA6B,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;gBAChD,MAAM;YACR,CAAC;YACD,KAAK,sBAAsB,CAAC,CAAC,CAAC;gBAC5B,gCAAgC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;gBACnD,MAAM;YACR,CAAC;YACD,KAAK,mBAAmB,CAAC,CAAC,CAAC;gBACzB,6BAA6B,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;gBAChD,MAAM;YACR,CAAC;YACD,KAAK,yBAAyB,CAAC,CAAC,CAAC;gBAC/B,mCAAmC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;gBACtD,MAAM;YACR,CAAC;YACD,KAAK,kBAAkB,CAAC,CAAC,CAAC;gBACxB,4BAA4B,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;gBAC/C,MAAM;YACR,CAAC;QACH,CAAC;IACH,CAAC;AACH,CAAC;AAED;;;;GAIG;AACH,SAAS,iBAAiB,CACxB,KAA+B,EAC/B,kBAAwB;IAExB,OAAO,EAAE,KAAK,EAAE,sBAAsB,CAAC,KAAK,CAAC,EAAE,QAAQ,EAAE,kBAAkB,EAAE,CAAC;AAChF,CAAC;AAcD;;;;;;;GAOG;AACH,SAAS,gBAAgB,CACvB,SAA8B,EAC9B,gBAA8E,EAC9E,cAAgD,EAChD,YAAwC;IAExC,IAAI,UAAU,GAAG,CAAC,CAAC;IACnB,SAAS,qBAAqB,CAC5B,OAAsC,EACtC,IAAoC;QAEpC,MAAM,EAAE,OAAO,EAAE,aAAa,EAAE,kBAAkB,EAAE,GAAG,IAAI,CAAC;QAC5D,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;YAChC,MAAM,wBAAwB,GAAG,gBAAgB,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC;YAC5E,OAAO;gBACL,GAAG,OAAO;gBACV;oBACE,OAAO,EAAE,wBAAwB;oBACjC,WAAW,EAAE,kBAAkB;iBAChC;aACF,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,GAAG,OAAO,EAAE,iBAAiB,CAAC,YAAY,CAAC,UAAU,EAAE,CAAC,EAAE,kBAAkB,CAAC,CAAC,CAAC;QACzF,CAAC;IACH,CAAC;IACD,OAAO,cAAc,CAAC,MAAM,CAAC,qBAAqB,EAAE,EAAE,CAAC,CAAC;AAC1D,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,0BAA0B,CACxC,QAA2B,EAC3B,SAA8B;;IAE9B,MAAM,6BAA6B,GAA+B,EAAE,CAAC;IACrE,MAAM,gCAAgC,GAA+B,EAAE,CAAC;IACxE,MAAM,6BAA6B,GAA+B,EAAE,CAAC;IACrE,MAAM,mCAAmC,GAA+B,EAAE,CAAC;IAC3E,MAAM,4BAA4B,GAA+B,EAAE,CAAC;IACpE,sBAAsB,CACpB,MAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,MAAM,mCAAI,EAAE,EACtB,6BAA6B,EAC7B,gCAAgC,EAChC,6BAA6B,EAC7B,mCAAmC,EACnC,4BAA4B,CAC7B,CAAC;IACF,OAAO;QACL,wBAAwB,EAAE,gBAAgB,CACxC,SAAS,EACT,2CAA2C,EAC3C,MAAA,QAAQ,CAAC,KAAK,CAAC,sBAAsB,mCAAI,EAAE,EAC3C,6BAA6B,CAC9B;QACD,2BAA2B,EAAE,gBAAgB,CAC3C,SAAS,EACT,mCAAmC,EACnC,MAAA,QAAQ,CAAC,KAAK,CAAC,yBAAyB,mCAAI,EAAE,EAC9C,gCAAgC,CACjC;QACD,wBAAwB,EAAE,gBAAgB,CACxC,SAAS,EACT,gCAAgC,EAChC,MAAA,QAAQ,CAAC,KAAK,CAAC,wBAAwB,mCAAI,EAAE,EAC7C,6BAA6B,CAC9B;QACD,8BAA8B,EAAE,gBAAgB,CAC9C,SAAS,EACT,sCAAsC,EACtC,MAAA,QAAQ,CAAC,KAAK,CAAC,kBAAkB,mCAAI,EAAE,EACvC,mCAAmC,CACpC;QACD,uBAAuB,EAAE,gBAAgB,CACvC,SAAS,EACT,+BAA+B,EAC/B,MAAA,QAAQ,CAAC,KAAK,CAAC,sBAAsB,mCAAI,EAAE,EAC3C,4BAA4B,CAC7B;KACF,CAAC;AACJ,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { PagedAsyncIterableIterator } from \"@azure/core-paging\";\nimport type { AnalyzeSentimentResultArray } from \"./analyzeSentimentResultArray.js\";\nimport { makeAnalyzeSentimentResultArray } from \"./analyzeSentimentResultArray.js\";\nimport type { ExtractKeyPhrasesResultArray } from \"./extractKeyPhrasesResultArray.js\";\nimport { makeExtractKeyPhrasesResultArray } from \"./extractKeyPhrasesResultArray.js\";\nimport type {\n  AnalyzeJobState as GeneratedResponse,\n  TextDocumentInput,\n} from \"./generated/models/index.js\";\nimport type { RecognizeCategorizedEntitiesResultArray } from \"./recognizeCategorizedEntitiesResultArray.js\";\nimport { makeRecognizeCategorizedEntitiesResultArray } from \"./recognizeCategorizedEntitiesResultArray.js\";\nimport type { RecognizeLinkedEntitiesResultArray } from \"./recognizeLinkedEntitiesResultArray.js\";\nimport { makeRecognizeLinkedEntitiesResultArray } from \"./recognizeLinkedEntitiesResultArray.js\";\nimport type { RecognizePiiEntitiesResultArray } from \"./recognizePiiEntitiesResultArray.js\";\nimport { makeRecognizePiiEntitiesResultArray } from \"./recognizePiiEntitiesResultArray.js\";\nimport type { ErrorCode, TextAnalyticsError } from \"./textAnalyticsResult.js\";\nimport { intoTextAnalyticsError } from \"./textAnalyticsResult.js\";\n\n/**\n * The results of an analyze Actions operation.\n */\nexport interface AnalyzeActionsResult {\n  /**\n   * Array of the results for each categorized entities recognition action.\n   */\n  recognizeEntitiesResults: RecognizeCategorizedEntitiesActionResult[];\n  /**\n   * Array of the results for each Pii entities recognition action.\n   */\n  recognizePiiEntitiesResults: RecognizePiiEntitiesActionResult[];\n  /**\n   * Array of the results for each key phrases extraction action.\n   */\n  extractKeyPhrasesResults: ExtractKeyPhrasesActionResult[];\n  /**\n   * Array of the results for each linked entities recognition action.\n   */\n  recognizeLinkedEntitiesResults: RecognizeLinkedEntitiesActionResult[];\n  /**\n   * Array of the results for each analyze sentiment action.\n   */\n  analyzeSentimentResults: AnalyzeSentimentActionResult[];\n}\n\n/**\n * The state of a succeeded action.\n */\nexport interface TextAnalyticsActionSuccessState {\n  /**\n   * When this action was completed by the service.\n   */\n  readonly completedOn: Date;\n  /**\n   * Discriminant to determine if that this is an error result.\n   */\n  readonly error?: undefined;\n}\n\n/**\n * The error of an analyze batch action.\n */\nexport interface TextAnalyticsActionErrorResult {\n  /**\n   * When this action was completed by the service.\n   */\n  readonly failedOn: Date;\n  /**\n   * The Error for this action result.\n   */\n  readonly error: TextAnalyticsError;\n}\n\n/**\n * The error of a recognize categorized entities action.\n */\nexport type RecognizeCategorizedEntitiesActionErrorResult = TextAnalyticsActionErrorResult;\n\n/**\n * The results of a succeeded recognize categorized entities action.\n */\nexport interface RecognizeCategorizedEntitiesActionSuccessResult\n  extends TextAnalyticsActionSuccessState {\n  /**\n   * Array of the results for each categorized entities recognition action.\n   */\n  results: RecognizeCategorizedEntitiesResultArray;\n}\n\n/**\n * The result of a recognize categorized entities action.\n */\nexport type RecognizeCategorizedEntitiesActionResult =\n  | RecognizeCategorizedEntitiesActionSuccessResult\n  | RecognizeCategorizedEntitiesActionErrorResult;\n\n/**\n * The error of a recognize pii entities action.\n */\nexport type RecognizePiiEntitiesActionErrorResult = TextAnalyticsActionErrorResult;\n\n/**\n * The results of a succeeded recognize pii entities action.\n */\nexport interface RecognizePiiEntitiesActionSuccessResult extends TextAnalyticsActionSuccessState {\n  /**\n   * Array of the results for each pii entities recognition action.\n   */\n  results: RecognizePiiEntitiesResultArray;\n}\n\n/**\n * The result of a recognize pii entities action.\n */\nexport type RecognizePiiEntitiesActionResult =\n  | RecognizePiiEntitiesActionSuccessResult\n  | RecognizePiiEntitiesActionErrorResult;\n\n/**\n * The error of a extract key phrases action.\n */\nexport type ExtractKeyPhrasesActionErrorResult = TextAnalyticsActionErrorResult;\n\n/**\n * The results of a succeeded extract key phrases action.\n */\nexport interface ExtractKeyPhrasesActionSuccessResult extends TextAnalyticsActionSuccessState {\n  /**\n   * Array of the results for each extract key phrases action.\n   */\n  results: ExtractKeyPhrasesResultArray;\n}\n\n/**\n * The result of a extract key phrases action.\n */\nexport type ExtractKeyPhrasesActionResult =\n  | ExtractKeyPhrasesActionSuccessResult\n  | ExtractKeyPhrasesActionErrorResult;\n\n/**\n * The error of a recognize linked entities action.\n */\nexport type RecognizeLinkedEntitiesActionErrorResult = TextAnalyticsActionErrorResult;\n\n/**\n * The results of a succeeded recognize linked entities action.\n */\nexport interface RecognizeLinkedEntitiesActionSuccessResult\n  extends TextAnalyticsActionSuccessState {\n  /**\n   * Array of the results for each linked entities recognition action.\n   */\n  results: RecognizeLinkedEntitiesResultArray;\n}\n\n/**\n * The result of a recognize linked entities action.\n */\nexport type RecognizeLinkedEntitiesActionResult =\n  | RecognizeLinkedEntitiesActionSuccessResult\n  | RecognizeLinkedEntitiesActionErrorResult;\n\n/**\n * The error of an analyze sentiment action.\n */\nexport type AnalyzeSentimentActionErrorResult = TextAnalyticsActionErrorResult;\n\n/**\n * The results of a succeeded analyze sentiment action.\n */\nexport interface AnalyzeSentimentActionSuccessResult extends TextAnalyticsActionSuccessState {\n  /**\n   * Array of the results for each analyze sentiment action.\n   */\n  results: AnalyzeSentimentResultArray;\n}\n\n/**\n * The result of an analyze sentiment action.\n */\nexport type AnalyzeSentimentActionResult =\n  | AnalyzeSentimentActionSuccessResult\n  | AnalyzeSentimentActionErrorResult;\n\n/**\n * The results of an analyze Actions operation represented as a paged iterator that\n * iterates over the results of the requested actions.\n */\nexport type PagedAsyncIterableAnalyzeActionsResult = PagedAsyncIterableIterator<\n  AnalyzeActionsResult,\n  AnalyzeActionsResult\n>;\n\n/**\n * The results of an analyze actions operation represented as a paged iterator that\n * iterates over the results of the requested actions.\n */\nexport interface PagedAnalyzeActionsResult extends PagedAsyncIterableAnalyzeActionsResult {\n  // /**\n  //  * Statistics about the input document batch and how it was processed\n  //  * by the service. This property will have a value when includeStatistics is set to true\n  //  * in the client call.\n  //  */\n  // statistics?: TextDocumentBatchStatistics;\n}\n\n/**\n * The type of different actions supported by the begin analyze actions operation.\n * @internal\n */\ntype TextAnalyticsActionType =\n  | \"RecognizeCategorizedEntities\"\n  | \"RecognizePiiEntities\"\n  | \"ExtractKeyPhrases\"\n  | \"RecognizeLinkedEntities\"\n  | \"AnalyzeSentiment\";\n\n/**\n * The type of an action error with the type of the action that erred and its\n * index in the list of input actions.\n * @internal\n */\ninterface TextAnalyticsActionError {\n  /**\n   * A code describing the kind of error produced\n   */\n  readonly code: ErrorCode;\n  /**\n   * A message from the service explaining the error\n   */\n  readonly message: string;\n  /**\n   * The type of the action that erred\n   */\n  readonly type: TextAnalyticsActionType;\n  /**\n   * The index of the action that erred in the list of input actions\n   */\n  readonly index: number;\n}\n\n/**\n * Converts the service task name (in the JSON pointer in an action error) to an action type name.\n * @param serviceActionType - The task type name the service uses.\n * @returns the action type name that the package uses\n * @internal\n */\nfunction convertTaskTypeToActionType(taskType: string): TextAnalyticsActionType {\n  switch (taskType) {\n    case \"entityRecognitionTasks\": {\n      return \"RecognizeCategorizedEntities\";\n    }\n    case \"entityRecognitionPiiTasks\": {\n      return \"RecognizePiiEntities\";\n    }\n    case \"keyPhraseExtractionTasks\": {\n      return \"ExtractKeyPhrases\";\n    }\n    case \"entityLinkingTasks\": {\n      return \"RecognizeLinkedEntities\";\n    }\n    case \"sentimentAnalysisTasks\": {\n      return \"AnalyzeSentiment\";\n    }\n    default: {\n      throw new Error(`unexpected action type from the service: ${taskType}`);\n    }\n  }\n}\n\n/**\n * Converts a service action error to one with the JSON pointer converted to an action index.\n * @param erredActions - the action error the service sent\n * @returns an action error with an action type and index\n * @internal\n */\nexport function parseActionError(erredActions: TextAnalyticsError): TextAnalyticsActionError {\n  if (erredActions.target) {\n    const regex = new RegExp(\n      /#\\/tasks\\/(entityRecognitionTasks|entityRecognitionPiiTasks|keyPhraseExtractionTasks|entityLinkingTasks|sentimentAnalysisTasks)\\/(\\d+)/,\n    );\n    const result = regex.exec(erredActions.target);\n    if (result !== null) {\n      return {\n        code: erredActions.code,\n        message: erredActions.message,\n        index: parseInt(result[2]),\n        type: convertTaskTypeToActionType(result[1]),\n      };\n    } else {\n      throw new Error(`Pointer \"${erredActions.target}\" is not a valid action pointer`);\n    }\n  } else {\n    throw new Error(\n      \"expected an error with a target field referencing an action but did not get one\",\n    );\n  }\n}\n\n/**\n * Categorize each action error into a bucket according to its action type.\n * @param erredActions - list of action errors\n * @param recognizeEntitiesActionErrors - a list of recognize entities action errors to be filled from the errors list\n * @param recognizePiiEntitiesActionErrors - a list of recognize pii entities action errors to be filled from the errors list\n * @param extractKeyPhrasesActionErrors - a list of extract key phrases action errors to be filled from the errors list\n * @internal\n */\nfunction categorizeActionErrors(\n  erredActions: TextAnalyticsError[],\n  recognizeEntitiesActionErrors: TextAnalyticsActionError[],\n  recognizePiiEntitiesActionErrors: TextAnalyticsActionError[],\n  extractKeyPhrasesActionErrors: TextAnalyticsActionError[],\n  recognizeLinkedEntitiesActionErrors: TextAnalyticsActionError[],\n  analyzeSentimentActionErrors: TextAnalyticsActionError[],\n): void {\n  for (const error of erredActions) {\n    const actionError = parseActionError(error);\n    switch (actionError.type) {\n      case \"RecognizeCategorizedEntities\": {\n        recognizeEntitiesActionErrors.push(actionError);\n        break;\n      }\n      case \"RecognizePiiEntities\": {\n        recognizePiiEntitiesActionErrors.push(actionError);\n        break;\n      }\n      case \"ExtractKeyPhrases\": {\n        extractKeyPhrasesActionErrors.push(actionError);\n        break;\n      }\n      case \"RecognizeLinkedEntities\": {\n        recognizeLinkedEntitiesActionErrors.push(actionError);\n        break;\n      }\n      case \"AnalyzeSentiment\": {\n        analyzeSentimentActionErrors.push(actionError);\n        break;\n      }\n    }\n  }\n}\n\n/**\n * @internal\n * @param error - the error the service sent for a task\n * @param lastUpdateDateTime - the time when this task failed\n */\nfunction createErredAction(\n  error: TextAnalyticsActionError,\n  lastUpdateDateTime: Date,\n): TextAnalyticsActionErrorResult {\n  return { error: intoTextAnalyticsError(error), failedOn: lastUpdateDateTime };\n}\n\ninterface TaskSuccessResult<T> {\n  results?: T;\n  lastUpdateDateTime: Date;\n}\n\ntype ActionResult<TSuccess> =\n  | {\n      results: TSuccess;\n      completedOn: Date;\n    }\n  | TextAnalyticsActionErrorResult;\n\n/**\n * Creates a list of results for any action.\n * @param documents - list of input documents\n * @param makeResultsArray - a function to convert the results of a service response to the SDK's one\n * @param succeededTasks - list of succeeded action results\n * @param erredActions - list of erred actions\n * @internal\n */\nfunction makeActionResult<TTaskResult, TActionResult>(\n  documents: TextDocumentInput[],\n  makeResultsArray: (docs: TextDocumentInput[], x: TTaskResult) => TActionResult,\n  succeededTasks: TaskSuccessResult<TTaskResult>[],\n  erredActions: TextAnalyticsActionError[],\n): ActionResult<TActionResult>[] {\n  let errorIndex = 0;\n  function convertTasksToActions(\n    actions: ActionResult<TActionResult>[],\n    task: TaskSuccessResult<TTaskResult>,\n  ): ActionResult<TActionResult>[] {\n    const { results: actionResults, lastUpdateDateTime } = task;\n    if (actionResults !== undefined) {\n      const recognizeEntitiesResults = makeResultsArray(documents, actionResults);\n      return [\n        ...actions,\n        {\n          results: recognizeEntitiesResults,\n          completedOn: lastUpdateDateTime,\n        },\n      ];\n    } else {\n      return [...actions, createErredAction(erredActions[errorIndex++], lastUpdateDateTime)];\n    }\n  }\n  return succeededTasks.reduce(convertTasksToActions, []);\n}\n\n/**\n * Creates the user-friendly action results object for the begin analyze actions operation.\n * @param response - the begin analyze actions operation response\n * @param documents - the list of input documents\n * @returns - the user-friendly action results object\n * @internal\n */\nexport function createAnalyzeActionsResult(\n  response: GeneratedResponse,\n  documents: TextDocumentInput[],\n): AnalyzeActionsResult {\n  const recognizeEntitiesActionErrors: TextAnalyticsActionError[] = [];\n  const recognizePiiEntitiesActionErrors: TextAnalyticsActionError[] = [];\n  const extractKeyPhrasesActionErrors: TextAnalyticsActionError[] = [];\n  const recognizeLinkedEntitiesActionErrors: TextAnalyticsActionError[] = [];\n  const analyzeSentimentActionErrors: TextAnalyticsActionError[] = [];\n  categorizeActionErrors(\n    response?.errors ?? [],\n    recognizeEntitiesActionErrors,\n    recognizePiiEntitiesActionErrors,\n    extractKeyPhrasesActionErrors,\n    recognizeLinkedEntitiesActionErrors,\n    analyzeSentimentActionErrors,\n  );\n  return {\n    recognizeEntitiesResults: makeActionResult(\n      documents,\n      makeRecognizeCategorizedEntitiesResultArray,\n      response.tasks.entityRecognitionTasks ?? [],\n      recognizeEntitiesActionErrors,\n    ),\n    recognizePiiEntitiesResults: makeActionResult(\n      documents,\n      makeRecognizePiiEntitiesResultArray,\n      response.tasks.entityRecognitionPiiTasks ?? [],\n      recognizePiiEntitiesActionErrors,\n    ),\n    extractKeyPhrasesResults: makeActionResult(\n      documents,\n      makeExtractKeyPhrasesResultArray,\n      response.tasks.keyPhraseExtractionTasks ?? [],\n      extractKeyPhrasesActionErrors,\n    ),\n    recognizeLinkedEntitiesResults: makeActionResult(\n      documents,\n      makeRecognizeLinkedEntitiesResultArray,\n      response.tasks.entityLinkingTasks ?? [],\n      recognizeLinkedEntitiesActionErrors,\n    ),\n    analyzeSentimentResults: makeActionResult(\n      documents,\n      makeAnalyzeSentimentResultArray,\n      response.tasks.sentimentAnalysisTasks ?? [],\n      analyzeSentimentActionErrors,\n    ),\n  };\n}\n"]}

package/dist/esm/analyzeHealthcareEntitiesResult.d.ts

@@ -0,0 +1,159 @@
+import type { PagedAsyncIterableIterator } from "@azure/core-paging";
+import type { DocumentHealthcareEntities, Entity, HealthcareAssertion, HealthcareEntityCategory, RelationType, TextAnalyticsError, TextDocumentBatchStatistics } from "./generated/models/index.js";
+import type { TextAnalyticsErrorResult, TextAnalyticsSuccessResult } from "./textAnalyticsResult.js";
+/**
+ * A type representing a reference for the healthcare entity into a specific
+ * entity catalog.
+ */
+export interface EntityDataSource {
+    /**
+     * Entity Catalog. Examples include: UMLS, CHV, MSH, etc.
+     */
+    name: string;
+    /**
+     * Entity id in the given source catalog.
+     */
+    entityId: 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.
+ */
+export interface HealthcareEntity extends Entity {
+    /**
+     * Normalized name for the entity. For example, the normalized text for "histologically" is "histologic".
+     */
+    normalizedText?: string;
+    /**
+     * Whether the entity is negated.
+     */
+    assertion?: HealthcareAssertion;
+    /**
+     * Entity references in known data sources.
+     */
+    dataSources: EntityDataSource[];
+    /**
+     * Defines values for HealthcareEntityCategory.
+     * {@link KnownHealthcareEntityCategory} can be used interchangeably with HealthcareEntityCategory,
+     *  this enum contains the known values that the service supports.
+     * ### Known values supported by the service
+     * **BODY_STRUCTURE**
+     * **AGE**
+     * **GENDER**
+     * **EXAMINATION_NAME**
+     * **DATE**
+     * **DIRECTION**
+     * **FREQUENCY**
+     * **MEASUREMENT_VALUE**
+     * **MEASUREMENT_UNIT**
+     * **RELATIONAL_OPERATOR**
+     * **TIME**
+     * **GENE_OR_PROTEIN**
+     * **VARIANT**
+     * **ADMINISTRATIVE_EVENT**
+     * **CARE_ENVIRONMENT**
+     * **HEALTHCARE_PROFESSION**
+     * **DIAGNOSIS**
+     * **SYMPTOM_OR_SIGN**
+     * **CONDITION_QUALIFIER**
+     * **MEDICATION_CLASS**
+     * **MEDICATION_NAME**
+     * **DOSAGE**
+     * **MEDICATION_FORM**
+     * **MEDICATION_ROUTE**
+     * **FAMILY_RELATION**
+     * **TREATMENT_NAME**
+     */
+    category: HealthcareEntityCategory;
+}
+/**
+ * The type of different roles a healthcare entity can play in a relation.
+ */
+export type HealthcareEntityRelationRoleType = string;
+/**
+ * A healthcare entity that plays a specific role in a relation.
+ */
+export interface HealthcareEntityRelationRole {
+    /**
+     * A healthcare entity
+     */
+    entity: HealthcareEntity;
+    /**
+     * The role of the healthcare entity in a particular relation.
+     */
+    name: HealthcareEntityRelationRoleType;
+}
+/**
+ * A relationship between two or more healthcare entities.
+ */
+export interface HealthcareEntityRelation {
+    /**
+     * The type of the healthcare relation.
+     */
+    relationType: RelationType;
+    /**
+     * The list of healthcare entities and their roles in the healthcare relation.
+     */
+    roles: HealthcareEntityRelationRole[];
+}
+/**
+ * The results of a successful healthcare operation for a single document.
+ */
+export interface AnalyzeHealthcareEntitiesSuccessResult extends TextAnalyticsSuccessResult {
+    /**
+     * Healthcare entities.
+     */
+    entities: HealthcareEntity[];
+    /**
+     * Relations between healthcare entities.
+     */
+    entityRelations: HealthcareEntityRelation[];
+}
+/**
+ * An error result from the healthcare operation on a single document.
+ */
+export type AnalyzeHealthcareEntitiesErrorResult = TextAnalyticsErrorResult;
+/**
+ * The result of the healthcare operation on a single document.
+ */
+export type AnalyzeHealthcareEntitiesResult = AnalyzeHealthcareEntitiesSuccessResult | AnalyzeHealthcareEntitiesErrorResult;
+/**
+ * Array of {@link AnalyzeHealthcareEntitiesResult}
+ */
+export interface AnalyzeHealthcareEntitiesResultArray extends Array<AnalyzeHealthcareEntitiesResult> {
+}
+/**
+ * The results of a healthcare operation represented as a paged iterator that can
+ * either iterate over the results on a document-by-document basis or, by
+ * byPage(), can iterate over pages of documents.
+ */
+export type PagedAsyncIterableAnalyzeHealthcareEntitiesResult = PagedAsyncIterableIterator<AnalyzeHealthcareEntitiesResult, AnalyzeHealthcareEntitiesResultArray>;
+/**
+ * The results of a healthcare operation represented as a paged iterator that can
+ * either iterate over the results on a document-by-document basis or, by
+ * byPage(), can iterate over pages of documents.
+ */
+export interface PagedAnalyzeHealthcareEntitiesResult extends PagedAsyncIterableAnalyzeHealthcareEntitiesResult {
+    /**
+     * Statistics about the input document batch and how it was processed
+     * by the service. This property will have a value when includeStatistics is set to true
+     * in the client call.
+     */
+    statistics?: TextDocumentBatchStatistics;
+    /**
+     * The version of the text analytics model used by this operation on this
+     * batch of input documents.
+     */
+    modelVersion: string;
+}
+/**
+ * Creates a healthcare entity in the convenience layer from the one sent by the service.
+ * @param document - incoming results sent by the service for a particular document
+ * @internal
+ */
+export declare function makeHealthcareEntitiesResult(document: DocumentHealthcareEntities): AnalyzeHealthcareEntitiesSuccessResult;
+/**
+ * @internal
+ */
+export declare function makeHealthcareEntitiesErrorResult(id: string, error: TextAnalyticsError): AnalyzeHealthcareEntitiesErrorResult;
+//# sourceMappingURL=analyzeHealthcareEntitiesResult.d.ts.map

package/dist/esm/analyzeHealthcareEntitiesResult.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"analyzeHealthcareEntitiesResult.d.ts","sourceRoot":"","sources":["../../src/analyzeHealthcareEntitiesResult.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,oBAAoB,CAAC;AACrE,OAAO,KAAK,EACV,0BAA0B,EAC1B,MAAM,EAEN,mBAAmB,EACnB,wBAAwB,EAGxB,YAAY,EACZ,kBAAkB,EAClB,2BAA2B,EAC5B,MAAM,6BAA6B,CAAC;AACrC,OAAO,KAAK,EACV,wBAAwB,EACxB,0BAA0B,EAC3B,MAAM,0BAA0B,CAAC;AAOlC;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAiB,SAAQ,MAAM;IAC9C;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,SAAS,CAAC,EAAE,mBAAmB,CAAC;IAChC;;OAEG;IACH,WAAW,EAAE,gBAAgB,EAAE,CAAC;IAChC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,QAAQ,EAAE,wBAAwB,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,MAAM,gCAAgC,GAAG,MAAM,CAAC;AAEtD;;GAEG;AACH,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,MAAM,EAAE,gBAAgB,CAAC;IACzB;;OAEG;IACH,IAAI,EAAE,gCAAgC,CAAC;CACxC;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,YAAY,EAAE,YAAY,CAAC;IAC3B;;OAEG;IACH,KAAK,EAAE,4BAA4B,EAAE,CAAC;CACvC;AAED;;GAEG;AACH,MAAM,WAAW,sCAAuC,SAAQ,0BAA0B;IACxF;;OAEG;IACH,QAAQ,EAAE,gBAAgB,EAAE,CAAC;IAC7B;;OAEG;IACH,eAAe,EAAE,wBAAwB,EAAE,CAAC;CAC7C;AAED;;GAEG;AACH,MAAM,MAAM,oCAAoC,GAAG,wBAAwB,CAAC;AAE5E;;GAEG;AACH,MAAM,MAAM,+BAA+B,GACvC,sCAAsC,GACtC,oCAAoC,CAAC;AAEzC;;GAEG;AACH,MAAM,WAAW,oCACf,SAAQ,KAAK,CAAC,+BAA+B,CAAC;CAAG;AAEnD;;;;GAIG;AACH,MAAM,MAAM,iDAAiD,GAAG,0BAA0B,CACxF,+BAA+B,EAC/B,oCAAoC,CACrC,CAAC;AAEF;;;;GAIG;AACH,MAAM,WAAW,oCACf,SAAQ,iDAAiD;IACzD;;;;OAIG;IACH,UAAU,CAAC,EAAE,2BAA2B,CAAC;IACzC;;;OAGG;IACH,YAAY,EAAE,MAAM,CAAC;CACtB;AA+CD;;;;GAIG;AACH,wBAAgB,4BAA4B,CAC1C,QAAQ,EAAE,0BAA0B,GACnC,sCAAsC,CAQxC;AAED;;GAEG;AACH,wBAAgB,iCAAiC,CAC/C,EAAE,EAAE,MAAM,EACV,KAAK,EAAE,kBAAkB,GACxB,oCAAoC,CAEtC"}

package/dist/esm/analyzeHealthcareEntitiesResult.js

@@ -0,0 +1,53 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+import { makeTextAnalyticsErrorResult, makeTextAnalyticsSuccessResult, } from "./textAnalyticsResult.js";
+import { parseHealthcareEntityIndex } from "./util.js";
+/**
+ * Creates a user-friendly healthcare entity represented as a node in a graph
+ * @param entity - the healthcare entity returned by the service
+ * @internal
+ */
+function makeHealthcareEntitiesWithoutNeighbors(entity) {
+    var _a;
+    const { category, confidenceScore, assertion, offset, text, links, subcategory, length, name } = entity;
+    return {
+        category,
+        confidenceScore,
+        assertion,
+        offset,
+        length,
+        text,
+        normalizedText: name,
+        subCategory: subcategory,
+        dataSources: (_a = links === null || links === void 0 ? void 0 : links.map(({ dataSource, id }) => ({ name: dataSource, entityId: id }))) !== null && _a !== void 0 ? _a : [],
+    };
+}
+/**
+ * @internal
+ */
+function makeHealthcareRelations(entities, relations) {
+    return relations.map((relation) => ({
+        relationType: relation.relationType,
+        roles: relation.entities.map((role) => ({
+            entity: entities[parseHealthcareEntityIndex(role.ref)],
+            name: role.role,
+        })),
+    }));
+}
+/**
+ * Creates a healthcare entity in the convenience layer from the one sent by the service.
+ * @param document - incoming results sent by the service for a particular document
+ * @internal
+ */
+export function makeHealthcareEntitiesResult(document) {
+    const { id, entities, relations, warnings, statistics } = document;
+    const newEntities = entities.map(makeHealthcareEntitiesWithoutNeighbors);
+    return Object.assign(Object.assign({}, makeTextAnalyticsSuccessResult(id, warnings, statistics)), { entities: newEntities, entityRelations: makeHealthcareRelations(newEntities, relations) });
+}
+/**
+ * @internal
+ */
+export function makeHealthcareEntitiesErrorResult(id, error) {
+    return makeTextAnalyticsErrorResult(id, error);
+}
+//# sourceMappingURL=analyzeHealthcareEntitiesResult.js.map

package/dist/esm/analyzeHealthcareEntitiesResult.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"analyzeHealthcareEntitiesResult.js","sourceRoot":"","sources":["../../src/analyzeHealthcareEntitiesResult.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAmBlC,OAAO,EACL,4BAA4B,EAC5B,8BAA8B,GAC/B,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,0BAA0B,EAAE,MAAM,WAAW,CAAC;AAoKvD;;;;GAIG;AACH,SAAS,sCAAsC,CAC7C,MAAiC;;IAEjC,MAAM,EAAE,QAAQ,EAAE,eAAe,EAAE,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,WAAW,EAAE,MAAM,EAAE,IAAI,EAAE,GAC5F,MAAM,CAAC;IACT,OAAO;QACL,QAAQ;QACR,eAAe;QACf,SAAS;QACT,MAAM;QACN,MAAM;QACN,IAAI;QACJ,cAAc,EAAE,IAAI;QACpB,WAAW,EAAE,WAAW;QACxB,WAAW,EACT,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,GAAG,CAAC,CAAC,EAAE,UAAU,EAAE,EAAE,EAAE,EAAoB,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC,CAAC,mCAC1F,EAAE;KACL,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,SAAS,uBAAuB,CAC9B,QAA4B,EAC5B,SAA+B;IAE/B,OAAO,SAAS,CAAC,GAAG,CAClB,CAAC,QAA4B,EAA4B,EAAE,CAAC,CAAC;QAC3D,YAAY,EAAE,QAAQ,CAAC,YAAY;QACnC,KAAK,EAAE,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAC1B,CAAC,IAA8B,EAAgC,EAAE,CAAC,CAAC;YACjE,MAAM,EAAE,QAAQ,CAAC,0BAA0B,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACtD,IAAI,EAAE,IAAI,CAAC,IAAI;SAChB,CAAC,CACH;KACF,CAAC,CACH,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,4BAA4B,CAC1C,QAAoC;IAEpC,MAAM,EAAE,EAAE,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAE,UAAU,EAAE,GAAG,QAAQ,CAAC;IACnE,MAAM,WAAW,GAAG,QAAQ,CAAC,GAAG,CAAC,sCAAsC,CAAC,CAAC;IACzE,uCACK,8BAA8B,CAAC,EAAE,EAAE,QAAQ,EAAE,UAAU,CAAC,KAC3D,QAAQ,EAAE,WAAW,EACrB,eAAe,EAAE,uBAAuB,CAAC,WAAW,EAAE,SAAS,CAAC,IAChE;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,iCAAiC,CAC/C,EAAU,EACV,KAAyB;IAEzB,OAAO,4BAA4B,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;AACjD,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { PagedAsyncIterableIterator } from \"@azure/core-paging\";\nimport type {\n  DocumentHealthcareEntities,\n  Entity,\n  HealthcareEntity as GeneratedHealthcareEntity,\n  HealthcareAssertion,\n  HealthcareEntityCategory,\n  HealthcareRelation,\n  HealthcareRelationEntity,\n  RelationType,\n  TextAnalyticsError,\n  TextDocumentBatchStatistics,\n} from \"./generated/models/index.js\";\nimport type {\n  TextAnalyticsErrorResult,\n  TextAnalyticsSuccessResult,\n} from \"./textAnalyticsResult.js\";\nimport {\n  makeTextAnalyticsErrorResult,\n  makeTextAnalyticsSuccessResult,\n} from \"./textAnalyticsResult.js\";\nimport { parseHealthcareEntityIndex } from \"./util.js\";\n\n/**\n * A type representing a reference for the healthcare entity into a specific\n * entity catalog.\n */\nexport interface EntityDataSource {\n  /**\n   * Entity Catalog. Examples include: UMLS, CHV, MSH, etc.\n   */\n  name: string;\n  /**\n   * Entity id in the given source catalog.\n   */\n  entityId: string;\n}\n\n/**\n * A healthcare entity represented as a node in a directed graph where the edges are\n * a particular type of relationship between the source and target nodes.\n */\nexport interface HealthcareEntity extends Entity {\n  /**\n   * Normalized name for the entity. For example, the normalized text for \"histologically\" is \"histologic\".\n   */\n  normalizedText?: string;\n  /**\n   * Whether the entity is negated.\n   */\n  assertion?: HealthcareAssertion;\n  /**\n   * Entity references in known data sources.\n   */\n  dataSources: EntityDataSource[];\n  /**\n   * Defines values for HealthcareEntityCategory.\n   * {@link KnownHealthcareEntityCategory} can be used interchangeably with HealthcareEntityCategory,\n   *  this enum contains the known values that the service supports.\n   * ### Known values supported by the service\n   * **BODY_STRUCTURE**\n   * **AGE**\n   * **GENDER**\n   * **EXAMINATION_NAME**\n   * **DATE**\n   * **DIRECTION**\n   * **FREQUENCY**\n   * **MEASUREMENT_VALUE**\n   * **MEASUREMENT_UNIT**\n   * **RELATIONAL_OPERATOR**\n   * **TIME**\n   * **GENE_OR_PROTEIN**\n   * **VARIANT**\n   * **ADMINISTRATIVE_EVENT**\n   * **CARE_ENVIRONMENT**\n   * **HEALTHCARE_PROFESSION**\n   * **DIAGNOSIS**\n   * **SYMPTOM_OR_SIGN**\n   * **CONDITION_QUALIFIER**\n   * **MEDICATION_CLASS**\n   * **MEDICATION_NAME**\n   * **DOSAGE**\n   * **MEDICATION_FORM**\n   * **MEDICATION_ROUTE**\n   * **FAMILY_RELATION**\n   * **TREATMENT_NAME**\n   */\n  category: HealthcareEntityCategory;\n}\n\n/**\n * The type of different roles a healthcare entity can play in a relation.\n */\nexport type HealthcareEntityRelationRoleType = string;\n\n/**\n * A healthcare entity that plays a specific role in a relation.\n */\nexport interface HealthcareEntityRelationRole {\n  /**\n   * A healthcare entity\n   */\n  entity: HealthcareEntity;\n  /**\n   * The role of the healthcare entity in a particular relation.\n   */\n  name: HealthcareEntityRelationRoleType;\n}\n\n/**\n * A relationship between two or more healthcare entities.\n */\nexport interface HealthcareEntityRelation {\n  /**\n   * The type of the healthcare relation.\n   */\n  relationType: RelationType;\n  /**\n   * The list of healthcare entities and their roles in the healthcare relation.\n   */\n  roles: HealthcareEntityRelationRole[];\n}\n\n/**\n * The results of a successful healthcare operation for a single document.\n */\nexport interface AnalyzeHealthcareEntitiesSuccessResult extends TextAnalyticsSuccessResult {\n  /**\n   * Healthcare entities.\n   */\n  entities: HealthcareEntity[];\n  /**\n   * Relations between healthcare entities.\n   */\n  entityRelations: HealthcareEntityRelation[];\n}\n\n/**\n * An error result from the healthcare operation on a single document.\n */\nexport type AnalyzeHealthcareEntitiesErrorResult = TextAnalyticsErrorResult;\n\n/**\n * The result of the healthcare operation on a single document.\n */\nexport type AnalyzeHealthcareEntitiesResult =\n  | AnalyzeHealthcareEntitiesSuccessResult\n  | AnalyzeHealthcareEntitiesErrorResult;\n\n/**\n * Array of {@link AnalyzeHealthcareEntitiesResult}\n */\nexport interface AnalyzeHealthcareEntitiesResultArray\n  extends Array<AnalyzeHealthcareEntitiesResult> {}\n\n/**\n * The results of a healthcare operation represented as a paged iterator that can\n * either iterate over the results on a document-by-document basis or, by\n * byPage(), can iterate over pages of documents.\n */\nexport type PagedAsyncIterableAnalyzeHealthcareEntitiesResult = PagedAsyncIterableIterator<\n  AnalyzeHealthcareEntitiesResult,\n  AnalyzeHealthcareEntitiesResultArray\n>;\n\n/**\n * The results of a healthcare operation represented as a paged iterator that can\n * either iterate over the results on a document-by-document basis or, by\n * byPage(), can iterate over pages of documents.\n */\nexport interface PagedAnalyzeHealthcareEntitiesResult\n  extends PagedAsyncIterableAnalyzeHealthcareEntitiesResult {\n  /**\n   * Statistics about the input document batch and how it was processed\n   * by the service. This property will have a value when includeStatistics is set to true\n   * in the client call.\n   */\n  statistics?: TextDocumentBatchStatistics;\n  /**\n   * The version of the text analytics model used by this operation on this\n   * batch of input documents.\n   */\n  modelVersion: string;\n}\n\n/**\n * Creates a user-friendly healthcare entity represented as a node in a graph\n * @param entity - the healthcare entity returned by the service\n * @internal\n */\nfunction makeHealthcareEntitiesWithoutNeighbors(\n  entity: GeneratedHealthcareEntity,\n): HealthcareEntity {\n  const { category, confidenceScore, assertion, offset, text, links, subcategory, length, name } =\n    entity;\n  return {\n    category,\n    confidenceScore,\n    assertion,\n    offset,\n    length,\n    text,\n    normalizedText: name,\n    subCategory: subcategory,\n    dataSources:\n      links?.map(({ dataSource, id }): EntityDataSource => ({ name: dataSource, entityId: id })) ??\n      [],\n  };\n}\n\n/**\n * @internal\n */\nfunction makeHealthcareRelations(\n  entities: HealthcareEntity[],\n  relations: HealthcareRelation[],\n): HealthcareEntityRelation[] {\n  return relations.map(\n    (relation: HealthcareRelation): HealthcareEntityRelation => ({\n      relationType: relation.relationType,\n      roles: relation.entities.map(\n        (role: HealthcareRelationEntity): HealthcareEntityRelationRole => ({\n          entity: entities[parseHealthcareEntityIndex(role.ref)],\n          name: role.role,\n        }),\n      ),\n    }),\n  );\n}\n\n/**\n * Creates a healthcare entity in the convenience layer from the one sent by the service.\n * @param document - incoming results sent by the service for a particular document\n * @internal\n */\nexport function makeHealthcareEntitiesResult(\n  document: DocumentHealthcareEntities,\n): AnalyzeHealthcareEntitiesSuccessResult {\n  const { id, entities, relations, warnings, statistics } = document;\n  const newEntities = entities.map(makeHealthcareEntitiesWithoutNeighbors);\n  return {\n    ...makeTextAnalyticsSuccessResult(id, warnings, statistics),\n    entities: newEntities,\n    entityRelations: makeHealthcareRelations(newEntities, relations),\n  };\n}\n\n/**\n * @internal\n */\nexport function makeHealthcareEntitiesErrorResult(\n  id: string,\n  error: TextAnalyticsError,\n): AnalyzeHealthcareEntitiesErrorResult {\n  return makeTextAnalyticsErrorResult(id, error);\n}\n"]}