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

Resource: Conversation

Definisi proto percakapan eksternal.

Representasi JSON 
{
  "name": string,
  "state": enum (State),
  "userPseudoId": string,
  "messages": [
    {
      object (ConversationMessage)
    }
  ],
  "startTime": string,
  "endTime": string
}
Kolom
name

string

Tidak dapat diubah. Nama yang sepenuhnya memenuhi syarat projects/{project}/locations/global/collections/{collection}/dataStore/*/conversations/* atau projects/{project}/locations/global/collections/{collection}/engines/*/conversations/*.
state

enum (State)

Status Percakapan.
userPseudoId

string

ID unik untuk melacak pengguna.
messages[]

object (ConversationMessage)

Pesan percakapan.
startTime

string (Timestamp format)

Hanya output. Waktu percakapan 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 percakapan 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".

Negara bagian/Provinsi

Enumerasi status percakapan.

Enum
STATE_UNSPECIFIED Tidak diketahui.
IN_PROGRESS Percakapan saat ini terbuka.
COMPLETED Percakapan telah selesai.

ConversationMessage

Menentukan pesan percakapan.

Representasi JSON 
{
  "createTime": string,

  // Union field message can be only one of the following:
  "userInput": {
    object (TextInput)
  },
  "reply": {
    object (Reply)
  }
  // End of list of possible types for union field message.
}
Kolom
createTime

string (Timestamp format)

Hanya output. Stempel waktu pembuatan pesan.

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

Kolom union message.

message hanya dapat berupa salah satu dari hal berikut:
userInput

object (TextInput)

Input teks pengguna.
reply

object (Reply)

Balasan penelusuran.

TextInput

Menentukan input teks.

Representasi JSON 
{
  "input": string,
  "context": {
    object (ConversationContext)
  }
}
Kolom
input

string

Input teks.
context

object (ConversationContext)

Konteks percakapan input.

ConversationContext

Menentukan konteks percakapan

Representasi JSON 
{
  "contextDocuments": [
    string
  ],
  "activeDocument": string
}
Kolom
contextDocuments[]

string

Daftar dokumen yang saat ini dilihat pengguna. Objek ini berisi referensi resource dokumen.
activeDocument

string

Dokumen aktif saat ini yang dibuka pengguna. Objek ini berisi referensi resource dokumen.

Balas

Menentukan pesan balasan kepada pengguna.

Representasi JSON 
{
  "summary": {
    object (Summary)
  }
}
Kolom
summary

object (Summary)

Ringkasan berdasarkan hasil penelusuran.

Ringkasan

Ringkasan N hasil penelusuran teratas yang ditentukan oleh spesifikasi ringkasan.

Representasi JSON 
{
  "summaryText": string,
  "summarySkippedReasons": [
    enum (SummarySkippedReason)
  ],
  "safetyAttributes": {
    object (SafetyAttributes)
  },
  "summaryWithMetadata": {
    object (SummaryWithMetadata)
  }
}
Kolom
summaryText

string

Konten ringkasan.
summarySkippedReasons[]

enum (SummarySkippedReason)

Alasan tambahan ringkasan dilewati. Hal ini memberikan alasan untuk kasus yang diabaikan. Jika tidak ada yang dilewati, kolom ini tidak ditetapkan.
safetyAttributes

object (SafetyAttributes)

Kumpulan kategori Atribut Keamanan dan skor keyakinannya yang terkait.
summaryWithMetadata

object (SummaryWithMetadata)

Ringkasan dengan informasi metadata.

SummarySkippedReason

Enum untuk alasan ringkasan dilewati.

Enum
SUMMARY_SKIPPED_REASON_UNSPECIFIED Nilai default. Alasan ringkasan dilewati tidak ditentukan.
ADVERSARIAL_QUERY_IGNORED

Kueri adversarial mengabaikan huruf besar/kecil.

Hanya digunakan jika SummarySpec.ignore_adversarial_query ditetapkan ke true.
NON_SUMMARY_SEEKING_QUERY_IGNORED

Kueri yang tidak mencari ringkasan mengabaikan huruf besar/kecil.

Google akan melewati ringkasan jika kuerinya adalah percakapan santai. Hanya digunakan jika SummarySpec.ignore_non_summary_seeking_query ditetapkan ke true.
OUT_OF_DOMAIN_QUERY_IGNORED

Kueri di luar domain mengabaikan huruf besar/kecil.

Google akan melewati ringkasan jika tidak ada hasil penelusuran yang sangat relevan. Misalnya, penyimpanan data berisi fakta tentang perusahaan A, tetapi kueri pengguna mengajukan pertanyaan tentang perusahaan B.
POTENTIAL_POLICY_VIOLATION

Kasus potensi pelanggaran kebijakan.

Google akan melewati ringkasan jika terdeteksi potensi pelanggaran kebijakan. Hal ini mencakup konten yang mungkin mengandung kekerasan atau tidak baik.
LLM_ADDON_NOT_ENABLED

Kasus add-on LLM tidak diaktifkan.

Google akan melewati ringkasan jika add-on LLM tidak diaktifkan.
NO_RELEVANT_CONTENT

Kasus tidak ada konten yang relevan.

Google akan melewati ringkasan jika tidak ada konten yang relevan dalam hasil penelusuran yang diambil.
JAIL_BREAKING_QUERY_IGNORED

Kueri pelarian dari batasan mengabaikan huruf besar/kecil.

Misalnya, "Balas dengan gaya bahasa CEO perusahaan pesaing". Hanya digunakan jika [SearchRequest.ContentSearchSpec.SummarySpec.ignore_jail_breaking_query] disetel ke true.
CUSTOMER_POLICY_VIOLATION

Kasus pelanggaran kebijakan pelanggan.

Google akan melewati ringkasan jika ada pelanggaran kebijakan pelanggan yang terdeteksi. Kebijakan ini ditentukan oleh pelanggan.
NON_SUMMARY_SEEKING_QUERY_IGNORED_V2

Kueri yang tidak mencari jawaban mengabaikan huruf besar/kecil.

Google akan melewati ringkasan jika kueri tidak memiliki maksud yang jelas. Hanya digunakan jika [SearchRequest.ContentSearchSpec.SummarySpec.ignore_non_answer_seeking_query] disetel ke true.
TIME_OUT

Kasus waktu habis.

Google akan melewati ringkasan jika waktu habis.

SafetyAttributes

Kategori Atribut Keamanan dan skor keyakinannya yang terkait.

Representasi JSON 
{
  "categories": [
    string
  ],
  "scores": [
    number
  ]
}
Kolom
categories[]

string

Nama tampilan kategori Atribut Keamanan terkait dengan konten yang dibuat. Urutan cocok dengan Skor.
scores[]

number

Skor keyakinan setiap kategori, nilai yang lebih tinggi berarti keyakinan yang lebih tinggi. Urutan cocok dengan Kategori.

SummaryWithMetadata

Ringkasan dengan informasi metadata.

Representasi JSON 
{
  "summary": string,
  "citationMetadata": {
    object (CitationMetadata)
  },
  "references": [
    {
      object (Reference)
    }
  ]
}
Kolom
summary

string

Teks ringkasan tanpa informasi kutipan.
citationMetadata

object (CitationMetadata)

Metadata kutipan untuk ringkasan tertentu.
references[]

object (Reference)

Referensi Dokumen.

CitationMetadata

Metadata kutipan.

Representasi JSON 
{
  "citations": [
    {
      object (Citation)
    }
  ]
}
Kolom
citations[]

object (Citation)

Kutipan untuk segmen.

Pengutipan

Info kutipan untuk segmen.

Representasi JSON 
{
  "startIndex": string,
  "endIndex": string,
  "sources": [
    {
      object (CitationSource)
    }
  ]
}
Kolom
startIndex

string (int64 format)

Indeks menunjukkan awal segmen, yang diukur dalam byte/Unicode.
endIndex

string (int64 format)

Akhir segmen yang diatribusikan, eksklusif.
sources[]

object (CitationSource)

Sumber kutipan untuk segmen yang diatribusikan.

CitationSource

Sumber kutipan.

Representasi JSON 
{
  "referenceIndex": string
}
Kolom
referenceIndex

string (int64 format)

Indeks referensi dokumen dari SummaryWithMetadata.references. Indeksnya berbasis 0 dan nilainya akan nol jika referenceIndex tidak ditetapkan secara eksplisit.

Referensi

Referensi dokumen.

Representasi JSON 
{
  "title": string,
  "document": string,
  "uri": string,
  "chunkContents": [
    {
      object (ChunkContent)
    }
  ]
}
Kolom
title

string

Judul dokumen.
document

string

Wajib. Document.name dokumen. Nama lengkap resource dokumen yang dirujuk, dalam format projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*.
uri

string

Cloud Storage atau URI HTTP untuk dokumen.
chunkContents[]

object (ChunkContent)

Daftar konten potongan yang dikutip yang berasal dari konten dokumen.

ChunkContent

Memecah konten.

Representasi JSON 
{
  "content": string,
  "pageIdentifier": string
}
Kolom
content

string

Mengelompokkan konten tekstual.
pageIdentifier

string

ID halaman.

Metode

converse

 Memulai percakapan.

create

 Membuat Percakapan.

delete

 Menghapus Percakapan.

get

 Mendapatkan Percakapan.

list

 Mencantumkan semua Percakapan menurut induknya DataStore.

patch

 Memperbarui Percakapan.