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 sepenuhnya memenuhi syarat 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)

Belokan.
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 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".
endTime

string (Timestamp format)

Hanya output. Waktu sesi selesai.

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".
isPinned

boolean

Opsional. Apakah sesi disematkan, sesi yang disematkan akan ditampilkan di bagian atas daftar sesi.

Negara Bagian

Enumerasi status sesi.

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

Belok

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 disetel jika giliran ini hanya membuat ulang jawaban untuk giliran yang berbeda
answer

string

Opsional. Nama resource jawaban atas kueri pengguna.

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

string

Hanya output. Nama resource jawaban Asisten untuk kueri pengguna.

Hanya disetel jika panggilan bantuan (/panggilan API bantuan) 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 disetel 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 disetel ke benar (true), kolom ini akan diisi saat mendapatkan sesi asisten.
queryConfig

map (key: string, value: string)

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

Kueri

Menentukan kueri yang dimasukkan pengguna.

Representasi JSON 
{
  "queryId": string,
  "parts": [
    {
      object (QueryPart)
    }
  ],

  // 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.
parts[]

object (QueryPart)

Kueri bagian konten.
Kolom union content. Kueri konten. content hanya ada berupa salah satu diantara berikut:
text

string

Teks biasa.

QueryPart

Mewakili sebagian atau seluruh konten, digunakan untuk merepresentasikan kueri. Kueri dapat terdiri dari beberapa bagian.

Representasi JSON 
{
  "mimeType": string,

  // Union field payload can be only one of the following:
  "text": string,
  "uiJsonPayload": string,
  "personReference": {
    object (PersonReference)
  },
  "driveDocumentReference": {
    object (DriveDocumentReference)
  },
  "documentReference": {
    object (DocumentReference)
  }
  // End of list of possible types for union field payload.
}
Kolom
mimeType

string

Opsional. Jenis MIME standar IANA untuk data. Lihat https://www.iana.org/assignments/media-types/media-types.xhtml. Kolom ini bersifat opsional. Jika tidak disetel, jenis MIME default yang diasumsikan adalah "text/plain" untuk kolom "data".
Kolom union payload. Payload bagian kueri. payload hanya ada berupa salah satu diantara berikut:
text

string

Konten teks.
uiJsonPayload

string

Kolom ini diharapkan berupa pesan UI dalam format JSON. Mulai Kuartal 1 2026, uiJsonPayload hanya didukung untuk pesan A2UI.
personReference

object (PersonReference)

Referensi ke seseorang.
driveDocumentReference

object (DriveDocumentReference)

Referensi ke dokumen Google Drive.
documentReference

object (DocumentReference)

Referensi VAIS Document lainnya.

PersonReference

Mewakili referensi orang.

Representasi JSON 
{
  "documentName": string,
  "personId": string,
  "email": string,
  "displayName": string,
  "displayPhotoUri": string,
  "destinationUri": string,
  "fileId": string
}
Kolom
documentName

string

Nama lengkap resource orang. Format: projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*.
personId

string

ID orang yang bersangkutan.
email

string

Email orang tersebut.
displayName

string

Nama tampilan orang.
displayPhotoUri

string

URL foto tampilan orang tersebut.
destinationUri

string

URI tujuan orang tersebut.
fileId

string

Hanya output. ID file data orang yang disimpan dalam file konteks sesi.

DriveDocumentReference

Mewakili referensi dokumen Google Drive.

Representasi JSON 
{
  "driveId": string,
  "documentName": string,
  "displayTitle": string,
  "destinationUri": string,
  "iconUri": string,
  "fileId": string
}
Kolom
driveId

string

ID Drive dokumen.
documentName

string

Nama lengkap resource dokumen. Format: projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*.
displayTitle

string

Judul tampilan referensi.
destinationUri

string

URI tujuan referensi.
iconUri

string

URI ikon referensi dokumen Drive.
fileId

string

Hanya output. ID file data dokumen Drive yang disimpan dalam file konteks sesi.

DocumentReference

Menampilkan referensi dokumen.

Representasi JSON 
{
  "documentName": string,
  "displayTitle": string,
  "destinationUri": string,
  "iconUri": string,
  "fileId": string,
  "urlForConnector": string
}
Kolom
documentName

string

Nama lengkap resource dokumen. Format: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}/documents/{documentId}.
displayTitle

string

Judul tampilan referensi.
destinationUri

string

URI tujuan referensi.
iconUri

string

URI ikon referensi.
fileId

string

Hanya output. ID file data dokumen yang disimpan dalam file konteks sesi.
urlForConnector

string

Khusus input. urlForConnector dokumen yang ditampilkan oleh Penelusuran Gabungan.

Metode

create

 Membuat Sesi.

delete

 Menghapus Sesi.

get

 Mendapatkan Sesi.

list

 Mencantumkan semua Sesi menurut DataStore induknya.

patch

 Memperbarui Sesi.