REST Resource: projects.locations.evaluations

Resource: Evaluasi

Evaluasi adalah satu kali eksekusi (atau jalankan) dari suatu proses evaluasi. Objek ini merangkum status evaluasi dan data yang dihasilkan.

Representasi JSON 
{
  "name": string,
  "evaluationSpec": {
    object (EvaluationSpec)
  },
  "qualityMetrics": {
    object (QualityMetrics)
  },
  "state": enum (State),
  "error": {
    object (Status)
  },
  "createTime": string,
  "endTime": string,
  "errorSamples": [
    {
      object (Status)
    }
  ]
}
Kolom
name

string

ID. Nama lengkap resource Evaluation, dalam format projects/{project}/locations/{location}/evaluations/{evaluation}.

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

object (EvaluationSpec)

Wajib. Spesifikasi evaluasi.
qualityMetrics

object (QualityMetrics)

Hanya output. Metrik yang dihasilkan oleh evaluasi, dirata-ratakan di semua SampleQuery dalam SampleQuerySet.

Hanya terisi ketika status evaluasi BERHASIL.
state

enum (State)

Hanya output. Status evaluasi.
error

object (Status)

Hanya output. Error yang terjadi selama evaluasi. Hanya diisi jika status evaluasi adalah GAGAL.
createTime

string (Timestamp format)

Hanya output. Stempel waktu saat Evaluation dibuat.

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

string (Timestamp format)

Hanya output. Catat waktu penyelesaian Evaluation tersebut.

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

object (Status)

Hanya output. Contoh error yang terjadi saat memproses permintaan.

EvaluationSpec

Menjelaskan spesifikasi evaluasi.

Representasi JSON 
{
  "querySetSpec": {
    object (QuerySetSpec)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "searchRequest": {
    object (SearchRequest)
  }
  // End of mutually exclusive fields.
}
Kolom
querySetSpec

object (QuerySetSpec)

Opsional. Spesifikasi set kueri.
Spesifikasi penelusuran. Berikut adalah daftar kolom yang bersifat eksklusif satu sama lain. Maksimal satu kolom akan ditetapkan dalam respons:
searchRequest

object (SearchRequest)

Wajib. Permintaan penelusuran yang digunakan untuk melakukan evaluasi.

Hanya kolom berikut dalam SearchRequest yang didukung; jika kolom lain diberikan, error UNSUPPORTED akan ditampilkan:
Akhir kolom yang saling eksklusif.

SearchRequest

Pesan permintaan untuk metode SearchService.Search.

Representasi JSON 
{
  "servingConfig": string,
  "branch": string,
  "query": string,
  "pageCategories": [
    string
  ],
  "imageQuery": {
    object (ImageQuery)
  },
  "pageSize": integer,
  "pageToken": string,
  "offset": integer,
  "oneBoxPageSize": integer,
  "dataStoreSpecs": [
    {
      object (DataStoreSpec)
    }
  ],
  "numResultsPerDataStore": integer,
  "filter": string,
  "canonicalFilter": string,
  "orderBy": string,
  "userInfo": {
    object (UserInfo)
  },
  "languageCode": string,
  "regionCode": string,
  "facetSpecs": [
    {
      object (FacetSpec)
    }
  ],
  "boostSpec": {
    object (BoostSpec)
  },
  "params": {
    string: value,
    ...
  },
  "queryExpansionSpec": {
    object (QueryExpansionSpec)
  },
  "spellCorrectionSpec": {
    object (SpellCorrectionSpec)
  },
  "userPseudoId": string,
  "useLatestData": boolean,
  "contentSearchSpec": {
    object (ContentSearchSpec)
  },
  "embeddingSpec": {
    object (EmbeddingSpec)
  },
  "rankingExpression": string,
  "rankingExpressionBackend": enum (RankingExpressionBackend),
  "safeSearch": boolean,
  "userLabels": {
    string: string,
    ...
  },
  "naturalLanguageQueryUnderstandingSpec": {
    object (NaturalLanguageQueryUnderstandingSpec)
  },
  "searchAsYouTypeSpec": {
    object (SearchAsYouTypeSpec)
  },
  "customFineTuningSpec": {
    object (CustomFineTuningSpec)
  },
  "displaySpec": {
    object (DisplaySpec)
  },
  "crowdingSpecs": [
    {
      object (CrowdingSpec)
    }
  ],
  "session": string,
  "sessionSpec": {
    object (SessionSpec)
  },
  "relevanceThreshold": enum (RelevanceThreshold),
  "relevanceFilterSpec": {
    object (RelevanceFilterSpec)
  },
  "personalizationSpec": {
    object (PersonalizationSpec)
  },
  "relevanceScoreSpec": {
    object (RelevanceScoreSpec)
  },
  "searchAddonSpec": {
    object (SearchAddonSpec)
  },
  "customRankingParams": {
    object (CustomRankingParams)
  },
  "entity": string
}
Kolom
servingConfig

string

Wajib. Nama sumber daya konfigurasi penyajian Pencarian, 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.
pageCategories[]

string

Opsional. Kategori yang terkait dengan halaman kategori. Harus ditetapkan untuk kueri navigasi kategori guna mencapai kualitas penelusuran yang baik. Formatnya harus sama dengan PageInfo.page_category. Kolom ini setara dengan kueri untuk kueri penjelajahan (navigasi). Digunakan oleh model penjelajahan saat kueri kosong.

Jika kolom kosong, kolom tidak akan digunakan oleh model penjelajahan. Jika kolom berisi lebih dari satu elemen, hanya elemen pertama yang akan digunakan.

Untuk merepresentasikan jalur lengkap kategori, gunakan karakter '>' untuk memisahkan hierarki yang berbeda. Jika '>' adalah bagian dari nama kategori, ganti dengan karakter lain. Misalnya, Graphics Cards > RTX>4090 > Founders Edition dengan "RTX > 4090" yang mewakili satu level, dapat ditulis ulang sebagai Graphics Cards > RTX_4090 > Founders Edition
imageQuery

object (ImageQuery)

Kueri gambar mentah.
pageSize

integer

Jumlah maksimum Document yang akan ditampilkan. Nilai maksimum yang diizinkan bergantung pada jenis data. Nilai di atas nilai maksimum akan diubah 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 bernilai negatif, INVALID_ARGUMENT akan ditampilkan.
pageToken

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

integer

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 pageToken tidak ditetapkan.

Jika kolom ini bernilai negatif, INVALID_ARGUMENT akan ditampilkan.

Offset besar dapat dibatasi ke nilai minimum yang wajar.
oneBoxPageSize

integer

Jumlah maksimum hasil yang akan ditampilkan untuk OmniBoks. Hal ini berlaku untuk setiap jenis OmniBoks secara terpisah. Jumlah defaultnya adalah 10.
dataStoreSpecs[]

object (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.
numResultsPerDataStore

integer

Opsional. Jumlah maksimum hasil yang akan diambil dari setiap penyimpanan data. Jika tidak ditentukan, SearchRequest.DataStoreSpec.num_results akan digunakan jika ada, atau tidak ada batas.
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
canonicalFilter

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

string

Urutan dokumen yang ditampilkan. Dokumen dapat diurutkan berdasarkan kolom dalam objek Document. Biarkan tidak disetel jika diurutkan berdasarkan relevansi. Ekspresi orderBy bersifat peka huruf besar/kecil.

Untuk mengetahui informasi selengkapnya tentang 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.
userInfo

object (UserInfo)

Informasi tentang pengguna akhir. Sangat direkomendasikan untuk analisis dan personalisasi. UserInfo.user_agent digunakan untuk menyimpulkan deviceType untuk analisis.
languageCode

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 tidak ada nilai yang ditentukan, kode bahasa kueri akan dideteksi secara otomatis, yang mungkin tidak akurat.
regionCode

string

Kode negara/wilayah Unicode (CLDR) suatu lokasi, seperti "US" dan "419". Untuk mengetahui informasi selengkapnya, lihat Kolom standar. Jika disetel, hasil akan dikuatkan berdasarkan regionCode yang diberikan.
facetSpecs[]

object (FacetSpec)

Spesifikasi faset untuk penelusuran dengan faset. Jika kosong, tidak ada faset yang ditampilkan.

Maksimal 100 nilai diizinkan. Jika tidak, error INVALID_ARGUMENT akan ditampilkan.
boostSpec

object (BoostSpec)

Spesifikasi penguatan untuk menguatkan dokumen tertentu. Untuk mengetahui informasi selengkapnya tentang penguatan, lihat Penguatan
params

map (key: string, value: value (Value format))

Parameter penelusuran tambahan.

Untuk penelusuran situs web publik saja, nilai yang didukung adalah:

  • user_country_code: string. Default kosong. Jika disetel ke tidak kosong, hasil akan dibatasi atau dikuatkan berdasarkan lokasi yang diberikan. Misalnya, user_country_code: "au"

Untuk kode yang tersedia, lihat Kode Negara

  • searchType: ganda. Default kosong. Mengaktifkan penelusuran non-halaman web bergantung pada nilainya. Satu-satunya nilai non-default yang valid adalah 1, yang mengaktifkan penelusuran gambar. Misalnya, searchType: 1
queryExpansionSpec

object (QueryExpansionSpec)

Spesifikasi perluasan kueri yang menentukan kondisi saat perluasan kueri terjadi.
spellCorrectionSpec

object (SpellCorrectionSpec)

Spesifikasi koreksi ejaan yang menentukan mode yang digunakan untuk menerapkan koreksi ejaan.
userPseudoId

string

Opsional. 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 ID 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.
useLatestData

boolean

menggunakan Engine, ServingConfig, dan Control yang baru saja dibaca dari basis data.

Catatan: ini melewati cache konfigurasi dan memperkenalkan ketergantungan pada basis data, yang dapat secara signifikan meningkatkan latensi API. Ini hanya boleh digunakan untuk pengujian, bukan untuk melayani pengguna akhir.
contentSearchSpec

object (ContentSearchSpec)

Spesifikasi untuk mengonfigurasi perilaku penelusuran konten.
embeddingSpec

object (EmbeddingSpec)

Menggunakan embedding yang disediakan untuk melakukan pengambilan dokumen semantik tambahan. Pengambilan data didasarkan pada hasil perkalian titik antara SearchRequest.EmbeddingSpec.EmbeddingVector.vector dan penyematan dokumen yang disediakan dalam SearchRequest.EmbeddingSpec.EmbeddingVector.field_path.

Jika SearchRequest.EmbeddingSpec.EmbeddingVector.field_path tidak disediakan, maka akan menggunakan ServingConfig.EmbeddingConfig.field_path.
rankingExpression

string

Opsional. Ekspresi peringkat mengontrol peringkat yang disesuaikan pada dokumen pengambilan. Kolom ini menggantikan ServingConfig.ranking_expression. Sintaksis dan fitur yang didukung bergantung pada nilai rankingExpressionBackend. Jika rankingExpressionBackend tidak diberikan, nilai defaultnya adalah RANK_BY_EMBEDDING.

Jika rankingExpressionBackend tidak disediakan atau disetel ke RANK_BY_EMBEDDING, nilai tersebut harus berupa satu fungsi atau beberapa fungsi yang digabungkan dengan "+".

  • rankingExpression = function, { " + ", function };

Fungsi yang didukung:

  • double * relevanceScore
  • double * dotProduct(embedding_field_path)

Variabel fungsi:

  • relevanceScore: 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 * relevanceScore + 0.3 * dotProduct(doc_embedding).

Jika rankingExpressionBackend 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.
  • isNan(signal) -- menampilkan 0 jika sinyal adalah NaN, 1 jika tidak.
  • fillNan(signal1, signal2 | double) -- jika signal1 adalah NaN, menampilkan signal2 | double, jika tidak, menampilkan signal1.

Berikut beberapa contoh formula peringkat yang menggunakan jenis ekspresi peringkat yang didukung:

  • 0.2 * semanticSimilarityScore + 0.8 * log(keywordSimilarityScore) -- sebagian besar diberi peringkat berdasarkan logaritma keywordSimilarityScore dengan sedikit penyesuaian semantic_smilarity_score.
  • 0.2 * exp(fillNan(semanticSimilarityScore, 0)) + 0.3 * isNan(keywordSimilarityScore) -- peringkat berdasarkan eksponen semanticSimilarityScore, mengisi nilai dengan 0 jika NaN, juga menambahkan penyesuaian konstanta 0,3 ke skor akhir jika semanticSimilarityScore adalah NaN.
  • 0.2 * rr(semanticSimilarityScore, 16) + 0.8 * rr(keywordSimilarityScore, 16) -- sebagian besar diberi peringkat berdasarkan peringkat kebalikan keywordSimilarityScore dengan sedikit penyesuaian peringkat kebalikan semantic_smilarity_score.

Sinyal berikut didukung:

  • semanticSimilarityScore: penyesuaian kesamaan semantik yang dihitung menggunakan embedding yang dihasilkan oleh model Google eksklusif. Skor ini menentukan seberapa mirip kueri penelusuran dengan dokumen secara semantik.
  • keywordSimilarityScore: penyesuaian kecocokan kata kunci menggunakan fungsi peringkat Best Match 25 (BM25). Skor ini dihitung menggunakan model probabilistik untuk memperkirakan probabilitas bahwa dokumen relevan dengan kueri tertentu.
  • relevanceScore: penyesuaian relevansi semantik yang menggunakan model eksklusif Google untuk menentukan makna dan maksud di balik kueri pengguna dalam konteks dengan konten dalam dokumen.
  • pctrRank: penyesuaian rasio konversi yang diprediksi sebagai penggunaan peringkat Rasio klik-tayang (CTR) 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.
  • freshnessRank: penyesuaian keaktualan sebagai peringkat
  • documentAge: Waktu dalam jam yang telah berlalu sejak dokumen terakhir diperbarui, angka floating point (misalnya, 0,25 berarti 15 menit).
  • topicalityRank: penyesuaian topik sebagai peringkat. Menggunakan model Google eksklusif untuk menentukan tumpang-tindih berbasis kata kunci antara kueri dan dokumen.
  • baseRank: peringkat default hasil
  • mediaActorMatch: apakah aktor media cocok dengan kueri
  • mediaDirectorMatch: apakah sutradara media cocok dengan kueri
  • mediaGenreMatch: apakah genre media cocok dengan kueri
  • mediaLanguageMatch: apakah bahasa media cocok dengan kueri
  • mediaTitleMatch: apakah judul media cocok dengan kueri
  • mediaPrefixSimilarityRank: peringkat kemiripan awalan untuk hasil media
  • mediaSemanticSimilarityRank: peringkat kesamaan semantik untuk hasil media
rankingExpressionBackend

enum (RankingExpressionBackend)

Opsional. Backend yang akan digunakan untuk evaluasi ekspresi peringkat.
userLabels

map (key: string, value: 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 panjang maksimumnya 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.
naturalLanguageQueryUnderstandingSpec

object (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.
searchAsYouTypeSpec

object (SearchAsYouTypeSpec)

Konfigurasi penelusuran saat Anda mengetik. Hanya didukung untuk kategori IndustryVertical.MEDIA.
customFineTuningSpec

object (CustomFineTuningSpec)

Konfigurasi penyesuaian kustom. Jika disetel, setelan ini memiliki prioritas yang lebih tinggi daripada konfigurasi yang disetel di ServingConfig.custom_fine_tuning_spec.
displaySpec

object (DisplaySpec)

Opsional. Konfigurasi untuk fitur tampilan, seperti penyorotan kecocokan pada hasil penelusuran.
crowdingSpecs[]

object (CrowdingSpec)

Opsional. Spesifikasi pengelompokan untuk meningkatkan keragaman hasil. Jika beberapa CrowdingSpec ditentukan, kepadatan akan dievaluasi pada setiap kombinasi unik nilai field, dan maxCount akan menjadi nilai maksimum maxCount di semua CrowdingSpec. Misalnya, jika CrowdingSpec pertama memiliki field = "color" dan maxCount = 3, dan CrowdingSpec kedua memiliki field = "size" dan maxCount = 2, maka setelah 3 dokumen yang memiliki warna DAN ukuran yang sama ditampilkan, dokumen berikutnya harus dihapus atau diturunkan.
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 dibuat 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 performa 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.
sessionSpec

object (SessionSpec)

Spesifikasi sesi.

Hanya dapat digunakan jika session ditetapkan.
relevanceThreshold

enum (RelevanceThreshold)

Nilai minimum relevansi global hasil penelusuran.

Secara default, menggunakan nilai minimum yang ditentukan Google, dengan memanfaatkan keseimbangan presisi dan perolehan untuk memberikan hasil yang sangat akurat dan cakupan informasi relevan yang komprehensif.

Jika pemfilteran relevansi yang lebih terperinci diperlukan, gunakan relevanceFilterSpec.

Fitur ini tidak didukung untuk penelusuran layanan kesehatan.
relevanceFilterSpec

object (RelevanceFilterSpec)

Opsional. Spesifikasi pemfilteran relevansi terperinci.

Jika tidak ditentukan, relevanceThreshold global akan digunakan untuk semua sub-penelusuran. Jika ditentukan, nilai ini akan menggantikan relevanceThreshold global untuk menggunakan nilai minimum per sub-penelusuran.

Saat ini, fitur ini hanya didukung untuk penelusuran kustom dan situs.
personalizationSpec

object (PersonalizationSpec)

Spesifikasi untuk personalisasi.

Perhatikan bahwa jika ServingConfig.personalization_spec dan SearchRequest.personalization_spec ditetapkan, SearchRequest.personalization_spec akan menggantikan ServingConfig.personalization_spec.
relevanceScoreSpec

object (RelevanceScoreSpec)

Opsional. Spesifikasi untuk menampilkan skor relevansi.
searchAddonSpec

object (SearchAddonSpec)

Opsional. SearchAddonSpec digunakan untuk menonaktifkan add-on untuk penelusuran sesuai dengan model penetapan harga baru. Kolom ini hanya didukung untuk permintaan penelusuran.
customRankingParams

object (CustomRankingParams)

Opsional. Konfigurasi opsional untuk fitur Peringkat Kustom.
entity

string

Opsional. Entitas untuk pelanggan yang dapat menjalankan beberapa entitas, domain, situs, atau wilayah yang berbeda, misalnya, "Google AS", "Google Ads", "Waymo", "google.com", "youtube.com", dll. Jika disetel, entitas ini harus cocok persis dengan UserEvent.entity untuk mendapatkan hasil penelusuran yang ditingkatkan berdasarkan entitas.

ImageQuery

Menentukan input kueri gambar.

Representasi JSON 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "imageBytes": string
  // End of mutually exclusive fields.
}
Kolom
Menentukan byte gambar. Berikut adalah daftar kolom yang bersifat eksklusif satu sama lain. Maksimal satu kolom akan ditetapkan dalam respons:
imageBytes

string

Byte gambar berenkode Base64. Format gambar yang didukung: JPEG, PNG, dan BMP.
Akhir kolom yang saling eksklusif.

FacetSpec

Spesifikasi faset untuk melakukan penelusuran dengan faset.

Representasi JSON 
{
  "facetKey": {
    object (FacetKey)
  },
  "limit": integer,
  "excludedFilterKeys": [
    string
  ],
  "enableDynamicPosition": boolean
}
Kolom
facetKey

object (FacetKey)

Wajib. Spesifikasi kunci faset.
limit

integer

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 agregasi dalam pencarian layanan kesehatan, ketika [FacetKey.key] adalah "healthcare_aggregation_key", batasnya akan ditimpa menjadi 10.000 secara internal, terlepas dari nilai yang ditetapkan di sini.

Jika kolom ini bernilai negatif, INVALID_ARGUMENT akan ditampilkan.
excludedFilterKeys[]

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 pencarian yang ditampilkan.

Sebagai contoh, anggaplah 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 mengembalikan dokumen "Red" dalam hasil pencarian, dan juga mengembalikan "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 pencarian, hasil pencarian tetap difilter dengan benar untuk hanya menampilkan dokumen "Merah".

Maksimal 100 nilai diizinkan. Jika tidak, error INVALID_ARGUMENT akan ditampilkan.
enableDynamicPosition

boolean

Mengaktifkan posisi dinamis untuk faset ini. Jika diatur ke true, posisi faset ini di antara semua faset dalam respons akan ditentukan secara otomatis. Jika faset dinamis diaktifkan, maka akan diurutkan bersama. Jika diatur ke false, posisi faset ini dalam respons sama dengan posisi dalam permintaan, dan faset ini diberi peringkat sebelum faset dengan posisi dinamis yang diaktifkan dan semua faset 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 menetapkan enableDynamicPosition ke benar (true) sehingga posisi aspek rating dalam respons ditentukan secara otomatis.

Contoh lain, dengan asumsi Anda memiliki aspek-aspek berikut dalam permintaan:

  • "rating", enableDynamicPosition = true

  • "harga", enableDynamicPosition = false

  • "merek", enableDynamicPosition = 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 peringkat pertama dan kedua karena enableDynamicPosition mereka bernilai false.

FacetKey

Menentukan bagaimana sebuah faset dihitung.

Representasi JSON 
{
  "key": string,
  "intervals": [
    {
      object (Interval)
    }
  ],
  "restrictedValues": [
    string
  ],
  "prefixes": [
    string
  ],
  "contains": [
    string
  ],
  "caseInsensitive": boolean,
  "orderBy": string
}
Kolom
key

string

Wajib. Kunci faset tekstual dan numerik yang didukung dalam objek Document, yang digunakan untuk menghitung nilai faset. Kunci faset peka terhadap huruf besar dan kecil.
intervals[]

object (Interval)

Pilih opsi ini hanya jika nilai-nilai perlu dikelompokkan ke dalam interval. Harus ditetapkan untuk aspek dengan nilai numerik. Tidak boleh diatur untuk faset dengan nilai teks. Jumlah interval maksimum adalah 30.
restrictedValues[]

string

Hanya mendapatkan aspek untuk nilai terbatas tertentu. Hanya didukung di kolom tekstual. Misalnya, "category" memiliki tiga nilai "Action > 2022", "Action > 2021", dan "Sci-Fi > 2022". Jika "restrictedValues" diatur ke "Action > 2022", faset "category" hanya berisi "Action > 2022". Hanya didukung di kolom tekstual. Jumlah maksimum adalah 10.
prefixes[]

string

Hanya ambil nilai faset yang diawali dengan awalan string yang diberikan. Misalnya, "category" memiliki tiga nilai "Action > 2022", "Action > 2021", dan "Sci-Fi > 2022". Jika "awalan" diatur ke "Aksi", faset "kategori" hanya berisi "Aksi > 2022" dan "Aksi > 2021". Hanya didukung pada kolom teks. Jumlah maksimum adalah 10.
contains[]

string

Hanya ambil nilai faset yang berisi string yang diberikan. Misalnya, "category" memiliki tiga nilai "Action > 2022", "Action > 2021", dan "Sci-Fi > 2022". Jika "contains" diatur ke "2022", faset "category" hanya berisi "Action > 2022" dan "Sci-Fi > 2022". Hanya didukung pada kolom teks. Jumlah maksimum adalah 10.
caseInsensitive

boolean

Benar untuk membuat kunci facet tidak peka huruf besar/kecil saat mendapatkan nilai facet dengan awalan atau berisi; salah jika tidak.
orderBy

string

Urutan dokumen yang ditampilkan.

Nilai yang diperbolehkan adalah:

Jika tidak ditetapkan, nilai tekstual diurutkan dalam urutan alami; interval numerik diurutkan dalam urutan yang diberikan oleh FacetSpec.FacetKey.intervals.

Interval

Interval bilangan floating point.

Representasi JSON 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "minimum": number,
  "exclusiveMinimum": number
  // End of mutually exclusive fields.

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "maximum": number,
  "exclusiveMaximum": number
  // End of mutually exclusive fields.
}
Kolom

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

Kolom ini tidak boleh lebih besar dari nilai maks. Jika tidak, error INVALID_ARGUMENT akan ditampilkan. Berikut adalah daftar kolom yang bersifat eksklusif satu sama lain. Maksimal satu kolom akan ditetapkan dalam respons:
minimum

number

Batas bawah inklusif.
exclusiveMinimum

number

Batas bawah eksklusif.
Akhir kolom yang saling eksklusif.

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. Berikut adalah daftar kolom yang bersifat eksklusif satu sama lain. Maksimal satu kolom akan ditetapkan dalam respons:
maximum

number

Batas atas inklusif.
exclusiveMaximum

number

Batas atas eksklusif.
Akhir kolom yang saling eksklusif.

QueryExpansionSpec

Spesifikasi untuk menentukan kondisi apa yang mengharuskan perluasan kueri terjadi.

Representasi JSON 
{
  "condition": enum (Condition),
  "pinUnexpandedResults": boolean
}
Kolom
condition

enum (Condition)

Kondisi di mana perluasan kueri harus terjadi. Defaultnya adalah Condition.DISABLED.
pinUnexpandedResults

boolean

Apakah hasil yang belum diperluas perlu disematkan. Jika kolom ini diatur ke true, produk yang belum diperluas akan selalu berada di bagian atas hasil pencarian, diikuti oleh hasil yang sudah diperluas.

Kondisi

Enum yang menjelaskan kondisi di mana perluasan kueri harus terjadi.

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 pencarian yang tepat yang digunakan, meskipun SearchResponse.total_size bernilai nol.
AUTO Ekspansi kueri otomatis yang dibangun oleh API Pencarian.

SpellCorrectionSpec

Spesifikasi untuk koreksi ejaan kueri.

Representasi JSON 
{
  "mode": enum (Mode)
}
Kolom
mode

enum (Mode)

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

Mode

Enum yang menjelaskan mode koreksi ejaan yang harus terjadi.

Enum
MODE_UNSPECIFIED Mode koreksi ejaan tidak ditentukan. Dalam hal ini, perilaku server ditetapkan secara default ke Mode.AUTO.
SUGGESTION_ONLY API pencarian 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.

EmbeddingSpec

Spesifikasi yang menggunakan vektor embedding kueri yang disesuaikan untuk melakukan pengambilan dokumen semantik.

Representasi JSON 
{
  "embeddingVectors": [
    {
      object (EmbeddingVector)
    }
  ]
}
Kolom
embeddingVectors[]

object (EmbeddingVector)

Vektor penyematan yang digunakan untuk pengambilan data. Dibatasi hingga 1.

EmbeddingVector

Vektor embedding.

Representasi JSON 
{
  "fieldPath": string,
  "vector": [
    number
  ]
}
Kolom
fieldPath

string

Menyematkan jalur bidang dalam skema.
vector[]

number

Vektor penyematan kueri.

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

Tidak digunakan lagi: Gunakan RANK_BY_FORMULA sebagai gantinya. Peringkat menurut formula kustom. Opsi enum lama, RANK_BY_FORMULA harus digunakan sebagai gantinya.
RANK_BY_EMBEDDING Peringkat menurut model sematan kustom, cara default untuk mengevaluasi ekspresi peringkat.
RANK_BY_FORMULA Peringkat menurut formula kustom.

NaturalLanguageQueryUnderstandingSpec

Spesifikasi untuk mengaktifkan kemampuan pemahaman bahasa alami untuk permintaan penelusuran.

Representasi JSON 
{
  "filterExtractionCondition": enum (FilterExtractionCondition),
  "geoSearchQueryDetectionFieldNames": [
    string
  ],
  "extractedFilterBehavior": enum (ExtractedFilterBehavior),
  "allowedFieldNames": [
    string
  ]
}
Kolom
filterExtractionCondition

enum (FilterExtractionCondition)

Kondisi saat ekstraksi filter harus terjadi. Perilaku server secara default adalah DISABLED.
geoSearchQueryDetectionFieldNames[]

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

enum (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.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition ditetapkan ke FilterExtractionCondition.ENABLED.
allowedFieldNames[]

string

Opsional. Daftar yang diizinkan dari kolom yang dapat digunakan untuk ekstraksi filter bahasa alami. 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 allowedFieldNames, 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.

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.

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.

SearchAsYouTypeSpec

Spesifikasi untuk penelusuran saat Anda mengetik di permintaan penelusuran.

Representasi JSON 
{
  "condition": enum (Condition)
}
Kolom
condition

enum (Condition)

Kondisi saat penelusuran saat Anda mengetik harus terjadi. Defaultnya adalah Condition.DISABLED.

Kondisi

Enum yang menjelaskan kondisi saat penelusuran saat Anda mengetik harus terjadi.

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

DisplaySpec

Menentukan fitur untuk ditampilkan, seperti penyorotan kecocokan.

Representasi JSON 
{
  "matchHighlightingCondition": enum (MatchHighlightingCondition)
}
Kolom
matchHighlightingCondition

enum (MatchHighlightingCondition)

Kondisi saat penyorotan kecocokan harus terjadi.

MatchHighlightingCondition

Enum yang menjelaskan kondisi saat penyorotan kecocokan harus terjadi.

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.

CrowdingSpec

Spesifikasi untuk kepadatan penduduk. Crowding meningkatkan keragaman hasil penelusuran dengan membatasi jumlah hasil yang memiliki nilai kolom yang sama. Sebagai contoh, kepadatan pada bidang warna dengan maxCount 3 dan mode DROP_CROWDED_RESULTS akan mengembalikan paling banyak 3 hasil dengan warna yang sama di semua halaman.

Representasi JSON 
{
  "field": string,
  "maxCount": integer,
  "mode": enum (Mode)
}
Kolom
field

string

Bidang yang akan digunakan untuk kepadatan. Dokumen dapat dikelompokkan berdasarkan kolom dalam objek Document. Crowding field bersifat case sensitive (mekaji huruf besar dan kecil).
maxCount

integer

Jumlah maksimum dokumen yang akan disimpan per nilai bidang tersebut. Setelah terdapat setidaknya maxCount hasil sebelumnya yang berisi nilai yang sama untuk bidang yang diberikan (sesuai dengan urutan yang ditentukan dalam orderBy), hasil selanjutnya dengan nilai yang sama akan "disingkirkan". Jika tidak ditentukan, nilai defaultnya adalah 1.
mode

enum (Mode)

Mode yang digunakan untuk dokumen yang berantakan.

Mode

Enum yang menjelaskan mode yang digunakan untuk dokumen yang disingkirkan. Produk dapat diturunkan atau diturunkan ke halaman berikutnya.

Enum
MODE_UNSPECIFIED Mode kepadatan tidak ditentukan. Dalam hal ini, perilaku server ditetapkan secara default ke Mode.DROP_CROWDED_RESULTS.
DROP_CROWDED_RESULTS Abaikan hasil yang ramai.
DEMOTE_CROWDED_RESULTS_TO_END Pindahkan hasil pencarian yang terlalu ramai ke halaman berikutnya.

SessionSpec

Spesifikasi sesi.

Representasi JSON 
{
  "queryId": string,
  "searchResultPersistenceCount": integer
}
Kolom
queryId

string

Jika diatur, hasil pencarian akan disimpan ke "giliran" yang ditentukan oleh ID kueri ini.

Contoh: Misalkan sesi terlihat seperti ini: session { name: ".../sessions/xxx" turns { query { text: "Apa itu foo?" queryId: ".../questions/yyy" } answer: "Foo adalah ..." } turns { query { text: "Bagaimana dengan bar?" queryId: ".../questions/zzz" } } }

Pengguna dapat memanggil /search API dengan permintaan seperti ini:

session: ".../sessions/xxx" sessionSpec { queryId: ".../questions/zzz" }

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

integer

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

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

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

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 akan menggunakan nilai default yang ditentukan Google.
LOWEST Nilai minimum relevansi.
LOW Ambang batas relevansi rendah.
MEDIUM Nilai minimum relevansi sedang.
HIGH Ambang batas relevansi tinggi.

RelevanceFilterSpec

Spesifikasi pemfilteran relevansi.

Representasi JSON 
{
  "keywordSearchThreshold": {
    object (RelevanceThresholdSpec)
  },
  "semanticSearchThreshold": {
    object (RelevanceThresholdSpec)
  }
}
Kolom
keywordSearchThreshold

object (RelevanceThresholdSpec)

Opsional. Spesifikasi nilai minimum pemfilteran relevansi untuk penelusuran kata kunci.
semanticSearchThreshold

object (RelevanceThresholdSpec)

Opsional. Spesifikasi ambang batas penyaringan relevansi untuk pencarian semantik.

RelevanceThresholdSpec

Spesifikasi untuk pemfilteran relevansi pada sub-penelusuran tertentu.

Representasi JSON 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "relevanceThreshold": enum (RelevanceThreshold),
  "semanticRelevanceThreshold": number
  // End of mutually exclusive fields.
}
Kolom
Mengonfigurasi cara menentukan nilai minimum relevansi. Berikut adalah daftar kolom yang bersifat eksklusif satu sama lain. Maksimal satu kolom akan ditetapkan dalam respons:
relevanceThreshold

enum (RelevanceThreshold)

Nilai minimum relevansi yang telah ditentukan untuk sub-penelusuran.
semanticRelevanceThreshold

number

Nilai minimum relevansi kustom untuk sub-penelusuran. Nilai harus dalam [0,0, 1,0].
Akhir kolom yang saling eksklusif.

RelevanceScoreSpec

Spesifikasi untuk menampilkan skor relevansi dokumen.

Representasi JSON 
{
  "returnRelevanceScore": boolean
}
Kolom
returnRelevanceScore

boolean

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

SearchAddonSpec

SearchAddonSpec digunakan untuk menonaktifkan add-on untuk penelusuran sesuai dengan model penetapan harga baru. Secara default, jika SearchAddonSpec tidak ditentukan, kami menganggap bahwa pelanggan ingin mengaktifkannya jika berlaku.

Representasi JSON 
{
  "disableSemanticAddOn": boolean,
  "disableKpiPersonalizationAddOn": boolean,
  "disableGenerativeAnswerAddOn": boolean
}
Kolom
disableSemanticAddOn

boolean

Opsional. Jika benar, add-on semantik akan dinonaktifkan. Add-on semantik mencakup embedding dan jetstream.
disableKpiPersonalizationAddOn

boolean

Opsional. Jika benar, menonaktifkan pemeringkatan ulang dan personalisasi peristiwa untuk mengoptimalkan KPI & mempersonalisasi hasil.
disableGenerativeAnswerAddOn

boolean

Opsional. Jika benar (true), add-on jawaban generatif akan dinonaktifkan. Add-on jawaban generatif mencakup bahasa alami untuk filter dan jawaban sederhana.

CustomRankingParams

Parameter konfigurasi untuk fitur Peringkat Kustom.

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

string

Opsional. Daftar ekspresi peringkat (lihat rankingExpression untuk dokumentasi sintaksis) yang akan dievaluasi. Hasil evaluasi akan dikembalikan dalam kolom SearchResponse.SearchResult.rank_signals.precomputed_expression_values.

QuerySetSpec

Menjelaskan spesifikasi set kueri.

Representasi JSON 
{
  "sampleQuerySet": string
}
Kolom
sampleQuerySet

string

Opsional. Nama resource lengkap SampleQuerySet yang digunakan untuk evaluasi, dalam format projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}.

QualityMetrics

Menjelaskan metrik yang dihasilkan oleh evaluasi.

Representasi JSON 
{
  "docRecall": {
    object (TopkMetrics)
  },
  "docPrecision": {
    object (TopkMetrics)
  },
  "docNdcg": {
    object (TopkMetrics)
  },
  "pageRecall": {
    object (TopkMetrics)
  },
  "pageNdcg": {
    object (TopkMetrics)
  }
}
Kolom
docRecall

object (TopkMetrics)

Recall per dokumen, pada berbagai tingkat cutoff top-k.

Perolehan adalah bagian dari dokumen yang relevan yang diambil dari semua dokumen yang relevan.

Contoh (5 teratas): * Untuk satu SampleQuery, jika 3 dari 5 dokumen yang relevan diambil dalam 5 teratas, recall@5 = 3/5 = 0,6
docPrecision

object (TopkMetrics)

Presisi per dokumen, pada berbagai tingkat cutoff top-k.

Presisi adalah fraksi dokumen yang diambil yang relevan.

Contoh (top-5): * Untuk satu SampleQuery, Jika 4 dari 5 dokumen yang diambil dalam top-5 relevan, precision@5 = 4/5 = 0,8
docNdcg

object (TopkMetrics)

Perolehan kumulatif setelah diskon yang dinormalisasi (NDCG) per dokumen, pada berbagai tingkat cutoff top-k.

NDCG mengukur kualitas peringkat, dengan memberikan relevansi yang lebih tinggi pada hasil teratas.

Contoh (3 teratas): Misalkan SampleQuery dengan tiga dokumen yang diambil (D1, D2, D3) dan penilaian relevansi biner (1 untuk relevan, 0 untuk tidak relevan):

Diperoleh: [D3 (0), D1 (1), D2 (1)] Ideal: [D1 (1), D2 (1), D3 (0)]

Hitung NDCG@3 untuk setiap SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1,13 * DCG@3 ideal: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1,63 * NDCG@3: 1,13/1,63 = 0,693
pageRecall

object (TopkMetrics)

Panggilan balik per halaman, pada berbagai tingkat cutoff top-k.

Perolehan adalah bagian dari halaman yang relevan yang diambil dari semua halaman yang relevan.

Contoh (top-5): * Untuk satu SampleQuery, jika 3 dari 5 halaman yang relevan diambil di top-5, recall@5 = 3/5 = 0,6
pageNdcg

object (TopkMetrics)

Perolehan kumulatif setelah diskon yang dinormalisasi (NDCG) per halaman, pada berbagai tingkat cutoff top-k.

NDCG mengukur kualitas peringkat, dengan memberikan relevansi yang lebih tinggi pada hasil teratas.

Contoh (3 teratas): Misalkan SampleQuery dengan tiga halaman yang diambil (P1, P2, P3) dan penilaian relevansi biner (1 untuk relevan, 0 untuk tidak relevan):

Diperoleh: [P3 (0), P1 (1), P2 (1)] Ideal: [P1 (1), P2 (1), P3 (0)]

Menghitung NDCG@3 untuk SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1,13 * DCG@3 ideal: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1,63 * NDCG@3: 1,13/1,63 = 0,693

TopkMetrics

Menyimpan nilai metrik pada level top-k tertentu.

Representasi JSON 
{
  "top1": number,
  "top3": number,
  "top5": number,
  "top10": number
}
Kolom
top1

number

Nilai teratas.
top3

number

Nilai 3 teratas.
top5

number

Nilai 5 teratas.
top10

number

Nilai 10 teratas.

Negara Bagian

Menjelaskan status evaluasi.

Enum
STATE_UNSPECIFIED Evaluasi tidak ditentukan.
PENDING Layanan sedang bersiap untuk menjalankan evaluasi.
RUNNING Evaluasi sedang berlangsung.
SUCCEEDED Evaluasi berhasil diselesaikan.
FAILED Evaluasi gagal.

Metode

create

 Membuat Evaluation.

get

 Mendapatkan Evaluation.

list

 Mendapatkan daftar Evaluation.

listResults

 Mendapatkan daftar hasil untuk Evaluation tertentu.