- Richiesta HTTP
- Parametri del percorso
- Corpo della richiesta
- Corpo della risposta
- Ambiti di autorizzazione
Esegue la ricerca semantica su un elemento Document
.
Richiesta HTTP
POST https://generativelanguage.googleapis.com/v1beta/{name=corpora/*/documents/*}:query
L'URL utilizza la sintassi di transcodifica gRPC.
Parametri del percorso
Parametri | |
---|---|
name |
Obbligatorio. Il nome dell'oggetto |
Corpo della richiesta
Il corpo della richiesta contiene dati con la seguente struttura:
Rappresentazione JSON |
---|
{
"query": string,
"resultsCount": integer,
"metadataFilters": [
{
object ( |
Campi | |
---|---|
query |
Obbligatorio. Stringa di query per eseguire la ricerca semantica. |
resultsCount |
Campo facoltativo. Il numero massimo di Se non specificato, verranno restituiti al massimo 10 |
metadataFilters[] |
Campo facoltativo. Filtra in base ai metadati Nota: i filtri a livello di Esempio di query: (anno >= 2020 OR anno < 2010) AND (genere = drammatico OR genere = azione)
Esempio di query per un intervallo numerico di valori: (anno > 2015 AND anno <= 2020) Elenco di oggetti 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. |
Corpo della risposta
Risposta da documents.query
contenente un elenco di blocchi pertinenti.
In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:
Rappresentazione JSON |
---|
{
"relevantChunks": [
{
object ( |
Campi | |
---|---|
relevantChunks[] |
I blocchi pertinenti sono stati restituiti. |
Ambiti di autorizzazione
Richiede uno dei seguenti ambiti OAuth:
https://www.googleapis.com/auth/generative-language.retriever
https://www.googleapis.com/auth/generative-language.retriever.readonly
Per ulteriori informazioni, consulta la Panoramica dell'autenticazione.