REST Resource: projects.locations.dataStores.documents

Recurso: Document

Um documento é uma única unidade de conteúdo ingerida em um repositório de dados. É um sub-recurso de um DataStore. Durante a ingestão, um Documento é analisado e dividido em um ou mais Segmentos.

Representação JSON 
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "content": {
    object (Content)
  },
  "etag": string,
  "metadata": {
    object (DocumentMetadata)
  }
}
Campos
name

string

Identificador. O nome totalmente qualificado do recurso do documento.

Formato: projects/{project}/locations/{location}/dataStores/{dataStoreId}/documents/{documentId} O documentId precisa ter de 1 a 63 caracteres e estar em conformidade com o RFC1035.

Quando o ImportDocuments importa arquivos diretamente (o formato de origem padrão), o serviço deriva o documentId do URI do Cloud Storage do arquivo: a reimportação do mesmo URI atualiza o mesmo documento, e um arquivo renomeado ou movido se torna um novo documento. Com SOURCE_FORMAT_DOCUMENT_JSON, o documentId é retirado do name fornecido no arquivo de entrada.
createTime

string (Timestamp format)

Apenas saída. Carimbo de data/hora em que o documento foi criado.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Apenas saída. Carimbo de data/hora da última atualização do documento.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
content

object (Content)

Opcional. Os dados não estruturados vinculados a este Documento: o arquivo do Cloud Storage de onde ele foi importado. Obrigatório em cada linha de um arquivo de entrada SOURCE_FORMAT_DOCUMENT_JSON.
etag

string

Opcional. A ETag do documento.
metadata

object (DocumentMetadata)

Opcional. Metadados definidos pelo usuário para este documento. Os valores de metadados precisam estar em conformidade com o documentMetadataSchema definido no DataStore pai.

Conteúdo

Dados não estruturados vinculados a este documento.

Representação 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
O conteúdo do documento não estruturado. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:
gcsUri

string

O URI do Cloud Storage do conteúdo. Somente URIs do Cloud Storage (por exemplo, gs://bucket-name/path/to/file) são compatíveis.
Fim dos campos mutuamente exclusivos.

DocumentMetadata

Metadados definidos pelo usuário associados a um documento.

Representação JSON 
{
  "value": {
    object
  }
}
Campos
value

object (Struct format)

Opcional. O valor dos metadados, como um objeto JSON. O valor precisa estar em conformidade com o documentMetadataSchema definido no DataStore pai.

Métodos

get

 Recebe um documento.

list

 Lista documentos em um DataStore.
Pesquisa os documentos de um único DataStore.