توثيق API الخاص بفينيس AI والبدء السريع

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

الخاص بك venice ai api key يصادق على كل طلب إلى API. استبدل عنوان URL الأساسي القياسي في تكوين SDK الخاص بك بالعنوان أعلاه. يستخدم النظام رصيدًا مدفوعًا مسبقًا، لذا تأكد من أن رصيدك كافٍ قبل إرسال حمولات ثقيلة.

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

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

قم بتكوين العميل ليشير إلى عنوان URL الأساسي الصحيح وضمن معرّف النموذج في جسم الطلب. يمكنك ضبط المعلمات مثل temperature أو top_p للتحكم في الإبداع.

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

استخدام أحداث الإرسال الخادم (SSE) للبث

فعّل توليد الرمز الفوري عن طريق تعيين stream: true في طلبك. تُعيد واجهة برمجة التطبيقات أحداث الإرسال الخادم (SSE) التي يمكنك تحليلها تدريجياً.

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

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

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

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

عرّف الأدوات في جسم الطلب للسماح للنموذج باستدعاء الدوال. سيعيد النموذج حججًا مهيكلة يمكن لخلفيتك تنفيذها.

هذه الميزة مثالية لبناء الوكلاء أو أتمتة سير العمل. تأكد من أن تعريفات الوظائف واضحة لتقليل الهلوسة في الحجج.

المعاملات والإعدادات

تحكم في سلوك النموذج باستخدام المعاملات القياسية. استخدم temperature للإبداع، top_p للعينة النواة، و stop التسseqs لتقطيع المخرجات.

تعيين seed لإنتاج نتائج قابلة لإعادة الإنتاج أثناء الاختبار. اضبط presence_penalty و frequency_penalty لتأثير تنوع الموضوع.

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

حدود المعدلات والقيود

يتيح كل مفتاح API 300 طلب في الدقيقة و8 طلبات متزامنة. حجم جسم الطلب الأقصى هو 8 ميجابايت.

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

لا تنتهي صلاحية الرصيد، لذا يمكنك الإيداع عند الحاجة. استخدم العملات المشفرة للإيداعات، مع توفر رصيد مكافأة للمبالغ الأكبر.

cURL

Copycurl https://api.veniceaiapikey.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Generate a summary of the current weather conditions"}]
  }'

Python

Copyfrom openai import OpenAI

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

Copyimport OpenAI from "openai";

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

التدفق

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)