Saran drop-down query - OpenSearch

Fitur saran drop-down adalah salah satu fitur dasar OpenSearch. Fitur ini memberikan rekomendasi query pencarian saat Anda memasukkan teks di kotak pencarian, sehingga memungkinkan Anda menemukan query yang diinginkan sebelum menyelesaikan seluruh input. Hal ini membantu Anda mendapatkan hasil pencarian yang relevan lebih cepat. Fitur saran drop-down OpenSearch mendukung awalan karakter Cina, ejaan pinyin lengkap, serta huruf pertama dari ejaan pinyin singkat. Dengan demikian, fitur ini membantu mengimplementasikan rekomendasi pencarian cerdas berdasarkan konten yang dimasukkan. Untuk mengonfigurasi saran drop-down yang dipersonalisasi sesuai kebutuhan bisnis Anda, Anda perlu menyelesaikan konfigurasi sederhana di konsol OpenSearch. Selain itu, konsol OpenSearch memungkinkan Anda mengonfigurasi daftar hitam dan rekomendasi pencarian untuk meningkatkan kontrol dan personalisasi terhadap saran drop-down. Untuk informasi lebih lanjut tentang cara menggunakan fitur ini, lihat Saran Drop-down.

URL

/v3/openapi/apps/{appName}/suggest/{suggestName}/search

Ganti parameter appName dengan nama aplikasi OpenSearch Anda.
Ganti parameter suggestName dengan nama model saran drop-down Anda.
Contoh URL menghilangkan informasi seperti parameter dalam header permintaan dan metode pengkodean.
Contoh URL juga menghilangkan titik akhir yang digunakan untuk terhubung ke OpenSearch.

Format yang Didukung

JSON

Metode Permintaan HTTP yang Didukung

GET

Parameter Permintaan

Parameter	Tipe	Diperlukan	Nilai valid	Nilai default	Deskripsi
query	STRING	Ya			Kata kunci query. Jika kata kunci tersebut mengandung karakter Cina, lakukan pengkodean URL pada nilai parameter ini.
hit	INT	Tidak	[1-10]	10	Jumlah saran drop-down yang akan ditampilkan.
user_id	STRING	Tidak			ID pengguna yang mengirim permintaan saran drop-down saat ini. Lakukan pengkodean URL pada nilai parameter ini. Kami merekomendasikan Anda menggunakan nilai parameter user_id dalam permintaan API yang dikirim untuk mencari data. Untuk informasi lebih lanjut, lihat Mengajukan permintaan pencarian.
re_search	STRING	Tidak			Menentukan apakah akan mengambil dokumen dengan mengganti istilah dalam query pencarian dengan homofon. Secara default, fitur ini diaktifkan. Untuk menonaktifkan fitur ini, atur parameter re_search ke disable.

Catatan: Parameter query dalam permintaan API untuk saran drop-down berbeda dari parameter query dalam permintaan API untuk pencarian data. Parameter query dalam permintaan API untuk saran drop-down menunjukkan teks yang dimasukkan pengguna di kotak pencarian. Teks tersebut tidak harus berupa nama bidang indeks.

Parameter Respons

Parameter	Tipe	Deskripsi
request_id	STRING	ID permintaan, yang digunakan untuk pemecahan masalah.
searchtime	FLOAT	Periode waktu yang diperlukan oleh mesin untuk menyelesaikan query, dalam satuan detik.
suggestions	ARRAY	Saran drop-down yang cocok. Setiap elemen dalam array ini adalah saran drop-down.
errors	ARRAY	Informasi kesalahan, di mana parameter message menunjukkan pesan kesalahan. Untuk informasi lebih lanjut tentang kode kesalahan, lihat Kode kesalahan.

Contoh

Contoh permintaan API untuk saran drop-down, yang menghilangkan informasi seperti parameter dalam header permintaan dan metode pengkodean:

http://$host/v3/openapi/apps/app_demo/suggest/suggest_demo/search?hit=10&query=One-piece dress&user_id=xxx

Contoh respons sukses:

{
    "request_id": "150116615820104116121674",
    "searchtime": 0.002654,
    "suggestions": [
        {
            "suggestion": "One-piece dress"
        },
        {
            "suggestion": "One-piece dress for Spring"
        },
        {
            "suggestion": "One-piece dress for art enthusiasts"
        }
    ]
}

Contoh respons kesalahan:

{
    "request_id": "150116635320104116122572",
    "searchtime": 0.037484,
    "suggestions": [],
    "errors": [
        {
            "code": 2551,
            "message": "suggester not found"
        }
    ]
}