Corpora

Méthode : corpora.create

Crée un Corpus vide.

Point de terminaison

Post https://generativelanguage.googleapis.com/v1beta/corpora

Corps de la requête

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

Champs
name string

Immuable. Identifiant. Nom de la ressource Corpus. L'ID (nom sans le préfixe "corpora/") 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/my-awesome-corpora-123a456b789c

displayName string

Facultatif. Nom lisible à afficher pour Corpus. Le nom à afficher ne doit pas dépasser 512 caractères, espaces compris. Exemple : "Documentation sur le Semantic Retriever"

Corps de la réponse

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

Méthode : corpora.query

Effectue une recherche sémantique sur un Corpus.

Point de terminaison

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

Paramètres de chemin d'accès

name string

Obligatoire. Nom de l'Corpus à interroger. 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 des données présentant la structure suivante :

Champs
query string

Obligatoire. Chaîne de requête permettant d'effectuer une recherche sémantique.

metadataFilters[] object (MetadataFilter)

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

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

MetadataFilter object list: metadataFilters = [ {key = &quot;document.custom_metadata.year&quot; conditions = [{int_value = 2020, operation = GREATER_EQUAL}, {int_value = 2010, operation = LESS}]}, {key = "document.custom_metadata.year" conditions = [{int_value = 2020, operation = GREATER_EQUAL}, {int_value = 2010, operation = LESS}]}, {key = "document.custom_metadata.genre" conditions = [{stringValue = &quot;drama&quot;, operation = EQUAL}, {stringValue = &quot;action&quot;, operation = EQUAL}]}]

Exemple de requête au niveau d'un segment pour une plage de valeurs numérique: (année > 2015 AND 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 une même clé ne sont acceptés que pour les valeurs numériques. Les valeurs de chaîne n'acceptent que les opérateurs "OU" pour la même clé.

resultsCount integer

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

Si aucune valeur n'est spécifiée, 10 Chunk au maximum seront renvoyés. Le nombre maximal de résultats spécifié est de 100.

Corps de la réponse

Réponse de corpora.query contenant une liste de fragments 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 segments pertinents.

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

Méthode : corpora.list

Liste tous les Corpora appartenant à l'utilisateur.

Point de terminaison

get https://generativelanguage.googleapis.com/v1beta/corpora

Paramètres de requête

pageSize integer

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

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

pageToken string

Facultatif. Jeton de page reçu d'un appel corpora.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 à corpora.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 corpora.list contenant une liste paginée de Corpora. Les résultats sont triés par ordre croissant de corpus.create_time.

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

Champs
corpora[] object (Corpus)

Les corpus 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 
{
  "corpora": [
    {
      object (Corpus)
    }
  ],
  "nextPageToken": string
}

Méthode: corpora.get

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

Point de terminaison

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

Paramètres de chemin d'accès

name string

Obligatoire. Nom du Corpus. 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 doit être vide.

Corps de la réponse

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

Méthode : corpora.patch

Met à jour un Corpus.

Point de terminaison

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

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

Paramètres de chemin d'accès

corpus.name string

Immuable. Identifiant. Nom de ressource Corpus. L'ID (nom sans le préfixe "corpora/") peut contenir jusqu'à 40 caractères alphanumériques en 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/my-awesome-corpora-123a456b789c. Il se présente sous la forme corpora/{corpora}.

Paramètres de requête

updateMask string (FieldMask format)

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

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

Champs
displayName string

Facultatif. Nom lisible à afficher pour Corpus. Le nom à afficher ne doit pas dépasser 512 caractères, espaces compris. Exemple : "Docs sur le récupérateur sémantique"

Corps de la réponse

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

Méthode: corpora.delete

Supprime un Corpus.

Point de terminaison

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

Paramètres de chemin d'accès

name string

Obligatoire. Nom de ressource de Corpus. Exemple: corpora/my-corpus-123. Il se présente sous la forme corpora/{corpora}.

Paramètres de requête

force boolean

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

Si la valeur est "false" (valeur par défaut), une erreur FAILED_PRECONDITION est renvoyée si Corpus contient des 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 est vide.

Ressource REST : corpora.permissions

Ressource : Autorisation

Une ressource d'autorisation permet à des utilisateurs, à des groupes ou au reste du monde d'accéder à la ressource de l'API PaLM (un modèle réglé ou un corpus, par exemple).

Un rôle est un ensemble d'opérations autorisées permettant aux utilisateurs d'effectuer des actions spécifiques sur les ressources de l'API PaLM. Pour les mettre à la disposition des utilisateurs, des groupes ou des comptes de service, vous devez leur attribuer des rôles. Lorsque vous attribuez un rôle, vous lui accordez les autorisations qu'il contient.

Il existe trois rôles concentriques. Chaque rôle est un sur-ensemble des opérations autorisées du rôle précédent :

  • Le lecteur peut utiliser la ressource (par exemple, le modèle affiné, le corpus) pour l'inférence.
  • le rédacteur dispose des autorisations de lecteur, et peut également modifier et partager le document ;
  • Propriétaire dispose des autorisations de rédacteur et peut en outre supprimer
Champs
name string

Uniquement en sortie. Identifiant. Nom de l'autorisation. Un nom unique est généré lors de la création. Exemples: ListenModels/{tunedModel}/permissions/{permission} corpora/{corpus}/permissions/{permission} Sortie uniquement.

granteeType enum (GranteeType)

Facultatif. Immuable. Type de bénéficiaire.

emailAddress string

Facultatif. Immuable. Adresse e-mail de l'utilisateur ou du groupe auquel cette autorisation fait référence. Le champ n'est pas défini lorsque le type de bénéficiaire de l'autorisation est EVERYONE.

role enum (Role)

Obligatoire. Rôle accordé par cette autorisation.

Représentation JSON 
{
  "name": string,
  "granteeType": enum (GranteeType),
  "emailAddress": string,
  "role": enum (Role)
}

GranteeType

Définit les types de bénéficiaires de cette autorisation.

Enums
GRANTEE_TYPE_UNSPECIFIED Valeur par défaut. Cette valeur n'est pas utilisée.
USER Représente un utilisateur. Lorsque ce paramètre est défini, vous devez fournir l'adresse e-mail de l'utilisateur.
GROUP Représente un groupe. Lorsque cette valeur est définie, vous devez fournir une adresse e-mail pour le groupe.
EVERYONE Représente l'accès à tous. Aucune information supplémentaire n'est requise.

Rôle

Définit le rôle accordé par cette autorisation.

Enums
ROLE_UNSPECIFIED Valeur par défaut. Cette valeur n'est pas utilisée.
OWNER Le propriétaire peut utiliser, mettre à jour, partager et supprimer la ressource.
WRITER L'auteur peut utiliser, mettre à jour et partager la ressource.
READER Le lecteur peut utiliser la ressource.

MetadataFilter

Filtre fourni par l'utilisateur pour limiter la récupération en fonction des valeurs de métadonnées au niveau Chunk ou Document. Exemple (genre = drame OU genre = action) : key = "document.custom_metadata.genre" conditions = [{stringValue = "drama", operation = EQUAL}, {stringValue = "action", operation = EQUAL}]

Champs
key string

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

conditions[] object (Condition)

Obligatoire. Condition pour la clé donnée qui déclenchera ce filtre. Plusieurs opérateurs Condition sont reliés par des opérateurs logiques OU.

Représentation JSON 
{
  "key": string,
  "conditions": [
    {
      object (Condition)
    }
  ]
}

Condition

Condition de filtre applicable à une seule clé.

Champs
operation enum (Operator)

Obligatoire. Opérateur appliqué à la paire clé-valeur donnée pour déclencher la condition.

Champ d'union value. Le type de valeur doit être cohérent avec celui défini dans le champ pour la clé correspondante. Si les types de valeurs ne sont pas cohérents, le résultat sera un ensemble vide. Lorsque l'CustomMetadata a un type de valeur StringList, la condition de filtrage doit utiliser string_value associé à une opération INCLUDES/EXCLUDES, sinon le résultat sera également un ensemble vide. value ne peut être que l'un des éléments suivants:
stringValue string

Valeur de chaîne à utiliser pour filtrer les métadonnées.

numericValue number

Valeur numérique sur laquelle filtrer les métadonnées.

Représentation JSON 
{
  "operation": enum (Operator),

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

Opérateur

Définit les opérateurs valides pouvant être appliqués à une paire clé-valeur.

Enums
OPERATOR_UNSPECIFIED Valeur par défaut. Cette valeur n'est pas utilisée.
LESS Compatible avec les valeurs numériques.
LESS_EQUAL Pris en charge par une valeur numérique.
EQUAL Pris en charge par les valeurs numériques & .
GREATER_EQUAL Pris en charge par une valeur numérique.
GREATER Pris en charge par une valeur numérique.
NOT_EQUAL Compatible avec les valeurs numériques et les chaînes.
INCLUDES Accepté par une chaîne uniquement lorsque le type de valeur CustomMetadata pour la clé donnée possède un stringListValue.
EXCLUDES Accepté par la chaîne uniquement lorsque le type de valeur CustomMetadata de la clé donnée comporte un stringListValue.

RelevantChunk

Informations sur un fragment pertinent pour une requête.

Champs
chunkRelevanceScore number

Chunk la pertinence par rapport à la requête.

chunk object (Chunk)

Chunk associé à la requête.

Représentation JSON 
{
  "chunkRelevanceScore": number,
  "chunk": {
    object (Chunk)
  }
}

Ressource REST: corpora

Ressource: corpus

Un Corpus est une collection de Document. Un projet peut créer jusqu'à cinq corpus.

Champs
name string

Immuable. Identifiant. Nom de la ressource Corpus. L'ID (nom sans le préfixe "corpora/") 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/my-awesome-corpora-123a456b789c

displayName string

Facultatif. Nom à afficher lisible par l'humain pour le Corpus. Le nom à afficher ne doit pas dépasser 512 caractères, espaces compris. Exemple : "Documentation sur le Semantic Retriever"

createTime string (Timestamp format)

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

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'Corpus.

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,
  "createTime": string,
  "updateTime": string
}