REST Resource: projects.locations.dataAgents

Ressource: DataAgent

Nachricht, die ein DataAgent-Objekt beschreibt.

JSON-Darstellung 
{
  "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.
}
Felder
name

string

Optional. ID. Der eindeutige Ressourcenname eines DataAgents. Format: projects/{project}/locations/{location}/dataAgents/{dataAgentId}. {dataAgent} ist die Ressourcen-ID. Sie darf maximal 63 Zeichen lang sein und muss dem Format entsprechen, das unter https://google.aip.dev/122#resource-id-segments beschrieben wird.

Beispiel: projects/1234567890/locations/us-central1/dataAgents/my-agent.

Es wird empfohlen, dieses Feld bei der Agent-Erstellung nicht festzulegen, da es automatisch abgeleitet und mit {parent}/dataAgents/{dataAgentId} überschrieben wird.
displayName

string

Optional. Nutzerfreundlicher Anzeigename.

  • Muss 1–256 Zeichen umfassen.
description

string

Optional. Beschreibung des KI-Agenten.

  • Muss 1–1.024 Zeichen umfassen.
labels

map (key: string, value: string)

Optional. Labels, mit denen Nutzer ähnliche KI-Agenten filtern können. Beispiele: „sales“, „business“, „etl“ usw. Beachten Sie, dass Labels nur zum Filtern und nicht für Richtlinien verwendet werden. Weitere Informationen zur Verwendung von Labels finden Sie in der Dokumentation zu Labels.

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
createTime

string (Timestamp format)

Nur Ausgabe. Der Zeitpunkt, zu dem der KI-Datenagent erstellt wurde.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Nur Ausgabe. Der Zeitpunkt, zu dem der KI-Datenagent zuletzt aktualisiert wurde.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
deleteTime

string (Timestamp format)

Nur Ausgabe. [Nur Ausgabe] Der Zeitpunkt, zu dem der KI-Datenagent vorläufig gelöscht wurde.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
purgeTime

string (Timestamp format)

Nur Ausgabe. Der Zeitstempel in UTC, der angibt, wann dieser KI-Datenagent als abgelaufen gilt. Dies wird immer bei der Ausgabe angegeben, ungeachtet dessen, was bei der Eingabe gesendet wurde.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
Union-Feld type. Der Typ des KI-Agenten. Kann einer der folgenden Werte sein: * Datenanalyse-Agent. * Der Data-Engineering-Agent type kann nur einer der folgenden Werte sein:
dataAnalyticsAgent

object (DataAnalyticsAgent)

Datenanalyse-Agent.

DataAnalyticsAgent

Nachricht, die ein DataAnalyticsAgent-Objekt beschreibt.

JSON-Darstellung 
{
  "stagingContext": {
    object (Context)
  },
  "publishedContext": {
    object (Context)
  },
  "lastPublishedContext": {
    object (Context)
  }
}
Felder
stagingContext

object (Context)

Optional. Der Staging-Kontext für den KI-Agenten. Dieser Kontext wird verwendet, um Änderungen vor der Veröffentlichung zu testen und zu validieren.
publishedContext

object (Context)

Optional. Der veröffentlichte Kontext für den KI-Agenten. Dieser Kontext wird von der Chat API in der Produktion verwendet.
lastPublishedContext

object (Context)

Nur Ausgabe. Der zuletzt veröffentlichte Kontext für den KI-Agenten. Dies ist ein reines Ausgabefeld und wird vom System ausgefüllt, wenn der veröffentlichte Kontext aktualisiert wird. Damit wird der KI-Agent in einen vorherigen Zustand zurückversetzt.

Context

Eine Sammlung von Kontext, der auf diese Unterhaltung angewendet werden soll.

JSON-Darstellung 
{
  "systemInstruction": string,
  "datasourceReferences": {
    object (DatasourceReferences)
  },
  "options": {
    object (ConversationOptions)
  },
  "exampleQueries": [
    {
      object (ExampleQuery)
    }
  ]
}
Felder
systemInstruction

string

Optional. Der grundlegende Einstiegspunkt für Dateninhaber, die Domainwissen für den KI-Agenten erstellen.

Grund: Geschäftsjargon (z. B. der Umsatz seit Jahresbeginn wird folgendermaßen berechnet…, das Rentenalter in den USA beträgt 65 Jahre usw.) und Systemanweisungen (z. B. antworte wie ein Pirat) können dem Modell helfen, den geschäftlichen Kontext einer Nutzerfrage zu verstehen.
datasourceReferences

object (DatasourceReferences)

Pflichtangabe. Datenquellen, die zur Beantwortung der Frage zur Verfügung stehen.
options

object (ConversationOptions)

Optional. Zusätzliche Optionen für die Unterhaltung.
exampleQueries[]

object (ExampleQuery)

Optional. Eine Liste mit Beispielabfragen, die Beispiele für relevante und häufig verwendete SQL-Abfragen und optional die entsprechenden Abfragen in natürlicher Sprache enthält. Wird derzeit nur für BigQuery-Datenquellen verwendet.

DatasourceReferences

Eine Sammlung von Verweisen auf Datenquellen.

JSON-Darstellung 
{

  // 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.
}
Felder
Union-Feld references. Die zu verwendenden Datenquellen. Für references ist nur einer der folgenden Werte zulässig:
bq

object (BigQueryTableReferences)

Verweise auf BigQuery-Tabellen.
studio

object (StudioDatasourceReferences)

Verweise auf Looker Studio-Datenquellen.
looker

object (LookerExploreReferences)

Verweise auf Looker-Explores.

BigQueryTableReferences

Nachricht, die Verweise auf BigQuery-Tabellen darstellt.

JSON-Darstellung 
{
  "tableReferences": [
    {
      object (BigQueryTableReference)
    }
  ]
}
Felder
tableReferences[]

object (BigQueryTableReference)

Pflichtangabe. Verweise auf BigQuery-Tabellen.

BigQueryTableReference

Nachricht, die einen Verweis auf eine einzelne BigQuery-Tabelle darstellt.

JSON-Darstellung 
{
  "projectId": string,
  "datasetId": string,
  "tableId": string,
  "schema": {
    object (Schema)
  }
}
Felder
projectId

string

Pflichtangabe. Projekt, zu dem die Tabelle gehört.
datasetId

string

Pflichtangabe. Das Dataset, zu dem die Tabelle gehört.
tableId

string

Pflichtangabe. Die Tabellen-ID.
schema

object (Schema)

Optional. Das Schema der Datenquelle.

Schema

Das Schema einer Datasource- oder QueryResult-Instanz.

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

object (Field)

Optional. Die Felder im Schema.
description

string

Optional. Eine Textbeschreibung des Inhalts und Zwecks der Tabelle. Beispiel: „Enthält Informationen zu Kundenbestellungen in unserem E-Commerce-Shop.“ Wird derzeit nur für BigQuery-Datenquellen verwendet.
synonyms[]

string

Optional. Eine Liste mit alternativen Namen oder Synonymen, die verwendet werden können, um sich auf die Tabelle zu beziehen. Beispiel: [„sales“, „orders“, „purchases“] Wird derzeit nur für BigQuery-Datenquellen verwendet.
tags[]

string

Optional. Eine Liste mit Tags oder Keywords, die der Tabelle zugeordnet sind und zur Kategorisierung verwendet werden. Beispiel: [„transaction“, „revenue“, „customer_data“] Wird derzeit nur für BigQuery-Datenquellen verwendet.
displayName

string

Optional. Anzeigename der Tabelle (entspricht dem Label in cloud/data_analytics/anarres/data/looker/proto/model_explore.proto), nicht erforderlich. Dieses Feld ist derzeit nur in Looker vorhanden.
filters[]

object (DataFilter)

Optional. Die Filter für die zugrunde liegenden Daten der Datenquelle. Wird derzeit nur für Looker-Datenquellen verwendet.

Feld

Ein Feld in einem Schema.

JSON-Darstellung 
{
  "name": string,
  "type": string,
  "description": string,
  "mode": string,
  "synonyms": [
    string
  ],
  "tags": [
    string
  ],
  "displayName": string,
  "subfields": [
    {
      object (Field)
    }
  ],
  "category": string,
  "valueFormat": string
}
Felder
name

string

Optional. Der Name des Felds.
type

string

Optional. Der Typ des Felds.
description

string

Optional. Eine kurze Beschreibung des Felds.
mode

string

Optional. Der Modus des Felds (z. B. NULLWERTE ZULÄSSIG, WIEDERHOLT).
synonyms[]

string

Optional. Eine Liste alternativer Namen oder Synonyme, die verwendet werden können, um sich auf dieses Feld zu beziehen. Beispiel: [„id“, „customerid“, „cust_id“]. Wird derzeit nur für BigQuery-Datenquellen verwendet.
tags[]

string

Optional. Eine Liste von Tags oder Keywords, die mit dem Feld verknüpft sind und zur Kategorisierung verwendet werden. Beispiel: [„identifier“, „customer“, „pii“]. Wird derzeit nur für BigQuery-Datenquellen verwendet.
displayName

string

Optional. Der Anzeigename des Felds (entspricht dem Label in
subfields[]

object (Field)

Optional. Rekursives Attribut für verschachtelte Schemastrukturen.
category

string

Optional. Feldkategorie, nicht erforderlich. Derzeit nur für Looker nützlich. Wir verwenden einen String, um nicht von einem externen Paket abhängig zu sein und dieses Paket in sich geschlossen zu halten.
valueFormat

string

Optional. Nur Looker. Wertformat des Felds. Referenz: https://cloud.google.com/looker/docs/reference/param-field-value-format

DataFilter

Ein Filter für die zugrunde liegenden Daten einer Datenquelle. Dokumentation zur Filtersyntax: https://cloud.google.com/looker/docs/filter-expressions

JSON-Darstellung 
{
  "field": string,
  "value": string,
  "type": enum (DataFilterType)
}
Felder
field

string

Optional. Das Feld, nach dem gefiltert werden soll. Beispiel: [„event_date“, „customer_id“, „product_category“]
value

string

Optional. Der Standardwert, der für diesen Filter verwendet wird, wenn der Filter in einer Abfrage nicht überschrieben wird. Beispiel: ["nach 2024-01-01", "123", "-mode"]
type

enum (DataFilterType)

Optional. Der Typ des Filters in einer Datenquelle, z. B. ALWAYS_FILTER.

DataFilterType

Der Typ des Filters in einer Datenquelle, z. B. ALWAYS_FILTER.

Enums
DATA_FILTER_TYPE_UNSPECIFIED Der Filtertyp wurde nicht angegeben.
ALWAYS_FILTER Ein Filter, den der Nutzer konfiguriert. Bei allen Abfragen für das Explore wird dieser Filter standardmäßig angewendet. Wird derzeit nur für Looker-Datenquellen verwendet.

StudioDatasourceReferences

Nachricht, die Verweise auf Looker Studio-Datenquellen darstellt.

JSON-Darstellung 
{
  "studioReferences": [
    {
      object (StudioDatasourceReference)
    }
  ]
}
Felder
studioReferences[]

object (StudioDatasourceReference)

Die Verweise auf die Studio-Datenquellen.

StudioDatasourceReference

Nachricht, die einen Verweis auf eine einzelne Looker Studio-Datenquelle darstellt.

JSON-Darstellung 
{
  "datasourceId": string
}
Felder
datasourceId

string

Pflichtangabe. Die ID der Datenquelle.

LookerExploreReferences

Nachricht, die Verweise auf Looker-Explores darstellt.

JSON-Darstellung 
{
  "exploreReferences": [
    {
      object (LookerExploreReference)
    }
  ],
  "credentials": {
    object (Credentials)
  }
}
Felder
exploreReferences[]

object (LookerExploreReference)

Pflichtangabe. Verweise auf Looker-Explores.
credentials

object (Credentials)

Optional. Die Anmeldedaten, die beim Aufrufen der Looker API verwendet werden sollen.

Derzeit werden Anmeldedaten auf Basis von OAuth-Tokens und API-Schlüssel unterstützt, wie unter Authentifizierung mit einem SDK beschrieben.

LookerExploreReference

Nachricht, die einen Verweis auf einen einzelnen Looker-Explore darstellt.

JSON-Darstellung 
{
  "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.
}
Felder
lookmlModel

string

Pflichtangabe. Looker-Modell, wie in Wichtige LookML-Strukturen beschrieben. Name des LookML-Modells.
explore

string

Pflichtangabe. Looker-Explore, wie in Wichtige LookML-Strukturen beschrieben. Name des LookML-Explores.
schema

object (Schema)

Optional. Das Schema der Datenquelle.
Union-Feld instance. Die Instanz des Looker-Explores. Für instance ist nur einer der folgenden Werte zulässig:
lookerInstanceUri

string

Pflichtangabe. Die Basis-URL der Looker-Instanz.
privateLookerInstanceInfo

object (PrivateLookerInstanceInfo)

Informationen zur privaten Looker-Instanz.

PrivateLookerInstanceInfo

Nachricht, die eine Information zur privaten Looker-Instanz darstellt, die erforderlich ist, wenn sich die Looker-Instanz hinter einem privaten Netzwerk befindet.

JSON-Darstellung 
{
  "lookerInstanceId": string,
  "serviceDirectoryName": string
}
Felder
lookerInstanceId

string

Die Looker-Instanz-ID.
serviceDirectoryName

string

Der Service Directory-Name der Looker-Instanz.

Anmeldedaten

Stellt verschiedene Formen der Spezifikation von Anmeldedaten dar.

JSON-Darstellung 
{

  // Union field kind can be only one of the following:
  "oauth": {
    object (OAuthCredentials)
  }
  // End of list of possible types for union field kind.
}
Felder
Union-Feld kind. Die Art der Anmeldedaten. } Für kind ist nur einer der folgenden Werte zulässig:
oauth

object (OAuthCredentials)

OAuth-Anmeldedaten.

OAuthCredentials

Stellt OAuth-Anmeldedaten dar.

JSON-Darstellung 
{

  // 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.
}
Felder
Union-Feld kind. Die Art der OAuth-Anmeldedaten. Für kind ist nur einer der folgenden Werte zulässig:
secret

object (SecretBased)

Secret-basierte OAuth-Anmeldedaten.
token

object (TokenBased)

Tokenbasierte OAuth-Anmeldedaten.

SecretBased

Der Name des Secrets, das das Zugriffstoken enthält. Stellt Secret-basierte OAuth-Anmeldedaten dar.

JSON-Darstellung 
{
  "clientId": string,
  "clientSecret": string
}
Felder
clientId

string

Pflichtangabe. Eine OAuth-Client-ID.
clientSecret

string

Pflichtangabe. Ein OAuth-Clientschlüssel.

TokenBased

Weitere Informationen zu Looker-Zugriffstokens finden Sie unter https://developers.looker.com/api/advanced-usage/looker-api-oauth.

JSON-Darstellung 
{
  "accessToken": string
}
Felder
accessToken

string

Pflichtangabe. Der Name des Secrets, das das Zugriffstoken enthält.

ConversationOptions

Optionen für die Unterhaltung.

JSON-Darstellung 
{
  "chart": {
    object (ChartOptions)
  },
  "analysis": {
    object (AnalysisOptions)
  }
}
Felder
chart

object (ChartOptions)

Optional. Optionen für die Diagrammerstellung.
analysis

object (AnalysisOptions)

Optional. Optionen für die Analyse.

ChartOptions

Optionen für die Diagrammerstellung.

JSON-Darstellung 
{
  "image": {
    object (ImageOptions)
  }
}
Felder
image

object (ImageOptions)

Optional. Wenn angegeben, rendert der KI-Agent generierte Diagramme im angegebenen Format. Die Standardeinstellung ist „Kein Bild“.

ImageOptions

Optionen zum Rendern von Bildern generierter Diagramme.

JSON-Darstellung 
{

  // 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.
}
Felder
Union-Feld kind. Die Art des zu rendernden Bildes. Für kind ist nur einer der folgenden Werte zulässig:
noImage

object (NoImage)

Kein Bild.
svg

object (SvgOptions)

SVG-Format.

NoImage

Dieser Typ hat keine Felder.

Kein Bild.

SvgOptions

Dieser Typ hat keine Felder.

SVG-Optionen.

AnalysisOptions

Optionen für die Analyse.

JSON-Darstellung 
{
  "python": {
    object (Python)
  }
}
Felder
python

object (Python)

Optional. Optionen für die Python-Analyse.

Python

Optionen für die Python-Analyse.

JSON-Darstellung 
{
  "enabled": boolean
}
Felder
enabled

boolean

Optional. Gibt an, ob die Python-Analyse aktiviert werden soll. Die Standardeinstellung ist "false".

ExampleQuery

Beispiel für eine relevante und häufig verwendete SQL-Abfrage und die entsprechenden optionalen Abfragen in natürlicher Sprache. Wird derzeit nur für BigQuery-Datenquellen verwendet.

JSON-Darstellung 
{
  "naturalLanguageQuestion": string,

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

string

Optional. Eine Frage in natürlicher Sprache, die ein Nutzer stellen könnte. Beispiel: „Wie viele Bestellungen wurden im letzten Monat aufgegeben?“
Union-Feld query. Die SQL- oder Looker-Abfrage, die generiert werden soll, um die Anfrage in natürlicher Sprache zu beantworten. Für query ist nur einer der folgenden Werte zulässig:
sqlQuery

string

Optional. Die SQL-Abfrage, die generiert werden soll, um die Frage in natürlicher Sprache zu beantworten. Beispiel: „SELECT COUNT(*) FROM orders WHERE order_date BETWEEN '2024-01-01' AND '2024-01-31'“

Methoden

create

 Erstellt einen neuen KI-Datenagenten in einem bestimmten Projekt und an einem bestimmten Ort.

delete

 Löscht einen einzelnen KI-Datenagenten.

get

 Ruft Details zu einem einzelnen KI-Datenagenten ab.

getIamPolicy

 Ruft die IAM-Richtlinie für den KI-Datenagenten ab.

list

 Listet KI-Datenagenten in einem angegebenen Projekt und an einem angegebenen Ort auf.

listAccessible

 Listet KI-Datenagenten auf, auf die der Aufrufer in einem angegebenen Projekt und an einem angegebenen Ort zugreifen kann.

patch

 Aktualisiert die Parameter eines einzelnen KI-Datenagenten.

setIamPolicy

 Legt die IAM-Richtlinie für einen KI-Datenagenten fest.