Corpora

Risorsa REST: corpora

Risorsa: corpus

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

Rappresentazione JSON 
{
  "name": string,
  "displayName": string,
  "createTime": string,
  "updateTime": string
}
Campi
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

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. Timestamp della creazione di Corpus.

Un timestamp nel formato RFC3339 UTC "Zulu" con risoluzione in nanosecondi 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. Timestamp dell'ultimo aggiornamento di Corpus.

Un timestamp nel formato RFC3339 UTC "Zulu" con risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

Metodo: corpora.create

Crea un campo Corpus vuoto.

Endpoint

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

Corpo della richiesta

Il corpo della richiesta contiene un'istanza di Corpus.

Corpo della risposta

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

Metodo: corpora.list

Elenca tutti i Corpora di proprietà dell'utente.

Endpoint

recupera 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 massimo per le dimensioni è 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.

Durante l'impaginazione, tutti gli altri parametri forniti a corpora.list devono corrispondere alla chiamata che ha fornito il token della 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 vengono ordinati in base al valore corpus.create_time crescente.

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

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

Metodo: corpora.query

Esegue una ricerca semantica su Corpus.

Endpoint

pubblica 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 Il formato è corpora/{corpora}.

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

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

Esempio di query a livello di documento: (anno >= 2020 OR anno < 2010) AND (genere = drammatico OR genere = azione)

Elenco di oggetti MetadataFilter: metadataFilters = [ {key = "document.custom_metadata.year" condizioni = [{int_value = 2020, operazione = GREATER_EQUAL}, {int_value = 2010, operazione = LESS}]}, {key = "document.custom_metadata.year" condizioni = [{int_value = 2020, operazione = GREATER_EQUAL}, {int_value = 2010, operazione = LESS}]}, {key = "document.custom_metadata.generate" condizioni = [{stringValue = "drama", operazione = EQUAL}, {stringValue = "azione", operazione = EQUAL}]}]

Esempio di query a livello di blocco per un intervallo numerico di valori: (anno > 2015 AND anno <= 2020)

Elenco di oggetti MetadataFilter: metadataFilters = [ {key = "chunk.custom_metadata.year" conditions = [{int_value = 2015, operation = GREATER}]}, {key = &quot;chunk.custom_metadata.year&quot; 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 "OR" per la stessa chiave.

resultsCount integer

(Facoltativo) Il numero massimo di Chunk da restituire. Il servizio potrebbe restituire meno Chunk secondi.

Se non specificato, verranno restituiti al massimo 10 Chunk. Il numero massimo di risultati specificato è 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:

Campi
relevantChunks[] object (RelevantChunk)

I blocchi pertinenti.

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

Metodo: corpora.get

Riceve informazioni su uno specifico Corpus.

Endpoint

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

Parametri del percorso

name string

Obbligatorio. Il nome dell'elemento Corpus. Esempio: corpora/my-corpus-123 Il formato è 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/*}

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 Il formato è 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 di nomi completi dei campi separati da virgole. Esempio: "user.displayName,photo".

Corpo della richiesta

Il corpo della richiesta contiene un'istanza di Corpus.

Corpo della risposta

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

Metodo: corpora.delete

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 il criterio viene impostato su true, tutti gli elementi Document e gli oggetti relativi a Corpus verranno eliminati.

Se il valore è false (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 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
  • proprietario dispone delle autorizzazioni dell'autore e può inoltre eliminare
Rappresentazione JSON 
{
  "name": string,
  "granteeType": enum (GranteeType),
  "emailAddress": string,
  "role": enum (Role)
}
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 se il tipo di beneficiario dell'autorizzazione è TUTTI.

role enum (Role)

Obbligatorio. Il ruolo concesso da questa autorizzazione.

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.

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" condizioni = [{stringValue = "drama", operazione = EQUAL}, {stringValue = "azione", operazione = EQUAL}]

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

Obbligatorio. La chiave dei metadati in base ai quali applicare il filtro.

conditions[] object (Condition)

Obbligatorio. I valori Condition della chiave specificata che attiverà il filtro. Più Condition sono uniti da OR logici.

Condizione

Condizione del filtro applicabile a una singola chiave.

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

  // Union field value can be only one of the following:
  "stringValue": string,
  "numericValue": number
  // End of list of possible types for union field value.
}
Campi
operation enum (Operator)

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

Campo unione value. Il tipo di valore deve essere coerente con il tipo di valore definito nel campo della 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 abbinata a un'operazione INCLUDES/EXCLUDES, 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.

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 un valore numerico.
EQUAL Supportato da numeri & stringa.
GREATER_EQUAL Supportato da un valore numerico.
GREATER Supportato da un valore numerico.
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.

RelevantChunk

Le informazioni di un blocco pertinente a una query.

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

Chunk la pertinenza rispetto alla query.

chunk object (Chunk)

Chunk associati alla query.