Corpora

Metodo: corpora.create

Crea un Corpus vuoto.

Endpoint

post https://generativelanguage.googleapis.com/v1beta/corpora

L'URL utilizza la sintassi di transcodifica gRPC.

Corpo della richiesta

Il corpo della richiesta contiene un'istanza di Corpus.

Campi
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 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 un Corpus.

Endpoint

post https://generativelanguage.googleapis.com/v1beta/{name=corpora/*}:query

L'URL utilizza la sintassi di transcodifica gRPC.

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:

Campi
query string

Obbligatorio. Stringa di query per eseguire una 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 elenco di oggetti: metadataFilters = [ {key = "chunk.custom_metadata.year" conditions = [{int_value = 2015, operation = GREATER}]}, {key = "chunk.custom_metadata.year" conditions = [{int_value = 2020, operation = LESS_EQUAL}]}]

Nota: i "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 di corpora.query contenente un elenco di chunk pertinenti.

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Campi
relevantChunks[] object (RelevantChunk)

I chunk pertinenti.

Rappresentazione JSON 
{
  "relevantChunks": [
    {
      object (RelevantChunk)
    }
  ]
}

Metodo: corpora.list

Elenca tutti i Corpora di proprietà dell'utente.

Endpoint

get https://generativelanguage.googleapis.com/v1beta/corpora

L'URL utilizza la sintassi di transcodifica gRPC.

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 chiamata corpora.list precedente.

Fornisci il valore nextPageToken restituito nella risposta come argomento alla richiesta successiva per recuperare la 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 paginato 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:

Campi
corpora[] object (Corpus)

I corpora restituiti.

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 (Corpus)
    }
  ],
  "nextPageToken": string
}

Metodo: corpora.get

Recupera le informazioni su un Corpus specifico.

Endpoint

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

L'URL utilizza la sintassi di transcodifica gRPC.

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

Aggiorna un Corpus.

Endpoint

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

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

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 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.

Campi
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

Consente di eliminare un Corpus.

Endpoint

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

name string

Obbligatorio. Il nome della risorsa del Corpus. Esempio: corpora/my-corpus-123 assume la forma 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 es. un modello ottimizzato, un corpus).

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 i ruoli. Quando assegni un ruolo, concedi le autorizzazioni incluse nel ruolo.

Esistono tre ruoli concentrici. Ogni ruolo è un superinsieme delle operazioni consentite dal ruolo precedente:

  • il lettore può utilizzare la risorsa (ad es. modello ottimizzato, corpus) per l'inferenza
  • L'autore ha le autorizzazioni del lettore e può anche 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 concessore.

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 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 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 = dramma OPPURE genere = azione): key = "document.custom_metadata.genre" conditions = [{stringValue = "drama", operation = EQUAL}, {stringValue = "action", operation = EQUAL}]

Campi
key string

Obbligatorio. La chiave dei metadati in base alla quale filtrare.

conditions[] object (Condition)

Obbligatorio. I valori Condition per la chiave specificata che attiveranno questo filtro. Più Condition sono uniti da operatori OR logici.

Rappresentazione JSON 
{
  "key": string,
  "conditions": [
    {
      object (Condition)
    }
  ]
}

Condizione

Condizione di filtro applicabile a una singola chiave.

Campi
operation enum (Operator)

Obbligatorio. Operatore applicato alla coppia chiave-valore specificata per attivare la condizione.

value Union type
Il tipo di valore deve essere coerente con il tipo di valore definito nel campo per la chiave corrispondente. Se i tipi di valore 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 di stringa in base al quale filtrare i metadati.

numericValue number

Il valore numerico in base al quale filtrare i metadati.

Rappresentazione JSON 
{
  "operation": enum (Operator),

  // value
  "stringValue": string,
  "numericValue": number
  // Union type
}

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 numeric.
LESS_EQUAL Supportato da numeric.
EQUAL Supportato da numeri e stringhe.
GREATER_EQUAL Supportato da numeric.
GREATER Supportato da numeric.
NOT_EQUAL Supportato da numeri e stringhe.
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.

RelevantChunk

Le informazioni relative a un chunk pertinenti a una query.

Campi
chunkRelevanceScore number

Chunk alla query.

chunk object (Chunk)

Chunk associato alla query.

Rappresentazione JSON 
{
  "chunkRelevanceScore": number,
  "chunk": {
    object (Chunk)
  }
}

Risorsa REST: corpora

Risorsa: Corpus

Un Corpus è una raccolta di Document. Un progetto può creare fino a 5 corpora.

Campi
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 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
}