preset وكل خيار مدعوم بواسطة قيم enum.
client.presets.list(options?)
اعرض جميع الإعدادات المسبقة المملوكة للحساب الذي تمّت مصادقته.
client.presets.get(presetId, options?)
اجلب إعدادًا مسبقًا واحدًا.
client.presets.create(body, options?)
أنشئ إعدادًا مسبقًا جديدًا.
string
required
الاسم المعروض في واجهة Youka.
KaraokePreset
required
محتوى الإعداد المسبق بالكامل. استخدم
مرجع إعدادات التصيير reference لخريطة الحقول بصيغة سهلة القراءة،
أو KaraokePresetSchema.toJSONSchema() للمخطط القابل للقراءة آليًا.boolean
عيّن الإعداد المسبق الجديد كإعداد افتراضي للحساب. يمكن أن يكون هناك إعداد مسبق
واحد فقط كافتراضي في أي وقت.
client.presets.update(presetId, body, options?)
حدّث إعدادًا مسبقًا موجودًا بتعديل جزئي (Patch). مرّر أي مجموعة فرعية من name وpreset وisDefault.
client.presets.delete(presetId, options?)
احذف إعدادًا مسبقًا.
client.presets.setDefault(presetId, options?)
عيّن إعدادًا مسبقًا كافتراضي للمشاريع الجديدة. هذا مُغلّف مريح حول client.presets.update(presetId, { isDefault: true }).
اكتشاف الحقول الصالحة
يقوم SDK بتصدير مخطط Zod الذي يتحقق من صحة محتويات الإعدادات المسبقة. حوّله إلى JSON Schema أثناء التشغيل للوكلاء (agents) وبُنّاة النماذج:تطبيق إعداد مسبق
طبّق الإعدادات المسبقة في ثلاث نقاط:- عند إنشاء المشروع
- على إعدادات المشروع
- عند التصدير
ما التالي
- مرجع إعدادات التصيير — جميع مسارات الحقول المشتركة وقيم enum
- الوسائط — تتم الإشارة إليها من محتويات الإعدادات المسبقة
- إعدادات المشروع — تطبيق الإعدادات المسبقة على مشروع
- إعدادات API المسبقة — نفس التدفق عبر HTTP الخام
- إعدادات CLI المسبقة — نفس التدفق من الطرفية
- عمليات التصدير — التصيير باستخدام إعداد مسبق
