مواد پر جائیں
API گائیڈ

پیرامیٹرز

Markdown کے طور پر دیکھیں اپ ڈیٹ کیا گیا

ہر ماڈل اپنے مقامی پیرامیٹر نام برقرار رکھتا ہے، اور ہر ماڈل کا صفحہ انہیں درج کرتا ہے۔ اس کے علاوہ، API ان پیرامیٹرز کے لیے معیاری نام قبول کرتی ہے جن کا مطلب ہر ماڈل میں یکساں ہوتا ہے، لہٰذا ایک ماڈل کے لیے لکھا گیا کوڈ کم تبدیلیوں کے ساتھ اگلے ماڈل پر بھی کام کرتا ہے۔

معیاری نام

معیاری نام مطلب عام مقامی نام
image ان پٹ یا پہلے فریم کی تصویر image_url, start_image_url, first_frame_url, first_image_url, source_image_url
end_image آخری فریم کی تصویر end_image_url, last_frame_url, tail_image_url
images حوالہ جاتی تصاویر کی فہرست image_urls, reference_image_urls
video ان پٹ ویڈیو video_url
videos حوالہ جاتی ویڈیوز کی فہرست video_urls
audio ان پٹ آڈیو audio_url
audios حوالہ جاتی آڈیو کلپس کی فہرست audio_urls
mask ماسک کی تصویر mask_url
num_outputs کتنے نتائج تیار کرنے ہیں num_images
generate_audio ویڈیو کے ساتھ آواز تیار کریں generate_audio_switch, enable_audio

ہر موجودہ ماڈل میں معیاری نام کس مقامی فیلڈ سے منسلک ہوتا ہے:

معیاری نام مقامی فیلڈ (اسے استعمال کرنے والے ماڈلز)
audio audio_url (ماڈلز: 126)
audios audio_urls (ماڈلز: 7), reference_audio_urls (ماڈلز: 1)
end_image end_image_url (ماڈلز: 76), last_frame_url (ماڈلز: 12), tail_image_url (ماڈلز: 1)
generate_audio generate_audio_switch (ماڈلز: 16), audio (ماڈلز: 3)
image image_url (ماڈلز: 529), start_image_url (ماڈلز: 20), first_frame_url (ماڈلز: 12), first_image_url (ماڈلز: 7), source_image_url (ماڈلز: 2)
images image_urls (ماڈلز: 148), reference_image_urls (ماڈلز: 31)
mask mask_url (ماڈلز: 46)
num_outputs num_images (ماڈلز: 337)
video video_url (ماڈلز: 197)
videos video_urls (ماڈلز: 13), reference_video_urls (ماڈلز: 1)

اصول:

  • یا تو معیاری نام بھیجیں یا مقامی نام۔ اگر آپ دونوں کو مختلف قدروں کے ساتھ بھیجتے ہیں تو کال 422 invalid_input کے ساتھ معیاری نام پر ناکام ہو جاتی ہے۔
  • ایسا پیرامیٹر جو ماڈل کا نہ مقامی نہ ہی معیاری نام ہو، 422 invalid_input ("نامعلوم پیرامیٹر") کے ساتھ مسترد کر دیا جاتا ہے، اور تجویز کے طور پر قریب ترین درست نام دیا جاتا ہے۔ ٹائپوز کبھی خاموشی سے قبول نہیں ہوتیں۔
  • ہر ماڈل کا صفحہ دونوں نام ساتھ ساتھ دکھاتا ہے۔

قسم کی تبدیلی

قدروں کو اس قسم میں تبدیل کیا جاتا ہے جس کی ماڈل کو توقع ہوتی ہے، اس لیے یہ سب کام کرتے ہیں:

آپ بھیجتے ہیں ماڈل کی توقع بن جاتا ہے
5, "5", "5s" duration بطور ایسی اسٹرنگ جیسے "5" "5"
"8" ایک عدد صحیح 8
"1080P", "4K" resolution جیسے "1080p", "4k" اجازت یافتہ ہجے بعینہٖ
"true", "false", 1, 0 ایک بولین true, false
"https://…/a.jpg" URLs کی فہرست ["https://…/a.jpg"]
42 ایک اسٹرنگ "42"

اجازت یافتہ قدروں کا پہلے بعینہٖ، پھر بڑے اور چھوٹے حروف کو نظرانداز کرتے ہوئے، اور پھر اعداد کے طور پر موازنہ کیا جاتا ہے (5، "5"، "5s" اور "5 s" جیسی قدروں سے مطابقت رکھتا ہے)۔

ڈیفالٹس

جو پیرامیٹرز آپ چھوڑ دیتے ہیں وہ ماڈل کا ڈیفالٹ استعمال کرتے ہیں، جو ماڈل کی پیرامیٹر جدول میں درج ہوتا ہے۔ قیمت انہی ڈیفالٹس کے ساتھ شمار کی جاتی ہے (مثلاً، ایسا ویڈیو ماڈل جس میں generate_audio کا ڈیفالٹ true ہو، آواز کے ساتھ قیمت رکھتا ہے، جب تک آپ "generate_audio": false نہ بھیجیں)۔

فائل پیرامیٹرز

تصویر، ویڈیو اور آڈیو پیرامیٹرز عوامی URL، 10 MB تک کی data: URI، یا اپ لوڈ کی file_url قبول کرتے ہیں۔ فائلیں دیکھیں۔