مستندات واجهة API المتوافقة مع OpenAI

البدء السريع: التوصيل مع مكتبة OpenAI

ابدأ بالمصادقة باستخدام مفتاحك وتوجيه العميل إلى عنوان URL الأساسي لدينا. يعمل هذا الإعداد مع مكتبات SDK الرسمية لـ OpenAI لـ Python وNode.js، مما يضمن إمكانية تشغيل نفس شيفرة العميل ضد خدمتنا. تحتاج إلى مفتاح API صالح من لوحة التحكم وتكوين نقطة النهاية الصحيح.

Copycurl https://api.openaiapicompatible.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Return the current UTC timestamp in ISO 8601 format"}]
  }'

Copyfrom openai import OpenAI

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

Copyimport OpenAI from "openai";

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

نقطة نهاية إكمال الدردشة

أرسل نصًا إلى نقطة نهاية الدردشة الوحيدة لدينا للحصول على مخرجات نصية مباشرة. نستخدم POST /v1/chat/completions لمعالجة مطالباتك وإرجاع النص المولد. هذا هو التفاعل الأساسي لمعظم تطبيقات نماذج اللغات الكبيرة (LLM)، ولا يتطلب توجيهًا معقدًا أو مكالمات خدمات إضافية.

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)

البث مع أحداث الخادم (SSE)

استلم الرموز (Tokens) في الوقت الفعلي باستخدام أحداث الإرسال من الخادم (SSE) لتأخير أقل. فعّل البث عن طريق تعيين معلمة البث (stream) إلى true في طلبك. تتضمن الكتلة الأخيرة بيانات استخدام الرموز (Tokens)، مما يتيح لك تتبع التكاليف بدقة أثناء توليد النموذج للنص. يحافظ هذا النهج على استجابة واجهة المستخدم حتى للمخرجات الطويلة.

استدعاء الوظائف ووضع JSON

دمج الأدوات وفرض المخرجات المهيكلة لتفاعلات برمجية موثوقة. استخدم معلمة الأدوات (tools) لتحديد مخططات الوظائف، واضبط response_format على json_object لضمان الامتثال الصارم لـ JSON. يتعامل نموذجنا غير الخاضع للرقابة مع التعليمات المعقدة وحالات الحافة دون رفض الطلبات الوظيفية الصالحة.

حدود معدل الطلبات والمعلمات

راقب استخدامك مقابل حدود صارمة لكل مفتاح لتجنب انقطاع الخدمة. يُسمح لك بـ 300 طلب في الدقيقة وثمانية طلبات متزامنة لكل مفتاح، مع حد حجم جسم يبلغ 8 ميجابايت. تشير أخطاء مثل 401 (مفتاح غير صالح)، و 402 (لا يوجد رصيد)، و 429 (حد معدل الطلب) إلى حالات حسابية محددة.

نافذة السياق والقيود

تعظيم التعامل مع السياق بنافذة بحجم 100,000 رمز للإدخال والإخراج معًا. اضبط max_tokens للتحكم في طول التوليد، مع افتراض 2,048 إذا لم يتم تحديده. يعمل نموذجنا على خوادم مملوكة لنا، وليس كوكيل لموردين آخرين، مما يضمن أداءً متسقًا لحالة الاستخدام الخاصة بك.