ข้อกำหนด API
เอกสารอ้างอิงสำหรับการเชื่อมต่อเวิร์กโฟลว์ข้อความ เอเจนต์ สื่อ และการค้นคืนข้อมูล
https://cicora.ai/api/v1https://cicora.ai/apiเอกสารอ้างอิงการเชื่อมต่อ: เลือกพารามิเตอร์และความสามารถที่ใช้ได้จากการตั้งค่า API ของบัญชีและแค็ตตาล็อกโมเดลสำหรับสภาพแวดล้อมของคุณ
ส่งคำขอแรกเริ่มต้นใช้งาน
ส่งคำขอแรก เลือกโมเดลจากแค็ตตาล็อก และเก็บตัวระบุคำขอไว้สำหรับการวินิจฉัย
การยืนยันตัวตนส่งคีย์ API ในส่วนหัว Bearer และแยกข้อมูลรับรองสำหรับการใช้งานจริงออกจากข้อมูลรับรองสำหรับการพัฒนา
SDK และไคลเอนต์ HTTPใช้ URL พื้นฐานต่างกันสำหรับไคลเอนต์รูปแบบ OpenAI และ Messages เพราะทั้งสองมุ่งไปยังข้อกำหนด API เดียวกันแต่ประกอบเส้นทางต่างกัน
CLI และการเชื่อมต่อกำหนดค่าไคลเอนต์ด้วยคีย์ โมเดล และ URL พื้นฐานที่ตรงกับโปรโตคอล โดยเก็บข้อมูลลับไว้ในสภาพแวดล้อม
คำถามที่พบบ่อยสำหรับนักพัฒนาคำตอบเชิงปฏิบัติแบบสั้นเกี่ยวกับคีย์ URL พื้นฐาน โมเดล ต้นทุน และการวินิจฉัยการเชื่อมต่อ
บัญชีและแค็ตตาล็อก
สร้างการเลือกโมเดลจากข้อมูลแค็ตตาล็อก แทนรายการที่เขียนตายตัวในแอปพลิเคชันของคุณ
ทีมและคีย์ APIแยกคีย์ เจ้าของ งบประมาณ และการติดตามการใช้งานตามแต่ละแอปพลิเคชันและพื้นที่ทำงาน
ขีดจำกัดถือว่าขีดจำกัดของคีย์ องค์กร โมเดล และการกำหนดเส้นทางเป็นส่วนหนึ่งของเวิร์กโฟลว์ผู้ใช้
การใช้งานและต้นทุนเชื่อมโยงข้อมูลเมตาของการตอบกลับและบันทึกคำขอของคุณเข้ากับการดำเนินการจริงของผู้ใช้
ข้อมูลและความเป็นส่วนตัวลดข้อมูลที่ส่ง แยกตัวระบุผู้ใช้ปลายทางออกจากเนื้อหา และควบคุมการเก็บรักษาในผลิตภัณฑ์ของคุณ
ข้อความและเอเจนต์
สร้างการสนทนาหลายรอบในรูปแบบ messages ที่คุ้นเคย และเลือกโมเดลสำหรับแต่ละคำขอ
Messages APIใช้รูปแบบ Messages สำหรับการสนทนา โดยมีคำสั่งระบบระดับบนสุดและขีดจำกัดเอาต์พุตที่ระบุชัดเจน
Responses APIใช้ออบเจ็กต์อินพุตเดียวเมื่อแอปพลิเคชันของคุณได้ประโยชน์จากการจัดการรายการเอาต์พุตและการดำเนินการในโมเดลข้อมูลเดียว
การสตรีมรับโทเค็นและเดลตาที่มีโครงสร้างผ่าน SSE โดยไม่ต้องรอการตอบกลับทั้งหมด
เครื่องมือและการเรียกใช้ฟังก์ชันอธิบายฟังก์ชันด้วย JSON Schema ดำเนินการเรียกใช้ในแอปพลิเคชันของคุณ และส่งผลลัพธ์กลับไปยังการสนทนา
เอาต์พุตที่มีโครงสร้างขอออบเจ็กต์ JSON หรือ JSON Schema เมื่อซอฟต์แวร์เป็นผู้ใช้ผลตอบกลับแทนบุคคล
การให้เหตุผลกำหนดระดับความพยายามในการให้เหตุผลต่อคำขอ เฉพาะกับโมเดลที่ประกาศว่ารองรับความสามารถนี้
การกำหนดเส้นทางระบุความต้องการด้านการดำเนินการไว้ในค่ากำหนดการเลือกผู้ให้บริการ และเก็บผลที่เกิดขึ้นจริงไว้เพื่อการสังเกตการณ์
การแคชบริบทแยกบริบทที่ใช้ซ้ำ เพื่อให้ไคลเอนต์ใช้การแคชที่เข้ากันได้เมื่อโมเดลที่เลือกรองรับ
การค้นหาเว็บค้นคืนแหล่งข้อมูลล่าสุดผ่านฟังก์ชัน `web_search` ที่ไคลเอนต์ดำเนินการ และแยกลิงก์ออกจากข้อความที่สร้าง
สื่อและการค้นคืนข้อมูล
อัปโหลดไฟล์ผ่านการดำเนินการเฉพาะ เก็บรหัสไว้ และส่งข้อมูลอ้างอิงในคำขอที่เข้ากันได้ภายหลัง
ภาพสร้างภาพผ่านเส้นทางเดียวและเลือกพารามิเตอร์จากความสามารถของโมเดลที่เลือก
วิดีโอเริ่มสร้างวิดีโอเป็นงานแบบอะซิงโครนัส เก็บรหัสงานไว้ และแยกการสร้างออกจากการอ่านผลลัพธ์
เสียงใช้การดำเนินการแยกกันสำหรับการสังเคราะห์เสียงพูด การถอดเสียง และอินพุตเสียงที่ส่งให้โมเดล
เวกเตอร์ฝังตัวแปลงข้อความหรืออินพุตที่รองรับเป็นเวกเตอร์สำหรับการค้นหา การจัดกลุ่ม และการแนะนำ
จัดอันดับใหม่จัดลำดับตัวเลือกชุดเล็กใหม่เทียบกับคิวรี เพื่อเพิ่มความแม่นยำของการค้นคืนขั้นสุดท้าย
การดำเนินการแบบแบตช์ประมวลผลการดำเนินการอิสระเป็นกลุ่มที่ควบคุมได้ เมื่อเวิร์กโฟลว์อนุญาตให้ส่งมอบแบบอะซิงโครนัส