เอกสาร API

เริ่มต้นใช้งาน: คำขอแรกของคุณ

ส่งข้อความแรกไปยังโมเดล uncensored ได้ทันที ใช้ endpoint chat-completions มาตรฐานเพื่อสร้างข้อความ โมเดลจะตอบสนองต่อ prompt ภาษาธรรมชาติโดยไม่มีการปฏิเสธเนื้อหาสำหรับการใช้งานผู้ใหญ่ที่ถูกต้องตามกฎหมาย การตั้งค่านี้ใช้งานได้กับไคลเอนต์ที่เข้ากันได้กับ OpenAI ใดๆ

เริ่มต้นด้วยการติดตั้ง SDK สำหรับภาษาที่คุณต้องการ จากนั้นกำหนดค่า API key ของคุณ ตัวอย่างต่อไปนี้แสดงคำขอ curl พื้นฐานเพื่อทดสอบการเชื่อมต่อ

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

Copycurl https://api.apiaicharacter.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "What is the current API rate limit status?"}]
  }'

URL ฐานและการตรวจสอบสิทธิ์

เชื่อมต่อโดยใช้ URL พื้นฐานเฉพาะเจาะจงสำหรับ API นี้ แทนที่จุดเริ่มต้นเริ่มต้นด้วยที่อยู่เซิร์ฟเวอร์ที่โฮสต์ของเรา เพื่อให้แน่ใจว่าคำขอของคุณไปถึงโมเดลแบบไม่มีข้อจำกัด (uncensored) โดยตรง การตรวจสอบสิทธิ์ขึ้นอยู่กับคีย์ API เดียวต่อบัญชี

สร้างคีย์ของคุณผ่านแดชบอร์ด ส่งคีย์ในหัว Authorization เป็น Bearer token วิธีนี้เข้ากันได้กับ SDK ของ OpenAI มาตรฐาน คุณสามารถเปลี่ยนผู้ให้บริการได้โดยการเปลี่ยนเฉพาะ URL พื้นฐานและคีย์

รักษาความมั่นคงปลอดภัยของคีย์ของคุณ คีย์นี้ให้การเข้าถึงเต็มต่อยอดเครดิตที่เติมเงินไว้ คีย์จะแทนที่คีย์ที่ใช้งานก่อนหน้าทันทีหลังจากการสร้าง

จุดปลาย: Chat Completions

โต้ตอบกับโมเดลผ่านเอนดพอยต์ chat completions นี่คือเอนดพอยต์การสร้างข้อความเพียงอย่างเดียวที่พร้อมใช้งาน มันรับข้อความและส่งกลับข้อความที่สร้าง ไม่มี embeddings รูปภาพ หรือเสียงรองรับ

ส่งคำขอ POST ไปยัง route chat รวมข้อความระบบและข้อความผู้ใช้ของคุณใน body โมเดลประมวลผลบริบทและสร้างข้อความตอบกลับ คุณสามารถใช้โหมด JSON สำหรับผลลัพธ์ที่มีโครงสร้าง

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

Copyfrom openai import OpenAI

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

พารามิเตอร์: อุณหภูมิ (Temperature), Top P และ Stop

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

ใช้ top P เพื่อกรองคำที่มีโอกาสน้อย ช่วยรักษาความสอดคล้องในขณะที่อนุญาตให้เกิดความคิดสร้างสรรค์ ตั้งค่าลำดับหยุด (stop sequences) เพื่อสิ้นสุดการสร้างที่เครื่องหมายเฉพาะ ซึ่งจะมีประโยชน์สำหรับการควบคุมโครงสร้างการสนทนา

พารามิเตอร์ seed ช่วยให้ได้ผลลัพธ์ที่ทำซ้ำได้ ใช้เมื่อกำลังดีบักพรอมต์ของคุณ พารามิเตอร์เหล่านี้ให้คุณควบคุมพฤติกรรมของโมเดลได้อย่างแม่นยำ ปรับแต่งให้ตรงกับความต้องการของแอปพลิเคชันของคุณ

Copyimport OpenAI from "openai";

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

การใช้งานโทเค็นและการสตรีม

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

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

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

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)

อัตราจำกัดและข้อจำกัด

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

จัดการข้อผิดพลาดอย่างสุภาพ สถานะ 401 หมายถึงคีย์ของคุณไม่ถูกต้อง สถานะ 402 หมายถึงเครดิตไม่เพียงพอ สถานะ 429 หมายถึงคุณเกินขีดจำกัดอัตราการใช้งาน

หน้าต่างบริบทรองรับ 100,000 tokens รวมกัน ซึ่งรวมถึง prompt และ completion ด้วย โดย output สูงสุดคือ 16,000 tokens ต่อการเรียก ตั้งค่า max_tokens เพื่อควบคุมความยาวของ output เนื่องจาก error ฟรี การทำ retry logic จึงปลอดภัย