เริ่มต้น: API Chat Completions

ข้อกำหนดเบื้องต้นและ URL ฐาน

API ของเราเข้ากันได้กับอินเทอร์เฟซการตอบกลับแชทมาตรฐานของ OpenAI คุณต้องการเพียง base URL และ API key เพื่อเริ่มส่งคำขอ base URL คือ HTTPS://api.howmuchisanapikey.com/v1 จุดเชื่อมต่อเดียวนี้จัดการการสร้างข้อความทั้งหมดโดยไม่ต้องให้คุณจัดการ URL ของบริการหลายรายการหรือการกำหนดค่าพร็อกซี

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

Authentication and headers

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

คุณไม่จำเป็นต้องส่งหัวข้อความเพิ่มเติมสำหรับการสร้างข้อความพื้นฐาน อย่างไรก็ตาม หากคุณใช้ฟีเจอร์เฉพาะเช่น โหมด JSON หรือการเรียกใช้ฟังก์ชัน คุณต้องตั้งค่าหัว Content-Type เป็น application/json เพื่อบอกเซิร์ฟเวอร์ให้วิเคราะห์ร่างกายคำขอของคุณได้อย่างถูกต้อง

การส่ง chat completion ครั้งแรกของคุณ

ส่งคำขอ POST ไปยัง /v1/chat/completions พร้อมประวัติข้อความของคุณและตัวระบุโมเดล id โมเดลคือ "uncensored" โมเดลนี้ปรับแต่งเพื่อตอบโดยไม่มีการปฏิเสธสำหรับเนื้อหาผู้ใหญ่ที่ถูกต้องตามกฎหมาย เรื่องเล่า หรือหัวข้อที่ถกเถกัน ไม่มีการกรองตามบรรทัดฐานทางการเมืองหรือสังคมมาตรฐาน

นี่คือตัวอย่าง curl พื้นฐานเพื่อเริ่มต้นใช้งาน:

Copycurl https://api.howmuchisanapikey.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Generate a simple hello world function in python"}]
  }'

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

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

ใช้ Server-Sent Events (SSE) เพื่อรับโทเค็นเมื่อมันถูกสร้าง สิ่งนี้ช่วยลดความหน่วงที่รับรู้สำหรับผลลัพธ์ที่ยาว ตั้งค่าพารามิเตอร์ stream เป็น true ใน body ของคำขอ เซิร์ฟเวอร์จะส่งหลาย chunk แต่ละ chunk มี delta ส่วนหนึ่งของคำตอบ

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

การเรียกฟังก์ชันและโหมด JSON

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

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

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

คุณจำกัดการใช้งานที่ 300 คำขอต่อนาทีต่อคีย์ และ 8 คำขอพร้อมกัน หากคุณเกินขีดจำกัดเหล่านี้ คุณจะได้รับข้อผิดพลาด 429 Too Many Requests body ของการตอบกลับจะรวมถึงรายละเอียด retry-after ปรับการจำกัดอัตราการใช้งานฝั่งไคลเอนต์เพื่อหลีกเลี่ยงการลองใหม่ที่ไม่จำเป็น

หากเครดิตแบบเติมเงินของคุณหมดแล้ว API จะส่งกลับข้อผิดพลาด 402 Payment Required คุณสามารถเติมเงินผ่านคริปโตได้ตลอดเวลา ข้อผิดพลาดและการปฏิเสธนั้นฟรี ดังนั้นคุณจึงจ่ายเฉพาะสำหรับการสร้างโทเค็นที่สำเร็จเท่านั้น หน้าต่างบริบทมีขนาด 100,000 โทเค็นสำหรับ prompt และการสร้างผลลัพธ์รวมกัน

Python

Copyfrom openai import OpenAI

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

Node.js

Copyimport OpenAI from "openai";

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

การสตรีม

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)