Corpus Permissions

Método: corpora.permissions.create

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 del Permission. Formatos: tunedModels/{tunedModel} corpora/{corpus} Tiene el formato 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 del 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

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

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

Obligatorio. El recurso superior de los permisos. Formatos: tunedModels/{tunedModel} corpora/{corpus} Tiene el formato corpora/{corpora}.

Parámetros de consulta

pageSize integer

Opcional. Es la cantidad máxima de Permission que se mostrarán (por página). Es posible que el servicio devuelva menos permisos.

Si no se especifica, se mostrarán 10 permisos como máximo. Este método muestra, como máximo, 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 para 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

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

# ...

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

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

Obligatorio. Es el nombre del recurso del permiso.

Formatos: tunedModels/{tunedModel}/permissions/{permission} corpora/{corpus}/permissions/{permission} Tiene el formato corpora/{corpora}/permissions/{permission}.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Ejemplo de solicitud

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

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

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. Es el nombre del permiso. En el momento de la creación, se generará un nombre único. Ejemplos: tunedModels/{tunedModel}/permissions/{permission} corpora/{corpus}/permissions/{permission} Solo salida. Tiene el formato corpora/{corpora}/permissions/{permission}.

Parámetros de consulta

updateMask string (FieldMask format)

Obligatorio. La lista de campos que se deben actualizar. Los aceptados son: - 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)

Obligatorio. El rol que otorga este permiso.

Ejemplo de solicitud

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

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

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

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

Cuerpo de la respuesta

Si se ejecuta correctamente, el cuerpo de la respuesta está vacío.

Recurso de REST: corpora.permissions

Recurso: Permiso

El recurso de permiso otorga acceso al usuario, al grupo o al resto del mundo al recurso de la API de PaLM (p. ej., un modelo ajustado, un 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 los permisos que este 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., el modelo ajustado o el 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
Campos
name string

Solo salida. Identificador. El nombre del permiso. En el momento de la creación, se generará un nombre único. 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. 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),
  "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 configure, debes 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 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)

Permisos devueltos

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
}