ما هو Rivya API؟

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

إنه ليس منتجا منفصلا عن Rivya Studio. يستخدم حدود الحساب نفسها، ومحفظة الرصيد نفسها، وطبقة النماذج العامة نفسها التي يراها المستخدمون عبر Rivya. الفرق هو طريقة بدء العمل: بدلا من النقر داخل Studio، يرسل تطبيقك الطلبات باستخدام مفتاح API.

إذا كنت تحتاج تفاصيل نقطة النهاية، فابدأ بـ نظرة عامة على Rivya API ودليل البدء السريع لـ Rivya API. هذا المقال هو الشرح على مستوى المنتج: ما الغرض من API، وأين يناسب، ومتى لا يجب أن يكون المسار الأول.

النسخة المختصرة

يتيح Rivya API v1 لحساب مؤهل ومسجل الدخول إنشاء مفاتيح API واستدعاء قدرات نماذج Rivya الجاهزة للـ API من خارج واجهة الويب. تصف صفحات المطورين العقد المنفذ، بينما يحدد النشر المباشر وصلاحيات الحساب وجاهزية النموذج ما إذا كان الطلب قابلا للتشغيل.

يشمل سطح API المنفذ:

• اكتشاف النماذج عبر قائمة نماذج API

• مهام توليد غير متزامنة للصور والفيديو والصوت

• رفع الملفات عبر API للنماذج التي تحتاج إلى وسائط مرجعية

• استعلام دوري لحالة التوليد باستخدام معرفات المهام العامة

• فحوص رصيد الحساب

• دورات واجهة API للمحادثة، بما في ذلك تدفق SSE اختياري

• إشعارات Webhook موقعة لاكتمال التوليد عندما تكون هذه الميزة مفعلة للنشر

• إصدار تجريبي من TypeScript SDK للفرق التي تريد غلاف عميل

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

لماذا لدى Rivya واجهة API

Studio مفيد عندما ما زال شخص يختار النماذج، ويشكل المطالبات، ويراجع المخرجات، ويقرر ما يجب فعله بعد ذلك.

API مفيد عندما يتحول ذلك القرار إلى سير عمل منتج أو عملية قابلة للتكرار.

من الأمثلة الشائعة، عندما يكون الوصول إلى API مفعلا:

• يريد منتج توليد تنويعات صور بعد أن يرسل مستخدم موجزا

• يحتاج سير عمل تسويقي إلى إنشاء مسودات بصرية من مدخلات حملة منظمة

• تحتاج أداة داخلية إلى إرسال مهام فيديو أو صوت دون أن يفتح أحد المتصفح

• يريد نظام دعم أو محتوى دورة نموذج محادثة داخل واجهته الخاصة

• تريد خدمة خلفية ردود نداء موقعة عندما تنتهي مهام التوليد

في هذه الحالات، يبقي Rivya API العمل متصلا بحساب Rivya نفسه بدلا من فرض حزمة منفصلة للفوترة، واختيار النموذج، وحالة المهمة.

ما الذي لا يستبدله API

لا يستبدل API كل سبب لاستخدام Rivya مباشرة.

استخدم الاستوديو أو أسطح العمل العامة عندما:

• ما زالت المطالبة تحتاج إلى استكشاف بشري

• اختيار النموذج غير مستقر

• يحتاج منشئ إلى مقارنة المخرجات بصريا

• يعتمد المشروع على السجل المحفوظ والمراجعة اليدوية

• لم يقرر الفريق بعد أي صيغة إدخال وإخراج يجب أن تصبح قابلة للتكرار

استخدم API عندما يكون سير العمل واضحا بما يكفي للأتمتة.

هذا الحد مهم. السؤال الإبداعي الغامض ينتمي عادة إلى Studio أولا. أما تدفق المنتج المعروف بمدخلات متوقعة فيمكن نقله إلى API.

اللبنات الرئيسية

فكر في API كست قطع متصلة.

وثائق API هي المصدر لشكل الطلب والاستجابة. يجب أن يساعدك هذا المقال على تحديد القطعة التي تحتاجها أولا.

كيف يعمل الرصيد

يسحب استخدام API من محفظة رصيد حساب Rivya نفسها التي يستخدمها Studio.

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

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

كيف تدخل الملفات في الصورة

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

في تكاملات API، يجب أن تمر تلك المراجع عبر واجهة API للملفات. ينشئ الرفع سجل ملف مدار يمكن تمريره إلى معاملات النماذج المدعومة.

القاعدة العملية بسيطة:

• إذا كان النموذج يقبل إدخال نص فقط، فابدأ من نقطة نهاية التوليد

• إذا كان النموذج يحتاج وسائط مرجعية، فارفع الملف أولا

• إذا كان النموذج نموذج محادثة مع مرفقات صور، فاستخدم واجهة API للمحادثة ومعرفات الملفات

لا تصمم تكاملك حول تدفقات رفع خاصة بالمتصفح فقط أو جلسات Studio محفوظة. لدى API حد ملفات عام خاص به لسبب واضح.

أين تساعد إشعارات Webhook

الاستعلام الدوري هو أسهل مسار تكامل أول. أرسل مهمة توليد، واحفظ معرف المهمة العام، ثم استعلم دوريا حتى تنجح أو تفشل.

عندما تكون إشعارات Webhook مفعلة للنشر، تصبح مفيدة مع اقتراب التكامل من الإنتاج:

• لا تريد عاملا يجري استعلاما دوريا لكل مهمة

• يحتاج تطبيقك إلى تحديث سجل عند انتهاء التوليد

• تريد حدثا موقّعا يمكن إعادة محاولته بأمان

• تحتاج المهام الفاشلة إلى الانتقال إلى مسار استرداد واضح

لعقد الحدث الموقع، استخدم إشعارات Webhook عبر API. تأكد من توفر الميزة قبل بناء التصميم حولها. أبق مستقبل الويبهوك ضيقا: تحقق من التوقيعات، وتعامل مع الأحداث المكررة، وتجنب وضع قيم سرية في السجلات.

مشروع API أول جيد

أفضل مشروع API أول يكون عادة صغيرا وملموسا.

مثلا:

1. تأكد من أن الوصول إلى API مفعل للنشر والحساب

2. أنشئ مفتاح API في الإعدادات

3. استدع قائمة النماذج

4. اختر نموذجا واحدا جاهزا للـ API

5. أرسل مهمة توليد واحدة باستخدام مفتاح عدم التكرار

6. أجر استعلاما دوريا لنقطة نهاية الحالة

7. افحص الرصيد قبل وبعد

8. عندها فقط أضف واجهة API للملفات أو واجهة API للمحادثة أو إشعارات Webhook التي يتيحها النشر

يعطيك هذا المسار تكاملا عاملا دون خلط كل ميزات API في الاختبار الأول.

متى يكون API نقطة بداية خاطئة

غالبا لا يكون API الخطوة الأولى الصحيحة عندما:

• لم يختر الفريق عائلة نماذج بعد

• الناتج المطلوب ما زال يتغير في كل تشغيل

• تعتمد المطالبة على الذوق والمراجعة اليدوية

• سيخفي التكامل استخدام الرصيد عن الأشخاص الذين يحتاجون إلى فهمه

• يحتاج المنتج إلى عرض تجريبي عام قبل أن يحتاج إلى الأتمتة

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

إلى أين تذهب بعد ذلك

• افتح المطورون لمركز API العام ومصحح الأخطاء.

• اقرأ دليل البدء السريع لـ Rivya API لإجراء أول طلب آمن.

• اقرأ مصادقة API قبل وضع مفتاح على خادم.

• اقرأ نماذج API قبل اختيار معرفات النماذج.

• اقرأ متى تستخدم Rivya API بدلا من Studio إذا كان حد المنتج ما زال غير واضح.

• اقرأ كيف تبني سير عمل AI متعدد الوسائط باستخدام Rivya API عندما تخطط لتكامل كامل للصور، أو الفيديو، أو الصوت، أو المحادثة.