Metoda: corpora.permissions.create
Utwórz uprawnienia dla określonego zasobu.
Punkt końcowy
post
https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*}/permissions
Parametry ścieżki
parent
string
Wymagane. Zasób nadrzędny obiektu Permission
. Formaty: tunedModels/{tunedModel}
corpora/{corpus}
Przyjmuje postać corpora/{corpora}
.
Treść żądania
Treść żądania zawiera wystąpienie elementu Permission
.
granteeType
enum (GranteeType
)
Opcjonalnie: Stała. Rodzaj beneficjenta.
emailAddress
string
Opcjonalnie: Stała. Adres e-mail użytkownika grupy, do którego odnosi się to uprawnienie. Pole nie jest ustawione, gdy typ użytkownika uprawnień to WSZYSCY.
role
enum (Role
)
Wymagane. Rola przypisana przez to uprawnienie.
Przykładowe żądanie
Python
Treść odpowiedzi
Jeśli operacja się uda, treść odpowiedzi będzie zawierała nowo utworzoną instancję Permission
.
Metoda: corpora.permissions.list
- Punkt końcowy
- Parametry ścieżki
- Parametry zapytania
- Treść żądania
- Treść odpowiedzi
- Zakresy autoryzacji
- Przykładowe żądanie
Wyświetla listę uprawnień dotyczących określonego zasobu.
Punkt końcowy
pobierz
https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*}/permissions
Parametry ścieżki
parent
string
Wymagane. Zasób nadrzędny uprawnień. Formaty: tunedModels/{tunedModel}
corpora/{corpus}
Przyjmuje postać corpora/{corpora}
.
Parametry zapytania
pageSize
integer
Opcjonalnie: Maksymalna liczba zwracanych elementów Permission
(na stronę). Usługa może zwrócić mniej uprawnień.
Jeśli nie określono inaczej, zwróconych zostanie maksymalnie 10 uprawnień. Ta metoda zwraca maksymalnie 1000 uprawnień na stronę, nawet jeśli przekażesz większy rozmiar strony.
pageToken
string
Opcjonalnie: Token strony otrzymany z poprzedniego wywołania funkcji permissions.list
.
Podaj pageToken
zwrócony przez jedno żądanie jako argument następnego żądania, aby pobrać kolejną stronę.
Podczas dzielenia na strony wszystkie pozostałe parametry podane w narzędziu permissions.list
muszą być zgodne z wywołaniem, które dostarczyło token strony.
Treść żądania
Treść żądania musi być pusta.
Przykładowe żądanie
Python
Treść odpowiedzi
W przypadku powodzenia treść odpowiedzi obejmuje wystąpienie elementu ListPermissionsResponse
.
Metoda: corpora.permissions.get
Pobiera informacje o określonym uprawnieniu.
Punkt końcowy
pobierz
https://generativelanguage.googleapis.com/v1beta/{name=corpora/*/permissions/*}
Parametry ścieżki
name
string
Wymagane. Nazwa zasobu uprawnienia.
Formaty: tunedModels/{tunedModel}/permissions/{permission}
corpora/{corpus}/permissions/{permission}
Przyjmuje postać corpora/{corpora}/permissions/{permission}
.
Treść żądania
Treść żądania musi być pusta.
Przykładowe żądanie
Python
Treść odpowiedzi
W przypadku powodzenia treść odpowiedzi obejmuje wystąpienie elementu Permission
.
Metoda: corpora.permissions.patch
- Punkt końcowy
- Parametry ścieżki
- Parametry zapytania
- Treść żądania
- Treść odpowiedzi
- Zakresy autoryzacji
- Przykładowe żądanie
Aktualizuje uprawnienie.
Punkt końcowy
poprawka
https://generativelanguage.googleapis.com/v1beta/{permission.name=corpora/*/permissions/*}
PATCH https://generativelanguage.googleapis.com/v1beta/{permission.name=corpora/*/permissions/*}
Parametry ścieżki
permission.name
string
Tylko dane wyjściowe. Identyfikator. Nazwa uprawnienia. Podczas tworzenia zostanie wygenerowana unikalna nazwa. Przykłady: tylko dostrojoneModele/{tunedModel}/permissions/{permission} korpus/{korpus}/permissions/{permission} – dane wyjściowe. Przyjmuje on postać corpora/{corpora}/permissions/{permission}
.
Parametry zapytania
updateMask
string (FieldMask
format)
Wymagane. Lista pól do zaktualizowania. Akceptowane: – rola (pole Permission.role
)
Jest to rozdzielana przecinkami lista w pełni kwalifikowanych nazw pól. Przykład: "user.displayName,photo"
.
Treść żądania
Treść żądania zawiera wystąpienie elementu Permission
.
role
enum (Role
)
Wymagane. Rola przypisana przez to uprawnienie.
Przykładowe żądanie
Python
Treść odpowiedzi
W przypadku powodzenia treść odpowiedzi obejmuje wystąpienie elementu Permission
.
Metoda: corpora.permissions.delete
Usuwa uprawnienie.
Punkt końcowy
usuń
https://generativelanguage.googleapis.com/v1beta/{name=corpora/*/permissions/*}
Parametry ścieżki
name
string
Wymagane. Nazwa zasobu uprawnienia. Formaty: tunedModels/{tunedModel}/permissions/{permission}
corpora/{corpus}/permissions/{permission}
Przyjmuje postać corpora/{corpora}/permissions/{permission}
.
Treść żądania
Treść żądania musi być pusta.
Przykładowe żądanie
Python
Treść odpowiedzi
Jeśli operacja się uda, treść odpowiedzi będzie pusta.
Zasób REST: corpora.permissions
Zasób: Permission
Uprawnienie zapewnia użytkownikowi, grupie lub reszcie świata dostęp do zasobu interfejsu PaLM API (np. dostrojonego modelu czy korpusu).
Rola to zbiór dozwolonych operacji, który umożliwia użytkownikom wykonywanie określonych działań na zasobach interfejsu PaLM API. Aby je udostępnić użytkownikom, grupom lub kontom usługi, musisz przypisać do nich role. Przypisując rolę, przyznajesz jej uprawnienia.
Istnieją 3 role koncentryczne. Każda rola jest nadzbiorem dozwolonych operacji poprzedniej roli:
- czytnik może używać zasobu (np. dostrojonego modelu, korpusu) w celu wnioskowania
- autor ma uprawnienia czytelnika i dodatkowo może edytować i udostępniać
- właściciel ma uprawnienia zapisującego i dodatkowo może usuwać
name
string
Tylko dane wyjściowe. Identyfikator. Nazwa uprawnienia. Podczas tworzenia zostanie wygenerowana unikalna nazwa. Przykłady: tylko dostrojoneModele/{tunedModel}/permissions/{permission} korpus/{korpus}/permissions/{permission} – dane wyjściowe.
granteeType
enum (GranteeType
)
Opcjonalnie: Stała. Rodzaj beneficjenta.
emailAddress
string
Opcjonalnie: Stała. Adres e-mail użytkownika grupy, do którego odnosi się to uprawnienie. Pole nie jest ustawione, gdy typ użytkownika uprawnień to WSZYSCY.
role
enum (Role
)
Wymagane. Rola przypisana przez to uprawnienie.
Zapis JSON |
---|
{ "name": string, "granteeType": enum ( |
GranteeType
Definiuje typy osób, którym przyznano to uprawnienie.
Wartości w polu enum | |
---|---|
GRANTEE_TYPE_UNSPECIFIED |
Wartość domyślna. Ta wartość nie jest używana. |
USER |
Reprezentuje użytkownika. Gdy to ustawienie jest skonfigurowane, musisz podać adres e-mail użytkownika. |
GROUP |
Reprezentuje grupę. Jeśli to ustawienie jest skonfigurowane, musisz podać adres e-mail grupy. |
EVERYONE |
Reprezentuje dostęp dla wszystkich. Nie musisz podawać żadnych dodatkowych informacji. |
Rola
Określa rolę przypisaną przez to uprawnienie.
Wartości w polu enum | |
---|---|
ROLE_UNSPECIFIED |
Wartość domyślna. Ta wartość nie jest używana. |
OWNER |
Właściciel może używać, aktualizować, udostępniać i usuwać zasób. |
WRITER |
Zapisujący może używać, aktualizować i udostępniać zasób. |
READER |
Odczytujący może użyć zasobu. |
ListPermissionsResponse
Odpowiedź z atrybutu ListPermissions
zawierająca podzieloną na strony listę uprawnień.
permissions[]
object (Permission
)
Przywrócone uprawnienia.
nextPageToken
string
Token, który może zostać wysłany jako pageToken
w celu pobrania następnej strony.
Jeśli pominiesz to pole, nie będzie więcej stron.
Zapis JSON |
---|
{
"permissions": [
{
object ( |