- JSON-Darstellung
- UserMessage
- SystemMessage
- TextMessage
- TextType
- SchemaMessage
- SchemaQuery
- SchemaResult
- Datasource
- DataMessage
- DataQuery
- DataResult
- BigQueryJob
- MatchedQuery
- QueryParameterValues
- AnalysisMessage
- AnalysisQuery
- AnalysisEvent
- ChartMessage
- ChartQuery
- ChartResult
- Blob
- ErrorMessage
- ExampleQueries
- Zitation
- CitationSource
- CitationAnchor
- TextMessageCitationAnchor
Eine Nachricht von einer Interaktion zwischen dem Nutzer und dem System.
| JSON-Darstellung |
|---|
{ "timestamp": string, "messageId": string, // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "userMessage": { object ( |
| 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. |
| Die Art der Nachricht. Im Folgenden finden Sie eine Liste von sich gegenseitig ausschließenden Feldern. In einer Antwort wird höchstens eines der Felder festgelegt: | |
userMessage |
Eine Nachricht vom Nutzer, der mit dem System interagiert. |
systemMessage |
Eine Nachricht vom System als Antwort auf die Nutzeranfrage. |
| Ende der sich gegenseitig ausschließenden Felder. | |
UserMessage
Eine Nachricht vom Nutzer, der mit dem System interagiert.
| JSON-Darstellung |
|---|
{ // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "text": string // End of mutually exclusive fields. } |
| Felder | |
|---|---|
| Die Art des Inhalts in der Nutzernachricht. Im Folgenden finden Sie eine Liste von sich gegenseitig ausschließenden Feldern. In einer Antwort wird höchstens eines der Felder festgelegt: | |
text |
Für Text sollte dieses Feld anstelle von „Blob“ verwendet werden. |
| Ende der sich gegenseitig ausschließenden Felder. | |
SystemMessage
Eine Nachricht vom System als Antwort auf die Nutzeranfrage. Diese Nachricht kann auch eine Nachricht des Nutzers als Verlaufskontext für Mehrfachdialog-Unterhaltungen mit dem System sein.
| JSON-Darstellung |
|---|
{ "citation": { object ( |
| Felder | |
|---|---|
citation |
Nur Ausgabe. Zitationsinformationen für die Systemmeldung. |
| Die Art des Inhalts in der Systemnachricht. Im Folgenden finden Sie eine Liste von sich gegenseitig ausschließenden Feldern. In einer Antwort wird höchstens eines der Felder festgelegt: | |
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. |
exampleQueries |
Optional. Eine Nachricht mit Beispielabfragen. |
| Ende der sich gegenseitig ausschließenden Felder. | |
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
],
"textType": enum ( |
| Felder | |
|---|---|
parts[] |
Optional. Die Teile der Nachricht. |
textType |
Optional. Der Typ der Nachricht. |
thoughtSignature |
Optional. Eine undurchsichtige Signatur für einen Gedanken, damit er in nachfolgenden Anfragen wiederverwendet werden kann. Ein base64-codierter String. |
TextType
Der Typ der Nachricht.
| Enums | |
|---|---|
TEXT_TYPE_UNSPECIFIED |
Der Standardtexttyp. |
FINAL_RESPONSE |
Der Text ist eine endgültige Antwort auf die Frage des Nutzers. |
THOUGHT |
Der Text ist ein Gedanke des Modells. |
PROGRESS |
Der Text ist eine Informationsmeldung zum Fortschritt des Agents, z. B. wenn ein Tool aufgerufen wird. Das unterscheidet sich vom internen Denkprozess des KI-Agenten (THOUGHT) und der endgültigen Antwort an den Nutzer (FINAL_RESPONSE). Diese Nachrichten geben Einblick in die Aktionen des KI-Agenten. |
FOLLOWUP_QUESTIONS |
Der Text ist eine Liste mit vorgeschlagenen Folgefragen. Jeder Eintrag in „parts“ ist eine Folgefrage. |
SchemaMessage
Eine Nachricht, die während der Schemaauflösung ausgegeben wird.
| JSON-Darstellung |
|---|
{ // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "query": { object ( |
| Felder | |
|---|---|
| Gibt an, ob diese Nachricht die Anfrage oder das Ergebnis der Schemaauflösung enthält. Im Folgenden finden Sie eine Liste von sich gegenseitig ausschließenden Feldern. In einer Antwort wird höchstens eines der Felder festgelegt: | |
query |
Eine Anfrage zur Schemaauflösung. |
result |
Das Ergebnis einer Anfrage zur Schemaauflösung. |
| Ende der sich gegenseitig ausschließenden Felder. | |
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. |
structSchema |
Optional. Eine Struktur-Darstellung des Schemas. Dieses Feld wird für Datenquellen mit Schemas ausgefüllt, die nicht vollständig durch das stark typisierte Feld Für Looker-Datenquellen entspricht dies dem Typ „LookmlModelExplore“: https://cloud.google.com/looker/docs/reference/looker-api/latest/types/LookmlModelExplore |
| Der Verweis auf die Datenquelle. Im Folgenden finden Sie eine Liste von sich gegenseitig ausschließenden Feldern. In einer Antwort wird höchstens eines der Felder festgelegt: | |
bigqueryTableReference |
Ein Verweis auf eine BigQuery-Tabelle. |
studioDatasourceId |
Ein Verweis auf eine Looker Studio-Datenquelle. |
lookerExploreReference |
Ein Verweis auf ein Looker-Explore. |
bigqueryPropertyGraphReference |
Ein Verweis auf einen BigQuery-Eigenschaftsgraphen. |
| Ende der sich gegenseitig ausschließenden Felder. | |
DataMessage
Eine Nachricht, die beim Abrufen von Daten ausgegeben wird.
| JSON-Darstellung |
|---|
{ // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "query": { object ( |
| Felder | |
|---|---|
| Gibt an, ob diese Nachricht die Anfrage, das Ergebnis oder generiertes SQL für den Datenabruf enthält. Im Folgenden finden Sie eine Liste von sich gegenseitig ausschließenden Feldern. In einer Antwort wird höchstens eines der Felder festgelegt: | |
query |
Eine Anfrage zum Abrufen von Daten. |
generatedSql |
SQL, das vom System zum Abrufen von Daten generiert wird. |
result |
Abgerufene Daten. |
bigQueryJob |
Ein BigQuery-Job, der vom System ausgeführt wird, um Daten abzurufen. |
matchedQuery |
Eine bereits vorhandene Anfrage, die zum Abrufen von Daten verwendet wurde. |
| Ende der sich gegenseitig ausschließenden Felder. | |
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. |
| Der Typ der auszuführenden Anfrage. Im Folgenden finden Sie eine Liste von sich gegenseitig ausschließenden Feldern. In einer Antwort wird höchstens eines der Felder festgelegt: | |
looker |
Optional. Eine Anfrage zum Abrufen von Daten aus einem Looker-Explore. |
| Ende der sich gegenseitig ausschließenden Felder. | |
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. |
formattedData[] |
Optional. Formatierte Darstellung der Daten, sofern zutreffend. Jede Zeile ist ein Struct, das der Zeile mit demselben Index im Feld |
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. |
MatchedQuery
Eine Nachricht mit einer übereinstimmenden Abfrage bedeutet, dass der Agent eine der im Kontext bereitgestellten Beispielabfragen als für die aktuelle Frage zutreffend erkannt hat. Außerdem enthält sie zusätzliche Informationen zum Abgleichsprozess.
| JSON-Darstellung |
|---|
{ "exampleQuery": { object ( |
| Felder | |
|---|---|
exampleQuery |
Die Abfrage, die auf Grundlage einer Beispielanfrage zugeordnet wurde. |
queryParameterValues[] |
Die extrahierten Werte für die Abfrageparameter. |
QueryParameterValues
Eine Meldung mit Abfrageparameterwerten enthält die Werte für die Abfrageparameter, die vom LLM anhand der Beispielanfrage aus der Nutzerfrage extrahiert wurden.
| JSON-Darstellung |
|---|
{ "name": string, "value": string } |
| Felder | |
|---|---|
name |
Erforderlich. Name des Parameters. |
value |
Erforderlich. Wert des Parameters. |
AnalysisMessage
Eine Nachricht, die während der Analyse ausgegeben wird.
| JSON-Darstellung |
|---|
{ // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "query": { object ( |
| Felder | |
|---|---|
| Gibt an, ob diese Nachricht die Anfrage oder eines der Ereignisse aus der Analyse enthält. Im Folgenden finden Sie eine Liste von sich gegenseitig ausschließenden Feldern. In einer Antwort wird höchstens eines der Felder festgelegt: | |
query |
Eine Analyseanfrage. |
progressEvent |
Ein Ereignis, das den Fortschritt der Analyse angibt. |
| Ende der sich gegenseitig ausschließenden Felder. | |
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 |
|---|
{ // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "plannerReasoning": string, "coderInstruction": string, "code": string, "executionOutput": string, "executionError": string, "resultVegaChartJson": string, "resultNaturalLanguage": string, "resultCsvData": string, "resultReferenceData": string, "error": string // End of mutually exclusive fields. } |
| Felder | |
|---|---|
| Die Art des Ereignisses, das während der Analyse aufgetreten ist. Im Folgenden finden Sie eine Liste von sich gegenseitig ausschließenden Feldern. In einer Antwort wird höchstens eines der Felder festgelegt: | |
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. |
| Ende der sich gegenseitig ausschließenden Felder. | |
ChartMessage
Eine Nachricht, die während der Diagrammerstellung ausgegeben wird.
| JSON-Darstellung |
|---|
{ // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "query": { object ( |
| Felder | |
|---|---|
| Gibt an, ob diese Nachricht die Anfrage oder das Ergebnis der Diagrammerstellung enthält. Im Folgenden finden Sie eine Liste von sich gegenseitig ausschließenden Feldern. In einer Antwort wird höchstens eines der Felder festgelegt: | |
query |
Eine Anfrage zum Erstellen eines Diagramms. |
result |
Das Ergebnis einer Anfrage zur Diagrammerstellung. |
| Ende der sich gegenseitig ausschließenden Felder. | |
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 von einem Toolaufruf. Diese Meldung wird verwendet, um einen Fehler darzustellen, der aufgetreten ist, als ein Agent versucht hat, ein Tool zu verwenden. Nicht alle Fehler sind schwerwiegend. Viele sind behebbar und der Agent kann die Informationen aus dieser Fehlermeldung verwenden, um sich selbst zu korrigieren und den Tool-Aufruf noch einmal zu versuchen oder einen anderen Ansatz zu wählen.
Wenn beispielsweise eine Datenabfrage fehlschlägt, erhält der Agent möglicherweise ein ErrorMessage, analysiert es und generiert dann eine korrigierte Abfrage.
Clients sollten diese Meldung nicht als endgültigen Fehler interpretieren. Dies kann Teil des normalen, iterativen Prozesses des Agents zum Erledigen einer Aufgabe sein. Wenn diese Fehler Endnutzern ohne Kontext angezeigt werden (z. B. als „schwerwiegender Fehler“), kann das irreführend sein.
| JSON-Darstellung |
|---|
{ "text": string } |
| Felder | |
|---|---|
text |
Nur Ausgabe. Der Text des Fehlers. |
ExampleQueries
Eine Nachricht mit abgeleiteten und erstellten Beispielanfragen.
| JSON-Darstellung |
|---|
{
"exampleQueries": [
{
object ( |
| Felder | |
|---|---|
exampleQueries[] |
Optional. Eine Liste mit abgeleiteten und erstellten Beispielanfragen mit Beispielen für relevante und häufig verwendete SQL-Abfragen und optional die entsprechenden Abfragen in natürlicher Sprache. Wird derzeit nur für BigQuery-Datenquellen verwendet. |
Quellenangabe
Quellenangaben für Inhalte
| JSON-Darstellung |
|---|
{ "sources": [ { object ( |
| Felder | |
|---|---|
sources[] |
Nur Ausgabe. Liste der zitierten Quellen. |
anchors[] |
Nur Ausgabe. Liste der Anker der Quellenangaben. |
CitationSource
Die Quelle der Zitation.
| JSON-Darstellung |
|---|
{ "id": string, "title": string, // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "uri": string, "exampleQuery": { object ( |
| Felder | |
|---|---|
id |
Nur Ausgabe. Eindeutige Kennung der Quelle. Diese ID wird vom Dienst generiert und ist im Rahmen einer einzelnen |
title |
Nur Ausgabe. Der Titel der Quelle. |
| Die Quelle der Quellenangabe. Dabei kann es sich um einen der unterstützten Typen handeln. Im Folgenden finden Sie eine Liste von sich gegenseitig ausschließenden Feldern. In einer Antwort wird höchstens eines der Felder festgelegt: | |
uri |
Nur Ausgabe. Die als Quelle verwendete URI, z. B. eine Web-Fundierungs-URL. |
exampleQuery |
Nur Ausgabe. Die als Quelle verwendete Beispielabfrage. |
glossaryTerm |
Nur Ausgabe. Der Glossarbegriff, der als Quelle verwendet wird. |
| Ende der sich gegenseitig ausschließenden Felder. | |
CitationAnchor
Der Anker der Quellenangabe.
| JSON-Darstellung |
|---|
{
// The following is a list of mutually exclusive fields. At most one of the
// fields will be set in a response:
"textMessageAnchor": {
object ( |
| Felder | |
|---|---|
| Der Anker der Quellenangabe, der einer der unterstützten Typen sein kann. Im Folgenden finden Sie eine Liste von sich gegenseitig ausschließenden Feldern. In einer Antwort wird höchstens eines der Felder festgelegt: | |
textMessageAnchor |
Nur Ausgabe. Wird nur festgelegt, wenn sich das Zitat auf eine TextMessage bezieht. |
| Ende der sich gegenseitig ausschließenden Felder. | |
TextMessageCitationAnchor
Zitationsanker in einer TextMessage.
| JSON-Darstellung |
|---|
{ "partIndex": integer, "startOffsetBytes": integer, "endOffsetBytes": integer, "sourceIds": [ string ] } |
| Felder | |
|---|---|
partIndex |
Nur Ausgabe. Der nullbasierte Index des Teils im Feld „TextMessage.parts“. |
startOffsetBytes |
Nur Ausgabe. Das Offset, gemessen in UTF‑8‑Byte, innerhalb des Teilstrings, an dem das Zitat beginnt (einschließlich). Beispiel: Für den Text „Hallo Welt“, in dem „Welt“ zitiert wird, ist der Start-Offset in Byte (inklusive) 7 und der End-Offset in Byte (exklusive) 12. |
endOffsetBytes |
Nur Ausgabe. Der Offset, gemessen in UTF-8-Byte, innerhalb des Teilstrings, an dem das Zitat endet (exklusiv). Beispiel: Für den Text „Hallo Welt“, in dem „Welt“ zitiert wird, ist der Start-Offset in Byte (inklusive) 7 und der End-Offset in Byte (exklusive) 12. |
sourceIds[] |
Nur Ausgabe. Die IDs der zitierten Quellen. |