เริ่มต้นอย่างรวดเร็วสำหรับผู้ใช้ OpenRouter

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

API ของเราเข้ากันได้กับ SDK มาตรฐานของ OpenAI อย่างสมบูรณ์ เพื่อเปลี่ยนจาก OpenRouter คุณเพียงแค่ต้องอัปเดตค่าการกำหนดค่าสองค่า: base_url และ api_key ชี้ไคลเอนต์ของคุณไปที่ https://api.openrouterapi.cc/v1 และใช้คีย์ที่สร้างจากแดชบอร์ดของเรา ไม่ต้องใช้ส่วนหัวแบบกำหนดเองหรือตรรกะการปรับเส้นทางที่ซับซ้อน รหัสโมเดลที่ต้องการคือ uncensored

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

การตรวจสอบสิทธิ์

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

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

การตอบกลับแชทพื้นฐาน

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

ตั้งค่าฟิลด์ model เป็น uncensored คุณสามารถควบคุมพฤติกรรมโดยใช้พารามิเตอร์เช่น temperature, top_p และ stop API รองรับโหมด JSON ผ่าน response_format และการเรียกใช้ฟังก์ชันผ่าน tools คำขอทั้งหมดได้รับการประมวลผลแบบอะซิงโครนัส และคุณจะได้รับผลลัพธ์ครบถ้วนเมื่อโมเดลเสร็จสิ้น

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

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

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

การเรียกใช้ฟังก์ชัน

API รองรับฟังก์ชันการเรียกใช้ผ่านพารามิเตอร์ tools กำหนดฟังก์ชันของคุณในอาร์เรย์ tools และตั้งค่า tool_choice เป็น auto หรือชื่อฟังก์ชันเฉพาะ โมเดลจะส่งคืนอาร์กิวเมนต์ JSON ที่มีโครงสร้างหากมีการเรียกใช้ฟังก์ชัน

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

โหมด JSON

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

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

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

หน้าต่างบริบทมีขนาด 100,000 โทเคน สำหรับพรอมต์และการตอบกลับรวมกัน ผลลัพธ์สูงสุดคือ 32,000 โทเคนต่อคำขอ (2,048 หากไม่ได้ตั้งค่า max_tokens) ขีดจำกัดอัตราคือ 300 คำขอต่อนาทีและ 8 คำขอพร้อมกันต่อคีย์ ขนาดร่างกายคำขอถูกจำกัดไว้ที่ 8 MB

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

cURL

Copycurl https://api.openrouterapi.cc/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Write a blunt product review of a cheap VPN."}]
  }'

Python

Copyfrom openai import OpenAI

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