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

package/dist-esm/src/textAnalyticsOperationOptions.js

@@ -1,4 +0,0 @@
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
-export {};
-//# sourceMappingURL=textAnalyticsOperationOptions.js.map

package/dist-esm/src/textAnalyticsOperationOptions.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"textAnalyticsOperationOptions.js","sourceRoot":"","sources":["../../src/textAnalyticsOperationOptions.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport { OperationOptions } from \"@azure/core-client\";\n\n/**\n * Options common to all text analytics operations.\n */\nexport interface TextAnalyticsOperationOptions extends OperationOptions {\n  /**\n   * This value indicates which model will be used for scoring. If a model-version is\n   * not specified, the API should default to the latest, non-preview version.\n   * For supported model versions, see operation-specific documentation, for example:\n   * https://docs.microsoft.com/azure/cognitive-services/text-analytics/how-tos/text-analytics-how-to-sentiment-analysis#model-versioning\n   */\n  modelVersion?: string;\n  /**\n   * If set to true, response will contain input and document level statistics.\n   */\n  includeStatistics?: boolean;\n  /**\n   * If set to true (the default for `beginAnalyzeHealthcareEntities` and `recognizePiiEntities`),\n   * you opt-out of having your text input logged for troubleshooting. By default, Text Analytics\n   * logs your input text for 48 hours, solely to allow for troubleshooting issues. Setting this\n   * parameter to true, disables input logging and may limit our ability to remediate issues that\n   * occur.\n   */\n  disableServiceLogs?: boolean;\n}\n"]}

package/dist-esm/src/textAnalyticsResult.js

@@ -1,94 +0,0 @@
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
-import { sortResponseIdObjects } from "./util";
-/**
- * Helper function for converting nested service error into
- * the unified TextAnalyticsError
- * @internal
- */
-export function intoTextAnalyticsError(errorModel) {
-    // Return the deepest error. This will always be at most
-    // one level for TextAnalytics
-    if (errorModel.innererror !== undefined) {
-        return intoTextAnalyticsError(errorModel.innererror);
-    }
-    return {
-        code: errorModel.code,
-        message: errorModel.message,
-        target: errorModel.target
-    };
-}
-/**
- * @internal
- */
-export function makeTextAnalyticsSuccessResult(id, warnings, statistics) {
-    return {
-        id,
-        statistics,
-        warnings
-    };
-}
-/**
- * @internal
- */
-export function makeTextAnalyticsErrorResult(id, error) {
-    return {
-        id,
-        error: intoTextAnalyticsError(error)
-    };
-}
-/**
- * @internal
- * combines successful and erroneous results into a single array of results and
- * sort them so that the IDs order match that of the input documents array.
- * @param input - the array of documents sent to the service for processing.
- * @param response - the response received from the service.
- */
-export function combineSuccessfulAndErroneousDocuments(input, response) {
-    return processAndCombineSuccessfulAndErroneousDocuments(input, response, (x) => x, makeTextAnalyticsErrorResult);
-}
-/**
- * @internal
- * combines successful and erroneous results into a single array of results and
- * sort them so that the IDs order match that of the input documents array.
- * @param input - the array of documents sent to the service for processing.
- * @param response - the response received from the service.
- * @param process - a function to convert the results from one type to another.
- */
-export function processAndCombineSuccessfulAndErroneousDocuments(input, response, processSuccess, processError) {
-    const successResults = response.documents.map(processSuccess);
-    const unsortedResults = successResults.concat(response.errors.map((error) => processError(error.id, error.error)));
-    return sortResponseIdObjects(input, unsortedResults);
-}
-/**
- * @internal
- * combines successful and erroneous results into a single array of results and
- * sort them so that the IDs order match that of the input documents array. It
- * also attaches statistics and modelVersion to the returned array.
- * @param input - the array of documents sent to the service for processing.
- * @param response - the response received from the service.
- */
-export function combineSuccessfulAndErroneousDocumentsWithStatisticsAndModelVersion(input, response, processSuccess, processError) {
-    const sorted = processAndCombineSuccessfulAndErroneousDocuments(input, response, processSuccess, processError);
-    return Object.assign(sorted, {
-        statistics: response.statistics,
-        modelVersion: response.modelVersion
-    });
-}
-/**
- * @internal
- * combines successful and erroneous results into a single array of results and
- * sort them so that the IDs order match that of the input documents array. It
- * also attaches statistics, projectName, and deploymentName to the returned array.
- * @param input - the array of documents sent to the service for processing.
- * @param response - the response received from the service.
- */
-export function combineSuccessfulAndErroneousDocumentsWithStatisticsAndCustomProjectInfo(input, response, processSuccess, processError) {
-    const sorted = processAndCombineSuccessfulAndErroneousDocuments(input, response, processSuccess, processError);
-    return Object.assign(sorted, {
-        statistics: response.statistics,
-        projectName: response.projectName,
-        deploymentName: response.deploymentName
-    });
-}
-//# sourceMappingURL=textAnalyticsResult.js.map

package/dist-esm/src/textAnalyticsResult.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"textAnalyticsResult.js","sourceRoot":"","sources":["../../src/textAnalyticsResult.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAalC,OAAO,EAAE,qBAAqB,EAAE,MAAM,QAAQ,CAAC;AAuK/C;;;;GAIG;AACH,MAAM,UAAU,sBAAsB,CACpC,UAAyD;IAEzD,wDAAwD;IACxD,8BAA8B;IAC9B,IAAI,UAAU,CAAC,UAAU,KAAK,SAAS,EAAE;QACvC,OAAO,sBAAsB,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;KACtD;IAED,OAAO;QACL,IAAI,EAAE,UAAU,CAAC,IAAI;QACrB,OAAO,EAAE,UAAU,CAAC,OAAO;QAC3B,MAAM,EAAE,UAAU,CAAC,MAAM;KAC1B,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,8BAA8B,CAC5C,EAAU,EACV,QAAgC,EAChC,UAAmC;IAEnC,OAAO;QACL,EAAE;QACF,UAAU;QACV,QAAQ;KACT,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,4BAA4B,CAC1C,EAAU,EACV,KAAuC;IAEvC,OAAO;QACL,EAAE;QACF,KAAK,EAAE,sBAAsB,CAAC,KAAK,CAAC;KACrC,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,sCAAsC,CACpD,KAA0B,EAC1B,QAAiD;IAEjD,OAAO,gDAAgD,CACrD,KAAK,EACL,QAAQ,EACR,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EACR,4BAA4B,CAC7B,CAAC;AACJ,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,gDAAgD,CAK9D,KAA0B,EAC1B,QAGC,EACD,cAA+D,EAC/D,YAA6E;IAE7E,MAAM,cAAc,GAA+C,QAAQ,CAAC,SAAS,CAAC,GAAG,CACvF,cAAc,CACf,CAAC;IACF,MAAM,eAAe,GAAG,cAAc,CAAC,MAAM,CAC3C,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,CACpE,CAAC;IAEF,OAAO,qBAAqB,CAAC,KAAK,EAAE,eAAe,CAAC,CAAC;AACvD,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,mEAAmE,CAKjF,KAA0B,EAC1B,QAAwD,EACxD,cAAqD,EACrD,YAA6E;IAE7E,MAAM,MAAM,GAAG,gDAAgD,CAC7D,KAAK,EACL,QAAQ,EACR,cAAc,EACd,YAAY,CACb,CAAC;IACF,OAAO,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE;QAC3B,UAAU,EAAE,QAAQ,CAAC,UAAU;QAC/B,YAAY,EAAE,QAAQ,CAAC,YAAY;KACpC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,wEAAwE,CAKtF,KAA0B,EAC1B,QAAsD,EACtD,cAAqD,EACrD,YAA6E;IAE7E,MAAM,MAAM,GAAG,gDAAgD,CAC7D,KAAK,EACL,QAAQ,EACR,cAAc,EACd,YAAY,CACb,CAAC;IACF,OAAO,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE;QAC3B,UAAU,EAAE,QAAQ,CAAC,UAAU;QAC/B,WAAW,EAAE,QAAQ,CAAC,WAAW;QACjC,cAAc,EAAE,QAAQ,CAAC,cAAc;KACxC,CAAC,CAAC;AACL,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport {\n  TextDocumentStatistics,\n  TextAnalyticsError as GeneratedTextAnalyticsErrorModel,\n  InnerError,\n  ErrorCodeValue,\n  InnerErrorCodeValue,\n  TextAnalyticsWarning,\n  DocumentError,\n  TextDocumentBatchStatistics,\n  TextDocumentInput\n} from \"./generated/models\";\nimport { sortResponseIdObjects } from \"./util\";\n\n/**\n * The result of a text analytics operation on a single input document.\n * @internal\n */\nexport type TextAnalyticsResult = TextAnalyticsSuccessResult | TextAnalyticsErrorResult;\n\n/**\n * An Error Code returned from the Text Analytics service. Possible\n * values include:\n *\n * For more information about the error, see the `message` property of the associated error.\n */\nexport type ErrorCode = ErrorCodeValue | InnerErrorCodeValue;\n\n/**\n * Type describing an error from the Text Analytics service.\n */\nexport interface TextAnalyticsError {\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 target of the particular error (for example, the name of an invalid parameter)\n   */\n  readonly target?: string;\n}\n\n/**\n * Base type for results of text analytics operations corresponding to a single\n * input document.\n */\nexport interface TextAnalyticsSuccessResult {\n  /**\n   * Unique, non-empty document identifier.\n   */\n  readonly id: string;\n\n  /**\n   * Statistics about the input document 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  readonly statistics?: TextDocumentStatistics;\n\n  /**\n   * An array of warning data corresponding to this document.\n   *\n   * If no warnings were returned, this array will be empty.\n   */\n  readonly warnings: TextAnalyticsWarning[];\n\n  /**\n   * Discriminant to determine if that this is an error result.\n   */\n  readonly error?: undefined;\n}\n\n/**\n * Base type for error results of text analytics operations corresponding to a\n * single document.\n */\nexport interface TextAnalyticsErrorResult {\n  /**\n   * Unique, non-empty document identifier.\n   */\n  readonly id: string;\n\n  /**\n   * The Error for this document result.\n   */\n  readonly error: TextAnalyticsError;\n}\n\n/**\n * @internal\n */\nexport interface StandardTextAnalyticsResultArray<T1 extends TextAnalyticsSuccessResult>\n  extends Array<T1 | TextAnalyticsErrorResult> {\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 * @internal\n */\nexport interface CustomTextAnalyticsResultArray<T1 extends TextAnalyticsSuccessResult>\n  extends Array<T1 | TextAnalyticsErrorResult> {\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   * This field indicates the project name for the model.\n   */\n  projectName: string;\n  /**\n   * This field indicates the deployment name for the model.\n   */\n  deploymentName: string;\n}\n\n/**\n * @internal\n */\nexport interface StandardTextAnalyticsResponse<T1 extends TextAnalyticsSuccessResult> {\n  /**\n   * Response by document\n   */\n  documents: T1[];\n  /**\n   * Errors by document id.\n   */\n  errors: DocumentError[];\n  /**\n   * if includeStatistics=true was specified in the request this field will contain information about the request payload.\n   */\n  statistics?: TextDocumentBatchStatistics;\n  /**\n   * This field indicates which model is used for scoring.\n   */\n  modelVersion: string;\n}\n\n/**\n * @internal\n */\nexport interface CustomTextAnalyticsResponse<T1 extends TextAnalyticsSuccessResult> {\n  /**\n   * Response by document\n   */\n  documents: T1[];\n  /**\n   * Errors by document id.\n   */\n  errors: DocumentError[];\n  /**\n   * if includeStatistics=true was specified in the request this field will contain information about the request payload.\n   */\n  statistics?: TextDocumentBatchStatistics;\n  /**\n   * This field indicates the project name for the model.\n   */\n  projectName: string;\n  /**\n   * This field indicates the deployment name for the model.\n   */\n  deploymentName: string;\n}\n\n/**\n * Helper function for converting nested service error into\n * the unified TextAnalyticsError\n * @internal\n */\nexport function intoTextAnalyticsError(\n  errorModel: GeneratedTextAnalyticsErrorModel | InnerError\n): TextAnalyticsError {\n  // Return the deepest error. This will always be at most\n  // one level for TextAnalytics\n  if (errorModel.innererror !== undefined) {\n    return intoTextAnalyticsError(errorModel.innererror);\n  }\n\n  return {\n    code: errorModel.code,\n    message: errorModel.message,\n    target: errorModel.target\n  };\n}\n\n/**\n * @internal\n */\nexport function makeTextAnalyticsSuccessResult(\n  id: string,\n  warnings: TextAnalyticsWarning[],\n  statistics?: TextDocumentStatistics\n): TextAnalyticsSuccessResult {\n  return {\n    id,\n    statistics,\n    warnings\n  };\n}\n\n/**\n * @internal\n */\nexport function makeTextAnalyticsErrorResult(\n  id: string,\n  error: GeneratedTextAnalyticsErrorModel\n): TextAnalyticsErrorResult {\n  return {\n    id,\n    error: intoTextAnalyticsError(error)\n  };\n}\n\n/**\n * @internal\n * combines successful and erroneous results into a single array of results and\n * sort them so that the IDs order match that of the input documents array.\n * @param input - the array of documents sent to the service for processing.\n * @param response - the response received from the service.\n */\nexport function combineSuccessfulAndErroneousDocuments<TSuccess extends TextAnalyticsSuccessResult>(\n  input: TextDocumentInput[],\n  response: StandardTextAnalyticsResponse<TSuccess>\n): (TSuccess | TextAnalyticsErrorResult)[] {\n  return processAndCombineSuccessfulAndErroneousDocuments(\n    input,\n    response,\n    (x) => x,\n    makeTextAnalyticsErrorResult\n  );\n}\n\n/**\n * @internal\n * combines successful and erroneous results into a single array of results and\n * sort them so that the IDs order match that of the input documents array.\n * @param input - the array of documents sent to the service for processing.\n * @param response - the response received from the service.\n * @param process - a function to convert the results from one type to another.\n */\nexport function processAndCombineSuccessfulAndErroneousDocuments<\n  TSuccessService extends TextAnalyticsSuccessResult,\n  TSuccessSDK extends TextAnalyticsSuccessResult,\n  TError extends TextAnalyticsErrorResult\n>(\n  input: TextDocumentInput[],\n  response: {\n    documents: TSuccessService[];\n    errors: DocumentError[];\n  },\n  processSuccess: (successResult: TSuccessService) => TSuccessSDK,\n  processError: (id: string, error: GeneratedTextAnalyticsErrorModel) => TError\n): (TSuccessSDK | TextAnalyticsErrorResult)[] {\n  const successResults: (TSuccessSDK | TextAnalyticsErrorResult)[] = response.documents.map(\n    processSuccess\n  );\n  const unsortedResults = successResults.concat(\n    response.errors.map((error) => processError(error.id, error.error))\n  );\n\n  return sortResponseIdObjects(input, unsortedResults);\n}\n\n/**\n * @internal\n * combines successful and erroneous results into a single array of results and\n * sort them so that the IDs order match that of the input documents array. It\n * also attaches statistics and modelVersion to the returned array.\n * @param input - the array of documents sent to the service for processing.\n * @param response - the response received from the service.\n */\nexport function combineSuccessfulAndErroneousDocumentsWithStatisticsAndModelVersion<\n  TSuccessService extends TextAnalyticsSuccessResult,\n  TSuccessSDK extends TextAnalyticsSuccessResult,\n  TError extends TextAnalyticsErrorResult\n>(\n  input: TextDocumentInput[],\n  response: StandardTextAnalyticsResponse<TSuccessService>,\n  processSuccess: (doc: TSuccessService) => TSuccessSDK,\n  processError: (id: string, error: GeneratedTextAnalyticsErrorModel) => TError\n): StandardTextAnalyticsResultArray<TSuccessSDK> {\n  const sorted = processAndCombineSuccessfulAndErroneousDocuments(\n    input,\n    response,\n    processSuccess,\n    processError\n  );\n  return Object.assign(sorted, {\n    statistics: response.statistics,\n    modelVersion: response.modelVersion\n  });\n}\n\n/**\n * @internal\n * combines successful and erroneous results into a single array of results and\n * sort them so that the IDs order match that of the input documents array. It\n * also attaches statistics, projectName, and deploymentName to the returned array.\n * @param input - the array of documents sent to the service for processing.\n * @param response - the response received from the service.\n */\nexport function combineSuccessfulAndErroneousDocumentsWithStatisticsAndCustomProjectInfo<\n  TSuccessService extends TextAnalyticsSuccessResult,\n  TSuccessSDK extends TextAnalyticsSuccessResult,\n  TError extends TextAnalyticsErrorResult\n>(\n  input: TextDocumentInput[],\n  response: CustomTextAnalyticsResponse<TSuccessService>,\n  processSuccess: (doc: TSuccessService) => TSuccessSDK,\n  processError: (id: string, error: GeneratedTextAnalyticsErrorModel) => TError\n): CustomTextAnalyticsResultArray<TSuccessSDK> {\n  const sorted = processAndCombineSuccessfulAndErroneousDocuments(\n    input,\n    response,\n    processSuccess,\n    processError\n  );\n  return Object.assign(sorted, {\n    statistics: response.statistics,\n    projectName: response.projectName,\n    deploymentName: response.deploymentName\n  });\n}\n"]}

package/dist-esm/src/tracing.js

@@ -1,12 +0,0 @@
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
-import { createSpanFunction } from "@azure/core-tracing";
-/**
- * Creates a span using the global tracer.
- * @internal
- */
-export const createSpan = createSpanFunction({
-    packagePrefix: "Azure.CognitiveServices.TextAnalytics",
-    namespace: "Microsoft.CognitiveServices"
-});
-//# sourceMappingURL=tracing.js.map

package/dist-esm/src/tracing.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"tracing.js","sourceRoot":"","sources":["../../src/tracing.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,OAAO,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AAEzD;;;GAGG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,kBAAkB,CAAC;IAC3C,aAAa,EAAE,uCAAuC;IACtD,SAAS,EAAE,6BAA6B;CACzC,CAAC,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport { createSpanFunction } from \"@azure/core-tracing\";\n\n/**\n * Creates a span using the global tracer.\n * @internal\n */\nexport const createSpan = createSpanFunction({\n  packagePrefix: \"Azure.CognitiveServices.TextAnalytics\",\n  namespace: \"Microsoft.CognitiveServices\"\n});\n"]}