REST Resource: corpora.documents

Ressource : Document

Un Document est une collection de Chunk. Une Corpus ne peut pas comporter plus de 10 000 Documents.

Représentation JSON
{
  "name": string,
  "displayName": string,
  "customMetadata": [
    {
      object (CustomMetadata)
    }
  ],
  "updateTime": string,
  "createTime": string
}
Champs
name

string

Immuable. Identifiant. Nom de ressource Document. L'ID (nom sans le préfixe "corpora/*/documents/") peut contenir jusqu'à 40 caractères alphanumériques minuscules ou tirets (-). Il ne peut pas commencer ni se terminer par un tiret. Si le nom est vide à la création, un nom unique sera dérivé de displayName avec un suffixe aléatoire de 12 caractères. Exemple : corpora/{corpus_id}/documents/my-awesome-doc-123a456b789c

displayName

string

Facultatif. Nom lisible à afficher pour Document. Le nom à afficher ne doit pas dépasser 512 caractères, espaces compris. Exemple: "Documentation sémantique Retriever"

customMetadata[]

object (CustomMetadata)

Facultatif. Métadonnées personnalisées fournies par l'utilisateur, stockées sous forme de paires clé/valeur utilisées pour les requêtes. Un élément Document ne peut pas comporter plus de 20 CustomMetadata.

updateTime

string (Timestamp format)

Uniquement en sortie. Horodatage de la dernière mise à jour de Document.

Code temporel au format RFC3339 UTC "Zulu", avec une résolution à la nanoseconde et jusqu'à neuf chiffres fractionnaires. Exemples: "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".

createTime

string (Timestamp format)

Uniquement en sortie. Horodatage de la création de Document.

Code temporel au format RFC3339 UTC "Zulu", avec une résolution à la nanoseconde et jusqu'à neuf chiffres fractionnaires. Exemples: "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".

Méthodes

create

Crée un Document vide.

delete

Supprime un Document.

get

Récupère des informations sur un Document spécifique.

list

Liste tous les Document d'une Corpus.

patch

Met à jour une Document.

query

Effectue une recherche sémantique sur un Document.