Method: projects.locations.queryData

Esegue query sui dati da una query utente in linguaggio naturale.

Richiesta HTTP


POST https://geminidataanalytics.googleapis.com/v1alpha/{parent=projects/*/locations/*}:queryData

Gli URL utilizzano la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
parent

string

Obbligatorio. La risorsa principale per cui generare la query. Formato: projects/{project}/locations/{location}

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "prompt": string,
  "context": {
    object (QueryDataContext)
  },
  "generationOptions": {
    object (GenerationOptions)
  }
}
Campi
prompt

string

Obbligatorio. La query in linguaggio naturale per cui generare la query. Esempio: "Quali sono i 5 prodotti più venduti questo mese?"
context

object (QueryDataContext)

Obbligatorio. Il contesto della query sui dati, incluse le origini dati da utilizzare.
generationOptions

object (GenerationOptions)

Facoltativo. Opzioni per controllare il comportamento di generazione ed esecuzione delle query.

Corpo della risposta

Risposta contenente la query generata e le informazioni correlate.

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

Rappresentazione JSON 
{
  "generatedQuery": string,
  "intentExplanation": string,
  "queryResult": {
    object (ExecutedQueryResult)
  },
  "naturalLanguageAnswer": string,
  "disambiguationQuestion": [
    string
  ]
}
Campi
generatedQuery

string

Query generata per il prompt dell'utente specificato.
intentExplanation

string

Una spiegazione in linguaggio naturale della query generata. Compilato se options.generate_explanation era true nella richiesta.
queryResult

object (ExecutedQueryResult)

Il risultato dell'esecuzione della query. Compilato se options.generate_query_result o options.generate_natural_language_answer era true nella richiesta e l'esecuzione è riuscita o è stata tentata.
naturalLanguageAnswer

string

Una risposta in linguaggio naturale alla query, basata su queryResult. Compilato se options.generate_natural_language_answer era true nella richiesta e l'esecuzione della query è riuscita in base alla risposta dell'API executeSql.
disambiguationQuestion[]

string

Se è stata rilevata ambiguità nella query in linguaggio naturale e options.generate_disambiguation_question è true, questo campo contiene una domanda all'utente per chiarimenti. Il risultato restituito rappresenta il miglior tentativo del servizio in base all'input ambiguo.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Per saperne di più, consulta la Authentication Overview.

QueryDataContext

Riferimenti alle origini dati e al contesto da utilizzare per la query.

Rappresentazione JSON 
{
  "datasourceReferences": {
    object (DatasourceReferences)
  }
}
Campi
datasourceReferences

object (DatasourceReferences)

Obbligatorio. I riferimenti all'origine dati da utilizzare per la query.

GenerationOptions

Opzioni per controllare la generazione, l'esecuzione e il formato di risposta delle query.

Rappresentazione JSON 
{
  "generateQueryResult": boolean,
  "generateNaturalLanguageAnswer": boolean,
  "generateExplanation": boolean,
  "generateDisambiguationQuestion": boolean
}
Campi
generateQueryResult

boolean

Facoltativo. Se è true, la query generata verrà eseguita e i dati dei risultati verranno restituiti nella risposta.
generateNaturalLanguageAnswer

boolean

Facoltativo. Se è true, nella risposta verrà generata e restituita una risposta in linguaggio naturale basata sul risultato dell'esecuzione della query.
generateExplanation

boolean

Facoltativo. Se è true, nella risposta verrà restituita una spiegazione della query generata.
generateDisambiguationQuestion

boolean

Facoltativo. Se è true (il valore predefinito è false), il servizio potrebbe restituire una clarifying_question se la query di input è ambigua.

ExecutedQueryResult

Il risultato dell'esecuzione di una query. Il design è generico per tutti i dialetti.

Rappresentazione JSON 
{
  "columns": [
    {
      object (Column)
    }
  ],
  "rows": [
    {
      object (Row)
    }
  ],
  "totalRowCount": string,
  "partialResult": boolean,
  "queryExecutionError": string
}
Campi
columns[]

object (Column)

Le colonne nel set di risultati, in ordine.
rows[]

object (Row)

Le righe restituite dalla query.
totalRowCount

string (int64 format)

Il numero totale di righe nel set di risultati completo, se noto. Potrebbe trattarsi di una stima o di un conteggio esatto.
partialResult

boolean

Impostato su true se le righe restituite in queryResult sono un sottoinsieme del risultato completo. Ciò può accadere, ad esempio, se l'esecuzione della query raggiunge un limite di righe. Se è true, queryResult non contiene tutte le righe. Per recuperare il risultato completo, valuta la possibilità di utilizzare generatedQuery in QueryDataResponse ed eseguirlo nel tuo ambiente.
queryExecutionError

string

Il messaggio di errore se l'esecuzione della query non è riuscita.

Colonna

Descrive una singola colonna nel set di risultati.

Rappresentazione JSON 
{
  "name": string,
  "type": string
}
Campi
name

string

Il nome della colonna.
type

string

Il tipo di colonna (ad es. "VARCHAR", "INT64", "TIMESTAMP").

Riga

Rappresenta una singola riga nell'insieme di risultati.

Rappresentazione JSON 
{
  "values": [
    {
      object (Value)
    }
  ]
}
Campi
values[]

object (Value)

I valori nella riga, corrispondenti per posizione alle colonne.

Valore

Rappresenta un singolo valore all'interno di una riga.

Rappresentazione JSON 
{
  "value": string
}
Campi
value

string

Il valore della cella, rappresentato in formato stringa. I timestamp potrebbero essere formattati, ad esempio, utilizzando RFC3339Nano. Questo campo viene utilizzato se il valore non è null.