API · ค้นหา
คำแนะนำระหว่างพิมพ์
เติมคำให้กล่องค้นหา ตั้งแต่ตัวอักษรแรก และสินค้าอันดับต้นในคำขอเดียวกัน
ทุกเส้นอยู่ใต้ https://api.intent-search.dev และยืนยันตัวตนด้วย Authorization: Bearer nsk_… · คีย์บอกเองว่าชุดข้อมูลไหน
พารามิเตอร์ใน URL
| ฟิลด์ | ความหมาย |
|---|---|
qต้องมีstring | สิ่งที่พิมพ์ไปแล้ว · ว่างได้ (ได้รายการว่าง) |
nnumber | จำนวนคำแนะนำ 1 ถึง 50 · ค่าเริ่มต้น 10 |
fromstring | แหล่งของคำแนะนำ ไม่ใช่เคอร์เซอร์ — titles (ข้อความจากระเบียนของคุณ ค่าเริ่มต้น) queries (คำที่คนค้นในชุดข้อมูลนี้) dictionary (พจนานุกรม) คั่นด้วยจุลภาคได้ ตามลำดับที่ต้องการ |
fieldstring | ฟิลด์ข้อความที่ใช้เติมคำ · ค่าเริ่มต้นคือฟิลด์ข้อความที่น้ำหนักสูงสุดในโครง (มักเป็นชื่อสินค้า) |
productsnumber | ขอสินค้าอันดับต้นที่ตรงกับสิ่งที่พิมพ์มาด้วย 0 ถึง 20 · ค่าเริ่มต้น 0 · นับเป็นการค้นหนึ่งครั้ง |
ตัวอย่าง
curl "https://api.intent-search.dev/v1/suggest?q=เซรั่&n=5&products=3" \
-H "Authorization: Bearer $NS_KEY"คำตอบ
{
"suggestions": [
{
"text": "เซรั่มวิตามินซี",
"from": "titles"
}
],
"sources": [
"titles"
],
"products": [
{
"id": "sku-1042",
"score": 3.18,
"matched": "words",
"words": "typed",
"sort": [
3.18,
"sku-1042"
],
"document": {
"product_name": "เซรั่มวิตามินซี ลดริ้วรอย",
"brand": "Aurora",
"price": 890,
"in_stock": true,
"raw": {
"supplier": "S-12",
"rank": 4
}
}
}
]
}สิ่งที่ควรรู้
คำแนะนำอ่านจากข้อความในระเบียนของคุณ ตั้งแต่ตรงที่พิมพ์ไปจนถึงช่องว่างถัดไป เรียงตามจำนวนระเบียนที่มี — กระถา ได้ กระถางต้นไม้ ไม่ใช่ชื่อสินค้าทั้งชื่อ · พิมพ์จบคำแล้ว (ระบบ) ได้คำถัดไปมาด้วย (ระบบ ค้นหา) · อ่านจาก n ระเบียนที่ตรงที่สุด ระเบียนที่ให้คำเดียวกันจึงทำให้รายการสั้นกว่า n ได้
products คือผลของ /v1/search สำหรับสิ่งที่พิมพ์อยู่ รูปเดียวกันทุกอย่าง — แถบสินค้าใต้คำแนะนำได้ในคำขอเดียว ไม่ต้องยิงสองเส้นแข่งกันทุกการกดแป้น
ใช้ได้ตามแพ็กเกจโดยไม่ต้องขอเปิด · เมื่อโควตาหมดเส้นนี้ถูก ปฏิเสธ ด้วย 402 ไม่ใช่ลดทอน (degraded) เพราะรายการว่างหน้าตาเหมือนดรอปดาวน์ปกติ การบอกตรง ๆ ทำให้ฝั่งคุณหยุดยิงได้
เป็น GET จึงแคชได้ และ preflight ของเบราว์เซอร์ถูกจำไว้สองชั่วโมง การกดแป้นหลังหยุดพิมพ์นาน ๆ จึงไม่ต้องรอ preflight ใหม่
ข้อผิดพลาดของเส้นนี้
| ฟิลด์ | ความหมาย |
|---|---|
400 | ไม่มี q · n หรือ products ไม่ใช่จำนวนเต็มในช่วง · from ไม่ใช่แหล่งที่มี · field ไม่ใช่ฟิลด์ข้อความ · มีพารามิเตอร์ที่เส้นนี้ไม่อ่าน |
402 | แพ็กเกจไม่มีคำแนะนำ หรือโควตาของเดือนนี้หมด |
429 | ยิงถี่เกินอัตราของแพ็กเกจ |
รูปของข้อผิดพลาด อัตราต่อวินาที และการลดทอน (degraded) อยู่ที่ ข้อผิดพลาดและเพดาน
POST /v1/filtersตัวกรองทั้งแถบ