الحصول على مدخلات سير عمل
اقرأ المدخلات التي تتطلبها أداة سير العمل قبل بدء التشغيل.
تُؤلَّف مدخلات سير العمل في Studio وتتغير عندما يغيرها مؤلفوها. اقرأ العقد بدلًا من ترميزه بشكل ثابت.
GET {base_url}/workflows/{workflow_id}/inputsيتطلب workflows:read.
الاستجابة
{
"workflow": {
"id": "0192f3c3-9d21-7c44-b8e1-5a7f2c9d4e10",
"name": "مرئيات القصة",
"version_id": "0192f3c4-1a02-7bb3-9f40-2c6e8d1a5b77",
"schema_hash": "9fdf032d5b1c4e88",
"credits_estimate": 1840,
"duration_seconds_estimate": 420
},
"inputs": [
{
"key": "story_document",
"accepts": "url",
"type": "document",
"required": true,
"allow_multiple": false,
"url_content_types": ["application/pdf", "text/plain", "text/markdown"],
"max_bytes": 104857600,
"title": "مستند القصة",
"description": "القصة النهائية المراد تكييفها"
},
{
"key": "tone",
"accepts": "value",
"type": "string",
"required": true,
"allow_multiple": false,
"allowed_values": ["thriller", "romance", "mythology"],
"allow_custom": false,
"default_value": "thriller",
"title": "النبرة"
}
]
}كائن سير العمل
| الحقل | المعنى |
|---|---|
version_id | الإصدار الذي سيُنفَّذ الآن. أَعِده في عملية التشغيل لتثبيت هذا العقد بالضبط |
schema_hash | يتغير عندما يتغير أي مدخل. الحقل الوحيد للمقارنة مع ذاكرة التخزين المؤقت لديك |
credits_estimate | الأرصدة التي كانت تكلفة تشغيل هذا سير العمل بها في المتوسط |
duration_seconds_estimate | المدة التي كان يستغرقها في المتوسط، من البداية إلى النهاية |
كل مدخل
| الحقل | المعنى |
|---|---|
المفتاح | الاسم الذي يجب استخدامه في المدخلات كائن |
يقبل | القيمة أرسل القيمة نفسها · رابط أرسل رابط HTTPS عامًّا · الخيار أرسل أحد options[].id |
النوع | نص, رقم, منطقي, صورة, فيديو, صوت أو مستند |
مطلوب | يجب أن يكون موجودًا، إلا إذا default_value مُعيَّن |
allow_multiple | عندما تكون true، يمكن أن تكون القيمة مصفوفة؛ وعندما تكون false، تُرفَض المصفوفة |
allowed_values | لـ يقبل: valueالوحيدة المقبولة، إلا إذا allow_custom true |
allow_custom | عندما تكون false، تُرفَض القيم خارج allowed_values أو الخيارات مرفوضة |
الحد الأدنى, الحد الأقصى | حدود شاملة، لـ type: number |
default_value | ما يستخدمه التشغيل عندما يُحذف المدخل |
url_content_types | لـ يقبل: urlأنواع المحتوى التي قد يقدمها الرابط |
الحد الأقصى للبايتات | لـ يقبل: urlأكبر ملف مقبول لهذا المدخل |
الخيارات | لـ يقبل: option: { "id", "label" } المدخلات. أرسل الـ المعرّف إياه كما هو تمامًا؛ فهو ليس رابطًا |
العنوان, الوصف | مكتوب للبشر، وآمن لعرضه في واجهة المستخدم الخاصة بك |
خزِّن العقد مؤقتًا مقابل schema_hash، وأعد قراءته عندما يُرفَض تشغيلٌ مع invalid_request. يمكن لمؤلفي سير العمل إضافة مدخل مطلوب بين تشغيلين من تشغيلاتك.