Corpus Perissions

Méthode: corpora.permissions.list

Répertorie les autorisations pour la ressource spécifique.

Point de terminaison

<ph type="x-smartling-placeholder"></ph> obtenir 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 prend la forme corpora/{corpora}.

Paramètres de requête

pageSize integer

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

Si aucune autorisation n'est spécifiée, 10 autorisations au maximum seront renvoyées. Cette méthode renvoie 1 000 autorisations par page au maximum, même si vous transmettez une taille de page plus importante.

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 à 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

model_info = genai.get_model("tunedModels/my-increment-model")

# ...

for p in model_info.permissions.list():
    print(p)

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

Supprime l'autorisation.

Point de terminaison

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

model_info = genai.get_model("tunedModels/my-increment-model")
# ...

public_permission = model_info.permissions.create(
    role="READER",
    grantee_type="EVERYONE",
)

public_permission.delete()

Corps de la réponse

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

Méthode: corpora.permissions.create

Créer une autorisation pour une ressource spécifique

Point de terminaison

<ph type="x-smartling-placeholder"></ph> publier 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 prend la forme corpora/{corpora}.

Corps de la requête

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

Exemple de requête

Python

model_info = genai.get_model("tunedModels/my-increment-model")
# ...

public_permission = model_info.permissions.create(
    role="READER",
    grantee_type="EVERYONE",
)

group_permission = model_info.permissions.create(
    role="READER",
    # Use "user" for an individual email address.
    grantee_type="group",
    email_address="genai-samples-test-group@googlegroups.com",
)

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

Met à jour l'autorisation.

Point de terminaison

<ph type="x-smartling-placeholder"></ph> correctif 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: ListenModels/{tunedModel}/permissions/{permission} corpora/{corpus}/permissions/{permission} Sortie uniquement. 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. Autorisés: - rôle (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.

Exemple de requête

Python

        model_info = genai.get_model("tunedModels/my-increment-model")

        # ...

        test_group = model_info.permissions.create(
            role="writer",
            grantee_type="group",
            email_address="genai-samples-test-group@googlegroups.com",
        )

        test_group.update({"role": "READER"})

    def test_tuned_models_permission_delete(self):
        model_info = genai.get_model("tunedModels/my-increment-model")
        # ...

        public_permission = model_info.permissions.create(
            role="READER",
            grantee_type="EVERYONE",
        )

        public_permission.delete()


if __name__ == "__main__":
    absltest.main()

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

Récupère des informations sur une autorisation spécifique.

Point de terminaison

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

model_info = genai.get_model("tunedModels/my-increment-model")

# ...

public = model_info.permissions.create(
    role="READER",
    grantee_type="EVERYONE",
)
print(public)
name = public.name
print(name)  # tunedModels/{tunedModel}/permissions/{permission}

from_name = genai.types.Permissions.get(name)
print(from_name)

Corps de la réponse

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

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 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:

  • lecteur peut utiliser la ressource (ex. : modèle réglé, corpus) pour l'inférence
  • l'auteur dispose des autorisations de lecteur et peut en outre modifier et partager
  • Propriétaire dispose des autorisations de rédacteur et peut en outre supprimer
Représentation JSON 
{
  "name": string,
  "granteeType": enum (GranteeType),
  "emailAddress": string,
  "role": enum (Role)
}
Champs
name string

Uniquement en sortie. Identifiant. Nom de l'autorisation. Un nom unique sera 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 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.

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 ce champ est défini, vous devez fournir une adresse e-mail pour le groupe.
EVERYONE Représente l'accès pour 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 Le rédacteur peut utiliser, mettre à jour et partager la ressource.
READER Le lecteur peut utiliser la ressource.

ListPermissionsResponse

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

Représentation JSON 
{
  "permissions": [
    {
      object (Permission)
    }
  ],
  "nextPageToken": string
}
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 plus de pages.