REST Resource: projects.locations.evaluations

Resource: Evaluasi

Evaluasi adalah satu eksekusi (atau operasi) dari 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 diisi jika status evaluasi adalah 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. Stempel waktu saat Evaluation diselesaikan.

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)
  },

  // Union field search_spec can be only one of the following:
  "searchRequest": {
    object (SearchRequest)
  }
  // End of list of possible types for union field search_spec.
}
Kolom
querySetSpec

object (QuerySetSpec)

Opsional. Spesifikasi set kueri.
Kolom union search_spec. Spesifikasi penelusuran. search_spec hanya ada berupa salah satu diantara berikut:
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:

SearchRequest

Pesan permintaan untuk metode SearchService.Search.

Representasi JSON 
{
  "servingConfig": string,
  "branch": string,
  "query": string,
  "imageQuery": {
    object (ImageQuery)
  },
  "pageSize": integer,
  "pageToken": string,
  "offset": integer,
  "oneBoxPageSize": integer,
  "dataStoreSpecs": [
    {
      object (DataStoreSpec)
    }
  ],
  "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,
  "contentSearchSpec": {
    object (ContentSearchSpec)
  },
  "embeddingSpec": {
    object (EmbeddingSpec)
  },
  "rankingExpression": string,
  "rankingExpressionBackend": enum (RankingExpressionBackend),
  "safeSearch": boolean,
  "userLabels": {
    string: string,
    ...
  },
  "naturalLanguageQueryUnderstandingSpec": {
    object (NaturalLanguageQueryUnderstandingSpec)
  },
  "searchAsYouTypeSpec": {
    object (SearchAsYouTypeSpec)
  },
  "displaySpec": {
    object (DisplaySpec)
  },
  "session": string,
  "sessionSpec": {
    object (SessionSpec)
  },
  "relevanceThreshold": enum (RelevanceThreshold),
  "personalizationSpec": {
    object (PersonalizationSpec)
  },
  "relevanceScoreSpec": {
    object (RelevanceScoreSpec)
  },
  "searchAddonSpec": {
    object (SearchAddonSpec)
  }
}
Kolom
servingConfig

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.
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 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.
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 negatif, INVALID_ARGUMENT akan ditampilkan.

Offset besar dapat dibatasi hingga nilai minimum yang wajar.
oneBoxPageSize

integer

Jumlah maksimum hasil yang akan ditampilkan untuk OneBox. Hal ini berlaku untuk setiap jenis OneBox 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.
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 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.
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 nilai tidak 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 ditetapkan, hasil akan ditingkatkan berdasarkan regionCode yang diberikan.
facetSpecs[]

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

object (BoostSpec)

Spesifikasi peningkat untuk meningkatkan kualitas dokumen tertentu. Untuk mengetahui informasi selengkapnya tentang promosi, lihat Promosi
params

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

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

  • searchType: 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, 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

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

object (ContentSearchSpec)

Spesifikasi untuk mengonfigurasi perilaku penelusuran konten.
embeddingSpec

object (EmbeddingSpec)

Menggunakan embedding yang diberikan untuk melakukan pengambilan dokumen semantik tambahan. Pengambilan didasarkan pada produk titik SearchRequest.EmbeddingSpec.EmbeddingVector.vector dan sematan dokumen yang disediakan di SearchRequest.EmbeddingSpec.EmbeddingVector.field_path.

Jika SearchRequest.EmbeddingSpec.EmbeddingVector.field_path tidak diberikan, ServingConfig.EmbeddingConfig.field_path akan digunakan.
rankingExpression

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 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 | ganda, 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 pemberian 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 niat di balik kueri pengguna dalam konteks dengan konten dalam dokumen.
  • pctrRank: 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.
  • freshnessRank: penyesuaian keaktualan sebagai peringkat
  • documentAge: Waktu dalam jam yang berlalu sejak dokumen terakhir diperbarui, bilangan 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
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 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.
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.
displaySpec

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

object (SessionSpec)

Spesifikasi sesi.

Hanya dapat digunakan jika session disetel.
relevanceThreshold

enum (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.
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.

ImageQuery

Menentukan input kueri gambar.

Representasi JSON 
{

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

Kolom union image.

image hanya dapat berupa salah satu dari hal berikut:
imageBytes

string

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

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.

Representasi JSON 
{
  "dataStore": string,
  "filter": string,
  "boostSpec": {
    object (BoostSpec)
  },
  "customSearchOperators": string
}
Kolom
dataStore

string

Wajib. Nama resource lengkap DataStore, seperti projects/{project}/locations/{location}/collections/{collectionId}/dataStores/{dataStoreId}. 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 dataStore. Untuk mengetahui informasi selengkapnya tentang pemfilteran, lihat Pemfilteran.
boostSpec

object (BoostSpec)

Opsional. Spesifikasi peningkat untuk meningkatkan kualitas dokumen tertentu. Untuk mengetahui informasi selengkapnya tentang promosi, lihat Promosi
customSearchOperators

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.

BoostSpec

Spesifikasi peningkat untuk meningkatkan kualitas dokumen tertentu.

Representasi JSON 
{
  "conditionBoostSpecs": [
    {
      object (ConditionBoostSpec)
    }
  ]
}
Kolom
conditionBoostSpecs[]

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

Representasi JSON 
{
  "condition": string,
  "boost": number,
  "boostControlSpec": {
    object (BoostControlSpec)
  }
}
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": (documentId: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))
boost

number

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 boostControlSpec di bawah yang ditetapkan. Jika keduanya disetel, peningkatan global akan diabaikan dan boostControlSpec yang lebih terperinci akan diterapkan.
boostControlSpec

object (BoostControlSpec)

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

BoostControlSpec

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.

Representasi JSON 
{
  "fieldName": string,
  "attributeType": enum (AttributeType),
  "interpolationType": enum (InterpolationType),
  "controlPoints": [
    {
      object (ControlPoint)
    }
  ]
}
Kolom
fieldName

string

Nama kolom yang nilainya akan digunakan untuk menentukan jumlah peningkat.
attributeType

enum (AttributeType)

Jenis atribut yang akan digunakan untuk menentukan jumlah peningkat. Nilai atribut dapat diperoleh dari nilai kolom fieldName yang ditentukan. Untuk nilai numerik, prosesnya sederhana, yaitu attributeValue = numerical_field_value. Namun, dalam kasus keaktualan, attributeValue = (time.now() - datetime_field_value).
interpolationType

enum (InterpolationType)

Jenis interpolasi yang akan diterapkan untuk menghubungkan titik kontrol yang tercantum di bawah.
controlPoints[]

object (ControlPoint)

Titik kontrol yang digunakan untuk menentukan kurva. Fungsi monotonik (ditentukan melalui interpolationType 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, attributeValue (nilai x) titik kontrol akan menjadi nilai sebenarnya dari kolom numerik yang boostAmount-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.

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.

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

Representasi JSON 
{
  "attributeValue": string,
  "boostAmount": number
}
Kolom
attributeValue

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]].
boostAmount

number

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

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 aspek.
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 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.
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 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.
enableDynamicPosition

boolean

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 menetapkan enableDynamicPosition ke benar (true) sehingga posisi aspek rating dalam respons ditentukan secara otomatis.

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

  • "rating", enableDynamicPosition = true

  • "price", enableDynamicPosition = false

  • "brands", 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 "price" dan "brands" selalu berada di peringkat pertama dan kedua karena enableDynamicPosition-nya adalah false.

FacetKey

Menentukan cara penghitungan aspek.

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 facet peka huruf besar/kecil.
intervals[]

object (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.
restrictedValues[]

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 "restrictedValues" disetel ke "Action > 2022", faset "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.
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 floating point.

Representasi JSON 
{

  // Union field min can be only one of the following:
  "minimum": number,
  "exclusiveMinimum": number
  // End of list of possible types for union field min.

  // Union field max can be only one of the following:
  "maximum": number,
  "exclusiveMaximum": number
  // End of list of possible types for union field max.
}
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

number

Batas bawah inklusif.
exclusiveMinimum

number

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

number

Batas atas inklusif.
exclusiveMaximum

number

Batas atas eksklusif.

QueryExpansionSpec

Spesifikasi untuk menentukan kondisi yang mensyaratkan terjadinya perluasan kueri.

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

enum (Condition)

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

boolean

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.

SpellCorrectionSpec

Spesifikasi untuk koreksi ejaan kueri.

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

enum (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.

EmbeddingSpec

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

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

object (EmbeddingVector)

Vektor embedding yang digunakan untuk pengambilan. Dibatasi hingga 1.

EmbeddingVector

Vektor embedding.

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

string

Menyematkan jalur kolom dalam skema.
vector[]

number

Kueri vektor embedding.

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.

Jika kolom ini ditetapkan, kolom ini akan menggantikan nama kolom yang ditetapkan di ServingConfig.geo_search_query_detection_field_names.
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.natural_language_query_understanding_spec.filter_extraction_condition][] ditetapkan ke FilterExtractionCondition.ENABLED.
allowedFieldNames[]

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

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

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.

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

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?" queryId: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" 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 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.
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 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.

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 di mana pun 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 penyematan 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.

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 (5 teratas): * Untuk satu SampleQuery, Jika 4 dari 5 dokumen yang diambil dalam 5 teratas relevan, presisi@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 (5 teratas): * Untuk satu SampleQuery, jika 3 dari 5 halaman yang relevan diambil di 5 teratas, 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)]

Hitung 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/Provinsi

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.