ข้ามไปยังเนื้อหา

การดำเนินการ AI

จัดการการดำเนินการของ AI Agent ผ่าน API

  • ดูตัวอย่างผลที่ตรงกับ JSONPath ตรวจเส้นทางระดับราก ฟิลด์ ดัชนีอาร์เรย์ และไวลด์การ์ดกับ JSON ที่กำหนด การตรวจสอบนี้ไม่เรียกใช้การดำเนินการหรือบันทึกหน่วยความจำบทสนทนา

  • ตรวจสอบตัวอย่างการเชื่อมต่อ MCP เริ่มต้นการเชื่อมต่อและแสดงเครื่องมือของเอนด์พอยต์เอกสาร Cloudflare หรือ Microsoft Learn เท่านั้น ไม่มีการเข้าสู่ระบบหรือเรียกใช้เครื่องมือ

ในเบราว์เซอร์ที่รองรับ การตรวจสอบเหล่านี้มีให้เป็นเครื่องมือของเว็บไซต์ด้วย ลิงก์จะเปิดแบบฟอร์มมาตรฐาน

การดำเนินการ AI เพิ่มความสามารถของ AI Agent ให้มากกว่าการตอบคำถามจากฐานความรู้ ช่วยให้กำหนด พฤติกรรมที่เรียกใช้ตามเงื่อนไข หรือสิ่งที่ AI ควรทำเมื่อตรวจพบสถานการณ์เฉพาะในบทสนทนา

การดำเนินการ AI ทำอะไรได้บ้าง:

  • การดำเนินการคำขอ HTTP: เรียก API ภายนอกเมื่อเข้าเงื่อนไข เช่น ตรวจสถานะคำสั่งซื้อในแบ็กเอนด์ สร้างคำร้องขอความช่วยเหลือ หรือค้นหาข้อมูลบัญชี ทั้งหมดระหว่างสนทนา
  • การดำเนินการ MCP: เชื่อมต่อเซิร์ฟเวอร์ Model Context Protocol เพื่อใช้เครื่องมือขั้นสูง (เช่น ค้นหาสินค้า Shopify หรือค้นฐานข้อมูลที่กำหนดเอง)

กรณีใช้งานทั่วไป:

  • ค้นข้อมูลแบบเรียลไทม์ (สถานะคำสั่งซื้อ รายละเอียดบัญชี สินค้าคงเหลือ) จากระบบแบ็กเอนด์ระหว่างสนทนา
  • สร้างคำร้อง อัปเดตข้อมูล CRM หรือเริ่มกระบวนการในระบบภายนอกตามบริบทบทสนทนา
  • ให้คำแนะนำเฉพาะบุคคลด้วยการค้นแค็ตตาล็อกสินค้า

แต่ละการดำเนินการมี name, description (สำหรับคำขอ HTTP คำอธิบายบอก AI ว่าควรเรียกเมื่อใด) และการตั้งค่าตามประเภท คุณเปิดหรือปิดแต่ละการดำเนินการผ่าน API ได้ สร้างและตั้งค่าการดำเนินการทั้งหมดใน แดชบอร์ด Quickchat ส่วน API รองรับการแสดงรายการ อัปเดต (เปิด/ปิด) และลบ รวมถึงเอนด์พอยต์เฉพาะสำหรับสร้างและตั้งค่า การดำเนินการ MCP

ขอบเขตสิทธิ์: read_all

GET https://app.quickchat.ai/v1/api/ai_actions

Terminal window
curl https://app.quickchat.ai/v1/api/ai_actions \
-H 'Authorization: Bearer <API_TOKEN>'

การตอบกลับ 200 OK

[
{
"id": 1,
"name": "Check Order Status",
"description": "Look up order status when customer asks about their order.",
"is_active": true,
"type": "http_request",
"icon": null,
"icon_color": null,
"is_valid": true
}
]
ฟิลด์คำอธิบาย
id
จำนวนเต็ม
ตัวระบุการดำเนินการ AI
name
สตริง
ชื่อที่แสดง
description
สตริง
เงื่อนไขที่เรียกการดำเนินการ
is_active
บูลีน
เปิดใช้อยู่หรือไม่
type
สตริง
"http_request", "remote_mcp", "shopify_remote_mcp" หรือ "knowledge_base"
icon
สตริง หรือ null
ตัวระบุไอคอน
icon_color
สตริง หรือ null
สีไอคอน
is_valid
บูลีน
ตั้งค่าถูกต้องหรือไม่
ขอบเขตสิทธิ์: write_all

PATCH https://app.quickchat.ai/v1/api/ai_actions/{action_id}

เนื้อหาคำขอ

พารามิเตอร์คำอธิบาย
is_active
บูลีน
เปิดหรือปิดการดำเนินการ
icon
สตริง
ตัวระบุไอคอน (สูงสุด 200 อักขระ)
icon_color
สตริง
สีไอคอน (สูงสุด 50 อักขระ)
Terminal window
curl -X PATCH https://app.quickchat.ai/v1/api/ai_actions/1 \
-H 'Authorization: Bearer <API_TOKEN>' \
-H 'Content-Type: application/json' \
-d '{"is_active": false}'

การตอบกลับ 200 OK ส่งกลับสแนปช็อตของการดำเนินการ AI ที่อัปเดตแล้ว

ขอบเขตสิทธิ์: write_all

DELETE https://app.quickchat.ai/v1/api/ai_actions/{action_id}

Terminal window
curl -X DELETE https://app.quickchat.ai/v1/api/ai_actions/1 \
-H 'Authorization: Bearer <API_TOKEN>'

การตอบกลับ 200 OK (เนื้อหาว่าง)

ขอบเขตสิทธิ์: write_all

POST https://app.quickchat.ai/v1/api/ai_actions/remote_mcp

เชื่อมเซิร์ฟเวอร์ MCP ระยะไกลกับ AI Agent เป็น การดำเนินการ MCP ต้องใช้โทเคน API ที่มีขอบเขต write_all (โทเคน API ต้องใช้ แพ็กเกจ Business ขึ้นไป)

เนื้อหาคำขอ

พารามิเตอร์คำอธิบาย
remote_mcp_url
สตริง, จำเป็น
URL เซิร์ฟเวอร์ MCP ต้องใช้ https:// ระบบปฏิเสธ URL ที่ชี้ไปยังที่อยู่เครือข่ายส่วนตัวหรือภายใน
headers
อาร์เรย์, จำเป็น
ส่วนหัวการเชื่อมต่อที่ส่งไปยังเซิร์ฟเวอร์ เช่น โทเคน Authorization แบบคงที่ แต่ละรายการเป็น {"id", "name", "value"} เลือกสตริงที่ไม่ซ้ำเป็น id หากเซิร์ฟเวอร์ไม่ต้องใช้ ให้ส่ง []
allowed_tools
อาร์เรย์, จำเป็น
สวิตช์รายเครื่องมือ แต่ละรายการเป็น {"name", "is_active"} ส่ง [] เพื่อให้การใช้งานเครื่องมือขึ้นกับ default_tool_is_active
name
สตริง
ชื่อที่แสดงในรายการการดำเนินการ (สูงสุด 100 อักขระ) ค่าเริ่มต้นได้จากชื่อโฮสต์เซิร์ฟเวอร์
description
สตริง
คำอธิบายที่แสดงในรายการการดำเนินการ (สูงสุด 2,500 อักขระ)
icon
สตริง
ตัวระบุไอคอน (สูงสุด 200 อักขระ)
icon_color
สตริง
สีไอคอน (สูงสุด 50 อักขระ)

name และ description เป็นป้ายสำหรับผู้ดูแล ใช้ระบุการดำเนินการในแดชบอร์ด และ AI ไม่ได้อ่าน AI ทำงานจากคำอธิบายเครื่องมือที่เซิร์ฟเวอร์ MCP เผยแพร่เอง

Terminal window
curl -X POST https://app.quickchat.ai/v1/api/ai_actions/remote_mcp \
-H 'Authorization: Bearer <API_TOKEN>' \
-H 'Content-Type: application/json' \
-d '{
"remote_mcp_url": "https://mcp.example.com/mcp",
"headers": [
{"id": "h-1", "name": "Authorization", "value": "Bearer <SERVER_TOKEN>"}
],
"allowed_tools": [],
"name": "Example MCP"
}'

การตอบกลับ 201 Created

{
"id": 2,
"name": "Example MCP",
"description": "Connected MCP server",
"is_active": false,
"type": "remote_mcp",
"icon": "FaMixcloud",
"icon_color": "#EF4444",
"is_valid": true,
"validation_issues": [],
"remote_mcp_url": "https://mcp.example.com/mcp",
"remote_mcp_auth_token": "",
"default_tool_is_active": true,
"allowed_tools": [],
"headers": [
{"id": 10, "name": "Authorization", "value": "Bearer <SERVER_TOKEN>"}
],
"oauth": null,
"recommended_tools": []
}
ฟิลด์คำอธิบาย
remote_mcp_url
สตริง
URL เซิร์ฟเวอร์ MCP ที่เชื่อมต่อ
default_tool_is_active
บูลีน
อนุญาตให้ใช้เครื่องมือที่ไม่ได้ระบุใน allowed_tools หรือไม่
allowed_tools
อาร์เรย์
สวิตช์รายเครื่องมือ {"name", "is_active"}
headers
อาร์เรย์
ส่วนหัวการเชื่อมต่อที่จัดเก็บ
remote_mcp_auth_token
สตริง หรือ null
ฟิลด์โทเคนคงที่รุ่นเก่า กำหนดผ่าน API นี้ไม่ได้ ให้ส่งข้อมูลรับรองผ่าน headers แทน
oauth
ออบเจ็กต์ หรือ null
สถานะการอนุญาตของเซิร์ฟเวอร์ที่เชื่อมต่อด้วยการเข้าสู่ระบบ OAuth (กรณีอื่นเป็น null)
recommended_tools
อาร์เรย์
ชื่อเครื่องมือที่ Quickchat แนะนำสำหรับเซิร์ฟเวอร์ที่มีโปรไฟล์จัดเตรียมไว้ (อ่านอย่างเดียว)
validation_issues
อาร์เรย์
ชื่อการตรวจสอบการตั้งค่าที่ไม่ผ่าน ว่างเมื่อ is_valid เป็น true

ฟิลด์ที่เหลือตรงกับ แสดงรายการการดำเนินการ AI ทั้งหมด

การดำเนินการสร้างขึ้นด้วย is_active: false สำหรับเซิร์ฟเวอร์ที่ไม่มีโปรไฟล์ที่ Quickchat จัดเตรียมไว้ จะเริ่มด้วย default_tool_is_active: true ด้วย จึงอนุญาตทุกเครื่องมือที่ค้นพบขณะตอบจนกว่าคุณจะจำกัด หากต้องการเปิดการดำเนินการ ให้ใช้เอนด์พอยต์ อัปเดตการดำเนินการ AI ด้านบน: PATCH /v1/api/ai_actions/{action_id} พร้อม {"is_active": true}

ขอบเขตสิทธิ์: read_all

GET https://app.quickchat.ai/v1/api/ai_actions/{action_id}/remote_mcp

Terminal window
curl https://app.quickchat.ai/v1/api/ai_actions/2/remote_mcp \
-H 'Authorization: Bearer <API_TOKEN>'

การตอบกลับ 200 OK ส่งกลับการตั้งค่าเฉพาะ MCP ในรูปแบบเดียวกับการตอบกลับการสร้างด้านบน

ขอบเขตสิทธิ์: write_all

PATCH https://app.quickchat.ai/v1/api/ai_actions/{action_id}/remote_mcp

ทุกฟิลด์ไม่บังคับ จะเปลี่ยนเฉพาะฟิลด์ที่คุณส่ง

เนื้อหาคำขอ

พารามิเตอร์คำอธิบาย
remote_mcp_url
สตริง
URL เซิร์ฟเวอร์ใหม่ (ตรวจสอบเหมือนตอนสร้าง) การเปลี่ยน URL ของเซิร์ฟเวอร์ที่เชื่อมต่อด้วย OAuth จะล้างการอนุญาตที่เก็บไว้และปิดการดำเนินการ
headers
อาร์เรย์
แทนที่ส่วนหัวการเชื่อมต่อ
allowed_tools
อาร์เรย์
แทนที่สวิตช์รายเครื่องมือ แต่ละรายการเป็น {"name", "is_active"}
default_tool_is_active
บูลีน
อนุญาตให้ใช้เครื่องมือที่ไม่ได้ระบุใน allowed_tools หรือไม่
name
สตริง
ชื่อที่แสดง (สูงสุด 100 อักขระ)
description
สตริง
คำอธิบายที่แสดงในรายการการดำเนินการ (สูงสุด 2,500 อักขระ)
Terminal window
curl -X PATCH https://app.quickchat.ai/v1/api/ai_actions/2/remote_mcp \
-H 'Authorization: Bearer <API_TOKEN>' \
-H 'Content-Type: application/json' \
-d '{
"allowed_tools": [
{"name": "search_docs", "is_active": true},
{"name": "delete_page", "is_active": false}
],
"default_tool_is_active": false
}'

การตอบกลับ 200 OK ส่งกลับการดำเนินการ MCP ที่อัปเดตแล้ว ในรูปแบบเดียวกับการตอบกลับการสร้าง

การทดสอบการเชื่อมต่อและการค้นหาเครื่องมือ ซึ่งคือการตรวจด้วย เชื่อมต่อ ในแดชบอร์ด ไม่มีให้ใช้ใน API สาธารณะ แดชบอร์ดตรวจให้อัตโนมัติเมื่อเชื่อมต่อหรือเชื่อมต่อเซิร์ฟเวอร์ใหม่ และเซิร์ฟเวอร์ที่ป้องกันด้วย OAuth ต้องดำเนินการอนุญาตในแดชบอร์ด ฟิลด์ oauth ในการตอบกลับข้างต้นรายงานสถานะนั้น