Creates a data source connector for a knowledge base.
+ *Connects a knowledge base to a data source. You specify the configuration for the specific data source service in the dataSourceConfiguration field.
You can't change the chunkingConfiguration after you create the data source connector.
Deletes documents from a data source and syncs the changes to the knowledge base that is connected to it. For more information, see Ingest documents into a knowledge base in real-time in the Amazon Bedrock User Guide.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BedrockAgentClient, DeleteKnowledgeBaseDocumentsCommand } from "@aws-sdk/client-bedrock-agent"; // ES Modules import + * // const { BedrockAgentClient, DeleteKnowledgeBaseDocumentsCommand } = require("@aws-sdk/client-bedrock-agent"); // CommonJS import + * const client = new BedrockAgentClient(config); + * const input = { // DeleteKnowledgeBaseDocumentsRequest + * knowledgeBaseId: "STRING_VALUE", // required + * dataSourceId: "STRING_VALUE", // required + * clientToken: "STRING_VALUE", + * documentIdentifiers: [ // DocumentIdentifiers // required + * { // DocumentIdentifier + * dataSourceType: "CUSTOM" || "S3", // required + * s3: { // S3Location + * uri: "STRING_VALUE", // required + * }, + * custom: { // CustomDocumentIdentifier + * id: "STRING_VALUE", // required + * }, + * }, + * ], + * }; + * const command = new DeleteKnowledgeBaseDocumentsCommand(input); + * const response = await client.send(command); + * // { // DeleteKnowledgeBaseDocumentsResponse + * // 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 DeleteKnowledgeBaseDocumentsCommandInput - {@link DeleteKnowledgeBaseDocumentsCommandInput} + * @returns {@link DeleteKnowledgeBaseDocumentsCommandOutput} + * @see {@link DeleteKnowledgeBaseDocumentsCommandInput} for command's `input` shape. + * @see {@link DeleteKnowledgeBaseDocumentsCommandOutput} for command's `response` shape. + * @see {@link BedrockAgentClientResolvedConfig | config} for BedrockAgentClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *The request is denied because of missing access permissions.
+ * + * @throws {@link InternalServerException} (server fault) + *An internal server error occurred. Retry your request.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
+ * + * @throws {@link ServiceQuotaExceededException} (client fault) + *The number of requests exceeds the service quota. Resubmit your request later.
+ * + * @throws {@link ThrottlingException} (client fault) + *The number of requests exceeds the limit. Resubmit your request later.
+ * + * @throws {@link ValidationException} (client fault) + *Input validation failed. Check your request parameters and retry the request.
+ * + * @throws {@link BedrockAgentServiceException} + *Base exception class for all service exceptions from BedrockAgent service.
+ * + * @public + */ +export class DeleteKnowledgeBaseDocumentsCommand extends $Command + .classBuilder< + DeleteKnowledgeBaseDocumentsCommandInput, + DeleteKnowledgeBaseDocumentsCommandOutput, + BedrockAgentClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: BedrockAgentClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AmazonBedrockAgentBuildTimeLambda", "DeleteKnowledgeBaseDocuments", {}) + .n("BedrockAgentClient", "DeleteKnowledgeBaseDocumentsCommand") + .f(void 0, void 0) + .ser(se_DeleteKnowledgeBaseDocumentsCommand) + .de(de_DeleteKnowledgeBaseDocumentsCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: DeleteKnowledgeBaseDocumentsRequest; + output: DeleteKnowledgeBaseDocumentsResponse; + }; + sdk: { + input: DeleteKnowledgeBaseDocumentsCommandInput; + output: DeleteKnowledgeBaseDocumentsCommandOutput; + }; + }; +} diff --git a/clients/client-bedrock-agent/src/commands/DisassociateAgentKnowledgeBaseCommand.ts b/clients/client-bedrock-agent/src/commands/DisassociateAgentKnowledgeBaseCommand.ts index 089d7dfe07e8b..ab868d843c900 100644 --- a/clients/client-bedrock-agent/src/commands/DisassociateAgentKnowledgeBaseCommand.ts +++ b/clients/client-bedrock-agent/src/commands/DisassociateAgentKnowledgeBaseCommand.ts @@ -6,7 +6,7 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { BedrockAgentClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BedrockAgentClient"; import { commonParams } from "../endpoint/EndpointParameters"; -import { DisassociateAgentKnowledgeBaseRequest, DisassociateAgentKnowledgeBaseResponse } from "../models/models_0"; +import { DisassociateAgentKnowledgeBaseRequest, DisassociateAgentKnowledgeBaseResponse } from "../models/models_1"; import { de_DisassociateAgentKnowledgeBaseCommand, se_DisassociateAgentKnowledgeBaseCommand, diff --git a/clients/client-bedrock-agent/src/commands/GetDataSourceCommand.ts b/clients/client-bedrock-agent/src/commands/GetDataSourceCommand.ts index c395eadcf80c3..089c4084bc778 100644 --- a/clients/client-bedrock-agent/src/commands/GetDataSourceCommand.ts +++ b/clients/client-bedrock-agent/src/commands/GetDataSourceCommand.ts @@ -53,7 +53,7 @@ export interface GetDataSourceCommandOutput extends GetDataSourceResponse, __Met * // 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/GetKnowledgeBaseDocumentsCommand.ts b/clients/client-bedrock-agent/src/commands/GetKnowledgeBaseDocumentsCommand.ts new file mode 100644 index 0000000000000..c4b7e3e6458d2 --- /dev/null +++ b/clients/client-bedrock-agent/src/commands/GetKnowledgeBaseDocumentsCommand.ts @@ -0,0 +1,139 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { BedrockAgentClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BedrockAgentClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { GetKnowledgeBaseDocumentsRequest, GetKnowledgeBaseDocumentsResponse } from "../models/models_0"; +import { de_GetKnowledgeBaseDocumentsCommand, se_GetKnowledgeBaseDocumentsCommand } from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link GetKnowledgeBaseDocumentsCommand}. + */ +export interface GetKnowledgeBaseDocumentsCommandInput extends GetKnowledgeBaseDocumentsRequest {} +/** + * @public + * + * The output of {@link GetKnowledgeBaseDocumentsCommand}. + */ +export interface GetKnowledgeBaseDocumentsCommandOutput extends GetKnowledgeBaseDocumentsResponse, __MetadataBearer {} + +/** + *Retrieves specific documents from a data source that is connected to a knowledge base. For more information, see Ingest documents into a knowledge base in real-time in the Amazon Bedrock User Guide.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BedrockAgentClient, GetKnowledgeBaseDocumentsCommand } from "@aws-sdk/client-bedrock-agent"; // ES Modules import + * // const { BedrockAgentClient, GetKnowledgeBaseDocumentsCommand } = require("@aws-sdk/client-bedrock-agent"); // CommonJS import + * const client = new BedrockAgentClient(config); + * const input = { // GetKnowledgeBaseDocumentsRequest + * knowledgeBaseId: "STRING_VALUE", // required + * dataSourceId: "STRING_VALUE", // required + * documentIdentifiers: [ // DocumentIdentifiers // required + * { // DocumentIdentifier + * dataSourceType: "CUSTOM" || "S3", // required + * s3: { // S3Location + * uri: "STRING_VALUE", // required + * }, + * custom: { // CustomDocumentIdentifier + * id: "STRING_VALUE", // required + * }, + * }, + * ], + * }; + * const command = new GetKnowledgeBaseDocumentsCommand(input); + * const response = await client.send(command); + * // { // GetKnowledgeBaseDocumentsResponse + * // 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 GetKnowledgeBaseDocumentsCommandInput - {@link GetKnowledgeBaseDocumentsCommandInput} + * @returns {@link GetKnowledgeBaseDocumentsCommandOutput} + * @see {@link GetKnowledgeBaseDocumentsCommandInput} for command's `input` shape. + * @see {@link GetKnowledgeBaseDocumentsCommandOutput} for command's `response` shape. + * @see {@link BedrockAgentClientResolvedConfig | config} for BedrockAgentClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *The request is denied because of missing access permissions.
+ * + * @throws {@link InternalServerException} (server fault) + *An internal server error occurred. Retry your request.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
+ * + * @throws {@link ServiceQuotaExceededException} (client fault) + *The number of requests exceeds the service quota. Resubmit your request later.
+ * + * @throws {@link ThrottlingException} (client fault) + *The number of requests exceeds the limit. Resubmit your request later.
+ * + * @throws {@link ValidationException} (client fault) + *Input validation failed. Check your request parameters and retry the request.
+ * + * @throws {@link BedrockAgentServiceException} + *Base exception class for all service exceptions from BedrockAgent service.
+ * + * @public + */ +export class GetKnowledgeBaseDocumentsCommand extends $Command + .classBuilder< + GetKnowledgeBaseDocumentsCommandInput, + GetKnowledgeBaseDocumentsCommandOutput, + BedrockAgentClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: BedrockAgentClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AmazonBedrockAgentBuildTimeLambda", "GetKnowledgeBaseDocuments", {}) + .n("BedrockAgentClient", "GetKnowledgeBaseDocumentsCommand") + .f(void 0, void 0) + .ser(se_GetKnowledgeBaseDocumentsCommand) + .de(de_GetKnowledgeBaseDocumentsCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: GetKnowledgeBaseDocumentsRequest; + output: GetKnowledgeBaseDocumentsResponse; + }; + sdk: { + input: GetKnowledgeBaseDocumentsCommandInput; + output: GetKnowledgeBaseDocumentsCommandOutput; + }; + }; +} diff --git a/clients/client-bedrock-agent/src/commands/IngestKnowledgeBaseDocumentsCommand.ts b/clients/client-bedrock-agent/src/commands/IngestKnowledgeBaseDocumentsCommand.ts new file mode 100644 index 0000000000000..e6064f6a66c5a --- /dev/null +++ b/clients/client-bedrock-agent/src/commands/IngestKnowledgeBaseDocumentsCommand.ts @@ -0,0 +1,191 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { BedrockAgentClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BedrockAgentClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { + IngestKnowledgeBaseDocumentsRequest, + IngestKnowledgeBaseDocumentsRequestFilterSensitiveLog, + IngestKnowledgeBaseDocumentsResponse, +} from "../models/models_0"; +import { + de_IngestKnowledgeBaseDocumentsCommand, + se_IngestKnowledgeBaseDocumentsCommand, +} from "../protocols/Aws_restJson1"; + +/** + * @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 {} + +/** + *Ingests documents directly into the knowledge base that is connected to the data source. The dataSourceType 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 Ingest documents into a knowledge base in real-time in the Amazon Bedrock User Guide.
The request is denied because of missing access permissions.
+ * + * @throws {@link InternalServerException} (server fault) + *An internal server error occurred. Retry your request.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
+ * + * @throws {@link ServiceQuotaExceededException} (client fault) + *The number of requests exceeds the service quota. Resubmit your request later.
+ * + * @throws {@link ThrottlingException} (client fault) + *The number of requests exceeds the limit. Resubmit your request later.
+ * + * @throws {@link ValidationException} (client fault) + *Input validation failed. Check your request parameters and retry the request.
+ * + * @throws {@link BedrockAgentServiceException} + *Base exception class for all service exceptions from BedrockAgent service.
+ * + * @public + */ +export class IngestKnowledgeBaseDocumentsCommand extends $Command + .classBuilder< + IngestKnowledgeBaseDocumentsCommandInput, + IngestKnowledgeBaseDocumentsCommandOutput, + BedrockAgentClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: BedrockAgentClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AmazonBedrockAgentBuildTimeLambda", "IngestKnowledgeBaseDocuments", {}) + .n("BedrockAgentClient", "IngestKnowledgeBaseDocumentsCommand") + .f(IngestKnowledgeBaseDocumentsRequestFilterSensitiveLog, void 0) + .ser(se_IngestKnowledgeBaseDocumentsCommand) + .de(de_IngestKnowledgeBaseDocumentsCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: IngestKnowledgeBaseDocumentsRequest; + output: IngestKnowledgeBaseDocumentsResponse; + }; + sdk: { + input: IngestKnowledgeBaseDocumentsCommandInput; + output: IngestKnowledgeBaseDocumentsCommandOutput; + }; + }; +} diff --git a/clients/client-bedrock-agent/src/commands/ListKnowledgeBaseDocumentsCommand.ts b/clients/client-bedrock-agent/src/commands/ListKnowledgeBaseDocumentsCommand.ts new file mode 100644 index 0000000000000..b6d9eebf1c319 --- /dev/null +++ b/clients/client-bedrock-agent/src/commands/ListKnowledgeBaseDocumentsCommand.ts @@ -0,0 +1,131 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { BedrockAgentClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BedrockAgentClient"; +import { commonParams } from "../endpoint/EndpointParameters"; +import { ListKnowledgeBaseDocumentsRequest, ListKnowledgeBaseDocumentsResponse } from "../models/models_0"; +import { de_ListKnowledgeBaseDocumentsCommand, se_ListKnowledgeBaseDocumentsCommand } from "../protocols/Aws_restJson1"; + +/** + * @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 {} + +/** + *Retrieves all the documents contained in a data source that is connected to a knowledge base. For more information, see Ingest documents into a knowledge base in real-time in the Amazon Bedrock User Guide.
+ * @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) + *The request is denied because of missing access permissions.
+ * + * @throws {@link InternalServerException} (server fault) + *An internal server error occurred. Retry your request.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
+ * + * @throws {@link ServiceQuotaExceededException} (client fault) + *The number of requests exceeds the service quota. Resubmit your request later.
+ * + * @throws {@link ThrottlingException} (client fault) + *The number of requests exceeds the limit. Resubmit your request later.
+ * + * @throws {@link ValidationException} (client fault) + *Input validation failed. Check your request parameters and retry the request.
+ * + * @throws {@link BedrockAgentServiceException} + *Base exception class for all service exceptions from BedrockAgent service.
+ * + * @public + */ +export class ListKnowledgeBaseDocumentsCommand extends $Command + .classBuilder< + ListKnowledgeBaseDocumentsCommandInput, + ListKnowledgeBaseDocumentsCommandOutput, + BedrockAgentClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: BedrockAgentClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("AmazonBedrockAgentBuildTimeLambda", "ListKnowledgeBaseDocuments", {}) + .n("BedrockAgentClient", "ListKnowledgeBaseDocumentsCommand") + .f(void 0, void 0) + .ser(se_ListKnowledgeBaseDocumentsCommand) + .de(de_ListKnowledgeBaseDocumentsCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: ListKnowledgeBaseDocumentsRequest; + output: ListKnowledgeBaseDocumentsResponse; + }; + sdk: { + input: ListKnowledgeBaseDocumentsCommandInput; + output: ListKnowledgeBaseDocumentsCommandOutput; + }; + }; +} diff --git a/clients/client-bedrock-agent/src/commands/UpdateDataSourceCommand.ts b/clients/client-bedrock-agent/src/commands/UpdateDataSourceCommand.ts index 3dbc6b2b312fc..f5a7b695db1b8 100644 --- a/clients/client-bedrock-agent/src/commands/UpdateDataSourceCommand.ts +++ b/clients/client-bedrock-agent/src/commands/UpdateDataSourceCommand.ts @@ -49,7 +49,7 @@ export interface UpdateDataSourceCommandOutput extends UpdateDataSourceResponse, * 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 UpdateDataSourceCommandOutput extends UpdateDataSourceResponse, * // 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/index.ts b/clients/client-bedrock-agent/src/commands/index.ts index ffc07c4e8d35e..4469e3d7982b1 100644 --- a/clients/client-bedrock-agent/src/commands/index.ts +++ b/clients/client-bedrock-agent/src/commands/index.ts @@ -19,6 +19,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"; @@ -32,7 +33,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"; @@ -43,6 +46,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"; diff --git a/clients/client-bedrock-agent/src/models/models_0.ts b/clients/client-bedrock-agent/src/models/models_0.ts index 8f691c4c0bf06..90250b8ebdc5f 100644 --- a/clients/client-bedrock-agent/src/models/models_0.ts +++ b/clients/client-bedrock-agent/src/models/models_0.ts @@ -2906,6 +2906,7 @@ export interface SharePointDataSourceConfiguration { */ export const DataSourceType = { CONFLUENCE: "CONFLUENCE", + CUSTOM: "CUSTOM", S3: "S3", SALESFORCE: "SALESFORCE", SHAREPOINT: "SHAREPOINT", @@ -8439,717 +8440,675 @@ export interface StopIngestionJobResponse { } /** + *Contains information about the identifier of the document to ingest into a custom data source.
* @public */ -export interface AssociateAgentKnowledgeBaseRequest { +export interface CustomDocumentIdentifier { /** - *The unique identifier of the agent with which you want to associate the knowledge base.
+ *The identifier of the document to ingest into a custom data source.
* @public */ - agentId: string | undefined; - - /** - *The version of the agent with which you want to associate the knowledge base.
- * @public - */ - agentVersion: string | undefined; - - /** - *The unique identifier of the knowledge base to associate with the agent.
- * @public - */ - knowledgeBaseId: string | undefined; - - /** - *A description of what the agent should use the knowledge base for.
- * @public - */ - description: string | undefined; - - /** - *Specifies whether to use the knowledge base or not when sending an InvokeAgent request.
- * @public - */ - knowledgeBaseState?: KnowledgeBaseState | undefined; -} - -/** - * @public - */ -export interface AssociateAgentKnowledgeBaseResponse { - /** - *Contains details about the knowledge base that has been associated with the agent.
- * @public - */ - agentKnowledgeBase: AgentKnowledgeBase | undefined; + id: string | undefined; } /** * @public * @enum */ -export const KnowledgeBaseType = { - VECTOR: "VECTOR", -} as const; - -/** - * @public - */ -export type KnowledgeBaseType = (typeof KnowledgeBaseType)[keyof typeof KnowledgeBaseType]; - -/** - * @public - * @enum - */ -export const EmbeddingDataType = { - BINARY: "BINARY", - FLOAT32: "FLOAT32", +export const ContentDataSourceType = { + CUSTOM: "CUSTOM", + S3: "S3", } as const; /** * @public */ -export type EmbeddingDataType = (typeof EmbeddingDataType)[keyof typeof EmbeddingDataType]; +export type ContentDataSourceType = (typeof ContentDataSourceType)[keyof typeof ContentDataSourceType]; /** - *The vector configuration details for the Bedrock embeddings model.
+ *Contains information that identifies the document.
* @public */ -export interface BedrockEmbeddingModelConfiguration { +export interface DocumentIdentifier { /** - *The dimensions details for the vector configuration used on the Bedrock embeddings model.
+ *The type of data source connected to the knowledge base that contains the document.
* @public */ - dimensions?: number | undefined; + dataSourceType: ContentDataSourceType | undefined; /** - *The data type for the vectors when using a model to convert text into vector - * embeddings. The model must support the specified data type for vector embeddings. - * Floating-point (float32) is the default data type, and is supported by most models - * for vector embeddings. See Supported embeddings - * models for information on the available models and their vector data types.
+ *Contains information that identifies the document in an S3 data source.
* @public */ - embeddingDataType?: EmbeddingDataType | undefined; -} + s3?: S3Location | undefined; -/** - *The configuration details for the embeddings model.
- * @public - */ -export interface EmbeddingModelConfiguration { /** - *The vector configuration details on the Bedrock embeddings model.
+ *Contains information that identifies the document in a custom data source.
* @public */ - bedrockEmbeddingModelConfiguration?: BedrockEmbeddingModelConfiguration | undefined; + custom?: CustomDocumentIdentifier | undefined; } /** - *Contains details about the model used to create vector embeddings for the knowledge base.
* @public */ -export interface VectorKnowledgeBaseConfiguration { +export interface DeleteKnowledgeBaseDocumentsRequest { /** - *The Amazon Resource Name (ARN) of the model or inference profile used to create vector embeddings for the knowledge base.
+ *The unique identifier of the knowledge base that is connected to the data source.
* @public */ - embeddingModelArn: string | undefined; + knowledgeBaseId: string | undefined; /** - *The embeddings model configuration details for the vector model used in Knowledge Base.
+ *The unique identifier of the data source that contains the documents.
* @public */ - embeddingModelConfiguration?: EmbeddingModelConfiguration | undefined; -} + dataSourceId: string | undefined; -/** - *Contains details about the vector embeddings configuration of the knowledge base.
- * @public - */ -export interface KnowledgeBaseConfiguration { /** - *The type of data that the data source is converted into for the knowledge base.
+ *A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, + * Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
* @public */ - type: KnowledgeBaseType | undefined; + clientToken?: string | undefined; /** - *Contains details about the model that's used to convert the data source into vector embeddings.
+ *A list of objects, each of which contains information to identify a document to delete.
* @public */ - vectorKnowledgeBaseConfiguration?: VectorKnowledgeBaseConfiguration | undefined; + documentIdentifiers: DocumentIdentifier[] | undefined; } /** - *Contains the names of the fields to which to map information about the vector store.
* @public + * @enum */ -export interface MongoDbAtlasFieldMapping { - /** - *The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
- * @public - */ - vectorField: string | undefined; - - /** - *The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
- * @public - */ - textField: string | undefined; +export const DocumentStatus = { + DELETE_IN_PROGRESS: "DELETE_IN_PROGRESS", + DELETING: "DELETING", + FAILED: "FAILED", + IGNORED: "IGNORED", + INDEXED: "INDEXED", + IN_PROGRESS: "IN_PROGRESS", + METADATA_PARTIALLY_INDEXED: "METADATA_PARTIALLY_INDEXED", + METADATA_UPDATE_FAILED: "METADATA_UPDATE_FAILED", + NOT_FOUND: "NOT_FOUND", + PARTIALLY_INDEXED: "PARTIALLY_INDEXED", + PENDING: "PENDING", + STARTING: "STARTING", +} as const; - /** - *The name of the field in which Amazon Bedrock stores metadata about the vector store.
- * @public - */ - metadataField: string | undefined; -} +/** + * @public + */ +export type DocumentStatus = (typeof DocumentStatus)[keyof typeof DocumentStatus]; /** - *Contains details about the storage configuration of the knowledge base in MongoDB Atlas.
+ *Contains the details for a document that was ingested or deleted.
* @public */ -export interface MongoDbAtlasConfiguration { +export interface KnowledgeBaseDocumentDetail { /** - *The endpoint URL of your MongoDB Atlas cluster for your knowledge base.
+ *The identifier of the knowledge base that the document was ingested into or deleted from.
* @public */ - endpoint: string | undefined; + knowledgeBaseId: string | undefined; /** - *The database name in your MongoDB Atlas cluster for your knowledge base.
+ *The identifier of the data source connected to the knowledge base that the document was ingested into or deleted from.
* @public */ - databaseName: string | undefined; + dataSourceId: string | undefined; /** - *The collection name of the knowledge base in MongoDB Atlas.
+ *The ingestion status of the document. The following statuses are possible:
+ *STARTED – You submitted the ingestion job containing the document.
+ *PENDING – The document is waiting to be ingested.
+ *IN_PROGRESS – The document is being ingested.
+ *INDEXED – The document was successfully indexed.
+ *PARTIALLY_INDEXED – The document was partially indexed.
+ *METADATA_PARTIALLY_INDEXED – You submitted metadata for an existing document and it was partially indexed.
+ *METADATA_UPDATE_FAILED – You submitted a metadata update for an existing document but it failed.
+ *FAILED – The document failed to be ingested.
+ *NOT_FOUND – The document wasn't found.
+ *IGNORED – The document was ignored during ingestion.
+ *DELETING – You submitted the delete job containing the document.
+ *DELETE_IN_PROGRESS – The document is being deleted.
+ *The name of the MongoDB Atlas vector search index.
+ *Contains information that identifies the document.
* @public */ - vectorIndexName: string | undefined; + identifier: DocumentIdentifier | undefined; /** - *The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that contains user credentials for your MongoDB Atlas cluster.
+ *The reason for the status. Appears alongside the status IGNORED.
Contains the names of the fields to which to map information about the vector store.
+ *The date and time at which the document was last updated.
* @public */ - fieldMapping: MongoDbAtlasFieldMapping | undefined; + updatedAt?: Date | undefined; +} +/** + * @public + */ +export interface DeleteKnowledgeBaseDocumentsResponse { /** - *The name of the VPC endpoint service in your account that is connected to your MongoDB Atlas cluster.
+ *A list of objects, each of which contains information about the documents that were deleted.
* @public */ - endpointServiceName?: string | undefined; + documentDetails?: KnowledgeBaseDocumentDetail[] | undefined; } /** - *Contains the names of the fields to which to map information about the vector store.
* @public */ -export interface OpenSearchServerlessFieldMapping { +export interface GetKnowledgeBaseDocumentsRequest { /** - *The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
+ *The unique identifier of the knowledge base that is connected to the data source.
* @public */ - vectorField: string | undefined; + knowledgeBaseId: string | undefined; /** - *The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
+ *The unique identifier of the data source that contains the documents.
* @public */ - textField: string | undefined; + dataSourceId: string | undefined; /** - *The name of the field in which Amazon Bedrock stores metadata about the vector store.
+ *A list of objects, each of which contains information to identify a document for which to retrieve information.
* @public */ - metadataField: string | undefined; + documentIdentifiers: DocumentIdentifier[] | undefined; } /** - *Contains details about the storage configuration of the knowledge base in Amazon OpenSearch Service. For more information, see Create a vector index in Amazon OpenSearch Service.
* @public */ -export interface OpenSearchServerlessConfiguration { +export interface GetKnowledgeBaseDocumentsResponse { /** - *The Amazon Resource Name (ARN) of the OpenSearch Service vector store.
+ *A list of objects, each of which contains information about the documents that were retrieved.
* @public */ - collectionArn: string | undefined; + documentDetails?: KnowledgeBaseDocumentDetail[] | undefined; +} +/** + *Contains information about content defined inline in bytes.
+ * @public + */ +export interface ByteContentDoc { /** - *The name of the vector store.
+ *The MIME type of the content. For a list of MIME types, see Media Types. The following MIME types are supported:
+ *text/plain
+ *text/html
+ *text/csv
+ *text/vtt
+ *message/rfc822
+ *application/xhtml+xml
+ *application/pdf
+ *application/msword
+ *application/vnd.ms-word.document.macroenabled.12
+ *application/vnd.ms-word.template.macroenabled.12
+ *application/vnd.ms-excel
+ *application/vnd.ms-excel.addin.macroenabled.12
+ *application/vnd.ms-excel.sheet.macroenabled.12
+ *application/vnd.ms-excel.template.macroenabled.12
+ *application/vnd.ms-excel.sheet.binary.macroenabled.12
+ *application/vnd.ms-spreadsheetml
+ *application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
+ *application/vnd.openxmlformats-officedocument.spreadsheetml.template
+ *application/vnd.openxmlformats-officedocument.wordprocessingml.document
+ *application/vnd.openxmlformats-officedocument.wordprocessingml.template
+ *Contains the names of the fields to which to map information about the vector store.
+ *The base64-encoded string of the content.
* @public */ - fieldMapping: OpenSearchServerlessFieldMapping | undefined; + data: Uint8Array | undefined; } /** - *Contains the names of the fields to which to map information about the vector store.
+ *Contains information about content defined inline in text.
* @public */ -export interface PineconeFieldMapping { - /** - *The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
- * @public - */ - textField: string | undefined; - +export interface TextContentDoc { /** - *The name of the field in which Amazon Bedrock stores metadata about the vector store.
+ *The text of the content.
* @public */ - metadataField: string | undefined; + data: string | undefined; } /** - *Contains details about the storage configuration of the knowledge base in Pinecone. For more information, see Create a vector index in Pinecone.
* @public + * @enum */ -export interface PineconeConfiguration { - /** - *The endpoint URL for your index management page.
- * @public - */ - connectionString: string | undefined; +export const InlineContentType = { + BYTE: "BYTE", + TEXT: "TEXT", +} as const; + +/** + * @public + */ +export type InlineContentType = (typeof InlineContentType)[keyof typeof InlineContentType]; +/** + *Contains information about content defined inline to ingest into a data source. Choose a type and include the field that corresponds to it.
The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that is linked to your Pinecone API key.
+ *The type of inline content to define.
* @public */ - credentialsSecretArn: string | undefined; + type: InlineContentType | undefined; /** - *The namespace to be used to write new data to your database.
+ *Contains information about content defined inline in bytes.
* @public */ - namespace?: string | undefined; + byteContent?: ByteContentDoc | undefined; /** - *Contains the names of the fields to which to map information about the vector store.
+ *Contains information about content defined inline in text.
* @public */ - fieldMapping: PineconeFieldMapping | undefined; + textContent?: TextContentDoc | undefined; } /** - *Contains the names of the fields to which to map information about the vector store.
+ *Contains information about the Amazon S3 location of the file containing the content to ingest into a knowledge base connected to a custom data source.
* @public */ -export interface RdsFieldMapping { +export interface CustomS3Location { /** - *The name of the field in which Amazon Bedrock stores the ID for each entry.
+ *The S3 URI of the file containing the content to ingest.
* @public */ - primaryKeyField: string | undefined; - - /** - *The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
- * @public - */ - vectorField: string | undefined; - - /** - *The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
- * @public - */ - textField: string | undefined; + uri: string | undefined; /** - *The name of the field in which Amazon Bedrock stores metadata about the vector store.
+ *The identifier of the Amazon Web Services account that owns the S3 bucket containing the content to ingest.
* @public */ - metadataField: string | undefined; + bucketOwnerAccountId?: string | undefined; } /** - *Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see Create a vector index in Amazon RDS.
* @public + * @enum */ -export interface RdsConfiguration { - /** - *The Amazon Resource Name (ARN) of the vector store.
- * @public - */ - resourceArn: string | undefined; +export const CustomSourceType = { + IN_LINE: "IN_LINE", + S3_LOCATION: "S3_LOCATION", +} as const; + +/** + * @public + */ +export type CustomSourceType = (typeof CustomSourceType)[keyof typeof CustomSourceType]; +/** + *Contains information about the content to ingest into a knowledge base connected to a custom data source. Choose a sourceType and include the field that corresponds to it.
The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that is linked to your Amazon RDS database.
+ *A unique identifier for the document.
* @public */ - credentialsSecretArn: string | undefined; + customDocumentIdentifier: CustomDocumentIdentifier | undefined; /** - *The name of your Amazon RDS database.
+ *The source of the data to ingest.
* @public */ - databaseName: string | undefined; + sourceType: CustomSourceType | undefined; /** - *The name of the table in the database.
+ *Contains information about the Amazon S3 location of the file from which to ingest data.
* @public */ - tableName: string | undefined; + s3Location?: CustomS3Location | undefined; /** - *Contains the names of the fields to which to map information about the vector store.
+ *Contains information about content defined inline to ingest into a knowledge base.
* @public */ - fieldMapping: RdsFieldMapping | undefined; + inlineContent?: InlineContent | undefined; } /** - *Contains the names of the fields to which to map information about the vector store.
+ *Contains information about the content to ingest into a knowledge base connected to an Amazon S3 data source.
* @public */ -export interface RedisEnterpriseCloudFieldMapping { - /** - *The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
- * @public - */ - vectorField: string | undefined; - - /** - *The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
- * @public - */ - textField: string | undefined; - +export interface S3Content { /** - *The name of the field in which Amazon Bedrock stores metadata about the vector store.
+ *The S3 location of the file containing the content to ingest.
* @public */ - metadataField: string | undefined; + s3Location: S3Location | undefined; } /** - *Contains details about the storage configuration of the knowledge base in Redis Enterprise Cloud. For more information, see Create a vector index in Redis Enterprise Cloud.
+ *Contains information about the content of a document. Choose a dataSourceType and include the field that corresponds to it.
The endpoint URL of the Redis Enterprise Cloud database.
+ *The type of data source that is connected to the knowledge base to which to ingest this document.
* @public */ - endpoint: string | undefined; + dataSourceType: ContentDataSourceType | undefined; /** - *The name of the vector index.
+ *Contains information about the content to ingest into a knowledge base connected to a custom data source.
* @public */ - vectorIndexName: string | undefined; + custom?: CustomContent | undefined; /** - *The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that is linked to your Redis Enterprise Cloud database.
+ *Contains information about the content to ingest into a knowledge base connected to an Amazon S3 data source
* @public */ - credentialsSecretArn: string | undefined; - - /** - *Contains the names of the fields to which to map information about the vector store.
- * @public - */ - fieldMapping: RedisEnterpriseCloudFieldMapping | undefined; + s3?: S3Content | undefined; } /** * @public * @enum */ -export const KnowledgeBaseStorageType = { - MONGO_DB_ATLAS: "MONGO_DB_ATLAS", - OPENSEARCH_SERVERLESS: "OPENSEARCH_SERVERLESS", - PINECONE: "PINECONE", - RDS: "RDS", - REDIS_ENTERPRISE_CLOUD: "REDIS_ENTERPRISE_CLOUD", +export const MetadataValueType = { + BOOLEAN: "BOOLEAN", + NUMBER: "NUMBER", + STRING: "STRING", + STRING_LIST: "STRING_LIST", } as const; /** * @public */ -export type KnowledgeBaseStorageType = (typeof KnowledgeBaseStorageType)[keyof typeof KnowledgeBaseStorageType]; +export type MetadataValueType = (typeof MetadataValueType)[keyof typeof MetadataValueType]; /** - *Contains the storage configuration of the knowledge base.
+ *Contains the value of the metadata attribute. Choose a type and include the field that corresponds to it.
The vector store service in which the knowledge base is stored.
+ *The type of the metadata attribute.
* @public */ - type: KnowledgeBaseStorageType | undefined; + type: MetadataValueType | undefined; /** - *Contains the storage configuration of the knowledge base in Amazon OpenSearch Service.
+ *The value of the numeric metadata attribute.
* @public */ - opensearchServerlessConfiguration?: OpenSearchServerlessConfiguration | undefined; + numberValue?: number | undefined; /** - *Contains the storage configuration of the knowledge base in Pinecone.
+ *The value of the Boolean metadata attribute.
* @public */ - pineconeConfiguration?: PineconeConfiguration | undefined; + booleanValue?: boolean | undefined; /** - *Contains the storage configuration of the knowledge base in Redis Enterprise Cloud.
+ *The value of the string metadata attribute.
* @public */ - redisEnterpriseCloudConfiguration?: RedisEnterpriseCloudConfiguration | undefined; + stringValue?: string | undefined; /** - *Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see Create a vector index in Amazon RDS.
+ *An array of strings that define the value of the metadata attribute.
* @public */ - rdsConfiguration?: RdsConfiguration | undefined; - - /** - *Contains the storage configuration of the knowledge base in MongoDB Atlas.
- * @public - */ - mongoDbAtlasConfiguration?: MongoDbAtlasConfiguration | undefined; + stringListValue?: string[] | undefined; } /** + *Contains information about a metadata attribute.
* @public */ -export interface CreateKnowledgeBaseRequest { - /** - *A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, - * Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
- * @public - */ - clientToken?: string | undefined; - +export interface MetadataAttribute { /** - *A name for the knowledge base.
+ *The key of the metadata attribute.
* @public */ - name: string | undefined; + key: string | undefined; /** - *A description of the knowledge base.
+ *Contains the value of the metadata attribute.
* @public */ - description?: string | undefined; - - /** - *The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.
- * @public - */ - roleArn: string | undefined; - - /** - *Contains details about the embeddings model used for the knowledge base.
- * @public - */ - knowledgeBaseConfiguration: KnowledgeBaseConfiguration | undefined; - - /** - *Contains details about the configuration of the vector database used for the knowledge base.
- * @public - */ - storageConfiguration: StorageConfiguration | undefined; - - /** - *Specify the key-value pairs for the tags that you want to attach to your knowledge base in this object.
- * @public - */ - tags?: RecordContains information about a knowledge base.
+ *Contains information about the metadata associate with the content to ingest into a knowledge base. Choose a type and include the field that corresponds to it.
The unique identifier of the knowledge base.
+ *The type of the source source from which to add metadata.
* @public */ - knowledgeBaseId: string | undefined; + type: MetadataSourceType | undefined; /** - *The name of the knowledge base.
+ *An array of objects, each of which defines a metadata attribute to associate with the content to ingest. You define the attributes inline.
* @public */ - name: string | undefined; - - /** - *The Amazon Resource Name (ARN) of the knowledge base.
- * @public - */ - knowledgeBaseArn: string | undefined; + inlineAttributes?: MetadataAttribute[] | undefined; /** - *The description of the knowledge base.
+ *The Amazon S3 location of the file containing metadata to associate with the content to ingest.
* @public */ - description?: string | undefined; - - /** - *The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.
- * @public - */ - roleArn: string | undefined; + s3Location?: CustomS3Location | undefined; +} +/** + *Contains information about a document to ingest into a knowledge base and metadata to associate with it.
+ * @public + */ +export interface KnowledgeBaseDocument { /** - *Contains details about the embeddings configuration of the knowledge base.
+ *Contains the metadata to associate with the document.
* @public */ - knowledgeBaseConfiguration: KnowledgeBaseConfiguration | undefined; + metadata?: DocumentMetadata | undefined; /** - *Contains details about the storage configuration of the knowledge base.
+ *Contains the content of the document.
* @public */ - storageConfiguration: StorageConfiguration | undefined; + content: DocumentContent | undefined; +} +/** + * @public + */ +export interface IngestKnowledgeBaseDocumentsRequest { /** - *The status of the knowledge base. The following statuses are possible:
- *CREATING – The knowledge base is being created.
- *ACTIVE – The knowledge base is ready to be queried.
- *DELETING – The knowledge base is being deleted.
- *UPDATING – The knowledge base is being updated.
- *FAILED – The knowledge base API operation failed.
- *The unique identifier of the knowledge base to ingest the documents into.
* @public */ - status: KnowledgeBaseStatus | undefined; + knowledgeBaseId: string | undefined; /** - *The time the knowledge base was created.
+ *The unique identifier of the data source connected to the knowledge base that you're adding documents to.
* @public */ - createdAt: Date | undefined; + dataSourceId: string | undefined; /** - *The time the knowledge base was last updated.
+ *A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, + * Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
* @public */ - updatedAt: Date | undefined; + clientToken?: string | undefined; /** - *A list of reasons that the API operation on the knowledge base failed.
+ *A list of objects, each of which contains information about the documents to add.
* @public */ - failureReasons?: string[] | undefined; + documents: KnowledgeBaseDocument[] | undefined; } /** * @public */ -export interface CreateKnowledgeBaseResponse { +export interface IngestKnowledgeBaseDocumentsResponse { /** - *Contains details about the knowledge base.
+ *A list of objects, each of which contains information about the documents that were ingested.
* @public */ - knowledgeBase: KnowledgeBase | undefined; + documentDetails?: KnowledgeBaseDocumentDetail[] | undefined; } /** * @public */ -export interface DeleteKnowledgeBaseRequest { +export interface ListKnowledgeBaseDocumentsRequest { /** - *The unique identifier of the knowledge base to delete.
+ *The unique identifier of the knowledge base that is connected to the data source.
* @public */ knowledgeBaseId: string | undefined; -} -/** - * @public - */ -export interface DeleteKnowledgeBaseResponse { /** - *The unique identifier of the knowledge base that was deleted.
+ *The unique identifier of the data source that contains the documents.
* @public */ - knowledgeBaseId: string | undefined; + dataSourceId: string | undefined; /** - *The status of the knowledge base and whether it has been successfully deleted.
+ *The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
The unique identifier of the agent from which to disassociate the knowledge base.
+ *If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
The version of the agent from which to disassociate the knowledge base.
+ *A list of objects, each of which contains information about the documents that were retrieved.
* @public */ - agentVersion: string | undefined; + documentDetails: KnowledgeBaseDocumentDetail[] | undefined; /** - *The unique identifier of the knowledge base to disassociate.
+ *If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
The unique identifier of the agent with which you want to associate the knowledge base.
+ * @public + */ + agentId: string | undefined; + + /** + *The version of the agent with which you want to associate the knowledge base.
+ * @public + */ + agentVersion: string | undefined; + + /** + *The unique identifier of the knowledge base to associate with the agent.
+ * @public + */ + knowledgeBaseId: string | undefined; + + /** + *A description of what the agent should use the knowledge base for.
+ * @public + */ + description: string | undefined; + + /** + *Specifies whether to use the knowledge base or not when sending an InvokeAgent request.
+ * @public + */ + knowledgeBaseState?: KnowledgeBaseState | undefined; +} + +/** + * @public + */ +export interface AssociateAgentKnowledgeBaseResponse { + /** + *Contains details about the knowledge base that has been associated with the agent.
+ * @public + */ + agentKnowledgeBase: AgentKnowledgeBase | undefined; +} + +/** + * @public + * @enum + */ +export const KnowledgeBaseType = { + VECTOR: "VECTOR", +} as const; + +/** + * @public + */ +export type KnowledgeBaseType = (typeof KnowledgeBaseType)[keyof typeof KnowledgeBaseType]; + +/** + * @public + * @enum + */ +export const EmbeddingDataType = { + BINARY: "BINARY", + FLOAT32: "FLOAT32", +} as const; + +/** + * @public + */ +export type EmbeddingDataType = (typeof EmbeddingDataType)[keyof typeof EmbeddingDataType]; + +/** + *The vector configuration details for the Bedrock embeddings model.
+ * @public + */ +export interface BedrockEmbeddingModelConfiguration { + /** + *The dimensions details for the vector configuration used on the Bedrock embeddings model.
+ * @public + */ + dimensions?: number | undefined; + + /** + *The data type for the vectors when using a model to convert text into vector + * embeddings. The model must support the specified data type for vector embeddings. + * Floating-point (float32) is the default data type, and is supported by most models + * for vector embeddings. See Supported embeddings + * models for information on the available models and their vector data types.
+ * @public + */ + embeddingDataType?: EmbeddingDataType | undefined; +} + +/** + *The configuration details for the embeddings model.
+ * @public + */ +export interface EmbeddingModelConfiguration { + /** + *The vector configuration details on the Bedrock embeddings model.
+ * @public + */ + bedrockEmbeddingModelConfiguration?: BedrockEmbeddingModelConfiguration | undefined; +} + +/** + *Contains details about the model used to create vector embeddings for the knowledge base.
+ * @public + */ +export interface VectorKnowledgeBaseConfiguration { + /** + *The Amazon Resource Name (ARN) of the model or inference profile used to create vector embeddings for the knowledge base.
+ * @public + */ + embeddingModelArn: string | undefined; + + /** + *The embeddings model configuration details for the vector model used in Knowledge Base.
+ * @public + */ + embeddingModelConfiguration?: EmbeddingModelConfiguration | undefined; +} + +/** + *Contains details about the vector embeddings configuration of the knowledge base.
+ * @public + */ +export interface KnowledgeBaseConfiguration { + /** + *The type of data that the data source is converted into for the knowledge base.
+ * @public + */ + type: KnowledgeBaseType | undefined; + + /** + *Contains details about the model that's used to convert the data source into vector embeddings.
+ * @public + */ + vectorKnowledgeBaseConfiguration?: VectorKnowledgeBaseConfiguration | undefined; +} + +/** + *Contains the names of the fields to which to map information about the vector store.
+ * @public + */ +export interface MongoDbAtlasFieldMapping { + /** + *The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
+ * @public + */ + vectorField: string | undefined; + + /** + *The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
+ * @public + */ + textField: string | undefined; + + /** + *The name of the field in which Amazon Bedrock stores metadata about the vector store.
+ * @public + */ + metadataField: string | undefined; +} + +/** + *Contains details about the storage configuration of the knowledge base in MongoDB Atlas.
+ * @public + */ +export interface MongoDbAtlasConfiguration { + /** + *The endpoint URL of your MongoDB Atlas cluster for your knowledge base.
+ * @public + */ + endpoint: string | undefined; + + /** + *The database name in your MongoDB Atlas cluster for your knowledge base.
+ * @public + */ + databaseName: string | undefined; + + /** + *The collection name of the knowledge base in MongoDB Atlas.
+ * @public + */ + collectionName: string | undefined; + + /** + *The name of the MongoDB Atlas vector search index.
+ * @public + */ + vectorIndexName: string | undefined; + + /** + *The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that contains user credentials for your MongoDB Atlas cluster.
+ * @public + */ + credentialsSecretArn: string | undefined; + + /** + *Contains the names of the fields to which to map information about the vector store.
+ * @public + */ + fieldMapping: MongoDbAtlasFieldMapping | undefined; + + /** + *The name of the VPC endpoint service in your account that is connected to your MongoDB Atlas cluster.
+ * @public + */ + endpointServiceName?: string | undefined; +} + +/** + *Contains the names of the fields to which to map information about the vector store.
+ * @public + */ +export interface OpenSearchServerlessFieldMapping { + /** + *The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
+ * @public + */ + vectorField: string | undefined; + + /** + *The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
+ * @public + */ + textField: string | undefined; + + /** + *The name of the field in which Amazon Bedrock stores metadata about the vector store.
+ * @public + */ + metadataField: string | undefined; +} + +/** + *Contains details about the storage configuration of the knowledge base in Amazon OpenSearch Service. For more information, see Create a vector index in Amazon OpenSearch Service.
+ * @public + */ +export interface OpenSearchServerlessConfiguration { + /** + *The Amazon Resource Name (ARN) of the OpenSearch Service vector store.
+ * @public + */ + collectionArn: string | undefined; + + /** + *The name of the vector store.
+ * @public + */ + vectorIndexName: string | undefined; + + /** + *Contains the names of the fields to which to map information about the vector store.
+ * @public + */ + fieldMapping: OpenSearchServerlessFieldMapping | undefined; +} + +/** + *Contains the names of the fields to which to map information about the vector store.
+ * @public + */ +export interface PineconeFieldMapping { + /** + *The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
+ * @public + */ + textField: string | undefined; + + /** + *The name of the field in which Amazon Bedrock stores metadata about the vector store.
+ * @public + */ + metadataField: string | undefined; +} + +/** + *Contains details about the storage configuration of the knowledge base in Pinecone. For more information, see Create a vector index in Pinecone.
+ * @public + */ +export interface PineconeConfiguration { + /** + *The endpoint URL for your index management page.
+ * @public + */ + connectionString: string | undefined; + + /** + *The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that is linked to your Pinecone API key.
+ * @public + */ + credentialsSecretArn: string | undefined; + + /** + *The namespace to be used to write new data to your database.
+ * @public + */ + namespace?: string | undefined; + + /** + *Contains the names of the fields to which to map information about the vector store.
+ * @public + */ + fieldMapping: PineconeFieldMapping | undefined; +} + +/** + *Contains the names of the fields to which to map information about the vector store.
+ * @public + */ +export interface RdsFieldMapping { + /** + *The name of the field in which Amazon Bedrock stores the ID for each entry.
+ * @public + */ + primaryKeyField: string | undefined; + + /** + *The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
+ * @public + */ + vectorField: string | undefined; + + /** + *The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
+ * @public + */ + textField: string | undefined; + + /** + *The name of the field in which Amazon Bedrock stores metadata about the vector store.
+ * @public + */ + metadataField: string | undefined; +} + +/** + *Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see Create a vector index in Amazon RDS.
+ * @public + */ +export interface RdsConfiguration { + /** + *The Amazon Resource Name (ARN) of the vector store.
+ * @public + */ + resourceArn: string | undefined; + + /** + *The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that is linked to your Amazon RDS database.
+ * @public + */ + credentialsSecretArn: string | undefined; + + /** + *The name of your Amazon RDS database.
+ * @public + */ + databaseName: string | undefined; + + /** + *The name of the table in the database.
+ * @public + */ + tableName: string | undefined; + + /** + *Contains the names of the fields to which to map information about the vector store.
+ * @public + */ + fieldMapping: RdsFieldMapping | undefined; +} + +/** + *Contains the names of the fields to which to map information about the vector store.
+ * @public + */ +export interface RedisEnterpriseCloudFieldMapping { + /** + *The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
+ * @public + */ + vectorField: string | undefined; + + /** + *The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
+ * @public + */ + textField: string | undefined; + + /** + *The name of the field in which Amazon Bedrock stores metadata about the vector store.
+ * @public + */ + metadataField: string | undefined; +} + +/** + *Contains details about the storage configuration of the knowledge base in Redis Enterprise Cloud. For more information, see Create a vector index in Redis Enterprise Cloud.
+ * @public + */ +export interface RedisEnterpriseCloudConfiguration { + /** + *The endpoint URL of the Redis Enterprise Cloud database.
+ * @public + */ + endpoint: string | undefined; + + /** + *The name of the vector index.
+ * @public + */ + vectorIndexName: string | undefined; + + /** + *The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that is linked to your Redis Enterprise Cloud database.
+ * @public + */ + credentialsSecretArn: string | undefined; + + /** + *Contains the names of the fields to which to map information about the vector store.
+ * @public + */ + fieldMapping: RedisEnterpriseCloudFieldMapping | undefined; +} + +/** + * @public + * @enum + */ +export const KnowledgeBaseStorageType = { + MONGO_DB_ATLAS: "MONGO_DB_ATLAS", + OPENSEARCH_SERVERLESS: "OPENSEARCH_SERVERLESS", + PINECONE: "PINECONE", + RDS: "RDS", + REDIS_ENTERPRISE_CLOUD: "REDIS_ENTERPRISE_CLOUD", +} as const; + +/** + * @public + */ +export type KnowledgeBaseStorageType = (typeof KnowledgeBaseStorageType)[keyof typeof KnowledgeBaseStorageType]; + +/** + *Contains the storage configuration of the knowledge base.
+ * @public + */ +export interface StorageConfiguration { + /** + *The vector store service in which the knowledge base is stored.
+ * @public + */ + type: KnowledgeBaseStorageType | undefined; + + /** + *Contains the storage configuration of the knowledge base in Amazon OpenSearch Service.
+ * @public + */ + opensearchServerlessConfiguration?: OpenSearchServerlessConfiguration | undefined; + + /** + *Contains the storage configuration of the knowledge base in Pinecone.
+ * @public + */ + pineconeConfiguration?: PineconeConfiguration | undefined; + + /** + *Contains the storage configuration of the knowledge base in Redis Enterprise Cloud.
+ * @public + */ + redisEnterpriseCloudConfiguration?: RedisEnterpriseCloudConfiguration | undefined; + + /** + *Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see Create a vector index in Amazon RDS.
+ * @public + */ + rdsConfiguration?: RdsConfiguration | undefined; + + /** + *Contains the storage configuration of the knowledge base in MongoDB Atlas.
+ * @public + */ + mongoDbAtlasConfiguration?: MongoDbAtlasConfiguration | undefined; +} + +/** + * @public + */ +export interface CreateKnowledgeBaseRequest { + /** + *A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, + * Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
+ * @public + */ + clientToken?: string | undefined; + + /** + *A name for the knowledge base.
+ * @public + */ + name: string | undefined; + + /** + *A description of the knowledge base.
+ * @public + */ + description?: string | undefined; + + /** + *The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.
+ * @public + */ + roleArn: string | undefined; + + /** + *Contains details about the embeddings model used for the knowledge base.
+ * @public + */ + knowledgeBaseConfiguration: KnowledgeBaseConfiguration | undefined; + + /** + *Contains details about the configuration of the vector database used for the knowledge base.
+ * @public + */ + storageConfiguration: StorageConfiguration | undefined; + + /** + *Specify the key-value pairs for the tags that you want to attach to your knowledge base in this object.
+ * @public + */ + tags?: RecordContains information about a knowledge base.
+ * @public + */ +export interface KnowledgeBase { + /** + *The unique identifier of the knowledge base.
+ * @public + */ + knowledgeBaseId: string | undefined; + + /** + *The name of the knowledge base.
+ * @public + */ + name: string | undefined; + + /** + *The Amazon Resource Name (ARN) of the knowledge base.
+ * @public + */ + knowledgeBaseArn: string | undefined; + + /** + *The description of the knowledge base.
+ * @public + */ + description?: string | undefined; + + /** + *The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.
+ * @public + */ + roleArn: string | undefined; + + /** + *Contains details about the embeddings configuration of the knowledge base.
+ * @public + */ + knowledgeBaseConfiguration: KnowledgeBaseConfiguration | undefined; + + /** + *Contains details about the storage configuration of the knowledge base.
+ * @public + */ + storageConfiguration: StorageConfiguration | undefined; + + /** + *The status of the knowledge base. The following statuses are possible:
+ *CREATING – The knowledge base is being created.
+ *ACTIVE – The knowledge base is ready to be queried.
+ *DELETING – The knowledge base is being deleted.
+ *UPDATING – The knowledge base is being updated.
+ *FAILED – The knowledge base API operation failed.
+ *The time the knowledge base was created.
+ * @public + */ + createdAt: Date | undefined; + + /** + *The time the knowledge base was last updated.
+ * @public + */ + updatedAt: Date | undefined; + + /** + *A list of reasons that the API operation on the knowledge base failed.
+ * @public + */ + failureReasons?: string[] | undefined; +} + +/** + * @public + */ +export interface CreateKnowledgeBaseResponse { + /** + *Contains details about the knowledge base.
+ * @public + */ + knowledgeBase: KnowledgeBase | undefined; +} + +/** + * @public + */ +export interface DeleteKnowledgeBaseRequest { + /** + *The unique identifier of the knowledge base to delete.
+ * @public + */ + knowledgeBaseId: string | undefined; +} + +/** + * @public + */ +export interface DeleteKnowledgeBaseResponse { + /** + *The unique identifier of the knowledge base that was deleted.
+ * @public + */ + knowledgeBaseId: string | undefined; + + /** + *The status of the knowledge base and whether it has been successfully deleted.
+ * @public + */ + status: KnowledgeBaseStatus | undefined; +} + +/** + * @public + */ +export interface DisassociateAgentKnowledgeBaseRequest { + /** + *The unique identifier of the agent from which to disassociate the knowledge base.
+ * @public + */ + agentId: string | undefined; + + /** + *The version of the agent from which to disassociate the knowledge base.
+ * @public + */ + agentVersion: string | undefined; + + /** + *The unique identifier of the knowledge base to disassociate.
+ * @public + */ + knowledgeBaseId: string | undefined; +} + +/** + * @public + */ +export interface DisassociateAgentKnowledgeBaseResponse {} + /** * @public */ diff --git a/clients/client-bedrock-agent/src/pagination/ListKnowledgeBaseDocumentsPaginator.ts b/clients/client-bedrock-agent/src/pagination/ListKnowledgeBaseDocumentsPaginator.ts new file mode 100644 index 0000000000000..d5a1ab5b8e279 --- /dev/null +++ b/clients/client-bedrock-agent/src/pagination/ListKnowledgeBaseDocumentsPaginator.ts @@ -0,0 +1,24 @@ +// smithy-typescript generated code +import { createPaginator } from "@smithy/core"; +import { Paginator } from "@smithy/types"; + +import { BedrockAgentClient } from "../BedrockAgentClient"; +import { + ListKnowledgeBaseDocumentsCommand, + ListKnowledgeBaseDocumentsCommandInput, + ListKnowledgeBaseDocumentsCommandOutput, +} from "../commands/ListKnowledgeBaseDocumentsCommand"; +import { BedrockAgentPaginationConfiguration } from "./Interfaces"; + +/** + * @public + */ +export const paginateListKnowledgeBaseDocuments: ( + config: BedrockAgentPaginationConfiguration, + input: ListKnowledgeBaseDocumentsCommandInput, + ...rest: any[] +) => PaginatorThe MIME type of the content. For a list of MIME types, see Media Types. The following MIME types are supported:
\ntext/plain
\ntext/html
\ntext/csv
\ntext/vtt
\nmessage/rfc822
\napplication/xhtml+xml
\napplication/pdf
\napplication/msword
\napplication/vnd.ms-word.document.macroenabled.12
\napplication/vnd.ms-word.template.macroenabled.12
\napplication/vnd.ms-excel
\napplication/vnd.ms-excel.addin.macroenabled.12
\napplication/vnd.ms-excel.sheet.macroenabled.12
\napplication/vnd.ms-excel.template.macroenabled.12
\napplication/vnd.ms-excel.sheet.binary.macroenabled.12
\napplication/vnd.ms-spreadsheetml
\napplication/vnd.openxmlformats-officedocument.spreadsheetml.sheet
\napplication/vnd.openxmlformats-officedocument.spreadsheetml.template
\napplication/vnd.openxmlformats-officedocument.wordprocessingml.document
\napplication/vnd.openxmlformats-officedocument.wordprocessingml.template
\nThe base64-encoded string of the content.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about content defined inline in bytes.
" + } + }, "com.amazonaws.bedrockagent#ChatPromptTemplateConfiguration": { "type": "structure", "members": { @@ -2364,6 +2400,23 @@ "target": "com.amazonaws.bedrockagent#ContentBlock" } }, + "com.amazonaws.bedrockagent#ContentDataSourceType": { + "type": "enum", + "members": { + "CUSTOM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOM" + } + }, + "S3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3" + } + } + } + }, "com.amazonaws.bedrockagent#ConversationRole": { "type": "enum", "members": { @@ -2829,7 +2882,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a data source connector for a knowledge base.
\nYou can't change the chunkingConfiguration after you create the data source connector.
Connects a knowledge base to a data source. You specify the configuration for the specific data source service in the dataSourceConfiguration field.
You can't change the chunkingConfiguration after you create the data source connector.
A unique identifier for the document.
", + "smithy.api#required": {} + } + }, + "sourceType": { + "target": "com.amazonaws.bedrockagent#CustomSourceType", + "traits": { + "smithy.api#documentation": "The source of the data to ingest.
", + "smithy.api#required": {} + } + }, + "s3Location": { + "target": "com.amazonaws.bedrockagent#CustomS3Location", + "traits": { + "smithy.api#documentation": "Contains information about the Amazon S3 location of the file from which to ingest data.
" + } + }, + "inlineContent": { + "target": "com.amazonaws.bedrockagent#InlineContent", + "traits": { + "smithy.api#documentation": "Contains information about content defined inline to ingest into a knowledge base.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the content to ingest into a knowledge base connected to a custom data source. Choose a sourceType and include the field that corresponds to it.
The identifier of the document to ingest into a custom data source.
", + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the identifier of the document to ingest into a custom data source.
" + } + }, "com.amazonaws.bedrockagent#CustomOrchestration": { "type": "structure", "members": { @@ -3860,6 +3966,44 @@ "smithy.api#documentation": "\n Details of custom orchestration.\n
" } }, + "com.amazonaws.bedrockagent#CustomS3Location": { + "type": "structure", + "members": { + "uri": { + "target": "com.amazonaws.bedrockagent#S3ObjectUri", + "traits": { + "smithy.api#documentation": "The S3 URI of the file containing the content to ingest.
", + "smithy.api#required": {} + } + }, + "bucketOwnerAccountId": { + "target": "com.amazonaws.bedrockagent#BucketOwnerAccountId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon Web Services account that owns the S3 bucket containing the content to ingest.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the Amazon S3 location of the file containing the content to ingest into a knowledge base connected to a custom data source.
" + } + }, + "com.amazonaws.bedrockagent#CustomSourceType": { + "type": "enum", + "members": { + "IN_LINE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_LINE" + } + }, + "S3_LOCATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3_LOCATION" + } + } + } + }, "com.amazonaws.bedrockagent#CustomTransformationConfiguration": { "type": "structure", "members": { @@ -3897,6 +4041,16 @@ "smithy.api#documentation": "Details about a cyclic connection detected in the flow.
" } }, + "com.amazonaws.bedrockagent#Data": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5242880 + }, + "smithy.api#sensitive": {} + } + }, "com.amazonaws.bedrockagent#DataDeletionPolicy": { "type": "enum", "members": { @@ -4176,6 +4330,12 @@ "traits": { "smithy.api#enumValue": "SHAREPOINT" } + }, + "CUSTOM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOM" + } } } }, @@ -4932,6 +5092,97 @@ "smithy.api#tags": ["console"] } }, + "com.amazonaws.bedrockagent#DeleteKnowledgeBaseDocuments": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#DeleteKnowledgeBaseDocumentsRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#DeleteKnowledgeBaseDocumentsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes documents from a data source and syncs the changes to the knowledge base that is connected to it. For more information, see Ingest documents into a knowledge base in real-time in the Amazon Bedrock User Guide.
", + "smithy.api#http": { + "code": 202, + "method": "POST", + "uri": "/knowledgebases/{knowledgeBaseId}/datasources/{dataSourceId}/documents/deleteDocuments" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": ["console"] + } + }, + "com.amazonaws.bedrockagent#DeleteKnowledgeBaseDocumentsRequest": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the knowledge base that is connected to the data source.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "dataSourceId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the data source that contains the documents.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagent#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
", + "smithy.api#idempotencyToken": {} + } + }, + "documentIdentifiers": { + "target": "com.amazonaws.bedrockagent#DocumentIdentifiers", + "traits": { + "smithy.api#documentation": "A list of objects, each of which contains information to identify a document to delete.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#DeleteKnowledgeBaseDocumentsResponse": { + "type": "structure", + "members": { + "documentDetails": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseDocumentDetails", + "traits": { + "smithy.api#documentation": "A list of objects, each of which contains information about the documents that were deleted.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.bedrockagent#DeleteKnowledgeBaseRequest": { "type": "structure", "members": { @@ -5149,78 +5400,249 @@ "smithy.api#output": {} } }, - "com.amazonaws.bedrockagent#DraftVersion": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 5, - "max": 5 - }, - "smithy.api#pattern": "^DRAFT$" - } - }, - "com.amazonaws.bedrockagent#DuplicateConditionExpressionFlowValidationDetails": { + "com.amazonaws.bedrockagent#DocumentContent": { "type": "structure", "members": { - "node": { - "target": "com.amazonaws.bedrockagent#FlowNodeName", + "dataSourceType": { + "target": "com.amazonaws.bedrockagent#ContentDataSourceType", "traits": { - "smithy.api#documentation": "The name of the node containing the duplicate condition expressions.
", + "smithy.api#documentation": "The type of data source that is connected to the knowledge base to which to ingest this document.
", "smithy.api#required": {} } }, - "expression": { - "target": "com.amazonaws.bedrockagent#FlowConditionExpression", + "custom": { + "target": "com.amazonaws.bedrockagent#CustomContent", "traits": { - "smithy.api#documentation": "The duplicated condition expression.
", - "smithy.api#required": {} + "smithy.api#documentation": "Contains information about the content to ingest into a knowledge base connected to a custom data source.
" + } + }, + "s3": { + "target": "com.amazonaws.bedrockagent#S3Content", + "traits": { + "smithy.api#documentation": "Contains information about the content to ingest into a knowledge base connected to an Amazon S3 data source
" } } }, "traits": { - "smithy.api#documentation": "Details about duplicate condition expressions found in a condition node.
" + "smithy.api#documentation": "Contains information about the content of a document. Choose a dataSourceType and include the field that corresponds to it.
The name of the source node where the duplicate connection starts.
", + "smithy.api#documentation": "The type of data source connected to the knowledge base that contains the document.
", "smithy.api#required": {} } }, - "target": { - "target": "com.amazonaws.bedrockagent#FlowNodeName", + "s3": { + "target": "com.amazonaws.bedrockagent#S3Location", "traits": { - "smithy.api#documentation": "The name of the target node where the duplicate connection ends.
", - "smithy.api#required": {} + "smithy.api#documentation": "Contains information that identifies the document in an S3 data source.
" + } + }, + "custom": { + "target": "com.amazonaws.bedrockagent#CustomDocumentIdentifier", + "traits": { + "smithy.api#documentation": "Contains information that identifies the document in a custom data source.
" } } }, "traits": { - "smithy.api#documentation": "Details about duplicate connections found between two nodes in the flow.
" + "smithy.api#documentation": "Contains information that identifies the document.
" } }, - "com.amazonaws.bedrockagent#EmbeddingDataType": { - "type": "enum", + "com.amazonaws.bedrockagent#DocumentIdentifiers": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#DocumentIdentifier" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.bedrockagent#DocumentMetadata": { + "type": "structure", "members": { - "FLOAT32": { - "target": "smithy.api#Unit", + "type": { + "target": "com.amazonaws.bedrockagent#MetadataSourceType", "traits": { - "smithy.api#enumValue": "FLOAT32" + "smithy.api#documentation": "The type of the source source from which to add metadata.
", + "smithy.api#required": {} } }, - "BINARY": { - "target": "smithy.api#Unit", + "inlineAttributes": { + "target": "com.amazonaws.bedrockagent#MetadataAttributes", "traits": { - "smithy.api#enumValue": "BINARY" + "smithy.api#documentation": "An array of objects, each of which defines a metadata attribute to associate with the content to ingest. You define the attributes inline.
", + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "s3Location": { + "target": "com.amazonaws.bedrockagent#CustomS3Location", + "traits": { + "smithy.api#documentation": "The Amazon S3 location of the file containing metadata to associate with the content to ingest.
" } } }, "traits": { - "smithy.api#documentation": "Bedrock models embedding data type. Can be either float32 or binary" + "smithy.api#documentation": "Contains information about the metadata associate with the content to ingest into a knowledge base. Choose a type and include the field that corresponds to it.
The name of the node containing the duplicate condition expressions.
", + "smithy.api#required": {} + } + }, + "expression": { + "target": "com.amazonaws.bedrockagent#FlowConditionExpression", + "traits": { + "smithy.api#documentation": "The duplicated condition expression.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Details about duplicate condition expressions found in a condition node.
" + } + }, + "com.amazonaws.bedrockagent#DuplicateConnectionsFlowValidationDetails": { + "type": "structure", + "members": { + "source": { + "target": "com.amazonaws.bedrockagent#FlowNodeName", + "traits": { + "smithy.api#documentation": "The name of the source node where the duplicate connection starts.
", + "smithy.api#required": {} + } + }, + "target": { + "target": "com.amazonaws.bedrockagent#FlowNodeName", + "traits": { + "smithy.api#documentation": "The name of the target node where the duplicate connection ends.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Details about duplicate connections found between two nodes in the flow.
" + } + }, + "com.amazonaws.bedrockagent#EmbeddingDataType": { + "type": "enum", + "members": { + "FLOAT32": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FLOAT32" + } + }, + "BINARY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BINARY" + } + } } }, "com.amazonaws.bedrockagent#EmbeddingModelConfiguration": { @@ -7726,6 +8148,90 @@ "smithy.api#tags": ["console"] } }, + "com.amazonaws.bedrockagent#GetKnowledgeBaseDocuments": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#GetKnowledgeBaseDocumentsRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#GetKnowledgeBaseDocumentsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves specific documents from a data source that is connected to a knowledge base. For more information, see Ingest documents into a knowledge base in real-time in the Amazon Bedrock User Guide.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/knowledgebases/{knowledgeBaseId}/datasources/{dataSourceId}/documents/getDocuments" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": ["console"] + } + }, + "com.amazonaws.bedrockagent#GetKnowledgeBaseDocumentsRequest": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the knowledge base that is connected to the data source.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "dataSourceId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the data source that contains the documents.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "documentIdentifiers": { + "target": "com.amazonaws.bedrockagent#DocumentIdentifiers", + "traits": { + "smithy.api#documentation": "A list of objects, each of which contains information to identify a document for which to retrieve information.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#GetKnowledgeBaseDocumentsResponse": { + "type": "structure", + "members": { + "documentDetails": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseDocumentDetails", + "traits": { + "smithy.api#documentation": "A list of objects, each of which contains information about the documents that were retrieved.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.bedrockagent#GetKnowledgeBaseRequest": { "type": "structure", "members": { @@ -8046,6 +8552,97 @@ "smithy.api#documentation": "Contains inference parameters to use when the agent invokes a foundation model in the part of the agent sequence defined by the promptType. For more information, see Inference parameters for foundation models.
Ingests documents directly into the knowledge base that is connected to the data source. The dataSourceType 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 Ingest documents into a knowledge base in real-time in the Amazon Bedrock User Guide.
The unique identifier of the knowledge base to ingest the documents into.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "dataSourceId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the data source connected to the knowledge base that you're adding documents to.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.bedrockagent#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
", + "smithy.api#idempotencyToken": {} + } + }, + "documents": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseDocuments", + "traits": { + "smithy.api#documentation": "A list of objects, each of which contains information about the documents to add.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bedrockagent#IngestKnowledgeBaseDocumentsResponse": { + "type": "structure", + "members": { + "documentDetails": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseDocumentDetails", + "traits": { + "smithy.api#documentation": "A list of objects, each of which contains information about the documents that were ingested.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.bedrockagent#IngestionJob": { "type": "structure", "members": { @@ -8421,6 +9018,50 @@ "smithy.api#documentation": "Contains details about a data ingestion job.
" } }, + "com.amazonaws.bedrockagent#InlineContent": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrockagent#InlineContentType", + "traits": { + "smithy.api#documentation": "The type of inline content to define.
", + "smithy.api#required": {} + } + }, + "byteContent": { + "target": "com.amazonaws.bedrockagent#ByteContentDoc", + "traits": { + "smithy.api#documentation": "Contains information about content defined inline in bytes.
" + } + }, + "textContent": { + "target": "com.amazonaws.bedrockagent#TextContentDoc", + "traits": { + "smithy.api#documentation": "Contains information about content defined inline in text.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about content defined inline to ingest into a data source. Choose a type and include the field that corresponds to it.
Contains configurations for an iterator node in a flow. Takes an input that is an array and iteratively sends each item of the array as an output to the following node. The size of the array is also returned in the output.
\nThe output flow node at the end of the flow iteration will return a response for each member of the array. To return only one response, you can include a collector node downstream from the iterator node.
" } }, + "com.amazonaws.bedrockagent#Key": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#sensitive": {} + } + }, "com.amazonaws.bedrockagent#KmsKeyArn": { "type": "string", "traits": { @@ -8581,19 +9232,123 @@ "type": { "target": "com.amazonaws.bedrockagent#KnowledgeBaseType", "traits": { - "smithy.api#documentation": "The type of data that the data source is converted into for the knowledge base.
", + "smithy.api#documentation": "The type of data that the data source is converted into for the knowledge base.
", + "smithy.api#required": {} + } + }, + "vectorKnowledgeBaseConfiguration": { + "target": "com.amazonaws.bedrockagent#VectorKnowledgeBaseConfiguration", + "traits": { + "smithy.api#documentation": "Contains details about the model that's used to convert the data source into vector embeddings.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about the vector embeddings configuration of the knowledge base.
" + } + }, + "com.amazonaws.bedrockagent#KnowledgeBaseDocument": { + "type": "structure", + "members": { + "metadata": { + "target": "com.amazonaws.bedrockagent#DocumentMetadata", + "traits": { + "smithy.api#documentation": "Contains the metadata to associate with the document.
" + } + }, + "content": { + "target": "com.amazonaws.bedrockagent#DocumentContent", + "traits": { + "smithy.api#documentation": "Contains the content of the document.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about a document to ingest into a knowledge base and metadata to associate with it.
" + } + }, + "com.amazonaws.bedrockagent#KnowledgeBaseDocumentDetail": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The identifier of the knowledge base that the document was ingested into or deleted from.
", + "smithy.api#required": {} + } + }, + "dataSourceId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The identifier of the data source connected to the knowledge base that the document was ingested into or deleted from.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.bedrockagent#DocumentStatus", + "traits": { + "smithy.api#documentation": "The ingestion status of the document. The following statuses are possible:
\nSTARTED – You submitted the ingestion job containing the document.
\nPENDING – The document is waiting to be ingested.
\nIN_PROGRESS – The document is being ingested.
\nINDEXED – The document was successfully indexed.
\nPARTIALLY_INDEXED – The document was partially indexed.
\nMETADATA_PARTIALLY_INDEXED – You submitted metadata for an existing document and it was partially indexed.
\nMETADATA_UPDATE_FAILED – You submitted a metadata update for an existing document but it failed.
\nFAILED – The document failed to be ingested.
\nNOT_FOUND – The document wasn't found.
\nIGNORED – The document was ignored during ingestion.
\nDELETING – You submitted the delete job containing the document.
\nDELETE_IN_PROGRESS – The document is being deleted.
\nContains information that identifies the document.
", "smithy.api#required": {} } }, - "vectorKnowledgeBaseConfiguration": { - "target": "com.amazonaws.bedrockagent#VectorKnowledgeBaseConfiguration", + "statusReason": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Contains details about the model that's used to convert the data source into vector embeddings.
" + "smithy.api#documentation": "The reason for the status. Appears alongside the status IGNORED.
The date and time at which the document was last updated.
" } } }, "traits": { - "smithy.api#documentation": "Contains details about the vector embeddings configuration of the knowledge base.
" + "smithy.api#documentation": "Contains the details for a document that was ingested or deleted.
" + } + }, + "com.amazonaws.bedrockagent#KnowledgeBaseDocumentDetails": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseDocumentDetail" + } + }, + "com.amazonaws.bedrockagent#KnowledgeBaseDocumentResource": { + "type": "resource", + "operations": [ + { + "target": "com.amazonaws.bedrockagent#DeleteKnowledgeBaseDocuments" + }, + { + "target": "com.amazonaws.bedrockagent#GetKnowledgeBaseDocuments" + }, + { + "target": "com.amazonaws.bedrockagent#IngestKnowledgeBaseDocuments" + }, + { + "target": "com.amazonaws.bedrockagent#ListKnowledgeBaseDocuments" + } + ] + }, + "com.amazonaws.bedrockagent#KnowledgeBaseDocuments": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#KnowledgeBaseDocument" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } } }, "com.amazonaws.bedrockagent#KnowledgeBaseFlowNodeConfiguration": { @@ -9832,6 +10587,108 @@ "smithy.api#output": {} } }, + "com.amazonaws.bedrockagent#ListKnowledgeBaseDocuments": { + "type": "operation", + "input": { + "target": "com.amazonaws.bedrockagent#ListKnowledgeBaseDocumentsRequest" + }, + "output": { + "target": "com.amazonaws.bedrockagent#ListKnowledgeBaseDocumentsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bedrockagent#AccessDeniedException" + }, + { + "target": "com.amazonaws.bedrockagent#InternalServerException" + }, + { + "target": "com.amazonaws.bedrockagent#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bedrockagent#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bedrockagent#ThrottlingException" + }, + { + "target": "com.amazonaws.bedrockagent#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves all the documents contained in a data source that is connected to a knowledge base. For more information, see Ingest documents into a knowledge base in real-time in the Amazon Bedrock User Guide.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/knowledgebases/{knowledgeBaseId}/datasources/{dataSourceId}/documents" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "documentDetails" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": ["console"] + } + }, + "com.amazonaws.bedrockagent#ListKnowledgeBaseDocumentsRequest": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the knowledge base that is connected to the data source.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "dataSourceId": { + "target": "com.amazonaws.bedrockagent#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the data source that contains the documents.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.bedrockagent#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
A list of objects, each of which contains information about the documents that were retrieved.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
The key of the metadata attribute.
", + "smithy.api#required": {} + } + }, + "value": { + "target": "com.amazonaws.bedrockagent#MetadataAttributeValue", + "traits": { + "smithy.api#documentation": "Contains the value of the metadata attribute.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about a metadata attribute.
" + } + }, + "com.amazonaws.bedrockagent#MetadataAttributeValue": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.bedrockagent#MetadataValueType", + "traits": { + "smithy.api#documentation": "The type of the metadata attribute.
", + "smithy.api#required": {} + } + }, + "numberValue": { + "target": "com.amazonaws.bedrockagent#NumberValue", + "traits": { + "smithy.api#documentation": "The value of the numeric metadata attribute.
" + } + }, + "booleanValue": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "The value of the Boolean metadata attribute.
" + } + }, + "stringValue": { + "target": "com.amazonaws.bedrockagent#StringValue", + "traits": { + "smithy.api#documentation": "The value of the string metadata attribute.
" + } + }, + "stringListValue": { + "target": "com.amazonaws.bedrockagent#StringListValue", + "traits": { + "smithy.api#documentation": "An array of strings that define the value of the metadata attribute.
", + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the value of the metadata attribute. Choose a type and include the field that corresponds to it.
The S3 location of the file containing the content to ingest.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the content to ingest into a knowledge base connected to an Amazon S3 data source.
" + } + }, "com.amazonaws.bedrockagent#S3DataSourceConfiguration": { "type": "structure", "members": { @@ -12137,6 +13132,16 @@ "smithy.api#pattern": "^[\\.\\-\\!\\*\\_\\'\\(\\)a-zA-Z0-9][\\.\\-\\!\\*\\_\\'\\(\\)\\/a-zA-Z0-9]*$" } }, + "com.amazonaws.bedrockagent#S3ObjectUri": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^s3://[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]/.{1,1024}$" + } + }, "com.amazonaws.bedrockagent#S3Prefix": { "type": "string", "traits": { @@ -12803,6 +13808,22 @@ "smithy.api#documentation": "Contains configurations for the service to use for storing the input into the node.
" } }, + "com.amazonaws.bedrockagent#StringListValue": { + "type": "list", + "member": { + "target": "com.amazonaws.bedrockagent#StringValue" + } + }, + "com.amazonaws.bedrockagent#StringValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#sensitive": {} + } + }, "com.amazonaws.bedrockagent#SystemContentBlock": { "type": "union", "members": { @@ -12965,6 +13986,21 @@ } } }, + "com.amazonaws.bedrockagent#TextContentDoc": { + "type": "structure", + "members": { + "data": { + "target": "com.amazonaws.bedrockagent#Data", + "traits": { + "smithy.api#documentation": "The text of the content.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about content defined inline in text.
" + } + }, "com.amazonaws.bedrockagent#TextPrompt": { "type": "string", "traits": {