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.
}
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 dati.

Utilizza RFC 3339, in cui l'output generato è sempre normalizzato in base al fuso orario UTC 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. La data e l'ora dell'ultimo aggiornamento dell'agente dati.

Utilizza RFC 3339, in cui l'output generato è sempre normalizzato in base al fuso orario UTC 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 di dati.

Utilizza RFC 3339, in cui l'output generato è sempre normalizzato in base al fuso orario UTC 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 normalizzato in base al fuso orario UTC 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ò corrispondere a 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.

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 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 (DatasourceReferences)
  },
  "options": {
    object (ConversationOptions)
  },
  "exampleQueries": [
    {
      object (ExampleQuery)
    }
  ],
  "glossaryTerms": [
    {
      object (GlossaryTerm)
    }
  ],
  "schemaRelationships": [
    {
      object (SchemaRelationship)
    }
  ]
}
Campi
systemInstruction

string

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

Perché: gergo commerciale (ad es. Il fatturato da inizio anno viene calcolato 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. Altre opzioni 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 BigQuery.
glossaryTerms[]

object (GlossaryTerm)

Facoltativo. Definizioni dei termini (al momento, solo quelle create dagli utenti)
schemaRelationships[]

object (SchemaRelationship)

Facoltativo. Relazioni tra lo schema della tabella, incluse le colonne di riferimento e quelle a cui viene fatto riferimento.

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)
  }
  // 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:
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.

BigQueryTableReferences

Messaggio che rappresenta i riferimenti alle tabelle BigQuery.

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

object (BigQueryTableReference)

Obbligatorio. 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 (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 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 le strutture dello schema nidificate.
category

string

Facoltativo. Categoria del campo, non obbligatoria, attualmente utile solo per Looker. Utilizziamo una stringa per evitare di dipendere da un pacchetto esterno e mantenere questo pacchetto autonomo.
valueFormat

string

Facoltativo. Solo Looker. Il 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.

StudioDatasourceReferences

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

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

object (StudioDatasourceReference)

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

object (Credentials)

Facoltativo. Le credenziali da utilizzare quando si chiama l'API Looker.

Attualmente supporta le credenziali basate su token OAuth e chiave 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. Nome del modello LookML.
explore

string

Obbligatorio. Looker Explore, come descritto in Strutture LookML principali. 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:
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:
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:
secret

object (SecretBased)

Credenziali OAuth basate su 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.

ConversationOptions

Opzioni per la conversazione.

Rappresentazione JSON 
{
  "chart": {
    object (ChartOptions)
  },
  "analysis": {
    object (AnalysisOptions)
  }
}
Campi
chart

object (ChartOptions)

Facoltativo. Opzioni per la generazione del grafico.
analysis

object (AnalysisOptions)

Facoltativo. Opzioni per l'analisi.

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:
noImage

object (NoImage)

Nessuna immagine.
svg

object (SvgOptions)

Formato SVG.

NoImage

Questo tipo non contiene campi.

Nessuna immagine.

SvgOptions

Questo tipo non contiene 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. Se abilitare l'analisi Python. Il valore predefinito è false.

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,

  // 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?"
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:
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'"

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", "Percentuale di utenti che completano un'azione desiderata", "Un ordine in attesa di essere elaborato".
labels[]

string

Facoltativo. Un elenco di etichette per scopi generali associate a questo termine. Ad esempio: ["tasso di clic", "clickthrough", "in attesa"]

SchemaRelationship

La relazione tra due tabelle, incluse le colonne di riferimento e quelle a cui viene fatto 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 dalla 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 della 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)

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

number

Un punteggio di affidabilità 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 completo della risorsa qualificata 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.

Metodi

create

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

delete

 Elimina un singolo DataAgent.

get

 Recupera i dettagli di un singolo DataAgent.

getIamPolicy

 Recupera il criterio IAM per DataAgent

list

 Elenca i DataAgent in un determinato progetto e in una determinata località.

listAccessible

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

patch

 Aggiorna i parametri di un singolo DataAgent.

setIamPolicy

 Imposta il criterio IAM per un DataAgent.