Permissions

Methode: tuneModels.permissions.create

Erstellen Sie eine Berechtigung für eine bestimmte Ressource.

Endpunkt

<ph type="x-smartling-placeholder"></ph> <ph type="x-smartling-placeholder"></ph> Beitrag https://generativelanguage.googleapis.com/v1beta/{parent=tunedModels/*}/permissions
.

Pfadparameter

parent string

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

Anfragetext

Der Anfragetext enthält eine Instanz von Permission.

<ph type="x-smartling-placeholder">
</ph> Felder
granteeType enum (GranteeType)

Optional. Nicht veränderbar. Der Typ des Empfängers einer Förderung.

emailAddress string

Optional. Nicht veränderbar. Die E-Mail-Adresse des Nutzers der Gruppe, auf die sich diese Berechtigung bezieht. Das Feld ist nicht festgelegt, wenn der Empfängertyp der Berechtigung „EVERYONE“ ist.

role enum (Role)

Erforderlich. Die durch diese Berechtigung gewährte Rolle.

Beispielanfrage

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",
)

Antworttext

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

Methode: tuneModels.permissions.get

Ruft Informationen zu einer bestimmten Berechtigung ab.

Endpunkt

<ph type="x-smartling-placeholder"></ph> <ph type="x-smartling-placeholder"></ph> erhalten https://generativelanguage.googleapis.com/v1beta/{name=tunedModels/*/permissions/*}
.

Pfadparameter

name string

Erforderlich. Der Ressourcenname der Berechtigung.

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

Anfragetext

Der Anfragetext muss leer sein.

Beispielanfrage

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)

Antworttext

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

Methode: tuneModels.permissions.list

Listet die Berechtigungen für die jeweilige Ressource auf.

Endpunkt

<ph type="x-smartling-placeholder"></ph> <ph type="x-smartling-placeholder"></ph> erhalten https://generativelanguage.googleapis.com/v1beta/{parent=tunedModels/*}/permissions
.

Pfadparameter

parent string

Erforderlich. Die übergeordnete Ressource der Berechtigungen. Formate: tunedModels/{tunedModel} corpora/{corpus} Sie 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 keine Angabe gemacht wird, werden maximal 10 Berechtigungen zurückgegeben. Diese Methode gibt maximal 1.000 Berechtigungen pro Seite zurück, auch wenn Sie größere Seitengrößen übergeben.

pageToken string

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

Geben Sie die von einer Anfrage zurückgegebene 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

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

# ...

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

Antworttext

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

Methode: tuneModels.permissions.patch

Aktualisiert die Berechtigung.

Endpunkt

<ph type="x-smartling-placeholder"></ph> <ph type="x-smartling-placeholder"></ph> Patch https://generativelanguage.googleapis.com/v1beta/{permission.name=tunedModels/*/permissions/*}
.

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

Pfadparameter

permission.name string

Nur Ausgabe. Kennung. Der Name der Berechtigung. Bei der Erstellung wird ein eindeutiger Name generiert. Beispiele: tunedModels/{tunedModel}/permissions/{permission} corpora/{corpus}/permissions/{permission} nur Ausgabe. Sie hat das Format tunedModels/{tunedmodel}/permissions/{permission}.

Abfrageparameter

updateMask string (FieldMask format)

Erforderlich. Die Liste der zu aktualisierenden Felder. Akzeptierte: – Rolle (Feld Permission.role)

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

Anfragetext

Der Anfragetext enthält eine Instanz von Permission.

<ph type="x-smartling-placeholder">
</ph> Felder
role enum (Role)

Erforderlich. Die durch diese Berechtigung gewährte Rolle.

Beispielanfrage

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

Antworttext

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

Methode: tuneModels.permissions.delete

Löscht die Berechtigung.

Endpunkt

<ph type="x-smartling-placeholder"></ph> <ph type="x-smartling-placeholder"></ph> Löschen https://generativelanguage.googleapis.com/v1beta/{name=tunedModels/*/permissions/*}
.

Pfadparameter

name string

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

Anfragetext

Der Anfragetext muss leer sein.

Beispielanfrage

Python

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

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

public_permission.delete()

Antworttext

Wenn der Vorgang erfolgreich ist, ist der Antworttext leer.

Methode: tuneModels.transferOwnership

Überträgt die Inhaberschaft des abgestimmten Modells. Dies ist die einzige Möglichkeit, die Inhaberschaft des abgestimmten Modells zu ändern. Für den aktuellen Inhaber wird die Rolle „Autor“ herabgestuft.

Endpunkt

<ph type="x-smartling-placeholder"></ph> <ph type="x-smartling-placeholder"></ph> Beitrag https://generativelanguage.googleapis.com/v1beta/{name=tunedModels/*}:transferOwnership
.

Pfadparameter

name string

Erforderlich. Der Ressourcenname des abgestimmten 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:

<ph type="x-smartling-placeholder">
</ph> Felder
emailAddress string

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

Antworttext

Wenn der Vorgang erfolgreich ist, ist der Antworttext leer.

REST-Ressource: tuneModels.permissions

Ressource: Berechtigung

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

Eine Rolle ist eine Sammlung zulässiger Vorgänge, mit denen Nutzer bestimmte Aktionen für PaLM API-Ressourcen ausführen können. Weisen Sie Rollen zu, um sie Nutzern, Gruppen oder Dienstkonten zur Verfügung zu stellen. Wenn Sie eine Rolle zuweisen, gewähren Sie damit die Berechtigungen, die in der Rolle enthalten sind.

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

  • Leser können die Ressource (z.B. abgestimmtes Modell, Korpus) für Inferenz verwenden
  • Autor verfügt über Leseberechtigungen und kann zusätzlich bearbeiten und freigeben.
  • Eigentümer verfügt über Schreibberechtigungen und kann zusätzlich löschen
<ph type="x-smartling-placeholder">
</ph> Felder
name string

Nur Ausgabe. Kennung. Der Name der Berechtigung. Bei der Erstellung 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 Empfängers einer Förderung.

emailAddress string

Optional. Nicht veränderbar. Die E-Mail-Adresse des Nutzers der Gruppe, auf die sich diese Berechtigung bezieht. Das Feld ist nicht festgelegt, wenn der Empfängertyp der Berechtigung „EVERYONE“ ist.

role enum (Role)

Erforderlich. Die durch diese Berechtigung gewährte Rolle.

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

ListPermissionsResponse

Antwort von ListPermissions mit einer paginierten Liste von Berechtigungen.

<ph type="x-smartling-placeholder">
</ph> 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, sind keine Seiten mehr vorhanden.

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