feat(client-bedrock-agent): This release introduces APIs to upload do…

…cuments directly into a Knowledge Base
aws · Dec 2, 2024 · 908a395 · 908a395
1 parent 824c92f
commit 908a395
Show file tree

Hide file tree

Showing 21 changed files with 3,390 additions and 447 deletions.
diff --git a/clients/client-bedrock-agent/README.md b/clients/client-bedrock-agent/README.md
@@ -362,6 +362,14 @@ DeleteKnowledgeBase
 
 [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/bedrock-agent/command/DeleteKnowledgeBaseCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-bedrock-agent/Interface/DeleteKnowledgeBaseCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-bedrock-agent/Interface/DeleteKnowledgeBaseCommandOutput/)
 
+</details>
+<details>
+<summary>
+DeleteKnowledgeBaseDocuments
+</summary>
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/bedrock-agent/command/DeleteKnowledgeBaseDocumentsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-bedrock-agent/Interface/DeleteKnowledgeBaseDocumentsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-bedrock-agent/Interface/DeleteKnowledgeBaseDocumentsCommandOutput/)
+
 </details>
 <details>
 <summary>
@@ -466,6 +474,14 @@ GetKnowledgeBase
 
 [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/bedrock-agent/command/GetKnowledgeBaseCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-bedrock-agent/Interface/GetKnowledgeBaseCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-bedrock-agent/Interface/GetKnowledgeBaseCommandOutput/)
 
+</details>
+<details>
+<summary>
+GetKnowledgeBaseDocuments
+</summary>
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/bedrock-agent/command/GetKnowledgeBaseDocumentsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-bedrock-agent/Interface/GetKnowledgeBaseDocumentsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-bedrock-agent/Interface/GetKnowledgeBaseDocumentsCommandOutput/)
+
 </details>
 <details>
 <summary>
@@ -474,6 +490,14 @@ GetPrompt
 
 [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/bedrock-agent/command/GetPromptCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-bedrock-agent/Interface/GetPromptCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-bedrock-agent/Interface/GetPromptCommandOutput/)
 
+</details>
+<details>
+<summary>
+IngestKnowledgeBaseDocuments
+</summary>
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/bedrock-agent/command/IngestKnowledgeBaseDocumentsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-bedrock-agent/Interface/IngestKnowledgeBaseDocumentsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-bedrock-agent/Interface/IngestKnowledgeBaseDocumentsCommandOutput/)
+
 </details>
 <details>
 <summary>
@@ -554,6 +578,14 @@ ListIngestionJobs
 
 [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/bedrock-agent/command/ListIngestionJobsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-bedrock-agent/Interface/ListIngestionJobsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-bedrock-agent/Interface/ListIngestionJobsCommandOutput/)
 
+</details>
+<details>
+<summary>
+ListKnowledgeBaseDocuments
+</summary>
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/bedrock-agent/command/ListKnowledgeBaseDocumentsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-bedrock-agent/Interface/ListKnowledgeBaseDocumentsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-bedrock-agent/Interface/ListKnowledgeBaseDocumentsCommandOutput/)
+
 </details>
 <details>
 <summary>

diff --git a/clients/client-bedrock-agent/src/BedrockAgent.ts b/clients/client-bedrock-agent/src/BedrockAgent.ts
@@ -87,6 +87,11 @@ import {
   DeleteKnowledgeBaseCommandInput,
   DeleteKnowledgeBaseCommandOutput,
 } from "./commands/DeleteKnowledgeBaseCommand";
+import {
+  DeleteKnowledgeBaseDocumentsCommand,
+  DeleteKnowledgeBaseDocumentsCommandInput,
+  DeleteKnowledgeBaseDocumentsCommandOutput,
+} from "./commands/DeleteKnowledgeBaseDocumentsCommand";
 import {
   DeletePromptCommand,
   DeletePromptCommandInput,
@@ -144,7 +149,17 @@ import {
   GetKnowledgeBaseCommandInput,
   GetKnowledgeBaseCommandOutput,
 } from "./commands/GetKnowledgeBaseCommand";
+import {
+  GetKnowledgeBaseDocumentsCommand,
+  GetKnowledgeBaseDocumentsCommandInput,
+  GetKnowledgeBaseDocumentsCommandOutput,
+} from "./commands/GetKnowledgeBaseDocumentsCommand";
 import { GetPromptCommand, GetPromptCommandInput, GetPromptCommandOutput } from "./commands/GetPromptCommand";
+import {
+  IngestKnowledgeBaseDocumentsCommand,
+  IngestKnowledgeBaseDocumentsCommandInput,
+  IngestKnowledgeBaseDocumentsCommandOutput,
+} from "./commands/IngestKnowledgeBaseDocumentsCommand";
 import {
   ListAgentActionGroupsCommand,
   ListAgentActionGroupsCommandInput,
@@ -187,6 +202,11 @@ import {
   ListIngestionJobsCommandInput,
   ListIngestionJobsCommandOutput,
 } from "./commands/ListIngestionJobsCommand";
+import {
+  ListKnowledgeBaseDocumentsCommand,
+  ListKnowledgeBaseDocumentsCommandInput,
+  ListKnowledgeBaseDocumentsCommandOutput,
+} from "./commands/ListKnowledgeBaseDocumentsCommand";
 import {
   ListKnowledgeBasesCommand,
   ListKnowledgeBasesCommandInput,
@@ -284,6 +304,7 @@ const commands = {
   DeleteFlowAliasCommand,
   DeleteFlowVersionCommand,
   DeleteKnowledgeBaseCommand,
+  DeleteKnowledgeBaseDocumentsCommand,
   DeletePromptCommand,
   DisassociateAgentKnowledgeBaseCommand,
   GetAgentCommand,
@@ -297,7 +318,9 @@ const commands = {
   GetFlowVersionCommand,
   GetIngestionJobCommand,
   GetKnowledgeBaseCommand,
+  GetKnowledgeBaseDocumentsCommand,
   GetPromptCommand,
+  IngestKnowledgeBaseDocumentsCommand,
   ListAgentActionGroupsCommand,
   ListAgentAliasesCommand,
   ListAgentKnowledgeBasesCommand,
@@ -308,6 +331,7 @@ const commands = {
   ListFlowsCommand,
   ListFlowVersionsCommand,
   ListIngestionJobsCommand,
+  ListKnowledgeBaseDocumentsCommand,
   ListKnowledgeBasesCommand,
   ListPromptsCommand,
   ListTagsForResourceCommand,
@@ -634,6 +658,23 @@ export interface BedrockAgent {
     cb: (err: any, data?: DeleteKnowledgeBaseCommandOutput) => void
   ): void;
 
+  /**
+   * @see {@link DeleteKnowledgeBaseDocumentsCommand}
+   */
+  deleteKnowledgeBaseDocuments(
+    args: DeleteKnowledgeBaseDocumentsCommandInput,
+    options?: __HttpHandlerOptions
+  ): Promise<DeleteKnowledgeBaseDocumentsCommandOutput>;
+  deleteKnowledgeBaseDocuments(
+    args: DeleteKnowledgeBaseDocumentsCommandInput,
+    cb: (err: any, data?: DeleteKnowledgeBaseDocumentsCommandOutput) => void
+  ): void;
+  deleteKnowledgeBaseDocuments(
+    args: DeleteKnowledgeBaseDocumentsCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: DeleteKnowledgeBaseDocumentsCommandOutput) => void
+  ): void;
+
   /**
    * @see {@link DeletePromptCommand}
    */
@@ -810,6 +851,23 @@ export interface BedrockAgent {
     cb: (err: any, data?: GetKnowledgeBaseCommandOutput) => void
   ): void;
 
+  /**
+   * @see {@link GetKnowledgeBaseDocumentsCommand}
+   */
+  getKnowledgeBaseDocuments(
+    args: GetKnowledgeBaseDocumentsCommandInput,
+    options?: __HttpHandlerOptions
+  ): Promise<GetKnowledgeBaseDocumentsCommandOutput>;
+  getKnowledgeBaseDocuments(
+    args: GetKnowledgeBaseDocumentsCommandInput,
+    cb: (err: any, data?: GetKnowledgeBaseDocumentsCommandOutput) => void
+  ): void;
+  getKnowledgeBaseDocuments(
+    args: GetKnowledgeBaseDocumentsCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: GetKnowledgeBaseDocumentsCommandOutput) => void
+  ): void;
+
   /**
    * @see {@link GetPromptCommand}
    */
@@ -821,6 +879,23 @@ export interface BedrockAgent {
     cb: (err: any, data?: GetPromptCommandOutput) => void
   ): void;
 
+  /**
+   * @see {@link IngestKnowledgeBaseDocumentsCommand}
+   */
+  ingestKnowledgeBaseDocuments(
+    args: IngestKnowledgeBaseDocumentsCommandInput,
+    options?: __HttpHandlerOptions
+  ): Promise<IngestKnowledgeBaseDocumentsCommandOutput>;
+  ingestKnowledgeBaseDocuments(
+    args: IngestKnowledgeBaseDocumentsCommandInput,
+    cb: (err: any, data?: IngestKnowledgeBaseDocumentsCommandOutput) => void
+  ): void;
+  ingestKnowledgeBaseDocuments(
+    args: IngestKnowledgeBaseDocumentsCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: IngestKnowledgeBaseDocumentsCommandOutput) => void
+  ): void;
+
   /**
    * @see {@link ListAgentActionGroupsCommand}
    */
@@ -975,6 +1050,23 @@ export interface BedrockAgent {
     cb: (err: any, data?: ListIngestionJobsCommandOutput) => void
   ): void;
 
+  /**
+   * @see {@link ListKnowledgeBaseDocumentsCommand}
+   */
+  listKnowledgeBaseDocuments(
+    args: ListKnowledgeBaseDocumentsCommandInput,
+    options?: __HttpHandlerOptions
+  ): Promise<ListKnowledgeBaseDocumentsCommandOutput>;
+  listKnowledgeBaseDocuments(
+    args: ListKnowledgeBaseDocumentsCommandInput,
+    cb: (err: any, data?: ListKnowledgeBaseDocumentsCommandOutput) => void
+  ): void;
+  listKnowledgeBaseDocuments(
+    args: ListKnowledgeBaseDocumentsCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: ListKnowledgeBaseDocumentsCommandOutput) => void
+  ): void;
+
   /**
    * @see {@link ListKnowledgeBasesCommand}
    */

diff --git a/clients/client-bedrock-agent/src/BedrockAgentClient.ts b/clients/client-bedrock-agent/src/BedrockAgentClient.ts
@@ -91,6 +91,10 @@ import {
   DeleteKnowledgeBaseCommandInput,
   DeleteKnowledgeBaseCommandOutput,
 } from "./commands/DeleteKnowledgeBaseCommand";
+import {
+  DeleteKnowledgeBaseDocumentsCommandInput,
+  DeleteKnowledgeBaseDocumentsCommandOutput,
+} from "./commands/DeleteKnowledgeBaseDocumentsCommand";
 import { DeletePromptCommandInput, DeletePromptCommandOutput } from "./commands/DeletePromptCommand";
 import {
   DisassociateAgentKnowledgeBaseCommandInput,
@@ -113,7 +117,15 @@ import { GetFlowCommandInput, GetFlowCommandOutput } from "./commands/GetFlowCom
 import { GetFlowVersionCommandInput, GetFlowVersionCommandOutput } from "./commands/GetFlowVersionCommand";
 import { GetIngestionJobCommandInput, GetIngestionJobCommandOutput } from "./commands/GetIngestionJobCommand";
 import { GetKnowledgeBaseCommandInput, GetKnowledgeBaseCommandOutput } from "./commands/GetKnowledgeBaseCommand";
+import {
+  GetKnowledgeBaseDocumentsCommandInput,
+  GetKnowledgeBaseDocumentsCommandOutput,
+} from "./commands/GetKnowledgeBaseDocumentsCommand";
 import { GetPromptCommandInput, GetPromptCommandOutput } from "./commands/GetPromptCommand";
+import {
+  IngestKnowledgeBaseDocumentsCommandInput,
+  IngestKnowledgeBaseDocumentsCommandOutput,
+} from "./commands/IngestKnowledgeBaseDocumentsCommand";
 import {
   ListAgentActionGroupsCommandInput,
   ListAgentActionGroupsCommandOutput,
@@ -130,6 +142,10 @@ import { ListFlowAliasesCommandInput, ListFlowAliasesCommandOutput } from "./com
 import { ListFlowsCommandInput, ListFlowsCommandOutput } from "./commands/ListFlowsCommand";
 import { ListFlowVersionsCommandInput, ListFlowVersionsCommandOutput } from "./commands/ListFlowVersionsCommand";
 import { ListIngestionJobsCommandInput, ListIngestionJobsCommandOutput } from "./commands/ListIngestionJobsCommand";
+import {
+  ListKnowledgeBaseDocumentsCommandInput,
+  ListKnowledgeBaseDocumentsCommandOutput,
+} from "./commands/ListKnowledgeBaseDocumentsCommand";
 import { ListKnowledgeBasesCommandInput, ListKnowledgeBasesCommandOutput } from "./commands/ListKnowledgeBasesCommand";
 import { ListPromptsCommandInput, ListPromptsCommandOutput } from "./commands/ListPromptsCommand";
 import {
@@ -199,6 +215,7 @@ export type ServiceInputTypes =
   | DeleteFlowCommandInput
   | DeleteFlowVersionCommandInput
   | DeleteKnowledgeBaseCommandInput
+  | DeleteKnowledgeBaseDocumentsCommandInput
   | DeletePromptCommandInput
   | DisassociateAgentKnowledgeBaseCommandInput
   | GetAgentActionGroupCommandInput
@@ -212,7 +229,9 @@ export type ServiceInputTypes =
   | GetFlowVersionCommandInput
   | GetIngestionJobCommandInput
   | GetKnowledgeBaseCommandInput
+  | GetKnowledgeBaseDocumentsCommandInput
   | GetPromptCommandInput
+  | IngestKnowledgeBaseDocumentsCommandInput
   | ListAgentActionGroupsCommandInput
   | ListAgentAliasesCommandInput
   | ListAgentKnowledgeBasesCommandInput
@@ -223,6 +242,7 @@ export type ServiceInputTypes =
   | ListFlowVersionsCommandInput
   | ListFlowsCommandInput
   | ListIngestionJobsCommandInput
+  | ListKnowledgeBaseDocumentsCommandInput
   | ListKnowledgeBasesCommandInput
   | ListPromptsCommandInput
   | ListTagsForResourceCommandInput
@@ -267,6 +287,7 @@ export type ServiceOutputTypes =
   | DeleteFlowCommandOutput
   | DeleteFlowVersionCommandOutput
   | DeleteKnowledgeBaseCommandOutput
+  | DeleteKnowledgeBaseDocumentsCommandOutput
   | DeletePromptCommandOutput
   | DisassociateAgentKnowledgeBaseCommandOutput
   | GetAgentActionGroupCommandOutput
@@ -280,7 +301,9 @@ export type ServiceOutputTypes =
   | GetFlowVersionCommandOutput
   | GetIngestionJobCommandOutput
   | GetKnowledgeBaseCommandOutput
+  | GetKnowledgeBaseDocumentsCommandOutput
   | GetPromptCommandOutput
+  | IngestKnowledgeBaseDocumentsCommandOutput
   | ListAgentActionGroupsCommandOutput
   | ListAgentAliasesCommandOutput
   | ListAgentKnowledgeBasesCommandOutput
@@ -291,6 +314,7 @@ export type ServiceOutputTypes =
   | ListFlowVersionsCommandOutput
   | ListFlowsCommandOutput
   | ListIngestionJobsCommandOutput
+  | ListKnowledgeBaseDocumentsCommandOutput
   | ListKnowledgeBasesCommandOutput
   | ListPromptsCommandOutput
   | ListTagsForResourceCommandOutput

diff --git a/clients/client-bedrock-agent/src/commands/AssociateAgentKnowledgeBaseCommand.ts b/clients/client-bedrock-agent/src/commands/AssociateAgentKnowledgeBaseCommand.ts
@@ -6,7 +6,7 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
 
 import { BedrockAgentClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BedrockAgentClient";
 import { commonParams } from "../endpoint/EndpointParameters";
-import { AssociateAgentKnowledgeBaseRequest, AssociateAgentKnowledgeBaseResponse } from "../models/models_0";
+import { AssociateAgentKnowledgeBaseRequest, AssociateAgentKnowledgeBaseResponse } from "../models/models_1";
 import {
   de_AssociateAgentKnowledgeBaseCommand,
   se_AssociateAgentKnowledgeBaseCommand,

diff --git a/clients/client-bedrock-agent/src/commands/CreateDataSourceCommand.ts b/clients/client-bedrock-agent/src/commands/CreateDataSourceCommand.ts
@@ -33,7 +33,7 @@ export interface CreateDataSourceCommandInput extends CreateDataSourceRequest {}
 export interface CreateDataSourceCommandOutput extends CreateDataSourceResponse, __MetadataBearer {}
 
 /**
- * <p>Creates a data source connector for a knowledge base.</p>
+ * <p>Connects a knowledge base to a data source. You specify the configuration for the specific data source service in the <code>dataSourceConfiguration</code> field.</p>
  *          <important>
  *             <p>You can't change the <code>chunkingConfiguration</code> after you create the data source connector.</p>
  *          </important>
@@ -49,7 +49,7 @@ export interface CreateDataSourceCommandOutput extends CreateDataSourceResponse,
  *   name: "STRING_VALUE", // required
  *   description: "STRING_VALUE",
  *   dataSourceConfiguration: { // DataSourceConfiguration
- *     type: "S3" || "WEB" || "CONFLUENCE" || "SALESFORCE" || "SHAREPOINT", // required
+ *     type: "S3" || "WEB" || "CONFLUENCE" || "SALESFORCE" || "SHAREPOINT" || "CUSTOM", // required
  *     s3Configuration: { // S3DataSourceConfiguration
  *       bucketArn: "STRING_VALUE", // required
  *       inclusionPrefixes: [ // S3Prefixes
@@ -219,7 +219,7 @@ export interface CreateDataSourceCommandOutput extends CreateDataSourceResponse,
  * //     status: "AVAILABLE" || "DELETING" || "DELETE_UNSUCCESSFUL", // required
  * //     description: "STRING_VALUE",
  * //     dataSourceConfiguration: { // DataSourceConfiguration
- * //       type: "S3" || "WEB" || "CONFLUENCE" || "SALESFORCE" || "SHAREPOINT", // required
+ * //       type: "S3" || "WEB" || "CONFLUENCE" || "SALESFORCE" || "SHAREPOINT" || "CUSTOM", // required
  * //       s3Configuration: { // S3DataSourceConfiguration
  * //         bucketArn: "STRING_VALUE", // required
  * //         inclusionPrefixes: [ // S3Prefixes

diff --git a/clients/client-bedrock-agent/src/commands/CreateKnowledgeBaseCommand.ts b/clients/client-bedrock-agent/src/commands/CreateKnowledgeBaseCommand.ts
@@ -6,7 +6,7 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
 
 import { BedrockAgentClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BedrockAgentClient";
 import { commonParams } from "../endpoint/EndpointParameters";
-import { CreateKnowledgeBaseRequest, CreateKnowledgeBaseResponse } from "../models/models_0";
+import { CreateKnowledgeBaseRequest, CreateKnowledgeBaseResponse } from "../models/models_1";
 import { de_CreateKnowledgeBaseCommand, se_CreateKnowledgeBaseCommand } from "../protocols/Aws_restJson1";
 
 /**

diff --git a/clients/client-bedrock-agent/src/commands/DeleteKnowledgeBaseCommand.ts b/clients/client-bedrock-agent/src/commands/DeleteKnowledgeBaseCommand.ts
@@ -6,7 +6,7 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
 
 import { BedrockAgentClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BedrockAgentClient";
 import { commonParams } from "../endpoint/EndpointParameters";
-import { DeleteKnowledgeBaseRequest, DeleteKnowledgeBaseResponse } from "../models/models_0";
+import { DeleteKnowledgeBaseRequest, DeleteKnowledgeBaseResponse } from "../models/models_1";
 import { de_DeleteKnowledgeBaseCommand, se_DeleteKnowledgeBaseCommand } from "../protocols/Aws_restJson1";
 
 /**