สร้าง Conversation ID

ใช้สำหรับสร้างและรับ conversation_id ซึ่งเป็นรหัสสำหรับระบุการสนทนาระหว่าง ผู้ใช้ กับ Agent โดยคุณสมบัติของผู้ใช้, หน่วยความจำระยะยาว และหน่วยความจำระยะสั้น จะถูกผูกกับ conversation_id นี้

ชื่อ ID	คำอธิบาย
conversation_id	รหัสระบุการสนทนา สร้างขึ้นจาก `agent_id` และ `user_id` ใช้สำหรับสนทนาแบบหลายรอบระหว่างผู้ใช้กับ Agent โดย conversation_id หนึ่งจะมีหลาย `message_id` อยู่ภายใน
message_id	รหัสระบุข้อความ สร้างจาก `ข้อความที่ผู้ใช้ส่ง` และ `ข้อความที่ Agent ตอบกลับ` ในแต่ละรอบของการสนทนา โดย message_id จะอยู่ภายใต้ conversation_id

วิธีการร้องขอ

POST

URL สำหรับร้องขอ

https://api-${endpoint}.gptbots.ai/v1/conversation

การยืนยันตัวตนสำหรับร้องขอ

โปรดดูรายละเอียดการยืนยันตัวตนที่ API Overview

ตัวอย่างการร้องขอ

curl -X POST 'https://api-${endpoint}.gptbots.ai/v1/conversation' \ -H 'Authorization: Bearer ${API Key}' \ -H 'Content-Type: application/json' \ -d '{ "user_id": "your_user_id", "anonymous_id": "device_abcdef123456" }'

                      
                      curl -X POST 'https://api-${endpoint}.gptbots.ai/v1/conversation' \
  -H 'Authorization: Bearer ${API Key}' \
  -H 'Content-Type: application/json' \
  -d '{
        "user_id": "your_user_id",
        "anonymous_id": "device_abcdef123456"
}'

บล็อกโค้ดนี้ในหน้าต่างลอย

user_id หรือ anonymous_id อย่างใดอย่างหนึ่งเป็นทางเลือก แนะนำให้ส่งทั้งสองค่าเพื่อการสร้างโปรไฟล์ผู้ใช้และการวิเคราะห์ที่ดีขึ้น

Request Headers

ฟิลด์	ประเภท	คำอธิบาย
Authorization	Bearer ${API Key}	ใช้ Authorization: Bearer ${API Key} เพื่อยืนยันตัวตน รับ API Key ได้จากหน้า API Key
Content-Type	application/json	ประเภทข้อมูล ต้องเป็น application/json

พารามิเตอร์สำหรับร้องขอ

ฟิลด์	ประเภท	จำเป็น	คำอธิบาย
user_id	string	ใช่	รหัสผู้ใช้ที่นักพัฒนากำหนด เพื่อระบุผู้ใช้ใน Agent อย่างชัดเจน ความยาวสูงสุด 32 ตัวอักษร
anonymous_id	string	ไม่	รหัสผู้ใช้ที่ไม่ระบุตัวตน (อุปกรณ์) ใช้สำหรับระบุผู้ใช้ปลายทาง/อุปกรณ์ที่ยังไม่ได้ลงทะเบียน เมื่อส่งค่านี้ บทสนทนานี้จะถูกผูกกับอัตลักษณ์ไม่ระบุตัวตนนั้น หากไม่ระบุ ระบบจะสร้างให้โดยอัตโนมัติ

การตอบกลับ

ตัวอย่างการตอบกลับ

{ "conversation_id": "657303a8a764d47094874bbe" }

                      
                      {
  "conversation_id": "657303a8a764d47094874bbe" 
}

บล็อกโค้ดนี้ในหน้าต่างลอย

การตอบกลับเมื่อสำเร็จ

ฟิลด์	ประเภท	คำอธิบาย
conversation_id	string	รหัสระบุการสนทนา

การตอบกลับเมื่อผิดพลาด

ฟิลด์	ประเภท	คำอธิบาย
code	int	รหัสข้อผิดพลาด
message	string	รายละเอียดข้อผิดพลาด

รหัสข้อผิดพลาด

รหัส	ข้อความ
40000	พารามิเตอร์ผิดพลาด
40127	การยืนยันตัวตนนักพัฒนาไม่สำเร็จ
40378	Agent ถูกลบ