Bedrock Agent  >  Structures  >  KnowledgeBaseDocumentDetail

KnowledgeBaseDocumentDetail

Structure Class

KnowledgeBaseDocumentDetail dataclass

Contains the details for a document that was ingested or deleted.

Attributes

data_source_id instance-attribute

data_source_id: str

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: str

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 class-attribute instance-attribute

status_reason: str | None = None

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

updated_at class-attribute instance-attribute

updated_at: datetime | None = None

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