@azure/ai-text-analytics 5.2.0-alpha.20211027.1 → 5.2.0-beta.2

package/CHANGELOG.md

@@ -1,17 +1,23 @@
 # Release History
 
-## 5.2.0-beta.2 (Unreleased)
+## 5.2.0-beta.2 (2021-11-02)
 
 ### Features Added
 
 - We are now targeting the service's v3.2-preview.2 API as the default instead of v3.2-preview.1.
 - Adding support for a three new actions in `beginAnalyzeActions`: `recognizeCustomEntities`, `singleCategoryClassify`, and `multiCategoryClassify`. The new actions allow you to use custom models to perform entity recognition and classification actions.
 
-### Breaking Changes
+### Other Changes
 
-### Bugs Fixed
+- `beginAnalyzeActions` supports actions to be named and the name is now accessible in each action result.
+- `beginAnalyzeActions` supports multiple actions of the same type so you can pass a list of any particular action type, e.g.
 
-### Other Changes
+    ```typescript
+    await client.beginAnalyzeActions(docs, { recognizePiiEntitiesActions: [
+      { modelVersion: "latest", actionName: "action1" },
+      { modelVersion: "2021-01-15", actionName: "action2" }] 
+    });
+    ```
 
 ## 5.2.0-beta.1 (2021-08-09)
 

package/dist/index.js

@@ -239,6 +239,12 @@ const EntitiesTask = {
                     name: "Composite",
                     className: "EntitiesTaskParameters"
                 }
+            },
+            taskName: {
+                serializedName: "taskName",
+                type: {
+                    name: "String"
+                }
             }
         }
     }
@@ -282,6 +288,12 @@ const PiiTask = {
                     name: "Composite",
                     className: "PiiTaskParameters"
                 }
+            },
+            taskName: {
+                serializedName: "taskName",
+                type: {
+                    name: "String"
+                }
             }
         }
     }
@@ -346,6 +358,12 @@ const KeyPhrasesTask = {
                     name: "Composite",
                     className: "KeyPhrasesTaskParameters"
                 }
+            },
+            taskName: {
+                serializedName: "taskName",
+                type: {
+                    name: "String"
+                }
             }
         }
     }
@@ -383,6 +401,12 @@ const EntityLinkingTask = {
                     name: "Composite",
                     className: "EntityLinkingTaskParameters"
                 }
+            },
+            taskName: {
+                serializedName: "taskName",
+                type: {
+                    name: "String"
+                }
             }
         }
     }
@@ -426,6 +450,12 @@ const SentimentAnalysisTask = {
                     name: "Composite",
                     className: "SentimentAnalysisTaskParameters"
                 }
+            },
+            taskName: {
+                serializedName: "taskName",
+                type: {
+                    name: "String"
+                }
             }
         }
     }
@@ -476,6 +506,12 @@ const ExtractiveSummarizationTask = {
                     name: "Composite",
                     className: "ExtractiveSummarizationTaskParameters"
                 }
+            },
+            taskName: {
+                serializedName: "taskName",
+                type: {
+                    name: "String"
+                }
             }
         }
     }
@@ -533,6 +569,12 @@ const CustomEntitiesTask = {
                     name: "Composite",
                     className: "CustomEntitiesTaskParameters"
                 }
+            },
+            taskName: {
+                serializedName: "taskName",
+                type: {
+                    name: "String"
+                }
             }
         }
     }
@@ -583,6 +625,12 @@ const CustomSingleClassificationTask = {
                     name: "Composite",
                     className: "CustomSingleClassificationTaskParameters"
                 }
+            },
+            taskName: {
+                serializedName: "taskName",
+                type: {
+                    name: "String"
+                }
             }
         }
     }
@@ -627,6 +675,12 @@ const CustomMultiClassificationTask = {
                     name: "Composite",
                     className: "CustomMultiClassificationTaskParameters"
                 }
+            },
+            taskName: {
+                serializedName: "taskName",
+                type: {
+                    name: "String"
+                }
             }
         }
     }
@@ -1000,6 +1054,13 @@ const TaskState = {
                     name: "DateTime"
                 }
             },
+            taskName: {
+                serializedName: "taskName",
+                required: true,
+                type: {
+                    name: "String"
+                }
+            },
             status: {
                 serializedName: "status",
                 required: true,
@@ -4063,32 +4124,42 @@ function addParamsToTask(action) {
     const { actionName } = action, params = tslib.__rest(action, ["actionName"]);
     return { parameters: params, taskName: actionName };
 }
+function appendReadableErrorMessage(currentMessage, innerMessage) {
+    let message = currentMessage;
+    if (message.slice(-1) !== ".") {
+        message = message + ".";
+    }
+    return message + " " + innerMessage;
+}
 /**
  * @internal
  * parses incoming errors from the service and if the inner error code is
  * InvalidDocumentBatch, it exposes that as the statusCode instead.
  * @param error - the incoming error
  */
-function handleInvalidDocumentBatch(error) {
-    var _a, _b, _c, _d, _e, _f, _g, _h;
-    const castError = error;
-    const innerCode = (_d = (_c = (_b = (_a = castError.response) === null || _a === void 0 ? void 0 : _a.parsedBody) === null || _b === void 0 ? void 0 : _b.error) === null || _c === void 0 ? void 0 : _c.innererror) === null || _d === void 0 ? void 0 : _d.code;
-    const innerMessage = (_h = (_g = (_f = (_e = castError.response) === null || _e === void 0 ? void 0 : _e.parsedBody) === null || _f === void 0 ? void 0 : _f.error) === null || _g === void 0 ? void 0 : _g.innererror) === null || _h === void 0 ? void 0 : _h.message;
-    if (innerMessage) {
-        return innerCode === "InvalidDocumentBatch"
-            ? new coreRestPipeline.RestError(innerMessage, { code: innerCode, statusCode: castError.statusCode })
-            : error;
-    }
-    else {
-        // unfortunately, the service currently does not follow the swagger definition
-        // for errors in some cases.
-        // Issue: https://msazure.visualstudio.com/Cognitive%20Services/_workitems/edit/8775003/?workitem=8972164
-        // throw new Error(
-        //   `The error coming from the service does not follow the expected structure: ${error}`
-        // );
-        logger.warning(`The error coming from the service does not follow the expected structure: ${error}`);
+function compileError(errorResponse) {
+    var _a;
+    const castErrorResponse = errorResponse;
+    const topLevelError = (_a = castErrorResponse.response.parsedBody) === null || _a === void 0 ? void 0 : _a.error;
+    if (!topLevelError)
+        return errorResponse;
+    let errorMessage = topLevelError.message || "";
+    let invalidDocumentBatchCode = false;
+    function unwrap(error) {
+        if ((error === null || error === void 0 ? void 0 : error.innererror) !== undefined && error.innererror.message !== undefined) {
+            if (error.innererror.code === "InvalidDocumentBatch") {
+                invalidDocumentBatchCode = true;
+            }
+            errorMessage = appendReadableErrorMessage(errorMessage, error.innererror.message);
+            return unwrap(error.innererror);
+        }
         return error;
     }
+    unwrap(topLevelError);
+    return new coreRestPipeline.RestError(errorMessage, {
+        code: invalidDocumentBatchCode ? "InvalidDocumentBatch" : topLevelError.code,
+        statusCode: castErrorResponse.statusCode
+    });
 }
 /**
  * @internal
@@ -4534,7 +4605,7 @@ class HealthLro {
             };
         }
         catch (e) {
-            const exception = handleInvalidDocumentBatch(e);
+            const exception = compileError(e);
             span.setStatus({
                 code: coreTracing.SpanStatusCode.ERROR,
                 message: exception.message
@@ -4834,8 +4905,12 @@ function categorizeActionErrors(erredActions, recognizeEntitiesActionErrors, rec
  * @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 };
+function createErredAction(error, lastUpdateDateTime, taskName) {
+    return {
+        error: intoTextAnalyticsError(error),
+        failedOn: lastUpdateDateTime,
+        actionName: taskName
+    };
 }
 /**
  * Creates a list of results for any action.
@@ -4848,19 +4923,23 @@ function createErredAction(error, lastUpdateDateTime) {
 function makeActionResult(documents, makeResultsArray, succeededTasks, erredActions) {
     let errorIndex = 0;
     function convertTasksToActions(actions, task) {
-        const { results: actionResults, lastUpdateDateTime } = task;
+        const { results: actionResults, lastUpdateDateTime, taskName } = task;
         if (actionResults !== undefined) {
             const recognizeEntitiesResults = makeResultsArray(documents, actionResults);
             return [
                 ...actions,
                 {
                     results: recognizeEntitiesResults,
-                    completedOn: lastUpdateDateTime
+                    completedOn: lastUpdateDateTime,
+                    actionName: taskName
                 }
             ];
         }
         else {
-            return [...actions, createErredAction(erredActions[errorIndex++], lastUpdateDateTime)];
+            return [
+                ...actions,
+                createErredAction(erredActions[errorIndex++], lastUpdateDateTime, taskName)
+            ];
         }
     }
     return succeededTasks.reduce(convertTasksToActions, []);
@@ -4945,7 +5024,7 @@ class AnalyzeLro {
             };
         }
         catch (e) {
-            const exception = handleInvalidDocumentBatch(e);
+            const exception = compileError(e);
             span.setStatus({
                 code: coreTracing.SpanStatusCode.ERROR,
                 message: exception.message
@@ -5132,7 +5211,7 @@ class TextAnalyticsClient {
              * earlier versions were throwing an exception that included the inner
              * code only.
              */
-            const backwardCompatibleException = handleInvalidDocumentBatch(e);
+            const backwardCompatibleException = compileError(e);
             span.setStatus({
                 code: coreTracing.SpanStatusCode.ERROR,
                 message: backwardCompatibleException.message
@@ -5324,7 +5403,6 @@ class TextAnalyticsClient {
             realInputs = documents;
             realOptions = languageOrOptions || {};
         }
-        validateActions(actions);
         const compiledActions = compileAnalyzeInput(actions);
         const { updateIntervalInMs, resumeFrom, displayName, includeStatistics, onResponse, requestOptions, serializerOptions, abortSignal, tracingOptions } = realOptions;
         const lro = new AnalyzeLro(this.client, {
@@ -5352,20 +5430,6 @@ class TextAnalyticsClient {
         return poller;
     }
 }
-function validateActions(actions) {
-    function validateActionType(actionList, actionType) {
-        var _a;
-        if (((_a = actionList === null || actionList === void 0 ? void 0 : actionList.length) !== null && _a !== void 0 ? _a : 0) > 1) {
-            throw new Error(`beginAnalyzeActions: Currently, the service can accept up to one action only for ${actionType} actions.`);
-        }
-    }
-    validateActionType(actions.analyzeSentimentActions, `analyzeSentiment`);
-    validateActionType(actions.extractKeyPhrasesActions, `extractKeyPhrases`);
-    validateActionType(actions.recognizeEntitiesActions, `recognizeEntities`);
-    validateActionType(actions.recognizeLinkedEntitiesActions, `recognizeLinkedEntities`);
-    validateActionType(actions.recognizePiiEntitiesActions, `recognizePiiEntities`);
-    validateActionType(actions.extractSummaryActions, `extractSummary`);
-}
 /**
  * @internal
  */