Chunks

Méthode: corpora.documents.chunks.create

Crée un objet Chunk.

Point de terminaison

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

parent string

Obligatoire. Nom de l'Document dans lequel ce Chunk sera créé. 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 une instance de Chunk.

Champs
name string

Immuable. Identifiant. Nom de la ressource Chunk. L'ID (nom sans le préfixe "corpora/*/documents/*/chunks/") 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 identifiant unique de 12 caractères est généré de manière aléatoire. Exemple : corpora/{corpus_id}/documents/{document_id}/chunks/123a456b789c

data object (ChunkData)

Obligatoire. Contenu de Chunk, par exemple la chaîne de texte. Le nombre maximal de jetons par bloc est de 2 043.

customMetadata[] object (CustomMetadata)

Facultatif. Métadonnées personnalisées fournies par l'utilisateur, stockées sous forme de paires clé-valeur. Le nombre maximal de CustomMetadata par bloc est de 20.

Corps de la réponse

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

Méthode: corpora.documents.chunks.list

Répertorie tous les Chunk d'un Document.

Point de terminaison

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

parent string

Obligatoire. Nom du Document contenant des Chunk. 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

pageSize integer

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

Si ce paramètre n'est pas spécifié, 10 Chunk au maximum sont renvoyés. La taille maximale est de 100 Chunk par page.

pageToken string

Facultatif. Jeton de page reçu d'un appel chunks.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 à chunks.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 chunks.list contenant une liste paginée de Chunk. Les Chunk sont triés par chunk.create_time croissant.

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

Champs
chunks[] object (Chunk)

Chunk 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 
{
  "chunks": [
    {
      object (Chunk)
    }
  ],
  "nextPageToken": string
}

Méthode: corpora.documents.chunks.get

Obtient des informations sur un Chunk spécifique.

Point de terminaison

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

name string

Obligatoire. Nom de l'Chunk à récupérer. Exemple: corpora/my-corpus-123/documents/the-doc-abc/chunks/some-chunk Il se présente sous la forme corpora/{corpora}/documents/{document}/chunks/{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 contient une instance de Chunk.

Méthode: corpora.documents.chunks.patch

Met à jour un Chunk.

Point de terminaison

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

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

chunk.name string

Immuable. Identifiant. Nom de la ressource Chunk. L'ID (nom sans le préfixe "corpora/*/documents/*/chunks/") 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 identifiant unique de 12 caractères est généré de manière aléatoire. Exemple: corpora/{corpus_id}/documents/{document_id}/chunks/123a456b789c Il se présente sous la forme corpora/{corpora}/documents/{document}/chunks/{chunk}.

Paramètres de requête

updateMask string (FieldMask format)

Obligatoire. Liste des champs à mettre à jour. Actuellement, cette fonctionnalité ne permet de mettre à jour que customMetadata et data.

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

Champs
data object (ChunkData)

Obligatoire. Contenu de Chunk, par exemple la chaîne de texte. Le nombre maximal de jetons par bloc est de 2 043.

customMetadata[] object (CustomMetadata)

Facultatif. Métadonnées personnalisées fournies par l'utilisateur, stockées sous forme de paires clé-valeur. Le nombre maximal de CustomMetadata par bloc est de 20.

Corps de la réponse

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

Méthode: corpora.documents.chunks.delete

Supprime un Chunk.

Point de terminaison

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

name string

Obligatoire. Nom de ressource du Chunk à supprimer. Exemple: corpora/my-corpus-123/documents/the-doc-abc/chunks/some-chunk Il se présente sous la forme corpora/{corpora}/documents/{document}/chunks/{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.

Méthode: corpora.documents.chunks.batchCreate

Créez des Chunk par lot.

Point de terminaison

Poster https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*/documents/*}/chunks:batchCreate

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

parent string

Facultatif. Nom de l'Document dans lequel ce lot de Chunk sera créé. Le champ parent de chaque CreateChunkRequest doit correspondre à cette valeur. 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
requests[] object (CreateChunkRequest)

Obligatoire. Messages de requête spécifiant les Chunk à créer. Vous pouvez créer jusqu'à 100 Chunk par lot.

Corps de la réponse

Réponse de chunks.batchCreate contenant une liste des Chunk créés.

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

Champs
chunks[] object (Chunk)

Chunk créées.

Représentation JSON 
{
  "chunks": [
    {
      object (Chunk)
    }
  ]
}

CreateChunkRequest

Demande de création d'un Chunk.

Champs
parent string

Obligatoire. Nom de l'Document dans lequel ce Chunk sera créé. Exemple : corpora/my-corpus-123/documents/the-doc-abc

chunk object (Chunk)

Obligatoire. Chunk à créer.

Représentation JSON 
{
  "parent": string,
  "chunk": {
    object (Chunk)
  }
}

Méthode: corpora.documents.chunks.batchUpdate

Mise à jour groupée des Chunk.

Point de terminaison

Poster https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*/documents/*}/chunks:batchUpdate

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

parent string

Facultatif. Nom de l'Document contenant les Chunk à mettre à jour. Le champ parent de chaque UpdateChunkRequest doit correspondre à cette valeur. 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
requests[] object (UpdateChunkRequest)

Obligatoire. Messages de requête spécifiant les Chunk à mettre à jour. Vous pouvez mettre à jour un maximum de 100 Chunk par lot.

Corps de la réponse

Réponse de chunks.batchUpdate contenant une liste de Chunk mis à jour.

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

Champs
chunks[] object (Chunk)

Chunks mis à jour.

Représentation JSON 
{
  "chunks": [
    {
      object (Chunk)
    }
  ]
}

UpdateChunkRequest

Demande de mise à jour d'un Chunk.

Champs
chunk object (Chunk)

Obligatoire. Chunk à mettre à jour.

updateMask string (FieldMask format)

Obligatoire. Liste des champs à mettre à jour. Actuellement, cette fonctionnalité ne permet de mettre à jour que customMetadata et data.

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

Représentation JSON 
{
  "chunk": {
    object (Chunk)
  },
  "updateMask": string
}

Méthode: corpora.documents.chunks.batchDelete

Supprimez des Chunk par lot.

Point de terminaison

Poster https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*/documents/*}/chunks:batchDelete

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

parent string

Facultatif. Nom du Document contenant les Chunk à supprimer. Le champ parent de chaque DeleteChunkRequest doit correspondre à cette valeur. 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
requests[] object (DeleteChunkRequest)

Obligatoire. Messages de requête spécifiant les Chunk à supprimer.

Corps de la réponse

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

DeleteChunkRequest

Demande de suppression d'un Chunk.

Champs
name string

Obligatoire. Nom de ressource du Chunk à supprimer. Exemple : corpora/my-corpus-123/documents/the-doc-abc/chunks/some-chunk

Représentation JSON 
{
  "name": string
}

Ressource REST: corpora.documents.chunks

Ressource: Chunk

Un Chunk est une sous-partie d'un Document qui est traité comme une unité indépendante à des fins de représentation et de stockage vectoriels. Un Corpus peut comporter jusqu'à un million de Chunk.

Champs
name string

Immuable. Identifiant. Nom de la ressource Chunk. L'ID (nom sans le préfixe "corpora/*/documents/*/chunks/") 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 identifiant unique de 12 caractères est généré de manière aléatoire. Exemple : corpora/{corpus_id}/documents/{document_id}/chunks/123a456b789c

data object (ChunkData)

Obligatoire. Contenu de Chunk, par exemple la chaîne de texte. Le nombre maximal de jetons par bloc est de 2 043.

customMetadata[] object (CustomMetadata)

Facultatif. Métadonnées personnalisées fournies par l'utilisateur stockées sous forme de paires clé-valeur. Le nombre maximal de CustomMetadata par bloc est de 20.

createTime string (Timestamp format)

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

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

updateTime string (Timestamp format)

Uniquement en sortie. Code temporel de la dernière mise à jour de l'Chunk.

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

state enum (State)

Uniquement en sortie. État actuel de Chunk.

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

ChunkData

Données extraites représentant le contenu Chunk.

Champs
data Union type
data ne peut être qu'un des éléments suivants :
stringValue string

Contenu Chunk sous forme de chaîne. Le nombre maximal de jetons par bloc est de 2 043.

Représentation JSON 
{

  // data
  "stringValue": string
  // Union type
}

État

États du cycle de vie d'un Chunk.

Enums
STATE_UNSPECIFIED Valeur par défaut. Cette valeur est utilisée si l'état est omis.
STATE_PENDING_PROCESSING Chunk est en cours de traitement (embeddings et stockage vectoriel).
STATE_ACTIVE Chunk est traité et disponible pour les requêtes.
STATE_FAILED Échec du traitement Chunk.