@azure/search-documents 12.2.0-beta.3 → 12.2.0

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,10 +35,6 @@ 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.
      */
@@ -51,10 +47,13 @@ export class SearchIndexClient {
      * Creates an instance of SearchIndexClient.
      *
      * Example usage:
-     * ```ts snippet:ReadmeSampleSearchIndexClient
-     * import { SearchIndexClient, AzureKeyCredential } from "@azure/search-documents";
+     * ```ts
+     * const { SearchIndexClient, AzureKeyCredential } = require("@azure/search-documents");
      *
-     * const indexClient = new SearchIndexClient("<endpoint>", new AzureKeyCredential("<apiKey>"));
+     * const client = new SearchIndexClient(
+     *   "<endpoint>",
+     *   new AzureKeyCredential("<Admin Key>");
+     * );
      * ```
      * @param endpoint - The endpoint of the search service
      * @param credential - Used to authenticate requests to the service.
@@ -84,7 +83,6 @@ 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`
@@ -137,46 +135,6 @@ 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 {
@@ -207,7 +165,6 @@ 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 {
@@ -247,7 +204,6 @@ 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 {
@@ -295,9 +251,7 @@ export class SearchIndexClient {
      * @param synonymMapName - The name of the SynonymMap.
      * @param options - Additional optional arguments.
      */
-    async getSynonymMap(synonymMapName, 
-    // eslint-disable-next-line @azure/azure-sdk/ts-naming-options
-    options = {}) {
+    async getSynonymMap(synonymMapName, options = {}) {
         const { span, updatedOptions } = createSpan("SearchIndexClient-getSynonymMaps", options);
         try {
             const result = await this.client.synonymMaps.get(synonymMapName, updatedOptions);
@@ -410,6 +364,11 @@ 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 {
@@ -461,97 +420,6 @@ 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.
@@ -625,326 +493,17 @@ 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 agent.
-     * @param knowledgeAgent - definition of the agent to create.
-     * @param options - options parameters.
-     */
-    async createKnowledgeAgent(knowledgeAgent, options) {
-        const { span, updatedOptions } = createSpan("SearchIndexClient-createKnowledgeAgent", options);
-        try {
-            const result = await this.client.knowledgeAgents.create(utils.convertKnowledgeAgentToGenerated(knowledgeAgent), updatedOptions);
-            return utils.convertKnowledgeAgentToPublic(result);
-        }
-        catch (e) {
-            span.setStatus({
-                status: "error",
-                error: e.message,
-            });
-            throw e;
-        }
-        finally {
-            span.end();
-        }
-    }
-    /**
-     * Creates a new agent or updates an agent if it already exists.
-     * @param agentName - name of the agent to create or update.
-     * @param knowledgeAgent - definition of the agent to create or update.
-     * @param options - options parameters.
-     */
-    async createOrUpdateKnowledgeAgent(agentName, knowledgeAgent, options) {
-        const { span, updatedOptions } = createSpan("SearchIndexClient-createOrUpdateKnowledgeAgent", options);
-        try {
-            const etag = updatedOptions.onlyIfUnchanged ? knowledgeAgent.etag : undefined;
-            const result = await this.client.knowledgeAgents.createOrUpdate(agentName, utils.convertKnowledgeAgentToGenerated(knowledgeAgent), {
-                ...updatedOptions,
-                ifMatch: etag,
-            });
-            return utils.convertKnowledgeAgentToPublic(result);
-        }
-        catch (e) {
-            span.setStatus({
-                status: "error",
-                error: e.message,
-            });
-            throw e;
-        }
-        finally {
-            span.end();
-        }
-    }
-    /**
-     * Retrieves an agent definition.
-     * @param agentName - name of the agent to retrieve.
-     * @param options - options parameters.
-     */
-    async getKnowledgeAgent(agentName, options) {
-        const { span, updatedOptions } = createSpan("SearchIndexClient-getKnowledgeAgent", options);
-        try {
-            const result = await this.client.knowledgeAgents.get(agentName, updatedOptions);
-            return utils.convertKnowledgeAgentToPublic(result);
-        }
-        catch (e) {
-            span.setStatus({
-                status: "error",
-                error: e.message,
-            });
-            throw e;
-        }
-        finally {
-            span.end();
-        }
-    }
-    async *listKnowledgeAgentsPage(options = {}) {
-        const { span, updatedOptions } = createSpan("SearchIndexClient-listKnowledgeAgentsPage", options);
-        try {
-            const { knowledgeAgents } = await this.client.knowledgeAgents.list(updatedOptions);
-            const mapped = knowledgeAgents.map((agent) => utils.convertKnowledgeAgentToPublic(agent));
-            yield mapped;
-        }
-        catch (e) {
-            span.setStatus({
-                status: "error",
-                error: e.message,
-            });
-            throw e;
-        }
-        finally {
-            span.end();
-        }
-    }
-    async *listKnowledgeAgentsAll(options = {}) {
-        for await (const page of this.listKnowledgeAgentsPage(options)) {
-            yield* page;
-        }
-    }
-    /**
-     * Retrieves a list of existing KnowledgeAgents in the service.
-     * @param options - Options to the list knowledge agents operation.
-     */
-    listKnowledgeAgents(options = {}) {
-        const iter = this.listKnowledgeAgentsAll(options);
-        return {
-            next() {
-                return iter.next();
-            },
-            [Symbol.asyncIterator]() {
-                return this;
-            },
-            byPage: () => {
-                return this.listKnowledgeAgentsPage(options);
-            },
-        };
-    }
-    async deleteKnowledgeAgent(agent, options) {
-        const { span, updatedOptions } = createSpan("SearchIndexClient-deleteKnowledgeAgent", options);
-        try {
-            const agentName = typeof agent === "string" ? agent : agent.name;
-            const etag = typeof agent !== "string" && updatedOptions.onlyIfUnchanged ? agent.etag : undefined;
-            const result = await this.client.knowledgeAgents.delete(agentName, {
-                ...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();
-        }
-    }
     /**
      * 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 agentName - Name of the agent
-     * @param options - KnowledgeRetrievalClient Options
-     */
-    getKnowledgeRetrievalClient(agentName, options) {
-        return new KnowledgeRetrievalClient(this.endpoint, agentName, this.credential, options || this.options);
-    }
 }
 //# sourceMappingURL=searchIndexClient.js.map