@aws-sdk/client-bedrock-agent 3.701.0 → 3.703.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +32 -0
- package/dist-cjs/index.js +423 -17
- package/dist-es/BedrockAgent.js +8 -0
- package/dist-es/commands/DeleteKnowledgeBaseDocumentsCommand.js +22 -0
- package/dist-es/commands/GetKnowledgeBaseDocumentsCommand.js +22 -0
- package/dist-es/commands/IngestKnowledgeBaseDocumentsCommand.js +23 -0
- package/dist-es/commands/ListKnowledgeBaseDocumentsCommand.js +22 -0
- package/dist-es/commands/index.js +4 -0
- package/dist-es/models/models_0.js +80 -14
- package/dist-es/models/models_1.js +22 -0
- package/dist-es/pagination/ListKnowledgeBaseDocumentsPaginator.js +4 -0
- package/dist-es/pagination/index.js +1 -0
- package/dist-es/protocols/Aws_restJson1.js +208 -0
- package/dist-types/BedrockAgent.d.ts +28 -0
- package/dist-types/BedrockAgentClient.d.ts +6 -2
- package/dist-types/commands/AssociateAgentKnowledgeBaseCommand.d.ts +1 -1
- package/dist-types/commands/CreateDataSourceCommand.d.ts +3 -3
- package/dist-types/commands/CreateKnowledgeBaseCommand.d.ts +3 -1
- package/dist-types/commands/DeleteKnowledgeBaseCommand.d.ts +1 -1
- package/dist-types/commands/DeleteKnowledgeBaseDocumentsCommand.d.ts +119 -0
- package/dist-types/commands/DisassociateAgentKnowledgeBaseCommand.d.ts +1 -1
- package/dist-types/commands/GetAgentKnowledgeBaseCommand.d.ts +1 -2
- package/dist-types/commands/GetDataSourceCommand.d.ts +1 -1
- package/dist-types/commands/GetKnowledgeBaseCommand.d.ts +1 -0
- package/dist-types/commands/GetKnowledgeBaseDocumentsCommand.d.ts +118 -0
- package/dist-types/commands/IngestKnowledgeBaseDocumentsCommand.d.ts +161 -0
- package/dist-types/commands/ListKnowledgeBaseDocumentsCommand.d.ts +110 -0
- package/dist-types/commands/UpdateDataSourceCommand.d.ts +2 -2
- package/dist-types/commands/UpdateKnowledgeBaseCommand.d.ts +2 -0
- package/dist-types/commands/index.d.ts +4 -0
- package/dist-types/models/models_0.d.ts +370 -350
- package/dist-types/models/models_1.d.ts +643 -1
- package/dist-types/pagination/ListKnowledgeBaseDocumentsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +1 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +36 -0
- package/dist-types/ts3.4/BedrockAgent.d.ts +68 -0
- package/dist-types/ts3.4/BedrockAgentClient.d.ts +24 -0
- package/dist-types/ts3.4/commands/AssociateAgentKnowledgeBaseCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/CreateKnowledgeBaseCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteKnowledgeBaseCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteKnowledgeBaseDocumentsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DisassociateAgentKnowledgeBaseCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetAgentKnowledgeBaseCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/GetKnowledgeBaseDocumentsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/IngestKnowledgeBaseDocumentsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListKnowledgeBaseDocumentsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/index.d.ts +4 -0
- package/dist-types/ts3.4/models/models_0.d.ts +161 -145
- package/dist-types/ts3.4/models/models_1.d.ts +172 -4
- package/dist-types/ts3.4/pagination/ListKnowledgeBaseDocumentsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +1 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +48 -0
- package/package.json +1 -1
|
@@ -2490,6 +2490,7 @@ export interface SharePointDataSourceConfiguration {
|
|
|
2490
2490
|
*/
|
|
2491
2491
|
export declare const DataSourceType: {
|
|
2492
2492
|
readonly CONFLUENCE: "CONFLUENCE";
|
|
2493
|
+
readonly CUSTOM: "CUSTOM";
|
|
2493
2494
|
readonly S3: "S3";
|
|
2494
2495
|
readonly SALESFORCE: "SALESFORCE";
|
|
2495
2496
|
readonly SHAREPOINT: "SHAREPOINT";
|
|
@@ -7320,625 +7321,604 @@ export interface StopIngestionJobResponse {
|
|
|
7320
7321
|
ingestionJob: IngestionJob | undefined;
|
|
7321
7322
|
}
|
|
7322
7323
|
/**
|
|
7324
|
+
* <p>Contains information about the identifier of the document to ingest into a custom data source.</p>
|
|
7323
7325
|
* @public
|
|
7324
7326
|
*/
|
|
7325
|
-
export interface
|
|
7327
|
+
export interface CustomDocumentIdentifier {
|
|
7326
7328
|
/**
|
|
7327
|
-
* <p>The
|
|
7329
|
+
* <p>The identifier of the document to ingest into a custom data source.</p>
|
|
7328
7330
|
* @public
|
|
7329
7331
|
*/
|
|
7330
|
-
|
|
7331
|
-
/**
|
|
7332
|
-
* <p>The version of the agent with which you want to associate the knowledge base.</p>
|
|
7333
|
-
* @public
|
|
7334
|
-
*/
|
|
7335
|
-
agentVersion: string | undefined;
|
|
7336
|
-
/**
|
|
7337
|
-
* <p>The unique identifier of the knowledge base to associate with the agent.</p>
|
|
7338
|
-
* @public
|
|
7339
|
-
*/
|
|
7340
|
-
knowledgeBaseId: string | undefined;
|
|
7341
|
-
/**
|
|
7342
|
-
* <p>A description of what the agent should use the knowledge base for.</p>
|
|
7343
|
-
* @public
|
|
7344
|
-
*/
|
|
7345
|
-
description: string | undefined;
|
|
7346
|
-
/**
|
|
7347
|
-
* <p>Specifies whether to use the knowledge base or not when sending an <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html">InvokeAgent</a> request.</p>
|
|
7348
|
-
* @public
|
|
7349
|
-
*/
|
|
7350
|
-
knowledgeBaseState?: KnowledgeBaseState | undefined;
|
|
7351
|
-
}
|
|
7352
|
-
/**
|
|
7353
|
-
* @public
|
|
7354
|
-
*/
|
|
7355
|
-
export interface AssociateAgentKnowledgeBaseResponse {
|
|
7356
|
-
/**
|
|
7357
|
-
* <p>Contains details about the knowledge base that has been associated with the agent.</p>
|
|
7358
|
-
* @public
|
|
7359
|
-
*/
|
|
7360
|
-
agentKnowledgeBase: AgentKnowledgeBase | undefined;
|
|
7332
|
+
id: string | undefined;
|
|
7361
7333
|
}
|
|
7362
7334
|
/**
|
|
7363
7335
|
* @public
|
|
7364
7336
|
* @enum
|
|
7365
7337
|
*/
|
|
7366
|
-
export declare const
|
|
7367
|
-
readonly
|
|
7338
|
+
export declare const ContentDataSourceType: {
|
|
7339
|
+
readonly CUSTOM: "CUSTOM";
|
|
7340
|
+
readonly S3: "S3";
|
|
7368
7341
|
};
|
|
7369
7342
|
/**
|
|
7370
7343
|
* @public
|
|
7371
7344
|
*/
|
|
7372
|
-
export type
|
|
7373
|
-
/**
|
|
7374
|
-
* <p>The vector configuration details for the Bedrock embeddings model.</p>
|
|
7375
|
-
* @public
|
|
7376
|
-
*/
|
|
7377
|
-
export interface BedrockEmbeddingModelConfiguration {
|
|
7378
|
-
/**
|
|
7379
|
-
* <p>The dimensions details for the vector configuration used on the Bedrock embeddings model.</p>
|
|
7380
|
-
* @public
|
|
7381
|
-
*/
|
|
7382
|
-
dimensions?: number | undefined;
|
|
7383
|
-
}
|
|
7345
|
+
export type ContentDataSourceType = (typeof ContentDataSourceType)[keyof typeof ContentDataSourceType];
|
|
7384
7346
|
/**
|
|
7385
|
-
* <p>
|
|
7347
|
+
* <p>Contains information that identifies the document.</p>
|
|
7386
7348
|
* @public
|
|
7387
7349
|
*/
|
|
7388
|
-
export interface
|
|
7350
|
+
export interface DocumentIdentifier {
|
|
7389
7351
|
/**
|
|
7390
|
-
* <p>The
|
|
7352
|
+
* <p>The type of data source connected to the knowledge base that contains the document.</p>
|
|
7391
7353
|
* @public
|
|
7392
7354
|
*/
|
|
7393
|
-
|
|
7394
|
-
}
|
|
7395
|
-
/**
|
|
7396
|
-
* <p>Contains details about the model used to create vector embeddings for the knowledge base.</p>
|
|
7397
|
-
* @public
|
|
7398
|
-
*/
|
|
7399
|
-
export interface VectorKnowledgeBaseConfiguration {
|
|
7355
|
+
dataSourceType: ContentDataSourceType | undefined;
|
|
7400
7356
|
/**
|
|
7401
|
-
* <p>
|
|
7357
|
+
* <p>Contains information that identifies the document in an S3 data source.</p>
|
|
7402
7358
|
* @public
|
|
7403
7359
|
*/
|
|
7404
|
-
|
|
7360
|
+
s3?: S3Location | undefined;
|
|
7405
7361
|
/**
|
|
7406
|
-
* <p>
|
|
7362
|
+
* <p>Contains information that identifies the document in a custom data source.</p>
|
|
7407
7363
|
* @public
|
|
7408
7364
|
*/
|
|
7409
|
-
|
|
7365
|
+
custom?: CustomDocumentIdentifier | undefined;
|
|
7410
7366
|
}
|
|
7411
7367
|
/**
|
|
7412
|
-
* <p>Contains details about the vector embeddings configuration of the knowledge base.</p>
|
|
7413
7368
|
* @public
|
|
7414
7369
|
*/
|
|
7415
|
-
export interface
|
|
7370
|
+
export interface DeleteKnowledgeBaseDocumentsRequest {
|
|
7416
7371
|
/**
|
|
7417
|
-
* <p>The
|
|
7372
|
+
* <p>The unique identifier of the knowledge base that is connected to the data source.</p>
|
|
7418
7373
|
* @public
|
|
7419
7374
|
*/
|
|
7420
|
-
|
|
7421
|
-
/**
|
|
7422
|
-
* <p>Contains details about the model that's used to convert the data source into vector embeddings.</p>
|
|
7423
|
-
* @public
|
|
7424
|
-
*/
|
|
7425
|
-
vectorKnowledgeBaseConfiguration?: VectorKnowledgeBaseConfiguration | undefined;
|
|
7426
|
-
}
|
|
7427
|
-
/**
|
|
7428
|
-
* <p>Contains the names of the fields to which to map information about the vector store.</p>
|
|
7429
|
-
* @public
|
|
7430
|
-
*/
|
|
7431
|
-
export interface MongoDbAtlasFieldMapping {
|
|
7375
|
+
knowledgeBaseId: string | undefined;
|
|
7432
7376
|
/**
|
|
7433
|
-
* <p>The
|
|
7377
|
+
* <p>The unique identifier of the data source that contains the documents.</p>
|
|
7434
7378
|
* @public
|
|
7435
7379
|
*/
|
|
7436
|
-
|
|
7380
|
+
dataSourceId: string | undefined;
|
|
7437
7381
|
/**
|
|
7438
|
-
* <p>
|
|
7382
|
+
* <p>A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,
|
|
7383
|
+
* Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</p>
|
|
7439
7384
|
* @public
|
|
7440
7385
|
*/
|
|
7441
|
-
|
|
7386
|
+
clientToken?: string | undefined;
|
|
7442
7387
|
/**
|
|
7443
|
-
* <p>
|
|
7388
|
+
* <p>A list of objects, each of which contains information to identify a document to delete.</p>
|
|
7444
7389
|
* @public
|
|
7445
7390
|
*/
|
|
7446
|
-
|
|
7391
|
+
documentIdentifiers: DocumentIdentifier[] | undefined;
|
|
7447
7392
|
}
|
|
7448
7393
|
/**
|
|
7449
|
-
*
|
|
7394
|
+
* @public
|
|
7395
|
+
* @enum
|
|
7396
|
+
*/
|
|
7397
|
+
export declare const DocumentStatus: {
|
|
7398
|
+
readonly DELETE_IN_PROGRESS: "DELETE_IN_PROGRESS";
|
|
7399
|
+
readonly DELETING: "DELETING";
|
|
7400
|
+
readonly FAILED: "FAILED";
|
|
7401
|
+
readonly IGNORED: "IGNORED";
|
|
7402
|
+
readonly INDEXED: "INDEXED";
|
|
7403
|
+
readonly IN_PROGRESS: "IN_PROGRESS";
|
|
7404
|
+
readonly METADATA_PARTIALLY_INDEXED: "METADATA_PARTIALLY_INDEXED";
|
|
7405
|
+
readonly METADATA_UPDATE_FAILED: "METADATA_UPDATE_FAILED";
|
|
7406
|
+
readonly NOT_FOUND: "NOT_FOUND";
|
|
7407
|
+
readonly PARTIALLY_INDEXED: "PARTIALLY_INDEXED";
|
|
7408
|
+
readonly PENDING: "PENDING";
|
|
7409
|
+
readonly STARTING: "STARTING";
|
|
7410
|
+
};
|
|
7411
|
+
/**
|
|
7412
|
+
* @public
|
|
7413
|
+
*/
|
|
7414
|
+
export type DocumentStatus = (typeof DocumentStatus)[keyof typeof DocumentStatus];
|
|
7415
|
+
/**
|
|
7416
|
+
* <p>Contains the details for a document that was ingested or deleted.</p>
|
|
7450
7417
|
* @public
|
|
7451
7418
|
*/
|
|
7452
|
-
export interface
|
|
7419
|
+
export interface KnowledgeBaseDocumentDetail {
|
|
7453
7420
|
/**
|
|
7454
|
-
* <p>The
|
|
7421
|
+
* <p>The identifier of the knowledge base that the document was ingested into or deleted from.</p>
|
|
7455
7422
|
* @public
|
|
7456
7423
|
*/
|
|
7457
|
-
|
|
7424
|
+
knowledgeBaseId: string | undefined;
|
|
7458
7425
|
/**
|
|
7459
|
-
* <p>The
|
|
7426
|
+
* <p>The identifier of the data source connected to the knowledge base that the document was ingested into or deleted from.</p>
|
|
7460
7427
|
* @public
|
|
7461
7428
|
*/
|
|
7462
|
-
|
|
7429
|
+
dataSourceId: string | undefined;
|
|
7463
7430
|
/**
|
|
7464
|
-
* <p>The
|
|
7431
|
+
* <p>The ingestion status of the document. The following statuses are possible:</p>
|
|
7432
|
+
* <ul>
|
|
7433
|
+
* <li>
|
|
7434
|
+
* <p>STARTED – You submitted the ingestion job containing the document.</p>
|
|
7435
|
+
* </li>
|
|
7436
|
+
* <li>
|
|
7437
|
+
* <p>PENDING – The document is waiting to be ingested.</p>
|
|
7438
|
+
* </li>
|
|
7439
|
+
* <li>
|
|
7440
|
+
* <p>IN_PROGRESS – The document is being ingested.</p>
|
|
7441
|
+
* </li>
|
|
7442
|
+
* <li>
|
|
7443
|
+
* <p>INDEXED – The document was successfully indexed.</p>
|
|
7444
|
+
* </li>
|
|
7445
|
+
* <li>
|
|
7446
|
+
* <p>PARTIALLY_INDEXED – The document was partially indexed.</p>
|
|
7447
|
+
* </li>
|
|
7448
|
+
* <li>
|
|
7449
|
+
* <p>METADATA_PARTIALLY_INDEXED – You submitted metadata for an existing document and it was partially indexed.</p>
|
|
7450
|
+
* </li>
|
|
7451
|
+
* <li>
|
|
7452
|
+
* <p>METADATA_UPDATE_FAILED – You submitted a metadata update for an existing document but it failed.</p>
|
|
7453
|
+
* </li>
|
|
7454
|
+
* <li>
|
|
7455
|
+
* <p>FAILED – The document failed to be ingested.</p>
|
|
7456
|
+
* </li>
|
|
7457
|
+
* <li>
|
|
7458
|
+
* <p>NOT_FOUND – The document wasn't found.</p>
|
|
7459
|
+
* </li>
|
|
7460
|
+
* <li>
|
|
7461
|
+
* <p>IGNORED – The document was ignored during ingestion.</p>
|
|
7462
|
+
* </li>
|
|
7463
|
+
* <li>
|
|
7464
|
+
* <p>DELETING – You submitted the delete job containing the document.</p>
|
|
7465
|
+
* </li>
|
|
7466
|
+
* <li>
|
|
7467
|
+
* <p>DELETE_IN_PROGRESS – The document is being deleted.</p>
|
|
7468
|
+
* </li>
|
|
7469
|
+
* </ul>
|
|
7465
7470
|
* @public
|
|
7466
7471
|
*/
|
|
7467
|
-
|
|
7472
|
+
status: DocumentStatus | undefined;
|
|
7468
7473
|
/**
|
|
7469
|
-
* <p>
|
|
7474
|
+
* <p>Contains information that identifies the document.</p>
|
|
7470
7475
|
* @public
|
|
7471
7476
|
*/
|
|
7472
|
-
|
|
7477
|
+
identifier: DocumentIdentifier | undefined;
|
|
7473
7478
|
/**
|
|
7474
|
-
* <p>The
|
|
7479
|
+
* <p>The reason for the status. Appears alongside the status <code>IGNORED</code>.</p>
|
|
7475
7480
|
* @public
|
|
7476
7481
|
*/
|
|
7477
|
-
|
|
7482
|
+
statusReason?: string | undefined;
|
|
7478
7483
|
/**
|
|
7479
|
-
* <p>
|
|
7484
|
+
* <p>The date and time at which the document was last updated.</p>
|
|
7480
7485
|
* @public
|
|
7481
7486
|
*/
|
|
7482
|
-
|
|
7487
|
+
updatedAt?: Date | undefined;
|
|
7488
|
+
}
|
|
7489
|
+
/**
|
|
7490
|
+
* @public
|
|
7491
|
+
*/
|
|
7492
|
+
export interface DeleteKnowledgeBaseDocumentsResponse {
|
|
7483
7493
|
/**
|
|
7484
|
-
* <p>
|
|
7494
|
+
* <p>A list of objects, each of which contains information about the documents that were deleted.</p>
|
|
7485
7495
|
* @public
|
|
7486
7496
|
*/
|
|
7487
|
-
|
|
7497
|
+
documentDetails?: KnowledgeBaseDocumentDetail[] | undefined;
|
|
7488
7498
|
}
|
|
7489
7499
|
/**
|
|
7490
|
-
* <p>Contains the names of the fields to which to map information about the vector store.</p>
|
|
7491
7500
|
* @public
|
|
7492
7501
|
*/
|
|
7493
|
-
export interface
|
|
7502
|
+
export interface GetKnowledgeBaseDocumentsRequest {
|
|
7494
7503
|
/**
|
|
7495
|
-
* <p>The
|
|
7504
|
+
* <p>The unique identifier of the knowledge base that is connected to the data source.</p>
|
|
7496
7505
|
* @public
|
|
7497
7506
|
*/
|
|
7498
|
-
|
|
7507
|
+
knowledgeBaseId: string | undefined;
|
|
7499
7508
|
/**
|
|
7500
|
-
* <p>The
|
|
7509
|
+
* <p>The unique identifier of the data source that contains the documents.</p>
|
|
7501
7510
|
* @public
|
|
7502
7511
|
*/
|
|
7503
|
-
|
|
7512
|
+
dataSourceId: string | undefined;
|
|
7504
7513
|
/**
|
|
7505
|
-
* <p>
|
|
7514
|
+
* <p>A list of objects, each of which contains information to identify a document for which to retrieve information.</p>
|
|
7506
7515
|
* @public
|
|
7507
7516
|
*/
|
|
7508
|
-
|
|
7517
|
+
documentIdentifiers: DocumentIdentifier[] | undefined;
|
|
7509
7518
|
}
|
|
7510
7519
|
/**
|
|
7511
|
-
* <p>Contains details about the storage configuration of the knowledge base in Amazon OpenSearch Service. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-oss.html">Create a vector index in Amazon OpenSearch Service</a>.</p>
|
|
7512
7520
|
* @public
|
|
7513
7521
|
*/
|
|
7514
|
-
export interface
|
|
7515
|
-
/**
|
|
7516
|
-
* <p>The Amazon Resource Name (ARN) of the OpenSearch Service vector store.</p>
|
|
7517
|
-
* @public
|
|
7518
|
-
*/
|
|
7519
|
-
collectionArn: string | undefined;
|
|
7520
|
-
/**
|
|
7521
|
-
* <p>The name of the vector store.</p>
|
|
7522
|
-
* @public
|
|
7523
|
-
*/
|
|
7524
|
-
vectorIndexName: string | undefined;
|
|
7522
|
+
export interface GetKnowledgeBaseDocumentsResponse {
|
|
7525
7523
|
/**
|
|
7526
|
-
* <p>
|
|
7524
|
+
* <p>A list of objects, each of which contains information about the documents that were retrieved.</p>
|
|
7527
7525
|
* @public
|
|
7528
7526
|
*/
|
|
7529
|
-
|
|
7527
|
+
documentDetails?: KnowledgeBaseDocumentDetail[] | undefined;
|
|
7530
7528
|
}
|
|
7531
7529
|
/**
|
|
7532
|
-
* <p>Contains
|
|
7530
|
+
* <p>Contains information about content defined inline in bytes.</p>
|
|
7533
7531
|
* @public
|
|
7534
7532
|
*/
|
|
7535
|
-
export interface
|
|
7533
|
+
export interface ByteContentDoc {
|
|
7536
7534
|
/**
|
|
7537
|
-
* <p>The
|
|
7535
|
+
* <p>The MIME type of the content. For a list of MIME types, see <a href="https://www.iana.org/assignments/media-types/media-types.xhtml">Media Types</a>. The following MIME types are supported:</p>
|
|
7536
|
+
* <ul>
|
|
7537
|
+
* <li>
|
|
7538
|
+
* <p>text/plain</p>
|
|
7539
|
+
* </li>
|
|
7540
|
+
* <li>
|
|
7541
|
+
* <p>text/html</p>
|
|
7542
|
+
* </li>
|
|
7543
|
+
* <li>
|
|
7544
|
+
* <p>text/csv</p>
|
|
7545
|
+
* </li>
|
|
7546
|
+
* <li>
|
|
7547
|
+
* <p>text/vtt</p>
|
|
7548
|
+
* </li>
|
|
7549
|
+
* <li>
|
|
7550
|
+
* <p>message/rfc822</p>
|
|
7551
|
+
* </li>
|
|
7552
|
+
* <li>
|
|
7553
|
+
* <p>application/xhtml+xml</p>
|
|
7554
|
+
* </li>
|
|
7555
|
+
* <li>
|
|
7556
|
+
* <p>application/pdf</p>
|
|
7557
|
+
* </li>
|
|
7558
|
+
* <li>
|
|
7559
|
+
* <p>application/msword</p>
|
|
7560
|
+
* </li>
|
|
7561
|
+
* <li>
|
|
7562
|
+
* <p>application/vnd.ms-word.document.macroenabled.12</p>
|
|
7563
|
+
* </li>
|
|
7564
|
+
* <li>
|
|
7565
|
+
* <p>application/vnd.ms-word.template.macroenabled.12</p>
|
|
7566
|
+
* </li>
|
|
7567
|
+
* <li>
|
|
7568
|
+
* <p>application/vnd.ms-excel</p>
|
|
7569
|
+
* </li>
|
|
7570
|
+
* <li>
|
|
7571
|
+
* <p>application/vnd.ms-excel.addin.macroenabled.12</p>
|
|
7572
|
+
* </li>
|
|
7573
|
+
* <li>
|
|
7574
|
+
* <p>application/vnd.ms-excel.sheet.macroenabled.12</p>
|
|
7575
|
+
* </li>
|
|
7576
|
+
* <li>
|
|
7577
|
+
* <p>application/vnd.ms-excel.template.macroenabled.12</p>
|
|
7578
|
+
* </li>
|
|
7579
|
+
* <li>
|
|
7580
|
+
* <p>application/vnd.ms-excel.sheet.binary.macroenabled.12</p>
|
|
7581
|
+
* </li>
|
|
7582
|
+
* <li>
|
|
7583
|
+
* <p>application/vnd.ms-spreadsheetml</p>
|
|
7584
|
+
* </li>
|
|
7585
|
+
* <li>
|
|
7586
|
+
* <p>application/vnd.openxmlformats-officedocument.spreadsheetml.sheet</p>
|
|
7587
|
+
* </li>
|
|
7588
|
+
* <li>
|
|
7589
|
+
* <p>application/vnd.openxmlformats-officedocument.spreadsheetml.template</p>
|
|
7590
|
+
* </li>
|
|
7591
|
+
* <li>
|
|
7592
|
+
* <p>application/vnd.openxmlformats-officedocument.wordprocessingml.document</p>
|
|
7593
|
+
* </li>
|
|
7594
|
+
* <li>
|
|
7595
|
+
* <p>application/vnd.openxmlformats-officedocument.wordprocessingml.template</p>
|
|
7596
|
+
* </li>
|
|
7597
|
+
* </ul>
|
|
7538
7598
|
* @public
|
|
7539
7599
|
*/
|
|
7540
|
-
|
|
7600
|
+
mimeType: string | undefined;
|
|
7541
7601
|
/**
|
|
7542
|
-
* <p>The
|
|
7602
|
+
* <p>The base64-encoded string of the content.</p>
|
|
7543
7603
|
* @public
|
|
7544
7604
|
*/
|
|
7545
|
-
|
|
7605
|
+
data: Uint8Array | undefined;
|
|
7546
7606
|
}
|
|
7547
7607
|
/**
|
|
7548
|
-
* <p>Contains
|
|
7608
|
+
* <p>Contains information about content defined inline in text.</p>
|
|
7549
7609
|
* @public
|
|
7550
7610
|
*/
|
|
7551
|
-
export interface
|
|
7611
|
+
export interface TextContentDoc {
|
|
7552
7612
|
/**
|
|
7553
|
-
* <p>The
|
|
7613
|
+
* <p>The text of the content.</p>
|
|
7554
7614
|
* @public
|
|
7555
7615
|
*/
|
|
7556
|
-
|
|
7616
|
+
data: string | undefined;
|
|
7617
|
+
}
|
|
7618
|
+
/**
|
|
7619
|
+
* @public
|
|
7620
|
+
* @enum
|
|
7621
|
+
*/
|
|
7622
|
+
export declare const InlineContentType: {
|
|
7623
|
+
readonly BYTE: "BYTE";
|
|
7624
|
+
readonly TEXT: "TEXT";
|
|
7625
|
+
};
|
|
7626
|
+
/**
|
|
7627
|
+
* @public
|
|
7628
|
+
*/
|
|
7629
|
+
export type InlineContentType = (typeof InlineContentType)[keyof typeof InlineContentType];
|
|
7630
|
+
/**
|
|
7631
|
+
* <p>Contains information about content defined inline to ingest into a data source. Choose a <code>type</code> and include the field that corresponds to it.</p>
|
|
7632
|
+
* @public
|
|
7633
|
+
*/
|
|
7634
|
+
export interface InlineContent {
|
|
7557
7635
|
/**
|
|
7558
|
-
* <p>The
|
|
7636
|
+
* <p>The type of inline content to define.</p>
|
|
7559
7637
|
* @public
|
|
7560
7638
|
*/
|
|
7561
|
-
|
|
7639
|
+
type: InlineContentType | undefined;
|
|
7562
7640
|
/**
|
|
7563
|
-
* <p>
|
|
7641
|
+
* <p>Contains information about content defined inline in bytes.</p>
|
|
7564
7642
|
* @public
|
|
7565
7643
|
*/
|
|
7566
|
-
|
|
7644
|
+
byteContent?: ByteContentDoc | undefined;
|
|
7567
7645
|
/**
|
|
7568
|
-
* <p>Contains
|
|
7646
|
+
* <p>Contains information about content defined inline in text.</p>
|
|
7569
7647
|
* @public
|
|
7570
7648
|
*/
|
|
7571
|
-
|
|
7649
|
+
textContent?: TextContentDoc | undefined;
|
|
7572
7650
|
}
|
|
7573
7651
|
/**
|
|
7574
|
-
* <p>Contains the
|
|
7652
|
+
* <p>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.</p>
|
|
7575
7653
|
* @public
|
|
7576
7654
|
*/
|
|
7577
|
-
export interface
|
|
7578
|
-
/**
|
|
7579
|
-
* <p>The name of the field in which Amazon Bedrock stores the ID for each entry.</p>
|
|
7580
|
-
* @public
|
|
7581
|
-
*/
|
|
7582
|
-
primaryKeyField: string | undefined;
|
|
7655
|
+
export interface CustomS3Location {
|
|
7583
7656
|
/**
|
|
7584
|
-
* <p>The
|
|
7657
|
+
* <p>The S3 URI of the file containing the content to ingest.</p>
|
|
7585
7658
|
* @public
|
|
7586
7659
|
*/
|
|
7587
|
-
|
|
7588
|
-
/**
|
|
7589
|
-
* <p>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.</p>
|
|
7590
|
-
* @public
|
|
7591
|
-
*/
|
|
7592
|
-
textField: string | undefined;
|
|
7660
|
+
uri: string | undefined;
|
|
7593
7661
|
/**
|
|
7594
|
-
* <p>The
|
|
7662
|
+
* <p>The identifier of the Amazon Web Services account that owns the S3 bucket containing the content to ingest.</p>
|
|
7595
7663
|
* @public
|
|
7596
7664
|
*/
|
|
7597
|
-
|
|
7665
|
+
bucketOwnerAccountId?: string | undefined;
|
|
7598
7666
|
}
|
|
7599
7667
|
/**
|
|
7600
|
-
* <p>Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-rds.html">Create a vector index in Amazon RDS</a>.</p>
|
|
7601
7668
|
* @public
|
|
7669
|
+
* @enum
|
|
7602
7670
|
*/
|
|
7603
|
-
export
|
|
7604
|
-
|
|
7605
|
-
|
|
7606
|
-
|
|
7607
|
-
|
|
7608
|
-
|
|
7671
|
+
export declare const CustomSourceType: {
|
|
7672
|
+
readonly IN_LINE: "IN_LINE";
|
|
7673
|
+
readonly S3_LOCATION: "S3_LOCATION";
|
|
7674
|
+
};
|
|
7675
|
+
/**
|
|
7676
|
+
* @public
|
|
7677
|
+
*/
|
|
7678
|
+
export type CustomSourceType = (typeof CustomSourceType)[keyof typeof CustomSourceType];
|
|
7679
|
+
/**
|
|
7680
|
+
* <p>Contains information about the content to ingest into a knowledge base connected to a custom data source. Choose a <code>sourceType</code> and include the field that corresponds to it.</p>
|
|
7681
|
+
* @public
|
|
7682
|
+
*/
|
|
7683
|
+
export interface CustomContent {
|
|
7609
7684
|
/**
|
|
7610
|
-
* <p>
|
|
7685
|
+
* <p>A unique identifier for the document.</p>
|
|
7611
7686
|
* @public
|
|
7612
7687
|
*/
|
|
7613
|
-
|
|
7688
|
+
customDocumentIdentifier: CustomDocumentIdentifier | undefined;
|
|
7614
7689
|
/**
|
|
7615
|
-
* <p>The
|
|
7690
|
+
* <p>The source of the data to ingest.</p>
|
|
7616
7691
|
* @public
|
|
7617
7692
|
*/
|
|
7618
|
-
|
|
7693
|
+
sourceType: CustomSourceType | undefined;
|
|
7619
7694
|
/**
|
|
7620
|
-
* <p>
|
|
7695
|
+
* <p>Contains information about the Amazon S3 location of the file from which to ingest data.</p>
|
|
7621
7696
|
* @public
|
|
7622
7697
|
*/
|
|
7623
|
-
|
|
7698
|
+
s3Location?: CustomS3Location | undefined;
|
|
7624
7699
|
/**
|
|
7625
|
-
* <p>Contains
|
|
7700
|
+
* <p>Contains information about content defined inline to ingest into a knowledge base.</p>
|
|
7626
7701
|
* @public
|
|
7627
7702
|
*/
|
|
7628
|
-
|
|
7703
|
+
inlineContent?: InlineContent | undefined;
|
|
7629
7704
|
}
|
|
7630
7705
|
/**
|
|
7631
|
-
* <p>Contains
|
|
7706
|
+
* <p>Contains information about the content to ingest into a knowledge base connected to an Amazon S3 data source.</p>
|
|
7632
7707
|
* @public
|
|
7633
7708
|
*/
|
|
7634
|
-
export interface
|
|
7709
|
+
export interface S3Content {
|
|
7635
7710
|
/**
|
|
7636
|
-
* <p>The
|
|
7711
|
+
* <p>The S3 location of the file containing the content to ingest.</p>
|
|
7637
7712
|
* @public
|
|
7638
7713
|
*/
|
|
7639
|
-
|
|
7640
|
-
/**
|
|
7641
|
-
* <p>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.</p>
|
|
7642
|
-
* @public
|
|
7643
|
-
*/
|
|
7644
|
-
textField: string | undefined;
|
|
7645
|
-
/**
|
|
7646
|
-
* <p>The name of the field in which Amazon Bedrock stores metadata about the vector store.</p>
|
|
7647
|
-
* @public
|
|
7648
|
-
*/
|
|
7649
|
-
metadataField: string | undefined;
|
|
7714
|
+
s3Location: S3Location | undefined;
|
|
7650
7715
|
}
|
|
7651
7716
|
/**
|
|
7652
|
-
* <p>Contains
|
|
7717
|
+
* <p>Contains information about the content of a document. Choose a <code>dataSourceType</code> and include the field that corresponds to it.</p>
|
|
7653
7718
|
* @public
|
|
7654
7719
|
*/
|
|
7655
|
-
export interface
|
|
7656
|
-
/**
|
|
7657
|
-
* <p>The endpoint URL of the Redis Enterprise Cloud database.</p>
|
|
7658
|
-
* @public
|
|
7659
|
-
*/
|
|
7660
|
-
endpoint: string | undefined;
|
|
7720
|
+
export interface DocumentContent {
|
|
7661
7721
|
/**
|
|
7662
|
-
* <p>The
|
|
7722
|
+
* <p>The type of data source that is connected to the knowledge base to which to ingest this document.</p>
|
|
7663
7723
|
* @public
|
|
7664
7724
|
*/
|
|
7665
|
-
|
|
7725
|
+
dataSourceType: ContentDataSourceType | undefined;
|
|
7666
7726
|
/**
|
|
7667
|
-
* <p>
|
|
7727
|
+
* <p>Contains information about the content to ingest into a knowledge base connected to a custom data source.</p>
|
|
7668
7728
|
* @public
|
|
7669
7729
|
*/
|
|
7670
|
-
|
|
7730
|
+
custom?: CustomContent | undefined;
|
|
7671
7731
|
/**
|
|
7672
|
-
* <p>Contains
|
|
7732
|
+
* <p>Contains information about the content to ingest into a knowledge base connected to an Amazon S3 data source</p>
|
|
7673
7733
|
* @public
|
|
7674
7734
|
*/
|
|
7675
|
-
|
|
7735
|
+
s3?: S3Content | undefined;
|
|
7676
7736
|
}
|
|
7677
7737
|
/**
|
|
7678
7738
|
* @public
|
|
7679
7739
|
* @enum
|
|
7680
7740
|
*/
|
|
7681
|
-
export declare const
|
|
7682
|
-
readonly
|
|
7683
|
-
readonly
|
|
7684
|
-
readonly
|
|
7685
|
-
readonly
|
|
7686
|
-
readonly REDIS_ENTERPRISE_CLOUD: "REDIS_ENTERPRISE_CLOUD";
|
|
7741
|
+
export declare const MetadataValueType: {
|
|
7742
|
+
readonly BOOLEAN: "BOOLEAN";
|
|
7743
|
+
readonly NUMBER: "NUMBER";
|
|
7744
|
+
readonly STRING: "STRING";
|
|
7745
|
+
readonly STRING_LIST: "STRING_LIST";
|
|
7687
7746
|
};
|
|
7688
7747
|
/**
|
|
7689
7748
|
* @public
|
|
7690
7749
|
*/
|
|
7691
|
-
export type
|
|
7750
|
+
export type MetadataValueType = (typeof MetadataValueType)[keyof typeof MetadataValueType];
|
|
7692
7751
|
/**
|
|
7693
|
-
* <p>Contains the
|
|
7752
|
+
* <p>Contains the value of the metadata attribute. Choose a <code>type</code> and include the field that corresponds to it.</p>
|
|
7694
7753
|
* @public
|
|
7695
7754
|
*/
|
|
7696
|
-
export interface
|
|
7697
|
-
/**
|
|
7698
|
-
* <p>The vector store service in which the knowledge base is stored.</p>
|
|
7699
|
-
* @public
|
|
7700
|
-
*/
|
|
7701
|
-
type: KnowledgeBaseStorageType | undefined;
|
|
7755
|
+
export interface MetadataAttributeValue {
|
|
7702
7756
|
/**
|
|
7703
|
-
* <p>
|
|
7757
|
+
* <p>The type of the metadata attribute.</p>
|
|
7704
7758
|
* @public
|
|
7705
7759
|
*/
|
|
7706
|
-
|
|
7760
|
+
type: MetadataValueType | undefined;
|
|
7707
7761
|
/**
|
|
7708
|
-
* <p>
|
|
7762
|
+
* <p>The value of the numeric metadata attribute.</p>
|
|
7709
7763
|
* @public
|
|
7710
7764
|
*/
|
|
7711
|
-
|
|
7765
|
+
numberValue?: number | undefined;
|
|
7712
7766
|
/**
|
|
7713
|
-
* <p>
|
|
7767
|
+
* <p>The value of the Boolean metadata attribute.</p>
|
|
7714
7768
|
* @public
|
|
7715
7769
|
*/
|
|
7716
|
-
|
|
7770
|
+
booleanValue?: boolean | undefined;
|
|
7717
7771
|
/**
|
|
7718
|
-
* <p>
|
|
7772
|
+
* <p>The value of the string metadata attribute.</p>
|
|
7719
7773
|
* @public
|
|
7720
7774
|
*/
|
|
7721
|
-
|
|
7775
|
+
stringValue?: string | undefined;
|
|
7722
7776
|
/**
|
|
7723
|
-
* <p>
|
|
7777
|
+
* <p>An array of strings that define the value of the metadata attribute.</p>
|
|
7724
7778
|
* @public
|
|
7725
7779
|
*/
|
|
7726
|
-
|
|
7780
|
+
stringListValue?: string[] | undefined;
|
|
7727
7781
|
}
|
|
7728
7782
|
/**
|
|
7783
|
+
* <p>Contains information about a metadata attribute.</p>
|
|
7729
7784
|
* @public
|
|
7730
7785
|
*/
|
|
7731
|
-
export interface
|
|
7786
|
+
export interface MetadataAttribute {
|
|
7732
7787
|
/**
|
|
7733
|
-
* <p>
|
|
7734
|
-
* Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</p>
|
|
7735
|
-
* @public
|
|
7736
|
-
*/
|
|
7737
|
-
clientToken?: string | undefined;
|
|
7738
|
-
/**
|
|
7739
|
-
* <p>A name for the knowledge base.</p>
|
|
7788
|
+
* <p>The key of the metadata attribute.</p>
|
|
7740
7789
|
* @public
|
|
7741
7790
|
*/
|
|
7742
|
-
|
|
7791
|
+
key: string | undefined;
|
|
7743
7792
|
/**
|
|
7744
|
-
* <p>
|
|
7793
|
+
* <p>Contains the value of the metadata attribute.</p>
|
|
7745
7794
|
* @public
|
|
7746
7795
|
*/
|
|
7747
|
-
|
|
7748
|
-
/**
|
|
7749
|
-
* <p>The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.</p>
|
|
7750
|
-
* @public
|
|
7751
|
-
*/
|
|
7752
|
-
roleArn: string | undefined;
|
|
7753
|
-
/**
|
|
7754
|
-
* <p>Contains details about the embeddings model used for the knowledge base.</p>
|
|
7755
|
-
* @public
|
|
7756
|
-
*/
|
|
7757
|
-
knowledgeBaseConfiguration: KnowledgeBaseConfiguration | undefined;
|
|
7758
|
-
/**
|
|
7759
|
-
* <p>Contains details about the configuration of the vector database used for the knowledge base.</p>
|
|
7760
|
-
* @public
|
|
7761
|
-
*/
|
|
7762
|
-
storageConfiguration: StorageConfiguration | undefined;
|
|
7763
|
-
/**
|
|
7764
|
-
* <p>Specify the key-value pairs for the tags that you want to attach to your knowledge base in this object.</p>
|
|
7765
|
-
* @public
|
|
7766
|
-
*/
|
|
7767
|
-
tags?: Record<string, string> | undefined;
|
|
7796
|
+
value: MetadataAttributeValue | undefined;
|
|
7768
7797
|
}
|
|
7769
7798
|
/**
|
|
7770
7799
|
* @public
|
|
7771
7800
|
* @enum
|
|
7772
7801
|
*/
|
|
7773
|
-
export declare const
|
|
7774
|
-
readonly
|
|
7775
|
-
readonly
|
|
7776
|
-
readonly DELETE_UNSUCCESSFUL: "DELETE_UNSUCCESSFUL";
|
|
7777
|
-
readonly DELETING: "DELETING";
|
|
7778
|
-
readonly FAILED: "FAILED";
|
|
7779
|
-
readonly UPDATING: "UPDATING";
|
|
7802
|
+
export declare const MetadataSourceType: {
|
|
7803
|
+
readonly IN_LINE_ATTRIBUTE: "IN_LINE_ATTRIBUTE";
|
|
7804
|
+
readonly S3_LOCATION: "S3_LOCATION";
|
|
7780
7805
|
};
|
|
7781
7806
|
/**
|
|
7782
7807
|
* @public
|
|
7783
7808
|
*/
|
|
7784
|
-
export type
|
|
7809
|
+
export type MetadataSourceType = (typeof MetadataSourceType)[keyof typeof MetadataSourceType];
|
|
7785
7810
|
/**
|
|
7786
|
-
* <p>Contains information about a knowledge base.</p>
|
|
7811
|
+
* <p>Contains information about the metadata associate with the content to ingest into a knowledge base. Choose a <code>type</code> and include the field that corresponds to it.</p>
|
|
7787
7812
|
* @public
|
|
7788
7813
|
*/
|
|
7789
|
-
export interface
|
|
7790
|
-
/**
|
|
7791
|
-
* <p>The unique identifier of the knowledge base.</p>
|
|
7792
|
-
* @public
|
|
7793
|
-
*/
|
|
7794
|
-
knowledgeBaseId: string | undefined;
|
|
7814
|
+
export interface DocumentMetadata {
|
|
7795
7815
|
/**
|
|
7796
|
-
* <p>The
|
|
7816
|
+
* <p>The type of the source source from which to add metadata.</p>
|
|
7797
7817
|
* @public
|
|
7798
7818
|
*/
|
|
7799
|
-
|
|
7819
|
+
type: MetadataSourceType | undefined;
|
|
7800
7820
|
/**
|
|
7801
|
-
* <p>
|
|
7821
|
+
* <p>An array of objects, each of which defines a metadata attribute to associate with the content to ingest. You define the attributes inline.</p>
|
|
7802
7822
|
* @public
|
|
7803
7823
|
*/
|
|
7804
|
-
|
|
7805
|
-
/**
|
|
7806
|
-
* <p>The description of the knowledge base.</p>
|
|
7807
|
-
* @public
|
|
7808
|
-
*/
|
|
7809
|
-
description?: string | undefined;
|
|
7824
|
+
inlineAttributes?: MetadataAttribute[] | undefined;
|
|
7810
7825
|
/**
|
|
7811
|
-
* <p>The Amazon
|
|
7826
|
+
* <p>The Amazon S3 location of the file containing metadata to associate with the content to ingest.</p>
|
|
7812
7827
|
* @public
|
|
7813
7828
|
*/
|
|
7814
|
-
|
|
7829
|
+
s3Location?: CustomS3Location | undefined;
|
|
7830
|
+
}
|
|
7831
|
+
/**
|
|
7832
|
+
* <p>Contains information about a document to ingest into a knowledge base and metadata to associate with it.</p>
|
|
7833
|
+
* @public
|
|
7834
|
+
*/
|
|
7835
|
+
export interface KnowledgeBaseDocument {
|
|
7815
7836
|
/**
|
|
7816
|
-
* <p>Contains
|
|
7837
|
+
* <p>Contains the metadata to associate with the document.</p>
|
|
7817
7838
|
* @public
|
|
7818
7839
|
*/
|
|
7819
|
-
|
|
7840
|
+
metadata?: DocumentMetadata | undefined;
|
|
7820
7841
|
/**
|
|
7821
|
-
* <p>Contains
|
|
7842
|
+
* <p>Contains the content of the document.</p>
|
|
7822
7843
|
* @public
|
|
7823
7844
|
*/
|
|
7824
|
-
|
|
7825
|
-
|
|
7826
|
-
|
|
7827
|
-
|
|
7828
|
-
|
|
7829
|
-
|
|
7830
|
-
* </li>
|
|
7831
|
-
* <li>
|
|
7832
|
-
* <p>ACTIVE – The knowledge base is ready to be queried.</p>
|
|
7833
|
-
* </li>
|
|
7834
|
-
* <li>
|
|
7835
|
-
* <p>DELETING – The knowledge base is being deleted.</p>
|
|
7836
|
-
* </li>
|
|
7837
|
-
* <li>
|
|
7838
|
-
* <p>UPDATING – The knowledge base is being updated.</p>
|
|
7839
|
-
* </li>
|
|
7840
|
-
* <li>
|
|
7841
|
-
* <p>FAILED – The knowledge base API operation failed.</p>
|
|
7842
|
-
* </li>
|
|
7843
|
-
* </ul>
|
|
7844
|
-
* @public
|
|
7845
|
-
*/
|
|
7846
|
-
status: KnowledgeBaseStatus | undefined;
|
|
7845
|
+
content: DocumentContent | undefined;
|
|
7846
|
+
}
|
|
7847
|
+
/**
|
|
7848
|
+
* @public
|
|
7849
|
+
*/
|
|
7850
|
+
export interface IngestKnowledgeBaseDocumentsRequest {
|
|
7847
7851
|
/**
|
|
7848
|
-
* <p>The
|
|
7852
|
+
* <p>The unique identifier of the knowledge base to ingest the documents into.</p>
|
|
7849
7853
|
* @public
|
|
7850
7854
|
*/
|
|
7851
|
-
|
|
7855
|
+
knowledgeBaseId: string | undefined;
|
|
7852
7856
|
/**
|
|
7853
|
-
* <p>The
|
|
7857
|
+
* <p>The unique identifier of the data source connected to the knowledge base that you're adding documents to.</p>
|
|
7854
7858
|
* @public
|
|
7855
7859
|
*/
|
|
7856
|
-
|
|
7860
|
+
dataSourceId: string | undefined;
|
|
7857
7861
|
/**
|
|
7858
|
-
* <p>A
|
|
7862
|
+
* <p>A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,
|
|
7863
|
+
* Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</p>
|
|
7859
7864
|
* @public
|
|
7860
7865
|
*/
|
|
7861
|
-
|
|
7862
|
-
}
|
|
7863
|
-
/**
|
|
7864
|
-
* @public
|
|
7865
|
-
*/
|
|
7866
|
-
export interface CreateKnowledgeBaseResponse {
|
|
7866
|
+
clientToken?: string | undefined;
|
|
7867
7867
|
/**
|
|
7868
|
-
* <p>
|
|
7868
|
+
* <p>A list of objects, each of which contains information about the documents to add.</p>
|
|
7869
7869
|
* @public
|
|
7870
7870
|
*/
|
|
7871
|
-
|
|
7871
|
+
documents: KnowledgeBaseDocument[] | undefined;
|
|
7872
7872
|
}
|
|
7873
7873
|
/**
|
|
7874
7874
|
* @public
|
|
7875
7875
|
*/
|
|
7876
|
-
export interface
|
|
7876
|
+
export interface IngestKnowledgeBaseDocumentsResponse {
|
|
7877
7877
|
/**
|
|
7878
|
-
* <p>
|
|
7878
|
+
* <p>A list of objects, each of which contains information about the documents that were ingested.</p>
|
|
7879
7879
|
* @public
|
|
7880
7880
|
*/
|
|
7881
|
-
|
|
7881
|
+
documentDetails?: KnowledgeBaseDocumentDetail[] | undefined;
|
|
7882
7882
|
}
|
|
7883
7883
|
/**
|
|
7884
7884
|
* @public
|
|
7885
7885
|
*/
|
|
7886
|
-
export interface
|
|
7886
|
+
export interface ListKnowledgeBaseDocumentsRequest {
|
|
7887
7887
|
/**
|
|
7888
|
-
* <p>The unique identifier of the knowledge base that
|
|
7888
|
+
* <p>The unique identifier of the knowledge base that is connected to the data source.</p>
|
|
7889
7889
|
* @public
|
|
7890
7890
|
*/
|
|
7891
7891
|
knowledgeBaseId: string | undefined;
|
|
7892
7892
|
/**
|
|
7893
|
-
* <p>The
|
|
7894
|
-
* @public
|
|
7895
|
-
*/
|
|
7896
|
-
status: KnowledgeBaseStatus | undefined;
|
|
7897
|
-
}
|
|
7898
|
-
/**
|
|
7899
|
-
* @public
|
|
7900
|
-
*/
|
|
7901
|
-
export interface DisassociateAgentKnowledgeBaseRequest {
|
|
7902
|
-
/**
|
|
7903
|
-
* <p>The unique identifier of the agent from which to disassociate the knowledge base.</p>
|
|
7893
|
+
* <p>The unique identifier of the data source that contains the documents.</p>
|
|
7904
7894
|
* @public
|
|
7905
7895
|
*/
|
|
7906
|
-
|
|
7896
|
+
dataSourceId: string | undefined;
|
|
7907
7897
|
/**
|
|
7908
|
-
* <p>The
|
|
7898
|
+
* <p>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 <code>nextToken</code> field when making another request to return the next batch of results.</p>
|
|
7909
7899
|
* @public
|
|
7910
7900
|
*/
|
|
7911
|
-
|
|
7901
|
+
maxResults?: number | undefined;
|
|
7912
7902
|
/**
|
|
7913
|
-
* <p>
|
|
7903
|
+
* <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, enter the token returned in the <code>nextToken</code> field in the response in this field to return the next batch of results.</p>
|
|
7914
7904
|
* @public
|
|
7915
7905
|
*/
|
|
7916
|
-
|
|
7917
|
-
}
|
|
7918
|
-
/**
|
|
7919
|
-
* @public
|
|
7920
|
-
*/
|
|
7921
|
-
export interface DisassociateAgentKnowledgeBaseResponse {
|
|
7906
|
+
nextToken?: string | undefined;
|
|
7922
7907
|
}
|
|
7923
7908
|
/**
|
|
7924
7909
|
* @public
|
|
7925
7910
|
*/
|
|
7926
|
-
export interface
|
|
7911
|
+
export interface ListKnowledgeBaseDocumentsResponse {
|
|
7927
7912
|
/**
|
|
7928
|
-
* <p>
|
|
7929
|
-
* @public
|
|
7930
|
-
*/
|
|
7931
|
-
agentId: string | undefined;
|
|
7932
|
-
/**
|
|
7933
|
-
* <p>The version of the agent with which the knowledge base is associated.</p>
|
|
7913
|
+
* <p>A list of objects, each of which contains information about the documents that were retrieved.</p>
|
|
7934
7914
|
* @public
|
|
7935
7915
|
*/
|
|
7936
|
-
|
|
7916
|
+
documentDetails: KnowledgeBaseDocumentDetail[] | undefined;
|
|
7937
7917
|
/**
|
|
7938
|
-
* <p>
|
|
7918
|
+
* <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, use this token when making another request in the <code>nextToken</code> field to return the next batch of results.</p>
|
|
7939
7919
|
* @public
|
|
7940
7920
|
*/
|
|
7941
|
-
|
|
7921
|
+
nextToken?: string | undefined;
|
|
7942
7922
|
}
|
|
7943
7923
|
/**
|
|
7944
7924
|
* @internal
|
|
@@ -8188,3 +8168,43 @@ export declare const UpdateFlowRequestFilterSensitiveLog: (obj: UpdateFlowReques
|
|
|
8188
8168
|
* @internal
|
|
8189
8169
|
*/
|
|
8190
8170
|
export declare const UpdateFlowResponseFilterSensitiveLog: (obj: UpdateFlowResponse) => any;
|
|
8171
|
+
/**
|
|
8172
|
+
* @internal
|
|
8173
|
+
*/
|
|
8174
|
+
export declare const ByteContentDocFilterSensitiveLog: (obj: ByteContentDoc) => any;
|
|
8175
|
+
/**
|
|
8176
|
+
* @internal
|
|
8177
|
+
*/
|
|
8178
|
+
export declare const TextContentDocFilterSensitiveLog: (obj: TextContentDoc) => any;
|
|
8179
|
+
/**
|
|
8180
|
+
* @internal
|
|
8181
|
+
*/
|
|
8182
|
+
export declare const InlineContentFilterSensitiveLog: (obj: InlineContent) => any;
|
|
8183
|
+
/**
|
|
8184
|
+
* @internal
|
|
8185
|
+
*/
|
|
8186
|
+
export declare const CustomContentFilterSensitiveLog: (obj: CustomContent) => any;
|
|
8187
|
+
/**
|
|
8188
|
+
* @internal
|
|
8189
|
+
*/
|
|
8190
|
+
export declare const DocumentContentFilterSensitiveLog: (obj: DocumentContent) => any;
|
|
8191
|
+
/**
|
|
8192
|
+
* @internal
|
|
8193
|
+
*/
|
|
8194
|
+
export declare const MetadataAttributeValueFilterSensitiveLog: (obj: MetadataAttributeValue) => any;
|
|
8195
|
+
/**
|
|
8196
|
+
* @internal
|
|
8197
|
+
*/
|
|
8198
|
+
export declare const MetadataAttributeFilterSensitiveLog: (obj: MetadataAttribute) => any;
|
|
8199
|
+
/**
|
|
8200
|
+
* @internal
|
|
8201
|
+
*/
|
|
8202
|
+
export declare const DocumentMetadataFilterSensitiveLog: (obj: DocumentMetadata) => any;
|
|
8203
|
+
/**
|
|
8204
|
+
* @internal
|
|
8205
|
+
*/
|
|
8206
|
+
export declare const KnowledgeBaseDocumentFilterSensitiveLog: (obj: KnowledgeBaseDocument) => any;
|
|
8207
|
+
/**
|
|
8208
|
+
* @internal
|
|
8209
|
+
*/
|
|
8210
|
+
export declare const IngestKnowledgeBaseDocumentsRequestFilterSensitiveLog: (obj: IngestKnowledgeBaseDocumentsRequest) => any;
|