البدء السريع لتكامل API الخاص بـ Character

ثبّت SDK

ابدأ بتثبيت مكتبة العميل الرسمية للغتك. يضمن ذلك التوافق مع نقطة النهاية المتوافقة مع OpenAI التي نقدمها. تتولى المكتبة مهام التسلسل ومنطق إعادة المحاولة نيابةً عنك.

بالنسبة لـ Python، استخدم pip. بالنسبة لـ Node.js، استخدم npm. تستغرق هذه الخطوة ثوانٍ وتهيئ البيئة لعينات التعليمات البرمجية التي تليها.

تكوين عنوان URL الأساسي الخاص بك

وجّه عميل SDK الخاص بك إلى نقطة النهاية لدينا للوصول إلى النموذج غير الخاضع للرقابة. عنوان URL الأساسي هو HTTPS://api.apicharacter.com/v1. يحل هذا محل عنوان URL الافتراضي لـ OpenAI في تكوينك.

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

تعيين مفتاح واجهة برمجة التطبيقات (API)

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

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

أجرِ أول طلب لك

أرسل إكمال محادثة بسيط للتحقق من الاتصال. معرف النموذج هو "uncensored". يؤكد هذا أن المصادقة وعنوان URL الأساسي صحيحان قبل بناء تطبيقك.

شاهد المثال أدناه لطلب cURL القياسي.

Copycurl https://api.apicharacter.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "set my name to Alex"}]
  }'

التعامل مع الاستجابات المتدفقة

فعّل التدفق لانخفاض زمن الانتظار في واجهات الدردشة الخاصة بك. اضبط المعلمة stream إلى true في طلبك. ستُعيد حزمة SDK الرموز أثناء توليدها.

هذا حاسم لتجارب المستخدم الاستجابة. تتعامل مع الأجزاء الجزئية عند وصولها عبر أحداث Server-Sent.

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 رمز ما لم تحدد خلاف ذلك.

حد معدل الطلبات هو 300 طلب في الدقيقة. يعني الخطأ 401 مفتاحاً غير صالح. يعني الخطأ 402 رصيداً صفراً. يعني الخطأ 429 تجاوز حد معدل الطلبات. ضع هذه الأمور في اعتبارك عند التوسع في بيئة الإنتاج.

Python

Copyfrom openai import OpenAI

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