REST Resource: projects.locations.collections.dataStores.sessions

Resource: Sesi

Definisi proto sesi eksternal.

Representasi JSON 
{
  "name": string,
  "displayName": string,
  "state": enum (State),
  "userPseudoId": string,
  "turns": [
    {
      object (Turn)
    }
  ],
  "labels": [
    string
  ],
  "startTime": string,
  "endTime": string,
  "isPinned": boolean
}
Kolom
name

string

Tidak dapat diubah. Nama yang memenuhi syarat sepenuhnya projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*
displayName

string

Opsional. Nama tampilan sesi.

Kolom ini digunakan untuk mengidentifikasi sesi di UI. Secara default, nama tampilan adalah teks kueri giliran pertama dalam sesi.
state

enum (State)

Status sesi.
userPseudoId

string

ID unik untuk melacak pengguna.
turns[]

object (Turn)

Giliran.
labels[]

string

Opsional. Label untuk sesi. Dapat ditetapkan sebagai filter di ListSessionsRequest.
startTime

string (Timestamp format)

Hanya output. Waktu sesi dimulai.

Menggunakan RFC 3339 yang outputnya akan selalu dikonversi ke format 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".
endTime

string (Timestamp format)

Hanya output. Waktu sesi selesai.

Menggunakan RFC 3339 yang outputnya akan selalu dikonversi ke format 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".
isPinned

boolean

Opsional. Apakah sesi disematkan atau tidak. Sesi yang disematkan akan ditampilkan di bagian atas daftar sesi.

Status

Enumerasi status sesi.

Enum
STATE_UNSPECIFIED Status tidak ditentukan.
IN_PROGRESS Sesi saat ini terbuka.

Giliran

Mewakili giliran, termasuk kueri dari pengguna dan jawaban dari layanan.

Representasi JSON 
{
  "query": {
    object (Query)
  },
  "answer": string,
  "assistAnswer": string,
  "detailedAnswer": {
    object (Answer)
  },
  "detailedAssistAnswer": {
    object (AssistAnswer)
  },
  "queryConfig": {
    string: string,
    ...
  }
}
Kolom
query

object (Query)

Opsional. Kueri pengguna. Mungkin tidak ditetapkan jika giliran ini hanya membuat ulang jawaban ke giliran yang berbeda
answer

string

Opsional. Nama resource jawaban untuk kueri pengguna.

Hanya ditetapkan jika pembuatan jawaban (panggilan API /answer) terjadi pada giliran ini.
assistAnswer

string

Hanya output. Nama resource jawaban Asisten untuk kueri pengguna.

Hanya ditetapkan jika panggilan bantuan (/assist API call) terjadi pada giliran ini.

Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assistAnswer}. Untuk mendapatkan semua AssistAnswer untuk sesi, tetapkan GetSessionRequest.include_answer_details ke benar (true). Atau, untuk mendapatkan resource AssistAnswer individual, gunakan AssistAnswerService.GetAssistAnswer API.
detailedAnswer

object (Answer)

Hanya output. Di ConversationalSearchService.GetSession API, jika GetSessionRequest.include_answer_details ditetapkan ke benar (true), kolom ini akan diisi saat mendapatkan sesi kueri jawaban.
detailedAssistAnswer

object (AssistAnswer)

Hanya output. Di ConversationalSearchService.GetSession API, jika GetSessionRequest.include_answer_details ditetapkan ke benar (true), kolom ini akan diisi saat mendapatkan sesi asisten.
queryConfig

map (key: string, value: string)

Opsional. Mewakili metadata terkait konfigurasi kueri, misalnya model dan versi LLM yang digunakan, parameter model (suhu, parameter grounding, dll.). Awalan "google." dicadangkan untuk fungsi yang dikembangkan Google.

Kueri

Menentukan kueri yang dimasukkan pengguna.

Representasi JSON 
{
  "queryId": string,

  // Union field content can be only one of the following:
  "text": string
  // End of list of possible types for union field content.
}
Kolom
queryId

string

Hanya output. ID unik untuk kueri.
Kolom union content. Konten kueri. content hanya dapat berupa salah satu dari berikut:
text

string

Teks biasa.

Metode

create

 Membuat Sesi.

delete

 Menghapus Sesi.

get

 Mendapatkan Sesi.

list

 Mencantumkan semua Sesi berdasarkan DataStore induknya.

patch

 Memperbarui Sesi.