All Products
Search
Document Center

OpenSearch:Saran drop-down

Last Updated:Apr 02, 2026

Fitur saran drop-down melengkapi kueri pencarian pengguna saat mereka mengetik, dengan menampilkan hingga 10 saran yang sesuai sebelum kueri lengkap dimasukkan. OpenSearch mendukung awalan karakter Tionghoa, ejaan pinyin lengkap, dan input pinyin singkat (huruf pertama) untuk menyediakan pengisian otomatis yang cerdas.

Untuk mengonfigurasi model saran drop-down, menyiapkan daftar blokir, dan menambahkan kueri promosi, lihat Saran drop-down.

Kueri saran drop-down

Endpoint

GET /v3/openapi/apps/{appName}/suggest/{suggestName}/search
Parameter pathDeskripsi
appNameNama aplikasi OpenSearch Anda
suggestNameNama model saran drop-down Anda

Endpoint ini tidak mencantumkan host, header permintaan, dan detail encoding. Untuk format koneksi lengkap, lihat Initiate search requests.

Format yang didukung: JSON

Parameter permintaan

ParameterTipeWajibNilai validBawaanDeskripsi
querySTRINGYaTeks yang dimasukkan di kotak pencarian. Encode nilai tersebut dalam URL jika berisi karakter Tionghoa.
hitINTTidak1–1010Jumlah saran yang akan dikembalikan.
user_idSTRINGTidakID pengguna yang mengirim permintaan. Encode nilai tersebut dalam URL. Kami menyarankan Anda menggunakan user_id yang sama seperti pada permintaan pencarian data Anda.
re_searchSTRINGTidakdisableDiaktifkanMenentukan apakah akan mengambil dokumen dengan mengganti istilah dalam kueri pencarian menggunakan homofon. Atur ke disable untuk menonaktifkan fitur ini.
Catatan: Parameter query di sini berbeda dari parameter query dalam permintaan pencarian data. Dalam permintaan saran drop-down, query adalah teks mentah yang diketik pengguna di kotak pencarian — tidak perlu berupa nama bidang indeks.

Parameter respons

ParameterTipeDeskripsi
request_idSTRINGID permintaan, digunakan untuk troubleshooting.
searchtimeFLOATWaktu yang dibutuhkan mesin untuk menyelesaikan kueri, dalam satuan detik.
suggestionsARRAYSaran yang cocok. Setiap elemen berupa objek yang berisi satu string saran.
errorsARRAYDetail kesalahan. Bidang message berisi deskripsi kesalahan. Lihat Kode kesalahan.

Contoh

Permintaan

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

  • suggest_demo — nama model saran

  • hit=10 — mengembalikan hingga 10 saran

  • query=One-piece dress — teks yang diketik di kotak pencarian

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"}
    ]
}

Respons kesalahan

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

Untuk daftar lengkap kode kesalahan, lihat Kode kesalahan.

Langkah selanjutnya