دليل البدء السريع لواجهة برمجة التضمينات

المصادقة

استخدم الـ API باستخدام مفتاح API فريد يتم إنشاؤه من لوحة حسابك. أضف هذا المفتاح إلى رأس Authorization في كل طلب باستخدام مخطط Bearer. عنوان URL الأساسي لجميع نقاط النهاية هو https://api.embeddingapis.com/v1. يعمل هذا العنوان مع مكتبات SDK الرسمية الخاصة بـ OpenAI وأي عميل مُعدّ للخدمات المتوافقة مع OpenAI. تأكد من الحفاظ على أمان مفتاحك، إذ يمنحك الوصول إلى رصيدك المسبق الدفع.

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

نقطة نهاية إكمال المحادثات

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

هيكل طلبك مع مصفوفة messages التي تحتوي على موجّهات النظام والمستخدم الخاصة بك. تُرجع واجهة برمجة التطبيقات استجابة JSON تحتوي على النص المولد.

Copycurl https://api.embeddingapis.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Write a blunt product review of a cheap VPN."}]
  }'

تكامل SDK لـ Python

استخدم مكتبة Python الرسمية من OpenAI للتفاعل مع واجهة برمجة التطبيقات. اضبط base_url على نقطة النهاية الخاصة بنا وقم بتوفير مفتاح API الخاص بك. يتيح هذا النهج استغلال كود العميل الحالي بتغييرات قليلة. يتولى العميل الترميز وطلبات الشبكة، ويعيد استجابات مُهيّأة يمكنك تحليلها لمنطق التطبيق الخاص بك.

تأكد من استخدام إصدار حديث من SDK لدعم جميع الميزات، بما في ذلك البث المتدفق واستدعاء الدوال. يظل معرّف النموذج uncensored عند استدعاء النصوص المكتملة.

Copyfrom openai import OpenAI

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

تكامل SDK لـ Node.js

لبيئات JavaScript أو TypeScript، استخدم SDK Node.js من OpenAI. قم بإعداد العميل بعنوان URL الأساسي ومفتاح API الصحيح. يضمن هذا الإعداد التوافق مع خطوط الأنابيب القائمة على Node.js الخاصة بك. يدير SDK الاتصال بنقطة النهاية POST /v1/chat/completions، مما يتيح لك إرسال الموجّهات واستقبال النصوص المكتملة بكفاءة.

هذا التكامل مناسب لمعالجة النص من جانب الخادم، مثل توليد التسميات التوضيحية، النصوص، أو استخراج البيانات من كتل نصية كبيرة.

Copyimport OpenAI from "openai";

const client = new OpenAI({ baseURL: "https://api.embeddingapis.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)، وتسليم الرموز بمجرد توليدها. هذا مفيد بشكل خاص لواجهات المستخدم في الوقت الفعلي أو عند معالجة النصوص الطويلة حيث يكون التغذية الراجعة الفورية ذات قيمة.

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

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 رمز لكل من الموجّه والإكمال معًا. ستفشل الطلبات التي تتجاوز حد حجم الجسم 8 ميجابايت أو حدّ المعدل البالغ 300 طلب في الدقيقة. تُرجع أخطاء المصادقة حالة 401 إذا كان المفتاح غير صالح. عندما ينفد رصيد مسبق الدفع، تفشل الطلبات لأنه لم يعد هناك رصيد لتغطية استخدام الرموز. تشير حالة 429 إلى استنفاد حدّ المعدل.

ينطبق حد محتوى صارم دائمًا: يتم حظر الطلبات التي تحتوي على محتوى جنسي يتضمن قاصرين، بغض النظر عن الإعدادات الأخرى. تتم معالجة كل المحتوى الآخر القانوني للبالغين دون رفض.