Skip to main content
الإعداد المسبق هو إعداد تصيير قابل لإعادة الاستخدام — الخلفية، نمط الترجمة، التخطيط — يمكنك تطبيقه على أي مشروع أو عملية تصدير. استخدم الإعدادات المسبقة عندما يكون لديك مظهر متّسق عبر العديد من المقاطع. راجع مرجع إعدادات التصيير للحصول على الشكل الكامل لـ 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
عيّن الإعداد المسبق الجديد كإعداد افتراضي للحساب. يمكن أن يكون هناك إعداد مسبق واحد فقط كافتراضي في أي وقت.
اقترن بمفتاح idempotency لإعادة المحاولة بأمان:

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) وبُنّاة النماذج:
لمؤلفي الوكلاء: استدعِ هذا المخطط قبل تعديل الإعدادات المسبقة حتى يعرف النموذج أسماء الحقول الدقيقة وأنواع القيم.
مرجع سهل القراءة:

تطبيق إعداد مسبق

طبّق الإعدادات المسبقة في ثلاث نقاط:

ما التالي