API · ตั้งค่า
เปลี่ยนโครง
PUT/v1/schemaคีย์ service
บอกว่าฟิลด์ไหนค้นได้ กรองได้ เรียงได้ — ลองดูผลก่อนด้วย dry_run
ทุกเส้นอยู่ใต้ https://api.intent-search.dev และยืนยันตัวตนด้วย Authorization: Bearer nsk_… · คีย์บอกเองว่าชุดข้อมูลไหน
เนื้อคำขอ
| ฟิลด์ | ความหมาย |
|---|---|
fieldsarray | รายการฟิลด์ทั้งหมด ฟิลด์ที่ไม่อยู่ในรายการเลิกลงดัชนี (ยังเก็บและส่งกลับตามเดิม) |
fields[].typeต้องมี"text" | "number" | "date" | "boolean" | ชนิดของค่า |
fields[].searchboolean | object | true หรือ {"weight": 2} ค้นด้วยคำได้ และคำในฟิลด์นี้มีน้ำหนักเท่าไหร่ · ข้อความเท่านั้น |
fields[].filterboolean | object | true เป็นตัวกรองแบบรายการ (ข้อความ true/false) หรือรายเดือน (วันที่) · ตัวเลขต้องบอกช่วง {"kind":"range","ranges":[{"to":100},{"from":100}]} · ใส่ label เพื่อตั้งชื่อที่แสดงได้ · วันที่เลือกขั้นได้ {"kind":"date","interval":"week"} — minute hour day week month quarter year · ขั้นที่ทั้งชุดข้อมูลมีช่องที่มีสินค้าเกิน 200 ช่องได้ 400 ที่บอกจำนวนช่องและขั้นที่ใกล้ที่สุดที่พอ และโครงไม่ถูกเปลี่ยน |
fields[].sortboolean | เรียงได้ · ตัวเลข วันที่ true/false เท่านั้น ข้อความไม่มีลำดับให้เรียง |
id_fieldstring | คอลัมน์ที่เป็น id ของแต่ละระเบียน · เปลี่ยนได้เมื่อชุดข้อมูลยังไม่มีระเบียน |
dry_runboolean | ตอบว่าจะเปลี่ยนอะไรทีละฟิลด์ และต้องเขียนระเบียนทุกตัวใหม่หรือไม่ โดยยังไม่เปลี่ยนอะไร · อยู่ในเนื้อคำขอเท่านั้น ?dry_run=true ใน URL ได้ 400 และไม่มีอะไรเปลี่ยน |
ตัวอย่าง
curl -X PUT "https://api.intent-search.dev/v1/schema" \
-H "Authorization: Bearer $NS_KEY" \
-H "Content-Type: application/json" \
-d '{
"fields": [
{
"name": "product_name",
"type": "text",
"search": {
"weight": 3
}
},
{
"name": "brand",
"type": "text",
"search": true,
"filter": {
"kind": "terms",
"label": "ยี่ห้อ"
}
},
{
"name": "price",
"type": "number",
"sort": true,
"filter": {
"kind": "range",
"ranges": [
{
"to": 500
},
{
"from": 500
}
]
}
},
{
"name": "in_stock",
"type": "boolean",
"filter": true,
"sort": true
}
],
"dry_run": true
}'คำตอบ
{
"dry_run": true,
"changes": [
{
"field": "product_name",
"from": {
"name": "product_name",
"type": "text",
"search": {
"weight": 2
},
"filter": false,
"sort": false
},
"to": {
"name": "product_name",
"type": "text",
"search": {
"weight": 3
},
"filter": false,
"sort": false
}
},
{
"field": "brand",
"from": {
"name": "brand",
"type": "text",
"search": {
"weight": 1
},
"filter": {
"kind": "terms"
},
"sort": false
},
"to": {
"name": "brand",
"type": "text",
"search": {
"weight": 1
},
"filter": {
"kind": "terms",
"label": "ยี่ห้อ"
},
"sort": false
}
},
{
"field": "price",
"from": {
"name": "price",
"type": "number",
"search": false,
"filter": false,
"sort": true
},
"to": {
"name": "price",
"type": "number",
"search": false,
"filter": {
"kind": "range",
"ranges": [
{
"to": 500
},
{
"from": 500
}
]
},
"sort": true
}
}
],
"reindex": true,
"documents": 3
}สิ่งที่ควรรู้
ไม่ต้องส่งข้อมูลใหม่ — การเปลี่ยนที่กระทบดัชนีจะเขียนระเบียนทุกตัวลงสำเนาใหม่ ระหว่างนั้นการค้นยังตอบจากของเดิม แล้วสลับทีเดียวเมื่อเสร็จ ถ้าล้มเหลวของเดิมยังอยู่ครบและโครงไม่ถูกเปลี่ยน · การเปลี่ยนแค่ label ไม่ต้องเขียนใหม่
ไม่ใส่ dry_run คือเปลี่ยนจริง คำตอบคือโครงใหม่แบบเดียวกับ GET /v1/schema พร้อม reindexed จำนวนระเบียนที่เขียนใหม่
คอลัมน์หมวดที่ PUT /v1/categories สร้างถูกเก็บไว้เสมอ ไม่ต้องใส่ในรายการ
ข้อผิดพลาดของเส้นนี้
| ฟิลด์ | ความหมาย |
|---|---|
400 | เรียงด้วยข้อความ · ค้นด้วยคำในตัวเลข · ตัวกรองตัวเลขไม่มีช่วง · ชื่อฟิลด์ซ้ำ มีช่องว่าง หรือขึ้นต้นด้วย _ / ns_ · มีคีย์ที่ไม่รู้จัก · มีพารามิเตอร์ใน URL (ตัวเลือกทุกตัวอยู่ในเนื้อคำขอ) |
409 | เปลี่ยน id_field ขณะที่ชุดข้อมูลมีระเบียนแล้ว · เปิดการค้นด้วยความหมายไว้แต่โครงใหม่ไม่มีฟิลด์ข้อความ |
502 | เขียนสำเนาใหม่ไม่สำเร็จ — โครงเดิมยังใช้อยู่ |
รูปของข้อผิดพลาด อัตราต่อวินาที และการลดทอน (degraded) อยู่ที่ ข้อผิดพลาดและเพดาน
GET /v1/synonymsคำพ้อง