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

package/dist/commonjs/knowledgeRetrievalClient.js

@@ -6,7 +6,7 @@ exports.KnowledgeRetrievalClient = void 0;
 const tslib_1 = require("tslib");
 const core_auth_1 = require("@azure/core-auth");
 const core_rest_pipeline_1 = require("@azure/core-rest-pipeline");
-const searchClient_js_1 = require("./generated/knowledgeAgent/searchClient.js");
+const searchClient_js_1 = require("./generated/knowledgeBase/searchClient.js");
 const logger_js_1 = require("./logger.js");
 const odataMetadataPolicy_js_1 = require("./odataMetadataPolicy.js");
 const searchApiKeyCredentialPolicy_js_1 = require("./searchApiKeyCredentialPolicy.js");
@@ -14,7 +14,7 @@ const searchAudience_js_1 = require("./searchAudience.js");
 const utils = tslib_1.__importStar(require("./serviceUtils.js"));
 const tracing_js_1 = require("./tracing.js");
 /**
- * Class used to perform operations against a knowledge agent.
+ * Class used to perform operations against a knowledge base.
  */
 class KnowledgeRetrievalClient {
     /// Maintenance note: when updating supported API versions,
@@ -28,9 +28,9 @@ class KnowledgeRetrievalClient {
      */
     endpoint;
     /**
-     * The name of the knowledge agent
+     * The name of the knowledge base
      */
-    agentName;
+    knowledgeBaseName;
     /**
      * @hidden
      * A reference to the auto-generated KnowledgeRetrievalClient
@@ -49,19 +49,19 @@ class KnowledgeRetrievalClient {
      *
      * const knowledgeRetrievalClient = new KnowledgeRetrievalClient(
      *   "<endpoint>",
-     *   "<agentName>",
+     *   "<knowledgeBaseName>",
      *   new AzureKeyCredential("<apiKey>"),
      * );
      * ```
      
      * @param endpoint - The endpoint of the search service
-     * @param agentName - The name of the knowledge agent
+     * @param knowledgeBaseName - The name of the knowledge base
      * @param credential - Used to authenticate requests to the service.
      * @param options - Used to configure the Search client.
      */
-    constructor(endpoint, agentName, credential, options = {}) {
+    constructor(endpoint, knowledgeBaseName, credential, options = {}) {
         this.endpoint = endpoint;
-        this.agentName = agentName;
+        this.knowledgeBaseName = knowledgeBaseName;
         const internalClientPipelineOptions = {
             ...options,
             ...{
@@ -79,7 +79,7 @@ class KnowledgeRetrievalClient {
             },
         };
         this.serviceVersion = options.serviceVersion ?? utils.defaultServiceVersion;
-        this.client = new searchClient_js_1.SearchClient(this.endpoint, this.agentName, this.serviceVersion, internalClientPipelineOptions);
+        this.client = new searchClient_js_1.SearchClient(this.endpoint, this.knowledgeBaseName, this.serviceVersion, internalClientPipelineOptions);
         this.pipeline = this.client.pipeline;
         if ((0, core_auth_1.isTokenCredential)(credential)) {
             const scope = options.audience

package/dist/commonjs/knowledgeRetrievalClient.js.map

@@ -1 +1 @@
-{"version":3,"file":"knowledgeRetrievalClient.js","sourceRoot":"","sources":["../../src/knowledgeRetrievalClient.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;;AAKlC,gDAAqD;AAIrD,kEAA4E;AAK5E,gFAA6F;AAE7F,2CAAqC;AACrC,qEAAqE;AACrE,uFAAuF;AACvF,2DAA0D;AAC1D,iEAA2C;AAC3C,6CAA0C;AAmB1C;;GAEG;AACH,MAAa,wBAAwB;IACnC,2DAA2D;IAC3D,8DAA8D;IAE9D;;OAEG;IACa,cAAc,GAAW,KAAK,CAAC,qBAAqB,CAAC;IAErE;;OAEG;IACa,QAAQ,CAAS;IAEjC;;OAEG;IACa,SAAS,CAAS;IAElC;;;OAGG;IACc,MAAM,CAAkB;IAEzC;;OAEG;IACa,QAAQ,CAAW;IAEnC;;;;;;;;;;;;;;;;;;OAkBG;IACH,YACE,QAAgB,EAChB,SAAiB,EACjB,UAA2C,EAC3C,UAA2C,EAAE;QAE7C,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAE3B,MAAM,6BAA6B,GAAkC;YACnE,GAAG,OAAO;YACV,GAAG;gBACD,cAAc,EAAE;oBACd,MAAM,EAAE,kBAAM,CAAC,IAAI;oBACnB,4BAA4B,EAAE;wBAC5B,cAAc;wBACd,UAAU;wBACV,kBAAkB;wBAClB,eAAe;wBACf,QAAQ;wBACR,iBAAiB;qBAClB;iBACF;aACF;SACF,CAAC;QAEF,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC,cAAc,IAAI,KAAK,CAAC,qBAAqB,CAAC;QAE5E,IAAI,CAAC,MAAM,GAAG,IAAI,8BAAe,CAC/B,IAAI,CAAC,QAAQ,EACb,IAAI,CAAC,SAAS,EACd,IAAI,CAAC,cAAc,EACnB,6BAA6B,CAC9B,CAAC;QAEF,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC;QAErC,IAAI,IAAA,6BAAiB,EAAC,UAAU,CAAC,EAAE,CAAC;YAClC,MAAM,KAAK,GAAW,OAAO,CAAC,QAAQ;gBACpC,CAAC,CAAC,GAAG,OAAO,CAAC,QAAQ,WAAW;gBAChC,CAAC,CAAC,GAAG,uCAAmB,CAAC,gBAAgB,WAAW,CAAC;YAEvD,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,SAAS,CAC5B,IAAA,oDAA+B,EAAC,EAAE,UAAU,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAC/D,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAA,oEAAkC,EAAC,UAAU,CAAC,CAAC,CAAC;QACjF,CAAC;QAED,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAA,kDAAyB,EAAC,MAAM,CAAC,CAAC,CAAC;IACpE,CAAC;IAEM,KAAK,CAAC,iBAAiB,CAC5B,gBAAgD,EAChD,OAAkC;QAElC,MAAM,EAAE,IAAI,EAAE,cAAc,EAAE,GAAG,IAAA,uBAAU,EACzC,4CAA4C,EAC5C,OAAO,CACR,CAAC;QAEF,IAAI,CAAC;YACH,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC,QAAQ,CAAC,gBAAgB,EAAE,cAAc,CAAC,CAAC;QACzF,CAAC;QAAC,OAAO,CAAM,EAAE,CAAC;YAChB,IAAI,CAAC,SAAS,CAAC;gBACb,MAAM,EAAE,OAAO;gBACf,KAAK,EAAE,CAAC,CAAC,OAAO;aACjB,CAAC,CAAC;YACH,MAAM,CAAC,CAAC;QACV,CAAC;gBAAS,CAAC;YACT,IAAI,CAAC,GAAG,EAAE,CAAC;QACb,CAAC;IACH,CAAC;CACF;AA1HD,4DA0HC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\n/// <reference lib=\"esnext.asynciterable\" />\n\nimport type { KeyCredential, TokenCredential } from \"@azure/core-auth\";\nimport { isTokenCredential } from \"@azure/core-auth\";\nimport type { InternalClientPipelineOptions } from \"@azure/core-client\";\nimport type { ExtendedCommonClientOptions } from \"@azure/core-http-compat\";\nimport type { Pipeline } from \"@azure/core-rest-pipeline\";\nimport { bearerTokenAuthenticationPolicy } from \"@azure/core-rest-pipeline\";\nimport type {\n  KnowledgeAgentRetrievalRequest,\n  KnowledgeAgentRetrievalResponse,\n} from \"./generated/knowledgeAgent/index.js\";\nimport { SearchClient as GeneratedClient } from \"./generated/knowledgeAgent/searchClient.js\";\nimport type { RetrieveKnowledgeOptions } from \"./knowledgeAgentModels.js\";\nimport { logger } from \"./logger.js\";\nimport { createOdataMetadataPolicy } from \"./odataMetadataPolicy.js\";\nimport { createSearchApiKeyCredentialPolicy } from \"./searchApiKeyCredentialPolicy.js\";\nimport { KnownSearchAudience } from \"./searchAudience.js\";\nimport * as utils from \"./serviceUtils.js\";\nimport { createSpan } from \"./tracing.js\";\n\n/**\n * Client options used to configure Cognitive Search API requests.\n */\nexport interface KnowledgeRetrievalClientOptions extends ExtendedCommonClientOptions {\n  /**\n   * The service version to use when communicating with the service.\n   */\n  serviceVersion?: string;\n\n  /**\n   * The Audience to use for authentication with Azure Active Directory (AAD). The\n   * audience is not considered when using a shared key.\n   * {@link KnownSearchAudience} can be used interchangeably with audience\n   */\n  audience?: string;\n}\n\n/**\n * Class used to perform operations against a knowledge agent.\n */\nexport class KnowledgeRetrievalClient {\n  /// Maintenance note: when updating supported API versions,\n  /// the ContinuationToken logic will need to be updated below.\n\n  /**\n   *  The service version to use when communicating with the service.\n   */\n  public readonly serviceVersion: string = utils.defaultServiceVersion;\n\n  /**\n   * The endpoint of the search service\n   */\n  public readonly endpoint: string;\n\n  /**\n   * The name of the knowledge agent\n   */\n  public readonly agentName: string;\n\n  /**\n   * @hidden\n   * A reference to the auto-generated KnowledgeRetrievalClient\n   */\n  private readonly client: GeneratedClient;\n\n  /**\n   * A reference to the internal HTTP pipeline for use with raw requests\n   */\n  public readonly pipeline: Pipeline;\n\n  /**\n   * Creates an instance of KnowledgeRetrievalClient.\n   *\n   * Example usage:\n   * ```ts snippet:ReadmeSampleKnowledgeRetrievalClient\n   * import { KnowledgeRetrievalClient, AzureKeyCredential } from \"@azure/search-documents\";\n   *\n   * const knowledgeRetrievalClient = new KnowledgeRetrievalClient(\n   *   \"<endpoint>\",\n   *   \"<agentName>\",\n   *   new AzureKeyCredential(\"<apiKey>\"),\n   * );\n   * ```\n   \n   * @param endpoint - The endpoint of the search service\n   * @param agentName - The name of the knowledge agent\n   * @param credential - Used to authenticate requests to the service.\n   * @param options - Used to configure the Search client.\n   */\n  constructor(\n    endpoint: string,\n    agentName: string,\n    credential: KeyCredential | TokenCredential,\n    options: KnowledgeRetrievalClientOptions = {},\n  ) {\n    this.endpoint = endpoint;\n    this.agentName = agentName;\n\n    const internalClientPipelineOptions: InternalClientPipelineOptions = {\n      ...options,\n      ...{\n        loggingOptions: {\n          logger: logger.info,\n          additionalAllowedHeaderNames: [\n            \"elapsed-time\",\n            \"Location\",\n            \"OData-MaxVersion\",\n            \"OData-Version\",\n            \"Prefer\",\n            \"throttle-reason\",\n          ],\n        },\n      },\n    };\n\n    this.serviceVersion = options.serviceVersion ?? utils.defaultServiceVersion;\n\n    this.client = new GeneratedClient(\n      this.endpoint,\n      this.agentName,\n      this.serviceVersion,\n      internalClientPipelineOptions,\n    );\n\n    this.pipeline = this.client.pipeline;\n\n    if (isTokenCredential(credential)) {\n      const scope: string = options.audience\n        ? `${options.audience}/.default`\n        : `${KnownSearchAudience.AzurePublicCloud}/.default`;\n\n      this.client.pipeline.addPolicy(\n        bearerTokenAuthenticationPolicy({ credential, scopes: scope }),\n      );\n    } else {\n      this.client.pipeline.addPolicy(createSearchApiKeyCredentialPolicy(credential));\n    }\n\n    this.client.pipeline.addPolicy(createOdataMetadataPolicy(\"none\"));\n  }\n\n  public async retrieveKnowledge(\n    retrievalRequest: KnowledgeAgentRetrievalRequest,\n    options?: RetrieveKnowledgeOptions,\n  ): Promise<KnowledgeAgentRetrievalResponse> {\n    const { span, updatedOptions } = createSpan(\n      \"KnowledgeRetrievalClient-retrieveKnowledge\",\n      options,\n    );\n\n    try {\n      return await this.client.knowledgeRetrieval.retrieve(retrievalRequest, updatedOptions);\n    } catch (e: any) {\n      span.setStatus({\n        status: \"error\",\n        error: e.message,\n      });\n      throw e;\n    } finally {\n      span.end();\n    }\n  }\n}\n"]}
+{"version":3,"file":"knowledgeRetrievalClient.js","sourceRoot":"","sources":["../../src/knowledgeRetrievalClient.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;;AAKlC,gDAAqD;AAIrD,kEAA4E;AAK5E,+EAA4F;AAE5F,2CAAqC;AACrC,qEAAqE;AACrE,uFAAuF;AACvF,2DAA0D;AAC1D,iEAA2C;AAC3C,6CAA0C;AAmB1C;;GAEG;AACH,MAAa,wBAAwB;IACnC,2DAA2D;IAC3D,8DAA8D;IAE9D;;OAEG;IACa,cAAc,GAAW,KAAK,CAAC,qBAAqB,CAAC;IAErE;;OAEG;IACa,QAAQ,CAAS;IAEjC;;OAEG;IACa,iBAAiB,CAAS;IAE1C;;;OAGG;IACc,MAAM,CAAkB;IAEzC;;OAEG;IACa,QAAQ,CAAW;IAEnC;;;;;;;;;;;;;;;;;;OAkBG;IACH,YACE,QAAgB,EAChB,iBAAyB,EACzB,UAA2C,EAC3C,UAA2C,EAAE;QAE7C,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,iBAAiB,GAAG,iBAAiB,CAAC;QAE3C,MAAM,6BAA6B,GAAkC;YACnE,GAAG,OAAO;YACV,GAAG;gBACD,cAAc,EAAE;oBACd,MAAM,EAAE,kBAAM,CAAC,IAAI;oBACnB,4BAA4B,EAAE;wBAC5B,cAAc;wBACd,UAAU;wBACV,kBAAkB;wBAClB,eAAe;wBACf,QAAQ;wBACR,iBAAiB;qBAClB;iBACF;aACF;SACF,CAAC;QAEF,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC,cAAc,IAAI,KAAK,CAAC,qBAAqB,CAAC;QAE5E,IAAI,CAAC,MAAM,GAAG,IAAI,8BAAe,CAC/B,IAAI,CAAC,QAAQ,EACb,IAAI,CAAC,iBAAiB,EACtB,IAAI,CAAC,cAAc,EACnB,6BAA6B,CAC9B,CAAC;QAEF,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC;QAErC,IAAI,IAAA,6BAAiB,EAAC,UAAU,CAAC,EAAE,CAAC;YAClC,MAAM,KAAK,GAAW,OAAO,CAAC,QAAQ;gBACpC,CAAC,CAAC,GAAG,OAAO,CAAC,QAAQ,WAAW;gBAChC,CAAC,CAAC,GAAG,uCAAmB,CAAC,gBAAgB,WAAW,CAAC;YAEvD,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,SAAS,CAC5B,IAAA,oDAA+B,EAAC,EAAE,UAAU,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAC/D,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAA,oEAAkC,EAAC,UAAU,CAAC,CAAC,CAAC;QACjF,CAAC;QAED,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAA,kDAAyB,EAAC,MAAM,CAAC,CAAC,CAAC;IACpE,CAAC;IAEM,KAAK,CAAC,iBAAiB,CAC5B,gBAA+C,EAC/C,OAAkC;QAElC,MAAM,EAAE,IAAI,EAAE,cAAc,EAAE,GAAG,IAAA,uBAAU,EACzC,4CAA4C,EAC5C,OAAO,CACR,CAAC;QAEF,IAAI,CAAC;YACH,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC,QAAQ,CAAC,gBAAgB,EAAE,cAAc,CAAC,CAAC;QACzF,CAAC;QAAC,OAAO,CAAM,EAAE,CAAC;YAChB,IAAI,CAAC,SAAS,CAAC;gBACb,MAAM,EAAE,OAAO;gBACf,KAAK,EAAE,CAAC,CAAC,OAAO;aACjB,CAAC,CAAC;YACH,MAAM,CAAC,CAAC;QACV,CAAC;gBAAS,CAAC;YACT,IAAI,CAAC,GAAG,EAAE,CAAC;QACb,CAAC;IACH,CAAC;CACF;AA1HD,4DA0HC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\n/// <reference lib=\"esnext.asynciterable\" />\n\nimport type { KeyCredential, TokenCredential } from \"@azure/core-auth\";\nimport { isTokenCredential } from \"@azure/core-auth\";\nimport type { InternalClientPipelineOptions } from \"@azure/core-client\";\nimport type { ExtendedCommonClientOptions } from \"@azure/core-http-compat\";\nimport type { Pipeline } from \"@azure/core-rest-pipeline\";\nimport { bearerTokenAuthenticationPolicy } from \"@azure/core-rest-pipeline\";\nimport type {\n  KnowledgeBaseRetrievalRequest,\n  KnowledgeBaseRetrievalResponse,\n} from \"./generated/knowledgeBase/index.js\";\nimport { SearchClient as GeneratedClient } from \"./generated/knowledgeBase/searchClient.js\";\nimport type { RetrieveKnowledgeOptions } from \"./knowledgeBaseModels.js\";\nimport { logger } from \"./logger.js\";\nimport { createOdataMetadataPolicy } from \"./odataMetadataPolicy.js\";\nimport { createSearchApiKeyCredentialPolicy } from \"./searchApiKeyCredentialPolicy.js\";\nimport { KnownSearchAudience } from \"./searchAudience.js\";\nimport * as utils from \"./serviceUtils.js\";\nimport { createSpan } from \"./tracing.js\";\n\n/**\n * Client options used to configure Cognitive Search API requests.\n */\nexport interface KnowledgeRetrievalClientOptions extends ExtendedCommonClientOptions {\n  /**\n   * The service version to use when communicating with the service.\n   */\n  serviceVersion?: string;\n\n  /**\n   * The Audience to use for authentication with Azure Active Directory (AAD). The\n   * audience is not considered when using a shared key.\n   * {@link KnownSearchAudience} can be used interchangeably with audience\n   */\n  audience?: string;\n}\n\n/**\n * Class used to perform operations against a knowledge base.\n */\nexport class KnowledgeRetrievalClient {\n  /// Maintenance note: when updating supported API versions,\n  /// the ContinuationToken logic will need to be updated below.\n\n  /**\n   *  The service version to use when communicating with the service.\n   */\n  public readonly serviceVersion: string = utils.defaultServiceVersion;\n\n  /**\n   * The endpoint of the search service\n   */\n  public readonly endpoint: string;\n\n  /**\n   * The name of the knowledge base\n   */\n  public readonly knowledgeBaseName: string;\n\n  /**\n   * @hidden\n   * A reference to the auto-generated KnowledgeRetrievalClient\n   */\n  private readonly client: GeneratedClient;\n\n  /**\n   * A reference to the internal HTTP pipeline for use with raw requests\n   */\n  public readonly pipeline: Pipeline;\n\n  /**\n   * Creates an instance of KnowledgeRetrievalClient.\n   *\n   * Example usage:\n   * ```ts snippet:ReadmeSampleKnowledgeRetrievalClient\n   * import { KnowledgeRetrievalClient, AzureKeyCredential } from \"@azure/search-documents\";\n   *\n   * const knowledgeRetrievalClient = new KnowledgeRetrievalClient(\n   *   \"<endpoint>\",\n   *   \"<knowledgeBaseName>\",\n   *   new AzureKeyCredential(\"<apiKey>\"),\n   * );\n   * ```\n   \n   * @param endpoint - The endpoint of the search service\n   * @param knowledgeBaseName - The name of the knowledge base\n   * @param credential - Used to authenticate requests to the service.\n   * @param options - Used to configure the Search client.\n   */\n  constructor(\n    endpoint: string,\n    knowledgeBaseName: string,\n    credential: KeyCredential | TokenCredential,\n    options: KnowledgeRetrievalClientOptions = {},\n  ) {\n    this.endpoint = endpoint;\n    this.knowledgeBaseName = knowledgeBaseName;\n\n    const internalClientPipelineOptions: InternalClientPipelineOptions = {\n      ...options,\n      ...{\n        loggingOptions: {\n          logger: logger.info,\n          additionalAllowedHeaderNames: [\n            \"elapsed-time\",\n            \"Location\",\n            \"OData-MaxVersion\",\n            \"OData-Version\",\n            \"Prefer\",\n            \"throttle-reason\",\n          ],\n        },\n      },\n    };\n\n    this.serviceVersion = options.serviceVersion ?? utils.defaultServiceVersion;\n\n    this.client = new GeneratedClient(\n      this.endpoint,\n      this.knowledgeBaseName,\n      this.serviceVersion,\n      internalClientPipelineOptions,\n    );\n\n    this.pipeline = this.client.pipeline;\n\n    if (isTokenCredential(credential)) {\n      const scope: string = options.audience\n        ? `${options.audience}/.default`\n        : `${KnownSearchAudience.AzurePublicCloud}/.default`;\n\n      this.client.pipeline.addPolicy(\n        bearerTokenAuthenticationPolicy({ credential, scopes: scope }),\n      );\n    } else {\n      this.client.pipeline.addPolicy(createSearchApiKeyCredentialPolicy(credential));\n    }\n\n    this.client.pipeline.addPolicy(createOdataMetadataPolicy(\"none\"));\n  }\n\n  public async retrieveKnowledge(\n    retrievalRequest: KnowledgeBaseRetrievalRequest,\n    options?: RetrieveKnowledgeOptions,\n  ): Promise<KnowledgeBaseRetrievalResponse> {\n    const { span, updatedOptions } = createSpan(\n      \"KnowledgeRetrievalClient-retrieveKnowledge\",\n      options,\n    );\n\n    try {\n      return await this.client.knowledgeRetrieval.retrieve(retrievalRequest, updatedOptions);\n    } catch (e: any) {\n      span.setStatus({\n        status: \"error\",\n        error: e.message,\n      });\n      throw e;\n    } finally {\n      span.end();\n    }\n  }\n}\n"]}

package/dist/commonjs/searchIndexClient.d.ts

@@ -1,13 +1,13 @@
 import type { KeyCredential, TokenCredential } from "@azure/core-auth";
 import type { ExtendedCommonClientOptions } from "@azure/core-http-compat";
 import type { Pipeline } from "@azure/core-rest-pipeline";
-import type { AnalyzeResult } from "./generated/service/models/index.js";
-import type { KnowledgeAgent } from "./knowledgeAgentModels.js";
+import type { AnalyzeResult, KnowledgeSourceStatus } from "./generated/service/models/index.js";
+import type { KnowledgeBase } from "./knowledgeBaseModels.js";
 import type { KnowledgeRetrievalClientOptions as GetKnowledgeRetrievalClientOptions } from "./knowledgeRetrievalClient.js";
 import { KnowledgeRetrievalClient } from "./knowledgeRetrievalClient.js";
 import type { SearchClientOptions as GetSearchClientOptions } from "./searchClient.js";
 import { SearchClient } from "./searchClient.js";
-import type { AliasIterator, AnalyzeTextOptions, CreateAliasOptions, CreateIndexOptions, CreateKnowledgeAgentOptions, CreateKnowledgeSourceOptions, CreateOrUpdateAliasOptions, CreateOrUpdateIndexOptions, CreateOrUpdateKnowledgeAgentOptions, CreateOrUpdateKnowledgeSourceOptions, CreateOrUpdateSynonymMapOptions, CreateSynonymMapOptions, DeleteAliasOptions, DeleteIndexOptions, DeleteKnowledgeAgentOptions, DeleteKnowledgeSourceOptions, DeleteSynonymMapOptions, GetAliasOptions, GetIndexOptions, GetIndexStatisticsOptions, GetIndexStatsSummaryOptions, GetKnowledgeAgentOptions, GetKnowledgeSourceOptions, GetServiceStatisticsOptions, GetSynonymMapsOptions, IndexIterator, IndexNameIterator, IndexStatisticsSummaryIterator, KnowledgeAgentIterator, KnowledgeSource, KnowledgeSourceIterator, ListAliasesOptions, ListIndexesOptions, ListKnowledgeAgentsOptions, ListKnowledgeSourcesOptions, ListSynonymMapsOptions, SearchIndex, SearchIndexAlias, SearchIndexStatistics, SearchServiceStatistics, SynonymMap } from "./serviceModels.js";
+import type { AliasIterator, AnalyzeTextOptions, CreateAliasOptions, CreateIndexOptions, CreateKnowledgeBaseOptions, CreateKnowledgeSourceOptions, CreateOrUpdateAliasOptions, CreateOrUpdateIndexOptions, CreateOrUpdateKnowledgeBaseOptions, CreateOrUpdateKnowledgeSourceOptions, CreateOrUpdateSynonymMapOptions, CreateSynonymMapOptions, DeleteAliasOptions, DeleteIndexOptions, DeleteKnowledgeBaseOptions, DeleteKnowledgeSourceOptions, DeleteSynonymMapOptions, GetAliasOptions, GetIndexOptions, GetIndexStatisticsOptions, GetIndexStatsSummaryOptions, GetKnowledgeBaseOptions, GetKnowledgeSourceOptions, GetKnowledgeSourceStatusOptions, GetServiceStatisticsOptions, GetSynonymMapsOptions, IndexIterator, IndexNameIterator, IndexStatisticsSummaryIterator, KnowledgeBaseIterator, KnowledgeSource, KnowledgeSourceIterator, ListAliasesOptions, ListIndexesOptions, ListKnowledgeBasesOptions, ListKnowledgeSourcesOptions, ListSynonymMapsOptions, SearchIndex, SearchIndexAlias, SearchIndexStatistics, SearchServiceStatistics, SynonymMap } from "./serviceModels.js";
 /**
  * Client options used to configure AI Search API requests.
  */
@@ -222,43 +222,43 @@ export declare class SearchIndexClient {
      */
     getIndexStatsSummary(options?: GetIndexStatsSummaryOptions): IndexStatisticsSummaryIterator;
     /**
-     * Creates a new agent.
-     * @param knowledgeAgent - definition of the agent to create.
+     * Creates a new knowledgebase.
+     * @param knowledgeBase - definition of the knowledgebase to create.
      * @param options - options parameters.
      */
-    createKnowledgeAgent(knowledgeAgent: KnowledgeAgent, options?: CreateKnowledgeAgentOptions): Promise<KnowledgeAgent>;
+    createKnowledgeBase(knowledgeBase: KnowledgeBase, options?: CreateKnowledgeBaseOptions): Promise<KnowledgeBase>;
     /**
-     * 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.
+     * 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.
      */
-    createOrUpdateKnowledgeAgent(agentName: string, knowledgeAgent: KnowledgeAgent, options?: CreateOrUpdateKnowledgeAgentOptions): Promise<KnowledgeAgent>;
+    createOrUpdateKnowledgeBase(knowledgeBaseName: string, knowledgeBase: KnowledgeBase, options?: CreateOrUpdateKnowledgeBaseOptions): Promise<KnowledgeBase>;
     /**
-     * Retrieves an agent definition.
-     * @param agentName - name of the agent to retrieve.
+     * Retrieves a knowledge base definition.
+     * @param knowledgeBaseName - name of the knowledge base to retrieve.
      * @param options - options parameters.
      */
-    getKnowledgeAgent(agentName: string, options?: GetKnowledgeAgentOptions): Promise<KnowledgeAgent>;
-    private listKnowledgeAgentsPage;
-    private listKnowledgeAgentsAll;
+    getKnowledgeBase(knowledgeBaseName: string, options?: GetKnowledgeBaseOptions): Promise<KnowledgeBase>;
+    private listKnowledgeBasesPage;
+    private listKnowledgeBasesAll;
     /**
-     * Retrieves a list of existing KnowledgeAgents in the service.
-     * @param options - Options to the list knowledge agents operation.
+     * Retrieves a list of existing KnowledgeBases in the service.
+     * @param options - Options to the list knowledge bases operation.
      */
-    listKnowledgeAgents(options?: ListKnowledgeAgentsOptions): KnowledgeAgentIterator;
+    listKnowledgeBases(options?: ListKnowledgeBasesOptions): KnowledgeBaseIterator;
     /**
-     * Deletes an existing agent.
-     * @param agentName - name of the agent to delete.
+     * Deletes an existing knowledge base.
+     * @param knowledgeBaseName - name of the knowledge base to delete.
      * @param options - options parameters.
      */
-    deleteKnowledgeAgent(agentName: string, options?: DeleteKnowledgeAgentOptions): Promise<void>;
+    deleteKnowledgeBase(knowledgeBaseName: string, options?: DeleteKnowledgeBaseOptions): Promise<void>;
     /**
-     * Deletes an existing agent.
-     * @param agent - the agent to delete.
+     * Deletes an existing knowledge base.
+     * @param knowledgeBase - the knowledge base to delete.
      * @param options - options parameters.
      */
-    deleteKnowledgeAgent(agent: KnowledgeAgent, options?: DeleteKnowledgeAgentOptions): Promise<void>;
+    deleteKnowledgeBase(knowledgeBase: KnowledgeBase, options?: DeleteKnowledgeBaseOptions): Promise<void>;
     createOrUpdateKnowledgeSource(sourceName: string, knowledgeSource: KnowledgeSource, options?: CreateOrUpdateKnowledgeSourceOptions): Promise<KnowledgeSource>;
     /**
      * Deletes an existing source.
@@ -291,6 +291,12 @@ export declare class SearchIndexClient {
      * @param options - The options parameters.
      */
     createKnowledgeSource(knowledgeSource: KnowledgeSource, options?: CreateKnowledgeSourceOptions): Promise<KnowledgeSource>;
+    /**
+     * 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.
+     */
+    getKnowledgeSourceStatus(sourceName: string, options?: GetKnowledgeSourceStatusOptions): Promise<KnowledgeSourceStatus>;
     /**
      * Retrieves the SearchClient corresponding to this SearchIndexClient
      * @param indexName - Name of the index
@@ -302,9 +308,9 @@ export declare class SearchIndexClient {
     getSearchClient<TModel extends object>(indexName: string, options?: GetSearchClientOptions): SearchClient<TModel>;
     /**
      * Retrieves the KnowledgeRetrievalClient corresponding to this SearchIndexClient
-     * @param agentName - Name of the agent
+     * @param knowledgeBaseName - Name of the knowledge base
      * @param options - KnowledgeRetrievalClient Options
      */
-    getKnowledgeRetrievalClient(agentName: string, options?: GetKnowledgeRetrievalClientOptions): KnowledgeRetrievalClient;
+    getKnowledgeRetrievalClient(knowledgeBaseName: string, options?: GetKnowledgeRetrievalClientOptions): KnowledgeRetrievalClient;
 }
 //# sourceMappingURL=searchIndexClient.d.ts.map

package/dist/commonjs/searchIndexClient.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"searchIndexClient.d.ts","sourceRoot":"","sources":["../../src/searchIndexClient.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAGvE,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,yBAAyB,CAAC;AAC3E,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,2BAA2B,CAAC;AAE1D,OAAO,KAAK,EAAE,aAAa,EAA0B,MAAM,qCAAqC,CAAC;AAEjG,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAChE,OAAO,KAAK,EAAE,+BAA+B,IAAI,kCAAkC,EAAE,MAAM,+BAA+B,CAAC;AAC3H,OAAO,EAAE,wBAAwB,EAAE,MAAM,+BAA+B,CAAC;AAKzE,OAAO,KAAK,EAAE,mBAAmB,IAAI,sBAAsB,EAAE,MAAM,mBAAmB,CAAC;AACvF,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,KAAK,EACV,aAAa,EACb,kBAAkB,EAClB,kBAAkB,EAClB,kBAAkB,EAClB,2BAA2B,EAC3B,4BAA4B,EAC5B,0BAA0B,EAC1B,0BAA0B,EAC1B,mCAAmC,EACnC,oCAAoC,EACpC,+BAA+B,EAC/B,uBAAuB,EACvB,kBAAkB,EAClB,kBAAkB,EAClB,2BAA2B,EAC3B,4BAA4B,EAC5B,uBAAuB,EACvB,eAAe,EACf,eAAe,EACf,yBAAyB,EACzB,2BAA2B,EAC3B,wBAAwB,EACxB,yBAAyB,EACzB,2BAA2B,EAC3B,qBAAqB,EACrB,aAAa,EACb,iBAAiB,EACjB,8BAA8B,EAC9B,sBAAsB,EACtB,eAAe,EACf,uBAAuB,EACvB,kBAAkB,EAClB,kBAAkB,EAClB,0BAA0B,EAC1B,2BAA2B,EAC3B,sBAAsB,EACtB,WAAW,EACX,gBAAgB,EAChB,qBAAqB,EACrB,uBAAuB,EACvB,UAAU,EACX,MAAM,oBAAoB,CAAC;AAI5B;;GAEG;AACH,MAAM,WAAW,wBAAyB,SAAQ,2BAA2B;IAC3E;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;;;GAIG;AACH,qBAAa,iBAAiB;IAC5B;;OAEG;IACH,SAAgB,cAAc,EAAE,MAAM,CAA+B;IAErE;;;OAGG;IACH,SAAgB,UAAU,EAAE,MAAM,CAA+B;IAEjE;;OAEG;IACH,SAAgB,QAAQ,EAAE,MAAM,CAAC;IAEjC;;;OAGG;IACH,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAkB;IAEzC;;OAEG;IACH,SAAgB,QAAQ,EAAE,QAAQ,CAAC;IAEnC;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAkC;IAE7D;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,OAAO,CAA2B;IAEnD;;;;;;;;;;;;OAYG;gBAED,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,aAAa,GAAG,eAAe,EAC3C,OAAO,GAAE,wBAA6B;YAiDzB,eAAe;YAmBf,cAAc;IAQ7B;;;OAGG;IACI,WAAW,CAAC,OAAO,GAAE,kBAAuB,GAAG,aAAa;YAgBpD,eAAe;YAkBf,cAAc;IAQ7B;;;OAGG;IACI,WAAW,CAAC,OAAO,GAAE,kBAAuB,GAAG,aAAa;YAgBpD,oBAAoB;YAsBpB,mBAAmB;IAQlC;;;OAGG;IAEI,gBAAgB,CAAC,OAAO,GAAE,kBAAuB,GAAG,iBAAiB;IAgB5E;;;OAGG;IACU,eAAe,CAAC,OAAO,GAAE,sBAA2B,GAAG,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IAgB9F;;;OAGG;IAEU,oBAAoB,CAAC,OAAO,GAAE,sBAA2B,GAAG,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IAmB/F;;;;OAIG;IACU,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,GAAE,eAAoB,GAAG,OAAO,CAAC,WAAW,CAAC;IAgB7F;;;;OAIG;IACU,aAAa,CACxB,cAAc,EAAE,MAAM,EAEtB,OAAO,GAAE,qBAA0B,GAClC,OAAO,CAAC,UAAU,CAAC;IAgBtB;;;;OAIG;IACU,WAAW,CACtB,KAAK,EAAE,WAAW,EAClB,OAAO,GAAE,kBAAuB,GAC/B,OAAO,CAAC,WAAW,CAAC;IAmBvB;;;;OAIG;IACU,gBAAgB,CAC3B,UAAU,EAAE,UAAU,EACtB,OAAO,GAAE,uBAA4B,GACpC,OAAO,CAAC,UAAU,CAAC;IAmBtB;;;;OAIG;IACU,mBAAmB,CAC9B,KAAK,EAAE,WAAW,EAClB,OAAO,GAAE,0BAA+B,GACvC,OAAO,CAAC,WAAW,CAAC;IAyBvB;;;;OAIG;IACU,wBAAwB,CACnC,UAAU,EAAE,UAAU,EACtB,OAAO,GAAE,+BAAoC,GAC5C,OAAO,CAAC,UAAU,CAAC;IA4BtB;;;;OAIG;IACU,WAAW,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC;IAExF;;;;OAIG;IACU,WAAW,CAAC,KAAK,EAAE,WAAW,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC;IA0BzF;;;;OAIG;IACU,gBAAgB,CAC3B,UAAU,EAAE,MAAM,GAAG,UAAU,EAC/B,OAAO,GAAE,uBAA4B,GACpC,OAAO,CAAC,IAAI,CAAC;IA0BhB;;;;OAIG;IACU,mBAAmB,CAC9B,KAAK,EAAE,gBAAgB,EACvB,OAAO,GAAE,0BAA+B,GACvC,OAAO,CAAC,gBAAgB,CAAC;IAqB5B;;;;OAIG;IACU,WAAW,CACtB,KAAK,EAAE,gBAAgB,EACvB,OAAO,GAAE,kBAAuB,GAC/B,OAAO,CAAC,gBAAgB,CAAC;IAgB5B;;;;;OAKG;IACU,WAAW,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC;IAExF;;;;;OAKG;IACU,WAAW,CAAC,KAAK,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC;IA0B9F;;;;OAIG;IACU,QAAQ,CACnB,SAAS,EAAE,MAAM,EACjB,OAAO,GAAE,eAAoB,GAC5B,OAAO,CAAC,gBAAgB,CAAC;IAgB5B;;;;;OAKG;IACU,kBAAkB,CAC7B,SAAS,EAAE,MAAM,EACjB,OAAO,GAAE,yBAA8B,GACtC,OAAO,CAAC,qBAAqB,CAAC;IAgBjC;;;;;OAKG;IACU,WAAW,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,aAAa,CAAC;IAoChG;;;OAGG;IACU,oBAAoB,CAC/B,OAAO,GAAE,2BAAgC,GACxC,OAAO,CAAC,uBAAuB,CAAC;YAgBpB,wBAAwB;YAqBxB,uBAAuB;IAQtC;;;OAGG;IACI,oBAAoB,CACzB,OAAO,GAAE,2BAAgC,GACxC,8BAA8B;IAgBjC;;;;OAIG;IACU,oBAAoB,CAC/B,cAAc,EAAE,cAAc,EAC9B,OAAO,CAAC,EAAE,2BAA2B,GACpC,OAAO,CAAC,cAAc,CAAC;IAmB1B;;;;;OAKG;IACU,4BAA4B,CACvC,SAAS,EAAE,MAAM,EACjB,cAAc,EAAE,cAAc,EAC9B,OAAO,CAAC,EAAE,mCAAmC,GAC5C,OAAO,CAAC,cAAc,CAAC;IA4B1B;;;;OAIG;IACU,iBAAiB,CAC5B,SAAS,EAAE,MAAM,EACjB,OAAO,CAAC,EAAE,wBAAwB,GACjC,OAAO,CAAC,cAAc,CAAC;YAgBX,uBAAuB;YAsBvB,sBAAsB;IAQrC;;;OAGG;IACI,mBAAmB,CAAC,OAAO,GAAE,0BAA+B,GAAG,sBAAsB;IAgB5F;;;;OAIG;IACU,oBAAoB,CAC/B,SAAS,EAAE,MAAM,EACjB,OAAO,CAAC,EAAE,2BAA2B,GACpC,OAAO,CAAC,IAAI,CAAC;IAChB;;;;OAIG;IACU,oBAAoB,CAC/B,KAAK,EAAE,cAAc,EACrB,OAAO,CAAC,EAAE,2BAA2B,GACpC,OAAO,CAAC,IAAI,CAAC;IA2BH,6BAA6B,CACxC,UAAU,EAAE,MAAM,EAClB,eAAe,EAAE,eAAe,EAChC,OAAO,CAAC,EAAE,oCAAoC,GAC7C,OAAO,CAAC,eAAe,CAAC;IA4B3B;;;;OAIG;IACU,qBAAqB,CAChC,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE,4BAA4B,GACrC,OAAO,CAAC,IAAI,CAAC;IAChB;;;;OAIG;IACU,qBAAqB,CAChC,MAAM,EAAE,eAAe,EACvB,OAAO,CAAC,EAAE,4BAA4B,GACrC,OAAO,CAAC,IAAI,CAAC;IA2BhB;;;;OAIG;IACU,kBAAkB,CAC7B,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE,yBAAyB,GAClC,OAAO,CAAC,eAAe,CAAC;YAgBZ,wBAAwB;YAwBxB,uBAAuB;IAQtC;;;OAGG;IACI,oBAAoB,CAAC,OAAO,GAAE,2BAAgC,GAAG,uBAAuB;IAgB/F;;;;OAIG;IACU,qBAAqB,CAChC,eAAe,EAAE,eAAe,EAChC,OAAO,CAAC,EAAE,4BAA4B,GACrC,OAAO,CAAC,eAAe,CAAC;IAmB3B;;;;;;;OAOG;IACI,eAAe,CAAC,MAAM,SAAS,MAAM,EAC1C,SAAS,EAAE,MAAM,EACjB,OAAO,CAAC,EAAE,sBAAsB,GAC/B,YAAY,CAAC,MAAM,CAAC;IASvB;;;;OAIG;IACI,2BAA2B,CAChC,SAAS,EAAE,MAAM,EACjB,OAAO,CAAC,EAAE,kCAAkC,GAC3C,wBAAwB;CAQ5B"}
+{"version":3,"file":"searchIndexClient.d.ts","sourceRoot":"","sources":["../../src/searchIndexClient.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAGvE,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,yBAAyB,CAAC;AAC3E,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,2BAA2B,CAAC;AAE1D,OAAO,KAAK,EACV,aAAa,EAEb,qBAAqB,EACtB,MAAM,qCAAqC,CAAC;AAE7C,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AAC9D,OAAO,KAAK,EAAE,+BAA+B,IAAI,kCAAkC,EAAE,MAAM,+BAA+B,CAAC;AAC3H,OAAO,EAAE,wBAAwB,EAAE,MAAM,+BAA+B,CAAC;AAKzE,OAAO,KAAK,EAAE,mBAAmB,IAAI,sBAAsB,EAAE,MAAM,mBAAmB,CAAC;AACvF,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,KAAK,EACV,aAAa,EACb,kBAAkB,EAClB,kBAAkB,EAClB,kBAAkB,EAClB,0BAA0B,EAC1B,4BAA4B,EAC5B,0BAA0B,EAC1B,0BAA0B,EAC1B,kCAAkC,EAClC,oCAAoC,EACpC,+BAA+B,EAC/B,uBAAuB,EACvB,kBAAkB,EAClB,kBAAkB,EAClB,0BAA0B,EAC1B,4BAA4B,EAC5B,uBAAuB,EACvB,eAAe,EACf,eAAe,EACf,yBAAyB,EACzB,2BAA2B,EAC3B,uBAAuB,EACvB,yBAAyB,EACzB,+BAA+B,EAC/B,2BAA2B,EAC3B,qBAAqB,EACrB,aAAa,EACb,iBAAiB,EACjB,8BAA8B,EAC9B,qBAAqB,EACrB,eAAe,EACf,uBAAuB,EACvB,kBAAkB,EAClB,kBAAkB,EAClB,yBAAyB,EACzB,2BAA2B,EAC3B,sBAAsB,EACtB,WAAW,EACX,gBAAgB,EAChB,qBAAqB,EACrB,uBAAuB,EACvB,UAAU,EACX,MAAM,oBAAoB,CAAC;AAI5B;;GAEG;AACH,MAAM,WAAW,wBAAyB,SAAQ,2BAA2B;IAC3E;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;;;GAIG;AACH,qBAAa,iBAAiB;IAC5B;;OAEG;IACH,SAAgB,cAAc,EAAE,MAAM,CAA+B;IAErE;;;OAGG;IACH,SAAgB,UAAU,EAAE,MAAM,CAA+B;IAEjE;;OAEG;IACH,SAAgB,QAAQ,EAAE,MAAM,CAAC;IAEjC;;;OAGG;IACH,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAkB;IAEzC;;OAEG;IACH,SAAgB,QAAQ,EAAE,QAAQ,CAAC;IAEnC;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAkC;IAE7D;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,OAAO,CAA2B;IAEnD;;;;;;;;;;;;OAYG;gBAED,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,aAAa,GAAG,eAAe,EAC3C,OAAO,GAAE,wBAA6B;YAiDzB,eAAe;YAmBf,cAAc;IAQ7B;;;OAGG;IACI,WAAW,CAAC,OAAO,GAAE,kBAAuB,GAAG,aAAa;YAgBpD,eAAe;YAkBf,cAAc;IAQ7B;;;OAGG;IACI,WAAW,CAAC,OAAO,GAAE,kBAAuB,GAAG,aAAa;YAgBpD,oBAAoB;YAsBpB,mBAAmB;IAQlC;;;OAGG;IAEI,gBAAgB,CAAC,OAAO,GAAE,kBAAuB,GAAG,iBAAiB;IAgB5E;;;OAGG;IACU,eAAe,CAAC,OAAO,GAAE,sBAA2B,GAAG,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IAgB9F;;;OAGG;IAEU,oBAAoB,CAAC,OAAO,GAAE,sBAA2B,GAAG,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IAmB/F;;;;OAIG;IACU,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,GAAE,eAAoB,GAAG,OAAO,CAAC,WAAW,CAAC;IAgB7F;;;;OAIG;IACU,aAAa,CACxB,cAAc,EAAE,MAAM,EAEtB,OAAO,GAAE,qBAA0B,GAClC,OAAO,CAAC,UAAU,CAAC;IAgBtB;;;;OAIG;IACU,WAAW,CACtB,KAAK,EAAE,WAAW,EAClB,OAAO,GAAE,kBAAuB,GAC/B,OAAO,CAAC,WAAW,CAAC;IAmBvB;;;;OAIG;IACU,gBAAgB,CAC3B,UAAU,EAAE,UAAU,EACtB,OAAO,GAAE,uBAA4B,GACpC,OAAO,CAAC,UAAU,CAAC;IAmBtB;;;;OAIG;IACU,mBAAmB,CAC9B,KAAK,EAAE,WAAW,EAClB,OAAO,GAAE,0BAA+B,GACvC,OAAO,CAAC,WAAW,CAAC;IAyBvB;;;;OAIG;IACU,wBAAwB,CACnC,UAAU,EAAE,UAAU,EACtB,OAAO,GAAE,+BAAoC,GAC5C,OAAO,CAAC,UAAU,CAAC;IA4BtB;;;;OAIG;IACU,WAAW,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC;IAExF;;;;OAIG;IACU,WAAW,CAAC,KAAK,EAAE,WAAW,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC;IA0BzF;;;;OAIG;IACU,gBAAgB,CAC3B,UAAU,EAAE,MAAM,GAAG,UAAU,EAC/B,OAAO,GAAE,uBAA4B,GACpC,OAAO,CAAC,IAAI,CAAC;IA0BhB;;;;OAIG;IACU,mBAAmB,CAC9B,KAAK,EAAE,gBAAgB,EACvB,OAAO,GAAE,0BAA+B,GACvC,OAAO,CAAC,gBAAgB,CAAC;IAqB5B;;;;OAIG;IACU,WAAW,CACtB,KAAK,EAAE,gBAAgB,EACvB,OAAO,GAAE,kBAAuB,GAC/B,OAAO,CAAC,gBAAgB,CAAC;IAgB5B;;;;;OAKG;IACU,WAAW,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC;IAExF;;;;;OAKG;IACU,WAAW,CAAC,KAAK,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC;IA0B9F;;;;OAIG;IACU,QAAQ,CACnB,SAAS,EAAE,MAAM,EACjB,OAAO,GAAE,eAAoB,GAC5B,OAAO,CAAC,gBAAgB,CAAC;IAgB5B;;;;;OAKG;IACU,kBAAkB,CAC7B,SAAS,EAAE,MAAM,EACjB,OAAO,GAAE,yBAA8B,GACtC,OAAO,CAAC,qBAAqB,CAAC;IAgBjC;;;;;OAKG;IACU,WAAW,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,aAAa,CAAC;IAoChG;;;OAGG;IACU,oBAAoB,CAC/B,OAAO,GAAE,2BAAgC,GACxC,OAAO,CAAC,uBAAuB,CAAC;YAgBpB,wBAAwB;YAqBxB,uBAAuB;IAQtC;;;OAGG;IACI,oBAAoB,CACzB,OAAO,GAAE,2BAAgC,GACxC,8BAA8B;IAgBjC;;;;OAIG;IACU,mBAAmB,CAC9B,aAAa,EAAE,aAAa,EAC5B,OAAO,CAAC,EAAE,0BAA0B,GACnC,OAAO,CAAC,aAAa,CAAC;IAmBzB;;;;;OAKG;IACU,2BAA2B,CACtC,iBAAiB,EAAE,MAAM,EACzB,aAAa,EAAE,aAAa,EAC5B,OAAO,CAAC,EAAE,kCAAkC,GAC3C,OAAO,CAAC,aAAa,CAAC;IA4BzB;;;;OAIG;IACU,gBAAgB,CAC3B,iBAAiB,EAAE,MAAM,EACzB,OAAO,CAAC,EAAE,uBAAuB,GAChC,OAAO,CAAC,aAAa,CAAC;YAgBV,sBAAsB;YAsBtB,qBAAqB;IAQpC;;;OAGG;IACI,kBAAkB,CAAC,OAAO,GAAE,yBAA8B,GAAG,qBAAqB;IAgBzF;;;;OAIG;IACU,mBAAmB,CAC9B,iBAAiB,EAAE,MAAM,EACzB,OAAO,CAAC,EAAE,0BAA0B,GACnC,OAAO,CAAC,IAAI,CAAC;IAChB;;;;OAIG;IACU,mBAAmB,CAC9B,aAAa,EAAE,aAAa,EAC5B,OAAO,CAAC,EAAE,0BAA0B,GACnC,OAAO,CAAC,IAAI,CAAC;IA8BH,6BAA6B,CACxC,UAAU,EAAE,MAAM,EAClB,eAAe,EAAE,eAAe,EAChC,OAAO,CAAC,EAAE,oCAAoC,GAC7C,OAAO,CAAC,eAAe,CAAC;IA4B3B;;;;OAIG;IACU,qBAAqB,CAChC,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE,4BAA4B,GACrC,OAAO,CAAC,IAAI,CAAC;IAChB;;;;OAIG;IACU,qBAAqB,CAChC,MAAM,EAAE,eAAe,EACvB,OAAO,CAAC,EAAE,4BAA4B,GACrC,OAAO,CAAC,IAAI,CAAC;IA2BhB;;;;OAIG;IACU,kBAAkB,CAC7B,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE,yBAAyB,GAClC,OAAO,CAAC,eAAe,CAAC;YAgBZ,wBAAwB;YAwBxB,uBAAuB;IAQtC;;;OAGG;IACI,oBAAoB,CAAC,OAAO,GAAE,2BAAgC,GAAG,uBAAuB;IAgB/F;;;;OAIG;IACU,qBAAqB,CAChC,eAAe,EAAE,eAAe,EAChC,OAAO,CAAC,EAAE,4BAA4B,GACrC,OAAO,CAAC,eAAe,CAAC;IAmB3B;;;;OAIG;IACU,wBAAwB,CACnC,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE,+BAA+B,GACxC,OAAO,CAAC,qBAAqB,CAAC;IAmBjC;;;;;;;OAOG;IACI,eAAe,CAAC,MAAM,SAAS,MAAM,EAC1C,SAAS,EAAE,MAAM,EACjB,OAAO,CAAC,EAAE,sBAAsB,GAC/B,YAAY,CAAC,MAAM,CAAC;IASvB;;;;OAIG;IACI,2BAA2B,CAChC,iBAAiB,EAAE,MAAM,EACzB,OAAO,CAAC,EAAE,kCAAkC,GAC3C,wBAAwB;CAQ5B"}

package/dist/commonjs/searchIndexClient.js

@@ -670,15 +670,15 @@ class SearchIndexClient {
         };
     }
     /**
-     * Creates a new agent.
-     * @param knowledgeAgent - definition of the agent to create.
+     * Creates a new knowledgebase.
+     * @param knowledgeBase - definition of the knowledgebase to create.
      * @param options - options parameters.
      */
-    async createKnowledgeAgent(knowledgeAgent, options) {
-        const { span, updatedOptions } = (0, tracing_js_1.createSpan)("SearchIndexClient-createKnowledgeAgent", options);
+    async createKnowledgeBase(knowledgeBase, options) {
+        const { span, updatedOptions } = (0, tracing_js_1.createSpan)("SearchIndexClient-createKnowledgeBase", options);
         try {
-            const result = await this.client.knowledgeAgents.create(utils.convertKnowledgeAgentToGenerated(knowledgeAgent), updatedOptions);
-            return utils.convertKnowledgeAgentToPublic(result);
+            const result = await this.client.knowledgeBases.create(utils.convertKnowledgeBaseToGenerated(knowledgeBase), updatedOptions);
+            return utils.convertKnowledgeBaseToPublic(result);
         }
         catch (e) {
             span.setStatus({
@@ -692,20 +692,20 @@ class SearchIndexClient {
         }
     }
     /**
-     * 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.
+     * 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 createOrUpdateKnowledgeAgent(agentName, knowledgeAgent, options) {
-        const { span, updatedOptions } = (0, tracing_js_1.createSpan)("SearchIndexClient-createOrUpdateKnowledgeAgent", options);
+    async createOrUpdateKnowledgeBase(knowledgeBaseName, knowledgeBase, options) {
+        const { span, updatedOptions } = (0, tracing_js_1.createSpan)("SearchIndexClient-createOrUpdateKnowledgeBase", options);
         try {
-            const etag = updatedOptions.onlyIfUnchanged ? knowledgeAgent.etag : undefined;
-            const result = await this.client.knowledgeAgents.createOrUpdate(agentName, utils.convertKnowledgeAgentToGenerated(knowledgeAgent), {
+            const etag = updatedOptions.onlyIfUnchanged ? knowledgeBase.etag : undefined;
+            const result = await this.client.knowledgeBases.createOrUpdate(knowledgeBaseName, utils.convertKnowledgeBaseToGenerated(knowledgeBase), {
                 ...updatedOptions,
                 ifMatch: etag,
             });
-            return utils.convertKnowledgeAgentToPublic(result);
+            return utils.convertKnowledgeBaseToPublic(result);
         }
         catch (e) {
             span.setStatus({
@@ -719,15 +719,15 @@ class SearchIndexClient {
         }
     }
     /**
-     * Retrieves an agent definition.
-     * @param agentName - name of the agent to retrieve.
+     * Retrieves a knowledge base definition.
+     * @param knowledgeBaseName - name of the knowledge base to retrieve.
      * @param options - options parameters.
      */
-    async getKnowledgeAgent(agentName, options) {
-        const { span, updatedOptions } = (0, tracing_js_1.createSpan)("SearchIndexClient-getKnowledgeAgent", options);
+    async getKnowledgeBase(knowledgeBaseName, options) {
+        const { span, updatedOptions } = (0, tracing_js_1.createSpan)("SearchIndexClient-getKnowledgeBase", options);
         try {
-            const result = await this.client.knowledgeAgents.get(agentName, updatedOptions);
-            return utils.convertKnowledgeAgentToPublic(result);
+            const result = await this.client.knowledgeBases.get(knowledgeBaseName, updatedOptions);
+            return utils.convertKnowledgeBaseToPublic(result);
         }
         catch (e) {
             span.setStatus({
@@ -740,11 +740,11 @@ class SearchIndexClient {
             span.end();
         }
     }
-    async *listKnowledgeAgentsPage(options = {}) {
-        const { span, updatedOptions } = (0, tracing_js_1.createSpan)("SearchIndexClient-listKnowledgeAgentsPage", options);
+    async *listKnowledgeBasesPage(options = {}) {
+        const { span, updatedOptions } = (0, tracing_js_1.createSpan)("SearchIndexClient-listKnowledgeBasesPage", options);
         try {
-            const { knowledgeAgents } = await this.client.knowledgeAgents.list(updatedOptions);
-            const mapped = knowledgeAgents.map((agent) => utils.convertKnowledgeAgentToPublic(agent));
+            const { knowledgeBases } = await this.client.knowledgeBases.list(updatedOptions);
+            const mapped = knowledgeBases.map((base) => utils.convertKnowledgeBaseToPublic(base));
             yield mapped;
         }
         catch (e) {
@@ -758,17 +758,17 @@ class SearchIndexClient {
             span.end();
         }
     }
-    async *listKnowledgeAgentsAll(options = {}) {
-        for await (const page of this.listKnowledgeAgentsPage(options)) {
+    async *listKnowledgeBasesAll(options = {}) {
+        for await (const page of this.listKnowledgeBasesPage(options)) {
             yield* page;
         }
     }
     /**
-     * Retrieves a list of existing KnowledgeAgents in the service.
-     * @param options - Options to the list knowledge agents operation.
+     * Retrieves a list of existing KnowledgeBases in the service.
+     * @param options - Options to the list knowledge bases operation.
      */
-    listKnowledgeAgents(options = {}) {
-        const iter = this.listKnowledgeAgentsAll(options);
+    listKnowledgeBases(options = {}) {
+        const iter = this.listKnowledgeBasesAll(options);
         return {
             next() {
                 return iter.next();
@@ -777,16 +777,18 @@ class SearchIndexClient {
                 return this;
             },
             byPage: () => {
-                return this.listKnowledgeAgentsPage(options);
+                return this.listKnowledgeBasesPage(options);
             },
         };
     }
-    async deleteKnowledgeAgent(agent, options) {
-        const { span, updatedOptions } = (0, tracing_js_1.createSpan)("SearchIndexClient-deleteKnowledgeAgent", options);
+    async deleteKnowledgeBase(knowledgeBase, options) {
+        const { span, updatedOptions } = (0, tracing_js_1.createSpan)("SearchIndexClient-deleteKnowledgeBase", 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, {
+            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,
             });
@@ -931,6 +933,28 @@ class SearchIndexClient {
             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 } = (0, tracing_js_1.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
@@ -944,11 +968,11 @@ class SearchIndexClient {
     }
     /**
      * Retrieves the KnowledgeRetrievalClient corresponding to this SearchIndexClient
-     * @param agentName - Name of the agent
+     * @param knowledgeBaseName - Name of the knowledge base
      * @param options - KnowledgeRetrievalClient Options
      */
-    getKnowledgeRetrievalClient(agentName, options) {
-        return new knowledgeRetrievalClient_js_1.KnowledgeRetrievalClient(this.endpoint, agentName, this.credential, options || this.options);
+    getKnowledgeRetrievalClient(knowledgeBaseName, options) {
+        return new knowledgeRetrievalClient_js_1.KnowledgeRetrievalClient(this.endpoint, knowledgeBaseName, this.credential, options || this.options);
     }
 }
 exports.SearchIndexClient = SearchIndexClient;