Method: projects.locations.apps.sessions.runSession

Memulai interaksi satu giliran dengan agen CES dalam satu sesi.

Permintaan HTTP

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

URL menggunakan sintaks gRPC Transcoding.

Parameter jalur

Parameter
config.session

string

Wajib. ID unik sesi. Format: projects/{project}/locations/{location}/apps/{app}/sessions/{session}

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON 
{
  "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)
    }
  ]
}
Kolom
config.inputAudioConfig

object (InputAudioConfig)

Opsional. Konfigurasi untuk memproses audio input.
config.outputAudioConfig

object (OutputAudioConfig)

Opsional. Konfigurasi untuk membuat audio output.
config.historicalContexts[]

object (Message)

Opsional. Konteks historis sesi, termasuk input pengguna, respons agen, dan pesan lainnya. Biasanya, agen CES akan mengelola sesi secara otomatis sehingga klien tidak perlu mengisi kolom ini secara eksplisit. Namun, klien dapat secara opsional mengganti konteks historis untuk memaksa sesi dimulai dari status tertentu.
config.entryAgent

string

Opsional. Agen entri untuk menangani sesi. Jika tidak ditentukan, sesi akan ditangani oleh root agent aplikasi. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
config.deployment

string

Opsional. Deployment aplikasi yang akan digunakan untuk sesi. Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
config.timeZone

string

Opsional. Zona waktu pengguna. Jika disediakan, agen akan menggunakan zona waktu untuk variabel terkait tanggal dan waktu. Jika tidak, agen akan menggunakan zona waktu yang ditentukan di App.time_zone_settings.

Formatnya adalah zona waktu Database Zona Waktu IANA, misalnya "America/Los_Angeles".
config.useToolFakes

boolean

Opsional. Apakah akan menggunakan alat palsu untuk sesi. Jika kolom ini ditetapkan, agen akan mencoba menggunakan alat palsu, bukan memanggil alat yang sebenarnya.
config.remoteDialogflowQueryParameters

object (SessionConfig.RemoteDialogflowQueryParameters)

Opsional. QueryParameters untuk dikirim ke agen Dialogflow jarak jauh saat kontrol sesi ditransfer ke agen jarak jauh.
config.enableTextStreaming

boolean

Opsional. Apakah akan menstreaming output teks dari model ke klien secara inkremental saat dibuat. Nilai defaultnya adalah false.

  • Jika dinonaktifkan, output teks model akan di-buffer, dan setiap output teks yang dikirim ke klien adalah kalimat lengkap. Klien dapat merender setiap output teks pada baris baru.
  • Jika diaktifkan, setiap output teks hanya boleh berisi bagian dari kalimat. Klien harus menggabungkan output teks yang berurutan untuk merender respons lengkap.

CATATAN: Fitur ini hanya didukung untuk sesi teks (non-suara) yang menggunakan sessions.streamRunSession atau BidiRunSession.
config.includeLlmThoughtSummary

boolean

Opsional. Apakah akan menyertakan ringkasan pemikiran LLM dalam output sesi.
config.excludeDiagnosticInfo

boolean

Opsional. Apakah akan mengecualikan info diagnostik dari output sesi.
config.includeProgressUpdate

boolean

Opsional. Apakah akan menyertakan update pemrosesan perantara ke klien. Jika diaktifkan, update akan dikirim kembali dalam SessionOutput.progress.
inputs[]

object (SessionInput)

Wajib. Input untuk sesi.

Isi respons

Jika berhasil, isi respons akan memuat instance RunSessionResponse.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

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

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.

Izin IAM

Memerlukan izin IAM berikut pada resource session:

  • ces.sessions.runSession

Untuk mengetahui informasi selengkapnya, baca dokumentasi IAM.