Document
One document in a knowledge base, stable across new uploads of new bytes.
| Member | Type | Description |
|---|---|---|
id (required) |
string | The document's identifier. 1 to 128 characters. |
knowledgeBaseId (required) |
string | The knowledge base the document is in. 1 to 128 characters. |
name (required) |
string | The document's name, as people see it. 1 to 1024 characters. |
folder (required) |
string | The folder the document is in. 1 to 1024 characters. Pattern `^(/ |
status (required) |
DocumentStatus | Where the document is in its lifecycle. |
stage |
string | While processing, what the server is doing, for display only. 1 to 128 characters. |
contentType |
string | The media type of the current bytes. 3 to 255 characters. |
byteSize |
long | The size of the current bytes, in bytes. |
sha256 |
string | The base64-encoded SHA-256 of the current bytes. 44 to 44 characters. Pattern ^[A-Za-z0-9+/]{43}=$. |
createdAt (required) |
timestamp (RFC 3339) | When the document was created. |
updatedAt (required) |
timestamp (RFC 3339) | When the document or its bytes last changed. |
partialFailures |
list of PartialFailure | Enrichments that did not complete (a picture description, metadata extraction, a table). They never fail the document. At most the first 100. At most 100 items. |
Unknown members a newer server sends are kept in the object's raw.
Used by CreateDocument, ListDocuments.