KnowledgeBaseDocumentDetail
Contains the details for a document that was ingested or deleted.
Contents
- dataSourceId
-
The identifier of the data source connected to the knowledge base that the document was ingested into or deleted from.
Type: String
Pattern:
^[0-9a-zA-Z]{10}$
Required: Yes
- identifier
-
Contains information that identifies the document.
Type: DocumentIdentifier object
Required: Yes
- knowledgeBaseId
-
The identifier of the knowledge base that the document was ingested into or deleted from.
Type: String
Pattern:
^[0-9a-zA-Z]{10}$
Required: Yes
- status
-
The ingestion status of the document. The following statuses are possible:
-
STARTED – 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.
Type: String
Valid Values:
INDEXED | PARTIALLY_INDEXED | PENDING | FAILED | METADATA_PARTIALLY_INDEXED | METADATA_UPDATE_FAILED | IGNORED | NOT_FOUND | STARTING | IN_PROGRESS | DELETING | DELETE_IN_PROGRESS
Required: Yes
-
- statusReason
-
The reason for the status. Appears alongside the status
IGNORED
.Type: String
Required: No
- updatedAt
-
The date and time at which the document was last updated.
Type: Timestamp
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: