- JSON-Darstellung
- UserMessage
- SystemMessage
- TextMessage
- SchemaMessage
- SchemaQuery
- SchemaResult
- Datasource
- DataMessage
- DataQuery
- DataResult
- LookerQuery
- Filter
- BigQueryJob
- AnalysisMessage
- AnalysisQuery
- AnalysisEvent
- ChartMessage
- ChartQuery
- ChartResult
- Blob
- ErrorMessage
Eine Nachricht von einer Interaktion zwischen dem Nutzer und dem System.
JSON-Darstellung |
---|
{ "timestamp": string, "messageId": string, // Union field |
Felder | |
---|---|
timestamp |
Nur Ausgabe. Bei Nutzernachrichten ist dies der Zeitpunkt, zu dem das System die Nachricht empfangen hat. Bei Systemnachrichten ist dies der Zeitpunkt, zu dem das System die Nachricht generiert hat. 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: |
messageId |
Optional. Eindeutige ID der Nachricht in der Unterhaltung für die Persistenz. |
Union-Feld kind . Die Art der Nachricht. Für kind ist nur einer der folgenden Werte zulässig: |
|
userMessage |
Eine Nachricht vom Nutzer, der mit dem System interagiert. |
systemMessage |
Eine Nachricht vom System als Antwort auf die Nutzeranfrage. |
UserMessage
Eine Nachricht vom Nutzer, der mit dem System interagiert.
JSON-Darstellung |
---|
{ // Union field |
Felder | |
---|---|
Union-Feld kind . Die Art des Inhalts in der Nutzernachricht. Für kind ist nur einer der folgenden Werte zulässig: |
|
text |
Für Text sollte dieses Feld anstelle von „Blob“ verwendet werden. |
SystemMessage
Eine Nachricht vom System als Antwort auf die Nutzeranfrage. Diese Nachricht kann auch eine Nachricht des Nutzers als Verlaufskontext für Multi-Turn-Unterhaltungen mit dem System sein.
JSON-Darstellung |
---|
{ // Union field |
Felder | |
---|---|
Union-Feld kind . Die Art des Inhalts in der Systemnachricht. Für kind ist nur einer der folgenden Werte zulässig: |
|
text |
Eine direkte Antwort in natürlicher Sprache auf die Nutzernachricht. |
schema |
Eine Nachricht, die während der Schemaauflösung ausgegeben wird. |
data |
Eine Nachricht, die beim Abrufen von Daten ausgegeben wird. |
analysis |
Eine Nachricht, die während der Analyse ausgegeben wird. |
chart |
Eine Nachricht, die während der Diagrammerstellung ausgegeben wird. |
error |
Eine Fehlermeldung. |
groupId |
Gibt die Gruppe an, zu der das Ereignis gehört. Ähnliche Ereignisse werden als logisch miteinander verknüpft betrachtet und sollten zusammen in der Benutzeroberfläche angezeigt werden. |
TextMessage
Eine mehrteilige Textnachricht.
JSON-Darstellung |
---|
{ "parts": [ string ] } |
Felder | |
---|---|
parts[] |
Optional. Die Teile der Nachricht. |
SchemaMessage
Eine Nachricht, die während der Schemaauflösung ausgegeben wird.
JSON-Darstellung |
---|
{ // Union field |
Felder | |
---|---|
Union-Feld kind . Gibt an, ob diese Nachricht die Anfrage oder das Ergebnis der Schemaauflösung enthält. Für kind ist nur einer der folgenden Werte zulässig: |
|
query |
Eine Anfrage zur Schemaauflösung. |
result |
Das Ergebnis einer Anfrage zur Schemaauflösung. |
SchemaQuery
Eine Anfrage zum Auflösen des Schemas, das für die gestellte Frage relevant ist.
JSON-Darstellung |
---|
{ "question": string } |
Felder | |
---|---|
question |
Optional. Die Frage, die zur Schemaauflösung an das System gesendet werden soll. |
SchemaResult
Das Ergebnis der Schemaauflösung.
JSON-Darstellung |
---|
{
"datasources": [
{
object ( |
Felder | |
---|---|
datasources[] |
Optional. Die Datenquellen, die zum Auflösen der Schemaanfrage verwendet wurden. |
Datasource
Eine Datenquelle, die zum Beantworten von Fragen verwendet werden kann.
JSON-Darstellung |
---|
{ "schema": { object ( |
Felder | |
---|---|
schema |
Optional. Das Schema der Datenquelle. |
Union-Feld reference . Der Verweis auf die Datenquelle. Für reference ist nur einer der folgenden Werte zulässig: |
|
bigqueryTableReference |
Ein Verweis auf eine BigQuery-Tabelle. |
studioDatasourceId |
Ein Verweis auf eine Looker Studio-Datenquelle. |
lookerExploreReference |
Ein Verweis auf ein Looker-Explore. |
DataMessage
Eine Nachricht, die beim Abrufen von Daten ausgegeben wird.
JSON-Darstellung |
---|
{ // Union field |
Felder | |
---|---|
Union-Feld kind . Gibt an, ob diese Nachricht die Anfrage, das Ergebnis oder generiertes SQL für den Datenabruf enthält. Für kind ist nur einer der folgenden Werte zulässig: |
|
query |
Eine Anfrage zum Abrufen von Daten. |
generatedSql |
SQL, das vom System zum Abrufen von Daten generiert wird. |
result |
Abgerufene Daten. |
generatedLookerQuery |
Vom System generierte Looker-Anfrage zum Abrufen von Daten. |
bigQueryJob |
Ein BigQuery-Job, der vom System ausgeführt wird, um Daten abzurufen. |
DataQuery
Eine Anfrage zum Abrufen von Daten.
JSON-Darstellung |
---|
{
"question": string,
"name": string,
"datasources": [
{
object ( |
Felder | |
---|---|
question |
Optional. Eine Frage in natürlicher Sprache, die beantwortet werden soll. |
name |
Optional. Ein Name im Snake-Case-Format für die Anfrage, der den Zweck der Anfrage widerspiegelt. Damit wird das entsprechende Datenergebnis benannt, sodass in späteren Schritten darauf verwiesen werden kann.
|
datasources[] |
Optional. Die Datenquellen, die zur Beantwortung der Frage zur Verfügung stehen. |
DataResult
Abgerufene Daten.
JSON-Darstellung |
---|
{
"name": string,
"schema": {
object ( |
Felder | |
---|---|
name |
Optional. Ein Name im Snake-Case-Format für das Datenergebnis, der den Inhalt des Ergebnisses widerspiegelt. Der Name wird verwendet, um das Ergebnis per Verweis zu übergeben, und dient als Signal für seine Bedeutung.
|
schema |
Optional. Das Schema der Daten. |
data[] |
Optional. Der Inhalt der Daten. Jede Zeile ist ein Struct, das dem Schema entspricht. Einfache Werte werden als Strings dargestellt, verschachtelte Strukturen als Listen oder Structs. |
LookerQuery
Eine Anfrage zum Abrufen von Daten aus einem Looker-Explore. Weitere Informationen finden Sie unter Inline-Anfrage ausführen.
JSON-Darstellung |
---|
{
"model": string,
"explore": string,
"fields": [
string
],
"filters": [
{
object ( |
Felder | |
---|---|
model |
Pflichtangabe. Das LookML-Modell, das zum Generieren der Anfrage verwendet wurde. |
explore |
Pflichtangabe. Das LookML-Explore, das zum Generieren der Anfrage verwendet wurde. |
fields[] |
Optional. Die Felder, die aus dem Explore abgerufen werden sollen. |
filters[] |
Optional. Die Filter, die auf den Explore angewendet werden sollen. |
sorts[] |
Optional. Die Sortierungen, die auf den Explore angewendet werden sollen. |
limit |
Optional. Limit in der Anfrage. |
Filter
Ein Looker-Anfragefilter.
JSON-Darstellung |
---|
{ "field": string, "value": string } |
Felder | |
---|---|
field |
Pflichtangabe. Das Feld, nach dem gefiltert werden soll. |
value |
Pflichtangabe. Der Wert f, nach dem gefiltert werden soll. |
BigQueryJob
Ein BigQuery-Job, der vom System ausgeführt wird.
JSON-Darstellung |
---|
{ "projectId": string, "jobId": string, "location": string, "destinationTable": { object ( |
Felder | |
---|---|
projectId |
Pflichtangabe. Das Projekt, zu dem der Job gehört. Siehe JobReference. |
jobId |
Pflichtangabe. Die ID des Jobs. Siehe JobReference. |
location |
Optional. Der Ort des Jobs. Siehe JobReference. |
destinationTable |
Optional. Ein Verweis auf die Zieltabelle der Anfrageergebnisse des Jobs. Siehe JobConfigurationQuery. |
schema |
Optional. Das Schema der Anfrageergebnisse des Jobs. Siehe JobStatistics2. |
AnalysisMessage
Eine Nachricht, die während der Analyse ausgegeben wird.
JSON-Darstellung |
---|
{ // Union field |
Felder | |
---|---|
Union-Feld kind . Gibt an, ob diese Nachricht die Anfrage oder eines der Ereignisse aus der Analyse enthält. Für kind ist nur einer der folgenden Werte zulässig: |
|
query |
Eine Analyseanfrage. |
progressEvent |
Ein Ereignis, das den Fortschritt der Analyse angibt. |
AnalysisQuery
Eine Anfrage zum Durchführen einer Analyse.
JSON-Darstellung |
---|
{ "question": string, "dataResultNames": [ string ] } |
Felder | |
---|---|
question |
Optional. Eine Analysefrage, die dabei helfen soll, die ursprüngliche Frage des Nutzers zu beantworten. |
dataResultNames[] |
Optional. Die Namen von zuvor abgerufenen Datenergebnissen, die analysiert werden sollen. |
AnalysisEvent
Ein Ereignis, das den Fortschritt einer Analyse angibt.
JSON-Darstellung |
---|
{ // Union field |
Felder | |
---|---|
Union-Feld kind . Die Art des Ereignisses, das während der Analyse aufgetreten ist. Für kind ist nur einer der folgenden Werte zulässig: |
|
plannerReasoning |
Begründung des Python-Codegen-Planers. |
coderInstruction |
Anweisungen, die für die Codegenerierung ausgestellt wurden. |
code |
Generierter Code. |
executionOutput |
Ausgabe der Codeausführung. |
executionError |
Ein Fehler bei der Codeausführung. |
resultVegaChartJson |
Ergebnis als JSON-String für ein Vega-Diagramm. |
resultNaturalLanguage |
Ergebnis als NL-String. |
resultCsvData |
Ergebnis als CSV-String. |
resultReferenceData |
Ergebnis als Verweis auf eine Datenquelle. |
error |
Eine allgemeine Fehlermeldung. |
ChartMessage
Eine Nachricht, die während der Diagrammerstellung ausgegeben wird.
JSON-Darstellung |
---|
{ // Union field |
Felder | |
---|---|
Union-Feld kind . Gibt an, ob diese Nachricht die Anfrage oder das Ergebnis der Diagrammerstellung enthält. Für kind ist nur einer der folgenden Werte zulässig: |
|
query |
Eine Anfrage zum Erstellen eines Diagramms. |
result |
Das Ergebnis einer Anfrage zur Diagrammerstellung. |
ChartQuery
Eine Anfrage zum Erstellen eines Diagramms.
JSON-Darstellung |
---|
{ "instructions": string, "dataResultName": string } |
Felder | |
---|---|
instructions |
Optional. Anweisungen in natürlicher Sprache zum Erstellen des Diagramms. |
dataResultName |
Optional. Der Name eines zuvor abgerufenen Datenergebnisses, das im Diagramm verwendet werden soll. |
ChartResult
Das Ergebnis einer Anfrage zur Diagrammerstellung.
JSON-Darstellung |
---|
{
"vegaConfig": {
object
},
"image": {
object ( |
Felder | |
---|---|
vegaConfig |
Optional. Eine generierte Vega-Diagrammkonfiguration. Weitere Informationen finden Sie unter https://vega.github.io/vega/docs/config/. |
image |
Optional. Eine gerenderte Version des Diagramms, wenn dies im Kontext angefordert wurde. |
Blob
Ein Blob mit Daten vom MIME-Typ.
JSON-Darstellung |
---|
{ "mimeType": string, "data": string } |
Felder | |
---|---|
mimeType |
Pflichtangabe. Der IANA-Standard-MIME-Typ der Nachrichtendaten. |
data |
Pflichtangabe. Die Daten als Byte dargestellt. Ein base64-codierter String. |
ErrorMessage
Eine Fehlermeldung.
JSON-Darstellung |
---|
{ "text": string } |
Felder | |
---|---|
text |
Nur Ausgabe. Der Text des Fehlers. |