Skip to content

KnowledgeBaseDocumentDetail

Source code in docs_src/capo_bedrock_agent/types/knowledge_base_document_detail.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
class KnowledgeBaseDocumentDetail(TypedDict, closed=True):
    knowledge_base_id: "capo_bedrock_agent.types.id.Id"
    """<p>The identifier of the knowledge base that the document was ingested into or deleted from.</p>"""
    data_source_id: "capo_bedrock_agent.types.id.Id"
    """<p>The identifier of the data source connected to the knowledge base that the document was ingested into or deleted from.</p>"""
    status: "capo_bedrock_agent.types.document_status.DocumentStatus"
    """<p>The ingestion status of the document. The following statuses are possible:</p> <ul> <li> <p>STARTING – You submitted the ingestion job containing the document.</p> </li> <li> <p>PENDING – The document is waiting to be ingested.</p> </li> <li> <p>IN_PROGRESS – The document is being ingested.</p> </li> <li> <p>INDEXED – The document was successfully indexed.</p> </li> <li> <p>PARTIALLY_INDEXED – The document was partially indexed.</p> </li> <li> <p>METADATA_PARTIALLY_INDEXED – You submitted metadata for an existing document and it was partially indexed.</p> </li> <li> <p>METADATA_UPDATE_FAILED – You submitted a metadata update for an existing document but it failed.</p> </li> <li> <p>FAILED – The document failed to be ingested.</p> </li> <li> <p>NOT_FOUND – The document wasn't found.</p> </li> <li> <p>IGNORED – The document was ignored during ingestion.</p> </li> <li> <p>DELETING – You submitted the delete job containing the document.</p> </li> <li> <p>DELETE_IN_PROGRESS – The document is being deleted.</p> </li> </ul>"""
    identifier: "capo_bedrock_agent.types.document_identifier.DocumentIdentifier"
    """<p>Contains information that identifies the document.</p>"""
    status_reason: NotRequired["str"]
    """<p>The reason for the status. Appears alongside the status <code>IGNORED</code>.</p>"""
    updated_at: NotRequired["capo_bedrock_agent.types.date_timestamp.DateTimestamp"]
    """<p>The date and time at which the document was last updated.</p>"""

data_source_id instance-attribute 

data_source_id: Id

The identifier of the data source connected to the knowledge base that the document was ingested into or deleted from.

identifier instance-attribute 

identifier: DocumentIdentifier

Contains information that identifies the document.

knowledge_base_id instance-attribute 

knowledge_base_id: Id

The identifier of the knowledge base that the document was ingested into or deleted from.

status instance-attribute 

status: DocumentStatus

The ingestion status of the document. The following statuses are possible:

  • STARTING – You submitted the ingestion job containing the document.

  • PENDING – The document is waiting to be ingested.

  • IN_PROGRESS – The document is being ingested.

  • INDEXED – The document was successfully indexed.

  • PARTIALLY_INDEXED – The document was partially indexed.

  • METADATA_PARTIALLY_INDEXED – You submitted metadata for an existing document and it was partially indexed.

  • METADATA_UPDATE_FAILED – You submitted a metadata update for an existing document but it failed.

  • FAILED – The document failed to be ingested.

  • NOT_FOUND – The document wasn't found.

  • IGNORED – The document was ignored during ingestion.

  • DELETING – You submitted the delete job containing the document.

  • DELETE_IN_PROGRESS – The document is being deleted.

status_reason instance-attribute 

status_reason: NotRequired[str]

The reason for the status. Appears alongside the status IGNORED.

updated_at instance-attribute 

updated_at: NotRequired[DateTimestamp]

The date and time at which the document was last updated.