REST Resource: projects.locations.dataStores.documents

Recurso: Document

Un documento es una unidad única de contenido que se transfiere a un DataStore. Es un recurso secundario de un DataStore. Durante la transferencia, un documento se analiza y se divide en uno o más segmentos.

Representación JSON
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "content": {
    object (Content)
  },
  "etag": string,
  "metadata": {
    object (DocumentMetadata)
  }
}
Campos
name

string

Es el identificador. Es el nombre de recurso completamente calificado del documento.

Formato: projects/{project}/locations/{location}/dataStores/{dataStoreId}/documents/{documentId} El documentId debe tener entre 1 y 63 caracteres, y cumplir con RFC1035.

Cuando ImportDocuments importa archivos directamente (el formato de origen predeterminado), el servicio deriva el documentId del URI de Cloud Storage del archivo: volver a importar el mismo URI actualiza el mismo documento, y un archivo renombrado o movido se convierte en un documento nuevo. Con SOURCE_FORMAT_DOCUMENT_JSON, el documentId se toma del name proporcionado en el archivo de entrada.

createTime

string (Timestamp format)

Solo salida. Es la marca de tiempo en la que se creó el documento.

Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

updateTime

string (Timestamp format)

Solo salida. Marca de tiempo de la última actualización del documento.

Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

content

object (Content)

Es opcional. Los datos no estructurados vinculados a este documento: el archivo de Cloud Storage desde el que se importó. Es obligatorio en cada línea de un archivo de entrada SOURCE_FORMAT_DOCUMENT_JSON.

etag

string

Es opcional. La etag del documento.

metadata

object (DocumentMetadata)

Es opcional. Son los metadatos definidos por el usuario para este documento. Los valores de los metadatos deben cumplir con el documentMetadataSchema definido en el DataStore superior.

Contenido

Son los datos no estructurados vinculados a este documento.

Representación JSON
{

  // 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.
}
Campos
Es el contenido del documento no estructurado. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta:
gcsUri

string

Es el URI de Cloud Storage del contenido. Solo se admiten los URI de Cloud Storage (p.ej., gs://bucket-name/path/to/file).

Fin de los campos mutuamente excluyentes.

DocumentMetadata

Son los metadatos definidos por el usuario asociados con un documento.

Representación JSON
{
  "value": {
    object
  }
}
Campos
value

object (Struct format)

Es opcional. Es el valor de los metadatos, como un objeto JSON. El valor debe cumplir con el documentMetadataSchema definido en el DataStore superior.

Métodos

get

Obtiene un documento.

list

Enumera los documentos de un DataStore.
Busca los documentos de un solo DataStore.