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