مقدمة

​

المصادقة

Authorization: Bearer VENICE_API_KEY

​

التوافق مع OpenAI

​

الإعداد

curl https://api.venice.ai/api/v1/chat/completions \
  -H "Authorization: Bearer $VENICE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "venice-uncensored",
    "messages": [{"role": "user", "content": "Hello!"}]
  }'

import OpenAI from "openai";

const client = new OpenAI({
  apiKey: process.env.VENICE_API_KEY,
  baseURL: "https://api.venice.ai/api/v1",
});

const response = await client.chat.completions.create({
  model: "venice-uncensored",
  messages: [{ role: "user", content: "Hello!" }]
});

console.log(response.choices[0].message.content);

import os
from openai import OpenAI

client = OpenAI(
    api_key=os.environ.get("VENICE_API_KEY"),
    base_url="https://api.venice.ai/api/v1"
)

response = client.chat.completions.create(
    model="venice-uncensored",
    messages=[{"role": "user", "content": "Hello!"}]
)

print(response.choices[0].message.content)

​

ميزات خاصة بـ Venice

​

System Prompts

1. السلوك الافتراضي: تتم إضافة system prompts الخاصة بك إلى الافتراضات الخاصة بـ Venice
2. السلوك المخصص: عطّل system prompts الخاصة بـ Venice بالكامل

​

تعطيل system prompts الخاصة بـ Venice

curl https://api.venice.ai/api/v1/chat/completions \
  -H "Authorization: Bearer $VENICE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "venice-uncensored",
    "messages": [
      {"role": "system", "content": "Your custom system prompt"},
      {"role": "user", "content": "Why is the sky blue?"}
    ],
    "venice_parameters": {
      "include_venice_system_prompt": false
    }
  }'

const completion = await client.chat.completions.create({
  model: "venice-uncensored",
  messages: [
    {
      role: "system",
      content: "Your custom system prompt",
    },
    {
      role: "user",
      content: "Why is the sky blue?",
    },
  ],
  venice_parameters: {
    include_venice_system_prompt: false,
  },
});

response = client.chat.completions.create(
    model="venice-uncensored",
    messages=[
        {"role": "system", "content": "Your custom system prompt"},
        {"role": "user", "content": "Why is the sky blue?"}
    ],
    extra_body={
        "venice_parameters": {
            "include_venice_system_prompt": False
        }
    }
)

​

معاملات Venice

​

Prompt Caching

​

مرجع رؤوس الاستجابة

​

ملاحظات مهمة

• حالة أحرف اسم Header: رؤوس HTTP غير حساسة لحالة الأحرف، لكن Venice تستخدم أحرفًا صغيرة مع شَرَطات للتناسق
• القيم النصية: قيم Boolean في الرؤوس تُعاد كسلاسل نصية ("true" أو "false")
• القيم الرقمية: قد تُعاد الأرقام الكبيرة وقيم الرصيد كسلاسل نصية لمنع فقدان الدقة
• الرؤوس الاختيارية: لا تُعاد جميع الرؤوس في كل استجابة؛ يعتمد الوجود على endpoint وسياق الطلب
• الضغط: استخدم Accept-Encoding: gzip, br في الطلبات لتلقي استجابات مضغوطة عند الدعم

​

مثال: الوصول إلى رؤوس الاستجابة

// بعد إجراء طلب API، يمكن الوصول إلى الرؤوس من كائن الاستجابة
const requestId = response.headers.get('CF-RAY');
const remainingRequests = response.headers.get('x-ratelimit-remaining-requests');
const remainingTokens = response.headers.get('x-ratelimit-remaining-tokens');
const usdBalance = response.headers.get('x-venice-balance-usd');

// التحقق من تحذيرات إيقاف النماذج
const deprecationWarning = response.headers.get('x-venice-model-deprecation-warning');
if (deprecationWarning) {
  console.warn(`Model Deprecation: ${deprecationWarning}`);
}

​

أفضل الممارسات

1. حدود المعدل: راقب رؤوس x-ratelimit-remaining-requests و x-ratelimit-remaining-tokens ونفّذ exponential backoff
2. مراقبة الرصيد: تتبع رؤوس x-venice-balance-usd و x-venice-balance-diem لتجنب انقطاع الخدمة
3. System Prompts: اختبر مع وبدون system prompts الخاصة بـ Venice للعثور على الأنسب لحالة استخدامك
4. مفاتيح API: احتفظ بمفاتيح API الخاصة بك آمنة وقم بتدويرها بانتظام
5. تسجيل الطلبات: سجّل قيم header CF-RAY لاستكشاف الأخطاء مع الدعم
6. إيقاف النماذج: تحقق من رؤوس x-venice-model-deprecation-warning عند استخدام النماذج

​

الاختلافات عن OpenAI API

1. venice_parameters: تكوينات إضافية مثل enable_web_search و character_slug و strip_thinking_response لوظائف ممتدة
2. System Prompts: تضيف Venice system prompts الخاصة بك إلى الافتراضات التي تُحسِّن للاستجابات بدون قيود (عطّل بـ include_venice_system_prompt: false)
3. منظومة النماذج: تقدم Venice قائمة نماذجها الخاصة بما في ذلك النماذج بدون قيود ونماذج الاستدلال - استخدم معرّفات نماذج Venice بدلًا من تعيينات OpenAI
4. رؤوس الاستجابة: رؤوس فريدة لتتبع الرصيد (x-venice-balance-usd و x-venice-balance-diem)، وتحذيرات إيقاف النماذج، وأعلام أمان المحتوى
5. سياسات المحتوى: سياسات أكثر تسامحًا مع نماذج بدون قيود مخصصة وتصفية محتوى اختيارية

​

استقرار API

​

مواصفات OpenAPI والبيانات الخام

• مواصفات OpenAPI (YAML) — مواصفات API الكاملة بتنسيق YAML
• مصدر وثائق API — جميع صفحات التوثيق (تنسيق .mdx) كأرشيف قابل للتنزيل