Corpus Permissions

Metoda: corpora.permissions.create

Utwórz uprawnienie do konkretnego 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} Ma format corpora/{corpora}.

Treść żądania

Treść żądania zawiera wystąpienie elementu Permission.

Fields
granteeType enum (GranteeType)

Opcjonalnie: Stały. Rodzaj beneficjenta.

emailAddress string

Opcjonalnie: Stały. Adres e-mail użytkownika lub grupy, do których 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

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

Treść odpowiedzi

Jeśli operacja się powiedzie, treść odpowiedzi będzie zawierała nowo utworzoną instancję Permission.

Metoda: corpora.permissions.list

Wyświetla uprawnienia dotyczące konkretnego 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} Ma format 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 podasz tej wartości, zwrócimy maksymalnie 10 uprawnień. Ta metoda zwraca maksymalnie 1000 uprawnień na stronę, nawet jeśli podasz większą wartość parametru pageSize.

pageToken string

Opcjonalnie: Token strony otrzymany z poprzedniego wywołania funkcji permissions.list.

Aby pobrać kolejną stronę, podaj jako argument kolejnego żądania pageToken zwrócony przez pierwsze żądanie.

Podczas podziału na strony wszystkie inne parametry przekazane do funkcji 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

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

# ...

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

Treść odpowiedzi

W przypadku powodzenia treść odpowiedzi obejmuje wystąpienie elementu ListPermissionsResponse.

Metoda: corpora.permissions.get

Pobiera informacje o konkretnym uprawnieniu.

Punkt końcowy

get 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} Ma format corpora/{corpora}/permissions/{permission}.

Treść żądania

Treść żądania musi być pusta.

Przykładowe żądanie

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

Treść odpowiedzi

W przypadku powodzenia treść odpowiedzi obejmuje wystąpienie elementu Permission.

Metoda: corpora.permissions.patch

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: tunedModels/{tunedModel}/permissions/{permission} corpora/{corpus}/permissions/{permission} Tylko dane wyjściowe. Ma 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 rozdzielona przecinkami lista pełnych i jednoznacznych nazw pól. Przykład: "user.displayName,photo".

Treść żądania

Treść żądania zawiera wystąpienie elementu Permission.

Pola
role enum (Role)

Wymagane. Rola przypisana przez to uprawnienie.

Przykładowe żądanie

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

tuned_models.py

Treść odpowiedzi

W przypadku powodzenia treść odpowiedzi obejmuje wystąpienie elementu Permission.

Metoda: corpora.permissions.delete

Usuwanie uprawnień.

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

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

Treść odpowiedzi

Jeśli operacja się uda, treść odpowiedzi będzie pusta.

Zasób REST: corpora.permissions

Zasób: Permission

Zasób uprawnień przyznaje użytkownikowi, grupie lub reszcie świata dostęp do zasobu PaLM API (np. dostrojonego modelu lub korpus).

Rola to zbiór dozwolonych operacji, który umożliwia użytkownikom wykonywanie określonych działań na zasobach 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 poziomy roli. Każda rola jest superzbiorem 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 autora i dodatkowo może usuwać
Fields
name string

Tylko dane wyjściowe. Identyfikator. Nazwa uprawnienia. Podczas tworzenia zostanie wygenerowana unikalna nazwa. Przykłady: tunedModels/{tunedModel}/permissions/{permission} corpora/{corpus}/permissions/{permission} Tylko dane wyjściowe.

granteeType enum (GranteeType)

Opcjonalnie: Stały. Typ podmiotu, któremu udzielono uprawnienia.

emailAddress string

Opcjonalnie: Stały. Adres e-mail użytkownika lub grupy, do których odnosi się to uprawnienie. Pole nie jest ustawione, gdy typ użytkownika uprawnień to WSZYSCY.

role enum (Role)

Wymagane. Rola przyznana przez to uprawnienie.

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

GranteeType

Definiuje typy podmiotów, którym udzielono tego uprawnienia.

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ę. Gdy jest ustawiony, musisz podać adres e-mail grupy.
EVERYONE Reprezentuje dostęp dla wszystkich. Nie musisz podawać żadnych dodatkowych informacji.

Rola

Określa rolę przyznaną 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 Autor może używać, aktualizować i udostępniać zasób.
READER Czytelnik może korzystać z zasobu.

ListPermissionsResponse

Odpowiedź z ListPermissions zawierająca ponumerowane strony z uprawnieniami.

Pola
permissions[] object (Permission)

Zwró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 kolejnych stron.

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