Methode: corpora.permissions.create
Erstellen Sie eine Berechtigung für eine bestimmte Ressource.
Endpunkt
post https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*}/permissionsPfadparameter
parent
string
Erforderlich. Die übergeordnete Ressource von Permission
. Formate: tunedModels/{tunedModel}
corpora/{corpus}
Die URL hat das Format corpora/{corpora}
.
Anfragetext
Der Anfragetext enthält eine Instanz von Permission
.
granteeType
enum (GranteeType
)
Optional. Nicht veränderbar. Der Typ des Begünstigten.
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
Antworttext
Bei Erfolg enthält der Antworttext eine neu erstellte Instanz von Permission
.
Methode: corpora.permissions.list
Hier werden die Berechtigungen für die jeweilige Ressource aufgelistet.
Endpunkt
get https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*}/permissionsPfadparameter
parent
string
Erforderlich. Die übergeordnete Ressource der Berechtigungen. Formate: tunedModels/{tunedModel}
corpora/{corpus}
Sie hat das Format corpora/{corpora}
.
Abfrageparameter
pageSize
integer
Optional. Die maximale Anzahl von Permission
s, 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 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
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
erhalten 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}
Sie hat das Format corpora/{corpora}/permissions/{permission}
.
Anfragetext
Der Anfragetext muss leer sein.
Beispielanfrage
Python
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. Bei der Erstellung wird ein eindeutiger Name generiert. Beispiele: tunedModels/{tunedModel}/permissions/{permission} corpora/{corpus}/permissions/{permission} nur Ausgabe. Es hat das Format corpora/{corpora}/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
.
role
enum (Role
)
Erforderlich. Die Rolle, die durch diese Berechtigung gewährt wird.
Beispielanfrage
Python
Antworttext
Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext eine Instanz von Permission
.
Methode: corpora.permissions.delete
Die Berechtigung wird gelöscht.
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}
Die URL hat das Format corpora/{corpora}/permissions/{permission}
.
Anfragetext
Der Anfragetext muss leer sein.
Beispielanfrage
Python
Antworttext
Wenn der Vorgang erfolgreich ist, ist der Antworttext leer.
REST-Ressource: corpora.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. Weisen Sie Rollen zu, um sie Nutzern, Gruppen oder Dienstkonten zur Verfügung zu stellen. 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
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 Rolle, die durch diese Berechtigung gewährt wird.
JSON-Darstellung |
---|
{ "name": string, "granteeType": enum ( |
GranteeType
Definiert die Typen der Begünstigten dieser Berechtigung.
Enums | |
---|---|
GRANTEE_TYPE_UNSPECIFIED |
Der Standardwert. Dieser Wert wird nicht verwendet. |
USER |
Stellt einen Nutzer dar. Wenn dies festgelegt ist, müssen Sie emailAddress für den Nutzer angeben. |
GROUP |
Stellt eine Gruppe dar. Wenn dies festgelegt ist, müssen Sie emailAddress für die Gruppe angeben. |
EVERYONE |
Stellt den Zugriff für alle dar. Es sind keine zusätzlichen Informationen erforderlich. |
Rolle
Definiert die durch diese Berechtigung gewährte Rolle.
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 freigeben. |
READER |
Leser können die Ressource verwenden. |
ListPermissionsResponse
Antwort von ListPermissions
mit einer paginierten Liste von Berechtigungen.
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 ( |