@azure/ai-language-text 1.1.0-beta.1 → 1.1.0-beta.2

package/dist/index.js

@@ -41,7 +41,7 @@ const DEFAULT_COGNITIVE_SCOPE = "https://cognitiveservices.azure.com/.default";
 /**
  * @internal
  */
-const SDK_VERSION = "1.1.0-beta.1";
+const SDK_VERSION = "1.1.0-beta.2";
 /**
  * @internal
  */
@@ -166,6 +166,21 @@ function getOperationOptions(options) {
         rest,
     };
 }
+/**
+ *
+ * @param error - error with the target in the JSON error pointer format "#/items/0
+ * @returns number: the position of the task with error
+ */
+function extractErrorPointerIndex(error) {
+    if (!error.target) {
+        throw new Error("Unexpected response from service - no target present");
+    }
+    const position = parseInt(error.target.split("/").pop());
+    if (isNaN(position)) {
+        throw new Error(`Unexpected response from service - action pointer "${error.target}" is not a valid action pointer.`);
+    }
+    return position;
+}
 
 /*
  * Copyright (c) Microsoft Corporation.
@@ -330,12 +345,6 @@ const AnalyzeTextJobsInput = {
                     name: "String"
                 }
             },
-            defaultLanguage: {
-                serializedName: "defaultLanguage",
-                type: {
-                    name: "String"
-                }
-            },
             analysisInput: {
                 serializedName: "analysisInput",
                 type: {
@@ -1646,7 +1655,7 @@ const AbstractiveSummarizationTaskParametersBase = {
         name: "Composite",
         className: "AbstractiveSummarizationTaskParametersBase",
         modelProperties: {
-            maxSentenceCount: {
+            sentenceCount: {
                 serializedName: "sentenceCount",
                 type: {
                     name: "Number"
@@ -1697,6 +1706,7 @@ const AbstractiveSummary = {
             },
             contexts: {
                 serializedName: "contexts",
+                required: true,
                 type: {
                     name: "Sequence",
                     element: {
@@ -4076,74 +4086,172 @@ function toHealthcareResult(docIds, results) {
 /**
  * @internal
  */
-function transformAnalyzeBatchResults(docIds, response = []) {
-    return response.map((actionData) => {
-        const { lastUpdateDateTime: completedOn, actionName, kind } = actionData;
-        switch (kind) {
+function transformAnalyzeBatchResults(docIds, response = [], errors = []) {
+    const errorMap = toIndexErrorMap(errors);
+    return response.map((actionData, idx) => {
+        const { lastUpdateDateTime: completedOn, actionName, kind: resultKind } = actionData;
+        const error = errorMap.get(idx);
+        switch (resultKind) {
             case "SentimentAnalysisLROResults": {
+                const kind = "SentimentAnalysis";
+                if (actionData.status === "failed") {
+                    return returnErrorTask(kind, error, completedOn);
+                }
                 const { results } = actionData;
                 const { modelVersion, statistics } = results;
-                return Object.assign(Object.assign(Object.assign({ kind: "SentimentAnalysis", results: toSentimentAnalysisResult(docIds, results), completedOn }, (actionName ? { actionName } : {})), (statistics ? { statistics } : {})), { modelVersion });
+                return Object.assign(Object.assign(Object.assign({ kind, results: toSentimentAnalysisResult(docIds, results), completedOn }, (actionName ? { actionName } : {})), (statistics ? { statistics } : {})), { modelVersion });
             }
             case "EntityRecognitionLROResults": {
+                const kind = "EntityRecognition";
+                if (actionData.status === "failed") {
+                    return returnErrorTask(kind, error, completedOn);
+                }
                 const { results } = actionData;
                 const { modelVersion, statistics } = results;
                 return Object.assign(Object.assign(Object.assign({ kind: "EntityRecognition", results: toEntityRecognitionResult(docIds, results), completedOn }, (actionName ? { actionName } : {})), (statistics ? { statistics } : {})), { modelVersion });
             }
             case "PiiEntityRecognitionLROResults": {
+                const kind = "PiiEntityRecognition";
+                if (actionData.status === "failed") {
+                    return returnErrorTask(kind, error, completedOn);
+                }
                 const { results } = actionData;
                 const { modelVersion, statistics } = results;
-                return Object.assign(Object.assign(Object.assign({ kind: "PiiEntityRecognition", results: toPiiEntityRecognitionResult(docIds, results), completedOn }, (actionName ? { actionName } : {})), (statistics ? { statistics } : {})), { modelVersion });
+                return Object.assign(Object.assign(Object.assign({ kind, results: toPiiEntityRecognitionResult(docIds, results), completedOn }, (actionName ? { actionName } : {})), (statistics ? { statistics } : {})), { modelVersion });
             }
             case "KeyPhraseExtractionLROResults": {
+                const kind = "KeyPhraseExtraction";
+                if (actionData.status === "failed") {
+                    return returnErrorTask(kind, error, completedOn);
+                }
                 const { results } = actionData;
                 const { modelVersion, statistics } = results;
-                return Object.assign(Object.assign(Object.assign({ kind: "KeyPhraseExtraction", results: toKeyPhraseExtractionResult(docIds, results), completedOn }, (actionName ? { actionName } : {})), (statistics ? { statistics } : {})), { modelVersion });
+                return Object.assign(Object.assign(Object.assign({ kind, results: toKeyPhraseExtractionResult(docIds, results), completedOn }, (actionName ? { actionName } : {})), (statistics ? { statistics } : {})), { modelVersion });
             }
             case "EntityLinkingLROResults": {
+                const kind = "EntityLinking";
+                if (actionData.status === "failed") {
+                    return returnErrorTask(kind, error, completedOn);
+                }
                 const { results } = actionData;
                 const { modelVersion, statistics } = results;
-                return Object.assign(Object.assign(Object.assign({ kind: "EntityLinking", results: toEntityLinkingResult(docIds, results), completedOn }, (actionName ? { actionName } : {})), (statistics ? { statistics } : {})), { modelVersion });
+                return Object.assign(Object.assign(Object.assign({ kind, results: toEntityLinkingResult(docIds, results), completedOn }, (actionName ? { actionName } : {})), (statistics ? { statistics } : {})), { modelVersion });
             }
             case "HealthcareLROResults": {
+                const kind = "Healthcare";
+                if (actionData.status === "failed") {
+                    return returnErrorTask(kind, error, completedOn);
+                }
                 const { results } = actionData;
                 const { modelVersion, statistics } = results;
-                return Object.assign(Object.assign(Object.assign({ kind: "Healthcare", results: toHealthcareResult(docIds, results), completedOn }, (actionName ? { actionName } : {})), (statistics ? { statistics } : {})), { modelVersion });
+                return Object.assign(Object.assign(Object.assign({ kind, results: toHealthcareResult(docIds, results), completedOn }, (actionName ? { actionName } : {})), (statistics ? { statistics } : {})), { modelVersion });
             }
             case "CustomEntityRecognitionLROResults": {
+                const kind = "CustomEntityRecognition";
+                if (actionData.status === "failed") {
+                    return returnErrorCustomTask(kind, error, completedOn);
+                }
                 const { results } = actionData;
                 const { deploymentName, projectName, statistics } = results;
-                return Object.assign(Object.assign(Object.assign({ kind: "CustomEntityRecognition", results: transformDocumentResults(docIds, results), completedOn }, (actionName ? { actionName } : {})), (statistics ? { statistics } : {})), { deploymentName,
+                return Object.assign(Object.assign(Object.assign({ kind, results: transformDocumentResults(docIds, results), completedOn }, (actionName ? { actionName } : {})), (statistics ? { statistics } : {})), { deploymentName,
                     projectName });
             }
             case "CustomSingleLabelClassificationLROResults": {
+                const kind = "CustomSingleLabelClassification";
+                if (actionData.status === "failed") {
+                    return returnErrorCustomTask(kind, error, completedOn);
+                }
                 const { results } = actionData;
                 const { deploymentName, projectName, statistics } = results;
-                return Object.assign(Object.assign(Object.assign({ kind: "CustomSingleLabelClassification", results: transformDocumentResults(docIds, results), completedOn }, (actionName ? { actionName } : {})), (statistics ? { statistics } : {})), { deploymentName,
+                return Object.assign(Object.assign(Object.assign({ kind, results: transformDocumentResults(docIds, results), completedOn }, (actionName ? { actionName } : {})), (statistics ? { statistics } : {})), { deploymentName,
                     projectName });
             }
             case "CustomMultiLabelClassificationLROResults": {
+                const kind = "CustomMultiLabelClassification";
+                if (actionData.status === "failed") {
+                    return returnErrorCustomTask(kind, error, completedOn);
+                }
                 const { results } = actionData;
                 const { deploymentName, projectName, statistics } = results;
-                return Object.assign(Object.assign(Object.assign({ kind: "CustomMultiLabelClassification", results: transformDocumentResults(docIds, results), completedOn }, (actionName ? { actionName } : {})), (statistics ? { statistics } : {})), { deploymentName,
+                return Object.assign(Object.assign(Object.assign({ kind, results: transformDocumentResults(docIds, results), completedOn }, (actionName ? { actionName } : {})), (statistics ? { statistics } : {})), { deploymentName,
                     projectName });
             }
             case "ExtractiveSummarizationLROResults": {
+                const kind = "ExtractiveSummarization";
+                if (actionData.status === "failed") {
+                    return returnErrorTask(kind, error, completedOn);
+                }
                 const { results } = actionData;
                 const { modelVersion, statistics } = results;
-                return Object.assign(Object.assign(Object.assign({ kind: "ExtractiveSummarization", results: transformDocumentResults(docIds, results), completedOn }, (actionName ? { actionName } : {})), (statistics ? { statistics } : {})), { modelVersion });
+                return Object.assign(Object.assign(Object.assign({ kind, results: transformDocumentResults(docIds, results), completedOn }, (actionName ? { actionName } : {})), (statistics ? { statistics } : {})), { modelVersion });
             }
             case "AbstractiveSummarizationLROResults": {
+                const kind = "AbstractiveSummarization";
+                if (actionData.status === "failed") {
+                    return returnErrorTask(kind, error, completedOn);
+                }
                 const { results } = actionData;
                 const { modelVersion, statistics } = results;
-                return Object.assign(Object.assign(Object.assign({ kind: "AbstractiveSummarization", results: transformDocumentResults(docIds, results), completedOn }, (actionName ? { actionName } : {})), (statistics ? { statistics } : {})), { modelVersion });
+                return Object.assign(Object.assign(Object.assign({ kind, results: transformDocumentResults(docIds, results), completedOn }, (actionName ? { actionName } : {})), (statistics ? { statistics } : {})), { modelVersion });
             }
             default: {
-                throw new Error(`Unsupported results kind: ${kind}`);
+                throw new Error(`Unsupported results kind: ${resultKind}`);
             }
         }
     });
 }
+/**
+ * @internal
+ * Transform a list of error into index and error Map
+ */
+function toIndexErrorMap(errors) {
+    const errorMap = new Map();
+    for (const error of errors) {
+        const position = extractErrorPointerIndex(error);
+        const errorWithoutTarget = tslib.__rest(error, ["target"]);
+        errorMap.set(position, toTextAnalysisError(errorWithoutTarget));
+    }
+    return errorMap;
+}
+/**
+ * Return the error for non-custom task
+ *
+ * @param kind - non custom task kind
+ * @param error - error returned from the service
+ * @param failedOn - the LastUpdateDateTime from the service
+ * @returns - AnalyzeBatchResult with error
+ */
+function returnErrorTask(kind, error, failedOn) {
+    if (!error) {
+        throw new Error("Unexpected response from service - no errors for missing action results.");
+    }
+    return {
+        kind,
+        modelVersion: "",
+        failedOn,
+        error,
+    };
+}
+/**
+ * Return the error for non-custom task
+ *
+ * @param kind - non custom task kind
+ * @param error - error returned from the service
+ * @param failedOn - the LastUpdateDateTime from the service
+ * @returns AnalyzeBatchResult for custom task with error
+ */
+function returnErrorCustomTask(kind, error, failedOn) {
+    if (!error) {
+        throw new Error("Unexpected response from service - no errors for missing action results.");
+    }
+    return {
+        kind,
+        projectName: "",
+        deploymentName: "",
+        failedOn,
+        error,
+    };
+}
 
 // Copyright (c) Microsoft Corporation.
 const serializer$2 = coreClient.createSerializer(Mappers, /* isXml */ false);
@@ -4161,13 +4269,24 @@ const jobStatusOperationSpec$1 = {
     queryParameters: [top, skip, includeStatistics],
     serializer: serializer$2,
 };
+function addOnResponse(options, cb) {
+    return Object.assign(Object.assign({}, options), { onResponse: (rawResponse, response, error) => {
+            var _a;
+            cb(rawResponse, response, error);
+            (_a = options.onResponse) === null || _a === void 0 ? void 0 : _a.call(options, rawResponse, response, error);
+        } });
+}
+function logWarnHeader(rawResponse) {
+    const warnHeader = rawResponse.headers.get("warn-text");
+    if (warnHeader) {
+        warnHeader.split(";").map((x) => logger.warning(x));
+    }
+}
 async function getRawResponse(getResponse, options) {
-    const { onResponse } = options || {};
     let rawResponse;
-    const flatResponse = await getResponse(Object.assign(Object.assign({}, options), { onResponse: (response, flatResponseParam) => {
-            rawResponse = response;
-            onResponse === null || onResponse === void 0 ? void 0 : onResponse(response, flatResponseParam);
-        } }));
+    const flatResponse = await getResponse(addOnResponse(options, (response) => {
+        rawResponse = response;
+    }));
     return {
         flatResponse,
         rawResponse: {
@@ -4190,7 +4309,12 @@ function createSendPollRequest(settings) {
     return async (path) => {
         return throwError(sendRequest({
             client,
-            opOptions: options,
+            opOptions: addOnResponse(options, (_, response) => {
+                const castResponse = response;
+                if (castResponse.status.toLowerCase() === "partiallysucceeded") {
+                    castResponse.status = "succeeded";
+                }
+            }),
             path,
             spanStr,
             spec: jobStatusOperationSpec$1,
@@ -4205,7 +4329,7 @@ function createAnalyzeBatchLro(settings) {
     const { client, commonOptions, documents, initialRequestOptions, pollRequestOptions, tasks, tracing, } = settings;
     return {
         async sendInitialRequest() {
-            return tracing.withSpan(`${clientName}.beginAnalyzeBatch`, Object.assign(Object.assign({}, commonOptions), initialRequestOptions), async (finalOptions) => throwError(getRawResponse((paramOptions) => client.analyzeBatch({
+            return tracing.withSpan(`${clientName}.beginAnalyzeBatch`, addOnResponse(Object.assign(Object.assign({}, commonOptions), initialRequestOptions), logWarnHeader), async (finalOptions) => throwError(getRawResponse((paramOptions) => client.analyzeBatch({
                 tasks,
                 analysisInput: {
                     documents,
@@ -4273,7 +4397,7 @@ function processAnalyzeResult(options) {
                 });
                 const flatResponse = response.flatResponse;
                 return {
-                    page: transformAnalyzeBatchResults(docIds, flatResponse.tasks.items),
+                    page: transformAnalyzeBatchResults(docIds, flatResponse.tasks.items, flatResponse.errors),
                     nextPageLink: flatResponse.nextLink,
                 };
             },
@@ -4414,13 +4538,13 @@ class GeneratedClient extends coreClient__namespace.ServiceClient {
         const defaults = {
             requestContentType: "application/json; charset=utf-8"
         };
-        const packageDetails = `azsdk-js-ai-language-text/1.1.0-beta.1`;
+        const packageDetails = `azsdk-js-ai-language-text/1.1.0-beta.2`;
         const userAgentPrefix = options.userAgentOptions && options.userAgentOptions.userAgentPrefix
             ? `${options.userAgentOptions.userAgentPrefix} ${packageDetails}`
             : `${packageDetails}`;
         const optionsWithDefaults = Object.assign(Object.assign(Object.assign({}, defaults), options), { userAgentOptions: {
                 userAgentPrefix
-            }, baseUri: (_b = (_a = options.endpoint) !== null && _a !== void 0 ? _a : options.baseUri) !== null && _b !== void 0 ? _b : "{Endpoint}/language" });
+            }, endpoint: (_b = (_a = options.endpoint) !== null && _a !== void 0 ? _a : options.baseUri) !== null && _b !== void 0 ? _b : "{Endpoint}/language" });
         super(optionsWithDefaults);
         // Parameter assignments
         this.endpoint = endpoint;
@@ -4639,8 +4763,8 @@ class TextAnalysisClient {
             throw new Error("'documents' must be a non-empty array");
         }
         if (isStringArray(documents)) {
-            const languageHint = (_a = languageOrOptions) !== null && _a !== void 0 ? _a : this.defaultLanguage;
-            realInputs = convertToTextDocumentInput(documents, languageHint);
+            const languageCode = (_a = languageOrOptions) !== null && _a !== void 0 ? _a : this.defaultLanguage;
+            realInputs = convertToTextDocumentInput(documents, languageCode);
             realOptions = options;
         }
         else {