Metodo: corpora.create
Crea un Corpus
vuoto.
Endpoint
pubblica
https://generativelanguage.googleapis.com/v1beta/corpora
Corpo della richiesta
Il corpo della richiesta contiene un'istanza di Corpus
.
name
string
Immutabile. Identificatore. Il nome della risorsa Corpus
. L'ID (nome escluso il prefisso "corpora/") può contenere fino a 40 caratteri alfanumerici minuscoli o trattini (-). L'ID non può iniziare o terminare con un trattino. Se il nome è vuoto al momento della creazione, verrà generato un nome univoco da displayName
insieme a un suffisso casuale di 12 caratteri. Esempio: corpora/my-awesome-corpora-123a456b789c
displayName
string
(Facoltativo) Il nome visualizzato leggibile per l'Corpus
. Il nome visualizzato non deve contenere più di 512 caratteri, spazi inclusi. Esempio: "Documenti su Semantic Retriever"
Corpo della risposta
In caso di esito positivo, il corpo della risposta contiene un'istanza di Corpus
appena creata.
Metodo: corpora.query
Esegue una ricerca semantica su Corpus
.
Endpoint
post
https://generativelanguage.googleapis.com/v1beta/{name=corpora/*}:query
Parametri del percorso
name
string
Obbligatorio. Il nome del Corpus
su cui eseguire la query. Esempio: corpora/my-corpus-123
assume la forma corpora/{corpora}
.
Corpo della richiesta
Il corpo della richiesta contiene dati con la seguente struttura:
query
string
Obbligatorio. Stringa di query per eseguire la ricerca semantica.
metadataFilters[]
object (MetadataFilter
)
(Facoltativo) Filtra in base ai metadati Chunk
e Document
. Ogni oggetto MetadataFilter
deve corrispondere a una chiave univoca. Più oggetti MetadataFilter
sono uniti da "AND" logici.
Query di esempio a livello di documento: (year >= 2020 OR year < 2010) AND (genre = drama OR genre = action)
MetadataFilter
elenco di oggetti: metadataFilters = [ {key = "document.custom_metadata.year" conditions = [{int_value = 2020, operation = GREATER_EQUAL}, {int_value = 2010, operation = LESS}]}, {key = "document.custom_metadata.year" conditions = [{int_value = 2020, operation = GREATER_EQUAL}, {int_value = 2010, operation = LESS}]}, {key = "document.custom_metadata.genre" conditions = [{stringValue = "drama", operation = EQUAL}, {stringValue = "action", operation = EQUAL}]}]
Query di esempio a livello di chunk per un intervallo di valori numerici: (year > 2015 AND year <= 2020)
MetadataFilter
object list: metadataFilters = [ {key = "chunk.custom_metadata.year" condizioni = [{int_value = 2015, operazione = GREATER}]}, {chiave = "chunk.custom_metadata.year" condizioni = [{int_value = 2020, operazione = LESS_EQUAL}]}]
Nota: gli "AND" per la stessa chiave sono supportati solo per i valori numerici. I valori stringa supportano solo gli operatori "OR" per la stessa chiave.
resultsCount
integer
(Facoltativo) Il numero massimo di Chunk
da restituire. Il servizio potrebbe restituire meno Chunk
.
Se non specificato, verranno restituiti al massimo 10 Chunk
. Il numero massimo di risultati specificati è 100.
Corpo della risposta
Risposta da corpora.query
contenente un elenco di blocchi pertinenti.
In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:
relevantChunks[]
object (RelevantChunk
)
I chunk pertinenti.
Rappresentazione JSON |
---|
{
"relevantChunks": [
{
object ( |
Metodo: corpora.list
Elenca tutti i Corpora
di proprietà dell'utente.
Endpoint
get
https://generativelanguage.googleapis.com/v1beta/corpora
Parametri di query
pageSize
integer
(Facoltativo) Il numero massimo di Corpora
da restituire (per pagina). Il servizio potrebbe restituire meno Corpora
.
Se non specificato, verranno restituiti al massimo 10 Corpora
. Il limite di dimensione massima è 20 Corpora
per pagina.
pageToken
string
(Facoltativo) Un token di pagina, ricevuto da una precedente chiamata a corpora.list
.
Fornisci il valore nextPageToken
restituito nella risposta come argomento per la richiesta successiva di recupero della pagina successiva.
Quando viene applicata la paginazione, tutti gli altri parametri forniti a corpora.list
devono corrispondere alla chiamata che ha fornito il token pagina.
Corpo della richiesta
Il corpo della richiesta deve essere vuoto.
Corpo della risposta
Risposta da corpora.list
contenente un elenco impaginato di Corpora
. I risultati sono ordinati in ordine crescente per corpus.create_time
.
In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:
corpora[]
object (Corpus
)
Il corpora restituito.
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 |
---|
{
"corpora": [
{
object ( |
Metodo: corpora.get
Recupera le informazioni su un Corpus
specifico.
Endpoint
recupera
https://generativelanguage.googleapis.com/v1beta/{name=corpora/*}
Parametri del percorso
name
string
Obbligatorio. Il nome del Corpus
. Esempio: corpora/my-corpus-123
assume la forma corpora/{corpora}
.
Corpo della richiesta
Il corpo della richiesta deve essere vuoto.
Corpo della risposta
In caso di esito positivo, il corpo della risposta contiene un'istanza di Corpus
.
Metodo: corpora.patch
- Endpoint
- Parametri percorso
- Parametri di ricerca
- Corpo della richiesta
- Corpo della risposta
- Ambiti di autorizzazione
Aggiorna un Corpus
.
Endpoint
patch
https://generativelanguage.googleapis.com/v1beta/{corpus.name=corpora/*}
PATCH https://generativelanguage.googleapis.com/v1beta/{corpus.name=corpora/*}
Parametri del percorso
corpus.name
string
Immutabile. Identificatore. Il nome della risorsa Corpus
. L'ID (nome senza il prefisso "corpora/") può contenere fino a 40 caratteri alfanumerici minuscoli o trattini (-). L'ID non può iniziare o terminare con un trattino. Se il nome è vuoto al momento della creazione, da displayName
verrà derivato un nome univoco con un suffisso casuale di 12 caratteri. Esempio: corpora/my-awesome-corpora-123a456b789c
assume la forma corpora/{corpora}
.
Parametri di query
updateMask
string (FieldMask
format)
Obbligatorio. L'elenco dei campi da aggiornare. Al momento è supportato solo l'aggiornamento di displayName
.
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 Corpus
.
displayName
string
(Facoltativo) Il nome visualizzato leggibile per Corpus
. Il nome visualizzato non deve contenere più di 512 caratteri, spazi inclusi. Esempio: "Documenti su Semantic Retriever"
Corpo della risposta
In caso di esito positivo, il corpo della risposta contiene un'istanza di Corpus
.
Metodo: corpora.delete
- Endpoint
- Parametri del percorso
- Parametri di ricerca
- Corpo della richiesta
- Corpo della risposta
- Ambiti di autorizzazione
Elimina un Corpus
.
Endpoint
elimina
https://generativelanguage.googleapis.com/v1beta/{name=corpora/*}
Parametri del percorso
name
string
Obbligatorio. Il nome della risorsa di Corpus
. Esempio: corpora/my-corpus-123
Il formato è corpora/{corpora}
.
Parametri di query
force
boolean
(Facoltativo) Se impostata su true, verranno eliminati anche tutti i Document
e gli oggetti correlati a questo Corpus
.
Se è false (il valore predefinito), verrà restituito un errore FAILED_PRECONDITION
se Corpus
contiene Document
.
Corpo della richiesta
Il corpo della richiesta deve essere vuoto.
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 è una raccolta 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 i 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
- proprietario dispone delle autorizzazioni dell'autore e può inoltre eliminare
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 se il tipo di beneficiario dell'autorizzazione è TUTTI.
role
enum (Role
)
Obbligatorio. Il ruolo concesso da questa autorizzazione.
Rappresentazione JSON |
---|
{ "name": string, "granteeType": enum ( |
GranteeType
Definisce i tipi di assegnatari 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 dell'utente. |
GROUP |
Rappresenta un gruppo. Se impostato, devi fornire l'indirizzo email 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. |
MetadataFilter
Filtro fornito dall'utente per limitare il recupero in base ai valori dei metadati a livello di Chunk
o Document
. Esempio (genere = drammatico OR genere = azione): chiave = "document.custom_metadata.genre" conditions = [{stringValue = "drama", operation = EQUAL}, {stringValue = "action", operation = EQUAL}]
key
string
Obbligatorio. La chiave dei metadati in base ai quali applicare il filtro.
conditions[]
object (Condition
)
Obbligatorio. I Condition
per la chiave specificata che attiveranno questo filtro. Più Condition
sono uniti da OR logici.
Rappresentazione JSON |
---|
{
"key": string,
"conditions": [
{
object ( |
Condizione
Condizione del filtro applicabile a una singola chiave.
operation
enum (Operator
)
Obbligatorio. Operatore applicato alla coppia chiave-valore specificata per attivare la condizione.
value
. Il tipo di valore deve essere coerente con il tipo di valore definito nel campo per la chiave corrispondente. Se i tipi di valori non sono coerenti, il risultato sarà un insieme vuoto. Quando CustomMetadata
ha un tipo di valore StringList
, la condizione di filtro deve utilizzare string_value
accoppiato a un'operazione INCLUDE/EXCLUDE, altrimenti il risultato sarà anche un insieme vuoto. value
può essere solo uno dei seguenti:
stringValue
string
Il valore della stringa in base al quale filtrare i metadati.
numericValue
number
Il valore numerico in base al quale filtrare i metadati.
Rappresentazione JSON |
---|
{ "operation": enum ( |
Operatore
Definisce gli operatori validi che possono essere applicati a una coppia chiave-valore.
Enum | |
---|---|
OPERATOR_UNSPECIFIED |
Il valore predefinito. Questo valore non è utilizzato. |
LESS |
Supportato da un valore numerico. |
LESS_EQUAL |
Supportato da numeric. |
EQUAL |
Supportato da numeri & stringa. |
GREATER_EQUAL |
Supportato da un valore numerico. |
GREATER |
Supportato da numeric. |
NOT_EQUAL |
Supportato da numeri & stringa. |
INCLUDES |
Supportato dalla stringa solo quando il tipo di valore CustomMetadata per la chiave specificata ha un stringListValue . |
EXCLUDES |
Supportato dalla stringa solo quando il tipo di valore CustomMetadata per la chiave specificata ha un stringListValue . |
Risorsa REST: corpora
Risorsa: Corpus
Un Corpus
è una raccolta di Document
. Un progetto può creare fino a cinque corpora.
name
string
Immutabile. Identificatore. Il nome della risorsa Corpus
. L'ID (nome escluso il prefisso "corpora/") può contenere fino a 40 caratteri alfanumerici minuscoli o trattini (-). L'ID non può iniziare o terminare con un trattino. Se il nome è vuoto al momento della creazione, da displayName
verrà derivato un nome univoco con un suffisso casuale di 12 caratteri. Esempio: corpora/my-awesome-corpora-123a456b789c
displayName
string
(Facoltativo) Il nome visualizzato leggibile per l'Corpus
. Il nome visualizzato non deve contenere più di 512 caratteri, spazi inclusi. Esempio: "Documenti su Semantic Retriever"
createTime
string (Timestamp
format)
Solo output. Il timestamp della creazione di Corpus
.
Un timestamp in formato "Zulu" UTC RFC3339, con risoluzione a livello di nanosecondo e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z"
e "2014-10-02T15:01:23.045123456Z"
.
updateTime
string (Timestamp
format)
Solo output. Il timestamp dell'ultimo aggiornamento di Corpus
.
Un timestamp in formato "Zulu" UTC RFC3339, con risoluzione a livello di nanosecondo e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z"
e "2014-10-02T15:01:23.045123456Z"
.
Rappresentazione JSON |
---|
{ "name": string, "displayName": string, "createTime": string, "updateTime": string } |