- Resource: Evaluation
- EvaluationSpec
- ImageQuery
- FacetSpec
- FacetKey
- Interval
- QueryExpansionSpec
- Kondisi
- SpellCorrectionSpec
- Mode
- EmbeddingSpec
- EmbeddingVector
- RankingExpressionBackend
- NaturalLanguageQueryUnderstandingSpec
- FilterExtractionCondition
- ExtractedFilterBehavior
- SearchAsYouTypeSpec
- Kondisi
- DisplaySpec
- MatchHighlightingCondition
- SessionSpec
- RelevanceThreshold
- RelevanceScoreSpec
- SearchAddonSpec
- QuerySetSpec
- QualityMetrics
- TopkMetrics
- Status
- Metode
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 ( |
Kolom | |
---|---|
name |
ID. Nama lengkap resource Kolom ini harus berupa string berenkode UTF-8 dengan batas panjang 1.024 karakter. |
evaluationSpec |
Wajib. Spesifikasi evaluasi. |
qualityMetrics |
Hanya output. Metrik yang dihasilkan oleh evaluasi, dirata-ratakan di semua Hanya diisi jika status evaluasi adalah BERHASIL. |
state |
Hanya output. Status evaluasi. |
error |
Hanya output. Error yang terjadi selama evaluasi. Hanya diisi jika status evaluasi adalah GAGAL. |
createTime |
Hanya output. Stempel waktu saat Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: |
endTime |
Hanya output. Stempel waktu saat Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: |
errorSamples[] |
Hanya output. Contoh error yang terjadi saat memproses permintaan. |
EvaluationSpec
Menjelaskan spesifikasi evaluasi.
Representasi JSON |
---|
{ "querySetSpec": { object ( |
Kolom | |
---|---|
querySetSpec |
Opsional. Spesifikasi set kueri. |
Kolom union search_spec . Spesifikasi penelusuran. search_spec hanya ada berupa salah satu diantara berikut: |
|
searchRequest |
Wajib. Permintaan penelusuran yang digunakan untuk melakukan evaluasi. Hanya kolom berikut dalam SearchRequest yang didukung; jika kolom lain diberikan, error UNSUPPORTED akan ditampilkan: |
ImageQuery
Menentukan input kueri gambar.
Representasi JSON |
---|
{ // Union field |
Kolom | |
---|---|
Kolom union
|
|
imageBytes |
Byte gambar berenkode Base64. Format gambar yang didukung: JPEG, PNG, dan BMP. |
FacetSpec
Spesifikasi faset untuk melakukan penelusuran dengan faset.
Representasi JSON |
---|
{
"facetKey": {
object ( |
Kolom | |
---|---|
facetKey |
Wajib. Spesifikasi kunci aspek. |
limit |
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, |
excludedFilterKeys[] |
Daftar kunci yang akan dikecualikan saat memfasilitasi. Secara default, 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 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 |
enableDynamicPosition |
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:
Selain itu, Anda telah mengaktifkan faset dinamis, yang menghasilkan |
FacetKey
Menentukan cara penghitungan aspek.
Representasi JSON |
---|
{
"key": string,
"intervals": [
{
object ( |
Kolom | |
---|---|
key |
Wajib. Kunci faset tekstual dan numerik yang didukung dalam objek |
intervals[] |
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[] |
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[] |
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[] |
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 |
Benar untuk membuat kunci facet tidak peka huruf besar/kecil saat mendapatkan nilai facet dengan awalan atau berisi; salah jika tidak. |
orderBy |
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 |
Interval
Interval floating point.
Representasi JSON |
---|
{ // Union field |
Kolom | |
---|---|
Kolom union Kolom ini tidak boleh lebih besar dari nilai maksimum. Jika tidak, error |
|
minimum |
Batas bawah inklusif. |
exclusiveMinimum |
Batas bawah eksklusif. |
Kolom union Kolom ini tidak boleh lebih kecil dari min. Jika tidak, error |
|
maximum |
Batas atas inklusif. |
exclusiveMaximum |
Batas atas eksklusif. |
QueryExpansionSpec
Spesifikasi untuk menentukan kondisi yang mensyaratkan terjadinya perluasan kueri.
Representasi JSON |
---|
{
"condition": enum ( |
Kolom | |
---|---|
condition |
Kondisi saat perluasan kueri harus terjadi. Default-nya adalah |
pinUnexpandedResults |
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 ( |
Kolom | |
---|---|
mode |
Mode yang digunakan koreksi ejaan untuk menggantikan kueri penelusuran asli. Nilai defaultnya adalah |
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 ( |
Kolom | |
---|---|
embeddingVectors[] |
Vektor embedding yang digunakan untuk pengambilan. Dibatasi hingga 1. |
EmbeddingVector
Vektor embedding.
Representasi JSON |
---|
{ "fieldPath": string, "vector": [ number ] } |
Kolom | |
---|---|
fieldPath |
Menyematkan jalur kolom dalam skema. |
vector[] |
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 |
CLEARBOX |
Tidak digunakan lagi: Gunakan |
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 ( |
Kolom | |
---|---|
filterExtractionCondition |
Kondisi saat ekstraksi filter harus terjadi. Perilaku server secara default adalah |
geoSearchQueryDetectionFieldNames[] |
Nama kolom yang digunakan untuk pemfilteran berbasis lokasi, tempat filter geolokasi terdeteksi dalam kueri penelusuran bahasa alami. Hanya valid jika FilterExtractionCondition disetel ke Jika kolom ini ditetapkan, kolom ini akan menggantikan nama kolom yang ditetapkan di |
extractedFilterBehavior |
Opsional. Mengontrol perilaku penerapan filter yang diekstrak ke penelusuran. Perilaku default bergantung pada permintaan. Untuk penelusuran terstruktur datastore tunggal, nilai defaultnya adalah |
allowedFieldNames[] |
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 ( |
Kolom | |
---|---|
condition |
Kondisi saat penelusuran saat Anda mengetik harus terjadi. Default-nya adalah |
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 ( |
Kolom | |
---|---|
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 |
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 |
Jumlah hasil penelusuran teratas yang akan dipertahankan. Hasil penelusuran yang dipertahankan dapat digunakan untuk panggilan API /answer berikutnya. Kolom ini mirip dengan kolom 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 |
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 |
Opsional. Jika benar, add-on semantik akan dinonaktifkan. Add-on semantik mencakup penyematan dan jetstream. |
disableKpiPersonalizationAddOn |
Opsional. Jika benar, menonaktifkan pemeringkatan ulang dan personalisasi peristiwa untuk mengoptimalkan KPI & mempersonalisasi hasil. |
disableGenerativeAnswerAddOn |
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 |
Opsional. Nama resource lengkap |
QualityMetrics
Menjelaskan metrik yang dihasilkan oleh evaluasi.
Representasi JSON |
---|
{ "docRecall": { object ( |
Kolom | |
---|---|
docRecall |
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 |
docPrecision |
Presisi per dokumen, pada berbagai tingkat cutoff top-k. Presisi adalah fraksi dokumen yang diambil yang relevan. Contoh (5 teratas): * Untuk satu |
docNdcg |
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 Diperoleh: [D3 (0), D1 (1), D2 (1)] Ideal: [D1 (1), D2 (1), D3 (0)] Hitung NDCG@3 untuk setiap |
pageRecall |
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 |
pageNdcg |
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 Diperoleh: [P3 (0), P1 (1), P2 (1)] Ideal: [P1 (1), P2 (1), P3 (0)] Hitung NDCG@3 untuk |
TopkMetrics
Menyimpan nilai metrik pada level top-k tertentu.
Representasi JSON |
---|
{ "top1": number, "top3": number, "top5": number, "top10": number } |
Kolom | |
---|---|
top1 |
Nilai teratas. |
top3 |
Nilai 3 teratas. |
top5 |
Nilai 5 teratas. |
top10 |
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 |
|
---|---|
|
Membuat Evaluation . |
|
Mendapatkan Evaluation . |
|
Mendapatkan daftar Evaluation . |
|
Mendapatkan daftar hasil untuk Evaluation tertentu. |