เมทาดาทาของบทสนทนา

เมทาดาทาของบทสนทนาช่วยให้แนบข้อมูลแบบคีย์และค่าที่กำหนดเองกับบทสนทนา เป็นตัวเชื่อมระหว่างระบบของคุณกับ AI Agent เมทาดาทาถูกใช้งานตลอดกระบวนการทำงานของ Quickchat:

• ส่งผ่าน API: ใช้เอนด์พอยต์เหล่านี้เพื่อแนบเมทาดาทากับบทสนทนาใดก็ได้ด้วยโปรแกรม (เช่น จาก CRM ระบบช่วยเหลือ หรือแบ็กเอนด์)
• ส่งผ่านวิดเจ็ตหรือแชตแบบฝัง: ส่งเมทาดาทาเป็นพารามิเตอร์เริ่มต้นเมื่อโหลดวิดเจ็ต หรือเพิ่มแบบไดนามิกระหว่างบทสนทนาที่กำลังดำเนินอยู่ด้วย JavaScript SDK
• เห็นได้ในแดชบอร์ด: เมทาดาทาที่กำหนดเองแสดงในรายละเอียดบทสนทนาของกล่องข้อความ คีย์ภายในจะถูกกรองออก ส่วนข้อมูลติดต่อที่เก็บได้และหน่วยความจำของการดำเนินการมีการแสดงผลแยกกัน
• รวมในการส่งออก: เมทาดาทารวมอยู่เมื่อส่งออกบทสนทนาจากแดชบอร์ด จึงนำไปวิเคราะห์แบบออฟไลน์ได้
• ใช้ในการดำเนินการ AI: ค่าเมทาดาทาสามารถแทนที่ตัวแปร {{metadata_<key>}} ใน การดำเนินการ AI ได้โดยตรง ดูตัวแปรทั้งหมดใน ตัวแปรของการดำเนินการ AI
• AI Agent ใช้ได้เมื่อได้รับอนุญาต: บริบทของโมเดลใช้เมทาดาทาเฉพาะส่วนที่ผ่านการกรอง การเก็บคีย์ไม่ได้รับประกันว่าโมเดลจะได้รับหรือกล่าวถึงค่านั้น

ใช้เมทาดาทาสำหรับข้อมูลอ้างอิงลูกค้า บริบทบัญชี การวิเคราะห์ และอินพุตของการดำเนินการ การจัดเก็บ การแสดงในกล่องข้อความ การแทนค่าในคำขอ และบริบทของโมเดลเป็นการใช้งานแยกกันของข้อมูลชุดเดียว

เมทาดาทาจะถูกตรวจสอบกับ JSON schema หากตั้งค่าไว้ในแดชบอร์ด

ตัวอย่างการตรวจสอบเพิ่มเติม

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

• ตรวจสอบเงื่อนไขการเรียกใช้การดำเนินการ ประเมินเงื่อนไขกับเมทาดาทาตัวอย่างที่ระบุโดยไม่เรียกใช้การดำเนินการ

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

บริบทของโมเดลและการอนุญาต

สำหรับช่องทางที่ผู้เยี่ยมชมควบคุมได้ เช่น Widget ของเว็บไซต์และแชตแบบฝัง บริบทของโมเดลรับคีย์ติดต่อของผู้เยี่ยมชม (visitor_name, visitor_email, visitor_phone_number) และคีย์ที่เข้าเกณฑ์ซึ่งการดำเนินการที่ใช้งานอยู่ใช้อ้างอิงหรือเก็บข้อมูล ค่าภายในและค่าสงวนจะถูกกรองออก และยังมีข้อจำกัดด้านการตั้งค่าและขนาด การเชื่อมต่ออื่นมีกฎบริบทตามช่องทาง คีย์กำหนดเองอย่าง customer_tier หรือ customer_id ไม่ได้ปรากฏต่อโมเดลโดยอัตโนมัติเพียงเพราะคุณส่งมา

การดำเนินการสามารถแทนค่า {{metadata_<key>}} ขณะสร้างคำขอโดยไม่ต้องให้ AI สร้างค่านั้น แต่ไม่ได้ทำให้เมทาดาทาทั่วไปเป็นความลับ: ค่าที่เข้าเกณฑ์อาจเข้าสู่บริบทของโมเดลแยกต่างหากหรือปรากฏในคำตอบของการดำเนินการ อย่าเก็บคีย์ API หรือรหัสผ่านในเมทาดาทาที่กำหนดเอง

เมทาดาทาที่ส่งจากเบราว์เซอร์ไม่ใช่หลักฐานยืนยันตัวตนหรือสิทธิ์ บริการปลายทางต้องยืนยันตัวตนและอนุญาตการเข้าถึงข้อมูลส่วนตัวเอง ID ลูกค้าหรือระดับแพ็กเกจที่เบราว์เซอร์ส่งมาไม่เพียงพอ ทดสอบทั้งคำขอของการดำเนินการและคำตอบของ Agent ตามการตั้งค่าของคุณ

ดึงเมทาดาทา

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

GET https://app.quickchat.ai/v1/api_core/conversations/{conv_id}/metadata

Shell

curl https://app.quickchat.ai/v1/api_core/conversations/conv-uuid-1234/metadata \
  -H 'Authorization: Bearer <API_TOKEN>'

Python

import requests

response = requests.get(
    url="https://app.quickchat.ai/v1/api_core/conversations/conv-uuid-1234/metadata",
    headers={"Authorization": "Bearer <API_TOKEN>"},
)
data = response.json()

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

{
  "metadata": {
    "ticket_id": "T-1234",
    "priority": "high"
  }
}

กำหนดเมทาดาทา

สร้างหรืออัปเดตเมทาดาทาของบทสนทนา

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

POST https://app.quickchat.ai/v1/api_core/conversations/{conv_id}/metadata

เนื้อหาคำขอ

พารามิเตอร์	คำอธิบาย
metadata ออบเจ็กต์, จำเป็น	เมทาดาทาแบบคีย์และค่าที่จะจัดเก็บ

Shell

curl -X POST https://app.quickchat.ai/v1/api_core/conversations/conv-uuid-1234/metadata \
  -H 'Authorization: Bearer <API_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{
  "metadata": {
    "ticket_id": "T-1234",
    "priority": "high"
  }
}'

Python

import requests

response = requests.post(
    url="https://app.quickchat.ai/v1/api_core/conversations/conv-uuid-1234/metadata",
    headers={"Authorization": "Bearer <API_TOKEN>"},
    json={
        "metadata": {"ticket_id": "T-1234", "priority": "high"}
    },
)
data = response.json()

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

{
  "metadata": {
    "ticket_id": "T-1234",
    "priority": "high"
  }
}

---