@azure/ai-text-analytics 5.1.1-alpha.20210730.2 → 5.1.1-alpha.20220725.1

package/package.json

@@ -3,7 +3,7 @@
   "sdk-type": "client",
   "author": "Microsoft Corporation",
   "description": "An isomorphic client library for the Azure Text Analytics service.",
-  "version": "5.1.1-alpha.20210730.2",
+  "version": "5.1.1-alpha.20220725.1",
   "keywords": [
     "node",
     "azure",
@@ -34,6 +34,10 @@
         "path": "src/generated/generatedClientContext.ts",
         "prefix": "packageDetails"
       },
+      {
+        "path": "src/constants.ts",
+        "prefix": "SDK_VERSION"
+      },
       {
         "path": "swagger/README.md",
         "prefix": "package-version"
@@ -60,53 +64,51 @@
   },
   "scripts": {
     "audit": "node ../../../common/scripts/rush-audit.js && rimraf node_modules package-lock.json && npm i --package-lock-only 2>&1 && npm audit",
-    "build:browser": "tsc -p . && cross-env ONLY_BROWSER=true rollup -c 2>&1",
-    "build:node": "tsc -p . && cross-env ONLY_NODE=true rollup -c 2>&1",
+    "build:browser": "tsc -p . && dev-tool run bundle",
+    "build:node": "tsc -p . && dev-tool run bundle",
     "build:samples": "echo Obsolete.",
-    "build:test": "tsc -p . && rollup -c 2>&1",
-    "build": "tsc -p . && rollup -c 2>&1 && api-extractor run --local",
-    "build:debug": "tsc -p . && rollup -c 2>&1 && api-extractor run --local",
+    "build:test": "tsc -p . && dev-tool run bundle",
+    "build": "npm run clean && tsc -p . && dev-tool run bundle && api-extractor run --local",
+    "build:debug": "tsc -p . && dev-tool run bundle && api-extractor run --local",
     "check-format": "prettier --list-different --config ../../../.prettierrc.json --ignore-path ../../../.prettierignore \"src/**/*.ts\" \"test/**/*.ts\" \"samples-dev/**/*.ts\" \"*.{js,json}\"",
     "clean": "rimraf dist dist-* temp types *.tgz *.log",
     "execute:samples": "dev-tool samples run samples-dev",
     "extract-api": "tsc -p . && api-extractor run --local",
     "format": "prettier --write --config ../../../.prettierrc.json --ignore-path ../../../.prettierignore \"src/**/*.ts\" \"test/**/*.ts\" \"samples-dev/**/*.ts\" \"*.{js,json}\"",
-    "integration-test:browser": "karma start --single-run",
-    "integration-test:node": "nyc mocha -r esm --require source-map-support/register --reporter ../../../common/tools/mocha-multi-reporter.js --timeout 5000000 --full-trace \"dist-esm/test/{,!(browser)/**/}*.spec.js\"",
+    "integration-test:browser": "dev-tool run test:browser",
+    "integration-test:node": "dev-tool run test:node-js-input -- --timeout 5000000 \"dist-esm/test/**/*.spec.js\"",
     "integration-test": "npm run integration-test:node && npm run integration-test:browser",
     "lint:fix": "eslint package.json api-extractor.json src test --ext .ts --fix --fix-type [problem,suggestion]",
     "lint": "eslint package.json api-extractor.json src test --ext .ts",
     "pack": "npm pack 2>&1",
-    "prebuild": "npm run clean",
     "test:browser": "npm run clean && npm run build:test && npm run unit-test:browser",
     "test:node": "npm run clean && npm run build:test && npm run unit-test:node",
     "test": "npm run clean && npm run build:test && npm run unit-test",
-    "unit-test:browser": "karma start --single-run",
-    "unit-test:node": "mocha -r esm --require ts-node/register --reporter ../../../common/tools/mocha-multi-reporter.js --timeout 1200000 --full-trace \"test/{,!(browser)/**/}*.spec.ts\"",
-    "unit-test": "npm run unit-test:node && npm run unit-test:browser",
-    "docs": "typedoc --excludePrivate --excludeNotExported --excludeExternals --stripInternal --mode file --out ./dist/docs ./src"
+    "unit-test:browser": "dev-tool run test:browser",
+    "unit-test:node": "dev-tool run test:node-ts-input -- --timeout 1200000 \"test/**/*.spec.ts\"",
+    "unit-test": "npm run unit-test:node && npm run unit-test:browser"
   },
   "sideEffects": false,
   "autoPublish": false,
   "dependencies": {
-    "@azure/abort-controller": "^1.0.0",
-    "@azure/core-asynciterator-polyfill": "^1.0.0",
+    "@azure/abort-controller": "^1.1.0",
     "@azure/core-auth": "^1.3.0",
     "@azure/core-client": "^1.0.0",
-    "@azure/core-rest-pipeline": "^1.1.0",
-    "@azure/core-lro": "^2.0.0",
-    "@azure/core-paging": "^1.1.1",
-    "@azure/core-tracing": "1.0.0-preview.13",
+    "@azure/core-rest-pipeline": "^1.8.1",
+    "@azure/core-lro": "^2.2.0",
+    "@azure/core-paging": "^1.3.0",
+    "@azure/core-tracing": "^1.0.0",
     "@azure/logger": "^1.0.0",
     "tslib": "^2.2.0"
   },
   "devDependencies": {
-    "@azure/dev-tool": "^1.0.0-alpha",
-    "@azure/eslint-plugin-azure-sdk": "^3.0.0-alpha",
-    "@azure/identity": "2.0.0-beta.4",
-    "@azure/test-utils": "^1.0.0-alpha",
-    "@azure/test-utils-recorder": "^1.0.0-alpha",
-    "@microsoft/api-extractor": "7.7.11",
+    "@azure/dev-tool": ">=1.0.0-alpha <1.0.0-alphb",
+    "@azure/eslint-plugin-azure-sdk": ">=3.0.0-alpha <3.0.0-alphb",
+    "@azure/identity": "^2.0.1",
+    "@azure/test-utils": ">=1.0.0-alpha <1.0.0-alphb",
+    "@azure-tools/test-recorder": "^2.0.0",
+    "@azure-tools/test-credential": ">=1.0.0-alpha <1.0.0-alphb",
+    "@microsoft/api-extractor": "7.18.11",
     "@types/chai": "^4.1.6",
     "@types/chai-as-promised": "^7.1.0",
     "@types/mocha": "^7.0.2",
@@ -116,7 +118,7 @@
     "chai-as-promised": "^7.1.1",
     "cross-env": "^7.0.2",
     "dotenv": "^8.2.0",
-    "eslint": "^7.15.0",
+    "eslint": "^8.0.0",
     "karma": "^6.2.0",
     "karma-chrome-launcher": "^3.0.0",
     "karma-coverage": "^2.0.0",
@@ -124,23 +126,19 @@
     "karma-env-preprocessor": "^0.1.1",
     "karma-firefox-launcher": "^1.1.0",
     "karma-ie-launcher": "^1.0.0",
-    "karma-json-preprocessor": "^0.3.3",
-    "karma-json-to-file-reporter": "^1.0.1",
     "karma-junit-reporter": "^2.0.1",
     "karma-mocha": "^2.0.1",
     "karma-mocha-reporter": "^2.2.5",
     "karma-sourcemap-loader": "^0.3.8",
     "karma-source-map-support": "~1.4.0",
     "mocha": "^7.1.1",
-    "mocha-junit-reporter": "^1.18.0",
-    "nyc": "^14.0.0",
-    "prettier": "^1.16.4",
+    "mocha-junit-reporter": "^2.0.0",
+    "nyc": "^15.0.0",
+    "prettier": "^2.5.1",
     "rimraf": "^3.0.0",
-    "rollup": "^1.16.3",
     "sinon": "^9.0.2",
     "source-map-support": "^0.5.9",
-    "ts-node": "^9.0.0",
-    "typescript": "~4.2.0",
-    "typedoc": "0.15.2"
+    "ts-node": "^10.0.0",
+    "typescript": "~4.6.0"
   }
 }

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

@@ -236,6 +236,7 @@ export declare interface AnalyzeSentimentSuccessResult extends TextAnalyticsSucc
  */
 export declare interface AssessmentSentiment extends SentenceAssessment {
 }
+
 export { AzureKeyCredential }
 
 /**
@@ -665,51 +666,88 @@ export declare type HealthcareEntityRelationType = string;
 export declare type InnerErrorCodeValue = string;
 
 /** Known values of {@link HealthcareEntityCategory} that the service accepts. */
-export declare const enum KnownHealthcareEntityCategory {
+export declare enum KnownHealthcareEntityCategory {
+    /** BodyStructure */
     BodyStructure = "BODY_STRUCTURE",
+    /** AGE */
     AGE = "AGE",
+    /** Gender */
     Gender = "GENDER",
+    /** ExaminationName */
     ExaminationName = "EXAMINATION_NAME",
+    /** Date */
     Date = "DATE",
+    /** Direction */
     Direction = "DIRECTION",
+    /** Frequency */
     Frequency = "FREQUENCY",
+    /** MeasurementValue */
     MeasurementValue = "MEASUREMENT_VALUE",
+    /** MeasurementUnit */
     MeasurementUnit = "MEASUREMENT_UNIT",
+    /** RelationalOperator */
     RelationalOperator = "RELATIONAL_OPERATOR",
+    /** Time */
     Time = "TIME",
+    /** GeneORProtein */
     GeneORProtein = "GENE_OR_PROTEIN",
+    /** Variant */
     Variant = "VARIANT",
+    /** AdministrativeEvent */
     AdministrativeEvent = "ADMINISTRATIVE_EVENT",
+    /** CareEnvironment */
     CareEnvironment = "CARE_ENVIRONMENT",
+    /** HealthcareProfession */
     HealthcareProfession = "HEALTHCARE_PROFESSION",
+    /** Diagnosis */
     Diagnosis = "DIAGNOSIS",
+    /** SymptomORSign */
     SymptomORSign = "SYMPTOM_OR_SIGN",
+    /** ConditionQualifier */
     ConditionQualifier = "CONDITION_QUALIFIER",
+    /** MedicationClass */
     MedicationClass = "MEDICATION_CLASS",
+    /** MedicationName */
     MedicationName = "MEDICATION_NAME",
+    /** Dosage */
     Dosage = "DOSAGE",
+    /** MedicationForm */
     MedicationForm = "MEDICATION_FORM",
+    /** MedicationRoute */
     MedicationRoute = "MEDICATION_ROUTE",
+    /** FamilyRelation */
     FamilyRelation = "FAMILY_RELATION",
+    /** TreatmentName */
     TreatmentName = "TREATMENT_NAME"
 }
 
 /** Known values of {@link InnerErrorCodeValue} that the service accepts. */
-export declare const enum KnownInnerErrorCodeValue {
+export declare enum KnownInnerErrorCodeValue {
+    /** InvalidParameterValue */
     InvalidParameterValue = "InvalidParameterValue",
+    /** InvalidRequestBodyFormat */
     InvalidRequestBodyFormat = "InvalidRequestBodyFormat",
+    /** EmptyRequest */
     EmptyRequest = "EmptyRequest",
+    /** MissingInputRecords */
     MissingInputRecords = "MissingInputRecords",
+    /** InvalidDocument */
     InvalidDocument = "InvalidDocument",
+    /** ModelVersionIncorrect */
     ModelVersionIncorrect = "ModelVersionIncorrect",
+    /** InvalidDocumentBatch */
     InvalidDocumentBatch = "InvalidDocumentBatch",
+    /** UnsupportedLanguageCode */
     UnsupportedLanguageCode = "UnsupportedLanguageCode",
+    /** InvalidCountryHint */
     InvalidCountryHint = "InvalidCountryHint"
 }
 
 /** Known values of {@link WarningCode} that the service accepts. */
-export declare const enum KnownWarningCode {
+export declare enum KnownWarningCode {
+    /** LongWordsInDocument */
     LongWordsInDocument = "LongWordsInDocument",
+    /** DocumentTruncated */
     DocumentTruncated = "DocumentTruncated"
 }
 
@@ -1499,6 +1537,7 @@ export declare class TextAnalyticsClient {
      */
     defaultLanguage: string;
     /* Excluded from this release type: client */
+    private readonly _tracing;
     /**
      * Creates an instance of TextAnalyticsClient.
      *
@@ -1553,10 +1592,10 @@ export declare class TextAnalyticsClient {
      * {@link https://docs.microsoft.com/azure/cognitive-services/text-analytics/language-support}.
      * @param documents - The input strings to analyze.
      * @param language - The language that all the input strings are
-          written in. If unspecified, this value will be set to the default
-          language in `TextAnalyticsClientOptions`.
-          If set to an empty string, the service will apply a model
-          where the language is explicitly set to "None".
+     written in. If unspecified, this value will be set to the default
+     language in `TextAnalyticsClientOptions`.
+     If set to an empty string, the service will apply a model
+     where the language is explicitly set to "None".
      * @param options - Optional parameters for the operation.
      */
     recognizeEntities(documents: string[], language?: string, options?: RecognizeCategorizedEntitiesOptions): Promise<RecognizeCategorizedEntitiesResultArray>;
@@ -1581,10 +1620,10 @@ export declare class TextAnalyticsClient {
      * {@link https://docs.microsoft.com/azure/cognitive-services/text-analytics/language-support}.
      * @param documents - The input strings to analyze.
      * @param language - The language that all the input strings are
-          written in. If unspecified, this value will be set to the default
-          language in `TextAnalyticsClientOptions`.
-          If set to an empty string, the service will apply a model
-          where the lanuage is explicitly set to "None".
+     written in. If unspecified, this value will be set to the default
+     language in `TextAnalyticsClientOptions`.
+     If set to an empty string, the service will apply a model
+     where the lanuage is explicitly set to "None".
      * @param options - Optional parameters that includes enabling opinion mining.
      */
     analyzeSentiment(documents: string[], language?: string, options?: AnalyzeSentimentOptions): Promise<AnalyzeSentimentResultArray>;
@@ -1606,10 +1645,10 @@ export declare class TextAnalyticsClient {
      * {@link https://docs.microsoft.com/azure/cognitive-services/text-analytics/language-support}.
      * @param documents - The input strings to analyze.
      * @param language - The language that all the input strings are
-          written in. If unspecified, this value will be set to the default
-          language in `TextAnalyticsClientOptions`.
-          If set to an empty string, the service will apply a model
-          where the language is explicitly set to "None".
+     written in. If unspecified, this value will be set to the default
+     language in `TextAnalyticsClientOptions`.
+     If set to an empty string, the service will apply a model
+     where the language is explicitly set to "None".
      * @param options - Options for the operation.
      */
     extractKeyPhrases(documents: string[], language?: string, options?: ExtractKeyPhrasesOptions): Promise<ExtractKeyPhrasesResultArray>;
@@ -1631,10 +1670,10 @@ export declare class TextAnalyticsClient {
      * {@link https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/language-support}.
      * @param inputs - The input strings to analyze.
      * @param language - The language that all the input strings are
-          written in. If unspecified, this value will be set to the default
-          language in `TextAnalyticsClientOptions`.
-          If set to an empty string, the service will apply a model
-          where the language is explicitly set to "None".
+     written in. If unspecified, this value will be set to the default
+     language in `TextAnalyticsClientOptions`.
+     If set to an empty string, the service will apply a model
+     where the language is explicitly set to "None".
      * @param options - Options for the operation.
      */
     recognizePiiEntities(inputs: string[], language?: string, options?: RecognizePiiEntitiesOptions): Promise<RecognizePiiEntitiesResultArray>;
@@ -1657,10 +1696,10 @@ export declare class TextAnalyticsClient {
      * {@link https://docs.microsoft.com/azure/cognitive-services/text-analytics/language-support}.
      * @param documents - The input strings to analyze.
      * @param language - The language that all the input strings are
-          written in. If unspecified, this value will be set to the default
-          language in `TextAnalyticsClientOptions`.
-          If set to an empty string, the service will apply a model
-          where the language is explicitly set to "None".
+     written in. If unspecified, this value will be set to the default
+     language in `TextAnalyticsClientOptions`.
+     If set to an empty string, the service will apply a model
+     where the language is explicitly set to "None".
      * @param options - Options for the operation.
      */
     recognizeLinkedEntities(documents: string[], language?: string, options?: RecognizeLinkedEntitiesOptions): Promise<RecognizeLinkedEntitiesResultArray>;
@@ -1679,10 +1718,10 @@ export declare class TextAnalyticsClient {
      * symptoms, etc) and their relations.
      * @param documents - Collection of documents to analyze.
      * @param language - The language that all the input strings are
-          written in. If unspecified, this value will be set to the default
-          language in `TextAnalyticsClientOptions`.
-          If set to an empty string, the service will apply a model
-          where the language is explicitly set to "None".
+     written in. If unspecified, this value will be set to the default
+     language in `TextAnalyticsClientOptions`.
+     If set to an empty string, the service will apply a model
+     where the language is explicitly set to "None".
      * @param options - Options for the operation.
      */
     beginAnalyzeHealthcareEntities(documents: string[], language?: string, options?: BeginAnalyzeHealthcareEntitiesOptions): Promise<AnalyzeHealthcareEntitiesPollerLike>;
@@ -1698,10 +1737,10 @@ export declare class TextAnalyticsClient {
      * @param documents - Collection of documents to analyze
      * @param actions - TextAnalyticsActions to execute.
      * @param language - The language that all the input strings are
-          written in. If unspecified, this value will be set to the default
-          language in `TextAnalyticsClientOptions`.
-          If set to an empty string, the service will apply a model
-          where the language is explicitly set to "None".
+     written in. If unspecified, this value will be set to the default
+     language in `TextAnalyticsClientOptions`.
+     If set to an empty string, the service will apply a model
+     where the language is explicitly set to "None".
      * @param options - Options for the operation.
      */
     beginAnalyzeActions(documents: string[], actions: TextAnalyticsActions, language?: string, options?: BeginAnalyzeActionsOptions): Promise<AnalyzeActionsPollerLike>;

package/CHANGELOG.md

@@ -1,144 +0,0 @@
-# Release History
-
-## 5.1.1 (Unreleased)
-
-### Features Added
-
-### Breaking Changes
-
-### Bugs Fixed
-
-### Other Changes
-
-## 5.1.0 (2021-07-07)
-
-### New Features
-
-- We are now targeting the service's v3.1 API as the default instead of v3.1-preview.5.
-- `beginAnalyzeHealthcareEntities` now works with Azure Active Directory credentials.
-- `categoriesFilter` support was added to `RecognizePiiEntitiesAction`.
-
-### Breaking Changes
-
-- `PiiEntityDomainType` was renamed to `PiiEntityDomain`.
-- `domain` property of `RecognizePiiEntitiesAction` was renamed to `domainFilter`.
-- `beginAnalyzeActions` is now limited to accept up to one action only per type.
-
-## 5.1.0-beta.6 (2021-05-18)
-
-### New Features
-
-- With the dropping of support for Node.js versions that are no longer in LTS, the dependency on `@types/node` has been updated to version 12. Read our [support policy](https://github.com/Azure/azure-sdk-for-js/blob/main/SUPPORT.md) for more details.
-- We are now targeting the service's v3.1-preview.5 API as the default instead of v3.1-preview.4.
-- `beginAnalyzeActions` adds support for analyze sentiment actions.
-- `disableServiceLogs` parameter is added to most actions in `beginAnalyzeActions` that controls service-side logging.
-
-### Breaking Changes
-
-- `beginAnalyzeBatchActions` was renamed to `beginAnalyzeActions`.
-- `TextElements_v8` is renamed to `TextElement_v8` in model `StringIndexType`.
-
-### Key Bug Fixes
-
-- Results of entity linking actions were not returned correctly by `beginAnalyzeActions` and that is now fixed.
-
-## 5.1.0-beta.5 (2021-03-11)
-
-- We are now targeting the service's v3.1-preview.4 API as the default instead of v3.1-preview.3.
-- [Breaking] Aspects in opinions mining are now called targets and each individual opinion is now called an assessment. The new naming simplifies the naming of different parts of the response.
-- `beginAnalyzeBatchActions` can now process recognize linked entities actions.
-- `beginAnalyzeHealthcareEntities` returns `entityRelations` per document, a list of relations between healthcare entities.
-- `beginAnalyzeHealthcareEntities` entities now include `assertions` instead of `isNegated` which gives more context about the respective entity.
-- [Breaking] `beginAnalyzeHealthcareEntities` no longer returns `relatedEntities`.
-- `recognizePiiEntities` takes a new option, `categoriesFilter`, that specifies a list of Pii categories to return.
-- [Breaking] `statistics` is no longer part of `PagedAnalyzeBatchActionsResult`.
-
-## 5.1.0-beta.4 (2021-02-10)
-
-- [Breaking] `beginAnalyzeHealthcare` is renamed to `beginAnalyzeHealthcareEntities`.
-- [Breaking] `beginAnalyze` is renamed to `beginAnalyzeBatchActions`.
-- A new option to control how the offset is calculated by the service, `stringIndexType`, is added to `analyzeSentiment`, `recognizeEntities`, `recognizePiiEntities`, and `beginAnalyzeHealthcareEntities`. Furthermore, `stringIndexType` is added to task types `RecognizeEntitiesAction` and `RecognizePiiEntitiesAction`, which are the types of input actions to the `beginAnalyzeBatchActions` method. For more information, see [the Text Analytics documentation](https://docs.microsoft.com/azure/cognitive-services/text-analytics/concepts/text-offsets#offsets-in-api-version-31-preview).
-- [Breaking] The healthcare entities returned by `beginAnalyzeHealthcare` are now organized as a directed graph where the edges represent a certain type of healthcare relationship between the source and target entities. Edges are stored in the `relatedEntities` property.
-- [Breaking] The `links` property of `HealthcareEntity` is renamed to `dataSources`, a list of objects representing medical databases, where each object has `name` and `entityId` properties.
-- The poller for the `beginAnalyzeBatchActions` long-running operation gained the ability to return certain metadata information about the currently running operation (e.g., when the operation was created, will be expired, and last time it was updated, and also how many actions completed and failed so far). Also, the poller for `beginAnalyzeHealthcareEntities` gained a similar ability.
-- [Breaking] the words "operation" and "action" are used consistently in our names and documentation instead of "job" and "task" respectively.
-
-## 5.1.0-beta.3 (2020-11-23)
-
-- We are now targeting the service's v3.1-preview.3 API as the default instead of v3.1-preview.2.
-- We introduced the `beginAnalyze` API which supports long-running batch process of Named Entity Recognition, Personally identifiable Information, and Key Phrase Extraction.
-- We now have added support for the recognition of healthcare entities with the introduction of the `beginAnalyzeHealthcare` API. Since the Health API is currently only available in a gated preview, you need to have your subscription on the service's allow list. Note that since this is a gated preview, AAD is not supported. For more information, see [the Text Analytics for Health documentation](https://docs.microsoft.com/azure/cognitive-services/text-analytics/how-tos/text-analytics-for-health?tabs=ner#request-access-to-the-public-preview).
-
-## 5.1.0-beta.2 (2020-10-06)
-
-- [Breaking] The `length` property is removed from `SentenceSentiment`, `Entity`, `Match`, `PiiEntity`, and `CategorizedEntity` because the length information can be accessed from the text property itself using the string's length property.
-
-## 5.1.0-beta.1 (2020-09-17)
-
-- We are now targeting the service's v3.1-preview.2 API as the default instead of v3.0.
-- We now have added support for opinion mining feature of Sentiment Analysis. To get this support, pass `includeOpinionMining` as True when calling the `analyzeSentiment` endpoint.
-- We have added the `recognizePiiEntities` API which returns entities containing personal information for a batch of documents and also returns the redacted text.
-- The `length` and `offset` properties are added to the `SentenceSentiment`, `Entity`, `Match`, `PiiEntity` and `CategorizedEntity` interfaces to represent the length of the sentence's text and its offset from the start of the document. The unit of distance used is UTF-16 code points.
-- The `text` property of the `SentenceSentiment` interface is no longer marked as optional because the service has always returned it. This interface is used exclusively as an output type so this change does not break existing code.
-- `bingEntitySearchApiId` property is now returned for entities returned by `recognizeLinkedEntities` API and is added to the `LinkedEntity` interface. This property is to be used in conjunction with the Bing Entity Search API to fetch additional relevant information about the returned entity.
-
-## 5.0.1 (2020-08-18)
-
-- Handles REST exceptions with code InvalidDocumentBatch in a way that maintains backward compatibility.
-
-## 5.0.0 (2020-07-27)
-
-- Updated the package version to be 5.0.0 instead of 1.0.0 in order to reduce confusion with older versions of the Azure Text Analytics SDKs.
-
-## 1.0.0 (2020-06-09)
-
-- This release marks the general availability of the `@azure/ai-text-analytics` package.
-
-## 1.0.0-preview.5 (2020-05-26)
-
-- [Breaking] Renamed all result array types that extend JavaScript's base `Array` class to end with the word `Array` instead of `Collection` (e.g. `AnalyzeSentimentResultCollection` is now `AnalyzeSentimentResultArray`)
-- [Breaking] Renamed `score` to `confidenceScore` in the `Match`, `Entity`, and `DetectedLanguage` types.
-- [Breaking] Removed the `graphemeOffset` and `graphemeLength` properties of the `Match`, `Entity`, and `SentenceSentiment` types.
-- [Breaking] Renamed the `graphemeCount` property of `TextDocumentStatistics` back to `characterCount`
-- Added a `text` property to `SentenceSentiment` that contains the sentence text
-- [Breaking] Removed the `warnings` property of `SentenceSentiment`.
-- Added `warnings` property to every document response object containing a list of `TextAnalyticsWarning` objects relevant to the corresponding document.
-- Migrated to using the Text Analytics v3.0 (General Availability) service endpoint.
-
-## 1.0.0-preview.4 (2020-04-07)
-
-- Renamed the first parameter of all operation methods from `inputs` to `documents`
-- [Breaking] Removed PII entity detection methods from `TextAnalyticsClient` as well as all associated samples and documentation
-- [Breaking] Replaced `TextAnalyticsApiKeyCredential` with `AzureKeyCredential` (re-exported through this package from `@azure/core-auth`).
-- `TextAnalyticsClient` methods now throw an error when the `documents` parameter is not an array or empty before sending a request to the Text Analytics service.
-
-## 1.0.0-preview.3 (2020-03-10)
-
-- [Breaking] Renamed `id` to `dataSourceEntityId` in the `LinkedEntity` type.
-- Added special handling for the string `"none"` as the `countryHint` parameter of the `TextAnalyticsClient.detectLanguage`. `"none"` is now treated the same as the empty string, and indicates that the default language detection model should be used.
-- [Breaking] Renamed `offset` to `graphemeOffset` and `length` to `graphemeLength` in fields of response objects as appropriate in order to make it clear that the offsets and lengths are in units of Unicode graphemes.
-- [Breaking] Renamed `sentimentScores` on both `DocumentSentiment` and `SentenceSentiment` to `confidenceScores`, and renamed the type `SentimentScorePerLabel` to `SentimentConfidenceScores`.
-- [Breaking] Renamed `characterCount` to `graphemeCount` in the `DocumentStatistics` interface, to align with the change to using `grapheme` in the lengths/offsets of response objects.
-
-## 1.0.0-preview.2 (2020-02-11)
-
-- Added support for rotating API keys via the `TextAnalyticsApiKeyCredential.updateKey` method.
-- Added a discriminant type for `TextAnalyticsResult.error` to allow for easy differentiation between success and error types using `if (result.error) { ... }` in both TypeScript and JavaScript.
-- [Breaking] Removed the `Entity` type and added new return types `CategorizedEntity` and `PiiEntity` for the `recognizeEntities` and `recognizePiiEntities` methods respectively. These types are equivalent to the previous `Entity` type.
-- [Breaking] Removed the `detectedLanguages` property from `DetectLanguageResult`, as the service currently only returns one language.
-- [Breaking] Renamed the `detectLanguages` method to `detectLanguage`, as the `detectedLanguages` property was removed from the `DetectLanguageResult` return type.
-- [Breaking] Renamed `documentScores` and `sentenceScores` on the `DocumentSentiment` and `SentenceSentiment` types both to `sentimentScores`.
-- [Breaking] Renamed `type` and `subtype` to `category` and `subcategory` respectively in the `CategorizedEntity` and `PiiEntity` types.
-- [Breaking] Renamed `DocumentSentimentValue` and `SentenceSentimentValue` to `DocumentSentimentLabel` and `SentenceSentimentLabel` respectively.
-- [Breaking] Renamed `SentimentConfidenceScorePerLabel` to `SentimentScorePerLabel`.
-- [Breaking] Refactored `TextAnalyticsError` to flatten the error hierarchy and remove `innerError`. The new error model has properties for `code`, `message`, and an optional `target` only. The `code` property of `TextAnalyticsError` can now contain all of the codes from the previous `InnerErrorCodeValue` as well as those from the top-level `ErrorCodeValue`.
-
-## 1.0.0-preview.1 (2020-01-09)
-
-- This release is a preview of our efforts to create a client library that is user friendly and
-  idiomatic to the JavaScript ecosystem. The reasons for most of the changes in this update can be found in the
-  [Azure SDK Design Guidelines for TypeScript](https://azure.github.io/azure-sdk/typescript_introduction.html).
-- Differences from previous public package `@azure/cognitiveservices-textanalytics`
-  - Package name changed from `@azure/cognitiveservices-textanalytics` to `@azure/ai-text-analytics`.
-  - Package targets version `3.0` of the service API.
-  - Supports authentication via `@azure/identity`.

package/dist-esm/src/generated/generatedClientContext.js

@@ -1,42 +0,0 @@
-/*
- * Copyright (c) Microsoft Corporation.
- * Licensed under the MIT License.
- *
- * Code generated by Microsoft (R) AutoRest Code Generator.
- * Changes may cause incorrect behavior and will be lost if the code is regenerated.
- */
-import * as coreClient from "@azure/core-client";
-/** @internal */
-export class GeneratedClientContext extends coreClient.ServiceClient {
-    /**
-     * Initializes a new instance of the GeneratedClientContext class.
-     * @param endpoint Supported Cognitive Services endpoints (protocol and hostname, for example:
-     *                 https://westus.api.cognitive.microsoft.com).
-     * @param options The parameter options
-     */
-    constructor(endpoint, options) {
-        if (endpoint === undefined) {
-            throw new Error("'endpoint' cannot be null");
-        }
-        // Initializing default values for options
-        if (!options) {
-            options = {};
-        }
-        const defaults = {
-            requestContentType: "application/json; charset=utf-8"
-        };
-        const packageDetails = `azsdk-js-ai-text-analytics/5.1.0`;
-        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: options.endpoint || "{Endpoint}/text/analytics/{ApiVersion}" });
-        super(optionsWithDefaults);
-        // Parameter assignments
-        this.endpoint = endpoint;
-        // Assigning values to Constant parameters
-        this.apiVersion = options.apiVersion || "v3.1";
-    }
-}
-//# sourceMappingURL=generatedClientContext.js.map

package/dist-esm/src/generated/generatedClientContext.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"generatedClientContext.js","sourceRoot":"","sources":["../../../src/generated/generatedClientContext.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,KAAK,UAAU,MAAM,oBAAoB,CAAC;AAGjD,gBAAgB;AAChB,MAAM,OAAO,sBAAuB,SAAQ,UAAU,CAAC,aAAa;IAIlE;;;;;OAKG;IACH,YAAY,QAAgB,EAAE,OAAuC;QACnE,IAAI,QAAQ,KAAK,SAAS,EAAE;YAC1B,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;SAC9C;QAED,0CAA0C;QAC1C,IAAI,CAAC,OAAO,EAAE;YACZ,OAAO,GAAG,EAAE,CAAC;SACd;QACD,MAAM,QAAQ,GAAkC;YAC9C,kBAAkB,EAAE,iCAAiC;SACtD,CAAC;QAEF,MAAM,cAAc,GAAG,kCAAkC,CAAC;QAC1D,MAAM,eAAe,GACnB,OAAO,CAAC,gBAAgB,IAAI,OAAO,CAAC,gBAAgB,CAAC,eAAe;YAClE,CAAC,CAAC,GAAG,OAAO,CAAC,gBAAgB,CAAC,eAAe,IAAI,cAAc,EAAE;YACjE,CAAC,CAAC,GAAG,cAAc,EAAE,CAAC;QAE1B,MAAM,mBAAmB,iDACpB,QAAQ,GACR,OAAO,KACV,gBAAgB,EAAE;gBAChB,eAAe;aAChB,EACD,OAAO,EAAE,OAAO,CAAC,QAAQ,IAAI,wCAAwC,GACtE,CAAC;QACF,KAAK,CAAC,mBAAmB,CAAC,CAAC;QAC3B,wBAAwB;QACxB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QAEzB,0CAA0C;QAC1C,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,UAAU,IAAI,MAAM,CAAC;IACjD,CAAC;CACF","sourcesContent":["/*\n * Copyright (c) Microsoft Corporation.\n * Licensed under the MIT License.\n *\n * Code generated by Microsoft (R) AutoRest Code Generator.\n * Changes may cause incorrect behavior and will be lost if the code is regenerated.\n */\n\nimport * as coreClient from \"@azure/core-client\";\nimport { GeneratedClientOptionalParams } from \"./models\";\n\n/** @internal */\nexport class GeneratedClientContext extends coreClient.ServiceClient {\n  endpoint: string;\n  apiVersion: string;\n\n  /**\n   * Initializes a new instance of the GeneratedClientContext class.\n   * @param endpoint Supported Cognitive Services endpoints (protocol and hostname, for example:\n   *                 https://westus.api.cognitive.microsoft.com).\n   * @param options The parameter options\n   */\n  constructor(endpoint: string, options?: GeneratedClientOptionalParams) {\n    if (endpoint === undefined) {\n      throw new Error(\"'endpoint' cannot be null\");\n    }\n\n    // Initializing default values for options\n    if (!options) {\n      options = {};\n    }\n    const defaults: GeneratedClientOptionalParams = {\n      requestContentType: \"application/json; charset=utf-8\"\n    };\n\n    const packageDetails = `azsdk-js-ai-text-analytics/5.1.0`;\n    const userAgentPrefix =\n      options.userAgentOptions && options.userAgentOptions.userAgentPrefix\n        ? `${options.userAgentOptions.userAgentPrefix} ${packageDetails}`\n        : `${packageDetails}`;\n\n    const optionsWithDefaults = {\n      ...defaults,\n      ...options,\n      userAgentOptions: {\n        userAgentPrefix\n      },\n      baseUri: options.endpoint || \"{Endpoint}/text/analytics/{ApiVersion}\"\n    };\n    super(optionsWithDefaults);\n    // Parameter assignments\n    this.endpoint = endpoint;\n\n    // Assigning values to Constant parameters\n    this.apiVersion = options.apiVersion || \"v3.1\";\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"]}