Klausa config digunakan untuk menentukan konfigurasi seperti posisi dokumen pertama yang akan dikembalikan, jumlah dokumen yang akan dikembalikan, format data hasil pengembalian, serta jumlah dokumen yang akan diurutkan oleh ekspresi pengurutan halus.
Deskripsi sintaksis
Parameter | Tipe | Wajib | Nilai valid | Nilai default | Deskripsi |
start | int | Tidak | [0, 5000] | 0 | Nomor urut dokumen pertama yang akan dikembalikan dalam hasil pencarian. |
hit | int | Tidak | [0, 500] | 10 | Jumlah maksimum dokumen yang dapat dikembalikan. |
format | string | Tidak | json | Format data hasil pengembalian. Format JSON dan fullJSON didukung. Dibandingkan dengan format JSON, format fullJSON mendukung bidang tambahan seperti variableValue dan sortExprValues. | |
rerank_size | int | Tidak | [0, 2000] | 200 | Jumlah dokumen yang akan diurutkan oleh ekspresi pengurutan halus berdasarkan satu kolom. |
total_rank_size | int | Tidak | - | - | Jumlah dokumen yang akan diurutkan oleh ekspresi pengurutan kasar. |
total_rerank_size | int | Tidak | [0,10000] | - | Jumlah dokumen yang akan diurutkan oleh ekspresi pengurutan halus. |
default_operator | string | Tidak | 'AND' atau 'OR' | AND | Operator query default yang digunakan dalam query ini. Catatan: Parameter ini hanya didukung untuk instance eksklusif. |
Catatan penggunaan
Klausa config bersifat opsional.
Pisahkan pasangan nilai kunci parameter dengan koma (,).
Pisahkan kunci dan nilai setiap parameter menggunakan titik dua (:).
Pastikan bahwa total dari nilai parameter start dan hit tidak melebihi 5.000. Jika melebihi, akan terjadi kesalahan dan tidak ada hasil yang dikembalikan. Untuk memperoleh lebih dari 5.000 entri data dalam beberapa halaman, gunakan pencarian gulir untuk mengekspor dokumen sekaligus dan mengimplementasikan pemisahan halaman. Untuk informasi lebih lanjut, lihat Pencarian Gulir.
Parameter default_operator hanya didukung untuk instance eksklusif.
Parameter total_rank_size ditentukan dalam format berbeda di OpenSearch SDK untuk bahasa yang berbeda. Di OpenSearch SDK untuk Java, tentukan parameter ini dalam format berikut:
config.addToCustomConfig("total_rank_size:200000");. Di OpenSearch SDK untuk PHP, tentukan parameter ini dalam format berikut:$params->setCustomConfig('total_rank_size', 200000);.Anda dapat melihat detail pengurutan dokumen dengan menambahkan parameter ke kode Anda.
Metode: Tambahkan parameter format:fulljson ke klausa config.
Dalam hasil yang dikembalikan, parameter sortExprValues menunjukkan informasi pengurutan dokumen.
"sortExprValues": [ "10000.0340123586" ]Nilai dari parameter sortExprValues adalah array, yang merupakan nilai dari bidang pengurutan dalam klausa pengurutan. Contoh:
sort=-price;-RANKDalam hal ini, nilai dari parameter sortExprValues berada dalam format [harga, skor dokumen].
Jika Anda tidak mengonfigurasi klausa pengurutan, nilai dari parameter sortExprValues secara default adalah skor dokumen.
Contoh
Konfigurasikan pemisahan halaman. Dalam contoh ini, 20 dokumen dikembalikan di setiap halaman.
# Klausa config untuk halaman pertama. config=start:0, hit:20, format:json # Klausa config untuk halaman kedua. config=start:20, hit:20, format:jsonAtur jumlah dokumen yang akan diurutkan oleh ekspresi pengurutan halus menjadi 1.000.
config=start:0, hit:20, rerank_size:1000Atur jumlah maksimum dokumen yang akan diambil menjadi 100.
config=start:0, hit:20, total_rank_size:100