คู่มือบูรณาการ
ตรวจสอบสิทธิ์ ค้นหา และอ่านผลลัพธ์
1. การรับรองความถูกต้อง
โทรจากเซิร์ฟเวอร์ของคุณด้วยส่วนหัว api-key และ Content-Type: application/json เก็บกุญแจของคุณไว้เป็นส่วนตัว
เปิดคีย์ API2. ขอพารามิเตอร์
คำขอรองรับเฉพาะการสืบค้น การนับ และ search_lang แบบสอบถามยอมรับคำถามหรือคำหลักที่เป็นภาษาธรรมชาติ
| สนาม | ชนิดข้อมูล | ที่จำเป็น | คำอธิบาย |
|---|---|---|---|
| query | string | ใช่ | คำถามค้นหาหรือคำสำคัญ ต้องไม่ว่างเปล่า |
| count | integer | เลขที่ | จำนวนผลลัพธ์ที่ต้องการ ละเว้นหรือส่งผ่าน 0 เพื่อใช้ค่าเริ่มต้นของบริการ |
| search_lang | string | เลขที่ | ค้นหาภาษา เช่น zh-hans บริการทำให้ zh เป็น zh-hans เป็นมาตรฐาน คลิกแถวนี้เพื่อดูรายการที่รองรับ |
3. เรียกการค้นหา API
POST
https://api.starsg.ai/api/product/websearch/searchแทนที่ YOUR_API_KEY และตั้งค่าการค้นหาเป็นข้อความค้นหาของคุณ count และ search_lang เป็นทางเลือก
curl -X POST 'https://api.starsg.ai/api/product/websearch/search' \
-H 'api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"query": "北京今天的天气",
"count": 5,
"search_lang": "zh-hans"
}'ส่งอ็อบเจ็กต์ JSON โดยตรง โดยไม่ต้องใช้ตัวห่อหุ้มหรือ /v1. เพิ่มเติม
4. อ่านผลลัพธ์
ตรวจสอบความสำเร็จก่อน เมื่อประสบความสำเร็จ ให้อ่าน data.references และ data.data หากเกิดความล้มเหลว ให้ตรวจสอบ errorCode และ errorMsg เนื้อหาเว็บด้านล่างนี้เป็นเพียงภาพประกอบ
การตอบสนองที่ประสบความสำเร็จ
{
"success": true,
"data": {
"references": [
{
"website": "example.com",
"logo": "https://example.com/favicon.ico",
"title": "ตัวอย่างข่าวสมาร์ทโฮม",
"url": "https://example.com/article",
"summary": "สรุปผลการค้นหาอยู่ที่นี่",
"published": "",
"extra": {}
}
],
"data": [
"สรุปผลการค้นหาอยู่ที่นี่"
]
},
"errorCode": null,
"errorMsg": null
}data.references | การอ้างอิงเว็บพร้อมชื่อเรื่อง ลิงก์ และบทสรุป |
data.data | รายการข้อความผลลัพธ์ที่ซ้อนอยู่ภายในออบเจ็กต์ข้อมูลภายนอก |
references[].website / logo | ชื่อเว็บไซต์หรือโดเมนและโลโก้ URL |
references[].title / url / summary | ชื่อผลลัพธ์ หน้าต้นฉบับ URL และสรุป |
references[].published / extra | วันที่ตีพิมพ์และข้อมูลเพิ่มเติม อาจจะว่างเปล่า |
success=true ที่มีการอ้างอิงว่างและอาร์เรย์ข้อมูล หมายความว่าไม่พบผลลัพธ์ที่ถูกต้อง ลองใช้คำหลักอื่นหรือภาษาการค้นหาอื่น อย่าถือว่ามันเป็นความล้มเหลว API
การตอบสนองข้อผิดพลาด
{
"success": false,
"data": null,
"errorCode": "PARAM_INVALID",
"errorMsg": "query is required"
}ข้อผิดพลาดทั่วไปและขั้นตอนถัดไป
PARAM_INVALID | ตรวจสอบ JSON และสอบถาม แก้ไขพารามิเตอร์ก่อนลองอีกครั้ง |
ค้นหา_ล้มเหลว | การค้นหาล้มเหลว ลองอีกครั้งในภายหลังโดยจำกัดจำนวนครั้ง สำหรับความล้มเหลวอย่างต่อเนื่อง โปรดประหยัดเวลาในการโทรและขอตัวระบุเพื่อรับการสนับสนุน |