Método: corpora.permissions.create
- Extremo
- Parámetros de ruta de acceso
- Cuerpo de la solicitud
- Cuerpo de la respuesta
- Permisos de autorización
- Ejemplo de solicitud
Crea un permiso para un recurso específico.
Extremo
publicación
https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*}/permissions
Parámetros de ruta
parent
string
Obligatorio. Es el recurso superior 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
.
granteeType
enum (GranteeType
)
Opcional. Inmutable. Es el tipo de beneficiario.
emailAddress
string
Opcional. Inmutable. La dirección de correo electrónico del usuario del grupo al que hace referencia este permiso. El campo no se configura cuando el tipo de beneficiario del permiso es TODOS.
role
enum (Role
)
Obligatorio. El rol que otorga este permiso.
Ejemplo de solicitud
Python
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
- Extremo
- Parámetros de ruta de acceso
- Parámetros de consulta
- Cuerpo de la solicitud
- Cuerpo de la respuesta
- Permisos de autorización
- Ejemplo de solicitud
Enumera los permisos para el recurso específico.
Extremo
obtener
https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*}/permissions
Parámetros de ruta
parent
string
Obligatorio. El recurso superior de los permisos. Formatos: tunedModels/{tunedModel}
corpora/{corpus}
Toma la forma corpora/{corpora}
.
Parámetros de consulta
pageSize
integer
Opcional. La cantidad máxima de elementos Permission
que se mostrarán (por página). Es posible que el servicio muestre menos permisos.
Si no se especifica, se mostrarán 10 permisos como máximo. Este método muestra un máximo de 1,000 permisos por página, incluso si pasas un pageSize más grande.
pageToken
string
Opcional. Un token de página, recibido desde una llamada permissions.list
anterior.
Proporciona el pageToken
que muestra una solicitud como argumento para la siguiente solicitud a fin de 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
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
- Extremo
- Parámetros de ruta de acceso
- Cuerpo de la solicitud
- Cuerpo de la respuesta
- Permisos de autorización
- Ejemplo de solicitud
Obtiene información sobre un permiso específico.
Extremo
obtener
https://generativelanguage.googleapis.com/v1beta/{name=corpora/*/permissions/*}
Parámetros de ruta
name
string
Obligatorio. 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
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
- Extremo
- Parámetros de ruta de acceso
- Parámetros de consulta
- Cuerpo de la solicitud
- Cuerpo de la respuesta
- Permisos de autorización
- Ejemplo de solicitud
Actualiza el permiso.
Extremo
parche
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. El nombre del permiso. En el momento de la creación, se generará un nombre único. Ejemplos: tunnelModels/{tunedModel}/permissions/{permission} corpora/{corpus}/permissions/{permission} Solo salida. Toma la forma corpora/{corpora}/permissions/{permission}
.
Parámetros de consulta
updateMask
string (FieldMask
format)
Obligatorio. La lista de campos que se deben actualizar. Se aceptan los siguientes: - rol (Permission.role
campo)
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
.
role
enum (Role
)
Obligatorio. El rol que otorga este permiso.
Ejemplo de solicitud
Python
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
- Extremo
- Parámetros de ruta de acceso
- Cuerpo de la solicitud
- Cuerpo de la respuesta
- Permisos de autorización
- Ejemplo de solicitud
Borra el permiso.
Extremo
borrar
https://generativelanguage.googleapis.com/v1beta/{name=corpora/*/permissions/*}
Parámetros de ruta
name
string
Obligatorio. 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
Cuerpo de la respuesta
Si se ejecuta correctamente, el cuerpo de la respuesta está vacío.
Recurso de REST: corpora.permissions
Recurso: Permission
El recurso de permiso otorga al usuario, grupo o al resto del mundo acceso al recurso de la API de PaLM (p.ej., un modelo ajustado o corpus).
Un rol es una colección de operaciones permitidas que les permite a los usuarios realizar acciones específicas en los recursos de la API de PaLM. Si quieres que estén disponibles para usuarios, grupos o cuentas de servicio, asigna roles. Cuando asignas un rol, otorgas permisos que el rol contiene.
Existen tres roles concéntricos. Cada función es un superconjunto de las operaciones permitidas de la función anterior:
- el lector puede usar el recurso (p.ej., modelo ajustado, corpus) para la inferencia
- escritor tiene los permisos de lectura y, además, puede editar y compartir
- tiene permiso de escritor y, además, puede borrar
name
string
Solo salida. Identificador. El nombre del permiso. En el momento de la creación, se generará un nombre único. Ejemplos: tunnelModels/{tunedModel}/permissions/{permission} corpora/{corpus}/permissions/{permission} Solo salida.
granteeType
enum (GranteeType
)
Opcional. Inmutable. Es el tipo de beneficiario.
emailAddress
string
Opcional. Inmutable. La dirección de correo electrónico del usuario del grupo al que hace referencia este permiso. El campo no se configura cuando el tipo de beneficiario del permiso es TODOS.
role
enum (Role
)
Obligatorio. El rol que otorga este permiso.
Representación JSON |
---|
{ "name": string, "granteeType": enum ( |
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. Si la estableces, deberás proporcionar la dirección de correo electrónico del usuario. |
GROUP |
Representa un grupo. Si se establece, debes proporcionar emailAddress para el grupo. |
EVERYONE |
Representa el acceso de 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.
permissions[]
object (Permission
)
Se muestran los permisos.
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 ( |