أدلة API
نظرة عامة على API المباشرة
قرر متى تستدعي HUMAIN Voice بلا SDK، واختر واجهة REST للنسخ الدفعي أو البث عبر HTTP أو Socket.IO لكل سير عمل.
متى تستدعي API مباشرة
تغلّف حزم SDK لـJavaScript وPython واجهة REST للنسخ الدفعي وSocket.IO. استدعِ API بنفسك عندما:
- لا تتوفر حزمة SDK للغتك؛
- لا تستطيع بيئة التشغيل إبقاء WebSocket مفتوحًا، فتحتاج إلى مسارات البث عبر HTTP التي لا تستدعيها أي حزمة SDK؛
- تحتاج إلى ميزة في البروتوكول لا تعرضها حزم SDK، مثل تفرع التمييز في Socket.IO الذي يعيد النص والمتحدثين المباشرين من تدفق واحد.
تصادق كل وسيلة نقل بـx-api-key من الخلفية (ويحتاج Socket.IO أيضًا إلى ترويسة Origin)؛ راجع المصادقة. لاختيار سير العمل نفسه، راجع المفاهيم.
وسائط النقل حسب سير العمل
| سير العمل | وسيلة النقل | الدليل |
|---|---|---|
| النسخ الدفعي | REST: أرسل مهمة ثم استعلم دوريًا | واجهة REST للنسخ الدفعي |
| النسخ السريع | Socket.IO audio_file، أو HTTP stt | Socket.IO · البث عبر HTTP |
| النسخ الفوري | Socket.IO audio_stream، أو HTTP stt-stream | Socket.IO · البث عبر HTTP |
| تمييز المتحدثين المباشر | Socket.IO diarization_stream (أو التفرع على audio_stream)، أو HTTP diarization-stream | Socket.IO · البث عبر HTTP |
| تحويل النص إلى كلام | Socket.IO tts: PCM قابل للتشغيل بتردد 24 kHz، أو HTTP tts: تسجيل مؤطر بتردد 16 kHz لا يمكن تشغيله بموثوقية، أو POST /v1/audio/speech: ملف MP3 أو WAV أو PCM كامل واحد (على voice-dev اليوم) | Socket.IO · البث عبر HTTP · واجهة OpenAI المتوافقة |
للصوت المباشر، يقارن الصوت المباشر عبر API بين Socket.IO والبث عبر HTTP. رموز الأخطاء والحدود وقواعد إعادة المحاولة لكل وسيلة نقل في الأخطاء والحدود.
المواصفات
| السطح | المرجع |
|---|---|
| واجهة REST للنسخ الدفعي (OpenAPI) | مرجع Batch API |
| البث عبر HTTP (OpenAPI) | مرجع Realtime HTTP API |
| Socket.IO (AsyncAPI) | أحداث Realtime · النسخ السريع · TTS |
نسخ Markdown لكل صفحة مدرجة في المقدمة.