Skip to content

IngestKnowledgeBaseDocumentsRequest

Source code in docs_src/capo_bedrock_agent/types/ingest_knowledge_base_documents_request.py 
15
16
17
18
19
20
21
22
23
24
25
class IngestKnowledgeBaseDocumentsRequest(TypedDict, closed=True):
    knowledge_base_id: "capo_bedrock_agent.types.id.Id"
    """<p>The unique identifier of the knowledge base to ingest the documents into.</p>"""
    data_source_id: "capo_bedrock_agent.types.id.Id"
    """<p>The unique identifier of the data source connected to the knowledge base that you're adding documents to.</p>"""
    client_token: NotRequired["capo_bedrock_agent.types.client_token.ClientToken"]
    """<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, 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>"""
    documents: (
        "capo_bedrock_agent.types.knowledge_base_documents.KnowledgeBaseDocuments"
    )
    """<p>A list of objects, each of which contains information about the documents to add.</p>"""

client_token instance-attribute 

client_token: NotRequired[ClientToken]

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.

data_source_id instance-attribute 

data_source_id: Id

The unique identifier of the data source connected to the knowledge base that you're adding documents to.

documents instance-attribute 

documents: KnowledgeBaseDocuments

A list of objects, each of which contains information about the documents to add.

knowledge_base_id instance-attribute 

knowledge_base_id: Id

The unique identifier of the knowledge base to ingest the documents into.