Corpus Permissions

Metodo: corpora.permissions.create

Crea un'autorizzazione per una risorsa specifica.

Endpoint

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

Parametri del percorso

parent string

Obbligatorio. La risorsa padre di Permission. Formati: tunedModels/{tunedModel} corpora/{corpus} Assume la forma corpora/{corpora}.

Corpo della richiesta

Il corpo della richiesta contiene un'istanza di Permission.

Campi
granteeType enum (GranteeType)

(Facoltativo) Immutabile. Il tipo di beneficiario.

emailAddress string

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

role enum (Role)

Obbligatorio. Il ruolo concesso da questa autorizzazione.

Esempio di richiesta

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 della risposta

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

Metodo: corpora.permissions.list

Elenca le autorizzazioni per la risorsa specifica.

Endpoint

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

Parametri del percorso

parent string

Obbligatorio. La risorsa padre delle autorizzazioni. Formati: tunedModels/{tunedModel} corpora/{corpus} Assume la forma 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 passi un valore pageSize maggiore.

pageToken string

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

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

Durante la paginazione, tutti gli altri parametri forniti a permissions.list devono corrispondere alla chiamata che ha fornito il token di pagina.

Corpo della richiesta

Il corpo della richiesta deve essere vuoto.

Esempio di richiesta

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 della risposta

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

Metodo: corpora.permissions.get

Recupera 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} Assume la forma corpora/{corpora}/permissions/{permission}.

Corpo della richiesta

Il corpo della richiesta deve essere vuoto.

Esempio di richiesta

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 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. Assume la forma corpora/{corpora}/permissions/{permission}.

Parametri di query

updateMask string (FieldMask format)

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

Si tratta di un elenco separato da virgole di nomi completi dei campi. 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.

Esempio di richiesta

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 della risposta

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

Metodo: corpora.permissions.delete

Elimina l'autorizzazione.

Endpoint

delete 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} Assume la forma corpora/{corpora}/permissions/{permission}.

Corpo della richiesta

Il corpo della richiesta deve essere vuoto.

Esempio di richiesta

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 della risposta

In caso di esito positivo, il corpo della risposta è un oggetto JSON 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 API PaLM (ad es. un modello ottimizzato, un corpus).

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

Esistono tre ruoli concentrici. Ogni ruolo è un superset delle operazioni consentite del ruolo precedente:

  • il lettore può utilizzare la risorsa (ad es. modello ottimizzato, corpus) per l'inferenza
  • L'autore dispone delle autorizzazioni del lettore e può anche modificare e condividere
  • Il proprietario dispone delle autorizzazioni di scrittura 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 o del gruppo a cui fa riferimento questa autorizzazione. Il campo non è impostato quando il tipo di beneficiario dell'autorizzazione è EVERYONE.

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 beneficiario di questa autorizzazione.

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

Ruolo

Definisce il ruolo concesso da questa autorizzazione.

Enum
ROLE_UNSPECIFIED Il valore predefinito. Questo valore non viene utilizzato.
OWNER Il proprietario può utilizzare, aggiornare, condividere ed eliminare la risorsa.
WRITER L'autore può utilizzare, aggiornare e condividere la risorsa.
READER Il lettore può utilizzare la risorsa.

ListPermissionsResponse

Risposta da 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 verranno visualizzate altre pagine.

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