Method: corpora.documents.query

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

string

Obbligatorio. Il nome dell'oggetto Document su cui eseguire la query. Esempio: corpora/my-corpus-123/documents/the-doc-abc

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "query": string,
  "resultsCount": integer,
  "metadataFilters": [
    {
      object (MetadataFilter)
    }
  ]
}
Campi
query

string

Obbligatorio. Stringa di query per eseguire la ricerca semantica.
resultsCount

integer

Campo 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 specificato è 100.
metadataFilters[]

object (MetadataFilter)

Campo facoltativo. Filtra in base ai metadati Chunk. Ogni oggetto MetadataFilter deve corrispondere a una chiave univoca. Più oggetti MetadataFilter sono uniti da "AND" logici.

Nota: i filtri a livello di Document non sono supportati per questa richiesta perché è già stato specificato un nome Document.

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

MetadataFilter elenco di oggetti: metadataFiltri = [ {key = "chunk.custom_metadata.year" condizioni = [{int_value = 2020, Operation = GREATER_EQUAL}, {int_value = 2010, Operation = LESS}}, {key = "chunk.custom_metadata.year" mondo", condizioni = [{stringValue = "drama EQUAL}} operazione, operazione EQUAL = "string EQUAL}}

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

Elenco di oggetti MetadataFilter: metadataFiltri = [ {key = condizioni "chunk.custom_metadata.year" = [{int_value = 2015, Operation = GREATER}]}, {key = "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.

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 (RelevantChunk)
    }
  ]
}
Campi
relevantChunks[]

object (RelevantChunk)

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.