MiniMax api: Quickstart and SDK Guide

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

ใช้คีย์ API ที่จัดเตรียมไว้และชี้ไคลเอนต์ของคุณไปยัง URL พื้นฐานเฉพาะ เอนด์พอยต์สำหรับการสร้างการตอบกลับคือ https://api.minimaxaiapi.com/v1/chat/completions.คุณส่งคีย์ใน Authorization header เป็น bearer token สิ่งนี้ใช้งานได้กับ SDK ทางการของ OpenAI ใดๆ ก็ได้เนื่องจากเราปฏิบัติตามโปรโตคอลเดียวกัน

• ชื่อส่วนหัว: Authorization
• ค่าส่วนหัว: Bearer YOUR_API_KEY
• Base URL: https://api.minimaxaiapi.com/v1

ไม่ต้องตั้งค่าที่ซับซ้อน เพียงอัปเดตการกำหนดค่าในโปรเจกต์ที่มีอยู่ของคุณ

Copycurl https://api.minimaxaiapi.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "return json with keys name and age"}]
  }'

จุดจบ API Chat Completions

ส่งคำขอ POST ไปยัง endpoint chat completions เพื่อรับข้อความตอบกลับ รหัสโมเดลคือ uncensored.คุณต้องรวมอาร์เรย์ messages พร้อมประวัติการสนทนาของคุณ ระบบจะประมวลผล input และคืนข้อความที่สร้างตาม prompt ของคุณ

เอนด์พอยต์นี้จัดการการสร้างข้อความทั้งหมด ไม่รองรับการสร้าง embedding เสียง หรือวิดีโอ คุณสามารถสตรีมคำตอบหรือรอรับผลลัพธ์แบบบล็อกเต็ม โมเดลรองรับบริบทได้สูงสุด 100,000 tokens รวม

Copyfrom openai import OpenAI

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

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

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

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

Copyimport OpenAI from "openai";

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

Function Calling และโหมด JSON

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

Function Calling มีประโยชน์สำหรับการดึงข้อมูลที่มีโครงสร้างหรือกระตุ้นการดำเนินการ โหมด JSON เหมาะสำหรับการผสานรวม 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)

พารามิเตอร์และข้อจำกัดของโมเดล

ปรับพฤติกรรมการสร้างโดยใช้พารามิเตอร์มาตรฐานเช่น temperature, top_p, และ stop. หน้าต่างบริบทสูงสุดคือ 100,000 โทเค็น รวมถึงคำขอและคำตอบ โทเค็นสูงสุดต่อคำขอคือ 16,000 โทเค็น หากคุณไม่ได้ตั้งค่า max_tokens, ค่าเริ่มต้นคือ 2,048 tokens

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

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

API กำหนดอัตราสูงสุด 300 คำขอต่อนาทีและคำขอพร้อมกันได้ 8 คำขอต่อ key หากเกินขีดจำกัดเหล่านี้ คุณจะได้รับ error 429 error 401 หมายถึง API key ไม่ถูกต้องหรือไม่มีอยู่ และ error 402 หมายถึงเครดิตแบบเติมเงินของคุณหมดแล้ว

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