Permissions

Methode: tunedModels.permissions.create

Erstellen Sie eine Berechtigung für eine bestimmte Ressource.

Endpunkt

Beitrag https://generativelanguage.googleapis.com/v1beta/{parent=tunedModels/*}/permissions

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

parent string

Erforderlich. Die übergeordnete Ressource der Permission. Formate: tunedModels/{tunedModel} corpora/{corpus} Die URL hat das Format tunedModels/{tunedmodel}.

Anfragetext

Der Anfragetext enthält eine Instanz von Permission.

Felder
granteeType enum (GranteeType)

Optional. Nicht veränderbar. Der Typ des Begünstigten.

emailAddress string

Optional. Nicht veränderbar. Die E-Mail-Adresse des Nutzers oder der Gruppe, auf die sich diese Berechtigung bezieht. Das Feld wird nicht festgelegt, wenn der Begünstigtentyp der Berechtigung „JEDER“ ist.

role enum (Role)

Erforderlich. Die Rolle, die durch diese Berechtigung gewährt wird.

Beispielanfrage

Python

import google.generativeai as genai

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",
)
tuned_models.py

Antworttext

Bei Erfolg enthält der Antworttext eine neu erstellte Instanz von Permission.

Methode: tunedModels.permissions.get

Ruft Informationen zu einer bestimmten Berechtigung ab.

Endpunkt

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

name string

Erforderlich. Der Ressourcenname der Berechtigung.

Formate: tunedModels/{tunedModel}/permissions/{permission} corpora/{corpus}/permissions/{permission} Die URL hat das Format tunedModels/{tunedmodel}/permissions/{permission}.

Anfragetext

Der Anfragetext muss leer sein.

Beispielanfrage

Python

import google.generativeai as genai

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)
tuned_models.py

Antworttext

Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext eine Instanz von Permission.

Methode: tunedModels.permissions.list

Hier werden die Berechtigungen für die jeweilige Ressource aufgelistet.

Endpunkt

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

parent string

Erforderlich. Die übergeordnete Ressource der Berechtigungen. Formate: tunedModels/{tunedModel} corpora/{corpus} Die URL hat das Format tunedModels/{tunedmodel}.

Abfrageparameter

pageSize integer

Optional. Die maximale Anzahl von Permissions, die zurückgegeben werden sollen (pro Seite). Der Dienst gibt möglicherweise weniger Berechtigungen zurück.

Wenn nicht angegeben, werden maximal 10 Berechtigungen zurückgegeben. Mit dieser Methode werden maximal 1.000 Berechtigungen pro Seite zurückgegeben, auch wenn Sie eine größere pageSize übergeben.

pageToken string

Optional. Ein Seitentoken, das von einem vorherigen permissions.list-Aufruf empfangen wurde.

Geben Sie den von einer Anfrage zurückgegebenen Wert „pageToken“ als Argument für die nächste Anfrage an, um die nächste Seite abzurufen.

Beim Paginieren müssen alle anderen für permissions.list bereitgestellten Parameter mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat.

Anfragetext

Der Anfragetext muss leer sein.

Beispielanfrage

Python

import google.generativeai as genai

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

# ...

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

Antworttext

Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext eine Instanz von ListPermissionsResponse.

Methode: tunedModels.permissions.patch

Aktualisiert die Berechtigung.

Endpunkt

Patch https://generativelanguage.googleapis.com/v1beta/{permission.name=tunedModels/*/permissions/*}

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

permission.name string

Nur Ausgabe. Kennung. Der Name der Berechtigung. Beim Erstellen wird ein eindeutiger Name generiert. Beispiele: tunedModels/{tunedModel}/permissions/{permission} corpora/{corpus}/permissions/{permission} Nur Ausgabe. Es hat das Format tunedModels/{tunedmodel}/permissions/{permission}.

Abfrageparameter

updateMask string (FieldMask format)

Erforderlich. Die Liste der zu aktualisierenden Felder. Zulässige Werte:  – „role“ (Permission.role-Feld)

Dies ist eine durch Kommas getrennte Liste vollständig qualifizierter Feldnamen. Beispiel: "user.displayName,photo".

Anfragetext

Der Anfragetext enthält eine Instanz von Permission.

Felder
role enum (Role)

Erforderlich. Die Rolle, die durch diese Berechtigung gewährt wird.

Beispielanfrage

Python

        import google.generativeai as genai

        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):
        import google.generativeai as genai

        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()

tuned_models.py

Antworttext

Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext eine Instanz von Permission.

Methode: tunedModels.permissions.delete

Die Berechtigung wird gelöscht.

Endpunkt

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

name string

Erforderlich. Der Ressourcenname der Berechtigung. Formate: tunedModels/{tunedModel}/permissions/{permission} corpora/{corpus}/permissions/{permission} Die URL hat das Format tunedModels/{tunedmodel}/permissions/{permission}.

Anfragetext

Der Anfragetext muss leer sein.

Beispielanfrage

Python

import google.generativeai as genai

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

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

public_permission.delete()
tuned_models.py

Antworttext

Wenn der Vorgang erfolgreich ist, ist der Antworttext leer.

Methode: tunedModels.transferOwnership

Überträgt die Inhaberschaft des optimierten Modells. Das ist die einzige Möglichkeit, die Inhaberschaft des optimierten Modells zu ändern. Der aktuelle Inhaber wird auf die Rolle „Mitbearbeiter“ herabgestuft.

Endpunkt

Beitrag https://generativelanguage.googleapis.com/v1beta/{name=tunedModels/*}:transferOwnership

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

name string

Erforderlich. Der Ressourcenname des optimierten Modells, dessen Inhaberschaft übertragen werden soll.

Format: tunedModels/my-model-id. Sie hat das Format tunedModels/{tunedmodel}.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

Felder
emailAddress string

Erforderlich. Die E-Mail-Adresse des Nutzers, an den das optimierte Modell übertragen wird.

Antworttext

Wenn der Vorgang erfolgreich ist, ist der Antworttext leer.

REST-Ressource: tunedModels.permissions

Ressource: Berechtigung

Die Berechtigungsressource gewährt Nutzern, Gruppen oder allen anderen Zugriff auf die PaLM API-Ressource (z.B. ein abgestimmtes Modell, ein Korpus).

Eine Rolle ist eine Sammlung zulässiger Vorgänge, mit denen Nutzer bestimmte Aktionen für PaLM API-Ressourcen ausführen können. Wenn Sie sie Nutzern, Gruppen oder Dienstkonten zur Verfügung stellen möchten, müssen Sie ihnen Rollen zuweisen. Wenn Sie eine Rolle zuweisen, gewähren Sie die Berechtigungen, die diese Rolle umfasst.

Es gibt drei konzentrische Rollen. Jede Rolle ist eine Übermenge der zulässigen Vorgänge der vorherigen Rolle:

  • Der Leser kann die Ressource (z. B. ein abgestimmtes Modell oder einen Korpus) für die Inferenz verwenden.
  • „Bearbeiter“ hat die Berechtigungen eines Lesers und kann zusätzlich bearbeiten und freigeben
  • Inhaber hat Schreibberechtigungen und kann zusätzlich löschen
Felder
name string

Nur Ausgabe. Kennung. Der Name der Berechtigung. Beim Erstellen wird ein eindeutiger Name generiert. Beispiele: tunedModels/{tunedModel}/permissions/{permission} corpora/{corpus}/permissions/{permission} Nur Ausgabe.

granteeType enum (GranteeType)

Optional. Nicht veränderbar. Der Typ des Begünstigten.

emailAddress string

Optional. Nicht veränderbar. Die E-Mail-Adresse des Nutzers oder der Gruppe, auf die sich diese Berechtigung bezieht. Das Feld wird nicht festgelegt, wenn der Begünstigtentyp der Berechtigung „JEDER“ ist.

role enum (Role)

Erforderlich. Die Rolle, die durch diese Berechtigung gewährt wird.

JSON-Darstellung 
{
  "name": string,
  "granteeType": enum (GranteeType),
  "emailAddress": string,
  "role": enum (Role)
}

ListPermissionsResponse

Antwort von ListPermissions mit einer paginaten Liste von Berechtigungen.

Felder
permissions[] object (Permission)

Zurückgegebene Berechtigungen

nextPageToken string

Ein Token, das als pageToken gesendet werden kann, um die nächste Seite abzurufen.

Wenn dieses Feld weggelassen wird, gibt es keine weiteren Seiten.

JSON-Darstellung 
{
  "permissions": [
    {
      object (Permission)
    }
  ],
  "nextPageToken": string
}