Codex API Quickstart

การติดตั้งและการตั้งค่า

The codex api ต้องการคีย์ที่ถูกต้องและ URL ฐานที่ถูกต้อง ลงทะเบียนผ่าน Google หรืออีเมลเพื่อรับคีย์ของคุณทันที ไม่ต้องใช้หมายเลขโทรศัพท์ ใช้ SDK ทางการของ OpenAI โดยตั้งค่า base_url เพื่อ https://api.codexfiyat.com/v1.

การตรวจสอบสิทธิ์ใช้มาตรฐาน Authorization: Bearer header บัญชีแต่ละบัญชีมีคีย์ที่ใช้งานได้นี้หนึ่งคีย์ การสร้างคีย์ใหม่จะเพิกถอนคีย์ก่อนหน้าทันที ซึ่งช่วยให้ง่ายต่อการหมุนเวียนคีย์โดยไม่ต้องจัดการข้อมูลรับรองหลายรายการ

ตัวอย่างคำขอพื้นฐาน

ส่งคำขอ completion ไปยัง uncensored โมเดลโดยใช้ไคลเอนต์ HTTP ใดๆ จุดปลายยอมรับพารามิเตอร์มาตรฐานเช่น temperature และ top_p. กำหนดค่าไคลเอนต์ของคุณให้จัดการ response JSON ได้อย่างมีประสิทธิภาพ

• ตั้งค่าโมเดลเป็น uncensored.
• รวมคำสั่งระบบของคุณสำหรับบริบท
• กำหนดข้อความผู้ใช้ใน messages อาร์เรย์

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

การสตรีมมิ่ง Yanitlar

เปิดใช้งานการสตรีมโดยตั้งค่า stream: true ในการร้องขอของคุณ API ส่งคืนเหตุการณ์ที่ส่งโดยเซิร์ฟเวอร์ (SSE) สำหรับการส่งโทเค็นแบบเรียลไทม์ แยกวิเคราะห์แต่ละชิ้นเพื่อแสดงข้อความแบบเพิ่มทีละน้อยให้กับผู้ใช้ของคุณ

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

Tool Calling (Function Calling)

กำหนดฟังก์ชันใน tools พารามิเตอร์เพื่อเปิดใช้งานการเรียกใช้เครื่องมือ โมเดลส่งกลับการเรียกใช้ฟังก์ชันในรูปแบบ JSON ที่มีโครงสร้าง ใช้ tool_choice: auto สำหรับการตรวจจับอัตโนมัติ

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

โหมด JSON

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

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

ขีดจำกัดและขอบเขต

API กำหนดขีดจำกัดที่เข้มงวดเพื่อความเสถียร คุณสามารถส่งคำขอได้ 300 ครั้งต่อนาทีต่อคีย์ ขีดจำกัดความพร้อมเพรียง (concurrency) จำกัดไว้ที่ 8 คำขอพร้อมกัน หน้าต่างบริบทสูงสุดรองรับ 100,000 tokens

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

cURL

Copycurl https://api.codexfiyat.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "list available server configurations for ubuntu"}]
  }'

Python

Copyfrom openai import OpenAI

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