OpenSearch:Pemrosesan pencarian

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

• $app_name: Nama aplikasi. Edisi Premium dan Standard Edition merupakan versi multi-aplikasi. Anda harus menentukan nama aplikasi untuk mengakses aplikasi yang sedang dalam layanan.

• URL di atas menghilangkan header permintaan, encoding, dan faktor lainnya.

• URL di atas menghilangkan alamat host untuk mengakses aplikasi.

• Untuk definisi, penggunaan, dan contoh parameter kueri dalam URL di atas, lihat bagian **Parameter kueri** di bawah ini.

HTTP

GET

JSON

Untuk detail cara menggabungkan parameter kueri, lihat dokumen mekanisme penandatanganan API v3.

Penggunaan parameter kueri

• query: Parameter `query` dapat menggabungkan beberapa klausa untuk memenuhi beragam kebutuhan pencarian. Klausa dalam parameter `query` dihubungkan oleh &&.

• fetch_fields: Ukuran data teks yang dikembalikan berdampak signifikan terhadap kinerja. Ambil hanya bidang yang diperlukan. Jika parameter ini dikonfigurasi di SDK atau API, maka akan menggantikan konfigurasi terkait di Konsol.

• qp: Jika parameter ini dikonfigurasi di SDK atau API, maka akan menggantikan konfigurasi terkait di Konsol.

Catatan: Anda dapat melihat efek dan hasil `qp` pada halaman uji pencarian di Konsol. API dan SDK saat ini tidak mengekspos informasi ini.

• disable: Anda dapat menggunakan parameter ini untuk menonaktifkan fitur-fitur untuk parameter seperti `qp`, `summary`, `first_rank`, `second_rank`, dan `re_search`.

  Deskripsi fitur

  • Parameter ini mengontrol apakah fitur tertentu dinonaktifkan selama kueri.

  • Anda dapat menonaktifkan fitur seperti analisis query, penyorotan, pengurutan kasar dan presisi, serta penelusuran ulang.

  Format parameter:

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

  • Contoh:

    • Untuk menonaktifkan analisis query, atur `disable=qp`.

    • Untuk menonaktifkan fitur `spell_check` dalam analisis query, atur `disable=qp:spell_check`.

    • Untuk menonaktifkan penelusuran ulang, atur `disable=re_search`.

• first_rank_name: Jika parameter ini dikonfigurasi di SDK atau API, maka akan menggantikan konfigurasi terkait di Konsol.

• second_rank_name: Jika parameter ini dikonfigurasi di SDK atau API, maka akan menggantikan konfigurasi terkait di Konsol.

• user_id:

  • Saat Anda mengatur parameter ini dalam permintaan pencarian, nilai `user_id` harus di-URL-encode.

• raw_query:

  Deskripsi fitur

  • Parameter ini menentukan kueri pencarian asli yang dimasukkan oleh end user.

  Format parameter:

  raw_query=content

  • content: Kueri pencarian asli.

• re_search:

  Deskripsi fitur

  • Parameter ini menetapkan kebijakan penelusuran ulang. Saat ini, Anda hanya dapat menetapkan kebijakan berdasarkan ambang batas total hits.

  Format parameter:

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

  • COUNT: Batas atas untuk `total_hits` yang memicu penelusuran ulang. Penelusuran ulang dilakukan jika `total_hits` kurang dari COUNT.

  • Contoh:

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

• biz:

  Deskripsi fitur

  • Parameter ini menjelaskan informasi bisnis terkait permintaan, seperti jenis bisnis tempat permintaan berasal.

    Format parameter:

    biz=type:$TYPE

  • type: Jenis traffic. Anda dapat menentukan nilainya. Anda dapat menggunakan nilai ini nanti untuk membedakan sumber traffic berbeda dalam laporan.

  • Contoh:

    • biz=type:home_page

• vector_threshold:

• summary:

  • Parameter `summary_element_prefix` dan `summary_element_postfix` harus diatur secara bersamaan.

  • Parameter `summary_element` dan pasangan (`summary_element_prefix`, `summary_element_postfix`) saling memengaruhi. Konfigurasi yang muncul belakangan akan menggantikan yang muncul lebih awal.

  • Saat ini, Anda tidak dapat mengonfigurasi ringkasan dan penyorotan secara terpisah.

  • Jika parameter ini dikonfigurasi di SDK atau API, maka akan menggantikan konfigurasi terkait di Konsol.

Hasil pengembalian

• searchtime: Waktu, dalam detik, yang dikonsumsi engine untuk memproses permintaan.

• Perbedaan antara `total`, `viewtotal`, dan `num`: `total` adalah jumlah hasil yang memenuhi kondisi kueri di engine, tanpa mempertimbangkan klausa `config`. Nilai ini merupakan perkiraan ketika ada banyak hasil dan umumnya digunakan untuk tujuan tampilan. `viewtotal` adalah jumlah maksimum hasil yang dikembalikan engine karena alasan kinerja dan relevansi. Untuk melakukan paging melalui hasil, `start` + `hit` harus kurang dari `viewtotal`. `num` adalah jumlah aktual item yang dikembalikan untuk permintaan saat ini. Nilai ini dibatasi oleh parameter `start` dan `hit` dalam klausa `config` dan tidak melebihi nilai `hit`.

• compute_cost: Array yang berisi satu elemen map. `index_name` adalah ID aplikasi, dan `value` adalah jumlah Logic Compute Unit (LCU) yang dikonsumsi oleh kueri.

• items: Berisi data yang diambil. Parameter fields berisi konten hasil pencarian.

• variableValue: Hasil pengembalian parameter kustom, seperti nilai jarak. Node `variableValue` hanya ditampilkan jika format dalam klausa config diatur ke xml atau fulljson. Secara default, node ini tidak ditampilkan dalam format `json`.

• sortExprValues: Skor pengurutan dokumen terkait.

• facet: Menyimpan informasi yang dikembalikan oleh klausa Aggregate.

• Tipe bidang array: Jika bidang array dikembalikan dalam format `json` atau `fulljson`, datanya dipisahkan oleh `\t`. Jika dikembalikan dalam format `xml`, datanya dipisahkan oleh spasi.

Contoh pencarian

Respons 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": "Men's jacket lapel 2021 spring and autumn new youth thin top casual zipper jacket",
     "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"
}

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": "Attribute not exist."
  }
 ],
 "status": "FAIL"
}

• Catatan: Status `FAIL` menunjukkan terjadi kesalahan dan tidak ada hasil yang dikembalikan. Namun, dalam beberapa kasus, baik kesalahan maupun hasil dapat dikembalikan. Dalam kasus tersebut, statusnya adalah `OK`. Misalnya, jika terjadi `kesalahan server 1000` (timeout pencarian) atau kesalahan `2112` (indeks untuk pengurutan presisi tidak ditentukan), hasil mungkin tetap dikembalikan.

Pencarian tradisional dirancang untuk mengambil hasil paling relevan dalam waktu sesingkat mungkin. Oleh karena itu, jumlah hasil pencarian dibatasi. Misalnya, metode pencarian dapat mengambil maksimal 5.000 dokumen. Dalam beberapa skenario, Anda mungkin perlu mengambil lebih banyak hasil untuk analisis. Anda dapat menggunakan API scroll untuk mengambil jumlah hasil yang lebih besar.

Klausa yang didukung

• Klausa `query`.

• Klausa `config`. Parameter `start` tidak valid dalam klausa ini.

• Klausa `filter`.

• Klausa `sort`. Klausa ini hanya mendukung pengurutan berdasarkan satu bidang bertipe `int` dan terbatas pada API v3 dan SDK.

URL

Kueri awal

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

Kueri berikutnya

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

• $app_name: Nama aplikasi.

• URL di atas menghilangkan alamat host untuk mengakses aplikasi.

• URL permintaan scroll di atas menghilangkan header permintaan, konten parameter kueri, encoding, dan faktor lainnya. Untuk URL permintaan scroll lengkap, lihat contoh di bawah.

• Metode scroll memiliki fungsionalitas terbatas dan tidak mendukung sebagian besar fitur. Untuk informasi lebih lanjut tentang batasan spesifik, lihat catatan di bagian bawah.

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

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=

Nilai pengembalian

{
  "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": ""
}