เริ่มต้นใช้งาน GearMind API

GearMind API เป็น API ที่ช่วยให้คุณเข้าถึงความสามารถของ GearMind AI ได้ง่ายดาย คุณสามารถใช้ API นี้ในการสนทนากับ AI และค้นหาข้อมูลจากคลังความรู้เฉพาะของคุณ

ความสามารถของ API

• คุยกับ GearMind AI ผ่าน REST API

• ค้นหาข้อมูลจากคลังความรู้

• รองรับการส่งข้อความในรูปแบบต่าง ๆ

กลุ่มเป้าหมาย

• นักพัฒนาที่ต้องการเพิ่มความฉลาดให้กับแอปพลิเคชัน

• ผู้ที่ต้องการใช้งาน GearMind AI ในรูปแบบต่าง ๆ

---

1. การตั้งค่าการใช้งาน

1.1 การยืนยันตัวตน (Authentication)

การเข้าถึง GearMind API ต้องใช้ Bearer token สำหรับการยืนยันตัวตน คุณสามารถสร้าง Token ได้จากเมนูการตั้งค่าภายในแอป GearMind ดังนี้:

• เข้าไปที่เมนู "การตั้งค่า"

• เข้าไปที่ "จัดการคีย์ API"

• ตั้งชื่อคีย์ตามที่คุณต้องการ เช่น ชื่อเล่น หรือชื่อที่เป็นทางการ

• กดสร้างคีย์ GearMind จะแสดง Secret Key ให้เก็บไว้ใช้ในการยืนยันตัวตน (อย่าลืมเก็บรักษาไว้ดี ๆ เพราะไม่สามารถดูกลับได้)

การใช้งาน Authorization Header:

Authorization: Bearer YOUR_API_KEY

---

2. การเรียกใช้งาน API

2.1 Endpoint

• Endpoint: https://gearmind.geworn.cloud/api/v1/chat

• Method: POST

• Content-Type: application/json

2.2 ตัวอย่างคำขอ (Request)

{
    "messages": [
        {
            "role" : "user",
            "content" : "สวัสดีครับ"
        }
    ]
}

2.3 ตัวอย่างคำตอบ (Response)

{
    "role": "assistant",
    "content": "สวัสดีครับ! 😊 มีอะไรให้ผมช่วยครับ?"
}

---

3. การจัดการข้อความ

ใน Request Body ต้องประกอบไปด้วย:

• messages: เป็น array ของข้อความที่ส่งในแต่ละครั้ง

• role: บทบาทของข้อความ (เช่น user สำหรับข้อความที่คุณส่ง หรือ assistant สำหรับข้อความจาก AI)

• content: เนื้อหาของข้อความ

ตัวอย่างการส่งคำถามที่ซับซ้อน:

{
    "messages": [
        {
            "role": "user",
            "content": "หาให้หน่อยครับ IsolationTestFailed คืออะไร"
        }
    ]
}

ตัวอย่างคำตอบจาก AI:

{
    "role": "assistant",
    "content": "\"IsolationTestFailed\" คือ error ที่เกิดจากค่าความต้านทานของฉนวนต่ำ..."
}

---

4. เงื่อนไขการใช้งาน

• ทุกคำขอจะต้องมี Authorization header พร้อมกับ Bearer token

• ข้อความใน request body ต้องมีโครงสร้างตามที่ระบุ

• Response จะมาในรูปแบบ JSON เสมอ

---

หากต้องการข้อมูลเพิ่มเติมเกี่ยวกับการใช้งาน หรือต้องการความช่วยเหลือเพิ่มเติม สามารถติดต่อฝ่ายสนับสนุนของ GearMind ได้ทุกเมื่อ!

---