BatchPutDocument
Note
Amazon Kendra is no longer open to new customers. For capabilities similar to Amazon Kendra, explore Amazon Bedrock Knowledge Bases. Learn more.
Adds one or more documents to an index.
The BatchPutDocument API enables you to ingest inline documents or a set
of documents stored in an Amazon S3 bucket. Use this API to ingest your text and
unstructured text into an index, add custom attributes to the documents, and to attach
an access control list to the documents added to the index.
The documents are indexed asynchronously. You can see the progress of the batch using
AWS
CloudWatch. Any error messages related to processing the batch are sent to your
AWS
CloudWatch log. You can also use the BatchGetDocumentStatus API to
monitor the progress of indexing your documents.
For an example of ingesting inline documents using Python and Java SDKs, see Adding files directly to an index.
Request Syntax
{
"CustomDocumentEnrichmentConfiguration": {
"InlineConfigurations": [
{
"Condition": {
"ConditionDocumentAttributeKey": "string",
"ConditionOnValue": {
"DateValue": number,
"LongValue": number,
"StringListValue": [ "string" ],
"StringValue": "string"
},
"Operator": "string"
},
"DocumentContentDeletion": boolean,
"Target": {
"TargetDocumentAttributeKey": "string",
"TargetDocumentAttributeValue": {
"DateValue": number,
"LongValue": number,
"StringListValue": [ "string" ],
"StringValue": "string"
},
"TargetDocumentAttributeValueDeletion": boolean
}
}
],
"PostExtractionHookConfiguration": {
"InvocationCondition": {
"ConditionDocumentAttributeKey": "string",
"ConditionOnValue": {
"DateValue": number,
"LongValue": number,
"StringListValue": [ "string" ],
"StringValue": "string"
},
"Operator": "string"
},
"LambdaArn": "string",
"S3Bucket": "string"
},
"PreExtractionHookConfiguration": {
"InvocationCondition": {
"ConditionDocumentAttributeKey": "string",
"ConditionOnValue": {
"DateValue": number,
"LongValue": number,
"StringListValue": [ "string" ],
"StringValue": "string"
},
"