เอกสาร API

Authentication

ส่งคีย์ API ของคุณใน Authorization header เป็น Bearer token คุณจะได้รับคีย์นี้ทันทีหลังจากสมัครสมาชิกด้วย Google หรืออีเมลที่ รับ API key หน้าเว็บ หากคุณสร้างคีย์ใหม่ มันจะแทนที่คีย์เก่าทันที ข้อผิดพลาดเช่นคีย์ที่ไม่ถูกต้องจะส่งกลับ 401 สถานะ ความผิดพลาดเช่นการเรียกเก็บเงินสองครั้งจะถูกแก้ไขผ่านหน้าการสนับสนุน

จุดจบ API Chat Completions

ส่ง JSON ไปยัง POST /v1/chat/completions เพื่อรับการตอบกลับแบบข้อความ นี่คือเอนด์พอยต์เดียวสำหรับการสร้างข้อความ มันไม่รองรับ embeddings รูปภาพ หรือเสียง

ตั้งค่า model field to "uncensored". โมเดลตอบโดยไม่มีการปฏิเสธเนื้อหาสำหรับการใช้งานผู้ใหญ่ที่ถูกต้องกฎหมาย มันเป็นโมเดลโอเพนเวตที่ปรับแต่งสำหรับการส่งออกที่ไม่ถูกจำกัด มันไม่ใช่ GPT Claude หรือโมเดลของผู้จัดจำหน่ายรายอื่น

เอนด์พอยต์โมเดล

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

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

Parameters & Options

รองรับพารามิเตอร์มาตรฐานเช่น temperature, top_p, stop, seed, presence_penalty, และ frequency_penalty. ตั้งค่า max_tokens เพื่อควบคุมความยาวของผลลัพธ์ ค่าเริ่มต้นคือ 2,048 โทเค็น หากคุณละเว้นฟิลด์นี้

หน้าต่างบริบทมีขนาด 100,000 tokens สำหรับ prompt และ completion รวมกัน คำขอที่เกินขนาด body 8 MB อาจล้มเหลว การเรียกใช้ฟังก์ชันและโหมด JSON ยังรองรับผ่านฟิลด์มาตรฐาน

การตอบกลับแบบสตรีมมิ่ง

เปิดใช้งานการสตรีมโดยตั้งค่า stream: true.คุณได้รับ Server-Sent Events (SSE) ขณะที่ tokens ถูกสร้าง ซึ่งช่วยลดความล่าช้าที่รับรู้ได้สำหรับแอปพลิเคชันแบบอินเทอร์แอคทีฟ

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

การเรียกใช้ฟังก์ชัน & โหมด JSON

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

ตั้งค่า tool_choice เพื่อควบคุมวิธีที่โมเดลใช้ฟังก์ชัน โมเดลรองรับทั้งการใช้งานเครื่องมืออัตโนมัติและแบบบังคับ สิ่งนี้รับประกันการผสานรวมที่เชื่อถือableกับตรรกะแบ็กเอนด์ของคุณ

cURL

Copycurl https://api.mistralaiapikey.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "what is the api limit for this service"}]
  }'

Python

Copyfrom openai import OpenAI

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