@azure/search-documents 11.3.0-beta.5 → 11.3.0-beta.8

package/types/search-documents.d.ts

@@ -1,13 +1,20 @@
 /// <reference lib="esnext.asynciterable" />
 
 import { AzureKeyCredential } from '@azure/core-auth';
-import { CommonClientOptions } from '@azure/core-client';
+import { ExtendedCommonClientOptions } from '@azure/core-http-compat';
 import { KeyCredential } from '@azure/core-auth';
 import { OperationOptions } from '@azure/core-client';
 import { PagedAsyncIterableIterator } from '@azure/core-paging';
 import { RestError } from '@azure/core-rest-pipeline';
 import { TokenCredential } from '@azure/core-auth';
 
+/**
+ * An iterator for listing the aliases that exist in the Search service. Will make requests
+ * as needed during iteration. Use .byPage() to make one request to the server
+ * per iteration.
+ */
+export declare type AliasIterator = PagedAsyncIterableIterator<SearchIndexAlias, SearchIndexAlias[], {}>;
+
 /** Information about a token returned by an analyzer. */
 export declare interface AnalyzedTokenInfo {
     /**
@@ -86,7 +93,7 @@ export declare interface AnswerResult {
     /** Describes unknown properties. The value of an unknown property can be of "any" type. */
     [property: string]: any;
     /**
-     * The score value represents how relevant the answer is to the the query relative to other answers returned for the query.
+     * The score value represents how relevant the answer is to the query relative to other answers returned for the query.
      * NOTE: This property will not be serialized. It can only be populated by the server.
      */
     readonly score: number;
@@ -223,6 +230,24 @@ export declare interface AzureActiveDirectoryApplicationCredentials {
 
 export { AzureKeyCredential }
 
+/** The AML skill allows you to extend AI enrichment with a custom Azure Machine Learning (AML) model. Once an AML model is trained and deployed, an AML skill integrates it into AI enrichment. */
+export declare type AzureMachineLearningSkill = BaseSearchIndexerSkill & {
+    /** Polymorphic discriminator, which specifies the different types this object can be */
+    odatatype: "#Microsoft.Skills.Custom.AmlSkill";
+    /** (Required for no authentication or key authentication) The scoring URI of the AML service to which the JSON payload will be sent. Only the https URI scheme is allowed. */
+    scoringUri?: string;
+    /** (Required for key authentication) The key for the AML service. */
+    authenticationKey?: string;
+    /** (Required for token authentication). The Azure Resource Manager resource ID of the AML service. It should be in the format subscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft.MachineLearningServices/workspaces/{workspace-name}/services/{service_name}. */
+    resourceId?: string;
+    /** (Optional) When specified, indicates the timeout for the http client making the API call. */
+    timeout?: string;
+    /** (Optional for token authentication). The region the AML service is deployed in. */
+    region?: string;
+    /** (Optional) When specified, indicates the number of calls the indexer will make in parallel to the endpoint you have provided. You can decrease this value if your endpoint is failing under too high of a request load, or raise it if your endpoint is able to accept more requests and you would like an increase in the performance of the indexer. If not set, a default value of 5 is used. The degreeOfParallelism can be set to a maximum of 10 and a minimum of 1. */
+    degreeOfParallelism?: number;
+};
+
 /** Base type for character filters. */
 export declare interface BaseCharFilter {
     /** Polymorphic discriminator, which specifies the different types this object can be */
@@ -296,7 +321,7 @@ export declare interface BaseSearchIndexerDataIdentity {
 /** Base type for skills. */
 export declare interface BaseSearchIndexerSkill {
     /** Polymorphic discriminator, which specifies the different types this object can be */
-    odatatype: "#Microsoft.Skills.Util.ConditionalSkill" | "#Microsoft.Skills.Text.KeyPhraseExtractionSkill" | "#Microsoft.Skills.Vision.OcrSkill" | "#Microsoft.Skills.Vision.ImageAnalysisSkill" | "#Microsoft.Skills.Text.LanguageDetectionSkill" | "#Microsoft.Skills.Util.ShaperSkill" | "#Microsoft.Skills.Text.MergeSkill" | "#Microsoft.Skills.Text.EntityRecognitionSkill" | "#Microsoft.Skills.Text.SentimentSkill" | "#Microsoft.Skills.Text.V3.SentimentSkill" | "#Microsoft.Skills.Text.V3.EntityLinkingSkill" | "#Microsoft.Skills.Text.V3.EntityRecognitionSkill" | "#Microsoft.Skills.Text.PIIDetectionSkill" | "#Microsoft.Skills.Text.SplitSkill" | "#Microsoft.Skills.Text.CustomEntityLookupSkill" | "#Microsoft.Skills.Text.TranslationSkill" | "#Microsoft.Skills.Util.DocumentExtractionSkill" | "#Microsoft.Skills.Custom.WebApiSkill";
+    odatatype: "#Microsoft.Skills.Util.ConditionalSkill" | "#Microsoft.Skills.Text.KeyPhraseExtractionSkill" | "#Microsoft.Skills.Vision.OcrSkill" | "#Microsoft.Skills.Vision.ImageAnalysisSkill" | "#Microsoft.Skills.Text.LanguageDetectionSkill" | "#Microsoft.Skills.Util.ShaperSkill" | "#Microsoft.Skills.Text.MergeSkill" | "#Microsoft.Skills.Text.EntityRecognitionSkill" | "#Microsoft.Skills.Text.SentimentSkill" | "#Microsoft.Skills.Text.V3.SentimentSkill" | "#Microsoft.Skills.Text.V3.EntityLinkingSkill" | "#Microsoft.Skills.Text.V3.EntityRecognitionSkill" | "#Microsoft.Skills.Text.PIIDetectionSkill" | "#Microsoft.Skills.Text.SplitSkill" | "#Microsoft.Skills.Text.CustomEntityLookupSkill" | "#Microsoft.Skills.Text.TranslationSkill" | "#Microsoft.Skills.Util.DocumentExtractionSkill" | "#Microsoft.Skills.Custom.WebApiSkill" | "#Microsoft.Skills.Custom.AmlSkill";
     /** The name of the skill which uniquely identifies it within the skillset. A skill with no name defined will be given a default name of its 1-based index in the skills array, prefixed with the character '#'. */
     name?: string;
     /** The description of the skill which describes the inputs, outputs, and usage of the skill. */
@@ -512,6 +537,11 @@ export declare interface CorsOptions {
  */
 export declare type CountDocumentsOptions = OperationOptions;
 
+/**
+ * Options for create alias operation.
+ */
+export declare type CreateAliasOptions = OperationOptions;
+
 /**
  * Options for create datasource operation.
  */
@@ -527,12 +557,22 @@ export declare type CreateIndexerOptions = OperationOptions;
  */
 export declare type CreateIndexOptions = OperationOptions;
 
+/**
+ * Options for create or update alias operation.
+ */
+export declare interface CreateOrUpdateAliasOptions extends OperationOptions {
+    /**
+     * If set to true, Resource will be deleted only if the etag matches.
+     */
+    onlyIfUnchanged?: boolean;
+}
+
 /**
  * Options for create/update datasource operation.
  */
 export declare interface CreateorUpdateDataSourceConnectionOptions extends OperationOptions {
     /**
-     * If set to true, Resource will be deleted only if the etag matches.
+     * If set to true, Resource will be updated only if the etag matches.
      */
     onlyIfUnchanged?: boolean;
     /**
@@ -546,7 +586,7 @@ export declare interface CreateorUpdateDataSourceConnectionOptions extends Opera
  */
 export declare interface CreateorUpdateIndexerOptions extends OperationOptions {
     /**
-     * If set to true, Resource will be deleted only if the etag matches.
+     * If set to true, Resource will be updated only if the etag matches.
      */
     onlyIfUnchanged?: boolean;
     /** Ignores cache reset requirements. */
@@ -577,7 +617,7 @@ export declare interface CreateOrUpdateIndexOptions extends OperationOptions {
  */
 export declare interface CreateOrUpdateSkillsetOptions extends OperationOptions {
     /**
-     * If set to true, Resource will be deleted only if the etag matches.
+     * If set to true, Resource will be updated only if the etag matches.
      */
     onlyIfUnchanged?: boolean;
     /**
@@ -595,7 +635,7 @@ export declare interface CreateOrUpdateSkillsetOptions extends OperationOptions
  */
 export declare interface CreateOrUpdateSynonymMapOptions extends OperationOptions {
     /**
-     * If set to true, Resource will be deleted only if the etag matches.
+     * If set to true, Resource will be updated only if the etag matches.
      */
     onlyIfUnchanged?: boolean;
 }
@@ -770,6 +810,16 @@ export declare type DefaultCognitiveServicesAccount = BaseCognitiveServicesAccou
     odatatype: "#Microsoft.Azure.Search.DefaultCognitiveServices";
 };
 
+/**
+ * Options for delete alias operation.
+ */
+export declare interface DeleteAliasOptions extends OperationOptions {
+    /**
+     * If set to true, Resource will be deleted only if the etag matches.
+     */
+    onlyIfUnchanged?: boolean;
+}
+
 /**
  * Options for delete datasource operation.
  */
@@ -1083,6 +1133,11 @@ export declare class GeographyPoint {
     toJSON(): Record<string, unknown>;
 }
 
+/**
+ * Options for get alias operation.
+ */
+export declare type GetAliasOptions = OperationOptions;
+
 /**
  * Options for get datasource operation.
  */
@@ -2468,7 +2523,9 @@ export declare enum KnownOcrSkillLanguage {
     /** Serbian (Latin, Serbia) */
     SrLatn = "sr-Latn",
     /** Slovak */
-    Sk = "sk"
+    Sk = "sk",
+    /** Unknown.  If the language is explicitly set to "unk", the language will be auto-detected. */
+    Unk = "unk"
 }
 
 /** Known values of {@link PIIDetectionSkillMaskingMode} that the service accepts. */
@@ -2563,9 +2620,9 @@ export declare enum KnownQueryLanguage {
     ArJo = "ar-jo",
     /** Query language value for Danish (Denmark). */
     DaDk = "da-dk",
-    /** Query language value for Norwegian (Normway). */
+    /** Query language value for Norwegian (Norway). */
     NoNo = "no-no",
-    /** Query language value for Bulgarian (Bulgary). */
+    /** Query language value for Bulgarian (Bulgaria). */
     BgBg = "bg-bg",
     /** Query language value for Croatian (Croatia). */
     HrHr = "hr-hr",
@@ -2671,6 +2728,24 @@ export declare enum KnownRegexFlags {
     UnixLines = "UNIX_LINES"
 }
 
+/**
+ * Known values for Search Audience
+ */
+export declare enum KnownSearchAudience {
+    /**
+     * Audience for Azure China
+     */
+    AzureChina = "https://search.azure.cn",
+    /**
+     * Audience for Azure Government
+     */
+    AzureGovernment = "https://search.azure.us",
+    /**
+     * Audience for Azure Public
+     */
+    AzurePublicCloud = "https://search.azure.com"
+}
+
 /** Known values of {@link SearchIndexerDataSourceType} that the service accepts. */
 export declare enum KnownSearchIndexerDataSourceType {
     /** Indicates an Azure SQL datasource. */
@@ -3422,6 +3497,11 @@ export declare type LimitTokenFilter = BaseTokenFilter & {
  */
 export declare type LineEnding = string;
 
+/**
+ * Options for list aliases operation.
+ */
+export declare type ListAliasesOptions = OperationOptions;
+
 /**
  * Options for a list data sources operation.
  */
@@ -3645,7 +3725,8 @@ export declare type OcrSkill = BaseSearchIndexerSkill & {
  * **ro**: Romanian \
  * **sr-Cyrl**: Serbian (Cyrillic, Serbia) \
  * **sr-Latn**: Serbian (Latin, Serbia) \
- * **sk**: Slovak
+ * **sk**: Slovak \
+ * **unk**: Unknown.  If the language is explicitly set to "unk", the language will be auto-detected.
  */
 export declare type OcrSkillLanguage = string;
 
@@ -3895,8 +3976,8 @@ export declare type QueryCaptionType = string;
  * **ar-kw**: Query language value for Arabic (Kuwait). \
  * **ar-jo**: Query language value for Arabic (Jordan). \
  * **da-dk**: Query language value for Danish (Denmark). \
- * **no-no**: Query language value for Norwegian (Normway). \
- * **bg-bg**: Query language value for Bulgarian (Bulgary). \
+ * **no-no**: Query language value for Norwegian (Norway). \
+ * **bg-bg**: Query language value for Bulgarian (Bulgaria). \
  * **hr-hr**: Query language value for Croatian (Croatia). \
  * **hr-ba**: Query language value for Croatian (Bosnia and Herzegovina). \
  * **ms-my**: Query language value for Malay (Malaysia). \
@@ -4042,14 +4123,29 @@ export declare interface ScoringProfile {
 /** Defines values for ScoringStatistics. */
 export declare type ScoringStatistics = "local" | "global";
 
+/** Represents an index alias, which describes a mapping from the alias name to an index. The alias name can be used in place of the index name for supported operations. */
+export declare interface SearchAlias {
+    /** The name of the alias. */
+    name: string;
+    /** The name of the index this alias maps to. Only one index name may be specified. */
+    indexes: string[];
+    /** The ETag of the alias. */
+    etag?: string;
+}
+
 /**
  * Class used to perform operations against a search index,
  * including querying documents in the index as well as
  * adding, updating, and removing them.
  */
 export declare class SearchClient<T> implements IndexDocumentsClient<T> {
+    /**
+     *  The service version to use when communicating with the service.
+     */
+    readonly serviceVersion: string;
     /**
      * The API version to use when communicating with the service.
+     * @deprecated use {@Link serviceVersion} instead
      */
     readonly apiVersion: string;
     /**
@@ -4174,11 +4270,22 @@ export declare class SearchClient<T> implements IndexDocumentsClient<T> {
 /**
  * Client options used to configure Cognitive Search API requests.
  */
-export declare interface SearchClientOptions extends CommonClientOptions {
+export declare interface SearchClientOptions extends ExtendedCommonClientOptions {
     /**
      * The API version to use when communicating with the service.
+     * @deprecated use {@Link serviceVersion} instead
      */
     apiVersion?: string;
+    /**
+     * The service version to use when communicating with the service.
+     */
+    serviceVersion?: string;
+    /**
+     * The Audience to use for authentication with Azure Active Directory (AAD). The
+     * audience is not considered when using a shared key.
+     * {@link KnownSearchAudience} can be used interchangeably with audience
+     */
+    audience?: string;
 }
 
 /**
@@ -4336,6 +4443,11 @@ export declare interface SearchIndex {
     etag?: string;
 }
 
+/**
+ * Search Alias object.
+ */
+export declare type SearchIndexAlias = SearchAlias;
+
 /**
  * Class to perform operations to manage
  * (create, update, list/delete)
@@ -4345,6 +4457,11 @@ export declare class SearchIndexClient {
     /**
      * The API version to use when communicating with the service.
      */
+    readonly serviceVersion: string;
+    /**
+     * The API version to use when communicating with the service.
+     * @deprecated use {@Link serviceVersion} instead
+     */
     readonly apiVersion: string;
     /**
      * The endpoint of the search service
@@ -4383,6 +4500,13 @@ export declare class SearchIndexClient {
      * @param options - Options to the list index operation.
      */
     listIndexes(options?: ListIndexesOptions): IndexIterator;
+    private listAliasesPage;
+    private listAliasesAll;
+    /**
+     * Lists all aliases available for a search service.
+     * @param options - The options parameters.
+     */
+    listAliases(options?: ListAliasesOptions): AliasIterator;
     private listIndexesNamesPage;
     private listIndexesNamesAll;
     /**
@@ -4448,6 +4572,31 @@ export declare class SearchIndexClient {
      * @param options - Additional optional arguments.
      */
     deleteSynonymMap(synonymMap: string | SynonymMap, options?: DeleteSynonymMapOptions): Promise<void>;
+    /**
+     * Creates a new search alias or updates an alias if it already exists.
+     * @param alias - The definition of the alias to create or update.
+     * @param options - The options parameters.
+     */
+    createOrUpdateAlias(alias: SearchIndexAlias, options?: CreateOrUpdateAliasOptions): Promise<SearchIndexAlias>;
+    /**
+     * Creates a new search alias.
+     * @param alias - The definition of the alias to create.
+     * @param options - The options parameters.
+     */
+    createAlias(alias: SearchIndexAlias, options?: CreateAliasOptions): Promise<SearchIndexAlias>;
+    /**
+     * Deletes a search alias and its associated mapping to an index. This operation is permanent, with no
+     * recovery option. The mapped index is untouched by this operation.
+     * @param alias - Alias/Name name of the alias to delete.
+     * @param options - The options parameters.
+     */
+    deleteAlias(alias: string | SearchIndexAlias, options?: DeleteAliasOptions): Promise<void>;
+    /**
+     * Retrieves an alias definition.
+     * @param aliasName - The name of the alias to retrieve.
+     * @param options - The options parameters.
+     */
+    getAlias(aliasName: string, options?: GetAliasOptions): Promise<SearchIndexAlias>;
     /**
      * Retrieves statistics about an index, such as the count of documents and the size
      * of index storage.
@@ -4478,11 +4627,22 @@ export declare class SearchIndexClient {
 /**
  * Client options used to configure Cognitive Search API requests.
  */
-export declare interface SearchIndexClientOptions extends CommonClientOptions {
+export declare interface SearchIndexClientOptions extends ExtendedCommonClientOptions {
     /**
      * The API version to use when communicating with the service.
+     * @deprecated use {@Link serviceVersion} instead
      */
     apiVersion?: string;
+    /**
+     * The service version to use when communicating with the service.
+     */
+    serviceVersion?: string;
+    /**
+     * The Audience to use for authentication with Azure Active Directory (AAD). The
+     * audience is not considered when using a shared key.
+     * {@link KnownSearchAudience} can be used interchangeably with audience
+     */
+    audience?: string;
 }
 
 /**
@@ -4569,6 +4729,11 @@ export declare class SearchIndexerClient {
     /**
      * The API version to use when communicating with the service.
      */
+    readonly serviceVersion: string;
+    /**
+     * The API version to use when communicating with the service.
+     * @deprecated use {@Link serviceVersion} instead
+     */
     readonly apiVersion: string;
     /**
      * The endpoint of the search service
@@ -4730,11 +4895,22 @@ export declare class SearchIndexerClient {
 /**
  * Client options used to configure Cognitive Search API requests.
  */
-export declare interface SearchIndexerClientOptions extends CommonClientOptions {
+export declare interface SearchIndexerClientOptions extends ExtendedCommonClientOptions {
     /**
      * The API version to use when communicating with the service.
+     * @deprecated use {@Link serviceVersion} instead
      */
     apiVersion?: string;
+    /**
+     * The service version to use when communicating with the service.
+     */
+    serviceVersion?: string;
+    /**
+     * The Audience to use for authentication with Azure Active Directory (AAD). The
+     * audience is not considered when using a shared key.
+     * {@link KnownSearchAudience} can be used interchangeably with audience
+     */
+    audience?: string;
 }
 
 /** Represents information about the entity (such as Azure SQL table or CosmosDB collection) that will be indexed. */
@@ -4940,7 +5116,7 @@ export declare interface SearchIndexerLimits {
 /**
  * Contains the possible cases for Skill.
  */
-export declare type SearchIndexerSkill = ConditionalSkill | KeyPhraseExtractionSkill | OcrSkill | ImageAnalysisSkill | LanguageDetectionSkill | ShaperSkill | MergeSkill | EntityRecognitionSkill | SentimentSkill | SplitSkill | PIIDetectionSkill | EntityRecognitionSkillV3 | EntityLinkingSkill | SentimentSkillV3 | CustomEntityLookupSkill | TextTranslationSkill | DocumentExtractionSkill | WebApiSkill;
+export declare type SearchIndexerSkill = ConditionalSkill | KeyPhraseExtractionSkill | OcrSkill | ImageAnalysisSkill | LanguageDetectionSkill | ShaperSkill | MergeSkill | EntityRecognitionSkill | SentimentSkill | SplitSkill | PIIDetectionSkill | EntityRecognitionSkillV3 | EntityLinkingSkill | SentimentSkillV3 | CustomEntityLookupSkill | TextTranslationSkill | DocumentExtractionSkill | WebApiSkill | AzureMachineLearningSkill;
 
 /**
  * A list of skills.
@@ -5731,6 +5907,8 @@ export declare type SentimentSkillV3 = BaseSearchIndexerSkill & {
 
 /** Represents service-level resource counters and quotas. */
 export declare interface ServiceCounters {
+    /** Total number of aliases. */
+    aliasCounter?: ResourceCounter;
     /** Total number of documents across all indexes in the service. */
     documentCounter: ResourceCounter;
     /** Total number of indexes. */

package/CHANGELOG.md

@@ -1,188 +0,0 @@
-# Release History
-
-## 11.3.0-beta.5 (2021-11-09)
-
-### Features Added
-
-- Added `semanticConfiguration` property to `SearchRequest` object.
-- Several new languages are added to the `KnownQueryLanguage` object.
-- Added `semanticSettings` property to `SearchIndex` object.
-
-### Breaking Changes
-
-- Renamed `IndexerCurrentState` property to `IndexerState` property.
-- Renamed `AllDocsInitialChangeTrackingState` property to `AllDocumentsInitialChangeTrackingState` property.
-- Renamed `AllDocsFinalChangeTrackingState` property to `AllDocumentsFinalChangeTrackingState` property.
-- Renamed `ResetDocsInitialChangeTrackingState` property to `ResetDocumentsInitialChangeTrackingState` property.
-- Renamed `ResetDocsFinalChangeTrackingState` property to `ResetDocumentsFinalChangeTrackingState` property.
-- Renamed `SkillNames` property to `ResetSkillsOptions` (with a `SkillNames` property)
-- Renamed `ResetDocs` method to `ResetDocuments` in the SDK client.
-
-### Bugs Fixed
-
-- Fixed the issue with the presence of recursive structure while uploading documents. Please refer [#15656](https://github.com/Azure/azure-sdk-for-js/issues/15656) for further details.
-
-## 11.3.0-beta.4 (2021-10-05)
-
-### Features Added
-
-- Added properties `currentState` & `statusDetail` to the `IndexerExecutionResult` object.
-- Added operations `resetDocs` & `resetSkills` to the `SearchIndexerClient` class.
-
-### Breaking Changes
-
-- Changed property `ignoreResetRequirements` to `skipIndexerResetRequirementForCache` in `CreateorUpdateDataSourceConnectionOptions`, `CreateorUpdateIndexerOptions` & `CreateOrUpdateSkillsetOptions` objects.
-- Changed the type of `answers` property from `Answers` to `QueryAnswerType`, in the `SearchRequest` object.
-- Changed the type of `captions` property from `Captions` to `QueryCaptionType`, in the `SearchRequest` object.
-- Changed the type of `speller` property from `Speller` to `QuerySpellerType`, in the `SearchRequest` object.
-- Changed the underlying dependency of the SDK from `core-http` to `core-rest-pipeline` package.
-
-## 11.3.0-beta.3 (2021-09-07)
-
-### Features Added
-
-- Added a new property `normalizerName` to the `AnalyzeRequest` object.
-- Added 2 new properties `captions` & `semanticFields` to the `SearchRequestOptions` object.
-
-## 11.3.0-beta.2 (2021-08-10)
-
-### Features Added
-
-- Added a new parameter `ignoreResetRequirements` for the `createOrUpdate` operation of Data Sources.
-- Added new parameters `ignoreResetRequirements` & `disableCacheReprocessingChangeDetection` for the `createOrUpdate` operation of Indexers and Skillsets.
-
-### Bugs Fixed
-
-- Converted the complex fields correctly within the Search Fields. Please refer [#16489](https://github.com/Azure/azure-sdk-for-js/issues/16489) for more details.
-- Fixed the typos `anayzerName` to `analyzerName` and `normalizerNames` to `normalizerName` in `convertFieldsToPublic` method of `serviceUtils.ts`.
-
-### Other Changes
-
-- Removed the `| null` from the definitions of the optional values. Please refer [#16694](https://github.com/Azure/azure-sdk-for-js/pull/16694) for more details.
-
-## 11.3.0-beta.1 (2021-07-07)
-
-- 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.
-- Updated our internal core package dependencies to their latest versions in order to add support for Opentelemetry 1.0.0 which is compatible with the latest versions of our other client libraries.
-- Changed TS compilation target to ES2017 in order to produce smaller bundles and use more native platform features
-- Regenerated the search SDK with the latest swaggers that includes the following changes:
-
-  - Support for `TokenCredential` has been added. With this addition, the Search SDK supports authentication via AAD.
-  - Identity types - `SearchIndexerDataNoneIdentity` & `SearchIndexerDataUserAssignedIdentity` have been added.
-  - The following new skills have been added:
-    - SentimentSkill(V3)
-    - EntityLinkingSkill(V3)
-    - EntityRecognitionSkill(V3)
-    - PIIDetectionSkill
-  - A new property `lineEnding` has been added to the skill `OcrSkill`.
-
-## 11.2.0 (2021-06-08)
-
-The list of changes in 11.2.0 since 11.1.0 & 11.2.0-beta.2 are provided below:
-
-**Changes since 11.1.0**
-
-- Added support for Knowledge Store feature through the new `SearchIndexerKnowledgeStore` in the `SearchIndexerSkillset` object.
-- The `skillsetCounter` property in `ServiceCounters` object has been made optional.
-- Added Support for new datasource `adlsgen2`. Please refer [#14620](https://github.com/Azure/azure-sdk-for-js/pull/14620) for further details.
-- Added Support for new skills such as `CustomEntityLookupSkill`, `DocumentExtractionSkill`, etc. Please refer [#14620](https://github.com/Azure/azure-sdk-for-js/pull/14620) for further details.
-
-**Changes since 11.2.0-beta.2**
-
-- Removed Support for Semantic Search and introduced new properties in `SearchOptions`, `SearchRequest`, `SearchResult` and `SearchDocumentsResult` objects.
-- Removed Support for normalizers `LexicalNormalizer` & `CustomNormalizer`. Please refer [#14620](https://github.com/Azure/azure-sdk-for-js/pull/14620) for further details.
-
-## 11.2.0-beta.2 (2021-05-11)
-
-- Added Support for Semantic Search and introduced new properties in `SearchOptions`, `SearchRequest`, `SearchResult` and `SearchDocumentsResult` objects.
-- Added support for Knowledge Store feature through the new `SearchIndexerKnowledgeStore` in the `SearchIndexerSkillset` object.
-- The `skillsetCounter` property in `ServiceCounters` object has been made optional.
-
-## 11.2.0-beta.1 (2021-04-06)
-
-- Added Support for new skills such as `CustomEntityLookupSkill`, `DocumentExtractionSkill`, etc. Please refer [#14620](https://github.com/Azure/azure-sdk-for-js/pull/14620) for further details.
-- Added Support for new datasource `adlsgen2`. Please refer [#14620](https://github.com/Azure/azure-sdk-for-js/pull/14620) for further details.
-- Added Support for normalizers `LexicalNormalizer` & `CustomNormalizer`. Please refer [#14620](https://github.com/Azure/azure-sdk-for-js/pull/14620) for further details.
-
-## 11.1.0 (2021-02-11)
-
-- The list of changes in 11.1.0 since 11.0.3 & 11.1.0-beta.2 are provided below:
-
-**Changes since 11.0.3**
-
-- Added Batching ability to the search SDK. The `SearchIndexingBufferedSender` class enables the user to perform indexing documents in batch mode. There are several user configurable properties such as `autoFlush`, `flushWindowInMs`, `throttlingDelayInMs`, etc.
-- The types `BlobIndexerDataToExtract`, `BlobIndexerImageAction`, `BlobIndexerParsingMode`, `BlobIndexerPDFTextRotationAlgorithm` have changed from union of string literals to string. This is to support the service definition for these types to be extensible enums. The documentation on methods that use these have been updated with known values that can be used for these types.
-
-**Changes since 11.1.0-beta.2**
-
-- [Breaking] Hidden the constructor of `SearchIndexingBufferedSender` and made it to an interface. Please refer [#11785](https://github.com/Azure/azure-sdk-for-js/pull/11785) for further details.
-- Added `encryptionKey` property to `SearchIndexerDataSource`, `SearchIndexer` and `SearchIndexerSkillSet` objects. Please refer [#12275](https://github.com/Azure/azure-sdk-for-js/pull/12275) for further details.
-- Added user configurable properties such as `flushWindowInMs`, `initialBatchActionCount`, `maxRetries`, etc to the `SearchIndexingBufferedSenderOptions` object. Please refer [#12297](https://github.com/Azure/azure-sdk-for-js/pull/12297) for further details.
-
-## 11.1.0-beta.1 (2020-10-05)
-
-- Added Batching ability to the search SDK. Please refer [#11544](https://github.com/Azure/azure-sdk-for-js/pull/11544) for further details.
-- Regenerated the search SDK using the latest swaggers. Please refer [#11533](https://github.com/Azure/azure-sdk-for-js/pull/11533) for further details.
-- Fixed the testcases to ensure success in CI. Please refer [#11518](https://github.com/Azure/azure-sdk-for-js/pull/11518) for further details.
-- Added more test cases for odata scenario. Please refer [#11321](https://github.com/Azure/azure-sdk-for-js/pull/11321) for further details.
-
-## 11.0.3 (2020-08-04)
-
-- Fixed the parented tracing span in the searchClient.search API. Please refer [#10442](https://github.com/Azure/azure-sdk-for-js/issues/10442) for further details.
-
-## 11.0.2 (2020-07-31)
-
-- Fixed the samples in the Readme File. Please refer [#10383](https://github.com/Azure/azure-sdk-for-js/pull/10383) for further details.
-
-## 11.0.1 (2020-07-20)
-
-- [BugFix] Set the correct continuation token in the search documrnts API. Please refer [#10146](https://github.com/Azure/azure-sdk-for-js/pull/10146) for further details.
-
-## 11.0.0 (2020-07-06)
-
-- Set `ConnectionString` value to `<unchanged>` in `SearchIndexerDataSourceConnection`, if the value is not set by the user.
-- [Breaking] In Suggest API & Search API return values, a new property called `document` is introduced. All user-defined fields are moved inside this `document` property.
-- [Breaking] In `analyzeText` API, the `text` parameter is moved from method level to inside `options` bag.
-- [Breaking] In `search` API, `includeTotalResultCount` property is renamed to `includeTotalCount`.
-- [Breaking] In `ServiceCounters`, the `skillsetCounter` property has been removed.
-- [Breaking] Modified the names of several properties. Please refer [#9321](https://github.com/Azure/azure-sdk-for-js/issues/9321) for a detailed list of renames.
-
-## 1.0.0-preview.4 (2020-06-08)
-
-- [Breaking] Changed `ListIndexes` operation to a pageable operation.
-- [Breaking] Added `onlyIfUnchanged` parameter for CreateOrUpdate and Delete operations.
-- [Breaking] Removed `$select` property for the List operations.
-- [Breaking] Refactored `SearchServiceClient` and split it to `SearchIndexClient` and `SearchIndexerClient` and changed `SearchIndexClient` class to `SearchClient` class.
-- [Breaking] Moved non-optional parameters from options bag.
-- [Breaking] Renamed `countDocuments` method to `getDocumentsCount` method.
-- [Breaking] In `search` method, moved the `searchText` parameter from the options bag to method parameter.
-- [Breaking] In `indexDocuments` method, the options parameter is renamed to `IndexDocumentsOptions`.
-- [Breaking] Modified `deleteDocuments` method to get documents as a parameter.
-- [Breaking] In `getIndexStatistics` method, renamed the return type from `GetIndexStatisticsResult` to `SearchIndexStatistics`.
-- [Breaking] In `getServiceStatistics` method, renamed the return type from `ServiceStatistics` to `SearchServiceStatistics`.
-- [Breaking] Modified `DataSource` model name to `DataSourceConnection`. Changed all references in the method names, parameters, etc.
-- [Breaking] Renamed `SimpleDataType` model to `SearchFieldDataType` model.
-- [Breaking] Modified the names of several models & parameters. Please refer [#8984](https://github.com/Azure/azure-sdk-for-js/issues/8984), [#9037](https://github.com/Azure/azure-sdk-for-js/issues/9037) and [#8383](https://github.com/Azure/azure-sdk-for-js/issues/8383) for a detailed list of renames.
-- Added separate methods for getting just names such as `listIndexesNames`, `listSynonymMapsNames`, etc.
-- Added `getSearchClient` method to the `SearchIndexClient` class.
-
-## 1.0.0-preview.3 (2020-05-05)
-
-- Added support for Indexers API (Create, Get, List, etc.)
-- Added support for Datasources API.(Create, Get, List, etc.)
-- Fixed a bug where GeographyPoints were serialized incorrectly causing latitude and longitude to be flipped.
-
-## 1.0.0-preview.2 (2020-04-06)
-
-- [Breaking] Package renamed to `@azure/search-documents` and version number reset to `1.0.0-preview.2`.
-- Support for index management operations using the `SearchServiceClient`.
-- [Breaking] `indexDocuments` on `SearchIndexClient` now takes an `IndexDocumentsBatch` object instead of a raw action array. This new type helps compose an array of actions to be performed on the index.
-- [Breaking] In `SearchIndexClient`, removed options `mergeIfExists` and `uploadIfNotExists` on `uploadDocuments` and `mergeDocuments` and replaced them with new helper `mergeOrUploadDocuments`.
-- The type `IndexAction` was renamed to `IndexDocumentsAction`.
-- [Breaking] Removed `SearchApiKeyCredential` and replaced with `AzureKeyCredential`.
-- [Breaking] Search results accessed `byPage` now have an opaque `continuationToken` in place of `nextLink` and `nextPageParameters`.
-
-## 11.0.0-preview.1 (2020-03-09)
-
-- Initial implementation of the data-plane Cognitive Search Client. The version number starts at 11 to align with client libraries in other languages.
-- This first preview has support for document operations on an index, such as querying and document management.