وثائق واجهة برمجة تطبيقات Venice AI للمطورين

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

قم بالاتصال فورًا عن طريق ضبط عنوان URL الأساسي على https://api.veniceapi.com/v1 و包括您的API密钥在 Authorization الرأس. تحصل على هذا المفتاح فورًا بعد التسجيل عبر Google أو البريد الإلكتروني. يتعامل هذا النموذج الوحيد مع جميع توليد النصوص بدون منطق توجيه. لا تحتاج إلى إدارة نقاط نهاية متعددة أو تكوينات الوكيل.

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

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

أرسل طلبات نصية إلى /v1/chat/completions نقطة النهاية باستخدام طرق HTTP POST القياسية. تقبل API حمولة JSON تحتوي على اسم النموذج، والتعليمات النظامية، ورسائل المستخدم.

إليك هيكل طلب أساسي:

Copycurl https://api.veniceapi.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Check if the service blocks adult content in the test endpoint"}]
  }'

يُرجع الرد النص المولد، وإحصائيات استخدام الرموز، وعلامات الإكمال. يمكنك تعديل السلوك باستخدام معلمات مثل temperature أو top_p. تتحكم هذه الإعدادات في الإبداع والعشوائية في الإخراج.

تعيد الأخطاء رموز HTTP القياسية. يشير 401 إلى مفتاح غير صالح، بينما يشير 402 إلى عدم كفاية الرصيد. استخدم هذه الرموز للتعامل مع الفشل بسلاسة في سير عمل الأتمتة الخاص بك.

تكامل مكتبة Python

استخدم مكتبة بايثون الرسمية من OpenAI للتفاعل مع نموذج اللغة الكبير غير الخاضع للرقابة. قم بتكوين العميل بعنوان URL الأساسي الخاص بـ Venice ومفتاح واجهة برمجة التطبيقات الخاص بك. يبسط هذا النهج بناء الطلبات وتحليل الاستجابات.

Copyfrom openai import OpenAI

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

تعمل هذه الطريقة بسلاسة مع قواعد الشفرة الموجودة المصممة لـ OpenAI. يمكنك تغيير عنوان URL الأساسي دون تغيير منطق تطبيقك بشكل كبير. تتعامل المكتبة مع التسلسل والاتصالات الشبكية تلقائيًا.

تذكر أنه يجب ضبط معرّف النموذج على uncensored. يضمن ذلك أنك تستخدم النموذج المُضبط المحدد الذي قدمته Venice. قد لا تظهر النماذج الأخرى أنماط سلوك مماثلة.

تكامل Node SDK

دمج واجهة برمجة التطبيقات في مشاريع JavaScript أو TypeScript باستخدام مكتبة OpenAI Node SDK. اضبط baseURL إلى نقطة نهاية Venice وقم بتوفير مفتاح API الخاص بك. يدعم هذا الإعداد كل من العمليات المتزامنة وغير المتزامنة.

Copyimport OpenAI from "openai";

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

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

تأكد من استيراد الإصدار الصحيح من SDK. قد لا تدعم الإصدارات القديمة جميع الميزات المتاحة في Venice API. تحقق من الوثائق لتفاصيل التوافق.

الاستجابات التدفقية عبر SSE

تمكين المخرجات في الوقت الفعلي عن طريق ضبط stream المعامل إلى true. تُعيد الـ API تدفق أحداث الإرسال من الخادم (SSE) بدلاً من كائن JSON كامل. يتيح هذا لك عرض الرموز أثناء توليدها.

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)

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

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

معالجة الأخطاء والحدود

تفرض واجهة برمجة التطبيقات حدًا لمعدل الطلبات يبلغ 300 طلب في الدقيقة لكل مفتاح. يمكن أن تكون الطلبات المتزامنة محدودة بـ 8 طلبات لكل مفتاح. يجب ألا تتجاوز أحمال الطلبات 8 ميجابايت. يؤدي تجاوز هذه الحدود إلى إرجاع خطأ 429 Too Many Requests.

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

تشمل الأخطاء الشائعة 401 للمفاتيح غير الصالحة و402 لقصور الرصيد. تعامل مع هذه الأكواد لتحفيز المستخدمين على الشحن. استخدم صفحة الدعم لمشاكل الفواتير. الرصيد لا ينتهي صلاحيته أبدًا، لذا يمكنك الشحن لاحقًا.