Corpus Permissions

Metodo: corpora.permissions.create

Creare un'autorizzazione per una risorsa specifica.

Endpoint

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

Parametri del percorso

parent string

Obbligatorio. La risorsa padre di Permission. Formati: tunedModels/{tunedModel} corpora/{corpus} Ha il formato corpora/{corpora}.

Corpo della richiesta

Il corpo della richiesta contiene un'istanza di Permission.

Campi
granteeType enum (GranteeType)

(Facoltativo) Immutabile. Il tipo di concessore.

emailAddress string

(Facoltativo) Immutabile. L'indirizzo email dell'utente del gruppo a cui fa riferimento questa autorizzazione. Il campo non è impostato quando il tipo di concessore dell'autorizzazione è TUTTI.

role enum (Role)

Obbligatorio. Il ruolo concesso da questa autorizzazione.

Richiesta di esempio

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

Corpo della risposta

In caso di esito positivo, il corpo della risposta contiene un'istanza di Permission appena creata.

Metodo: corpora.permissions.list

Elenca le autorizzazioni per la risorsa specifica.

Endpoint

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

Parametri del percorso

parent string

Obbligatorio. La risorsa principale delle autorizzazioni. Formati: tunedModels/{tunedModel} corpora/{corpus} Ha il formato corpora/{corpora}.

Parametri di query

pageSize integer

(Facoltativo) Il numero massimo di Permission da restituire (per pagina). Il servizio potrebbe restituire meno autorizzazioni.

Se non specificato, verranno restituite al massimo 10 autorizzazioni. Questo metodo restituisce al massimo 1000 autorizzazioni per pagina, anche se specifichi un valore di pageSize più grande.

pageToken string

(Facoltativo) Un token di pagina ricevuto da una chiamata permissions.list precedente.

Fornisci il valore pageToken restituito da una richiesta come argomento per la richiesta successiva per recuperare la pagina successiva.

Durante l'impaginazione, tutti gli altri parametri forniti a permissions.list devono corrispondere alla chiamata che ha fornito il token della pagina.

Corpo della richiesta

Il corpo della richiesta deve essere vuoto.

Richiesta di esempio

Python

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

# ...

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

Corpo della risposta

In caso di esito positivo, il corpo della risposta contiene un'istanza di ListPermissionsResponse.

Metodo: corpora.permissions.get

Recupera le informazioni su un'autorizzazione specifica.

Endpoint

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

Parametri del percorso

name string

Obbligatorio. Il nome della risorsa dell'autorizzazione.

Formati: tunedModels/{tunedModel}/permissions/{permission} corpora/{corpus}/permissions/{permission} Ha il formato corpora/{corpora}/permissions/{permission}.

Corpo della richiesta

Il corpo della richiesta deve essere vuoto.

Richiesta di esempio

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

Corpo della risposta

In caso di esito positivo, il corpo della risposta contiene un'istanza di Permission.

Metodo: corpora.permissions.patch

Aggiorna l'autorizzazione.

Endpoint

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

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

Parametri del percorso

permission.name string

Solo output. Identificatore. Il nome dell'autorizzazione. Al momento della creazione verrà generato un nome univoco. Esempi: tunedModels/{tunedModel}/permissions/{permission} corpora/{corpus}/permissions/{permission} Solo output. Il formato è corpora/{corpora}/permissions/{permission}.

Parametri di query

updateMask string (FieldMask format)

Obbligatorio. L'elenco dei campi da aggiornare. quelli accettati: - ruolo (Permission.role campo)

Si tratta di un elenco di nomi completi dei campi separati da virgole. Esempio: "user.displayName,photo".

Corpo della richiesta

Il corpo della richiesta contiene un'istanza di Permission.

Campi
role enum (Role)

Obbligatorio. Il ruolo concesso da questa autorizzazione.

Richiesta di esempio

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

Corpo della risposta

In caso di esito positivo, il corpo della risposta contiene un'istanza di Permission.

Metodo: corpora.permissions.delete

Consente di eliminare l'autorizzazione.

Endpoint

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

Parametri del percorso

name string

Obbligatorio. Il nome risorsa dell'autorizzazione. Formati: tunedModels/{tunedModel}/permissions/{permission} corpora/{corpus}/permissions/{permission} Il formato è corpora/{corpora}/permissions/{permission}.

Corpo della richiesta

Il corpo della richiesta deve essere vuoto.

Richiesta di esempio

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

Corpo della risposta

In caso di esito positivo, il corpo della risposta è vuoto.

Risorsa REST: corpora.permissions

Risorsa: autorizzazione

La risorsa di autorizzazione concede all'utente, al gruppo o al resto del mondo l'accesso alla risorsa dell'API PaLM (ad esempio, un corpus o un modello ottimizzato).

Un ruolo è un insieme di operazioni consentite che consente agli utenti di eseguire azioni specifiche sulle risorse dell'API PaLM. Per renderli disponibili a utenti, gruppi o account di servizio, devi assegnare dei ruoli. Quando assegni un ruolo, concedi le autorizzazioni incluse nel ruolo.

Esistono tre ruoli concentrici. Ogni ruolo è un soprainsieme di operazioni consentite del ruolo precedente:

  • lettore può utilizzare la risorsa (ad es. modello ottimizzato, corpus) per l'inferenza
  • l'autore dispone delle autorizzazioni dei lettori e può inoltre modificare e condividere
  • il proprietario dispone delle autorizzazioni dello scrittore e può anche eliminare
Campi
name string

Solo output. Identificatore. Il nome dell'autorizzazione. Al momento della creazione verrà generato un nome univoco. Esempi: tunedModels/{tunedModel}/permissions/{permission} corpora/{corpus}/permissions/{permission} Solo output.

granteeType enum (GranteeType)

(Facoltativo) Immutabile. Il tipo di beneficiario.

emailAddress string

(Facoltativo) Immutabile. L'indirizzo email dell'utente del gruppo a cui fa riferimento questa autorizzazione. Il campo non è impostato quando il tipo di concessore dell'autorizzazione è TUTTI.

role enum (Role)

Obbligatorio. Il ruolo concesso da questa autorizzazione.

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

GranteeType

Definisce i tipi di beneficiari di questa autorizzazione.

Enum
GRANTEE_TYPE_UNSPECIFIED Il valore predefinito. Questo valore non è utilizzato.
USER Rappresenta un utente. Se impostato, devi fornire l'indirizzo email per l'utente.
GROUP Rappresenta un gruppo. Quando è impostato, devi fornire emailAddress per il gruppo.
EVERYONE Rappresenta l'accesso a tutti. Non sono richieste informazioni aggiuntive.

Ruolo

Definisce il ruolo concesso da questa autorizzazione.

Enum
ROLE_UNSPECIFIED Il valore predefinito. Questo valore non è utilizzato.
OWNER Il proprietario può utilizzare, aggiornare, condividere ed eliminare la risorsa.
WRITER Lo scrittore può utilizzare, aggiornare e condividere la risorsa.
READER Il Lettore può utilizzare la risorsa.

ListPermissionsResponse

Risposta di ListPermissions contenente un elenco paginato di autorizzazioni.

Campi
permissions[] object (Permission)

Autorizzazioni restituite.

nextPageToken string

Un token, che può essere inviato come pageToken per recuperare la pagina successiva.

Se questo campo viene omesso, non ci sono altre pagine.

Rappresentazione JSON 
{
  "permissions": [
    {
      object (Permission)
    }
  ],
  "nextPageToken": string
}