Corpus Permissions

Methode: corpora.permissions.create

Erstellen Sie eine Berechtigung für eine bestimmte Ressource.

Endpunkt

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

Pfadparameter

parent string

Erforderlich. Die übergeordnete Ressource von Permission. Formate: tunedModels/{tunedModel} corpora/{corpus} Das Format ist corpora/{corpora}.

Anfragetext

Der Anfragetext enthält eine Instanz von Permission.

Felder
granteeType enum (GranteeType)

Optional. Nicht veränderbar. Der Typ des Lizenznehmers.

emailAddress string

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

role enum (Role)

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

Beispielanfrage

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

Antworttext

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

Methode: corpora.permissions.list

Listet Berechtigungen für die angegebene Ressource auf.

Endpunkt

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

Pfadparameter

parent string

Erforderlich. Die übergeordnete Ressource der Berechtigungen. Formate: tunedModels/{tunedModel} corpora/{corpus} Das Format ist corpora/{corpora}.

Abfrageparameter

pageSize integer

Optional. Die maximale Anzahl der zurückzugebenden Permissions (pro Seite). Der Dienst gibt möglicherweise weniger Berechtigungen zurück.

Wenn nicht angegeben, werden maximal 10 Berechtigungen zurückgegeben. Diese Methode gibt maximal 1.000 Berechtigungen pro Seite zurück, auch wenn Sie einen größeren Wert für „pageSize“ übergeben.

pageToken string

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

Geben Sie das 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

# 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

Antworttext

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

Methode: corpora.permissions.get

Ruft Informationen zu einer bestimmten Berechtigung ab.

Endpunkt

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

Pfadparameter

name string

Erforderlich. Der Ressourcenname der Berechtigung.

Formate: tunedModels/{tunedModel}/permissions/{permission} corpora/{corpus}/permissions/{permission} Das Format ist corpora/{corpora}/permissions/{permission}.

Anfragetext

Der Anfragetext muss leer sein.

Beispielanfrage

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

Antworttext

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

Methode: corpora.permissions.patch

Aktualisiert die Berechtigung.

Endpunkt

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

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

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. Sie hat die Form corpora/{corpora}/permissions/{permission}.

Abfrageparameter

updateMask string (FieldMask format)

Erforderlich. Die Liste der zu aktualisierenden Felder. Akzeptierte Werte: – 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.

Felder
role enum (Role)

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

Beispielanfrage

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

Antworttext

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

Methode: corpora.permissions.delete

Löscht die Berechtigung.

Endpunkt

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

Pfadparameter

name string

Erforderlich. Der Ressourcenname der Berechtigung. Formate: tunedModels/{tunedModel}/permissions/{permission} corpora/{corpus}/permissions/{permission} Das Format ist corpora/{corpora}/permissions/{permission}.

Anfragetext

Der Anfragetext muss leer sein.

Beispielanfrage

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

Antworttext

Wenn der Vorgang erfolgreich ist, ist der Antworttext ein leeres JSON-Objekt.

REST-Ressource: corpora.permissions

Ressource: Permission

Mit einer Berechtigungsressource wird Nutzern, Gruppen oder der ganzen Welt Zugriff auf die PaLM API-Ressource (z.B. ein abgestimmtes Modell, ein Korpus) gewährt.

Eine Rolle ist eine Sammlung von zulässigen Vorgängen, mit denen Nutzer bestimmte Aktionen für PaLM API-Ressourcen ausführen können. Damit sie für Nutzer, Gruppen oder Dienstkonten verfügbar sind, weisen Sie Rollen zu. Wenn Sie eine Rolle zuweisen, gewähren Sie die Berechtigungen, die diese Rolle enthält.

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

  • Der Leser kann die Ressource (z. B. abgestimmtes Modell, Korpus) für die Inferenz verwenden.
  • Der Autor hat die Berechtigungen des Lesers und kann zusätzlich bearbeiten und freigeben.
  • Der Inhaber hat Schreibberechtigungen und kann außerdem 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 Lizenznehmers.

emailAddress string

Optional. Nicht veränderbar. Die E-Mail-Adresse des Nutzers oder der Gruppe, auf die sich diese Berechtigung bezieht. Das Feld ist nicht festgelegt, wenn der Berechtigungsempfänger „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)
}

GranteeType

Definiert die Typen des Empfängers dieser Berechtigung.

Enums
GRANTEE_TYPE_UNSPECIFIED Der Standardwert. Dieser Wert wird nicht verwendet.
USER Stellt einen Nutzer dar. Wenn diese Option festgelegt ist, müssen Sie die E-Mail-Adresse des Nutzers angeben.
GROUP Stellt eine Gruppe dar. Wenn diese Option festgelegt ist, müssen Sie die E-Mail-Adresse für die Gruppe angeben.
EVERYONE Steht für den Zugriff für alle. Es sind keine zusätzlichen Informationen erforderlich.

Rolle

Definiert die Rolle, die durch diese Berechtigung gewährt wird.

Enums
ROLE_UNSPECIFIED Der Standardwert. Dieser Wert wird nicht verwendet.
OWNER Der Inhaber kann die Ressource verwenden, aktualisieren, freigeben und löschen.
WRITER Der Autor kann die Ressource verwenden, aktualisieren und teilen.
READER Der Leser kann die Ressource verwenden.

ListPermissionsResponse

Antwort von ListPermissions mit einer paginierten 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
}