@azure/search-documents 12.2.0 → 12.3.0-alpha.20251031.1

package/dist/esm/searchIndexClient.js

@@ -1,9 +1,9 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
-/// <reference lib="esnext.asynciterable" />
 import { isTokenCredential } from "@azure/core-auth";
 import { bearerTokenAuthenticationPolicy } from "@azure/core-rest-pipeline";
 import { SearchServiceClient as GeneratedClient } from "./generated/service/searchServiceClient.js";
+import { KnowledgeRetrievalClient } from "./knowledgeRetrievalClient.js";
 import { logger } from "./logger.js";
 import { createOdataMetadataPolicy } from "./odataMetadataPolicy.js";
 import { createSearchApiKeyCredentialPolicy } from "./searchApiKeyCredentialPolicy.js";
@@ -35,6 +35,10 @@ export class SearchIndexClient {
      * A reference to the auto-generated SearchServiceClient
      */
     client;
+    /**
+     * A reference to the internal HTTP pipeline for use with raw requests
+     */
+    pipeline;
     /**
      * Used to authenticate requests to the service.
      */
@@ -47,13 +51,10 @@ export class SearchIndexClient {
      * Creates an instance of SearchIndexClient.
      *
      * Example usage:
-     * ```ts
-     * const { SearchIndexClient, AzureKeyCredential } = require("@azure/search-documents");
+     * ```ts snippet:ReadmeSampleSearchIndexClient
+     * import { SearchIndexClient, AzureKeyCredential } from "@azure/search-documents";
      *
-     * const client = new SearchIndexClient(
-     *   "<endpoint>",
-     *   new AzureKeyCredential("<Admin Key>");
-     * );
+     * const indexClient = new SearchIndexClient("<endpoint>", new AzureKeyCredential("<apiKey>"));
      * ```
      * @param endpoint - The endpoint of the search service
      * @param credential - Used to authenticate requests to the service.
@@ -83,6 +84,7 @@ export class SearchIndexClient {
             this.options.serviceVersion ?? this.options.apiVersion ?? utils.defaultServiceVersion;
         this.apiVersion = this.serviceVersion;
         this.client = new GeneratedClient(this.endpoint, this.serviceVersion, internalClientPipelineOptions);
+        this.pipeline = this.client.pipeline;
         if (isTokenCredential(credential)) {
             const scope = this.options.audience
                 ? `${this.options.audience}/.default`
@@ -135,6 +137,46 @@ export class SearchIndexClient {
             },
         };
     }
+    async *listAliasesPage(options = {}) {
+        const { span, updatedOptions } = createSpan("SearchIndexClient-listAliases", options);
+        try {
+            const result = await this.client.aliases.list(updatedOptions);
+            yield result.aliases;
+        }
+        catch (e) {
+            span.setStatus({
+                status: "error",
+                error: e.message,
+            });
+            throw e;
+        }
+        finally {
+            span.end();
+        }
+    }
+    async *listAliasesAll(options = {}) {
+        for await (const page of this.listAliasesPage(options)) {
+            yield* page;
+        }
+    }
+    /**
+     * Lists all aliases available for a search service.
+     * @param options - The options parameters.
+     */
+    listAliases(options = {}) {
+        const iter = this.listAliasesAll(options);
+        return {
+            next() {
+                return iter.next();
+            },
+            [Symbol.asyncIterator]() {
+                return this;
+            },
+            byPage: () => {
+                return this.listAliasesPage(options);
+            },
+        };
+    }
     async *listIndexesNamesPage(options = {}) {
         const { span, updatedOptions } = createSpan("SearchIndexClient-listIndexesNamesPage", options);
         try {
@@ -165,6 +207,7 @@ export class SearchIndexClient {
      * Retrieves a list of names of existing indexes in the service.
      * @param options - Options to the list index operation.
      */
+    // eslint-disable-next-line @azure/azure-sdk/ts-naming-options
     listIndexesNames(options = {}) {
         const iter = this.listIndexesNamesAll(options);
         return {
@@ -204,6 +247,7 @@ export class SearchIndexClient {
      * Retrieves a list of names of existing SynonymMaps in the service.
      * @param options - Options to the list SynonymMaps operation.
      */
+    // eslint-disable-next-line @azure/azure-sdk/ts-naming-options
     async listSynonymMapsNames(options = {}) {
         const { span, updatedOptions } = createSpan("SearchIndexClient-listSynonymMapsNames", options);
         try {
@@ -251,7 +295,9 @@ export class SearchIndexClient {
      * @param synonymMapName - The name of the SynonymMap.
      * @param options - Additional optional arguments.
      */
-    async getSynonymMap(synonymMapName, options = {}) {
+    async getSynonymMap(synonymMapName, 
+    // eslint-disable-next-line @azure/azure-sdk/ts-naming-options
+    options = {}) {
         const { span, updatedOptions } = createSpan("SearchIndexClient-getSynonymMaps", options);
         try {
             const result = await this.client.synonymMaps.get(synonymMapName, updatedOptions);
@@ -364,11 +410,6 @@ export class SearchIndexClient {
             span.end();
         }
     }
-    /**
-     * Deletes an existing index.
-     * @param indexName - Index/Name of the index to delete.
-     * @param options - Additional optional arguments.
-     */
     async deleteIndex(index, options = {}) {
         const { span, updatedOptions } = createSpan("SearchIndexClient-deleteIndex", options);
         try {
@@ -420,6 +461,97 @@ export class SearchIndexClient {
             span.end();
         }
     }
+    /**
+     * 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.
+     */
+    async createOrUpdateAlias(alias, options = {}) {
+        const { span, updatedOptions } = createSpan("SearchIndexClient-createOrUpdateAlias", options);
+        try {
+            const etag = options.onlyIfUnchanged ? alias.etag : undefined;
+            const result = await this.client.aliases.createOrUpdate(alias.name, alias, {
+                ...updatedOptions,
+                ifMatch: etag,
+            });
+            return result;
+        }
+        catch (e) {
+            span.setStatus({
+                status: "error",
+                error: e.message,
+            });
+            throw e;
+        }
+        finally {
+            span.end();
+        }
+    }
+    /**
+     * Creates a new search alias.
+     * @param alias - The definition of the alias to create.
+     * @param options - The options parameters.
+     */
+    async createAlias(alias, options = {}) {
+        const { span, updatedOptions } = createSpan("SearchIndexClient-createAlias", options);
+        try {
+            const result = await this.client.aliases.create(alias, updatedOptions);
+            return result;
+        }
+        catch (e) {
+            span.setStatus({
+                status: "error",
+                error: e.message,
+            });
+            throw e;
+        }
+        finally {
+            span.end();
+        }
+    }
+    async deleteAlias(alias, options = {}) {
+        const { span, updatedOptions } = createSpan("SearchIndexClient-deleteAlias", options);
+        try {
+            const aliasName = typeof alias === "string" ? alias : alias.name;
+            const etag = typeof alias === "string" ? undefined : options.onlyIfUnchanged ? alias.etag : undefined;
+            await this.client.aliases.delete(aliasName, {
+                ...updatedOptions,
+                ifMatch: etag,
+            });
+        }
+        catch (e) {
+            span.setStatus({
+                status: "error",
+                error: e.message,
+            });
+            throw e;
+        }
+        finally {
+            span.end();
+        }
+    }
+    /**
+     * Retrieves an alias definition.
+     * @param aliasName - The name of the alias to retrieve.
+     * @param options - The options parameters.
+     */
+    async getAlias(aliasName, options = {}) {
+        const { span, updatedOptions } = createSpan("SearchIndexClient-getAlias", options);
+        try {
+            const result = await this.client.aliases.get(aliasName, updatedOptions);
+            return result;
+        }
+        catch (e) {
+            span.setStatus({
+                status: "error",
+                error: e.message,
+            });
+            throw e;
+        }
+        finally {
+            span.end();
+        }
+    }
     /**
      * Retrieves statistics about an index, such as the count of documents and the size
      * of index storage.
@@ -493,17 +625,350 @@ export class SearchIndexClient {
             span.end();
         }
     }
+    async *getIndexStatsSummaryPage(options = {}) {
+        const { span, updatedOptions } = createSpan("SearchIndexClient-getIndexStatsSummaryPage", options);
+        try {
+            const { indexesStatistics } = await this.client.getIndexStatsSummary(updatedOptions);
+            yield indexesStatistics;
+        }
+        catch (e) {
+            span.setStatus({
+                status: "error",
+                error: e.message,
+            });
+            throw e;
+        }
+        finally {
+            span.end();
+        }
+    }
+    async *getIndexStatsSummaryAll(options = {}) {
+        for await (const page of this.getIndexStatsSummaryPage(options)) {
+            yield* page;
+        }
+    }
+    /**
+     * Retrieves a list of existing indexes in the service.
+     * @param options - Options to the list index operation.
+     */
+    getIndexStatsSummary(options = {}) {
+        const iter = this.getIndexStatsSummaryAll(options);
+        return {
+            next() {
+                return iter.next();
+            },
+            [Symbol.asyncIterator]() {
+                return this;
+            },
+            byPage: () => {
+                return this.getIndexStatsSummaryPage(options);
+            },
+        };
+    }
+    /**
+     * Creates a new knowledgebase.
+     * @param knowledgeBase - definition of the knowledgebase to create.
+     * @param options - options parameters.
+     */
+    async createKnowledgeBase(knowledgeBase, options) {
+        const { span, updatedOptions } = createSpan("SearchIndexClient-createKnowledgeBase", options);
+        try {
+            const result = await this.client.knowledgeBases.create(utils.convertKnowledgeBaseToGenerated(knowledgeBase), updatedOptions);
+            return utils.convertKnowledgeBaseToPublic(result);
+        }
+        catch (e) {
+            span.setStatus({
+                status: "error",
+                error: e.message,
+            });
+            throw e;
+        }
+        finally {
+            span.end();
+        }
+    }
+    /**
+     * Creates a new knowledge base or updates a knowledge base if it already exists.
+     * @param knowledgeBaseName - name of the knowledge base to create or update.
+     * @param knowledgeBase - definition of the knowledge base to create or update.
+     * @param options - options parameters.
+     */
+    async createOrUpdateKnowledgeBase(knowledgeBaseName, knowledgeBase, options) {
+        const { span, updatedOptions } = createSpan("SearchIndexClient-createOrUpdateKnowledgeBase", options);
+        try {
+            const etag = updatedOptions.onlyIfUnchanged ? knowledgeBase.etag : undefined;
+            const result = await this.client.knowledgeBases.createOrUpdate(knowledgeBaseName, utils.convertKnowledgeBaseToGenerated(knowledgeBase), {
+                ...updatedOptions,
+                ifMatch: etag,
+            });
+            return utils.convertKnowledgeBaseToPublic(result);
+        }
+        catch (e) {
+            span.setStatus({
+                status: "error",
+                error: e.message,
+            });
+            throw e;
+        }
+        finally {
+            span.end();
+        }
+    }
+    /**
+     * Retrieves a knowledge base definition.
+     * @param knowledgeBaseName - name of the knowledge base to retrieve.
+     * @param options - options parameters.
+     */
+    async getKnowledgeBase(knowledgeBaseName, options) {
+        const { span, updatedOptions } = createSpan("SearchIndexClient-getKnowledgeBase", options);
+        try {
+            const result = await this.client.knowledgeBases.get(knowledgeBaseName, updatedOptions);
+            return utils.convertKnowledgeBaseToPublic(result);
+        }
+        catch (e) {
+            span.setStatus({
+                status: "error",
+                error: e.message,
+            });
+            throw e;
+        }
+        finally {
+            span.end();
+        }
+    }
+    async *listKnowledgeBasesPage(options = {}) {
+        const { span, updatedOptions } = createSpan("SearchIndexClient-listKnowledgeBasesPage", options);
+        try {
+            const { knowledgeBases } = await this.client.knowledgeBases.list(updatedOptions);
+            const mapped = knowledgeBases.map((base) => utils.convertKnowledgeBaseToPublic(base));
+            yield mapped;
+        }
+        catch (e) {
+            span.setStatus({
+                status: "error",
+                error: e.message,
+            });
+            throw e;
+        }
+        finally {
+            span.end();
+        }
+    }
+    async *listKnowledgeBasesAll(options = {}) {
+        for await (const page of this.listKnowledgeBasesPage(options)) {
+            yield* page;
+        }
+    }
+    /**
+     * Retrieves a list of existing KnowledgeBases in the service.
+     * @param options - Options to the list knowledge bases operation.
+     */
+    listKnowledgeBases(options = {}) {
+        const iter = this.listKnowledgeBasesAll(options);
+        return {
+            next() {
+                return iter.next();
+            },
+            [Symbol.asyncIterator]() {
+                return this;
+            },
+            byPage: () => {
+                return this.listKnowledgeBasesPage(options);
+            },
+        };
+    }
+    async deleteKnowledgeBase(knowledgeBase, options) {
+        const { span, updatedOptions } = createSpan("SearchIndexClient-deleteKnowledgeBase", options);
+        try {
+            const knowledgeBaseName = typeof knowledgeBase === "string" ? knowledgeBase : knowledgeBase.name;
+            const etag = typeof knowledgeBase !== "string" && updatedOptions.onlyIfUnchanged
+                ? knowledgeBase.etag
+                : undefined;
+            const result = await this.client.knowledgeBases.delete(knowledgeBaseName, {
+                ...updatedOptions,
+                ifMatch: etag,
+            });
+            return result;
+        }
+        catch (e) {
+            span.setStatus({
+                status: "error",
+                error: e.message,
+            });
+            throw e;
+        }
+        finally {
+            span.end();
+        }
+    }
+    async createOrUpdateKnowledgeSource(sourceName, knowledgeSource, options) {
+        const { span, updatedOptions } = createSpan("SearchIndexClient-createOrUpdateKnowledgeSource", options);
+        try {
+            const etag = updatedOptions.onlyIfUnchanged ? knowledgeSource.etag : undefined;
+            const result = await this.client.knowledgeSources.createOrUpdate(sourceName, utils.convertKnowledgeSourceToGenerated(knowledgeSource), {
+                ...updatedOptions,
+                ifMatch: etag,
+            });
+            return utils.convertKnowledgeSourceToPublic(result);
+        }
+        catch (e) {
+            span.setStatus({
+                status: "error",
+                error: e.message,
+            });
+            throw e;
+        }
+        finally {
+            span.end();
+        }
+    }
+    async deleteKnowledgeSource(source, options) {
+        const { span, updatedOptions } = createSpan("SearchIndexClient-deleteKnowledgeSource", options);
+        try {
+            const sourceName = typeof source === "string" ? source : source.name;
+            const etag = typeof source !== "string" && updatedOptions.onlyIfUnchanged ? source.etag : undefined;
+            const result = await this.client.knowledgeSources.delete(sourceName, {
+                ...updatedOptions,
+                ifMatch: etag,
+            });
+            return result;
+        }
+        catch (e) {
+            span.setStatus({
+                status: "error",
+                error: e.message,
+            });
+            throw e;
+        }
+        finally {
+            span.end();
+        }
+    }
+    /**
+     * Retrieves a knowledge source definition.
+     * @param sourceName - The name of the knowledge source to retrieve.
+     * @param options - The options parameters.
+     */
+    async getKnowledgeSource(sourceName, options) {
+        const { span, updatedOptions } = createSpan("SearchIndexClient-getKnowledgeSource", options);
+        try {
+            const result = await this.client.knowledgeSources.get(sourceName, updatedOptions);
+            return utils.convertKnowledgeSourceToPublic(result);
+        }
+        catch (e) {
+            span.setStatus({
+                status: "error",
+                error: e.message,
+            });
+            throw e;
+        }
+        finally {
+            span.end();
+        }
+    }
+    async *listKnowledgeSourcesPage(options = {}) {
+        const { span, updatedOptions } = createSpan("SearchIndexClient-listKnowledgeSourcesPage", options);
+        try {
+            const { knowledgeSources } = await this.client.knowledgeSources.list(updatedOptions);
+            const mapped = knowledgeSources.map((source) => utils.convertKnowledgeSourceToPublic(source));
+            yield mapped;
+        }
+        catch (e) {
+            span.setStatus({
+                status: "error",
+                error: e.message,
+            });
+            throw e;
+        }
+        finally {
+            span.end();
+        }
+    }
+    async *listKnowledgeSourcesAll(options = {}) {
+        for await (const page of this.listKnowledgeSourcesPage(options)) {
+            yield* page;
+        }
+    }
+    /**
+     * Retrieves a list of existing KnowledgeSources in the service.
+     * @param options - Options to the list knowledge sources operation.
+     */
+    listKnowledgeSources(options = {}) {
+        const iter = this.listKnowledgeSourcesAll(options);
+        return {
+            next() {
+                return iter.next();
+            },
+            [Symbol.asyncIterator]() {
+                return this;
+            },
+            byPage: () => {
+                return this.listKnowledgeSourcesPage(options);
+            },
+        };
+    }
+    /**
+     * Creates a new knowledge source.
+     * @param knowledgeSource - The definition of the knowledge source to create.
+     * @param options - The options parameters.
+     */
+    async createKnowledgeSource(knowledgeSource, options) {
+        const { span, updatedOptions } = createSpan("SearchIndexClient-createKnowledgeSource", options);
+        try {
+            const result = await this.client.knowledgeSources.create(utils.convertKnowledgeSourceToGenerated(knowledgeSource), updatedOptions);
+            return utils.convertKnowledgeSourceToPublic(result);
+        }
+        catch (e) {
+            span.setStatus({
+                status: "error",
+                error: e.message,
+            });
+            throw e;
+        }
+        finally {
+            span.end();
+        }
+    }
+    /**
+     * Returns the current status and synchronization history of a knowledge source.
+     * @param sourceName - The name of the knowledge source for which to retrieve status.
+     * @param options - The options parameters.
+     */
+    async getKnowledgeSourceStatus(sourceName, options) {
+        const { span, updatedOptions } = createSpan("SearchIndexClient-getKnowledgeSourceStatus", options);
+        try {
+            const result = await this.client.knowledgeSources.getStatus(sourceName, updatedOptions);
+            return result;
+        }
+        catch (e) {
+            span.setStatus({
+                status: "error",
+                error: e.message,
+            });
+            throw e;
+        }
+        finally {
+            span.end();
+        }
+    }
     /**
      * Retrieves the SearchClient corresponding to this SearchIndexClient
      * @param indexName - Name of the index
      * @param options - SearchClient Options
-     * @typeParam TModel - An optional type that represents the documents stored in
-     * the search index. For the best typing experience, all non-key fields should
-     * be marked optional and nullable, and the key property should have the
-     * non-nullable type `string`.
+     * @typeParam TModel - An optional type that represents the documents stored in the search index.
+     * For the best typing experience, all non-key fields should be marked optional and nullable, and
+     * the key property should have the non-nullable type `string`.
      */
     getSearchClient(indexName, options) {
         return new SearchClient(this.endpoint, indexName, this.credential, options || this.options);
     }
+    /**
+     * Retrieves the KnowledgeRetrievalClient corresponding to this SearchIndexClient
+     * @param knowledgeBaseName - Name of the knowledge base
+     * @param options - KnowledgeRetrievalClient Options
+     */
+    getKnowledgeRetrievalClient(knowledgeBaseName, options) {
+        return new KnowledgeRetrievalClient(this.endpoint, knowledgeBaseName, this.credential, options || this.options);
+    }
 }
 //# sourceMappingURL=searchIndexClient.js.map