REST Resource: projects.locations.apps.assistantSessions

Resource: AssistantSession

Sesi asisten mewakili percakapan antara pengguna dan agen asisten.

Representasi JSON 
{
  "name": string,
  "requestor": string,
  "messages": [
    {
      object (AssistantMessage)
    }
  ],
  "state": enum (AssistantSessionState),
  "createTime": string,
  "updateTime": string,
  "userResponseSuggestions": {
    object (UserResponseSuggestions)
  },
  "displayName": string,
  "artifacts": [
    {
      object (AssistantSessionArtifact)
    }
  ],
  "sessionCheckpoint": {
    object (SessionCheckpoint)
  },
  "activeTurn": {
    object (ActiveTurnInfo)
  },
  "touchedApps": [
    string
  ]
}
Kolom
name

string

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

string

Hanya output. Pengguna yang memulai sesi.
messages[]

object (AssistantMessage)

Opsional. Histori pesan dalam sesi.
state

enum (AssistantSessionState)

Hanya output. Status sesi asisten.
createTime

string (Timestamp format)

Hanya output. Waktu pembuatan sesi asisten.

Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Hanya output. Waktu sesi asisten terakhir diperbarui.

Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".
userResponseSuggestions

object (UserResponseSuggestions)

Hanya output. Respons pengguna yang disarankan dari agen asisten.
displayName

string

Opsional. Nama tampilan sesi asisten.
artifacts[]

object (AssistantSessionArtifact)

Hanya output. Artefak dokumen (misalnya, TDD yang dihasilkan dalam markdown) yang dihasilkan oleh asisten dalam sesi ini. Hanya pointer; konten file berada di bucket Cloud Storage pelanggan.
sessionCheckpoint

object (SessionCheckpoint)

Hanya output. Checkpoint sesi yang berisi niat pengguna dan ringkasan histori berkelanjutan.
activeTurn

object (ActiveTurnInfo)

Hanya output. Info lampiran untuk giliran yang sedang berjalan dalam sesi ini. Tidak disetel saat tidak ada giliran yang berjalan.
touchedApps[]

string

Hanya output. Aplikasi yang telah ditargetkan atau diubah oleh sesi ini (khusus sesi cakupan project), untuk tag histori. Format: projects/{project}/locations/{location}/apps/{app}

AssistantMessage

Pesan dalam sesi asisten.

Representasi JSON 
{
  "role": string,
  "chunks": [
    {
      object (AssistantChunk)
    }
  ],
  "eventTime": string,
  "attachedGcsUris": [
    string
  ]
}
Kolom
role

string

Wajib. Peran dalam percakapan "user" atau "model".
chunks[]

object (AssistantChunk)

Opsional. Konten pesan sebagai potongan.
eventTime

string (Timestamp format)

Wajib. Stempel waktu saat pesan dikirim atau diterima.

Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".
attachedGcsUris[]

string

Opsional. Cloud Storage URI untuk file yang diupload oleh pengguna selama giliran ini. Hal ini memungkinkan lampiran dipertahankan dan dirender di UI histori sesi. Contoh: "gs://cxas-transient-uploads/uuid/prd.pdf"

AssistantChunk

Sebagian data dalam pesan asisten.

Representasi JSON 
{
  "createTime": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "text": string,
  "thought": string,
  "payload": {
    object
  },
  "typedPayload": {
    object (TypedPayload)
  }
  // End of mutually exclusive fields.
}
Kolom
createTime

string (Timestamp format)

Opsional. Stempel waktu saat potongan dibuat atau dikeluarkan.

Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".
Data dalam potongan. Berikut adalah daftar kolom yang sama-sama bersifat eksklusif. Maksimal satu kolom akan ditetapkan dalam respons:
text

string

Opsional. Data teks.
thought

string

Opsional. Pemikiran yang dihasilkan oleh model.
payload

object (Struct format)

Opsional. Payload yang berisi respons terstruktur seperti laporan kualitas, nama versi agen, respons yang disarankan, dll.
typedPayload

object (TypedPayload)

Opsional. Payload yang diketik yang berisi respons terstruktur.
Akhir kolom yang saling eksklusif.

TypedPayload

Payload dengan jenis. Digunakan oleh histori asisten (AssistantChunk) dan oleh peristiwa typedPayload streaming; berada di sini karena assistant_service.proto dan session_service.proto membutuhkannya.

Representasi JSON 
{
  "displayName": string,
  "type": string,
  "value": {
    object
  },
  "metadata": {
    object
  }
}
Kolom
displayName

string

Wajib. Nama tampilan payload.
type

string

Wajib. Jenis payload.
value

object (Struct format)

Wajib. Nilai payload.
metadata

object (Struct format)

Opsional. Metadata payload.

AssistantSessionState

Status sesi asisten.

Enum
ASSISTANT_SESSION_STATE_UNSPECIFIED Nilai default. Nilai ini digunakan jika status tidak ditentukan.
PROCESSING Agen asisten memproses permintaan sebagai tugas yang berjalan lama.
IDLE Agen asisten tidak ada aktivitas dan tidak memiliki permintaan atau respons yang tertunda.
PENDING_REVIEW Agen asisten selesai memproses tugas yang berjalan lama dan memiliki respons yang siap untuk pengguna.

UserResponseSuggestions

Respons pengguna yang disarankan dari agen asisten.

Representasi JSON 
{
  "suggestions": [
    string
  ]
}
Kolom
suggestions[]

string

Wajib. Asisten menyarankan respons pengguna. Saran ini ditujukan bagi pengguna tentang cara berinteraksi dengan asisten.

AssistantSessionArtifact

Artefak dokumen yang dihasilkan oleh asisten dalam sesi, yang disimpan sebagai file di bucket Cloud Storage pelanggan.

Representasi JSON 
{
  "id": string,
  "displayName": string,
  "gcsUri": string,
  "mimeType": string,
  "createTime": string,
  "turnIndex": integer
}
Kolom
id

string

Hanya output. ID unik artefak dalam sesi.
displayName

string

Hanya output. Nama file yang ditampilkan kepada pengguna, misalnya "hotel_booking_tdd.md".
gcsUri

string

Hanya output. Objek Cloud Storage yang menyimpan konten artefak. Contoh: Contoh: "gs://{project}-agent-assist-artifacts/agent-assist-generated/1_tdd.md"
mimeType

string

Hanya output. Jenis media IANA dari konten artefak, misalnya "text/markdown".
createTime

string (Timestamp format)

Hanya output. Waktu artefak dipertahankan.

Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".
turnIndex

integer

Hanya output. Indeks pesan di [AssistantSession.messages] yang gilirannya menghasilkan artefak, untuk menempatkan chip artefak saat histori dipulihkan.

SessionCheckpoint

Checkpoint sesi yang berisi niat pengguna yang disimpulkan untuk judul sesi dan UI.

Representasi JSON 
{
  "userIntent": string
}
Kolom
userIntent

string

Sasaran atau topik pengguna yang disimpulkan untuk sesi tersebut (misalnya, "Membangun Agen Dukungan E-Commerce").

ActiveTurnInfo

Info lampiran langsung untuk giliran sesi yang saat ini berjalan, terputus dari kliennya, atau diparkir untuk diambil oleh tugas server lain.

Representasi JSON 
{
  "turnId": string,
  "status": enum (ActiveTurnInfo.Status),
  "startTime": string,
  "lastProgressTime": string,
  "orphanDeadlineTime": string
}
Kolom
turnId

string

Mengidentifikasi giliran; digemakan oleh snapshot resume di API streaming.
status

enum (ActiveTurnInfo.Status)

Status lampiran saat ini.
startTime

string (Timestamp format)

Hanya output. Saat giliran dimulai.

Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".
lastProgressTime

string (Timestamp format)

Hanya output. Kapan giliran terakhir mempertahankan progres.

Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".
orphanDeadlineTime

string (Timestamp format)

Hanya output. Kapan giliran akan dihentikan jika tidak ada klien yang terhubung.

Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".

ActiveTurnInfo.Status

Cara giliran yang berjalan saat ini terkait dengan tugas klien dan server.

Enum
STATUS_UNSPECIFIED Tidak ditentukan.
RUNNING Giliran sedang dijalankan dengan setidaknya satu klien yang terpasang.
DISCONNECTED Giliran sedang dieksekusi tanpa klien yang terpasang.
RESUMING Giliran diparkir untuk pengambilan: lampiran berikutnya akan melanjutkannya.
ABANDONED Lease server giliran telah berakhir dan tidak ada tugas yang menggerakkannya; pembacaan berikutnya akan menyegelnya ke parsial yang di-commit. Tidak dapat dipasang.

Metode

cancelAssistantTurn

 Membatalkan giliran yang sedang berlangsung dalam sesi asisten, jika ada: penghentian eksplisit oleh pengguna untuk giliran yang berjalan terpisah dari streaming mana pun.

create

 Membuat sesi asisten baru di aplikasi yang diberikan.

delete

 Menghapus sesi asisten yang ditentukan.

get

 Mendapatkan detail sesi asisten yang ditentukan.

list

 Mencantumkan semua sesi asisten di aplikasi tertentu.

streamChatAiAssistant

 Menjalankan Arc, asisten AI, untuk sesi asisten yang ditentukan dalam mode streaming.