KiApi เอกสาร: ผสานใน 5 นาที

เริ่มต้น: base_url และการตรวจสอบสิทธิ์

KiApi เข้ากันได้กับ OpenAI API อย่างสมบูรณ์ คุณสามารถใช้ระบบนิเวศของ SDK และไคลเอนต์ที่มีอยู่ได้โดยการปรับ base_url URL พื้นฐานสำหรับคำขอทั้งหมดคือ https://api.kiapis.com/v1 การตรวจสอบสิทธิ์ทำผ่านคีย์ API เท่านั้น ซึ่งคุณจะได้รับหลังจากลงทะเบียนในหน้าแดชบอร์ดของคุณ คีย์นี้ต้องส่งใน HTTP header Authorization: Bearer <IHR_API_SCHLÜSSEL> คุณสามารถสร้างคีย์ใหม่ได้ตลอดเวลา ซึ่งจะทำให้คีย์เก่ายกเลิก

ต่างจากบริการอื่น เราไม่เสนอเอนด์พอยต์ที่ซับซ้อนสำหรับ embedding หรือ fine-tuning จุดเน้นของเราคือการสร้างข้อความล้วนๆ KiApi คือการเชื่อมต่อโดยตรงของคุณไปยังโมเดลที่ปรับให้ตอบแบบไม่เซ็นเซอร์ ตรวจสอบให้แน่ใจว่าคุณตั้งค่าสภาพแวดล้อมให้ถูกต้องก่อนส่งคำขอครั้งแรก

POST /v1/chat/completions: การสร้างข้อความ

หัวใจของ API คือเอนด์พอยต์ POST /v1/chat/completions ที่นี่คุณส่งรายการข้อความ (ระบบ ผู้ใช้ ผู้ช่วย) และรับข้อความตอบกลับ พารามิเตอร์ model ID ต้องตั้งค่าเป็น uncensored การตอบกลับเป็นแบบซิงโครนัสและให้ข้อความที่สร้างพร้อมข้อมูลการใช้โทเคนทันที

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

Kopierencurl https://api.kiapis.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Write a blunt product review of a cheap VPN."}]
  }'

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

สตรีมมิงด้วย Server-Sent Events (SSE)

สำหรับแอปพลิเคชันที่ต้องการผลลัพธ์ทันที KiApi รองรับสตรีมมิงผ่าน Server-Sent Events (SSE) เปิดใช้งานโดยตั้งค่า "stream": true ใน body ของคำขอ แทนที่จะรอการตอบกลับสมบูรณ์ คุณจะรับสตรีมของ JSON patches ที่มีข้อความที่สร้างทีละส่วน

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

Kopierenstream = 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)

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

การเรียกใช้เครื่องมือและการเรียกฟังก์ชัน

โมเดลรองรับ Tool Calling หรือที่เรียกว่า Function Calling สิ่งนี้ทำให้ LLM สามารถส่งคืนข้อมูล JSON ที่มีโครงสร้างซึ่งแสดงถึงฟังก์ชันหรือการกระทำเฉพาะในแอปพลิเคชันของคุณ คุณกำหนดเครื่องมือที่มีอยู่ใน body ของคำขอและโมเดลจะตัดสินใจตามอินพุตของผู้ใช้ว่าควรเรียกใช้เครื่องมือใด

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

Kopierenfrom openai import OpenAI

client = OpenAI(base_url="https://api.kiapis.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)

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

GET /v1/models: โมเดลที่มีอยู่

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

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

Kopierenimport OpenAI from "openai";

const client = new OpenAI({ baseURL: "https://api.kiapis.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);

ใช้เอนด์พอยต์นี้เพื่อให้แอปพลิเคชันของคุณรองรับการเปลี่ยนแปลงในอนาคต หากเพิ่มโมเดลใหม่ โมเดลเหล่านั้นจะปรากฏในรายการนี้โดยอัตโนมัติ โมเดลปัจจุบัน uncensored เป็นโมเดลเดียวที่มีอยู่และอธิบายว่าเป็นโมเดลภาษาขนาดใหญ่ที่ปรับให้เหมาะกับเนื้อหาแบบไม่เซ็นเซอร์

ขีดจำกัดอัตราและรหัสข้อผิดพลาด

เพื่อรักษาความเสถียรของบริการ มีขีดจำกัดที่กำหนดไว้ คีย์ API แต่ละรายการอนุญาตคำขอได้ 300 คำขอต่อนาที body ของคำขอสูงสุดคือ 8 MB หากคุณเกินขีดจำกัดเหล่านี้คุณจะรับรหัสสถานะ HTTP 429 Too Many Requests วางแผนแอปพลิเคชันของคุณเพื่อใช้งานการลองใหม่แบบ exponential backoff

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

หน้าต่างบริบทคือ 100,000 โทเคนสำหรับอินพุตและเอาต์พุตรวมกัน หากเกินขีดจำกัดนี้จะส่งข้อความข้อผิดพลาด KiApi เป็นโซลูชันที่เชื่อถือได้สำหรับนักพัฒนาที่ชื่นชอบกฎที่ชัดเจนและขีดจำกัดที่โปร่งใส