Method: projects.locations.apps.sessions.runSession

Initiiert eine einstufige Interaktion mit dem CES-Agenten innerhalb einer Sitzung.

HTTP-Anfrage

POST https://ces.googleapis.com/v1/{config.session=projects/*/locations/*/apps/*/sessions/*}:runSession

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
config.session

string

Erforderlich. Die eindeutige Kennung der Sitzung. Format: projects/{project}/locations/{location}/apps/{app}/sessions/{session}

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung 
{
  "config": {
    "session": string,
    "inputAudioConfig": {
      "audioEncoding": enum (AudioEncoding),
      "sampleRateHertz": integer,
      "noiseSuppressionLevel": string
    },
    "outputAudioConfig": {
      "audioEncoding": enum (AudioEncoding),
      "sampleRateHertz": integer
    },
    "historicalContexts": [
      {
        "role": string,
        "chunks": [
          {
            object (Chunk)
          }
        ],
        "eventTime": string
      }
    ],
    "entryAgent": string,
    "deployment": string,
    "timeZone": string,
    "useToolFakes": boolean,
    "remoteDialogflowQueryParameters": {
      "webhookHeaders": {
        string: string,
        ...
      },
      "payload": {
        object
      },
      "endUserMetadata": {
        object
      }
    },
    "enableTextStreaming": boolean,
    "includeLlmThoughtSummary": boolean,
    "excludeDiagnosticInfo": boolean,
    "includeProgressUpdate": boolean
  },
  "inputs": [
    {
      object (SessionInput)
    }
  ]
}
Felder
config.inputAudioConfig

object (InputAudioConfig)

Optional. Konfiguration für die Verarbeitung des Eingabeaudios.
config.outputAudioConfig

object (OutputAudioConfig)

Optional. Konfiguration zum Generieren des Ausgabeaudios.
config.historicalContexts[]

object (Message)

Optional. Der historische Kontext der Sitzung, einschließlich Nutzereingaben, Agent-Antworten und anderer Nachrichten. In der Regel verwaltet der CES-Agent die Sitzung automatisch, sodass der Client dieses Feld nicht explizit ausfüllen muss. Der Client kann die historischen Kontexte jedoch optional überschreiben, um die Sitzung von einem bestimmten Status aus zu starten.
config.entryAgent

string

Optional. Der Einstiegs-Agent, der die Sitzung verarbeitet. Wenn keine Angabe erfolgt, wird die Sitzung von der root agent der Anwendung verarbeitet. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
config.deployment

string

Optional. Die Bereitstellung der Anwendung, die für die Sitzung verwendet werden soll. Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
config.timeZone

string

Optional. Die Zeitzone des Nutzers. Wenn angegeben, verwendet der KI-Agent die Zeitzone für datums- und zeitbezogene Variablen. Andernfalls verwendet der Agent die in „App.time_zone_settings“ angegebene Zeitzone.

Das Format ist die Zeitzone aus der IANA-Zeitzonendatenbank, z.B. „America/Los_Angeles“.
config.useToolFakes

boolean

Optional. Gibt an, ob Tool-Fakes für die Sitzung verwendet werden sollen. Wenn dieses Feld festgelegt ist, versucht der Agent, Tool-Fakes zu verwenden, anstatt die echten Tools aufzurufen.
config.remoteDialogflowQueryParameters

object (SessionConfig.RemoteDialogflowQueryParameters)

Optional. QueryParameters, die an den Remote-Dialogflow-Agenten gesendet werden, wenn die Sitzungssteuerung an den Remote-Agenten übertragen wird.
config.enableTextStreaming

boolean

Optional. Gibt an, ob die Textausgabe des Modells inkrementell an den Client gestreamt werden soll, während sie generiert wird. Die Standardeinstellung ist false.

  • Wenn diese Option deaktiviert ist, wird die Textausgabe des Modells zwischengespeichert und jede an den Client gesendete Textausgabe ist ein vollständiger Satz. Clients können jede Textausgabe in einer neuen Zeile rendern.
  • Wenn diese Option aktiviert ist, enthält jede Textausgabe möglicherweise nur einen Teil eines Satzes. Clients sollten aufeinanderfolgende Textausgaben verketten, um die vollständige Antwort zu rendern.

HINWEIS: Dies wird nur für Text-Sitzungen (nicht für Sprach-Sitzungen) mit sessions.streamRunSession oder BidiRunSession unterstützt.
config.includeLlmThoughtSummary

boolean

Optional. Gibt an, ob Zusammenfassungen der LLM-Gedanken in die Sitzungsausgaben aufgenommen werden sollen.
config.excludeDiagnosticInfo

boolean

Optional. Gibt an, ob Diagnoseinformationen aus der Sitzungsausgabe ausgeschlossen werden sollen.
config.includeProgressUpdate

boolean

Optional. Gibt an, ob ein Zwischenverarbeitungsupdate an den Client gesendet werden soll. Wenn diese Option aktiviert ist, wird das Update in SessionOutput.progress zurückgesendet.
inputs[]

object (SessionInput)

Erforderlich. Eingaben für die Sitzung.

Antworttext

Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext eine Instanz von RunSessionResponse.

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 session:

  • ces.sessions.runSession

Weitere Informationen finden Sie in der IAM-Dokumentation.