เอกสาร API: จุดสิ้นสุดที่เข้ากันได้กับ OpenAI

Authentication & Base URL

เข้าถึง API โดยกำหนดคีย์เฉพาะของคุณและ URL พื้นฐานในตัวแปรสภาพแวดล้อมของคุณ จุดปลายอยู่ที่ https://api.apikeykimi.com/v1.คุณต้องรวม header Authorization: Bearer YOUR_API_KEY พร้อมทุกคำขอ คีย์นี้สร้างทันทีเมื่อสมัครผ่าน Google หรืออีเมล เป็นข้อมูลรับรองเพียงอย่างเดียวที่ต้องการสำหรับการตรวจสอบสิทธิ์ ไม่ต้องกำหนดค่าขอบเขตหรือสิทธิ์

Copycurl https://api.apikeykimi.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "convert this json object to python dictionary syntax"}]
  }'

จุดจบ API Chat Completions

ส่งข้อความไปยังโมเดลโดยใช้มาตรฐาน /v1/chat/completions endpoint. endpoint. ระบุ ID ของโมเดลเป็น uncensored ใน body ของคำขอ API ส่งคืนข้อความที่สร้างตามประวัติ prompt ของคุณ คุณสามารถปรับพารามิเตอร์เช่น temperature และ top_p เพื่อควบคุมความคิดสร้างสรรค์ โมเดลรองรับ function calling และโหมด JSON สำหรับผลลัพธ์ที่มีโครงสร้าง

Copyfrom openai import OpenAI

client = OpenAI(base_url="https://api.apikeykimi.com/v1", api_key="YOUR_KEY")

resp = client.chat.completions.create(
    model="uncensored",
    messages=[{"role": "user", "content": "Summarise this thread without softening it."}],
)
print(resp.choices[0].message.content)

การตอบกลับแบบสตรีมมิ่ง (SSE)

เปิดใช้งานการจัดส่งโทเค็นแบบเรียลไทม์โดยตั้งค่า stream: true ในการร้องขอของคุณ เซิร์ฟเวอร์ส่งสตรีม Server-Sent Events แต่ละชิ้นส่วนมีข้อความบางส่วนจนกว่าคำตอบจะสมบูรณ์ วิธีนี้เหมาะสำหรับอินเทอร์เฟซแชทและการแสดงโค้ดสด รายละเอียดการใช้งานโทเค็นจะปรากฏในชิ้นส่วนสุดท้ายของสตรีม

Copystream = client.chat.completions.create(
    model="uncensored",
    messages=[{"role": "user", "content": "Tell the story in second person."}],
    stream=True,
)
for chunk in stream:
    if chunk.choices and chunk.choices[0].delta.content:
        print(chunk.choices[0].delta.content, end="", flush=True)

การเรียกใช้ฟังก์ชัน & โหมด JSON

กำหนดเครื่องมือหรือบังคับให้ส่งออก JSON โดยใช้ response_format พารามิเตอร์ ตั้ง json_object เพื่อให้แน่ใจว่าได้รับคำตอบเป็น JSON ที่ถูกต้อง คุณสามารถส่งคำจำกัดความของเครื่องมือสำหรับการเรียกใช้ฟังก์ชันได้ โมเดลจะปฏิบัติตามข้อจำกัดเหล่านี้อย่างเคร่งครัด ซึ่งช่วยให้สามารถผสานรวมกับบริการภายนอกได้อย่างน่าเชื่อถือ ใช้ tool_choice เพื่อควบคุมวิธีการเรียกใช้เครื่องมือ

ขีดจำกัดโทเค็น & ข้อจำกัด

หน้าต่างบริบทรองรับได้สูงสุด 100,000 tokens สำหรับ input และ output รวมกัน ผลลัพธ์สูงสุดต่อการเรียกคือ 16,000 tokens หากไม่ได้ตั้งค่า max_tokens, ค่าเริ่มต้นคือ 2,048 tokens Requests ถูกจำกัดที่ 8 MB ในขนาด body คุณจำกัดอยู่ที่ 300 requests ต่อนาที มีเพียง 8 requests ที่สามารถทำงานพร้อมกันได้ต่อ key

การจัดการข้อผิดพลาด & ขีดจำกัดการใช้งาน

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

Node.js

Copyimport OpenAI from "openai";

const client = new OpenAI({ baseURL: "https://api.apikeykimi.com/v1", apiKey: process.env.API_KEY });

const resp = await client.chat.completions.create({
  model: "uncensored",
  messages: [{ role: "user", content: "Draft a villain monologue for my game." }],
});
console.log(resp.choices[0].message.content);