Chunks

Ressource REST: corpora.documents.chunks

Ressource: Fragment

Un Chunk est une sous-partie d'une Document traitée comme une unité indépendante à des fins de représentation vectorielle et de stockage. Un élément Corpus ne peut pas comporter plus d'un million d'instances Chunk.

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

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

data object (ChunkData)

Obligatoire. Le contenu de Chunk, par exemple la chaîne de texte. Le nombre maximal de jetons par fragment 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 d'CustomMetadata par fragment est de 20.

createTime string (Timestamp format)

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

ChunkData

Données extraites représentant le contenu Chunk.

Représentation JSON 
{

  // Union field data can be only one of the following:
  "stringValue": string
  // End of list of possible types for union field data.
}
Champs

Champ d'union data.

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

stringValue string

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

État

États pour le 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 (représentation vectorielle continue et stockage vectoriel).
STATE_ACTIVE Chunk est traité et disponible pour l'interrogation.
STATE_FAILED Échec du traitement de Chunk.

Méthode: corpora.documents.chunks.create

Crée un objet Chunk.

Point de terminaison

<ph type="x-smartling-placeholder"></ph> publier https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*/documents/*}/chunks .

Paramètres de chemin d'accès

parent string

Obligatoire. Nom du 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.

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 toutes les Chunk d'un Document.

Point de terminaison

<ph type="x-smartling-placeholder"></ph> obtenir https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*/documents/*}/chunks .

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 d'éléments Chunk à renvoyer (par page). Le service peut renvoyer moins de Chunk.

Si aucune valeur n'est spécifiée, 10 Chunk au maximum seront 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 en tant qu'argument à 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 d'éléments Chunk. Les éléments Chunk sont triés dans l'ordre croissant des valeurs chunk.create_time.

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

Champs
chunks[] object (Chunk)

Les 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

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

Point de terminaison

<ph type="x-smartling-placeholder"></ph> obtenir https://generativelanguage.googleapis.com/v1beta/{name=corpora/*/documents/*/chunks/*} .

Paramètres de chemin d'accès

name string

Obligatoire. Nom du 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

<ph type="x-smartling-placeholder"></ph> correctif https://generativelanguage.googleapis.com/v1beta/{chunk.name=corpora/*/documents/*/chunks/*} .

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

Paramètres de chemin d'accès

chunk.name string

Immuable. Identifiant. Nom de ressource Chunk. L'ID (nom à l'exclusion du préfixe "corpora/*/documents/*/chunks/") 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 ID unique aléatoire de 12 caractères est généré. 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, cela 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.

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

<ph type="x-smartling-placeholder"></ph> supprimer https://generativelanguage.googleapis.com/v1beta/{name=corpora/*/documents/*/chunks/*} .

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éation groupée d'objets Chunk.

Point de terminaison

<ph type="x-smartling-placeholder"></ph> publier https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*/documents/*}/chunks:batchCreate .

Paramètres de chemin d'accès

parent string

Facultatif. Nom du Document dans lequel ce lot d'objets Chunk sera créé. Le champ parent dans 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 :

<ph type="x-smartling-placeholder">
</ph> 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éés.

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

CreateChunkRequest

Requête de création d'un Chunk.

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

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

chunk object (Chunk)

Obligatoire. Le Chunk à créer.

Méthode: corpora.documents.chunks.batchUpdate

Mise à jour groupée des Chunk.

Point de terminaison

<ph type="x-smartling-placeholder"></ph> publier https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*/documents/*}/chunks:batchUpdate .

Paramètres de chemin d'accès

parent string

Facultatif. Nom du Document contenant les Chunk à mettre à jour. Le champ parent dans 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 :

<ph type="x-smartling-placeholder">
</ph> Champs
requests[] object (UpdateChunkRequest)

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

Corps de la réponse

Réponse de chunks.batchUpdate contenant une liste des Chunk mises à 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)

Chunk mis à jour.

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

UpdateChunkRequest

Requête de mise à jour d'un Chunk.

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

Obligatoire. Le Chunk à mettre à jour.

updateMask string (FieldMask format)

Obligatoire. Liste des champs à mettre à jour. Actuellement, cela 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"

Méthode: corpora.documents.chunks.batchDelete

Supprimez les Chunks de manière groupée.

Point de terminaison

<ph type="x-smartling-placeholder"></ph> publier https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*/documents/*}/chunks:batchDelete .

Paramètres de chemin d'accès

parent string

Facultatif. Nom du Document contenant les Chunk à supprimer. Le champ parent dans 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 :

<ph type="x-smartling-placeholder">
</ph> 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

Requête de suppression d'un Chunk.

Représentation JSON 
{
  "name": string
}
Champs
name string

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