BatchPutDocumentRequest

import type { BatchPutDocumentRequest } from "https://aws-api.deno.dev/v0.3/services/kendra.ts?docs=full";

interface BatchPutDocumentRequest {

CustomDocumentEnrichmentConfiguration?: CustomDocumentEnrichmentConfiguration | null;

Documents: Document[];

IndexId: string;

RoleArn?: string | null;

}

§Properties

CustomDocumentEnrichmentConfiguration?: CustomDocumentEnrichmentConfiguration | null

[src]

Configuration information for altering your document metadata and content during the document ingestion process when you use the BatchPutDocument operation.

For more information on how to create, modify and delete document metadata, or make other content alterations when you ingest documents into Amazon Kendra, see Customizing document metadata during the ingestion process.

Documents: Document[]

[src]

One or more documents to add to the index.

Documents can include custom attributes. For example, 'DataSourceId' and 'DataSourceSyncJobId' are custom attributes that provide information on the synchronization of documents running on a data source. Note, 'DataSourceSyncJobId' could be an optional custom attribute as Amazon Kendra will use the ID of a running sync job.

Documents have the following file size limits.

5 MB total size for inline documents
50 MB total size for files from an S3 bucket
5 MB extracted text for any file

For more information about file size and transaction per second quotas, see Quotas.

IndexId: string

[src]

The identifier of the index to add the documents to. You need to create the index first using the CreateIndex operation.

RoleArn?: string | null

[src]

The Amazon Resource Name (ARN) of a role that is allowed to run the BatchPutDocument operation. For more information, see IAM Roles for Amazon Kendra.