Corpus Permissions

Método: corpora.permissions.create

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

Endpoint

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

Parâmetros de caminho

parent string

Obrigatório. O recurso pai do Permission. Formatos: tunedModels/{tunedModel} corpora/{corpus}. Ele tem 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 do beneficiário.

emailAddress string

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

role enum (Role)

Obrigatório. O papel concedido por essa permissão.

Exemplo de solicitação

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

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 do recurso específico.

Endpoint

get 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 tem 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, no máximo 10 permissões serão retornadas. 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 argumento para a próxima solicitação e recupere 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

# 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

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

# 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

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: - role (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 por essa permissão.

Exemplo de solicitação

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

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

delete 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

# 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

Corpo da resposta

Se não houver nenhum problema, o corpo da resposta será um objeto JSON vazio.

Recurso REST: corpora.permissions

Recurso: permissão

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

Um papel é um conjunto de operações permitidas que permite aos usuários realizar ações específicas nos recursos da API PaLM. Para disponibilizar as permissões a usuários, grupos ou contas de serviço, atribua papéis. Ao atribuir um papel, você concede as permissões que ele contém.

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

  • o leitor pode usar o recurso (por exemplo, modelo ajustado, corpus) para inferência
  • o gravador tem as permissões do leitor e também pode editar e compartilhar
  • o proprietário tem permissões de gravador 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: tunedModels/{tunedModel}/permissions/{permission} corpora/{corpus}/permissions/{permission} Somente saída.

granteeType enum (GranteeType)

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

emailAddress string

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

role enum (Role)

Obrigatório. O papel concedido por essa permissão.

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

GranteeType

Define os tipos de beneficiário desta 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 o emailAddress do usuário.
GROUP Representa um grupo. Quando definido, é necessário fornecer o emailAddress do grupo.
EVERYONE Representa o acesso a todos. Nenhuma informação extra é necessária.

Papel

Define o papel concedido por essa 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 gravador 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
}