Corpus Permissions

Méthode : corpora.permissions.create

Créez une autorisation pour une ressource spécifique.

Point de terminaison

post https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*}/permissions

Paramètres de chemin d'accès

parent string

Obligatoire. Ressource parente de Permission. Formats : tunedModels/{tunedModel} corpora/{corpus}. Il se présente sous la forme corpora/{corpora}.

Corps de la requête

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

Champs
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" (TOUT LE MONDE).

role enum (Role)

Obligatoire. Rôle accordé par cette autorisation.

Exemple de requête

Python

# With Gemini 2 we're launching a new SDK. See the following doc for details.
# https://ai.google.dev/gemini-api/docs/migrate
README.md

Corps de la réponse

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

Méthode : corpora.permissions.list

Liste les autorisations pour la ressource spécifique.

Point de terminaison

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

Paramètres de chemin d'accès

parent string

Obligatoire. Ressource parente des autorisations. Formats : tunedModels/{tunedModel} corpora/{corpus}. Il se présente sous la forme corpora/{corpora}.

Paramètres de requête

pageSize integer

Facultatif. Nombre maximal de Permission à renvoyer (par page). Le service peut renvoyer moins d'autorisations.

Si aucune valeur n'est spécifiée, 10 autorisations au maximum sont renvoyées. Cette méthode renvoie au maximum 1 000 autorisations par page, même si vous transmettez une valeur pageSize plus élevée.

pageToken string

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

Fournissez le pageToken renvoyé par une requête 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 à permissions.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.

Exemple de requête

Python

# With Gemini 2 we're launching a new SDK. See the following doc for details.
# https://ai.google.dev/gemini-api/docs/migrate
README.md

Corps de la réponse

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

Méthode : corpora.permissions.get

Obtient des informations sur une autorisation spécifique.

Point de terminaison

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

Paramètres de chemin d'accès

name string

Obligatoire. Nom de ressource de l'autorisation.

Formats : tunedModels/{tunedModel}/permissions/{permission} corpora/{corpus}/permissions/{permission}. Il se présente sous la forme corpora/{corpora}/permissions/{permission}.

Corps de la requête

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

Exemple de requête

Python

# With Gemini 2 we're launching a new SDK. See the following doc for details.
# https://ai.google.dev/gemini-api/docs/migrate
README.md

Corps de la réponse

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

Méthode : corpora.permissions.patch

Met à jour l'autorisation.

Point de terminaison

patch https://generativelanguage.googleapis.com/v1beta/{permission.name=corpora/*/permissions/*}

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

Paramètres de chemin d'accès

permission.name string

Uniquement en sortie. Identifiant. Nom de l'autorisation. Un nom unique sera généré lors de la création. Exemples : tunedModels/{tunedModel}/permissions/{permission} corpora/{corpus}/permissions/{permission} Uniquement en sortie. Il se présente sous la forme corpora/{corpora}/permissions/{permission}.

Paramètres de requête

updateMask string (FieldMask format)

Obligatoire. Liste des champs à mettre à jour. Valeurs acceptées : - role (champ Permission.role)

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

Champs
role enum (Role)

Obligatoire. Rôle accordé par cette autorisation.

Exemple de requête

Python

# With Gemini 2 we're launching a new SDK. See the following doc for details.
# https://ai.google.dev/gemini-api/docs/migrate
README.md

Corps de la réponse

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

Méthode : corpora.permissions.delete

Supprime l'autorisation.

Point de terminaison

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

Paramètres de chemin d'accès

name string

Obligatoire. Nom de ressource de l'autorisation. Formats : tunedModels/{tunedModel}/permissions/{permission} corpora/{corpus}/permissions/{permission}. Il se présente sous la forme corpora/{corpora}/permissions/{permission}.

Corps de la requête

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

Exemple de requête

Python

# With Gemini 2 we're launching a new SDK. See the following doc for details.
# https://ai.google.dev/gemini-api/docs/migrate
README.md

Corps de la réponse

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

Ressource REST : corpora.permissions

Ressource : Permission

La ressource d'autorisation accorde à un utilisateur, à un groupe ou au reste du monde l'accès à la ressource de l'API PaLM (par exemple, un modèle ajusté ou un corpus).

Un rôle est un ensemble d'opérations autorisées qui permet aux utilisateurs d'effectuer des actions spécifiques sur les ressources de l'API PaLM. Pour les rendre disponibles aux utilisateurs, aux groupes ou aux comptes de service, vous devez leur attribuer des rôles. Lorsque vous attribuez un rôle, vous 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 ajusté ou le corpus) pour l'inférence.
  • Le rédacteur dispose des autorisations du lecteur, et peut également modifier et partager le document.
  • Le propriétaire dispose des autorisations de rédacteur et peut également supprimer le fichier.
Champs
name string

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

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" (TOUT LE MONDE).

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. Si cette option est définie, vous devez fournir l'adresse e-mail de l'utilisateur.
GROUP Représente un groupe. Si 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, modifier, partager et supprimer la ressource.
WRITER Le rédacteur peut utiliser, modifier et partager la ressource.
READER Le lecteur peut utiliser la ressource.

ListPermissionsResponse

Réponse de ListPermissions contenant une liste paginée d'autorisations.

Champs
permissions[] object (Permission)

Autorisations renvoyées.

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