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

المصادقة

أرسل مفتاح واجهة برمجة التطبيقات الخاص بك في Authorization الرأس. لا تنطبق هنا تدفقات OAuth المعقدة أو قفل الاشتراكات. تحصل على مفتاح فورًا بعد التسجيل باستخدام Google أو البريد الإلكتروني. تشير الأخطاء مثل 401 إلى مفتاح غير صالح أو مفقود، بينما يعني 402 استنفاد رصيدك المدفوع مسبقًا.

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

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

Copycurl https://api.ollamauncensoredmodel.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Run the python script and show output"}]
  }'

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

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

Copyfrom openai import OpenAI

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

قم تهيئة العميل باستخدام عنوان URL الأساسي الصحيح. يعمل هذا مع أي SDK متوافق مع OpenAI. يظل معرف النموذج uncensored. يمكنك تدفق الاستجابات أو معالجتها بشكل متزامن. يلغي هذا النهج الحاجة إلى توجيه الوكيل (proxy) أو الإعدادات المحلية المعقدة.

Copyimport OpenAI from "openai";

const client = new OpenAI({ baseURL: "https://api.ollamauncensoredmodel.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. يرسل الخادم أحداث الحدث المرسلة من الخادم (SSE). تظهر تفاصيل استخدام الرموز المميزة في الجزء الأخير من التدفق. يتيح لك ذلك تتبع التكاليف في الوقت الفعلي. يمكنك أيضًا استخدام temperature, top_p، و stop المعلمات للتحكم في المخرجات.

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 رمز لكل طلب، أو 2,048 إذا max_tokens غير مُضبط. حدود المعدل هي 300 طلب في الدقيقة لكل مفتاح. يعني خطأ 429 أنك وصلت إلى هذا الحد. حافظ على الطلبات أقل من 8 ميجابايت وحدد الاتصالات المتزامنة إلى 8 لكل مفتاح.