البدء السريع: واجهة برمجة تطبيقات إكمال الدردشة

المتطلبات الأساسية وعنوان URL الأساسي

تتوافق واجهة برمجة التطبيقات (API) الخاصة بنا مع واجهة إكمال المحادثات القياسية من OpenAI. كل ما تحتاجه هو عنوان URL أساسي ومفتاح API لبدء إرسال الطلبات. عنوان URL الأساسي هو HTTPS://api.howmuchisanapikey.com/v1. يتعامل هذا العنوان النهائي الوحيد مع جميع توليد النصوص دون الحاجة إلى إدارة عناوين URL متعددة للخدمات أو تكوينات الوكيل (proxy).

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

المصادقة والرؤوس

تضمين رأس التفويض في كل طلب للتحقق من هويتك. تنسيق الرأس هو Authorization: Bearer YOUR_API_KEY. إذا كان المفتاح غير صالح أو منتهي الصلاحية، فإن واجهة برمجة التطبيقات تعيد خطأ 401 على الفور. يضمن هذا أن الحسابات المصرح لها فقط يمكنها استهلاك رصيدك المدفوع مسبقًا.

لا تحتاج إلى تمرير رؤوس إضافية للتوليد النصي الأساسي. ومع ذلك، إذا استخدمت ميزات محددة مثل وضع JSON أو استدعاء الوظائف، يجب عليك تعيين رأس Content-Type إلى application/json. يخبر هذا الخادم بكيفية تحليل جسم الطلب الخاص بك بشكل صحيح.

إرسال أول إكمال دردشة لك

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

إليك مثال أساسي باستخدام curl للبدء:

Copycurl https://api.howmuchisanapikey.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Generate a simple hello world function in python"}]
  }'

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

الاستجابات التدفقية واستخدام الرموز

استخدم أحداث الإرسال الخادم (SSE) لتلقي الرموز أثناء توليدها. يقلل هذا من زمن الاستجابة المدرك للمخرجات الطويلة. اضبط معلمة التدفق إلى true في جسم طلبك. سيرسل الخادم شرائح متعددة، تحتوي كل منها على جزء جزئي من الاستجابة.

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

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

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

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

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

يُسمح لك بإجراء 300 طلب في الدقيقة لكل مفتاح و8 طلبات متزامنة. إذا تجاوزت هذه الحدود، ستتلقى خطأ 429 Too Many Requests. سيتضمن جسم الاستجابة تفاصيل retry-after. اضبط التخفيف من جانب العميل لتجنب إعادة المحاولة غير الضرورية.

إذا استنفدت رصيدك المدفوع مسبقًا، فإن واجهة برمجة التطبيقات (API) تُرجع خطأ 402 Payment Required. يمكنك إضافة رصيد عبر العملات المشفرة في أي وقت. الأخطاء والرفضات مجانية، لذا فإنك تدفع فقط مقابل توليد الرموز الناجح. نافذة السياق هي 100,000 رمز للسياق والإكمال معًا.

Python

Copyfrom openai import OpenAI

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