Documents

Méthode: corpora.documents.create

Crée un Document vide.

Point de terminaison

publier https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*}/documents

Paramètres de chemin d'accès

parent string

Obligatoire. Nom du Corpus dans lequel ce Document sera créé. Exemple : corpora/my-corpus-123 Il se présente sous la forme corpora/{corpora}.

Corps de la requête

Le corps de la requête contient une instance de Document.

Champs
name string

Immuable. Identifiant. Nom de ressource Document. L'ID (nom à l'exclusion du préfixe "corpora/*/documents/") peut contenir jusqu'à 40 caractères alphanumériques minuscules ou tirets (-). L'ID ne peut pas commencer ni se terminer par un tiret. Si le nom est vide lors de la création, un nom unique est dérivé de displayName, accompagné d'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 sur les récupérateurs"

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 Document ne peut pas contenir plus de 20 CustomMetadata.

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient une nouvelle instance de Document.

Méthode: corpora.documents.query

Effectue une recherche sémantique sur un Document.

Point de terminaison

Post https://generativelanguage.googleapis.com/v1beta/{name=corpora/*/documents/*}:query

Paramètres de chemin d'accès

name string

Obligatoire. Nom du Document à interroger. Exemple : corpora/my-corpus-123/documents/the-doc-abc Il se présente sous la forme corpora/{corpora}/documents/{document}.

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Champs
query string

Obligatoire. Chaîne de requête pour effectuer une recherche sémantique.

resultsCount integer

Facultatif. Nombre maximal d'éléments Chunk à renvoyer. Le service peut renvoyer moins de Chunk.

Si ce paramètre n'est pas spécifié, 10 Chunk au maximum sont renvoyés. Le nombre maximal de résultats spécifié est de 100.

metadataFilters[] object (MetadataFilter)

Facultatif. Filtrez les métadonnées Chunk. Chaque objet MetadataFilter doit correspondre à une clé unique. Plusieurs objets MetadataFilter sont joints par des opérateurs logiques "AND".

Remarque: Le filtrage au niveau Document n'est pas compatible avec cette requête, car un nom Document est déjà spécifié.

Exemple de requête: (année >= 2020 OR année < 2010) AND (genre = drame OR genre = action)

Liste d'objets MetadataFilter : metadataFilters = [ {key = "chunk.custom_metadata.year" conditions = [{int_value = 2020, operation = GREATER_EQUAL}, {int_value = 2010, operation = LESS}}, {key = "chunk.custom_metadata.genre" conditions = [{stringValue = "drama", operation = EQUAL}, {stringValue = "action", operation = EQUAL}}]

Exemple de requête pour une plage de valeurs numériques : (année > 2015 ET année <= 2020)

Liste d'objets MetadataFilter : metadataFilters = [ {key = "chunk.custom_metadata.year" conditions = [{int_value = 2015, operation = GREATER}]}, {key = "chunk.custom_metadata.year" conditions = [{int_value = 2020, operation = LESS_EQUAL}]}]

Remarque : Les opérateurs "AND" pour la même clé ne sont acceptés que pour les valeurs numériques. Les valeurs de chaîne n'acceptent que des opérateurs "OR" pour la même clé.

Corps de la réponse

Réponse de documents.query contenant une liste de segments pertinents.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Champs
relevantChunks[] object (RelevantChunk)

Les fragments pertinents renvoyés.

Représentation JSON 
{
  "relevantChunks": [
    {
      object (RelevantChunk)
    }
  ]
}

Méthode: corpora.documents.list

Répertorie toutes les Document d'un Corpus.

Point de terminaison

obtenir https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*}/documents

Paramètres de chemin d'accès

parent string

Obligatoire. Nom du Corpus contenant des Document. Exemple: corpora/my-corpus-123. Il se présente sous la forme corpora/{corpora}.

Paramètres de requête

pageSize integer

Facultatif. Nombre maximal d'éléments Document à renvoyer (par page). Le service peut renvoyer moins de Document.

Si aucune valeur n'est spécifiée, 10 Document au maximum seront renvoyés. La taille maximale est de 20 Document par page.

pageToken string

Facultatif. Jeton de page reçu d'un appel documents.list précédent.

Fournissez le nextPageToken renvoyé dans la réponse comme argument de la requête suivante pour récupérer la page suivante.

Lors de la pagination, tous les autres paramètres fournis à documents.list doivent correspondre à l'appel ayant fourni le jeton de page.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Réponse de documents.list contenant une liste paginée de Document. Les Document sont triés par document.create_time croissant.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Champs
documents[] object (Document)

Les Document renvoyés.

nextPageToken string

Jeton pouvant être envoyé en tant que pageToken pour récupérer la page suivante. Si ce champ est omis, il n'y a plus de pages.

Représentation JSON 
{
  "documents": [
    {
      object (Document)
    }
  ],
  "nextPageToken": string
}

Méthode: corpora.documents.get

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

Point de terminaison

get https://generativelanguage.googleapis.com/v1beta/{name=corpora/*/documents/*}

Paramètres de chemin d'accès

name string

Obligatoire. Nom de l'élément Document à récupérer. Exemple: corpora/my-corpus-123/documents/the-doc-abc. Il se présente sous la forme corpora/{corpora}/documents/{document}.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient une instance de Document.

Méthode : corpora.documents.patch

Met à jour un Document.

Point de terminaison

correctif https://generativelanguage.googleapis.com/v1beta/{document.name=corpora/*/documents/*}

PATCH https://generativelanguage.googleapis.com/v1beta/{document.name=corpora/*/documents/*}

Paramètres de chemin d'accès

document.name string

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

Paramètres de requête

updateMask string (FieldMask format)

Obligatoire. Liste des champs à mettre à jour. Actuellement, cela ne permet de mettre à jour que displayName et customMetadata.

Il s'agit d'une liste de noms de champs complets séparés par une virgule. Exemple : "user.displayName,photo"

Corps de la requête

Le corps de la requête contient une instance de Document.

Champs
displayName string

Facultatif. Nom à afficher lisible par l'humain pour le Document. Le nom à afficher ne doit pas dépasser 512 caractères, espaces compris. Exemple : "Documentation du Semantic 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 Document ne peut pas contenir plus de 20 CustomMetadata.

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient une instance de Document.

Méthode : corpora.documents.delete

Supprime un Document.

Point de terminaison

delete https://generativelanguage.googleapis.com/v1beta/{name=corpora/*/documents/*}

Paramètres de chemin d'accès

name string

Obligatoire. Nom de ressource du Document à supprimer. Exemple: corpora/my-corpus-123/documents/the-doc-abc. Il se présente sous la forme corpora/{corpora}/documents/{document}.

Paramètres de requête

force boolean

Facultatif. Si elle est définie sur "true", tous les Chunk et tous les objets associés à cette Document seront également supprimés.

Si la valeur est "false" (valeur par défaut), une erreur FAILED_PRECONDITION est renvoyée si Document contient des Chunk.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Si la requête aboutit, le corps de la réponse est vide.

Ressource REST : corpora.documents

Ressource : Document

Un Document est une collection de Chunk. Un élément Corpus peut comporter jusqu'à 10 000 éléments Document.

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 en minuscule ou des tirets (-). L'ID ne doit pas commencer ni se terminer par un tiret. Si le nom est vide lors de la création, un nom unique est 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 sur les récupérateurs"

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 Document peut comporter jusqu'à 20 CustomMetadata.

updateTime string (Timestamp format)

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

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".

createTime string (Timestamp format)

Uniquement en sortie. Code temporel de création de l'Document.

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".

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

CustomMetadata

Métadonnées fournies par l'utilisateur stockées sous forme de paires clé/valeur.

Champs
key string

Obligatoire. Clé des métadonnées à stocker.

Champ d'union value.

value ne peut être qu'un des éléments suivants :

stringValue string

Valeur de chaîne des métadonnées à stocker.

stringListValue object (StringList)

Valeur StringList des métadonnées à stocker.

numericValue number

Valeur numérique des métadonnées à stocker.

Représentation JSON 
{
  "key": string,

  // Union field value can be only one of the following:
  "stringValue": string,
  "stringListValue": {
    object (StringList)
  },
  "numericValue": number
  // End of list of possible types for union field value.
}

StringList

Valeurs de chaîne fournies par l'utilisateur attribuées à une seule clé de métadonnées.

Champs
values[] string

Valeurs de chaîne des métadonnées à stocker.

Représentation JSON 
{
  "values": [
    string
  ]
}