API · ค้นหา
ตัวกรองทั้งแถบ
ทุกตัวกรองที่ชุดข้อมูลนี้มี พร้อมทุกค่าและจำนวน ในคำขอเดียว
ทุกเส้นอยู่ใต้ https://api.intent-search.dev และยืนยันตัวตนด้วย Authorization: Bearer nsk_… · คีย์บอกเองว่าชุดข้อมูลไหน
เนื้อคำขอ
| ฟิลด์ | ความหมาย |
|---|---|
querystring | นับภายใต้คำค้นนี้ · ไม่ใส่คือนับทั้งชุดข้อมูล |
filtersobject | สิ่งที่ผู้ใช้ติ๊กไว้แล้ว รูปเดียวกับ /v1/search |
sizenumber | ค่าต่อตัวกรองสูงสุดกี่ค่า 1 ถึง 10,000 · ค่าเริ่มต้นคือทุกค่า · ลำดับ value ตัดหลังเรียงตามพจนานุกรมไทย |
order"value" | "count" | "key" | value ตามพจนานุกรมไทย (ค่าเริ่มต้น) · count มากไปน้อย · key ลำดับที่ไล่หน้าด้วย after ได้ |
ตัวอย่าง
curl -X POST "https://api.intent-search.dev/v1/filters" \
-H "Authorization: Bearer $NS_KEY" \
-H "Content-Type: application/json" \
-d '{
"query": "ครีม",
"order": "count"
}'คำตอบ
{
"counted_over": 1,
"filters": [
{
"field": "brand",
"kind": "terms",
"order": "count",
"values": [
{
"value": "Aurora",
"count": 1
}
],
"other": 0,
"other_values": 0,
"missing": 0
},
{
"field": "in_stock",
"kind": "terms",
"order": "count",
"values": [
{
"value": "false",
"count": 1
}
],
"other": 0,
"other_values": 0,
"missing": 0
}
]
}สิ่งที่ควรรู้
ใช้ตอนวาดแถบตัวกรองครั้งแรก หรือทำหน้ารวมยี่ห้อทั้งหมด · ผลค้นหาปกติพกตัวกรองมาใน filters + aggregations อยู่แล้ว (ยี่สิบค่าแรกของแต่ละตัว)
ชุดข้อมูลที่ยังไม่มีตัวกรองตอบ {"counted_over": 0, "filters": []} · ประกาศตัวกรองด้วย filter ของ PUT /v1/schema
label มาเมื่อเจ้าของตั้งชื่อที่แสดงไว้ · other_values คือจำนวนค่าที่ไม่ได้อยู่ในรายการ ถ้ามากกว่า 0 จะมี note บอกว่าไล่ต่อทีละหน้าที่ /v1/filters/:field · เส้นนี้ไม่มี next เพราะถามหลายฟิลด์พร้อมกัน จึงไม่มีลำดับเดียวให้ไล่
other คือจำนวนระเบียนที่ถือค่าที่ไม่ได้อยู่ในรายการ นับหนึ่งครั้งต่อหนึ่งค่า ระเบียนที่มีสองยี่ห้อจึงนับสอง ใช้แทนจำนวนค่าไม่ได้ · missing คือจำนวนระเบียนที่ไม่มีค่าในตัวกรองนั้นเลย
ข้อผิดพลาดของเส้นนี้
| ฟิลด์ | ความหมาย |
|---|---|
400 | query ไม่ใช่สตริง · filters ผิดรูปหรือไม่ใช่ตัวกรอง · size/order นอกช่วง · มีคีย์ที่เส้นนี้ไม่รับ · ส่ง after (ใช้ได้กับ /v1/filters/:field เท่านั้น) |
รูปของข้อผิดพลาด อัตราต่อวินาที และการลดทอน (degraded) อยู่ที่ ข้อผิดพลาดและเพดาน
POST /v1/filters/:fieldค่าทั้งหมดของตัวกรองหนึ่งตัว