Corpus Permissions

Método: corpora.permissions.create

Crea un permiso para un recurso específico.

Extremo

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

Parámetros de ruta

parent string

Es obligatorio. Es el recurso principal de Permission. Formatos: tunedModels/{tunedModel} corpora/{corpus} Toma la forma corpora/{corpora}.

Cuerpo de la solicitud

El cuerpo de la solicitud contiene una instancia de Permission.

Campos
granteeType enum (GranteeType)

Opcional. Inmutable. Es el tipo de beneficiario.

emailAddress string

Opcional. Inmutable. Es la dirección de correo electrónico del usuario del grupo al que se refiere este permiso. El campo no se establece cuando el tipo de beneficiario del permiso es EVERYONE.

role enum (Role)

Es obligatorio. Es el rol que otorga este permiso.

Ejemplo de solicitud

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

Cuerpo de la respuesta

Si el proceso se realiza de forma correcta, el cuerpo de la respuesta contiene una instancia recién creada de Permission.

Método: corpora.permissions.list

Enumera los permisos para el recurso específico.

Extremo

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

Parámetros de ruta

parent string

Es obligatorio. Es el recurso principal de los permisos. Formatos: tunedModels/{tunedModel} corpora/{corpus} Toma la forma corpora/{corpora}.

Parámetros de consulta

pageSize integer

Opcional. Es la cantidad máxima de Permissions que se devolverán (por página). El servicio puede devolver menos permisos.

Si no se especifica, se devolverán, como máximo, 10 permisos. Este método devuelve un máximo de 1,000 permisos por página, incluso si pasas un valor de pageSize mayor.

pageToken string

Opcional. Un token de página, recibido desde una llamada permissions.list anterior.

Proporciona el pageToken que mostró una solicitud como argumento para la siguiente solicitud y, así, recuperar la página siguiente.

Cuando se pagina, todos los demás parámetros proporcionados a permissions.list deben coincidir con la llamada que proporcionó el token de la página.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Ejemplo de solicitud

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

Cuerpo de la respuesta

Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de ListPermissionsResponse.

Método: corpora.permissions.get

Obtiene información sobre un permiso específico.

Extremo

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

Parámetros de ruta

name string

Es obligatorio. Es el nombre del recurso del permiso.

Formatos: tunedModels/{tunedModel}/permissions/{permission} corpora/{corpus}/permissions/{permission} Toma la forma corpora/{corpora}/permissions/{permission}.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Ejemplo de solicitud

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

Cuerpo de la respuesta

Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de Permission.

Método: corpora.permissions.patch

Actualiza el permiso.

Extremo

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

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

Parámetros de ruta

permission.name string

Solo salida. Identificador. Es el nombre del permiso. Se generará un nombre único durante la creación. Ejemplos: tunedModels/{tunedModel}/permissions/{permission} corpora/{corpus}/permissions/{permission} Solo salida. Toma la forma corpora/{corpora}/permissions/{permission}.

Parámetros de consulta

updateMask string (FieldMask format)

Es obligatorio. La lista de campos que se deben actualizar. Aceptados: - role (campo Permission.role)

Esta es una lista separada por comas de los nombres de campos totalmente calificados. Ejemplo: "user.displayName,photo".

Cuerpo de la solicitud

El cuerpo de la solicitud contiene una instancia de Permission.

Campos
role enum (Role)

Es obligatorio. Es el rol que otorga este permiso.

Ejemplo de solicitud

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

Cuerpo de la respuesta

Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de Permission.

Método: corpora.permissions.delete

Borra el permiso.

Extremo

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

Parámetros de ruta

name string

Es obligatorio. Es el nombre del recurso del permiso. Formatos: tunedModels/{tunedModel}/permissions/{permission} corpora/{corpus}/permissions/{permission} Toma la forma corpora/{corpora}/permissions/{permission}.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Ejemplo de solicitud

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

Cuerpo de la respuesta

Si se ejecuta correctamente, el cuerpo de la respuesta es un objeto JSON vacío.

Recurso de REST: corpora.permissions

Recurso: Permission

El recurso de permiso otorga acceso al recurso de la API de PaLM (p.ej., un modelo ajustado o un corpus) al usuario, al grupo o al resto del mundo.

Un rol es una colección de operaciones permitidas que permite a los usuarios realizar acciones específicas en los recursos de la API de PaLM. Para que estén disponibles para usuarios, grupos o cuentas de servicio, debes asignar roles. Cuando asignas un rol, otorgas los permisos que este contiene.

Existen tres roles concéntricos. Cada rol es un superconjunto de las operaciones permitidas del rol anterior:

  • El lector puede usar el recurso (p. ej., modelo ajustado, corpus) para la inferencia.
  • El escritor tiene permisos de lector y, además, puede editar y compartir.
  • El propietario tiene permisos de escritura y, además, puede borrar.
Campos
name string

Solo salida. Identificador. Es el nombre del permiso. Se generará un nombre único durante la creación. Ejemplos: tunedModels/{tunedModel}/permissions/{permission} corpora/{corpus}/permissions/{permission} Solo salida.

granteeType enum (GranteeType)

Opcional. Inmutable. Es el tipo de beneficiario.

emailAddress string

Opcional. Inmutable. Es la dirección de correo electrónico del usuario del grupo al que se refiere este permiso. El campo no se establece cuando el tipo de beneficiario del permiso es EVERYONE.

role enum (Role)

Es obligatorio. Es el rol que otorga este permiso.

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

GranteeType

Define los tipos de beneficiario de este permiso.

Enumeraciones
GRANTEE_TYPE_UNSPECIFIED Es el valor predeterminado. Este valor no se usa.
USER Representa a un usuario. Cuando se establece, debes proporcionar el parámetro emailAddress para el usuario.
GROUP Representa un grupo. Cuando se establece, debes proporcionar el parámetro emailAddress para el grupo.
EVERYONE Representa el acceso para todos. No se requiere información adicional.

Rol

Define el rol que otorga este permiso.

Enumeraciones
ROLE_UNSPECIFIED Es el valor predeterminado. Este valor no se usa.
OWNER El propietario puede usar, actualizar, compartir y borrar el recurso.
WRITER El escritor puede usar, actualizar y compartir el recurso.
READER El lector puede usar el recurso.

ListPermissionsResponse

Respuesta de ListPermissions que contiene una lista paginada de permisos.

Campos
permissions[] object (Permission)

Son los permisos que se devolvieron.

nextPageToken string

Un token, que se puede enviar como pageToken para recuperar la página siguiente.

Si se omite este campo, no habrá más páginas.

Representación JSON 
{
  "permissions": [
    {
      object (Permission)
    }
  ],
  "nextPageToken": string
}