- Risorsa: DataAgent
- DataAnalyticsAgent
- Contesto
- DatasourceReferences
- BigQueryTableReferences
- BigQueryTableReference
- Schema
- Campo
- DataFilter
- DataFilterType
- StudioDatasourceReferences
- StudioDatasourceReference
- LookerExploreReferences
- LookerExploreReference
- PrivateLookerInstanceInfo
- ConversationOptions
- AnalysisOptions
- Python
- DatasourceOptions
- Modello
- ExampleQuery
- QueryParameter
- LookerGoldenQuery
- LookerQuery
- Filtro
- GlossaryTerm
- SchemaRelationship
- SchemaPaths
- Origine
- UserFunctions
- BigQueryRoutine
- BigQueryRoutineReference
- Metodi
Risorsa: DataAgent
Messaggio che descrive un oggetto DataAgent.
| Rappresentazione JSON |
|---|
{ "name": string, "displayName": string, "description": string, "labels": { string: string, ... }, "createTime": string, "updateTime": string, "deleteTime": string, "purgeTime": string, // Union field |
| Campi | |
|---|---|
name |
Facoltativo. Identificatore. Il nome univoco della risorsa di un DataAgent. Formato: Esempio: Ti consigliamo di saltare l'impostazione di questo campo durante la creazione dell'agente, in quanto verrà dedotto automaticamente e sovrascritto con {parent}/dataAgents/{dataAgentId}. |
displayName |
Facoltativo. Nome visualizzato intuitivo.
|
description |
Facoltativo. Descrizione dell'agente.
|
labels |
Facoltativo. Etichette per aiutare gli utenti a filtrare gli agenti correlati. Ad esempio, "vendite", "business", "etl" e così via. Le etichette delle note vengono utilizzate solo per il filtraggio e non per le norme. Per ulteriori dettagli sull'utilizzo delle etichette, consulta la documentazione sulle etichette. Un oggetto contenente un elenco di coppie |
createTime |
Solo output. L'ora in cui è stato creato l'agente dati. Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: |
updateTime |
Solo output. L'ora dell'ultimo aggiornamento dell'agente di dati. Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: |
deleteTime |
Solo output. [Solo output] Data e ora di eliminazione temporanea dell'agente dati. Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: |
purgeTime |
Solo output. Timestamp in UTC di quando questo agente di dati è considerato scaduto. Viene sempre fornito nell'output, anche se non inviato nell'input. Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: |
Campo unione type. Il tipo di agente. Può essere uno dei seguenti: * Agente di analisi dei dati. * L'agente di data engineering type può essere solo uno dei seguenti: |
|
dataAnalyticsAgent |
Agente di analisi dei dati. |
kmsKey |
Facoltativo. Chiave di crittografia gestita dal cliente (CMEK) da utilizzare per criptare le risorse DataAgent. Le chiavi di crittografia Cloud KMS devono trovarsi nella stessa località di DataAgent. Il formato previsto è |
DataAnalyticsAgent
Messaggio che descrive un oggetto DataAnalyticsAgent.
| Rappresentazione JSON |
|---|
{ "stagingContext": { object ( |
| Campi | |
|---|---|
stagingContext |
Facoltativo. Il contesto di staging per l'agente. Questo contesto viene utilizzato per testare e convalidare le modifiche prima della pubblicazione. |
publishedContext |
Facoltativo. Il contesto pubblicato per l'agente. Questo contesto viene utilizzato dall'API Chat in produzione. |
lastPublishedContext |
Solo output. L'ultimo contesto pubblicato per l'agente. Questo è un campo di solo output compilato dal sistema quando viene aggiornato il contesto pubblicato. Viene utilizzato per ripristinare lo stato precedente dell'agente. |
Contesto
Una raccolta di contesto da applicare a questa conversazione
| Rappresentazione JSON |
|---|
{ "systemInstruction": string, "datasourceReferences": { object ( |
| Campi | |
|---|---|
systemInstruction |
Facoltativo. Il punto di accesso di base per i proprietari dei dati che creano conoscenze del dominio per l'agente. Perché: il gergo aziendale (ad es. il fatturato da inizio anno viene calcolato come…, l'età pensionabile è 65 anni negli Stati Uniti, ecc.) e le istruzioni di sistema (ad es. rispondi come un pirata) possono aiutare il modello a comprendere il contesto aziendale di una domanda dell'utente. |
datasourceReferences |
Obbligatorio. Le origini dati disponibili per rispondere alla domanda. |
options |
Facoltativo. Opzioni aggiuntive per la conversazione. |
exampleQueries[] |
Facoltativo. Un elenco di query di esempio, che forniscono esempi di query SQL pertinenti e di uso comune e, facoltativamente, le query in linguaggio naturale corrispondenti. Attualmente utilizzato solo per le origini dati e i database BigQuery (alloydb, cloudsql, spanner). |
lookerGoldenQueries[] |
Facoltativo. Un elenco di query di riferimento, che fornisce esempi di query di Looker pertinenti e di uso comune e, facoltativamente, le query in linguaggio naturale corrispondenti. Supportato solo per le origini dati di Looker. |
glossaryTerms[] |
Facoltativo. Definizioni dei termini (al momento, solo quelle create dagli utenti) Non supportate per le origini dati dei database (alloydb, cloudsql, spanner). |
schemaRelationships[] |
Facoltativo. Relazioni tra lo schema della tabella, incluse le colonne di riferimento e quelle a cui si fa riferimento. |
userFunctions |
Facoltativo. Una raccolta di funzioni utente da includere nel contesto. |
DatasourceReferences
Una raccolta di riferimenti alle origini dati.
| Rappresentazione JSON |
|---|
{ // Union field |
| Campi | |
|---|---|
Campo unione references. Le origini dati da utilizzare. references può essere solo uno dei seguenti tipi: |
|
bq |
Riferimenti alle tabelle BigQuery. |
studio |
Riferimenti alle origini dati di Looker Studio. |
looker |
Riferimenti alle esplorazioni di Looker. |
BigQueryTableReferences
Messaggio che rappresenta i riferimenti alle tabelle BigQuery e ai grafici delle proprietà. Almeno uno dei campi tableReferences, propertyGraphReferences o searchScope deve essere compilato.
| Rappresentazione JSON |
|---|
{
"tableReferences": [
{
object ( |
| Campi | |
|---|---|
tableReferences[] |
Facoltativo. Riferimenti alle tabelle BigQuery. |
BigQueryTableReference
Messaggio che rappresenta un riferimento a una singola tabella BigQuery.
| Rappresentazione JSON |
|---|
{
"projectId": string,
"datasetId": string,
"tableId": string,
"schema": {
object ( |
| Campi | |
|---|---|
projectId |
Obbligatorio. Il progetto a cui appartiene la tabella. |
datasetId |
Obbligatorio. Il set di dati a cui appartiene la tabella. |
tableId |
Obbligatorio. L'ID tabella. |
schema |
Facoltativo. Lo schema dell'origine dati. |
Schema
Lo schema di un'istanza Datasource o QueryResult.
| Rappresentazione JSON |
|---|
{ "fields": [ { object ( |
| Campi | |
|---|---|
fields[] |
Facoltativo. I campi dello schema. |
description |
Facoltativo. Una descrizione testuale dei contenuti e dello scopo della tabella. Ad esempio: "Contiene informazioni sugli ordini dei clienti nel nostro negozio e-commerce". Attualmente utilizzato solo per le origini dati BigQuery. |
synonyms[] |
Facoltativo. Un elenco di nomi alternativi o sinonimi che possono essere utilizzati per fare riferimento alla tabella. Ad esempio: ["vendite", "ordini", "acquisti"]. Attualmente utilizzato solo per le origini dati BigQuery. |
tags[] |
Facoltativo. Un elenco di tag o parole chiave associati alla tabella, utilizzati per la categorizzazione. Ad esempio: ["transaction", "revenue", "customer_data"]. Attualmente utilizzato solo per le origini dati BigQuery. |
displayName |
Facoltativo. displayName della tabella (uguale all'etichetta in cloud/data_analytics/anarres/data/looker/proto/model_explore.proto), non obbligatorio, attualmente solo Looker ha questo campo. |
filters[] |
Facoltativo. I filtri sui dati sottostanti dell'origine dati. Attualmente utilizzato solo per le origini dati Looker. |
Campo
Un campo in uno schema.
| Rappresentazione JSON |
|---|
{
"name": string,
"type": string,
"description": string,
"mode": string,
"synonyms": [
string
],
"tags": [
string
],
"displayName": string,
"subfields": [
{
object ( |
| Campi | |
|---|---|
name |
Facoltativo. Il nome del campo. |
type |
Facoltativo. Il tipo di campo. |
description |
Facoltativo. Una breve descrizione del campo. |
mode |
Facoltativo. La modalità del campo (ad es. NULLABLE, REPEATED). |
synonyms[] |
Facoltativo. Un elenco di nomi alternativi o sinonimi che possono essere utilizzati per fare riferimento a questo campo. Ad esempio: ["id", "customerid", "cust_id"]. Attualmente utilizzato solo per le origini dati BigQuery. |
tags[] |
Facoltativo. Un elenco di tag o parole chiave associati al campo, utilizzati per la categorizzazione. Ad esempio: ["identifier", "customer", "pii"]. Attualmente utilizzato solo per le origini dati BigQuery. |
displayName |
Facoltativo. displayName del campo (uguale all'etichetta in |
subfields[] |
Facoltativo. Proprietà ricorsiva per le strutture dello schema nidificate. |
category |
Facoltativo. Categoria del campo, non obbligatoria, attualmente utile solo per Looker. |
valueFormat |
Facoltativo. Solo Looker. Formato del valore del campo. Riferimento: https://cloud.google.com/looker/docs/reference/param-field-value-format |
DataFilter
Un filtro sui dati sottostanti di un'origine dati. Documentazione sulla sintassi dei filtri: https://cloud.google.com/looker/docs/filter-expressions
| Rappresentazione JSON |
|---|
{
"field": string,
"value": string,
"type": enum ( |
| Campi | |
|---|---|
field |
Facoltativo. Il campo in base al quale applicare il filtro. Ad esempio: ["event_date", "customer_id", "product_category"] |
value |
Facoltativo. Il valore predefinito utilizzato per questo filtro se non viene sostituito in una query. Ad esempio: ["after 2024-01-01", "123", "-fashion"] |
type |
Facoltativo. Il tipo di filtro presente in un'origine dati, ad esempio ALWAYS_FILTER. |
DataFilterType
Il tipo di filtro presente in un'origine dati, ad esempio ALWAYS_FILTER.
| Enum | |
|---|---|
DATA_FILTER_TYPE_UNSPECIFIED |
Il tipo di filtro non è stato specificato. |
ALWAYS_FILTER |
Un filtro configurato dall'utente e tutte le query di Esplora applicheranno sempre questo filtro per impostazione predefinita. Attualmente utilizzato solo per le origini dati Looker. |
StudioDatasourceReferences
Messaggio che rappresenta i riferimenti alle origini dati di Looker Studio.
| Rappresentazione JSON |
|---|
{
"studioReferences": [
{
object ( |
| Campi | |
|---|---|
studioReferences[] |
Facoltativo. I riferimenti alle origini dati dello studio. |
StudioDatasourceReference
Messaggio che rappresenta un riferimento a una singola origine dati di Looker Studio.
| Rappresentazione JSON |
|---|
{ "datasourceId": string } |
| Campi | |
|---|---|
datasourceId |
Obbligatorio. L'ID dell'origine dati. |
LookerExploreReferences
Messaggio che rappresenta i riferimenti alle esplorazioni di Looker.
| Rappresentazione JSON |
|---|
{
"exploreReferences": [
{
object ( |
| Campi | |
|---|---|
exploreReferences[] |
Obbligatorio. Riferimenti alle esplorazioni di Looker. |
LookerExploreReference
Messaggio che rappresenta un riferimento a una singola esplorazione di Looker.
| Rappresentazione JSON |
|---|
{ "lookmlModel": string, "explore": string, "schema": { object ( |
| Campi | |
|---|---|
lookmlModel |
Obbligatorio. Modello Looker, come descritto in Strutture LookML principali. Nome del modello LookML. |
explore |
Obbligatorio. Esplora di Looker, come descritto in Strutture principali di LookML. Nome dell'esplorazione LookML. |
schema |
Facoltativo. Lo schema dell'origine dati. |
Campo unione instance. L'istanza dell'esplorazione di Looker. instance può essere solo uno dei seguenti tipi: |
|
lookerInstanceUri |
Obbligatorio. L'URL di base dell'istanza di Looker. |
privateLookerInstanceInfo |
Informazioni sull'istanza di Looker privata. |
PrivateLookerInstanceInfo
Messaggio che rappresenta le informazioni di un'istanza Looker privata richiesto se l'istanza Looker si trova dietro una rete privata.
| Rappresentazione JSON |
|---|
{ "lookerInstanceId": string, "serviceDirectoryName": string } |
| Campi | |
|---|---|
lookerInstanceId |
L'ID istanza Looker. |
serviceDirectoryName |
Il nome della Service Directory dell'istanza di Looker. |
ConversationOptions
Opzioni per la conversazione.
| Rappresentazione JSON |
|---|
{ "analysis": { object ( |
| Campi | |
|---|---|
analysis |
Facoltativo. Opzioni per l'analisi. |
datasource |
Facoltativo. Opzioni per le origini dati. |
model |
Facoltativo. Il modello da utilizzare per il ciclo dell'agente. |
AnalysisOptions
Opzioni per l'analisi.
| Rappresentazione JSON |
|---|
{
"python": {
object ( |
| Campi | |
|---|---|
python |
Facoltativo. Opzioni per l'analisi Python. |
Python
Opzioni per l'analisi Python.
| Rappresentazione JSON |
|---|
{ "enabled": boolean } |
| Campi | |
|---|---|
enabled |
Facoltativo. Se abilitare l'analisi Python. Il valore predefinito è false. |
DatasourceOptions
Opzioni per le configurazioni delle origini dati.
| Rappresentazione JSON |
|---|
{ "bigQueryMaxBilledBytes": string } |
| Campi | |
|---|---|
bigQueryMaxBilledBytes |
Facoltativo. Questa opzione si applica solo alle origini dati che richiedono query BigQuery. Limita i byte fatturati per ogni job di query BigQuery. Le query che includeranno byte fatturati oltre questo limite avranno esito negativo (senza addebiti). Se non specificato, non verrà applicato alcun limite. |
Modello
Modelli consentiti per l'agente/la conversazione.
| Enum | |
|---|---|
MODEL_UNSPECIFIED |
Nessun modello specificato. Il modello può essere impostato nella richiesta di chat oppure verrà utilizzato il modello predefinito. |
LATEST_GA_MODEL |
Utilizza il modello non di anteprima più aggiornato. Ciò potrebbe limitare alcune impostazioni a livello di richiesta. |
ExampleQuery
Esempio di query SQL pertinente e di uso comune e delle query in linguaggio naturale corrispondenti, se presenti. Attualmente utilizzato solo per le origini dati BigQuery.
| Rappresentazione JSON |
|---|
{ "naturalLanguageQuestion": string, "parameters": [ { object ( |
| Campi | |
|---|---|
naturalLanguageQuestion |
Facoltativo. Una domanda in linguaggio naturale che un utente potrebbe porre. Ad esempio: "Quanti ordini sono stati effettuati il mese scorso?" |
parameters[] |
Facoltativo. L'elenco dei parametri di ricerca. Esempio: la query SQL con parametri "SELECT * FROM my_table WHERE id = @id" può essere abbinata a qualsiasi valore di id. |
Campo unione query. La query SQL o Looker che deve essere generata per rispondere alla query in linguaggio naturale. query può essere solo uno dei seguenti tipi: |
|
sqlQuery |
Facoltativo. La query SQL che deve essere generata per rispondere alla domanda in linguaggio naturale. Ad esempio: "SELECT COUNT(*) FROM orders WHERE order_date BETWEEN '2024-01-01' AND '2024-01-31'" |
QueryParameter
Un messaggio con parametro di query rappresenta un parametro che può essere utilizzato per parametrizzare una query SQL.
| Rappresentazione JSON |
|---|
{ "name": string, "description": string, "dataType": string } |
| Campi | |
|---|---|
name |
Obbligatorio. Il nome del riferimento al parametro nella query SQL. |
description |
Facoltativo. La descrizione del parametro che può essere utilizzato dal modello LLM per estrarre il valore parametro dalla domanda dell'utente. |
dataType |
Obbligatorio. Il tipo di dati del parametro, ad esempio "STRING", "INT64", "DATE" e così via. Per i valori validi, consulta la documentazione di BigQuery. Verrà utilizzato per compilare google.cloud.bigquery.v2.QueryParameterType.type. |
LookerGoldenQuery
Una query di riferimento per Looker, incluse domande in linguaggio naturale e una query di Looker corrispondente. Analogous to ExampleQuery.
| Rappresentazione JSON |
|---|
{
"naturalLanguageQuestions": [
string
],
"lookerQuery": {
object ( |
| Campi | |
|---|---|
naturalLanguageQuestions[] |
Facoltativo. Domande in linguaggio naturale che un utente potrebbe porre. Ad esempio: "Quanti ordini sono stati effettuati il mese scorso?" |
lookerQuery |
Facoltativo. La query di Looker corrispondente alle domande in linguaggio naturale. |
LookerQuery
Oggetto query di Looker Documentazione dell'API Looker.
| Rappresentazione JSON |
|---|
{
"model": string,
"explore": string,
"fields": [
string
],
"filters": [
{
object ( |
| Campi | |
|---|---|
model |
Obbligatorio. Il modello LookML utilizzato per generare la query. |
explore |
Obbligatorio. L'esplorazione LookML utilizzata per generare la query. |
fields[] |
Facoltativo. I campi da recuperare dall'esplorazione. |
filters[] |
Facoltativo. I filtri da applicare all'esplorazione. |
sorts[] |
Facoltativo. I tipi di ordinamento da applicare all'esplorazione. |
limit |
Facoltativo. Limite nella query. |
queryId |
Facoltativo. L'identificatore principale della risorsa query in Looker, utilizzato per le operazioni API. Corrisponde a |
clientId |
Facoltativo. L'identificatore alfanumerico breve per la query, utilizzato per i link di condivisione e gli URL di Esplora (ad esempio, nel parametro |
Filtro
Un filtro query di Looker.
| Rappresentazione JSON |
|---|
{ "field": string, "value": string } |
| Campi | |
|---|---|
field |
Obbligatorio. Il campo in base al quale applicare il filtro. |
value |
Facoltativo. Il valore del campo in base al quale applicare il filtro. Facoltativo, in modo da poter conservare il valore predefinito come stringa vuota, importante per ottenere un URL di esplorazione di Looker valido e funzionante. |
GlossaryTerm
Definizione di un termine all'interno di un dominio specifico.
| Rappresentazione JSON |
|---|
{ "displayName": string, "description": string, "labels": [ string ] } |
| Campi | |
|---|---|
displayName |
Obbligatorio. Nome visualizzato intuitivo del termine del glossario in fase di definizione. Ad esempio: "CTR", "tasso di conversione", "in attesa" |
description |
Obbligatorio. La descrizione o il significato del termine. Ad esempio: "Tasso di clickthrough", "La percentuale di utenti che completano un'azione desiderata", "Un ordine in attesa di essere elaborato". |
labels[] |
Facoltativo. Un elenco di etichette generiche associate a questo termine. Ad esempio: ["percentuale di clic", "clickthrough", "in attesa"] |
SchemaRelationship
La relazione tra due tabelle, incluse le colonne di riferimento e quelle a cui si fa riferimento. Questo è un contesto derivato recuperato da Dataplex Dataset Insights.
| Rappresentazione JSON |
|---|
{ "leftSchemaPaths": { object ( |
| Campi | |
|---|---|
leftSchemaPaths |
Un elenco ordinato di campi per l'unione della prima tabella. Le dimensioni di questo elenco devono essere uguali a |
rightSchemaPaths |
Un elenco ordinato di campi per l'unione dalla seconda tabella. Le dimensioni di questo elenco devono essere uguali a |
sources[] |
Facoltativo. Le origini che hanno generato il bordo della relazione dello schema. |
confidenceScore |
Facoltativo. Un punteggio di confidenza per la relazione suggerita. I bordi aggiunti manualmente hanno il punteggio di affidabilità più alto. |
SchemaPaths
Rappresenta un insieme ordinato di percorsi all'interno dello schema della tabella.
| Rappresentazione JSON |
|---|
{ "tableFqn": string, "paths": [ string ] } |
| Campi | |
|---|---|
tableFqn |
Il nome completo della risorsa qualificato per il servizio della tabella. Esempio: bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID |
paths[] |
L'elenco ordinato dei percorsi all'interno dello schema della tabella. |
Origine
L'origine che ha generato il bordo della relazione dello schema.
| Enum | |
|---|---|
SOURCE_UNSPECIFIED |
L'origine della relazione dello schema non è specificata. |
BIGQUERY_JOB_HISTORY |
L'origine della relazione dello schema è la cronologia dei job BigQuery. |
LLM_SUGGESTED |
L'origine della relazione dello schema è suggerita dall'LLM. |
BIGQUERY_TABLE_CONSTRAINTS |
L'origine della relazione dello schema sono i vincoli della tabella BigQuery. |
UserFunctions
Una raccolta di funzioni utente da includere nel contesto.
| Rappresentazione JSON |
|---|
{
"bqRoutines": [
{
object ( |
| Campi | |
|---|---|
bqRoutines[] |
Un elenco di routine BigQuery da includere nel contesto. |
BigQueryRoutine
Un riferimento a una routine BigQuery.
| Rappresentazione JSON |
|---|
{
"routineReference": {
object ( |
| Campi | |
|---|---|
routineReference |
Il riferimento alla routine BigQuery. |
description |
Override o aggiunta alla descrizione da parte dell'utente, per indicare all'agente quando utilizzare la funzione definita dall'utente. |
BigQueryRoutineReference
Un riferimento a una routine BigQuery.
| Rappresentazione JSON |
|---|
{ "projectId": string, "datasetId": string, "routineId": string } |
| Campi | |
|---|---|
projectId |
L'ID progetto della routine. |
datasetId |
L'ID del set di dati della routine. |
routineId |
L'ID della routine. |
Metodi |
|
|---|---|
|
Crea un nuovo DataAgent in un progetto e una località specifici. |
|
Crea un nuovo DataAgent in un progetto e una località specifici in modo sincrono. |
|
Elimina un singolo DataAgent. |
|
Elimina un singolo DataAgent in modo sincrono. |
|
Recupera i dettagli di un singolo DataAgent. |
|
Recupera il criterio IAM per DataAgent |
|
Elenca le risorse DataAgent in un progetto e una località specifici. |
|
Elenca i DataAgent accessibili al chiamante in un progetto e una località specifici. |
|
Aggiorna i parametri di un singolo DataAgent. |
|
Imposta il criterio IAM per un DataAgent. |
|
Aggiorna i parametri di un singolo DataAgent in modo sincrono. |