API · ตั้งค่า
โครงของชุดข้อมูล
GET/v1/schemaคีย์ service
ฟิลด์ไหนค้นได้ กรองได้ เรียงได้ ฟิลด์ไหนเก็บไว้เฉย ๆ และมีระเบียนค้างอยู่เท่าไหร่
ทุกเส้นอยู่ใต้ https://api.intent-search.dev และยืนยันตัวตนด้วย Authorization: Bearer nsk_… · คีย์บอกเองว่าชุดข้อมูลไหน
ตัวอย่าง
curl "https://api.intent-search.dev/v1/schema" \
-H "Authorization: Bearer $NS_KEY"คำตอบ
{
"id_field": "id",
"fields": [
{
"name": "product_name",
"type": "text",
"search": {
"weight": 2
},
"filter": false,
"sort": false
},
{
"name": "brand",
"type": "text",
"search": {
"weight": 1
},
"filter": {
"kind": "terms"
},
"sort": false
},
{
"name": "price",
"type": "number",
"search": false,
"filter": false,
"sort": true
},
{
"name": "in_stock",
"type": "boolean",
"search": false,
"filter": {
"kind": "terms"
},
"sort": true
}
],
"stored_only": [
"raw"
],
"documents": {
"stored": 3,
"pending": 0
}
}สิ่งที่ควรรู้
fields เขียนเป็นความสามารถ ไม่ใช่ชนิดของเอนจิน: search (พร้อมน้ำหนัก) filter และ sort ของแต่ละฟิลด์ · type คือชนิดของค่า text number date boolean
stored_only คือคอลัมน์ที่ระเบียนมีแต่ไม่ได้ลงดัชนี ยังเก็บครบและส่งกลับมาพร้อมผล · generated คือคอลัมน์ที่ระบบเขียนให้ เช่นหมวดจาก PUT /v1/categories
PUT /v1/schemaเปลี่ยนโครง