REST Resource: projects.locations.dataStores.documents

Ressource : Document

Un document est une unité de contenu unique ingérée dans un datastore. Il s'agit d'une sous-ressource d'un DataStore. Lors de l'ingestion, un document est analysé et divisé en un ou plusieurs segments.

Représentation JSON 
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "content": {
    object (Content)
  },
  "etag": string,
  "metadata": {
    object (DocumentMetadata)
  }
}
Champs
name

string

Identifiant. Nom complet de la ressource du document.

Format : projects/{project}/locations/{location}/dataStores/{dataStoreId}/documents/{documentId}. Le documentId doit comporter entre 1 et 63 caractères et respecter la norme RFC1035.

Lorsque ImportDocuments importe des fichiers directement (format source par défaut), le service dérive le documentId de l'URI Cloud Storage du fichier : la réimportation du même URI met à jour le même document, et un fichier renommé ou déplacé devient un nouveau document. Avec SOURCE_FORMAT_DOCUMENT_JSON, le documentId est extrait de l'élément name fourni dans le fichier d'entrée.
createTime

string (Timestamp format)

Uniquement en sortie. Code temporel de création du document.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Uniquement en sortie. Code temporel de la dernière mise à jour du document.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
content

object (Content)

Facultatif. Les données non structurées associées à ce document : le fichier Cloud Storage à partir duquel il a été importé. Obligatoire sur chaque ligne d'un fichier d'entrée SOURCE_FORMAT_DOCUMENT_JSON.
etag

string

Facultatif. Etag du document.
metadata

object (DocumentMetadata)

Facultatif. Métadonnées définies par l'utilisateur pour ce document. Les valeurs des métadonnées doivent être conformes au documentMetadataSchema défini sur le datastore parent.

Contenu

Données non structurées associées à ce document.

Représentation 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.
}
Champs
Contenu du document non structuré. Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse :
gcsUri

string

URI Cloud Storage du contenu. Seuls les URI Cloud Storage (par exemple, gs://bucket-name/path/to/file) sont acceptés.
Fin des champs mutuellement exclusifs.

DocumentMetadata

Métadonnées définies par l'utilisateur associées à un document.

Représentation JSON 
{
  "value": {
    object
  }
}
Champs
value

object (Struct format)

Facultatif. Valeur des métadonnées, sous la forme d'un objet JSON. La valeur doit être conforme au documentMetadataSchema défini sur le datastore parent.

Méthodes

get

 Récupère un document.

list

 Répertorie les documents d'un datastore.
Recherche dans les documents d'un seul datastore.