Corpus Permissions

Método: corpora.permissions.create

Crie uma permissão para um recurso específico.

Endpoint

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

Parâmetros de caminho

parent string

Obrigatório. O recurso pai da Permission. Formatos: tunedModels/{tunedModel} corpora/{corpus} Ele assume o formato corpora/{corpora}.

Corpo da solicitação

O corpo da solicitação contém uma instância de Permission.

Campos
granteeType enum (GranteeType)

Opcional. Imutável. O tipo de beneficiário.

emailAddress string

Opcional. Imutável. O endereço de e-mail do usuário do grupo a que esta permissão se refere. O campo não é definido quando o tipo de concessão de permissão é TODOS.

role enum (Role)

Obrigatório. O papel concedido pela permissão.

Exemplo de solicitação

Python

import google.generativeai as genai

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

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta incluirá uma instância de Permission.

Método: corpora.permissions.list

Lista as permissões para o recurso específico.

Endpoint

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

Parâmetros de caminho

parent string

Obrigatório. O recurso pai das permissões. Formatos: tunedModels/{tunedModel} corpora/{corpus} Ele assume o formato corpora/{corpora}.

Parâmetros de consulta

pageSize integer

Opcional. O número máximo de Permissions a serem retornados (por página). O serviço pode retornar menos permissões.

Se não for especificado, serão retornadas no máximo 10 permissões. Esse método retorna no máximo 1.000 permissões por página, mesmo que você transmita um pageSize maior.

pageToken string

Opcional. Um token de página recebido de uma chamada permissions.list anterior.

Forneça o pageToken retornado por uma solicitação como um argumento para a próxima solicitação para recuperar a próxima página.

Ao paginar, todos os outros parâmetros fornecidos para permissions.list precisam corresponder à chamada que forneceu o token da página.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Exemplo de solicitação

Python

import google.generativeai as genai

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

# ...

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

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de ListPermissionsResponse.

Método: corpora.permissions.get

Recebe informações sobre uma permissão específica.

Endpoint

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

Parâmetros de caminho

name string

Obrigatório. O nome do recurso da permissão.

Formatos: tunedModels/{tunedModel}/permissions/{permission} corpora/{corpus}/permissions/{permission} Ele tem o formato corpora/{corpora}/permissions/{permission}.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Exemplo de solicitação

Python

import google.generativeai as genai

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

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de Permission.

Método: corpora.permissions.patch

Atualiza a permissão.

Endpoint

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

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

Parâmetros de caminho

permission.name string

Apenas saída. Identificador. O nome da permissão. Um nome exclusivo será gerado na criação. Exemplos: tunedModels/{tunedModel}/permissions/{permission} corpora/{corpus}/permissions/{permission} Somente saída. Ele tem o formato corpora/{corpora}/permissions/{permission}.

Parâmetros de consulta

updateMask string (FieldMask format)

Obrigatório. Lista de campos a serem atualizados. Aceitos: - função (campo Permission.role)

É uma lista separada por vírgulas de nomes de campos totalmente qualificados. Exemplo: "user.displayName,photo".

Corpo da solicitação

O corpo da solicitação contém uma instância de Permission.

Campos
role enum (Role)

Obrigatório. O papel concedido pela permissão.

Exemplo de solicitação

Python

        import google.generativeai as genai

        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):
        import google.generativeai as genai

        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

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de Permission.

Método: corpora.permissions.delete

Exclui a permissão.

Endpoint

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

Parâmetros de caminho

name string

Obrigatório. O nome do recurso da permissão. Formatos: tunedModels/{tunedModel}/permissions/{permission} corpora/{corpus}/permissions/{permission} Ele tem o formato corpora/{corpora}/permissions/{permission}.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Exemplo de solicitação

Python

import google.generativeai as genai

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

Corpo da resposta

Se a solicitação for concluída, o corpo da resposta estará vazio.

Recurso REST: corpora.permissions

Recurso: permissão

O recurso de permissão concede ao usuário, grupo ou o resto do mundo acesso ao recurso da API PaLM (por exemplo, um modelo ajustado, corpus).

Um papel é um conjunto de operações permitidas que permite que os usuários realizem ações específicas nos recursos da API PaLM. Você atribui papéis para disponibilizá-los a usuários, grupos ou contas de serviço. Ao atribuir um papel, você concede as permissões contidas nele.

Há três papéis concêntricos. Cada papel é um superconjunto das operações permitidas pelo papel anterior:

  • o leitor pode usar o recurso (por exemplo, modelo ajustado, corpus) para inferência
  • O escritor tem permissões de leitor e também pode editar e compartilhar
  • O proprietário tem as permissões de um colaborador e também pode excluir
Campos
name string

Apenas saída. Identificador. O nome da permissão. Um nome exclusivo será gerado na criação. Exemplos: tuningModels/{tunedModel}/permissions/{permission} corpora/{corpus}/permissions/{permission} somente saída.

granteeType enum (GranteeType)

Opcional. Imutável. O tipo de beneficiário.

emailAddress string

Opcional. Imutável. O endereço de e-mail do usuário do grupo a que esta permissão se refere. O campo não é definido quando o tipo de concessão de permissão é TODOS.

role enum (Role)

Obrigatório. O papel concedido pela permissão.

Representação JSON 
{
  "name": string,
  "granteeType": enum (GranteeType),
  "emailAddress": string,
  "role": enum (Role)
}

GranteeType

Define os tipos do beneficiário da permissão.

Enums
GRANTEE_TYPE_UNSPECIFIED O valor padrão. Esse valor não é usado.
USER Representa um usuário. Quando definido, você precisa fornecer emailAddress para o usuário.
GROUP Representa um grupo. Quando definido, é necessário fornecer o emailAddress do grupo.
EVERYONE Representa o acesso de todos. Nenhuma informação extra é necessária.

Papel

Define o papel concedido pela permissão.

Enums
ROLE_UNSPECIFIED O valor padrão. Esse valor não é usado.
OWNER O proprietário pode usar, atualizar, compartilhar e excluir o recurso.
WRITER O redator pode usar, atualizar e compartilhar o recurso.
READER O leitor pode usar o recurso.

ListPermissionsResponse

Resposta de ListPermissions contendo uma lista paginada de permissões.

Campos
permissions[] object (Permission)

Permissões retornadas.

nextPageToken string

Um token, que pode ser enviado como pageToken para recuperar a próxima página.

Se esse campo for omitido, não haverá mais páginas.

Representação JSON 
{
  "permissions": [
    {
      object (Permission)
    }
  ],
  "nextPageToken": string
}