البدء السريع لمستخدمي OpenRouter

التثبيت والإعداد

تتوافق واجهة برمجة التطبيقات لدينا تمامًا مع مكتبات OpenAI القياسية. للانتقال من OpenRouter، تحتاج فقط إلى تحديث قيمتي تكوين: base_url و api_key. وجّه عميلك إلى https://api.openrouterapi.cc/v1 واستخدم المفتاح الذي تم إنشاؤه على لوحة التحكم الخاصة بنا. لا توجد حاجة إلى رؤوس مخصصة أو منطق توجيه معقد. معرف النموذج المطلوب هو uncensored.

تأكد من أن إصدار SDK الخاص بك يدعم معلمة base_url. إذا كنت تستخدم عميل HTTP خام، قم ببساطة بتحديث عنوان URL المستهدف. يضمن هذا الإعداد عمل رمز العميل الحالي دون تعديل، بشرط أن ترسل فقط طلبات إكمال النص.

المصادقة

يتم التعامل مع المصادقة عبر الرأس القياسي Authorization. مرر مفتاح API الخاص بك كرمز Bearer. إذا كان المفتاح غير صالح أو منتهي الصلاحية، تُعيد واجهة برمجة التطبيقات خطأ 401. على عكس بعض المزودين، لا نcharge عن الطلبات الفاشلة؛ الأخطاء والرفض مجانيان، لذا يمكنك اختبار المصادقة دون استهلاك الرصيد.

يدعم كل حساب مفتاحًا نشطًا واحدًا في وقت واحد. يؤدي إنشاء مفتاح جديد إلى إبطال المفتاح السابق فورًا. احفظ مفتاحك بأمان وقم بتدويره إذا اشتبهت في تعرضه. يظهر المفتاح مباشرة بعد تسجيل الدخول، لذا انسخه قبل مغادرة الصفحة.

إكمال الدردشة الأساسي

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

حدد حقل model إلى uncensored. يمكنك التحكم في السلوك باستخدام معاملات مثل temperature، وtop_p، وstop. تدعم واجهة برمجة التطبيقات وضع JSON عبر response_format واستدعاء الدوال عبر tools. تتم معالجة جميع الطلبات بشكل غير متزامن، وتتلقى الإكمال الكامل بمجرد انتهاء النموذج.

استجابات البث المتدفق

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

يتم توفير معلومات استخدام الرموز في الجزء الأخير من البث. يتيح لك ذلك تتبع التكاليف بدقة دون تحليل كل رمز فردي. البث المتدفق مثالي لواجهات الدردشة حيث يهم زمن الاستجابة. تأكد من أن عميلك يتعامل مع SSE بشكل صحيح ويغلق الاتصال عند انتهاء البث.

استدعاء الدوال

تدعم واجهة برمجة التطبيقات استدعاء الدوال عبر معلمة tools. عرّف دوالك في مصفوفة tools وحدد tool_choice إلى auto أو اسم دالة محدد. سيعيد النموذج حجج JSON المهيكلة إذا تم تفعيل دالة.

هذه الميزة مفيدة لدمج LLM مع واجهات برمجة التطبيقات الخارجية أو قواعد البيانات. تأكد من أن تعريفات الدوال دقيقة، حيث يعتمد النموذج عليها لتوليد حجج صالحة. لا تنفذ واجهة برمجة التطبيقات الدوال؛ يجب عليك معالجة منطق التنفيذ في شفرة التطبيق الخاصة بك.

وضع JSON

للمخرجات المهيكلة، استخدم response_format: {"type": "json_object"}. هذا يجبر النموذج على إرجاع JSON صالح، وهو أمر ضروري لتحليل البيانات في التطبيقات التالية. وضع JSON أكثر موثوقية غالبًا من استدعاء الدوال لمهام استخراج البيانات البسيطة.

تأكد من أن الموجّهات توضح بوضوح للنموذج إرجاع JSON. قد تحدث استجابات JSON غير صالحة إذا كان الموجّه غامضًا. يتم دعم وضع JSON في كل من الوضعين القياسي والبث المتدفق. استخدمه عندما تحتاج إلى مخرجات قابلة للقراءة الآلية ومتوقعة.

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

نافذة السياق هي 100,000 رمز للموجّه والإكمال معًا. الحد الأقصى للإخراج هو 32,000 رمز لكل طلب (2,048 إذا لم يتم تعيين max_tokens). حدود المعدل هي 300 طلب في الدقيقة و8 طلبات متزامنة لكل مفتاح. حجم جسم الطلب محدود بـ 8 ميجابايت.

تُعيد الأخطاء أكواد 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)