مواصفات API
مرجع لعمليات التكامل عبر مسارات عمل النص والوكلاء والوسائط والاسترجاع.
https://cicora.ai/api/v1https://cicora.ai/apiمرجع التكامل: اختر المعلمات والإمكانات المتاحة من إعدادات API لحسابك ومن كتالوج النماذج لبيئتك.
إرسال أول طلبالبدء
أرسل طلبًا أول، واختر نموذجًا من الكتالوج، واحتفظ بمعرّف طلب للتشخيص.
المصادقةأرسل مفتاح API في ترويسة Bearer وأبقِ بيانات اعتماد الإنتاج منفصلة عن بيانات اعتماد التطوير.
حزم SDK وعملاء HTTPاستخدم عناوين URL أساسية مختلفة لعملاء أسلوب OpenAI وMessages: فكلاهما يستهدف مواصفة واحدة لكنهما يكوّنان المسارات بصورة مختلفة.
واجهة سطر الأوامر وعمليات التكاملاضبط عميلًا بمفتاح ونموذج وعنوان URL أساسي يطابق بروتوكوله؛ وأبقِ السر في البيئة.
الأسئلة الشائعة للمطورينإجابات عملية موجزة عن المفاتيح وعناوين URL الأساسية والنماذج والتكلفة وتشخيص التكامل.
الحساب والكتالوج
ابنِ اختيار النماذج من بيانات الكتالوج بدلًا من قائمة ثابتة في تطبيقك.
الفرق ومفاتيح APIافصل المفاتيح والمالكين والميزانيات وآثار الاستخدام بين التطبيقات ومساحات العمل.
الحدوداعتبر حدود المفتاح والمؤسسة والنموذج والتوجيه جزءًا من سير عمل المستخدم.
الاستخدام والتكلفةاربط البيانات الوصفية للاستجابة وسجلات طلباتك بإجراءات المستخدم الحقيقية.
البيانات والخصوصيةقلل البيانات المنقولة، وافصل معرّف المستخدم النهائي عن المحتوى، واضبط الاحتفاظ في منتجك.
النص والوكلاء
أنشئ محادثات متعددة الأدوار بتنسيق messages المألوف واختر نموذجًا لكل طلب.
Messages APIاستخدم تنسيق Messages للمحادثات التي تتضمن تعليمة system في المستوى الأعلى وحد مخرجات صريحًا.
Responses APIاستخدم كائن input واحدًا عندما يستفيد تطبيقك من معالجة عناصر المخرجات والإجراءات في نموذج بيانات واحد.
البثاستقبل الرموز والدلتا المنظّمة عبر SSE من دون انتظار الاستجابة الكاملة.
الأدوات واستدعاء الدوالصِف الدوال باستخدام JSON Schema، ونفّذ الاستدعاء في تطبيقك، وأعد النتيجة إلى المحادثة.
مخرجات منظّمةاطلب كائن JSON أو JSON Schema عندما ستستهلك البرمجيات الاستجابة بدلًا من شخص.
الاستدلالاضبط جهد الاستدلال لكل طلب فقط للنماذج التي تعلن هذه الإمكانية.
التوجيهعبّر عن متطلبات التنفيذ في تفضيلات المزوّد واحتفظ بالنتيجة الفعلية لقابلية الرصد.
تخزين السياق مؤقتًاافصل السياق المتكرر كي يتمكن العميل من استخدام التخزين المؤقت المتوافق حيث يدعمه النموذج المختار.
البحث على الويباسترجع مصادر حديثة عبر دالة `web_search` ينفذها العميل، وأبقِ الروابط منفصلة عن النص المنشأ.
الوسائط والاسترجاع
ارفع ملفًا عبر عملية مخصصة، واحتفظ بمعرّفه، ومرر مرجعًا إليه في طلب متوافق لاحق.
الصورأنشئ الصور عبر مسار واحد واختر المعلمات من إمكانات النموذج المختار.
الفيديوابدأ إنشاء الفيديو كمهمة غير متزامنة، واحتفظ بمعرّف المهمة، وأبقِ الإنشاء منفصلًا عن قراءة النتيجة.
الصوتاستخدم عمليات منفصلة لتوليف الكلام والنسخ الصوتي والإدخال الصوتي إلى نموذج.
التضميناتحوّل النص أو المدخلات المدعومة إلى متجهات للبحث والتجميع والتوصيات.
إعادة الترتيبأعد ترتيب مجموعة صغيرة من المرشحين وفق استعلام لتحسين دقة الاسترجاع النهائي.
تنفيذ الدفعاتعالج العمليات المستقلة في مجموعات مضبوطة عندما يسمح سير العمل بالتسليم غير المتزامن.