Method: projects.locations.chat

Beantwortet eine Datenfrage, indem ein Stream von Message-Objekten generiert wird.

HTTP-Anfrage

POST https://geminidataanalytics.googleapis.com/v1/{parent=projects/*/locations/*}:chat

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
parent

string

Pflichtangabe. Der übergeordnete Wert für die Chatanfrage. Muster: projects/{project}/locations/{location}

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung
{
  "messages": [
    {
      object (Message)
    }
  ],
  "credentials": {
    object (Credentials)
  },
  "thinkingMode": enum (ThinkingMode),
  "model": enum (Model),

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "inlineContext": {
    object (Context)
  },
  "conversationReference": {
    object (ConversationReference)
  },
  "dataAgentContext": {
    object (DataAgentContext)
  },
  "clientManagedResourceContext": {
    object (ClientManagedResourceContext)
  }
  // End of mutually exclusive fields.

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "lookerSettings": {
    object (LookerSettings)
  }
  // End of mutually exclusive fields.
}
Felder
messages[]

object (Message)

Erforderlich. Inhalt der aktuellen Unterhaltung.

credentials

object (Credentials)

Optional. Die Anmeldedaten, die beim Aufrufen der im Kontext angegebenen Datenquellen verwendet werden sollen.

Dieses Feld kann verwendet werden, um Anmeldedaten für verschiedene Datenquellen anzugeben. Wenn Sie beispielsweise eine Verbindung zu Looker herstellen, werden derzeit sowohl OAuth-Token als auch Anmeldedaten auf API-Schlüsselbasis unterstützt, wie unter Authentifizierung mit einem SDK beschrieben.

thinkingMode

enum (ThinkingMode)

Optional. Der Thinking-Modus, der für die Agentenschleife verwendet werden soll. Wenn keine Angabe erfolgt, wird standardmäßig THINKING_MODE_UNSPECIFIED verwendet.

model

enum (Model)

Optional. Das Modell, das für die Agentenschleife bei der Verarbeitung der Anfrage verwendet werden soll. Diese Einstellung hat nur Auswirkungen, wenn „context.options.model“ nicht festgelegt ist.

Kontextanbieter für die Chatanfrage. Es kann entweder „inline_context“ sein, ein Kontext, der inline in der Anfrage bereitgestellt wird, „data_agent“, ein Verweis auf eine KI-Datenagenten-Ressource, oder „conversation_reference“, ein Verweis auf eine persistente Unterhaltung und einen Kontext mit „conversation_id“ und „agent_id“. Im Folgenden finden Sie eine Liste der sich gegenseitig ausschließenden Felder. In einer Antwort wird höchstens eines der Felder festgelegt:
inlineContext

object (Context)

Optional. Inline-Kontext für die Chatanfrage. Damit können Sie zustandslos chatten (ohne verwaltete Unterhaltungspersistenz und ohne Agenten), indem Sie den gesamten Kontext inline übergeben.

conversationReference

object (ConversationReference)

Optional. Verweis auf eine persistente Unterhaltung und einen persistenten KI-Agentenkontext. Verwenden Sie diesen Wert, um mit einem KI-Agenten zu chatten und dabei die verwaltete Unterhaltungspersistenz zu nutzen.

dataAgentContext

object (DataAgentContext)

Optional. Kontext für die Chatanfrage. Damit können Sie zustandslos mit einem KI-Agenten ohne verwaltete Unterhaltungspersistenz chatten.

clientManagedResourceContext

object (ClientManagedResourceContext)

Optional. Kontext mit kundenverwalteten Ressourcen. Einige Kunden verwenden möglicherweise keine von GDA verwalteten Ressourcen wie Unterhaltungen und KI-Agenten, sondern erstellen und verwalten eigene Unterhaltungs- und KI-Agentenressourcen.

Ende der sich gegenseitig ausschließenden Felder.
Optionale Einstellungen zum Anpassen des Anfrageverhaltens, spezifisch für die Zieldatenquelle. Im Folgenden finden Sie eine Liste von sich gegenseitig ausschließenden Feldern. In einer Antwort wird höchstens eines der Felder festgelegt:
lookerSettings

object (LookerSettings)

Optional. Looker-spezifische Einstellungen.

Ende der sich gegenseitig ausschließenden Felder.

Antworttext

Bei Erfolg enthält der Antworttext einen Stream von Message-Instanzen.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/geminidataanalytics

Weitere Informationen finden Sie unter Authentication Overview.

ConversationReference

Verweis auf eine persistente Unterhaltung und einen persistenten KI-Agentenkontext.

JSON-Darstellung
{
  "conversation": string,
  "dataAgentContext": {
    object (DataAgentContext)
  }
}
Felder
conversation

string

Pflichtangabe. Name der Unterhaltungsressource. Format: projects/{project}/locations/{location}/conversations/{conversationId}

dataAgentContext

object (DataAgentContext)

Pflichtangabe. Kontext für die Chatanfrage mit einem KI-Datenagenten.

DataAgentContext

Kontext für die Chatanfrage mit einem KI-Datenagenten.

JSON-Darstellung
{
  "dataAgent": string,
  "contextVersion": enum (ContextVersion)
}
Felder
dataAgent

string

Pflichtangabe. Der Name der KI-Datenagenten-Ressource.

contextVersion

enum (ContextVersion)

Optional. Version des Kontexts, der von DCS verwendet werden soll (z. B. STAGING, PUBLISHED)

ContextVersion

Liste der von DCS unterstützten Kontextversionen. Es gibt zwei Versionen von Kontext. So wird die Versionsverwaltung für den KI-Datenagenten beibehalten.

Enums
CONTEXT_VERSION_UNSPECIFIED Nicht angegeben oder nicht erkannt.
STAGING Bei Verwendung dieser Version wird für den KI-Datenagenten der aktuelle Staging-Kontext verwendet.
PUBLISHED Bei Verwendung dieser Version wird für den KI-Datenagenten der zuletzt veröffentlichte Kontext verwendet.

ClientManagedResourceContext

Kontext mit kundenverwalteten Ressourcen. Einige Kunden verwenden möglicherweise keine von GDA verwalteten Ressourcen wie Unterhaltungen und KI-Agenten, sondern erstellen und verwalten eigene Unterhaltungs- und KI-Agentenressourcen.

JSON-Darstellung
{
  "inlineContext": {
    object (Context)
  },
  "conversationId": string,
  "agentId": string
}
Felder
inlineContext

object (Context)

Pflichtangabe. Kontext für die Chatanfrage. Damit können Sie chatten, ohne dass die GDA API die Unterhaltungs- und KI-Agentenpersistenz verwaltet, indem Sie den gesamten Kontext inline übergeben.

conversationId

string

Optional. Die kundenverwaltete Unterhaltungs-ID.

agentId

string

Optional. Die kundenverwaltete KI-Agenten-ID.

LookerSettings

Nachricht für Looker-spezifische benutzerdefinierte Einstellungen.

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

boolean

Optional. Gibt an, ob der Entwicklungsmodus von Looker verwendet werden soll. Wenn „true“ festgelegt ist, wird die API-Sitzung zum „dev“-Arbeitsbereich gewechselt. So können Sie mit LookML-Änderungen im Entwicklungszweig des Nutzers interagieren. Wenn „false“ aktiviert ist oder die Richtlinie nicht konfiguriert ist, bleibt die Sitzung im Standardstatus (Produktionsmodus). Weitere Informationen finden Sie unter https://cloud.google.com/looker/docs/dev-mode-prod-mode.

Anmeldedaten

Stellt verschiedene Formen der Spezifikation von Anmeldedaten dar.

JSON-Darstellung
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "oauth": {
    object (OAuthCredentials)
  }
  // End of mutually exclusive fields.
}
Felder
Die Art der Anmeldedaten. Im Folgenden finden Sie eine Liste der sich gegenseitig ausschließenden Felder. In einer Antwort wird höchstens eines der Felder festgelegt:
oauth

object (OAuthCredentials)

OAuth-Anmeldedaten.

Ende der sich gegenseitig ausschließenden Felder.

OAuthCredentials

Stellt OAuth-Anmeldedaten dar.

JSON-Darstellung
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "secret": {
    object (SecretBased)
  },
  "token": {
    object (TokenBased)
  }
  // End of mutually exclusive fields.
}
Felder
Die Art der OAuth-Anmeldedaten. Im Folgenden finden Sie eine Liste von sich gegenseitig ausschließenden Feldern. In einer Antwort wird höchstens eines der Felder festgelegt:
secret

object (SecretBased)

Secret-basierte OAuth-Anmeldedaten.

token

object (TokenBased)

Tokenbasierte OAuth-Anmeldedaten.

Ende der sich gegenseitig ausschließenden Felder.

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

Erforderlich. Eine OAuth-Client-ID.

clientSecret

string

Erforderlich. 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

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

ThinkingMode

Denkweise des KI-Agenten.

Enums
THINKING_MODE_UNSPECIFIED Der Standardwert. Für BigQuery- und Looker-Datenquellen verwendet der KI-Agent FAST. Für alle anderen Datenquellen verwendet der Agent THINKING.
FAST Schnellmodus: Antworten werden schnell generiert.
THINKING Denkmodus, löst komplexe Probleme.

Modell

Modellauswahl für den Agenten für BigQuery-Nutzer.

Enums
MODEL_UNSPECIFIED Kein Modell angegeben. Es kann entweder ein Vorschaumodell oder ein Nicht-Vorschaumodell verwendet werden.
LATEST_GA_MODEL Verwenden Sie das aktuelle Modell, das keine Vorabversion ist. Dies kann bestimmte Einstellungen auf Anfrageebene einschränken.