أدلة API

نظرة عامة على API المباشرة

اختر أعمال Batch أو الصوت الكامل السريع أو البث المباشر أو TTS لتكامل HUMAIN Voice مباشر.

استخدم هذه الأدلة عندما لا يملك وقت التشغيل SDK منشورًا، أو تحتاج تحكمًا على مستوى البروتوكول، أو تحتاج تشخيص سلوك النقل. ينبغي لتطبيقات JavaScript وPython أن تبدأ عادة من أدلة SDK.

اختر حسب دورة حياة الإدخال

الإدخال والنتيجةالسطح المباشرابدأ منأبقِ هذا مفتوحًا كعقد
اجتماع أو بودكاست أو أرشيف أو تسجيل طويل مكتمل آخر يمكن أن ينتهي بصورة غير متزامنةBatch REST: ارفع مرة، واستلم jobId، ثم استعلمدليل Batch RESTBatch OpenAPI
وحدة صوت مكتملة حساسة للكمون، مثل دور محادثة واحدالنسخ السريع: أرسل الوحدة كاملة عبر Socket.IO audio_file أو HTTP متعدد الأجزاء /realtime/http/sttدليل Socket.IO أو دليل Realtime HTTPFast AsyncAPI أو Realtime HTTP OpenAPI
صوت لا يزال يصل، مع نص مباشر أو مقاطع متحدثينالبث المباشر: audio_stream / diarization_stream عبر Socket.IO، أو بث HTTP مؤطرنظرة عامة على نقل RealtimeRealtime AsyncAPI وRealtime HTTP OpenAPI
نص يجب أن يصبح كلامًاTTS: tts / tts_audio عبر Socket.IO، أو TTS مباشر عبر HTTP مع قيد التأطير الموثقدليل Socket.IO؛ استخدم Realtime HTTP فقط عند الحاجة إلى HTTPTTS AsyncAPI أو Realtime HTTP OpenAPI

يستهلك Batch والنسخ السريع كلاهما صوتًا مكتملًا. اختر Batch للوسائط الطويلة، وFast فقط لوحدة مكتملة محدودة يهم كمونها. لا تجعل أحداث النتائج إدخال Fast فوريًا. اختر Realtime فقط ما دام الصوت يصل.

المتطلبات المشتركة

  • احصل على API_KEY عبر مسار المصادقة، واستخدم API_URL المعروض لهذه البيئة. يستخدم SDK المسار /socket.io افتراضيًا؛ ولا تستنتج تجاوزًا من بيئة أخرى.
  • أرسل x-api-key في كل طلب HTTP محمي واتصال Socket.IO. احتفظ به في خلفية موثوقة؛ فلا تستطيع شيفرة المتصفح إبقاء مفتاح API سريًا.
  • ضع مهلاً محدودة للاتصال والطلب والقراءة والاستعلام والنتيجة النهائية. تحقق من حالة HTTP قبل تحليل النجاح، وأغلق كل بث أو مقبس.
السطحعقد الصوت أو الخرج المطلوب
Batch RESTرفع ملف multipart/form-data واحد
النسخ السريعملف مشفر مكتمل واحد في حزمة Socket.IO أو طلب HTTP متعدد الأجزاء
ASR المباشر والتمييزPCM16 little-endian، بتردد 16 kHz وأحادي القناة؛ يحتوي كل جسم إدخال ترويسة التحكم الموثقة ذات 18 بايت
TTS عبر Socket.IOPCM16 خام مؤطر little-endian، بتردد 24 kHz وأحادي؛ يبدأ الصوت بعد ترويسة الإطار ذات 17 بايت
TTS عبر HTTPتسجيل بروتوكول بلا فواصل تحمل إطاراته النظرية PCM16 بتردد 16 kHz؛ ولا يستطيع العميل العام استعادة حدود الإطارات أو صوت قابل للتشغيل

تجيب الأدلة والمراجع عن أسئلة مختلفة

استخدمعندما تحتاج إلى
دليل APIاختيار النقل، وتسلسل الطلب، وقواعد دورة الحياة، وتسوية النتائج، والتنظيف، والتنبيهات التشغيلية
مرجع OpenAPI المولدمسار HTTP وطريقته ومصادقته ومعاملاته وجسمه وحالاته ومخططات استجابته بدقة
مرجع AsyncAPI المولدأسماء أحداث Socket.IO وحقول الحمولات وتخطيطات البايت الثنائية وأمان الاتصال بدقة

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

الخطوات التالية

  1. تحقق من العنوان والمفتاح الصادرين بلا رفع صوت.
  2. اختر صفًا واحدًا أعلاه وأكمل أصغر طلب ممثل له.
  3. أضف معالجة الأخطاء المنظمة وإعادة المحاولة المحدودة من الأخطاء وحدود المعدل.

في هذه الصفحة