Параметры
Каждая модель сохраняет свои собственные имена параметров, и на странице каждой модели они перечислены. Кроме того, 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("Unknown parameter"); в сообщении предлагается ближайшее допустимое имя. Опечатки никогда не игнорируются. - На странице каждой модели оба имени показаны рядом.
Приведение типов
Значения преобразуются в тип, ожидаемый моделью, поэтому работают все следующие варианты:
| Вы передаёте | Модель ожидает | Результат |
|---|---|---|
5, "5", "5s" |
duration в виде строки, например "5" |
"5" |
"8" |
целое число | 8 |
"1080P", "4K" |
resolution, например "1080p", "4k" |
точное допустимое написание |
"true", "false", 1, 0 |
логическое значение | true, false |
"https://…/a.jpg" |
список URL | ["https://…/a.jpg"] |
42 |
строка | "42" |
Сначала допустимые значения сравниваются точно, затем без учёта регистра, а затем как числа (5 соответствует значениям в стилях "5", "5s" и
"5 s").
Значения по умолчанию
Для пропущенных параметров используются значения по умолчанию модели, указанные в таблице параметров модели. Цена
рассчитывается с использованием тех же значений по умолчанию (например, для видеомодели, у которой generate_audio по умолчанию имеет значение true, цена рассчитывается
с учётом звука, если не передать "generate_audio": false).
Параметры файлов
Параметры изображений, видео и аудио принимают общедоступный URL, URI data: размером до 10 МБ или значение file_url загруженного файла.
См. Files.