@azure/search-documents 11.3.0 → 12.0.0-alpha.20230306.2

package/dist-esm/src/searchIndexerClient.js

@@ -1,15 +1,14 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
 import { isTokenCredential } from "@azure/core-auth";
-import { createPipelineFromOptions, operationOptionsToRequestOptionsBase, bearerTokenAuthenticationPolicy } from "@azure/core-http";
-import { SpanStatusCode } from "@azure/core-tracing";
+import { bearerTokenAuthenticationPolicy } from "@azure/core-rest-pipeline";
 import { SDK_VERSION } from "./constants";
 import { SearchServiceClient as GeneratedClient } from "./generated/service/searchServiceClient";
 import { logger } from "./logger";
 import { createSearchApiKeyCredentialPolicy } from "./searchApiKeyCredentialPolicy";
 import * as utils from "./serviceUtils";
 import { createSpan } from "./tracing";
-import { odataMetadataPolicy } from "./odataMetadataPolicy";
+import { createOdataMetadataPolicy } from "./odataMetadataPolicy";
 import { KnownSearchAudience } from "./searchAudience";
 /**
  * Class to perform operations to manage
@@ -37,7 +36,12 @@ export class SearchIndexerClient {
         /**
          * The API version to use when communicating with the service.
          */
-        this.apiVersion = "2020-06-30";
+        this.serviceVersion = utils.defaultServiceVersion;
+        /**
+         * The API version to use when communicating with the service.
+         * @deprecated use {@Link serviceVersion} instead
+         */
+        this.apiVersion = utils.defaultServiceVersion;
         this.endpoint = endpoint;
         const libInfo = `azsdk-js-search-documents/${SDK_VERSION}`;
         if (!options.userAgentOptions) {
@@ -49,37 +53,44 @@ export class SearchIndexerClient {
         else {
             options.userAgentOptions.userAgentPrefix = libInfo;
         }
-        const internalPipelineOptions = Object.assign(Object.assign({}, options), {
+        const internalClientPipelineOptions = Object.assign(Object.assign({}, options), {
             loggingOptions: {
                 logger: logger.info,
-                allowedHeaderNames: [
+                additionalAllowedHeaderNames: [
                     "elapsed-time",
                     "Location",
                     "OData-MaxVersion",
                     "OData-Version",
                     "Prefer",
-                    "throttle-reason"
-                ]
-            }
+                    "throttle-reason",
+                ],
+            },
         });
-        const scope = options.audience
-            ? `${options.audience}/.default`
-            : `${KnownSearchAudience.AzurePublicCloud}/.default`;
-        const requestPolicyFactory = isTokenCredential(credential)
-            ? bearerTokenAuthenticationPolicy(credential, scope)
-            : createSearchApiKeyCredentialPolicy(credential);
-        const pipeline = createPipelineFromOptions(internalPipelineOptions, requestPolicyFactory);
-        if (Array.isArray(pipeline.requestPolicyFactories)) {
-            pipeline.requestPolicyFactories.unshift(odataMetadataPolicy("minimal"));
-        }
-        let apiVersion = this.apiVersion;
         if (options.apiVersion) {
-            if (!["2020-06-30-Preview", "2020-06-30"].includes(options.apiVersion)) {
+            if (!utils.serviceVersions.includes(options.apiVersion)) {
                 throw new Error(`Invalid Api Version: ${options.apiVersion}`);
             }
-            apiVersion = options.apiVersion;
+            this.serviceVersion = options.apiVersion;
+            this.apiVersion = options.apiVersion;
+        }
+        if (options.serviceVersion) {
+            if (!utils.serviceVersions.includes(options.serviceVersion)) {
+                throw new Error(`Invalid Service Version: ${options.serviceVersion}`);
+            }
+            this.serviceVersion = options.serviceVersion;
+            this.apiVersion = options.serviceVersion;
+        }
+        this.client = new GeneratedClient(this.endpoint, this.serviceVersion, internalClientPipelineOptions);
+        if (isTokenCredential(credential)) {
+            const scope = options.audience
+                ? `${options.audience}/.default`
+                : `${KnownSearchAudience.AzurePublicCloud}/.default`;
+            this.client.pipeline.addPolicy(bearerTokenAuthenticationPolicy({ credential, scopes: scope }));
+        }
+        else {
+            this.client.pipeline.addPolicy(createSearchApiKeyCredentialPolicy(credential));
         }
-        this.client = new GeneratedClient(this.endpoint, apiVersion, pipeline);
+        this.client.pipeline.addPolicy(createOdataMetadataPolicy("minimal"));
     }
     /**
      * Retrieves a list of existing indexers in the service.
@@ -88,13 +99,13 @@ export class SearchIndexerClient {
     async listIndexers(options = {}) {
         const { span, updatedOptions } = createSpan("SearchIndexerClient-listIndexers", options);
         try {
-            const result = await this.client.indexers.list(operationOptionsToRequestOptionsBase(updatedOptions));
+            const result = await this.client.indexers.list(updatedOptions);
             return result.indexers.map(utils.generatedSearchIndexerToPublicSearchIndexer);
         }
         catch (e) {
             span.setStatus({
-                code: SpanStatusCode.ERROR,
-                message: e.message
+                status: "error",
+                error: e.message,
             });
             throw e;
         }
@@ -109,13 +120,13 @@ export class SearchIndexerClient {
     async listIndexersNames(options = {}) {
         const { span, updatedOptions } = createSpan("SearchIndexerClient-listIndexersNames", options);
         try {
-            const result = await this.client.indexers.list(Object.assign(Object.assign({}, operationOptionsToRequestOptionsBase(updatedOptions)), { select: "name" }));
+            const result = await this.client.indexers.list(Object.assign(Object.assign({}, updatedOptions), { select: "name" }));
             return result.indexers.map((idx) => idx.name);
         }
         catch (e) {
             span.setStatus({
-                code: SpanStatusCode.ERROR,
-                message: e.message
+                status: "error",
+                error: e.message,
             });
             throw e;
         }
@@ -130,13 +141,13 @@ export class SearchIndexerClient {
     async listDataSourceConnections(options = {}) {
         const { span, updatedOptions } = createSpan("SearchIndexerClient-listDataSourceConnections", options);
         try {
-            const result = await this.client.dataSources.list(operationOptionsToRequestOptionsBase(updatedOptions));
+            const result = await this.client.dataSources.list(updatedOptions);
             return result.dataSources.map(utils.generatedDataSourceToPublicDataSource);
         }
         catch (e) {
             span.setStatus({
-                code: SpanStatusCode.ERROR,
-                message: e.message
+                status: "error",
+                error: e.message,
             });
             throw e;
         }
@@ -151,13 +162,13 @@ export class SearchIndexerClient {
     async listDataSourceConnectionsNames(options = {}) {
         const { span, updatedOptions } = createSpan("SearchIndexerClient-listDataSourceConnectionsNames", options);
         try {
-            const result = await this.client.dataSources.list(Object.assign(Object.assign({}, operationOptionsToRequestOptionsBase(updatedOptions)), { select: "name" }));
+            const result = await this.client.dataSources.list(Object.assign(Object.assign({}, updatedOptions), { select: "name" }));
             return result.dataSources.map((ds) => ds.name);
         }
         catch (e) {
             span.setStatus({
-                code: SpanStatusCode.ERROR,
-                message: e.message
+                status: "error",
+                error: e.message,
             });
             throw e;
         }
@@ -172,13 +183,13 @@ export class SearchIndexerClient {
     async listSkillsets(options = {}) {
         const { span, updatedOptions } = createSpan("SearchIndexerClient-listSkillsets", options);
         try {
-            const result = await this.client.skillsets.list(operationOptionsToRequestOptionsBase(updatedOptions));
+            const result = await this.client.skillsets.list(updatedOptions);
             return result.skillsets.map(utils.generatedSkillsetToPublicSkillset);
         }
         catch (e) {
             span.setStatus({
-                code: SpanStatusCode.ERROR,
-                message: e.message
+                status: "error",
+                error: e.message,
             });
             throw e;
         }
@@ -193,13 +204,13 @@ export class SearchIndexerClient {
     async listSkillsetsNames(options = {}) {
         const { span, updatedOptions } = createSpan("SearchIndexerClient-listSkillsetsNames", options);
         try {
-            const result = await this.client.skillsets.list(Object.assign(Object.assign({}, operationOptionsToRequestOptionsBase(updatedOptions)), { select: "name" }));
+            const result = await this.client.skillsets.list(Object.assign(Object.assign({}, updatedOptions), { select: "name" }));
             return result.skillsets.map((sks) => sks.name);
         }
         catch (e) {
             span.setStatus({
-                code: SpanStatusCode.ERROR,
-                message: e.message
+                status: "error",
+                error: e.message,
             });
             throw e;
         }
@@ -215,13 +226,13 @@ export class SearchIndexerClient {
     async getIndexer(indexerName, options = {}) {
         const { span, updatedOptions } = createSpan("SearchIndexerClient-getIndexer", options);
         try {
-            const result = await this.client.indexers.get(indexerName, operationOptionsToRequestOptionsBase(updatedOptions));
+            const result = await this.client.indexers.get(indexerName, updatedOptions);
             return utils.generatedSearchIndexerToPublicSearchIndexer(result);
         }
         catch (e) {
             span.setStatus({
-                code: SpanStatusCode.ERROR,
-                message: e.message
+                status: "error",
+                error: e.message,
             });
             throw e;
         }
@@ -237,13 +248,13 @@ export class SearchIndexerClient {
     async getDataSourceConnection(dataSourceConnectionName, options = {}) {
         const { span, updatedOptions } = createSpan("SearchIndexerClient-getDataSourceConnection", options);
         try {
-            const result = await this.client.dataSources.get(dataSourceConnectionName, operationOptionsToRequestOptionsBase(updatedOptions));
+            const result = await this.client.dataSources.get(dataSourceConnectionName, updatedOptions);
             return utils.generatedDataSourceToPublicDataSource(result);
         }
         catch (e) {
             span.setStatus({
-                code: SpanStatusCode.ERROR,
-                message: e.message
+                status: "error",
+                error: e.message,
             });
             throw e;
         }
@@ -259,13 +270,13 @@ export class SearchIndexerClient {
     async getSkillset(skillsetName, options = {}) {
         const { span, updatedOptions } = createSpan("SearchIndexerClient-getSkillset", options);
         try {
-            const result = await this.client.skillsets.get(skillsetName, operationOptionsToRequestOptionsBase(updatedOptions));
+            const result = await this.client.skillsets.get(skillsetName, updatedOptions);
             return utils.generatedSkillsetToPublicSkillset(result);
         }
         catch (e) {
             span.setStatus({
-                code: SpanStatusCode.ERROR,
-                message: e.message
+                status: "error",
+                error: e.message,
             });
             throw e;
         }
@@ -281,13 +292,13 @@ export class SearchIndexerClient {
     async createIndexer(indexer, options = {}) {
         const { span, updatedOptions } = createSpan("SearchIndexerClient-createIndexer", options);
         try {
-            const result = await this.client.indexers.create(utils.publicSearchIndexerToGeneratedSearchIndexer(indexer), operationOptionsToRequestOptionsBase(updatedOptions));
+            const result = await this.client.indexers.create(utils.publicSearchIndexerToGeneratedSearchIndexer(indexer), updatedOptions);
             return utils.generatedSearchIndexerToPublicSearchIndexer(result);
         }
         catch (e) {
             span.setStatus({
-                code: SpanStatusCode.ERROR,
-                message: e.message
+                status: "error",
+                error: e.message,
             });
             throw e;
         }
@@ -303,13 +314,13 @@ export class SearchIndexerClient {
     async createDataSourceConnection(dataSourceConnection, options = {}) {
         const { span, updatedOptions } = createSpan("SearchIndexerClient-createDataSourceConnection", options);
         try {
-            const result = await this.client.dataSources.create(utils.publicDataSourceToGeneratedDataSource(dataSourceConnection), operationOptionsToRequestOptionsBase(updatedOptions));
+            const result = await this.client.dataSources.create(utils.publicDataSourceToGeneratedDataSource(dataSourceConnection), updatedOptions);
             return utils.generatedDataSourceToPublicDataSource(result);
         }
         catch (e) {
             span.setStatus({
-                code: SpanStatusCode.ERROR,
-                message: e.message
+                status: "error",
+                error: e.message,
             });
             throw e;
         }
@@ -325,13 +336,13 @@ export class SearchIndexerClient {
     async createSkillset(skillset, options = {}) {
         const { span, updatedOptions } = createSpan("SearchIndexerClient-createSkillset", options);
         try {
-            const result = await this.client.skillsets.create(utils.publicSkillsetToGeneratedSkillset(skillset), operationOptionsToRequestOptionsBase(updatedOptions));
+            const result = await this.client.skillsets.create(utils.publicSkillsetToGeneratedSkillset(skillset), updatedOptions);
             return utils.generatedSkillsetToPublicSkillset(result);
         }
         catch (e) {
             span.setStatus({
-                code: SpanStatusCode.ERROR,
-                message: e.message
+                status: "error",
+                error: e.message,
             });
             throw e;
         }
@@ -348,13 +359,13 @@ export class SearchIndexerClient {
         const { span, updatedOptions } = createSpan("SearchIndexerClient-createOrUpdateIndexer", options);
         try {
             const etag = options.onlyIfUnchanged ? indexer.etag : undefined;
-            const result = await this.client.indexers.createOrUpdate(indexer.name, utils.publicSearchIndexerToGeneratedSearchIndexer(indexer), Object.assign(Object.assign({}, operationOptionsToRequestOptionsBase(updatedOptions)), { ifMatch: etag }));
+            const result = await this.client.indexers.createOrUpdate(indexer.name, utils.publicSearchIndexerToGeneratedSearchIndexer(indexer), Object.assign(Object.assign({}, updatedOptions), { ifMatch: etag, skipIndexerResetRequirementForCache: options.skipIndexerResetRequirementForCache, disableCacheReprocessingChangeDetection: options.disableCacheReprocessingChangeDetection }));
             return utils.generatedSearchIndexerToPublicSearchIndexer(result);
         }
         catch (e) {
             span.setStatus({
-                code: SpanStatusCode.ERROR,
-                message: e.message
+                status: "error",
+                error: e.message,
             });
             throw e;
         }
@@ -371,13 +382,13 @@ export class SearchIndexerClient {
         const { span, updatedOptions } = createSpan("SearchIndexerClient-createOrUpdateDataSourceConnection", options);
         try {
             const etag = options.onlyIfUnchanged ? dataSourceConnection.etag : undefined;
-            const result = await this.client.dataSources.createOrUpdate(dataSourceConnection.name, utils.publicDataSourceToGeneratedDataSource(dataSourceConnection), Object.assign(Object.assign({}, operationOptionsToRequestOptionsBase(updatedOptions)), { ifMatch: etag }));
+            const result = await this.client.dataSources.createOrUpdate(dataSourceConnection.name, utils.publicDataSourceToGeneratedDataSource(dataSourceConnection), Object.assign(Object.assign({}, updatedOptions), { ifMatch: etag, skipIndexerResetRequirementForCache: options.skipIndexerResetRequirementForCache }));
             return utils.generatedDataSourceToPublicDataSource(result);
         }
         catch (e) {
             span.setStatus({
-                code: SpanStatusCode.ERROR,
-                message: e.message
+                status: "error",
+                error: e.message,
             });
             throw e;
         }
@@ -394,13 +405,13 @@ export class SearchIndexerClient {
         const { span, updatedOptions } = createSpan("SearchIndexerClient-createOrUpdateSkillset", options);
         try {
             const etag = options.onlyIfUnchanged ? skillset.etag : undefined;
-            const result = await this.client.skillsets.createOrUpdate(skillset.name, utils.publicSkillsetToGeneratedSkillset(skillset), Object.assign(Object.assign({}, operationOptionsToRequestOptionsBase(updatedOptions)), { ifMatch: etag }));
+            const result = await this.client.skillsets.createOrUpdate(skillset.name, utils.publicSkillsetToGeneratedSkillset(skillset), Object.assign(Object.assign({}, updatedOptions), { ifMatch: etag, skipIndexerResetRequirementForCache: options.skipIndexerResetRequirementForCache, disableCacheReprocessingChangeDetection: options.disableCacheReprocessingChangeDetection }));
             return utils.generatedSkillsetToPublicSkillset(result);
         }
         catch (e) {
             span.setStatus({
-                code: SpanStatusCode.ERROR,
-                message: e.message
+                status: "error",
+                error: e.message,
             });
             throw e;
         }
@@ -422,12 +433,12 @@ export class SearchIndexerClient {
                 : options.onlyIfUnchanged
                     ? indexer.etag
                     : undefined;
-            await this.client.indexers.delete(indexerName, Object.assign(Object.assign({}, operationOptionsToRequestOptionsBase(updatedOptions)), { ifMatch: etag }));
+            await this.client.indexers.delete(indexerName, Object.assign(Object.assign({}, updatedOptions), { ifMatch: etag }));
         }
         catch (e) {
             span.setStatus({
-                code: SpanStatusCode.ERROR,
-                message: e.message
+                status: "error",
+                error: e.message,
             });
             throw e;
         }
@@ -449,12 +460,12 @@ export class SearchIndexerClient {
                 : options.onlyIfUnchanged
                     ? dataSourceConnection.etag
                     : undefined;
-            await this.client.dataSources.delete(dataSourceConnectionName, Object.assign(Object.assign({}, operationOptionsToRequestOptionsBase(updatedOptions)), { ifMatch: etag }));
+            await this.client.dataSources.delete(dataSourceConnectionName, Object.assign(Object.assign({}, updatedOptions), { ifMatch: etag }));
         }
         catch (e) {
             span.setStatus({
-                code: SpanStatusCode.ERROR,
-                message: e.message
+                status: "error",
+                error: e.message,
             });
             throw e;
         }
@@ -476,12 +487,12 @@ export class SearchIndexerClient {
                 : options.onlyIfUnchanged
                     ? skillset.etag
                     : undefined;
-            await this.client.skillsets.delete(skillsetName, Object.assign(Object.assign({}, operationOptionsToRequestOptionsBase(updatedOptions)), { ifMatch: etag }));
+            await this.client.skillsets.delete(skillsetName, Object.assign(Object.assign({}, updatedOptions), { ifMatch: etag }));
         }
         catch (e) {
             span.setStatus({
-                code: SpanStatusCode.ERROR,
-                message: e.message
+                status: "error",
+                error: e.message,
             });
             throw e;
         }
@@ -497,13 +508,13 @@ export class SearchIndexerClient {
     async getIndexerStatus(indexerName, options = {}) {
         const { span, updatedOptions } = createSpan("SearchIndexerClient-getIndexerStatus", options);
         try {
-            const result = await this.client.indexers.getStatus(indexerName, operationOptionsToRequestOptionsBase(updatedOptions));
+            const result = await this.client.indexers.getStatus(indexerName, updatedOptions);
             return result;
         }
         catch (e) {
             span.setStatus({
-                code: SpanStatusCode.ERROR,
-                message: e.message
+                status: "error",
+                error: e.message,
             });
             throw e;
         }
@@ -519,12 +530,12 @@ export class SearchIndexerClient {
     async resetIndexer(indexerName, options = {}) {
         const { span, updatedOptions } = createSpan("SearchIndexerClient-resetIndexer", options);
         try {
-            await this.client.indexers.reset(indexerName, operationOptionsToRequestOptionsBase(updatedOptions));
+            await this.client.indexers.reset(indexerName, updatedOptions);
         }
         catch (e) {
             span.setStatus({
-                code: SpanStatusCode.ERROR,
-                message: e.message
+                status: "error",
+                error: e.message,
             });
             throw e;
         }
@@ -540,12 +551,58 @@ export class SearchIndexerClient {
     async runIndexer(indexerName, options = {}) {
         const { span, updatedOptions } = createSpan("SearchIndexerClient-runIndexer", options);
         try {
-            await this.client.indexers.run(indexerName, operationOptionsToRequestOptionsBase(updatedOptions));
+            await this.client.indexers.run(indexerName, updatedOptions);
+        }
+        catch (e) {
+            span.setStatus({
+                status: "error",
+                error: e.message,
+            });
+            throw e;
+        }
+        finally {
+            span.end();
+        }
+    }
+    /**
+     * Resets specific documents in the datasource to be selectively re-ingested by the indexer.
+     * @param indexerName - The name of the indexer to reset documents for.
+     * @param options - Additional optional arguments.
+     */
+    async resetDocuments(indexerName, options = {}) {
+        const { span, updatedOptions } = createSpan("SearchIndexerClient-resetDocs", options);
+        try {
+            await this.client.indexers.resetDocs(indexerName, Object.assign(Object.assign({}, updatedOptions), { keysOrIds: {
+                    documentKeys: updatedOptions.documentKeys,
+                    datasourceDocumentIds: updatedOptions.datasourceDocumentIds,
+                } }));
+        }
+        catch (e) {
+            span.setStatus({
+                status: "error",
+                error: e.message,
+            });
+            throw e;
+        }
+        finally {
+            span.end();
+        }
+    }
+    /**
+     * Reset an existing skillset in a search service.
+     * @param skillsetName - The name of the skillset to reset.
+     * @param skillNames - The names of skills to reset.
+     * @param options - The options parameters.
+     */
+    async resetSkills(skillsetName, options = {}) {
+        const { span, updatedOptions } = createSpan("SearchIndexerClient-resetSkills", options);
+        try {
+            await this.client.skillsets.resetSkills(skillsetName, { skillNames: options.skillNames }, updatedOptions);
         }
         catch (e) {
             span.setStatus({
-                code: SpanStatusCode.ERROR,
-                message: e.message
+                status: "error",
+                error: e.message,
             });
             throw e;
         }