ingest_knowledge_base_documents¶
Operation¶
async
¶
ingest_knowledge_base_documents(input: IngestKnowledgeBaseDocumentsInput, plugins: list[Plugin] | None = None) -> IngestKnowledgeBaseDocumentsOutput
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 changes directly into a
knowledge
base
in the Amazon Bedrock User Guide.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
IngestKnowledgeBaseDocumentsInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
IngestKnowledgeBaseDocumentsOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for IngestKnowledgeBaseDocumentsInput structure.
Attributes¶
class-attribute
instance-attribute
¶
client_token: str | None = None
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.
class-attribute
instance-attribute
¶
data_source_id: str | None = None
The unique identifier of the data source connected to the knowledge base that you're adding documents to.
class-attribute
instance-attribute
¶
documents: list[KnowledgeBaseDocument] | None = None
A list of objects, each of which contains information about the documents to add.
class-attribute
instance-attribute
¶
knowledge_base_id: str | None = None
The unique identifier of the knowledge base to ingest the documents into.
Output¶
dataclass
¶
Dataclass for IngestKnowledgeBaseDocumentsOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
document_details: list[KnowledgeBaseDocumentDetail] | None = None
A list of objects, each of which contains information about the documents that were ingested.