สรุปข้อกำหนด
หากคุณมีโค้ดที่ทำงานกับ OpenAI อยู่แล้ว เวอร์ชันย่อของสเปค API ที่เข้ากันได้กับ OpenAI คือ: เปลี่ยน base URL, เปลี่ยนคีย์ API, ตั้งค่าโมเดลเป็น uncensored ข้อมูลใน body ของคำขอและการตอบกลับมีโครงสร้างตาม chat completions ดังนั้น SDK จึงสามารถแยกวิเคราะห์ได้โดยไม่ต้องแก้ไข
| รายการ | ค่า |
|---|---|
| URL พื้นฐาน | https://api.unrestrictedaiapi.com/v1 |
| การตรวจสอบสิทธิ์ | Authorization: Bearer YOUR_KEY |
| เอนด์พอยต์ | POST /v1/chat/completions, GET /v1/models |
| ID โมเดล | uncensored |
| หน้าต่างบริบท | 100,000 โทเคน, รวมพรอมต์และผลลัพธ์ |
| ขนาดสูงสุดของ body คำขอ | 8 MB |
| เอาต์พุต | ข้อความเท่านั้น |
โมเดลเป็นโมเดลแบบเปิดน้ำหนักเพียงตัวเดียวที่ให้บริการโดยผู้ให้บริการอิสระและปรับแต่งเพื่อตอบคำถามโดยไม่มีการปฏิเสธเนื้อหาสำหรับการใช้งานผู้ใหญ่ที่ถูกต้องตามกฎหมาย ไม่ใช่เอนด์พอยต์ทางการของผู้จัดจำหน่ายโมเดลรายใดรายหนึ่ง และไม่มีการเปลี่ยนเส้นทางระหว่างผู้จัดจำหน่าย นั่นคือเหตุผลที่มี ID โมเดลเพียงตัวเดียวและรายการโมเดลสั้น
เอนด์พอยต์
GET /v1/models
คืนค่าโมเดลที่มีให้สำหรับคีย์ของคุณ เป็นวิธีที่ประหยัดที่สุดในการยืนยันว่าคีย์และ Base URL ของคุณถูกต้อง และไคลเอนต์ UI หลายรายเรียกใช้เพื่อเติมข้อมูลลงในรายการแบบเลื่อนลง
curl https://api.unrestrictedaiapi.com/v1/models \
-H "Authorization: Bearer $KEY"
POST /v1/chat/completions
เอนด์พอยต์สำหรับการสร้างข้อความเพียงอย่างเดียว คุณส่งอาร์เรย์ของวัตถุ messages ที่มี role (system, user, assistant หรือ tool) และ content รวมถึงโมเดลและตัวเลือกการสุ่มใดๆ ตัวอย่างการเรียกใช้งานอย่างง่าย:
curl https://api.unrestrictedaiapi.com/v1/chat/completions \
-H "Authorization: Bearer $KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "uncensored",
"messages": [
{"role": "system", "content": "Answer in one sentence."},
{"role": "user", "content": "What is a base URL?"}
]
}'
คำตอบจะประกอบด้วยข้อความที่สร้างแล้วใน choices[0].message.content และจำนวนโทเคนใน usage จำนวนโทเคนเหล่านี้คือสิ่งที่การเรียกเก็บเงินอ้างอิงตาม
ไม่ให้บริการ: เอนด์พอยต์ completions แบบเก่า, embeddings, ภาพ, เสียงและวิดีโอ, fine-tuning และเอนด์พอยต์ไฟล์ ไคลเอนต์ที่เรียกใช้เอนด์พอยต์เหล่านี้จะได้รับข้อผิดพลาด ดังนั้นให้ปิดคุณสมบัตินั้นๆ ในเครื่องมือที่ตั้งค่าเริ่มต้นให้ใช้เอนด์พอยต์เหล่านี้
พารามิเตอร์ของคำขอ
พารามิเตอร์เหล่านี้ได้รับการยอมรับและส่งต่อไปยังโมเดล:
temperatureและtop_pสำหรับการสุ่มตัวอย่างstopสำหรับลำดับหยุดหนึ่งหรือหลายลำดับseedสำหรับการสุ่มตัวอย่างที่ซ้ำกันได้เมื่อคุณตั้งค่าอื่นๆ เหมือนกันpresence_penaltyและfrequency_penaltyเพื่อลดการซ้ำซ้อนmax_tokensซึ่งเป็นตัวเลือก หากไม่ระบุ การสร้างข้อความสามารถใช้พื้นที่ที่เหลือของหน้าต่าง 100,000 โทเคนได้streamสำหรับเหตุการณ์ที่ส่งจากเซิร์ฟเวอร์toolsและtool_choiceสำหรับการเรียกใช้ฟังก์ชันresponse_formatพร้อม{"type":"json_object"}สำหรับโหมด JSON
ข้อควรพิจารณาเชิงปฏิบัติสองประการ ประการแรก หน้าต่างบริบทนับรวมพรอมต์และการสร้างคำตอบรวมกัน ดังนั้นพรอมต์ขนาด 90,000 โทเคน จะเหลือพื้นที่ประมาณ 10,000 โทเคนสำหรับการตอบกลับ ประการที่สอง ข้อจำกัดของ body คือ 8 MB ซึ่งมากกว่าความต้องการของข้อความ 100,000 โทเคนมาก ดังนั้นคุณจึงจะถึงขีดจำกัดนี้เฉพาะเมื่อฝัง payload ที่เข้ารหัสขนาดใหญ่ในข้อความเท่านั้น
สตรีมมิง
ตั้งค่า stream: true และการตอบกลับจะมาถึงในรูปแบบเหตุการณ์ที่ส่งจากเซิร์ฟเวอร์ แต่ละเหตุการณ์คือชิ้นส่วน JSON ที่มี delta เก็บข้อความชิ้นถัดไป และข้อมูลการใช้งานจะรายงานที่ตอนท้ายของสตรีม SDK ซ่อนโครงสร้างพื้นฐาน; ด้วยโปรโตคอลดิบคุณอ่านบรรทัดที่ขึ้นต้นด้วย data: จนกว่าสตรีมจะปิด
from openai import OpenAI
client = OpenAI(base_url="https://api.unrestrictedaiapi.com/v1", api_key="YOUR_KEY")
with client.chat.completions.create(
model="uncensored",
messages=[{"role": "user", "content": "List five HTTP status codes."}],
stream=True,
) as stream:
for chunk in stream:
if chunk.choices and chunk.choices[0].delta.content:
print(chunk.choices[0].delta.content, end="")
กฎหนึ่งข้อที่ส่งผลต่อการวางแผนความจุ: คำขอแบบสตรีมจะครอบครองช่องความพร้อมใช้งานพร้อมกันจนกว่าสตรีมจะสิ้นสุด ไม่ใช่จนกว่าโทเคนแรกจะมาถึง หากไคลเอนต์ค้างขณะอ่านข้อมูล ช่องนี้จะยังคงถูกใช้งานอยู่เสมอ ให้ปิดหรือสิ้นสุดสตรีม และตั้งค่าเวลาหมดอายุของไคลเอนต์
การเรียกใช้ฟังก์ชันและโหมด JSON
การเรียกใช้ฟังก์ชัน
ส่ง tools เป็นรายการคำจำกัดความของฟังก์ชันที่มีพารามิเตอร์เป็น JSON Schema หากโมเดลตัดสินใจเรียกใช้ฟังก์ชันหนึ่ง ข้อความจะประกอบด้วย tool_calls ซึ่งจะถูกสตรีมเมื่อ stream เปิดอยู่ คุณเรียกใช้ฟังก์ชันและส่งผลลัพธ์กลับเป็นข้อความที่มี role: "tool" และ tool_call_id ที่ตรงกัน ใช้ tool_choice เพื่อบังคับใช้ฟังก์ชันเฉพาะหรือปล่อยให้โมเดลตัดสินใจ
{
"model": "uncensored",
"messages": [{"role": "user", "content": "Weather in Oslo?"}],
"tools": [{
"type": "function",
"function": {
"name": "get_weather",
"description": "Current weather for a city",
"parameters": {
"type": "object",
"properties": {"city": {"type": "string"}},
"required": ["city"]
}
}
}]
}
โมเดลเสนอข้อโต้แย้ง; โมเดลไม่ได้ดำเนินการใดๆ ตรวจสอบข้อโต้แย้งก่อนดำเนินการกับมัน เช่นเดียวกับที่คุณทำกับข้อมูลผู้ใช้ทั่วไป
โหมด JSON
เพิ่ม "response_format": {"type": "json_object"} เพื่อขอวัตถุ JSON ที่ถูกต้องเพียงชิ้นเดียว เช่นเดียวกับวิธีการทำงานแบบ OpenAI อื่นๆ ให้บอกโมเดลในพรอมต์ว่าคุณต้องการคีย์ใด เช่น "ส่งคืนออบเจกต์ที่มีคีย์ title และ tags" แยกวิเคราะห์ผลลัพธ์ใน try block เสมอ และตั้งค่า max_tokens ให้สูงพอเพื่อไม่ให้วัตถุที่ยาวถูกตัด
ขีดจำกัด เฮดเดอร์ และข้อผิดพลาด
| ประเภทคีย์ | คำขอพร้อมกัน | คำขอต่อนาที |
|---|---|---|
| คีย์เต็ม | 8 | 300 |
| คีย์ทดลอง | 2 | 60 |
ทุกการตอบกลับจะมี X-Request-Id (ระบุค่านี้เมื่อติดต่อ ฝ่ายสนับสนุน), X-Balance-USD (เครดิตคงเหลือของคุณ), X-RateLimit-Limit-Requests และ X-RateLimit-Limit-Concurrency
เมื่อคุณเกินขีดจำกัด API จะส่ง HTTP 429 กลับมา รหัสข้อผิดพลาดจะแยกกรณีดังนี้:
rate_limited: คำขอมากเกินไปในหนึ่งนาที ลดความเร็วหรือกระจายโหลดconcurrency: มีคำขอที่กำลังดำเนินการอยู่พร้อมกันมากเกินไป ให้จัดคิวคำขอที่ฝั่งของคุณ- 429 พร้อมเฮดเดอร์
Retry-After: 5: เกิดการโอเวอร์โหลดชั่วคราว รอห้าวิแล้วลองใหม่
import time
import httpx
def post_with_retry(payload, key, tries=4):
# payload example: {"model": "uncensored", "messages": [...]}
for attempt in range(tries):
r = httpx.post(
"https://api.unrestrictedaiapi.com/v1/chat/completions",
headers={"Authorization": "Bearer " + key},
json=payload,
timeout=120,
)
if r.status_code == 429:
wait = int(r.headers.get("Retry-After", 2 ** attempt))
time.sleep(wait)
continue
return r
return r
คำขอที่ล้มเหลวหรือถูกปฏิเสธจะไม่ถูกคิดเงิน
บทบาท ประวัติ และออบเจกต์การตอบกลับ
API เป็นแบบไร้สถานะ (stateless) ไม่จำคำขอในอดีต ดังนั้นการสนทนาจึงมีอยู่เฉพาะในอาร์เรย์ messages ที่คุณส่งทุกครั้ง ประวัติทั่วไปจะเริ่มด้วยข้อความ system หนึ่งข้อความเพื่อตั้งค่าพฤติกรรม ตามด้วยข้อความ user และ assistant สลับกัน เมื่อมีการเรียกใช้ฟังก์ชัน ข้อความ tool จะปรากฏระหว่างนั้น โดยแต่ละข้อความจะเชื่อมโยงกับการเรียกใช้ผ่าน tool_call_id
สิ่งนี้มีสองผลกระทบ ประการแรกคือค่าใช้จ่าย: ทุกรอบต้องจ่ายสำหรับประวัติทั้งหมดเป็นข้อมูลนำเข้า ดังนั้นการสนทนาที่ยาวนานจึงมีค่าใช้จ่ายต่อข้อความมากขึ้นแม้ว่าแต่ละคำถามจะสั้นก็ตาม ประการที่สองคือความควบคุม: คุณสามารถแก้ไข ตัดแต่ง หรือเขียนประวัติใหม่ได้ตามต้องการ การตัดรอบเก่าออกแทนที่ด้วยบทสรุป หรือฉีดข้อความจากโมเดลที่แก้ไขแล้ว ล้วนเป็นปฏิบัติการปกติ และโมเดลจะมองว่าสิ่งที่คุณส่งไปคือความจริง
ในการตอบกลับ อ่านสามสิ่ง choices[0].message เก็บข้อความหรือการเรียกใช้ฟังก์ชัน choices[0].finish_reason บอกเหตุผลที่การสร้างหยุดลง: จบตามธรรมชาติ, ถึงขีดจำกัดโทเคน หรือมีการเรียกใช้ฟังก์ชัน usage เก็บจำนวนโทเคนพรอมต์ การสร้างข้อความ และรวม หาก finish reason บอกว่าถึงขีดจำกัดโทเคน ข้อความจะถูกตัด และคุณควรเพิ่มขีดจำกัดหรือขอให้โมเดลดำเนินการต่อในรอบถัดไป
รายการตรวจสอบความเข้ากันได้แบบสั้น
ก่อนปล่อยไคลเอนต์เข้ากับเอนด์พอยต์นี้ ให้ตรวจสอบรายการเหล่านี้เพื่อจับปัญหาการอินทิเกรตส่วนใหญ่ภายในไม่กี่นาที
- เรียก
GET /v1/modelsด้วยคีย์ของคุณและยืนยันว่าคุณได้รับรายการที่มีuncensored - ส่งคำขอแชทธรรมดาโดยไม่ระบุตัวเลือกและยืนยันการตอบกลับปกติที่มีบล็อก
usage - ทำซ้ำด้วย
stream: trueและยืนยันว่าไคลเอนต์ของคุณจัดการจุดสิ้นสุดของสตรีมและข้อมูลการใช้งานสุดท้ายได้ - หากคุณใช้เครื่องมือ ให้ส่งการเรียกใช้เครื่องมือแบบไปกลับครบวงจร รวมถึงคำขอติดตามด้วยข้อความ
tool - ยิง 10 คำขอพร้อมกันบนคีย์ทดลองและยืนยันว่าโค้ดของคุณรับมือกับ 429 ที่ตามมาหลังคำขอพร้อมกันครั้งที่สองได้
- บันทึก
X-Request-Idสำหรับการเรียกใช้ทุกครั้ง เพื่อให้สามารถติดตามผลลัพธ์ที่ผิดปกติได้ในภายหลัง
การผ่านทั้งหกข้อหมายความว่าไคลเอนต์ของคุณพร้อมสำหรับการใช้งานจริง
จุดที่แตกต่างจากแพลตฟอร์ม OpenAI แบบเต็มรูปแบบ
ความเข้ากันได้หมายถึงโปรโตคอลการแชท ไม่ใช่แพลตฟอร์มทั้งหมด ฟีเจอร์นอกเหนือจากแชทข้อความไม่มีอยู่ และพฤติกรรมบางอย่างมาจากโมเดล ไม่ใช่โปรโตคอล ชื่อโมเดลจะคงที่ คำตอบอาจมีสไตล์แตกต่างจากโมเดลที่คุณเคยใช้มาก่อน และการสุ่มตัวอย่างด้วย seed ที่เหมือนกันจะทำซ้ำได้เฉพาะเมื่อพรอมต์และพารามิเตอร์ยังคงเหมือนเดิม
กฎเนื้อหาข้อเดียวที่คุณไม่สามารถเปลี่ยนได้คือการบล็อกเนื้อหาทางเพศที่เกี่ยวข้องกับผู้เยาว์ นอกเหนือจากนั้น โมเดลถูกปรับให้หลีกเลี่ยงการปฏิเสธสำหรับการใช้งานผู้ใหญ่ที่ถูกต้องตามกฎหมาย และพรอมต์ไม่ถูกใช้ในการฝึกฝน
สำหรับโค้ดในห้าภาษา ดู เริ่มต้นอย่างรวดเร็ว สำหรับเทคนิคการเขียนพรอมต์ อ่าน การเขียนพรอมต์สำหรับโมเดลที่ไม่มีข้อจำกัด และสำหรับด้านบัญชี ราคา ระบุอัตรา: $0.15 ต่อ 1M โทเคนข้อมูลนำเข้า และ $0.50 ต่อ 1M โทเคนข้อมูลส่งออก พร้อมเครดิตที่ไม่หมดอายุ เอกสาร มีสเปคเดียวกันในรูปแบบย่อ
