REST Resource: projects.locations.dataStores.documents

Resource: Document

A Document is a single unit of content ingested into a DataStore. It is a sub-resource of a DataStore. During ingestion a Document is parsed and chunked into one or more Segments.

JSON representation 
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "content": {
    object (Content)
  },
  "etag": string,
  "metadata": {
    object (DocumentMetadata)
  }
}
Fields
name

string

Identifier. The fully qualified resource name of the Document.

Format: projects/{project}/locations/{location}/dataStores/{dataStoreId}/documents/{documentId} The documentId must be 1-63 characters long, and comply with RFC1035.

When ImportDocuments imports files directly (the default source format), the service derives the documentId from the file's Cloud Storage URI: re-importing the same URI updates the same Document, and a renamed or moved file becomes a new Document. With SOURCE_FORMAT_DOCUMENT_JSON, the documentId is taken from the name given in the input file.
createTime

string (Timestamp format)

Output only. Timestamp the Document was created at.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Output only. Timestamp the Document was last updated.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
content

object (Content)

Optional. The unstructured data linked to this Document: the Cloud Storage file it was imported from. Required in each line of a SOURCE_FORMAT_DOCUMENT_JSON input file.
etag

string

Optional. The etag of the Document.
metadata

object (DocumentMetadata)

Optional. User-defined metadata for this Document. The metadata values must conform to the documentMetadataSchema defined on the parent DataStore.

Content

Unstructured data linked to this Document.

JSON representation 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "gcsUri": string
  // End of mutually exclusive fields.
}
Fields
The content of the unstructured Document. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response:
gcsUri

string

The Cloud Storage URI of the content. Only Cloud Storage URIs (e.g. gs://bucket-name/path/to/file) are supported.
End of mutually exclusive fields.

DocumentMetadata

User-defined metadata associated with a Document.

JSON representation 
{
  "value": {
    object
  }
}
Fields
value

object (Struct format)

Optional. The metadata value, as a JSON object. The value must conform to the documentMetadataSchema defined on the parent DataStore.

Methods

get

 Gets a Document.

list

 Lists Documents in a DataStore.
Searches the Documents of a single DataStore.