٠
رمسة
تجاوز إلى المحتوى

التوثيق

ادمج أصوات رمسة الإماراتية في منتجك خلال دقائق.

مقدمة

رمسة واجهة برمجية لتحويل النص إلى صوت إماراتي أصيل. المفاهيم الأساسية: الوكلاء (شخصيات بأصوات ولهجات)، والأصوات، والجلسات، والبثّ المتدفّق.

كل وكيل له معرّف (agent_id) ومعرّف صوت (voice_id) تستخدمهما في طلباتك.

البدء السريع

ثبّت الحزمة، ثم ولّد أول جملة إماراتية في أقل من خمس دقائق.

npm install @ramsa/sdk

import { Ramsa } from "@ramsa/sdk";
const ramsa = new Ramsa({ apiKey: process.env.RAMSA_KEY });

const audio = await ramsa.speak({
  agent: "salem",
  text: "هلا والله، نوّرت رمسة",
});

المصادقة

استخدم مفتاح API في ترويسة الطلب. أنشئ المفاتيح وتدوّرها من لوحة التحكم، وافصل بين بيئتي الاختبار والإنتاج.

curl https://api.ramsa.ai/v1/speak \
  -H "Authorization: Bearer rmsa_live_..." \
  -H "Content-Type: application/json" \
  -d '{ "agent": "salem", "text": "..." }'

تحويل النص إلى صوت

نقطة النهاية /speak تأخذ agent ونص text وإعدادات صوت اختيارية (السرعة، الطبقة، الانفعال، الثبات، شدّة اللهجة).

await ramsa.speak({
  agent: "moza",
  text: "هلا فيك! تبي مساعدة؟",
  settings: { speed: 60, emotion: 70, dialectIntensity: 75 },
  format: "mp3",
});

المحادثة المتدفّقة

للبثّ الفوري، استهلك تدفّق الأحداث: نتائج التعرّف الجزئية، ثم الكلمات، ثم مقاطع الصوت. ادمجها مع زر «اضغط للتحدث».

for await (const chunk of ramsa.stream({ agent: "salem", input })) {
  if (chunk.type === "token") render(chunk.text);
  if (chunk.type === "audio") play(chunk.audio);
}

الأخطاء

تُرجع الواجهة رموز حالة HTTP قياسية. 401 مصادقة غير صحيحة، 429 تجاوز الحدّ، 400 طلب غير صالح. أعد المحاولة مع تراجع أُسّي عند 429/5xx.

تحتاج مساعدة؟

تواصل مع الدعم