Method: projects.locations.apps.runAssistant

Führt den KI-Agenten für die angegebene Assistentensitzung aus.

HTTP-Anfrage

POST https://ces.googleapis.com/v1beta/{app=projects/*/locations/*/apps/*}:runAssistant

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
app

string

Erforderlich. Die App, für die der Assistent ausgeführt werden soll. Format: projects/{project}/locations/{location}/apps/{app}

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung 
{
  "assistantSession": string,
  "message": {
    object (AssistantMessage)
  },
  "interactionType": enum (RunAssistantRequest.InteractionType)
}
Felder
assistantSession

string

Erforderlich. Die Assistentensitzung, die zum Ausführen des Assistenten verwendet werden soll. Format: projects/{project}/locations/{location}/apps/{app}/assistantSessions/{assistantSession}
message

object (AssistantMessage)

Erforderlich. Die Nachricht, die an den Assistant-Agenten gesendet werden soll.
interactionType

enum (RunAssistantRequest.InteractionType)

Optional. Verschiedene Interaktionstypen für die Assistant-Nachricht.

Antworttext

Antwortnachricht für AssistantService.RunAssistant.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung 
{
  "output": {
    object (AssistantOutput)
  },
  "state": enum (AssistantSessionState)
}
Felder
output

object (AssistantOutput)

Erforderlich. Die Ausgabe des Assistant-Agenten.
state

enum (AssistantSessionState)

Nur Ausgabe. Der Status der Assistentensitzung.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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

Weitere Informationen finden Sie unter Authentication Overview.

IAM-Berechtigungen

Erfordert die folgende IAM-Berechtigung für die Ressource app:

  • ces.apps.update

Weitere Informationen finden Sie in der IAM-Dokumentation.

RunAssistantRequest.InteractionType

Die Art der Interaktion für die an den Assistenten gesendete Nachricht.

Enums
INTERACTION_TYPE_UNSPECIFIED Der Standardwert. Dieser Wert wird verwendet, wenn der Typ nicht angegeben ist.
NEW_MESSAGE Die Nachricht ist eine Nutzereingabe. Die Nutzereingabe wird in der Chunk-Liste bereitgestellt.
POLL Die Nachricht dient zum Abfragen des Status der Assistant-Sitzung.
DISMISS Die Nachricht dient dazu, die ausstehende Überprüfung der Assistentensitzung zu verwerfen. Dadurch wird der Status der Assistant-Sitzung in „Inaktiv“ geändert.

AssistantOutput

Die Ausgabe des Assistant-Agenten.

JSON-Darstellung 
{
  "message": {
    object (AssistantMessage)
  },
  "userResponseSuggestions": {
    object (UserResponseSuggestions)
  }
}
Felder
message

object (AssistantMessage)

Erforderlich. Die Antwort des KI-Agenten.
userResponseSuggestions

object (UserResponseSuggestions)

Nur Ausgabe. Vorgeschlagene Nutzerantworten vom Assistant-Agenten.