REST Resource: projects.locations.dataAgents

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 type can be only one of the following:
  "dataAnalyticsAgent": {
    object (DataAnalyticsAgent)
  }
  // End of list of possible types for union field type.
  "kmsKey": string
}
Campi
name

string

Facoltativo. Identificatore. Il nome univoco della risorsa di un DataAgent. Formato: projects/{project}/locations/{location}/dataAgents/{dataAgentId} {dataAgent} è l'ID risorsa e deve contenere al massimo 63 caratteri e corrispondere al formato descritto in https://google.aip.dev/122#resource-id-segments

Esempio: projects/1234567890/locations/global/dataAgents/my-agent.

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

string

Facoltativo. Nome visualizzato intuitivo.

  • Deve avere una lunghezza compresa tra 1 e 256 caratteri.
description

string

Facoltativo. Descrizione dell'agente.

  • Deve avere una lunghezza compresa tra 1 e 1024 caratteri.
labels

map (key: string, value: string)

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 "key": value. Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
createTime

string (Timestamp format)

Solo output. L'ora in cui è stato creato l'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: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

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: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
deleteTime

string (Timestamp format)

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: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
purgeTime

string (Timestamp format)

Solo output. Timestamp in UTC di quando questo agente 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: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
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

object (DataAnalyticsAgent)

Agente di analisi dei dati.
kmsKey

string

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 è projects/*/locations/*/keyRings/*/cryptoKeys/*.

DataAnalyticsAgent

Messaggio che descrive un oggetto DataAnalyticsAgent.

Rappresentazione JSON 
{
  "stagingContext": {
    object (Context)
  },
  "publishedContext": {
    object (Context)
  },
  "lastPublishedContext": {
    object (Context)
  }
}
Campi
stagingContext

object (Context)

Facoltativo. Il contesto di staging per l'agente. Questo contesto viene utilizzato per testare e convalidare le modifiche prima della pubblicazione.
publishedContext

object (Context)

Facoltativo. Il contesto pubblicato per l'agente. Questo contesto viene utilizzato dall'API Chat in produzione.
lastPublishedContext

object (Context)

Solo output. L'ultimo contesto pubblicato per l'agente. Questo è un campo di sola 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 (DatasourceReferences)
  },
  "options": {
    object (ConversationOptions)
  },
  "exampleQueries": [
    {
      object (ExampleQuery)
    }
  ],
  "lookerGoldenQueries": [
    {
      object (LookerGoldenQuery)
    }
  ],
  "glossaryTerms": [
    {
      object (GlossaryTerm)
    }
  ],
  "schemaRelationships": [
    {
      object (SchemaRelationship)
    }
  ],
  "userFunctions": {
    object (UserFunctions)
  }
}
Campi
systemInstruction

string

Facoltativo. Il punto di accesso di base per i proprietari dei dati che creano conoscenze del dominio per l'agente.

Motivo: il gergo aziendale (ad es. i ricavi da inizio anno vengono calcolati come…, l'età pensionabile è 65 anni negli Stati Uniti e così via) 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

object (DatasourceReferences)

Obbligatorio. Le origini dati disponibili per rispondere alla domanda.
options

object (ConversationOptions)

Facoltativo. Opzioni aggiuntive per la conversazione.
exampleQueries[]

object (ExampleQuery)

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[]

object (LookerGoldenQuery)

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[]

object (GlossaryTerm)

Facoltativo. Definizioni dei termini (al momento, solo quelle create dagli utenti) non supportate per le origini dati dei database (alloydb, cloudsql, spanner).
schemaRelationships[]

object (SchemaRelationship)

Facoltativo. Relazioni tra lo schema della tabella, incluse le colonne di riferimento e quelle a cui si fa riferimento.
userFunctions

object (UserFunctions)

Facoltativo. Una raccolta di funzioni utente da includere nel contesto.

DatasourceReferences

Una raccolta di riferimenti alle origini dati.

Rappresentazione JSON 
{

  // Union field references can be only one of the following:
  "bq": {
    object (BigQueryTableReferences)
  },
  "studio": {
    object (StudioDatasourceReferences)
  },
  "looker": {
    object (LookerExploreReferences)
  },
  "alloydb": {
    object (AlloyDbReference)
  },
  "spannerReference": {
    object (SpannerReference)
  },
  "cloudSqlReference": {
    object (CloudSqlReference)
  }
  // End of list of possible types for union field references.
}
Campi
Campo unione references. Le origini dati da utilizzare. references può essere solo uno dei seguenti tipi:
bq

object (BigQueryTableReferences)

Riferimenti alle tabelle BigQuery.
studio

object (StudioDatasourceReferences)

Riferimenti alle origini dati di Looker Studio.
looker

object (LookerExploreReferences)

Riferimenti alle esplorazioni di Looker.
alloydb

object (AlloyDbReference)

Riferimento a un database AlloyDB. Supportato solo per il metodo QueryData.
spannerReference

object (SpannerReference)

Riferimento a un database Spanner. Supportato solo per il metodo QueryData.
cloudSqlReference

object (CloudSqlReference)

Riferimento a un database CloudSql. Supportato solo per il metodo QueryData.

BigQueryTableReferences

Messaggio che rappresenta i riferimenti alle tabelle BigQuery e ai grafici delle proprietà. Almeno uno tra tableReferences, propertyGraphReferences o searchScope deve essere compilato.

Rappresentazione JSON 
{
  "tableReferences": [
    {
      object (BigQueryTableReference)
    }
  ],
  "propertyGraphReferences": [
    {
      object (BigQueryPropertyGraphReference)
    }
  ]
}
Campi
tableReferences[]

object (BigQueryTableReference)

Facoltativo. Riferimenti alle tabelle BigQuery.
propertyGraphReferences[]

object (BigQueryPropertyGraphReference)

Facoltativo. Riferimenti ai grafici BigQuery.

Nota: "grafico delle proprietà" è il nome precedente di BigQuery Graph. I nomi dei campi e dei messaggi mantengono il termine originale per la compatibilità con le versioni precedenti; entrambi si riferiscono alla stessa risorsa.

BigQueryTableReference

Messaggio che rappresenta un riferimento a una singola tabella BigQuery.

Rappresentazione JSON 
{
  "projectId": string,
  "datasetId": string,
  "tableId": string,
  "schema": {
    object (Schema)
  }
}
Campi
projectId

string

Obbligatorio. Il progetto a cui appartiene la tabella.
datasetId

string

Obbligatorio. Il set di dati a cui appartiene la tabella.
tableId

string

Obbligatorio. L'ID tabella.
schema

object (Schema)

Facoltativo. Lo schema dell'origine dati.

Schema

Lo schema di un'istanza Datasource o QueryResult.

Rappresentazione JSON 
{
  "fields": [
    {
      object (Field)
    }
  ],
  "description": string,
  "synonyms": [
    string
  ],
  "tags": [
    string
  ],
  "displayName": string,
  "filters": [
    {
      object (DataFilter)
    }
  ]
}
Campi
fields[]

object (Field)

Facoltativo. I campi dello schema.
description

string

Facoltativo. Una descrizione testuale dei contenuti e dello scopo della tabella. Ad esempio: "Contiene informazioni sugli ordini dei clienti nel nostro negozio di e-commerce". Attualmente utilizzato solo per le origini dati BigQuery.
synonyms[]

string

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[]

string

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

string

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[]

object (DataFilter)

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 (Field)
    }
  ],
  "category": string,
  "valueFormat": string
}
Campi
name

string

Facoltativo. Il nome del campo.
type

string

Facoltativo. Il tipo di campo.
description

string

Facoltativo. Una breve descrizione del campo.
mode

string

Facoltativo. La modalità del campo (ad es. NULLABLE, REPEATED).
synonyms[]

string

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[]

string

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

string

Facoltativo. displayName del campo (uguale all'etichetta in
subfields[]

object (Field)

Facoltativo. Proprietà ricorsiva per strutture di schema nidificate.
category

string

Facoltativo. Categoria del campo, non obbligatoria, attualmente utile solo per Looker.
valueFormat

string

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 (DataFilterType)
}
Campi
field

string

Facoltativo. Il campo in base al quale applicare il filtro. Ad esempio: ["event_date", "customer_id", "product_category"]
value

string

Facoltativo. Il valore predefinito utilizzato per questo filtro se non viene sostituito in una query. Ad esempio: ["after 2024-01-01", "123", "-fashion"]
type

enum (DataFilterType)

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 qualsiasi query a Esplora applicherà sempre questo filtro per impostazione predefinita. Attualmente utilizzato solo per le origini dati Looker.

BigQueryPropertyGraphReference

Messaggio che rappresenta un riferimento a un singolo grafico delle proprietà BigQuery.

Rappresentazione JSON 
{
  "projectId": string,
  "datasetId": string,
  "propertyGraphId": string
}
Campi
projectId

string

Obbligatorio. Il progetto a cui appartiene il grafico delle proprietà.
datasetId

string

Obbligatorio. Il set di dati a cui appartiene il grafico delle proprietà.
propertyGraphId

string

Obbligatorio. L'ID del grafico delle proprietà.

StudioDatasourceReferences

Messaggio che rappresenta i riferimenti alle origini dati di Looker Studio.

Rappresentazione JSON 
{
  "studioReferences": [
    {
      object (StudioDatasourceReference)
    }
  ]
}
Campi
studioReferences[]

object (StudioDatasourceReference)

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

string

Obbligatorio. L'ID dell'origine dati.

LookerExploreReferences

Messaggio che rappresenta i riferimenti alle esplorazioni di Looker.

Rappresentazione JSON 
{
  "exploreReferences": [
    {
      object (LookerExploreReference)
    }
  ],
  "credentials": {
    object (Credentials)
  }
}
Campi
exploreReferences[]

object (LookerExploreReference)

Obbligatorio. Riferimenti alle esplorazioni di Looker.
credentials
(deprecated)

object (Credentials)

Facoltativo. Ritirato: utilizza le credenziali in ChatRequest. Le credenziali da utilizzare quando chiami l'API Looker.

Al momento supporta le credenziali basate su token OAuth e chiavi API, come descritto in Autenticazione con un SDK.

LookerExploreReference

Messaggio che rappresenta un riferimento a una singola esplorazione di Looker.

Rappresentazione JSON 
{
  "lookmlModel": string,
  "explore": string,
  "schema": {
    object (Schema)
  },

  // Union field instance can be only one of the following:
  "lookerInstanceUri": string,
  "privateLookerInstanceInfo": {
    object (PrivateLookerInstanceInfo)
  }
  // End of list of possible types for union field instance.
}
Campi
lookmlModel

string

Obbligatorio. Modello Looker, come descritto in Strutture LookML principali. Il nome del modello LookML.
explore

string

Obbligatorio. Esplorazione di Looker, come descritto in Strutture principali di LookML. Nome dell'esplorazione LookML.
schema

object (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

string

Obbligatorio. L'URL di base dell'istanza di Looker.
privateLookerInstanceInfo

object (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

string

L'ID istanza Looker.
serviceDirectoryName

string

Il nome della Service Directory dell'istanza di Looker.

Credenziali

Rappresenta diverse forme di specifica delle credenziali.

Rappresentazione JSON 
{

  // Union field kind can be only one of the following:
  "oauth": {
    object (OAuthCredentials)
  }
  // End of list of possible types for union field kind.
}
Campi
Campo unione kind. Il tipo di credenziali. kind può essere solo uno dei seguenti tipi:
oauth

object (OAuthCredentials)

Credenziali OAuth.

OAuthCredentials

Rappresenta le credenziali OAuth.

Rappresentazione JSON 
{

  // Union field kind can be only one of the following:
  "secret": {
    object (SecretBased)
  },
  "token": {
    object (TokenBased)
  }
  // End of list of possible types for union field kind.
}
Campi
Campo unione kind. Il tipo di credenziali OAuth. kind può essere solo uno dei seguenti tipi:
secret

object (SecretBased)

Credenziali OAuth basate sul secret.
token

object (TokenBased)

Credenziali OAuth basate su token.

SecretBased

Il nome del secret contenente il token di accesso. Rappresenta le credenziali OAuth basate su secret.

Rappresentazione JSON 
{
  "clientId": string,
  "clientSecret": string
}
Campi
clientId

string

Obbligatorio. Un ID client OAuth.
clientSecret

string

Obbligatorio. Un client secret OAuth.

TokenBased

Scopri di più sui token di accesso di Looker qui: https://developers.looker.com/api/advanced-usage/looker-api-oauth

Rappresentazione JSON 
{
  "accessToken": string
}
Campi
accessToken

string

Obbligatorio. Il nome del secret contenente il token di accesso.

AlloyDbReference

Messaggio che rappresenta il riferimento a un database AlloyDB e al contesto dell'agente. Supportato solo per il metodo QueryData.

Rappresentazione JSON 
{
  "databaseReference": {
    object (AlloyDbDatabaseReference)
  },
  "agentContextReference": {
    object (AgentContextReference)
  }
}
Campi
databaseReference

object (AlloyDbDatabaseReference)

Obbligatorio. Singular proto che supporta la specifica del database e delle tabelle da includere.
agentContextReference

object (AgentContextReference)

Facoltativo. Parametri per recuperare i dati dal contesto dell'agente.

AlloyDbDatabaseReference

Messaggio che rappresenta un riferimento a un singolo database AlloyDB.

Rappresentazione JSON 
{
  "projectId": string,
  "region": string,
  "clusterId": string,
  "instanceId": string,
  "databaseId": string,
  "tableIds": [
    string
  ],
  "databaseTableReferences": [
    {
      object (DatabaseTableReference)
    }
  ]
}
Campi
projectId

string

Obbligatorio. Il progetto a cui appartiene l'istanza.
region

string

Obbligatorio. La regione dell'istanza.
clusterId

string

Obbligatorio. L'ID cluster.
instanceId

string

Obbligatorio. L'ID istanza.
databaseId

string

Obbligatorio. L'ID database.
tableIds[]

string

Facoltativo. Gli ID tabella. Indica tutte le tabelle se non impostato.
databaseTableReferences[]

object (DatabaseTableReference)

Facoltativo. Riferimenti alle tabelle all'interno del database. Ogni riferimento specifica una tabella e può includere facoltativamente lo schema della tabella per fornire il contesto della query.

DatabaseTableReference

Messaggio che rappresenta una tabella, incluso il relativo schema.

Rappresentazione JSON 
{
  "tableId": string,
  "schema": {
    object (Schema)
  }
}
Campi
tableId

string

Obbligatorio. Il nome della tabella come definito nel database.

Nota: le regole precise per la denominazione delle tabelle, inclusi i caratteri validi, i limiti di lunghezza e la sensibilità alle maiuscole, sono determinate dal sistema di database specifico.

Requisiti: - Corrispondenza esatta: il nome fornito deve essere identico a quello memorizzato nel database. - Distinzione tra maiuscole e minuscole: rispetta le regole di distinzione tra maiuscole e minuscole del sistema di database specifico e la modalità di creazione della tabella. Ad esempio, "Ordini" e "ordini" potrebbero essere nomi di tabelle distinti. - Caratteri speciali/parole chiave: se il nome della tabella include spazi, caratteri speciali o è una parola chiave riservata del database, fornisci il nome letterale così com'è memorizzato. Non aggiungere caratteri di citazione dell'identificatore specifici del database (ad es. ", `, []).

Esempi: - Nome semplice: "ordini", "UserActivity" - Distinzione tra maiuscole e minuscole: "MyTable" - Nome con spazi: "Order Details" - Nome con altri caratteri speciali: "user/data", "order-items" - Nome che è una parola chiave: "Group", "Order"

Autorizzazioni: le credenziali del chiamante devono disporre delle autorizzazioni del database necessarie per accedere allo schema e ai dati della tabella.
schema

object (Schema)

Facoltativo. Lo schema della tabella.

AgentContextReference

Messaggio che rappresenta un riferimento al contesto dell'agente.

Rappresentazione JSON 
{
  "contextSetId": string
}
Campi
contextSetId

string

Obbligatorio. L'ID del set di contesti da recuperare.

SpannerReference

Messaggio che rappresenta il riferimento a un database Spanner e al contesto dell'agente. Supportato solo per il metodo QueryData.

Rappresentazione JSON 
{
  "databaseReference": {
    object (SpannerDatabaseReference)
  },
  "agentContextReference": {
    object (AgentContextReference)
  }
}
Campi
databaseReference

object (SpannerDatabaseReference)

Obbligatorio. Singular proto che supporta la specifica del database e delle tabelle da includere.
agentContextReference

object (AgentContextReference)

Facoltativo. Parametri per recuperare i dati dal contesto dell'agente.

SpannerDatabaseReference

Messaggio che rappresenta un riferimento a un singolo database Spanner.

Rappresentazione JSON 
{
  "engine": enum (Engine),
  "projectId": string,
  "instanceId": string,
  "databaseId": string,
  "tableIds": [
    string
  ],
  "databaseTableReferences": [
    {
      object (DatabaseTableReference)
    }
  ],
  "priority": string,
  "requestTag": string
}
Campi
engine

enum (Engine)

Obbligatorio. Il motore dell'istanza Spanner.
projectId

string

Obbligatorio. Il progetto a cui appartiene l'istanza.
instanceId

string

Obbligatorio. L'ID istanza.
databaseId

string

Obbligatorio. L'ID database.
tableIds[]

string

Facoltativo. Gli ID tabella. Indica tutte le tabelle se non impostato.
databaseTableReferences[]

object (DatabaseTableReference)

Facoltativo. Riferimenti alle tabelle all'interno del database. Ogni riferimento specifica una tabella e può includere facoltativamente lo schema della tabella per fornire il contesto della query.
priority

string

Facoltativo. Priorità per le query in Spanner. Deve essere un valore supportato da Cloud Spanner, ad esempio: BASSA, MEDIA, ALTA. I valori non supportati verranno ignorati. Per un elenco completo, consulta la pagina https://docs.cloud.google.com/spanner/docs/reference/rest/v1/RequestOptions#Priority.
requestTag

string

Tag da allegare a tutte le query a Spanner. Consente di identificare e monitorare le query inviate a Spanner dal servizio GDA.

Motore

Il motore del database.

Enum
ENGINE_UNSPECIFIED Il motore non è specificato.
GOOGLE_SQL SQL di Google
POSTGRESQL PostgreSQL

CloudSqlReference

Messaggio che rappresenta il riferimento a un database Cloud SQL e al contesto dell'agente. Supportato solo per il metodo QueryData.

Rappresentazione JSON 
{
  "databaseReference": {
    object (CloudSqlDatabaseReference)
  },
  "agentContextReference": {
    object (AgentContextReference)
  }
}
Campi
databaseReference

object (CloudSqlDatabaseReference)

Obbligatorio. Singular proto che supporta la specifica del database e delle tabelle da includere.
agentContextReference

object (AgentContextReference)

Facoltativo. Parametri per recuperare i dati dal contesto dell'agente.

CloudSqlDatabaseReference

Messaggio che rappresenta un riferimento a un singolo database CloudSQL.

Rappresentazione JSON 
{
  "engine": enum (Engine),
  "projectId": string,
  "region": string,
  "instanceId": string,
  "databaseId": string,
  "tableIds": [
    string
  ],
  "databaseTableReferences": [
    {
      object (DatabaseTableReference)
    }
  ]
}
Campi
engine

enum (Engine)

Obbligatorio. Il motore dell'istanza Cloud SQL.
projectId

string

Obbligatorio. Il progetto a cui appartiene l'istanza.
region

string

Obbligatorio. La regione dell'istanza.
instanceId

string

Obbligatorio. L'ID istanza.
databaseId

string

Obbligatorio. L'ID database.
tableIds[]

string

Facoltativo. Gli ID tabella. Indica tutte le tabelle se non impostato.
databaseTableReferences[]

object (DatabaseTableReference)

Facoltativo. Riferimenti alle tabelle all'interno del database. Ogni riferimento specifica una tabella e può includere facoltativamente lo schema della tabella per fornire il contesto della query.

Motore

Il motore del database.

Enum
ENGINE_UNSPECIFIED Il motore non è specificato.
POSTGRESQL PostgreSQL
MYSQL MySQL

ConversationOptions

Opzioni per la conversazione.

Rappresentazione JSON 
{
  "chart": {
    object (ChartOptions)
  },
  "analysis": {
    object (AnalysisOptions)
  },
  "datasource": {
    object (DatasourceOptions)
  },
  "model": enum (Model)
}
Campi
chart

object (ChartOptions)

Facoltativo. Opzioni per la generazione del grafico.
analysis

object (AnalysisOptions)

Facoltativo. Opzioni per l'analisi.
datasource

object (DatasourceOptions)

Facoltativo. Opzioni per le origini dati.
model

enum (Model)

Facoltativo. Il modello da utilizzare per il ciclo dell'agente.

ChartOptions

Opzioni per la generazione del grafico.

Rappresentazione JSON 
{
  "image": {
    object (ImageOptions)
  }
}
Campi
image

object (ImageOptions)

Facoltativo. Se specificato, l'agente eseguirà il rendering dei grafici generati utilizzando il formato fornito. Il valore predefinito è nessuna immagine.

ImageOptions

Opzioni per il rendering delle immagini dei grafici generati.

Rappresentazione JSON 
{

  // Union field kind can be only one of the following:
  "noImage": {
    object (NoImage)
  },
  "svg": {
    object (SvgOptions)
  }
  // End of list of possible types for union field kind.
}
Campi
Campo unione kind. Il tipo di immagine da eseguire il rendering. kind può essere solo uno dei seguenti tipi:
noImage

object (NoImage)

Nessuna immagine.
svg

object (SvgOptions)

Formato SVG.

NoImage

Questo tipo non ha campi.

Nessuna immagine.

SvgOptions

Questo tipo non ha campi.

Opzioni SVG.

AnalysisOptions

Opzioni per l'analisi.

Rappresentazione JSON 
{
  "python": {
    object (Python)
  }
}
Campi
python

object (Python)

Facoltativo. Opzioni per l'analisi Python.

Python

Opzioni per l'analisi Python.

Rappresentazione JSON 
{
  "enabled": boolean
}
Campi
enabled

boolean

Facoltativo. Indica se attivare l'analisi Python. Il valore predefinito è false.

DatasourceOptions

Opzioni per le configurazioni delle origini dati.

Rappresentazione JSON 
{
  "bigQueryMaxBilledBytes": string
}
Campi
bigQueryMaxBilledBytes

string (Int64Value format)

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 potrebbe 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 (QueryParameter)
    }
  ],

  // Union field query can be only one of the following:
  "sqlQuery": string
  // End of list of possible types for union field query.
}
Campi
naturalLanguageQuestion

string

Facoltativo. Una domanda in linguaggio naturale che un utente potrebbe porre. Ad esempio: "Quanti ordini sono stati effettuati il mese scorso?"
parameters[]

object (QueryParameter)

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

string

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 di 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

string

Obbligatorio. Il nome del riferimento al parametro nella query SQL.
description

string

Facoltativo. La descrizione del parametro che può essere utilizzato dal modello LLM per estrarre il valore parametro dalla domanda dell'utente.
dataType

string

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 (LookerQuery)
  }
}
Campi
naturalLanguageQuestions[]

string

Facoltativo. Domande in linguaggio naturale che un utente potrebbe porre. Ad esempio: "Quanti ordini sono stati effettuati il mese scorso?"
lookerQuery

object (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 (Filter)
    }
  ],
  "sorts": [
    string
  ],
  "limit": string,
  "queryId": string,
  "clientId": string
}
Campi
model

string

Obbligatorio. Il modello LookML utilizzato per generare la query.
explore

string

Obbligatorio. L'esplorazione LookML utilizzata per generare la query.
fields[]

string

Facoltativo. I campi da recuperare dall'esplorazione.
filters[]

object (Filter)

Facoltativo. I filtri da applicare all'esplorazione.
sorts[]

string

Facoltativo. I tipi di ordinamento da applicare all'esplorazione.
limit

string

Facoltativo. Limite nella query.
queryId

string

Facoltativo. L'identificatore principale della risorsa query in Looker, utilizzato per le operazioni API. Corrisponde a id (o slug) nella risorsa Query dell'API Looker.
clientId

string

Facoltativo. L'identificatore alfanumerico breve per la query, utilizzato per i link di condivisione e gli URL di Esplora (ad es. nel parametro qid). Corrisponde a clientId nella risorsa API Looker Query.

Filtro

Un filtro query di Looker.

Rappresentazione JSON 
{
  "field": string,
  "value": string
}
Campi
field

string

Obbligatorio. Il campo in base al quale applicare il filtro.
value

string

Facoltativo. Il valore del campo in base al quale filtrare. 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

string

Obbligatorio. Nome visualizzato intuitivo del termine del glossario in fase di definizione. Ad esempio: "CTR", "tasso di conversione", "in attesa"
description

string

Obbligatorio. La descrizione o il significato del termine. Ad esempio: "Percentuale di clic", "La percentuale di utenti che completano un'azione desiderata", "Un ordine in attesa di essere elaborato".
labels[]

string

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 (SchemaPaths)
  },
  "rightSchemaPaths": {
    object (SchemaPaths)
  },
  "sources": [
    enum (Source)
  ],
  "confidenceScore": number
}
Campi
leftSchemaPaths

object (SchemaPaths)

Un elenco ordinato di campi per l'unione della prima tabella. Le dimensioni di questo elenco devono essere uguali a rightSchemaPaths. Ogni campo all'indice i di questo elenco deve corrispondere a un campo con lo stesso indice nell'elenco rightSchemaPaths.
rightSchemaPaths

object (SchemaPaths)

Un elenco ordinato di campi per l'unione dalla seconda tabella. Le dimensioni di questo elenco devono essere uguali a leftSchemaPaths. Ogni campo all'indice i di questo elenco deve corrispondere a un campo con lo stesso indice nell'elenco leftSchemaPaths.
sources[]

enum (Source)

Facoltativo. Le origini che hanno generato il bordo della relazione dello schema.
confidenceScore

number

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

string

Il nome risorsa completo qualificato per il servizio della tabella. Esempio: bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID
paths[]

string

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 (BigQueryRoutine)
    }
  ]
}
Campi
bqRoutines[]

object (BigQueryRoutine)

Un elenco di routine BigQuery da includere nel contesto.

BigQueryRoutine

Un riferimento a una routine BigQuery.

Rappresentazione JSON 
{
  "routineReference": {
    object (BigQueryRoutineReference)
  },
  "description": string
}
Campi
routineReference

object (BigQueryRoutineReference)

Il riferimento alla routine BigQuery.
description

string

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

string

L'ID progetto della routine.
datasetId

string

L'ID set di dati della routine.
routineId

string

L'ID della routine.

Metodi

create

 Crea un nuovo DataAgent in un progetto e una località specifici.

createSync

 Crea un nuovo DataAgent in un progetto e una località specifici in modo sincrono.

delete

 Elimina un singolo DataAgent.

deleteSync

 Elimina un singolo DataAgent in modo sincrono.

get

 Recupera i dettagli di un singolo DataAgent.

getIamPolicy

 Ottiene la policy IAM per DataAgent

list

 Elenca le risorse DataAgent in un progetto e una località specifici.

listAccessible

 Elenca i DataAgent accessibili al chiamante in un progetto e una località specifici.

patch

 Aggiorna i parametri di un singolo DataAgent.

setIamPolicy

 Imposta la policy IAM per un DataAgent.

updateSync

 Aggiorna i parametri di un singolo DataAgent in modo sincrono.