OpenSearch：Inisiasi Permintaan Pencarian

/v3/openapi/apps/$app_name/search?fetch_fields=name&query=config=format:fulljson&&query=name:'zhangsan'&&sort=id

• $app_name: Nama aplikasi. Aplikasi OpenSearch tingkat lanjut atau standar memiliki versi online dan offline. Saat menginisiasi permintaan pencarian, Anda harus menentukan ID aplikasi yang akan menerima permintaan tersebut. Secara umum, Anda dapat mengatur parameter ini sebagai ID aplikasi online. Namun, Anda juga dapat menentukan ID aplikasi offline untuk melakukan pencarian di aplikasi offline.

• Contoh URL menghilangkan informasi seperti header permintaan dan metode pengkodean.

• Contoh URL juga menghilangkan titik akhir yang digunakan untuk terhubung ke aplikasi OpenSearch.

• Untuk informasi lebih lanjut tentang definisi, penggunaan, dan nilai contoh dari semua parameter permintaan yang digabungkan dalam URL sebelumnya, lihat bagian "Parameter Permintaan" dari topik ini.

HTTP

GET

JSON

Untuk informasi lebih lanjut tentang aturan penggabungan parameter permintaan, lihat Metode Tanda Tangan API OpenSearch V3.

Penggunaan Parameter Permintaan

• query: Anda dapat menentukan beberapa klausa untuk memenuhi berbagai kebutuhan pencarian. Hubungkan klausa dalam parameter query dengan &&.

• fetch_fields: Ukuran data teks yang dikembalikan memiliki dampak besar pada kinerja pencarian. Kami merekomendasikan Anda hanya menentukan bidang yang diperlukan. Parameter fetch_fields yang dikonfigurasi dalam SDK atau operasi API menimpa bidang tampilan default yang ditentukan di konsol OpenSearch.

• qp: Parameter qp yang dikonfigurasi dalam SDK atau operasi API menimpa aturan analisis query yang ditentukan di konsol OpenSearch.

Catatan: Anda dapat melihat proses validasi dan hasil parameter qp di halaman Uji Pencarian di konsol OpenSearch. Anda tidak dapat melihat proses validasi atau hasilnya dengan menggunakan SDK atau operasi API.

• disable: Anda dapat menonaktifkan fitur yang ditentukan oleh parameter seperti qp, summary, first_rank, second_rank, dan re_search.

  Deskripsi

  • Anda dapat menggunakan parameter ini untuk menonaktifkan fitur tertentu selama pencarian.

  • Anda dapat menonaktifkan fitur seperti analisis query, sorotan merah, pengurutan kasar dan halus, serta pencarian ulang.

  Format Parameter

  disable=function[;function]
  function=function_name[:function_param]

  • Contoh:

    • Nonaktifkan fitur analisis query: disable=qp

    • Nonaktifkan fitur koreksi ejaan dalam analisis query: Disable=qp:spell_check. Format: disable=qp:$qp_processor_name. Untuk informasi lebih lanjut, lihat QueryProcessor.

    • Nonaktifkan fitur pencarian ulang: disable=re_search

• first_rank_name: Parameter first_rank_name yang dikonfigurasi dalam SDK atau operasi API menimpa ekspresi pengurutan kasar yang ditentukan di konsol OpenSearch.

• second_rank_name: Parameter second_rank_name yang dikonfigurasi dalam SDK atau operasi API menimpa ekspresi pengurutan halus yang ditentukan di konsol OpenSearch.

• user_id:

  • Saat mengonfigurasi parameter ini dalam permintaan pencarian, Anda harus melakukan pengkodean URL pada nilai parameter ini.

  • Statistik tentang pengunjung unik (UV) dikumpulkan berdasarkan parameter ini saat fitur statistik data digunakan.

  • Jika fitur pengumpulan data digunakan, kami menyarankan Anda mengonfigurasi parameter user_id saat melaporkan data perilaku dengan cara yang sama seperti Anda mengonfigurasi parameter user_id dalam permintaan pencarian.

• abtest: Nilai parameter ini dalam format berikut: abtest=urlencode(scene_tag:urlencode(\$scene),flow_divider:urlencode(\$value)). urlencode adalah fungsi yang digunakan untuk mengkodekan URL.

  • Kami merekomendasikan Anda mengganti flow_divider dengan ID pengguna Anda. Anda juga dapat menggunakan ID atau alamat IP perangkat pengguna Anda. Parameter ini diperlukan.

  • scene_tag: Indikator adegan uji. Jika Anda tidak menentukan parameter ini di konsol OpenSearch, Uji A/B dijalankan berdasarkan permintaan pencarian di semua adegan.

• raw_query:

  Deskripsi

  • Parameter ini digunakan untuk pencarian berbasis prediksi kategori. Hasil pencarian diurutkan berdasarkan prediksi kategori hanya ketika kueri pencarian sama dengan nilai parameter raw_query.

  • Parameter ini digunakan untuk algoritma yang digunakan untuk melatih model seperti model prediksi kategori. Kami merekomendasikan Anda mengonfigurasi parameter ini untuk semua permintaan pencarian.

  • Kami merekomendasikan Anda mengatur parameter ini ke kueri pencarian yang dimasukkan oleh pengguna Anda.

  Format Parameter

  raw_query=content

  • content: Kueri pencarian asli.

• re_search:

  Deskripsi

  • Parameter ini digunakan untuk mengonfigurasi kebijakan pencarian ulang. Kebijakan pencarian ulang hanya dapat dikonfigurasi berdasarkan ambang batas total hit.

  • Anda harus mengaktifkan fitur analisis query jika Anda mengonfigurasi parameter ini.

  • Selama kueri, jika bobot istilah kueri setelah analisis sama, pencarian ulang tidak akan dipicu. Anda perlu mengonfigurasi bobot untuk setiap kategori fitur pengenalan entitas bernama (NER).

  Format Parameter

  re_search=strategy:threshold,params:total_hits#${COUNT}

  • COUNT: Jumlah minimum total hits yang diizinkan jika Anda tidak ingin memicu pencarian ulang. Ketika jumlah total hits kurang dari nilai parameter COUNT, pencarian ulang akan dilakukan.

  • Contoh:

    • re_search=url_encode(strategy:threshold,params:total_hits#6)

• biz:

  Deskripsi

  • Parameter ini digunakan untuk menggambarkan informasi bisnis terkait permintaan, seperti tipe bisnis dari sumber yang mengirimkan permintaan pencarian.

    Format parameter

    biz=type:$TYPE

  • type: Tipe sumber dari mana permintaan pencarian dikirim. Anda dapat menyesuaikan nilai parameter ini. Parameter ini membantu mengumpulkan statistik tentang sumber permintaan dalam laporan.

  • Contoh:

    • biz=type:home_page

• vector_threshold:

• ringkasan:

  • Parameter summary_element_prefix dan summary_element_postfix harus digunakan berpasangan.

  • Parameter summary_element atau pasangan parameter summary_element_prefix dan summary_element_postfix valid. Mana yang dikonfigurasi terakhir akan berlaku.

  • Ringkasan dan pengaturan yang digunakan untuk menyorot istilah dengan warna merah tidak dapat dikonfigurasi secara terpisah.

  • Parameter ringkasan yang dikonfigurasi dalam SDK atau Operasi API akan menimpa pengaturan ringkasan hasil pencarian di konsol OpenSearch.

Parameter respons

• searchtime: Periode waktu yang dibutuhkan oleh mesin untuk menyelesaikan pencarian. Satuan: detik.

• Perbedaan antara parameter total, viewtotal, dan num: Parameter total menunjukkan jumlah hasil yang memenuhi kondisi di mesin untuk satu pencarian tanpa memperhatikan klausa config. Jika jumlah hasilnya besar, nilai parameter total dioptimalkan. Namun, untuk memastikan kinerja dan relevansi pencarian, jumlah hasil yang dikembalikan oleh mesin kurang dari atau sama dengan nilai parameter viewtotal. Jika Anda memerlukan paging, jumlah nilai dari parameter start dan hit harus kurang dari nilai parameter viewtotal. Nilai parameter total umumnya digunakan untuk tampilan. Parameter num menunjukkan jumlah entri yang dikembalikan untuk permintaan pencarian ini. Nilai parameter ini dibatasi oleh parameter start dan hit dalam klausa config dan tidak melebihi nilai parameter hit.

• compute_cost: Array dengan satu elemen peta. Parameter index_name menunjukkan ID aplikasi. Parameter value menunjukkan unit komputasi logis (LCUs) yang dikonsumsi dalam permintaan pencarian ini.

• items: Hasil pencarian. Parameter fields menunjukkan isi dari hasil pencarian.

• variableValue: Nilai dari parameter kustom, seperti nilai dari parameter distance. Parameter variableValue hanya ditampilkan ketika parameter format dalam klausa config adalah xml atau fulljson. Secara default, parameter variableValue tidak ditampilkan ketika parameter format diatur ke json.

• sortExprValues: Skor pengurutan dokumen.

• facet: Statistik yang dikembalikan oleh klausa aggregate.

• Bidang tipe ARRAY: Jika respons dalam format JSON atau fullJSON, data dipisahkan oleh karakter tab (\t). Jika respons dalam format XML, data dipisahkan oleh spasi.

Contoh respons pencarian

Format JSON

{
 "result": {
  "searchtime": 0,009554,
  "total": 1,
  "compute_cost": [
   {
    "index_name": "110247758",
    "value": 0,304
   }
  ],
  "num": 1,
  "viewtotal": 1,
  "items": [
   {
    "variableValue": {

    },
    "sortExprValues": [
     "10000"
    ],
    "property": {

    },
    "attribute": {

    },
    "fields": {
     "size": "XL",
     "discount_price": "9,9",
     "pid": "950",
     "range_age": "18\t25",
     "detail": "Jaket Pria dengan Krah 2021 untuk Musim Semi dan Gugur Gaya Baru Kaum Muda Tipis Jaket Kasual Resleting",
     "index_name": "110247758"
    }
   }
  ],
  "facet": []
 },
 "ops_request_misc": "%7B%22request%5Fid%22%3A%22162642700916781929257960%22%2C%22scm%22%3A%2220140713.110229359..%22%7D",
 "tracer": "",
 "request_id": "162642700916781929257960",
 "errors": [],
 "status": "OK"
}

Contoh respons kesalahan

{
 "result": {
  "searchtime": 0,003999,
  "total": 0,
  "compute_cost": [
   {
    "index_name": "110247758",
    "value": 0,232
   }
  ],
  "num": 0,
  "viewtotal": 0,
  "items": [],
  "facet": []
 },
 "ops_request_misc": "%7B%22request%5Fid%22%3A%22162642716516781913069826%22%2C%22scm%22%3A%2220140713.110229359..%22%7D",
 "tracer": "",
 "request_id": "162642716516781913069826",
 "errors": [
  {
   "code": 6127,
   "message": "Atribut tidak ada."
  }
 ],
 "status": "GAGAL"
}

• Catatan: Nilai parameter status adalah FAIL jika terjadi kesalahan dan tidak ada hasil yang dikembalikan. Nilai parameter status adalah OK jika baik kesalahan maupun hasil dikembalikan. Jika terjadi kesalahan seperti kesalahan server 1000 atau kesalahan 2112, hasil mungkin tetap tersedia. Kesalahan server 1000 menunjukkan bahwa waktu pencarian telah habis. Kesalahan 2112 menunjukkan bahwa indeks yang ditentukan dalam penyortiran halus tidak valid.

Dalam skenario pencarian tradisional, tujuannya adalah untuk mengambil hasil yang paling sesuai dalam waktu sesingkat mungkin. Oleh karena itu, jumlah dokumen yang dapat dimuat dalam hasil dibatasi. Sebagai contoh, hasil dari sebuah pencarian dapat berisi hingga 5.000 dokumen. Namun, dalam beberapa skenario, Anda mungkin memerlukan lebih banyak hasil untuk analisis. Dalam hal ini, Anda dapat menggunakan pencarian gulir untuk mendapatkan lebih banyak hasil pencarian.

Klausa yang didukung

• Klausa query.

• Klausa config: Parameter start tidak valid.

• Klausa filter.

• Klausa sort. Anda dapat menentukan kondisi pengurutan hanya berdasarkan satu field dan field tersebut harus bertipe INT. Versi OpenSearch API dan OpenSearch SDK harus V3.

URL

Pencarian pertama

/v3/openapi/apps/$app_name/search?search_type=scan&scroll=1m&Parameter permintaan

Pencarian selanjutnya

/v3/openapi/apps/$app_name/search?scroll_id=$scroll_id&scroll=1m&Parameter permintaan

• $app_name: Nama aplikasi.

• URL contoh menghilangkan titik akhir yang digunakan untuk terhubung ke aplikasi OpenSearch.

• Dua URL permintaan scroll sebelumnya menghilangkan informasi seperti parameter di header permintaan, parameter permintaan, dan metode pengkodean. Untuk informasi lebih lanjut tentang URL permintaan scroll lengkap, lihat bagian "Contoh pencarian scroll" dari topik ini.

• Pencarian scroll mendukung sejumlah fitur terbatas, dan sebagian besar fitur tidak didukung. Untuk informasi lebih lanjut tentang batasan fitur pencarian scroll, lihat catatan di bagian "Contoh pencarian scroll" dari topik ini.

HTTP

GET

JSON

Permintaan pertama

http://$host/v3/openapi/apps/app_schema_demo/search?query=config=start:0,hit:1,format:fulljson,rerank_size:200&&query=name:'Search'&&sort=+id&&filter=id>0&search_type=scan&scroll=1m&fetch_fields=id;name;phone;int_arr;literal_arr;float_arr;cate_id

Contoh respons sukses

{
  "status": "OK",
  "request_id": "150150574119953661605242",
  "result": {
    "searchtime": 0,005029,
    "total": 1,
    "num": 0,
    "viewtotal": 1,
    "scroll_id": "eJxtUMtuhDAM/BrvOYQC5cABdulvRFFIirsm2TpBavv1Ndut1EMlS36NZ0Y2ZHMxbueceAjIuWCMnrPjRITLyfzZm83y9V QVGT8x80U3PxQNUqieVZV1/an4ItbTUBPSx5wgXqKdvOSbmuKR8ZYjGWWirB4tvToAiX7u3G2eCNK77vnz8GlGPAV6suKBeqxAn0OiTd7NGEnesspyoyFLF6hecn4JUKjVgp0K3FnkfMfIyPoDuYWegX9GeYOpicY9TG8gwOSuBL04X1 MMg3ROwCesLlG6X7a2o=",
    "items": [],
    "facet": []
  },
  "errors": [],
  "tracer": ""
}

Permintaan berikutnya

http://$host/v3/openapi/apps/app_schema_demo/search?fetch_fields=id;name;phone;int_arr;literal_arr;float_arr;cate_id&query=config=start:0,hit:1,format:fulljson,rerank_size:200&&query=name:'Search'&&sort=+id&&filter=id>0&scroll=1m&scroll_id=eJxtUMtuhDAM/BrvOYQC5cABdulvRFFIirsm2TpBavv1Ndut1EMlS36NZ0Y2ZHMxbueceAjIuWCMnrPjRITLyfzZm83y9V+QVGT8x80U3PxQNUqieVZV1/an4ItbTUBPSx5wgXqKdvOSbmuKR8ZYjGWWirB4tvToAiX7u3G2eCNK77vnz8GlGPAV6suKBeqxAn0OiTd7NGEnesspyoyFLF6hecn4JUKjVgp0K3FnkfMfIyPoDuYWegX9GeYOpicY9TG8gwOSuBL04X1+MMg3ROwCesLlG6X7a2o=

Contoh respons sukses

{
  "status": "OK",
  "request_id": "150150574119952551519970",
  "result": {
    "searchtime": 0,006293,
    "total": 1,
    "num": 1,
    "viewtotal": 1,
    "scroll_id": "eJxNT9tugzAM/RrznIRC4YEHaNlvRFFIhteQtE6Qtn39TNdJk2z5dnx8rIPJRdudcqKhl60Uir2Vp06ISv8b6s3QbZCVzpaCdp93XXBzg2wEW9MJ2dWq8q7YVXt0YckDLlBP0WyOw31N8YgYizZEnAUsjkx4VT4k8zexpjiNS/XYHX0NNkWP71BfVyxQjxLUxSfazFH4PYSPnCL3iMniDZq3jN98aFRCgGrZniy8/itkBHWGuYVeQH+B+QzTCUZ1NJ9gj4FVMfrQPr8Y+Hk+dgU14fIDVhtfTw==",
    "items": [
      {
        "fields": {
          "cate_id": "0",
          "float_arr": "0",
          "id": "1",
          "int_arr": "0",
          "literal_arr": "Search",
          "name": "Search",
          "phone": "123****5678",
          "index_name": "app_schema_demo"
        },
        "property": {},
        "attribute": {},
        "variableValue": {},
        "sortExprValues": [
          "1"
        ]
      }
    ],
    "facet": []
  },
  "errors": [],
  "tracer": ""
}