Documents

L'API File Search référence vos fichiers sources bruts ou vos documents en tant qu'objets File temporaires.

Méthode : fileSearchStores.documents.delete

Supprime un Document.

Point de terminaison

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

Paramètres de chemin d'accès

name string

Obligatoire. Nom de ressource du Document à supprimer. Exemple : fileSearchStores/my-file-search-store-123/documents/the-doc-abc se présente sous la forme fileSearchStores/{filesearchstore}/documents/{document}.

Paramètres de requête

force boolean

Facultatif. Si la valeur est définie sur "true", tous les Chunk et objets associés à ce 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 un objet JSON vide.

Méthode : fileSearchStores.documents.get

Obtient des informations sur un Document spécifique.

Point de terminaison

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

Paramètres de chemin d'accès

name string

Obligatoire. Nom du Document à récupérer. Exemple : fileSearchStores/my-file-search-store-123/documents/the-doc-abc se présente sous la forme fileSearchStores/{filesearchstore}/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 : fileSearchStores.documents.list

Répertorie tous les Document d'un Corpus.

Point de terminaison

get https://generativelanguage.googleapis.com/v1beta/{parent=fileSearchStores/*}/documents

Paramètres de chemin d'accès

parent string

Obligatoire. Nom du FileSearchStore contenant les Document. Exemple : fileSearchStores/my-file-search-store-123 se présente sous la forme fileSearchStores/{filesearchstore}.

Paramètres de requête

pageSize integer

Facultatif. Nombre maximal de Document à renvoyer (par page). Le service peut renvoyer un nombre inférieur de Document.

Si aucune valeur n'est spécifiée, 10 Document au maximum sont renvoyés. La limite de 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 en tant qu'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 pas d'autres pages.

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

Méthode : fileSearchStores.documents.query

Effectue une recherche sémantique sur un Document.

Point de terminaison

post https://generativelanguage.googleapis.com/v1beta/{name=fileSearchStores/*/documents/*}:query

Paramètres de chemin d'accès

name string

Obligatoire. Nom du Document à interroger. Exemple : fileSearchStores/my-file-search-store-123/documents/the-doc-abc se présente sous la forme fileSearchStores/{filesearchstore}/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 de Chunk à renvoyer. Le service peut renvoyer un nombre inférieur de Chunk.

Si aucune valeur n'est spécifiée, 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 associés par des "ET" logiques.

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

Exemple de requête : (year >= 2020 OR year < 2010) AND (genre = drama OR genre = action)

MetadataFilter object list: 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 : (year > 2015 AND year <= 2020)

MetadataFilter object list: 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 "AND" pour la même clé ne sont acceptés que pour les valeurs numériques. Les valeurs de chaîne n'acceptent que les "OR" pour la même clé.

Corps de la réponse

Réponse de documents.query contenant une liste de blocs 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 blocs pertinents renvoyés.

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

Ressource REST : fileSearchStores.documents

Ressource : Document

Un Document est une collection de Chunk.

Champs
name string

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

displayName string

Facultatif. Nom à afficher lisible pour Document. Le nom à afficher ne doit pas comporter plus de 512 caractères, espaces compris. Exemple : "Documentation sur le récupérateur sémantique"

customMetadata[] object (CustomMetadata)

Facultatif. Métadonnées personnalisées fournies par l'utilisateur, stockées sous forme de paires clé/valeur et 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.

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".

createTime string (Timestamp format)

Uniquement en sortie. Code temporel de création de 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".

state enum (State)

Uniquement en sortie. État actuel de Document.

sizeBytes string (int64 format)

Uniquement en sortie. Taille des octets bruts ingérés dans le document.

mimeType string

Uniquement en sortie. Type MIME du document.

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

État

États du cycle de vie d'un Document.

Enums
STATE_UNSPECIFIED Valeur par défaut. Cette valeur est utilisée si l'état est omis.
STATE_PENDING Certains Chunks de Document sont en cours de traitement (stockage d'embeddings et de vecteurs).
STATE_ACTIVE Tous les Chunks du Document sont traités et peuvent être interrogés.
STATE_FAILED Le traitement de certains Chunks sur Document a échoué.