โมเดล API

ใช้ GET /api/v1/models เพื่อดูรายการโมเดล Rivya พร้อมความพร้อมใช้งานของ Public API

curl https://rivya.ai/api/v1/models

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

รูปแบบผลตอบกลับ

ผลตอบกลับใช้โครงสร้างนี้:

{
  "object": "list",
  "data": [
    {
      "id": "z-image",
      "display_name": "Z-Image",
      "category": "image",
      "runtime": "async_task",
      "base_credits": 1,
      "billing_type": "FIXED",
      "supported_modes": ["text-to-image"],
      "max_prompt_length": 1000,
      "reference_media": null,
      "params": [],
      "api_status": "available",
      "api_input_status": "available_text",
      "supported_api_inputs": ["text"],
      "requires_files_api": false,
      "requires_upload_for_modes": [],
      "url_input_supported": false,
      "file_kinds": [],
      "chat_capabilities": null,
      "notices": []
    }
  ]
}

ใช้ id เป็นค่า model ใน POST /api/v1/generations สำหรับโมเดลสร้างงานแบบอะซิงโครนัส ส่วนโมเดลแชตให้ใช้ POST /api/v1/chat/completions และตรวจ chat_capabilities

สถานะความพร้อมใช้งาน

เอกสารอ้างอิงโมเดลใช้สถานะสาธารณะต่อไปนี้:

• available: มีเส้นทางสร้างผลลัพธ์ผ่าน API สาธารณะอย่างน้อยหนึ่งเส้นทางที่พร้อมใช้งาน

• temporarily_unavailable: โมเดลไม่พร้อมใช้งานชั่วคราวและขณะนี้ไม่สามารถเรียกผ่าน Public API v1 ได้

• studio_only: โมเดลพร้อมใช้งานผ่าน Studio หรือพื้นที่อื่นของผลิตภัณฑ์ แต่ไม่ใช่ Public API v1

ฟิลด์ความพร้อมของอินพุตจะระบุรายละเอียดมากกว่า:

• available_text: ทดสอบคำขอที่ใช้พรอมต์ได้โดยตรง

• available_reference: ทดสอบ URL สาธารณะหรือพารามิเตอร์ค่าเดี่ยวได้โดยตรง

• partial_requires_files: บางโหมดเรียกได้โดยไม่ต้องอัปโหลด ส่วนโหมดที่ใช้สื่ออ้างอิงควรใช้ Files API

• requires_files_api: โมเดลต้องใช้สื่ออ้างอิงที่อัปโหลดผ่าน /api/v1/files

ใช้ Files API ก่อนเรียกโหมดที่ต้องใช้รูปภาพ วิดีโอ หรือเสียงอ้างอิงที่อัปโหลดแล้ว

สำหรับโมเดลแชต chat_capabilities จะระบุว่า Chat API รองรับคำตอบแบบไม่สตรีม คำตอบแบบสตรีม การค้นหาเว็บ ไฟล์ภาพแนบแบบ file_id กระบวนการคิด และการกำหนดระดับการใช้เหตุผลหรือไม่

นโยบายจำนวนโมเดล

รายการโมเดลสาธารณะเปลี่ยนได้เมื่อ Rivya เพิ่ม ลบ หรือจำกัดการเข้าถึงโมเดล

อย่ากำหนดจำนวนโมเดลตายตัวในระบบเชื่อมต่อของคุณ ให้อ่าน /api/v1/models หรือ ข้อมูลอ้างอิง Model API แบบไดนามิกเสมอ

หน้าที่เกี่ยวข้อง

• ข้อมูลอ้างอิง Model API

• การสร้างงานผ่าน API

• Chat API

• คู่มือเลือกโมเดล Rivya

• ความพร้อมใช้งานของโมเดลใน Rivya

รายการเร็ว ๆ นี้แบบอ่านอย่างเดียว

• coming_soon: แสดงโมเดลเพื่อการค้นพบเท่านั้น และส่งไปยัง API สร้างงานหรือ API แชตไม่ได้ รายการจะคืน supports_direct_generation: false, ค่า runtime, billing และ pricing เป็น null พร้อม supported_modes และ params ว่าง สำหรับคำขอให้เลือก api_status: available