Keural API

เรียกใช้โมเดลที่ลงทะเบียนใน Keural ด้วยรูปแบบ OpenAI Chat Completions

Base URL มีรูปแบบ https://<public API domain for each environment>/llm/v1 โดเมน API สาธารณะแตกต่างกันในแต่ละสภาพแวดล้อม ให้สอบถามผู้ดูแลระบบ

ไม่รองรับพาธสำหรับ embedding, การสร้างภาพ, เสียง และ Responses API เรียกพาธเหล่านี้จะได้รับ 404

ขั้นตอนการใช้งานคัดลอกลิงก์ของหัวข้อ

เตรียมการคัดลอกลิงก์ของหัวข้อ

ออก API keyคัดลอกลิงก์ของหัวข้อ

1. เปิดเมนูบัญชี เลือก การตั้งค่า → API ในแอปเดสก์ท็อปและแอปมือถือ เมนูนี้อยู่ในส่วน เครื่องมือ
2. ในแท็บ API keys เลือกพื้นที่ทำงานที่คีย์จะสังกัด (ส่วนตัวหรือองค์กร) และ Model ID
3. หากต้องการ ให้กำหนด วันหมดอายุของคีย์ใหม่ หากเว้นว่างไว้ คีย์จะใช้ได้โดยไม่มีวันหมดอายุจนกว่าจะเพิกถอน
4. คลิก ออกคีย์ แล้วคลิก คัดลอกคีย์ เพื่อคัดลอกและเก็บรักษาคีย์ คีย์ฉบับเต็มจะแสดงเพียงครั้งเดียว

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

สิทธิ์ API ของสมาชิกองค์กรคัดลอกลิงก์ของหัวข้อ

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

ไปที่ การจัดการองค์กร → Organization API เมนูนี้ประกอบด้วยสามส่วนต่อไปนี้ หากไม่มีเมนูนี้ แสดงว่าฟีเจอร์ API ปิดอยู่ หรือบัญชีนี้ไม่มีสิทธิ์จัดการองค์กร

เมื่อสมาชิกออกจากองค์กรหรือถูกนำออกจากองค์กร คีย์ที่สมาชิกคนนั้นได้รับจากองค์กรจะถูกเพิกถอนอัตโนมัติ

เชื่อมต่อกับไคลเอนต์คัดลอกลิงก์ของหัวข้อ

ใส่ค่าสามค่าต่อไปนี้ลงในแอปที่รองรับ OpenAI API (ไคลเอนต์แชต ส่วนขยาย IDE เครื่องมืออัตโนมัติ และอื่น ๆ)

1. ในการตั้งค่าของแอป เลือกเพิ่ม การเชื่อมต่อที่เข้ากันได้กับ OpenAI (Connection)
2. ใส่ Base URL และ API Key แล้วบันทึก
3. เลือกโมเดลจากรายการโมเดล รายการจะมีเพียงโมเดลเดียว คือโมเดลที่เชื่อมกับคีย์
4. ส่งข้อความสั้น ๆ เพื่อตรวจสอบการตอบกลับ

คำขอที่ใช้มีดังนี้

คำขอแรกคัดลอกลิงก์ของหัวข้อ

export KEURAL_API_KEY='คีย์ที่ได้รับ'
export KEURAL_BASE_URL='https://<โดเมน API สาธารณะตามสภาพแวดล้อม>/llm/v1'
export MODEL_ID='Model ID จากหน้าออกคีย์'

curl "$KEURAL_BASE_URL/chat/completions" \
  -H "Authorization: Bearer $KEURAL_API_KEY" \
  -H 'Content-Type: application/json' \
  -d "{\"model\":\"$MODEL_ID\",\"messages\":[{\"role\":\"user\",\"content\":\"สวัสดี\"}]}"

ค่า model ในเนื้อหาคำขอต้องตรงกับ model ID ที่เชื่อมกับคีย์ หากมีพาธนำหน้า เช่น provider/model-ID ให้เปรียบเทียบส่วนหลัง / สุดท้าย หากไม่ตรงจะได้รับ 403 ในการตอบกลับ model จะเป็น model ID ของคีย์เสมอ

from openai import OpenAI
import os

client = OpenAI(
    api_key=os.environ["KEURAL_API_KEY"],
    base_url=os.environ["KEURAL_BASE_URL"],
)
res = client.chat.completions.create(
    model=os.environ["MODEL_ID"],
    messages=[{"role": "user", "content": "สวัสดี"}],
)
print(res.choices[0].message.content)

ฟิลด์คำขอที่รองรับคัดลอกลิงก์ของหัวข้อ

รับเฉพาะฟิลด์ระดับบนสุด 18 ฟิลด์ต่อไปนี้เท่านั้น หากส่งฟิลด์อื่นจะได้รับ 400 ฟิลด์ที่ไม่บังคับและมีค่าเป็น null ถือว่าไม่ได้ส่ง

ข้อความคัดลอกลิงก์ของหัวข้อ

• ข้อความ tool ตอบกลับได้เพียงครั้งเดียวต่อ id ใน tool_calls ก่อนหน้า
• ส่วนรูปภาพ (image_url) ใส่ได้เฉพาะในข้อความ user ของโมเดลที่รับรูปภาพ ใช้ที่อยู่ http หรือ https หรือ data URI แบบ base64 ที่เป็น PNG, JPEG, GIF หรือ WebP detail ใช้ได้ auto · low · high

เนื้อหา (body)คัดลอกลิงก์ของหัวข้อ

หากละเมิดกฎของเนื้อหา จะได้รับ 400 และ param จะเป็น body

การสตรีมคัดลอกลิงก์ของหัวข้อ

ใส่ "stream": true ในคำขอเพื่อรับการตอบกลับผ่าน SSE แต่ละชังค์จะมาเป็นอีเวนต์ data: ... และสิ้นสุดด้วย data: [DONE] หากใส่ "stream_options": {"include_usage": true} จะมีชังค์ข้อมูลการใช้โทเค็นเพิ่มอีกหนึ่งชังค์ก่อน [DONE]

เมื่อใส่ include_usage ทุกชังค์จะมี usage: null และชังค์การใช้งานชังค์สุดท้ายจะมี choices เป็นอาร์เรย์ว่าง การตอบกลับแบบไม่สตรีมจะมี usage เฉพาะเมื่อยืนยันจำนวนโทเค็นอินพุตและเอาต์พุตได้ครบแล้ว

id ของการตอบกลับมีรูปแบบ chatcmpl-<x-request-id> ทุกการตอบกลับมี header x-request-id แนบมาด้วย

หากเกิดข้อผิดพลาดระหว่างสตรีม จะส่งอีเวนต์ data: ที่มี JSON ของข้อผิดพลาดมา แล้วการเชื่อมต่อจะปิดโดยไม่มี [DONE] หากชังค์เดียวเกิน 1 MiB หรือการตอบกลับเกิน 16 MiB สตรีมจะจบด้วย 503

curl -N "$KEURAL_BASE_URL/chat/completions" \
  -H "Authorization: Bearer $KEURAL_API_KEY" \
  -H 'Content-Type: application/json' \
  -d "{\"model\":\"$MODEL_ID\",\"messages\":[{\"role\":\"user\",\"content\":\"สวัสดี\"}],\"stream\":true,\"stream_options\":{\"include_usage\":true}}"

ขีดจำกัดการใช้งานคัดลอกลิงก์ของหัวข้อ

คำขอถูกจำกัดตามผู้ใช้ องค์กร และโมเดล ด้วยจำนวนคำขอพร้อมกัน จำนวนคำขอต่อนาที (RPM) และจำนวนโทเค็นต่อนาที (TPM) ค่าจริงแตกต่างกันในแต่ละสภาพแวดล้อม

โทเค็นต่อนาทีจะถูกหักไว้ล่วงหน้าตั้งแต่รับคำขอ อินพุตนับ 1 โทเค็นต่อตัวอักษรภาษาอังกฤษ 4 ตัว และนับ 1 โทเค็นต่อตัวอักษรอื่น ๆ รูปภาพ 1 รูปนับ 2,000 โทเค็น เอาต์พุตหักเท่ากับ max_tokens (สูงสุด 4,096) ดังนั้นหากกำหนดขีดจำกัดเอาต์พุตเท่าที่จำเป็น โควตาคงเหลือจะมากขึ้น

การจัดการคีย์คัดลอกลิงก์ของหัวข้อ

ในแท็บ API keys ของ การตั้งค่า → API ตรวจสอบสถานะคีย์ (ใช้ได้ · หมดอายุ · เพิกถอนแล้ว) และหมุนเวียนหรือเพิกถอนคีย์ได้ที่นี่

คีย์เป็นสตริง 51 ตัวอักษรที่ขึ้นต้นด้วย krl_llm_ แต่ละพื้นที่ทำงานมีคีย์ได้หนึ่งคีย์ หากมีอยู่แล้ว จะหมุนเวียนคีย์แทนการออกใหม่ วันหมดอายุตั้งได้เฉพาะหลังวันนี้เท่านั้น

ตรวจสอบการใช้งานคัดลอกลิงก์ของหัวข้อ

คำขอที่ส่งผ่าน API และโทเค็นที่ใช้ไปดูได้จากสองที่

เงื่อนไขการค้นหาคัดลอกลิงก์ของหัวข้อ

กำหนดเงื่อนไขแล้วคลิก ค้นหา หากต้องการดูคำขอที่เพิ่งส่งไป ให้คลิก รีเฟรช

ค่าที่แสดงบนหน้าจอคัดลอกลิงก์ของหัวข้อ

• ช่วงเวลาที่ใช้ค้นหา (KST): ช่วงเวลาที่ค้นหาจริง หากเว้นเวลาว่างไว้ หรือเกิน 90 วัน จะแสดงช่วงที่เซิร์ฟเวอร์ปรับให้
• จำนวนคำขอ และ โทเค็นอินพุต · โทเค็นเอาต์พุต · โทเค็นรวม: รวมเฉพาะค่าที่ยืนยันแล้ว โทเค็นที่ยังไม่ยืนยันจะไม่นับเป็น 0 แต่แสดงเป็น ยังไม่ยืนยัน
• รายการคำขอ: แต่ละคำขอแสดงเป็นหนึ่งแถว ประกอบด้วยเวลาที่ส่ง Model ID สถานะคำขอ และโทเค็นอินพุต เอาต์พุต และรวม แต่ละหน้าแสดง 20 คำขอ เลื่อนหน้าด้วย ก่อนหน้า และ ถัดไป

คลิก รายละเอียดคำขอ ในแถวเพื่อดูค่าต่อไปนี้

คำขอแบบสตรีมจะถูกบันทึกการใช้งานแม้ไม่ได้ใส่ stream_options.include_usage หากคำขอขาดหายกลางทาง สถานะอาจค้างเป็น ยืนยันบางส่วน หรือ ยังไม่ยืนยัน

รูปแบบข้อผิดพลาดคัดลอกลิงก์ของหัวข้อ

ข้อผิดพลาดจะถูกส่งกลับในรูปแบบที่เข้ากันได้กับ OpenAI

{
  "error": {
    "message": "คำอธิบายข้อผิดพลาดที่มนุษย์อ่านได้",
    "type": "authentication_error",
    "code": "invalid_api_key",
    "param": null
  }
}

type ถูกกำหนดจากรหัสสถานะ และ code ใช้แยกสาเหตุ

การแก้ปัญหาคัดลอกลิงก์ของหัวข้อ

หากยังไม่หายให้ติดต่อผู้ดูแลระบบ พร้อมข้อมูลต่อไปนี้เพื่อให้หาสาเหตุได้เร็วขึ้น ไม่ต้องส่งค่าคีย์ฉบับเต็มหรือเนื้อหา prompt

• เวลาที่เกิดเหตุ
• Model ID ที่ใช้
• ชื่อและเวอร์ชันของแอปไคลเอนต์
• x-request-id จาก header การตอบกลับ
• ข้อความข้อผิดพลาดที่แสดงบนหน้าจอ