@aws-sdk/client-bedrock-agent 3.701.0 → 3.703.0

package/dist-types/commands/IngestKnowledgeBaseDocumentsCommand.d.ts

@@ -0,0 +1,161 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { BedrockAgentClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BedrockAgentClient";
+import { IngestKnowledgeBaseDocumentsRequest, IngestKnowledgeBaseDocumentsResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link IngestKnowledgeBaseDocumentsCommand}.
+ */
+export interface IngestKnowledgeBaseDocumentsCommandInput extends IngestKnowledgeBaseDocumentsRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link IngestKnowledgeBaseDocumentsCommand}.
+ */
+export interface IngestKnowledgeBaseDocumentsCommandOutput extends IngestKnowledgeBaseDocumentsResponse, __MetadataBearer {
+}
+declare const IngestKnowledgeBaseDocumentsCommand_base: {
+    new (input: IngestKnowledgeBaseDocumentsCommandInput): import("@smithy/smithy-client").CommandImpl<IngestKnowledgeBaseDocumentsCommandInput, IngestKnowledgeBaseDocumentsCommandOutput, BedrockAgentClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: IngestKnowledgeBaseDocumentsCommandInput): import("@smithy/smithy-client").CommandImpl<IngestKnowledgeBaseDocumentsCommandInput, IngestKnowledgeBaseDocumentsCommandOutput, BedrockAgentClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Ingests documents directly into the knowledge base that is connected to the data source. The <code>dataSourceType</code> specified in the content for each document must match the type of the data source that you specify in the header. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/kb-real-time-ingestion.html">Ingest documents into a knowledge base in real-time</a> in the Amazon Bedrock User Guide.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { BedrockAgentClient, IngestKnowledgeBaseDocumentsCommand } from "@aws-sdk/client-bedrock-agent"; // ES Modules import
+ * // const { BedrockAgentClient, IngestKnowledgeBaseDocumentsCommand } = require("@aws-sdk/client-bedrock-agent"); // CommonJS import
+ * const client = new BedrockAgentClient(config);
+ * const input = { // IngestKnowledgeBaseDocumentsRequest
+ *   knowledgeBaseId: "STRING_VALUE", // required
+ *   dataSourceId: "STRING_VALUE", // required
+ *   clientToken: "STRING_VALUE",
+ *   documents: [ // KnowledgeBaseDocuments // required
+ *     { // KnowledgeBaseDocument
+ *       metadata: { // DocumentMetadata
+ *         type: "IN_LINE_ATTRIBUTE" || "S3_LOCATION", // required
+ *         inlineAttributes: [ // MetadataAttributes
+ *           { // MetadataAttribute
+ *             key: "STRING_VALUE", // required
+ *             value: { // MetadataAttributeValue
+ *               type: "BOOLEAN" || "NUMBER" || "STRING" || "STRING_LIST", // required
+ *               numberValue: Number("double"),
+ *               booleanValue: true || false,
+ *               stringValue: "STRING_VALUE",
+ *               stringListValue: [ // StringListValue
+ *                 "STRING_VALUE",
+ *               ],
+ *             },
+ *           },
+ *         ],
+ *         s3Location: { // CustomS3Location
+ *           uri: "STRING_VALUE", // required
+ *           bucketOwnerAccountId: "STRING_VALUE",
+ *         },
+ *       },
+ *       content: { // DocumentContent
+ *         dataSourceType: "CUSTOM" || "S3", // required
+ *         custom: { // CustomContent
+ *           customDocumentIdentifier: { // CustomDocumentIdentifier
+ *             id: "STRING_VALUE", // required
+ *           },
+ *           sourceType: "IN_LINE" || "S3_LOCATION", // required
+ *           s3Location: {
+ *             uri: "STRING_VALUE", // required
+ *             bucketOwnerAccountId: "STRING_VALUE",
+ *           },
+ *           inlineContent: { // InlineContent
+ *             type: "BYTE" || "TEXT", // required
+ *             byteContent: { // ByteContentDoc
+ *               mimeType: "STRING_VALUE", // required
+ *               data: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")               // required
+ *             },
+ *             textContent: { // TextContentDoc
+ *               data: "STRING_VALUE", // required
+ *             },
+ *           },
+ *         },
+ *         s3: { // S3Content
+ *           s3Location: { // S3Location
+ *             uri: "STRING_VALUE", // required
+ *           },
+ *         },
+ *       },
+ *     },
+ *   ],
+ * };
+ * const command = new IngestKnowledgeBaseDocumentsCommand(input);
+ * const response = await client.send(command);
+ * // { // IngestKnowledgeBaseDocumentsResponse
+ * //   documentDetails: [ // KnowledgeBaseDocumentDetails
+ * //     { // KnowledgeBaseDocumentDetail
+ * //       knowledgeBaseId: "STRING_VALUE", // required
+ * //       dataSourceId: "STRING_VALUE", // required
+ * //       status: "INDEXED" || "PARTIALLY_INDEXED" || "PENDING" || "FAILED" || "METADATA_PARTIALLY_INDEXED" || "METADATA_UPDATE_FAILED" || "IGNORED" || "NOT_FOUND" || "STARTING" || "IN_PROGRESS" || "DELETING" || "DELETE_IN_PROGRESS", // required
+ * //       identifier: { // DocumentIdentifier
+ * //         dataSourceType: "CUSTOM" || "S3", // required
+ * //         s3: { // S3Location
+ * //           uri: "STRING_VALUE", // required
+ * //         },
+ * //         custom: { // CustomDocumentIdentifier
+ * //           id: "STRING_VALUE", // required
+ * //         },
+ * //       },
+ * //       statusReason: "STRING_VALUE",
+ * //       updatedAt: new Date("TIMESTAMP"),
+ * //     },
+ * //   ],
+ * // };
+ *
+ * ```
+ *
+ * @param IngestKnowledgeBaseDocumentsCommandInput - {@link IngestKnowledgeBaseDocumentsCommandInput}
+ * @returns {@link IngestKnowledgeBaseDocumentsCommandOutput}
+ * @see {@link IngestKnowledgeBaseDocumentsCommandInput} for command's `input` shape.
+ * @see {@link IngestKnowledgeBaseDocumentsCommandOutput} for command's `response` shape.
+ * @see {@link BedrockAgentClientResolvedConfig | config} for BedrockAgentClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>The request is denied because of missing access permissions.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>An internal server error occurred. Retry your request.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.</p>
+ *
+ * @throws {@link ServiceQuotaExceededException} (client fault)
+ *  <p>The number of requests exceeds the service quota. Resubmit your request later.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The number of requests exceeds the limit. Resubmit your request later.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>Input validation failed. Check your request parameters and retry the request.</p>
+ *
+ * @throws {@link BedrockAgentServiceException}
+ * <p>Base exception class for all service exceptions from BedrockAgent service.</p>
+ *
+ * @public
+ */
+export declare class IngestKnowledgeBaseDocumentsCommand extends IngestKnowledgeBaseDocumentsCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: IngestKnowledgeBaseDocumentsRequest;
+            output: IngestKnowledgeBaseDocumentsResponse;
+        };
+        sdk: {
+            input: IngestKnowledgeBaseDocumentsCommandInput;
+            output: IngestKnowledgeBaseDocumentsCommandOutput;
+        };
+    };
+}

package/dist-types/commands/ListKnowledgeBaseDocumentsCommand.d.ts

@@ -0,0 +1,110 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { BedrockAgentClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BedrockAgentClient";
+import { ListKnowledgeBaseDocumentsRequest, ListKnowledgeBaseDocumentsResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link ListKnowledgeBaseDocumentsCommand}.
+ */
+export interface ListKnowledgeBaseDocumentsCommandInput extends ListKnowledgeBaseDocumentsRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link ListKnowledgeBaseDocumentsCommand}.
+ */
+export interface ListKnowledgeBaseDocumentsCommandOutput extends ListKnowledgeBaseDocumentsResponse, __MetadataBearer {
+}
+declare const ListKnowledgeBaseDocumentsCommand_base: {
+    new (input: ListKnowledgeBaseDocumentsCommandInput): import("@smithy/smithy-client").CommandImpl<ListKnowledgeBaseDocumentsCommandInput, ListKnowledgeBaseDocumentsCommandOutput, BedrockAgentClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: ListKnowledgeBaseDocumentsCommandInput): import("@smithy/smithy-client").CommandImpl<ListKnowledgeBaseDocumentsCommandInput, ListKnowledgeBaseDocumentsCommandOutput, BedrockAgentClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Retrieves all the documents contained in a data source that is connected to a knowledge base. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/kb-real-time-ingestion.html">Ingest documents into a knowledge base in real-time</a> in the Amazon Bedrock User Guide.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { BedrockAgentClient, ListKnowledgeBaseDocumentsCommand } from "@aws-sdk/client-bedrock-agent"; // ES Modules import
+ * // const { BedrockAgentClient, ListKnowledgeBaseDocumentsCommand } = require("@aws-sdk/client-bedrock-agent"); // CommonJS import
+ * const client = new BedrockAgentClient(config);
+ * const input = { // ListKnowledgeBaseDocumentsRequest
+ *   knowledgeBaseId: "STRING_VALUE", // required
+ *   dataSourceId: "STRING_VALUE", // required
+ *   maxResults: Number("int"),
+ *   nextToken: "STRING_VALUE",
+ * };
+ * const command = new ListKnowledgeBaseDocumentsCommand(input);
+ * const response = await client.send(command);
+ * // { // ListKnowledgeBaseDocumentsResponse
+ * //   documentDetails: [ // KnowledgeBaseDocumentDetails // required
+ * //     { // KnowledgeBaseDocumentDetail
+ * //       knowledgeBaseId: "STRING_VALUE", // required
+ * //       dataSourceId: "STRING_VALUE", // required
+ * //       status: "INDEXED" || "PARTIALLY_INDEXED" || "PENDING" || "FAILED" || "METADATA_PARTIALLY_INDEXED" || "METADATA_UPDATE_FAILED" || "IGNORED" || "NOT_FOUND" || "STARTING" || "IN_PROGRESS" || "DELETING" || "DELETE_IN_PROGRESS", // required
+ * //       identifier: { // DocumentIdentifier
+ * //         dataSourceType: "CUSTOM" || "S3", // required
+ * //         s3: { // S3Location
+ * //           uri: "STRING_VALUE", // required
+ * //         },
+ * //         custom: { // CustomDocumentIdentifier
+ * //           id: "STRING_VALUE", // required
+ * //         },
+ * //       },
+ * //       statusReason: "STRING_VALUE",
+ * //       updatedAt: new Date("TIMESTAMP"),
+ * //     },
+ * //   ],
+ * //   nextToken: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param ListKnowledgeBaseDocumentsCommandInput - {@link ListKnowledgeBaseDocumentsCommandInput}
+ * @returns {@link ListKnowledgeBaseDocumentsCommandOutput}
+ * @see {@link ListKnowledgeBaseDocumentsCommandInput} for command's `input` shape.
+ * @see {@link ListKnowledgeBaseDocumentsCommandOutput} for command's `response` shape.
+ * @see {@link BedrockAgentClientResolvedConfig | config} for BedrockAgentClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>The request is denied because of missing access permissions.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>An internal server error occurred. Retry your request.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.</p>
+ *
+ * @throws {@link ServiceQuotaExceededException} (client fault)
+ *  <p>The number of requests exceeds the service quota. Resubmit your request later.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The number of requests exceeds the limit. Resubmit your request later.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>Input validation failed. Check your request parameters and retry the request.</p>
+ *
+ * @throws {@link BedrockAgentServiceException}
+ * <p>Base exception class for all service exceptions from BedrockAgent service.</p>
+ *
+ * @public
+ */
+export declare class ListKnowledgeBaseDocumentsCommand extends ListKnowledgeBaseDocumentsCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: ListKnowledgeBaseDocumentsRequest;
+            output: ListKnowledgeBaseDocumentsResponse;
+        };
+        sdk: {
+            input: ListKnowledgeBaseDocumentsCommandInput;
+            output: ListKnowledgeBaseDocumentsCommandOutput;
+        };
+    };
+}

package/dist-types/commands/UpdateDataSourceCommand.d.ts

@@ -43,7 +43,7 @@ declare const UpdateDataSourceCommand_base: {
  *   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
@@ -213,7 +213,7 @@ declare const UpdateDataSourceCommand_base: {
  * //     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

package/dist-types/commands/UpdateKnowledgeBaseCommand.d.ts

@@ -65,6 +65,7 @@ declare const UpdateKnowledgeBaseCommand_base: {
  *       embeddingModelConfiguration: { // EmbeddingModelConfiguration
  *         bedrockEmbeddingModelConfiguration: { // BedrockEmbeddingModelConfiguration
  *           dimensions: Number("int"),
+ *           embeddingDataType: "FLOAT32" || "BINARY",
  *         },
  *       },
  *     },
@@ -142,6 +143,7 @@ declare const UpdateKnowledgeBaseCommand_base: {
  * //         embeddingModelConfiguration: { // EmbeddingModelConfiguration
  * //           bedrockEmbeddingModelConfiguration: { // BedrockEmbeddingModelConfiguration
  * //             dimensions: Number("int"),
+ * //             embeddingDataType: "FLOAT32" || "BINARY",
  * //           },
  * //         },
  * //       },

package/dist-types/commands/index.d.ts

@@ -18,6 +18,7 @@ export * from "./DeleteFlowAliasCommand";
 export * from "./DeleteFlowCommand";
 export * from "./DeleteFlowVersionCommand";
 export * from "./DeleteKnowledgeBaseCommand";
+export * from "./DeleteKnowledgeBaseDocumentsCommand";
 export * from "./DeletePromptCommand";
 export * from "./DisassociateAgentKnowledgeBaseCommand";
 export * from "./GetAgentActionGroupCommand";
@@ -31,7 +32,9 @@ export * from "./GetFlowCommand";
 export * from "./GetFlowVersionCommand";
 export * from "./GetIngestionJobCommand";
 export * from "./GetKnowledgeBaseCommand";
+export * from "./GetKnowledgeBaseDocumentsCommand";
 export * from "./GetPromptCommand";
+export * from "./IngestKnowledgeBaseDocumentsCommand";
 export * from "./ListAgentActionGroupsCommand";
 export * from "./ListAgentAliasesCommand";
 export * from "./ListAgentKnowledgeBasesCommand";
@@ -42,6 +45,7 @@ export * from "./ListFlowAliasesCommand";
 export * from "./ListFlowVersionsCommand";
 export * from "./ListFlowsCommand";
 export * from "./ListIngestionJobsCommand";
+export * from "./ListKnowledgeBaseDocumentsCommand";
 export * from "./ListKnowledgeBasesCommand";
 export * from "./ListPromptsCommand";
 export * from "./ListTagsForResourceCommand";