توثيق واجهة برمجة التطبيقات

عنوان URL الأساسي والمصادقة

مفتاح واجهة برمجة التطبيقات الخاص بك يصادق على كل طلب. مرره في Authorization قيمة التوكن كـ bearer token. يشير عنوان URL الأساسي إلى نقطة النهاية المتوافقة مع OpenAI الخاصة بنا. استخدم مكتلات SDK الرسمية أو أي مكتبة عميل متوافقة. غيّر عنوان URL الأساسي إلى النطاق الخاص بنا وأدرج مفتاحك. لا يتطلب رقم هاتف للتسجيل. يلزم فقط عنوان بريد إلكتروني لتلقي مفتاحك. يظهر المفتاح فوراً بعد الإنشاء. استخدم هذا المفتاح لجميع المكالمات اللاحقة. يبقى ساري المفعول حتى تقوم بإلغائه أو استبداله.

الطلب الأول

أرسل طلب POST إلى نقطة نهاية إكمال الدردشة. حدد معرف النموذج كـ uncensored. قم بتضمين رسائل النظام والمستخدم في جسم الطلب. تحتوي الاستجابة على النص المُولّد. تُرجع الأخطاء أكواد حالة HTTP القياسية. استخدم هذا الهيكل البسيط للتحقق من الاتصال. تحقق من كائن الاستجابة للحصول على المحتوى واستخدام الرموز. يؤكد هذا أن إعداداتك تعمل بشكل صحيح.

Copycurl https://api.cheapestgptmodel.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Convert this python function to async"}]
  }'

تكامل واجهة برمجة تطبيقات Python

ثبّت حزمة OpenAI لـ Python عبر pip. اضبط مفتاح API وعنوان URL الأساسي في تكوين العميل. مرر الرسائل كقائمة من القواميس. يتعامل العميل مع التسلسل وإعادة المحاولة تلقائيًا. استرد رسالة المساعد من كائن الاستجابة. يبسط هذا النهج التكامل في النصوص البرمجية الحالية. يعمل مع كل من سير العمل المتزامن وغير المتزامن. اضبط المعلمات مثل درجة الحرارة للتحكم في العشوائية. التدفق متاح أيضًا في Python.

Copyfrom openai import OpenAI

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

تثبيت حزمة OpenAI Node.js باستخدام npm أو yarn. قم بتكوين العميل بعنوان URL الأساسي والمفتاح. قم باستدعاء طريقة chat.completions.create. قدم اسم النموذج ومصفوفة الرسائل. يحتوي كائن الاستجابة على المحتوى المولد. تعامل مع الأخطاء بسلاسة عن طريق التحقق من خاصية الخطأ. تتكامل هذه الطريقة بسلاسة مع Express أو الوظائف الخالية من الخوادم. تدعم كل من أنماط الـ promise والـ async/await. استخدمها لمهام التوليد عالية الحجم.

Copyimport OpenAI from "openai";

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

استجابات البث

فعّل التدفق عن طريق تعيين معلمة stream إلى true. تُعيد واجهة برمجة التطبيقات تسلسلاً من أحداث مُرسلة من الخادم. يحتوي كل حدث على جزء جزئي من الاستجابة. اجمع هذه الأجزاء لإعادة بناء الرسالة الكاملة. يقلل هذا من زمن الاستجابة المُدرَك للإطالات. يتضمن الجزء الأخير إحصائيات استخدام الرموز. تعامل مع انقطاعات الشبكة عن طريق استئناف الجزء الأخير. التدفق فعال لواجهات المستخدم في الوقت الفعلي. يبقي الاتصال مفتوحاً حتى الاكتمال.

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)

حدود، أخطاء، والسياق

نافذة السياق هي 100,000 رمز إجمالاً. الحد الأقصى للإخراج هو 16,000 رمز لكل طلب. حدود المعدل تسمح بـ 300 طلب في الدقيقة. يتم تقييد الطلبات المتزامنة بـ 8 لكل مفتاح. يعني خطأ 401 أن مفتاح API الخاص بك غير صالح. يشير خطأ 402 إلى عدم كفاية الرصيد المدفوع مسبقاً. يشير خطأ 429 إلى تجاوز حد المعدل. زد رصيدك المدفوع مسبقاً لمواصلة الاستخدام. الأخطاء لا تستهلك الرموز. هذا يضمن أن تدفع فقط عن التوليد الناجح.