SubFT

مرجع Python API

تواقيع subft-client ومعاملاته وعقود إرجاعه وصادراته العامة.

المعاملات والقيم المعادة والأخطاء

هذا عميل HTTP متزامن ومحدود الوظيفة. لا يطلب إدخالاً ولا يفحص الملفات تلقائياً ولا ينسّق العمل المدفوع نيابةً عنك. ابدأ بـالمثال الكامل. تحتاج دوال API إلى حساب ورمز وإذن للمشروع المختار. لا تخصم الخطة والتقدير رصيداً؛ اعتماد العملية يفعل ذلك. يتطلب توليد الرمز أو إلغاؤه الحساب الموثّق ويستبدل رمزه النشط الوحيد أو يلغيه.

تصف أنواع positional-only وpositional-or-keyword وkeyword-only والأنواع المتغيرة صيغة الاستدعاء في Python. تعني الشرطة في عمود الافتراض عدم وجود قيمة افتراضية؛ يجب توفير المعاملات المطلوبة. تعني _UNSET حذف الحقل، بينما قد تمسح None حقل مشروع يقبل الفراغ صراحةً.

JsonValue هو Any وليس نموذج استجابة متحققاً منه. تعيد أدوات HTTP بيانات JSON مفكوكة أو None للاستجابة الفارغة؛ راجع مخططات الاستجابة أدناه للحقول الموثقة. تعيد request وput_upload_target كائناً من httpx.Response، وتعيد close القيمة None، وتعيد resolve_url نص عنوان.

التقط SubftMaintenanceError قبل SubftApiError؛ افحص status_code وpayload وresponse وmode وmaintenance_until. يحتفظ SubftTransportError بـrequest_error. يغطي SubftError أخطاء العميل؛ وقد يرفع التحقق من المعاملات ValueError أيضاً. تتطلب 409 قراءة أو خطة جديدة، وليس تكرار قيم تحقق قديمة. احتفظ بالرسائل التقنية في السجلات الداخلية وحوّل الرموز إلى نص مترجم في الواجهات العامة. لا تكرر اعتماداً مدفوعاً دون تحقق بعد فشل نقل ملتبس: طابق العملية المقبولة أولاً.

تستخدم أخطاء HTTP البنية {"detail":{"code":"…","params":{…}}}. اقرأ SubftApiError.code وSubftApiError.params؛ نصوص الخادم الخام مخصصة للتشخيص فقط. تتضمن المعاملات مبالغ الرصيد وبيانات الصيانة وأرقام أسطر الترجمة النصية. مثلاً، قد تعيد الترجمة غير القابلة للقراءة {"detail":{"code":"invalid_subtitles","params":{"line":2}}}. يجب أن تعرض الواجهات العامة رسالة عامة مترجمة للرموز غير المعروفة.

SubftClient

أنشئ عميلاً واحداً وأغلقه بمدير السياق. تُستورد الإضافات صراحةً؛ لا تحمّل الحزمة الأساسية تبعيات FFmpeg أو WebSocket.

Python
SubftClient(
    base_url: str,
    *,
    token: str | None = None,
    timeout: float | httpx.Timeout = 30.0,
    headers: Mapping[str, str] | None = None,
    cookies: Mapping[str, str] | None = None,
    transport: httpx.BaseTransport | None = None
) -> None
المعاملالنوعالتمريرالافتراضالمعنى
base_urlstrpositional-or-keyword—عنوان البوابة التي تقدم مسارات API والمصادقة والاتصال الفوري؛ تُوحّد الشرطة المائلة الأخيرة.
tokenstr | Nonekeyword-onlyNoneرمز API من صفحة وصول المطورين. احفظه في متغير بيئة محمي.
timeoutfloat | httpx.Timeoutkeyword-only30.0المهلة بالثواني؛ راجع التوقيع لمعرفة القيمة الافتراضية للطلب أو الفحص أو الاشتراك.
headersMapping[str, str] | Nonekeyword-onlyNoneترويسات HTTP. مرّر ترويسات هدف الرفع دون تغيير؛ ترويسات الطلب العادي تتجاوز ترويسات المنشئ.
cookiesMapping[str, str] | Nonekeyword-onlyNoneملفات ارتباط HTTP اختيارية لجلسة هذا العميل.
transporthttpx.BaseTransport | Nonekeyword-onlyNoneوسيلة نقل HTTPX اختيارية؛ استخدم MockTransport في الاختبارات بدلاً من بوابة حية.

دوال العميل

ترد كل دالة عامة مرة واحدة أدناه. تتبع القيم المعادة والأخطاء المشتركة العقد أعلاه؛ تحتفظ تعارضات نقطة النهاية بحالة الخادم وبياناته.

abandon_content_preparation

التخلي عن تحضير مصدر واحد ما زال قابلاً للإجراء، مع الحفاظ على مصادر العملية الأخرى.

Python
abandon_content_preparation(
    operation_id: str, media_id: str, content_id: str
) -> JsonValue
المعاملالنوعالتمريرالافتراضالمعنى
operation_idstrpositional-or-keyword—معرّف العملية التي تم اعتمادها؛ احتفظ به قبل المغادرة أو إعادة محاولة التحضير.
media_idstrpositional-or-keyword—معرّف الوسائط في هذا المسار: معرّف وسائط المشروع لمسارات المشاريع، ومعرّف وسائط العملية للرفع والتحضير.
content_idstrpositional-or-keyword—معرّف عنصر مصدر داخل العملية، وليس معرّف وسائط مشروع أو ناتج مرحلة.

abort_operation

إيقاف العمل الذي قبله الخادم باستخدام الإجراء المسموح للعملية؛ يختلف ذلك عن فصل المراقبة.

Python
abort_operation(operation_id: str) -> JsonValue
المعاملالنوعالتمريرالافتراضالمعنى
operation_idstrpositional-or-keyword—معرّف العملية التي تم اعتمادها؛ احتفظ به قبل المغادرة أو إعادة محاولة التحضير.

add_project_media

تسجيل عنصر جرد واحد تم فحصه محلياً مع مصادره الفعلية.

Python
add_project_media(
    project_id: str, media: Mapping[str, Any]
) -> JsonValue
المعاملالنوعالتمريرالافتراضالمعنى
project_idstrpositional-or-keyword—معرّف المشروع المحفوظ، كما تعيده عملية إنشاء المشروع أو قائمة المشاريع.
mediaMapping[str, Any]positional-or-keyword—سجلات جرد متوافقة مع الخادم أو معرّفات وسائط المشروع المختارة؛ احصل على المعرّفات من الاستجابات الحالية.

add_project_media_bulk

تسجيل دفعة كاملة من سجلات الوسائط المفحوصة.

Python
add_project_media_bulk(
    project_id: str, media: Iterable[Mapping[str, Any]]
) -> JsonValue
المعاملالنوعالتمريرالافتراضالمعنى
project_idstrpositional-or-keyword—معرّف المشروع المحفوظ، كما تعيده عملية إنشاء المشروع أو قائمة المشاريع.
mediaIterable[Mapping[str, Any]]positional-or-keyword—سجلات جرد متوافقة مع الخادم أو معرّفات وسائط المشروع المختارة؛ احصل على المعرّفات من الاستجابات الحالية.

apply_project_directory_sync

تطبيق لقطة مجلد تمت مراجعتها مع قيم تحقق حديثة؛ تتطلب الحالة القديمة معاينة جديدة.

Python
apply_project_directory_sync(
    project_id: str,
    *,
    files: Iterable[Mapping[str, Any]],
    media: Iterable[Mapping[str, Any]] | None = None,
    confirmed_moves: Iterable[Mapping[str, Any]] | None = None,
    confirm_reviewed: bool = False,
    expected_assets: Mapping[str, Any] | None = None,
    complete: bool = True
) -> JsonValue
المعاملالنوعالتمريرالافتراضالمعنى
project_idstrpositional-or-keyword—معرّف المشروع المحفوظ، كما تعيده عملية إنشاء المشروع أو قائمة المشاريع.
filesIterable[Mapping[str, Any]]keyword-only—لقطة مجلد كاملة أو قائمة ملفات أو أدلة ملاحظة تتطلبها نقطة النهاية؛ أنشئها من الملفات المحلية.
mediaIterable[Mapping[str, Any]] | Nonekeyword-onlyNoneسجلات جرد متوافقة مع الخادم أو معرّفات وسائط المشروع المختارة؛ احصل على المعرّفات من الاستجابات الحالية.
confirmed_movesIterable[Mapping[str, Any]] | Nonekeyword-onlyNoneخرائط مسارات الوسائط القديمة والجديدة التي تمت مراجعتها من معاينة المجلد.
confirm_reviewedboolkeyword-onlyFalseموافقة صريحة على تغييرات المجلد التي تمت مراجعتها؛ لا يضيف العميل موافقة ضمنية.
expected_assetsMapping[str, Any] | Nonekeyword-onlyNoneقيم التحقق الحالية للملاحظة أو الجيل أو الحفظ من استجابة القراءة أو بدء الفحص؛ تتطلب القيم القديمة قراءة جديدة.
completeboolkeyword-onlyTrueيحدد ما إذا كانت اللقطة كاملة؛ لا تصف فحصاً محلياً فشل جزئياً بأنه كامل.

archive_project

أرشفة مشروع اكتملت تسوية مهامه ليصبح للقراءة فقط. تكرار الطلب يحافظ على تاريخ الأرشفة.

Python
archive_project(project_id: str) -> JsonValue
المعاملالنوعالتمريرالافتراضالمعنى
project_idstrpositional-or-keyword—معرّف المشروع المحفوظ، كما تعيده عملية إنشاء المشروع أو قائمة المشاريع.

restore_project

استعادة مشروع مؤرشف لإتاحة تعديله مجددًا. لا تؤدي استعادة مشروع نشط إلى أي تغيير.

Python
restore_project(project_id: str) -> JsonValue
المعاملالنوعالتمريرالافتراضالمعنى
project_idstrpositional-or-keyword—معرّف المشروع المحفوظ، كما تعيده عملية إنشاء المشروع أو قائمة المشاريع.

delete_project

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

Python
delete_project(project_id: str, confirmation_name: str) -> JsonValue
المعاملالنوعالتمريرالافتراضالمعنى
project_idstrpositional-or-keyword—معرّف المشروع المحفوظ، كما تعيده عملية إنشاء المشروع أو قائمة المشاريع.
confirmation_namestrpositional-or-keyword—اسم المشروع مطابقًا تمامًا بعد إزالة المسافات المحيطة، مع مراعاة حالة الأحرف.

attach_project_media_sidecars

إرفاق ملفات ترجمة جانبية تمت مراجعتها بعنصر وسائط باستخدام خط أساس الفحص.

Python
attach_project_media_sidecars(
    project_id: str,
    media_id: str,
    sidecars: Iterable[Mapping[str, Any]],
    *,
    expected_assets: Iterable[Mapping[str, Any]] = ()
) -> JsonValue
المعاملالنوعالتمريرالافتراضالمعنى
project_idstrpositional-or-keyword—معرّف المشروع المحفوظ، كما تعيده عملية إنشاء المشروع أو قائمة المشاريع.
media_idstrpositional-or-keyword—معرّف الوسائط في هذا المسار: معرّف وسائط المشروع لمسارات المشاريع، ومعرّف وسائط العملية للرفع والتحضير.
sidecarsIterable[Mapping[str, Any]]positional-or-keyword—ملفات ترجمة جانبية تم فحصها مع بيانات الاقتران والتصنيف.
expected_assetsIterable[Mapping[str, Any]]keyword-only()قيم التحقق الحالية للملاحظة أو الجيل أو الحفظ من استجابة القراءة أو بدء الفحص؛ تتطلب القيم القديمة قراءة جديدة.

begin_media_asset_checks

قراءة خط أساس فحص الأصول الحالي قبل مطابقة الملاحظات الفعلية.

Python
begin_media_asset_checks(
    project_id: str, media_id: str, *, scope: Mapping[str, Any] | None = None
) -> JsonValue
المعاملالنوعالتمريرالافتراضالمعنى
project_idstrpositional-or-keyword—معرّف المشروع المحفوظ، كما تعيده عملية إنشاء المشروع أو قائمة المشاريع.
media_idstrpositional-or-keyword—معرّف الوسائط في هذا المسار: معرّف وسائط المشروع لمسارات المشاريع، ومعرّف وسائط العملية للرفع والتحضير.
scopeMapping[str, Any] | Nonekeyword-onlyNoneمحدد خاص بنقطة النهاية لنوع الأصل أو نطاق الفحص أو الجاهزية أو الموضع؛ اتبع عقد نقطة النهاية.

begin_project_directory_checks

قراءة خطوط أساس فحص الأصول لدورة كاملة من معاينة المجلد وتطبيقها.

Python
begin_project_directory_checks(project_id: str) -> JsonValue
المعاملالنوعالتمريرالافتراضالمعنى
project_idstrpositional-or-keyword—معرّف المشروع المحفوظ، كما تعيده عملية إنشاء المشروع أو قائمة المشاريع.

clone_media_asset

إنشاء نسخة قابلة للتحرير أو نسخة مكررة باستخدام قيم التحقق للّقطة الحالية.

Python
clone_media_asset(
    project_id: str, media_id: str, asset_id: str, payload: Mapping[str, Any]
) -> JsonValue
المعاملالنوعالتمريرالافتراضالمعنى
project_idstrpositional-or-keyword—معرّف المشروع المحفوظ، كما تعيده عملية إنشاء المشروع أو قائمة المشاريع.
media_idstrpositional-or-keyword—معرّف الوسائط في هذا المسار: معرّف وسائط المشروع لمسارات المشاريع، ومعرّف وسائط العملية للرفع والتحضير.
asset_idstrpositional-or-keyword—معرّف أصل الترجمة النصية أو الصوت التابع لوسائطه.
payloadMapping[str, Any]positional-or-keyword—خريطة طلب خاصة بنقطة النهاية. استخدم مخططها واحتفظ بقيم التحقق المطلوبة للملاحظة أو التحضير.

close

إغلاق مجموعة اتصالات HTTP؛ يستدعي مدير السياق ذلك تلقائياً.

Python
close() -> None

compare_media_asset_exports

مقارنة مرشحات التصدير المختارة دون استخراج ملفات محلية أو كتابتها.

Python
compare_media_asset_exports(
    project_id: str, media_id: str, asset_id: str, payload: Mapping[str, Any]
) -> JsonValue
المعاملالنوعالتمريرالافتراضالمعنى
project_idstrpositional-or-keyword—معرّف المشروع المحفوظ، كما تعيده عملية إنشاء المشروع أو قائمة المشاريع.
media_idstrpositional-or-keyword—معرّف الوسائط في هذا المسار: معرّف وسائط المشروع لمسارات المشاريع، ومعرّف وسائط العملية للرفع والتحضير.
asset_idstrpositional-or-keyword—معرّف أصل الترجمة النصية أو الصوت التابع لوسائطه.
payloadMapping[str, Any]positional-or-keyword—خريطة طلب خاصة بنقطة النهاية. استخدم مخططها واحتفظ بقيم التحقق المطلوبة للملاحظة أو التحضير.

complete_media_asset_checks

إكمال الفحوص الفعلية المحمية ومطابقة المصادر التي تمت ملاحظتها حديثاً.

Python
complete_media_asset_checks(
    project_id: str, media_id: str, payload: Mapping[str, Any]
) -> JsonValue
المعاملالنوعالتمريرالافتراضالمعنى
project_idstrpositional-or-keyword—معرّف المشروع المحفوظ، كما تعيده عملية إنشاء المشروع أو قائمة المشاريع.
media_idstrpositional-or-keyword—معرّف الوسائط في هذا المسار: معرّف وسائط المشروع لمسارات المشاريع، ومعرّف وسائط العملية للرفع والتحضير.
payloadMapping[str, Any]positional-or-keyword—خريطة طلب خاصة بنقطة النهاية. استخدم مخططها واحتفظ بقيم التحقق المطلوبة للملاحظة أو التحضير.

complete_upload

إتمام الرفع المباشر لعنصر المصدر والرفع ومحاولة التحضير الحالية.

Python
complete_upload(
    operation_id: str,
    media_id: str,
    *,
    content_id: str,
    attempt_id: str,
    upload_id: str,
    content_hash: str | None = None
) -> JsonValue
المعاملالنوعالتمريرالافتراضالمعنى
operation_idstrpositional-or-keyword—معرّف العملية التي تم اعتمادها؛ احتفظ به قبل المغادرة أو إعادة محاولة التحضير.
media_idstrpositional-or-keyword—معرّف الوسائط في هذا المسار: معرّف وسائط المشروع لمسارات المشاريع، ومعرّف وسائط العملية للرفع والتحضير.
content_idstrkeyword-only—معرّف عنصر مصدر داخل العملية، وليس معرّف وسائط مشروع أو ناتج مرحلة.
attempt_idstrkeyword-only—قيمة UUID جديدة يختارها المستدعي وتؤكدها استجابة التحضير؛ استخدمها في كل طلب يخص هذه المحاولة.
upload_idstrkeyword-only—معرّف الرفع من استجابة الهدف الحالية، المرتبط بالمحاولة الحالية.
content_hashstr | Nonekeyword-onlyNoneتجزئة البايتات المحضّرة أو تجزئة زوج الملفات الموثقة، وليست بصمة الوسائط الأصلية.

create_blank_media_asset

إنشاء أصل ترجمة نصية فارغ قابل للتحرير باستخدام طلب نقطة النهاية المحمي.

Python
create_blank_media_asset(
    project_id: str, media_id: str, payload: Mapping[str, Any]
) -> JsonValue
المعاملالنوعالتمريرالافتراضالمعنى
project_idstrpositional-or-keyword—معرّف المشروع المحفوظ، كما تعيده عملية إنشاء المشروع أو قائمة المشاريع.
media_idstrpositional-or-keyword—معرّف الوسائط في هذا المسار: معرّف وسائط المشروع لمسارات المشاريع، ومعرّف وسائط العملية للرفع والتحضير.
payloadMapping[str, Any]positional-or-keyword—خريطة طلب خاصة بنقطة النهاية. استخدم مخططها واحتفظ بقيم التحقق المطلوبة للملاحظة أو التحضير.

create_project

إنشاء مشروع ملف أو مجلد فارغ؛ يُرسل الجرد المحلي بشكل منفصل.

Python
create_project(
    *, name: str, mode: str, root_label: str | None = None
) -> JsonValue
المعاملالنوعالتمريرالافتراضالمعنى
namestrkeyword-only—اسم عرض المشروع؛ يمكن أن يستخدم update_project القيمة None لمسح قيمة تقبل الفراغ.
modestrkeyword-only—وضع المشروع: file أو directory.
root_labelstr | Nonekeyword-onlyNoneتسمية مقروءة للمجلد أو الملف الجذر، وليست مساراً محلياً يمكن للخادم الوصول إليه.

create_project_operation

اعتماد اختيارات المصادر المحمية والمقدّرة وخصم التقدير المقبول.

Python
create_project_operation(
    project_id: str,
    *,
    media_ids: Iterable[str],
    target_language: str,
    content_overrides: Iterable[Mapping[str, Any]] | None = None,
    metrics: Iterable[Mapping[str, Any]] | None = None,
    source_selections: Iterable[Mapping[str, Any]]
) -> JsonValue
المعاملالنوعالتمريرالافتراضالمعنى
project_idstrpositional-or-keyword—معرّف المشروع المحفوظ، كما تعيده عملية إنشاء المشروع أو قائمة المشاريع.
media_idsIterable[str]keyword-only—سجلات جرد متوافقة مع الخادم أو معرّفات وسائط المشروع المختارة؛ احصل على المعرّفات من الاستجابات الحالية.
target_languagestrkeyword-only—رمز اللغة الهدف للترجمة النصية المولدة أو المترجمة.
content_overridesIterable[Mapping[str, Any]] | Nonekeyword-onlyNoneتجاوزات مرتبطة بمرجع source_ref ثابت: تفعيل المصدر أو تحديد لغته صراحةً.
metricsIterable[Mapping[str, Any]] | Nonekeyword-onlyNoneمقاييس المصدر التي تطلبها الخطة الحالية فقط، محسوبة محلياً. مدة الصوت موجودة بالفعل في الجرد المفحوص.
source_selectionsIterable[Mapping[str, Any]]keyword-only—اختيارات محمية من الخطة المقدّرة مع source_language الموحّدة؛ احتفظ باللقطات والملاحظات.

create_project_operation_plan

طلب خطة للمصادر والمراحل دون خصم رصيد أو رفع بيانات.

Python
create_project_operation_plan(
    project_id: str,
    *,
    media_ids: Iterable[str],
    target_language: str,
    content_overrides: Iterable[Mapping[str, Any]] | None = None
) -> JsonValue
المعاملالنوعالتمريرالافتراضالمعنى
project_idstrpositional-or-keyword—معرّف المشروع المحفوظ، كما تعيده عملية إنشاء المشروع أو قائمة المشاريع.
media_idsIterable[str]keyword-only—سجلات جرد متوافقة مع الخادم أو معرّفات وسائط المشروع المختارة؛ احصل على المعرّفات من الاستجابات الحالية.
target_languagestrkeyword-only—رمز اللغة الهدف للترجمة النصية المولدة أو المترجمة.
content_overridesIterable[Mapping[str, Any]] | Nonekeyword-onlyNoneتجاوزات مرتبطة بمرجع source_ref ثابت: تفعيل المصدر أو تحديد لغته صراحةً.

create_upload_target

طلب هدف رفع مباشر أو تحديثه بعد دخول التحضير في حالة التجزئة أو الرفع.

Python
create_upload_target(
    operation_id: str,
    media_id: str,
    *,
    content_id: str,
    attempt_id: str,
    content_hash: str,
    filename: str | None = None
) -> JsonValue
المعاملالنوعالتمريرالافتراضالمعنى
operation_idstrpositional-or-keyword—معرّف العملية التي تم اعتمادها؛ احتفظ به قبل المغادرة أو إعادة محاولة التحضير.
media_idstrpositional-or-keyword—معرّف الوسائط في هذا المسار: معرّف وسائط المشروع لمسارات المشاريع، ومعرّف وسائط العملية للرفع والتحضير.
content_idstrkeyword-only—معرّف عنصر مصدر داخل العملية، وليس معرّف وسائط مشروع أو ناتج مرحلة.
attempt_idstrkeyword-only—قيمة UUID جديدة يختارها المستدعي وتؤكدها استجابة التحضير؛ استخدمها في كل طلب يخص هذه المحاولة.
content_hashstrkeyword-only—تجزئة البايتات المحضّرة أو تجزئة زوج الملفات الموثقة، وليست بصمة الوسائط الأصلية.
filenamestr | Nonekeyword-onlyNoneاسم الملف المحضّر مع امتداده الفعلي، لتحديد تنسيق التخزين.

estimate_project_operation_plan

تقدير الخطة الحالية باستخدام المقاييس الفعلية المطلوبة؛ افحص can_commit قبل طلب الموافقة.

Python
estimate_project_operation_plan(
    project_id: str,
    *,
    media_ids: Iterable[str],
    target_language: str,
    content_overrides: Iterable[Mapping[str, Any]] | None = None,
    metrics: Iterable[Mapping[str, Any]] | None = None
) -> JsonValue
المعاملالنوعالتمريرالافتراضالمعنى
project_idstrpositional-or-keyword—معرّف المشروع المحفوظ، كما تعيده عملية إنشاء المشروع أو قائمة المشاريع.
media_idsIterable[str]keyword-only—سجلات جرد متوافقة مع الخادم أو معرّفات وسائط المشروع المختارة؛ احصل على المعرّفات من الاستجابات الحالية.
target_languagestrkeyword-only—رمز اللغة الهدف للترجمة النصية المولدة أو المترجمة.
content_overridesIterable[Mapping[str, Any]] | Nonekeyword-onlyNoneتجاوزات مرتبطة بمرجع source_ref ثابت: تفعيل المصدر أو تحديد لغته صراحةً.
metricsIterable[Mapping[str, Any]] | Nonekeyword-onlyNoneمقاييس المصدر التي تطلبها الخطة الحالية فقط، محسوبة محلياً. مدة الصوت موجودة بالفعل في الجرد المفحوص.

export_media_asset

التقاط تصدير ترجمة لأصل محفوظ مع قيم تحقق حديثة للّقطة والإصدار والبيانات الوصفية.

Python
export_media_asset(
    project_id: str, media_id: str, asset_id: str, payload: Mapping[str, Any]
) -> JsonValue
المعاملالنوعالتمريرالافتراضالمعنى
project_idstrpositional-or-keyword—معرّف المشروع المحفوظ، كما تعيده عملية إنشاء المشروع أو قائمة المشاريع.
media_idstrpositional-or-keyword—معرّف الوسائط في هذا المسار: معرّف وسائط المشروع لمسارات المشاريع، ومعرّف وسائط العملية للرفع والتحضير.
asset_idstrpositional-or-keyword—معرّف أصل الترجمة النصية أو الصوت التابع لوسائطه.
payloadMapping[str, Any]positional-or-keyword—خريطة طلب خاصة بنقطة النهاية. استخدم مخططها واحتفظ بقيم التحقق المطلوبة للملاحظة أو التحضير.

export_project_operation_artifact

تصدير مرحلة ناجحة وثابتة محددة؛ لا يُنشئ التنزيل أصلاً قابلاً للتحرير أو أصلاً فعلياً.

Python
export_project_operation_artifact(
    project_id: str,
    operation_id: str,
    artifact_id: str,
    *,
    output_target: str | None = None
) -> JsonValue
المعاملالنوعالتمريرالافتراضالمعنى
project_idstrpositional-or-keyword—معرّف المشروع المحفوظ، كما تعيده عملية إنشاء المشروع أو قائمة المشاريع.
operation_idstrpositional-or-keyword—معرّف العملية التي تم اعتمادها؛ احتفظ به قبل المغادرة أو إعادة محاولة التحضير.
artifact_idstrpositional-or-keyword—معرّف ناتج مرحلة ناجحة وثابتة، كما تعيده قائمة النتائج.
output_targetstr | Nonekeyword-onlyNoneexternal_srt أو external_vtt أو external_ass أو embedded؛ تستخدم None افتراض نقطة النهاية أو الحساب.

export_project_operation_result

تصدير آخر مرحلة ناجحة لعنصر مصدر واحد في العملية.

Python
export_project_operation_result(
    project_id: str,
    operation_id: str,
    content_id: str,
    *,
    output_target: str | None = None
) -> JsonValue
المعاملالنوعالتمريرالافتراضالمعنى
project_idstrpositional-or-keyword—معرّف المشروع المحفوظ، كما تعيده عملية إنشاء المشروع أو قائمة المشاريع.
operation_idstrpositional-or-keyword—معرّف العملية التي تم اعتمادها؛ احتفظ به قبل المغادرة أو إعادة محاولة التحضير.
content_idstrpositional-or-keyword—معرّف عنصر مصدر داخل العملية، وليس معرّف وسائط مشروع أو ناتج مرحلة.
output_targetstr | Nonekeyword-onlyNoneexternal_srt أو external_vtt أو external_ass أو embedded؛ تستخدم None افتراض نقطة النهاية أو الحساب.

export_project_operation_result_names

أسماء الملفات النهائية للنتائج المحددة التي تُكتب معاً في ملف ZIP واحد أو مجلد واحد. تحصل الأسماء التي قد تتعارض على رقم أصل المصدر أو على رقم تسلسلي (clip.en.3.srt).

Python
export_project_operation_result_names(
    project_id: str,
    operation_id: str,
    artifact_ids: list[str],
    *,
    output_target: str
) -> JsonValue
المعاملالنوعالتمريرالافتراضالمعنى
project_idstrpositional-or-keyword—معرّف المشروع المحفوظ، كما تعيده عملية إنشاء المشروع أو قائمة المشاريع.
operation_idstrpositional-or-keyword—معرّف العملية التي تم اعتمادها؛ احتفظ به قبل المغادرة أو إعادة محاولة التحضير.
artifact_idslist[str]positional-or-keyword—معرّفات نواتج مراحل العملية الناجحة والثابتة التي تُكتب معاً، كما تعيدها قائمة النتائج.
output_targetstrkeyword-only—external_srt أو external_vtt أو external_ass؛ لا تملك النتائج المضمّنة أسماء ملفات خاصة بها.

generate_api_token

توليد رمز API النشط الوحيد مع استبدال السابق؛ يتولى المستدعي الموافقة وحماية السر.

Python
generate_api_token() -> JsonValue

get_api_token_status

قراءة حالة الرمز دون استعادة سر موجود.

Python
get_api_token_status() -> JsonValue

get_asset_document

قراءة مستند ترجمة محفوظ ومتسق مع إصداره الحالي.

Python
get_asset_document(
    project_id: str, media_id: str, asset_id: str
) -> JsonValue
المعاملالنوعالتمريرالافتراضالمعنى
project_idstrpositional-or-keyword—معرّف المشروع المحفوظ، كما تعيده عملية إنشاء المشروع أو قائمة المشاريع.
media_idstrpositional-or-keyword—معرّف الوسائط في هذا المسار: معرّف وسائط المشروع لمسارات المشاريع، ومعرّف وسائط العملية للرفع والتحضير.
asset_idstrpositional-or-keyword—معرّف أصل الترجمة النصية أو الصوت التابع لوسائطه.

get_maintenance_status

قراءة حالة صيانة البوابة دون مصادقة.

Python
get_maintenance_status() -> JsonValue

get_media_asset

قراءة أصل حالي واحد مع بيانات ارتباطه ولقطته.

Python
get_media_asset(
    project_id: str, media_id: str, asset_id: str
) -> JsonValue
المعاملالنوعالتمريرالافتراضالمعنى
project_idstrpositional-or-keyword—معرّف المشروع المحفوظ، كما تعيده عملية إنشاء المشروع أو قائمة المشاريع.
media_idstrpositional-or-keyword—معرّف الوسائط في هذا المسار: معرّف وسائط المشروع لمسارات المشاريع، ومعرّف وسائط العملية للرفع والتحضير.
asset_idstrpositional-or-keyword—معرّف أصل الترجمة النصية أو الصوت التابع لوسائطه.

get_operation

قراءة الحالة العامة المعتمدة للعملية؛ طابقها بعد الأحداث وإعادة الاتصال.

Python
get_operation(operation_id: str) -> JsonValue
المعاملالنوعالتمريرالافتراضالمعنى
operation_idstrpositional-or-keyword—معرّف العملية التي تم اعتمادها؛ احتفظ به قبل المغادرة أو إعادة محاولة التحضير.

get_project

قراءة مشروع مع نظرة عامة على جرده الحالي.

Python
get_project(project_id: str) -> JsonValue
المعاملالنوعالتمريرالافتراضالمعنى
project_idstrpositional-or-keyword—معرّف المشروع المحفوظ، كما تعيده عملية إنشاء المشروع أو قائمة المشاريع.

get_project_media

قراءة سجل وسائط مشروع حالي واحد.

Python
get_project_media(project_id: str, media_id: str) -> JsonValue
المعاملالنوعالتمريرالافتراضالمعنى
project_idstrpositional-or-keyword—معرّف المشروع المحفوظ، كما تعيده عملية إنشاء المشروع أو قائمة المشاريع.
media_idstrpositional-or-keyword—معرّف الوسائط في هذا المسار: معرّف وسائط المشروع لمسارات المشاريع، ومعرّف وسائط العملية للرفع والتحضير.

get_project_operation

قراءة عملية عبر مسار المشروع الذي يملكها.

Python
get_project_operation(project_id: str, operation_id: str) -> JsonValue
المعاملالنوعالتمريرالافتراضالمعنى
project_idstrpositional-or-keyword—معرّف المشروع المحفوظ، كما تعيده عملية إنشاء المشروع أو قائمة المشاريع.
operation_idstrpositional-or-keyword—معرّف العملية التي تم اعتمادها؛ احتفظ به قبل المغادرة أو إعادة محاولة التحضير.

get_session

قراءة مورد الجلسة الموثّقة.

Python
get_session() -> JsonValue

get_workflow_preferences

قراءة افتراضات سير العمل والتصدير للحساب؛ يمكن أن تتجاوزها الخيارات الصريحة.

Python
get_workflow_preferences() -> JsonValue

hide_media_asset

إخفاء أصل باستخدام قيم التحقق الحالية مع الاحتفاظ بسجل إنتاجه.

Python
hide_media_asset(
    project_id: str,
    media_id: str,
    asset_id: str,
    *,
    expected_autosave_version: int | None = None,
    guards: Mapping[str, Any] | None = None
) -> JsonValue
المعاملالنوعالتمريرالافتراضالمعنى
project_idstrpositional-or-keyword—معرّف المشروع المحفوظ، كما تعيده عملية إنشاء المشروع أو قائمة المشاريع.
media_idstrpositional-or-keyword—معرّف الوسائط في هذا المسار: معرّف وسائط المشروع لمسارات المشاريع، ومعرّف وسائط العملية للرفع والتحضير.
asset_idstrpositional-or-keyword—معرّف أصل الترجمة النصية أو الصوت التابع لوسائطه.
expected_autosave_versionint | Nonekeyword-onlyNoneقيم التحقق الحالية للملاحظة أو الجيل أو الحفظ من استجابة القراءة أو بدء الفحص؛ تتطلب القيم القديمة قراءة جديدة.
guardsMapping[str, Any] | Nonekeyword-onlyNoneقيم التحقق الحالية للملاحظة أو الجيل أو الحفظ من استجابة القراءة أو بدء الفحص؛ تتطلب القيم القديمة قراءة جديدة.

import_project

إنشاء مشروع من إعداد كامل للملفات والجرد المقدمين.

Python
import_project(
    *,
    name: str,
    mode: str,
    root_label: str | None = None,
    media: Iterable[Mapping[str, Any]] | None = None,
    file_evidence: Iterable[Mapping[str, Any]] | None = None
) -> JsonValue
المعاملالنوعالتمريرالافتراضالمعنى
namestrkeyword-only—اسم عرض المشروع؛ يمكن أن يستخدم update_project القيمة None لمسح قيمة تقبل الفراغ.
modestrkeyword-only—وضع المشروع: file أو directory.
root_labelstr | Nonekeyword-onlyNoneتسمية مقروءة للمجلد أو الملف الجذر، وليست مساراً محلياً يمكن للخادم الوصول إليه.
mediaIterable[Mapping[str, Any]] | Nonekeyword-onlyNoneسجلات جرد متوافقة مع الخادم أو معرّفات وسائط المشروع المختارة؛ احصل على المعرّفات من الاستجابات الحالية.
file_evidenceIterable[Mapping[str, Any]] | Nonekeyword-onlyNoneلقطة مجلد كاملة أو قائمة ملفات أو أدلة ملاحظة تتطلبها نقطة النهاية؛ أنشئها من الملفات المحلية.

list_media_assets

سرد الأصول المحفوظة التابعة لعنصر وسائط مشروع واحد.

Python
list_media_assets(
    project_id: str,
    media_id: str,
    *,
    limit: int = 50,
    offset: int = 0,
    content_type: str | None = None,
    kind: str | None = None,
    search: str | None = None,
    language: str | None = None,
    forced: bool | None = None,
    sdh: bool | None = None,
    commentary: bool | None = None,
    classification: str | None = None,
    readiness: str | None = None,
    placement: str | None = None,
    sort: str = 'created_at',
    direction: str = 'asc'
) -> JsonValue
المعاملالنوعالتمريرالافتراضالمعنى
project_idstrpositional-or-keyword—معرّف المشروع المحفوظ، كما تعيده عملية إنشاء المشروع أو قائمة المشاريع.
media_idstrpositional-or-keyword—معرّف الوسائط في هذا المسار: معرّف وسائط المشروع لمسارات المشاريع، ومعرّف وسائط العملية للرفع والتحضير.
limitintkeyword-only50حجم الصفحة أو إزاحة تبدأ من الصفر؛ تابع الصفحات حتى الوصول إلى العدد الإجمالي المعلن.
offsetintkeyword-only0حجم الصفحة أو إزاحة تبدأ من الصفر؛ تابع الصفحات حتى الوصول إلى العدد الإجمالي المعلن.
content_typestr | Nonekeyword-onlyNoneنوع MIME للبيانات المحضّرة؛ تتقدم ترويسة هدف الرفع إذا كانت تحدده بالفعل.
kindstr | Nonekeyword-onlyNoneمحدد خاص بنقطة النهاية لنوع الأصل أو نطاق الفحص أو الجاهزية أو الموضع؛ اتبع عقد نقطة النهاية.
searchstr | Nonekeyword-onlyNoneنص بحث اختياري لقائمة المشاريع أو الوسائط المطلوبة.
languagestr | Nonekeyword-onlyNoneلغة الترجمة أو تصنيفها العادي أو الإجباري أو SDH أو التعليق؛ تبقى رموز اللغة التقنية دون تغيير.
forcedbool | Nonekeyword-onlyNoneلغة الترجمة أو تصنيفها العادي أو الإجباري أو SDH أو التعليق؛ تبقى رموز اللغة التقنية دون تغيير.
sdhbool | Nonekeyword-onlyNoneلغة الترجمة أو تصنيفها العادي أو الإجباري أو SDH أو التعليق؛ تبقى رموز اللغة التقنية دون تغيير.
commentarybool | Nonekeyword-onlyNoneلغة الترجمة أو تصنيفها العادي أو الإجباري أو SDH أو التعليق؛ تبقى رموز اللغة التقنية دون تغيير.
classificationstr | Nonekeyword-onlyNoneلغة الترجمة أو تصنيفها العادي أو الإجباري أو SDH أو التعليق؛ تبقى رموز اللغة التقنية دون تغيير.
readinessstr | Nonekeyword-onlyNoneمحدد خاص بنقطة النهاية لنوع الأصل أو نطاق الفحص أو الجاهزية أو الموضع؛ اتبع عقد نقطة النهاية.
placementstr | Nonekeyword-onlyNoneمحدد خاص بنقطة النهاية لنوع الأصل أو نطاق الفحص أو الجاهزية أو الموضع؛ اتبع عقد نقطة النهاية.
sortstrkeyword-only'created_at'حقل الترتيب أو اتجاهه الذي تدعمه نقطة نهاية القائمة.
directionstrkeyword-only'asc'حقل الترتيب أو اتجاهه الذي تدعمه نقطة نهاية القائمة.

list_operations

سرد العمليات العامة مع تحديد الصفحات صراحةً.

Python
list_operations(*, limit: int = 50, offset: int = 0) -> JsonValue
المعاملالنوعالتمريرالافتراضالمعنى
limitintkeyword-only50حجم الصفحة أو إزاحة تبدأ من الصفر؛ تابع الصفحات حتى الوصول إلى العدد الإجمالي المعلن.
offsetintkeyword-only0حجم الصفحة أو إزاحة تبدأ من الصفر؛ تابع الصفحات حتى الوصول إلى العدد الإجمالي المعلن.

list_project_media

سرد وسائط المشروع مع المرشحات والصفحات؛ افحص total وstatus_counts.

Python
list_project_media(
    project_id: str,
    *,
    limit: int = 50,
    offset: int = 0,
    search: str | None = None,
    status: str = 'all',
    media_ids: Iterable[str] | None = None
) -> JsonValue
المعاملالنوعالتمريرالافتراضالمعنى
project_idstrpositional-or-keyword—معرّف المشروع المحفوظ، كما تعيده عملية إنشاء المشروع أو قائمة المشاريع.
limitintkeyword-only50حجم الصفحة أو إزاحة تبدأ من الصفر؛ تابع الصفحات حتى الوصول إلى العدد الإجمالي المعلن.
offsetintkeyword-only0حجم الصفحة أو إزاحة تبدأ من الصفر؛ تابع الصفحات حتى الوصول إلى العدد الإجمالي المعلن.
searchstr | Nonekeyword-onlyNoneنص بحث اختياري لقائمة المشاريع أو الوسائط المطلوبة.
statusstrkeyword-only'all'مرشح الحالة أو الحالة الجديدة وفقاً للدالة؛ تحتفظ المشاريع المؤرشفة بالنتائج المحفوظة.
media_idsIterable[str] | Nonekeyword-onlyNoneسجلات جرد متوافقة مع الخادم أو معرّفات وسائط المشروع المختارة؛ احصل على المعرّفات من الاستجابات الحالية.

list_project_operation_results

سرد نواتج المراحل الناجحة المحفوظة، بما فيها النتائج المفيدة من العمل الذي فشل جزئياً.

Python
list_project_operation_results(
    project_id: str, operation_id: str
) -> JsonValue
المعاملالنوعالتمريرالافتراضالمعنى
project_idstrpositional-or-keyword—معرّف المشروع المحفوظ، كما تعيده عملية إنشاء المشروع أو قائمة المشاريع.
operation_idstrpositional-or-keyword—معرّف العملية التي تم اعتمادها؛ احتفظ به قبل المغادرة أو إعادة محاولة التحضير.

list_project_operations

سرد عمليات المشروع، مع إمكانية حصرها في عنصر وسائط واحد.

Python
list_project_operations(
    project_id: str,
    *,
    limit: int = 50,
    offset: int = 0,
    media_id: str | None = None
) -> JsonValue
المعاملالنوعالتمريرالافتراضالمعنى
project_idstrpositional-or-keyword—معرّف المشروع المحفوظ، كما تعيده عملية إنشاء المشروع أو قائمة المشاريع.
limitintkeyword-only50حجم الصفحة أو إزاحة تبدأ من الصفر؛ تابع الصفحات حتى الوصول إلى العدد الإجمالي المعلن.
offsetintkeyword-only0حجم الصفحة أو إزاحة تبدأ من الصفر؛ تابع الصفحات حتى الوصول إلى العدد الإجمالي المعلن.
media_idstr | Nonekeyword-onlyNoneمعرّف الوسائط في هذا المسار: معرّف وسائط المشروع لمسارات المشاريع، ومعرّف وسائط العملية للرفع والتحضير.

list_archived_projects

عرض المشاريع المؤرشفة مع التصفية حسب الوضع والبحث والترتيب وتقسيم الصفحات. يُعرض الأحدث أرشفة أولًا افتراضيًا.

Python
list_archived_projects(
    *,
    limit: int = 50,
    offset: int = 0,
    mode: str | None = None,
    search: str | None = None,
    sort: str = 'archived_at',
    direction: str = 'desc'
) -> JsonValue
المعاملالنوعالتمريرالافتراضالمعنى
limitintkeyword-only50حجم الصفحة أو إزاحة تبدأ من الصفر؛ تابع الصفحات حتى الوصول إلى العدد الإجمالي المعلن.
offsetintkeyword-only0حجم الصفحة أو إزاحة تبدأ من الصفر؛ تابع الصفحات حتى الوصول إلى العدد الإجمالي المعلن.
modestr | Nonekeyword-onlyNoneوضع المشروع: file أو directory.
searchstr | Nonekeyword-onlyNoneنص بحث اختياري لقائمة المشاريع أو الوسائط المطلوبة.
sortstrkeyword-only'archived_at'حقل الترتيب أو اتجاهه الذي تدعمه نقطة نهاية القائمة.
directionstrkeyword-only'desc'حقل الترتيب أو اتجاهه الذي تدعمه نقطة نهاية القائمة.

list_projects

عرض المشاريع النشطة مع التصفية حسب الوضع والبحث والترتيب وتقسيم الصفحات.

Python
list_projects(
    *,
    limit: int = 50,
    offset: int = 0,
    mode: str | None = None,
    search: str | None = None,
    sort: str = 'updated_at',
    direction: str = 'desc'
) -> JsonValue
المعاملالنوعالتمريرالافتراضالمعنى
limitintkeyword-only50حجم الصفحة أو إزاحة تبدأ من الصفر؛ تابع الصفحات حتى الوصول إلى العدد الإجمالي المعلن.
offsetintkeyword-only0حجم الصفحة أو إزاحة تبدأ من الصفر؛ تابع الصفحات حتى الوصول إلى العدد الإجمالي المعلن.
modestr | Nonekeyword-onlyNoneوضع المشروع: file أو directory.
searchstr | Nonekeyword-onlyNoneنص بحث اختياري لقائمة المشاريع أو الوسائط المطلوبة.
sortstrkeyword-only'updated_at'حقل الترتيب أو اتجاهه الذي تدعمه نقطة نهاية القائمة.
directionstrkeyword-only'desc'حقل الترتيب أو اتجاهه الذي تدعمه نقطة نهاية القائمة.

materialize_asset

تسجيل نص ترجمة مستخرج محلياً من مصدر فعلي باستخدام قيم تحقق حديثة للملاحظة.

Python
materialize_asset(
    project_id: str, media_id: str, asset_id: str, payload: Mapping[str, Any]
) -> JsonValue
المعاملالنوعالتمريرالافتراضالمعنى
project_idstrpositional-or-keyword—معرّف المشروع المحفوظ، كما تعيده عملية إنشاء المشروع أو قائمة المشاريع.
media_idstrpositional-or-keyword—معرّف الوسائط في هذا المسار: معرّف وسائط المشروع لمسارات المشاريع، ومعرّف وسائط العملية للرفع والتحضير.
asset_idstrpositional-or-keyword—معرّف أصل الترجمة النصية أو الصوت التابع لوسائطه.
payloadMapping[str, Any]positional-or-keyword—خريطة طلب خاصة بنقطة النهاية. استخدم مخططها واحتفظ بقيم التحقق المطلوبة للملاحظة أو التحضير.

preview_project_directory_sync

مقارنة لقطة محلية كاملة بالجرد الحالي قبل تطبيق التغييرات.

Python
preview_project_directory_sync(
    project_id: str, files: Iterable[Mapping[str, Any]]
) -> JsonValue
المعاملالنوعالتمريرالافتراضالمعنى
project_idstrpositional-or-keyword—معرّف المشروع المحفوظ، كما تعيده عملية إنشاء المشروع أو قائمة المشاريع.
filesIterable[Mapping[str, Any]]positional-or-keyword—لقطة مجلد كاملة أو قائمة ملفات أو أدلة ملاحظة تتطلبها نقطة النهاية؛ أنشئها من الملفات المحلية.

preview_project_sidecars

العثور على تطابقات الملفات الجانبية وحالات الالتباس قبل إرفاقها.

Python
preview_project_sidecars(
    project_id: str, sidecars: Iterable[Mapping[str, Any]]
) -> JsonValue
المعاملالنوعالتمريرالافتراضالمعنى
project_idstrpositional-or-keyword—معرّف المشروع المحفوظ، كما تعيده عملية إنشاء المشروع أو قائمة المشاريع.
sidecarsIterable[Mapping[str, Any]]positional-or-keyword—ملفات ترجمة جانبية تم فحصها مع بيانات الاقتران والتصنيف.

put_upload_target

الرفع مباشرةً باستخدام طريقة الخادم وترويساته؛ يُحذف رمز SubFT.

Python
put_upload_target(
    upload_url: str,
    *,
    method: str = 'PUT',
    data: Any | None = None,
    content: Any | None = None,
    headers: Mapping[str, str] | None = None,
    content_type: str = 'application/octet-stream'
) -> httpx.Response
المعاملالنوعالتمريرالافتراضالمعنى
upload_urlstrpositional-or-keyword—عنوان من API؛ تُحل العناوين النسبية مقابل البوابة. لا يُرسل رمز SubFT إلى عناوين الرفع.
methodstrkeyword-only'PUT'طريقة HTTP؛ احتفظ بالطريقة الصادرة من الخادم عند الرفع المباشر.
dataAny | Nonekeyword-onlyNoneبيانات النموذج أو الرفع التي يقبلها HTTPX؛ لا تجمعها مع content في الرفع المباشر.
contentAny | Nonekeyword-onlyNoneبايتات خام أو مجموعة من كتل البايتات. استخدم الملف المحضّر للرفع.
headersMapping[str, str] | Nonekeyword-onlyNoneترويسات HTTP. مرّر ترويسات هدف الرفع دون تغيير؛ ترويسات الطلب العادي تتجاوز ترويسات المنشئ.
content_typestrkeyword-only'application/octet-stream'نوع MIME للبيانات المحضّرة؛ تتقدم ترويسة هدف الرفع إذا كانت تحدده بالفعل.

register_verified_asset_outputs

تسجيل المخرجات الفعلية المتحقق منها محلياً باستخدام التقاطها الثابت؛ لا يكفي التنزيل وحده.

Python
register_verified_asset_outputs(
    project_id: str, media_id: str, payload: Mapping[str, Any]
) -> JsonValue
المعاملالنوعالتمريرالافتراضالمعنى
project_idstrpositional-or-keyword—معرّف المشروع المحفوظ، كما تعيده عملية إنشاء المشروع أو قائمة المشاريع.
media_idstrpositional-or-keyword—معرّف الوسائط في هذا المسار: معرّف وسائط المشروع لمسارات المشاريع، ومعرّف وسائط العملية للرفع والتحضير.
payloadMapping[str, Any]positional-or-keyword—خريطة طلب خاصة بنقطة النهاية. استخدم مخططها واحتفظ بقيم التحقق المطلوبة للملاحظة أو التحضير.

remove_project_media

إزالة عنصر وسائط من الجرد النشط عبر مسار المشروع.

Python
remove_project_media(project_id: str, media_id: str) -> JsonValue
المعاملالنوعالتمريرالافتراضالمعنى
project_idstrpositional-or-keyword—معرّف المشروع المحفوظ، كما تعيده عملية إنشاء المشروع أو قائمة المشاريع.
media_idstrpositional-or-keyword—معرّف الوسائط في هذا المسار: معرّف وسائط المشروع لمسارات المشاريع، ومعرّف وسائط العملية للرفع والتحضير.

replace_project_media

مطابقة ملف وسائط محلي تغير باستخدام أدلة جرد جديدة.

Python
replace_project_media(
    project_id: str, media_id: str, media: Mapping[str, Any]
) -> JsonValue
المعاملالنوعالتمريرالافتراضالمعنى
project_idstrpositional-or-keyword—معرّف المشروع المحفوظ، كما تعيده عملية إنشاء المشروع أو قائمة المشاريع.
media_idstrpositional-or-keyword—معرّف الوسائط في هذا المسار: معرّف وسائط المشروع لمسارات المشاريع، ومعرّف وسائط العملية للرفع والتحضير.
mediaMapping[str, Any]positional-or-keyword—سجلات جرد متوافقة مع الخادم أو معرّفات وسائط المشروع المختارة؛ احصل على المعرّفات من الاستجابات الحالية.

report_content_progress

الإبلاغ عن تقدم العميل الخاص بالمحاولة وفق العقد الحالي ورقم مراجعة متزايد.

Python
report_content_progress(
    operation_id: str,
    media_id: str,
    content_id: str,
    payload: Mapping[str, Any]
) -> JsonValue
المعاملالنوعالتمريرالافتراضالمعنى
operation_idstrpositional-or-keyword—معرّف العملية التي تم اعتمادها؛ احتفظ به قبل المغادرة أو إعادة محاولة التحضير.
media_idstrpositional-or-keyword—معرّف الوسائط في هذا المسار: معرّف وسائط المشروع لمسارات المشاريع، ومعرّف وسائط العملية للرفع والتحضير.
content_idstrpositional-or-keyword—معرّف عنصر مصدر داخل العملية، وليس معرّف وسائط مشروع أو ناتج مرحلة.
payloadMapping[str, Any]positional-or-keyword—خريطة طلب خاصة بنقطة النهاية. استخدم مخططها واحتفظ بقيم التحقق المطلوبة للملاحظة أو التحضير.

request

إرسال طلب HTTP وإعادة الاستجابة الخام بعد معالجة الأخطاء المشتركة.

Python
request(
    method: str,
    path: str,
    *,
    params: Mapping[str, Any] | None = None,
    json: JsonValue | None = None,
    data: Any | None = None,
    content: Any | None = None,
    headers: Mapping[str, str] | None = None,
    authenticated: bool = True
) -> httpx.Response
المعاملالنوعالتمريرالافتراضالمعنى
methodstrpositional-or-keyword—طريقة HTTP؛ احتفظ بالطريقة الصادرة من الخادم عند الرفع المباشر.
pathstrpositional-or-keyword—مسار HTTP نسبة إلى base_url أو عنوان URL مطلق؛ ليس مساراً محلياً في نظام الملفات.
paramsMapping[str, Any] | Nonekeyword-onlyNoneمعاملات الاستعلام؛ تُحذف قيم None والمجموعات الفارغة.
jsonJsonValue | Nonekeyword-onlyNoneمحتوى طلب JSON، ويجب أن يطابق عقد نقطة النهاية.
dataAny | Nonekeyword-onlyNoneبيانات النموذج أو الرفع التي يقبلها HTTPX؛ لا تجمعها مع content في الرفع المباشر.
contentAny | Nonekeyword-onlyNoneبايتات خام أو مجموعة من كتل البايتات. استخدم الملف المحضّر للرفع.
headersMapping[str, str] | Nonekeyword-onlyNoneترويسات HTTP. مرّر ترويسات هدف الرفع دون تغيير؛ ترويسات الطلب العادي تتجاوز ترويسات المنشئ.
authenticatedboolkeyword-onlyTrueيحدد ما إذا كان العميل يضيف ترويسة تفويض SubFT. يستخدم الرفع المباشر False.

request_json

إرسال طلب HTTP وفك JSON؛ تعيد الاستجابات الفارغة None.

Python
request_json(
    method: str,
    path: str,
    *,
    params: Mapping[str, Any] | None = None,
    json: JsonValue | None = None,
    headers: Mapping[str, str] | None = None,
    authenticated: bool = True
) -> JsonValue
المعاملالنوعالتمريرالافتراضالمعنى
methodstrpositional-or-keyword—طريقة HTTP؛ احتفظ بالطريقة الصادرة من الخادم عند الرفع المباشر.
pathstrpositional-or-keyword—مسار HTTP نسبة إلى base_url أو عنوان URL مطلق؛ ليس مساراً محلياً في نظام الملفات.
paramsMapping[str, Any] | Nonekeyword-onlyNoneمعاملات الاستعلام؛ تُحذف قيم None والمجموعات الفارغة.
jsonJsonValue | Nonekeyword-onlyNoneمحتوى طلب JSON، ويجب أن يطابق عقد نقطة النهاية.
headersMapping[str, str] | Nonekeyword-onlyNoneترويسات HTTP. مرّر ترويسات هدف الرفع دون تغيير؛ ترويسات الطلب العادي تتجاوز ترويسات المنشئ.
authenticatedboolkeyword-onlyTrueيحدد ما إذا كان العميل يضيف ترويسة تفويض SubFT. يستخدم الرفع المباشر False.

resolve_url

حل عنوان نسبي من الخادم مقابل بوابة العميل.

Python
resolve_url(url: str) -> str
المعاملالنوعالتمريرالافتراضالمعنى
urlstrpositional-or-keyword—عنوان من API؛ تُحل العناوين النسبية مقابل البوابة. لا يُرسل رمز SubFT إلى عناوين الرفع.

restore_project_media

استعادة عنصر مؤرشف. يحتاج عنصر الفيديو أو الصوت إلى media، أي بيانات الجرد الحالية لملفه: تحتفظ المسارات غير المتغيرة بأصولها. ولا يحتاج عنصر الترجمة إلى شيء.

Python
restore_project_media(
    project_id: str, media_id: str, media: Mapping[str, Any] | None = None
) -> JsonValue
المعاملالنوعالتمريرالافتراضالمعنى
project_idstrpositional-or-keyword—معرّف المشروع المحفوظ، كما تعيده عملية إنشاء المشروع أو قائمة المشاريع.
media_idstrpositional-or-keyword—معرّف الوسائط في هذا المسار: معرّف وسائط المشروع لمسارات المشاريع، ومعرّف وسائط العملية للرفع والتحضير.
mediaMapping[str, Any] | Nonepositional-or-keywordNoneسجل الجرد لملف العنصر كما في replace_project_media؛ يُحذف لعنصر الترجمة.

retry_content_preparation

بدء محاولة تحضير جديدة مؤهلة مع التحقق بمعرّف المحاولة السابقة؛ لا يبدأ ذلك عملية جديدة.

Python
retry_content_preparation(
    operation_id: str,
    media_id: str,
    content_id: str,
    *,
    attempt_id: str,
    previous_attempt_id: str
) -> JsonValue
المعاملالنوعالتمريرالافتراضالمعنى
operation_idstrpositional-or-keyword—معرّف العملية التي تم اعتمادها؛ احتفظ به قبل المغادرة أو إعادة محاولة التحضير.
media_idstrpositional-or-keyword—معرّف الوسائط في هذا المسار: معرّف وسائط المشروع لمسارات المشاريع، ومعرّف وسائط العملية للرفع والتحضير.
content_idstrpositional-or-keyword—معرّف عنصر مصدر داخل العملية، وليس معرّف وسائط مشروع أو ناتج مرحلة.
attempt_idstrkeyword-only—قيمة UUID جديدة يختارها المستدعي وتؤكدها استجابة التحضير؛ استخدمها في كل طلب يخص هذه المحاولة.
previous_attempt_idstrkeyword-only—معرّف المحاولة في أحدث حالة تحضير معتمدة، ويستخدم للتحقق عند إعادة المحاولة.

revoke_api_token

إلغاء الرمز النشط على الخادم؛ لا يؤدي حذف رمز محفوظ محلياً إلى ذلك.

Python
revoke_api_token() -> JsonValue

save_media_asset_document

حفظ المقاطع القابلة للتحرير مع قيم تحقق للّقطة والإصدار؛ تتطلب التعارضات قراءة جديدة للمستند.

Python
save_media_asset_document(
    project_id: str, media_id: str, asset_id: str, payload: Mapping[str, Any]
) -> JsonValue
المعاملالنوعالتمريرالافتراضالمعنى
project_idstrpositional-or-keyword—معرّف المشروع المحفوظ، كما تعيده عملية إنشاء المشروع أو قائمة المشاريع.
media_idstrpositional-or-keyword—معرّف الوسائط في هذا المسار: معرّف وسائط المشروع لمسارات المشاريع، ومعرّف وسائط العملية للرفع والتحضير.
asset_idstrpositional-or-keyword—معرّف أصل الترجمة النصية أو الصوت التابع لوسائطه.
payloadMapping[str, Any]positional-or-keyword—خريطة طلب خاصة بنقطة النهاية. استخدم مخططها واحتفظ بقيم التحقق المطلوبة للملاحظة أو التحضير.

scan_project_directory

طلب تصنيف لقطة محلية مقدمة من الخادم؛ لا يستطيع الخادم فحص قرص المستدعي.

Python
scan_project_directory(files: Iterable[str]) -> JsonValue
المعاملالنوعالتمريرالافتراضالمعنى
filesIterable[str]positional-or-keyword—لقطة مجلد كاملة أو قائمة ملفات أو أدلة ملاحظة تتطلبها نقطة النهاية؛ أنشئها من الملفات المحلية.

start_content_preparation

بدء محاولة تحضير مسموح بها بقيمة UUID جديدة قبل التجزئة والرفع.

Python
start_content_preparation(
    operation_id: str, media_id: str, content_id: str, *, attempt_id: str
) -> JsonValue
المعاملالنوعالتمريرالافتراضالمعنى
operation_idstrpositional-or-keyword—معرّف العملية التي تم اعتمادها؛ احتفظ به قبل المغادرة أو إعادة محاولة التحضير.
media_idstrpositional-or-keyword—معرّف الوسائط في هذا المسار: معرّف وسائط المشروع لمسارات المشاريع، ومعرّف وسائط العملية للرفع والتحضير.
content_idstrpositional-or-keyword—معرّف عنصر مصدر داخل العملية، وليس معرّف وسائط مشروع أو ناتج مرحلة.
attempt_idstrkeyword-only—قيمة UUID جديدة يختارها المستدعي وتؤكدها استجابة التحضير؛ استخدمها في كل طلب يخص هذه المحاولة.

update_content_preparation

تحديث التحضير أو تجديد نبضه أو الإبلاغ عن فشل awaiting_retry برمز المحاولة نفسه.

Python
update_content_preparation(
    operation_id: str,
    media_id: str,
    content_id: str,
    attempt_id: str,
    payload: Mapping[str, Any]
) -> JsonValue
المعاملالنوعالتمريرالافتراضالمعنى
operation_idstrpositional-or-keyword—معرّف العملية التي تم اعتمادها؛ احتفظ به قبل المغادرة أو إعادة محاولة التحضير.
media_idstrpositional-or-keyword—معرّف الوسائط في هذا المسار: معرّف وسائط المشروع لمسارات المشاريع، ومعرّف وسائط العملية للرفع والتحضير.
content_idstrpositional-or-keyword—معرّف عنصر مصدر داخل العملية، وليس معرّف وسائط مشروع أو ناتج مرحلة.
attempt_idstrpositional-or-keyword—قيمة UUID جديدة يختارها المستدعي وتؤكدها استجابة التحضير؛ استخدمها في كل طلب يخص هذه المحاولة.
payloadMapping[str, Any]positional-or-keyword—خريطة طلب خاصة بنقطة النهاية. استخدم مخططها واحتفظ بقيم التحقق المطلوبة للملاحظة أو التحضير.

update_media_asset

تحديث البيانات الوصفية المسموح بها للأصل مع الحفاظ على محتوى الترجمة.

Python
update_media_asset(
    project_id: str, media_id: str, asset_id: str, metadata: Mapping[str, Any]
) -> JsonValue
المعاملالنوعالتمريرالافتراضالمعنى
project_idstrpositional-or-keyword—معرّف المشروع المحفوظ، كما تعيده عملية إنشاء المشروع أو قائمة المشاريع.
media_idstrpositional-or-keyword—معرّف الوسائط في هذا المسار: معرّف وسائط المشروع لمسارات المشاريع، ومعرّف وسائط العملية للرفع والتحضير.
asset_idstrpositional-or-keyword—معرّف أصل الترجمة النصية أو الصوت التابع لوسائطه.
metadataMapping[str, Any]positional-or-keyword—بيانات اللغة والتصنيف المسموح بها للأصل؛ لا يؤدي ذلك إلى تعديل مقاطع الترجمة.

update_project

تحديث حقول المشروع المقدمة. تختلف حقول _UNSET المحذوفة عن القيم الممسوحة صراحةً باستخدام None.

Python
update_project(
    project_id: str,
    *,
    name: str | None | object = _UNSET,
    root_label: str | None | object = _UNSET
) -> JsonValue
المعاملالنوعالتمريرالافتراضالمعنى
project_idstrpositional-or-keyword—معرّف المشروع المحفوظ، كما تعيده عملية إنشاء المشروع أو قائمة المشاريع.
namestr | None | objectkeyword-only_UNSETاسم عرض المشروع؛ يمكن أن يستخدم update_project القيمة None لمسح قيمة تقبل الفراغ.
root_labelstr | None | objectkeyword-only_UNSETتسمية مقروءة للمجلد أو الملف الجذر، وليست مساراً محلياً يمكن للخادم الوصول إليه.

verify_auth

التحقق من بيانات الاعتماد الفعلية وقراءة هوية الحساب.

Python
verify_auth() -> JsonValue

صادرات الحزمة الأساسية

استورد من subft_client. تحتاج الدوال المحلية إلى الإضافة المحلية وأدوات النظام المختارة. افحص الأخطاء المعادة قبل تحديث الجرد لدى الخادم. يحتاج الاتصال الفوري إلى إضافته ولا يطابق حالة HTTP المعتمدة.

JsonArray

ثابت عام أو اسم مستعار لنوع. تأتي القيمة أدناه من المصدر؛ تحتفظ المعرّفات والوحدات بمعناها التقني.

Python
JsonArray = list[Any]

JsonObject

ثابت عام أو اسم مستعار لنوع. تأتي القيمة أدناه من المصدر؛ تحتفظ المعرّفات والوحدات بمعناها التقني.

Python
JsonObject = dict[str, Any]

JsonValue

ثابت عام أو اسم مستعار لنوع. تأتي القيمة أدناه من المصدر؛ تحتفظ المعرّفات والوحدات بمعناها التقني.

Python
JsonValue = Any

SubftApiError

استثناء عام. التقط النوع المحدد عندما تختلف المعالجة؛ يغطي الاستثناء الأساسي الأنواع المشتقة. تحتفظ حقول المنشئ الاختيارية بحالة HTTP أو البيانات أو أدلة النقل كما يحدد النوع.

Python
SubftApiError(
    status_code: int,
    message: str,
    *,
    payload: Any | None = None,
    response: httpx.Response | None = None
) -> None

SubftClient

عميل عام أو سجل ثابت. تمثل الحقول أدلة محلية أو فورية معادة، وليست أمراً لبدء العمل. تعرض الدوال أدناه القيم المسجلة.

Python
SubftClient(
    base_url: str,
    *,
    token: str | None = None,
    timeout: float | httpx.Timeout = 30.0,
    headers: Mapping[str, str] | None = None,
    cookies: Mapping[str, str] | None = None,
    transport: httpx.BaseTransport | None = None
) -> None

SubftError

استثناء عام. التقط النوع المحدد عندما تختلف المعالجة؛ يغطي الاستثناء الأساسي الأنواع المشتقة. تحتفظ حقول المنشئ الاختيارية بحالة HTTP أو البيانات أو أدلة النقل كما يحدد النوع.

SubftMaintenanceError

استثناء عام. التقط النوع المحدد عندما تختلف المعالجة؛ يغطي الاستثناء الأساسي الأنواع المشتقة. تحتفظ حقول المنشئ الاختيارية بحالة HTTP أو البيانات أو أدلة النقل كما يحدد النوع.

Python
SubftMaintenanceError(
    status_code: int,
    message: str,
    *,
    payload: Any | None = None,
    response: httpx.Response | None = None,
    mode: str | None = None,
    maintenance_until: str | None = None
) -> None

SubftTransportError

استثناء عام. التقط النوع المحدد عندما تختلف المعالجة؛ يغطي الاستثناء الأساسي الأنواع المشتقة. تحتفظ حقول المنشئ الاختيارية بحالة HTTP أو البيانات أو أدلة النقل كما يحدد النوع.

Python
SubftTransportError(
    message: str, *, request_error: httpx.RequestError
) -> None

__version__

ثابت عام أو اسم مستعار لنوع. تأتي القيمة أدناه من المصدر؛ تحتفظ المعرّفات والوحدات بمعناها التقني.

Python
__version__ = '0.1.0'

الأدوات والسجلات المحلية

استورد من subft_client.local. تحتاج الدوال المحلية إلى الإضافة المحلية وأدوات النظام المختارة. افحص الأخطاء المعادة قبل تحديث الجرد لدى الخادم. يحتاج الاتصال الفوري إلى إضافته ولا يطابق حالة HTTP المعتمدة.

AUDIO_EXTENSIONS

ثابت عام أو اسم مستعار لنوع. تأتي القيمة أدناه من المصدر؛ تحتفظ المعرّفات والوحدات بمعناها التقني.

Python
AUDIO_EXTENSIONS = frozenset({'mp3', 'wav', 'flac', 'aac', 'ogg', 'm4a'})

DEFAULT_HASH_CHUNK_SIZE

ثابت عام أو اسم مستعار لنوع. تأتي القيمة أدناه من المصدر؛ تحتفظ المعرّفات والوحدات بمعناها التقني.

Python
DEFAULT_HASH_CHUNK_SIZE = 4 * 1024 * 1024

DirectorySnapshotFile

عميل عام أو سجل ثابت. تمثل الحقول أدلة محلية أو فورية معادة، وليست أمراً لبدء العمل. تعرض الدوال أدناه القيم المسجلة.

الحقلالنوعمطلوبالتصريح / الافتراضالمعنى
pathstrTrue—جذر محلي أو مسار أو مسار POSIX نسبي. تستبعد أدوات الفحص الروابط الرمزية؛ أبق المسارات داخل الجذر المختار.
size_bytesintTrue—حجم الملف أو النقل الفعلي أو تقدم البايتات المقاس.
last_modified_msintTrue—وقت تعديل الملف الذي تمت ملاحظته بالمللي ثانية.
mime_typestr | NoneTrue—نوع MIME المكتشف؛ لا يثبت وحده دعم الترميز.
file_kindLocalFileKindTrue—امتداد معروف أو تصنيف الجرد أو الحاوية المفحوصة.
file_fingerprint_hashstr | NoneFalseNoneبصمة أو تجزئة مقاسة من المصدر؛ راع نوع البصمة في السجل.
language_text_samplestr | NoneFalseNoneنص ترجمة فعلي محدود يستخدم كدليل على اللغة.
Python
to_api_dict() -> JsonObject

DirectorySnapshotResult

عميل عام أو سجل ثابت. تمثل الحقول أدلة محلية أو فورية معادة، وليست أمراً لبدء العمل. تعرض الدوال أدناه القيم المسجلة.

الحقلالنوعمطلوبالتصريح / الافتراضالمعنى
filestuple[DirectorySnapshotFile, ...]True—لقطة مجلد كاملة أو قائمة ملفات أو أدلة ملاحظة تتطلبها نقطة النهاية؛ أنشئها من الملفات المحلية.
failurestuple[LocalFailure, ...]True—أخطاء مسجلة لكل عنصر؛ لا تجعل هذه القائمة إرسال جرد جزئي آمناً.
Python
to_api_dict() -> JsonObject

ExtractedFile

عميل عام أو سجل ثابت. تمثل الحقول أدلة محلية أو فورية معادة، وليست أمراً لبدء العمل. تعرض الدوال أدناه القيم المسجلة.

الحقلالنوعمطلوبالتصريح / الافتراضالمعنى
pathPathTrue—جذر محلي أو مسار أو مسار POSIX نسبي. تستبعد أدوات الفحص الروابط الرمزية؛ أبق المسارات داخل الجذر المختار.
filenamestrTrue—اسم الملف المحضّر مع امتداده الفعلي، لتحديد تنسيق التخزين.
content_typestrTrue—نوع MIME للبيانات المحضّرة؛ تتقدم ترويسة هدف الرفع إذا كانت تحدده بالفعل.
Python
to_api_dict() -> JsonObject

FfmpegTools

عميل عام أو سجل ثابت. تمثل الحقول أدلة محلية أو فورية معادة، وليست أمراً لبدء العمل. تعرض الدوال أدناه القيم المسجلة.

الحقلالنوعمطلوبالتصريح / الافتراضالمعنى
wrapper_availableboolTrue—تثبيت الأداة أو إصدارها أو تشخيصها المرصود؛ لا تثبت إضافات Python البرامج التنفيذية للنظام.
ffmpeg_pathstr | NoneTrue—تثبيت الأداة أو إصدارها أو تشخيصها المرصود؛ لا تثبت إضافات Python البرامج التنفيذية للنظام.
ffmpeg_versionstr | NoneTrue—تثبيت الأداة أو إصدارها أو تشخيصها المرصود؛ لا تثبت إضافات Python البرامج التنفيذية للنظام.
ffmpeg_errorstr | NoneTrue—تثبيت الأداة أو إصدارها أو تشخيصها المرصود؛ لا تثبت إضافات Python البرامج التنفيذية للنظام.
ffprobe_pathstr | NoneTrue—تثبيت الأداة أو إصدارها أو تشخيصها المرصود؛ لا تثبت إضافات Python البرامج التنفيذية للنظام.
ffprobe_versionstr | NoneTrue—تثبيت الأداة أو إصدارها أو تشخيصها المرصود؛ لا تثبت إضافات Python البرامج التنفيذية للنظام.
ffprobe_errorstr | NoneTrue—تثبيت الأداة أو إصدارها أو تشخيصها المرصود؛ لا تثبت إضافات Python البرامج التنفيذية للنظام.
Python
ffmpeg_available: bool
Python
ffprobe_available: bool
Python
available: bool
Python
to_api_dict() -> JsonObject

FfmpegUnavailableError

استثناء عام. التقط النوع المحدد عندما تختلف المعالجة؛ يغطي الاستثناء الأساسي الأنواع المشتقة. تحتفظ حقول المنشئ الاختيارية بحالة HTTP أو البيانات أو أدلة النقل كما يحدد النوع.

FileFingerprint

عميل عام أو سجل ثابت. تمثل الحقول أدلة محلية أو فورية معادة، وليست أمراً لبدء العمل. تعرض الدوال أدناه القيم المسجلة.

الحقلالنوعمطلوبالتصريح / الافتراضالمعنى
kindFingerprintKindTrue—محدد خاص بنقطة النهاية لنوع الأصل أو نطاق الفحص أو الجاهزية أو الموضع؛ اتبع عقد نقطة النهاية.
hashstrTrue—بصمة أو تجزئة مقاسة من المصدر؛ راع نوع البصمة في السجل.
Python
to_api_dict() -> JsonObject

GRAPHICAL_SUBTITLE_EXTENSIONS

ثابت عام أو اسم مستعار لنوع. تأتي القيمة أدناه من المصدر؛ تحتفظ المعرّفات والوحدات بمعناها التقني.

Python
GRAPHICAL_SUBTITLE_EXTENSIONS = frozenset({'sup', 'idx', 'sub'})

InventoryResult

عميل عام أو سجل ثابت. تمثل الحقول أدلة محلية أو فورية معادة، وليست أمراً لبدء العمل. تعرض الدوال أدناه القيم المسجلة.

الحقلالنوعمطلوبالتصريح / الافتراضالمعنى
itemstuple[MediaInventoryItem, ...]True—سجلات جرد وسائط مفحوصة؛ افحص الأخطاء قبل إرسالها.
failurestuple[LocalFailure, ...]True—أخطاء مسجلة لكل عنصر؛ لا تجعل هذه القائمة إرسال جرد جزئي آمناً.
total_candidatesintTrue—عدد مرشحات الفحص قبل استبعاد الملفات غير المدعومة أو الأخطاء.
Python
to_api_dict() -> JsonObject

LANGUAGE_SAMPLE_BYTES

ثابت عام أو اسم مستعار لنوع. تأتي القيمة أدناه من المصدر؛ تحتفظ المعرّفات والوحدات بمعناها التقني.

Python
LANGUAGE_SAMPLE_BYTES = 64 * 1024

LocalFailure

عميل عام أو سجل ثابت. تمثل الحقول أدلة محلية أو فورية معادة، وليست أمراً لبدء العمل. تعرض الدوال أدناه القيم المسجلة.

الحقلالنوعمطلوبالتصريح / الافتراضالمعنى
pathstrTrue—جذر محلي أو مسار أو مسار POSIX نسبي. تستبعد أدوات الفحص الروابط الرمزية؛ أبق المسارات داخل الجذر المختار.
error_typestrTrue—بيانات تشخيص تقنية للسجلات الداخلية؛ يجب أن تحول الواجهات العامة الرموز إلى نص مترجم.
messagestrTrue—بيانات تشخيص تقنية للسجلات الداخلية؛ يجب أن تحول الواجهات العامة الرموز إلى نص مترجم.
Python
from_exception(path: str | Path, error: Exception) -> LocalFailure
Python
to_api_dict() -> JsonObject

LocalFile

عميل عام أو سجل ثابت. تمثل الحقول أدلة محلية أو فورية معادة، وليست أمراً لبدء العمل. تعرض الدوال أدناه القيم المسجلة.

الحقلالنوعمطلوبالتصريح / الافتراضالمعنى
absolute_pathPathTrue—مسار محلي محسوم للمستدعي؛ لا تنشره في البحث العام.
relative_pathstrTrue—جذر محلي أو مسار أو مسار POSIX نسبي. تستبعد أدوات الفحص الروابط الرمزية؛ أبق المسارات داخل الجذر المختار.
size_bytesintTrue—حجم الملف أو النقل الفعلي أو تقدم البايتات المقاس.
last_modified_msintTrue—وقت تعديل الملف الذي تمت ملاحظته بالمللي ثانية.
mime_typestr | NoneTrue—نوع MIME المكتشف؛ لا يثبت وحده دعم الترميز.
suffixstrTrue—امتداد معروف أو تصنيف الجرد أو الحاوية المفحوصة.
file_kindLocalFileKindTrue—امتداد معروف أو تصنيف الجرد أو الحاوية المفحوصة.
Python
to_api_dict() -> JsonObject

LocalFileChangedError

استثناء عام. التقط النوع المحدد عندما تختلف المعالجة؛ يغطي الاستثناء الأساسي الأنواع المشتقة. تحتفظ حقول المنشئ الاختيارية بحالة HTTP أو البيانات أو أدلة النقل كما يحدد النوع.

LocalHashError

استثناء عام. التقط النوع المحدد عندما تختلف المعالجة؛ يغطي الاستثناء الأساسي الأنواع المشتقة. تحتفظ حقول المنشئ الاختيارية بحالة HTTP أو البيانات أو أدلة النقل كما يحدد النوع.

LocalPathError

استثناء عام. التقط النوع المحدد عندما تختلف المعالجة؛ يغطي الاستثناء الأساسي الأنواع المشتقة. تحتفظ حقول المنشئ الاختيارية بحالة HTTP أو البيانات أو أدلة النقل كما يحدد النوع.

LocalProgress

عميل عام أو سجل ثابت. تمثل الحقول أدلة محلية أو فورية معادة، وليست أمراً لبدء العمل. تعرض الدوال أدناه القيم المسجلة.

الحقلالنوعمطلوبالتصريح / الافتراضالمعنى
phaseProgressPhaseTrue—مرحلة التقدم المحلي وعدد العناصر أو البايتات المكتملة المقاس؛ الاستدعاءات متزامنة.
pathstr | NoneTrue—جذر محلي أو مسار أو مسار POSIX نسبي. تستبعد أدوات الفحص الروابط الرمزية؛ أبق المسارات داخل الجذر المختار.
currentintTrue—مرحلة التقدم المحلي وعدد العناصر أو البايتات المكتملة المقاس؛ الاستدعاءات متزامنة.
totalintTrue—مرحلة التقدم المحلي وعدد العناصر أو البايتات المكتملة المقاس؛ الاستدعاءات متزامنة.
loaded_bytesint | NoneFalseNoneحجم الملف أو النقل الفعلي أو تقدم البايتات المقاس.
total_bytesint | NoneFalseNoneحجم الملف أو النقل الفعلي أو تقدم البايتات المقاس.
Python
percent: float
Python
to_api_dict() -> JsonObject

LocalScanError

استثناء عام. التقط النوع المحدد عندما تختلف المعالجة؛ يغطي الاستثناء الأساسي الأنواع المشتقة. تحتفظ حقول المنشئ الاختيارية بحالة HTTP أو البيانات أو أدلة النقل كما يحدد النوع.

MediaInventoryItem

عميل عام أو سجل ثابت. تمثل الحقول أدلة محلية أو فورية معادة، وليست أمراً لبدء العمل. تعرض الدوال أدناه القيم المسجلة.

الحقلالنوعمطلوبالتصريح / الافتراضالمعنى
pathstrTrue—جذر محلي أو مسار أو مسار POSIX نسبي. تستبعد أدوات الفحص الروابط الرمزية؛ أبق المسارات داخل الجذر المختار.
display_namestrTrue—اسم العرض لعنصر الوسائط هذا الذي تمت ملاحظته محلياً.
size_bytesintTrue—حجم الملف أو النقل الفعلي أو تقدم البايتات المقاس.
last_modified_msintTrue—وقت تعديل الملف الذي تمت ملاحظته بالمللي ثانية.
mime_typestr | NoneTrue—نوع MIME المكتشف؛ لا يثبت وحده دعم الترميز.
file_fingerprint_hashstr | NoneTrue—بصمة أو تجزئة مقاسة من المصدر؛ راع نوع البصمة في السجل.
duration_secondsfloatTrue—المدة المقاسة بالثواني، وليست وقت معالجة مضموناً.
container_formatstr | NoneTrue—امتداد معروف أو تصنيف الجرد أو الحاوية المفحوصة.
probe_dataJsonObject | NoneTrue—أدلة الحاوية والمسارات الفعلية من FFprobe؛ تحتفظ الخرائط المفتوحة بحقول الفحص.
streamstuple[ProbeStream, ...]True—سجلات مسارات صوت أو ترجمة موحّدة مع أرقام المسارات الأصلية.
statusstrFalse'active'مرشح الحالة أو الحالة الجديدة وفقاً للدالة؛ تحتفظ المشاريع المؤرشفة بالنتائج المحفوظة.
Python
to_api_dict() -> JsonObject

MediaEmbeddingError

استثناء عام. التقط النوع المحدد عندما تختلف المعالجة؛ يغطي الاستثناء الأساسي الأنواع المشتقة. تحتفظ حقول المنشئ الاختيارية بحالة HTTP أو البيانات أو أدلة النقل كما يحدد النوع.

MediaExtractionError

استثناء عام. التقط النوع المحدد عندما تختلف المعالجة؛ يغطي الاستثناء الأساسي الأنواع المشتقة. تحتفظ حقول المنشئ الاختيارية بحالة HTTP أو البيانات أو أدلة النقل كما يحدد النوع.

MediaProbe

عميل عام أو سجل ثابت. تمثل الحقول أدلة محلية أو فورية معادة، وليست أمراً لبدء العمل. تعرض الدوال أدناه القيم المسجلة.

الحقلالنوعمطلوبالتصريح / الافتراضالمعنى
duration_secondsfloatTrue—المدة المقاسة بالثواني، وليست وقت معالجة مضموناً.
has_audioboolTrue—يحدد ما إذا كان المسار أو المصدر المرصود قابلاً للاختيار أو يحتوي على صوت.
streamstuple[ProbeStream, ...]True—سجلات مسارات صوت أو ترجمة موحّدة مع أرقام المسارات الأصلية.
formatJsonObjectTrue—أدلة الحاوية والمسارات الفعلية من FFprobe؛ تحتفظ الخرائط المفتوحة بحقول الفحص.
raw_streamstuple[JsonObject, ...]True—أدلة الحاوية والمسارات الفعلية من FFprobe؛ تحتفظ الخرائط المفتوحة بحقول الفحص.
Python
to_api_dict() -> JsonObject

MediaProbeError

استثناء عام. التقط النوع المحدد عندما تختلف المعالجة؛ يغطي الاستثناء الأساسي الأنواع المشتقة. تحتفظ حقول المنشئ الاختيارية بحالة HTTP أو البيانات أو أدلة النقل كما يحدد النوع.

MuxedMedia

عميل عام أو سجل ثابت. تمثل الحقول أدلة محلية أو فورية معادة، وليست أمراً لبدء العمل. تعرض الدوال أدناه القيم المسجلة.

الحقلالنوعمطلوبالتصريح / الافتراضالمعنى
pathPathTrue—جذر محلي أو مسار أو مسار POSIX نسبي. تستبعد أدوات الفحص الروابط الرمزية؛ أبق المسارات داخل الجذر المختار.
size_bytesintTrue—حجم الملف أو النقل الفعلي أو تقدم البايتات المقاس.
last_modified_msintTrue—وقت تعديل الملف الذي تمت ملاحظته بالمللي ثانية.
Python
to_api_dict() -> JsonObject

ProbeStream

عميل عام أو سجل ثابت. تمثل الحقول أدلة محلية أو فورية معادة، وليست أمراً لبدء العمل. تعرض الدوال أدناه القيم المسجلة.

الحقلالنوعمطلوبالتصريح / الافتراضالمعنى
stream_indexint | NoneTrue—رقم مسار FFprobe أو أرقام المسارات المحددة للاستبدال، وليس ترتيبها في قائمة مفلترة.
stream_typestrTrue—ترميز المسار الفعلي أو تصنيف الترجمة، بشكل مستقل عن التعرف عند الاستيراد.
stream_classStreamClassTrue—التصنيف العادي أو أي مجموعة من التعليق والإجباري وSDH.
codec_typestrTrue—ترميز المسار الفعلي أو تصنيف الترجمة، بشكل مستقل عن التعرف عند الاستيراد.
codec_namestr | NoneTrue—ترميز المسار الفعلي أو تصنيف الترجمة، بشكل مستقل عن التعرف عند الاستيراد.
languagestr | NoneTrue—لغة الترجمة أو تصنيفها العادي أو الإجباري أو SDH أو التعليق؛ تبقى رموز اللغة التقنية دون تغيير.
tagsJsonObject | NoneTrue—بيانات المسار الحالية والأدلة الفعلية المستخدمة للتحقق من الملاحظة.
dispositionJsonObject | NoneTrue—بيانات المسار الحالية والأدلة الفعلية المستخدمة للتحقق من الملاحظة.
selectableboolFalseTrueيحدد ما إذا كان المسار أو المصدر المرصود قابلاً للاختيار أو يحتوي على صوت.
language_text_samplestr | NoneFalseNoneنص ترجمة فعلي محدود يستخدم كدليل على اللغة.
sidecar_pathstr | NoneFalseNoneهوية الملف المرافق وأدلته المرصودة؛ احتفظ بزوج الملفات المتطابق.
sidecar_display_namestr | NoneFalseNoneهوية الملف المرافق وأدلته المرصودة؛ احتفظ بزوج الملفات المتطابق.
sidecar_size_bytesint | NoneFalseNoneهوية الملف المرافق وأدلته المرصودة؛ احتفظ بزوج الملفات المتطابق.
sidecar_last_modified_msint | NoneFalseNoneهوية الملف المرافق وأدلته المرصودة؛ احتفظ بزوج الملفات المتطابق.
sidecar_content_hashstr | NoneFalseNoneهوية الملف المرافق وأدلته المرصودة؛ احتفظ بزوج الملفات المتطابق.
source_observationJsonObject | NoneFalseNoneبيانات المسار الحالية والأدلة الفعلية المستخدمة للتحقق من الملاحظة.
text_contentstr | NoneFalseNoneنص الترجمة الكامل الذي تخزنه مشاريع الملفات؛ وتكون القيمة None للمسارات الأخرى.
Python
to_api_dict() -> JsonObject

SUBTITLE_EXTENSIONS

ثابت عام أو اسم مستعار لنوع. تأتي القيمة أدناه من المصدر؛ تحتفظ المعرّفات والوحدات بمعناها التقني.

Python
SUBTITLE_EXTENSIONS = frozenset({'srt', 'vtt', 'ass'})

ScanResult

عميل عام أو سجل ثابت. تمثل الحقول أدلة محلية أو فورية معادة، وليست أمراً لبدء العمل. تعرض الدوال أدناه القيم المسجلة.

الحقلالنوعمطلوبالتصريح / الافتراضالمعنى
filestuple[LocalFile, ...]True—لقطة مجلد كاملة أو قائمة ملفات أو أدلة ملاحظة تتطلبها نقطة النهاية؛ أنشئها من الملفات المحلية.
failurestuple[LocalFailure, ...]True—أخطاء مسجلة لكل عنصر؛ لا تجعل هذه القائمة إرسال جرد جزئي آمناً.
Python
to_api_dict() -> JsonObject

SubftLocalError

استثناء عام. التقط النوع المحدد عندما تختلف المعالجة؛ يغطي الاستثناء الأساسي الأنواع المشتقة. تحتفظ حقول المنشئ الاختيارية بحالة HTTP أو البيانات أو أدلة النقل كما يحدد النوع.

SubtitleMuxInput

عميل عام أو سجل ثابت. تمثل الحقول أدلة محلية أو فورية معادة، وليست أمراً لبدء العمل. تعرض الدوال أدناه القيم المسجلة.

الحقلالنوعمطلوبالتصريح / الافتراضالمعنى
pathPathTrue—جذر محلي أو مسار أو مسار POSIX نسبي. تستبعد أدوات الفحص الروابط الرمزية؛ أبق المسارات داخل الجذر المختار.
languagestr | NoneFalseNoneلغة الترجمة أو تصنيفها العادي أو الإجباري أو SDH أو التعليق؛ تبقى رموز اللغة التقنية دون تغيير.
stream_classStreamClassFalse'normal'التصنيف العادي أو أي مجموعة من التعليق والإجباري وSDH.

VIDEO_EXTENSIONS

ثابت عام أو اسم مستعار لنوع. تأتي القيمة أدناه من المصدر؛ تحتفظ المعرّفات والوحدات بمعناها التقني.

Python
VIDEO_EXTENSIONS = frozenset({'mp4', 'mkv', 'avi', 'mov', 'webm'})

VOBSUB_EXTENSIONS

ثابت عام أو اسم مستعار لنوع. تأتي القيمة أدناه من المصدر؛ تحتفظ المعرّفات والوحدات بمعناها التقني.

Python
VOBSUB_EXTENSIONS = frozenset({'idx', 'sub'})

build_directory_snapshot

إنشاء ملفات كاملة وبصمات وعينات لغوية محدودة لمطابقة المجلد.

Python
build_directory_snapshot(
    source: FileCollection,
    *,
    include_hidden: bool = False,
    hash_media_paths: Iterable[str | os.PathLike[str]] = (),
    include_text_samples: bool = False,
    on_progress: ProgressCallback | None = None
) -> DirectorySnapshotResult
المعاملالنوعالتمريرالافتراضالمعنى
sourceFileCollectionpositional-or-keyword—ملف مصدر محلي موجود أو سجل LocalFile أو مجموعة ملفات كما يحدد النوع؛ افحص الأخطاء قبل إرسال الجرد.
include_hiddenboolkeyword-onlyFalseتضمين الملفات والمجلدات التي تبدأ بنقطة عند True؛ تبقى الروابط الرمزية مستبعدة.
hash_media_pathsIterable[str | os.PathLike[str]]keyword-only()مسارات الوسائط النسبية التي تحتاج لقطة المجلد إلى بصماتها.
include_text_samplesboolkeyword-onlyFalseتضمين عينات محدودة من لغة الترجمة أو تحديد أقصى عدد لبايتات المصدر.
on_progressProgressCallback | Nonekeyword-onlyNoneاستدعاء متزامن يستقبل LocalProgress. رفع استثناء يوقف العمل، وتنتقل أخطاء الاستدعاء إلى المستدعي.

build_inventory

فحص الوسائط لتكوين جرد جاهز لـ API؛ يجب معالجة كل خطأ مسجل قبل الإرسال.

Python
build_inventory(
    source: FileCollection,
    *,
    include_hidden: bool = False,
    ffprobe_executable: str = 'ffprobe',
    probe_timeout: float = 30.0,
    on_progress: ProgressCallback | None = None
) -> InventoryResult
المعاملالنوعالتمريرالافتراضالمعنى
sourceFileCollectionpositional-or-keyword—ملف مصدر محلي موجود أو سجل LocalFile أو مجموعة ملفات كما يحدد النوع؛ افحص الأخطاء قبل إرسال الجرد.
include_hiddenboolkeyword-onlyFalseتضمين الملفات والمجلدات التي تبدأ بنقطة عند True؛ تبقى الروابط الرمزية مستبعدة.
ffprobe_executablestrkeyword-only'ffprobe'اسم البرنامج التنفيذي للنظام أو مساره؛ تثبيت إضافة Python لا يثبت هذه البرامج.
probe_timeoutfloatkeyword-only30.0المهلة بالثواني؛ راجع التوقيع لمعرفة القيمة الافتراضية للطلب أو الفحص أو الاشتراك.
on_progressProgressCallback | Nonekeyword-onlyNoneاستدعاء متزامن يستقبل LocalProgress. رفع استثناء يوقف العمل، وتنتقل أخطاء الاستدعاء إلى المستدعي.

check_ffmpeg_tools

إعادة توفر الأدوات دون اشتراط وجودها كلها.

Python
check_ffmpeg_tools(
    *,
    ffmpeg_executable: str = 'ffmpeg',
    ffprobe_executable: str = 'ffprobe',
    timeout: float = 5.0
) -> FfmpegTools
المعاملالنوعالتمريرالافتراضالمعنى
ffmpeg_executablestrkeyword-only'ffmpeg'اسم البرنامج التنفيذي للنظام أو مساره؛ تثبيت إضافة Python لا يثبت هذه البرامج.
ffprobe_executablestrkeyword-only'ffprobe'اسم البرنامج التنفيذي للنظام أو مساره؛ تثبيت إضافة Python لا يثبت هذه البرامج.
timeoutfloatkeyword-only5.0المهلة بالثواني؛ راجع التوقيع لمعرفة القيمة الافتراضية للطلب أو الفحص أو الاشتراك.

count_pgs_images

عد صور الترجمة الرسومية من المصدر الفعلي؛ يتطلب VobSub كلا الملفين.

Python
count_pgs_images(content: bytes) -> int
المعاملالنوعالتمريرالافتراضالمعنى
contentbytespositional-or-keyword—بايتات خام أو مجموعة من كتل البايتات. استخدم الملف المحضّر للرفع.

count_vobsub_images

عد صور الترجمة الرسومية من المصدر الفعلي؛ يتطلب VobSub كلا الملفين.

Python
count_vobsub_images(text: str) -> int
المعاملالنوعالتمريرالافتراضالمعنى
textstrpositional-or-keyword—نص الترجمة الفعلي أو تنسيقه SRT/VTT/ASS؛ تُوحّد المقاييس التنسيق بدلاً من عد بايتات الملف الخام.

embed_subtitle_tracks

كتابة خرج مدمج يملكه المستدعي مع الحفاظ على المسارات الأخرى؛ التثبيت والتسجيل خطوتان منفصلتان.

Python
embed_subtitle_tracks(
    source: LocalSource,
    subtitles: Iterable[SubtitleMuxInput],
    output_path: str | os.PathLike[str],
    *,
    ffmpeg_executable: str = 'ffmpeg',
    ffprobe_executable: str = 'ffprobe',
    timeout: float = 1800.0,
    on_progress: ProgressCallback | None = None,
    replace_stream_indexes: Iterable[int] = ()
) -> MuxedMedia
المعاملالنوعالتمريرالافتراضالمعنى
sourceLocalSourcepositional-or-keyword—ملف مصدر محلي موجود أو سجل LocalFile أو مجموعة ملفات كما يحدد النوع؛ افحص الأخطاء قبل إرسال الجرد.
subtitlesIterable[SubtitleMuxInput]positional-or-keyword—سجلات SubtitleMuxInput تحدد ملفات SRT فعلية واللغات وتصنيفات المسارات المراد إضافتها.
output_pathstr | os.PathLike[str]positional-or-keyword—مسار خرج جديد يملكه المستدعي. لا تستبدل أدوات الاستخراج والدمج الأصل ولا تسجل أصولاً لدى الخادم.
ffmpeg_executablestrkeyword-only'ffmpeg'اسم البرنامج التنفيذي للنظام أو مساره؛ تثبيت إضافة Python لا يثبت هذه البرامج.
ffprobe_executablestrkeyword-only'ffprobe'اسم البرنامج التنفيذي للنظام أو مساره؛ تثبيت إضافة Python لا يثبت هذه البرامج.
timeoutfloatkeyword-only1800.0المهلة بالثواني؛ راجع التوقيع لمعرفة القيمة الافتراضية للطلب أو الفحص أو الاشتراك.
on_progressProgressCallback | Nonekeyword-onlyNoneاستدعاء متزامن يستقبل LocalProgress. رفع استثناء يوقف العمل، وتنتقل أخطاء الاستدعاء إلى المستدعي.
replace_stream_indexesIterable[int]keyword-only()رقم مسار FFprobe أو أرقام المسارات المحددة للاستبدال، وليس ترتيبها في قائمة مفلترة.

extract_audio_stream

استخراج مسار صوت مختار بصيغة MP3 دون تغيير الأصل.

Python
extract_audio_stream(
    source: LocalSource,
    stream_index: int,
    output_path: str | os.PathLike[str],
    *,
    ffmpeg_executable: str = 'ffmpeg',
    timeout: float = 1800.0,
    on_progress: ProgressCallback | None = None
) -> ExtractedFile
المعاملالنوعالتمريرالافتراضالمعنى
sourceLocalSourcepositional-or-keyword—ملف مصدر محلي موجود أو سجل LocalFile أو مجموعة ملفات كما يحدد النوع؛ افحص الأخطاء قبل إرسال الجرد.
stream_indexintpositional-or-keyword—رقم مسار FFprobe أو أرقام المسارات المحددة للاستبدال، وليس ترتيبها في قائمة مفلترة.
output_pathstr | os.PathLike[str]positional-or-keyword—مسار خرج جديد يملكه المستدعي. لا تستبدل أدوات الاستخراج والدمج الأصل ولا تسجل أصولاً لدى الخادم.
ffmpeg_executablestrkeyword-only'ffmpeg'اسم البرنامج التنفيذي للنظام أو مساره؛ تثبيت إضافة Python لا يثبت هذه البرامج.
timeoutfloatkeyword-only1800.0المهلة بالثواني؛ راجع التوقيع لمعرفة القيمة الافتراضية للطلب أو الفحص أو الاشتراك.
on_progressProgressCallback | Nonekeyword-onlyNoneاستدعاء متزامن يستقبل LocalProgress. رفع استثناء يوقف العمل، وتنتقل أخطاء الاستدعاء إلى المستدعي.

extract_subtitle_stream

استخراج النص بصيغة SRT أو نسخ الترجمة الرسومية إلى Matroska؛ يتولى المستدعي التنظيف.

Python
extract_subtitle_stream(
    source: LocalSource,
    stream_index: int,
    output_path: str | os.PathLike[str],
    *,
    graphical: bool = False,
    source_format: str = 'srt',
    ffmpeg_executable: str = 'ffmpeg',
    timeout: float = 1800.0,
    on_progress: ProgressCallback | None = None
) -> ExtractedFile
المعاملالنوعالتمريرالافتراضالمعنى
sourceLocalSourcepositional-or-keyword—ملف مصدر محلي موجود أو سجل LocalFile أو مجموعة ملفات كما يحدد النوع؛ افحص الأخطاء قبل إرسال الجرد.
stream_indexintpositional-or-keyword—رقم مسار FFprobe أو أرقام المسارات المحددة للاستبدال، وليس ترتيبها في قائمة مفلترة.
output_pathstr | os.PathLike[str]positional-or-keyword—مسار خرج جديد يملكه المستدعي. لا تستبدل أدوات الاستخراج والدمج الأصل ولا تسجل أصولاً لدى الخادم.
graphicalboolkeyword-onlyFalseيحدد ما إذا كان الاستخراج ينسخ مسار ترجمة رسومية إلى Matroska بدلاً من إنشاء SRT.
source_formatstrkeyword-only'srt'نص الترجمة الفعلي أو تنسيقه SRT/VTT/ASS؛ تُوحّد المقاييس التنسيق بدلاً من عد بايتات الملف الخام.
ffmpeg_executablestrkeyword-only'ffmpeg'اسم البرنامج التنفيذي للنظام أو مساره؛ تثبيت إضافة Python لا يثبت هذه البرامج.
timeoutfloatkeyword-only1800.0المهلة بالثواني؛ راجع التوقيع لمعرفة القيمة الافتراضية للطلب أو الفحص أو الاشتراك.
on_progressProgressCallback | Nonekeyword-onlyNoneاستدعاء متزامن يستقبل LocalProgress. رفع استثناء يوقف العمل، وتنتقل أخطاء الاستدعاء إلى المستدعي.

fingerprint_media_file

حساب بصمة وسائط كاملة أو جزئية متوافقة ورفض تغير المصدر.

Python
fingerprint_media_file(
    source: LocalSource,
    *,
    chunk_size: int = DEFAULT_HASH_CHUNK_SIZE,
    on_progress: ProgressCallback | None = None
) -> FileFingerprint
المعاملالنوعالتمريرالافتراضالمعنى
sourceLocalSourcepositional-or-keyword—ملف مصدر محلي موجود أو سجل LocalFile أو مجموعة ملفات كما يحدد النوع؛ افحص الأخطاء قبل إرسال الجرد.
chunk_sizeintkeyword-onlyDEFAULT_HASH_CHUNK_SIZEعدد موجب للبايتات المقروءة في كل كتلة تجزئة؛ احتفظ بالافتراض لتوافق البصمات الجزئية.
on_progressProgressCallback | Nonekeyword-onlyNoneاستدعاء متزامن يستقبل LocalProgress. رفع استثناء يوقف العمل، وتنتقل أخطاء الاستدعاء إلى المستدعي.

hash_file_sha256

قراءة كل البايتات لتكوين FileFingerprint بتجزئة SHA-256؛ استخدم حقل hash لطلبات API.

Python
hash_file_sha256(
    source: LocalSource,
    *,
    chunk_size: int = DEFAULT_HASH_CHUNK_SIZE,
    on_progress: ProgressCallback | None = None
) -> FileFingerprint
المعاملالنوعالتمريرالافتراضالمعنى
sourceLocalSourcepositional-or-keyword—ملف مصدر محلي موجود أو سجل LocalFile أو مجموعة ملفات كما يحدد النوع؛ افحص الأخطاء قبل إرسال الجرد.
chunk_sizeintkeyword-onlyDEFAULT_HASH_CHUNK_SIZEعدد موجب للبايتات المقروءة في كل كتلة تجزئة؛ احتفظ بالافتراض لتوافق البصمات الجزئية.
on_progressProgressCallback | Nonekeyword-onlyNoneاستدعاء متزامن يستقبل LocalProgress. رفع استثناء يوقف العمل، وتنتقل أخطاء الاستدعاء إلى المستدعي.

hash_text_subtitle

تجزئة نص الترجمة بعد توحيد الأسطر والمسافات المحيطة.

Python
hash_text_subtitle(source: LocalSource) -> FileFingerprint
المعاملالنوعالتمريرالافتراضالمعنى
sourceLocalSourcepositional-or-keyword—ملف مصدر محلي موجود أو سجل LocalFile أو مجموعة ملفات كما يحدد النوع؛ افحص الأخطاء قبل إرسال الجرد.

inspect_media

فحص ملف مدعوم واحد وإعادة أدلة الفحص والملاحظات الفعلية للمصدر.

Python
inspect_media(
    source: LocalFile | str | os.PathLike[str],
    *,
    relative_path: str | None = None,
    ffprobe_executable: str = 'ffprobe',
    probe_timeout: float = 30.0,
    on_progress: ProgressCallback | None = None,
    file_project: bool = False
) -> MediaInventoryItem
المعاملالنوعالتمريرالافتراضالمعنى
sourceLocalFile | str | os.PathLike[str]positional-or-keyword—ملف مصدر محلي موجود أو سجل LocalFile أو مجموعة ملفات كما يحدد النوع؛ افحص الأخطاء قبل إرسال الجرد.
relative_pathstr | Nonekeyword-onlyNoneجذر محلي أو مسار أو مسار POSIX نسبي. تستبعد أدوات الفحص الروابط الرمزية؛ أبق المسارات داخل الجذر المختار.
ffprobe_executablestrkeyword-only'ffprobe'اسم البرنامج التنفيذي للنظام أو مساره؛ تثبيت إضافة Python لا يثبت هذه البرامج.
probe_timeoutfloatkeyword-only30.0المهلة بالثواني؛ راجع التوقيع لمعرفة القيمة الافتراضية للطلب أو الفحص أو الاشتراك.
on_progressProgressCallback | Nonekeyword-onlyNoneاستدعاء متزامن يستقبل LocalProgress. رفع استثناء يوقف العمل، وتنتقل أخطاء الاستدعاء إلى المستدعي.
file_projectboolkeyword-onlyFalseتطبيق قواعد مشاريع الملفات: تضمين نص الترجمة الكامل ورفض ملفات الترجمة الرسومية.

pgs_duration_seconds

حساب مدة الترجمة بالثواني من التوقيت الفعلي للمقاطع أو الصور.

Python
pgs_duration_seconds(content: bytes) -> float
المعاملالنوعالتمريرالافتراضالمعنى
contentbytespositional-or-keyword—بايتات خام أو مجموعة من كتل البايتات. استخدم الملف المحضّر للرفع.

probe_media

قراءة مدة FFprobe والمسارات وأدلة الحاوية دون تعديل الملف.

Python
probe_media(
    source: LocalSource,
    *,
    ffprobe_executable: str = 'ffprobe',
    timeout: float = 30.0
) -> MediaProbe
المعاملالنوعالتمريرالافتراضالمعنى
sourceLocalSourcepositional-or-keyword—ملف مصدر محلي موجود أو سجل LocalFile أو مجموعة ملفات كما يحدد النوع؛ افحص الأخطاء قبل إرسال الجرد.
ffprobe_executablestrkeyword-only'ffprobe'اسم البرنامج التنفيذي للنظام أو مساره؛ تثبيت إضافة Python لا يثبت هذه البرامج.
timeoutfloatkeyword-only30.0المهلة بالثواني؛ راجع التوقيع لمعرفة القيمة الافتراضية للطلب أو الفحص أو الاشتراك.

read_subtitle_language_sample

قراءة عينة محدودة من نص المصدر لتصنيف اللغة.

Python
read_subtitle_language_sample(
    source: LocalSource, *, max_bytes: int = LANGUAGE_SAMPLE_BYTES
) -> str | None
المعاملالنوعالتمريرالافتراضالمعنى
sourceLocalSourcepositional-or-keyword—ملف مصدر محلي موجود أو سجل LocalFile أو مجموعة ملفات كما يحدد النوع؛ افحص الأخطاء قبل إرسال الجرد.
max_bytesintkeyword-onlyLANGUAGE_SAMPLE_BYTESتضمين عينات محدودة من لغة الترجمة أو تحديد أقصى عدد لبايتات المصدر.

require_ffmpeg_tools

اشتراط الأدوات المحددة ورفع FfmpegUnavailableError إذا كانت المتطلبات مفقودة.

Python
require_ffmpeg_tools(
    *,
    ffmpeg_executable: str = 'ffmpeg',
    ffprobe_executable: str = 'ffprobe',
    timeout: float = 5.0,
    require_ffmpeg: bool = True,
    require_ffprobe: bool = True
) -> FfmpegTools
المعاملالنوعالتمريرالافتراضالمعنى
ffmpeg_executablestrkeyword-only'ffmpeg'اسم البرنامج التنفيذي للنظام أو مساره؛ تثبيت إضافة Python لا يثبت هذه البرامج.
ffprobe_executablestrkeyword-only'ffprobe'اسم البرنامج التنفيذي للنظام أو مساره؛ تثبيت إضافة Python لا يثبت هذه البرامج.
timeoutfloatkeyword-only5.0المهلة بالثواني؛ راجع التوقيع لمعرفة القيمة الافتراضية للطلب أو الفحص أو الاشتراك.
require_ffmpegboolkeyword-onlyTrueيحدد ما إذا كان هذا الفحص يتطلب توفر البرنامج التنفيذي المقابل.
require_ffprobeboolkeyword-onlyTrueيحدد ما إذا كان هذا الفحص يتطلب توفر البرنامج التنفيذي المقابل.

scan_directory

فحص حتمي مع تجاوز الروابط الرمزية وتسجيل الأخطاء لكل مسار.

Python
scan_directory(
    root: str | os.PathLike[str],
    *,
    include_hidden: bool = False,
    on_progress: ProgressCallback | None = None
) -> ScanResult
المعاملالنوعالتمريرالافتراضالمعنى
rootstr | os.PathLike[str]positional-or-keyword—جذر محلي أو مسار أو مسار POSIX نسبي. تستبعد أدوات الفحص الروابط الرمزية؛ أبق المسارات داخل الجذر المختار.
include_hiddenboolkeyword-onlyFalseتضمين الملفات والمجلدات التي تبدأ بنقطة عند True؛ تبقى الروابط الرمزية مستبعدة.
on_progressProgressCallback | Nonekeyword-onlyNoneاستدعاء متزامن يستقبل LocalProgress. رفع استثناء يوقف العمل، وتنتقل أخطاء الاستدعاء إلى المستدعي.

subtitle_duration_seconds

حساب مدة الترجمة بالثواني من التوقيت الفعلي للمقاطع أو الصور.

Python
subtitle_duration_seconds(
    text: str, format_hint: str | None = None
) -> float
المعاملالنوعالتمريرالافتراضالمعنى
textstrpositional-or-keyword—نص الترجمة الفعلي أو تنسيقه SRT/VTT/ASS؛ تُوحّد المقاييس التنسيق بدلاً من عد بايتات الملف الخام.
format_hintstr | Nonepositional-or-keywordNoneنص الترجمة الفعلي أو تنسيقه SRT/VTT/ASS؛ تُوحّد المقاييس التنسيق بدلاً من عد بايتات الملف الخام.

vobsub_duration_seconds

حساب مدة الترجمة بالثواني من التوقيت الفعلي للمقاطع أو الصور.

Python
vobsub_duration_seconds(text: str) -> float
المعاملالنوعالتمريرالافتراضالمعنى
textstrpositional-or-keyword—نص الترجمة الفعلي أو تنسيقه SRT/VTT/ASS؛ تُوحّد المقاييس التنسيق بدلاً من عد بايتات الملف الخام.

vobsub_pair_hash

دمج بصمتي IDX وSUB المتطابقتين بالترتيب الحتمي الموثق.

Python
vobsub_pair_hash(idx_hash: str, sub_hash: str) -> str
المعاملالنوعالتمريرالافتراضالمعنى
idx_hashstrpositional-or-keyword—تجزئتا ملفي IDX وSUB المتطابقين فعلياً، لتكوين تجزئة ثابتة للمصدر المزدوج.
sub_hashstrpositional-or-keyword—تجزئتا ملفي IDX وSUB المتطابقين فعلياً، لتكوين تجزئة ثابتة للمصدر المزدوج.

visible_subtitle_character_count

عد محارف الترجمة المرئية وفق قواعد توحيد الفوترة.

Python
visible_subtitle_character_count(
    text: str, format_hint: str | None = None
) -> int
المعاملالنوعالتمريرالافتراضالمعنى
textstrpositional-or-keyword—نص الترجمة الفعلي أو تنسيقه SRT/VTT/ASS؛ تُوحّد المقاييس التنسيق بدلاً من عد بايتات الملف الخام.
format_hintstr | Nonepositional-or-keywordNoneنص الترجمة الفعلي أو تنسيقه SRT/VTT/ASS؛ تُوحّد المقاييس التنسيق بدلاً من عد بايتات الملف الخام.

الأدوات والسجلات الفورية

استورد من subft_client.realtime. تحتاج الدوال المحلية إلى الإضافة المحلية وأدوات النظام المختارة. افحص الأخطاء المعادة قبل تحديث الجرد لدى الخادم. يحتاج الاتصال الفوري إلى إضافته ولا يطابق حالة HTTP المعتمدة.

OperationEvent

عميل عام أو سجل ثابت. تمثل الحقول أدلة محلية أو فورية معادة، وليست أمراً لبدء العمل. تعرض الدوال أدناه القيم المسجلة.

الحقلالنوعمطلوبالتصريح / الافتراضالمعنى
eventstrTrue—بيانات حدث أو اتصال فوري؛ اقرأ حالة HTTP المعتمدة قبل تحديد النتيجة.
operation_idstrTrue—معرّف العملية التي تم اعتمادها؛ احتفظ به قبل المغادرة أو إعادة محاولة التحضير.
content_idstr | NoneTrue—معرّف عنصر مصدر داخل العملية، وليس معرّف وسائط مشروع أو ناتج مرحلة.
session_idstr | NoneTrue—بيانات حدث أو اتصال فوري؛ اقرأ حالة HTTP المعتمدة قبل تحديد النتيجة.
statusstr | NoneTrue—مرشح الحالة أو الحالة الجديدة وفقاً للدالة؛ تحتفظ المشاريع المؤرشفة بالنتائج المحفوظة.
payloadMapping[str, Any]True—خريطة طلب خاصة بنقطة النهاية. استخدم مخططها واحتفظ بقيم التحقق المطلوبة للملاحظة أو التحضير.

RealtimeConnectionState

عميل عام أو سجل ثابت. تمثل الحقول أدلة محلية أو فورية معادة، وليست أمراً لبدء العمل. تعرض الدوال أدناه القيم المسجلة.

الحقلالنوعمطلوبالتصريح / الافتراضالمعنى
statusConnectionStatusTrue—مرشح الحالة أو الحالة الجديدة وفقاً للدالة؛ تحتفظ المشاريع المؤرشفة بالنتائج المحفوظة.
attemptintTrue—بيانات حدث أو اتصال فوري؛ اقرأ حالة HTTP المعتمدة قبل تحديد النتيجة.
reconnectedboolTrue—يحدد ما إذا كان الحدث يلي إعادة اتصال ناجحة؛ اقرأ الحالة المعتمدة مجدداً.
reasonstr | NoneFalseNoneالسبب التقني لحالة الاتصال هذه؛ استخدم حالة HTTP المعتمدة لتحديد الاسترداد.

RealtimeDependencyError

استثناء عام. التقط النوع المحدد عندما تختلف المعالجة؛ يغطي الاستثناء الأساسي الأنواع المشتقة. تحتفظ حقول المنشئ الاختيارية بحالة HTTP أو البيانات أو أدلة النقل كما يحدد النوع.

RealtimeProtocolError

استثناء عام. التقط النوع المحدد عندما تختلف المعالجة؛ يغطي الاستثناء الأساسي الأنواع المشتقة. تحتفظ حقول المنشئ الاختيارية بحالة HTTP أو البيانات أو أدلة النقل كما يحدد النوع.

RealtimeSubscriptionError

Python
RealtimeSubscriptionError(code: str='request_failed', params: Mapping[str, Any] | None=None)

تستخدم حالات رفض الاشتراك الآني event: "failed" مع واصف {code, params} في payload.error. يتيح RealtimeSubscriptionError الحقلين code وparams؛ نص التشخيص ليس عقداً للعرض.

استثناء عام. التقط النوع المحدد عندما تختلف المعالجة؛ يغطي الاستثناء الأساسي الأنواع المشتقة. تحتفظ حقول المنشئ الاختيارية بحالة HTTP أو البيانات أو أدلة النقل كما يحدد النوع.

SubftRealtimeError

استثناء عام. التقط النوع المحدد عندما تختلف المعالجة؛ يغطي الاستثناء الأساسي الأنواع المشتقة. تحتفظ حقول المنشئ الاختيارية بحالة HTTP أو البيانات أو أدلة النقل كما يحدد النوع.

watch_operation_events

إعادة أحداث العملية وتغيرات الاتصال مع إعادة الاتصال؛ تبقى مطابقة حالة HTTP المعتمدة مسؤولية المستدعي.

Python
watch_operation_events(
    base_url: str,
    operation_id: str,
    *,
    token: str,
    heartbeat_interval: float = DEFAULT_HEARTBEAT_INTERVAL,
    pong_timeout: float = DEFAULT_PONG_TIMEOUT,
    subscribe_timeout: float = DEFAULT_SUBSCRIBE_TIMEOUT,
    reconnect_initial_delay: float = DEFAULT_RECONNECT_INITIAL_DELAY,
    reconnect_max_delay: float = DEFAULT_RECONNECT_MAX_DELAY,
    _sleep: Callable[[float], Awaitable[None]] = asyncio.sleep
) -> AsyncGenerator[RealtimeMessage, None]
المعاملالنوعالتمريرالافتراضالمعنى
base_urlstrpositional-or-keyword—عنوان البوابة التي تقدم مسارات API والمصادقة والاتصال الفوري؛ تُوحّد الشرطة المائلة الأخيرة.
operation_idstrpositional-or-keyword—معرّف العملية التي تم اعتمادها؛ احتفظ به قبل المغادرة أو إعادة محاولة التحضير.
tokenstrkeyword-only—رمز API من صفحة وصول المطورين. احفظه في متغير بيئة محمي.
heartbeat_intervalfloatkeyword-onlyDEFAULT_HEARTBEAT_INTERVALفترة نبض الاتصال أو انتظار pong أو إعادة الاتصال بالثواني؛ تستخدم إعادة الاتصال تأخيراً متزايداً محدوداً.
pong_timeoutfloatkeyword-onlyDEFAULT_PONG_TIMEOUTفترة نبض الاتصال أو انتظار pong أو إعادة الاتصال بالثواني؛ تستخدم إعادة الاتصال تأخيراً متزايداً محدوداً.
subscribe_timeoutfloatkeyword-onlyDEFAULT_SUBSCRIBE_TIMEOUTالمهلة بالثواني؛ راجع التوقيع لمعرفة القيمة الافتراضية للطلب أو الفحص أو الاشتراك.
reconnect_initial_delayfloatkeyword-onlyDEFAULT_RECONNECT_INITIAL_DELAYفترة نبض الاتصال أو انتظار pong أو إعادة الاتصال بالثواني؛ تستخدم إعادة الاتصال تأخيراً متزايداً محدوداً.
reconnect_max_delayfloatkeyword-onlyDEFAULT_RECONNECT_MAX_DELAYفترة نبض الاتصال أو انتظار pong أو إعادة الاتصال بالثواني؛ تستخدم إعادة الاتصال تأخيراً متزايداً محدوداً.
_sleepCallable[[float], Awaitable[None]]keyword-onlyasyncio.sleepدالة انتظار غير متزامنة اختيارية للاختبارات الحتمية؛ تحتفظ التكاملات العادية بالافتراض.

مخططات الطلب والاستجابة

تعيد الجداول الحقول المعلنة بما فيها الموروثة. يستخدم عمود مطلوب True/False. تعني الشرطة عدم وجود تصريح افتراضي؛ تعرض Field(...) افتراضات Pydantic وقيوده الفعلية. قد تكون الحقول التي تقبل الفراغ مطلوبة أيضاً. تصف الأنواع المسماة سجلات متداخلة؛ تبقى dict[str, Any] مفتوحة عمداً وليست مخططاً شاملاً مخترعاً. تعيد أهداف الرفع أيضاً upload_id وoperation_id وmedia_id وcontent_id وupload_url وmethod وheaders وexpires_at وsidecar الاختياري؛ احتفظ بهويتها وانتهائها وطريقتها. يتحقق المثال الكامل من الحقول التي يستخدمها.

AssetSelection

عقد مشتق من المصدر. احتفظ بالحقول المطلوبة وقيم التحقق عند تكييف المثال؛ تختلف القيم التي تقبل الفراغ عن الحقول المطلوبة المفقودة.

الحقلالنوعمطلوبالتصريح / الافتراضالمعنى
media_idstrTrueField(max_length=64)معرّف الوسائط في هذا المسار: معرّف وسائط المشروع لمسارات المشاريع، ومعرّف وسائط العملية للرفع والتحضير.
asset_idstrTrueField(max_length=64)معرّف أصل الترجمة النصية أو الصوت التابع لوسائطه.
source_languagestrTrueField(max_length=32)لغة المصدر الموحّدة الملتقطة مع الاختيار المحمي.
expected_snapshot_idstr | NoneFalseField(default=None, max_length=64)اللقطة الثابتة الحالية أو جيل الفحص الفعلي المستخدم لتثبيت المصدر.
expected_autosave_versionint | NoneFalseNoneقيم التحقق الحالية للملاحظة أو الجيل أو الحفظ من استجابة القراءة أو بدء الفحص؛ تتطلب القيم القديمة قراءة جديدة.
expected_observationSourceObservation | NoneFalseNoneأدلة الملفات والمسارات الفعلية التي يجب أن تظل مطابقة عند الاعتماد.
check_generationint | NoneFalseNoneاللقطة الثابتة الحالية أو جيل الفحص الفعلي المستخدم لتثبيت المصدر.

CapturedExport

عقد مشتق من المصدر. احتفظ بالحقول المطلوبة وقيم التحقق عند تكييف المثال؛ تختلف القيم التي تقبل الفراغ عن الحقول المطلوبة المفقودة.

الحقلالنوعمطلوبالتصريح / الافتراضالمعنى
asset_idstrTrueField(max_length=64)معرّف أصل الترجمة النصية أو الصوت التابع لوسائطه.
snapshot_idstrTrueField(max_length=64)سلسلة الأصل المنتج وأصل النتيجة واللقطة الثابتة؛ احتفظ بهذه الهويات عند التصدير.
autosave_versionint | NoneTrue—إصدار الحفظ الحالي للتحرير، ويستخدم لاكتشاف التعديلات المتزامنة.
effective_metadataEffectiveMetadataTrue—لغة الحاوية الملتقطة أو اللغة والتصنيف الفعليان للخرج.
container_languagestrTrueField(max_length=32)لغة الحاوية الملتقطة أو اللغة والتصنيف الفعليان للخرج.
formatLiteral['srt', 'vtt', 'ass']True—أدلة الحاوية والمسارات الفعلية من FFprobe؛ تحتفظ الخرائط المفتوحة بحقول الفحص.
optionsExportOptionsFalseField(default_factory=ExportOptions)هوية وجهة التصدير أو خيارات التصدير الخاصة بنقطة النهاية.
mime_typestrTrueField(max_length=255)نوع MIME المكتشف؛ لا يثبت وحده دعم الترميز.
suggested_pathstrTrueField(max_length=2048)بيانات تصدير ثابتة أو اسم ملف نسبي مقترح من الخادم أو نص الترجمة المتسلسل الفعلي.
serializer_versionintTrue—إصدار المحلل أو أداة تسلسل التصدير المستخدمة للمستند الملتقط.
parser_versionintTrue—إصدار المحلل أو أداة تسلسل التصدير المستخدمة للمستند الملتقط.
text_contentstrTrueField(max_length=20000000)بيانات تصدير ثابتة أو اسم ملف نسبي مقترح من الخادم أو نص الترجمة المتسلسل الفعلي.

CommittedSource

عقد مشتق من المصدر. احتفظ بالحقول المطلوبة وقيم التحقق عند تكييف المثال؛ تختلف القيم التي تقبل الفراغ عن الحقول المطلوبة المفقودة.

قيمة ضمن source_ref_map بمفتاح معرّف وسائط المشروع:معرّف الأصل. استخدم media_id وcontent_id أثناء التشغيل للتحضير والرفع؛ تحدد الخطط المصادر باستخدام source_ref.

الحقلالنوعمطلوبالتصريح / الافتراضالمعنى
media_idstrTrue—معرّف الوسائط في هذا المسار: معرّف وسائط المشروع لمسارات المشاريع، ومعرّف وسائط العملية للرفع والتحضير.
content_idstrTrue—معرّف عنصر مصدر داخل العملية، وليس معرّف وسائط مشروع أو ناتج مرحلة.
project_media_idstrTrue—العلاقة بين وسائط العملية والمشروع مع مسار الوسائط النسبي المسجل.

ContentFlow

عقد مشتق من المصدر. احتفظ بالحقول المطلوبة وقيم التحقق عند تكييف المثال؛ تختلف القيم التي تقبل الفراغ عن الحقول المطلوبة المفقودة.

الحقلالنوعمطلوبالتصريح / الافتراضالمعنى
statusstrTrue—مرشح الحالة أو الحالة الجديدة وفقاً للدالة؛ تحتفظ المشاريع المؤرشفة بالنتائج المحفوظة.
stepstrTrue—خطوة تنفيذ تقرؤها الآلة؛ استخدم نوع التدفق أو التقدم الحاوي وقيمه المعدودة.
execution_countintTrue—عدد محاولات التنفيذ المسجلة لتدفق المصدر هذا.
failure_codestr | NoneTrue—رمز فشل تقرؤه الآلة، وقد يكون فارغاً؛ حوّله إلى نص مستخدم مترجم.
failure_classstr | NoneTrue—تصنيف فشل تقرؤه الآلة وقد يكون فارغاً، وهو منفصل عن failure_code.
runnable_atstr | NoneTrue—وقت تأهل هذا التدفق للتنفيذ وقد يكون فارغاً.

ContentPreparation

عقد مشتق من المصدر. احتفظ بالحقول المطلوبة وقيم التحقق عند تكييف المثال؛ تختلف القيم التي تقبل الفراغ عن الحقول المطلوبة المفقودة.

حالات التحضير المعتمد هي awaiting_client وpreparing وhashing وuploading وawaiting_retry وready وabandoned وnot_required. قد تكون attempt_id ومواعيد انتهاء الحجز والرفع فارغة. تحتوي allowed_actions الإجراءات المؤهلة حالياً فقط: start_preparation أوretry_preparation أوabandon_source. تتطلب الإعادة attempt_id السابقة وUUID جديداً؛ لا تعد تزويد العمل الجاهز أو النهائي دون تحقق.

الحقلالنوعمطلوبالتصريح / الافتراضالمعنى
statestrTrue—حالة هذا السجل؛ يميّز شرح المخطط الحاوي حالات التحضير من حالات العملية.
attempt_idstr | NoneTrue—قيمة UUID جديدة يختارها المستدعي وتؤكدها استجابة التحضير؛ استخدمها في كل طلب يخص هذه المحاولة.
attempt_numberintTrue—مراجعة محاولة التحضير أو رمز الفشل أو وقت الانتهاء؛ تتطلب المحاولات أو الأهداف المنتهية استرداداً معتمداً.
client_progress_revisionintTrue—رقم مراجعة متزايد للتقدم المقبول من العميل داخل المحاولة الحالية.
failure_codestr | NoneTrue—رمز فشل تقرؤه الآلة، وقد يكون فارغاً؛ حوّله إلى نص مستخدم مترجم.
updated_atstr | NoneTrue—وقت مسجل لدى الخادم؛ تشير القيمة الفارغة إلى أن الحدث لم يقع أو أن الوقت غير متاح.
lease_expires_atstr | NoneTrue—وقت انتهاء ISO لحجز التحضير أو هدف الرفع الصادر، وقد يكون فارغاً.
upload_expires_atstr | NoneTrue—وقت انتهاء ISO لحجز التحضير أو هدف الرفع الصادر، وقد يكون فارغاً.
allowed_actionstuple[str, ...]True—الإجراءات المسموح بها حالياً في الحالة المعتمدة، وليست ضماناً للطلبات اللاحقة.

ContentPreparationResponse

عقد مشتق من المصدر. احتفظ بالحقول المطلوبة وقيم التحقق عند تكييف المثال؛ تختلف القيم التي تقبل الفراغ عن الحقول المطلوبة المفقودة.

هذه لقطة التحضير المتداخلة وليست execution_state للعملية. تغلفها نقطة نهاية التحضير مع operation_id وcontent_id وprogress. تكون state هي preparing بعد قبول البدء أو الإعادة؛ تحقق من attempt_id المؤكدة. تأتي media_id من المسار أوsource_ref_map وليس هذا الغلاف.

الحقلالنوعمطلوبالتصريح / الافتراضالمعنى
stateLiteral['awaiting_client', 'preparing', 'hashing', 'uploading', 'awaiting_retry', 'ready', 'abandoned', 'not_required']True—حالة هذا السجل؛ يميّز شرح المخطط الحاوي حالات التحضير من حالات العملية.
attempt_idstr | NoneFalseNoneقيمة UUID جديدة يختارها المستدعي وتؤكدها استجابة التحضير؛ استخدمها في كل طلب يخص هذه المحاولة.
attempt_numberintTrue—مراجعة محاولة التحضير أو رمز الفشل أو وقت الانتهاء؛ تتطلب المحاولات أو الأهداف المنتهية استرداداً معتمداً.
client_progress_revisionintTrue—رقم مراجعة متزايد للتقدم المقبول من العميل داخل المحاولة الحالية.
failure_codestr | NoneFalseNoneرمز فشل تقرؤه الآلة، وقد يكون فارغاً؛ حوّله إلى نص مستخدم مترجم.
updated_atstr | NoneFalseNoneوقت مسجل لدى الخادم؛ تشير القيمة الفارغة إلى أن الحدث لم يقع أو أن الوقت غير متاح.
lease_expires_atstr | NoneFalseNoneوقت انتهاء ISO لحجز التحضير أو هدف الرفع الصادر، وقد يكون فارغاً.
upload_expires_atstr | NoneFalseNoneوقت انتهاء ISO لحجز التحضير أو هدف الرفع الصادر، وقد يكون فارغاً.
allowed_actionslist[Literal['start_preparation', 'retry_preparation', 'abandon_source']]True—الإجراءات المسموح بها حالياً في الحالة المعتمدة، وليست ضماناً للطلبات اللاحقة.

ContentProgress

عقد مشتق من المصدر. احتفظ بالحقول المطلوبة وقيم التحقق عند تكييف المثال؛ تختلف القيم التي تقبل الفراغ عن الحقول المطلوبة المفقودة.

الحقلالنوعمطلوبالتصريح / الافتراضالمعنى
versionintTrue—إصدار مخطط التقدم وهو 4 حالياً؛ ارفض الإصدارات غير المدعومة بدلاً من تخمين بنيتها.
revisionintTrue—رقم مراجعة متزايد للتقدم المعتمد؛ طابق الأحداث القديمة مع حالة HTTP.
statusProgressStatusTrue—مرشح الحالة أو الحالة الجديدة وفقاً للدالة؛ تحتفظ المشاريع المؤرشفة بالنتائج المحفوظة.
phase_plantuple[str, ...]True—مراحل مرتبة في سير العمل المقبول؛ المراحل الغائبة لا تعني عملاً ضمنياً.
current_phasestr | NoneTrue—المرحلة أو الخطوة النشطة وقد تكون فارغة. قد لا تتضمن اللقطة النهائية مرحلة أو خطوة نشطة.
current_step_namestr | NoneTrue—خطوة تنفيذ تقرؤها الآلة؛ استخدم نوع التدفق أو التقدم الحاوي وقيمه المعدودة.
active_work_unitsintTrue—عدد وحدات العمل النشطة حالياً في هذه الخطوة أو المرحلة أو اللقطة.
countsMapping[str, int]True—أعداد مراحل متداخلة: الكلية والمحسومة والمكتملة والمتجاوزة والفاشلة.
phasesMapping[str, ProgressPhase]True—سجلات مراحل أو خطوات متداخلة بمفتاح قيمة التعداد المقابلة؛ افحص حالتها وقياساتها.

CreditEstimate

عقد مشتق من المصدر. احتفظ بالحقول المطلوبة وقيم التحقق عند تكييف المثال؛ تختلف القيم التي تقبل الفراغ عن الحقول المطلوبة المفقودة.

الحقلالنوعمطلوبالتصريح / الافتراضالمعنى
required_creditsintTrue—عرض الرصيد أو قرار قبول من التقدير الحالي؛ راجع نوع الحقل الحاوي.
available_creditsintTrue—عرض الرصيد أو قرار قبول من التقدير الحالي؛ راجع نوع الحقل الحاوي.
shortfallintTrue—عرض الرصيد أو قرار قبول من التقدير الحالي؛ راجع نوع الحقل الحاوي.
missing_metricsintTrue—عدد مقاييس المصدر المطلوبة الغائبة؛ يجب أن يكون صفراً قبل الاعتماد.
can_commitboolTrue—عرض الرصيد أو قرار قبول من التقدير الحالي؛ راجع نوع الحقل الحاوي.
contentstuple[CreditEstimateContent, ...]True—عناصر مصدر متداخلة أو صفوف تقدير لكل مصدر وفق السجل الحاوي.

CreditEstimateContent

عقد مشتق من المصدر. احتفظ بالحقول المطلوبة وقيم التحقق عند تكييف المثال؛ تختلف القيم التي تقبل الفراغ عن الحقول المطلوبة المفقودة.

الحقلالنوعمطلوبالتصريح / الافتراضالمعنى
source_refSourceRefTrue—زوج ثابت من معرّف وسائط المشروع ومعرّف الأصل المختار؛ تختلف عنه معرّفات عناصر المصدر أثناء التنفيذ.
media_pathstrTrue—العلاقة بين وسائط العملية والمشروع مع مسار الوسائط النسبي المسجل.
typeContentTypeTrue—فئة المصدر text أوaudio أوgraphical؛ تحدد المقاييس والمراحل المطلوبة.
stream_classstrTrue—التصنيف العادي أو أي مجموعة من التعليق والإجباري وSDH.
stream_indexint | NoneTrue—رقم مسار FFprobe أو أرقام المسارات المحددة للاستبدال، وليس ترتيبها في قائمة مفلترة.
character_countint | NoneTrue—محارف مرئية أو صور رسومية مقاسة تطلبها الخطة؛ لا تستبدلها بأعداد مخمّنة.
image_countint | NoneTrue—محارف مرئية أو صور رسومية مقاسة تطلبها الخطة؛ لا تستبدلها بأعداد مخمّنة.
duration_secondsfloat | NoneTrue—المدة المقاسة بالثواني، وليست وقت معالجة مضموناً.
creditsint | NoneTrue—الرصيد المقدّر لهذا المصدر.

EffectiveMetadata

عقد مشتق من المصدر. احتفظ بالحقول المطلوبة وقيم التحقق عند تكييف المثال؛ تختلف القيم التي تقبل الفراغ عن الحقول المطلوبة المفقودة.

الحقلالنوعمطلوبالتصريح / الافتراضالمعنى
languagestrFalseField(default='und', max_length=32)لغة الترجمة أو تصنيفها العادي أو الإجباري أو SDH أو التعليق؛ تبقى رموز اللغة التقنية دون تغيير.
classificationtuple[Disposition, ...] | NoneFalseField(default=None, max_length=16)لغة الترجمة أو تصنيفها العادي أو الإجباري أو SDH أو التعليق؛ تبقى رموز اللغة التقنية دون تغيير.

ExportOptions

عقد مشتق من المصدر. احتفظ بالحقول المطلوبة وقيم التحقق عند تكييف المثال؛ تختلف القيم التي تقبل الفراغ عن الحقول المطلوبة المفقودة.

FileObservation

عقد مشتق من المصدر. احتفظ بالحقول المطلوبة وقيم التحقق عند تكييف المثال؛ تختلف القيم التي تقبل الفراغ عن الحقول المطلوبة المفقودة.

الحقلالنوعمطلوبالتصريح / الافتراضالمعنى
roleLiteral['primary', 'index', 'data']False'primary'دور الملف الفعلي أو بصمته المرصودة أو وصف المسار المستخدم للفحوص المحمية.
size_bytesStrictIntTrueField(ge=0)حجم الملف أو النقل الفعلي أو تقدم البايتات المقاس.
last_modified_msStrictIntTrue—وقت تعديل الملف الذي تمت ملاحظته بالمللي ثانية.
sampled_fingerprintstr | NoneFalseField(default=None, max_length=128)دور الملف الفعلي أو بصمته المرصودة أو وصف المسار المستخدم للفحوص المحمية.

OperationBaseResponse

عقد مشتق من المصدر. احتفظ بالحقول المطلوبة وقيم التحقق عند تكييف المثال؛ تختلف القيم التي تقبل الفراغ عن الحقول المطلوبة المفقودة.

execution_state هي pending أوrunning أوfinished. تبقى outcome فارغة حتى finished ثم تكون succeeded أوpartially_succeeded أوfailed أوcanceled. display_status هي الحالة أو النتيجة النهائية. تلخص الأعداد المحتوى المفعّل؛ ترتب state_version وevent_sequence الملاحظات. لكل عملية committed_at وcharged_credits؛ لا تكلفة للخطط المؤقتة. تبقى media مفتوحة في تصريح الاستجابة؛ تصف سجلات المحلل أدناه الحقول المتداخلة المستخدمة.

الحقلالنوعمطلوبالتصريح / الافتراضالمعنى
operation_idstrTrue—معرّف العملية التي تم اعتمادها؛ احتفظ به قبل المغادرة أو إعادة محاولة التحضير.
project_idstr | NoneFalseNoneمعرّف المشروع المحفوظ، كما تعيده عملية إنشاء المشروع أو قائمة المشاريع.
kindstrTrue—محدد خاص بنقطة النهاية لنوع الأصل أو نطاق الفحص أو الجاهزية أو الموضع؛ اتبع عقد نقطة النهاية.
target_languagestr | NoneFalseNoneرمز اللغة الهدف للترجمة النصية المولدة أو المترجمة.
execution_stateLiteral['pending', 'running', 'finished']True—حقل دورة حياة معتمد: التنفيذ أو النتيجة النهائية أو العرض أو رقم مراجعة وتسلسل متزايد.
outcomeLiteral['succeeded', 'partially_succeeded', 'failed', 'canceled'] | NoneTrue—حقل دورة حياة معتمد: التنفيذ أو النتيجة النهائية أو العرض أو رقم مراجعة وتسلسل متزايد.
display_statusLiteral['pending', 'running', 'succeeded', 'partially_succeeded', 'failed', 'canceled']True—حقل دورة حياة معتمد: التنفيذ أو النتيجة النهائية أو العرض أو رقم مراجعة وتسلسل متزايد.
state_versionintTrue—حقل دورة حياة معتمد: التنفيذ أو النتيجة النهائية أو العرض أو رقم مراجعة وتسلسل متزايد.
event_sequenceintTrue—حقل دورة حياة معتمد: التنفيذ أو النتيجة النهائية أو العرض أو رقم مراجعة وتسلسل متزايد.
phase_countsWorkflowPhaseCountsTrue—إسقاطات سير عمل وأعداد متداخلة؛ راجع المخطط المسمى بدلاً من اعتبارها نص حالة.
content_countsOperationLifecycleContentCountsResponseTrue—إسقاطات سير عمل وأعداد متداخلة؛ راجع المخطط المسمى بدلاً من اعتبارها نص حالة.
preparation_countsOperationPreparationCountsResponseTrue—إسقاطات سير عمل وأعداد متداخلة؛ راجع المخطط المسمى بدلاً من اعتبارها نص حالة.
allowed_actionslist[Literal['abort']]True—الإجراءات المسموح بها حالياً في الحالة المعتمدة، وليست ضماناً للطلبات اللاحقة.
started_atstr | NoneFalseNoneوقت مسجل لدى الخادم؛ تشير القيمة الفارغة إلى أن الحدث لم يقع أو أن الوقت غير متاح.
finished_atstr | NoneFalseNoneوقت مسجل لدى الخادم؛ تشير القيمة الفارغة إلى أن الحدث لم يقع أو أن الوقت غير متاح.
updated_atstr | NoneFalseNoneوقت مسجل لدى الخادم؛ تشير القيمة الفارغة إلى أن الحدث لم يقع أو أن الوقت غير متاح.
created_atstr | NoneFalseNoneوقت مسجل لدى الخادم؛ تشير القيمة الفارغة إلى أن الحدث لم يقع أو أن الوقت غير متاح.
committed_atstrTrue—وقت إلزامي يسجله الخادم عند اعتماد العملية.
charged_creditsintTrue—الرصيد المخصوم عند بدء العمل.
charged_atstr | NoneFalseNoneوقت مسجل لدى الخادم؛ تشير القيمة الفارغة إلى أن الحدث لم يقع أو أن الوقت غير متاح.
refunded_creditsintTrue—الرصيد المعاد لاحقًا مقابل المراحل أو المصادر المستحقة للاسترداد.
used_creditsintTrue—الرصيد المخصوم مطروحًا منه الرصيد المعاد، على ألا تقل النتيجة عن صفر.
workflowOperationWorkflowSummaryResponseFalseField(default_factory=OperationWorkflowSummaryResponse)إسقاطات سير عمل وأعداد متداخلة؛ راجع المخطط المسمى بدلاً من اعتبارها نص حالة.

OperationContent

عقد مشتق من المصدر. احتفظ بالحقول المطلوبة وقيم التحقق عند تكييف المثال؛ تختلف القيم التي تقبل الفراغ عن الحقول المطلوبة المفقودة.

عنصر مصدر متداخل كما يطبّعه محلل CLI. تحتوي source_ref على media_id للمشروع وasset_id. تحمل asset_input.selection قيم تحقق AssetSelection الصادرة عن الخادم دون تغيير. يُوصف preparation أدناه؛ قد يكون flow فارغاً. progress بالإصدار 4 وليس نسبة اكتمال. تصف أنواع الفراغ والاختيارية هنا القيم المطبّعة وليست نموذج تحقق HTTP شاملاً.

الحقلالنوعمطلوبالتصريح / الافتراضالمعنى
source_refSourceRefTrue—زوج ثابت من معرّف وسائط المشروع ومعرّف الأصل المختار؛ تختلف عنه معرّفات عناصر المصدر أثناء التنفيذ.
enabledboolTrue—تضمين المصدر أو تجاوز لغته صراحةً في الخطة الحالية.
typeContentTypeTrue—فئة المصدر text أوaudio أوgraphical؛ تحدد المقاييس والمراحل المطلوبة.
stream_classstrTrue—التصنيف العادي أو أي مجموعة من التعليق والإجباري وSDH.
codec_typestr | NoneTrue—ترميز المسار الفعلي أو تصنيف الترجمة، بشكل مستقل عن التعرف عند الاستيراد.
codec_namestr | NoneTrue—ترميز المسار الفعلي أو تصنيف الترجمة، بشكل مستقل عن التعرف عند الاستيراد.
stream_indexint | NoneTrue—رقم مسار FFprobe أو أرقام المسارات المحددة للاستبدال، وليس ترتيبها في قائمة مفلترة.
filenamestr | NoneTrue—اسم الملف المحضّر مع امتداده الفعلي، لتحديد تنسيق التخزين.
languagestr | NoneTrue—لغة الترجمة أو تصنيفها العادي أو الإجباري أو SDH أو التعليق؛ تبقى رموز اللغة التقنية دون تغيير.
language_overridestr | NoneTrue—تضمين المصدر أو تجاوز لغته صراحةً في الخطة الحالية.
workflow_kindstr | NoneTrue—سير المراحل المختار وشرح التخطيط له؛ فارغ عند عدم اختيار سير عمل.
workflow_reasonstr | NoneTrue—سير المراحل المختار وشرح التخطيط له؛ فارغ عند عدم اختيار سير عمل.
input_snapshot_idstr | NoneTrue—سلسلة الأصل المنتج وأصل النتيجة واللقطة الثابتة؛ احتفظ بهذه الهويات عند التصدير.
asset_inputdict[str, Any]True—عقد مدخل صادر عن الخادم؛ احتفظ بقيم تحقق الاختيار وهوية الأصل.
idstrTrue—معرّف المورد المعاد.
statusstrTrue—مرشح الحالة أو الحالة الجديدة وفقاً للدالة؛ تحتفظ المشاريع المؤرشفة بالنتائج المحفوظة.
preparationContentPreparationTrue—لقطة محاولة معتمدة تتضمن الحالة وقيمة تحقق المحاولة والإجراءات المسموحة.
flowContentFlow | NoneTrue—حالة تدفق معتمدة تقبل الفراغ: status وstep وexecution_count وfailure_code وfailure_class وrunnable_at.
failure_codestr | NoneTrue—رمز فشل تقرؤه الآلة، وقد يكون فارغاً؛ حوّله إلى نص مستخدم مترجم.
progress_updated_atstr | NoneTrue—وقت آخر تحديث تقدم مقبول، وقد يكون فارغاً.
progressContentProgressTrue—تقدم بالإصدار 4 مع phase_plan والمرحلة والخطوة والقياس الحالي وphases وrevision. ليس قيمة نسبة قديمة.

OperationLifecycleContentCountsResponse

عقد مشتق من المصدر. احتفظ بالحقول المطلوبة وقيم التحقق عند تكييف المثال؛ تختلف القيم التي تقبل الفراغ عن الحقول المطلوبة المفقودة.

الحقلالنوعمطلوبالتصريح / الافتراضالمعنى
totalintTrue—مرحلة التقدم المحلي وعدد العناصر أو البايتات المكتملة المقاس؛ الاستدعاءات متزامنة.
pendingintTrue—عدد المصادر في حالة دورة الحياة أو التحضير المسماة؛ الأعداد ليست نسباً مئوية.
uploadingintTrue—عدد المصادر في حالة دورة الحياة أو التحضير المسماة؛ الأعداد ليست نسباً مئوية.
processingintTrue—عدد المصادر في حالة دورة الحياة أو التحضير المسماة؛ الأعداد ليست نسباً مئوية.
completedintTrue—وحدات القياس المكتملة من 0 إلى total. لا يمكن أن يتجاوز القياس مجموعه.
failedintTrue—عدد المصادر في حالة دورة الحياة أو التحضير المسماة؛ الأعداد ليست نسباً مئوية.
skippedintTrue—عدد المصادر في حالة دورة الحياة أو التحضير المسماة؛ الأعداد ليست نسباً مئوية.
terminalintTrue—عدد المصادر في حالة دورة الحياة أو التحضير المسماة؛ الأعداد ليست نسباً مئوية.

OperationMedia

عقد مشتق من المصدر. احتفظ بالحقول المطلوبة وقيم التحقق عند تكييف المثال؛ تختلف القيم التي تقبل الفراغ عن الحقول المطلوبة المفقودة.

وسائط عملية متداخلة. id هو معرّف التشغيل وproject_media_id وجهتها الدائمة في المشروع. contents مصفوفة JSON في النقل وtuple في سجل محلل CLI. لا تزوّد العناصر المعطّلة.

الحقلالنوعمطلوبالتصريح / الافتراضالمعنى
idstrTrue—معرّف المورد المعاد.
project_media_idstrTrue—العلاقة بين وسائط العملية والمشروع مع مسار الوسائط النسبي المسجل.
pathstrTrue—جذر محلي أو مسار أو مسار POSIX نسبي. تستبعد أدوات الفحص الروابط الرمزية؛ أبق المسارات داخل الجذر المختار.
enabledboolTrue—تضمين المصدر أو تجاوز لغته صراحةً في الخطة الحالية.
contentstuple[OperationContent, ...]True—عناصر مصدر متداخلة أو صفوف تقدير لكل مصدر وفق السجل الحاوي.

OperationPreparationCountsResponse

عقد مشتق من المصدر. احتفظ بالحقول المطلوبة وقيم التحقق عند تكييف المثال؛ تختلف القيم التي تقبل الفراغ عن الحقول المطلوبة المفقودة.

الحقلالنوعمطلوبالتصريح / الافتراضالمعنى
awaiting_clientintTrue—عدد المصادر في حالة دورة الحياة أو التحضير المسماة؛ الأعداد ليست نسباً مئوية.
preparingintTrue—عدد المصادر في حالة دورة الحياة أو التحضير المسماة؛ الأعداد ليست نسباً مئوية.
hashingintTrue—عدد المصادر في حالة دورة الحياة أو التحضير المسماة؛ الأعداد ليست نسباً مئوية.
uploadingintTrue—عدد المصادر في حالة دورة الحياة أو التحضير المسماة؛ الأعداد ليست نسباً مئوية.
awaiting_retryintTrue—عدد المصادر في حالة دورة الحياة أو التحضير المسماة؛ الأعداد ليست نسباً مئوية.
readyintTrue—عدد المصادر في حالة دورة الحياة أو التحضير المسماة؛ الأعداد ليست نسباً مئوية.
abandonedintTrue—عدد المصادر في حالة دورة الحياة أو التحضير المسماة؛ الأعداد ليست نسباً مئوية.
not_requiredintTrue—عدد المصادر في حالة دورة الحياة أو التحضير المسماة؛ الأعداد ليست نسباً مئوية.

OperationResultExportResponse

عقد مشتق من المصدر. احتفظ بالحقول المطلوبة وقيم التحقق عند تكييف المثال؛ تختلف القيم التي تقبل الفراغ عن الحقول المطلوبة المفقودة.

الحقلالنوعمطلوبالتصريح / الافتراضالمعنى
artifact_idstrTrue—معرّف ناتج مرحلة ناجحة وثابتة، كما تعيده قائمة النتائج.
snapshot_idstrTrue—سلسلة الأصل المنتج وأصل النتيجة واللقطة الثابتة؛ احتفظ بهذه الهويات عند التصدير.
content_idstrTrue—معرّف عنصر مصدر داخل العملية، وليس معرّف وسائط مشروع أو ناتج مرحلة.
output_targetOutputTargetTrue—external_srt أو external_vtt أو external_ass أو embedded؛ تستخدم None افتراض نقطة النهاية أو الحساب.
captureCapturedExportTrue—بيانات تصدير ثابتة أو اسم ملف نسبي مقترح من الخادم أو نص الترجمة المتسلسل الفعلي.
suggested_pathstrTrue—بيانات تصدير ثابتة أو اسم ملف نسبي مقترح من الخادم أو نص الترجمة المتسلسل الفعلي.
mime_typestrTrue—نوع MIME المكتشف؛ لا يثبت وحده دعم الترميز.
text_contentstrTrue—بيانات تصدير ثابتة أو اسم ملف نسبي مقترح من الخادم أو نص الترجمة المتسلسل الفعلي.
media_pathstrTrue—العلاقة بين وسائط العملية والمشروع مع مسار الوسائط النسبي المسجل.
languagestr | NoneFalseNoneلغة الترجمة أو تصنيفها العادي أو الإجباري أو SDH أو التعليق؛ تبقى رموز اللغة التقنية دون تغيير.
stream_indexint | NoneFalseNoneرقم مسار FFprobe أو أرقام المسارات المحددة للاستبدال، وليس ترتيبها في قائمة مفلترة.
stream_classstr | NoneFalseNoneالتصنيف العادي أو أي مجموعة من التعليق والإجباري وSDH.

OperationWorkflowSummaryResponse

عقد مشتق من المصدر. احتفظ بالحقول المطلوبة وقيم التحقق عند تكييف المثال؛ تختلف القيم التي تقبل الفراغ عن الحقول المطلوبة المفقودة.

الحقلالنوعمطلوبالتصريح / الافتراضالمعنى
requestedWorkflowStageFlagsResponseFalseField(default_factory=WorkflowStageFlagsResponse)علامات مراحل متداخلة: audio_transcription وocr_transcription وtranslation. ميّز الخطة المطلوبة عن المراحل اللازمة بعد تخطي المراحل التي لم تبدأ عند التسوية.
neededWorkflowStageFlagsResponseFalseField(default_factory=WorkflowStageFlagsResponse)علامات مراحل متداخلة: audio_transcription وocr_transcription وtranslation. ميّز الخطة المطلوبة عن المراحل اللازمة بعد تخطي المراحل التي لم تبدأ عند التسوية.
skippedWorkflowStageFlagsResponseFalseField(default_factory=WorkflowStageFlagsResponse)عدد المصادر في حالة دورة الحياة أو التحضير المسماة؛ الأعداد ليست نسباً مئوية.

ProgressMeasurement

عقد مشتق من المصدر. احتفظ بالحقول المطلوبة وقيم التحقق عند تكييف المثال؛ تختلف القيم التي تقبل الفراغ عن الحقول المطلوبة المفقودة.

الحقلالنوعمطلوبالتصريح / الافتراضالمعنى
completedAnnotated[int, Field(ge=0, le=2 ** 63 - 1)]True—وحدات القياس المكتملة من 0 إلى total. لا يمكن أن يتجاوز القياس مجموعه.
totalAnnotated[int, Field(gt=0, le=2 ** 63 - 1)]True—مرحلة التقدم المحلي وعدد العناصر أو البايتات المكتملة المقاس؛ الاستدعاءات متزامنة.
unitProgressUnitTrue—وحدة قياس من ProgressUnit البايتات أو العناصر أو المقاطع أو المللي ثانية؛ استخدم قيم التعداد المعلنة.

ProgressMeasurementSnapshot

عقد مشتق من المصدر. احتفظ بالحقول المطلوبة وقيم التحقق عند تكييف المثال؛ تختلف القيم التي تقبل الفراغ عن الحقول المطلوبة المفقودة.

الحقلالنوعمطلوبالتصريح / الافتراضالمعنى
completedintTrue—وحدات القياس المكتملة من 0 إلى total. لا يمكن أن يتجاوز القياس مجموعه.
totalintTrue—مرحلة التقدم المحلي وعدد العناصر أو البايتات المكتملة المقاس؛ الاستدعاءات متزامنة.
unitstrTrue—وحدة قياس من ProgressUnit البايتات أو العناصر أو المقاطع أو المللي ثانية؛ استخدم قيم التعداد المعلنة.
percentfloatTrueField(ge=0, le=100)مرحلة التقدم المحلي وعدد العناصر أو البايتات المكتملة المقاس؛ الاستدعاءات متزامنة.

ProgressPhase

عقد مشتق من المصدر. احتفظ بالحقول المطلوبة وقيم التحقق عند تكييف المثال؛ تختلف القيم التي تقبل الفراغ عن الحقول المطلوبة المفقودة.

JSON
{
  "PREPARATION": "preparation",
  "UPLOADING": "uploading",
  "TRANSCRIPTION": "transcription",
  "TRANSLATION": "translation"
}

ProgressPhaseSnapshot

عقد مشتق من المصدر. احتفظ بالحقول المطلوبة وقيم التحقق عند تكييف المثال؛ تختلف القيم التي تقبل الفراغ عن الحقول المطلوبة المفقودة.

الحقلالنوعمطلوبالتصريح / الافتراضالمعنى
statusProgressStatusFalseProgressStatus.PENDINGمرشح الحالة أو الحالة الجديدة وفقاً للدالة؛ تحتفظ المشاريع المؤرشفة بالنتائج المحفوظة.
current_stepProgressStep | NoneFalseNoneالمرحلة أو الخطوة النشطة وقد تكون فارغة. قد لا تتضمن اللقطة النهائية مرحلة أو خطوة نشطة.
measurementProgressMeasurementSnapshot | NoneFalseNoneقياس completed وtotal وunit للعمل الفعلي وقد يكون فارغاً، مع percent في اللقطات فقط.
active_work_unitsintFalseField(default=0, ge=0)عدد وحدات العمل النشطة حالياً في هذه الخطوة أو المرحلة أو اللقطة.
stepsdict[ProgressStep, ProgressStepSnapshot]True—سجلات مراحل أو خطوات متداخلة بمفتاح قيمة التعداد المقابلة؛ افحص حالتها وقياساتها.

ProgressSnapshotV4

عقد مشتق من المصدر. احتفظ بالحقول المطلوبة وقيم التحقق عند تكييف المثال؛ تختلف القيم التي تقبل الفراغ عن الحقول المطلوبة المفقودة.

الحقلالنوعمطلوبالتصريح / الافتراضالمعنى
versionLiteral[4]FalsePROGRESS_SCHEMA_VERSIONإصدار مخطط التقدم وهو 4 حالياً؛ ارفض الإصدارات غير المدعومة بدلاً من تخمين بنيتها.
revisionintFalseField(default=0, ge=0)رقم مراجعة متزايد للتقدم المعتمد؛ طابق الأحداث القديمة مع حالة HTTP.
statusProgressStatusFalseProgressStatus.PENDINGمرشح الحالة أو الحالة الجديدة وفقاً للدالة؛ تحتفظ المشاريع المؤرشفة بالنتائج المحفوظة.
phase_planlist[ProgressPhase]True—مراحل مرتبة في سير العمل المقبول؛ المراحل الغائبة لا تعني عملاً ضمنياً.
countsWorkflowPhaseCountsTrue—أعداد مراحل متداخلة: الكلية والمحسومة والمكتملة والمتجاوزة والفاشلة.
current_phaseProgressPhase | NoneFalseNoneالمرحلة أو الخطوة النشطة وقد تكون فارغة. قد لا تتضمن اللقطة النهائية مرحلة أو خطوة نشطة.
current_stepProgressStep | NoneFalseNoneالمرحلة أو الخطوة النشطة وقد تكون فارغة. قد لا تتضمن اللقطة النهائية مرحلة أو خطوة نشطة.
measurementProgressMeasurementSnapshot | NoneFalseNoneقياس completed وtotal وunit للعمل الفعلي وقد يكون فارغاً، مع percent في اللقطات فقط.
active_work_unitsintFalseField(default=0, ge=0)عدد وحدات العمل النشطة حالياً في هذه الخطوة أو المرحلة أو اللقطة.
phasesdict[ProgressPhase, ProgressPhaseSnapshot]True—سجلات مراحل أو خطوات متداخلة بمفتاح قيمة التعداد المقابلة؛ افحص حالتها وقياساتها.

ProgressStatus

عقد مشتق من المصدر. احتفظ بالحقول المطلوبة وقيم التحقق عند تكييف المثال؛ تختلف القيم التي تقبل الفراغ عن الحقول المطلوبة المفقودة.

JSON
{
  "PENDING": "pending",
  "RUNNING": "running",
  "COMPLETED": "completed",
  "SKIPPED": "skipped",
  "FAILED": "failed"
}

ProgressStep

عقد مشتق من المصدر. احتفظ بالحقول المطلوبة وقيم التحقق عند تكييف المثال؛ تختلف القيم التي تقبل الفراغ عن الحقول المطلوبة المفقودة.

JSON
{
  "EXTRACTING_STREAM": "extracting_stream",
  "HASHING_SOURCE": "hashing_source",
  "UPLOADING_SOURCE": "uploading_source",
  "DOWNLOADING_SOURCE": "downloading_source",
  "STARTING_RUNTIME": "starting_runtime",
  "RESOLVING_MODEL": "resolving_model",
  "LOADING_TOKENIZER": "loading_tokenizer",
  "LOADING_MODEL": "loading_model",
  "LOADING_INPUT": "loading_input",
  "RUNNING_INFERENCE": "running_inference",
  "ALIGNING_TIMESTAMPS": "aligning_timestamps",
  "EXTRACTING_SUBTITLE_TRACK": "extracting_subtitle_track",
  "RUNNING_OCR": "running_ocr",
  "PARSING_OCR_OUTPUT": "parsing_ocr_output",
  "FINALIZING_RESULT": "finalizing_result"
}

ProgressStepSnapshot

عقد مشتق من المصدر. احتفظ بالحقول المطلوبة وقيم التحقق عند تكييف المثال؛ تختلف القيم التي تقبل الفراغ عن الحقول المطلوبة المفقودة.

الحقلالنوعمطلوبالتصريح / الافتراضالمعنى
statusProgressStatusFalseProgressStatus.PENDINGمرشح الحالة أو الحالة الجديدة وفقاً للدالة؛ تحتفظ المشاريع المؤرشفة بالنتائج المحفوظة.
measurementProgressMeasurementSnapshot | NoneFalseNoneقياس completed وtotal وunit للعمل الفعلي وقد يكون فارغاً، مع percent في اللقطات فقط.
active_work_unitsintFalseField(default=0, ge=0)عدد وحدات العمل النشطة حالياً في هذه الخطوة أو المرحلة أو اللقطة.
started_atdatetime | NoneFalseNoneوقت مسجل لدى الخادم؛ تشير القيمة الفارغة إلى أن الحدث لم يقع أو أن الوقت غير متاح.

ProgressUnit

عقد مشتق من المصدر. احتفظ بالحقول المطلوبة وقيم التحقق عند تكييف المثال؛ تختلف القيم التي تقبل الفراغ عن الحقول المطلوبة المفقودة.

JSON
{
  "BYTES": "bytes",
  "ITEMS": "items",
  "CHUNKS": "chunks",
  "MILLISECONDS": "milliseconds"
}

ProgressUpdateV4

عقد مشتق من المصدر. احتفظ بالحقول المطلوبة وقيم التحقق عند تكييف المثال؛ تختلف القيم التي تقبل الفراغ عن الحقول المطلوبة المفقودة.

الحقلالنوعمطلوبالتصريح / الافتراضالمعنى
versionLiteral[4]FalsePROGRESS_SCHEMA_VERSIONإصدار مخطط التقدم وهو 4 حالياً؛ ارفض الإصدارات غير المدعومة بدلاً من تخمين بنيتها.
phaseProgressPhaseTrue—مرحلة التقدم المحلي وعدد العناصر أو البايتات المكتملة المقاس؛ الاستدعاءات متزامنة.
stepProgressStepTrue—خطوة تنفيذ تقرؤها الآلة؛ استخدم نوع التدفق أو التقدم الحاوي وقيمه المعدودة.
statusProgressStatusTrue—مرشح الحالة أو الحالة الجديدة وفقاً للدالة؛ تحتفظ المشاريع المؤرشفة بالنتائج المحفوظة.
work_unit_idAnnotated[str, Field(min_length=1, max_length=255)]True—هوية وحدة العمل المقاسة هذه؛ احتفظ بها عبر تحديثات التقدم المتزايدة.
sequenceAnnotated[int, Field(ge=0, le=2 ** 63 - 1)]True—تسلسل تحديث متزايد داخل وحدة عمل واحدة؛ لا تستبدل الحالة الأحدث بتحديثات قديمة.
measurementProgressMeasurement | NoneFalseNoneقياس completed وtotal وunit للعمل الفعلي وقد يكون فارغاً، مع percent في اللقطات فقط.

ProjectOperationCommitRequest

عقد مشتق من المصدر. احتفظ بالحقول المطلوبة وقيم التحقق عند تكييف المثال؛ تختلف القيم التي تقبل الفراغ عن الحقول المطلوبة المفقودة.

الحقلالنوعمطلوبالتصريح / الافتراضالمعنى
media_idslist[Annotated[str, Field(max_length=64)]]TrueField(min_length=1, max_length=OPERATION_MEDIA_MAX_COUNT)سجلات جرد متوافقة مع الخادم أو معرّفات وسائط المشروع المختارة؛ احصل على المعرّفات من الاستجابات الحالية.
target_languagestrTrueField(min_length=1, max_length=32)رمز اللغة الهدف للترجمة النصية المولدة أو المترجمة.
content_overrideslist[ProjectOperationContentOverride]FalseField(default_factory=list, max_length=OPERATION_MEDIA_MAX_COUNT * 4)تجاوزات مرتبطة بمرجع source_ref ثابت: تفعيل المصدر أو تحديد لغته صراحةً.
metricslist[ProjectOperationMetricEntry]FalseField(default_factory=list, max_length=OPERATION_MEDIA_MAX_COUNT * 4)مقاييس المصدر التي تطلبها الخطة الحالية فقط، محسوبة محلياً. مدة الصوت موجودة بالفعل في الجرد المفحوص.
source_selectionslist[AssetSelection]TrueField(max_length=OPERATION_MEDIA_MAX_COUNT * 4)اختيارات محمية من الخطة المقدّرة مع source_language الموحّدة؛ احتفظ باللقطات والملاحظات.

ProjectOperationCommitResponse

عقد مشتق من المصدر. احتفظ بالحقول المطلوبة وقيم التحقق عند تكييف المثال؛ تختلف القيم التي تقبل الفراغ عن الحقول المطلوبة المفقودة.

الحقلالنوعمطلوبالتصريح / الافتراضالمعنى
operationdict[str, Any]True—كائن الخطة أو التقدير أو الاعتماد أو خريطة المصادر المحمية. تبقى بيانات dict[str, Any] مفتوحة؛ يتحقق المثال من الحقول المستخدمة.
commitdict[str, Any]True—كائن الخطة أو التقدير أو الاعتماد أو خريطة المصادر المحمية. تبقى بيانات dict[str, Any] مفتوحة؛ يتحقق المثال من الحقول المستخدمة.
source_ref_mapdict[str, dict[str, str]]True—كائن الخطة أو التقدير أو الاعتماد أو خريطة المصادر المحمية. تبقى بيانات dict[str, Any] مفتوحة؛ يتحقق المثال من الحقول المستخدمة.

ProjectOperationContentOverride

عقد مشتق من المصدر. احتفظ بالحقول المطلوبة وقيم التحقق عند تكييف المثال؛ تختلف القيم التي تقبل الفراغ عن الحقول المطلوبة المفقودة.

الحقلالنوعمطلوبالتصريح / الافتراضالمعنى
source_refProjectOperationSourceRefTrue—زوج ثابت من معرّف وسائط المشروع ومعرّف الأصل المختار؛ تختلف عنه معرّفات عناصر المصدر أثناء التنفيذ.
enabledbool | NoneFalseNoneتضمين المصدر أو تجاوز لغته صراحةً في الخطة الحالية.
language_overridestr | NoneFalseField(default=None, max_length=32)تضمين المصدر أو تجاوز لغته صراحةً في الخطة الحالية.

ProjectOperationMetricEntry

عقد مشتق من المصدر. احتفظ بالحقول المطلوبة وقيم التحقق عند تكييف المثال؛ تختلف القيم التي تقبل الفراغ عن الحقول المطلوبة المفقودة.

الحقلالنوعمطلوبالتصريح / الافتراضالمعنى
source_refProjectOperationSourceRefTrue—زوج ثابت من معرّف وسائط المشروع ومعرّف الأصل المختار؛ تختلف عنه معرّفات عناصر المصدر أثناء التنفيذ.
duration_secondsfloat | int | NoneFalseNoneالمدة المقاسة بالثواني، وليست وقت معالجة مضموناً.
image_countint | NoneFalseNoneمحارف مرئية أو صور رسومية مقاسة تطلبها الخطة؛ لا تستبدلها بأعداد مخمّنة.

ProjectOperationPlanContentResponse

عقد مستمد من المصدر. احتفظ بالحقول المطلوبة والضوابط عند تعديل الوصفة؛ القيم القابلة للفراغ تختلف عن الحقول المطلوبة المفقودة.

الحقلالنوعمطلوبالتصريح / الافتراضيالمعنى
source_refProjectOperationSourceRefTrue—زوج ثابت من معرّف وسائط المشروع ومعرّف الأصل المختار؛ تختلف عنه معرّفات عناصر المصدر أثناء التنفيذ.
source_asset_idstr | NoneTrue—سلسلة الأصل المنتج وأصل النتيجة واللقطة الثابتة؛ احتفظ بهذه الهويات عند التصدير.
enabledboolTrue—تضمين المصدر أو تجاوز لغته صراحةً في الخطة الحالية.
sparse_normalboolTrue—يقترح فحص تصنيف الترجمة النصية العادية تلقائيًا عندما تكون أسطرها المعروفة قليلة مقارنة بطول الوسائط.
languagestrTrue—لغة الترجمة أو تصنيفها العادي أو الإجباري أو SDH أو التعليق؛ تبقى رموز اللغة التقنية دون تغيير.
language_modestr | NoneTrue—أدلة لغة المصدر التي يستخدمها المخطط؛ تبقى رموز اللغات بصيغتها المعيارية.
language_sourcestr | NoneTrue—أدلة لغة المصدر التي يستخدمها المخطط؛ تبقى رموز اللغات بصيغتها المعيارية.
language_declaredstr | NoneTrue—أدلة لغة المصدر التي يستخدمها المخطط؛ تبقى رموز اللغات بصيغتها المعيارية.
language_declared_sourcestr | NoneTrue—أدلة لغة المصدر التي يستخدمها المخطط؛ تبقى رموز اللغات بصيغتها المعيارية.
language_guessstr | NoneTrue—أدلة لغة المصدر التي يستخدمها المخطط؛ تبقى رموز اللغات بصيغتها المعيارية.
language_guess_sourcestr | NoneTrue—أدلة لغة المصدر التي يستخدمها المخطط؛ تبقى رموز اللغات بصيغتها المعيارية.
language_overridestr | NoneTrue—تضمين المصدر أو تجاوز لغته صراحةً في الخطة الحالية.
language_guess_statusstr | NoneTrue—حالة جاهزية اكتشاف لغة المصدر قبل تأكيد التنفيذ.
language_guess_confidencefloat | NoneTrue—درجة الثقة في تخمين لغة المصدر.
language_profiledict[str, Any] | NoneTrue—ملف لغة المصدر المرفق بأدلة اللغة.
typestr | NoneTrue—فئة المصدر text أوaudio أوgraphical؛ تحدد المقاييس والمراحل المطلوبة.
stream_typestr | NoneTrue—ترميز المسار الفعلي أو تصنيف الترجمة، بشكل مستقل عن التعرف عند الاستيراد.
stream_classstr | NoneTrue—التصنيف العادي أو أي مجموعة من التعليق والإجباري وSDH.
codec_typestr | NoneTrue—ترميز المسار الفعلي أو تصنيف الترجمة، بشكل مستقل عن التعرف عند الاستيراد.
codec_namestr | NoneTrue—ترميز المسار الفعلي أو تصنيف الترجمة، بشكل مستقل عن التعرف عند الاستيراد.
filenamestr | NoneTrue—اسم الملف المحضّر مع امتداده الفعلي، لتحديد تنسيق التخزين.
input_snapshot_idstr | NoneTrue—سلسلة الأصل المنتج وأصل النتيجة واللقطة الثابتة؛ احتفظ بهذه الهويات عند التصدير.
stream_indexint | NoneTrue—رقم مسار FFprobe أو أرقام المسارات المحددة للاستبدال، وليس ترتيبها في قائمة مفلترة.
asset_inputdict[str, Any] | NoneTrue—عقد مدخل صادر عن الخادم؛ احتفظ بقيم تحقق الاختيار وهوية الأصل.
workflow_kindstrTrue—سير المراحل المختار وشرح التخطيط له؛ فارغ عند عدم اختيار سير عمل.
workflow_reasonstrTrue—سير المراحل المختار وشرح التخطيط له؛ فارغ عند عدم اختيار سير عمل.
needs_audio_transcriptionboolTrue—ما إذا كان هذا المصدر يحتاج إلى مرحلة المعالجة المذكورة.
needs_ocr_transcriptionboolTrue—ما إذا كان هذا المصدر يحتاج إلى مرحلة المعالجة المذكورة.
needs_translationboolTrue—ما إذا كان هذا المصدر يحتاج إلى مرحلة المعالجة المذكورة.
translation_decisionstrTrue—ما إذا كانت الخطة تتطلب الترجمة أو تتجاوزها.
audio_transcription_enginestr | NoneTrue—مسار المعالجة أو النموذج الذي اختاره الخادم أو أدلة اختيار هذه المرحلة.
audio_transcription_appstr | NoneTrue—مسار المعالجة أو النموذج الذي اختاره الخادم أو أدلة اختيار هذه المرحلة.
audio_transcription_modelstr | NoneTrue—مسار المعالجة أو النموذج الذي اختاره الخادم أو أدلة اختيار هذه المرحلة.
audio_transcription_model_modestr | NoneTrue—مسار المعالجة أو النموذج الذي اختاره الخادم أو أدلة اختيار هذه المرحلة.
audio_transcription_route_reasonstr | NoneTrue—مسار المعالجة أو النموذج الذي اختاره الخادم أو أدلة اختيار هذه المرحلة.
audio_transcription_route_rulestr | NoneTrue—مسار المعالجة أو النموذج الذي اختاره الخادم أو أدلة اختيار هذه المرحلة.
ocr_enginestr | NoneTrue—مسار المعالجة أو النموذج الذي اختاره الخادم أو أدلة اختيار هذه المرحلة.
ocr_modelstr | NoneTrue—مسار المعالجة أو النموذج الذي اختاره الخادم أو أدلة اختيار هذه المرحلة.
translation_providerstr | NoneTrue—مسار المعالجة أو النموذج الذي اختاره الخادم أو أدلة اختيار هذه المرحلة.
translation_modelstr | NoneTrue—مسار المعالجة أو النموذج الذي اختاره الخادم أو أدلة اختيار هذه المرحلة.
translation_model_modestr | NoneTrue—مسار المعالجة أو النموذج الذي اختاره الخادم أو أدلة اختيار هذه المرحلة.
translation_route_reasonstr | NoneTrue—مسار المعالجة أو النموذج الذي اختاره الخادم أو أدلة اختيار هذه المرحلة.
translation_route_rulestr | NoneTrue—مسار المعالجة أو النموذج الذي اختاره الخادم أو أدلة اختيار هذه المرحلة.
estimated_character_countint | NoneTrue—حجم العمل التقديري المقاس للمصدر المحدد.
estimated_cue_countint | NoneTrue—العدد التقديري للمقاطع النصية المرئية في اللقطة المحددة.
estimated_image_countint | NoneTrue—حجم العمل التقديري المقاس للمصدر المحدد.
estimated_duration_secondsint | NoneTrue—حجم العمل التقديري المقاس للمصدر المحدد.
estimated_creditsint | NoneTrue—الرصيد المقدّر لهذا المصدر أو لمرحلة المعالجة المذكورة.
estimated_audio_transcription_creditsint | NoneTrue—الرصيد المقدّر لهذا المصدر أو لمرحلة المعالجة المذكورة.
estimated_ocr_transcription_creditsint | NoneTrue—الرصيد المقدّر لهذا المصدر أو لمرحلة المعالجة المذكورة.
estimated_translation_creditsint | NoneTrue—الرصيد المقدّر لهذا المصدر أو لمرحلة المعالجة المذكورة.

ProjectOperationPlanSlotResponse

عقد مستمد من المصدر. احتفظ بالحقول المطلوبة والضوابط عند تعديل الوصفة؛ القيم القابلة للفراغ تختلف عن الحقول المطلوبة المفقودة.

الحقلالنوعمطلوبالتصريح / الافتراضيالمعنى
slotstrTrue—تصنيف النتيجة: normal أو forced أو sdh أو commentary أو مزيج منها.
source_asset_idstrTrue—معرّف أصل المصدر الموصى به لهذه النتيجة، ويُحسب قبل تعديلات المستخدم.
availableboolTrue—ما إذا كان نص ذو تحديد موثوق للغة موجودًا بالفعل باللغة المستهدفة لهذه النتيجة.

ProjectOperationPlanMediaResponse

عقد مستمد من المصدر. احتفظ بالحقول المطلوبة والضوابط عند تعديل الوصفة؛ القيم القابلة للفراغ تختلف عن الحقول المطلوبة المفقودة.

الحقلالنوعمطلوبالتصريح / الافتراضيالمعنى
project_media_idstrTrue—العلاقة بين وسائط العملية والمشروع مع مسار الوسائط النسبي المسجل.
pathstrTrue—جذر محلي أو مسار أو مسار POSIX نسبي. تستبعد أدوات الفحص الروابط الرمزية؛ أبق المسارات داخل الجذر المختار.
probe_datadict[str, Any] | NoneTrue—أدلة الحاوية والمسارات الفعلية من FFprobe؛ تحتفظ الخرائط المفتوحة بحقول الفحص.
contentslist[ProjectOperationPlanContentResponse]True—عناصر مصدر متداخلة أو صفوف تقدير لكل مصدر وفق السجل الحاوي.
slotslist[ProjectOperationPlanSlotResponse]True—النتائج التي لها مصدر مرشح، مع المصدر الموصى به وحالة التوفر.

ProjectOperationPlanPayload

عقد مستمد من المصدر. احتفظ بالحقول المطلوبة والضوابط عند تعديل الوصفة؛ القيم القابلة للفراغ تختلف عن الحقول المطلوبة المفقودة.

الحقلالنوعمطلوبالتصريح / الافتراضيالمعنى
target_languagestrTrue—رمز اللغة الهدف للترجمة النصية المولدة أو المترجمة.
medialist[ProjectOperationPlanMediaResponse]True—سجل الجرد لملف العنصر كما في replace_project_media؛ يُحذف لعنصر الترجمة.

ProjectOperationPlanEstimateRequest

عقد مشتق من المصدر. احتفظ بالحقول المطلوبة وقيم التحقق عند تكييف المثال؛ تختلف القيم التي تقبل الفراغ عن الحقول المطلوبة المفقودة.

الحقلالنوعمطلوبالتصريح / الافتراضالمعنى
media_idslist[Annotated[str, Field(max_length=64)]]TrueField(min_length=1, max_length=OPERATION_MEDIA_MAX_COUNT)سجلات جرد متوافقة مع الخادم أو معرّفات وسائط المشروع المختارة؛ احصل على المعرّفات من الاستجابات الحالية.
target_languagestrTrueField(min_length=1, max_length=32)رمز اللغة الهدف للترجمة النصية المولدة أو المترجمة.
content_overrideslist[ProjectOperationContentOverride]FalseField(default_factory=list, max_length=OPERATION_MEDIA_MAX_COUNT * 4)تجاوزات مرتبطة بمرجع source_ref ثابت: تفعيل المصدر أو تحديد لغته صراحةً.
metricslist[ProjectOperationMetricEntry]FalseField(default_factory=list, max_length=OPERATION_MEDIA_MAX_COUNT * 4)مقاييس المصدر التي تطلبها الخطة الحالية فقط، محسوبة محلياً. مدة الصوت موجودة بالفعل في الجرد المفحوص.

ProjectOperationPlanEstimateResponse

عقد مشتق من المصدر. احتفظ بالحقول المطلوبة وقيم التحقق عند تكييف المثال؛ تختلف القيم التي تقبل الفراغ عن الحقول المطلوبة المفقودة.

الحقلالنوعمطلوبالتصريح / الافتراضالمعنى
planProjectOperationPlanPayloadTrue—خطة غير محفوظة تتضمن مراجع المصادر والخطوات المخططة؛ تُنشأ معرّفات العملية الدائمة عند تأكيد التنفيذ.
estimatedict[str, Any]True—كائن الخطة أو التقدير أو الاعتماد أو خريطة المصادر المحمية. تبقى بيانات dict[str, Any] مفتوحة؛ يتحقق المثال من الحقول المستخدمة.

ProjectOperationPlanRequest

عقد مشتق من المصدر. احتفظ بالحقول المطلوبة وقيم التحقق عند تكييف المثال؛ تختلف القيم التي تقبل الفراغ عن الحقول المطلوبة المفقودة.

الحقلالنوعمطلوبالتصريح / الافتراضالمعنى
media_idslist[Annotated[str, Field(max_length=64)]]TrueField(min_length=1, max_length=OPERATION_MEDIA_MAX_COUNT)سجلات جرد متوافقة مع الخادم أو معرّفات وسائط المشروع المختارة؛ احصل على المعرّفات من الاستجابات الحالية.
target_languagestrTrueField(min_length=1, max_length=32)رمز اللغة الهدف للترجمة النصية المولدة أو المترجمة.
content_overrideslist[ProjectOperationContentOverride]FalseField(default_factory=list, max_length=OPERATION_MEDIA_MAX_COUNT * 4)تجاوزات مرتبطة بمرجع source_ref ثابت: تفعيل المصدر أو تحديد لغته صراحةً.

ProjectOperationPlanResponse

عقد مشتق من المصدر. احتفظ بالحقول المطلوبة وقيم التحقق عند تكييف المثال؛ تختلف القيم التي تقبل الفراغ عن الحقول المطلوبة المفقودة.

الحقلالنوعمطلوبالتصريح / الافتراضالمعنى
planProjectOperationPlanPayloadTrue—خطة غير محفوظة تتضمن مراجع المصادر والخطوات المخططة؛ تُنشأ معرّفات العملية الدائمة عند تأكيد التنفيذ.

ProjectOperationResultListResponse

عقد مشتق من المصدر. احتفظ بالحقول المطلوبة وقيم التحقق عند تكييف المثال؛ تختلف القيم التي تقبل الفراغ عن الحقول المطلوبة المفقودة.

الحقلالنوعمطلوبالتصريح / الافتراضالمعنى
resultslist[ProjectOperationResultResponse]FalseField(default_factory=list)سجلات مراحل ناجحة وثابتة، بما فيها المراحل المحفوظة بعد فشل مرحلة أخرى.
totalintFalse0مرحلة التقدم المحلي وعدد العناصر أو البايتات المكتملة المقاس؛ الاستدعاءات متزامنة.

ProjectOperationResultResponse

عقد مشتق من المصدر. احتفظ بالحقول المطلوبة وقيم التحقق عند تكييف المثال؛ تختلف القيم التي تقبل الفراغ عن الحقول المطلوبة المفقودة.

كل صف مرحلة ناجحة ثابتة، بما فيها النسخ أو OCR الوسيط والترجمة النهائية. قد تحمل عملية فاشلة جزئياً هذه الصفوف. صدّر artifact_id المختارة؛ يحتاج التحرير نسخة أصل مستقلة قابلة للتحرير.

الحقلالنوعمطلوبالتصريح / الافتراضالمعنى
artifact_idstrTrue—معرّف ناتج مرحلة ناجحة وثابتة، كما تعيده قائمة النتائج.
stageLiteral['transcription', 'ocr', 'translation']True—المرحلة المنتجة: نسخ الكلام أو OCR أو الترجمة.
result_asset_idstrTrue—سلسلة الأصل المنتج وأصل النتيجة واللقطة الثابتة؛ احتفظ بهذه الهويات عند التصدير.
snapshot_idstrTrue—سلسلة الأصل المنتج وأصل النتيجة واللقطة الثابتة؛ احتفظ بهذه الهويات عند التصدير.
generating_artifact_idstrTrue—سلسلة الأصل المنتج وأصل النتيجة واللقطة الثابتة؛ احتفظ بهذه الهويات عند التصدير.
source_asset_idstrTrue—سلسلة الأصل المنتج وأصل النتيجة واللقطة الثابتة؛ احتفظ بهذه الهويات عند التصدير.
source_asset_numberint | NoneFalseNoneرقم المصدر داخل عنصر الوسائط الخاص به؛ تضيفه عمليات التصدير إلى الأسماء التي قد تتعارض لولا ذلك (clip.en.3.srt).
source_languagestrTrue—لغة المصدر الموحّدة الملتقطة مع الاختيار المحمي.
target_languagestr | NoneFalseNoneرمز اللغة الهدف للترجمة النصية المولدة أو المترجمة.
input_snapshot_idstr | NoneFalseNoneسلسلة الأصل المنتج وأصل النتيجة واللقطة الثابتة؛ احتفظ بهذه الهويات عند التصدير.
content_idstrTrue—معرّف عنصر مصدر داخل العملية، وليس معرّف وسائط مشروع أو ناتج مرحلة.
operation_media_idstrTrue—العلاقة بين وسائط العملية والمشروع مع مسار الوسائط النسبي المسجل.
project_media_idstr | NoneFalseNoneالعلاقة بين وسائط العملية والمشروع مع مسار الوسائط النسبي المسجل.
media_pathstrTrue—العلاقة بين وسائط العملية والمشروع مع مسار الوسائط النسبي المسجل.
media_name_numberint | NoneFalseNoneرقم يميّز العناصر التي تحمل الاسم نفسه في مشروع ملفات (يُعرض كـ clip.mp4 · 2)؛ None للإدخال الأقدم أو للاسم الفريد.
export_stemstrTrue—اسم ملف التصدير دون الصيغة (S01/clip.en)، قبل ترقيم التعارضات داخل وجهة واحدة.
languagestr | NoneFalseNoneلغة الترجمة أو تصنيفها العادي أو الإجباري أو SDH أو التعليق؛ تبقى رموز اللغة التقنية دون تغيير.
stream_indexint | NoneFalseNoneرقم مسار FFprobe أو أرقام المسارات المحددة للاستبدال، وليس ترتيبها في قائمة مفلترة.
stream_typestr | NoneFalseNoneترميز المسار الفعلي أو تصنيف الترجمة، بشكل مستقل عن التعرف عند الاستيراد.
stream_classstr | NoneFalseNoneالتصنيف العادي أو أي مجموعة من التعليق والإجباري وSDH.
codec_namestr | NoneFalseNoneترميز المسار الفعلي أو تصنيف الترجمة، بشكل مستقل عن التعرف عند الاستيراد.
result_created_atstrTrue—وقت إنشاء النتيجة المحفوظة أو عدد مقاطع الترجمة.
cue_countintFalse0وقت إنشاء النتيجة المحفوظة أو عدد مقاطع الترجمة.

ProjectOperationSourceRef

عقد مشتق من المصدر. احتفظ بالحقول المطلوبة وقيم التحقق عند تكييف المثال؛ تختلف القيم التي تقبل الفراغ عن الحقول المطلوبة المفقودة.

الحقلالنوعمطلوبالتصريح / الافتراضالمعنى
media_idstrTrueField(min_length=1, max_length=64)معرّف الوسائط في هذا المسار: معرّف وسائط المشروع لمسارات المشاريع، ومعرّف وسائط العملية للرفع والتحضير.
asset_idstrTrueField(min_length=1, max_length=64)معرّف أصل الترجمة النصية أو الصوت التابع لوسائطه.

SourceObservation

عقد مشتق من المصدر. احتفظ بالحقول المطلوبة وقيم التحقق عند تكييف المثال؛ تختلف القيم التي تقبل الفراغ عن الحقول المطلوبة المفقودة.

الحقلالنوعمطلوبالتصريح / الافتراضالمعنى
filestuple[FileObservation, ...]TrueField(min_length=1, max_length=2)لقطة مجلد كاملة أو قائمة ملفات أو أدلة ملاحظة تتطلبها نقطة النهاية؛ أنشئها من الملفات المحلية.
stream_indexStrictInt | NoneFalseNoneرقم مسار FFprobe أو أرقام المسارات المحددة للاستبدال، وليس ترتيبها في قائمة مفلترة.
stream_descriptordict[Annotated[str, Field(max_length=128)], JsonValue]FalseField(default_factory=dict, max_length=128)دور الملف الفعلي أو بصمته المرصودة أو وصف المسار المستخدم للفحوص المحمية.

SourceRef

عقد مشتق من المصدر. احتفظ بالحقول المطلوبة وقيم التحقق عند تكييف المثال؛ تختلف القيم التي تقبل الفراغ عن الحقول المطلوبة المفقودة.

الحقلالنوعمطلوبالتصريح / الافتراضالمعنى
media_idstrTrue—معرّف الوسائط في هذا المسار: معرّف وسائط المشروع لمسارات المشاريع، ومعرّف وسائط العملية للرفع والتحضير.
asset_idstrTrue—معرّف أصل الترجمة النصية أو الصوت التابع لوسائطه.

UploadTarget

عقد مشتق من المصدر. احتفظ بالحقول المطلوبة وقيم التحقق عند تكييف المثال؛ تختلف القيم التي تقبل الفراغ عن الحقول المطلوبة المفقودة.

سجل هدف مطبّع: expires_at كائن datetime هنا ووقت ISO في HTTP JSON. تحمل الاستجابة أيضاً upload_id وهوية العملية والوسائط والمحتوى وsidecar يقبل الفراغ بالشكل نفسه. headers خريطة نصوص مفتوحة وليست وجهة رمز API. احتفظ بالطريقة والترويسات وأعد تجديد الأهداف المنتهية وأكمل المحاولة والرفع والتجزئة المطابقة فقط.

الحقلالنوعمطلوبالتصريح / الافتراضالمعنى
upload_urlstrTrue—عنوان من API؛ تُحل العناوين النسبية مقابل البوابة. لا يُرسل رمز SubFT إلى عناوين الرفع.
methodstrTrue—طريقة HTTP؛ احتفظ بالطريقة الصادرة من الخادم عند الرفع المباشر.
headersMapping[str, str]True—ترويسات HTTP. مرّر ترويسات هدف الرفع دون تغيير؛ ترويسات الطلب العادي تتجاوز ترويسات المنشئ.
expires_atdatetimeTrue—انتهاء الهدف الموقّع؛ جدّده قبل محاولة رفع منتهية.

WorkflowPhaseCounts

عقد مشتق من المصدر. احتفظ بالحقول المطلوبة وقيم التحقق عند تكييف المثال؛ تختلف القيم التي تقبل الفراغ عن الحقول المطلوبة المفقودة.

الحقلالنوعمطلوبالتصريح / الافتراضالمعنى
total_phasesintFalseField(default=0, ge=0)عدد مراحل سير العمل بهذه النتيجة. تشمل المراحل المحسومة المكتملة والمتجاوزة والفاشلة.
resolved_phasesintFalseField(default=0, ge=0)عدد مراحل سير العمل بهذه النتيجة. تشمل المراحل المحسومة المكتملة والمتجاوزة والفاشلة.
completed_phasesintFalseField(default=0, ge=0)عدد مراحل سير العمل بهذه النتيجة. تشمل المراحل المحسومة المكتملة والمتجاوزة والفاشلة.
skipped_phasesintFalseField(default=0, ge=0)عدد مراحل سير العمل بهذه النتيجة. تشمل المراحل المحسومة المكتملة والمتجاوزة والفاشلة.
failed_phasesintFalseField(default=0, ge=0)عدد مراحل سير العمل بهذه النتيجة. تشمل المراحل المحسومة المكتملة والمتجاوزة والفاشلة.

WorkflowStageFlagsResponse

عقد مشتق من المصدر. احتفظ بالحقول المطلوبة وقيم التحقق عند تكييف المثال؛ تختلف القيم التي تقبل الفراغ عن الحقول المطلوبة المفقودة.

الحقلالنوعمطلوبالتصريح / الافتراضالمعنى
audio_transcriptionboolFalseFalseعلامات أو أعداد لكل مرحلة. يصف requested العمل المخطط وneeded العمل المتبقي بعد تخطي المراحل التي لم تبدأ عند التسوية وفق نوع الحقل المتداخل.
ocr_transcriptionboolFalseFalseعلامات أو أعداد لكل مرحلة. يصف requested العمل المخطط وneeded العمل المتبقي بعد تخطي المراحل التي لم تبدأ عند التسوية وفق نوع الحقل المتداخل.
translationboolFalseFalseعلامات أو أعداد لكل مرحلة. يصف requested العمل المخطط وneeded العمل المتبقي بعد تخطي المراحل التي لم تبدأ عند التسوية وفق نوع الحقل المتداخل.