Package google.cloud.discoveryengine.v1

QueryClassificationInfo

Waktu saat pencarian ulang terbaru ini terjadi.

score

double

Skor setiap saran. Skor berada dalam rentang [0, 1].

AdvancedSiteSearchConfig

Data konfigurasi untuk penelusuran situs lanjutan.

Kolom

disable_initial_index

bool

Jika disetel ke benar (true), pengindeksan awal dinonaktifkan untuk DataStore.

disable_automatic_refresh

bool

Jika disetel ke benar (true), refresh otomatis akan dinonaktifkan untuk DataStore.

AlertPolicyConfig

Konfigurasi pemberitahuan tingkat konektor.

Kolom

alert_policy_name

string

Tidak dapat diubah. Nama resource AlertPolicy yang sepenuhnya memenuhi syarat.

alert_enrollments[]

AlertEnrollment

Opsional. Status pendaftaran setiap pemberitahuan.

AlertEnrollment

Status pendaftaran notifikasi.

Kolom

alert_id

string

Tidak dapat diubah. ID pemberitahuan.

enroll_state

EnrollStates

Wajib. Status pendaftaran pelanggan.

EnrollStates

Enum status pendaftaran untuk notifikasi.

Enum
`ENROLL_STATES_UNSPECIFIED`	Nilai default. Digunakan untuk pelanggan yang belum merespons kebijakan pemberitahuan.
`ENROLLED`	Pelanggan terdaftar dalam kebijakan ini.
`DECLINED`	Pelanggan menolak kebijakan ini.

AlertPolicyResourceConfig

Konfigurasi pemberitahuan tingkat resource. Digunakan di: * UserLicense * EngineUserData AlertPolicyConfig di konektor data memiliki penggunaan yang sama. Tidak ada cara mudah untuk bermigrasi.

Kolom
`alert_policy`	`string` Tidak dapat diubah. Nama resource AlertPolicy yang sepenuhnya memenuhi syarat.
`alert_enrollments[]`	`AlertEnrollment` Opsional. Status pendaftaran setiap pemberitahuan.
`contact_details[]`	`ContactDetails` Opsional. Detail kontak untuk setiap kebijakan pemberitahuan.
`language_code`	`string` Opsional. Kode bahasa yang digunakan untuk notifikasi

AlertEnrollment

Status pendaftaran notifikasi.

Kolom

alert_id

string

Tidak dapat diubah. ID pemberitahuan.

enroll_state

EnrollState

Wajib. Status pendaftaran pelanggan.

notification_params

map<string, string>

Opsional. Parameter yang digunakan untuk membuat instance notifikasi. Digunakan untuk notifikasi yang dipicu saat didaftarkan. Tidak disimpan. * Email selamat datang Gemini Business. * Email undangan pengguna Gemini Business.

EnrollState

Enum status pendaftaran untuk notifikasi.

Enum
`ENROLL_STATE_UNSPECIFIED`	Nilai default. Digunakan untuk pelanggan yang belum merespons kebijakan pemberitahuan.
`ENROLLED`	Pelanggan terdaftar dalam kebijakan ini.
`DECLINED`	Pelanggan menolak kebijakan ini.

AlloyDbSource

Data impor sumber AlloyDB dari.

Kolom
`project_id`	`string` Project ID yang berisi sumber AlloyDB. Memiliki batas panjang 128 karakter. Jika tidak ditentukan, akan mewarisi project ID dari permintaan induk.
`location_id`	`string` Wajib. Lokasi AlloyDB untuk menyalin data dari dengan batas panjang 256 karakter.
`cluster_id`	`string` Wajib. Cluster AlloyDB untuk menyalin data dengan batas panjang 256 karakter.
`database_id`	`string` Wajib. Database AlloyDB untuk menyalin data dari dengan batas panjang 256 karakter.
`table_id`	`string` Wajib. Tabel AlloyDB untuk menyalin data dengan batas panjang 256 karakter.
`gcs_staging_dir`	`string` Direktori Cloud Storage perantara yang digunakan untuk impor dengan batas panjang 2.000 karakter. Dapat ditentukan jika seseorang ingin mengekspor AlloyDB ke direktori Cloud Storage tertentu. Pastikan akun layanan AlloyDB memiliki izin Admin Cloud Storage yang diperlukan untuk mengakses direktori Cloud Storage yang ditentukan.

Jawaban

Menentukan jawaban.

Kolom
`name`	`string` Tidak dapat diubah. Nama yang sepenuhnya memenuhi syarat `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions//answers/`
`state`	`State` Status pembuatan jawaban.
`answer_text`	`string` Jawaban tekstual.
`citations[]`	`Citation` Kutipan.
`grounding_supports[]`	`GroundingSupport` Opsional. Dukungan perujukan.
`references[]`	`Reference` Referensi.
`related_questions[]`	`string` Pertanyaan terkait yang disarankan.
`steps[]`	`Step` Langkah-langkah pembuatan jawaban.
`query_understanding_info`	`QueryUnderstandingInfo` Informasi pemahaman kueri.
`answer_skipped_reasons[]`	`AnswerSkippedReason` Alasan tambahan jawaban dilewati. Hal ini memberikan alasan untuk kasus yang diabaikan. Jika tidak ada yang dilewati, kolom ini tidak ditetapkan.
`create_time`	`Timestamp` Hanya output. Stempel waktu pembuatan jawaban.
`complete_time`	`Timestamp` Hanya output. Stempel waktu penyelesaian jawaban.
`safety_ratings[]`	`SafetyRating` Opsional. Peringkat keselamatan.
`grounding_score`	`double` Skor dalam rentang [0, 1] yang menjelaskan seberapa kuat jawaban didasarkan pada potongan referensi.

AnswerSkippedReason

Enum untuk alasan jawaban dilewati.

Enum
`ANSWER_SKIPPED_REASON_UNSPECIFIED`	Nilai default. Alasan melewati jawaban tidak ditentukan.
`ADVERSARIAL_QUERY_IGNORED`	Kueri adversarial mengabaikan huruf besar/kecil.
`NON_ANSWER_SEEKING_QUERY_IGNORED`	Kueri mencari non-jawaban mengabaikan huruf besar/kecil Google akan melewati jawaban jika kuerinya adalah percakapan santai.
`OUT_OF_DOMAIN_QUERY_IGNORED`	Kueri di luar domain mengabaikan huruf besar/kecil. Google akan melewati jawaban jika tidak ada hasil penelusuran yang sangat relevan.
`POTENTIAL_POLICY_VIOLATION`	Kasus potensi pelanggaran kebijakan. Google akan melewati jawaban jika terdeteksi potensi pelanggaran kebijakan. Hal ini mencakup konten yang mungkin mengandung kekerasan atau tidak baik.
`NO_RELEVANT_CONTENT`	Kasus tidak ada konten yang relevan. Google akan melewati jawaban 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". Google akan melewati jawaban jika kueri diklasifikasikan sebagai kueri pelarian dari batasan.
`CUSTOMER_POLICY_VIOLATION`	Kasus pelanggaran kebijakan pelanggan. Google akan melewati ringkasan jika ada pelanggaran kebijakan pelanggan yang terdeteksi. Kebijakan ini ditentukan oleh pelanggan.
`NON_ANSWER_SEEKING_QUERY_IGNORED_V2`	Kueri yang tidak mencari jawaban mengabaikan huruf besar/kecil. Google akan melewati jawaban jika kueri tidak memiliki maksud yang jelas.
`LOW_GROUNDED_ANSWER`	Kasus jawaban yang tidak berdasar. Google akan melewati jawaban jika jawaban yang memiliki rujukan kuat tidak dapat dibuat.
`USER_DEFINED_CLASSIFICATION_QUERY_IGNORED`	Klasifikasi kueri yang ditentukan pengguna mengabaikan huruf besar/kecil. Google akan melewati jawaban jika kueri diklasifikasikan sebagai klasifikasi kueri yang ditentukan pengguna.
`UNHELPFUL_ANSWER`	Kasus jawaban yang tidak membantu. Google akan melewati jawaban jika jawaban tersebut tidak membantu. Hal ini dapat disebabkan oleh berbagai faktor, termasuk, tetapi tidak terbatas pada: kueri tidak dapat dijawab, jawaban tidak relevan dengan kueri, atau jawaban tidak diformat dengan baik.

Pengutipan

Info kutipan untuk segmen.

Kolom

start_index

int64

Indeks menunjukkan awal segmen, diukur dalam byte (Unicode UTF-8). Jika ada karakter multi-byte,seperti karakter non-ASCII, pengukuran indeks lebih panjang daripada panjang string.

end_index

int64

Akhir segmen yang diatribusikan, eksklusif. Diukur dalam byte (Unicode UTF-8). Jika ada karakter multi-byte,seperti karakter non-ASCII, pengukuran indeks lebih panjang daripada panjang string.

sources[]

CitationSource

Sumber kutipan untuk segmen yang diatribusikan.

CitationSource

Sumber kutipan.

Kolom

reference_id

string

ID sumber kutipan.

GroundingSupport

Dukungan perujukan untuk klaim di answer_text.

Kolom
`start_index`	`int64` Wajib. Indeks menunjukkan awal klaim, diukur dalam byte (Unicode UTF-8).
`end_index`	`int64` Wajib. Akhir klaim, eksklusif.
`sources[]`	`CitationSource` Opsional. Sumber kutipan untuk klaim.
`grounding_score`	`double` Skor dalam rentang [0, 1] yang menjelaskan seberapa kuat klaim tertentu didukung oleh referensi. Nilai yang lebih tinggi berarti klaim lebih didukung oleh potongan referensi.
`grounding_check_required`	`bool` Menunjukkan bahwa klaim ini memerlukan pemeriksaan perujukan. Jika sistem memutuskan bahwa klaim ini tidak memerlukan pemeriksaan perujukan/perujukan, kolom ini disetel ke salah (false). Dalam hal ini, tidak ada pemeriksaan perujukan yang dilakukan untuk klaim tersebut, sehingga `grounding_score`, `sources` tidak ditampilkan.

QueryUnderstandingInfo

Informasi pemahaman kueri.

Kolom

query_classification_info[]

Informasi klasifikasi kueri.

QueryClassificationInfo

Informasi klasifikasi kueri.

Kolom

type

Type

Jenis klasifikasi kueri.

positive

bool

Output klasifikasi.

Jenis

Jenis klasifikasi kueri.

Enum
`TYPE_UNSPECIFIED`	Jenis klasifikasi kueri tidak ditentukan.
`ADVERSARIAL_QUERY`	Jenis klasifikasi kueri adversarial.
`NON_ANSWER_SEEKING_QUERY`	Jenis klasifikasi kueri yang tidak mencari jawaban, untuk percakapan santai.
`JAIL_BREAKING_QUERY`	Jenis klasifikasi kueri pelarian dari batasan.
`NON_ANSWER_SEEKING_QUERY_V2`	Jenis klasifikasi kueri non-pencarian jawaban, tanpa maksud yang jelas.
`USER_DEFINED_CLASSIFICATION_QUERY`	Jenis klasifikasi kueri yang ditentukan pengguna.

Referensi

Referensi.

Kolom
Kolom union `content`. Konten hasil penelusuran. `content` hanya ada berupa salah satu diantara berikut:
`unstructured_document_info`	`UnstructuredDocumentInfo` Informasi dokumen tidak terstruktur.
`chunk_info`	`ChunkInfo` Informasi bagian.
`structured_document_info`	`StructuredDocumentInfo` Informasi dokumen terstruktur.

ChunkInfo

Informasi bagian.

Kolom
`chunk`	`string` Nama resource chunk.
`content`	`string` Mengelompokkan konten tekstual.
`document_metadata`	`DocumentMetadata` Metadata dokumen.
`relevance_score`	`float` Relevansi potongan untuk kueri tertentu. Nilai berkisar dari 0,0 (sama sekali tidak relevan) hingga 1,0 (sangat relevan). Nilai ini hanya untuk tujuan informasi. Nilai ini dapat berubah untuk kueri dan potongan yang sama kapan saja karena pelatihan ulang model atau perubahan dalam penerapan.

DocumentMetadata

Metadata dokumen.

Kolom
`document`	`string` Nama resource dokumen.
`uri`	`string` URI untuk dokumen.
`title`	`string` Judul.
`page_identifier`	`string` ID halaman.
`struct_data`	`Struct` Metadata JSON terstruktur untuk dokumen. Kolom ini diisi dari data struct dari Chunk di hasil penelusuran.

StructuredDocumentInfo

Informasi penelusuran terstruktur.

Kolom
`document`	`string` Nama resource dokumen.
`struct_data`	`Struct` Data penelusuran terstruktur.
`title`	`string` Hanya output. Judul dokumen.
`uri`	`string` Hanya output. URI dokumen.

UnstructuredDocumentInfo

Informasi dokumen tidak terstruktur.

Kolom
`document`	`string` Nama resource dokumen.
`uri`	`string` URI untuk dokumen.
`title`	`string` Judul.
`chunk_contents[]`	`ChunkContent` Daftar konten potongan yang dikutip yang berasal dari konten dokumen.
`struct_data`	`Struct` Metadata JSON terstruktur untuk dokumen. Kolom ini diisi dari data struct dari Chunk di hasil penelusuran.

ChunkContent

Memecah konten.

Kolom

content

string

Mengelompokkan konten tekstual.

page_identifier

string

ID halaman.

relevance_score

float

Relevansi potongan untuk kueri tertentu. Nilai berkisar dari 0,0 (sama sekali tidak relevan) hingga 1,0 (sangat relevan). Nilai ini hanya untuk tujuan informasi. Nilai ini dapat berubah untuk kueri dan potongan yang sama kapan saja karena pelatihan ulang model atau perubahan dalam penerapan.

Negara bagian/Provinsi

Enumerasi status pembuatan jawaban.

Enum
`STATE_UNSPECIFIED`	Tidak diketahui.
`IN_PROGRESS`	Pembuatan jawaban sedang berlangsung.
`FAILED`	Pembuatan jawaban saat ini gagal.
`SUCCEEDED`	Pembuatan jawaban berhasil.
`STREAMING`	Pembuatan jawaban sedang berlangsung.

Langkah

Informasi langkah.

Kolom
`state`	`State` Status langkah.
`description`	`string` Deskripsi langkah.
`thought`	`string` Pemikiran tentang langkah.
`actions[]`	`Action` Tindakan.

Tindakan

Tindakan.

Kolom

observation

Observation

Pengamatan.

Kolom union action. Tindakan. action hanya ada berupa salah satu diantara berikut:

search_action

SearchAction

Tindakan penelusuran.

Pengamatan

Pengamatan.

Kolom

search_results[]

SearchResult

Hasil penelusuran yang diamati oleh tindakan penelusuran, dapat berupa info cuplikan atau info bagian, bergantung pada jenis kutipan yang ditetapkan oleh pengguna.

SearchResult

Kolom
`document`	`string` Nama resource dokumen.
`uri`	`string` URI untuk dokumen.
`title`	`string` Judul.
`snippet_info[]`	`SnippetInfo` Jika citation_type adalah DOCUMENT_LEVEL_CITATION, isi cuplikan tingkat dokumen.
`chunk_info[]`	`ChunkInfo` Jika citation_type adalah CHUNK_LEVEL_CITATION dan mode chunk aktif, isi info chunk.
`struct_data`	`Struct` Representasi data. Data JSON terstruktur untuk dokumen. Bagian ini diisi dari data struct dari Dokumen, atau Chunk dalam hasil penelusuran.

ChunkInfo

Informasi bagian.

Kolom

chunk

string

Nama resource chunk.

content

string

Mengelompokkan konten tekstual.

relevance_score

float

SnippetInfo

Informasi cuplikan.

Kolom

snippet

string

Konten cuplikan.

snippet_status

string

Status cuplikan yang ditentukan oleh tim penelusuran.

SearchAction

Tindakan penelusuran.

Kolom

query

string

Kueri yang akan ditelusuri.

Negara bagian/Provinsi

Enumerasi status langkah.

Enum
`STATE_UNSPECIFIED`	Tidak diketahui.
`IN_PROGRESS`	Langkah sedang berlangsung.
`FAILED`	Langkah saat ini gagal.
`SUCCEEDED`	Langkah berhasil.

AnswerGenerationSpec

Spesifikasi untuk pembuatan jawaban.

Kolom

user_defined_classifier_spec

UserDefinedClassifierSpec

Opsional. Spesifikasi untuk spesifikasi pengklasifikasi yang ditentukan pengguna.

UserDefinedClassifierSpec

Spesifikasi untuk pengklasifikasi buatan pengguna.

Kolom
`enable_user_defined_classifier`	`bool` Opsional. Apakah akan mengaktifkan dan menyertakan pengklasifikasi yang ditentukan pengguna atau tidak.
`preamble`	`string` Opsional. Pengantar yang akan digunakan untuk pengklasifikasi yang ditentukan pengguna.
`model_id`	`string` Opsional. ID model yang akan digunakan untuk pengklasifikasi yang ditentukan pengguna.
`task_marker`	`string` Opsional. Penanda tugas yang akan digunakan untuk pengklasifikasi yang ditentukan pengguna.
`top_p`	`double` Opsional. Nilai top-p yang akan digunakan untuk pengklasifikasi yang ditentukan pengguna.
`top_k`	`int64` Opsional. Nilai top-k yang akan digunakan untuk pengklasifikasi yang ditentukan pengguna.
`temperature`	`double` Opsional. Nilai suhu yang akan digunakan untuk pengklasifikasi yang ditentukan pengguna.
`seed`	`int32` Opsional. Nilai seed yang akan digunakan untuk pengklasifikasi yang ditentukan pengguna.

AnswerQueryRequest

Pesan permintaan untuk metode ConversationalSearchService.AnswerQuery.

Kolom
`serving_config`	`string` Wajib. Nama resource konfigurasi penayangan Search, seperti `projects//locations/global/collections/default_collection/engines//servingConfigs/default_serving_config`, atau `projects//locations/global/collections/default_collection/dataStores//servingConfigs/default_serving_config`. Kolom ini digunakan untuk mengidentifikasi nama konfigurasi penayangan, kumpulan model yang digunakan untuk melakukan penelusuran.
`query`	`Query` Wajib. Kueri pengguna saat ini.
`session`	`string` Nama resource sesi. Tidak diperlukan. Jika kolom sesi tidak disetel, API berada dalam mode tanpa sesi. Kami mendukung mode sesi otomatis: pengguna dapat menggunakan simbol pengganti `-` sebagai ID sesi. ID baru akan otomatis dibuat dan ditetapkan.
`safety_spec`	`SafetySpec` Spesifikasi model.
`related_questions_spec`	`RelatedQuestionsSpec` Spesifikasi pertanyaan terkait.
`grounding_spec`	`GroundingSpec` Opsional. Spesifikasi perujukan.
`answer_generation_spec`	`AnswerGenerationSpec` Spesifikasi pembuatan jawaban.
`search_spec`	`SearchSpec` Spesifikasi penelusuran.
`query_understanding_spec`	`QueryUnderstandingSpec` Spesifikasi pemahaman kueri.
`asynchronous_mode (deprecated)`	`bool` Item ini tidak digunakan lagi. Tidak digunakan lagi: Kolom ini tidak digunakan lagi. Streaming Answer API akan didukung. Kontrol mode asinkron. Jika diaktifkan, respons akan ditampilkan dengan nama resource jawaban/sesi tanpa jawaban akhir. Pengguna API perlu melakukan polling untuk mendapatkan status jawaban/sesi terbaru dengan memanggil metode `ConversationalSearchService.GetAnswer` atau `ConversationalSearchService.GetSession`.
`user_pseudo_id`	`string` ID unik untuk melacak pengunjung. Misalnya, hal ini dapat diterapkan dengan cookie HTTP, yang harus dapat mengidentifikasi pengunjung secara unik di satu perangkat. ID unik ini tidak boleh berubah jika pengunjung login atau logout dari situs. Kolom ini TIDAK boleh memiliki nilai tetap seperti `unknown_visitor`. Kolom harus berupa string berenkode UTF-8 dengan batas panjang 128 karakter. Jika tidak, error `INVALID_ARGUMENT` akan ditampilkan.
`user_labels`	`map<string, string>` Label pengguna yang diterapkan ke resource harus memenuhi persyaratan berikut: Setiap resource dapat memiliki beberapa label, hingga maksimum 64 label. Setiap label harus berupa pasangan nilai kunci. Kunci memiliki panjang minimum 1 karakter dan panjang maksimum 63 karakter, serta tidak boleh kosong. Nilai boleh kosong dan memiliki panjang maksimum 63 karakter. Kunci dan nilai hanya boleh berisi huruf kecil, karakter numerik, garis bawah, dan tanda hubung. Semua karakter harus menggunakan encoding UTF-8, dan karakter internasional boleh digunakan. Bagian kunci label harus unik. Namun, Anda dapat menggunakan kunci yang sama dengan beberapa resource. Kunci harus diawali dengan huruf kecil atau karakter internasional. Lihat Dokumen Google Cloud untuk mengetahui detail selengkapnya.
`end_user_spec`	`EndUserSpec` Opsional. Spesifikasi pengguna akhir.

AnswerGenerationSpec

Spesifikasi pembuatan jawaban.

Kolom
`model_spec`	`ModelSpec` Spesifikasi model pembuatan jawaban.
`prompt_spec`	`PromptSpec` Spesifikasi perintah pembuatan jawaban.
`include_citations`	`bool` Menentukan apakah akan menyertakan metadata kutipan dalam jawaban. Nilai defaultnya adalah `false`.
`answer_language_code`	`string` Kode bahasa untuk Jawaban. Gunakan tag bahasa yang ditentukan oleh BCP47. Catatan: Ini adalah fitur eksperimental.
`ignore_adversarial_query`	`bool` Menentukan apakah kueri berbahaya harus difilter. Nilai defaultnya adalah `false`. Google menggunakan klasifikasi kueri penelusuran untuk mendeteksi kueri berbahaya. Tidak ada jawaban yang ditampilkan jika kueri penelusuran diklasifikasikan sebagai kueri yang merugikan. Misalnya, pengguna dapat mengajukan pertanyaan terkait komentar negatif tentang perusahaan atau mengirimkan kueri yang dirancang untuk menghasilkan output yang tidak aman dan melanggar kebijakan. Jika kolom ini disetel ke `true`, kami akan melewati pembuatan jawaban untuk kueri yang bertentangan dan menampilkan pesan pengganti.
`ignore_non_answer_seeking_query`	`bool` Menentukan apakah akan mengecualikan kueri yang tidak mencari jawaban. Nilai defaultnya adalah `false`. Google menggunakan klasifikasi kueri penelusuran untuk mendeteksi kueri yang mencari jawaban. Tidak ada jawaban yang ditampilkan jika kueri penelusuran diklasifikasikan sebagai kueri yang tidak mencari jawaban. Jika kolom ini disetel ke `true`, kami akan melewati pembuatan jawaban untuk kueri yang tidak mencari jawaban dan menampilkan pesan penggantian.
`ignore_jail_breaking_query`	`bool` Opsional. Menentukan apakah kueri jailbreak akan difilter. Nilai defaultnya adalah `false`. Google menggunakan klasifikasi kueri penelusuran untuk mendeteksi kueri jailbreak. Tidak ada ringkasan yang ditampilkan jika kueri penelusuran diklasifikasikan sebagai kueri pelarian dari batasan. Pengguna dapat menambahkan petunjuk ke kueri untuk mengubah gaya bahasa, gaya penulisan, bahasa, konten jawaban, atau meminta model bertindak sebagai entitas lain, misalnya, "Balas dengan gaya bahasa CEO perusahaan pesaing". Jika kolom ini disetel ke `true`, kami akan melewati pembuatan ringkasan untuk kueri jailbreak dan menampilkan pesan penggantian.
`ignore_low_relevant_content`	`bool` Menentukan apakah akan memfilter kueri yang memiliki relevansi rendah. Jika kolom ini disetel ke `false`, semua hasil penelusuran akan digunakan, terlepas dari relevansinya, untuk membuat jawaban. Jika disetel ke `true` atau tidak disetel, perilaku akan ditentukan secara otomatis oleh layanan.

ModelSpec

Spesifikasi Model Pembuatan Jawaban.

Kolom

model_version

string

Versi model. Jika tidak disetel, model stabil default akan digunakan. Nilai yang diizinkan adalah: stabil, pratinjau.

PromptSpec

Spesifikasi perintah pembuatan jawaban.

Kolom

preamble

string

Pengantar yang disesuaikan.

EndUserSpec

Spesifikasi pengguna akhir.

Kolom

end_user_metadata[]

EndUserMetaData

Opsional. Metadata pengguna akhir.

EndUserMetaData

Metadata pengguna akhir.

Kolom

Kolom union content. Konten hasil penelusuran. content hanya ada berupa salah satu diantara berikut:

chunk_info

ChunkInfo

Informasi bagian.

ChunkInfo

Informasi bagian.

Kolom

content

string

Mengelompokkan konten tekstual. Panjangnya dibatasi hingga 8.000 karakter.

document_metadata

QueryClassificationSpec

Metadata dokumen dari chunk saat ini.

DocumentMetadata

Metadata dokumen berisi informasi dokumen potongan saat ini.

Kolom

title

string

Judul dokumen.

GroundingSpec

Spesifikasi perujukan.

Kolom

include_grounding_supports

bool

Opsional. Menentukan apakah akan menyertakan grounding_supports dalam jawaban. Nilai defaultnya adalah false.

Jika kolom ini disetel ke true, jawaban yang ditampilkan akan memiliki grounding_score dan akan berisi GroundingSupports untuk setiap klaim.

filtering_level

FilteringLevel

Opsional. Menentukan apakah akan mengaktifkan pemfilteran berdasarkan skor perujukan dan pada tingkat apa.

FilteringLevel

Tingkat untuk memfilter berdasarkan perujukan jawaban.

Enum
`FILTERING_LEVEL_UNSPECIFIED`	Defaultnya adalah tidak ada filter
`FILTERING_LEVEL_LOW`	Memfilter jawaban berdasarkan nilai minimum.
`FILTERING_LEVEL_HIGH`	Memfilter jawaban berdasarkan nilai minimum yang tinggi.

QueryUnderstandingSpec

Spesifikasi pemahaman kueri.

Kolom

query_classification_spec

Spesifikasi klasifikasi kueri.

query_rephraser_spec

QueryRephraserSpec

Spesifikasi pengubahan frasa kueri.

disable_spell_correction

bool

Opsional. Apakah akan menonaktifkan koreksi ejaan. Nilai defaultnya adalah false.

QueryClassificationSpec

Spesifikasi klasifikasi kueri.

Kolom

types[]

Type

Mengaktifkan jenis klasifikasi kueri.

Jenis

Jenis klasifikasi kueri.

Enum
`TYPE_UNSPECIFIED`	Jenis klasifikasi kueri tidak ditentukan.
`ADVERSARIAL_QUERY`	Jenis klasifikasi kueri adversarial.
`NON_ANSWER_SEEKING_QUERY`	Jenis klasifikasi kueri yang tidak mencari jawaban, untuk percakapan santai.
`JAIL_BREAKING_QUERY`	Jenis klasifikasi kueri pelarian dari batasan.
`NON_ANSWER_SEEKING_QUERY_V2`	Jenis klasifikasi kueri non-pencarian jawaban, tanpa maksud yang jelas.
`USER_DEFINED_CLASSIFICATION_QUERY`	Jenis klasifikasi kueri yang ditentukan pengguna.

QueryRephraserSpec

Spesifikasi pengubahan frasa kueri.

Kolom

disable

bool

Menonaktifkan pengubah susunan kata kueri.

max_rephrase_steps

int32

Langkah-langkah parafrasa maksimum. Jumlah maksimum adalah 5 langkah. Jika tidak disetel atau disetel ke < 1, nilai defaultnya adalah 1.

model_spec

ModelSpec

Opsional. Spesifikasi Model Parafrasa Kueri.

ModelSpec

Spesifikasi Model Parafrasa Kueri.

Kolom

model_type

ModelType

Opsional. Jenis model pengubah frasa kueri yang diaktifkan. Jika tidak disetel, nilai defaultnya adalah LARGE.

ModelType

Jenis pengubahan frasa kueri. Saat ini hanya mendukung pemilihan model single-hop (max_rephrase_steps = 1). Untuk multi-hop (max_rephrase_steps > 1), hanya ada satu model default.

Enum
`MODEL_TYPE_UNSPECIFIED`	Jenis model tidak ditentukan.
`SMALL`	Model pengubah frasa kueri kecil. Model Gemini 1.0 XS.
`LARGE`	Model parafrasa kueri besar. Model Gemini 1.0 Pro.

RelatedQuestionsSpec

Spesifikasi pertanyaan terkait.

Kolom

enable

bool

Mengaktifkan fitur pertanyaan terkait jika benar.

SafetySpec

Spesifikasi keselamatan. Ada dua kasus penggunaan: 1. Jika hanya safety_spec.enable yang ditetapkan, batas BLOCK_LOW_AND_ABOVE akan diterapkan untuk semua kategori. 2. Jika safety_spec.enable ditetapkan dan beberapa safety_settings ditetapkan, hanya safety_settings yang ditentukan yang diterapkan.

Kolom

enable

bool

Aktifkan pemfilteran keamanan pada respons jawaban. Secara default, nilainya adalah false.

safety_settings[]

SafetySetting

Opsional. Setelan keamanan. Setelan ini hanya berlaku jika safety_spec.enable benar (true).

SafetySetting

Setelan keamanan.

Kolom

category

HarmCategory

Wajib. Kategori bahaya.

threshold

HarmBlockThreshold

Wajib. Ambang batas pemblokiran bahaya.

HarmBlockThreshold

Tingkat nilai minimum berbasis probabilitas untuk pemblokiran.

Enum
`HARM_BLOCK_THRESHOLD_UNSPECIFIED`	Batas blokir bahaya tidak ditentukan.
`BLOCK_LOW_AND_ABOVE`	Blokir batas rendah dan lebih tinggi (yaitu, blokir lebih banyak).
`BLOCK_MEDIUM_AND_ABOVE`	Blokir batas sedang dan lebih tinggi.
`BLOCK_ONLY_HIGH`	Ambang batas Block only high (yaitu, blokir lebih sedikit).
`BLOCK_NONE`	Tidak memblokir apa pun.
`OFF`	Nonaktifkan filter keamanan.

SearchSpec

Spesifikasi penelusuran.

Kolom

Kolom union input. Parameter penelusuran untuk mengontrol perilaku penelusuran. Atau berikan daftar hasil penelusuran untuk membuat jawaban. input hanya ada berupa salah satu diantara berikut:

search_params

SearchParams

Parameter penelusuran.

search_result_list

SearchResultList

Daftar hasil penelusuran.

SearchParams

Parameter penelusuran.

Kolom
`max_return_results`	`int32` Jumlah hasil penelusuran yang akan ditampilkan. Nilai defaultnya adalah 10.
`filter`	`string` Sintaksis filter terdiri dari bahasa ekspresi untuk membuat predikat dari satu atau beberapa kolom dokumen yang difilter. Ekspresi filter peka huruf besar/kecil. Hal ini akan digunakan untuk memfilter hasil penelusuran yang dapat memengaruhi respons Jawaban. Jika kolom ini tidak dapat dikenali, `INVALID_ARGUMENT` akan ditampilkan. Pemfilteran di Vertex AI Search dilakukan dengan memetakan kunci filter LHS ke properti kunci yang ditentukan di backend Vertex AI Search -- pemetaan ini ditentukan oleh pelanggan dalam skemanya. Misalnya, pelanggan media mungkin memiliki kolom 'name' dalam skemanya. Dalam hal ini, filter akan terlihat seperti ini: filter --> name:'ANY("king kong")' Untuk mengetahui informasi selengkapnya tentang pemfilteran, termasuk sintaksis dan operator filter, lihat Filter
`boost_spec`	`BoostSpec` Spesifikasi peningkatan untuk meningkatkan kualitas dokumen tertentu dalam hasil penelusuran yang dapat memengaruhi respons kueri jawaban. Untuk mengetahui informasi selengkapnya tentang promosi, lihat Promosi
`order_by`	`string` Urutan dokumen yang ditampilkan. Dokumen dapat diurutkan berdasarkan kolom dalam objek `Document`. Biarkan tidak disetel jika diurutkan berdasarkan relevansi. Ekspresi `order_by` peka huruf besar/kecil. Untuk mengetahui informasi selengkapnya tentang pemesanan, lihat Pemesanan Jika kolom ini tidak dapat dikenali, `INVALID_ARGUMENT` akan ditampilkan.
`search_result_mode`	`SearchResultMode` Menentukan mode hasil penelusuran. Jika tidak ditentukan, mode hasil penelusuran ditetapkan ke `DOCUMENTS` secara default. Lihat mengurai dan memotong dokumen
`data_store_specs[]`	`DataStoreSpec` Spesifikasi yang menentukan dataStore yang akan difilter dalam panggilan penelusuran dan konfigurasi untuk dataStore tersebut. Hal ini hanya dipertimbangkan untuk kasus penggunaan mesin dengan beberapa dataStore. Untuk satu dataStore dalam mesin, mereka harus menggunakan spesifikasi di tingkat teratas.

SearchResultList

Daftar hasil penelusuran.

Kolom

search_results[]

SearchResult

Hasil penelusuran.

SearchResult

Hasil penelusuran.

Kolom

Kolom union content. Konten hasil penelusuran. content hanya ada berupa salah satu diantara berikut:

unstructured_document_info

UnstructuredDocumentInfo

Informasi dokumen tidak terstruktur.

chunk_info

ChunkInfo

Informasi bagian.

ChunkInfo

Informasi bagian.

Kolom

chunk

string

Nama resource chunk.

content

string

Mengelompokkan konten tekstual.

document_metadata

Metadata dokumen dari chunk saat ini.

DocumentMetadata

Metadata dokumen berisi informasi dokumen potongan saat ini.

Kolom

uri

string

URI dokumen.

title

string

Judul dokumen.

UnstructuredDocumentInfo

Informasi dokumen tidak terstruktur.

Kolom
`document`	`string` Nama resource dokumen.
`uri`	`string` URI untuk dokumen.
`title`	`string` Judul.
`document_contexts[]`	`DocumentContext` Daftar konteks dokumen. Konten akan digunakan untuk Pembuatan Jawaban. Bagian ini seharusnya menjadi konten utama dokumen yang bisa panjang dan komprehensif.
`extractive_segments[]`	`ExtractiveSegment` Daftar segmen ekstraktif.
`extractive_answers[] (deprecated)`	`ExtractiveAnswer` Item ini tidak digunakan lagi. Tidak digunakan lagi: Kolom ini tidak digunakan lagi dan tidak akan memengaruhi Pembuatan jawaban. Gunakan kolom document_contexts dan extractive_segments. Daftar jawaban ekstraktif.

DocumentContext

Konteks dokumen.

Kolom

page_identifier

string

ID halaman.

content

string

Konten dokumen yang akan digunakan untuk pembuatan jawaban.

ExtractiveAnswer

Jawaban ekstraktif. Panduan

Kolom

page_identifier

string

ID halaman.

content

string

Konten jawaban ekstraktif.

ExtractiveSegment

Segmen ekstraktif. Pembuatan jawaban Panduan hanya akan menggunakannya jika document_contexts kosong. Ini seharusnya berupa cuplikan yang lebih pendek.

Kolom

page_identifier

string

ID halaman.

content

string

Konten segmen ekstraktif.

AnswerQueryResponse

Pesan respons untuk metode ConversationalSearchService.AnswerQuery.

Kolom

answer

Answer

Objek resource jawaban. Jika AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec.max_rephrase_steps lebih besar dari 1, gunakan Answer.name untuk mengambil informasi jawaban menggunakan ConversationalSearchService.GetAnswer API.

session

PolicyEnforcementResult

Objek resource sesi. Kolom ini hanya akan tersedia jika kolom sesi disetel dan valid dalam permintaan AnswerQueryRequest.

answer_query_token

string

ID unik global yang digunakan untuk mencatat aktivitas.

AssistAnswer

Resource AssistAnswer, bagian utama dari AssistResponse.

Kolom
`name`	`string` Tidak dapat diubah. ID. Nama resource `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` Kolom ini harus berupa string berenkode UTF-8 dengan batas panjang 1.024 karakter.
`state`	`State` Status pembuatan jawaban.
`replies[]`	`Reply` Balasan asisten.
`assist_skipped_reasons[]`	`AssistSkippedReason` Alasan tidak menjawab panggilan bantuan.
`customer_policy_enforcement_result`	`CustomerPolicyEnforcementResult` Opsional. Kolom ini berisi informasi tentang hasil berbagai pemeriksaan kebijakan seperti frasa terlarang atau pemeriksaan Perlindungan Model. Kolom ini hanya diisi jika panggilan bantuan dilewati karena pelanggaran kebijakan.

AssistSkippedReason

Kemungkinan alasan tidak menjawab panggilan bantuan.

Enum
`ASSIST_SKIPPED_REASON_UNSPECIFIED`	Nilai default. Alasan melewati tidak ditentukan.
`NON_ASSIST_SEEKING_QUERY_IGNORED`	Asisten mengabaikan kueri karena tampaknya tidak mencari jawaban.
`CUSTOMER_POLICY_VIOLATION`	Asisten mengabaikan kueri atau menolak menjawab karena pelanggaran kebijakan pelanggan (misalnya, kueri atau jawaban berisi frasa yang dilarang).

CustomerPolicyEnforcementResult

Hasil penegakan kebijakan pelanggan. Berisi hasil berbagai pemeriksaan kebijakan, seperti frasa terlarang atau pemeriksaan Model Armor.

Kolom

verdict

Verdict

Putusan akhir penegakan kebijakan pelanggan. Jika hanya satu kebijakan yang memblokir pemrosesan, maka keputusannya adalah BLOKIR.

policy_results[]

Hasil penegakan kebijakan pelanggan. Diisi hanya jika panggilan bantuan dilewati karena pelanggaran kebijakan. Bagian ini berisi hasil dari filter yang memblokir pemrosesan kueri.

BannedPhraseEnforcementResult

Hasil penegakan kebijakan pelanggan untuk kebijakan frasa terlarang.

Kolom

banned_phrases[]

string

Frasa terlarang yang ditemukan dalam kueri atau jawaban.

ModelArmorEnforcementResult

Hasil penegakan kebijakan pelanggan untuk kebijakan Model Armor.

Kolom

Kolom union result. Hasil kebijakan Model Armor. result hanya ada berupa salah satu diantara berikut:

model_armor_violation

string

Pelanggaran Model Armor yang ditemukan.

error

BannedPhraseEnforcementResult

Error yang ditampilkan oleh Model Armor jika penerapan kebijakan gagal karena alasan tertentu.

PolicyEnforcementResult

Hasil penegakan kebijakan pelanggan untuk satu jenis kebijakan.

Kolom

Kolom union enforcement_result. Hasil spesifik jenis kebijakan. Nilainya dapat berupa error atau informasi mendetail tentang hasil penegakan kebijakan. enforcement_result hanya ada berupa salah satu diantara berikut:

banned_phrase_enforcement_result

Hasil penerapan kebijakan untuk kebijakan frasa terlarang.

model_armor_enforcement_result

ModelArmorEnforcementResult

Hasil penerapan kebijakan untuk kebijakan Model Armor.

Putusan

Putusan penegakan kebijakan pelanggan.

Enum
`UNSPECIFIED`	Nilai tidak diketahui.
`ALLOW`	Tidak ada pelanggaran kebijakan.
`BLOCK`	Pemrosesan diblokir oleh kebijakan pelanggan.

Balas

Salah satu bagian dari respons multi-bagian panggilan bantuan.

Kolom

Kolom union reply. Alternatif untuk jawaban asisten. reply hanya ada berupa salah satu diantara berikut:

grounded_content

AssistantGroundedContent

Teks atau media respons yang mungkin memiliki rujukan dari asisten.

Negara bagian/Provinsi

Status pembuatan jawaban.

Enum
`STATE_UNSPECIFIED`	Tidak diketahui.
`IN_PROGRESS`	Operasi bantuan sedang berlangsung.
`FAILED`	Operasi bantuan gagal.
`SUCCEEDED`	Operasi bantuan berhasil.
`SKIPPED`	Operasi bantuan telah dilewati.

AssistRequest

Permintaan untuk metode AssistantService.Assist.

Kolom
`name`	`string` Wajib. Nama resource `Assistant`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}`
`query`	`Query` Opsional. Kueri pengguna saat ini. Kueri kosong hanya didukung jika `file_ids` diberikan. Dalam hal ini, jawaban akan dibuat berdasarkan file konteks tersebut.
`session`	`string` Opsional. Sesi yang akan digunakan untuk permintaan. Jika ditentukan, asisten memiliki akses ke histori sesi, dan kueri serta jawabannya disimpan di sana. Jika `-` ditentukan sebagai ID sesi, atau dibiarkan kosong, sesi baru akan dibuat dengan ID yang dihasilkan secara otomatis. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`
`assist_skipping_mode`	`AssistSkippingMode` Opsional. Menentukan kasus saat asisten tidak akan menjawab kueri. Jika jawaban dilewati, alasannya akan dicantumkan di `AssistAnswer.assist_skipped_reasons` dalam `AssistResponse.answer`.
`file_ids[]`	`string` Opsional. ID file yang akan digunakan untuk menjawab permintaan. Saat mengupload file, ID-nya akan ditampilkan di `AddContextFileResponse.file_id`.
`user_metadata`	`AssistUserMetadata` Opsional. Informasi tentang pengguna yang memulai kueri.

AssistSkippingMode

Perilaku melewati yang tersedia untuk permintaan bantuan.

Enum
`ASSIST_SKIPPING_MODE_UNSPECIFIED`	Nilai default. Jawaban dapat dilewati jika kueri tidak meminta bantuan.
`REQUEST_ASSIST`	Minta jawaban Asisten. Jawaban mungkin masih dilewati jika kueri gagal dalam pemeriksaan kebijakan.

AssistResponse

Respons untuk metode AssistantService.Assist.

Kolom

answer

AssistAnswer

Resource AssistAnswer yang dihasilkan sebagai respons terhadap kueri.

session_info

SessionInfo

Informasi sesi.

assist_token

string

ID unik global yang mengidentifikasi pasangan permintaan-respons saat ini. Digunakan untuk masukan dan dukungan.

SessionInfo

Informasi tentang sesi.

Kolom

session

string

Nama sesi yang baru dibuat atau dilanjutkan.

Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}

query_id

string

ID kueri yang sesuai dengan panggilan API bantuan ini. Satu sesi dapat memiliki beberapa giliran, yang masing-masing memiliki ID kueri unik.

Dengan menentukan nama sesi dan ID kueri ini dalam panggilan Assist API, permintaan bantuan terjadi dalam konteks hasil penelusuran dari panggilan penelusuran ini.

AssistUserMetadata

Metadata pengguna permintaan.

Kolom

time_zone

string

Opsional. Zona waktu IANA, misalnya, Eropa/Budapest.

preferred_language_code

string

Opsional. Bahasa pilihan yang akan digunakan untuk memberikan jawaban jika pendeteksian bahasa gagal. Juga digunakan sebagai bahasa pesan error yang dibuat oleh tindakan, terlepas dari hasil deteksi bahasa.

Asisten

Resource Asisten Discovery Engine.

Kolom
`name`	`string` Tidak dapat diubah. Nama resource asisten. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` Harus berupa string berenkode UTF-8 dengan batas panjang 1.024 karakter.
`display_name`	`string` Wajib. Nama tampilan asisten. Harus berupa string berenkode UTF-8 dengan batas panjang 128 karakter.
`description`	`string` Opsional. Deskripsi untuk informasi tambahan. Diharapkan ditampilkan di UI konfigurasi, bukan kepada pengguna asisten.
`generation_config`	`GenerationConfig` Opsional. Konfigurasi untuk pembuatan respons asisten.
`google_search_grounding_enabled (deprecated)`	`bool` Item ini tidak digunakan lagi. Opsional. Tidak digunakan lagi. Sebagai gantinya, gunakan `web_grounding_type`.
`web_grounding_type`	`WebGroundingType` Opsional. Jenis perujukan web yang akan digunakan.
`enabled_actions (deprecated)`	`map<string, ActionList>` Item ini tidak digunakan lagi. Opsional. Tidak digunakan lagi: akan diganti dengan `enabled_tools`. Tindakan yang diaktifkan di asisten ini. Kuncinya adalah nama konektor, misalnya "projects/{projectId}/locations/{locationId}/collections/{collectionId}/dataconnector. Nilainya terdiri dari tindakan yang diaktifkan admin terhadap instance konektor. Admin dapat mengaktifkan beberapa tindakan secara selektif pada salah satu instance konektor yang dibuatnya di project. Misalnya, {"jira1ConnectorName": [(actionId1, "createTicket"), (actionId2, "transferTicket")], "gmail1ConnectorName": [(actionId3, "sendEmail"),..] }
`enabled_tools`	`map<string, ToolList>` Opsional. Catatan: belum diterapkan. Sebagai gantinya, gunakan `enabled_actions`. Alat yang diaktifkan di asisten ini. Kuncinya adalah nama konektor, misalnya "projects/{projectId}/locations/{locationId}/collections/{collectionId}/dataconnector". Nilainya terdiri dari alat yang diaktifkan admin untuk instance konektor. Admin dapat mengaktifkan beberapa alat secara selektif di salah satu instance konektor yang mereka buat dalam project. Misalnya, {"jira1ConnectorName": [(toolId1, "createTicket"), (toolId2, "transferTicket")], "gmail1ConnectorName": [(toolId3, "sendEmail"),..] }
`customer_policy`	`CustomerPolicy` Opsional. Kebijakan pelanggan untuk asisten.

ActionInfo

Tidak digunakan lagi: Akan diganti dengan ToolInfo. Informasi untuk mengidentifikasi tindakan.

Kolom

action_name

string

Nama tindakan seperti yang ditentukan oleh DataConnectorService.QueryAvailableActions.

action_display_name

string

Nama tampilan tindakan.

ActionList

Tidak digunakan lagi: Akan diganti dengan ToolList. Tindakan yang diaktifkan pada konektor

Kolom

action_info[]

ActionInfo

Daftar tindakan dengan informasi tindakan yang sesuai.

CustomerPolicy

Kebijakan yang ditentukan pelanggan untuk asisten.

Kolom

banned_phrases[]

BannedPhrase

Opsional. Daftar frasa yang dilarang.

model_armor_config

ModelArmorConfig

Opsional. Konfigurasi Model Armor yang akan digunakan untuk menyaring perintah pengguna dan respons asisten.

BannedPhrase

Definisi frasa terlarang yang ditentukan pelanggan. Frasa yang dilarang tidak boleh muncul dalam kueri pengguna atau respons LLM, atau jawaban akan ditolak.

Kolom

phrase

string

Wajib. Konten string mentah yang akan dilarang.

match_type

BannedPhraseMatchType

Opsional. Jenis pencocokan untuk frasa yang dilarang.

ignore_diacritics

bool

Opsional. Jika benar (true), tanda diakritik (misalnya, aksen, umlaut) akan diabaikan saat mencocokkan frasa yang dilarang. Misalnya, "cafe" akan cocok dengan "café".

BannedPhraseMatchType

Metode pencocokan untuk frasa terlarang.

Enum
`BANNED_PHRASE_MATCH_TYPE_UNSPECIFIED`	Default-nya adalah SIMPLE_STRING_MATCH.
`SIMPLE_STRING_MATCH`	Frasa yang dilarang cocok jika ditemukan di mana saja dalam teks sebagai sub-string persis.
`WORD_BOUNDARY_STRING_MATCH`	Frasa terlarang hanya cocok jika pola yang ditemukan dalam teks diapit oleh pembatas kata. Frasa itu sendiri mungkin masih berisi pembatas kata.

ModelArmorConfig

Konfigurasi untuk template Model Armor yang ditentukan pelanggan yang akan digunakan untuk membersihkan perintah pengguna dan respons asisten.

Kolom

user_prompt_template

string

Opsional. Nama resource template Model Armor untuk membersihkan perintah pengguna. Format: projects/{project}/locations/{location}/templates/{template_id}

Jika tidak ditentukan, tidak ada pembersihan yang akan diterapkan pada perintah pengguna.

response_template

string

Opsional. Nama resource template Model Armor untuk menyaring respons asisten. Format: projects/{project}/locations/{location}/templates/{template_id}

Jika tidak ditentukan, tidak ada pembersihan yang akan diterapkan pada respons asisten.

failure_mode

FailureMode

Opsional. Menentukan mode kegagalan untuk pembersihan Model Armor.

FailureMode

Menentukan perilaku saat Model Armor gagal memproses permintaan.

Enum
`FAILURE_MODE_UNSPECIFIED`	Mode kegagalan tidak ditentukan, perilaku default adalah `FAIL_CLOSED`.
`FAIL_OPEN`	Jika terjadi kegagalan pemrosesan Model Armor, permintaan diizinkan untuk dilanjutkan tanpa perubahan apa pun.
`FAIL_CLOSED`	Jika pemrosesan Model Armor gagal, permintaan akan ditolak.

GenerationConfig

Konfigurasi untuk pembuatan respons asisten.

Kolom

system_instruction

SystemInstruction

Instruksi sistem, juga dikenal sebagai preamble perintah untuk panggilan LLM. Lihat juga https://cloud.google.com/vertex-ai/generative-ai/docs/learn/prompts/system-instructions

default_language

string

Bahasa default yang akan digunakan untuk pembuatan respons asisten. Gunakan kode bahasa ISO 639-1 seperti en. Jika tidak ditentukan, bahasa akan otomatis terdeteksi.

SystemInstruction

Instruksi sistem, juga dikenal sebagai preamble perintah untuk panggilan LLM.

Kolom

additional_system_instruction

string

Opsional. Instruksi sistem tambahan yang akan ditambahkan ke instruksi sistem default.

ToolInfo

Informasi untuk mengidentifikasi alat.

Kolom

tool_name

string

Nama alat sebagaimana ditentukan oleh DataConnectorService.QueryAvailableActions. Catatan: menggunakan action di API DataConnectorService, tetapi sama dengan tool di sini.

tool_display_name

string

Nama tampilan alat.

ToolList

Alat yang diaktifkan di konektor

Kolom

tool_info[]

ToolInfo

Daftar alat dengan informasi alat yang sesuai.

WebGroundingType

Jenis perujukan web yang akan digunakan.

Enum
`WEB_GROUNDING_TYPE_UNSPECIFIED`	Setelan default, tidak ditentukan. Ini sama dengan dinonaktifkan.
`WEB_GROUNDING_TYPE_DISABLED`	Grounding web dinonaktifkan.
`WEB_GROUNDING_TYPE_GOOGLE_SEARCH`	Grounding dengan Google Penelusuran diaktifkan.
`WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`	Grounding dengan Penelusuran Web Perusahaan diaktifkan.

AssistantContent

Konten multimodal.

Kolom
`role`	`string` Produser konten. Dapat berupa "model" atau "user".
`thought`	`bool` Opsional. Menunjukkan apakah bagian tersebut diperkirakan dari model.
Kolom union `data`. Data yang ada di dalamnya. `data` hanya ada berupa salah satu diantara berikut:
`text`	`string` Teks inline.
`inline_data`	`Blob` Data biner inline.
`file`	`File` File, misalnya, ringkasan audio.
`executable_code`	`ExecutableCode` Kode yang dihasilkan oleh model yang dimaksudkan untuk dieksekusi.
`code_execution_result`	`CodeExecutionResult` Hasil menjalankan ExecutableCode.

Blob

Blob inline.

Kolom

mime_type

string

Wajib. Jenis media (jenis MIME) data yang dihasilkan.

data

bytes

Wajib. Byte mentah.

CodeExecutionResult

Hasil eksekusi ExecutableCode.

Kolom

outcome

Outcome

Wajib. Hasil eksekusi kode.

output

string

Opsional. Berisi stdout saat eksekusi kode berhasil, stderr, atau deskripsi lainnya.

Hasil

Enumerasi kemungkinan hasil eksekusi kode.

Enum
`OUTCOME_UNSPECIFIED`	Status tidak ditentukan. Nilai ini tidak boleh digunakan.
`OUTCOME_OK`	Eksekusi kode berhasil diselesaikan.
`OUTCOME_FAILED`	Eksekusi kode selesai, tetapi gagal. `stderr` harus berisi alasan.
`OUTCOME_DEADLINE_EXCEEDED`	Eksekusi kode berjalan terlalu lama, dan dibatalkan. Mungkin ada atau tidak ada output parsial.

ExecutableCode

Kode yang dihasilkan oleh model yang dimaksudkan untuk dieksekusi oleh model.

Kolom

code

string

Wajib. Konten kode. Saat ini hanya mendukung Python.

File

File, misalnya, ringkasan audio.

Kolom

mime_type

string

Wajib. Jenis media (jenis MIME) file.

file_id

string

Wajib. ID file.

AssistantGroundedContent

Sebuah konten dan kemungkinan informasi perujukan konten tersebut.

Tidak semua konten memerlukan perujukan. Frasa seperti "Tentu, saya akan dengan senang hati mencarinya untuk Anda" tidak memerlukan perujukan.

Kolom
`content`	`AssistantContent` Konten.
`citation_metadata`	`CitationMetadata` Atribusi sumber konten yang dihasilkan. Lihat juga https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check
`content_metadata`	`ContentMetadata` Opsional. Metadata untuk konten. Saat ini hanya digunakan untuk jawaban asisten riset.
Kolom union `metadata`. Metadata perujukan untuk berbagai modal. Saat ini, hanya teks yang didukung. `metadata` hanya ada berupa salah satu diantara berikut:
`text_grounding_metadata`	`TextGroundingMetadata` Metadata untuk perujukan berdasarkan sumber teks.

ContentMetadata

Metadata untuk konten.

Kolom

content_kind

ContentKind

Jenis konten. Menunjukkan bagian jawaban asisten riset yang berisi konten ini.

content_id

string

ID konten. Digunakan untuk menghubungkan pertanyaan penelitian dengan jawabannya. Misalnya, bagian jawaban atas pertanyaan penelitian akan memiliki content_id yang sama dengan pertanyaan.

ContentKind

Kemungkinan jenis konten. Saat ini hanya digunakan untuk membedakan bagian dalam jawaban lengkap asisten riset.

Enum
`CONTENT_KIND_UNSPECIFIED`	Tidak diketahui.
`RESEARCH_PLAN`	Rencana riset.
`RESEARCH_QUESTION`	Pertanyaan penelitian.
`RESEARCH_ANSWER`	Jawaban penelitian.
`RESEARCH_REPORT`	Research report.
`RESEARCH_AUDIO_SUMMARY`	Ringkasan audio riset.

TextGroundingMetadata

Detail perujukan untuk sumber teks.

Kolom

segments[]

Segment

Informasi perujukan untuk bagian teks.

references[]

Reference

Referensi untuk teks yang memiliki rujukan.

Referensi

Konten yang dirujuk dan metadata dokumen terkait.

Kolom

content

string

Konten teks yang dirujuk.

document_metadata

Metadata dokumen.

DocumentMetadata

Metadata dokumen.

Kolom
`document`	`string` Nama resource dokumen.
`uri`	`string` URI untuk dokumen. Mungkin berisi URL yang mengalihkan ke situs sebenarnya.
`title`	`string` Judul.
`page_identifier`	`string` ID halaman.
`domain`	`string` Nama domain dari URI dokumen. Perhatikan bahwa kolom `uri` dapat berisi URL yang mengalihkan ke situs sebenarnya, yang dalam hal ini akan berisi nama domain situs target.
`mime_type`	`string` Jenis MIME dokumen. https://www.iana.org/assignments/media-types/media-types.xhtml.

Segmen

Informasi perujukan untuk segmen teks.

Kolom
`start_index`	`int64` Indeks berbasis nol yang menunjukkan awal segmen, diukur dalam byte string UTF-8 (yaitu karakter yang dienkode pada beberapa byte memiliki panjang lebih dari satu).
`end_index`	`int64` Akhir segmen, eksklusif.
`reference_indices[]`	`int32` Referensi untuk segmen.
`grounding_score`	`float` Skor untuk segmen.
`text`	`string` Segmen teks itu sendiri.

BAPConfig

Konfigurasi untuk konektor BAP.

Kolom

supported_connector_modes[]

ConnectorMode

Wajib. Mode konektor yang didukung untuk koneksi BAP terkait.

enabled_actions[]

string

Opsional. Tindakan yang diaktifkan pada koneksi BAP terkait.

ConnectorMode

Kasus penggunaan yang didukung oleh konektor BAP ini.

Enum
`CONNECTOR_MODE_UNSPECIFIED`	Mode konektor tidak ditentukan.
`DATA_INGESTION`	Konektor yang digunakan untuk penyerapan data.
`ACTIONS`	Konektor yang digunakan untuk Tindakan
`END_USER_AUTHENTICATION`	Konektor yang digunakan untuk Autentikasi Pengguna Akhir.

BatchCreateTargetSiteMetadata

Metadata yang terkait dengan progres operasi SiteSearchEngineService.BatchCreateTargetSites. Hal ini akan ditampilkan oleh kolom google.longrunning.Operation.metadata.

Kolom

create_time

Waktu pembuatan operasi.

update_time

CreateTargetSiteRequest

Waktu update terakhir operasi. Jika operasi selesai, ini juga merupakan waktu selesainya.

BatchCreateTargetSitesRequest

Pesan permintaan untuk metode SiteSearchEngineService.BatchCreateTargetSites.

Kolom

parent

string

Wajib. Resource induk yang dibagikan oleh semua TargetSite yang sedang dibuat. projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine. Kolom induk dalam pesan CreateBookRequest harus kosong atau cocok dengan kolom ini.

requests[]

Wajib. Pesan permintaan yang menentukan resource yang akan dibuat. Maksimum 20 TargetSite dapat dibuat dalam batch.

BatchCreateTargetSitesResponse

Pesan respons untuk metode SiteSearchEngineService.BatchCreateTargetSites.

Kolom

target_sites[]

TargetSites dibuat.

BatchGetDocumentsMetadataRequest

Pesan permintaan untuk metode DocumentService.BatchGetDocumentsMetadata.

Kolom

parent

string

Wajib. Nama resource cabang induk, seperti projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}.

matcher

Matcher

Wajib. Pencocok untuk Document.

FhirMatcher

Pencocokan untuk Document berdasarkan nama resource FHIR.

Kolom

fhir_resources[]

string

Wajib. Resource FHIR yang akan dicocokkan. Format: projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id}

Matcher

Pencocok untuk Document. Saat ini mendukung pencocokan menurut URI persis.

Kolom

Kolom union matcher. Pencocok untuk Document. matcher hanya dapat berupa salah satu dari hal berikut:

uris_matcher

UrisMatcher

Pencocokan menurut URI persis.

fhir_matcher

FhirMatcher

Pencocokan menurut nama resource FHIR.

UrisMatcher

Pencocokan untuk Document detik berdasarkan URI persis.

Kolom

uris[]

string

URI persis yang akan dicocokkan.

BatchGetDocumentsMetadataResponse

Pesan respons untuk metode DocumentService.BatchGetDocumentsMetadata.

Kolom

documents_metadata[]

Metadata Document.

DocumentMetadata

Metadata Document.

Kolom
`matcher_value`	`MatcherValue` Nilai pencocok yang digunakan untuk mencocokkan `Document`.
`state`	`State` Status dokumen.
`last_refreshed_time`	`Timestamp` Stempel waktu saat `Document` terakhir diindeks.
`data_ingestion_source`	`string` Sumber penyerapan data `Document`. Nilai yang diperbolehkan adalah: `batch`: Data yang di-ingest melalui Batch API, misalnya, ImportDocuments. Data `streaming` yang dimasukkan melalui Streaming API, misalnya, Streaming FHIR.

MatcherValue

Nilai pencocok yang digunakan untuk mencocokkan Document.

Kolom

Kolom union matcher_value. Nilai pencocok yang digunakan untuk mencocokkan Document. matcher_value hanya dapat berupa salah satu dari hal berikut:

uri

string

Jika cocok menurut URI, URI Document.

fhir_resource

string

Format: projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id}

Negara bagian/Provinsi

Status Document.

Enum
`STATE_UNSPECIFIED`	Tidak boleh disetel.
`INDEXED`	`Document` diindeks.
`NOT_IN_TARGET_SITE`	`Document` tidak diindeks karena URI-nya tidak ada di `TargetSite`.
`NOT_IN_INDEX`	`Document` tidak diindeks.

BatchUpdateUserLicensesMetadata

Metadata yang terkait dengan progres operasi UserLicenseService.BatchUpdateUserLicenses. Hal ini akan ditampilkan oleh kolom google.longrunning.Operation.metadata.

Kolom
`create_time`	`Timestamp` Waktu pembuatan operasi.
`update_time`	`Timestamp` Waktu update terakhir operasi. Jika operasi selesai, ini juga merupakan waktu selesainya.
`success_count`	`int64` Jumlah lisensi pengguna berhasil diperbarui.
`failure_count`	`int64` Jumlah lisensi pengguna yang gagal diperbarui.

BatchUpdateUserLicensesRequest

Pesan permintaan untuk metode UserLicenseService.BatchUpdateUserLicenses.

Kolom
`parent`	`string` Wajib. Nama resource induk [UserStore][], format: `projects/{project}/locations/{location}/userStores/{user_store_id}`.
`delete_unassigned_user_licenses`	`bool` Opsional. Jika benar (true), jika lisensi pengguna yang dihapus terkait dengan konfigurasi lisensi, lisensi pengguna akan dihapus. Secara default, yang salah (false), lisensi pengguna akan diperbarui ke status tidak ditetapkan.
Kolom union `source`. Wajib. Sumber input. `source` hanya ada berupa salah satu diantara berikut:
`inline_source`	`InlineSource` Sumber inline untuk konten input untuk embedding dokumen.

InlineSource

Sumber inline untuk konfigurasi input metode BatchUpdateUserLicenses.

Kolom

user_licenses[]

UserLicense

Wajib. Daftar lisensi pengguna yang akan diperbarui. Setiap lisensi pengguna harus memiliki UserLicense.user_principal yang valid.

update_mask

Opsional. Daftar kolom yang akan diperbarui.

BatchUpdateUserLicensesResponse

Pesan respons untuk metode UserLicenseService.BatchUpdateUserLicenses.

Kolom

user_licenses[]

UserLicense

UserLicenses berhasil diperbarui.

error_samples[]

Contoh error yang terjadi saat memproses permintaan.

BatchVerifyTargetSitesMetadata

Metadata yang terkait dengan progres operasi SiteSearchEngineService.BatchVerifyTargetSites. Hal ini akan ditampilkan oleh kolom google.longrunning.Operation.metadata.

Kolom

create_time

Waktu pembuatan operasi.

update_time

Waktu update terakhir operasi. Jika operasi selesai, ini juga merupakan waktu selesainya.

BatchVerifyTargetSitesRequest

Pesan permintaan untuk metode SiteSearchEngineService.BatchVerifyTargetSites.

Kolom

parent

string

Wajib. Resource induk yang dibagikan oleh semua TargetSite yang sedang diverifikasi. projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine.

BatchVerifyTargetSitesResponse

Jenis ini tidak memiliki kolom.

Pesan respons untuk metode SiteSearchEngineService.BatchVerifyTargetSites.

BigQuerySource

Data impor sumber BigQuery dari.

Kolom
`project_id`	`string` ID project atau nomor project yang berisi sumber BigQuery. Memiliki batas panjang 128 karakter. Jika tidak ditentukan, akan mewarisi project ID dari permintaan induk.
`dataset_id`	`string` Wajib. Set data BigQuery yang akan disalin datanya dengan batas panjang 1.024 karakter.
`table_id`	`string` Wajib. Tabel BigQuery yang akan disalin datanya dengan batas panjang 1.024 karakter.
`gcs_staging_dir`	`string` Direktori Cloud Storage perantara yang digunakan untuk impor dengan batas panjang 2.000 karakter. Dapat ditentukan jika pengguna ingin melakukan ekspor BigQuery ke direktori Cloud Storage tertentu.
`data_schema`	`string` Skema yang akan digunakan saat menguraikan data dari sumber. Nilai yang didukung untuk impor peristiwa pengguna: `user_event` (default): Satu `UserEvent` per baris. Nilai yang didukung untuk impor dokumen: `document` (default): Satu format `Document` per baris. Setiap dokumen harus memiliki `Document.id` yang valid dan salah satu dari `Document.json_data` atau `Document.struct_data`. `custom`: Satu data kustom per baris dalam format arbitrer yang sesuai dengan `Schema` penyimpanan data yang ditentukan. Ini hanya dapat digunakan oleh vertikal Data Store GENERIC.
Kolom union `partition`. Info partisi tabel BigQuery. Biarkan kosong jika tabel BigQuery tidak dipartisi. `partition` hanya ada berupa salah satu diantara berikut:
`partition_date`	`Date` _PARTITIONDATE tabel yang dipartisi menurut waktu BigQuery dalam format YYYY-MM-DD.

BigtableOptions

Objek Opsi Bigtable yang berisi informasi untuk mendukung impor.

Kolom

key_field_name

string

Nama kolom yang digunakan untuk menyimpan nilai kunci baris dalam dokumen. Nama harus cocok dengan pola [a-zA-Z0-9][a-zA-Z0-9-_]*.

families

map<string, BigtableColumnFamily>

Pemetaan dari nama grup ke objek yang berisi informasi tingkat grup kolom untuk grup kolom tertentu. Jika tidak ada keluarga dalam peta ini, keluarga tersebut akan diabaikan.

BigtableColumn

Kolom Bigtable.

Kolom
`qualifier`	`bytes` Wajib. Penentu kolom. Jika tidak dapat didekode dengan utf-8, gunakan string berenkode base-64 sebagai gantinya.
`field_name`	`string` Nama kolom yang akan digunakan untuk kolom ini dalam dokumen. Nama harus cocok dengan pola `[a-zA-Z0-9][a-zA-Z0-9-_]*`. Jika tidak disetel, nilai ini akan diuraikan dari byte penentu dengan upaya terbaik. Namun, karena pola penamaan yang berbeda, konflik nama kolom dapat terjadi, yang menyebabkan perilaku parsing tidak terdefinisi.
`encoding`	`Encoding` Mode encoding nilai saat jenisnya bukan `STRING`. Nilai encoding yang dapat diterima adalah: `TEXT`: menunjukkan bahwa nilai adalah string teks alfanumerik. `BINARY`: menunjukkan bahwa nilai dienkode menggunakan fungsi keluarga `HBase Bytes.toBytes`. Hal ini dapat diganti untuk kolom tertentu dengan mencantumkan kolom tersebut di `columns` dan menentukan encoding untuknya.
`type`	`Type` Jenis nilai dalam grup kolom ini. Nilai diharapkan dienkode menggunakan fungsi `HBase Bytes.toBytes` jika nilai encoding ditetapkan ke `BINARY`.

BigtableColumnFamily

Grup kolom Bigtable.

Kolom
`field_name`	`string` Nama kolom yang akan digunakan untuk kolom ini dalam dokumen. Nama harus cocok dengan pola `[a-zA-Z0-9][a-zA-Z0-9-_]*`. Jika tidak disetel, nama akan diuraikan dari nama keluarga dengan upaya terbaik. Namun, karena pola penamaan yang berbeda, konflik nama kolom dapat terjadi, yang menyebabkan perilaku parsing tidak terdefinisi.
`encoding`	`Encoding` Mode encoding nilai saat jenisnya bukan STRING. Nilai encoding yang dapat diterima adalah: `TEXT`: menunjukkan bahwa nilai adalah string teks alfanumerik. `BINARY`: menunjukkan bahwa nilai dienkode menggunakan fungsi keluarga `HBase Bytes.toBytes`. Hal ini dapat diganti untuk kolom tertentu dengan mencantumkan kolom tersebut di `columns` dan menentukan encoding untuknya.
`type`	`Type` Jenis nilai dalam grup kolom ini. Nilai diharapkan dienkode menggunakan fungsi `HBase Bytes.toBytes` jika nilai encoding ditetapkan ke `BINARY`.
`columns[]`	`BigtableColumn` Daftar objek yang berisi informasi tingkat kolom untuk setiap kolom. Jika kolom tidak ada dalam daftar ini, kolom tersebut akan diabaikan.

Encoding

Mode encoding kolom atau grup kolom Bigtable.

Enum
`ENCODING_UNSPECIFIED`	Encoding tidak ditentukan.
`TEXT`	Encoding teks.
`BINARY`	Encoding biner.

Jenis

Jenis nilai dalam kolom atau grup kolom Bigtable. Nilai diharapkan dienkode menggunakan fungsi HBase Bytes.toBytes saat nilai encoding disetel ke BINARY.

Enum
`TYPE_UNSPECIFIED`	Jenis tidak ditentukan.
`STRING`	Jenis string.
`NUMBER`	Jenis numerik.
`INTEGER`	Jenis bilangan bulat.
`VAR_INTEGER`	Jenis bilangan bulat dengan panjang variabel.
`BIG_NUMERIC`	Jenis BigDecimal.
`BOOLEAN`	Jenis Boolean.
`JSON`	Jenis JSON.

BigtableSource

Sumber Cloud Bigtable untuk mengimpor data.

Kolom
`project_id`	`string` Project ID yang berisi sumber Bigtable. Memiliki batas panjang 128 karakter. Jika tidak ditentukan, akan mewarisi project ID dari permintaan induk.
`instance_id`	`string` Wajib. ID instance Cloud Bigtable yang perlu diimpor.
`table_id`	`string` Wajib. ID tabel Cloud Bigtable yang perlu diimpor.
`bigtable_options`	`BigtableOptions` Wajib. Opsi Bigtable yang berisi informasi yang diperlukan saat mengurai data ke dalam struktur yang diketik. Misalnya, anotasi jenis kolom.

CheckGroundingRequest

Pesan permintaan untuk metode GroundedGenerationService.CheckGrounding.

Kolom
`grounding_config`	`string` Wajib. Nama resource konfigurasi perujukan, seperti `projects/*/locations/global/groundingConfigs/default_grounding_config`.
`answer_candidate`	`string` Jawaban kandidat yang akan diperiksa. Panjang maksimumnya adalah 4096 token.
`facts[]`	`GroundingFact` Daftar fakta untuk pemeriksaan perujukan. Kami mendukung hingga 200 fakta.
`grounding_spec`	`CheckGroundingSpec` Konfigurasi pemeriksaan perujukan.
`user_labels`	`map<string, string>` Label pengguna yang diterapkan ke resource harus memenuhi persyaratan berikut: Setiap resource dapat memiliki beberapa label, hingga maksimum 64 label. Setiap label harus berupa pasangan nilai kunci. Kunci memiliki panjang minimum 1 karakter dan panjang maksimum 63 karakter, serta tidak boleh kosong. Nilai boleh kosong dan memiliki panjang maksimum 63 karakter. Kunci dan nilai hanya boleh berisi huruf kecil, karakter numerik, garis bawah, dan tanda hubung. Semua karakter harus menggunakan encoding UTF-8, dan karakter internasional boleh digunakan. Bagian kunci label harus unik. Namun, Anda dapat menggunakan kunci yang sama dengan beberapa resource. Kunci harus diawali dengan huruf kecil atau karakter internasional. Lihat Dokumen Google Cloud untuk mengetahui detail selengkapnya.

CheckGroundingResponse

Pesan respons untuk metode GroundedGenerationService.CheckGrounding.

Kolom
`cited_chunks[]`	`FactChunk` Daftar fakta yang dikutip di semua klaim dalam kandidat jawaban. Jawaban ini berasal dari fakta yang diberikan dalam permintaan.
`cited_facts[]`	`CheckGroundingFactChunk` Daftar fakta yang dikutip di semua klaim dalam kandidat jawaban. Jawaban ini berasal dari fakta yang diberikan dalam permintaan.
`claims[]`	`Claim` Teks klaim dan info kutipan di semua klaim dalam kandidat jawaban.
`support_score`	`float` Skor dukungan untuk kandidat jawaban input. Makin tinggi skornya, makin tinggi pula fraksi klaim yang didukung oleh fakta yang diberikan. Ini selalu disetel saat respons ditampilkan.

CheckGroundingFactChunk

Potongan fakta untuk pemeriksaan perujukan.

Kolom

chunk_text

string

Konten teks dari bagian fakta. Panjang maksimal 10 ribu karakter.

Klaim

Info teks dan kutipan untuk klaim dalam kandidat jawaban.

Kolom
`claim_text`	`string` Teks untuk klaim dalam kandidat jawaban. Selalu disediakan, terlepas dari apakah kutipan atau anti-kutipan ditemukan.
`citation_indices[]`	`int32` Daftar indeks (ke dalam 'cited_chunks') yang menentukan kutipan yang terkait dengan klaim. Misalnya, [1,3,4] berarti cited_chunks[1], cited_chunks[3], cited_chunks[4] adalah fakta yang dikutip untuk mendukung klaim. Kutipan fakta menunjukkan bahwa klaim didukung oleh fakta tersebut.
`start_pos`	`int32` Posisi yang menunjukkan awal klaim dalam kandidat jawaban, diukur dalam byte. Perhatikan bahwa hal ini tidak diukur dalam karakter dan, oleh karena itu, harus dirender di antarmuka pengguna dengan mengingat bahwa beberapa karakter mungkin memerlukan lebih dari satu byte. Misalnya, jika teks klaim berisi karakter non-ASCII, posisi awal dan akhir akan bervariasi jika diukur dalam karakter (bergantung pada bahasa pemrograman) dan jika diukur dalam byte (tidak bergantung pada bahasa pemrograman).
`end_pos`	`int32` Posisi yang menunjukkan akhir klaim dalam kandidat jawaban, eksklusif, dalam byte. Perhatikan bahwa hal ini tidak diukur dalam karakter dan, oleh karena itu, harus dirender seperti itu. Misalnya, jika teks klaim berisi karakter non-ASCII, posisi awal dan akhir akan bervariasi jika diukur dalam karakter (bergantung pada bahasa pemrograman) dan jika diukur dalam byte (tidak bergantung pada bahasa pemrograman).
`grounding_check_required`	`bool` Menunjukkan bahwa klaim ini memerlukan pemeriksaan perujukan. Jika sistem memutuskan bahwa klaim ini tidak memerlukan pemeriksaan atribusi/perujukan, kolom ini akan disetel ke salah (false). Dalam hal ini, tidak ada pemeriksaan perujukan yang dilakukan untuk klaim tersebut, sehingga `citation_indices` tidak boleh ditampilkan.
`score`	`double` Skor keyakinan untuk klaim dalam kandidat jawaban, dalam rentang [0, 1]. Ini hanya disetel jika `CheckGroundingRequest.grounding_spec.enable_claim_level_score` benar (true).

CheckGroundingSpec

Spesifikasi untuk pemeriksaan perujukan.

Kolom

citation_threshold

double

Ambang batas (dalam [0,1]) yang digunakan untuk menentukan apakah suatu fakta harus dikutip untuk klaim dalam kandidat jawaban. Memilih nilai minimum yang lebih tinggi akan menghasilkan lebih sedikit kutipan, tetapi sangat kuat, sementara memilih nilai minimum yang lebih rendah dapat menghasilkan lebih banyak kutipan, tetapi agak lemah. Jika tidak disetel, nilai minimum defaultnya adalah 0,6.

enable_claim_level_score

bool

Flag kontrol yang mengaktifkan skor perujukan tingkat klaim dalam respons.

Chunk

Chunk mencatat semua informasi metadata mentah item yang akan direkomendasikan atau dicari dalam mode chunk.

Kolom
`name`	`string` Nama lengkap resource potongan. Format `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}/chunks/{chunk_id}`. Kolom ini harus berupa string berenkode UTF-8 dengan batas panjang 1.024 karakter.
`id`	`string` ID potongan unik dari potongan saat ini.
`content`	`string` Content adalah string dari dokumen (konten yang diuraikan).
`document_metadata`	`DocumentMetadata` Metadata dokumen dari chunk saat ini.
`derived_struct_data`	`Struct` Hanya output. Kolom ini bersifat OUTPUT_ONLY. Objek ini berisi data turunan yang tidak ada dalam dokumen input asli.
`page_span`	`PageSpan` Rentang halaman potongan.
`chunk_metadata`	`ChunkMetadata` Hanya output. Metadata potongan saat ini.
`data_urls[]`	`string` Hanya output. URL Data Gambar jika chunk saat ini berisi gambar. URL data terdiri dari empat bagian: awalan (data:), jenis MIME yang menunjukkan jenis data, token base64 opsional jika non-tekstual, dan data itu sendiri: data:[][;base64],
`annotation_contents[]`	`string` Hanya output. Isi anotasi jika chunk saat ini berisi anotasi.
`annotation_metadata[]`	`AnnotationMetadata` Hanya output. Metadata anotasi mencakup konten terstruktur dalam potongan saat ini.
`relevance_score`	`double` Hanya output. Mewakili skor relevansi berdasarkan kemiripan. Skor yang lebih tinggi menunjukkan relevansi potongan yang lebih tinggi. Skor berada dalam rentang [-1.0, 1.0]. Hanya diisi di `SearchResponse`.

AnnotationMetadata

Metadata anotasi mencakup konten terstruktur dalam potongan saat ini.

Kolom

structured_content

StructuredContent

Hanya output. Informasi konten terstruktur.

image_id

string

Hanya output. ID gambar diberikan jika konten terstruktur didasarkan pada gambar.

ChunkMetadata

Metadata potongan saat ini. Kolom ini hanya diisi di API SearchService.Search.

Kolom

previous_chunks[]

Chunk

Chunk sebelumnya dari chunk saat ini. Nomor tersebut dikontrol oleh SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks. Kolom ini hanya diisi di API SearchService.Search.

next_chunks[]

Chunk

Chunk berikutnya dari chunk saat ini. Nomor tersebut dikontrol oleh SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks. Kolom ini hanya diisi di API SearchService.Search.

DocumentMetadata

Metadata dokumen berisi informasi dokumen potongan saat ini.

Kolom
`uri`	`string` URI dokumen.
`title`	`string` Judul dokumen.
`mime_type`	`string` Jenis MIME dokumen. https://www.iana.org/assignments/media-types/media-types.xhtml.
`struct_data`	`Struct` Representasi data. Data JSON terstruktur untuk dokumen. Harus sesuai dengan `Schema` yang terdaftar atau error `INVALID_ARGUMENT` akan ditampilkan.

PageSpan

Rentang halaman potongan.

Kolom

page_start

int32

Halaman awal chunk.

page_end

int32

Halaman akhir potongan.

StructureType

Mendefinisikan jenis konten terstruktur yang dapat diekstrak.

Enum
`STRUCTURE_TYPE_UNSPECIFIED`	Nilai default.
`SHAREHOLDER_STRUCTURE`	Struktur pemegang saham.
`SIGNATURE_STRUCTURE`	Struktur tanda tangan.
`CHECKBOX_STRUCTURE`	Struktur kotak centang.

StructuredContent

Informasi konten terstruktur.

Kolom

structure_type

StructureType

Hanya output. Jenis struktur konten terstruktur.

content

string

Hanya output. Konten konten terstruktur.

Pengutipan

Atribusi sumber untuk konten.

Kolom
`start_index`	`int32` Hanya output. Indeks awal ke dalam konten.
`end_index`	`int32` Hanya output. Indeks akhir ke dalam konten.
`uri`	`string` Hanya output. Referensi URL atribusi.
`title`	`string` Hanya output. Judul atribusi.
`license`	`string` Hanya output. Lisensi atribusi.
`publication_date`	`Date` Hanya output. Tanggal publikasi atribusi.

CitationMetadata

Kumpulan atribusi sumber untuk suatu konten.

Kolom

citations[]

Citation

Hanya output. Daftar kutipan.

CloudSqlSource

Data impor sumber Cloud SQL dari.

Kolom
`project_id`	`string` Project ID yang berisi sumber Cloud SQL. Memiliki batas panjang 128 karakter. Jika tidak ditentukan, akan mewarisi project ID dari permintaan induk.
`instance_id`	`string` Wajib. Instance Cloud SQL yang akan disalin datanya dengan batas panjang 256 karakter.
`database_id`	`string` Wajib. Database Cloud SQL untuk menyalin data dari dengan batas panjang 256 karakter.
`table_id`	`string` Wajib. Tabel Cloud SQL yang akan disalin datanya dengan batas panjang 256 karakter.
`gcs_staging_dir`	`string` Direktori Cloud Storage perantara yang digunakan untuk impor dengan batas panjang 2.000 karakter. Dapat ditentukan jika Anda ingin mengekspor Cloud SQL ke direktori Cloud Storage tertentu. Pastikan akun layanan Cloud SQL memiliki izin Admin Cloud Storage yang diperlukan untuk mengakses direktori Cloud Storage yang ditentukan.
`offload`	`bool` Opsi untuk ekspor serverless. Mengaktifkan opsi ini akan menimbulkan biaya tambahan. Info selengkapnya dapat ditemukan di sini.

CmekConfig

Konfigurasi yang digunakan untuk mengaktifkan enkripsi data CMEK dengan kunci Cloud KMS.

Kolom
`name`	`string` Wajib. Nama CmekConfig dalam format `projects/{project}/locations/{location}/cmekConfig` atau `projects/{project}/locations/{location}/cmekConfigs/{cmek_config}`.
`kms_key`	`string` Wajib. Nama resource kunci KMS yang akan digunakan untuk mengenkripsi resource `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
`kms_key_version`	`string` Hanya output. Nama resource versi kunci KMS yang akan digunakan untuk mengenkripsi resource `<kms_key>/cryptoKeyVersions/{keyVersion}`.
`state`	`State` Hanya output. Status CmekConfig.
`is_default`	`bool` Hanya output. CmekConfig default untuk Pelanggan.
`last_rotation_timestamp_micros`	`int64` Hanya output. Stempel waktu rotasi kunci terakhir.
`single_region_keys[]`	`SingleRegionKey` Opsional. CMEK regional tunggal yang diperlukan untuk beberapa fitur VAIS.
`notebooklm_state`	`NotebookLMState` Hanya output. Apakah Korpus NotebookLM siap digunakan.

NotebookLMState

Status NotebookLM.

Enum
`NOTEBOOK_LM_STATE_UNSPECIFIED`	Status NotebookLM tidak diketahui.
`NOTEBOOK_LM_NOT_READY`	NotebookLM belum siap.
`NOTEBOOK_LM_READY`	NotebookLM siap digunakan.
`NOTEBOOK_LM_NOT_ENABLED`	NotebookLM tidak diaktifkan.

Negara bagian/Provinsi

Status CmekConfig.

Enum
`STATE_UNSPECIFIED`	Status CmekConfig tidak diketahui.
`CREATING`	CmekConfig sedang dibuat.
`ACTIVE`	CmekConfig dapat digunakan dengan DataStore.
`KEY_ISSUE`	CmekConfig tidak tersedia, kemungkinan besar karena Kunci KMS dicabut.
`DELETING`	CmekConfig sedang dihapus.
`DELETE_FAILED`	Proses penghapusan CmekConfig gagal.
`UNUSABLE`	CmekConfig tidak dapat digunakan, kemungkinan besar karena masalah internal.
`ACTIVE_ROTATING`	Versi kunci KMS sedang dirotasi.
`DELETED`	Kunci KMS dihapus sementara. Beberapa kebijakan pembersihan pada akhirnya akan diterapkan.
`EXPIRED`	Masa berlaku kunci KMS telah habis, yang berarti kunci telah dinonaktifkan selama 30+ hari. Pelanggan dapat memanggil DeleteCmekConfig untuk mengubah status menjadi DELETED.

CollectUserEventRequest

Pesan permintaan untuk metode CollectUserEvent.

Kolom
`parent`	`string` Wajib. Nama resource induk. Jika tindakan kumpulkan peristiwa pengguna diterapkan di tingkat `DataStore`, formatnya adalah: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. Jika tindakan kumpulkan peristiwa pengguna diterapkan di tingkat `Location`, misalnya, peristiwa dengan `Document` di beberapa `DataStore`, formatnya adalah: `projects/{project}/locations/{location}`.
`user_event`	`string` Wajib. Proto UserEvent yang dienkode URL dengan batas panjang 2.000.000 karakter.
`uri`	`string` URL yang menyertakan parameter cgi,tetapi tidak menyertakan fragmen hash dengan batas panjang 5.000 karakter. Hal ini sering kali lebih berguna daripada URL perujuk, karena banyak browser hanya mengirimkan domain untuk permintaan pihak ketiga.
`ets`	`int64` Stempel waktu peristiwa dalam milidetik. Hal ini mencegah browser menyimpan dalam cache permintaan get yang identik. Nama disingkat untuk mengurangi byte payload.

Koleksi

Koleksi adalah penampung untuk mengonfigurasi resource dan akses ke sekumpulan DataStore.

Kolom

name

string

Tidak dapat diubah. Nama lengkap resource Koleksi. Format projects/{project}/locations/{location}/collections/{collection_id}.

Kolom ini harus berupa string berenkode UTF-8 dengan batas panjang 1.024 karakter.

display_name

string

Wajib. Nama tampilan Koleksi.

Kolom ini harus berupa string berenkode UTF-8 dengan batas panjang 128 karakter. Jika tidak, error INVALID_ARGUMENT akan ditampilkan.

create_time

Hanya output. Stempel waktu saat Collection dibuat.

CompleteQueryRequest

Pesan permintaan untuk metode CompletionService.CompleteQuery.

Kolom
`data_store`	`string` Wajib. Nama resource penyimpanan data induk yang penyelesaiannya dilakukan, seperti `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`.
`query`	`string` Wajib. Input typeahead yang digunakan untuk mengambil saran. Panjang maksimum adalah 128 karakter.
`query_model`	`string` Menentukan model data pelengkapan otomatis. Tindakan ini akan menggantikan model apa pun yang ditentukan di bagian Konfigurasi > Pelengkapan otomatis di konsol Cloud. Nilai yang saat ini didukung: `document` - Menggunakan saran yang dihasilkan dari dokumen yang diimpor pengguna. `search-history` - Menggunakan saran yang dihasilkan dari histori panggilan API `SearchService.Search` sebelumnya. Jangan gunakan saat tidak ada traffic untuk Search API. `user-event` - Menggunakan saran yang dihasilkan dari peristiwa penelusuran yang diimpor pengguna. `document-completable` - Menggunakan saran yang diambil langsung dari kolom dokumen yang diimpor pengguna dan ditandai sebagai dapat diselesaikan. Nilai default: `document` adalah model default untuk dataStore reguler. `search-history` adalah model default untuk dataStore penelusuran situs.
`user_pseudo_id`	`string` ID unik untuk melacak pengunjung. Misalnya, hal ini dapat diterapkan dengan cookie HTTP, yang harus dapat mengidentifikasi pengunjung secara unik di satu perangkat. ID unik ini tidak boleh berubah jika pengunjung login atau logout dari situs. Kolom ini TIDAK boleh memiliki nilai tetap seperti `unknown_visitor`. ID ini harus sama dengan `UserEvent.user_pseudo_id` dan `SearchRequest.user_pseudo_id`. Kolom harus berupa string berenkode UTF-8 dengan batas panjang 128 karakter. Jika tidak, error `INVALID_ARGUMENT` akan ditampilkan.
`include_tail_suggestions`	`bool` Menunjukkan apakah saran ekor harus ditampilkan jika tidak ada saran yang cocok dengan kueri lengkap. Meskipun disetel ke benar (true), jika ada saran yang cocok dengan kueri lengkap, saran tersebut akan ditampilkan dan tidak ada saran ekor yang ditampilkan.

CompleteQueryResponse

Pesan respons untuk metode CompletionService.CompleteQuery.

Kolom

query_suggestions[]

QuerySuggestion

Hasil saran kueri yang cocok. Daftar hasil diurutkan dan hasil pertama adalah saran teratas.

tail_match_triggered

bool

Benar jika saran yang ditampilkan semuanya adalah saran ekor.

Agar pencocokan ekor dipicu, include_tail_suggestions dalam permintaan harus benar dan tidak boleh ada saran yang cocok dengan kueri lengkap.

QuerySuggestion

Saran sebagai kueri penelusuran.

Kolom

suggestion

string

Saran untuk kueri.

completable_field_paths[]

string

Jalur kolom dokumen unik yang berfungsi sebagai sumber saran ini jika dibuat dari kolom yang dapat dilengkap.

Kolom ini hanya diisi untuk model yang dapat melengkapi dokumen.

CompletionInfo

Informasi penyelesaian mendetail, termasuk token atribusi penyelesaian dan info penyelesaian yang diklik.

Kolom

selected_suggestion

string

Pengguna akhir dipilih CompleteQueryResponse.QuerySuggestion.suggestion.

selected_position

int32

Posisi CompleteQueryResponse.QuerySuggestion.suggestion yang dipilih pengguna akhir, dimulai dari 0.

CompletionSuggestion

Saran pelengkapan otomatis yang diimpor dari Pelanggan.

Kolom
`suggestion`	`string` Wajib. Teks saran.
`language_code`	`string` Kode bahasa BCP-47 saran ini.
`group_id`	`string` Jika dua saran memiliki groupId yang sama, keduanya tidak akan ditampilkan bersama. Sebagai gantinya, yang akan ditampilkan adalah yang memiliki peringkat lebih tinggi. Hal ini dapat digunakan untuk menghapus duplikat saran yang identik secara semantik.
`group_score`	`double` Skor saran ini dalam grupnya.
`alternative_phrases[]`	`string` Frasa alternatif yang cocok untuk saran ini.
Kolom union `ranking_info`. Metrik peringkat saran ini. `ranking_info` hanya ada berupa salah satu diantara berikut:
`global_score`	`double` Skor global saran ini. Kontrol cara saran ini diberi skor / peringkat.
`frequency`	`int64` Frekuensi saran ini. Akan digunakan untuk memberi peringkat saran jika skor tidak tersedia.

Kondisi

Menentukan keadaan yang harus diperiksa sebelum mengizinkan perilaku

Kolom

query_terms[]

QueryTerm

Penelusuran hanya Daftar istilah untuk mencocokkan kueri. Tidak dapat disetel saat Condition.query_regex disetel.

Maksimum 10 istilah kueri.

active_time_range[]

TimeRange

Rentang waktu yang menentukan kapan kondisi aktif.

Maksimum 10 rentang waktu.

query_regex

string

Opsional. Regex kueri untuk mencocokkan seluruh kueri penelusuran. Tidak dapat disetel saat Condition.query_terms disetel. Hanya didukung untuk kontrol penayangan promosi Penelusuran Situs Dasar.

QueryTerm

Pencocok untuk kueri permintaan penelusuran

Kolom

value

string

Nilai kueri spesifik yang akan dicocokkan

Harus huruf kecil, harus UTF-8. Dapat memiliki maksimal 3 istilah yang dipisahkan spasi jika full_match benar (true). Tidak boleh berupa string kosong. Panjang maksimum 5.000 karakter.

full_match

bool

Apakah kueri penelusuran harus sama persis dengan istilah kueri.

TimeRange

Digunakan untuk kondisi yang bergantung pada waktu.

Kolom

start_time

Awal rentang waktu.

Rentang bersifat inklusif.

end_time

Akhir rentang waktu.

Rentang bersifat inklusif. Harus di masa depan.

ConnectorType

Jenis konektor.

Enum
`CONNECTOR_TYPE_UNSPECIFIED`	Nilai default.
`THIRD_PARTY`	Konektor pihak ketiga ke konektor ke aplikasi pihak ketiga.
`GCP_FHIR`	Konektor data menghubungkan antara penyimpanan FHIR dan penyimpanan data VAIS.
`BIG_QUERY`	Konektor BigQuery.
`GCS`	Konektor Google Cloud Storage.
`GOOGLE_MAIL`	Konektor Gmail.
`GOOGLE_CALENDAR`	Konektor Google Kalender.
`GOOGLE_DRIVE`	Konektor Google Drive.
`NATIVE_CLOUD_IDENTITY`	Konektor Cloud Identity native untuk penelusuran orang yang didukung oleh People API.
`THIRD_PARTY_FEDERATED`	Konektor federasi adalah konektor pihak ketiga yang tidak melakukan penyerapan data, dan penelusuran didukung oleh API aplikasi pihak ketiga.
`THIRD_PARTY_EUA`	Konektor yang digunakan untuk fitur Autentikasi Pengguna Akhir.
`GCNV`	Konektor Google Cloud NetApp Volumes.

ContactDetails

Info kontak yang disimpan di tingkat resource. Jika tingkat project dan tingkat resource diisi, info kontak tingkat resource akan menggantikan info kontak tingkat project.

Kolom

email_address

string

Opsional. Alamat email kontak.

Kontrol

Menentukan perilaku bersyarat yang akan diterapkan selama penyajian. Harus dilampirkan ke ServingConfig agar dipertimbangkan pada waktu penayangan. Tindakan yang diizinkan bergantung pada SolutionType.

Kolom
`name`	`string` Tidak dapat diubah. Nama yang sepenuhnya memenuhi syarat `projects//locations/global/dataStore//controls/*`
`display_name`	`string` Wajib. Nama yang dapat dibaca manusia. ID yang digunakan dalam tampilan UI. Harus berupa string berenkode UTF-8. Batas panjang adalah 128 karakter. Jika tidak, error ARGUMEN TIDAK VALID akan ditampilkan.
`associated_serving_config_ids[]`	`string` Hanya output. Daftar semua ID `ServingConfig` yang terlampir pada kontrol ini. Mungkin perlu waktu hingga 10 menit untuk memperbarui setelah perubahan.
`solution_type`	`SolutionType` Wajib. Tidak dapat diubah. Solusi yang menjadi bagian dari kontrol. Harus kompatibel dengan kategori resource. Jika tidak, error ARGUMEN TIDAK VALID akan ditampilkan.
`use_cases[]`	`SearchUseCase` Menentukan kasus penggunaan untuk kontrol. Memengaruhi kolom kondisi yang dapat ditetapkan. Hanya berlaku untuk `SOLUTION_TYPE_SEARCH`. Saat ini hanya mengizinkan satu kasus penggunaan per kontrol. Harus ditetapkan jika solution_type adalah `SolutionType.SOLUTION_TYPE_SEARCH`.
`conditions[]`	`Condition` Menentukan kapan tindakan terkait akan dipicu. Hilangkan untuk selalu menerapkan tindakan. Saat ini hanya satu kondisi yang dapat ditentukan. Jika tidak, error ARGUMEN TIDAK VALID akan ditampilkan.
Kolom union `action`. Tindakan dibatasi menurut Vertikal dan Solusi Wajib. `action` hanya dapat berupa salah satu dari hal berikut:
`boost_action`	`BoostAction` Menentukan kontrol jenis pendorong
`filter_action`	`FilterAction` Menentukan kontrol jenis filter Saat ini tidak didukung oleh Rekomendasi
`redirect_action`	`RedirectAction` Menentukan kontrol jenis pengalihan.
`synonyms_action`	`SynonymsAction` Memperlakukan sekelompok istilah sebagai sinonim satu sama lain.
`promote_action`	`PromoteAction` Mempromosikan link tertentu berdasarkan kueri pemicu yang telah ditentukan sebelumnya.

BoostAction

Menyesuaikan urutan produk dalam daftar yang ditampilkan.

Kolom
`boost (deprecated)`	`float` Item ini tidak digunakan lagi. Kekuatan pendorong, yang harus berada dalam [-1, 1]. Peningkatan negatif berarti penurunan. Defaultnya adalah 0.0 (No-op).
`filter`	`string` Wajib. Menentukan produk yang akan diterapkan peningkatannya. Jika tidak ada filter yang diberikan, semua produk akan dipromosikan (No-op). Dokumentasi sintaksis: https://cloud.google.com/retail/docs/filter-and-order Panjang maksimum adalah 5.000 karakter. Jika tidak, error ARGUMEN TIDAK VALID akan ditampilkan.
`data_store`	`string` Wajib. Menentukan dokumen penyimpanan data mana yang dapat dipromosikan oleh kontrol ini. Nama lengkap penyimpanan data, misalnya projects/123/locations/global/collections/default_collection/dataStores/default_data_store
Kolom union `boost_spec`. Spesifikasi peningkatan nilai konstan atau peningkatan nilai berdasarkan peringkat kustom. `boost_spec` hanya ada berupa salah satu diantara berikut:
`fixed_boost`	`float` Opsional. Kekuatan pendorong, yang harus berada dalam [-1, 1]. Peningkatan negatif berarti penurunan. Defaultnya adalah 0.0 (No-op).
`interpolation_boost_spec`	`InterpolationBoostSpec` Opsional. Spesifikasi kompleks untuk peringkat kustom berdasarkan nilai atribut yang ditentukan pelanggan.

InterpolationBoostSpec

Spesifikasi untuk peringkat kustom berdasarkan nilai atribut yang ditentukan pelanggan. Hal ini memberikan lebih banyak kontrol untuk peringkat yang disesuaikan daripada kombinasi (kondisi, peningkatan) sederhana di atas.

Kolom
`field_name`	`string` Opsional. Nama kolom yang nilainya akan digunakan untuk menentukan jumlah peningkat.
`attribute_type`	`AttributeType` Opsional. Jenis atribut yang akan digunakan untuk menentukan jumlah peningkat. Nilai atribut dapat diperoleh dari nilai kolom field_name yang ditentukan. Untuk nilai numerik, caranya mudah, yaitu attribute_value = numerical_field_value. Namun, dalam kasus keaktualan, attribute_value = (time.now() - datetime_field_value).
`interpolation_type`	`InterpolationType` Opsional. Jenis interpolasi yang akan diterapkan untuk menghubungkan titik kontrol yang tercantum di bawah.
`control_points[]`	`ControlPoint` Opsional. Titik kontrol yang digunakan untuk menentukan kurva. Fungsi monotonik (ditentukan melalui interpolation_type di atas) melewati titik kontrol yang tercantum di sini.

AttributeType

Atribut(atau fungsi) yang akan diterapkan peringkat kustomnya.

Enum
`ATTRIBUTE_TYPE_UNSPECIFIED`	AttributeType tidak ditentukan.
`NUMERICAL`	Nilai kolom numerik akan digunakan untuk memperbarui jumlah peningkat secara dinamis. Dalam hal ini, attribute_value (nilai x) titik kontrol akan menjadi nilai sebenarnya dari kolom numerik yang boost_amount-nya ditentukan.
`FRESHNESS`	Untuk kasus penggunaan keaktualan, nilai atribut akan berupa durasi antara waktu saat ini dan tanggal di kolom datetime yang ditentukan. Nilai harus diformat sebagai nilai XSD `dayTimeDuration` (subset terbatas dari nilai durasi ISO 8601). Pola untuk ini adalah: `[nD][T[nH][nM][nS]]`. Misalnya, `5D`, `3DT12H30M`, `T24H`.

ControlPoint

Titik kontrol yang digunakan untuk menentukan kurva. Kurva yang ditentukan melalui titik kontrol ini hanya dapat meningkat atau menurun secara monoton(nilai konstan dapat diterima).

Kolom

attribute_value

string

Opsional. Dapat berupa salah satu dari: 1. Nilai kolom numerik. 2. Spesifikasi durasi untuk keaktualan: Nilai harus diformat sebagai nilai XSD dayTimeDuration (subset terbatas dari nilai durasi ISO 8601). Pola untuk ini adalah: [nD][T[nH][nM][nS]].

boost_amount

float

Opsional. Nilai antara -1 hingga 1 yang digunakan untuk meningkatkan skor jika attribute_value dievaluasi ke nilai yang ditentukan di atas.

InterpolationType

Jenis interpolasi yang akan diterapkan. Defaultnya adalah linear (Piecewise Linear).

Enum
`INTERPOLATION_TYPE_UNSPECIFIED`	Jenis interpolasi tidak ditentukan. Dalam hal ini, nilai defaultnya adalah Linear.
`LINEAR`	Interpolasi linear sepotong-sepotong akan diterapkan.

FilterAction

Menentukan produk mana yang dapat disertakan dalam hasil. Menggunakan filter yang sama dengan promosi.

Kolom

filter

string

Wajib. Filter yang akan diterapkan pada hasil kondisi pencocokan.

Dokumentasi Sintaksis yang diperlukan: https://cloud.google.com/retail/docs/filter-and-order Panjang maksimum adalah 5.000 karakter. Jika tidak, error ARGUMEN TIDAK VALID akan ditampilkan.

data_store

string

Wajib. Menentukan dokumen penyimpanan data mana yang dapat difilter oleh kontrol ini. Nama lengkap penyimpanan data, misalnya projects/123/locations/global/collections/default_collection/dataStores/default_data_store

PromoteAction

Mempromosikan link tertentu berdasarkan beberapa kueri pemicu.

Contoh: Promosikan link toko sepatu saat menelusuri kata kunci shoe. Link dapat berada di luar penyimpanan data terkait.

Kolom

data_store

string

Wajib. Penyimpanan data yang terkait dengan promosi ini.

search_link_promotion

SearchLinkPromotion

Wajib. Promosi yang dilampirkan pada tindakan ini.

RedirectAction

Mengarahkan pembeli ke URI yang disediakan.

Kolom

redirect_uri

string

Wajib. URI yang menjadi tujuan pengalihan pembeli.

Wajib. URI harus memiliki panjang yang sama atau kurang dari 2.000 karakter. Jika tidak, error ARGUMEN TIDAK VALID akan ditampilkan.

SynonymsAction

Membuat sekumpulan istilah yang akan bertindak sebagai sinonim satu sama lain.

Contoh: "senang" juga akan dianggap sebagai "bahagia", "bahagia" juga akan dianggap sebagai "senang".

Kolom

synonyms[]

string

Menentukan sekumpulan sinonim. Dapat menentukan hingga 100 sinonim. Harus menentukan minimal 2 sinonim. Jika tidak, error ARGUMEN TIDAK VALID akan ditampilkan.

Percakapan

Definisi proto percakapan eksternal.

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`	`State` Status Percakapan.
`user_pseudo_id`	`string` ID unik untuk melacak pengguna.
`messages[]`	`ConversationMessage` Pesan percakapan.
`start_time`	`Timestamp` Hanya output. Waktu percakapan dimulai.
`end_time`	`Timestamp` Hanya output. Waktu percakapan selesai.

Negara bagian/Provinsi

Enumerasi status percakapan.

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

ConversationContext

Menentukan konteks percakapan

Kolom

context_documents[]

string

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

active_document

string

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

ConversationMessage

Menentukan pesan percakapan.

Kolom
`create_time`	`Timestamp` Hanya output. Stempel waktu pembuatan pesan.
Kolom union `message`. `message` hanya dapat berupa salah satu dari hal berikut:
`user_input`	`TextInput` Input teks pengguna.
`reply`	`Reply` Balasan penelusuran.

ConverseConversationRequest

Pesan permintaan untuk metode ConversationalSearchService.ConverseConversation.

Kolom
`name`	`string` Wajib. Nama resource Percakapan yang akan didapatkan. Format `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. Gunakan `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/-` untuk mengaktifkan mode sesi otomatis, yang otomatis membuat percakapan baru di dalam sesi ConverseConversation.
`query`	`TextInput` Wajib. Input pengguna saat ini.
`serving_config`	`string` Nama resource Konfigurasi Penayangan yang akan digunakan. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}` Jika tidak disetel, konfigurasi penayangan default akan digunakan.
`conversation`	`Conversation` Percakapan yang akan digunakan oleh sesi otomatis saja. Kolom nama akan diabaikan karena kami otomatis menetapkan nama baru untuk percakapan dalam sesi otomatis.
`safe_search`	`bool` Apakah akan mengaktifkan safe search.
`user_labels`	`map<string, string>` Label pengguna yang diterapkan ke resource harus memenuhi persyaratan berikut: Setiap resource dapat memiliki beberapa label, hingga maksimum 64 label. Setiap label harus berupa pasangan nilai kunci. Kunci memiliki panjang minimum 1 karakter dan panjang maksimum 63 karakter, serta tidak boleh kosong. Nilai boleh kosong dan memiliki panjang maksimum 63 karakter. Kunci dan nilai hanya boleh berisi huruf kecil, karakter numerik, garis bawah, dan tanda hubung. Semua karakter harus menggunakan encoding UTF-8, dan karakter internasional boleh digunakan. Bagian kunci label harus unik. Namun, Anda dapat menggunakan kunci yang sama dengan beberapa resource. Kunci harus diawali dengan huruf kecil atau karakter internasional. Lihat Dokumen Google Cloud untuk mengetahui detail selengkapnya.
`summary_spec`	`SummarySpec` Spesifikasi untuk mengonfigurasi ringkasan yang ditampilkan dalam respons.
`filter`	`string` Sintaksis filter terdiri dari bahasa ekspresi untuk membuat predikat dari satu atau beberapa kolom dokumen yang difilter. Ekspresi filter peka huruf besar/kecil. Hal ini akan digunakan untuk memfilter hasil penelusuran yang dapat memengaruhi respons ringkasan. Jika kolom ini tidak dapat dikenali, `INVALID_ARGUMENT` akan ditampilkan. Pemfilteran di Vertex AI Search dilakukan dengan memetakan kunci filter LHS ke properti kunci yang ditentukan di backend Vertex AI Search -- pemetaan ini ditentukan oleh pelanggan dalam skemanya. Misalnya, pelanggan media mungkin memiliki kolom 'name' dalam skemanya. Dalam hal ini, filter akan terlihat seperti ini: filter --> name:'ANY("king kong")' Untuk mengetahui informasi selengkapnya tentang pemfilteran, termasuk sintaksis dan operator filter, lihat Filter
`boost_spec`	`BoostSpec` Spesifikasi peningkat untuk meningkatkan kualitas dokumen tertentu dalam hasil penelusuran yang dapat memengaruhi respons percakapan. Untuk mengetahui informasi selengkapnya tentang promosi, lihat Promosi

ConverseConversationResponse

Pesan respons untuk metode ConversationalSearchService.ConverseConversation.

Kolom

reply

Reply

Jawaban untuk kueri saat ini.

conversation

Percakapan yang diperbarui termasuk jawabannya.

search_results[]

SearchResult

Hasil Penelusuran.

CreateAssistantRequest

Permintaan untuk metode AssistantService.CreateAssistant.

Kolom

parent

string

Wajib. Nama resource induk. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}

assistant

Assistant

Wajib. Assistant yang akan dibuat.

assistant_id

string

Wajib. ID yang akan digunakan untuk Assistant, yang akan menjadi komponen akhir dari nama resource Assistant.

Kolom ini harus sesuai dengan RFC-1034 dengan batas panjang 63 karakter.

CreateControlRequest

Permintaan untuk metode CreateControl.

Kolom

parent

string

Wajib. Nama lengkap resource penyimpanan data induk. Format: projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id} atau projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}.

control

Control

Wajib. Kontrol yang akan dibuat.

control_id

string

Wajib. ID yang akan digunakan untuk Kontrol, yang akan menjadi komponen akhir dari nama resource Kontrol.

Nilai ini harus terdiri dari 1-63 karakter. Karakter yang valid adalah /[a-z][0-9]-_/.

CreateConversationRequest

Permintaan untuk metode CreateConversation.

Kolom

parent

string

Wajib. Nama lengkap resource penyimpanan data induk. Format: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}

conversation

Wajib. Percakapan yang akan dibuat.

CreateDataStoreMetadata

Metadata yang terkait dengan progres operasi DataStoreService.CreateDataStore. Hal ini akan ditampilkan oleh kolom google.longrunning.Operation.metadata.

Kolom

create_time

Waktu pembuatan operasi.

update_time

Waktu update terakhir operasi. Jika operasi selesai, ini juga merupakan waktu selesainya.

CreateDataStoreRequest

Permintaan untuk metode DataStoreService.CreateDataStore.

Kolom
`parent`	`string` Wajib. Nama resource induk, seperti `projects/{project}/locations/{location}/collections/{collection}`.
`data_store`	`DataStore` Wajib. `DataStore` yang akan dibuat.
`data_store_id`	`string` Wajib. ID yang akan digunakan untuk `DataStore`, yang akan menjadi komponen akhir dari nama resource `DataStore`. Kolom ini harus sesuai dengan standar RFC-1034 dengan batas panjang 63 karakter. Jika tidak, error INVALID_ARGUMENT akan ditampilkan.
`create_advanced_site_search`	`bool` Flag boolean yang menunjukkan apakah pengguna ingin membuat penyimpanan data lanjutan secara langsung untuk penelusuran situs. Jika penyimpanan data tidak dikonfigurasi sebagai penelusuran situs (vertical GENERIC dan content_config PUBLIC_WEBSITE), tanda ini akan diabaikan.
`skip_default_schema_creation`	`bool` Tanda boolean yang menunjukkan apakah akan melewati pembuatan skema default untuk penyimpanan data. Aktifkan tanda ini hanya jika Anda yakin bahwa skema default tidak kompatibel dengan kasus penggunaan Anda. Jika disetel ke benar (true), Anda harus membuat skema untuk penyimpanan data secara manual sebelum dokumen dapat di-ingest. Flag ini tidak dapat ditentukan jika `data_store.starting_schema` ditentukan.
Kolom union `cmek_options`. Opsi CMEK untuk DataStore. Menetapkan kolom ini akan menggantikan CmekConfig default jika ada yang ditetapkan untuk project. `cmek_options` hanya ada berupa salah satu diantara berikut:
`cmek_config_name`	`string` Nama resource CmekConfig yang akan digunakan untuk melindungi DataStore ini.
`disable_cmek`	`bool` DataStore tanpa perlindungan CMEK. Jika CmekConfig default ditetapkan untuk project, menyetel kolom ini juga akan menggantikan CmekConfig default.

CreateDocumentRequest

Pesan permintaan untuk metode DocumentService.CreateDocument.

Kolom

parent

string

Wajib. Nama resource induk, seperti projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}.

document

Wajib. Document yang akan dibuat.

document_id

string

Wajib. ID yang akan digunakan untuk Document, yang menjadi komponen akhir Document.name.

Jika pemanggil tidak memiliki izin untuk membuat Document, terlepas dari apakah Document tersebut ada atau tidak, error PERMISSION_DENIED akan ditampilkan.

Kolom ini harus unik di antara semua Document dengan parent yang sama. Jika tidak, error ALREADY_EXISTS akan ditampilkan.

Kolom ini harus sesuai dengan standar RFC-1034 dengan batas panjang 128 karakter. Jika tidak, error INVALID_ARGUMENT akan ditampilkan.

CreateEngineMetadata

Metadata yang terkait dengan progres operasi EngineService.CreateEngine. Hal ini akan ditampilkan oleh kolom google.longrunning.Operation.metadata.

Kolom

create_time

Waktu pembuatan operasi.

update_time

Waktu update terakhir operasi. Jika operasi selesai, ini juga merupakan waktu selesainya.

CreateEngineRequest

Permintaan untuk metode EngineService.CreateEngine.

Kolom

parent

string

Wajib. Nama resource induk, seperti projects/{project}/locations/{location}/collections/{collection}.

engine

Engine

Wajib. Engine yang akan dibuat.

engine_id

string

Wajib. ID yang akan digunakan untuk Engine, yang akan menjadi komponen akhir dari nama resource Engine.

Kolom ini harus sesuai dengan standar RFC-1034 dengan batas panjang 63 karakter. Jika tidak, error INVALID_ARGUMENT akan ditampilkan.

CreateIdentityMappingStoreRequest

Pesan permintaan untuk IdentityMappingStoreService.CreateIdentityMappingStore

Kolom
`parent`	`string` Wajib. Nama resource kumpulan induk, seperti `projects/{project}/locations/{location}`.
`identity_mapping_store_id`	`string` Wajib. ID Identity Mapping Store yang akan dibuat. ID hanya boleh berisi huruf (a-z, A-Z), angka (0-9), garis bawah (_), dan tanda hubung (-). Panjang maksimumnya adalah 63 karakter.
`identity_mapping_store`	`IdentityMappingStore` Wajib. Penyimpanan Pemetaan Identitas yang akan dibuat.
Kolom union `cmek_options`. Opsi CMEK untuk Identity Mapping Store. Menetapkan kolom ini akan menggantikan CmekConfig default jika ada yang ditetapkan untuk project. `cmek_options` hanya ada berupa salah satu diantara berikut:
`cmek_config_name`	`string` Nama resource CmekConfig yang akan digunakan untuk melindungi Identity Mapping Store ini.
`disable_cmek`	`bool` Penyimpanan Pemetaan Identitas tanpa perlindungan CMEK. Jika CmekConfig default ditetapkan untuk project, menyetel kolom ini juga akan menggantikan CmekConfig default.

CreateLicenseConfigRequest

Pesan permintaan untuk metode LicenseConfigService.CreateLicenseConfig.

Kolom

parent

string

Wajib. Nama resource induk, seperti projects/{project}/locations/{location}.

license_config

LicenseConfig

Wajib. LicenseConfig yang akan dibuat.

license_config_id

string

Opsional. ID yang akan digunakan untuk LicenseConfig, yang akan menjadi komponen akhir dari nama resource LicenseConfig. Kami menggunakan nama tingkat (edisi produk) sebagai ID konfigurasi lisensi seperti search atau search_and_assistant.

CreateSchemaMetadata

Metadata untuk LRO Buat Skema.

Kolom

create_time

Waktu pembuatan operasi.

update_time

Waktu update terakhir operasi. Jika operasi selesai, ini juga merupakan waktu selesainya.

CreateSchemaRequest

Pesan permintaan untuk metode SchemaService.CreateSchema.

Kolom

parent

string

Wajib. Nama resource penyimpanan data induk, dalam format projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}.

schema

Schema

Wajib. Schema yang akan dibuat.

schema_id

string

Wajib. ID yang akan digunakan untuk Schema, yang menjadi komponen akhir Schema.name.

Kolom ini harus sesuai dengan standar RFC-1034 dengan batas panjang 63 karakter.

CreateSessionRequest

Permintaan untuk metode CreateSession.

Kolom

parent

string

Wajib. Nama lengkap resource penyimpanan data induk. Format: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}

session

Wajib. Sesi yang akan dibuat.

CreateSitemapMetadata

Metadata yang terkait dengan progres operasi SiteSearchEngineService.CreateSitemap. Hal ini akan ditampilkan oleh kolom google.longrunning.Operation.metadata.

Kolom

create_time

Waktu pembuatan operasi.

update_time

Waktu update terakhir operasi. Jika operasi selesai, ini juga merupakan waktu selesainya.

CreateSitemapRequest

Pesan permintaan untuk metode SiteSearchEngineService.CreateSitemap.

Kolom

parent

string

Wajib. Nama resource induk SiteSearchEngine, seperti projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine.

sitemap

Sitemap

Wajib. Sitemap yang akan dibuat.

CreateTargetSiteMetadata

Metadata yang terkait dengan progres operasi SiteSearchEngineService.CreateTargetSite. Hal ini akan ditampilkan oleh kolom google.longrunning.Operation.metadata.

Kolom

create_time

Waktu pembuatan operasi.

update_time

Waktu update terakhir operasi. Jika operasi selesai, ini juga merupakan waktu selesainya.

CreateTargetSiteRequest

Pesan permintaan untuk metode SiteSearchEngineService.CreateTargetSite.

Kolom

parent

string

Wajib. Nama resource induk TargetSite, seperti projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine.

target_site

Wajib. TargetSite yang akan dibuat.

CustomAttribute

Atribut kustom yang tidak dimodelkan secara eksplisit dalam resource, misalnya UserEvent.

Kolom

text[]

string

Nilai tekstual atribut khusus ini. Misalnya, ["yellow", "green"] saat kuncinya adalah "color".

String kosong tidak diizinkan. Jika tidak, error INVALID_ARGUMENT akan ditampilkan.

Tepatnya salah satu dari CustomAttribute.text atau CustomAttribute.numbers yang harus ditetapkan. Jika tidak, error INVALID_ARGUMENT akan ditampilkan.

numbers[]

double

Nilai numerik atribut khusus ini. Misalnya, [2.3, 15.4] jika kuncinya adalah "lengths_cm".

Tepatnya salah satu dari CustomAttribute.text atau CustomAttribute.numbers yang harus ditetapkan. Jika tidak, error INVALID_ARGUMENT akan ditampilkan.

CustomTuningModel

Metadata yang mendeskripsikan model yang di-tune kustom.

Kolom
`name`	`string` Wajib. Nama resource model yang sepenuhnya memenuhi syarat. Format `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}`. Model harus berupa string alfanumerik dengan batas 40 karakter.
`display_name`	`string` Nama tampilan model.
`model_version`	`int64` Versi model.
`model_state`	`ModelState` Status model (misalnya,`TRAINING` atau `TRAINING_FAILED`).
`create_time (deprecated)`	`Timestamp` Item ini tidak digunakan lagi. Tidak digunakan lagi: Stempel waktu saat Model dibuat.
`training_start_time`	`Timestamp` Stempel waktu saat pelatihan model dimulai.
`metrics`	`map<string, double>` Metrik model terlatih.
`error_message`	`string` Saat ini, kolom ini hanya diisi jika status modelnya adalah `INPUT_VALIDATION_FAILED`.

ModelState

Status model.

Enum
`MODEL_STATE_UNSPECIFIED`	Nilai default.
`TRAINING_PAUSED`	Model berada dalam status pelatihan yang dijeda.
`TRAINING`	Model saat ini sedang dilatih.
`TRAINING_COMPLETE`	Model telah berhasil menyelesaikan pelatihan.
`READY_FOR_SERVING`	Model siap untuk penayangan.
`TRAINING_FAILED`	Pelatihan model gagal.
`NO_IMPROVEMENT`	Pelatihan model berhasil diselesaikan, tetapi metrik tidak meningkat.
`INPUT_VALIDATION_FAILED`	Validasi data input gagal. Pelatihan model tidak dimulai.

DataConnector

Mengelola koneksi ke sumber data eksternal untuk semua penyimpanan data yang dikelompokkan dalam Collection. Ini adalah resource singleton Collection. Inisialisasi hanya didukung melalui metode DataConnectorService.SetUpDataConnector, yang akan membuat Collection baru dan melakukan inisialisasi DataConnector-nya.

Kolom
`name`	`string` Hanya output. Nama lengkap resource Data Connector. Format `projects//locations//collections/*/dataConnector`.
`state`	`State` Hanya output. Status konektor.
`data_source`	`string` Wajib. Nama sumber data. Nilai yang didukung: `salesforce`, `jira`, `confluence`, `bigquery`.
`remove_param_keys[]`	`string` Opsional. Menentukan kunci yang akan dihapus dari kolom 'params'. Tindakan ini hanya aktif jika 'params' disertakan dalam 'update_mask' di UpdateDataConnectorRequest. Penghapusan lebih diprioritaskan jika kunci ada di 'remove_param_keys' dan ada di kolom 'params' permintaan.
`refresh_interval`	`Duration` Wajib. Interval pembaruan untuk sinkronisasi data. Jika durasi disetel ke 0, data akan disinkronkan secara real time. Fitur streaming belum didukung. Durasi minimumnya adalah 30 menit dan maksimumnya adalah 7 hari. Jika interval refresh disetel ke nilai yang sama dengan interval refresh inkremental, sinkronisasi inkremental akan dinonaktifkan.
`next_sync_time`	`DateTime` Menentukan waktu terjadwal untuk sinkronisasi data berikutnya. Kolom ini memerlukan hour , minute, dan time_zone dari Database Zona Waktu IANA. Opsi ini digunakan saat konektor data memiliki interval pembaruan lebih dari 1 hari. Jika jam atau menit tidak ditentukan, kami akan mengasumsikan waktu sinkronisasi 0:00. Pengguna harus memberikan zona waktu untuk menghindari ambiguitas.
`entities[]`	`SourceEntity` Daftar entitas dari sumber data yang terhubung untuk diproses.
`create_time`	`Timestamp` Hanya output. Stempel waktu saat `DataConnector` dibuat.
`latest_pause_time`	`Timestamp` Hanya output. Stempel waktu terbaru saat `DataConnector` ini dijeda, yang memengaruhi semua fungsi seperti sinkronisasi data. Menjeda konektor akan memberikan efek berikut: - Semua fungsi, termasuk sinkronisasi data, akan dihentikan. - Semua tugas sinkronisasi data yang sedang berlangsung akan dibatalkan. - Tidak ada operasi sinkronisasi data mendatang yang akan dijadwalkan atau dapat dipicu.
`last_sync_time`	`Timestamp` Hanya output. Khusus untuk konektor berkala, waktu terakhir sinkronisasi data selesai.
`update_time`	`Timestamp` Hanya output. Stempel waktu `DataConnector` terakhir diperbarui.
`errors[]`	`Status` Hanya output. Error dari inisialisasi atau dari eksekusi konektor terbaru.
`sync_mode`	`SyncMode` Mode sinkronisasi data yang didukung oleh konektor data.
`kms_key_name`	`string` Hanya input. Kunci KMS yang akan digunakan untuk melindungi DataStore yang dikelola oleh konektor ini. Harus ditetapkan untuk permintaan yang perlu mematuhi perlindungan Kebijakan Org. CMEK. Jika kolom ini ditetapkan dan berhasil diproses, DataStore yang dibuat oleh konektor ini akan dilindungi oleh kunci KMS.
`destination_configs[]`	`DestinationConfig` Opsional. Tujuan target yang digunakan untuk terhubung ke layanan pihak ketiga.
`action_state`	`State` Hanya output. Status konektor tindakan. Ini mencerminkan apakah konektor tindakan sedang diinisialisasi, aktif, atau mengalami error.
`action_config`	`ActionConfig` Opsional. Konfigurasi tindakan untuk membuat konektor mendukung tindakan.
`end_user_config`	`EndUserConfig` Opsional. Semua parameter dan kredensial yang digunakan khusus untuk konektor EUA.
`federated_config`	`FederatedConfig` Opsional. Parameter dan kredensial apa pun yang digunakan secara khusus untuk konektor hybrid yang mendukung mode FEDERATED. Kolom ini hanya boleh ditetapkan jika konektor adalah konektor hybrid dan kita ingin mengaktifkan mode FEDERATED.
`connector_modes[]`	`ConnectorMode` Opsional. Mode yang diaktifkan untuk konektor ini. Status default-nya adalah CONNECTOR_MODE_UNSPECIFIED.
`static_ip_enabled`	`bool` Opsional. Apakah pelanggan telah mengaktifkan alamat IP statis untuk konektor ini.
`static_ip_addresses[]`	`string` Hanya output. Alamat IP statis yang digunakan oleh konektor ini.
`blocking_reasons[]`	`BlockingReason` Hanya output. Tindakan pengguna yang harus diselesaikan sebelum konektor dapat mulai menyinkronkan data.
`identity_refresh_interval (deprecated)`	`Duration` Item ini tidak digunakan lagi. Interval pemuatan ulang untuk menyinkronkan informasi Daftar Kontrol Akses untuk dokumen yang diproses oleh konektor ini. Jika tidak disetel, daftar kontrol akses akan diperbarui pada interval default 30 menit. Interval pembaruan identitas dapat berupa minimal 30 menit dan maksimal 7 hari.
`identity_schedule_config`	`IdentityScheduleConfig` Konfigurasi untuk menjalankan sinkronisasi data identitas. Ini berisi interval pemuatan ulang untuk menyinkronkan informasi Daftar Kontrol Akses untuk dokumen yang diserap oleh konektor ini.
`private_connectivity_project_id`	`string` Hanya output. ID project tenant yang terkait dengan konektor konektivitas pribadi. Project ini harus dimasukkan dalam daftar yang diizinkan agar konektor dapat berfungsi.
`bap_config`	`BAPConfig` Opsional. Konfigurasi untuk membuat koneksi BAP.
`connector_type`	`ConnectorType` Hanya output. Jenis konektor. Setiap sumber hanya dapat dipetakan ke satu jenis. Misalnya, salesforce, confluence, dan jira memiliki jenis konektor THIRD_PARTY. Tidak dapat diubah setelah ditetapkan oleh sistem.
`realtime_state`	`State` Hanya output. Status sinkronisasi real-time
`alert_policy_configs[]`	`AlertPolicyConfig` Opsional. Konfigurasi pemberitahuan tingkat konektor.
`realtime_sync_config`	`RealtimeSyncConfig` Opsional. Konfigurasi untuk sinkronisasi real-time.
`acl_enabled`	`bool` Opsional. Apakah konektor akan dibuat dengan konfigurasi ACL. Saat ini, kolom ini hanya memengaruhi konektor Cloud Storage dan BigQuery.
`create_eua_saas`	`bool` Opsional. Apakah konektor END USER AUTHENTICATION dibuat di SaaS.
`auto_run_disabled`	`bool` Opsional. Menunjukkan apakah konektor dinonaktifkan untuk menjalankan otomatis. Dapat digunakan untuk menjeda sinkronisasi berkala dan real time. Update: dengan diperkenalkannya incremental_sync_disabled, auto_run_disabled digunakan untuk menjeda/menonaktifkan hanya sinkronisasi penuh
`incremental_sync_disabled`	`bool` Opsional. Menunjukkan apakah sinkronisasi inkremental dijeda untuk konektor ini. Ini tidak bergantung pada auto_run_disabled. Hanya berlaku untuk konektor pihak ketiga. Jika interval refresh disetel ke nilai yang sama dengan interval refresh inkremental, sinkronisasi inkremental akan dinonaktifkan, yaitu disetel ke benar (true).
`incremental_refresh_interval`	`Duration` Opsional. Interval refresh khusus untuk sinkronisasi data inkremental. Jika tidak disetel, sinkronisasi inkremental akan menggunakan default dari env, yang disetel ke 3 jam. Durasi minimumnya adalah 30 menit dan maksimumnya adalah 7 hari. Hanya berlaku untuk konektor pihak ketiga. Jika interval refresh disetel ke nilai yang sama dengan interval refresh inkremental, sinkronisasi inkremental akan dinonaktifkan.
`hybrid_ingestion_disabled`	`bool` Opsional. Jika konektor adalah konektor hybrid, tentukan apakah penyerapan diaktifkan dan resource yang sesuai disediakan selama pembuatan konektor. Jika konektor bukan konektor hybrid, kolom ini akan diabaikan.
Kolom union `data_connector_params`. Parameter yang diperlukan untuk mengakses sumber dalam format pasangan (Kunci, Nilai). Nilai string dengan format `projects//[locations//]secrets//versions/` akan dibaca dari Secret Manager. Parameter wajib untuk semua sumber data: Kunci: `instance_uri` Nilai: jenis STRING. URI untuk mengakses sumber data. Parameter wajib untuk sumber yang mendukung OAUTH, yaitu `salesforce`: Kunci: `client_id` Nilai: jenis STRING. ID klien untuk penyedia layanan pihak ketiga guna mengidentifikasi aplikasi Anda. Kunci: `client_secret` Nilai:STRING jenis. Rahasia klien yang dibuat oleh server otorisasi pihak ketiga. Kunci: `access_token` Nilai: jenis STRING. Token OAuth untuk UCS guna mengakses resource yang dilindungi. Kunci: `refresh_token` Nilai: jenis STRING. Token refresh OAuth untuk UCS guna mendapatkan token akses baru tanpa interaksi pengguna. Parameter wajib untuk sumber yang mendukung autentikasi token API dasar, yaitu `jira`, `confluence`: Kunci: `user_account` Nilai: jenis STRING. Nama pengguna atau email dengan sumber. Kunci: `api_token` Nilai: jenis STRING. Token API yang dibuat untuk akun sumber, yang digunakan untuk mengautentikasi di mana pun Anda akan menggunakan sandi. Contoh: `{ "instance_uri": "https://xxx.atlassian.net", "user_account": "xxxx.xxx@xxx.com", "api_token": "test-token" }` Parameter opsional untuk menentukan jenis otorisasi yang akan digunakan untuk dukungan beberapa jenis otorisasi: Kunci: `auth_type` Nilai: jenis STRING. Jenis otorisasi untuk sumber data. Nilai yang didukung: `BASIC_AUTH`, `OAUTH`, `OAUTH_ACCESS_TOKEN`, `OAUTH_TWO_LEGGED`, `OAUTH_JWT_BEARER`, `OAUTH_PASSWORD_GRANT`, `JWT`, `API_TOKEN`, `FEDERATED_CREDENTIAL`. `data_connector_params` hanya dapat berupa salah satu dari hal berikut:
`params`	`Struct` Parameter konektor data yang diperlukan dalam format json terstruktur.
`json_params`	`string` Parameter konektor data yang diperlukan dalam format string json.

BlockingReason

Tindakan pengguna yang harus diselesaikan sebelum konektor dapat mulai menyinkronkan data.

Enum
`BLOCKING_REASON_UNSPECIFIED`	Nilai default.
`ALLOWLIST_STATIC_IP`	Konektor mengharuskan pelanggan memasukkan IP statis ke dalam daftar yang diizinkan.
`ALLOWLIST_IN_SERVICE_ATTACHMENT`	Konektor mewajibkan pelanggan untuk memasukkan project kami ke dalam daftar yang diizinkan di lampiran layanannya.
`ALLOWLIST_SERVICE_ACCOUNT`	Konektor mengharuskan pelanggan untuk memasukkan akun layanan ke dalam daftar yang diizinkan di project mereka.

ConnectorMode

Mode yang diaktifkan untuk konektor ini. PENYERAPAN, TINDAKAN, GABUNGAN, ATAU EUA

Enum
`CONNECTOR_MODE_UNSPECIFIED`	Mode konektor tidak ditentukan.
`DATA_INGESTION`	Konektor yang digunakan untuk penyerapan data.
`ACTIONS`	Konektor yang digunakan untuk tindakan.
`FEDERATED`	Konektor yang digunakan untuk penelusuran gabungan.
`EUA`	Konektor yang digunakan untuk Autentikasi Pengguna Akhir.
`FEDERATED_AND_EUA`	Konektor hybrid yang digunakan untuk penelusuran gabungan dan Autentikasi Pengguna Akhir.

EndUserConfig

Semua parameter dan kredensial yang digunakan khusus untuk konektor EUA.

Kolom
`additional_params`	`Struct` Opsional. Parameter tambahan yang diperlukan untuk EUA.
`tenant`	`Tenant` Opsional. Project tenant tempat konektor terhubung.
Kolom union `auth_config`. Konfigurasi autentikasi untuk konektor EUA. `auth_config` hanya ada berupa salah satu diantara berikut:
`auth_params`	`Struct` Opsional. Parameter autentikasi apa pun yang khusus untuk konektor EUA.
`json_auth_params`	`string` Opsional. Parameter autentikasi apa pun yang khusus untuk konektor EUA dalam format string json.

FederatedConfig

Parameter dan kredensial apa pun yang digunakan secara khusus untuk konektor hybrid yang mendukung mode FEDERATED.

Kolom
`additional_params`	`Struct` Opsional. Parameter tambahan yang diperlukan untuk FEDERATED.
Kolom union `auth_config`. Konfigurasi autentikasi untuk konektor FEDERATED. `auth_config` hanya ada berupa salah satu diantara berikut:
`auth_params`	`Struct` Opsional. Parameter autentikasi apa pun yang khusus untuk konektor FEDERATED.
`json_auth_params`	`string` Opsional. Parameter autentikasi apa pun yang khusus untuk konektor FEDERATED dalam format string json.

RealtimeSyncConfig

Konfigurasi untuk sinkronisasi real-time guna menyimpan parameter tambahan untuk sinkronisasi real-time.

Kolom

webhook_uri

string

Opsional. URL webhook untuk konektor guna menentukan parameter tambahan untuk sinkronisasi real-time.

realtime_sync_secret

string

Opsional. ID secret Secret Manager yang digunakan untuk secret webhook.

streaming_error

StreamingError

Opsional. Detail error streaming.

StreamingError

Detail error streaming.

Kolom

streaming_error_reason

StreamingErrorReason

Opsional. Error streaming.

error

Opsional. Detail error.

StreamingErrorReason

Jenis error streaming yang luas.

Enum
`STREAMING_ERROR_REASON_UNSPECIFIED`	Alasan error streaming tidak ditentukan.
`STREAMING_SETUP_ERROR`	Terjadi error saat menyiapkan resource untuk sinkronisasi real-time.
`STREAMING_SYNC_ERROR`	Terjadi error saat menjalankan sinkronisasi real-time untuk konektor.
`INGRESS_ENDPOINT_REQUIRED`	Endpoint ingress diperlukan saat menyiapkan sinkronisasi real-time dalam konektivitas pribadi.

SourceEntity

Mewakili entity di sumber data. Misalnya, objek Account di Salesforce.

Kolom
`entity_name`	`string` Nama entity. Nilai yang didukung menurut sumber data: Salesforce: `Lead`, `Opportunity`, `Contact`, `Account`, `Case`, `Contract`, `Campaign` Jira: `Issue` Confluence: `Content`, `Space`
`key_property_mappings`	`map<string, string>` Atribut untuk pengindeksan. Kunci: Nama kolom. Nilai: Properti kunci untuk memetakan kolom, seperti `title`, dan `description`. Properti utama yang didukung: `title`: Judul untuk catatan data. Hal ini akan ditampilkan di hasil penelusuran. `description`: Deskripsi untuk catatan data. Ini akan ditampilkan di hasil penelusuran.
`data_store`	`string` Hanya output. Nama resource lengkap penyimpanan data terkait untuk entity sumber. Format `projects//locations//collections//dataStores/`. Saat konektor diinisialisasi oleh metode `DataConnectorService.SetUpDataConnector`, `DataStore` akan otomatis dibuat untuk setiap entity sumber.
`starting_schema`	`Schema` Opsional. Skema awal yang akan digunakan untuk `DataStore` yang dibuat dari SourceEntity ini. Jika tidak disetel, skema khusus vertikal default akan digunakan. Kolom ini hanya digunakan oleh API [SetUpDataConnector][] dan akan diabaikan jika digunakan di API lain. Kolom ini akan dihilangkan dari semua respons API, termasuk API [GetDataConnector][]. Untuk mengambil skema `DataStore`, gunakan `SchemaService.GetSchema` API. Skema yang diberikan akan divalidasi terhadap aturan tertentu pada schema.org. Pelajari lebih lanjut dari dokumen ini.
`healthcare_fhir_config`	`HealthcareFhirConfig` Opsional. Konfigurasi untuk vertikal `HEALTHCARE_FHIR`.
Kolom union `entity_params`. Parameter untuk entitas guna memfasilitasi penyerapan data. Misalnya, untuk konektor BigQuery: Kunci: `document_id_column` Nilai: jenis STRING. Nilai ID kolom. `entity_params` hanya dapat berupa salah satu dari hal berikut:
`params`	`Struct` Parameter untuk entitas guna memfasilitasi penyerapan data dalam format json terstruktur.
`json_params`	`string` Parameter untuk entitas guna memfasilitasi penyerapan data dalam format string json.

Negara bagian/Provinsi

Status konektor.

Enum
`STATE_UNSPECIFIED`	Nilai default.
`CREATING`	Konektor sedang disiapkan.
`ACTIVE`	Konektor berhasil disiapkan dan menunggu proses sinkronisasi berikutnya.
`FAILED`	Konektor mengalami error. Detail error dapat ditemukan di `DataConnector.errors`. Jika error tidak dapat diperbaiki, `DataConnector` dapat dihapus oleh API [CollectionService.DeleteCollection].
`RUNNING`	Konektor secara aktif menyinkronkan data dari sumber data.
`WARNING`	Konektor telah menyelesaikan proses sinkronisasi, tetapi mengalami error non-fatal.
`INITIALIZATION_FAILED`	Inisialisasi konektor gagal. Kemungkinan penyebabnya mencakup error runtime atau masalah dalam pipeline asinkron, yang mencegah permintaan mencapai layanan hilir (kecuali untuk beberapa jenis konektor).
`UPDATING`	Konektor sedang dalam proses update.

SyncMode

Menentukan mode sinkronisasi data yang didukung oleh konektor data.

Enum
`PERIODIC`	Konektor akan menyinkronkan data secara berkala berdasarkan refresh_interval. Gunakan dengan auto_run_disabled untuk menjeda sinkronisasi berkala, atau menunjukkan sinkronisasi satu kali.
`STREAMING`	Data akan disinkronkan secara real time.
`UNSPECIFIED`	Konektor yang tidak menyerap data akan memiliki nilai ini

DataStore

DataStore merekam setelan dan konfigurasi global di tingkat DataStore.

Kolom
`name`	`string` Tidak dapat diubah. ID. Nama lengkap resource penyimpanan data. Format `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. Kolom ini harus berupa string berenkode UTF-8 dengan batas panjang 1.024 karakter.
`display_name`	`string` Wajib. Nama tampilan penyimpanan data. Kolom ini harus berupa string berenkode UTF-8 dengan batas panjang 128 karakter. Jika tidak, error INVALID_ARGUMENT akan ditampilkan.
`industry_vertical`	`IndustryVertical` Tidak dapat diubah. Bidang industri yang didaftarkan oleh penyimpanan data.
`solution_types[]`	`SolutionType` Solusi yang didaftarkan oleh penyimpanan data. Solusi yang tersedia untuk setiap `industry_vertical`: `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` dan `SOLUTION_TYPE_SEARCH`. `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` didaftarkan secara otomatis. Solusi lain tidak dapat didaftarkan.
`default_schema_id`	`string` Hanya output. ID `Schema` default yang terkait dengan penyimpanan data ini.
`content_config`	`ContentConfig` Tidak dapat diubah. Konfigurasi konten penyimpanan data. Jika kolom ini tidak disetel, perilaku server akan ditetapkan secara default ke `ContentConfig.NO_CONTENT`.
`create_time`	`Timestamp` Hanya output. Stempel waktu saat `DataStore` dibuat.
`advanced_site_search_config`	`AdvancedSiteSearchConfig` Opsional. Konfigurasi untuk penelusuran situs lanjutan.
`kms_key_name`	`string` Hanya input. Kunci KMS yang akan digunakan untuk melindungi DataStore ini pada saat pembuatan. Harus ditetapkan untuk permintaan yang perlu mematuhi perlindungan Kebijakan Org. CMEK. Jika kolom ini ditetapkan dan diproses dengan berhasil, DataStore akan dilindungi oleh kunci KMS, seperti yang ditunjukkan di kolom cmek_config.
`cmek_config`	`CmekConfig` Hanya output. Informasi terkait CMEK untuk DataStore.
`billing_estimation`	`BillingEstimation` Hanya output. Estimasi ukuran data untuk penagihan.
`acl_enabled`	`bool` Tidak dapat diubah. Apakah data dalam `DataStore` memiliki informasi ACL. Jika ditetapkan ke `true`, data sumber harus memiliki ACL. ACL akan diserap saat data diserap oleh metode `DocumentService.ImportDocuments`. Jika ACL diaktifkan untuk `DataStore`, `Document` tidak dapat diakses dengan memanggil `DocumentService.GetDocument` atau `DocumentService.ListDocuments`. Saat ini, ACL hanya didukung di vertikal industri `GENERIC` dengan konfigurasi konten non-`PUBLIC_WEBSITE`.
`workspace_config`	`WorkspaceConfig` Konfigurasi untuk menyimpan konfigurasi jenis penyimpanan data untuk data ruang kerja. Properti ini harus ditetapkan jika `DataStore.content_config` ditetapkan sebagai `DataStore.ContentConfig.GOOGLE_WORKSPACE`.
`document_processing_config`	`DocumentProcessingConfig` Konfigurasi untuk Pemahaman dan pengayaan dokumen.
`starting_schema`	`Schema` Skema awal yang akan digunakan untuk `DataStore` ini saat menyediakannya. Jika tidak disetel, skema khusus vertikal default akan digunakan. Kolom ini hanya digunakan oleh API `CreateDataStore`, dan akan diabaikan jika digunakan di API lain. Kolom ini akan dihilangkan dari semua respons API, termasuk `CreateDataStore` API. Untuk mengambil skema `DataStore`, gunakan `SchemaService.GetSchema` API. Skema yang diberikan akan divalidasi terhadap aturan tertentu pada schema.org. Pelajari lebih lanjut dari dokumen ini.
`healthcare_fhir_config`	`HealthcareFhirConfig` Opsional. Konfigurasi untuk vertikal `HEALTHCARE_FHIR`.
`serving_config_data_store`	`ServingConfigDataStore` Opsional. Menyimpan konfigurasi penayangan di tingkat DataStore.
`identity_mapping_store`	`string` Tidak dapat diubah. Nama resource yang sepenuhnya memenuhi syarat dari `IdentityMappingStore` terkait. Kolom ini hanya dapat ditetapkan untuk DataStore acl_enabled dengan IdP `THIRD_PARTY` atau `GSUITE`. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`.
`is_infobot_faq_data_store`	`bool` Opsional. Jika disetel, DataStore ini adalah DataStore FAQ Infobot.
`configurable_billing_approach`	`ConfigurableBillingApproach` Opsional. Konfigurasi untuk pendekatan penagihan yang dapat dikonfigurasi. Lihat

BillingEstimation

Estimasi ukuran data per penyimpanan data.

Kolom
`structured_data_size`	`int64` Ukuran data untuk data terstruktur dalam byte.
`unstructured_data_size`	`int64` Ukuran data untuk data tidak terstruktur dalam byte.
`website_data_size`	`int64` Ukuran data untuk situs dalam byte.
`structured_data_update_time`	`Timestamp` Stempel waktu terakhir diperbarui untuk data terstruktur.
`unstructured_data_update_time`	`Timestamp` Stempel waktu terakhir diperbarui untuk data tidak terstruktur.
`website_data_update_time`	`Timestamp` Stempel waktu terakhir diperbarui untuk situs.

ConfigurableBillingApproach

Konfigurasi untuk pendekatan penagihan yang dapat dikonfigurasi.

Enum
`CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED`	Nilai default. Untuk pendekatan penagihan yang tidak dapat dikonfigurasi Spark dan non-Spark.
`CONFIGURABLE_SUBSCRIPTION_INDEXING_CORE`	Gunakan penagihan berbasis langganan + kelebihan penggunaan untuk pengindeksan inti bagi penyimpanan non-penyematan.
`CONFIGURABLE_CONSUMPTION_EMBEDDING`	Gunakan penagihan bayar sesuai penggunaan untuk add-on penyimpanan penyematan.

ContentConfig

Konfigurasi konten penyimpanan data.

Enum
`CONTENT_CONFIG_UNSPECIFIED`	Nilai default.
`NO_CONTENT`	Hanya berisi dokumen tanpa `Document.content`.
`CONTENT_REQUIRED`	Hanya berisi dokumen dengan `Document.content`.
`PUBLIC_WEBSITE`	Penyimpanan data digunakan untuk penelusuran situs publik.
`GOOGLE_WORKSPACE`	Penyimpanan data digunakan untuk penelusuran ruang kerja. Detail penyimpanan data ruang kerja ditentukan dalam `WorkspaceConfig`.

ServingConfigDataStore

Menyimpan informasi terkait konfigurasi penayangan di tingkat DataStore.

Kolom

disabled_for_serving

bool

Opsional. Jika disetel ke benar (true), DataStore tidak akan tersedia untuk menayangkan permintaan penelusuran.

DeleteAssistantRequest

Pesan permintaan untuk metode AssistantService.DeleteAssistant.

Kolom

name

string

Wajib. Nama resource Assistant. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}

Jika pemanggil tidak memiliki izin untuk menghapus Assistant, terlepas dari apakah Assistant tersebut ada atau tidak, error PERMISSION_DENIED akan ditampilkan.

Jika Assistant yang akan dihapus tidak ada, error NOT_FOUND akan ditampilkan.

DeleteCmekConfigMetadata

Metadata yang terkait dengan progres operasi CmekConfigService.DeleteCmekConfig. Hal ini akan ditampilkan oleh kolom google.longrunning.Operation.metadata.

Kolom

create_time

Waktu pembuatan operasi.

update_time

Waktu update terakhir operasi. Jika operasi selesai, ini juga merupakan waktu selesainya.

DeleteCmekConfigRequest

Pesan permintaan untuk metode CmekConfigService.DeleteCmekConfig.

Kolom

name

string

Wajib. Nama resource CmekConfig yang akan dihapus, seperti projects/{project}/locations/{location}/cmekConfigs/{cmek_config}.

DeleteCollectionMetadata

Metadata yang terkait dengan progres operasi [CollectionService.UpdateCollection][]. Hal ini akan ditampilkan oleh kolom google.longrunning.Operation.metadata.

Kolom

create_time

Waktu pembuatan operasi.

update_time

Waktu update terakhir operasi. Jika operasi selesai, ini juga merupakan waktu selesainya.

DeleteCollectionRequest

Pesan permintaan untuk metode CollectionService.DeleteCollection.

Kolom

name

string

Wajib. Nama resource lengkap Kumpulan, dalam format projects/{project}/locations/{location}/collections/{collection}.

DeleteControlRequest

Permintaan untuk metode DeleteControl.

Kolom

name

string

Wajib. Nama resource Kontrol yang akan dihapus. Format: projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}

DeleteConversationRequest

Permintaan untuk metode DeleteConversation.

Kolom

name

string

Wajib. Nama resource Percakapan yang akan dihapus. Format: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}

DeleteDataStoreMetadata

Metadata yang terkait dengan progres operasi DataStoreService.DeleteDataStore. Hal ini akan ditampilkan oleh kolom google.longrunning.Operation.metadata.

Kolom

create_time

Waktu pembuatan operasi.

update_time

Waktu update terakhir operasi. Jika operasi selesai, ini juga merupakan waktu selesainya.

DeleteDataStoreRequest

Pesan permintaan untuk metode DataStoreService.DeleteDataStore.

Kolom

name

string

Wajib. Nama resource lengkap DataStore, seperti projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}.

Jika pemanggil tidak memiliki izin untuk menghapus DataStore, terlepas dari apakah DataStore tersebut ada atau tidak, error PERMISSION_DENIED akan ditampilkan.

Jika DataStore yang akan dihapus tidak ada, error NOT_FOUND akan ditampilkan.

DeleteDocumentRequest

Pesan permintaan untuk metode DocumentService.DeleteDocument.

Kolom

name

string

Wajib. Nama resource lengkap Document, seperti projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}.

Jika pemanggil tidak memiliki izin untuk menghapus Document, terlepas dari apakah Document ada atau tidak, error PERMISSION_DENIED akan ditampilkan.

Jika Document yang akan dihapus tidak ada, error NOT_FOUND akan ditampilkan.

DeleteEngineMetadata

Metadata yang terkait dengan progres operasi EngineService.DeleteEngine. Hal ini akan ditampilkan oleh kolom google.longrunning.Operation.metadata.

Kolom

create_time

Waktu pembuatan operasi.

update_time

Waktu update terakhir operasi. Jika operasi selesai, ini juga merupakan waktu selesainya.

DeleteEngineRequest

Pesan permintaan untuk metode EngineService.DeleteEngine.

Kolom

name

string

Wajib. Nama resource lengkap Engine, seperti projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}.

Jika pemanggil tidak memiliki izin untuk menghapus Engine, terlepas dari apakah Engine tersebut ada atau tidak, error PERMISSION_DENIED akan ditampilkan.

Jika Engine yang akan dihapus tidak ada, error NOT_FOUND akan ditampilkan.

DeleteIdentityMappingStoreMetadata

Metadata yang terkait dengan progres operasi IdentityMappingStoreService.DeleteIdentityMappingStore. Hal ini akan ditampilkan oleh kolom google.longrunning.Operation.metadata.

Kolom

create_time

Waktu pembuatan operasi.

update_time

Waktu update terakhir operasi. Jika operasi selesai, ini juga merupakan waktu selesainya.

DeleteIdentityMappingStoreRequest

Pesan permintaan untuk IdentityMappingStoreService.DeleteIdentityMappingStore

Kolom

name

string

Wajib. Nama Identity Mapping Store yang akan dihapus. Format: projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}

DeleteSchemaMetadata

Metadata untuk LRO DeleteSchema.

Kolom

create_time

Waktu pembuatan operasi.

update_time

Waktu update terakhir operasi. Jika operasi selesai, ini juga merupakan waktu selesainya.

DeleteSchemaRequest

Pesan permintaan untuk metode SchemaService.DeleteSchema.

Kolom

name

string

Wajib. Nama lengkap resource skema, dalam format projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}.

DeleteSessionRequest

Permintaan untuk metode DeleteSession.

Kolom

name

string

Wajib. Nama resource Sesi yang akan dihapus. Format: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}

DeleteSitemapMetadata

Metadata yang terkait dengan progres operasi SiteSearchEngineService.DeleteSitemap. Hal ini akan ditampilkan oleh kolom google.longrunning.Operation.metadata.

Kolom

create_time

Waktu pembuatan operasi.

update_time

Waktu update terakhir operasi. Jika operasi selesai, ini juga merupakan waktu selesainya.

DeleteSitemapRequest

Pesan permintaan untuk metode SiteSearchEngineService.DeleteSitemap.

Kolom

name

string

Wajib. Nama resource lengkap Sitemap, seperti projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/sitemaps/{sitemap}.

Jika pemanggil tidak memiliki izin untuk mengakses Sitemap, terlepas dari apakah Sitemap ada atau tidak, error PERMISSION_DENIED akan ditampilkan.

Jika Sitemap yang diminta tidak ada, error NOT_FOUND akan ditampilkan.

DeleteTargetSiteMetadata

Metadata yang terkait dengan progres operasi SiteSearchEngineService.DeleteTargetSite. Hal ini akan ditampilkan oleh kolom google.longrunning.Operation.metadata.

Kolom

create_time

Waktu pembuatan operasi.

update_time

Waktu update terakhir operasi. Jika operasi selesai, ini juga merupakan waktu selesainya.

DeleteTargetSiteRequest

Pesan permintaan untuk metode SiteSearchEngineService.DeleteTargetSite.

Kolom

name

string

Wajib. Nama resource lengkap TargetSite, seperti projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}.

Jika pemanggil tidak memiliki izin untuk mengakses TargetSite, terlepas dari apakah TargetSite ada atau tidak, error PERMISSION_DENIED akan ditampilkan.

Jika TargetSite yang diminta tidak ada, error NOT_FOUND akan ditampilkan.

DestinationConfig

Menentukan endpoint target yang digunakan untuk terhubung ke sumber pihak ketiga.

Kolom
`key`	`string` Opsional. ID tujuan unik yang didukung oleh konektor.
`destinations[]`	`Destination` Opsional. Tujuan untuk kunci yang sesuai.
Kolom union `destination_config_params`. Parameter tambahan untuk konfigurasi tujuan ini. `destination_config_params` hanya ada berupa salah satu diantara berikut:
`params`	`Struct` Opsional. Parameter tambahan untuk konfigurasi tujuan ini dalam format json terstruktur.
`json_params`	`string` Parameter tambahan untuk konfigurasi tujuan ini dalam format string json.

Tujuan

Menentukan endpoint target

Kolom

port

int32

Opsional. Nomor port target yang diterima oleh tujuan.

Kolom union destination. Tujuan endpoint. destination hanya ada berupa salah satu diantara berikut:

host

string

Host yang dapat dirutekan secara publik.

DisableAdvancedSiteSearchMetadata

Metadata yang terkait dengan progres operasi SiteSearchEngineService.DisableAdvancedSiteSearch. Hal ini akan ditampilkan oleh kolom google.longrunning.Operation.metadata.

Kolom

create_time

Waktu pembuatan operasi.

update_time

Waktu update terakhir operasi. Jika operasi selesai, ini juga merupakan waktu selesainya.

DisableAdvancedSiteSearchRequest

Pesan permintaan untuk metode SiteSearchEngineService.DisableAdvancedSiteSearch.

Kolom

site_search_engine

string

Wajib. Nama resource lengkap SiteSearchEngine, seperti projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine.

DisableAdvancedSiteSearchResponse

Jenis ini tidak memiliki kolom.

Pesan respons untuk metode SiteSearchEngineService.DisableAdvancedSiteSearch.

Dokumen

Dokumen mencatat semua informasi metadata mentah item yang akan direkomendasikan atau ditelusuri.

Kolom
`name`	`string` Tidak dapat diubah. Nama lengkap resource dokumen. Format `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. Kolom ini harus berupa string berenkode UTF-8 dengan batas panjang 1.024 karakter.
`id`	`string` Tidak dapat diubah. ID dokumen. ID harus sesuai dengan standar RFC-1034 dengan batas panjang 128 karakter.
`schema_id`	`string` ID skema yang berada di penyimpanan data yang sama.
`content`	`Content` Data tidak terstruktur yang ditautkan ke dokumen ini. Konten hanya dapat disetel dan harus disetel jika dokumen ini berada di penyimpanan data `CONTENT_REQUIRED`.
`parent_document_id`	`string` ID dokumen induk. Saat ini mendukung hierarki dokumen paling banyak dua tingkat. ID harus sesuai dengan standar RFC-1034 dengan batas panjang 63 karakter.
`derived_struct_data`	`Struct` Hanya output. Kolom ini bersifat OUTPUT_ONLY. Objek ini berisi data turunan yang tidak ada dalam dokumen input asli.
`acl_info`	`AclInfo` Informasi kontrol akses untuk dokumen.
`index_time`	`Timestamp` Hanya output. Terakhir kali dokumen diindeks. Jika kolom ini disetel, dokumen dapat ditampilkan dalam hasil penelusuran. Kolom ini bersifat OUTPUT_ONLY. Jika kolom ini tidak diisi, artinya dokumen belum pernah diindeks.
`index_status`	`IndexStatus` Hanya output. Status indeks dokumen. Jika dokumen berhasil diindeks, kolom index_time akan diisi. Jika tidak, jika dokumen tidak diindeks karena error, kolom error_samples akan diisi. Jika tidak, jika pengindeksan dokumen sedang berlangsung, kolom pending_message akan diisi.
Kolom union `data`. Representasi data. Salah satu dari `struct_data` atau `json_data` harus diberikan. Jika tidak, error `INVALID_ARGUMENT` akan ditampilkan. `data` hanya dapat berupa salah satu dari hal berikut:
`struct_data`	`Struct` Data JSON terstruktur untuk dokumen. Harus sesuai dengan `Schema` yang terdaftar atau error `INVALID_ARGUMENT` akan ditampilkan.
`json_data`	`string` Representasi string JSON dokumen. Harus sesuai dengan `Schema` yang terdaftar atau error `INVALID_ARGUMENT` akan ditampilkan.

AclInfo

Informasi ACL Dokumen.

Kolom

readers[]

AccessRestriction

Pembaca dokumen.

AccessRestriction

AclRestriction untuk memodelkan batasan pewarisan yang kompleks.

Contoh: Memodelkan pewarisan "Izinkan Keduanya", di mana untuk mengakses dokumen turunan, pengguna harus memiliki akses ke dokumen induk.

Hierarki Dokumen - Space_S --> Page_P.

Pembaca: Space_S: group_1, user_1 Page_P: group_2, group_3, user_2

Pembatasan ACL Space_S - { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_1" }, { "user_id": "user_1" } ] } ] } }

Pembatasan ACL Page_P. { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_2" }, { "group_id": "group_3" }, { "user_id": "user_2" } ], }, { "principals": [ { "group_id": "group_1" }, { "user_id": "user_1" } ], } ] } }

Kolom

principals[]

Principal

Daftar akun utama.

idp_wide

bool

Semua pengguna dalam Penyedia Identitas.

Konten

Data tidak terstruktur yang ditautkan ke dokumen ini.

Kolom
`mime_type`	`string` Jenis MIME konten. Jenis yang didukung: `application/pdf` (PDF, hanya PDF asli yang didukung untuk saat ini) `text/html` (HTML) `text/plain` (TXT) `application/xml` atau `text/xml` (XML) `application/json` (JSON) `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX) `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX) `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet` (XLSX) `application/vnd.ms-excel.sheet.macroenabled.12` (XLSM) Jenis berikut hanya didukung jika parser tata letak diaktifkan di penyimpanan data: `image/bmp` (BMP) `image/gif` (GIF) `image/jpeg` (JPEG) `image/png` (PNG) `image/tiff` (TIFF) Lihat https://www.iana.org/assignments/media-types/media-types.xhtml.
Kolom union `content`. Isi dokumen tidak terstruktur. `content` hanya ada berupa salah satu diantara berikut:
`raw_bytes`	`bytes` Konten yang direpresentasikan sebagai aliran byte. Panjang maksimum adalah 1.000.000 byte (1 MB / ~0,95 MiB). Catatan: Seperti semua kolom `bytes`, kolom ini direpresentasikan sebagai biner murni di Protocol Buffers dan string berenkode base64 di JSON. Misalnya, `abc123!?$*&()'-=@~` harus ditampilkan sebagai `YWJjMTIzIT8kKiYoKSctPUB+` dalam JSON. Lihat https://developers.google.com/protocol-buffers/docs/proto3#json.
`uri`	`string` URI konten. Hanya URI Cloud Storage (misalnya, `gs://bucket-name/path/to/file`) yang didukung. Ukuran file maksimum adalah 2,5 MB untuk format berbasis teks, 200 MB untuk format lainnya.

IndexStatus

Status indeks dokumen.

Kolom

index_time

Waktu saat dokumen diindeks. Jika kolom ini terisi, berarti dokumen telah diindeks.

error_samples[]

LayoutBasedChunkingConfig

Contoh error yang terjadi saat mengindeks dokumen. Jika kolom ini diisi, dokumen tidak diindeks karena error.

pending_message

string

Tidak dapat diubah. Pesan menunjukkan bahwa pengindeksan dokumen sedang berlangsung. Jika kolom ini diisi, indeks dokumen tertunda.

DocumentInfo

Informasi dokumen mendetail yang terkait dengan peristiwa pengguna.

Kolom
`promotion_ids[]`	`string` ID promosi yang terkait dengan Dokumen ini. Saat ini, kolom ini dibatasi hingga maksimal satu ID.
`joined`	`bool` Hanya output. Apakah Dokumen yang direferensikan dapat ditemukan di penyimpanan data.
Kolom union `document_descriptor`. Deskriptor wajib untuk `Document` terkait. Jika `id` ditentukan, nilai default untuk `{location}`, `{collection_id}`, `{data_store_id}`, dan `{branch_id}` akan digunakan saat membuat anotasi dengan Dokumen yang disimpan. Jika `name` ditentukan, nilai yang diberikan (nilai default diizinkan) untuk `{location}`, `{collection_id}`, `{data_store_id}`, dan `{branch_id}` akan digunakan saat membuat anotasi dengan Dokumen yang disimpan. `document_descriptor` hanya dapat berupa salah satu dari hal berikut:
`id`	`string` ID resource `Document`.
`name`	`string` `Document`Nama lengkap resource, dalam bentuk: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}`
`uri`	`string` URI `Document` - hanya diizinkan untuk penyimpanan data situs.
`quantity`	`int32` Jumlah Dokumen yang terkait dengan peristiwa pengguna. Default-nya adalah 1. Misalnya, kolom ini adalah 2 jika dua kuantitas Dokumen yang sama terlibat dalam peristiwa `add-to-cart`. Wajib untuk peristiwa dengan jenis peristiwa berikut: `add-to-cart` `purchase`
`conversion_value`	`float` Opsional. Nilai konversi yang terkait dengan Dokumen ini. Harus ditetapkan jika `UserEvent.event_type` adalah "conversion". Misalnya, nilai 1000 menandakan bahwa 1000 detik dihabiskan untuk melihat Dokumen untuk jenis konversi `watch`.

DocumentProcessingConfig

Resource singleton DataStore. Jika kosong saat DataStore dibuat dan DataStore disetel ke DataStore.ContentConfig.CONTENT_REQUIRED, parser default akan menggunakan parser digital secara default.

Kolom
`name`	`string` Nama lengkap resource Konfigurasi Pemrosesan Dokumen. Format `projects//locations//collections//dataStores//documentProcessingConfig`.
`chunking_config`	`ChunkingConfig` Apakah mode chunking diaktifkan.
`default_parsing_config`	`ParsingConfig` Konfigurasi untuk Pengurai dokumen default. Jika tidak ditentukan, kami akan mengonfigurasinya sebagai DigitalParsingConfig default, dan konfigurasi parsing default akan diterapkan ke semua jenis file untuk parsing Dokumen.
`parsing_config_overrides`	`map<string, ParsingConfig>` Memetakan dari jenis file untuk mengganti konfigurasi parsing default berdasarkan jenis file. Kunci yang didukung: `pdf`: Mengganti konfigurasi parsing untuk file PDF, baik parsing digital, parsing OCR, atau parsing tata letak didukung. `html`: Mengganti konfigurasi parsing untuk file HTML, hanya parsing digital dan parsing tata letak yang didukung. `docx`: Mengganti konfigurasi parsing untuk file DOCX, hanya parsing digital dan parsing tata letak yang didukung. `pptx`: Mengganti konfigurasi penguraian untuk file PPTX, hanya penguraian digital dan penguraian tata letak yang didukung. `xlsm`: Mengganti konfigurasi penguraian untuk file XLSM, hanya penguraian digital dan penguraian tata letak yang didukung. `xlsx`: Mengganti konfigurasi penguraian untuk file XLSX, hanya penguraian digital dan penguraian tata letak yang didukung.

ChunkingConfig

Konfigurasi untuk konfigurasi pemotongan.

Kolom

Kolom union chunk_mode. Konfigurasi tambahan yang menentukan perilaku chunking. chunk_mode hanya ada berupa salah satu diantara berikut:

layout_based_chunking_config

Konfigurasi untuk chunking berbasis tata letak.

LayoutBasedChunkingConfig

Konfigurasi untuk chunking berbasis tata letak.

Kolom

chunk_size

int32

Batas ukuran token untuk setiap bagian.

Nilai yang didukung: 100-500 (inklusif). Nilai default: 500.

include_ancestor_headings

bool

Apakah akan menyertakan penambahan berbagai tingkat judul ke bagian dari tengah dokumen untuk mencegah hilangnya konteks.

Nilai default: False.

ParsingConfig

Konfigurasi terkait yang diterapkan ke jenis parser dokumen tertentu.

Kolom
Kolom union `type_dedicated_config`. Konfigurasi untuk jenis pemrosesan dokumen. `type_dedicated_config` hanya ada berupa salah satu diantara berikut:
`digital_parsing_config`	`DigitalParsingConfig` Konfigurasi yang diterapkan ke parser digital.
`ocr_parsing_config`	`OcrParsingConfig` Konfigurasi diterapkan ke parser OCR. Saat ini hanya berlaku untuk PDF.
`layout_parsing_config`	`LayoutParsingConfig` Konfigurasi diterapkan ke parser tata letak.

DigitalParsingConfig

Jenis ini tidak memiliki kolom.

Konfigurasi penguraian digital untuk dokumen.

LayoutParsingConfig

Konfigurasi penguraian tata letak untuk dokumen.

Kolom
`enable_table_annotation`	`bool` Opsional. Jika benar, anotasi berbasis LLM akan ditambahkan ke tabel selama penguraian.
`enable_image_annotation`	`bool` Opsional. Jika benar, anotasi berbasis LLM akan ditambahkan ke gambar selama penguraian.
`structured_content_types[]`	`string` Opsional. Berisi jenis struktur yang diperlukan untuk diekstrak dari dokumen. Nilai yang didukung: `shareholder-structure`
`exclude_html_elements[]`	`string` Opsional. Daftar elemen HTML yang akan dikecualikan dari konten yang diuraikan.
`exclude_html_classes[]`	`string` Opsional. Daftar class HTML yang akan dikecualikan dari konten yang diuraikan.
`exclude_html_ids[]`	`string` Opsional. Daftar ID HTML yang akan dikecualikan dari konten yang diuraikan.
`enable_get_processed_document`	`bool` Opsional. Jika benar, dokumen yang diproses akan tersedia untuk GetProcessedDocument API.

OcrParsingConfig

Konfigurasi penguraian OCR untuk dokumen.

Kolom

enhanced_document_elements[]
(deprecated)

string

[TIDAK DIGUNAKAN LAGI] Kolom ini tidak digunakan lagi. Untuk menggunakan pemrosesan elemen dokumen yang ditingkatkan tambahan, beralihlah ke layout_parsing_config.

use_native_text

bool

Jika benar, akan menggunakan teks asli, bukan teks OCR di halaman yang berisi teks asli.

DoubleList

Daftar ganda.

Kolom

values[]

double

Nilai ganda.

EnableAdvancedSiteSearchMetadata

Metadata yang terkait dengan progres operasi SiteSearchEngineService.EnableAdvancedSiteSearch. Hal ini akan ditampilkan oleh kolom google.longrunning.Operation.metadata.

Kolom

create_time

Waktu pembuatan operasi.

update_time

RecommendedForYouFeatureConfig

Waktu update terakhir operasi. Jika operasi selesai, ini juga merupakan waktu selesainya.

EnableAdvancedSiteSearchRequest

Pesan permintaan untuk metode SiteSearchEngineService.EnableAdvancedSiteSearch.

Kolom

site_search_engine

string

Wajib. Nama resource lengkap SiteSearchEngine, seperti projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine.

EnableAdvancedSiteSearchResponse

Jenis ini tidak memiliki kolom.

Pesan respons untuk metode SiteSearchEngineService.EnableAdvancedSiteSearch.

Mesin

Metadata yang menjelaskan parameter pelatihan dan penayangan Engine.

Kolom
`name`	`string` Tidak dapat diubah. ID. Nama resource mesin yang sepenuhnya memenuhi syarat. Kolom ini harus berupa string berenkode UTF-8 dengan batas panjang 1.024 karakter. Format: Mesin `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` harus terdiri dari 1-63 karakter, dan karakter yang valid adalah /[a-z0-9][a-z0-9-_]*/. Jika tidak, error INVALID_ARGUMENT akan ditampilkan.
`display_name`	`string` Wajib. Nama tampilan mesin. Harus dapat dibaca manusia. String berenkode UTF-8 dengan batas 1024 karakter.
`create_time`	`Timestamp` Hanya output. Stempel waktu saat Recommendation Engine dibuat.
`update_time`	`Timestamp` Hanya output. Stempel waktu saat Recommendation Engine terakhir diperbarui.
`data_store_ids[]`	`string` Opsional. Penyimpanan data yang terkait dengan mesin ini. Untuk jenis mesin `SOLUTION_TYPE_SEARCH` dan `SOLUTION_TYPE_RECOMMENDATION`, mesin hanya dapat dikaitkan dengan maksimal satu penyimpanan data. Jika `solution_type` adalah `SOLUTION_TYPE_CHAT`, beberapa `DataStore` dalam `Collection` yang sama dapat dikaitkan di sini. Perhatikan bahwa saat digunakan di `CreateEngineRequest`, satu ID DataStore harus diberikan karena sistem akan menggunakannya untuk inisialisasi yang diperlukan.
`solution_type`	`SolutionType` Wajib. Solusi mesin.
`industry_vertical`	`IndustryVertical` Opsional. Vertical industri yang didaftarkan mesin. Pembatasan vertical industri Engine didasarkan pada `DataStore`: Vertical di Engine harus cocok dengan vertical DataStore yang ditautkan ke engine.
`common_config`	`CommonConfig` Spesifikasi konfigurasi umum yang menentukan metadata mesin.
`app_type`	`AppType` Opsional. Tidak dapat diubah. Jenis aplikasi yang diwakili oleh resource mesin ini. CATATAN: ini adalah konsep baru yang terlepas dari jenis solusi atau vertikal industri yang ada.
`disable_analytics`	`bool` Opsional. Apakah akan menonaktifkan analisis untuk penelusuran yang dilakukan di mesin telusur ini.
`features`	`map<string, FeatureState>` Opsional. Konfigurasi fitur untuk mesin agar dapat mengaktifkan atau menonaktifkan fitur. Kunci yang didukung: `*`: semua fitur, jika ada, semua setelan status fitur lainnya akan diabaikan. `agent-gallery` `no-code-agent-builder` `prompt-gallery` `model-selector` `notebook-lm` `people-search` `people-search-org-chart` `bi-directional-audio` `feedback` `session-sharing` `personalization-memory` `disable-agent-sharing` `disable-image-generation` `disable-video-generation` `disable-onedrive-upload` `disable-talk-to-content` `disable-google-drive-upload`
`configurable_billing_approach`	`ConfigurableBillingApproach` Opsional. Konfigurasi untuk pendekatan penagihan yang dapat dikonfigurasi.
Kolom union `engine_config`. Spesifikasi konfigurasi tambahan yang menentukan perilaku mesin. `engine_config` hanya ada berupa salah satu diantara berikut:
`chat_engine_config`	`ChatEngineConfig` Konfigurasi untuk Chat Engine. Hanya berlaku jika `solution_type` adalah `SOLUTION_TYPE_CHAT`.
`search_engine_config`	`SearchEngineConfig` Konfigurasi untuk Mesin Telusur. Hanya berlaku jika `solution_type` adalah `SOLUTION_TYPE_SEARCH`.
`media_recommendation_engine_config`	`MediaRecommendationEngineConfig` Konfigurasi untuk Media Engine. Hanya berlaku di penyimpanan data dengan vertikal `solution_type` `SOLUTION_TYPE_RECOMMENDATION` dan `IndustryVertical.MEDIA`.
Kolom union `engine_metadata`. Metadata mesin untuk memantau status mesin. `engine_metadata` hanya ada berupa salah satu diantara berikut:
`chat_engine_metadata`	`ChatEngineMetadata` Hanya output. Informasi tambahan tentang Chat Engine. Hanya berlaku jika `solution_type` adalah `SOLUTION_TYPE_CHAT`.

AppType

Aplikasi mesin.

Enum
`APP_TYPE_UNSPECIFIED`	Semua aplikasi yang tidak ditentukan.
`APP_TYPE_INTRANET`	Jenis aplikasi untuk penelusuran intranet dan Agentspace.

ChatEngineConfig

Konfigurasi untuk Chat Engine.

Kolom

agent_creation_config

AgentCreationConfig

Konfigurasi ini akan menghasilkan agen Dialogflow yang terkait dengan Engine ini.

Perhatikan bahwa konfigurasi ini hanya digunakan satu kali oleh dan diteruskan ke layanan Dialogflow. Artinya, item tersebut tidak dapat diambil menggunakan API EngineService.GetEngine atau EngineService.ListEngines setelah pembuatan mesin.

dialogflow_agent_to_link

string

Nama resource agen Dialogflow yang ada untuk ditautkan ke Chat Engine ini. Pelanggan dapat memberikan agent_creation_config untuk membuat agen atau memberikan nama agen yang menautkan agen dengan mesin Chat.

Format projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.

Perhatikan bahwa dialogflow_agent_to_link digunakan satu kali oleh dan diteruskan ke layanan Dialogflow. Artinya, item tersebut tidak dapat diambil menggunakan API EngineService.GetEngine atau EngineService.ListEngines setelah pembuatan mesin. Gunakan ChatEngineMetadata.dialogflow_agent untuk mengaitkan agen yang sebenarnya setelah Engine dibuat.

allow_cross_region

bool

Opsional. Jika tanda ditetapkan ke benar (true), kami mengizinkan agen dan mesin berada di lokasi yang berbeda. Jika tidak, agen dan mesin harus berada di lokasi yang sama. Flag ini ditetapkan ke false secara default.

Perhatikan bahwa allow_cross_region digunakan satu kali oleh dan diteruskan ke EngineService.CreateEngine. Artinya, item tersebut tidak dapat diambil menggunakan API EngineService.GetEngine atau EngineService.ListEngines setelah pembuatan mesin.

AgentCreationConfig

Konfigurasi untuk membuat agen Dialogflow.

Kolom
`business`	`string` Nama perusahaan, organisasi, atau entitas lain yang diwakili agen. Digunakan untuk perintah LLM konektor pengetahuan dan untuk penelusuran pengetahuan.
`default_language_code`	`string` Wajib. Bahasa default agen sebagai tag bahasa. Lihat Dukungan Bahasa untuk mengetahui daftar kode bahasa yang saat ini didukung.
`time_zone`	`string` Wajib. Zona waktu agen dari database zona waktu, misalnya, America/New_York, Europe/Paris.
`location`	`string` Lokasi agen untuk pembuatan Agen, nilai yang didukung: global/us/eu. Jika tidak diberikan, Engine AS akan membuat Agen menggunakan us-central-1 secara default; Engine Uni Eropa akan membuat Agen menggunakan eu-west-1 secara default.

ChatEngineMetadata

Informasi tambahan tentang Chat Engine. Kolom dalam pesan ini hanya berupa output.

Kolom

dialogflow_agent

string

Nama resource agen Dialogflow yang dirujuk oleh Chat Engine ini.

Format projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.

CommonConfig

Konfigurasi umum untuk Engine.

Kolom

company_name

string

Nama perusahaan, bisnis, atau entitas yang terkait dengan mesin telusur. Menyetel ini dapat membantu meningkatkan kualitas fitur terkait LLM.

ConfigurableBillingApproach

Konfigurasi untuk pendekatan penagihan yang dapat dikonfigurasi.

Enum
`CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED`	Nilai default. Untuk pendekatan penagihan yang tidak dapat dikonfigurasi Spark dan non-Spark. Model harga umum.
`CONFIGURABLE_BILLING_APPROACH_ENABLED`	Pendekatan penagihan mengikuti konfigurasi yang ditentukan oleh pelanggan.

FeatureState

Status fitur untuk mesin telusur.

Enum
`FEATURE_STATE_UNSPECIFIED`	Status fitur tidak ditentukan.
`FEATURE_STATE_ON`	Fitur diaktifkan agar dapat diakses.
`FEATURE_STATE_OFF`	Fitur ini dinonaktifkan agar tidak dapat diakses.

MediaRecommendationEngineConfig

Spesifikasi konfigurasi tambahan untuk mesin Rekomendasi Media.

Kolom
`type`	`string` Wajib. Jenis mesin. misalnya, `recommended-for-you`. Kolom ini bersama dengan `optimization_objective` menjelaskan metadata mesin yang akan digunakan untuk mengontrol pelatihan dan penayangan mesin. Nilai yang didukung saat ini: `recommended-for-you`, `others-you-may-like`, `more-like-this`, `most-popular-items`.
`optimization_objective`	`string` Tujuan pengoptimalan. Misalnya, `cvr`. Kolom ini bersama dengan `optimization_objective` menjelaskan metadata mesin yang akan digunakan untuk mengontrol pelatihan dan penayangan mesin. Nilai yang didukung saat ini: `ctr`, `cvr`. Jika tidak ditentukan, kami akan memilih default berdasarkan jenis mesin. Default bergantung pada jenis rekomendasi: `recommended-for-you` => `ctr` `others-you-may-like` => `ctr`
`optimization_objective_config`	`OptimizationObjectiveConfig` Nama dan nilai nilai minimum kustom untuk cvr optimization_objective. Untuk target_field `watch-time`, target_field_value harus berupa nilai bilangan bulat yang menunjukkan waktu progres media dalam detik antara (0, 86400] (tidak termasuk 0, termasuk 86400) (misalnya, 90). Untuk target_field `watch-percentage`, target_field_value harus berupa nilai float yang valid antara (0, 1.0] (tidak termasuk 0, termasuk 1.0) (misalnya, 0,5).
`training_state`	`TrainingState` Status pelatihan yang sedang dijalankan mesin (misalnya, `TRAINING` atau `PAUSED`). Karena sebagian biaya untuk menjalankan layanan adalah frekuensi pelatihan, hal ini dapat digunakan untuk menentukan kapan harus melatih mesin guna mengontrol biaya. Jika tidak ditentukan: nilai default untuk metode `CreateEngine` adalah `TRAINING`. Nilai default untuk metode `UpdateEngine` adalah mempertahankan status yang sama seperti sebelumnya.
`engine_features_config`	`EngineFeaturesConfig` Opsional. Konfigurasi fitur mesin tambahan.

EngineFeaturesConfig

Konfigurasi fitur lainnya dari jenis mesin yang dipilih.

Kolom

Kolom union type_dedicated_config. Konfigurasi terkait fitur yang diterapkan ke jenis mesin rekomendasi media tertentu. type_dedicated_config hanya ada berupa salah satu diantara berikut:

recommended_for_you_config

Konfigurasi fitur mesin rekomendasi untuk Anda.

most_popular_config

MostPopularFeatureConfig

Konfigurasi fitur mesin paling populer.

MostPopularFeatureConfig

Konfigurasi fitur yang diperlukan untuk membuat mesin Paling Populer.

Kolom

time_window_days

int64

Rentang waktu saat mesin dikueri pada waktu pelatihan dan prediksi. Hanya bilangan bulat positif. Nilai ini diterjemahkan ke peristiwa X hari terakhir. Saat ini diperlukan untuk mesin most-popular-items.

OptimizationObjectiveConfig

Nilai minimum kustom untuk cvr optimization_objective.

Kolom

target_field

string

Wajib. Nama kolom yang akan ditargetkan. Nilai yang didukung saat ini: watch-percentage, watch-time.

target_field_value_float

float

Wajib. Nilai minimum yang akan diterapkan ke target (misalnya, 0,5).

RecommendedForYouFeatureConfig

Konfigurasi fitur tambahan untuk membuat mesin recommended-for-you.

Kolom

context_event_type

string

Jenis peristiwa yang digunakan untuk membuat kueri mesin pada waktu prediksi. Jika disetel ke generic, hanya view-item, media-play,dan media-complete yang akan digunakan sebagai context-event dalam pelatihan mesin. Jika ditetapkan ke view-home-page, view-home-page juga akan digunakan sebagai context-events selain view-item, media-play, dan media-complete. Saat ini didukung untuk mesin recommended-for-you. Nilai yang didukung saat ini: view-home-page, generic.

TrainingState

Status pelatihan mesin.

Enum
`TRAINING_STATE_UNSPECIFIED`	Status pelatihan tidak ditentukan.
`PAUSED`	Pelatihan mesin dijeda.
`TRAINING`	Mesin sedang dilatih.

SearchEngineConfig

Konfigurasi untuk Mesin Telusur.

Kolom

search_tier

SearchTier

Tingkat fitur penelusuran mesin telusur ini.

Tingkatan yang berbeda mungkin memiliki harga yang berbeda. Untuk mempelajari lebih lanjut, lihat dokumentasi harga.

Jika tidak ditentukan, nilai defaultnya adalah SearchTier.SEARCH_TIER_STANDARD.

search_add_ons[]

SearchAddOn

Add-on yang diaktifkan oleh mesin telusur ini.

FactChunk

Chunk Fakta.

Kolom
`chunk_text`	`string` Konten teks dari bagian fakta. Panjang maksimal 10 ribu karakter.
`source`	`string` Sumber tempat potongan fakta ini diambil. Jika diambil dari GroundingFacts yang disediakan dalam permintaan, kolom ini akan berisi indeks fakta spesifik tempat potongan ini diambil.
`index`	`int32` Indeks potongan ini. Saat ini hanya digunakan untuk mode streaming.
`source_metadata`	`map<string, string>` Informasi yang lebih terperinci untuk referensi sumber.
`uri`	`string` URI sumber.
`title`	`string` Judul sumber.
`domain`	`string` Domain sumber.

FetchDomainVerificationStatusRequest

Pesan permintaan untuk metode SiteSearchEngineService.FetchDomainVerificationStatus.

Kolom

site_search_engine

string

Wajib. Resource mesin telusur situs yang digunakan untuk mengambil semua status verifikasi domain. projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine.

page_size

int32

Ukuran halaman yang diminta. Server dapat menampilkan lebih sedikit item daripada yang diminta. Jika tidak ditentukan, server akan memilih default yang sesuai. Nilai maksimum adalah 1.000; nilai di atas 1.000 akan dikonversi menjadi 1.000.

Jika kolom ini negatif, error INVALID_ARGUMENT akan ditampilkan.

page_token

string

Token halaman, yang diterima dari panggilan FetchDomainVerificationStatus sebelumnya. Berikan ini untuk mengambil halaman selanjutnya.

Saat melakukan penomoran halaman, semua parameter lain yang disediakan untuk FetchDomainVerificationStatus harus sesuai dengan panggilan yang memberikan token halaman.

FetchDomainVerificationStatusResponse

Pesan respons untuk metode SiteSearchEngineService.FetchDomainVerificationStatus.

Kolom

target_sites[]

Daftar TargetSite yang berisi status verifikasi situs.

next_page_token

string

Token yang dapat dikirim sebagai page_token untuk mengambil halaman berikutnya. Jika kolom ini dihilangkan, tidak akan ada halaman berikutnya.

total_size

int32

Jumlah total item yang cocok dengan permintaan. Ini akan selalu diisi dalam respons.

FetchSitemapsRequest

Pesan permintaan untuk metode SiteSearchEngineService.FetchSitemaps.

Kolom

parent

string

Wajib. Nama resource induk SiteSearchEngine, seperti projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine.

matcher

Matcher

Opsional. Jika ditentukan, mengambil Sitemap yang cocok. Jika tidak ditentukan, akan mengambil semua Sitemap di DataStore.

Matcher

Pencocok untuk Sitemap. Saat ini hanya mendukung pencocokan URI.

Kolom

Kolom union matcher. Pencocok untuk Sitemap. matcher hanya dapat berupa salah satu dari hal berikut:

uris_matcher

UrisMatcher

Pencocokan menurut URI peta situs.

UrisMatcher

Pencocok untuk Sitemap-an berdasarkan URI-nya.

Kolom

uris[]

string

URI Sitemap.

FetchSitemapsResponse

Pesan respons untuk metode SiteSearchEngineService.FetchSitemaps.

Kolom

sitemaps_metadata[]

SitemapMetadata

Daftar Sitemap yang diambil.

SitemapMetadata

Berisi Sitemap dan metadatanya.

Kolom

sitemap

Sitemap

Sitemap.

FhirStoreSource

Data impor sumber Cloud FhirStore dari.

Kolom
`fhir_store`	`string` Wajib. Nama lengkap resource penyimpanan FHIR tempat data akan diimpor, dalam format `projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}`.
`gcs_staging_dir`	`string` Direktori Cloud Storage perantara yang digunakan untuk impor dengan batas panjang 2.000 karakter. Dapat ditentukan jika seseorang ingin mengekspor FhirStore ke direktori Cloud Storage tertentu.
`resource_types[]`	`string` Jenis resource FHIR yang akan diimpor. Jenis resource harus berupa subset dari semua jenis resource FHIR yang didukung. Secara default, semua jenis resource FHIR yang didukung jika kosong.
`update_from_latest_predefined_schema`	`bool` Opsional. Apakah akan memperbarui skema DataStore ke skema standar terbaru. Jika benar, skema DataStore akan diperbarui untuk menyertakan kolom atau jenis resource FHIR yang telah ditambahkan sejak impor terakhir dan resource FHIR yang sesuai akan diimpor dari penyimpanan FHIR. Perhatikan bahwa kolom ini tidak dapat digunakan bersama dengan `resource_types`. Tindakan ini harus digunakan setelah impor awal.

FirestoreSource

Data impor sumber Firestore dari.

Kolom
`project_id`	`string` Project ID tempat sumber Cloud SQL berada dengan batas panjang 128 karakter. Jika tidak ditentukan, akan mewarisi project ID dari permintaan induk.
`database_id`	`string` Wajib. Database Firestore untuk menyalin data dari dengan batas panjang 256 karakter.
`collection_id`	`string` Wajib. Koleksi (atau entity) Firestore untuk menyalin data dengan batas panjang 1.500 karakter.
`gcs_staging_dir`	`string` Direktori Cloud Storage perantara yang digunakan untuk impor dengan batas panjang 2.000 karakter. Dapat ditentukan jika pengguna ingin mengekspor Firestore ke direktori Cloud Storage tertentu. Pastikan akun layanan Firestore memiliki izin Admin Cloud Storage yang diperlukan untuk mengakses direktori Cloud Storage yang ditentukan.

GcsSource

Lokasi Cloud Storage untuk konten input.

Kolom

input_uris[]

string

Wajib. URI Cloud Storage ke file input. Setiap URI dapat berisi hingga 2.000 karakter. URI dapat cocok dengan jalur objek lengkap (misalnya, gs://bucket/directory/object.json) atau pola yang cocok dengan satu atau beberapa file, seperti gs://bucket/directory/*.json.

Permintaan dapat berisi paling banyak 100 file (atau 100.000 file jika data_schema adalah content). Setiap file dapat berukuran hingga 2 GB (atau 100 MB jika data_schema adalah content).

data_schema

string

Skema yang akan digunakan saat menguraikan data dari sumber.

Nilai yang didukung untuk impor dokumen:

document (default): Satu JSON Document per baris. Setiap dokumen harus memiliki Document.id yang valid.
content: Data tidak terstruktur (misalnya, PDF, HTML). Setiap file yang cocok dengan input_uris menjadi dokumen, dengan ID yang ditetapkan ke 128 bit pertama SHA256(URI) yang dienkode sebagai string hex.
custom: Satu JSON data kustom per baris dalam format arbitrer yang sesuai dengan Schema yang ditentukan dari penyimpanan data. Ini hanya dapat digunakan oleh vertikal Data Store GENERIC.
csv: File CSV dengan header yang sesuai dengan Schema yang ditentukan dari penyimpanan data. Setiap entri setelah header diimpor sebagai Dokumen. Ini hanya dapat digunakan oleh vertikal Data Store GENERIC.

Nilai yang didukung untuk impor peristiwa pengguna:

user_event (default): Satu JSON UserEvent per baris.

GetAclConfigRequest

Pesan permintaan untuk metode GetAclConfigRequest.

Kolom

name

string

Wajib. Nama resource AclConfig, seperti projects/*/locations/*/aclConfig.

Jika pemanggil tidak memiliki izin untuk mengakses AclConfig, terlepas dari apakah AclConfig ada atau tidak, error PERMISSION_DENIED akan ditampilkan.

GetAnswerRequest

Permintaan untuk metode GetAnswer.

Kolom

name

string

Wajib. Nama resource Jawaban yang akan didapatkan. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}

GetAssistAnswerRequest

Pesan permintaan untuk metode AssistAnswerService.GetAssistAnswer.

Kolom

name

string

Wajib. Nama resource AssistAnswer. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}

GetAssistantRequest

Pesan permintaan untuk metode AssistantService.GetAssistant.

Kolom

name

string

Wajib. Nama resource Assistant. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}

GetCmekConfigRequest

Pesan permintaan untuk metode GetCmekConfigRequest.

Kolom

name

string

Wajib. Nama resource CmekConfig, seperti projects/*/locations/*/cmekConfig atau projects/*/locations/*/cmekConfigs/*.

Jika pemanggil tidak memiliki izin untuk mengakses CmekConfig, terlepas dari apakah CmekConfig ada atau tidak, error PERMISSION_DENIED akan ditampilkan.

GetControlRequest

Permintaan untuk metode GetControl.

Kolom

name

string

Wajib. Nama resource Kontrol yang akan didapatkan. Format: projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}

GetConversationRequest

Permintaan untuk metode GetConversation.

Kolom

name

string

Wajib. Nama resource Percakapan yang akan didapatkan. Format: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}

GetDataConnectorRequest

Permintaan untuk metode DataConnectorService.GetDataConnector.

Kolom

name

string

Wajib. Nama resource lengkap DataConnector, seperti projects/{project}/locations/{location}/collections/{collection_id}/dataConnector.

Jika pemanggil tidak memiliki izin untuk mengakses DataConnector, terlepas dari apakah DataConnector ada atau tidak, error PERMISSION_DENIED akan ditampilkan.

Jika DataConnector yang diminta tidak ada, error NOT_FOUND akan ditampilkan.

GetDataStoreRequest

Pesan permintaan untuk metode DataStoreService.GetDataStore.

Kolom

name

string

Wajib. Nama resource lengkap DataStore, seperti projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}.

Jika pemanggil tidak memiliki izin untuk mengakses DataStore, terlepas dari apakah DataStore ada atau tidak, error PERMISSION_DENIED akan ditampilkan.

Jika DataStore yang diminta tidak ada, error NOT_FOUND akan ditampilkan.

GetDocumentRequest

Pesan permintaan untuk metode DocumentService.GetDocument.

Kolom

name

string

Wajib. Nama resource lengkap Document, seperti projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}.

Jika pemanggil tidak memiliki izin untuk mengakses Document, terlepas dari apakah Document ada atau tidak, error PERMISSION_DENIED akan ditampilkan.

Jika Document yang diminta tidak ada, error NOT_FOUND akan ditampilkan.

GetEngineRequest

Pesan permintaan untuk metode EngineService.GetEngine.

Kolom

name

string

Wajib. Nama resource lengkap Engine, seperti projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}.

GetIdentityMappingStoreRequest

Pesan permintaan untuk IdentityMappingStoreService.GetIdentityMappingStore

Kolom

name

string

Wajib. Nama Identity Mapping Store yang akan didapatkan. Format: projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}

GetLicenseConfigRequest

Pesan permintaan untuk metode LicenseConfigService.GetLicenseConfig.

Kolom

name

string

Wajib. Nama resource lengkap LicenseConfig, seperti projects/{project}/locations/{location}/licenseConfigs/*.

Jika pemanggil tidak memiliki izin untuk mengakses LicenseConfig, terlepas dari apakah LicenseConfig ada atau tidak, error PERMISSION_DENIED akan ditampilkan.

Jika LicenseConfig yang diminta tidak ada, error NOT_FOUND akan ditampilkan.

GetSchemaRequest

Pesan permintaan untuk metode SchemaService.GetSchema.

Kolom

name

string

Wajib. Nama lengkap resource skema, dalam format projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}.

GetSessionRequest

Permintaan untuk metode GetSession.

Kolom

name

string

Wajib. Nama resource Sesi yang akan didapatkan. Format: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}

include_answer_details

bool

Opsional. Jika disetel ke benar (true), sesi lengkap termasuk semua detail jawaban akan ditampilkan.

GetSiteSearchEngineRequest

Pesan permintaan untuk metode SiteSearchEngineService.GetSiteSearchEngine.

Kolom

name

string

Wajib. Nama resource SiteSearchEngine, seperti projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine.

Jika pemanggil tidak memiliki izin untuk mengakses [SiteSearchEngine], terlepas dari apakah [SiteSearchEngine] ada atau tidak, error PERMISSION_DENIED akan ditampilkan.

GetTargetSiteRequest

Pesan permintaan untuk metode SiteSearchEngineService.GetTargetSite.

Kolom

name

string

Wajib. Nama resource lengkap TargetSite, seperti projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}.

Jika pemanggil tidak memiliki izin untuk mengakses TargetSite, terlepas dari apakah TargetSite ada atau tidak, error PERMISSION_DENIED akan ditampilkan.

Jika TargetSite yang diminta tidak ada, error NOT_FOUND akan ditampilkan.

GroundingFact

Menemukan Fakta.

Kolom

fact_text

string

Konten teks fakta. Panjang maksimal 10 ribu karakter.

attributes

map<string, string>

Atribut yang terkait dengan fakta. Atribut umum mencakup source (yang menunjukkan sumber fakta), author (yang menunjukkan penulis fakta), dan sebagainya.

HarmCategory

Kategori bahaya yang akan memblokir konten.

Enum
`HARM_CATEGORY_UNSPECIFIED`	Kategori bahaya tidak ditentukan.
`HARM_CATEGORY_HATE_SPEECH`	Kategori bahaya adalah ujaran kebencian.
`HARM_CATEGORY_DANGEROUS_CONTENT`	Kategori bahayanya adalah konten berbahaya.
`HARM_CATEGORY_HARASSMENT`	Kategori bahayanya adalah pelecehan.
`HARM_CATEGORY_SEXUALLY_EXPLICIT`	Kategori bahayanya adalah konten seksual vulgar.
`HARM_CATEGORY_CIVIC_INTEGRITY`	Kategori bahayanya adalah integritas sipil.

HealthcareFhirConfig

Konfigurasi ke penyimpanan data untuk vertikal HEALTHCARE_FHIR.

Kolom

enable_configurable_schema

bool

Apakah akan mengaktifkan skema yang dapat dikonfigurasi untuk vertikal HEALTHCARE_FHIR.

Jika disetel ke true, skema FHIR perawatan kesehatan yang telah ditentukan sebelumnya dapat diperluas untuk penelusuran dan pemfilteran yang lebih disesuaikan.

enable_static_indexing_for_batch_ingestion

bool

Apakah akan mengaktifkan pengindeksan statis untuk penyerapan batch HEALTHCARE_FHIR.

Jika disetel ke true, penyerapan batch akan diproses dalam mode pengindeksan statis yang lebih lambat, tetapi lebih mampu menangani volume yang lebih besar.

IdentityMappingEntry

Entri Pemetaan Identitas yang memetakan identitas eksternal ke identitas internal.

Kolom
`external_identity`	`string` Wajib. Identitas di luar penyedia identitas pelanggan. Batas panjang identitas eksternal adalah 100 karakter.
Kolom union `identity_provider_id`. Kolom gabungan identity_provider_id. ID Penyedia Identitas dapat berupa pengguna atau grup. `identity_provider_id` hanya ada berupa salah satu diantara berikut:
`user_id`	`string` ID pengguna. Untuk akun pengguna Google Workspace, user_id harus berupa email pengguna Google Workspace. Untuk penyedia identitas non-Google, user_id adalah ID pengguna yang dipetakan dan dikonfigurasi selama konfigurasi workforcepool.
`group_id`	`string` ID grup. Untuk akun pengguna Google Workspace, group_id harus berupa email grup Google Workspace. Untuk penyedia identitas non-Google, group_id adalah ID grup yang dipetakan dan dikonfigurasi selama konfigurasi workforcepool.

IdentityMappingEntryOperationMetadata

Metadata IdentityMappingEntry LongRunningOperation untuk IdentityMappingStoreService.ImportIdentityMappings dan IdentityMappingStoreService.PurgeIdentityMappings

Kolom

success_count

int64

Jumlah IdentityMappingEntry yang berhasil diproses.

failure_count

int64

Jumlah IdentityMappingEntries yang gagal diproses.

total_count

int64

Jumlah total IdentityMappingEntries yang diproses.

IdentityMappingStore

Penyimpanan Pemetaan Identitas yang berisi Entri Pemetaan Identitas.

Kolom

name

string

Tidak dapat diubah. Nama lengkap resource penyimpanan pemetaan identitas. Format projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}. Kolom ini harus berupa string berenkode UTF-8 dengan batas panjang 1.024 karakter.

kms_key_name

string

Hanya input. Kunci KMS yang akan digunakan untuk melindungi Identity Mapping Store ini pada saat pembuatan.

Harus ditetapkan untuk permintaan yang perlu mematuhi perlindungan Kebijakan Org. CMEK.

Jika kolom ini ditetapkan dan diproses dengan berhasil, Identity Mapping Store akan dilindungi oleh kunci KMS, seperti yang ditunjukkan di kolom cmek_config.

cmek_config

CmekConfig

Hanya output. Informasi terkait CMEK untuk Identity Mapping Store.

IdentityScheduleConfig

Konfigurasi untuk menjalankan sinkronisasi data identitas.

Kolom

refresh_interval

Duration

Opsional. Interval pemuatan ulang untuk menyinkronkan informasi Daftar Kontrol Akses untuk dokumen yang diproses oleh konektor ini. Jika tidak disetel, daftar kontrol akses akan diperbarui pada interval default 30 menit. Interval pembaruan identitas dapat berupa minimal 30 menit dan maksimal 7 hari.

next_sync_time

DateTime

Opsional. Waktu UTC saat sinkronisasi data berikutnya diperkirakan akan dimulai untuk Konektor Data. Pelanggan hanya dapat menentukan jam dan menit untuk menjadwalkan sinkronisasi data. Opsi ini digunakan saat konektor data memiliki interval pembaruan lebih dari 1 hari.

IdpConfig

Konfigurasi Penyedia Identitas.

Kolom

idp_type

IdpType

Jenis penyedia identitas dikonfigurasi.

external_idp_config

ExternalIdpConfig

Konfigurasi penyedia identitas eksternal.

ExternalIdpConfig

Konfigurasi IDP Pihak Ketiga.

Kolom

workforce_pool_name

string

Nama kumpulan tenaga kerja. Contoh: "locations/global/workforcePools/pool_id"

IdpType

Jenis Penyedia Identitas.

Enum
`IDP_TYPE_UNSPECIFIED`	Nilai default. Penelusuran ACL tidak diaktifkan.
`GSUITE`	Penyedia pihak pertama Google.
`THIRD_PARTY`	Penyedia pihak ketiga.

ImportCompletionSuggestionsMetadata

Metadata yang terkait dengan progres operasi ImportCompletionSuggestions. Hal ini akan ditampilkan oleh kolom google.longrunning.Operation.metadata.

Kolom
`create_time`	`Timestamp` Waktu pembuatan operasi.
`update_time`	`Timestamp` Waktu update terakhir operasi. Jika operasi selesai, ini juga merupakan waktu selesainya.
`success_count`	`int64` Jumlah `CompletionSuggestion` yang berhasil diimpor.
`failure_count`	`int64` Jumlah `CompletionSuggestion` yang gagal diimpor.

ImportCompletionSuggestionsRequest

Pesan permintaan untuk metode CompletionService.ImportCompletionSuggestions.

Kolom
`parent`	`string` Wajib. Nama resource penyimpanan data induk yang akan digunakan untuk mengimpor saran pelengkapan otomatis pelanggan. Mengikuti pola `projects//locations//collections//dataStores/`
`error_config`	`ImportErrorConfig` Lokasi yang diinginkan untuk error yang terjadi selama Impor.
Kolom union `source`. Sumber saran pelengkapan otomatis. `source` hanya ada berupa salah satu diantara berikut:
`inline_source`	`InlineSource` Sumber Inline untuk entri saran.
`gcs_source`	`GcsSource` Lokasi Cloud Storage untuk konten input.
`bigquery_source`	`BigQuerySource` Sumber input BigQuery.

InlineSource

Sumber inline untuk CompletionSuggestions.

Kolom

suggestions[]

CompletionSuggestion

Wajib. Daftar semua entri daftar tolak yang akan diimpor. Maksimal 1.000 item.

ImportCompletionSuggestionsResponse

Respons metode CompletionService.ImportCompletionSuggestions. Jika operasi yang berjalan lama selesai, pesan ini akan ditampilkan oleh kolom google.longrunning.Operations.response jika operasi berhasil.

Kolom

error_samples[]

Contoh error yang terjadi saat memproses permintaan.

error_config

ImportErrorConfig

Lokasi yang diinginkan untuk error yang terjadi selama Impor.

ImportDocumentsMetadata

Metadata yang terkait dengan progres operasi ImportDocuments. Hal ini ditampilkan oleh kolom google.longrunning.Operation.metadata.

Kolom
`create_time`	`Timestamp` Waktu pembuatan operasi.
`update_time`	`Timestamp` Waktu update terakhir operasi. Jika operasi selesai, ini juga merupakan waktu selesainya.
`success_count`	`int64` Jumlah entri yang berhasil diproses.
`failure_count`	`int64` Jumlah entri yang mengalami error saat diproses.
`total_count`	`int64` Jumlah total entri yang diproses.

ImportDocumentsRequest

Pesan permintaan untuk Metode impor.

Kolom
`parent`	`string` Wajib. Nama resource cabang induk, seperti `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Memerlukan izin pembuatan/pembaruan.
`error_config`	`ImportErrorConfig` Lokasi yang diinginkan untuk error yang terjadi selama Impor.
`reconciliation_mode`	`ReconciliationMode` Mode rekonsiliasi antara dokumen yang ada dan dokumen yang akan diimpor. Nilai defaultnya adalah `ReconciliationMode.INCREMENTAL`.
`update_mask`	`FieldMask` Menunjukkan kolom mana dalam dokumen impor yang diberikan yang akan diperbarui. Jika tidak ditetapkan, defaultnya adalah memperbarui semua kolom.
`auto_generate_ids`	`bool` Apakah akan membuat ID secara otomatis untuk dokumen jika tidak ada. Jika disetel ke `true`, `Document.id` akan otomatis dibuat berdasarkan hash payload, dengan ID yang mungkin tidak konsisten selama beberapa kali impor. Dalam hal ini, sebaiknya gunakan `ReconciliationMode.FULL` untuk menghindari konten duplikat. Jika tidak disetel atau disetel ke `false`, `Document.id` harus ditentukan menggunakan `id_field`. Jika tidak, dokumen tanpa ID akan gagal diimpor. Sumber data yang didukung: `GcsSource`. `GcsSource.data_schema` harus berupa `custom` atau `csv`. Jika tidak, error INVALID_ARGUMENT akan ditampilkan. `BigQuerySource`. `BigQuerySource.data_schema` harus berupa `custom` atau `csv`. Jika tidak, error INVALID_ARGUMENT akan ditampilkan. `SpannerSource`. `CloudSqlSource`. `FirestoreSource`. `BigtableSource`.
`id_field`	`string` Kolom ini menunjukkan kolom atau kolom ID yang akan digunakan sebagai ID unik dokumen. Untuk `GcsSource`, ini adalah kunci kolom JSON. Misalnya, `my_id` untuk JSON `{"my_id": "some_uuid"}`. Untuk yang lain, mungkin berupa nama kolom tabel tempat ID unik disimpan. Nilai kolom tabel atau kolom JSON digunakan sebagai `Document.id`. Kolom JSON atau kolom tabel harus berjenis string, dan nilai harus ditetapkan sebagai string valid yang sesuai dengan RFC-1034 dengan 1-63 karakter. Jika tidak, dokumen tanpa ID yang valid akan gagal diimpor. Tetapkan kolom ini hanya jika `auto_generate_ids` tidak ditetapkan atau ditetapkan sebagai `false`. Jika tidak, error INVALID_ARGUMENT akan ditampilkan. Jika tidak disetel, nilai default `_id` akan digunakan saat mengimpor dari sumber data yang diizinkan. Sumber data yang didukung: `GcsSource`. `GcsSource.data_schema` harus berupa `custom` atau `csv`. Jika tidak, error INVALID_ARGUMENT akan ditampilkan. `BigQuerySource`. `BigQuerySource.data_schema` harus berupa `custom` atau `csv`. Jika tidak, error INVALID_ARGUMENT akan ditampilkan. `SpannerSource`. `CloudSqlSource`. `BigtableSource`.
`force_refresh_content`	`bool` Opsional. Apakah akan memuat ulang konten tidak terstruktur dokumen secara paksa. Jika disetel ke `true`, bagian konten dokumen akan diperbarui terlepas dari status pembaruan konten yang merujuk.
Kolom union `source`. Wajib. Sumber input. `source` hanya ada berupa salah satu diantara berikut:
`inline_source`	`InlineSource` Sumber Inline untuk konten input dokumen.
`gcs_source`	`GcsSource` Lokasi Cloud Storage untuk konten input.
`bigquery_source`	`BigQuerySource` Sumber input BigQuery.
`fhir_store_source`	`FhirStoreSource` Sumber input FhirStore.
`spanner_source`	`SpannerSource` Sumber input Spanner.
`cloud_sql_source`	`CloudSqlSource` Sumber input Cloud SQL.
`firestore_source`	`FirestoreSource` Sumber input Firestore.
`alloy_db_source`	`AlloyDbSource` Sumber input AlloyDB.
`bigtable_source`	`BigtableSource` Sumber input Cloud Bigtable.

InlineSource

Sumber inline untuk konfigurasi input metode ImportDocuments.

Kolom

documents[]

Wajib. Daftar dokumen yang akan diperbarui/dibuat. Setiap dokumen harus memiliki Document.id yang valid. Maksimum 100 item yang direkomendasikan.

ReconciliationMode

Menunjukkan cara dokumen yang diimpor disesuaikan dengan dokumen yang ada yang dibuat atau diimpor sebelumnya.

Enum
`RECONCILIATION_MODE_UNSPECIFIED`	Nilai defaultnya adalah `INCREMENTAL`.
`INCREMENTAL`	Menyisipkan dokumen baru atau memperbarui dokumen yang ada.
`FULL`	Menghitung perbedaan dan mengganti seluruh set data dokumen. Dokumen yang ada dapat dihapus jika tidak ada di lokasi sumber. Saat menggunakan mode ini, tidak akan ada periode nonaktif pada set data yang ditargetkan. Dokumen apa pun yang seharusnya tidak berubah atau yang seharusnya diperbarui akan terus ditayangkan saat operasi sedang berjalan.

ImportDocumentsResponse

Respons dari ImportDocumentsRequest. Jika operasi yang berjalan lama selesai, pesan ini akan ditampilkan oleh kolom google.longrunning.Operations.response jika operasi berhasil.

Kolom

error_samples[]

Contoh error yang terjadi saat memproses permintaan.

error_config

ImportErrorConfig

Menggema tujuan untuk error lengkap dalam permintaan jika ditetapkan.

ImportErrorConfig

Konfigurasi tujuan untuk error terkait Impor.

Kolom

Kolom union destination. Wajib. Tujuan error. destination hanya ada berupa salah satu diantara berikut:

gcs_prefix

string

Awalan Cloud Storage untuk error impor. Ini harus berupa direktori Cloud Storage yang kosong dan sudah ada. Error impor ditulis ke file yang di-shard di direktori ini, satu per baris, sebagai pesan google.rpc.Status yang dienkode JSON.

ImportIdentityMappingsRequest

Pesan permintaan untuk IdentityMappingStoreService.ImportIdentityMappings

Kolom

identity_mapping_store

string

Wajib. Nama Identity Mapping Store untuk mengimpor Identity Mapping Entries. Format: projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}

Kolom union source. Sumber input. source hanya ada berupa salah satu diantara berikut:

inline_source

InlineSource

Sumber inline untuk mengimpor entri pemetaan identitas.

InlineSource

Sumber inline untuk mengimpor entri pemetaan identitas.

Kolom

identity_mapping_entries[]

IdentityMappingEntry

Maksimum 10.000 entri dapat diimpor sekaligus

ImportIdentityMappingsResponse

Pesan respons untuk IdentityMappingStoreService.ImportIdentityMappings

Kolom

error_samples[]

Contoh error yang terjadi saat memproses permintaan.

ImportSuggestionDenyListEntriesMetadata

Metadata yang terkait dengan progres operasi ImportSuggestionDenyListEntries. Hal ini ditampilkan oleh kolom google.longrunning.Operation.metadata.

Kolom

create_time

Waktu pembuatan operasi.

update_time

SuggestionDenyListEntry

Waktu update terakhir operasi. Jika operasi selesai, ini juga merupakan waktu selesainya.

ImportSuggestionDenyListEntriesRequest

Pesan permintaan untuk metode CompletionService.ImportSuggestionDenyListEntries.

Kolom
`parent`	`string` Wajib. Nama resource penyimpanan data induk yang entri daftar tolaknya akan diimpor. Mengikuti pola projects//locations//collections//dataStores/.
Kolom union `source`. Sumber SuggestionDenyList yang diperbarui. `source` hanya ada berupa salah satu diantara berikut:
`inline_source`	`InlineSource` Sumber Inline untuk konten input bagi entri daftar penolakan saran.
`gcs_source`	`GcsSource` Lokasi Cloud Storage untuk konten input. Hanya 1 file yang dapat ditentukan yang berisi semua entri yang akan diimpor. Nilai `gcs_source.schema` yang didukung untuk impor entri daftar penolakan saran pelengkapan otomatis: `suggestion_deny_list` (default): Satu JSON [SuggestionDenyListEntry] per baris.

InlineSource

Sumber inline untuk SuggestionDenyListEntry.

Kolom

entries[]

Wajib. Daftar semua entri daftar tolak yang akan diimpor. Maksimal 1.000 item.

ImportSuggestionDenyListEntriesResponse

Pesan respons untuk metode CompletionService.ImportSuggestionDenyListEntries.

Kolom

error_samples[]

Contoh error yang terjadi saat memproses permintaan.

imported_entries_count

int64

Jumlah entri daftar penolakan yang berhasil diimpor.

failed_entries_count

int64

Jumlah entri daftar penolakan yang gagal diimpor.

ImportUserEventsMetadata

Metadata yang terkait dengan progres operasi Impor. Hal ini ditampilkan oleh kolom google.longrunning.Operation.metadata.

Kolom
`create_time`	`Timestamp` Waktu pembuatan operasi.
`update_time`	`Timestamp` Waktu update terakhir operasi. Jika operasi selesai, ini juga merupakan waktu selesainya.
`success_count`	`int64` Jumlah entri yang berhasil diproses.
`failure_count`	`int64` Jumlah entri yang mengalami error saat diproses.

ImportUserEventsRequest

Pesan permintaan untuk permintaan ImportUserEvents.

Kolom
`parent`	`string` Wajib. Nama resource DataStore induk, dalam bentuk `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`
`error_config`	`ImportErrorConfig` Lokasi yang diinginkan untuk error yang terjadi selama Impor. Tidak dapat ditetapkan untuk impor peristiwa pengguna inline.
Kolom union `source`. Wajib - Sumber input yang diinginkan dari data peristiwa pengguna. `source` hanya ada berupa salah satu diantara berikut:
`inline_source`	`InlineSource` Sumber Inline untuk konten input untuk UserEvents.
`gcs_source`	`GcsSource` Lokasi Cloud Storage untuk konten input.
`bigquery_source`	`BigQuerySource` Sumber input BigQuery.

InlineSource

Sumber inline untuk konfigurasi input metode ImportUserEvents.

Kolom

user_events[]

UserEvent

Wajib. Daftar peristiwa pengguna yang akan diimpor. Maksimum yang direkomendasikan adalah 10 ribu item.

ImportUserEventsResponse

Respons ImportUserEventsRequest. Jika operasi yang berjalan lama berhasil, pesan ini akan ditampilkan oleh kolom google.longrunning.Operations.response jika operasi berhasil.

Kolom
`error_samples[]`	`Status` Contoh error yang terjadi saat memproses permintaan.
`error_config`	`ImportErrorConfig` Menggema tujuan untuk error lengkap jika kolom ini ditetapkan dalam permintaan.
`joined_events_count`	`int64` Jumlah peristiwa pengguna yang diimpor dengan Dokumen lengkap yang ada.
`unjoined_events_count`	`int64` Jumlah peristiwa pengguna yang diimpor, tetapi Informasi dokumen tidak ditemukan di Cabang yang ada.

IndustryVertical

Vertical industri yang terkait dengan DataStore.

Enum
`INDUSTRY_VERTICAL_UNSPECIFIED`	Nilai yang digunakan saat tidak disetel.
`GENERIC`	Kategori umum untuk dokumen yang tidak spesifik untuk kategori industri apa pun.
`MEDIA`	Vertical industri media.
`HEALTHCARE_FHIR`	Industri FHIR layanan kesehatan.

Interval

Interval floating point.

Kolom

Kolom union min. Batas bawah interval. Jika tidak ada kolom min yang ditetapkan, batas bawahnya adalah negatif tak hingga.

Kolom ini tidak boleh lebih besar dari nilai maksimum. Jika tidak, error INVALID_ARGUMENT akan ditampilkan. min hanya ada berupa salah satu diantara berikut:

minimum

double

Batas bawah inklusif.

exclusive_minimum

double

Batas bawah eksklusif.

Kolom union max. Batas atas interval. Jika kedua kolom maks tidak ditetapkan, batas atasnya adalah infinitas positif.

Kolom ini tidak boleh lebih kecil dari min. Jika tidak, error INVALID_ARGUMENT akan ditampilkan. max hanya ada berupa salah satu diantara berikut:

maximum

double

Batas atas inklusif.

exclusive_maximum

double

Batas atas eksklusif.

LicenseConfig

Informasi tentang lisensi pengguna.

Kolom
`name`	`string` Tidak dapat diubah. ID. Nama resource yang sepenuhnya memenuhi syarat dari konfigurasi lisensi. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}`
`license_count`	`int64` Wajib. Jumlah lisensi yang dibeli.
`subscription_tier`	`SubscriptionTier` Wajib. Informasi tingkat langganan untuk konfigurasi lisensi.
`state`	`State` Hanya output. Status konfigurasi lisensi.
`auto_renew`	`bool` Opsional. Apakah konfigurasi lisensi harus diperpanjang otomatis saat mencapai tanggal akhir.
`start_date`	`Date` Wajib. Tanggal mulai.
`end_date`	`Date` Opsional. Rencana tanggal akhir.
`subscription_term`	`SubscriptionTerm` Wajib. Persyaratan langganan.
`free_trial`	`bool` Opsional. Apakah konfigurasi lisensi untuk uji coba gratis.
`alert_policy_resource_config`	`AlertPolicyResourceConfig` Opsional. Konfigurasi kebijakan pemberitahuan untuk konfigurasi lisensi ini.
`gemini_bundle`	`bool` Hanya output. Apakah konfigurasi lisensi untuk paket Gemini.

Negara bagian/Provinsi

Enumerasi status konfigurasi lisensi.

Enum
`STATE_UNSPECIFIED`	Nilai default. Konfigurasi lisensi tidak ada.
`ACTIVE`	Konfigurasi lisensi berlaku dan sedang digunakan.
`EXPIRED`	Konfigurasi lisensi telah berakhir.
`NOT_STARTED`	Konfigurasi lisensi belum dimulai, dan tanggal mulainya adalah pada masa mendatang.

ListAssistantsRequest

Pesan permintaan untuk metode AssistantService.ListAssistants.

Kolom

parent

string

Wajib. Nama resource induk. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}

page_size

int32

Jumlah maksimum Assistant yang akan ditampilkan. Jika tidak ditentukan, nilai defaultnya adalah 100. Nilai maksimum yang diizinkan adalah 1.000; nilai di atas itu akan dikonversi menjadi 1.000.

page_token

string

Token halaman ListAssistantsResponse.next_page_token, yang diterima dari panggilan AssistantService.ListAssistants sebelumnya. Berikan ini untuk mengambil halaman selanjutnya.

Saat melakukan penomoran halaman, semua parameter lain yang disediakan untuk ListAssistants harus sesuai dengan panggilan yang memberikan token halaman.

ListAssistantsResponse

Pesan respons untuk metode AssistantService.ListAssistants.

Kolom

assistants[]

Assistant

Semua Assistant pelanggan.

next_page_token

string

Token yang dapat dikirim sebagai ListAssistantsRequest.page_token untuk mengambil halaman berikutnya. Jika kolom ini dihilangkan, tidak akan ada halaman berikutnya.

ListCmekConfigsRequest

Pesan permintaan untuk metode CmekConfigService.ListCmekConfigs.

Kolom

parent

string

Wajib. Nama resource lokasi induk, seperti projects/{project}/locations/{location}.

Jika pemanggil tidak memiliki izin untuk mencantumkan CmekConfig di lokasi ini, terlepas dari apakah CmekConfig ada atau tidak, error PERMISSION_DENIED akan ditampilkan.

ListCmekConfigsResponse

Pesan respons untuk metode CmekConfigService.ListCmekConfigs.

Kolom

cmek_configs[]

CmekConfig

Semua CmekConfig pelanggan.

ListControlsRequest

Permintaan untuk metode ListControls.

Kolom
`parent`	`string` Wajib. Nama resource penyimpanan data. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}` atau `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.
`page_size`	`int32` Opsional. Jumlah hasil maksimum dalam satu halaman. Jika tidak ditentukan, defaultnya adalah 50. Nilai maksimum yang diizinkan adalah 1.000.
`page_token`	`string` Opsional. Token halaman, yang diterima dari panggilan `ListControls` sebelumnya. Berikan ini untuk mengambil halaman selanjutnya.
`filter`	`string` Opsional. Filter yang akan diterapkan pada hasil daftar. Fitur yang didukung: Mencantumkan semua produk di cabang induk jika `filter` tidak disetel. Saat ini, kolom ini tidak didukung.

ListControlsResponse

Respons untuk metode ListControls.

Kolom

controls[]

Control

Semua Kontrol untuk penyimpanan data tertentu.

next_page_token

string

Token penomoran halaman, jika tidak ditampilkan, menunjukkan halaman terakhir.

ListConversationsRequest

Permintaan untuk metode ListConversations.

Kolom
`parent`	`string` Wajib. Nama resource penyimpanan data. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`
`page_size`	`int32` Jumlah hasil maksimum dalam satu halaman. Jika tidak ditentukan, defaultnya adalah 50. Nilai maksimum yang diizinkan adalah 1.000.
`page_token`	`string` Token halaman, yang diterima dari panggilan `ListConversations` sebelumnya. Berikan ini untuk mengambil halaman selanjutnya.
`filter`	`string` Filter yang akan diterapkan pada hasil daftar. Fitur yang didukung adalah: user_pseudo_id, state. Contoh: "user_pseudo_id = some_id"
`order_by`	`string` Daftar kolom yang dipisahkan koma untuk diurutkan, diurutkan dalam urutan menaik. Gunakan "desc" setelah nama kolom untuk urutan menurun. Kolom yang didukung: * `update_time` * `create_time` * `conversation_name` Contoh: "update_time desc" "create_time"

ListConversationsResponse

Respons untuk metode ListConversations.

Kolom

conversations[]

Semua Percakapan untuk penyimpanan data tertentu.

next_page_token

string

Token penomoran halaman, jika tidak ditampilkan, menunjukkan halaman terakhir.

ListCustomModelsRequest

Pesan permintaan untuk metode SearchTuningService.ListCustomModels.

Kolom

data_store

string

Wajib. Nama resource Penyimpanan Data induk, seperti projects/*/locations/global/collections/default_collection/dataStores/default_data_store. Kolom ini digunakan untuk mengidentifikasi penyimpanan data tempat pengambilan model.

ListCustomModelsResponse

Pesan respons untuk metode SearchTuningService.ListCustomModels.

Kolom

models[]

CustomTuningModel

Daftar model penyesuaian kustom.

ListDataStoresRequest

Pesan permintaan untuk metode DataStoreService.ListDataStores.

Kolom
`parent`	`string` Wajib. Nama resource cabang induk, seperti `projects/{project}/locations/{location}/collections/{collection_id}`. Jika pemanggil tidak memiliki izin untuk mencantumkan `DataStore` di lokasi ini, terlepas dari apakah penyimpanan data ini ada atau tidak, error PERMISSION_DENIED akan ditampilkan.
`page_size`	`int32` Jumlah maksimum `DataStore` yang akan ditampilkan. Jika tidak ditentukan, nilai defaultnya adalah 10. Nilai maksimum yang diizinkan adalah 50. Nilai di atas 50 akan dikonversi menjadi 50. Jika kolom ini negatif, INVALID_ARGUMENT akan ditampilkan.
`page_token`	`string` Token halaman `ListDataStoresResponse.next_page_token`, yang diterima dari panggilan `DataStoreService.ListDataStores` sebelumnya. Berikan ini untuk mengambil halaman selanjutnya. Saat melakukan penomoran halaman, semua parameter lain yang disediakan untuk `DataStoreService.ListDataStores` harus sesuai dengan panggilan yang memberikan token halaman. Jika tidak, error INVALID_ARGUMENT akan ditampilkan.
`filter`	`string` Filter menurut jenis solusi . Contoh: `filter = 'solution_type:SOLUTION_TYPE_SEARCH'`

ListDataStoresResponse

Pesan respons untuk metode DataStoreService.ListDataStores.

Kolom

data_stores[]

DataStore

Semua DataStore pelanggan.

next_page_token

string

Token yang dapat dikirim sebagai ListDataStoresRequest.page_token untuk mengambil halaman berikutnya. Jika kolom ini dihilangkan, tidak akan ada halaman berikutnya.

ListDocumentsRequest

Pesan permintaan untuk metode DocumentService.ListDocuments.

Kolom

parent

string

Wajib. Nama resource cabang induk, seperti projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}. Gunakan default_branch sebagai ID cabang, untuk mencantumkan dokumen di cabang default.

Jika pemanggil tidak memiliki izin untuk mencantumkan Document di cabang ini, terlepas dari apakah cabang ini ada atau tidak, error PERMISSION_DENIED akan ditampilkan.

page_size

int32

Jumlah maksimum Document yang akan ditampilkan. Jika tidak ditentukan, nilai defaultnya adalah 100. Nilai maksimum yang diizinkan adalah 1.000. Nilai di atas 1.000 ditetapkan ke 1.000.

Jika kolom ini negatif, error INVALID_ARGUMENT akan ditampilkan.

page_token

string

Token halaman ListDocumentsResponse.next_page_token, yang diterima dari panggilan DocumentService.ListDocuments sebelumnya. Berikan ini untuk mengambil halaman selanjutnya.

Saat melakukan penomoran halaman, semua parameter lain yang disediakan untuk DocumentService.ListDocuments harus sesuai dengan panggilan yang memberikan token halaman. Jika tidak, error INVALID_ARGUMENT akan ditampilkan.

ListDocumentsResponse

Pesan respons untuk metode DocumentService.ListDocuments.

Kolom

documents[]

Document.

next_page_token

string

Token yang dapat dikirim sebagai ListDocumentsRequest.page_token untuk mengambil halaman berikutnya. Jika kolom ini dihilangkan, tidak akan ada halaman berikutnya.

ListEnginesRequest

Pesan permintaan untuk metode EngineService.ListEngines.

Kolom
`parent`	`string` Wajib. Nama resource induk, seperti `projects/{project}/locations/{location}/collections/{collection_id}`.
`page_size`	`int32` Opsional. Tidak didukung.
`page_token`	`string` Opsional. Tidak didukung.
`filter`	`string` Opsional. Filter menurut jenis solusi. Misalnya: solution_type=SOLUTION_TYPE_SEARCH

ListEnginesResponse

Pesan respons untuk metode EngineService.ListEngines.

Kolom

engines[]

Engine

Semua Engine pelanggan.

next_page_token

string

Tidak didukung.

ListIdentityMappingStoresRequest

Pesan permintaan untuk IdentityMappingStoreService.ListIdentityMappingStores

Kolom

parent

string

Wajib. Induk dari Identity Mapping Store yang akan dicantumkan. Format projects/{project}/locations/{location}.

page_size

int32

Jumlah maksimum IdentityMappingStore yang akan ditampilkan. Jika tidak ditentukan, nilai defaultnya adalah 100. Nilai maksimum yang diizinkan adalah 1.000. Nilai di atas 1.000 akan dikonversi menjadi 1.000.

page_token

string

Token halaman, yang diterima dari panggilan ListIdentityMappingStores sebelumnya. Berikan ini untuk mengambil halaman selanjutnya.

Saat melakukan penomoran halaman, semua parameter lain yang disediakan untuk ListIdentityMappingStores harus sesuai dengan panggilan yang memberikan token halaman.

ListIdentityMappingStoresResponse

Pesan respons untuk IdentityMappingStoreService.ListIdentityMappingStores

Kolom

identity_mapping_stores[]

IdentityMappingStore

Penyimpanan Pemetaan Identitas.

next_page_token

string

Token yang dapat dikirim sebagai page_token untuk mengambil halaman berikutnya. Jika kolom ini dihilangkan, tidak akan ada halaman berikutnya.

ListIdentityMappingsRequest

Pesan permintaan untuk IdentityMappingStoreService.ListIdentityMappings

Kolom

identity_mapping_store

string

Wajib. Nama Identity Mapping Store untuk mencantumkan Identity Mapping Entry. Format: projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}

page_size

int32

Jumlah maksimum IdentityMapping yang akan ditampilkan. Jika tidak ditentukan, nilai defaultnya adalah 2000. Nilai maksimum yang diizinkan adalah 10.000. Nilai di atas 10.000 akan dikonversi menjadi 10.000.

page_token

string

Token halaman, yang diterima dari panggilan ListIdentityMappings sebelumnya. Berikan ini untuk mengambil halaman selanjutnya.

Saat melakukan penomoran halaman, semua parameter lain yang disediakan untuk ListIdentityMappings harus sesuai dengan panggilan yang memberikan token halaman.

ListIdentityMappingsResponse

Pesan respons untuk IdentityMappingStoreService.ListIdentityMappings

Kolom

identity_mapping_entries[]

IdentityMappingEntry

Entri Pemetaan Identitas.

next_page_token

string

Token yang dapat dikirim sebagai page_token untuk mengambil halaman berikutnya. Jika kolom ini dihilangkan, tidak akan ada halaman berikutnya.

ListSchemasRequest

Pesan permintaan untuk metode SchemaService.ListSchemas.

Kolom

parent

string

Wajib. Nama resource penyimpanan data induk, dalam format projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}.

page_size

int32

Jumlah maksimum Schema yang akan ditampilkan. Layanan mungkin menampilkan lebih sedikit dari nilai ini.

Jika tidak ditentukan, paling banyak 100 Schema yang akan ditampilkan.

Nilai maksimum adalah 1.000; nilai di atas 1.000 akan ditetapkan ke 1.000.

page_token

string

Token halaman, yang diterima dari panggilan SchemaService.ListSchemas sebelumnya. Berikan ini untuk mengambil halaman selanjutnya.

Saat melakukan penomoran halaman, semua parameter lain yang disediakan untuk SchemaService.ListSchemas harus sesuai dengan panggilan yang memberikan token halaman.

ListSchemasResponse

Pesan respons untuk metode SchemaService.ListSchemas.

Kolom

schemas[]

Schema

Schema.

next_page_token

string

Token yang dapat dikirim sebagai ListSchemasRequest.page_token untuk mengambil halaman berikutnya. Jika kolom ini dihilangkan, tidak akan ada halaman berikutnya.

ListSessionsRequest

Permintaan untuk metode ListSessions.

Kolom
`parent`	`string` Wajib. Nama resource penyimpanan data. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`
`page_size`	`int32` Jumlah hasil maksimum dalam satu halaman. Jika tidak ditentukan, defaultnya adalah 50. Nilai maksimum yang diizinkan adalah 1.000.
`page_token`	`string` Token halaman, yang diterima dari panggilan `ListSessions` sebelumnya. Berikan ini untuk mengambil halaman selanjutnya.
`filter`	`string` Daftar kolom yang dipisahkan koma untuk difilter, dalam tata bahasa EBNF. Kolom yang didukung adalah: `user_pseudo_id` `state` `display_name` `starred` `is_pinned` `labels` `create_time` `update_time` Contoh: `user_pseudo_id = some_id` `display_name = "some_name"` `starred = true` `is_pinned=true AND (NOT labels:hidden)` `create_time > "1970-01-01T12:00:00Z"`
`order_by`	`string` Daftar kolom yang dipisahkan koma untuk diurutkan, diurutkan dalam urutan menaik. Gunakan "desc" setelah nama kolom untuk urutan menurun. Kolom yang didukung: `update_time` `create_time` `session_name` `is_pinned` Contoh: `update_time desc` `create_time` `is_pinned desc,update_time desc`: mencantumkan sesi menurut is_pinned terlebih dahulu, lalu menurut update_time.

ListSessionsResponse

Respons untuk metode ListSessions.

Kolom

sessions[]

Semua Sesi untuk penyimpanan data tertentu.

next_page_token

string

Token penomoran halaman, jika tidak ditampilkan, menunjukkan halaman terakhir.

ListTargetSitesRequest

Pesan permintaan untuk metode SiteSearchEngineService.ListTargetSites.

Kolom

parent

string

Wajib. Nama resource mesin telusur situs induk, seperti projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine.

Jika pemanggil tidak memiliki izin untuk mencantumkan TargetSites di bawah mesin telusur situs ini, terlepas dari apakah cabang ini ada atau tidak, error PERMISSION_DENIED akan ditampilkan.

page_size

int32

Jika kolom ini negatif, error INVALID_ARGUMENT akan ditampilkan.

page_token

string

Token halaman, yang diterima dari panggilan ListTargetSites sebelumnya. Berikan ini untuk mengambil halaman selanjutnya.

Saat melakukan penomoran halaman, semua parameter lain yang disediakan untuk ListTargetSites harus sesuai dengan panggilan yang memberikan token halaman.

ListTargetSitesResponse

Pesan respons untuk metode SiteSearchEngineService.ListTargetSites.

Kolom

target_sites[]

Daftar TargetSite.

next_page_token

string

Token yang dapat dikirim sebagai page_token untuk mengambil halaman berikutnya. Jika kolom ini dihilangkan, tidak akan ada halaman berikutnya.

total_size

int32

Jumlah total item yang cocok dengan permintaan. Ini akan selalu diisi dalam respons.

ListUserLicensesRequest

Pesan permintaan untuk UserLicenseService.ListUserLicenses.

Kolom
`parent`	`string` Wajib. Nama resource induk [UserStore][], format: `projects/{project}/locations/{location}/userStores/{user_store_id}`.
`page_size`	`int32` Opsional. Ukuran halaman yang diminta. Server dapat menampilkan lebih sedikit item daripada yang diminta. Jika tidak ditentukan, nilai defaultnya adalah 10. Nilai maksimum adalah 50; nilai di atas 50 akan dikonversi menjadi 50. Jika kolom ini negatif, error INVALID_ARGUMENT akan ditampilkan.
`page_token`	`string` Opsional. Token halaman, yang diterima dari panggilan `ListUserLicenses` sebelumnya. Berikan ini untuk mengambil halaman selanjutnya. Saat melakukan penomoran halaman, semua parameter lain yang disediakan untuk `ListUserLicenses` harus sesuai dengan panggilan yang memberikan token halaman.
`filter`	`string` Opsional. Filter untuk permintaan daftar. Kolom yang didukung: `license_assignment_state` Contoh: `license_assignment_state = ASSIGNED` untuk mencantumkan lisensi pengguna yang ditetapkan. `license_assignment_state = NO_LICENSE` untuk mencantumkan pengguna yang tidak memiliki lisensi. `license_assignment_state = NO_LICENSE_ATTEMPTED_LOGIN` untuk mencantumkan pengguna yang mencoba login, tetapi tidak ada lisensi yang ditetapkan. `license_assignment_state != NO_LICENSE_ATTEMPTED_LOGIN` untuk memfilter pengguna yang mencoba login, tetapi tidak ada lisensi yang ditetapkan.

ListUserLicensesResponse

Pesan respons untuk UserLicenseService.ListUserLicenses.

Kolom

user_licenses[]

UserLicense

Semua UserLicense pelanggan.

next_page_token

string

Token yang dapat dikirim sebagai page_token untuk mengambil halaman berikutnya. Jika kolom ini dihilangkan, tidak akan ada halaman berikutnya.

MediaInfo

Informasi peristiwa pengguna khusus media.

Kolom

media_progress_duration

Duration

Waktu progres media dalam detik, jika ada. Misalnya, jika pengguna akhir telah menyelesaikan 90 detik video pemutaran, maka MediaInfo.media_progress_duration.seconds harus disetel ke 90.

media_progress_percentage

float

Progres media harus dihitung hanya menggunakan media_progress_duration relatif terhadap total durasi media.

Nilai ini harus antara [0, 1.0] inklusif.

Jika ini bukan pemutaran atau progres tidak dapat dihitung (misalnya, livestream yang sedang berlangsung), kolom ini harus dibiarkan tidak ditetapkan.

PageInfo

Informasi halaman mendetail.

Kolom
`pageview_id`	`string` ID unik tampilan halaman web. Nilai ini harus tetap sama untuk semua peristiwa pengguna yang dipicu dari tayangan halaman yang sama. Misalnya, tampilan halaman detail item dapat memicu beberapa peristiwa saat pengguna menjelajahi halaman. Properti `pageview_id` harus tetap sama untuk semua peristiwa ini agar dapat dikelompokkan dengan benar. Saat menggunakan pelaporan peristiwa sisi klien dengan piksel JavaScript dan Google Tag Manager, nilai ini akan diisi secara otomatis.
`page_category`	`string` Kategori paling spesifik yang terkait dengan halaman kategori. Untuk merepresentasikan jalur lengkap kategori, gunakan tanda '>' untuk memisahkan hierarki yang berbeda. Jika '>' adalah bagian dari nama kategori, ganti dengan karakter lain. Halaman kategori mencakup halaman khusus seperti halaman diskon atau promosi. Misalnya, halaman promo khusus mungkin memiliki hierarki kategori: `"pageCategory" : "Sales > 2017 Black Friday Deals"`. Wajib untuk peristiwa `view-category-page`. Jenis peristiwa lainnya tidak boleh menyetel kolom ini. Jika tidak, error `INVALID_ARGUMENT` akan ditampilkan.
`uri`	`string` URL lengkap (window.location.href) halaman pengguna saat ini. Saat menggunakan pelaporan peristiwa sisi klien dengan piksel JavaScript dan Google Tag Manager, nilai ini akan diisi secara otomatis. Panjang maksimum 5.000 karakter.
`referrer_uri`	`string` URL perujuk halaman saat ini. Saat menggunakan pelaporan peristiwa sisi klien dengan piksel JavaScript dan Google Tag Manager, nilai ini akan diisi secara otomatis. Namun, beberapa batasan privasi browser dapat menyebabkan kolom ini kosong.

PanelInfo

Informasi panel mendetail yang terkait dengan peristiwa pengguna.

Kolom
`panel_id`	`string` Wajib. ID panel.
`display_name`	`string` Nama tampilan panel.
`documents[]`	`DocumentInfo` Opsional. ID dokumen yang terkait dengan panel ini.
`panel_position`	`int32` Posisi panel yang diurutkan, jika ditampilkan kepada pengguna dengan panel lain. Jika ditetapkan, `total_panels` juga harus ditetapkan.
`total_panels`	`int32` Jumlah total panel, termasuk panel ini, yang ditampilkan kepada pengguna. Harus ditetapkan jika `panel_position` ditetapkan.

Akun utama

ID utama pengguna atau grup.

Kolom
Kolom union `principal`. Principal kolom gabungan. Akun utama dapat berupa pengguna atau grup. `principal` hanya ada berupa salah satu diantara berikut:
`user_id`	`string` ID pengguna. Untuk akun pengguna Google Workspace, user_id harus berupa email pengguna Google Workspace. Untuk akun pengguna penyedia identitas non-Google, user_id adalah ID pengguna yang dipetakan dan dikonfigurasi selama konfigurasi workforcepool.
`group_id`	`string` ID grup. Untuk akun pengguna Google Workspace, group_id harus berupa email grup Google Workspace. Untuk akun pengguna penyedia identitas non-Google, group_id adalah ID grup yang dipetakan dan dikonfigurasi selama konfigurasi workforcepool.
`external_entity_id`	`string` Untuk identitas aplikasi pihak ketiga yang tidak ada di penyedia identitas pelanggan.

Project

Metadata dan konfigurasi untuk project Google Cloud dalam layanan.

Kolom
`name`	`string` Hanya output. Nama resource lengkap project, misalnya `projects/{project}`. Perhatikan bahwa saat membuat permintaan, nomor project dan project ID dapat diterima, tetapi server akan selalu merespons dalam nomor project.
`create_time`	`Timestamp` Hanya output. Stempel waktu saat project ini dibuat.
`provision_completion_time`	`Timestamp` Hanya output. Stempel waktu saat project ini berhasil disediakan. Nilai kosong berarti project ini masih dalam penyediaan dan belum siap digunakan.
`service_terms_map`	`map<string, ServiceTerms>` Hanya output. Peta persyaratan layanan. Kuncinya adalah `id` dari `ServiceTerms`.
`customer_provided_config`	`CustomerProvidedConfig` Opsional. Konfigurasi yang disediakan pelanggan.

CustomerProvidedConfig

Konfigurasi yang disediakan pelanggan.

Kolom

notebooklm_config

NotebooklmConfig

Opsional. Konfigurasi untuk setelan NotebookLM.

NotebooklmConfig

Konfigurasi untuk NotebookLM.

Kolom

model_armor_config

ModelArmorConfig

Konfigurasi Model Armor yang akan digunakan untuk menyaring perintah pengguna dan respons LLM.

ModelArmorConfig

Konfigurasi untuk template Model Armor yang ditentukan pelanggan yang akan digunakan untuk membersihkan perintah pengguna dan respons LLM.

Kolom

user_prompt_template

string

Opsional. Nama resource Template Model Armor untuk membersihkan perintah pengguna. Format: projects/{project}/locations/{location}/templates/{template_id} Jika tidak ditentukan, tidak ada pembersihan yang akan diterapkan pada perintah pengguna.

response_template

string

Opsional. Nama resource Template Model Armor untuk menyaring respons LLM. Format: projects/{project}/locations/{location}/templates/{template_id} Jika tidak ditentukan, tidak ada pembersihan yang akan diterapkan pada respons LLM.

ServiceTerms

Metadata tentang persyaratan layanan.

Kolom
`id`	`string` ID unik persyaratan layanan ini. Istilah yang tersedia: `GA_DATA_USE_TERMS`: Persyaratan penggunaan data. Saat menggunakan ini sebagai `id`, `version` yang dapat diterima untuk diberikan adalah `2022-11-23`.
`version`	`string` String versi persyaratan layanan. Untuk mengetahui nilai yang dapat diterima, lihat komentar untuk `id` di atas.
`state`	`State` Apakah project telah menyetujui/menolak persyaratan layanan atau masih menunggu keputusan.
`accept_time`	`Timestamp` Terakhir kali project menyetujui persyaratan layanan.
`decline_time`	`Timestamp` Terakhir kali project menolak atau mencabut persetujuan terhadap persyaratan layanan.

Negara bagian/Provinsi

Perjanjian ini menyatakan persyaratan layanan ini.

Enum
`STATE_UNSPECIFIED`	Nilai default enum. Nilai ini sebenarnya tidak digunakan.
`TERMS_ACCEPTED`	Project telah memberikan izin untuk persyaratan layanan.
`TERMS_PENDING`	Project menunggu peninjauan dan persetujuan persyaratan layanan.
`TERMS_DECLINED`	Project telah menolak atau mencabut perjanjian persyaratan layanan.

ProvisionProjectMetadata

Jenis ini tidak memiliki kolom.

Metadata yang terkait dengan operasi penyediaan project.

ProvisionProjectRequest

Permintaan untuk metode ProjectService.ProvisionProject.

Kolom
`name`	`string` Wajib. Nama lengkap resource `Project`, seperti `projects/{project_id_or_number}`.
`accept_data_use_terms`	`bool` Wajib. Disetel ke `true` untuk menentukan bahwa pemanggil telah membaca dan ingin memberikan izin untuk Persyaratan penggunaan data.
`data_use_terms_version`	`string` Wajib. Versi Persyaratan penggunaan data yang telah dibaca dan ingin disetujui oleh pemanggil. Versi yang dapat diterima adalah `2022-11-23`, dan ini dapat berubah dari waktu ke waktu.
`saas_params`	`SaasParams` Opsional. Parameter untuk Agentspace.

SaasParams

Parameter untuk Agentspace.

Kolom

accept_biz_qos

bool

Opsional. Disetel ke true untuk menentukan bahwa pemanggil telah membaca dan ingin memberikan izin untuk [Persyaratan kualitas layanan Ruang Agen].

is_biz

bool

Opsional. Menunjukkan apakah permintaan saat ini untuk edisi Biz (= benar) atau tidak (= salah).

PurgeCompletionSuggestionsMetadata

Metadata yang terkait dengan progres operasi PurgeCompletionSuggestions. Hal ini ditampilkan oleh kolom google.longrunning.Operation.metadata.

Kolom

create_time

Waktu pembuatan operasi.

update_time

Waktu update terakhir operasi. Jika operasi selesai, ini juga merupakan waktu selesainya.

PurgeCompletionSuggestionsRequest

Pesan permintaan untuk metode CompletionService.PurgeCompletionSuggestions.

Kolom

parent

string

Wajib. Nama resource penyimpanan data induk yang saran penyelesaiannya akan dihapus. Mengikuti pola projects/*/locations/*/collections/*/dataStores/*.

PurgeCompletionSuggestionsResponse

Pesan respons untuk metode CompletionService.PurgeCompletionSuggestions.

Kolom

purge_succeeded

bool

Apakah saran penyelesaian berhasil dihapus.

error_samples[]

Contoh error yang terjadi saat memproses permintaan.

PurgeDocumentsMetadata

Metadata yang terkait dengan progres operasi PurgeDocuments. Hal ini akan ditampilkan oleh kolom google.longrunning.Operation.metadata.

Kolom
`create_time`	`Timestamp` Waktu pembuatan operasi.
`update_time`	`Timestamp` Waktu update terakhir operasi. Jika operasi selesai, ini juga merupakan waktu selesainya.
`success_count`	`int64` Jumlah entri yang berhasil dihapus.
`failure_count`	`int64` Jumlah entri yang mengalami error saat diproses.
`ignored_count`	`int64` Jumlah entri yang diabaikan karena entri tidak ditemukan.

PurgeDocumentsRequest

Pesan permintaan untuk metode DocumentService.PurgeDocuments.

Kolom
`parent`	`string` Wajib. Nama resource induk, seperti `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
`filter`	`string` Wajib. Memfilter dokumen yang cocok untuk dihapus. Satu-satunya nilai yang saat ini didukung adalah `*` (semua item).
`error_config`	`PurgeErrorConfig` Lokasi yang diinginkan untuk error yang terjadi selama penghapusan.
`force`	`bool` Benar-benar melakukan penghapusan permanen. Jika `force` disetel ke salah (false), kembalikan jumlah penghapusan yang diharapkan tanpa menghapus dokumen apa pun.
Kolom union `source`. Sumber input yang diinginkan untuk menghapus dokumen berdasarkan ID dokumen. `source` hanya ada berupa salah satu diantara berikut:
`gcs_source`	`GcsSource` Lokasi Cloud Storage untuk konten input. `data_schema` yang didukung: * `document_id`: Satu `Document.id` yang valid per baris.
`inline_source`	`InlineSource` Sumber inline untuk konten input yang akan dihapus.

InlineSource

Sumber inline untuk konfigurasi input untuk metode DocumentService.PurgeDocuments.

Kolom

documents[]

string

Wajib. Daftar nama lengkap resource dokumen yang akan dihapus. Dalam format projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*. Maksimum 100 item yang direkomendasikan.

PurgeDocumentsResponse

Pesan respons untuk metode DocumentService.PurgeDocuments. Jika operasi yang berjalan lama berhasil dilakukan, pesan ini akan ditampilkan oleh kolom google.longrunning.Operations.response.

Kolom

purge_count

int64

Jumlah total dokumen yang dihapus sebagai hasil dari operasi.

purge_sample[]

string

Contoh nama dokumen yang akan dihapus. Hanya diisi jika force disetel ke salah. Maksimal 100 nama akan ditampilkan dan nama-nama tersebut dipilih secara acak.

PurgeErrorConfig

Konfigurasi tujuan untuk error terkait Penghapusan.

Kolom

Kolom union destination. Wajib. Tujuan error. destination hanya ada berupa salah satu diantara berikut:

gcs_prefix

string

Awalan Cloud Storage untuk menghapus error. Ini harus berupa direktori Cloud Storage yang kosong dan sudah ada. Error penghapusan ditulis ke file yang di-shard di direktori ini, satu per baris, sebagai pesan google.rpc.Status yang dienkode JSON.

PurgeIdentityMappingsRequest

Pesan permintaan untuk IdentityMappingStoreService.PurgeIdentityMappings

Kolom
`identity_mapping_store`	`string` Wajib. Nama Identity Mapping Store untuk menghapus Identity Mapping Entries. Format: `projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}`
`filter`	`string` Memfilter pemetaan identitas yang cocok untuk dihapus. Kolom yang memenuhi syarat untuk pemfilteran adalah: * `update_time`: dalam format "zulu" ISO 8601. * `external_id` Contoh: Menghapus semua pemetaan identitas yang diperbarui dalam rentang waktu: `update_time > "2012-04-23T18:25:43.511Z" AND update_time < "2012-04-23T18:30:43.511Z"` Menghapus semua pemetaan identitas untuk external_id tertentu: `external_id = "id1"` Menghapus semua pemetaan identitas di dalam penyimpanan pemetaan identitas: `*` Kolom pemfilteran diasumsikan memiliki AND implisit. Tidak boleh digunakan dengan sumber. Error akan ditampilkan jika keduanya diberikan.
Kolom union `source`. Sumber input. `source` hanya ada berupa salah satu diantara berikut:
`inline_source`	`InlineSource` Sumber inline untuk menghapus entri pemetaan identitas.
`force`	`bool` Benar-benar melakukan penghapusan permanen. Jika `force` disetel ke salah (false), tampilkan jumlah penghapusan yang diharapkan tanpa menghapus pemetaan identitas apa pun. Kolom ini hanya didukung untuk penghapusan dengan filter. Untuk sumber input, kolom ini diabaikan dan data akan dihapus terlepas dari nilai kolom ini.

InlineSource

Sumber inline untuk menghapus entri pemetaan identitas.

Kolom

identity_mapping_entries[]

IdentityMappingEntry

Maksimum 10.000 entri dapat dihapus sekaligus

PurgeSuggestionDenyListEntriesMetadata

Metadata yang terkait dengan progres operasi PurgeSuggestionDenyListEntries. Hal ini ditampilkan oleh kolom google.longrunning.Operation.metadata.

Kolom

create_time

Waktu pembuatan operasi.

update_time

Waktu update terakhir operasi. Jika operasi selesai, ini juga merupakan waktu selesainya.

PurgeSuggestionDenyListEntriesRequest

Pesan permintaan untuk metode CompletionService.PurgeSuggestionDenyListEntries.

Kolom

parent

string

Wajib. Nama resource penyimpanan data induk yang entri daftar tolaknya akan diimpor. Mengikuti pola projects/*/locations/*/collections/*/dataStores/*.

PurgeSuggestionDenyListEntriesResponse

Pesan respons untuk metode CompletionService.PurgeSuggestionDenyListEntries.

Kolom

purge_count

int64

Jumlah entri daftar penolakan saran yang dihapus.

error_samples[]

Contoh error yang terjadi saat memproses permintaan.

PurgeUserEventsMetadata

Metadata yang terkait dengan progres operasi PurgeUserEvents. Hal ini akan ditampilkan oleh kolom google.longrunning.Operation.metadata.

Kolom
`create_time`	`Timestamp` Waktu pembuatan operasi.
`update_time`	`Timestamp` Waktu update terakhir operasi. Jika operasi selesai, ini juga merupakan waktu selesainya.
`success_count`	`int64` Jumlah entri yang berhasil dihapus.
`failure_count`	`int64` Jumlah entri yang mengalami error saat diproses.

PurgeUserEventsRequest

Pesan permintaan untuk metode PurgeUserEvents.

Kolom

parent

string

Wajib. Nama resource katalog tempat peristiwa dibuat. Formatnya adalah projects/{project}/locations/global/collections/{collection}/dataStores/{dataStore}.

filter

string

Wajib. String filter untuk menentukan peristiwa yang akan dihapus dengan batas panjang 5.000 karakter. Kolom yang memenuhi syarat untuk pemfilteran adalah:

eventType: String UserEvent.event_type dengan tanda petik ganda.
eventTime: dalam format "zulu" ISO 8601.
userPseudoId: String yang diapit tanda petik ganda. Menentukan ini akan menghapus semua peristiwa yang terkait dengan pengunjung.
userId: String yang diapit tanda petik ganda. Menentukan ini akan menghapus semua peristiwa yang terkait dengan pengguna.

Catatan: API ini hanya mendukung penghapusan rentang maksimum 30 hari.

Contoh:

Menghapus semua acara dalam rentang waktu: eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z"
Menghapus eventType tertentu dalam rentang waktu: eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z" eventType = "search"
Menghapus semua acara untuk pengunjung tertentu dalam rentang waktu: eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z" userPseudoId = "visitor1024"
Menghapus peristiwa 30 hari terakhir di dalam DataStore: *

Kolom pemfilteran diasumsikan memiliki AND implisit.

force

bool

Kolom force saat ini tidak didukung. Permintaan penghapusan total peristiwa pengguna akan menghapus semua peristiwa yang dapat dihapus total secara permanen. Setelah pengembangan selesai: Jika force disetel ke salah (false), metode ini akan menampilkan jumlah penghapusan yang diharapkan tanpa menghapus peristiwa pengguna. Kolom ini akan ditetapkan secara default ke false jika tidak disertakan dalam permintaan.

PurgeUserEventsResponse

Respons PurgeUserEventsRequest. Jika operasi yang berjalan lama berhasil dilakukan, pesan ini akan ditampilkan oleh kolom google.longrunning.Operations.response.

Kolom

purge_count

int64

Jumlah total peristiwa yang dihapus sebagai hasil dari operasi.

Kueri

Menentukan kueri yang dimasukkan pengguna.

Kolom

query_id

string

Hanya output. ID unik untuk kueri.

Kolom union content. Konten kueri. content hanya ada berupa salah satu diantara berikut:

text

string

Teks biasa.

RankRequest

Pesan permintaan untuk metode RankService.Rank.

Kolom
`ranking_config`	`string` Wajib. Nama resource konfigurasi layanan peringkat, seperti `projects/{project_num}/locations/{location}/rankingConfigs/default_ranking_config`.
`model`	`string` ID model yang akan digunakan. Nilainya adalah salah satu dari: `semantic-ranker-512@latest`: Model peringkat semantik dengan ukuran token input maksimum 512. Nilai default-nya adalah `semantic-ranker-512@latest` jika tidak ditentukan.
`top_n`	`int32` Jumlah hasil yang akan ditampilkan. Jika tidak disetel atau tidak lebih besar dari nol, akan menampilkan semua hasil.
`query`	`string` Kueri yang akan digunakan.
`records[]`	`RankingRecord` Wajib. Daftar rekaman untuk diberi peringkat.
`ignore_record_details_in_response`	`bool` Jika benar, respons hanya akan berisi ID dan skor rekaman. Secara default, nilainya adalah salah (false), dan respons akan berisi detail rekaman.
`user_labels`	`map<string, string>` Label pengguna yang diterapkan ke resource harus memenuhi persyaratan berikut: Setiap resource dapat memiliki beberapa label, hingga maksimum 64 label. Setiap label harus berupa pasangan nilai kunci. Kunci memiliki panjang minimum 1 karakter dan panjang maksimum 63 karakter, serta tidak boleh kosong. Nilai boleh kosong dan memiliki panjang maksimum 63 karakter. Kunci dan nilai hanya boleh berisi huruf kecil, karakter numerik, garis bawah, dan tanda hubung. Semua karakter harus menggunakan encoding UTF-8, dan karakter internasional boleh digunakan. Bagian kunci label harus unik. Namun, Anda dapat menggunakan kunci yang sama dengan beberapa resource. Kunci harus diawali dengan huruf kecil atau karakter internasional. Lihat Dokumen Google Cloud untuk mengetahui detail selengkapnya.

RankResponse

Pesan respons untuk metode RankService.Rank.

Kolom

records[]

RankingRecord

Daftar rekaman yang diurutkan berdasarkan skor menurun.

RankingRecord

Rekam pesan untuk metode RankService.Rank.

Kolom
`id`	`string` ID unik untuk merepresentasikan data.
`title`	`string` Judul rekaman. Kosong secara default. Setidaknya salah satu dari `title` atau `content` harus ditetapkan, jika tidak, error INVALID_ARGUMENT akan ditampilkan.
`content`	`string` Konten data. Kosong secara default. Setidaknya salah satu dari `title` atau `content` harus ditetapkan, jika tidak, error INVALID_ARGUMENT akan ditampilkan.
`score`	`float` Skor rekaman ini berdasarkan kueri yang diberikan dan model yang dipilih. Skor akan dibulatkan menjadi 2 tempat desimal. Jika skor mendekati 0, skor akan dibulatkan menjadi 0,0001 untuk menghindari nilai yang tidak ditetapkan.

RecommendRequest

Pesan permintaan untuk metode Recommend.

Kolom
`serving_config`	`string` Wajib. Nama lengkap resource `ServingConfig`: `projects//locations/global/collections//engines//servingConfigs/`, atau `projects//locations/global/collections//dataStores//servingConfigs/` Satu konfigurasi penayangan default dibuat bersamaan dengan pembuatan mesin pemberi saran Anda. ID mesin telusur digunakan sebagai ID konfigurasi penayangan default. Misalnya, untuk Engine `projects//locations/global/collections//engines/my-engine`, Anda dapat menggunakan `projects//locations/global/collections//engines/my-engine/servingConfigs/my-engine` untuk permintaan `RecommendationService.Recommend`.
`user_event`	`UserEvent` Wajib. Konteks tentang pengguna, apa yang mereka lihat, dan tindakan apa yang mereka lakukan untuk memicu permintaan Rekomendasi. Perhatikan bahwa detail peristiwa pengguna ini tidak akan diproses ke log userEvent. Oleh karena itu, permintaan penulisan userEvent terpisah diperlukan untuk pencatatan peristiwa. Jangan menetapkan `UserEvent.user_pseudo_id` atau `UserEvent.user_info.user_id` ke ID tetap yang sama untuk pengguna yang berbeda. Jika Anda mencoba menerima rekomendasi yang tidak dipersonalisasi (tidak direkomendasikan; hal ini dapat berdampak negatif pada performa model), tetapkan `UserEvent.user_pseudo_id` ke ID unik acak dan biarkan `UserEvent.user_info.user_id` tidak ditetapkan.
`page_size`	`int32` Jumlah hasil maksimum dalam satu halaman. Tetapkan properti ini ke jumlah hasil rekomendasi yang diperlukan. Jika nol, layanan akan memilih default yang wajar. Nilai maksimum yang diizinkan adalah 100. Nilai di atas 100 ditetapkan ke 100.
`filter`	`string` Filter untuk membatasi hasil rekomendasi dengan batas panjang 5.000 karakter. Saat ini, hanya ekspresi filter pada atribut `filter_tags` yang didukung. Contoh: `(filter_tags: ANY("Red", "Blue") OR filter_tags: ANY("Hot", "Cold"))` `(filter_tags: ANY("Red", "Blue")) AND NOT (filter_tags: ANY("Green"))` Jika `attributeFilteringSyntax` disetel ke benar (true) di kolom `params`, maka ekspresi berbasis atribut akan diharapkan, bukan sintaksis berbasis tag yang dijelaskan di atas. Contoh: (language: ANY("en", "es")) AND NOT (categories: ANY("Movie")) (available: true) AND (language: ANY("en", "es")) OR (categories: ANY("Movie")) Jika filter Anda memblokir semua hasil, API akan menampilkan Dokumen populer generik (tanpa filter). Jika Anda hanya menginginkan hasil yang benar-benar cocok dengan filter, tetapkan `strictFiltering` ke `true` di `RecommendRequest.params` untuk menerima hasil kosong. Perhatikan bahwa API tidak pernah menampilkan `Document` dengan `storageStatus` sebagai `EXPIRED` atau `DELETED`, terlepas dari pilihan filter.
`validate_only`	`bool` Gunakan mode hanya validasi untuk kueri rekomendasi ini. Jika disetel ke `true`, model palsu yang menampilkan ID Dokumen arbitrer akan digunakan. Perhatikan bahwa mode hanya validasi hanya boleh digunakan untuk menguji API, atau jika model belum siap.
`params`	`map<string, Value>` Parameter tambahan khusus domain untuk rekomendasi. Nilai yang diizinkan: `returnDocument`: Boolean. Jika disetel ke `true`, objek Dokumen terkait akan ditampilkan di `RecommendResponse.RecommendationResult.document`. `returnScore`: Boolean. Jika disetel ke benar (true), skor rekomendasi yang sesuai dengan setiap Dokumen yang ditampilkan akan disetel di `RecommendResponse.RecommendationResult.metadata`. Skor yang diberikan menunjukkan probabilitas konversi Dokumen berdasarkan konteks dan histori pengguna. `strictFiltering`: Boolean. Benar secara default. Jika disetel ke `false`, layanan akan menampilkan Dokumen populer generik (tanpa filter), bukan kosong, jika filter Anda memblokir semua hasil rekomendasi. `diversityLevel`: String. Default kosong. Jika ditetapkan agar tidak kosong, maka harus berupa salah satu dari: `no-diversity` `low-diversity` `medium-diversity` `high-diversity` `auto-diversity` Hal ini memberikan kontrol tingkat permintaan dan menyesuaikan hasil rekomendasi berdasarkan Kategori dokumen. `attributeFilteringSyntax`: Boolean. False secara default. Jika disetel ke benar (true), kolom `filter` ditafsirkan sesuai dengan sintaksis baru berbasis atribut.
`user_labels`	`map<string, string>` Label pengguna yang diterapkan ke resource harus memenuhi persyaratan berikut: Setiap resource dapat memiliki beberapa label, hingga maksimum 64 label. Setiap label harus berupa pasangan nilai kunci. Kunci memiliki panjang minimum 1 karakter dan panjang maksimum 63 karakter, serta tidak boleh kosong. Nilai boleh kosong dan memiliki panjang maksimum 63 karakter. Kunci dan nilai hanya boleh berisi huruf kecil, karakter numerik, garis bawah, dan tanda hubung. Semua karakter harus menggunakan encoding UTF-8, dan karakter internasional boleh digunakan. Bagian kunci label harus unik. Namun, Anda dapat menggunakan kunci yang sama dengan beberapa resource. Kunci harus diawali dengan huruf kecil atau karakter internasional. Lihat Persyaratan untuk label untuk mengetahui detail selengkapnya.

RecommendResponse

Pesan respons untuk metode Recommend.

Kolom
`results[]`	`RecommendationResult` Daftar Dokumen yang direkomendasikan. Urutan ini menunjukkan peringkat (dari Dokumen yang paling relevan hingga yang paling tidak relevan).
`attribution_token`	`string` Token atribusi unik. Hal ini harus disertakan dalam log `UserEvent` yang dihasilkan dari rekomendasi ini, yang memungkinkan atribusi akurat performa model rekomendasi.
`missing_ids[]`	`string` ID dokumen dalam permintaan yang tidak ada di Cabang default yang terkait dengan ServingConfig yang diminta.
`validate_only`	`bool` Benar jika `RecommendRequest.validate_only` disetel.

RecommendationResult

RecommendationResult mewakili hasil rekomendasi generik dengan metadata terkait.

Kolom

id

string

ID resource Dokumen yang direkomendasikan.

document

MatchHighlightingCondition

Disetel jika returnDocument disetel ke benar di RecommendRequest.params.

metadata

map<string, Value>

Metadata atau anotasi Dokumen Tambahan.

Nilai yang memungkinkan:

score: Skor rekomendasi dalam nilai ganda. Disetel jika returnScore disetel ke benar di RecommendRequest.params.

RecrawlUrisMetadata

Metadata yang terkait dengan progres operasi SiteSearchEngineService.RecrawlUris. Hal ini akan ditampilkan oleh kolom google.longrunning.Operation.metadata.

Kolom
`create_time`	`Timestamp` Waktu pembuatan operasi.
`update_time`	`Timestamp` Waktu update terakhir operasi. Jika operasi selesai, ini juga merupakan waktu selesainya.
`invalid_uris[]`	`string` URI unik dalam permintaan yang memiliki format tidak valid. Contoh dibatasi hingga 1.000.
`invalid_uris_count`	`int32` Total jumlah URI unik dalam permintaan yang memiliki format tidak valid.
`noindex_uris[]`	`string` URI yang tidak memiliki tag meta indeks. Contoh dibatasi hingga 1.000.
`noindex_uris_count`	`int32` Jumlah total URI yang tidak memiliki tag meta indeks.
`uris_not_matching_target_sites[]`	`string` URI unik dalam permintaan yang tidak cocok dengan TargetSite apa pun di DataStore, hanya cocok dengan TargetSite yang belum diindeks sepenuhnya, atau cocok dengan TargetSite dengan jenis EXCLUDE. Contoh dibatasi hingga 1.000.
`uris_not_matching_target_sites_count`	`int32` Jumlah total URI yang tidak cocok dengan TargetSites mana pun.
`valid_uris_count`	`int32` Jumlah total URI unik dalam permintaan yang tidak ada di invalid_uris.
`success_count`	`int32` Jumlah total URI yang telah di-crawl sejauh ini.
`pending_count`	`int32` Jumlah total URI yang belum di-crawl.
`quota_exceeded_count`	`int32` Jumlah total URI yang ditolak karena resource pengindeksan tidak mencukupi.

RecrawlUrisRequest

Pesan permintaan untuk metode SiteSearchEngineService.RecrawlUris.

Kolom

site_search_engine

string

Wajib. Nama resource lengkap SiteSearchEngine, seperti projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine.

uris[]

string

Wajib. Daftar URI yang akan di-crawl. Maksimal 10 ribu URI didukung, jika tidak, error INVALID_ARGUMENT akan ditampilkan. Setiap URI harus cocok dengan setidaknya satu TargetSite di site_search_engine.

site_credential

string

Opsional. ID kredensial yang akan digunakan untuk crawling.

RecrawlUrisResponse

Pesan respons untuk metode SiteSearchEngineService.RecrawlUris.

Kolom

failure_samples[]

FailureInfo

Detail untuk sampel hingga 10 failed_uris.

failed_uris[]

string

URI yang tidak di-crawl sebelum LRO dihentikan.

FailureInfo

Detail tentang alasan URI tertentu gagal di-crawl. Setiap FailureInfo berisi satu FailureReason per CorpusType.

Kolom

uri

string

URI yang gagal di-crawl.

failure_reasons[]

FailureReason

Daftar alasan kegagalan menurut jenis korpus (misalnya, desktop, seluler).

FailureReason

Detail tentang alasan crawling gagal untuk CorpusType tertentu, misalnya, Crawl DESKTOP dan MOBILE dapat gagal karena alasan yang berbeda.

Kolom

corpus_type

CorpusType

DESKTOP, MOBILE, atau CORPUS_TYPE_UNSPECIFIED.

error_message

string

Alasan URI tidak di-crawl.

CorpusType

CorpusType untuk operasi crawling yang gagal.

Enum
`CORPUS_TYPE_UNSPECIFIED`	Nilai default.
`DESKTOP`	Menunjukkan upaya crawling untuk versi desktop halaman.
`MOBILE`	Menunjukkan upaya crawling untuk halaman versi seluler.

Balas

Menentukan pesan balasan kepada pengguna.

Kolom

summary

Summary

Ringkasan berdasarkan hasil penelusuran.

SafetyRating

Rating keamanan yang sesuai dengan konten yang dihasilkan.

Kolom
`category`	`HarmCategory` Hanya output. Kategori bahaya.
`probability`	`HarmProbability` Hanya output. Tingkat probabilitas bahaya dalam konten.
`probability_score`	`float` Hanya output. Skor probabilitas bahaya.
`severity`	`HarmSeverity` Hanya output. Tingkat keparahan bahaya dalam konten.
`severity_score`	`float` Hanya output. Skor tingkat keparahan bahaya.
`blocked`	`bool` Hanya output. Menunjukkan apakah konten difilter karena rating ini.

HarmProbability

Tingkat probabilitas bahaya dalam konten.

Enum
`HARM_PROBABILITY_UNSPECIFIED`	Kemungkinan bahaya tidak ditentukan.
`NEGLIGIBLE`	Tingkat bahaya yang dapat diabaikan.
`LOW`	Tingkat bahaya rendah.
`MEDIUM`	Tingkat bahaya sedang.
`HIGH`	Tingkat bahaya tinggi.

HarmSeverity

Tingkat keparahan bahaya.

Enum
`HARM_SEVERITY_UNSPECIFIED`	Tingkat keparahan bahaya tidak ditentukan.
`HARM_SEVERITY_NEGLIGIBLE`	Tingkat keparahan bahaya yang dapat diabaikan.
`HARM_SEVERITY_LOW`	Tingkat keparahan bahaya rendah.
`HARM_SEVERITY_MEDIUM`	Tingkat keparahan bahaya sedang.
`HARM_SEVERITY_HIGH`	Tingkat keparahan bahaya tinggi.

Skema

Menentukan struktur dan tata letak jenis data dokumen.

Kolom
`name`	`string` Tidak dapat diubah. Nama lengkap resource skema, dalam format `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. Kolom ini harus berupa string berenkode UTF-8 dengan batas panjang 1.024 karakter.
Kolom union `schema`. Representasi skema. Salah satu dari `struct_schema` atau `json_schema` harus diberikan. Jika tidak, error `INVALID_ARGUMENT` akan ditampilkan. `schema` hanya dapat berupa salah satu dari hal berikut:
`struct_schema`	`Struct` Representasi terstruktur dari skema.
`json_schema`	`string` Representasi JSON skema.

SearchAddOn

Add-on yang menyediakan fungsi tambahan untuk penelusuran.

Enum
`SEARCH_ADD_ON_UNSPECIFIED`	Nilai default saat enum tidak ditentukan. Tidak valid untuk digunakan.
`SEARCH_ADD_ON_LLM`	Add-on model bahasa besar.

SearchInfo

Informasi penelusuran mendetail.

Kolom

search_query

string

Kueri penelusuran pengguna.

Lihat SearchRequest.query untuk mengetahui definisinya.

Nilai harus berupa string berenkode UTF-8 dengan batas panjang 5.000 karakter. Jika tidak, error INVALID_ARGUMENT akan ditampilkan.

Setidaknya salah satu dari search_query atau PageInfo.page_category harus ada untuk peristiwa search. Jenis peristiwa lainnya tidak boleh menyetel kolom ini. Jika tidak, error INVALID_ARGUMENT akan ditampilkan.

order_by

string

Urutan produk ditampilkan, jika berlaku.

Lihat SearchRequest.order_by untuk mengetahui definisi dan sintaksis.

Nilai harus berupa string berenkode UTF-8 dengan batas panjang 1.000 karakter. Jika tidak, error INVALID_ARGUMENT akan ditampilkan.

Kolom ini hanya dapat disetel untuk acara search. Jenis peristiwa lainnya tidak boleh menyetel kolom ini. Jika tidak, error INVALID_ARGUMENT akan ditampilkan.

offset

int32

Bilangan bulat yang menentukan offset saat ini untuk penomoran halaman (lokasi awal berindeks 0, di antara produk yang dianggap relevan oleh API).

Lihat SearchRequest.offset untuk mengetahui definisinya.

Jika kolom ini negatif, INVALID_ARGUMENT akan ditampilkan.

Kolom ini hanya dapat disetel untuk acara search. Jenis peristiwa lainnya tidak boleh menyetel kolom ini. Jika tidak, error INVALID_ARGUMENT akan ditampilkan.

SearchLinkPromotion

Proto promosi mencakup URI dan informasi bantuan lainnya untuk menampilkan promosi.

Kolom
`title`	`string` Wajib. Judul promosi. Panjang maksimum: 160 karakter.
`uri`	`string` Opsional. URL untuk halaman yang ingin dipromosikan pengguna. Harus disetel untuk penelusuran situs. Untuk vertikal lainnya, atribut ini bersifat opsional.
`document`	`string` Opsional. `Document` yang ingin dipromosikan pengguna. Untuk penelusuran situs, biarkan tidak disetel dan hanya isi uri. Dapat disetel bersama dengan URI.
`image_uri`	`string` Opsional. URL gambar thumbnail promosi.
`description`	`string` Opsional. Deskripsi Promosi. Panjang maksimum: 200 karakter.
`enabled`	`bool` Opsional. Promosi yang diaktifkan akan ditampilkan untuk semua konfigurasi penayangan yang terkait dengan induk kontrol tempat promosi ini dilampirkan. Flag ini hanya digunakan untuk penelusuran situs dasar.

SearchRequest

Pesan permintaan untuk metode SearchService.Search.

Kolom
`serving_config`	`string` Wajib. Nama resource konfigurasi penayangan Search, seperti `projects//locations/global/collections/default_collection/engines//servingConfigs/default_serving_config`, atau `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. Kolom ini digunakan untuk mengidentifikasi nama konfigurasi penayangan, kumpulan model yang digunakan untuk melakukan penelusuran.
`branch`	`string` Nama resource cabang, seperti `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. Gunakan `default_branch` sebagai ID cabang atau biarkan kolom ini kosong, untuk menelusuri dokumen di cabang default.
`query`	`string` Kueri penelusuran mentah.
`image_query`	`ImageQuery` Kueri gambar mentah.
`page_size`	`int32` Jumlah maksimum `Document` yang akan ditampilkan. Nilai maksimum yang diizinkan bergantung pada jenis data. Nilai di atas nilai maksimum akan dikonversi menjadi nilai maksimum. Situs dengan pengindeksan dasar: Default `10`, Maksimum `25`. Situs dengan pengindeksan lanjutan: Default `25`, Maksimum `50`. Lainnya: Default `50`, Maksimum `100`. Jika kolom ini negatif, `INVALID_ARGUMENT` akan ditampilkan.
`page_token`	`string` Token halaman yang diterima dari panggilan `SearchService.Search` sebelumnya. Berikan ini untuk mengambil halaman selanjutnya. Saat melakukan penomoran halaman, semua parameter lain yang disediakan untuk `SearchService.Search` harus sesuai dengan panggilan yang memberikan token halaman. Jika tidak, error `INVALID_ARGUMENT` akan ditampilkan.
`offset`	`int32` Bilangan bulat berindeks 0 yang menentukan offset saat ini (yaitu, lokasi hasil awal, di antara `Document` yang dianggap relevan oleh API) dalam hasil penelusuran. Kolom ini hanya dipertimbangkan jika `page_token` tidak ditetapkan. Jika kolom ini negatif, `INVALID_ARGUMENT` akan ditampilkan. Offset besar dapat dibatasi hingga nilai minimum yang wajar.
`one_box_page_size`	`int32` Jumlah maksimum hasil yang akan ditampilkan untuk OneBox. Hal ini berlaku untuk setiap jenis OneBox secara terpisah. Jumlah defaultnya adalah 10.
`data_store_specs[]`	`DataStoreSpec` Spesifikasi yang menentukan `DataStore` tertentu yang akan ditelusuri, beserta konfigurasi untuk penyimpanan data tersebut. Hal ini hanya dipertimbangkan untuk `Engine` dengan beberapa penyimpanan data. Untuk mesin dengan satu penyimpanan data, spesifikasi langsung di bawah `SearchRequest` harus digunakan.
`filter`	`string` Sintaksis filter terdiri dari bahasa ekspresi untuk membuat predikat dari satu atau beberapa kolom dokumen yang difilter. Ekspresi filter peka huruf besar/kecil. Jika kolom ini tidak dapat dikenali, `INVALID_ARGUMENT` akan ditampilkan. Pemfilteran di Vertex AI Search dilakukan dengan memetakan kunci filter LHS ke properti kunci yang ditentukan di backend Vertex AI Search -- pemetaan ini ditentukan oleh pelanggan dalam skemanya. Misalnya, pelanggan media mungkin memiliki kolom 'name' dalam skemanya. Dalam hal ini, filter akan terlihat seperti ini: filter --> name:'ANY("king kong")' Untuk mengetahui informasi selengkapnya tentang pemfilteran, termasuk sintaksis dan operator filter, lihat Filter
`canonical_filter`	`string` Filter default yang diterapkan saat pengguna melakukan penelusuran tanpa mencentang filter apa pun di halaman penelusuran. Filter yang diterapkan ke setiap permintaan penelusuran saat peningkatan kualitas seperti perluasan kueri diperlukan. Jika kueri tidak memiliki jumlah hasil yang memadai, filter ini akan digunakan untuk menentukan apakah alur perluasan kueri akan diaktifkan atau tidak. Filter asli akan tetap digunakan untuk penelusuran yang diperluas kuerinya. Kolom ini sangat direkomendasikan untuk mencapai kualitas penelusuran yang tinggi. Untuk mengetahui informasi selengkapnya tentang sintaksis filter, lihat `SearchRequest.filter`.
`order_by`	`string` Urutan dokumen yang ditampilkan. Dokumen dapat diurutkan berdasarkan kolom dalam objek `Document`. Biarkan tidak disetel jika diurutkan berdasarkan relevansi. Ekspresi `order_by` peka huruf besar/kecil. Untuk mengetahui informasi selengkapnya tentang cara mengurutkan hasil penelusuran situs, lihat Mengurutkan hasil penelusuran web. Untuk mengetahui informasi selengkapnya tentang pengurutan hasil penelusuran layanan kesehatan, lihat Mengurutkan hasil penelusuran layanan kesehatan. Jika kolom ini tidak dapat dikenali, `INVALID_ARGUMENT` akan ditampilkan.
`user_info`	`UserInfo` Informasi tentang pengguna akhir. Sangat direkomendasikan untuk analisis dan personalisasi. `UserInfo.user_agent` digunakan untuk menyimpulkan `device_type` untuk analisis.
`language_code`	`string` Kode bahasa BCP-47, seperti "en-US" atau "sr-Latn". Untuk mengetahui informasi selengkapnya, lihat Kolom standar. Kolom ini membantu menafsirkan kueri dengan lebih baik. Jika nilai tidak ditentukan, kode bahasa kueri akan dideteksi secara otomatis, yang mungkin tidak akurat.
`facet_specs[]`	`FacetSpec` Spesifikasi faset untuk penelusuran dengan faset. Jika kosong, tidak ada faset yang ditampilkan. Maksimum 100 nilai yang diizinkan. Jika tidak, error `INVALID_ARGUMENT` akan ditampilkan.
`boost_spec`	`BoostSpec` Spesifikasi peningkat untuk meningkatkan kualitas dokumen tertentu. Untuk mengetahui informasi selengkapnya tentang promosi, lihat Promosi
`params`	`map<string, Value>` Parameter penelusuran tambahan. Untuk penelusuran situs publik saja, nilai yang didukung adalah: `user_country_code`: string. Default kosong. Jika disetel ke tidak kosong, hasil akan dibatasi atau ditingkatkan berdasarkan lokasi yang diberikan. Misalnya, `user_country_code: "au"` Untuk kode yang tersedia, lihat Kode Negara `search_type`: double. Default kosong. Mengaktifkan penelusuran non-halaman web bergantung pada nilainya. Satu-satunya nilai non-default yang valid adalah 1, yang mengaktifkan penelusuran gambar. Misalnya, `search_type: 1`
`query_expansion_spec`	`QueryExpansionSpec` Spesifikasi perluasan kueri yang menentukan kondisi saat perluasan kueri terjadi.
`spell_correction_spec`	`SpellCorrectionSpec` Spesifikasi koreksi ejaan yang menentukan mode yang digunakan untuk menerapkan koreksi ejaan.
`user_pseudo_id`	`string` ID unik untuk melacak pengunjung. Misalnya, hal ini dapat diterapkan dengan cookie HTTP, yang harus dapat mengidentifikasi pengunjung secara unik di satu perangkat. ID unik ini tidak boleh berubah jika pengunjung login atau logout dari situs. Kolom ini TIDAK boleh memiliki nilai tetap seperti `unknown_visitor`. ID ini harus sama dengan `UserEvent.user_pseudo_id` dan `CompleteQueryRequest.user_pseudo_id` Kolom harus berupa string berenkode UTF-8 dengan batas panjang 128 karakter. Jika tidak, error `INVALID_ARGUMENT` akan ditampilkan.
`content_search_spec`	`ContentSearchSpec` Spesifikasi untuk mengonfigurasi perilaku penelusuran konten.
`ranking_expression`	`string` Opsional. Ekspresi peringkat mengontrol peringkat yang disesuaikan pada dokumen pengambilan. Tindakan ini akan menggantikan `ServingConfig.ranking_expression`. Sintaksis dan fitur yang didukung bergantung pada nilai `ranking_expression_backend`. Jika `ranking_expression_backend` tidak diberikan, nilai defaultnya adalah `RANK_BY_EMBEDDING`. Jika `ranking_expression_backend` tidak disediakan atau disetel ke `RANK_BY_EMBEDDING`, nilai tersebut harus berupa satu fungsi atau beberapa fungsi yang digabungkan dengan "+". ranking_expression = function, { " + ", function }; Fungsi yang didukung: double * relevance_score double * dotProduct(embedding_field_path) Variabel fungsi: `relevance_score`: kata kunci yang telah ditentukan sebelumnya, digunakan untuk mengukur relevansi antara kueri dan dokumen. `embedding_field_path`: kolom embedding dokumen yang digunakan dengan vektor embedding kueri. `dotProduct`: fungsi embedding antara `embedding_field_path` dan vektor embedding kueri. Contoh ekspresi peringkat: Jika dokumen memiliki kolom penyematan doc_embedding, ekspresi peringkatnya bisa berupa `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. Jika `ranking_expression_backend` disetel ke `RANK_BY_FORMULA`, jenis ekspresi berikut (dan kombinasi yang dirangkai menggunakan operator + atau ) didukung: `double` `signal` `log(signal)` `exp(signal)` `rr(signal, double > 0)` -- transformasi peringkat timbal balik dengan argumen kedua berupa konstanta penyebut. `is_nan(signal)` -- menampilkan 0 jika sinyal adalah NaN, 1 jika tidak. `fill_nan(signal1, signal2 \| double)` -- jika signal1 adalah NaN, menampilkan signal2 \| ganda, jika tidak, menampilkan signal1. Berikut beberapa contoh formula peringkat yang menggunakan jenis ekspresi peringkat yang didukung: `0.2 semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- sebagian besar diberi peringkat berdasarkan logaritma `keyword_similarity_score` dengan sedikit penyesuaian `semantic_smilarity_score`. `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- peringkat berdasarkan eksponen `semantic_similarity_score`, mengisi nilai dengan 0 jika NaN, juga menambahkan penyesuaian konstanta 0,3 ke skor akhir jika `semantic_similarity_score` adalah NaN. `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- sebagian besar diberi peringkat berdasarkan peringkat kebalikan `keyword_similarity_score` dengan sedikit penyesuaian peringkat kebalikan `semantic_smilarity_score`. Sinyal berikut didukung: `semantic_similarity_score`: penyesuaian kesamaan semantik yang dihitung menggunakan embedding yang dihasilkan oleh model Google eksklusif. Skor ini menentukan seberapa mirip kueri penelusuran dengan dokumen secara semantik. `keyword_similarity_score`: penyesuaian kecocokan kata kunci menggunakan fungsi pemberian peringkat Best Match 25 (BM25). Skor ini dihitung menggunakan model probabilistik untuk memperkirakan probabilitas bahwa dokumen relevan dengan kueri tertentu. `relevance_score`: penyesuaian relevansi semantik yang menggunakan model eksklusif Google untuk menentukan makna dan niat di balik kueri pengguna dalam konteks dengan konten dalam dokumen. `pctr_rank`: penyesuaian rasio konversi yang diprediksi sebagai penggunaan peringkat, rasio klik-tayang (pCTR) yang diprediksi untuk mengukur relevansi dan daya tarik hasil penelusuran dari perspektif pengguna. pCTR yang lebih tinggi menunjukkan bahwa hasil lebih mungkin memuaskan kueri dan niat pengguna, sehingga menjadikannya sinyal yang berharga untuk pemberian peringkat. `freshness_rank`: penyesuaian keaktualan sebagai peringkat `document_age`: Waktu dalam jam yang berlalu sejak dokumen terakhir diperbarui, bilangan floating point (misalnya, 0,25 berarti 15 menit). `topicality_rank`: penyesuaian topik sebagai peringkat. Menggunakan model Google eksklusif untuk menentukan tumpang-tindih berbasis kata kunci antara kueri dan dokumen. `base_rank`: peringkat default hasil
`ranking_expression_backend`	`RankingExpressionBackend` Opsional. Backend yang akan digunakan untuk evaluasi ekspresi peringkat.
`safe_search`	`bool` Apakah akan mengaktifkan safe search. Fitur ini hanya didukung untuk penelusuran situs.
`user_labels`	`map<string, string>` Label pengguna yang diterapkan ke resource harus memenuhi persyaratan berikut: Setiap resource dapat memiliki beberapa label, hingga maksimum 64 label. Setiap label harus berupa pasangan nilai kunci. Kunci memiliki panjang minimum 1 karakter dan panjang maksimum 63 karakter, serta tidak boleh kosong. Nilai boleh kosong dan memiliki panjang maksimum 63 karakter. Kunci dan nilai hanya boleh berisi huruf kecil, karakter numerik, garis bawah, dan tanda hubung. Semua karakter harus menggunakan encoding UTF-8, dan karakter internasional boleh digunakan. Bagian kunci label harus unik. Namun, Anda dapat menggunakan kunci yang sama dengan beberapa resource. Kunci harus diawali dengan huruf kecil atau karakter internasional. Lihat Dokumen Google Cloud untuk mengetahui detail selengkapnya.
`natural_language_query_understanding_spec`	`NaturalLanguageQueryUnderstandingSpec` Opsional. Konfigurasi untuk kemampuan pemahaman kueri bahasa natural, seperti mengekstrak filter kolom terstruktur dari kueri. Baca dokumentasi ini untuk mengetahui informasi selengkapnya. Jika `naturalLanguageQueryUnderstandingSpec` tidak ditentukan, tidak ada pemahaman kueri bahasa alami tambahan yang akan dilakukan.
`search_as_you_type_spec`	`SearchAsYouTypeSpec` Konfigurasi penelusuran saat Anda mengetik. Hanya didukung untuk kategori `IndustryVertical.MEDIA`.
`display_spec`	`DisplaySpec` Opsional. Konfigurasi untuk fitur tampilan, seperti penyorotan kecocokan pada hasil penelusuran.
`session`	`string` Nama resource sesi. Opsional. Sesi memungkinkan pengguna melakukan panggilan API multi-turn /search atau koordinasi antara panggilan API /search dan panggilan API /answer. Contoh #1 (panggilan API multi-turn /search): Panggil /search API dengan ID sesi yang dihasilkan pada panggilan pertama. Di sini, kueri penelusuran sebelumnya dipertimbangkan dalam posisi kueri. Artinya, jika kueri pertama adalah "Bagaimana kinerja Alphabet pada tahun 2022?" dan kueri saat ini adalah "Bagaimana dengan tahun 2023?", kueri saat ini akan ditafsirkan sebagai "Bagaimana kinerja Alphabet pada tahun 2023?". Contoh #2 (koordinasi antara panggilan API /search dan panggilan API /answer): Panggil API /answer dengan ID sesi yang dibuat pada panggilan pertama. Di sini, pembuatan jawaban terjadi dalam konteks hasil penelusuran dari panggilan penelusuran pertama. Fitur Penelusuran multi-giliran saat ini berada di tahap GA pribadi. Gunakan versi v1alpha atau v1beta sebelum kami meluncurkan fitur ini ke GA publik. Atau, minta agar Anda dimasukkan ke daftar yang diizinkan melalui tim Dukungan Google.
`session_spec`	`SessionSpec` Spesifikasi sesi. Hanya dapat digunakan jika `session` disetel.
`relevance_threshold`	`RelevanceThreshold` Nilai minimum relevansi hasil penelusuran. Secara default, menggunakan nilai minimum yang ditentukan Google, dengan memanfaatkan keseimbangan presisi dan perolehan untuk memberikan hasil yang sangat akurat dan cakupan komprehensif informasi yang relevan. Fitur ini tidak didukung untuk penelusuran layanan kesehatan.
`relevance_score_spec`	`RelevanceScoreSpec` Opsional. Spesifikasi untuk menampilkan skor relevansi.

BoostSpec

Spesifikasi peningkat untuk meningkatkan kualitas dokumen tertentu.

Kolom

condition_boost_specs[]

ConditionBoostSpec

Spesifikasi peningkat kondisi. Jika dokumen cocok dengan beberapa kondisi dalam spesifikasi, skor peningkat dari spesifikasi ini akan diterapkan dan digabungkan secara non-linear. Jumlah maksimum spesifikasi adalah 20.

ConditionBoostSpec

Peningkatan berlaku untuk dokumen yang cocok dengan suatu kondisi.

Kolom

condition

string

Ekspresi yang menentukan kondisi peninggian. Sintaksis dan kolom yang didukung sama dengan ekspresi filter. Lihat SearchRequest.filter untuk mengetahui sintaksis dan batasan detail.

Contoh:

Untuk meningkatkan kualitas dokumen dengan ID dokumen "doc_1" atau "doc_2", dan warna "Merah" atau "Biru": (document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))

boost

float

Kekuatan peningkatan kondisi, yang harus berada dalam [-1, 1]. Peningkatan negatif berarti penurunan. Nilai defaultnya adalah 0.0.

Menetapkan ke 1.0 akan memberikan promosi besar pada dokumen. Namun, dokumen yang dipromosikan tidak selalu menjadi hasil teratas, dan dokumen lain tidak akan dikecualikan. Hasil tetap dapat ditampilkan meskipun tidak ada yang cocok dengan kondisi. Selain itu, hasil yang jauh lebih relevan dengan kueri penelusuran masih dapat mengalahkan dokumen Anda yang sangat disukai tetapi tidak relevan.

Menetapkan ke -1,0 akan menurunkan peringkat dokumen secara signifikan. Namun, hasil yang sangat relevan mungkin masih ditampilkan. Dokumen akan bersaing untuk mendapatkan peringkat yang cukup tinggi, tetapi tidak diblokir sepenuhnya.

Menyetel ke 0,0 berarti tidak ada peningkatan yang diterapkan. Kondisi peningkatan diabaikan. Hanya satu kombinasi (kondisi, peningkat) atau boost_control_spec di bawah yang ditetapkan. Jika keduanya disetel, peningkatan global akan diabaikan dan boost_control_spec yang lebih terperinci akan diterapkan.

boost_control_spec

BoostControlSpec

Spesifikasi kompleks untuk peringkat kustom berdasarkan nilai atribut yang ditentukan pelanggan.

BoostControlSpec

Kolom
`field_name`	`string` Nama kolom yang nilainya akan digunakan untuk menentukan jumlah peningkat.
`attribute_type`	`AttributeType` Jenis atribut yang akan digunakan untuk menentukan jumlah peningkat. Nilai atribut dapat diperoleh dari nilai kolom field_name yang ditentukan. Untuk nilai numerik, caranya mudah, yaitu attribute_value = numerical_field_value. Namun, dalam kasus keaktualan, attribute_value = (time.now() - datetime_field_value).
`interpolation_type`	`InterpolationType` Jenis interpolasi yang akan diterapkan untuk menghubungkan titik kontrol yang tercantum di bawah.
`control_points[]`	`ControlPoint` Titik kontrol yang digunakan untuk menentukan kurva. Fungsi monotonik (ditentukan melalui interpolation_type di atas) melewati titik kontrol yang tercantum di sini.

AttributeType

Atribut(atau fungsi) yang akan diterapkan peringkat kustomnya.

Enum
`ATTRIBUTE_TYPE_UNSPECIFIED`	AttributeType tidak ditentukan.
`NUMERICAL`	Nilai kolom numerik akan digunakan untuk memperbarui jumlah peningkat secara dinamis. Dalam hal ini, attribute_value (nilai x) titik kontrol akan menjadi nilai sebenarnya dari kolom numerik yang boost_amount-nya ditentukan.
`FRESHNESS`	Untuk kasus penggunaan keaktualan, nilai atribut akan berupa durasi antara waktu saat ini dan tanggal di kolom datetime yang ditentukan. Nilai harus diformat sebagai nilai XSD `dayTimeDuration` (subset terbatas dari nilai durasi ISO 8601). Pola untuk ini adalah: `[nD][T[nH][nM][nS]]`. Misalnya, `5D`, `3DT12H30M`, `T24H`.

ControlPoint

Titik kontrol yang digunakan untuk menentukan kurva. Kurva yang ditentukan melalui titik kontrol ini hanya dapat meningkat atau menurun secara monoton(nilai konstan dapat diterima).

Kolom

attribute_value

string

Dapat berupa salah satu dari: 1. Nilai kolom numerik. 2. Spesifikasi durasi untuk keaktualan: Nilai harus diformat sebagai nilai XSD dayTimeDuration (subset terbatas dari nilai durasi ISO 8601). Pola untuk ini adalah: [nD][T[nH][nM][nS]].

boost_amount

float

Nilai antara -1 hingga 1 yang digunakan untuk meningkatkan skor jika attribute_value dievaluasi ke nilai yang ditentukan di atas.

InterpolationType

Jenis interpolasi yang akan diterapkan. Defaultnya adalah linear (Piecewise Linear).

Enum
`INTERPOLATION_TYPE_UNSPECIFIED`	Jenis interpolasi tidak ditentukan. Dalam hal ini, nilai defaultnya adalah Linear.
`LINEAR`	Interpolasi linear sepotong-sepotong akan diterapkan.

ContentSearchSpec

Spesifikasi untuk mengonfigurasi perilaku penelusuran konten.

Kolom
`snippet_spec`	`SnippetSpec` Jika `snippetSpec` tidak ditentukan, cuplikan tidak akan disertakan dalam respons penelusuran.
`summary_spec`	`SummarySpec` Jika `summarySpec` tidak ditentukan, ringkasan tidak akan disertakan dalam respons penelusuran.
`extractive_content_spec`	`ExtractiveContentSpec` Jika tidak ada extractive_content_spec yang diberikan, tidak akan ada jawaban ekstraktif dalam respons penelusuran.
`search_result_mode`	`SearchResultMode` Menentukan mode hasil penelusuran. Jika tidak ditentukan, mode hasil penelusuran ditetapkan ke `DOCUMENTS` secara default.
`chunk_spec`	`ChunkSpec` Menentukan spesifikasi potongan yang akan ditampilkan dari respons penelusuran. Hanya tersedia jika `SearchRequest.ContentSearchSpec.search_result_mode` disetel ke `CHUNKS`

ChunkSpec

Menentukan spesifikasi potongan yang akan ditampilkan dari respons penelusuran. Hanya tersedia jika SearchRequest.ContentSearchSpec.search_result_mode disetel ke CHUNKS

Kolom

num_previous_chunks

int32

Jumlah potongan sebelumnya yang akan ditampilkan dari potongan saat ini. Nilai maksimum yang diizinkan adalah 3. Jika tidak ditentukan, tidak ada chunk sebelumnya yang akan ditampilkan.

num_next_chunks

int32

Jumlah potongan berikutnya yang akan ditampilkan dari potongan saat ini. Nilai maksimum yang diizinkan adalah 3. Jika tidak ditentukan, tidak ada potongan berikutnya yang akan ditampilkan.

ExtractiveContentSpec

Spesifikasi untuk mengonfigurasi konten ekstraktif dalam respons penelusuran.

Kolom
`max_extractive_answer_count`	`int32` Jumlah maksimum jawaban ekstraktif yang ditampilkan di setiap hasil penelusuran. Jawaban ekstraktif adalah jawaban kata demi kata yang diekstrak dari dokumen asli, yang memberikan jawaban yang tepat dan relevan secara kontekstual untuk kueri penelusuran. Jika jumlah jawaban yang cocok kurang dari `max_extractive_answer_count`, tampilkan semua jawaban. Jika tidak, tampilkan `max_extractive_answer_count`. Maksimal lima jawaban ditampilkan untuk setiap `SearchResult`.
`max_extractive_segment_count`	`int32` Jumlah maksimum segmen ekstraktif yang ditampilkan di setiap hasil penelusuran. Hanya diterapkan jika `DataStore` ditetapkan ke `DataStore.ContentConfig.CONTENT_REQUIRED` atau `DataStore.solution_types` adalah `SOLUTION_TYPE_CHAT`. Segmen ekstraktif adalah segmen teks yang diekstrak dari dokumen asli yang relevan dengan kueri penelusuran, dan secara umum, lebih panjang daripada jawaban ekstraktif. Segmen tersebut kemudian dapat digunakan sebagai input untuk LLM dalam membuat ringkasan dan jawaban. Jika jumlah segmen yang cocok kurang dari `max_extractive_segment_count`, tampilkan semua segmen. Jika tidak, tampilkan `max_extractive_segment_count`.
`return_extractive_segment_score`	`bool` Menentukan apakah akan menampilkan skor keyakinan dari segmen ekstraktif di setiap hasil penelusuran. Fitur ini hanya tersedia untuk penyimpanan data baru atau yang masuk dalam daftar yang diizinkan. Untuk memasukkan toko data Anda ke daftar yang diizinkan, hubungi Customer Engineer Anda. Nilai defaultnya adalah `false`.
`num_previous_segments`	`int32` Menentukan apakah akan menyertakan juga yang berdekatan dari setiap segmen yang dipilih. Menampilkan paling banyak `num_previous_segments` segmen sebelum setiap segmen yang dipilih.
`num_next_segments`	`int32` Menampilkan paling banyak `num_next_segments` segmen setelah setiap segmen yang dipilih.

SearchResultMode

Menentukan mode hasil penelusuran. Jika tidak ditentukan, mode hasil penelusuran ditetapkan ke DOCUMENTS secara default.

Enum
`SEARCH_RESULT_MODE_UNSPECIFIED`	Nilai default.
`DOCUMENTS`	Menampilkan dokumen dalam hasil penelusuran.
`CHUNKS`	Menampilkan bagian dalam hasil penelusuran. Hanya tersedia jika `DocumentProcessingConfig.chunking_config` ditentukan.

SnippetSpec

Spesifikasi untuk mengonfigurasi cuplikan dalam respons penelusuran.

Kolom

max_snippet_count
(deprecated)

int32

[TIDAK DIGUNAKAN LAGI] Kolom ini tidak digunakan lagi. Untuk mengontrol kembalinya cuplikan, gunakan kolom return_snippet. Untuk kompatibilitas mundur, kami akan menampilkan cuplikan jika max_snippet_count > 0.

reference_only
(deprecated)

bool

[TIDAK DIGUNAKAN LAGI] Kolom ini tidak digunakan lagi dan tidak akan memengaruhi cuplikan.

return_snippet

bool

Jika true, tampilkan cuplikan. Jika tidak ada cuplikan yang dapat dibuat, kami akan menampilkan "Tidak ada cuplikan yang tersedia untuk halaman ini". snippet_status dengan SUCCESS atau NO_SNIPPET_AVAILABLE juga akan ditampilkan.

SummarySpec

Spesifikasi untuk mengonfigurasi ringkasan yang ditampilkan dalam respons penelusuran.

Kolom
`summary_result_count`	`int32` Jumlah hasil teratas yang akan digunakan untuk membuat ringkasan. Jika jumlah hasil yang ditampilkan kurang dari `summaryResultCount`, ringkasan dibuat dari semua hasil. Maksimal 10 hasil untuk mode dokumen, atau 50 untuk mode potongan, dapat digunakan untuk membuat ringkasan. Mode potongan digunakan saat `SearchRequest.ContentSearchSpec.search_result_mode` disetel ke `CHUNKS`.
`include_citations`	`bool` Menentukan apakah akan menyertakan kutipan dalam ringkasan. Nilai defaultnya adalah `false`. Jika kolom ini disetel ke `true`, ringkasan akan menyertakan nomor kutipan inline. Contoh ringkasan yang menyertakan kutipan: BigQuery adalah data warehouse perusahaan dari Google Cloud yang sepenuhnya terkelola dan serverless [1]. BigQuery mendukung semua jenis data, kompatibel dengan berbagai cloud, dan memiliki machine learning serta business intelligence bawaan, semuanya dalam satu platform terpadu [2, 3]. Nomor kutipan merujuk pada hasil penelusuran yang ditampilkan dan diindeks 1. Misalnya, [1] berarti kalimat tersebut diatribusikan ke hasil penelusuran pertama. [2, 3] berarti kalimat tersebut diatribusikan ke hasil penelusuran kedua dan ketiga.
`ignore_adversarial_query`	`bool` Menentukan apakah kueri berbahaya harus difilter. Nilai defaultnya adalah `false`. Google menggunakan klasifikasi kueri penelusuran untuk mendeteksi kueri berbahaya. Tidak ada ringkasan yang ditampilkan jika kueri penelusuran diklasifikasikan sebagai kueri yang merugikan. Misalnya, pengguna dapat mengajukan pertanyaan terkait komentar negatif tentang perusahaan atau mengirimkan kueri yang dirancang untuk menghasilkan output yang tidak aman dan melanggar kebijakan. Jika kolom ini disetel ke `true`, kami akan melewati pembuatan ringkasan untuk kueri yang bertentangan dan menampilkan pesan penggantian.
`ignore_non_summary_seeking_query`	`bool` Menentukan apakah akan mengecualikan kueri yang tidak mencari ringkasan. Nilai defaultnya adalah `false`. Google menggunakan klasifikasi kueri penelusuran untuk mendeteksi kueri yang mencari ringkasan. Tidak ada ringkasan yang ditampilkan jika kueri penelusuran diklasifikasikan sebagai kueri yang tidak mencari ringkasan. Misalnya, `why is the sky blue` dan `Who is the best soccer player in the world?` adalah kueri yang mencari ringkasan, tetapi `SFO airport` dan `world cup 2026` bukan. Kueri tersebut kemungkinan besar adalah kueri navigasi. Jika kolom ini disetel ke `true`, kami akan melewati pembuatan ringkasan untuk kueri yang tidak mencari ringkasan dan menampilkan pesan penggantian.
`ignore_low_relevant_content`	`bool` Menentukan apakah akan memfilter kueri yang memiliki relevansi rendah. Nilai defaultnya adalah `false`. Jika kolom ini disetel ke `false`, semua hasil penelusuran akan digunakan, terlepas dari relevansinya, untuk membuat jawaban. Jika disetel ke `true`, hanya kueri dengan hasil penelusuran yang sangat relevan yang akan menghasilkan jawaban.
`ignore_jail_breaking_query`	`bool` Opsional. Menentukan apakah kueri jailbreak akan difilter. Nilai defaultnya adalah `false`. Google menggunakan klasifikasi kueri penelusuran untuk mendeteksi kueri jailbreak. Tidak ada ringkasan yang ditampilkan jika kueri penelusuran diklasifikasikan sebagai kueri pelarian dari batasan. Pengguna dapat menambahkan petunjuk ke kueri untuk mengubah gaya bahasa, gaya penulisan, bahasa, konten jawaban, atau meminta model bertindak sebagai entitas lain, misalnya, "Balas dengan gaya bahasa CEO perusahaan pesaing". Jika kolom ini disetel ke `true`, kami akan melewati pembuatan ringkasan untuk kueri jailbreak dan menampilkan pesan penggantian.
`model_prompt_spec`	`ModelPromptSpec` Jika ditentukan, spesifikasi akan digunakan untuk mengubah perintah yang diberikan ke LLM.
`language_code`	`string` Kode bahasa untuk Ringkasan. Gunakan tag bahasa yang ditentukan oleh BCP47. Catatan: Ini adalah fitur eksperimental.
`model_spec`	`ModelSpec` Jika ditentukan, spesifikasi akan digunakan untuk mengubah spesifikasi model yang diberikan ke LLM.
`use_semantic_chunks`	`bool` Jika benar, jawaban akan dihasilkan dari potongan yang paling relevan dari hasil penelusuran teratas. Fitur ini akan meningkatkan kualitas ringkasan. Perhatikan bahwa jika fitur ini diaktifkan, tidak semua hasil penelusuran teratas akan dirujuk dan disertakan dalam daftar rujukan, sehingga indeks sumber kutipan hanya mengarah ke hasil penelusuran yang tercantum dalam daftar rujukan.

ModelPromptSpec

Spesifikasi perintah yang akan digunakan dengan model.

Kolom

preamble

string

Teks di awal perintah yang memberikan petunjuk kepada asisten. Contoh tersedia di panduan pengguna.

ModelSpec

Spesifikasi model.

Kolom

version

string

Versi model yang digunakan untuk membuat ringkasan.

Nilai yang didukung adalah:

stable: string. Nilai default saat tidak ada nilai yang ditentukan. Menggunakan model yang telah disesuaikan dan tersedia secara umum. Untuk mengetahui informasi selengkapnya, lihat Versi dan siklus proses model pembuatan jawaban.
preview: string. (Pratinjau publik) Menggunakan model pratinjau. Untuk mengetahui informasi selengkapnya, lihat Versi dan siklus proses model pembuatan jawaban.

DataStoreSpec

Struktur untuk menentukan penyimpanan data yang akan difilter dalam panggilan penelusuran dan konfigurasi untuk penyimpanan data tersebut. Jika tidak, error INVALID_ARGUMENT akan ditampilkan.

Kolom
`data_store`	`string` Wajib. Nama resource lengkap `DataStore`, seperti `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. Jalur harus menyertakan nomor project, ID project tidak didukung untuk kolom ini.
`filter`	`string` Opsional. Spesifikasi filter untuk memfilter dokumen di penyimpanan data yang ditentukan oleh kolom data_store. Untuk mengetahui informasi selengkapnya tentang pemfilteran, lihat Pemfilteran.
`boost_spec`	`BoostSpec` Opsional. Spesifikasi peningkat untuk meningkatkan kualitas dokumen tertentu. Untuk mengetahui informasi selengkapnya tentang promosi, lihat Promosi
`custom_search_operators`	`string` Opsional. Operator penelusuran kustom yang jika ditentukan akan digunakan untuk memfilter hasil dari penyimpanan data ruang kerja. Untuk mengetahui informasi selengkapnya tentang operator penelusuran kustom, lihat SearchOperators.

DisplaySpec

Menentukan fitur untuk ditampilkan, seperti penyorotan kecocokan.

Kolom

match_highlighting_condition

Kondisi saat penyorotan kecocokan harus terjadi.

MatchHighlightingCondition

Enum yang menjelaskan kondisi yang mendasari penyorotan kecocokan.

Enum
`MATCH_HIGHLIGHTING_CONDITION_UNSPECIFIED`	Perilaku server sama dengan `MATCH_HIGHLIGHTING_DISABLED`.
`MATCH_HIGHLIGHTING_DISABLED`	Menonaktifkan penyorotan kecocokan di semua dokumen.
`MATCH_HIGHLIGHTING_ENABLED`	Mengaktifkan penyorotan kecocokan di semua dokumen.

FacetSpec

Spesifikasi faset untuk melakukan penelusuran dengan faset.

Kolom
`facet_key`	`FacetKey` Wajib. Spesifikasi kunci aspek.
`limit`	`int32` Nilai faset maksimum yang ditampilkan untuk faset ini. Jika tidak ditentukan, nilai defaultnya adalah 20. Nilai maksimum yang diizinkan adalah 300. Nilai di atas 300 akan dikonversi menjadi 300. Untuk penggabungan dalam penelusuran layanan kesehatan, jika [FacetKey.key] adalah "healthcare_aggregation_key", batas akan diganti menjadi 10.000 secara internal, terlepas dari nilai yang ditetapkan di sini. Jika kolom ini negatif, `INVALID_ARGUMENT` akan ditampilkan.
`excluded_filter_keys[]`	`string` Daftar kunci yang akan dikecualikan saat memfasilitasi. Secara default, `FacetKey.key` tidak dikecualikan dari filter kecuali jika tercantum dalam kolom ini. Mencantumkan kunci faset di kolom ini memungkinkan nilainya muncul sebagai hasil faset, meskipun nilai tersebut difilter dari hasil penelusuran. Penggunaan kolom ini tidak memengaruhi hasil penelusuran yang ditampilkan. Misalnya, ada 100 dokumen dengan faset warna "Merah" dan 200 dokumen dengan faset warna "Biru". Kueri yang berisi filter "color:ANY("Red")" dan memiliki "color" sebagai `FacetKey.key` secara default hanya akan menampilkan dokumen "Red" dalam hasil penelusuran, dan juga menampilkan "Red" dengan jumlah 100 sebagai satu-satunya faset warna. Meskipun ada juga dokumen biru yang tersedia, "Biru" tidak akan ditampilkan sebagai nilai faset yang tersedia. Jika "color" tercantum di "excludedFilterKeys", kueri akan menampilkan nilai faset "Red" dengan jumlah 100 dan "Blue" dengan jumlah 200, karena kunci "color" kini dikecualikan dari filter. Karena kolom ini tidak memengaruhi hasil penelusuran, hasil penelusuran masih difilter dengan benar untuk menampilkan hanya dokumen "Merah". Maksimum 100 nilai yang diizinkan. Jika tidak, error `INVALID_ARGUMENT` akan ditampilkan.
`enable_dynamic_position`	`bool` Mengaktifkan posisi dinamis untuk faset ini. Jika disetel ke benar (true), posisi aspek ini di antara semua aspek dalam respons akan ditentukan secara otomatis. Jika faset dinamis diaktifkan, faset tersebut akan diurutkan bersama. Jika disetel ke salah (false), posisi aspek ini dalam respons sama seperti dalam permintaan, dan aspek ini diberi peringkat sebelum aspek dengan posisi dinamis diaktifkan dan semua aspek dinamis. Misalnya, Anda mungkin selalu ingin aspek rating ditampilkan dalam respons, tetapi aspek rating tidak harus selalu ditampilkan di bagian atas. Dalam hal ini, Anda dapat menyetel enable_dynamic_position ke benar (true) sehingga posisi aspek penilaian dalam respons ditentukan secara otomatis. Contoh lain, dengan asumsi Anda memiliki aspek berikut dalam permintaan: "rating", enable_dynamic_position = true "price", enable_dynamic_position = false "brands", enable_dynamic_position = false Selain itu, Anda telah mengaktifkan faset dinamis, yang menghasilkan `gender` faset. Kemudian, urutan akhir faset dalam respons dapat berupa ("price", "brands", "rating", "gender") atau ("price", "brands", "gender", "rating") bergantung pada cara API mengurutkan faset "gender" dan "rating". Namun, perhatikan bahwa "harga" dan "merek" selalu berada di posisi pertama dan kedua karena enable_dynamic_position-nya adalah salah (false).

FacetKey

Menentukan cara penghitungan aspek.

Kolom
`key`	`string` Wajib. Kunci faset tekstual dan numerik yang didukung dalam objek `Document`, yang digunakan untuk menghitung nilai faset. Kunci facet peka huruf besar/kecil.
`intervals[]`	`Interval` Tetapkan hanya jika nilai harus dikelompokkan ke dalam interval. Harus ditetapkan untuk aspek dengan nilai numerik. Tidak boleh ditetapkan untuk faset dengan nilai teks. Jumlah interval maksimum adalah 30.
`restricted_values[]`	`string` Hanya mendapatkan aspek untuk nilai terbatas tertentu. Hanya didukung di kolom tekstual. Misalnya, "kategori" memiliki tiga nilai "Action > 2022", "Action > 2021", dan "Sci-Fi > 2022". Jika "restricted_values" ditetapkan ke "Action > 2022", aspek "category" hanya berisi "Action > 2022". Hanya didukung di kolom tekstual. Maksimum adalah 10.
`prefixes[]`	`string` Hanya dapatkan nilai aspek yang dimulai dengan awalan string tertentu. Misalnya, "kategori" memiliki tiga nilai "Action > 2022", "Action > 2021", dan "Sci-Fi > 2022". Jika "prefixes" ditetapkan ke "Action", faset "category" hanya berisi "Action > 2022" dan "Action > 2021". Hanya didukung di kolom tekstual. Maksimum adalah 10.
`contains[]`	`string` Hanya dapatkan nilai aspek yang berisi string tertentu. Misalnya, "kategori" memiliki tiga nilai "Action > 2022", "Action > 2021", dan "Sci-Fi > 2022". Jika "contains" disetel ke "2022", faset "category" hanya berisi "Action > 2022" dan "Sci-Fi > 2022". Hanya didukung di kolom tekstual. Maksimum adalah 10.
`case_insensitive`	`bool` Benar untuk membuat kunci facet tidak peka huruf besar/kecil saat mendapatkan nilai facet dengan awalan atau berisi; salah jika tidak.
`order_by`	`string` Urutan dokumen yang ditampilkan. Nilai yang diperbolehkan adalah: "count desc", yang berarti urutkan menurut `SearchResponse.Facet.values.count` dari atas ke bawah. "value desc", yang berarti urutkan menurut `SearchResponse.Facet.values.value` menurun. Hanya berlaku untuk aspek tekstual. Jika tidak ditetapkan, nilai tekstual diurutkan dalam urutan alami; interval numerik diurutkan dalam urutan yang diberikan oleh `FacetSpec.FacetKey.intervals`.

ImageQuery

Menentukan input kueri gambar.

Kolom

Kolom union image.

image hanya dapat berupa salah satu dari hal berikut:

image_bytes

string

Byte gambar berenkode Base64. Format gambar yang didukung: JPEG, PNG, dan BMP.

NaturalLanguageQueryUnderstandingSpec

Spesifikasi untuk mengaktifkan kemampuan pemahaman bahasa alami untuk permintaan penelusuran.

Kolom
`filter_extraction_condition`	`FilterExtractionCondition` Kondisi saat ekstraksi filter harus terjadi. Perilaku server secara default adalah `DISABLED`.
`geo_search_query_detection_field_names[]`	`string` Nama kolom yang digunakan untuk pemfilteran berbasis lokasi, tempat filter geolokasi terdeteksi dalam kueri penelusuran bahasa alami. Hanya valid jika FilterExtractionCondition disetel ke `ENABLED`. Jika kolom ini ditetapkan, kolom ini akan menggantikan nama kolom yang ditetapkan di `ServingConfig.geo_search_query_detection_field_names`.
`extracted_filter_behavior`	`ExtractedFilterBehavior` Opsional. Mengontrol perilaku penerapan filter yang diekstrak ke penelusuran. Perilaku default bergantung pada permintaan. Untuk penelusuran terstruktur datastore tunggal, nilai defaultnya adalah `HARD_FILTER`. Untuk penelusuran multi-datastore, perilaku defaultnya adalah `SOFT_BOOST`. Filter berbasis lokasi selalu diterapkan sebagai filter tetap, dan setelan `SOFT_BOOST` tidak akan memengaruhinya. Kolom ini hanya digunakan jika [SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition][] ditetapkan ke `FilterExtractionCondition.ENABLED`.
`allowed_field_names[]`	`string` Opsional. Daftar kolom yang diizinkan yang dapat digunakan untuk ekstraksi filter bahasa natural. Secara default, jika tidak ditentukan, semua kolom yang dapat diindeks memenuhi syarat untuk ekstraksi filter bahasa alami (tetapi tidak dijamin akan digunakan). Jika ada kolom yang ditentukan dalam allowed_field_names, hanya kolom yang ditandai sebagai dapat diindeks dalam skema dan ditentukan dalam daftar yang diizinkan yang akan memenuhi syarat untuk ekstraksi filter bahasa alami. Catatan: untuk penelusuran multi-datastore, fitur ini belum didukung, dan akan diabaikan.

ExtractedFilterBehavior

Enum yang menjelaskan cara filter yang diekstrak diterapkan ke penelusuran.

Enum
`EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED`	`EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED` akan menggunakan perilaku default untuk filter yang diekstrak. Untuk penelusuran datastore tunggal, defaultnya adalah menerapkan sebagai filter tetap. Untuk penelusuran multi-datastore, defaultnya adalah menerapkan sebagai peningkatan ringan.
`HARD_FILTER`	Menerapkan semua filter yang diekstrak sebagai filter tetap pada hasil. Hasil yang tidak lulus filter yang diekstrak tidak akan ditampilkan dalam kumpulan hasil.
`SOFT_BOOST`	Menerapkan semua filter yang diekstrak sebagai peningkatan ringan. Hasil yang lolos filter akan dipromosikan ke peringkat yang lebih tinggi dalam kumpulan hasil.

FilterExtractionCondition

Enum yang menjelaskan kondisi saat ekstraksi filter harus terjadi.

Enum
`CONDITION_UNSPECIFIED`	Perilaku server secara default adalah `DISABLED`.
`DISABLED`	Menonaktifkan ekstraksi filter NL.
`ENABLED`	Mengaktifkan ekstraksi filter NL.

QueryExpansionSpec

Spesifikasi untuk menentukan kondisi yang mensyaratkan terjadinya perluasan kueri.

Kolom

condition

Condition

Kondisi saat perluasan kueri harus terjadi. Default-nya adalah Condition.DISABLED.

pin_unexpanded_results

bool

Apakah akan menyematkan hasil yang tidak diperluas. Jika kolom ini disetel ke benar (true), produk yang tidak diperluas akan selalu berada di bagian atas hasil penelusuran, diikuti dengan hasil yang diperluas.

Kondisi

Enum yang menjelaskan kondisi yang mendasari terjadinya perluasan kueri.

Enum
`CONDITION_UNSPECIFIED`	Kondisi perluasan kueri tidak ditentukan. Dalam hal ini, perilaku server ditetapkan secara default ke `Condition.DISABLED`.
`DISABLED`	Perluasan kueri dinonaktifkan. Hanya kueri penelusuran persis yang digunakan, meskipun `SearchResponse.total_size` adalah nol.
`AUTO`	Perluasan kueri otomatis yang dibuat oleh Search API.

RankingExpressionBackend

Backend yang akan digunakan untuk evaluasi ekspresi peringkat.

Enum
`RANKING_EXPRESSION_BACKEND_UNSPECIFIED`	Opsi default untuk nilai yang tidak ditentukan/tidak diketahui.
`BYOE`	Tidak digunakan lagi: Gunakan `RANK_BY_EMBEDDING` sebagai gantinya. Peringkat menurut model sematan kustom, cara default untuk mengevaluasi ekspresi peringkat. Opsi enum lama, `RANK_BY_EMBEDDING` harus digunakan sebagai gantinya. Item ini tidak digunakan lagi.
`CLEARBOX`	Tidak digunakan lagi: Gunakan `RANK_BY_FORMULA` sebagai gantinya. Peringkat menurut formula kustom. Opsi enum lama, `RANK_BY_FORMULA` harus digunakan sebagai gantinya. Item ini tidak digunakan lagi.
`RANK_BY_EMBEDDING`	Peringkat menurut model sematan kustom, cara default untuk mengevaluasi ekspresi peringkat.
`RANK_BY_FORMULA`	Peringkat menurut formula kustom.

RelevanceScoreSpec

Spesifikasi untuk menampilkan skor relevansi dokumen.

Kolom

return_relevance_score

bool

Opsional. Apakah akan menampilkan skor relevansi untuk hasil penelusuran. Makin tinggi skornya, makin relevan dokumen tersebut dengan kueri.

RelevanceThreshold

Nilai minimum relevansi hasil penelusuran. Makin tinggi nilai minimum relevansi, makin banyak hasil yang relevan ditampilkan dan makin sedikit jumlah hasil yang ditampilkan.

Enum
`RELEVANCE_THRESHOLD_UNSPECIFIED`	Nilai default. Dalam hal ini, perilaku server secara default adalah batas yang ditentukan Google.
`LOWEST`	Nilai minimum relevansi.
`LOW`	Nilai minimum relevansi rendah.
`MEDIUM`	Nilai minimum relevansi sedang.
`HIGH`	Nilai minimum relevansi tinggi.

SearchAsYouTypeSpec

Spesifikasi untuk penelusuran saat Anda mengetik di permintaan penelusuran.

Kolom

condition

Condition

Kondisi saat penelusuran saat Anda mengetik harus terjadi. Default-nya adalah Condition.DISABLED.

Kondisi

Enum yang menjelaskan kondisi yang mendasari terjadinya penelusuran saat Anda mengetik.

Enum
`CONDITION_UNSPECIFIED`	Perilaku server secara default adalah `Condition.DISABLED`.
`DISABLED`	Menonaktifkan Telusuri Saat Anda Mengetik.
`ENABLED`	Mengaktifkan Telusuri Saat Anda Mengetik.
`AUTO`	Pengalihan otomatis antara mode penelusuran saat Anda mengetik dan penelusuran standar, ideal untuk penerapan API tunggal (misalnya, penghilangan getaran).

SessionSpec

Spesifikasi sesi.

Fitur Penelusuran multi-giliran saat ini berada di tahap GA pribadi. Gunakan versi v1alpha atau v1beta sebelum kami meluncurkan fitur ini ke GA publik. Atau, minta agar Anda dimasukkan ke daftar yang diizinkan melalui tim Dukungan Google.

Kolom

query_id

string

Jika disetel, hasil penelusuran akan disimpan ke "giliran" yang ditentukan oleh ID kueri ini.

Contoh: Misalkan sesi terlihat seperti ini: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } }

Pengguna dapat memanggil /search API dengan permintaan seperti ini:

session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" }

Kemudian, API menyimpan hasil penelusuran, yang terkait dengan giliran terakhir. Hasil penelusuran yang disimpan dapat digunakan oleh panggilan API /answer berikutnya (dengan ID sesi dan ID kueri yang ditentukan). Selain itu, /search dan /answer dapat dipanggil secara paralel dengan ID sesi & ID kueri yang sama.

search_result_persistence_count

int32

Jumlah hasil penelusuran teratas yang akan dipertahankan. Hasil penelusuran yang dipertahankan dapat digunakan untuk panggilan API /answer berikutnya.

Kolom ini mirip dengan kolom summary_result_count di SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count.

Maksimum 10 hasil untuk mode dokumen, atau 50 untuk mode potongan.

SpellCorrectionSpec

Spesifikasi untuk koreksi ejaan kueri.

Kolom

mode

Mode

Mode yang digunakan koreksi ejaan untuk menggantikan kueri penelusuran asli. Nilai defaultnya adalah Mode.AUTO.

Mode

Enum yang menjelaskan mode koreksi ejaan yang harus dilakukan.

Enum
`MODE_UNSPECIFIED`	Mode koreksi ejaan tidak ditentukan. Dalam hal ini, perilaku server ditetapkan secara default ke `Mode.AUTO`.
`SUGGESTION_ONLY`	Search API mencoba menemukan saran ejaan. Jika saran ditemukan, saran tersebut akan dimasukkan ke dalam `SearchResponse.corrected_query`. Saran ejaan tidak akan digunakan sebagai kueri penelusuran.
`AUTO`	Koreksi ejaan otomatis yang dibuat oleh Search API. Penelusuran akan didasarkan pada kueri yang telah dikoreksi jika ditemukan.

SearchResponse

Pesan respons untuk metode SearchService.Search.

Kolom
`results[]`	`SearchResult` Daftar dokumen yang cocok. Urutan ini menunjukkan peringkat.
`facets[]`	`Facet` Hasil aspek yang diminta oleh pengguna.
`total_size`	`int32` Perkiraan jumlah total item yang cocok, terlepas dari penomoran halaman. Jumlah `results` yang ditampilkan oleh penomoran halaman mungkin kurang dari `total_size` yang cocok.
`attribution_token`	`string` Token penelusuran unik. Ini harus disertakan dalam log `UserEvent` yang dihasilkan dari penelusuran ini, yang memungkinkan atribusi akurat performa model penelusuran. ID ini juga membantu mengidentifikasi permintaan selama skenario dukungan pelanggan.
`redirect_uri`	`string` URI halaman pengalihan yang ditentukan pelanggan. Jika tindakan pengalihan dipicu, tidak ada penelusuran yang dilakukan, dan hanya `redirect_uri` dan `attribution_token` yang ditetapkan dalam respons.
`next_page_token`	`string` Token yang dapat dikirim sebagai `SearchRequest.page_token` untuk mengambil halaman berikutnya. Jika kolom ini dihilangkan, tidak akan ada halaman berikutnya.
`corrected_query`	`string` Berisi kueri yang ejaannya dikoreksi, jika ditemukan. Jika jenis koreksi ejaan adalah OTOMATIS, hasil penelusuran didasarkan pada corrected_query. Jika tidak, kueri asli akan digunakan untuk penelusuran.
`summary`	`Summary` Ringkasan sebagai bagian dari hasil penelusuran. Kolom ini hanya ditampilkan jika `SearchRequest.ContentSearchSpec.summary_spec` ditetapkan.
`query_expansion_info`	`QueryExpansionInfo` Informasi perluasan kueri untuk hasil yang ditampilkan.
`session_info`	`SessionInfo` Informasi sesi. Hanya disetel jika `SearchRequest.session` diberikan. Lihat deskripsinya untuk mengetahui detail selengkapnya.
`search_link_promotions[]`	`SearchLinkPromotion` Promosi untuk penelusuran situs.

Hasil faset.

Kolom

key

string

Kunci untuk faset ini. Misalnya "colors" atau "price". Cocok dengan SearchRequest.FacetSpec.FacetKey.key.

values[]

FacetValue

Nilai faset untuk kolom ini.

dynamic_facet

bool

Apakah aspek dibuat secara dinamis.

FacetValue

Nilai facet yang berisi nama nilai dan jumlahnya.

Kolom
`count`	`int64` Jumlah item yang memiliki nilai faset ini.
Kolom union `facet_value`. Nilai facet yang berisi nilai. `facet_value` hanya ada berupa salah satu diantara berikut:
`value`	`string` Nilai teks faset, seperti "Hitam" untuk faset "warna".
`interval`	`Interval` Nilai interval untuk faset, seperti [10, 20) untuk faset "harga". Cocok dengan `SearchRequest.FacetSpec.FacetKey.intervals`.

QueryExpansionInfo

Informasi yang menjelaskan perluasan kueri, termasuk apakah perluasan telah terjadi.

Kolom

expanded_query

bool

Bool yang menjelaskan apakah perluasan kueri telah terjadi.

pinned_result_count

int64

Jumlah hasil yang disematkan. Kolom ini hanya akan ditetapkan saat ekspansi terjadi dan SearchRequest.QueryExpansionSpec.pin_unexpanded_results ditetapkan ke benar (true).

SearchResult

Menampilkan hasil penelusuran.

Kolom
`id`	`string` `Document.id` dari `Document` yang ditelusuri.
`document`	`Document` Cuplikan data dokumen dalam respons penelusuran. Hanya kolom yang ditandai sebagai `retrievable` yang diisi.
`chunk`	`Chunk` Data potongan dalam respons penelusuran jika `SearchRequest.ContentSearchSpec.search_result_mode` disetel ke `CHUNKS`.
`model_scores`	`map<string, DoubleList>` Hanya output. Google menyediakan skor yang tersedia.
`rank_signals`	`RankSignals` Opsional. Kumpulan sinyal peringkat yang terkait dengan hasil.

RankSignals

Kumpulan sinyal penentu peringkat.

Kolom
`default_rank`	`float` Opsional. Peringkat default hasil.
`custom_signals[]`	`CustomSignal` Opsional. Daftar sinyal clearbox kustom.
`keyword_similarity_score`	`float` Opsional. Penyesuaian pencocokan kata kunci.
`relevance_score`	`float` Opsional. Penyesuaian relevansi semantik.
`semantic_similarity_score`	`float` Opsional. Penyesuaian kemiripan semantik.
`pctr_rank`	`float` Opsional. Penyesuaian prediksi rasio konversi sebagai peringkat.
`topicality_rank`	`float` Opsional. Penyesuaian topikalitas sebagai peringkat.
`document_age`	`float` Opsional. Usia dokumen dalam jam.
`boosting_factor`	`float` Opsional. Menggabungkan peningkatan kustom untuk dokumen.

CustomSignal

Sinyal clearbox kustom yang diwakili oleh pasangan nama dan nilai.

Kolom

name

string

Opsional. Nama sinyal.

value

float

Opsional. Nilai mengambang yang merepresentasikan sinyal peringkat (misalnya, 1,25 untuk BM25).

SessionInfo

Informasi tentang sesi.

Kolom

name

string

Nama sesi. Jika mode sesi otomatis digunakan (saat SearchRequest.session berakhir dengan "-"), kolom ini akan menyimpan nama sesi yang baru dibuat.

query_id

string

ID kueri yang sesuai dengan panggilan API penelusuran ini. Satu sesi dapat memiliki beberapa giliran, yang masing-masing memiliki ID kueri unik.

Dengan menentukan nama sesi dan ID kueri ini dalam panggilan Answer API, pembuatan jawaban terjadi dalam konteks hasil penelusuran dari panggilan penelusuran ini.

Ringkasan

Ringkasan N hasil penelusuran teratas yang ditentukan oleh spesifikasi ringkasan.

Kolom
`summary_text`	`string` Konten ringkasan.
`summary_skipped_reasons[]`	`SummarySkippedReason` Alasan tambahan ringkasan dilewati. Hal ini memberikan alasan untuk kasus yang diabaikan. Jika tidak ada yang dilewati, kolom ini tidak ditetapkan.
`safety_attributes`	`SafetyAttributes` Kumpulan kategori Atribut Keamanan dan skor keyakinannya yang terkait.
`summary_with_metadata`	`SummaryWithMetadata` Ringkasan dengan informasi metadata.

Pengutipan

Info kutipan untuk segmen.

Kolom

start_index

int64

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

end_index

int64

Akhir segmen yang diatribusikan, eksklusif.

sources[]

CitationSource

Sumber kutipan untuk segmen yang diatribusikan.

CitationMetadata

Metadata kutipan.

Kolom

citations[]

Citation

Kutipan untuk segmen.

CitationSource

Sumber kutipan.

Kolom

reference_index

int64

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

Referensi

Referensi dokumen.

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.
`chunk_contents[]`	`ChunkContent` Daftar konten potongan yang dikutip yang berasal dari konten dokumen.

ChunkContent

Memecah konten.

Kolom

content

string

Mengelompokkan konten tekstual.

page_identifier

string

ID halaman.

SafetyAttributes

Kategori Atribut Keamanan dan skor keyakinannya yang terkait.

Kolom

categories[]

string

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

scores[]

float

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

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.

SummaryWithMetadata

Ringkasan dengan informasi metadata.

Kolom

summary

string

Teks ringkasan tanpa informasi kutipan.

citation_metadata

CitationMetadata

Metadata kutipan untuk ringkasan tertentu.

references[]

Reference

Referensi Dokumen.

SearchTier

Tingkatan fitur penelusuran. Tingkatan yang berbeda mungkin memiliki harga yang berbeda. Untuk mempelajari lebih lanjut, lihat dokumentasi harga.

Enum
`SEARCH_TIER_UNSPECIFIED`	Nilai default saat enum tidak ditentukan. Tidak valid untuk digunakan.
`SEARCH_TIER_STANDARD`	Tingkat standar.
`SEARCH_TIER_ENTERPRISE`	Paket Enterprise.

SearchUseCase

Menentukan sub-pembagian lebih lanjut dari SolutionType. Berlaku khusus untuk SOLUTION_TYPE_SEARCH.

Enum
`SEARCH_USE_CASE_UNSPECIFIED`	Nilai yang digunakan saat tidak disetel. Tidak akan terjadi di CSS.
`SEARCH_USE_CASE_SEARCH`	Kasus penggunaan penelusuran. Mengharapkan traffic memiliki `query` yang tidak kosong.
`SEARCH_USE_CASE_BROWSE`	Jelajahi kasus penggunaan. Mengharapkan traffic memiliki `query` kosong.

ServingConfig

Mengonfigurasi metadata yang digunakan untuk menghasilkan hasil waktu penayangan (misalnya, hasil penelusuran atau prediksi rekomendasi). ServingConfig diteruskan dalam permintaan penelusuran dan prediksi serta menghasilkan hasil.

Kolom
`name`	`string` Tidak dapat diubah. Nama yang sepenuhnya memenuhi syarat `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}`
`display_name`	`string` Wajib. Nama tampilan konfigurasi penayangan yang dapat dibaca manusia. Digunakan di UI Discovery. Kolom ini harus berupa string berenkode UTF-8 dengan batas panjang 128 karakter. Jika tidak, error INVALID_ARGUMENT akan ditampilkan.
`solution_type`	`SolutionType` Wajib. Tidak dapat diubah. Menentukan jenis solusi yang dapat dikaitkan dengan konfigurasi penayangan.
`model_id`	`string` ID model yang akan digunakan pada waktu inferensi. Saat ini hanya RecommendationModel yang didukung. Dapat diubah, tetapi hanya ke model yang kompatibel (misalnya, CTR "mungkin Anda suka" ke CVR "mungkin Anda suka"). Wajib jika `SolutionType` adalah `SOLUTION_TYPE_RECOMMENDATION`.
`diversity_level`	`string` Seberapa banyak keragaman yang akan digunakan dalam hasil model rekomendasi, misalnya `medium-diversity` atau `high-diversity`. Nilai yang saat ini didukung: `no-diversity` `low-diversity` `medium-diversity` `high-diversity` `auto-diversity` Jika tidak ditentukan, kami akan memilih default berdasarkan jenis model rekomendasi. Nilai default: `no-diversity`. Hanya dapat disetel jika `SolutionType` adalah `SOLUTION_TYPE_RECOMMENDATION`.
`ranking_expression`	`string` Ekspresi peringkat mengontrol peringkat yang disesuaikan pada dokumen pengambilan. Untuk memanfaatkannya, penyematan dokumen diperlukan. Setelan ekspresi peringkat di ServingConfig berlaku untuk semua permintaan penelusuran yang ditayangkan oleh konfigurasi penayangan. Namun, jika `SearchRequest.ranking_expression` ditentukan, `SearchRequest.ranking_expression` akan menggantikan ekspresi peringkat ServingConfig. Ekspresi peringkat adalah satu fungsi atau beberapa fungsi yang digabungkan dengan "+". ranking_expression = function, { " + ", function }; Fungsi yang didukung: double * relevance_score double * dotProduct(embedding_field_path) Variabel fungsi: `relevance_score`: kata kunci yang telah ditentukan sebelumnya, digunakan untuk mengukur relevansi antara kueri dan dokumen. `embedding_field_path`: kolom embedding dokumen yang digunakan dengan vektor embedding kueri. `dotProduct`: fungsi embedding antara embedding_field_path dan vektor embedding kueri. Contoh ekspresi peringkat: Jika dokumen memiliki kolom penyematan doc_embedding, ekspresi peringkatnya bisa berupa `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.
`create_time`	`Timestamp` Hanya output. Stempel waktu pembuatan ServingConfig.
`update_time`	`Timestamp` Hanya output. Stempel waktu ServingConfig diperbarui.
`filter_control_ids[]`	`string` Kontrol filter yang akan digunakan di jalur penayangan. Semua kontrol filter yang dipicu akan diterapkan. Kontrol filter harus berada di penyimpanan data yang sama dengan konfigurasi penayangan. Maksimum 20 kontrol filter.
`boost_control_ids[]`	`string` Kontrol peningkat untuk digunakan di jalur penayangan. Semua kontrol peningkat yang dipicu akan diterapkan. Kontrol peningkat harus berada di penyimpanan data yang sama dengan konfigurasi penayangan. Maksimum 20 kontrol peningkat.
`redirect_control_ids[]`	`string` ID kontrol pengalihan. Hanya tindakan pengalihan yang dipicu pertama yang diterapkan, meskipun ada beberapa tindakan. Jumlah maksimum spesifikasi adalah 100. Hanya dapat disetel jika `SolutionType` adalah `SOLUTION_TYPE_SEARCH`.
`synonyms_control_ids[]`	`string` Spesifikasi sinonim kondisi. Jika beberapa kondisi sinonim cocok, semua kontrol sinonim yang cocok dalam daftar akan dieksekusi. Jumlah maksimum spesifikasi adalah 100. Hanya dapat disetel jika `SolutionType` adalah `SOLUTION_TYPE_SEARCH`.
`oneway_synonyms_control_ids[]`	`string` Kondisi spesifikasi sinonim satu arah. Jika beberapa kondisi sinonim satu arah cocok, semua kontrol sinonim satu arah yang cocok dalam daftar akan dieksekusi. Jumlah maksimum spesifikasi adalah 100. Hanya dapat disetel jika `SolutionType` adalah `SOLUTION_TYPE_SEARCH`.
`dissociate_control_ids[]`	`string` Kondisi tidak mengaitkan spesifikasi. Jika beberapa kondisi jangan kaitkan cocok, semua kontrol jangan kaitkan yang cocok dalam daftar akan dieksekusi. Urutan tidak menjadi masalah. Jumlah maksimum spesifikasi adalah 100. Hanya dapat disetel jika `SolutionType` adalah `SOLUTION_TYPE_SEARCH`.
`replacement_control_ids[]`	`string` Spesifikasi penggantian kondisi. Diterapkan sesuai urutan dalam daftar. Istilah yang sebelumnya diganti tidak dapat diganti lagi. Jumlah maksimum spesifikasi adalah 100. Hanya dapat disetel jika `SolutionType` adalah `SOLUTION_TYPE_SEARCH`.
`ignore_control_ids[]`	`string` Spesifikasi pengabaian kondisi. Jika beberapa kondisi pengabaian cocok, semua kontrol pengabaian yang cocok dalam daftar akan dieksekusi. Urutan tidak menjadi masalah. Jumlah maksimum spesifikasi adalah 100.
`promote_control_ids[]`	`string` Spesifikasi promosi kondisi. Jumlah maksimum spesifikasi adalah 100.
`answer_generation_spec`	`AnswerGenerationSpec` Opsional. Spesifikasi untuk pembuatan jawaban.
Kolom union `vertical_config`. Konfigurasi khusus vertical industri. `vertical_config` hanya ada berupa salah satu diantara berikut:
`media_config`	`MediaConfig` MediaConfig dari konfigurasi penayangan.
`generic_config`	`GenericConfig` GenericConfig dari konfigurasi inferensi.

GenericConfig

Menentukan konfigurasi yang diperlukan untuk Penemuan Generik.Saat ini kami mendukung:

content_search_spec: konfigurasi untuk penelusuran konten umum.

Kolom

content_search_spec

ContentSearchSpec

Menentukan perilaku yang diharapkan dari penelusuran konten. Hanya valid untuk penyimpanan data yang mendukung penelusuran konten.

MediaConfig

Menentukan konfigurasi yang diperlukan untuk Penemuan Media. Saat ini kami mendukung:

demote_content_watched: Nilai minimum untuk penurunan peringkat konten yang ditonton. Pelanggan dapat menentukan apakah akan menggunakan penurunan peringkat konten yang ditonton atau menggunakan halaman detail yang dilihat. Dengan menggunakan penurunan peringkat konten yang ditonton, pelanggan perlu menentukan menit atau persentase yang ditonton melebihi nilai minimum, konten akan diturunkan peringkatnya dalam hasil rekomendasi.
promote_fresh_content: hari batas untuk promosi konten baru. Pelanggan dapat menentukan apakah akan menggunakan promosi keaktualan konten. Jika konten dipublikasikan dalam batas hari, konten akan dipromosikan dalam hasil rekomendasi. Hanya dapat disetel jika SolutionType adalah SOLUTION_TYPE_RECOMMENDATION.

Kolom
`demotion_event_type`	`string` Menentukan jenis peristiwa yang digunakan untuk menurunkan hasil rekomendasi. Nilai yang saat ini didukung: `view-item`: Item dilihat. `media-play`: Mulai/lanjutkan menonton video, memutar lagu, dll. `media-complete`: Menyelesaikan atau berhenti di tengah-tengah video, lagu, dll. Jika tidak disetel, penurunan kualitas histori tontonan tidak akan diterapkan. Penurunan peringkat keaktualan konten akan tetap diterapkan.
`demote_content_watched_past_days`	`int32` Opsional. Menentukan jumlah hari untuk melihat kembali konten yang ditonton agar diturunkan. Jika disetel ke nol atau tidak disetel, defaultnya adalah maksimum 365 hari.
`content_freshness_cutoff_days`	`int32` Menentukan keaktualan konten yang digunakan untuk hasil rekomendasi. Konten akan didemosikan jika dipublikasikan selama lebih dari hari batas keaktualan konten.
Kolom union `demote_content_watched`. Tentukan batas untuk menurunkan konten yang ditonton, batas dapat berupa nilai persentase atau menit. Nilai ini harus ditetapkan untuk jenis peristiwa `media-complete`. `demote_content_watched` hanya dapat berupa salah satu dari hal berikut:
`content_watched_percentage_threshold`	`float` Menentukan batas persentase konten yang ditonton untuk penurunan peringkat. Nilai minimum harus antara [0, 1.0] inklusif.
`content_watched_seconds_threshold`	`float` Menentukan nilai minimum menit menonton konten untuk penurunan peringkat.

Sesi

Definisi proto sesi eksternal.

Kolom
`name`	`string` Tidak dapat diubah. Nama yang sepenuhnya memenuhi syarat `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`
`display_name`	`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`	`State` Status sesi.
`user_pseudo_id`	`string` ID unik untuk melacak pengguna.
`turns[]`	`Turn` Belokan.
`labels[]`	`string` Opsional. Label untuk sesi. Dapat ditetapkan sebagai filter di ListSessionsRequest.
`start_time`	`Timestamp` Hanya output. Waktu sesi dimulai.
`end_time`	`Timestamp` Hanya output. Waktu sesi selesai.
`is_pinned`	`bool` Opsional. Apakah sesi disematkan atau tidak, sesi yang disematkan akan ditampilkan di bagian atas daftar sesi.

Negara bagian/Provinsi

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.

Kolom
`query`	`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.
`assist_answer`	`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/{assist_answer}`. Untuk mendapatkan semua AssistAnswer untuk sesi, tetapkan GetSessionRequest.include_answer_details ke benar (true). Atau, untuk mendapatkan resource AssistAnswer individual, gunakan AssistAnswerService.GetAssistAnswer API.
`detailed_answer`	`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.
`detailed_assist_answer`	`AssistAnswer` Hanya output. Di `ConversationalSearchService.GetSession` API, jika `GetSessionRequest.include_answer_details` disetel ke benar (true), kolom ini akan diisi saat mendapatkan sesi asisten.
`query_config`	`map<string, 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.

SetUpDataConnectorMetadata

Jenis ini tidak memiliki kolom.

Metadata untuk metode DataConnectorService.SetUpDataConnector.

SetUpDataConnectorRequest

Permintaan untuk metode DataConnectorService.SetUpDataConnector.

Kolom
`parent`	`string` Wajib. Induk `Collection`, dalam format `projects/{project}/locations/{location}`.
`collection_id`	`string` Wajib. ID yang akan digunakan untuk `Collection`, yang akan menjadi komponen akhir dari nama resource `Collection`. `Collection` baru dibuat sebagai bagian dari penyiapan `DataConnector`. `DataConnector` adalah resource singleton di bawah `Collection`, yang mengelola semua `DataStore` dari `Collection`. Kolom ini harus sesuai dengan standar RFC-1034 dengan batas panjang 63 karakter. Jika tidak, error INVALID_ARGUMENT akan ditampilkan.
`collection_display_name`	`string` Wajib. Nama tampilan `Collection`. Harus dapat dibaca manusia, digunakan untuk menampilkan koleksi di Dasbor Konsol. String berenkode UTF-8 dengan batas 1024 karakter.
`data_connector`	`DataConnector` Wajib. `DataConnector` yang akan diinisialisasi di `Collection` yang baru dibuat.

SingleRegionKey

Metadata untuk CMEK satu region.

Kolom

kms_key

string

Wajib. Nama resource kunci kms regional tunggal yang akan digunakan untuk mengenkripsi resource projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}.

SiteSearchEngine

SiteSearchEngine merekam konfigurasi persisten penelusuran situs tingkat DataStore. Nilai ini adalah nilai singleton per penyimpanan data.

Kolom

name

string

Nama resource yang memenuhi syarat sepenuhnya dari mesin telusur situs. Format: projects/*/locations/*/dataStores/*/siteSearchEngine

SiteVerificationInfo

Informasi verifikasi untuk situs target dalam penelusuran situs lanjutan.

Kolom

site_verification_state

SiteVerificationState

Status verifikasi situs yang menunjukkan kepemilikan dan validitas.

verify_time

Waktu verifikasi situs terbaru.

SiteVerificationState

Status verifikasi situs.

Enum
`SITE_VERIFICATION_STATE_UNSPECIFIED`	Nilai defaultnya adalah VERIFIED.
`VERIFIED`	Kepemilikan situs telah diverifikasi.
`UNVERIFIED`	Kepemilikan situs menunggu verifikasi atau verifikasi gagal.
`EXEMPTED`	Situs yang dikecualikan dari verifikasi, misalnya, situs publik yang terbuka untuk semua orang.

Peta situs

Peta situs untuk SiteSearchEngine.

Kolom
`name`	`string` Hanya output. Nama resource yang sepenuhnya memenuhi syarat dari peta situs. `projects//locations//collections//dataStores//siteSearchEngine/sitemaps/*` Suffix `sitemap_id` dibuat oleh sistem.
`create_time`	`Timestamp` Hanya output. Waktu pembuatan peta situs.
Kolom union `feed`. Sumber feed yang didukung. `feed` hanya ada berupa salah satu diantara berikut:
`uri`	`string` URI publik untuk peta situs, misalnya `www.example.com/sitemap.xml`.

SolutionType

Jenis solusi.

Enum
`SOLUTION_TYPE_UNSPECIFIED`	Nilai default.
`SOLUTION_TYPE_RECOMMENDATION`	Digunakan untuk Recommendations AI.
`SOLUTION_TYPE_SEARCH`	Digunakan untuk Penelusuran Penemuan.
`SOLUTION_TYPE_CHAT`	Digunakan untuk kasus penggunaan yang terkait dengan agen AI Generatif.
`SOLUTION_TYPE_GENERATIVE_CHAT`	Digunakan untuk kasus penggunaan terkait agen Generative Chat. Fitur ini hanya digunakan untuk Generative chat engine, penyimpanan data terkait harus didaftarkan dengan solusi `SOLUTION_TYPE_CHAT`.

SpannerSource

Sumber Spanner untuk mengimpor data

Kolom
`project_id`	`string` Project ID yang berisi sumber Spanner. Memiliki batas panjang 128 karakter. Jika tidak ditentukan, akan mewarisi project ID dari permintaan induk.
`instance_id`	`string` Wajib. ID instance tabel Spanner sumber.
`database_id`	`string` Wajib. ID database tabel Spanner sumber.
`table_id`	`string` Wajib. Nama tabel database Spanner yang perlu diimpor.
`enable_data_boost`	`bool` Apakah akan menerapkan peningkatan data pada ekspor Spanner. Mengaktifkan opsi ini akan menimbulkan biaya tambahan. Info selengkapnya dapat ditemukan di sini.

StreamAssistRequest

Permintaan untuk metode AssistantService.StreamAssist.

Kolom
`name`	`string` Wajib. Nama resource `Assistant`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}`
`query`	`Query` Opsional. Kueri pengguna saat ini. Kueri kosong hanya didukung jika `file_ids` diberikan. Dalam hal ini, jawaban akan dibuat berdasarkan file konteks tersebut.
`session`	`string` Opsional. Sesi yang akan digunakan untuk permintaan. Jika ditentukan, asisten memiliki akses ke histori sesi, dan kueri serta jawabannya disimpan di sana. Jika `-` ditentukan sebagai ID sesi, atau dibiarkan kosong, sesi baru akan dibuat dengan ID yang dihasilkan secara otomatis. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`
`user_metadata`	`AssistUserMetadata` Opsional. Informasi tentang pengguna yang memulai kueri.
`agents_spec`	`AgentsSpec` Opsional. Spesifikasi agen yang digunakan untuk menayangkan permintaan.
`tools_spec`	`ToolsSpec` Opsional. Spesifikasi alat yang digunakan untuk menayangkan permintaan.
`generation_spec`	`GenerationSpec` Opsional. Spesifikasi konfigurasi pembuatan untuk permintaan.

AgentsSpec

Spesifikasi agen yang digunakan untuk menayangkan permintaan.

Kolom

agent_specs[]

AgentSpec

Opsional. Spesifikasi agen yang digunakan untuk menayangkan permintaan.

AgentSpec

Spesifikasi agen.

Kolom

agent_id

string

Wajib. ID untuk mengidentifikasi resource agen yang melayani permintaan.

Kolom ini harus sesuai dengan RFC-1034 dengan batas panjang 63 karakter.

GenerationSpec

Spesifikasi pembuatan Asisten untuk permintaan. Hal ini memungkinkan penggantian konfigurasi pembuatan default di tingkat mesin.

Kolom

model_id

string

Opsional. model_id Vertex AI yang digunakan untuk model generatif. Jika tidak disetel, model Asisten default akan digunakan.

ToolsSpec

Spesifikasi alat yang digunakan untuk menayangkan permintaan.

Kolom
`vertex_ai_search_spec`	`VertexAiSearchSpec` Opsional. Spesifikasi alat Vertex AI Search.
`web_grounding_spec`	`WebGroundingSpec` Opsional. Spesifikasi alat perujukan web. Jika kolom ada, mengaktifkan perujukan dengan penelusuran web. Hanya berfungsi jika `Assistant.web_grounding_type` adalah [WEB_GROUNDING_TYPE_GOOGLE_SEARCH][] atau [WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH][].
`image_generation_spec`	`ImageGenerationSpec` Opsional. Spesifikasi alat pembuatan gambar.
`video_generation_spec`	`VideoGenerationSpec` Opsional. Spesifikasi alat pembuatan video.

ImageGenerationSpec

Jenis ini tidak memiliki kolom.

Spesifikasi alat pembuatan gambar.

VertexAiSearchSpec

Spesifikasi alat Vertex AI Search.

Kolom

data_store_specs[]

DataStoreSpec

Opsional. Spesifikasi yang menentukan DataStore untuk memfilter panggilan penelusuran dan konfigurasi untuk penyimpanan data tersebut. Hal ini hanya dipertimbangkan untuk Engine dengan beberapa penyimpanan data.

filter

string

Opsional. Sintaksis filter terdiri dari bahasa ekspresi untuk membuat predikat dari satu atau beberapa kolom dokumen yang difilter. Ekspresi filter peka huruf besar/kecil.

Jika kolom ini tidak dapat dikenali, INVALID_ARGUMENT akan ditampilkan.

Pemfilteran di Vertex AI Search dilakukan dengan memetakan kunci filter LHS ke properti kunci yang ditentukan di backend Vertex AI Search -- pemetaan ini ditentukan oleh pelanggan dalam skemanya. Misalnya, pelanggan media mungkin memiliki kolom 'name' dalam skemanya. Dalam hal ini, filter akan terlihat seperti ini: filter --> name:'ANY("king kong")'

Untuk mengetahui informasi selengkapnya tentang pemfilteran, termasuk sintaksis dan operator filter, lihat Filter

VideoGenerationSpec

Jenis ini tidak memiliki kolom.

Spesifikasi alat pembuatan video.

WebGroundingSpec

Jenis ini tidak memiliki kolom.

Spesifikasi alat perujukan web.

StreamAssistResponse

Respons untuk metode AssistantService.StreamAssist.

Kolom

answer

AssistAnswer

Objek resource jawaban bantuan yang berisi bagian dari jawaban akhir asisten untuk kueri pengguna.

Tidak ada jika respons saat ini tidak menambahkan apa pun ke AssistAnswer.replies yang dikirim sebelumnya.

Amati AssistAnswer.state untuk melihat apakah ada bagian lain yang akan datang. Saat statusnya IN_PROGRESS, kolom AssistAnswer.replies di setiap respons akan berisi balasan (fragmen balasan) yang akan ditambahkan ke balasan yang diterima dalam respons sebelumnya. AssistAnswer.name tidak akan diisi.

Jika statusnya adalah SUCCEEDED, FAILED, atau SKIPPED, responsnya adalah respons terakhir dan AssistAnswer.name akan memiliki nilai.

session_info

SessionInfo

Informasi sesi. Hanya disertakan dalam StreamAssistResponse akhir dari aliran respons.

assist_token

string

ID unik global yang mengidentifikasi pasangan permintaan dan aliran respons saat ini. Digunakan untuk masukan dan dukungan.

SessionInfo

Informasi tentang sesi.

Kolom

session

string

Nama sesi yang baru dibuat atau dilanjutkan.

Format projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}.

SubscriptionTerm

Persyaratan langganan. LINT.IfChange

Enum
`SUBSCRIPTION_TERM_UNSPECIFIED`	Nilai default, jangan gunakan.
`SUBSCRIPTION_TERM_ONE_MONTH`	1 bulan.
`SUBSCRIPTION_TERM_ONE_YEAR`	1 tahun.
`SUBSCRIPTION_TERM_THREE_YEARS`	3 tahun.

SubscriptionTier

Informasi tingkat langganan.

Enum
`SUBSCRIPTION_TIER_UNSPECIFIED`	Nilai default.
`SUBSCRIPTION_TIER_SEARCH`	Tingkat penelusuran. Tingkat penelusuran dapat mengakses fitur penelusuran VAIS dan fitur NotebookLM.
`SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT`	Paket penelusuran + asisten. Tingkat penelusuran + asisten dapat mengakses fitur penelusuran VAIS, fitur NotebookLM, dan fitur asisten.
`SUBSCRIPTION_TIER_NOTEBOOK_LM`	Tingkatan NotebookLM. Tingkatan langganan NotebookLM hanya dapat mengakses fitur NotebookLM.
`SUBSCRIPTION_TIER_FRONTLINE_WORKER`	Tingkatan pekerja garis depan.
`SUBSCRIPTION_TIER_AGENTSPACE_STARTER`	Tingkat Agentspace Starter.
`SUBSCRIPTION_TIER_AGENTSPACE_BUSINESS`	Paket Agentspace Business.
`SUBSCRIPTION_TIER_ENTERPRISE`	Paket Enterprise.
`SUBSCRIPTION_TIER_EDU`	Tingkat EDU.
`SUBSCRIPTION_TIER_EDU_PRO`	Paket EDU Pro.
`SUBSCRIPTION_TIER_EDU_EMERGING`	Tingkat pasar negara berkembang EDU.
`SUBSCRIPTION_TIER_EDU_PRO_EMERGING`	Paket EDU Pro untuk pasar negara berkembang.

SuggestionDenyListEntry

Entri daftar penolakan saran yang mengidentifikasi frasa yang akan diblokir dari saran dan operasi yang diterapkan untuk frasa tersebut.

Kolom

block_phrase

string

Wajib. Frasa yang akan diblokir dari saran yang ditayangkan. Dapat berisi maksimum 125 karakter.

match_operator

MatchOperator

Wajib. Operator kecocokan yang akan diterapkan untuk frasa ini. Apakah akan memblokir frasa persis, atau memblokir saran apa pun yang berisi frasa ini.

MatchOperator

Operator untuk mencocokkan dengan saran yang dihasilkan.

Enum
`MATCH_OPERATOR_UNSPECIFIED`	Nilai default. Tidak boleh digunakan
`EXACT_MATCH`	Jika saran sama persis dengan block_phrase, maka blokir.
`CONTAINS`	Jika saran berisi block_phrase, blokir saran tersebut.

TargetSite

Situs target untuk SiteSearchEngine.

Kolom
`name`	`string` Hanya output. Nama resource yang sepenuhnya memenuhi syarat dari situs target. `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}` `target_site_id` dibuat oleh sistem.
`provided_uri_pattern`	`string` Wajib. Hanya input. Pola URI yang disediakan pengguna dari mana `generated_uri_pattern` dibuat.
`type`	`Type` Jenis situs target, misalnya, apakah situs akan disertakan atau dikecualikan.
`exact_match`	`bool` Tidak dapat diubah. Jika disetel ke false, uri_pattern akan dibuat untuk menyertakan semua halaman yang alamatnya berisi provided_uri_pattern. Jika disetel ke benar (true), uri_pattern akan dibuat agar cocok persis dengan provided_uri_pattern atau hanya halaman tertentu jika provided_uri_pattern adalah halaman tertentu. provided_uri_pattern selalu dinormalisasi untuk membuat pola URI yang akan digunakan oleh mesin telusur.
`generated_uri_pattern`	`string` Hanya output. Ini dihasilkan sistem berdasarkan provided_uri_pattern.
`root_domain_uri`	`string` Hanya output. Domain root dari provided_uri_pattern.
`site_verification_info`	`SiteVerificationInfo` Hanya output. Status verifikasi kepemilikan dan validitas situs.
`indexing_status`	`IndexingStatus` Hanya output. Status pengindeksan.
`update_time`	`Timestamp` Hanya output. Waktu terakhir situs target diperbarui.
`failure_reason`	`FailureReason` Hanya output. Alasan kegagalan.

FailureReason

Alasan kegagalan pengindeksan penelusuran situs.

Kolom

Kolom union failure. Alasan kegagalan. failure hanya ada berupa salah satu diantara berikut:

quota_failure

QuotaFailure

Gagal karena kuota tidak mencukupi.

QuotaFailure

Gagal karena kuota tidak mencukupi.

Kolom

total_required_quota

int64

Jumlah ini adalah perkiraan jumlah total kuota yang dibutuhkan project ini untuk menyelesaikan pengindeksan dengan berhasil.

IndexingStatus

Enumerasi status pengindeksan situs target.

Enum
`INDEXING_STATUS_UNSPECIFIED`	Nilai defaultnya adalah SUCCEEDED.
`PENDING`	Situs target berada dalam antrean pembaruan dan akan diambil oleh pipeline pengindeksan.
`FAILED`	Situs target gagal diindeks.
`SUCCEEDED`	Situs target telah diindeks.
`DELETING`	Situs target yang sebelumnya diindeks telah ditandai untuk dihapus. Ini adalah status transisi yang akan menghasilkan: 1. situs target dihapus jika penghapusan pengindeksan berhasil; 2. status kembali ke BERHASIL jika penghapusan pengindeksan gagal.
`CANCELLABLE`	Perubahan situs target tertunda, tetapi dapat dibatalkan.
`CANCELLED`	Perubahan situs target dibatalkan.

Jenis

Kemungkinan jenis situs target.

Enum
`TYPE_UNSPECIFIED`	Nilai ini tidak digunakan. Dalam hal ini, perilaku server ditetapkan secara default ke `Type.INCLUDE`.
`INCLUDE`	Sertakan situs target.
`EXCLUDE`	Mengecualikan situs target.

Tenant

Informasi tenant untuk sumber konektor. Hal ini mencakup beberapa informasi yang sama yang disimpan dalam pesan Kredensial, tetapi terbatas hanya pada informasi yang diperlukan untuk memberikan daftar tenant yang dapat diakses kepada pengguna.

Kolom

id

string

ID instance tenant. Contoh: Jira ("8594f221-9797-5f78-1fa4-485e198d7cd0"), Slack ("T123456").

uri

string

URI tenant, jika ada. Misalnya, URI instance Jira adalah https://my-jira-instance.atlassian.net, dan tenant Slack tidak memiliki URI.

display_name

string

Nama tampilan opsional untuk tenant, misalnya "Tim Slack Saya".

TextInput

Menentukan input teks.

Kolom

input

string

Input teks.

context

ConversationContext

Konteks percakapan input.

TrainCustomModelMetadata

Metadata yang terkait dengan progres operasi TrainCustomModel. Hal ini ditampilkan oleh kolom google.longrunning.Operation.metadata.

Kolom

create_time

Waktu pembuatan operasi.

update_time

Waktu update terakhir operasi. Jika operasi selesai, ini juga merupakan waktu selesainya.

TrainCustomModelRequest

Pesan permintaan untuk metode SearchTuningService.TrainCustomModel.

Kolom
`data_store`	`string` Wajib. Nama resource Penyimpanan Data, seperti `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`. Kolom ini digunakan untuk mengidentifikasi penyimpanan data tempat melatih model.
`model_type`	`string` Model yang akan dilatih. Nilai yang didukung adalah: search-tuning: Menyesuaikan sistem penelusuran berdasarkan data yang diberikan.
`error_config`	`ImportErrorConfig` Lokasi yang diinginkan untuk error yang terjadi selama penyerapan dan pelatihan data.
`model_id`	`string` Jika tidak diberikan, UUID akan dibuat.
Kolom union `training_input`. Input pelatihan model. `training_input` hanya ada berupa salah satu diantara berikut:
`gcs_training_input`	`GcsTrainingInput` Input pelatihan Cloud Storage.

GcsTrainingInput

Input data pelatihan Cloud Storage.

Kolom
`corpus_data_path`	`string` Data korpus Cloud Storage yang dapat dikaitkan dalam data pelatihan. Format jalur data adalah `gs://<bucket_to_data>/<jsonl_file_name>`. File jsonl/ndjson yang dibatasi baris baru. Untuk model penyesuaian penelusuran, setiap baris harus memiliki _id, judul, dan teks. Contoh: `{"_id": "doc1", title: "relevant doc", "text": "relevant text"}`
`query_data_path`	`string` Data kueri gcs yang dapat dikaitkan dalam data pelatihan. Format jalur data adalah `gs://<bucket_to_data>/<jsonl_file_name>`. File jsonl/ndjson yang dibatasi baris baru. Untuk model penyesuaian penelusuran, setiap baris harus memiliki _id dan teks. Contoh: {"_id": "query1", "text": "example query"}
`train_data_path`	`string` Jalur data pelatihan Cloud Storage yang formatnya harus `gs://<bucket_to_data>/<tsv_file_name>`. File harus dalam format tsv. Setiap baris harus memiliki doc_id, query_id, dan skor (angka). Untuk model penyesuaian penelusuran, model harus memiliki skor query-id corpus-id sebagai header file tsv. Skor harus berupa angka dalam `[0, inf+)`. Makin besar angkanya, makin relevan pasangan tersebut. Contoh: `query-id\tcorpus-id\tscore` `query1\tdoc1\t1`
`test_data_path`	`string` Data pengujian Cloud Storage. Format yang sama dengan train_data_path. Jika tidak diberikan, pemisahan pelatihan/pengujian 80/20 acak akan dilakukan di train_data_path.

TrainCustomModelResponse

Respons dari TrainCustomModelRequest. Pesan ini ditampilkan oleh kolom google.longrunning.Operations.response.

Kolom
`error_samples[]`	`Status` Contoh error yang terjadi saat memproses data.
`error_config`	`ImportErrorConfig` Menggema tujuan untuk error lengkap dalam permintaan jika ditetapkan.
`model_status`	`string` Status model terlatih. Nilainya dapat berupa: bad-data: Kualitas data pelatihan buruk. no-improvement: Penyesuaian tidak meningkatkan performa. Tidak akan di-deploy. sedang berlangsung: Pembuatan tugas pelatihan model sedang berlangsung. training: Model sedang dilatih secara aktif. mengevaluasi: Model sedang mengevaluasi metrik yang dilatih. pengindeksan: Metrik model yang dilatih sedang diindeks. siap: Model siap untuk ditayangkan.
`metrics`	`map<string, double>` Metrik model terlatih.
`model_name`	`string` Nama lengkap CustomTuningModel.

TransactionInfo

Transaksi mewakili seluruh transaksi pembelian.

Kolom
`currency`	`string` Wajib. Kode mata uang. Gunakan kode ISO-4217 tiga karakter.
`transaction_id`	`string` ID transaksi dengan batas panjang 128 karakter.
`value`	`float` Wajib. Total nilai bukan nol yang terkait dengan transaksi. Nilai ini dapat mencakup pengiriman, pajak, atau penyesuaian lainnya pada total nilai yang ingin Anda sertakan.
`tax`	`float` Semua pajak yang terkait dengan transaksi.
`cost`	`float` Semua biaya yang terkait dengan produk. Biaya ini dapat berupa biaya produksi, biaya pengiriman yang tidak ditanggung oleh pengguna akhir, atau biaya lainnya, sehingga: Laba = `value` - `tax` - `cost`
`discount_value`	`float` Total nilai diskon yang diterapkan pada transaksi ini. Angka ini harus dikecualikan dari `TransactionInfo.value` Misalnya, jika pengguna membayar sebesar `TransactionInfo.value`, maka nilai nominal (sebelum diskon) transaksi adalah jumlah `TransactionInfo.value` dan `TransactionInfo.discount_value` Artinya, laba dihitung dengan cara yang sama, terlepas dari nilai diskon, dan `TransactionInfo.discount_value` dapat lebih besar dari `TransactionInfo.value`: Laba = `value` - `tax` - `cost`

UpdateAclConfigRequest

Pesan permintaan untuk metode UpdateAclConfig.

Kolom
`acl_config`	`AclConfig`

UpdateAssistantRequest

Pesan permintaan untuk metode AssistantService.UpdateAssistant.

Kolom

assistant

Assistant

Wajib. Assistant yang akan diupdate.

Kolom name Assistant digunakan untuk mengidentifikasi Assistant yang akan diperbarui. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}

Jika pemanggil tidak memiliki izin untuk memperbarui Assistant, terlepas dari apakah Assistant ada atau tidak, error PERMISSION_DENIED akan ditampilkan.

Jika Assistant yang akan diupdate tidak ada, error NOT_FOUND akan ditampilkan.

update_mask

Daftar kolom yang akan diperbarui.

UpdateCmekConfigMetadata

Metadata yang terkait dengan progres operasi CmekConfigService.UpdateCmekConfig. Hal ini akan ditampilkan oleh kolom google.longrunning.Operation.metadata.

Kolom

create_time

Waktu pembuatan operasi.

update_time

Waktu update terakhir operasi. Jika operasi selesai, ini juga merupakan waktu selesainya.

UpdateCmekConfigRequest

Pesan permintaan untuk metode UpdateCmekConfig. rpc.

Kolom

config

CmekConfig

Wajib. Resource CmekConfig.

set_default

bool

Tetapkan CmekConfig berikut sebagai default yang akan digunakan untuk resource turunan jika tidak ada yang ditentukan.

UpdateControlRequest

Permintaan untuk metode UpdateControl.

Kolom

control

Control

Wajib. Kontrol yang akan diperbarui.

update_mask

Opsional. Menunjukkan kolom mana dalam Control yang diberikan yang akan diperbarui. Berikut TIDAK didukung:

Control.name
Control.solution_type

Jika tidak disetel atau kosong, semua kolom yang didukung akan diperbarui.

UpdateConversationRequest

Permintaan untuk metode UpdateConversation.

Kolom

conversation

Wajib. Percakapan yang akan diperbarui.

update_mask

Menunjukkan kolom mana dalam Conversation yang diberikan yang akan diperbarui. Berikut TIDAK didukung:

Conversation.name

Jika tidak disetel atau kosong, semua kolom yang didukung akan diperbarui.

UpdateDataConnectorRequest

Pesan permintaan untuk metode DataConnectorService.UpdateDataConnector.

Kolom

data_connector

DataConnector

Wajib. DataConnector yang akan diupdate.

Jika pemanggil tidak memiliki izin untuk memperbarui DataConnector, terlepas dari apakah DataConnector ada atau tidak, error PERMISSION_DENIED akan ditampilkan.

Jika DataConnector tidak ada, error NOT_FOUND akan ditampilkan.

update_mask

Menunjukkan kolom mana dalam DataConnector yang diberikan yang akan diperbarui.

Jalur kolom yang didukung meliputi:

refresh_interval
params
auto_run_disabled
action_config
action_config.action_params
action_config.service_name
destination_configs
blocking_reasons
sync_mode
incremental_sync_disabled
incremental_refresh_interval

Catatan: Dukungan untuk kolom ini dapat bervariasi bergantung pada jenis konektor. Misalnya, tidak semua konektor mendukung destination_configs.

Jika jalur kolom yang tidak didukung atau tidak diketahui diberikan, permintaan akan menampilkan error INVALID_ARGUMENT.

UpdateDataStoreRequest

Pesan permintaan untuk metode DataStoreService.UpdateDataStore.

Kolom

data_store

DataStore

Wajib. DataStore yang akan diupdate.

Jika pemanggil tidak memiliki izin untuk memperbarui DataStore, terlepas dari apakah DataStore ada atau tidak, error PERMISSION_DENIED akan ditampilkan.

Jika DataStore yang akan diupdate tidak ada, error NOT_FOUND akan ditampilkan.

update_mask

Menunjukkan kolom mana dalam DataStore yang diberikan yang akan diperbarui.

Jika kolom yang tidak didukung atau tidak diketahui diberikan, error INVALID_ARGUMENT akan ditampilkan.

UpdateDocumentRequest

Pesan permintaan untuk metode DocumentService.UpdateDocument.

Kolom

document

Wajib. Dokumen yang akan diperbarui/dibuat.

Jika pemanggil tidak memiliki izin untuk memperbarui Document, terlepas dari apakah Document ada atau tidak, error PERMISSION_DENIED akan ditampilkan.

Jika Document yang akan diupdate tidak ada dan allow_missing tidak disetel, error NOT_FOUND akan ditampilkan.

allow_missing

bool

Jika disetel ke true dan Document tidak ditemukan, Document baru akan dibuat.

update_mask

Menunjukkan kolom mana dalam 'dokumen' yang diimpor yang akan diperbarui. Jika tidak disetel, secara default akan memperbarui semua kolom.

UpdateEngineRequest

Pesan permintaan untuk metode EngineService.UpdateEngine.

Kolom

engine

Engine

Wajib. Engine yang akan diupdate.

Jika pemanggil tidak memiliki izin untuk memperbarui Engine, terlepas dari apakah Engine ada atau tidak, error PERMISSION_DENIED akan ditampilkan.

Jika Engine yang akan diupdate tidak ada, error NOT_FOUND akan ditampilkan.

update_mask

Menunjukkan kolom mana dalam Engine yang diberikan yang akan diperbarui.

Jika kolom yang tidak didukung atau tidak diketahui diberikan, error INVALID_ARGUMENT akan ditampilkan.

UpdateLicenseConfigRequest

Pesan permintaan untuk metode LicenseConfigService.UpdateLicenseConfig.

Kolom

license_config

LicenseConfig

Wajib. LicenseConfig yang akan diupdate.

update_mask

Opsional. Menunjukkan kolom mana dalam LicenseConfig yang diberikan yang akan diperbarui.

Jika kolom yang tidak didukung atau tidak diketahui diberikan, error INVALID_ARGUMENT akan ditampilkan.

UpdateSchemaMetadata

Metadata untuk LRO UpdateSchema.

Kolom

create_time

Waktu pembuatan operasi.

update_time

Waktu update terakhir operasi. Jika operasi selesai, ini juga merupakan waktu selesainya.

UpdateSchemaRequest

Pesan permintaan untuk metode SchemaService.UpdateSchema.

Kolom

schema

Schema

Wajib. Schema yang akan diupdate.

allow_missing

bool

Jika disetel ke benar, dan Schema tidak ditemukan, Schema baru akan dibuat. Dalam situasi ini, update_mask diabaikan.

UpdateServingConfigRequest

Permintaan untuk metode UpdateServingConfig.

Kolom

serving_config

ServingConfig

Wajib. ServingConfig yang akan diperbarui.

update_mask

Menunjukkan kolom mana dalam ServingConfig yang diberikan yang akan diperbarui. Berikut TIDAK didukung:

ServingConfig.name

Jika tidak ditetapkan, semua kolom yang didukung akan diperbarui.

UpdateSessionRequest

Permintaan untuk metode UpdateSession.

Kolom

session

Wajib. Sesi yang akan diperbarui.

update_mask

Menunjukkan kolom mana dalam Session yang diberikan yang akan diperbarui. Berikut TIDAK didukung:

Session.name

Jika tidak disetel atau kosong, semua kolom yang didukung akan diperbarui.

UpdateTargetSiteMetadata

Metadata yang terkait dengan progres operasi SiteSearchEngineService.UpdateTargetSite. Hal ini akan ditampilkan oleh kolom google.longrunning.Operation.metadata.

Kolom

create_time

Waktu pembuatan operasi.

update_time

Waktu update terakhir operasi. Jika operasi selesai, ini juga merupakan waktu selesainya.

UpdateTargetSiteRequest

Pesan permintaan untuk metode SiteSearchEngineService.UpdateTargetSite.

Kolom

target_site