doc(seed):新增或者大模型文档说明
This commit is contained in:
qian committed
1 parent
42f2b2e1c0
commit
d5b100e590
7 files changed
+6241
No files matched your search
@@ -0,0 +1,645 @@
|
||||
`POST https://ark.cn-beijing.volces.com/api/v3/contents/generations/tasks` [ ](https://api.volcengine.com/api-explorer/?action=CreateContentsGenerationsTasks&data=%7B%7D&groupName=%E8%A7%86%E9%A2%91%E7%94%9F%E6%88%90API&query=%7B%7D&serviceCode=ark&version=2024-01-01)[运行](https://api.volcengine.com/api-explorer/?action=CreateContentsGenerationsTasks&data=%7B%7D&groupName=%E8%A7%86%E9%A2%91%E7%94%9F%E6%88%90API&query=%7B%7D&serviceCode=ark&version=2024-01-01)
|
||||
本文介绍创建视频生成任务 API 的输入输出参数，供您使用接口时查阅字段含义。模型会依据传入的图片及文本信息生成视频，待生成完成后，您可以按条件查询任务并获取生成的视频。
|
||||
:::tip
|
||||
请确保您的账户余额大于等于 200 元（[前往充值](https://console.volcengine.com/finance/fund/recharge)），或已[购买资源包](https://console.volcengine.com/common-buy/fast/ark_bd%7C%7Cd682ppeeq1mp7kd5q0e0)，否则无法开通 Seedance 2.0 及 Seedance 2.0 fast 模型。
|
||||
|
||||
:::
|
||||
**模型能力==^new^==**
|
||||
|
||||
* **Doubao Seedance 2.0 系列==^new^==** ** (有声视频/无声视频)**
|
||||
* **多模态参考生视频==^new^==**：输入++参考图片（0~9）+参考视频（0~3）+ 参考音频（0~3）+ 文本提示词（可选）++ 生成 1 个目标视频。注意不可单独输入音频，应至少包含 1 个参考视频或图片。支持生成全新视频、编辑视频、延长视频，[阅读教程](https://www.volcengine.com/docs/82379/2291680) 获取详细代码示例。
|
||||
* **图生视频\-首尾帧**：输入++首帧图片+尾帧图片+文本提示词（可选）++ 生成 1 个目标视频。
|
||||
* **图生视频\-首帧**：输入++首帧图片+文本提示词（可选）++ 生成 1 个目标视频。
|
||||
* **文生视频**：输入++文本提示词++生成 1 个目标视频。
|
||||
* **Doubao Seedance 1.5 pro (有声视频/无声视频)**
|
||||
【图生视频\-首尾帧】【图生视频\-首帧】【文生视频】
|
||||
* **Doubao Seedance 1.0 pro**
|
||||
【图生视频\-首尾帧】【图生视频\-首帧】【文生视频】
|
||||
* **Doubao Seedance 1.0 pro fast**
|
||||
【图生视频\-首帧】【文生视频】
|
||||
|
||||
|
||||
Tips：一键展开折叠，快速检索内容
|
||||
打开页面右上角开关，**ctrl ** + **f** 可检索页面内所有内容。
|
||||
<span> </span>
|
||||
|
||||
|
||||
```mixin-react
|
||||
return (<Tabs>
|
||||
<Tabs.TabPane title="在线调试" key="4rK5FhUg"><RenderMd content={`<APILink link="https://api.volcengine.com/api-explorer/?action=CreateContentsGenerationsTasks&data=%7B%7D&groupName=%E8%A7%86%E9%A2%91%E7%94%9F%E6%88%90API&query=%7B%7D&serviceCode=ark&version=2024-01-01" description="API Explorer 您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。">去调试</APILink>
|
||||
|
||||
`}></RenderMd></Tabs.TabPane>
|
||||
<Tabs.TabPane title="鉴权说明" key="iRuPtuk6"><RenderMd content={`本接口仅支持 API Key 鉴权，请在 [获取 API Key](https://console.volcengine.com/ark/region:ark+cn-beijing/apiKey) 页面，获取长效 API Key。
|
||||
`}></RenderMd></Tabs.TabPane>
|
||||
<Tabs.TabPane title="快速入口" key="5LZLMN0J"><RenderMd content={` [ ](#)[体验中心](https://console.volcengine.com/ark/region:ark+cn-beijing/experience/vision) <span> </span>[模型列表](https://www.volcengine.com/docs/82379/1330310?lang=zh#2705b333) <span> </span>[模型计费](https://www.volcengine.com/docs/82379/1544106?redirect=1&lang=zh#02affcb8) <span> </span>[API Key](https://console.volcengine.com/ark/region:ark+cn-beijing/apiKey?apikey=%7B%7D)
|
||||
<span> </span>[调用教程](https://www.volcengine.com/docs/82379/1366799) <span> </span>[接口文档](https://www.volcengine.com/docs/82379/1520758) <span> </span>[常见问题](https://www.volcengine.com/docs/82379/1359411) <span> </span>[开通模型](https://console.volcengine.com/ark/region:ark+cn-beijing/openManagement?LLM=%7B%7D&OpenTokenDrawer=false)
|
||||
`}></RenderMd></Tabs.TabPane></Tabs>);
|
||||
```
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
||||
<span id="5qndT7DS"></span>
|
||||
## 请求参数
|
||||
> 跳转 [响应参数](#y2hhTyHB)
|
||||
|
||||
<span id="wsGzv1pD"></span>
|
||||
### 请求体
|
||||
|
||||
---
|
||||
|
||||
|
||||
**model** `string` %%require%%
|
||||
您需要调用的模型的 ID （Model ID），[开通模型服务](https://console.volcengine.com/ark/region:ark+cn-beijing/openManagement?LLM=%7B%7D&OpenTokenDrawer=false)，并[查询 Model ID](https://www.volcengine.com/docs/82379/1330310) 。
|
||||
您也可通过 Endpoint ID 来调用模型，获得限流、计费类型（前付费/后付费）、运行状态查询、监控、安全等高级能力，可参考[获取 Endpoint ID](https://www.volcengine.com/docs/82379/1099522)。
|
||||
|
||||
---
|
||||
|
||||
|
||||
**content** `object[]` %%require%%
|
||||
输入给模型，生成视频的信息，支持文本、图片、音频、视频、样片任务 ID。
|
||||
:::warning
|
||||
Seedance 2.0 系列模型不支持直接上传含有真人人脸的参考图/视频。为了便利创作者对肖像的使用，平台推出了以下解决方案，详情参见 [教程](https://www.volcengine.com/docs/82379/2291680?lang=zh#5c67c9a1)。
|
||||
|
||||
* 支持使用部分模型的含人脸原始产物作为输入素材
|
||||
* 支持使用预置虚拟人像作为输入素材
|
||||
* 支持使用已授权真人素材作为输入
|
||||
|
||||
:::
|
||||
支持以下几种组合：
|
||||
|
||||
* **文本**
|
||||
* **文本（可选）+ 图片**
|
||||
* **文本（可选）+ 视频**
|
||||
* **文本（可选）+ 图片 + 音频**
|
||||
* **文本（可选）+ 图片 + 视频**
|
||||
* **文本（可选）+ 视频 + 音频**
|
||||
* **文本（可选）+ 图片 + 视频 + 音频**
|
||||
* **样片任务 ID**：样片指使用 Seedance 模型成功生成的样片视频，模型可基于样片生成高质量正式视频。
|
||||
|
||||
|
||||
信息类型
|
||||
|
||||
---
|
||||
|
||||
|
||||
**文本信息** `object`
|
||||
输入给模型的提示词信息。
|
||||
|
||||
属性
|
||||
|
||||
---
|
||||
|
||||
|
||||
content.**type ** `string` %%require%%
|
||||
输入内容的类型，此处应为 `text`。
|
||||
|
||||
---
|
||||
|
||||
|
||||
content.**text ** `string` %%require%%
|
||||
输入给模型的文本提示词，描述期望生成的视频。
|
||||
:::tip
|
||||
|
||||
* 提示词语言支持：所有模型均支持中英文提示词；seedance 2.0 及 seedance 2.0 fast 额外支持日语、印尼语、西班牙语、葡萄牙语。
|
||||
* 提示词字数建议：中文提示词不超过500字，英文提示词不超过1000词。字数过多易导致信息分散，模型可能忽略细节、仅关注重点，进而造成视频缺失部分元素。
|
||||
* 更多使用技巧：提示词的详细使用技巧，请参见 [seedance 提示词指南](https://www.volcengine.com/docs/82379/2222480?lang=zh)。
|
||||
|
||||
|
||||
|
||||
:::
|
||||
|
||||
---
|
||||
|
||||
|
||||
**图片信息==^new^==** `object`
|
||||
输入给模型的图片信息。
|
||||
|
||||
属性
|
||||
|
||||
---
|
||||
|
||||
|
||||
content.**type ** `string` %%require%%
|
||||
输入内容的类型，此处应为 `image_url`。
|
||||
|
||||
---
|
||||
|
||||
|
||||
content.**image_url ** `object` %%require%%
|
||||
输入给模型的图片对象。
|
||||
|
||||
属性
|
||||
|
||||
---
|
||||
|
||||
|
||||
content.image_url.**url ** `string` %%require%%
|
||||
图片 URL 、图片 Base64 编码、素材 ID。
|
||||
|
||||
* 图片 URL：填入图片的公网 URL。
|
||||
* Base64 编码：将本地文件转换为 Base64 编码字符串，然后提交给大模型。遵循格式：`data:image/<图片格式>;base64,<Base64编码>`，注意 `<图片格式>` 需小写，如 `data:image/png;base64,{base64_image}`。
|
||||
* 素材 ID：用于视频生成的预置素材及虚拟人像的 ID，遵循格式：asset://<ASSET_ID\>。可从 [素材&虚拟人像库](https://console.volcengine.com/ark/region:ark+cn-beijing/experience/vision?modelId=doubao-seedance-2-0-260128) 获取。
|
||||
|
||||
:::tip 传入单张图片要求
|
||||
|
||||
* 格式：jpeg、png、webp、bmp、tiff、gif。其中，Seedance 1.5 pro 和 Seedance 2.0 系列模型新增支持 heic 和 heif。
|
||||
* 宽高比（宽/高）： (0.4, 2.5)
|
||||
* 宽高长度（px）：(300, 6000)
|
||||
* 大小：单张图片小于 30 MB。请求体大小不超过 64 MB。大文件请勿使用Base64编码。
|
||||
* 图片数量：
|
||||
* 图生视频\-首帧：1 张
|
||||
* 图生视频\-首尾帧：2 张
|
||||
* Seedance 2.0 系列 多模态参考生视频：1~9 张
|
||||
|
||||
:::
|
||||
|
||||
---
|
||||
|
||||
|
||||
content.**role ** `string` `条件必填`
|
||||
图片的位置或用途。
|
||||
:::warning
|
||||
|
||||
* **图生视频\-首帧**、**图生视频\-首尾帧**、**多模态参考生视频**（包括参考图、视频、音频）为 3 种互斥场景，**不可混用**。
|
||||
* **多模态参考生视频**可通过提示词指定参考图片作为首帧/尾帧，间接实现“首尾帧+多模态参考”效果。若需严格保障首尾帧和指定图片一致，**优先使用图生视频\-首尾帧**（配置 role 为 first_frame/last_frame）。
|
||||
|
||||
|
||||
:::
|
||||
图生视频\-首帧
|
||||
|
||||
* **支持模型：** 所有模型
|
||||
* **字段role取值：** 需要传入1个 image_url 对象，字段 role 为 first_frame 或不填。
|
||||
|
||||
|
||||
图生视频\-首尾帧
|
||||
|
||||
* **支持模型：** Seedance 2.0 系列，Seedance 1.5 pro、Seedance 1.0 pro
|
||||
* **字段role取值：** 需要传入2个image_url对象，且字段 role 必填。
|
||||
* 首帧图片对应的字段 role 为：first_frame
|
||||
* 尾帧图片对应的字段 role 为：last_frame
|
||||
|
||||
:::tip
|
||||
传入的首尾帧图片可相同。首尾帧图片的宽高比不一致时，以首帧图片为主，尾帧图片会自动裁剪适配。
|
||||
|
||||
:::
|
||||
|
||||
图生视频\-参考图
|
||||
|
||||
* **支持模型：** Seedance 2.0 系列（1~9 张图片）
|
||||
* **字段role取值：** 必填，每张参考图对应的字段 role 均为：reference_image
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
||||
**视频信息==^new^==** `object`
|
||||
输入给模型的视频信息。仅 Seedance 2.0 系列支持输入视频。
|
||||
方舟平台信任 Seedance 2.0 系列模型生成的含人脸视频，您可使用**本账号下近30天内由上述模型生成的含人脸原始视频**，作为输入素材进行二次创作，详情参见 [教程](https://www.volcengine.com/docs/82379/2291680?lang=zh#341d7f71)。
|
||||
|
||||
属性
|
||||
content.**type ** `string` %%require%%
|
||||
输入内容的类型，此处应为`video_url`。
|
||||
|
||||
---
|
||||
|
||||
|
||||
content.**video_url** ** ** `object` %%require%%
|
||||
输入给模型的视频对象。
|
||||
|
||||
属性
|
||||
content.video_url.**url ** `string` %%require%%
|
||||
视频URL、素材 ID。
|
||||
|
||||
* 视频 URL：填入视频的公网 URL。
|
||||
* 素材 ID：用于视频生成的预置素材及虚拟人像视频的 ID，遵循格式：asset://<ASSET_ID\>。可从[素材&虚拟人像库](https://console.volcengine.com/ark/region:ark+cn-beijing/experience/vision?modelId=doubao-seedance-2-0-260128)获取。
|
||||
|
||||
:::tip 传入单个视频要求
|
||||
|
||||
* 视频格式：mp4、mov，支持编码格式见下表。
|
||||
* 分辨率：480p，720p，1080p
|
||||
* 时长：单个视频时长 [2, 15] s，最多传入 3 个参考视频，所有视频总时长不超过 15s。
|
||||
* 尺寸：
|
||||
* 宽高比（宽/高）：[0.4, 2.5]
|
||||
* 宽高长度（px）：[300, 6000]
|
||||
* 总像素数：[640×640=409600, 2206×946=2086876]，即宽和高的乘积符合 [409600, 2086876] 的区间要求。
|
||||
* 大小：单个视频不超过 50 MB。
|
||||
* 帧率 (FPS)：[24, 60]
|
||||
|
||||
|
||||
:::
|
||||
|**容器格式** |**常用文件扩展名** |**MIME** |**支持编码** |
|
||||
|---|---|---|---|
|
||||
|MP4 |.mp4 |video/mp4 |视频：H.264/AVC、H.265/HEVC|\
|
||||
| | | |音频：AAC、MP3 |
|
||||
|QuickTime |.mov |video/quicktime |视频：H.264/AVC、H.265/HEVC|\
|
||||
| | | |音频：AAC、MP3 |
|
||||
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
||||
content.**role ** `string` `条件必填`
|
||||
视频的位置或用途。当前仅支持 reference_video：参考视频。
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
||||
**音频信息==^new^==** `object`
|
||||
输入给模型的音频信息。仅 Seedance 2.0 系列支持输入音频。
|
||||
注意不可单独输入音频，应至少包含 1 个参考视频或图片。
|
||||
|
||||
属性
|
||||
content.**type ** `string` %%require%%
|
||||
输入内容的类型，此处应为`audio_url`。
|
||||
|
||||
---
|
||||
|
||||
|
||||
content.**audio_url** ** ** `object` %%require%%
|
||||
输入给模型的音频对象。
|
||||
|
||||
属性
|
||||
content.audio_url.**url ** `string` %%require%%
|
||||
音频 URL 、音频 Base64 编码、素材 ID。
|
||||
|
||||
* 音频 URL：填入音频的公网 URL。
|
||||
* Base64 编码：将本地文件转换为 Base64 编码字符串，然后提交给大模型。遵循格式：`data:audio/<音频格式>;base64,<Base64编码>`，注意 `<音频格式>` 需小写，如 `data:audio/wav;base64,{base64_audio}`。
|
||||
* 素材 ID：用于视频生成的虚拟人的音频素材 ID，遵循格式：asset://<ASSET_ID\>。可从[素材&虚拟人像库](https://console.volcengine.com/ark/region:ark+cn-beijing/experience/vision?modelId=doubao-seedance-2-0-260128)获取。
|
||||
|
||||
:::tip 传入单个音频要求
|
||||
|
||||
* 格式：wav、mp3
|
||||
* 时长：单个音频时长 [2, 15] s，最多传入 3 段参考音频，所有音频总时长不超过 15 s。
|
||||
* 大小：单个音频不超过 15 MB，请求体大小不超过 64 MB。大文件请勿使用Base64编码。
|
||||
|
||||
|
||||
|
||||
:::
|
||||
|
||||
---
|
||||
|
||||
|
||||
content.**role ** `string` `条件必填`
|
||||
音频的位置或用途。当前仅支持 reference_audio：参考音频。
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
||||
**样片信息 ** `object`
|
||||
基于样片任务 ID，生成正式视频。仅 Seedance 1.5 pro 支持该功能。[阅读](https://www.volcengine.com/docs/82379/1366799?lang=zh#5acd28c8)[文档](https://www.volcengine.com/docs/82379/1366799?lang=zh#5acd28c8) 获取 draft 功能的使用教程和注意事项。
|
||||
|
||||
属性
|
||||
|
||||
---
|
||||
|
||||
|
||||
content.**type ** `string` %%require%%
|
||||
输入内容的类型，此处应为 `draft_task`。
|
||||
|
||||
---
|
||||
|
||||
|
||||
content.**draft_task** ** ** `object` %%require%%
|
||||
输入给模型的样片任务。
|
||||
|
||||
属性
|
||||
|
||||
---
|
||||
|
||||
|
||||
content.draft_task.**id ** `string` %%require%%
|
||||
样片任务 ID。平台将自动复用 Draft 视频使用的用户输入（**model、** content.**text、** content.**image_url、generate_audio、seed、ratio、duration、camera_fixed ** ），生成正式视频。其余参数支持指定，不指定将使用本模型的默认值。
|
||||
使用分为两步：Step1: 调用本接口生成 Draft 视频。Step2: 如果确认 Draft 视频符合预期，可基于 Step1 返回的 Draft 视频任务 ID，调用本接口生成最终视频。[阅读文档](https://www.volcengine.com/docs/82379/1366799?lang=zh#5acd28c8) 获取详细教程。
|
||||
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
||||
**callback_url** `string`
|
||||
填写本次生成任务结果的回调通知地址。当视频生成任务有状态变化时，方舟将向此地址推送 POST 请求。
|
||||
回调请求内容结构与[查询任务API](https://www.volcengine.com/docs/82379/1521309)的返回体一致。
|
||||
回调返回的 status 包括以下状态：
|
||||
|
||||
* queued：排队中。
|
||||
* running：任务运行中。
|
||||
* succeeded： 任务成功。（如发送失败，即5秒内没有接收到成功发送的信息，回调三次）
|
||||
* failed：任务失败。（如发送失败，即5秒内没有接收到成功发送的信息，回调三次）
|
||||
* expired：任务超时，即任务处于**运行中或排队中**状态超过过期时间。可通过 **execution_expires_after ** 字段设置过期时间。
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
||||
**return_last_frame** `boolean` `默认值 false`
|
||||
|
||||
* true：返回生成视频的尾帧图像。设置为 `true` 后，可通过 [查询视频生成任务接口](https://www.volcengine.com/docs/82379/1521309) 获取视频的尾帧图像。尾帧图像的格式为 png，宽高像素值与生成的视频保持一致，无水印。
|
||||
使用该参数可实现生成多个连续视频：以上一个生成视频的尾帧作为下一个视频任务的首帧，快速生成多个连续视频，调用示例详见 [教程](https://www.volcengine.com/docs/82379/1366799?lang=zh#141cf7fa)。
|
||||
* false：不返回生成视频的尾帧图像。
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
||||
**service_tier** `string` `默认值 default`
|
||||
> 不支持修改已提交任务的服务等级
|
||||
> Seedance 2.0 系列 不支持离线推理
|
||||
|
||||
指定处理本次请求的服务等级类型，枚举值：
|
||||
|
||||
* default：在线推理模式，RPM 和并发数配额较低（详见 [模型列表](https://www.volcengine.com/docs/82379/1330310?lang=zh#2705b333)），适合对推理时效性要求较高的场景。
|
||||
* flex：离线推理模式，TPD 配额更高（详见 [模型列表](https://www.volcengine.com/docs/82379/1330310?lang=zh#2705b333)），价格为在线推理的 50%， 适合对推理时延要求不高的场景。
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
||||
**execution_expires_after ** `integer` `默认值 172800`
|
||||
任务超时阈值。指定任务提交后的过期时间（单位：秒），从 **created at** 时间戳开始计算。默认值 172800 秒，即 48 小时。取值范围：[3600，259200]。
|
||||
不论使用哪种 **service_tier**，都建议根据业务场景设置合适的超时时间。超过该时间后任务会被自动终止，并标记为`expired`状态。
|
||||
|
||||
---
|
||||
|
||||
|
||||
**generate_audio ** `boolean` `默认值 true`
|
||||
> 仅 Seedance 2.0 系列、Seedance 1.5 pro 支持
|
||||
|
||||
控制生成的视频是否包含与画面同步的声音。
|
||||
|
||||
* true：模型输出的视频包含同步音频。模型会基于文本提示词与视觉内容，自动生成与之匹配的人声、音效及背景音乐。建议将对话部分置于双引号内，以优化音频生成效果。例如：男人叫住女人说：“你记住，以后不可以用手指指月亮。”
|
||||
* false：模型输出的视频为无声视频。
|
||||
|
||||
:::warning
|
||||
生成的有声视频均为单声道，和传入的音频声道数无关。
|
||||
|
||||
:::
|
||||
---
|
||||
|
||||
|
||||
**draft ** `boolean` `默认值 false`
|
||||
> 仅 Seedance 1.5 pro 支持
|
||||
|
||||
控制是否开启样片模式。[阅读文档](https://www.volcengine.com/docs/82379/1366799?lang=zh#5acd28c8) 获取使用教程和注意事项。
|
||||
|
||||
* true：开启样片模式，生成一段预览视频，快速验证场景结构、镜头调度、主体动作与 prompt 意图是否符合预期。消耗 token 数较正常视频更少，使用成本更低。
|
||||
* false：关闭样片模式，正常生成一段视频。
|
||||
|
||||
:::tip
|
||||
开启样片模式后，将使用 480p 分辨率生成 Draft 视频（使用其他分辨率会报错），不支持返回尾帧功能，不支持离线推理功能。
|
||||
|
||||
:::
|
||||
---
|
||||
|
||||
|
||||
**tools==^new^==** ** ** `object[]`
|
||||
> 仅 Seedance 2.0 系列 支持
|
||||
|
||||
配置模型要调用的工具。
|
||||
|
||||
属性
|
||||
tools.**type ** `string`
|
||||
指定使用的工具类型。
|
||||
|
||||
* web_search：联网搜索工具。[阅读教程](https://www.volcengine.com/docs/82379/1366799?lang=zh#c40ed3ef) 获取详细代码示例。
|
||||
|
||||
:::tip
|
||||
|
||||
* 开启联网搜索后，模型会根据用户的提示词自主判断是否搜索互联网内容（如商品、天气等）。可提升生成视频的时效性，但也会增加一定的时延。
|
||||
* 实际搜索次数可通过 [查询视频生成任务 API](https://www.volcengine.com/docs/82379/1521309?lang=zh) 返回的 usage.tool_usage.**web_search** 字段获取，如果为 0 表示未搜索。
|
||||
|
||||
:::
|
||||
|
||||
---
|
||||
|
||||
|
||||
**safety_identifier==^new^==** `string`
|
||||
终端用户的唯一标识符，用于协助平台检测您的应用中可能违反火山方舟使用政策的用户。该标识符为英文字符串，需保证对单个用户固定且唯一，长度不超过 64 个字符。推荐传入对用户名、用户 ID 或邮箱进行哈希处理后生成的字符串，避免泄露用户隐私信息。
|
||||
|
||||
---
|
||||
|
||||
|
||||
|
||||
:::warning 部分参数升级说明
|
||||
|
||||
* **对于 resolution、ratio、duration、frames、seed、camera_fixed、watermark 参数，平台升级了参数传入方式，示例如下。所有模型依然兼容支持旧方式。**
|
||||
* 不同模型，可能对应支持不同的参数与取值，详见 [输出视频格式](https://www.volcengine.com/docs/82379/1366799?lang=zh#9fe4cce0)。当输入的参数或取值不符合所选的模型时，该参数将被忽略或触发报错：
|
||||
* 新方式：在 request body 中直接传入参数。此方式为**强校验，** 若参数填写错误，模型会返回错误提示。
|
||||
* 旧方式：在文本提示词后追加 \-\-[parameters]。此方式为**弱校验，** 若参数填写错误，该参数将被忽略或触发报错。
|
||||
|
||||
|
||||
:::
|
||||
**新方式（推荐）：在 request body 中直接传入参数**
|
||||
```JSON
|
||||
...
|
||||
// Specify the aspect ratio of the generated video as 16:9, duration as 5 seconds, resolution as 720p, seed as 11, and include a watermark. The camera is not fixed.
|
||||
"model": "doubao-seedance-1-5-pro-251215",
|
||||
"content": [
|
||||
{
|
||||
"type": "text",
|
||||
"text": "小猫对着镜头打哈欠"
|
||||
}
|
||||
],
|
||||
// All parameters must be written in full; abbreviations are not supported
|
||||
"resolution": "720p",
|
||||
"ratio":"16:9",
|
||||
"duration": 5,
|
||||
// "frames": 29, Either duration or frames is required
|
||||
"seed": 11,
|
||||
"camera_fixed": false,
|
||||
"watermark": true
|
||||
...
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
**旧方式：在文本提示词后追加 \-\-[parameters]**
|
||||
```JSON
|
||||
...
|
||||
// Specify the aspect ratio of the generated video as 16:9, duration as 5 seconds, resolution as 720p, seed as 11, and include a watermark. The camera is not fixed.
|
||||
"model": "doubao-seedance-1-5-pro-251215",
|
||||
"content": [
|
||||
{
|
||||
"type": "text",
|
||||
"text": "小猫对着镜头打哈欠 --rs 720p --rt 16:9 --dur 5 --seed 11 --cf false --wm true"
|
||||
// "text": "小猫对着镜头打哈欠 --resolution 720p --ratio 16:9 --duration 5 --seed 11 --camerafixed false --watermark true"
|
||||
}
|
||||
]
|
||||
...
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
||||
**resolution ** `string`
|
||||
> Seedance 2.0 系列、Seedance 1.5 pro 默认值：`720p`
|
||||
> Seedance 1.0 pro & pro\-fast 默认值：`1080p`
|
||||
|
||||
视频分辨率，枚举值：
|
||||
|
||||
* 480p
|
||||
* 720p
|
||||
* 1080p：Seedance 2.0 fast 不支持
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
||||
**ratio ** `string`
|
||||
> Seedance 2.0 系列、Seedance 1.5 pro 默认值为 `adaptive`
|
||||
> 其他模型：文生视频默认值 `16:9`，图生视频默认值 `adaptive`
|
||||
|
||||
生成视频的宽高比例。不同宽高比对应的宽高像素值见下方表格。
|
||||
|
||||
* 16:9
|
||||
* 4:3
|
||||
* 1:1
|
||||
* 3:4
|
||||
* 9:16
|
||||
* 21:9
|
||||
* adaptive：根据输入自动选择最合适的宽高比（详见下文说明）
|
||||
|
||||
:::warning **adaptive ** 适配规则
|
||||
当配置 **ratio** 为 `adaptive` 时，模型会根据生成场景自动适配宽高比；实际生成的视频宽高比可通过 [查询视频生成任务 API](https://www.volcengine.com/docs/82379/1521309?lang=zh) 返回的 **ratio** 字段获取。
|
||||
**支持模型：**
|
||||
|
||||
* Seedance 2.0 系列、Seedance 1.5 Pro 支持
|
||||
* 其他模型仅图生视频场景支持
|
||||
|
||||
**取值规则：**
|
||||
|
||||
* 文生视频：根据输入的提示词，智能选择最合适的宽高比。
|
||||
* 首帧 / 首尾帧生视频：根据上传的首帧图片比例，自动选择最接近的宽高比。
|
||||
* 多模态参考生视频：根据用户提示词意图判断，如果是首帧生视频/编辑视频/延长视频，以该图片/视频为准选择最接近的宽高比；否则，以传入的第一个媒体文件为准（优先级：视频＞图片）选择最接近的宽高比。
|
||||
|
||||
:::
|
||||
|
||||
|
||||
不同宽高比对应的宽高像素值
|
||||
Note：图生视频，选择的宽高比与您上传的图片宽高比不一致时，方舟会对您的图片进行裁剪，裁剪时会居中裁剪，详细规则见 [图片裁剪规则](https://www.volcengine.com/docs/82379/1366799?lang=zh#f76aafc8)。
|
||||
|
||||
|分辨率 |宽高比|宽高像素值|宽高像素值|\
|
||||
| | |Seedance 1.0 系列 |Seedance 1.5 pro|\
|
||||
| | | |Seedance 2.0 系列 |
|
||||
|---|---|---|---|
|
||||
|480p |16:9 |864×480 |864×496 |
|
||||
|^^|4:3 |736×544 |752×560 |
|
||||
|^^|1:1 |640×640 |640×640 |
|
||||
|^^|3:4 |544×736 |560×752 |
|
||||
|^^|9:16 |480×864 |496×864 |
|
||||
|^^|21:9 |960×416 |992×432 |
|
||||
|720p |16:9 |1248×704 |1280×720 |
|
||||
|^^|4:3 |1120×832 |1112×834 |
|
||||
|^^|1:1 |960×960 |960×960 |
|
||||
|^^|3:4 |832×1120 |834×1112 |
|
||||
|^^|9:16 |704×1248 |720×1280 |
|
||||
|^^|21:9 |1504×640 |1470×630 |
|
||||
|1080p |16:9 |1920×1088 |1920×1080 |\
|
||||
|> Seedance 2.0 fast 不支持 | | | |
|
||||
|^^|4:3 |1664×1248 |1664×1248 |
|
||||
|^^|1:1 |1440×1440 |1440×1440 |
|
||||
|^^|3:4 |1248×1664 |1248×1664 |
|
||||
|^^|9:16 |1088×1920 |1080×1920 |
|
||||
|^^|21:9 |2176×928 |2206×946 |
|
||||
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
||||
**duration** `integer` `默认值 5`
|
||||
> duration 和 frames 二选一即可，frames 的优先级高于 duration。如果您希望生成整数秒的视频，建议指定 duration。
|
||||
|
||||
生成视频时长，仅支持整数，单位：秒。
|
||||
|
||||
* Seedance 1.0 pro、Seedance 1.0 pro fast: [2, 12] s。
|
||||
* Seedance 1.5 pro: [4,12] 或设置为`-1`
|
||||
* Seedance 2.0 系列: [4,15] 或设置为`-1`
|
||||
|
||||
:::warning
|
||||
Seedance 2.0 系列、Seedance 1.5 pro 支持两种配置方法
|
||||
|
||||
* 指定具体时长：支持有效范围内的任一整数。
|
||||
* 智能指定：设置为 `-1`，表示由模型在有效范围内自主选择合适的视频长度（整数秒）。实际生成视频的时长可通过 [查询视频生成任务 API](https://www.volcengine.com/docs/82379/1521309?lang=zh) 返回的 **duration** 字段获取。注意视频时长与计费相关，请谨慎设置。
|
||||
|
||||
|
||||
:::
|
||||
---
|
||||
|
||||
|
||||
**frames** `integer`
|
||||
> Seedance 2.0 系列、Seedance 1.5 pro 暂不支持
|
||||
> duration 和 frames 二选一即可，frames 的优先级高于 duration。如果您希望生成小数秒的视频，建议指定 frames。
|
||||
|
||||
生成视频的帧数。通过指定帧数，可以灵活控制生成视频的长度，生成小数秒的视频。
|
||||
由于 frames 的取值限制，仅能支持有限小数秒，您需要根据公式推算最接近的帧数。
|
||||
|
||||
* 计算公式：帧数 = 时长 × 帧率（24）。
|
||||
* 取值范围：支持 [29, 289] 区间内所有满足 `25 + 4n` 格式的整数值，其中 n 为正整数。
|
||||
|
||||
例如：假设需要生成 2.4 秒的视频，帧数=2.4×24=57.6。由于 frames 不支持 57.6，此时您只能选择一个最接近的值。根据 25+4n 计算出最接近的帧数为 57，实际生成的视频为 57/24=2.375 秒。
|
||||
|
||||
---
|
||||
|
||||
|
||||
**seed** `integer` `默认值 -1`
|
||||
种子整数，用于控制生成内容的随机性。
|
||||
取值范围：[\-1, 2^32\-1]之间的整数。
|
||||
:::warning
|
||||
|
||||
* 相同的请求下，模型收到不同的seed值，如：不指定seed值或令seed取值为\-1（会使用随机数替代）、或手动变更seed值，将生成不同的结果。
|
||||
* 相同的请求下，模型收到相同的seed值，会生成类似的结果，但不保证完全一致。
|
||||
|
||||
|
||||
:::
|
||||
---
|
||||
|
||||
|
||||
**camera_fixed** `boolean` `默认值 false`
|
||||
> 参考图场景不支持，Seedance 2.0 系列 暂不支持
|
||||
|
||||
是否固定摄像头。枚举值：
|
||||
|
||||
* true：固定摄像头。平台会在用户提示词中追加固定摄像头，实际效果不保证。
|
||||
* false：不固定摄像头。
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
||||
**watermark** `boolean` `默认值 false`
|
||||
生成视频是否包含水印。枚举值：
|
||||
|
||||
* false：生成视频不含水印。
|
||||
* true：生成视频右下角会展示`AI 生成`水印。
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
||||
<span id="oCS1tULg"></span>
|
||||
## 响应参数
|
||||
> 跳转 [请求参数](#RxN8G2nH)
|
||||
|
||||
**id ** `string`
|
||||
视频生成任务 ID 。仅保存 7 天（从 **created at** 时间戳开始计算），超时后将自动清除。
|
||||
|
||||
* 设置`"draft": true`，为 Draft 视频任务 ID。
|
||||
* 设置 `"draft": false`，为正常视频任务 ID。
|
||||
|
||||
创建视频生成任务为异步接口，获取 ID 后，需要通过 [查询视频生成任务 API](https://www.volcengine.com/docs/82379/1521309) 来查询视频生成任务的状态。任务成功后，会输出生成视频的`video_url`。
|
||||
|
||||
|
||||
@@ -0,0 +1,50 @@
|
||||
`DELETE https://ark.cn-beijing.volces.com/api/v3/contents/generations/tasks/{id}` [运行](https://api.volcengine.com/api-explorer/?action=DeleteContentsGenerationsTasks&data=%7B%22id%22%3A%22cgt-20250331175019-68d9t%22%7D&groupName=%E8%A7%86%E9%A2%91%E7%94%9F%E6%88%90API&query=%7B%7D&serviceCode=ark&version=2024-01-01)
|
||||
取消排队中的视频生成任务，或者删除视频生成任务记录。
|
||||
|
||||
```mixin-react
|
||||
return (<Tabs>
|
||||
<Tabs.TabPane title="快速入口" key="vI631gwS"><RenderMd content={` [ ](#)[体验中心](https://console.volcengine.com/ark/region:ark+cn-beijing/experience/vision) <span> </span>[模型列表](https://www.volcengine.com/docs/82379/1330310) <span> </span>[模型计费](https://www.volcengine.com/docs/82379/1099320#%E8%A7%86%E9%A2%91%E7%94%9F%E6%88%90%E6%A8%A1%E5%9E%8B) <span> </span>[API Key](https://console.volcengine.com/ark/region:ark+cn-beijing/apiKey?apikey=%7B%7D)
|
||||
<span> </span>[调用教程](https://www.volcengine.com/docs/82379/1366799) <span> </span>[接口文档](https://www.volcengine.com/docs/82379/1521675) <span> </span>[常见问题](https://www.volcengine.com/docs/82379/1359411) <span> </span>[开通模型](https://console.volcengine.com/ark/region:ark+cn-beijing/openManagement?LLM=%7B%7D&OpenTokenDrawer=false)
|
||||
`}></RenderMd></Tabs.TabPane>
|
||||
<Tabs.TabPane title="鉴权说明" key="L8aMwmZD"><RenderMd content={`本接口支持 API Key 鉴权，详见[鉴权认证方式](https://www.volcengine.com/docs/82379/1298459)。
|
||||
`}></RenderMd></Tabs.TabPane></Tabs>);
|
||||
```
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
||||
<span id="RxN8G2nH"></span>
|
||||
## 请求参数
|
||||
> 跳转 [响应参数](#7mi8G8RI)
|
||||
|
||||
:::tip
|
||||
下面参数为Query String Parameters，在URL String中传入。
|
||||
|
||||
:::
|
||||
---
|
||||
|
||||
|
||||
**id** `string` %%require%%
|
||||
需要取消或者删除的视频生成任务。
|
||||
任务状态不同，调用`DELETE`接口，执行的操作有所不同，具体说明如下：
|
||||
|
||||
|当前任务状态 |是否支持DELETE操作 |操作含义 |DELETE操作后任务状态 |
|
||||
|---|---|---|---|
|
||||
|queued |是 |任务取消排队，任务状态被变更为cancelled。 |cancelled |
|
||||
|running |否 |\- |\- |
|
||||
|succeeded |是 |删除视频生成任务记录，后续将不支持查询。 |\- |
|
||||
|failed |是 |删除视频生成任务记录，后续将不支持查询。 |\- |
|
||||
|cancelled |否 |\- |\- |
|
||||
|expired |是 |删除视频生成任务记录，后续将不支持查询。 |\- |
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
||||
<span id="7mi8G8RI"></span>
|
||||
## 响应参数
|
||||
> 跳转 [请求参数](#RxN8G2nH)
|
||||
|
||||
本接口无返回参数。
|
||||
|
||||
@@ -0,0 +1,250 @@
|
||||
`GET https://ark.cn-beijing.volces.com/api/v3/contents/generations/tasks/{id}` [运行](https://api.volcengine.com/api-explorer/?action=GetContentsGenerationsTask&data=%7B%22id%22%3A%22cgt-20250331175019-68d9t%22%7D&groupName=%E8%A7%86%E9%A2%91%E7%94%9F%E6%88%90API&query=%7B%7D&serviceCode=ark&version=2024-01-01)
|
||||
查询视频生成任务的状态。
|
||||
:::tip
|
||||
仅支持查询最近 7 天的历史数据。时间计算统一采用UTC时间戳，返回的7天历史数据范围以用户实际发起查询请求的时刻为基准（精确到秒），时间戳区间为 [T\-7天, T)。
|
||||
|
||||
:::
|
||||
```mixin-react
|
||||
return (<Tabs>
|
||||
<Tabs.TabPane title="快速入口" key="fq9yXaKY"><RenderMd content={` [ ](#)[体验中心](https://console.volcengine.com/ark/region:ark+cn-beijing/experience/vision) <span> </span>[模型列表](https://www.volcengine.com/docs/82379/1330310) <span> </span>[模型计费](https://www.volcengine.com/docs/82379/1099320#%E8%A7%86%E9%A2%91%E7%94%9F%E6%88%90%E6%A8%A1%E5%9E%8B) <span> </span>[API Key](https://console.volcengine.com/ark/region:ark+cn-beijing/apiKey?apikey=%7B%7D)
|
||||
<span> </span>[调用教程](https://www.volcengine.com/docs/82379/1366799) <span> </span>[接口文档](https://www.volcengine.com/docs/82379/1521309) <span> </span>[常见问题](https://www.volcengine.com/docs/82379/1359411) <span> </span>[开通模型](https://console.volcengine.com/ark/region:ark+cn-beijing/openManagement?LLM=%7B%7D&OpenTokenDrawer=false)
|
||||
`}></RenderMd></Tabs.TabPane>
|
||||
<Tabs.TabPane title="鉴权说明" key="3vCxpwty"><RenderMd content={`本接口支持 API Key 鉴权，详见[鉴权认证方式](https://www.volcengine.com/docs/82379/1298459)。
|
||||
`}></RenderMd></Tabs.TabPane></Tabs>);
|
||||
```
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
||||
<span id="RxN8G2nH"></span>
|
||||
## 请求参数
|
||||
> 跳转 [响应参数](#7mi8G8RI)
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
||||
**id** `string` %%require%%
|
||||
您需要查询的视频生成任务的 ID 。
|
||||
:::tip
|
||||
上面参数为Query String Parameters，在URL String中传入。
|
||||
|
||||
:::
|
||||
---
|
||||
|
||||
|
||||
|
||||
<span id="7mi8G8RI"></span>
|
||||
## 响应参数
|
||||
> 跳转 [请求参数](#RxN8G2nH)
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
||||
**id ** `string`
|
||||
视频生成任务 ID 。
|
||||
|
||||
---
|
||||
|
||||
|
||||
**model** `string`
|
||||
任务使用的模型名称和版本，`模型名称-版本`。
|
||||
|
||||
---
|
||||
|
||||
|
||||
**status** `string`
|
||||
任务状态，以及相关的信息：
|
||||
|
||||
* `queued`：排队中。
|
||||
* `running`：任务运行中。
|
||||
* `cancelled`：取消任务，取消状态24h自动删除（只支持排队中状态的任务被取消）。
|
||||
* `succeeded`： 任务成功。
|
||||
* `failed`：任务失败。
|
||||
* `expired`：任务超时。
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
||||
**error** `object / null`
|
||||
错误提示信息，任务成功返回`null`，任务失败时返回错误数据，错误信息具体参见 [错误处理](https://www.volcengine.com/docs/82379/1299023#.5pa56Iif6ZSZ6K-v56CB)。
|
||||
|
||||
属性
|
||||
|
||||
---
|
||||
|
||||
|
||||
error.**code** `string`
|
||||
错误码。
|
||||
|
||||
---
|
||||
|
||||
|
||||
error.**message** `string`
|
||||
错误提示信息。
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
||||
**created_at** `integer`
|
||||
任务创建时间的 Unix 时间戳（秒）。
|
||||
|
||||
---
|
||||
|
||||
|
||||
**updated_at** `integer`
|
||||
任务当前状态更新时间的 Unix 时间戳（秒）。
|
||||
|
||||
---
|
||||
|
||||
|
||||
**content** `object`
|
||||
视频生成任务的输出内容。
|
||||
|
||||
属性
|
||||
|
||||
---
|
||||
|
||||
|
||||
content.**video_url** `string`
|
||||
生成视频的 URL，格式为 mp4。为保障信息安全，生成的视频会在24小时后被清理，请及时转存。
|
||||
推荐配置火山引擎 TOS 提供的数据订阅功能，将您的模型推理产物自动转存到自己的 TOS 桶中，便于长期备份或二次加工。详细介绍请参见 [TOS 数据订阅](https://www.volcengine.com/docs/6349/2280949?lang=zh)。
|
||||
content.**last_frame_url ** `string`
|
||||
视频的尾帧图像 URL。有效期为 24小时，请及时转存。
|
||||
说明：[创建视频生成任务](https://www.volcengine.com/docs/82379/1520757) 时设置 `"return_last_frame": true` 时，会返回该参数。
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
||||
**seed** `integer`
|
||||
本次请求使用的种子整数值。
|
||||
|
||||
---
|
||||
|
||||
|
||||
**resolution ** `string`
|
||||
生成视频的分辨率。
|
||||
|
||||
---
|
||||
|
||||
|
||||
**ratio ** `string`
|
||||
生成视频的宽高比。
|
||||
|
||||
---
|
||||
|
||||
|
||||
**duration** `integer`
|
||||
生成视频的时长，单位：秒。
|
||||
说明：**duration 和 frames 参数只会返回一个**。[创建视频生成任务](https://www.volcengine.com/docs/82379/1520757) 时未指定 frames，会返回 duration。
|
||||
|
||||
---
|
||||
|
||||
|
||||
**frames** `integer`
|
||||
生成视频的帧数。
|
||||
说明：**duration 和 frames 参数只会返回一个**。[创建视频生成任务](https://www.volcengine.com/docs/82379/1520757) 时指定了 frames，会返回 frames。
|
||||
|
||||
---
|
||||
|
||||
|
||||
**framespersecond** `integer`
|
||||
生成视频的帧率。
|
||||
|
||||
---
|
||||
|
||||
|
||||
**generate_audio** `boolean`
|
||||
生成的视频是否包含与画面同步的声音。仅 seedance 2.0 & 2.0 fast、seedance 1.5 pro 会返回该参数。
|
||||
|
||||
* `true`：模型输出的视频包含同步音频。
|
||||
* `false`：模型输出的视频为无声视频。
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
||||
**tools==^new^==** ** ** `object[]`
|
||||
本次请求模型实际使用的工具。未使用工具时不返回。
|
||||
|
||||
属性
|
||||
tools.**type ** `string`
|
||||
实际使用的工具类型
|
||||
|
||||
* web_search：联网搜索工具。
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
||||
**safety_identifier==^new^==** `string`
|
||||
终端用户的唯一标识符。若 [创建视频生成任务](https://www.volcengine.com/docs/82379/1520757) 时设置了该参数，接口会原样返回此信息。
|
||||
|
||||
---
|
||||
|
||||
|
||||
**draft** `boolean`
|
||||
生成的视频是否为 Draft 视频。仅 seedance 1.5 pro 会返回该参数。
|
||||
|
||||
* `true`：表示当前输出为 Draft 视频。
|
||||
* `false`：表示当前输出为正常视频。
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
||||
**draft_task_id ** `string`
|
||||
Draft 视频任务 ID。基于 Draft 视频生成正式视频时，会返回该参数。
|
||||
|
||||
---
|
||||
|
||||
|
||||
**service_tier ** `string`
|
||||
实际处理任务使用的服务等级。
|
||||
|
||||
---
|
||||
|
||||
|
||||
**execution_expires_after** ** ** `integer`
|
||||
任务超时阈值，单位：秒。
|
||||
|
||||
---
|
||||
|
||||
|
||||
**usage** `object`
|
||||
本次请求的 token 用量。
|
||||
|
||||
属性
|
||||
|
||||
---
|
||||
|
||||
|
||||
usage.**completion_tokens** `integer`
|
||||
模型输出视频花费的 token 数量，可作为计费对账依据。
|
||||
:::tip
|
||||
seedance 2.0 系列模型存在最低 token 用量限制，如果实际 token 用量 ＜ 最低 token 用量，本字段会返回最低 token 用量，平台按最低 token 用量计费。
|
||||
|
||||
:::
|
||||
---
|
||||
|
||||
|
||||
usage.**total_tokens** `integer`
|
||||
本次请求消耗的总 token 数量。视频生成模型不统计输入 token，输入 token 为 0，故 **total_tokens**=**completion_tokens**。
|
||||
|
||||
---
|
||||
|
||||
|
||||
usage.**tool_usage==^new^==** ** ** `object`
|
||||
使用工具的用量信息。
|
||||
|
||||
属性
|
||||
usage.tool_usage.**web_search ** `integer`
|
||||
实际调用联网搜索工具的次数，仅开启联网搜索时返回。
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,308 @@
|
||||
`GET https://ark.cn-beijing.volces.com/api/v3/contents/generations/tasks?page_num={page_num}&page_size={page_size}&filter.status={filter.status}&filter.task_ids={filter.task_ids}&filter.model={filter.model}` [运行](https://api.volcengine.com/api-explorer/?action=ListContentsGenerationsTasks&data=%7B%7D&groupName=%E8%A7%86%E9%A2%91%E7%94%9F%E6%88%90API&query=%7B%7D&serviceCode=ark&version=2024-01-01)
|
||||
当您要查询符合条件的任务，您可以传入条件筛选参数，返回符合要求的任务。
|
||||
:::tip
|
||||
仅支持查询最近 7 天的历史数据。时间计算统一采用UTC时间戳，返回的7天历史数据范围以用户实际发起批量查询请求的时刻为基准（精确到秒），时间戳区间为 [T\-7天, T)。
|
||||
|
||||
:::
|
||||
```mixin-react
|
||||
return (<Tabs>
|
||||
<Tabs.TabPane title="快速入口" key="opV4RT2k"><RenderMd content={` [ ](#)[体验中心](https://console.volcengine.com/ark/region:ark+cn-beijing/experience/vision) <span> </span>[模型列表](https://www.volcengine.com/docs/82379/1330310) <span> </span>[模型计费](https://www.volcengine.com/docs/82379/1099320#%E8%A7%86%E9%A2%91%E7%94%9F%E6%88%90%E6%A8%A1%E5%9E%8B) <span> </span>[API Key](https://console.volcengine.com/ark/region:ark+cn-beijing/apiKey?apikey=%7B%7D)
|
||||
<span> </span>[调用教程](https://www.volcengine.com/docs/82379/1366799) <span> </span>[接口文档](https://www.volcengine.com/docs/82379/1521675) <span> </span>[常见问题](https://www.volcengine.com/docs/82379/1359411) <span> </span>[开通模型](https://console.volcengine.com/ark/region:ark+cn-beijing/openManagement?LLM=%7B%7D&OpenTokenDrawer=false)
|
||||
`}></RenderMd></Tabs.TabPane>
|
||||
<Tabs.TabPane title="鉴权说明" key="CPeW5vNl"><RenderMd content={`本接口支持 API Key 鉴权，详见[鉴权认证方式](https://www.volcengine.com/docs/82379/1298459)。
|
||||
`}></RenderMd></Tabs.TabPane></Tabs>);
|
||||
```
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
||||
<span id="RxN8G2nH"></span>
|
||||
## 请求参数
|
||||
> 跳转 [响应参数](#7mi8G8RI)
|
||||
|
||||
:::tip
|
||||
下面参数为Query String Parameters，在URL String中传入。
|
||||
|
||||
:::
|
||||
---
|
||||
|
||||
|
||||
**page_num** `integer / null`
|
||||
取值范围：[1, 500]
|
||||
返回结果的页码。
|
||||
|
||||
---
|
||||
|
||||
|
||||
**page_size ** `integer / null`
|
||||
取值范围：[1, 500]
|
||||
返回结果的每页的结果数量。
|
||||
|
||||
---
|
||||
|
||||
|
||||
**filter.status ** `string / null`
|
||||
过滤参数，查询某个任务状态。
|
||||
|
||||
* `queued`：排队中的任务。
|
||||
* `running`：运行中任务。
|
||||
* `cancelled`：取消的任务。
|
||||
* `succeeded`： 成功的任务。
|
||||
* `failed`：失败的任务。
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
||||
**filter.task_ids ** `string[] / null`
|
||||
视频生成任务 ID，精确搜索，支持同时搜索多个任务 ID。多个任务 ID 之间通过 `&`连接。示例：`filter.task_ids=id1&filter.task_ids=id2`。
|
||||
|
||||
---
|
||||
|
||||
|
||||
**filter.model ** `string / null`
|
||||
与返回参数不同，该字段为任务使用的推理接入点 ID，精确搜索。
|
||||
|
||||
---
|
||||
|
||||
|
||||
**filter.service_tier ** `string / null` `默认值 default`
|
||||
处理任务使用的服务等级。
|
||||
|
||||
* `default`：在线推理模式
|
||||
* `flex`：离线推理模式
|
||||
|
||||
<span id="7mi8G8RI"></span>
|
||||
## 响应参数
|
||||
> 跳转 [请求参数](#RxN8G2nH)
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
||||
**items ** `object[]`
|
||||
查询到的视频生成任务列表。
|
||||
|
||||
属性
|
||||
|
||||
---
|
||||
|
||||
|
||||
items.**id ** `string`
|
||||
视频生成任务 ID 。
|
||||
|
||||
---
|
||||
|
||||
|
||||
items.**model** `string`
|
||||
任务使用的模型名称和版本，`模型名称-版本`。
|
||||
|
||||
---
|
||||
|
||||
|
||||
items.**status** `string`
|
||||
任务状态，以及相关的信息：
|
||||
|
||||
* `queued`：排队中。
|
||||
* `running`：任务运行中。
|
||||
* `cancelled`：取消任务（只支持排队中状态的任务被取消）。
|
||||
* `succeeded`： 任务成功。
|
||||
* `failed`：任务失败。
|
||||
* `expired`：任务超时。
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
||||
items.**error** `object / null`
|
||||
错误提示信息，任务成功返回`null`，任务失败时返回错误数据，错误信息具体参见 [错误处理](https://www.volcengine.com/docs/82379/1393047#653d2c40)。
|
||||
|
||||
属性
|
||||
|
||||
---
|
||||
|
||||
|
||||
error.**code** `string`
|
||||
错误码。
|
||||
|
||||
---
|
||||
|
||||
|
||||
error.**message** `string`
|
||||
错误提示信息。
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
||||
items.**created_at** `integer`
|
||||
任务创建时间的 Unix 时间戳（秒）。
|
||||
|
||||
---
|
||||
|
||||
|
||||
items.**updated_at** `integer`
|
||||
任务当前状态更新时间的 Unix 时间戳（秒）。
|
||||
|
||||
---
|
||||
|
||||
|
||||
items.**content** `object`
|
||||
当视频生成任务完成，会输出该字段，包含生成视频下载的 URL。
|
||||
|
||||
属性
|
||||
|
||||
---
|
||||
|
||||
|
||||
content.**video_url** `string`
|
||||
生成视频的URL。为保障信息安全，生成的视频会在24小时后被清理，请及时转存。
|
||||
|
||||
---
|
||||
|
||||
|
||||
content.**last_frame_url ** `string`
|
||||
视频的尾帧图像 URL。有效期为 24小时，请及时转存。
|
||||
说明：[创建视频生成任务](https://www.volcengine.com/docs/82379/1520757) 时设置 `"return_last_frame": true` 时，会返回参数。
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
||||
items.**seed** `integer`
|
||||
本次请求使用的种子整数值。
|
||||
|
||||
---
|
||||
|
||||
|
||||
items.**resolution ** `string`
|
||||
生成视频的分辨率。
|
||||
|
||||
---
|
||||
|
||||
|
||||
items.**ratio ** `string`
|
||||
生成视频的宽高比。
|
||||
|
||||
---
|
||||
|
||||
|
||||
items.**duration** `integer`
|
||||
生成视频的时长，单位：秒。
|
||||
说明：**duration 和 frames 参数只会返回一个**。[创建视频生成任务](https://www.volcengine.com/docs/82379/1520757) 时未指定 frames，会返回 duration。
|
||||
|
||||
---
|
||||
|
||||
|
||||
items.**frames ** `integer`
|
||||
生成视频的帧数。
|
||||
说明：**duration 和 frames 参数只会返回一个**。[创建视频生成任务](https://www.volcengine.com/docs/82379/1520757) 时指定了 frames，会返回 frames。
|
||||
|
||||
---
|
||||
|
||||
|
||||
items.**framespersecond** `integer`
|
||||
生成视频的帧率。
|
||||
|
||||
---
|
||||
|
||||
|
||||
items.**generate_audio** `boolean`
|
||||
生成的视频是否包含与画面同步的声音。仅 Seedance 2.0 系列、Seedance 1.5 pro 会返回该参数。
|
||||
|
||||
* `true`：模型输出的视频包含同步音频。
|
||||
* `false`：模型输出的视频为无声视频。
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
||||
items.**tools==^new^==** ** ** `object[]`
|
||||
本次请求模型实际使用的工具。未使用工具时不返回。
|
||||
|
||||
属性
|
||||
items.tools.**type ** `string`
|
||||
实际使用的工具类型
|
||||
|
||||
* web_search：联网搜索工具。
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
||||
items.**safety_identifier==^new^==** `string`
|
||||
终端用户的唯一标识符。若 [创建视频生成任务](https://www.volcengine.com/docs/82379/1520757) 时设置了该参数，接口会原样返回此信息。
|
||||
|
||||
---
|
||||
|
||||
|
||||
items.**draft** `boolean`
|
||||
生成的视频是否为 Draft 视频。仅 Seedance 1.5 pro 会返回该参数。
|
||||
|
||||
* `true`：表示当前输出为 Draft 视频。
|
||||
* `false`：表示当前输出为正常视频。
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
||||
items.**draft_task_id ** `string`
|
||||
Draft 视频任务 ID。基于 Draft 视频生成正式视频时，会返回该参数。
|
||||
|
||||
---
|
||||
|
||||
|
||||
items.**service_tier ** `string`
|
||||
实际处理任务使用的服务等级。
|
||||
|
||||
---
|
||||
|
||||
|
||||
items.**execution_expires_after** ** ** `integer`
|
||||
任务超时阈值，单位：秒。
|
||||
|
||||
---
|
||||
|
||||
|
||||
items.**usage** `object`
|
||||
本次请求的 token 用量。
|
||||
|
||||
属性
|
||||
|
||||
---
|
||||
|
||||
|
||||
items.usage.**completion_tokens** `integer`
|
||||
模型输出视频花费的 token 数量，可作为计费对账依据。
|
||||
:::tip
|
||||
Seedance 2.0 系列模型存在最低 token 用量限制，如果实际 token 用量 ＜ 最低 token 用量，本字段会返回最低 token 用量，平台按最低 token 用量计费。
|
||||
|
||||
:::
|
||||
---
|
||||
|
||||
|
||||
items.usage.**total_tokens**`integer`
|
||||
本次请求消耗的总 token 数量。视频生成模型不统计输入 token，输入 token 为 0，故 **total_tokens**=**completion_tokens**。
|
||||
|
||||
---
|
||||
|
||||
|
||||
items.usage.**tool_usage==^new^==** ** ** `object`
|
||||
使用工具的用量信息。
|
||||
|
||||
属性
|
||||
items.usage.tool_usage.**web_search ** `integer`
|
||||
实际调用联网搜索工具的次数，仅开启联网搜索时返回。
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
||||
**total ** `integer`
|
||||
符合筛选条件的任务数量。
|
||||
|
||||
|
||||
File diff suppressed because it is too large.
Load diff
@@ -0,0 +1,570 @@
|
||||
`POST https://ark.cn-beijing.volces.com/api/v3/images/generations` [运行](https://api.volcengine.com/api-explorer/?action=ImageGenerations&groupName=%E5%9B%BE%E7%89%87%E7%94%9F%E6%88%90API&serviceCode=ark&version=2024-01-01&tab=2#N4IgTgpgzgDg9gOyhA+gMzmAtgQwC4gBcIArmADYgA0IUAlgF4REgBMA0tSAO74TY4wAayJoc5ZDSxwAJhErEZcEgCMccALTIIMyDiwaALBoAMG1gFYTADlbWuMMHCwwCxQPhmgUTTA-l6Ao2MAw-4CLeYB4tkHBgDOJgE2KgF+KgABygGHxgNf6gPSmgN2egCwegHEegCFugLCagCfKgOhKgGbx-oBFRoBjkYCTkZGA34qA2Ur+gKyugI76gOSagOJO-oDU5oCnpoBHphWA+Ib+gBVKI4Cf2oAr1oBOQf5wAMaATHaAy+b+gJKKgP1+gL-xgFRxY4CABoCEVoBTPv6A9maAj7b+gKGxgA3OgHnagNxygJJy-peAuyH+gNyugEbpgFgJgHH4wBjfoBvQOygAY5QAz2tkZoBLfUAQjqAQmtAIoagAIEp6AZXlAHBygC51c7+QAUsUNAPjuD38gHSzQKAOYzADMB52y6xagAlTQA55oBSELR0UA2DaAF7V-IAXU0xgB9FQDuioAvIMA9OaAbz1AM8GI0AHJqAAn1soB-PUAS5GAeASKmz-IAAAPW-kAs8qAEB1-IBA80AL4GMlr+QBc+oBUfUagDwVQA2aiAAL5AA)
|
||||
本文介绍图片生成模型如 Seedream 5.0 lite 的调用 API ，包括输入输出参数，取值范围，注意事项等信息，供您使用接口时查阅字段含义。
|
||||
|
||||
**不同模型支持的图片生成能力简介**
|
||||
|
||||
* **doubao seedream 5.0 lite==^new^==** **、doubao seedream 4.5/4.0**
|
||||
* 生成组图（组图：基于您输入的内容，生成的一组内容关联的图片；需配置 **sequential_image_generation ** 为`auto` **）**
|
||||
* 多图生组图，根据您输入的 **++多张参考图片（2\-14）++ ** +++文本提示词++ 生成一组内容关联的图片（输入的参考图数量+最终生成的图片数量≤15张）。
|
||||
* 单图生组图，根据您输入的 ++单张参考图片+文本提示词++ 生成一组内容关联的图片（最多生成14张图片）。
|
||||
* 文生组图，根据您输入的 ++文本提示词++ 生成一组内容关联的图片（最多生成15张图片）。
|
||||
* 生成单图（配置 **sequential_image_generation ** 为`disabled` **）**
|
||||
* 多图生图，根据您输入的 **++多张参考图片（2\-14）++ ** +++文本提示词++ 生成单张图片。
|
||||
* 单图生图，根据您输入的 ++单张参考图片+文本提示词++ 生成单张图片。
|
||||
* 文生图，根据您输入的 ++文本提示词++ 生成单张图片。
|
||||
|
||||
|
||||
|
||||
```mixin-react
|
||||
return (<Tabs>
|
||||
<Tabs.TabPane title="鉴权说明" key="oOTdY3Sn"><RenderMd content={`本接口仅支持 API Key 鉴权，请在 [获取 API Key](https://console.volcengine.com/ark/region:ark+cn-beijing/apiKey) 页面，获取长效 API Key。
|
||||
`}></RenderMd></Tabs.TabPane>
|
||||
<Tabs.TabPane title="快速入门" key="HHCpvO5jKo"><RenderMd content={` [ ](#)[体验中心](https://console.volcengine.com/ark/region:ark+cn-beijing/experience/vision?type=GenImage) <span> </span>[模型列表](https://www.volcengine.com/docs/82379/1330310?lang=zh#9df4d9fd) <span> </span>[模型计费](https://www.volcengine.com/docs/82379/1544106?lang=zh#457edfd0) <span> </span>[API Key](https://console.volcengine.com/ark/region:ark+cn-beijing/apiKey?apikey=%7B%7D)
|
||||
<span> </span>[调用教程](https://www.volcengine.com/docs/82379/1548482) <span> </span>[接口文档](https://www.volcengine.com/docs/82379/1666945) <span> </span>[常见问题](https://www.volcengine.com/docs/82379/1359411) <span> </span>[开通模型](https://console.volcengine.com/ark/region:ark+cn-beijing/openManagement?LLM=%7B%7D&OpenTokenDrawer=false)
|
||||
`}></RenderMd></Tabs.TabPane></Tabs>);
|
||||
```
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
||||
<span id="7thx2dVa"></span>
|
||||
## 请求参数
|
||||
<span id="BFVUvDi6"></span>
|
||||
### 请求体
|
||||
|
||||
---
|
||||
|
||||
|
||||
**model** `string` %%require%%
|
||||
您需要调用的模型的 ID （Model ID），[开通模型服务](https://console.volcengine.com/ark/region:ark+cn-beijing/openManagement?LLM=%7B%7D&OpenTokenDrawer=false)，并[查询 Model ID](https://www.volcengine.com/docs/82379/1330310?lang=zh#9df4d9fd) 。
|
||||
您也可通过 Endpoint ID 来调用模型，获得限流、计费类型（前付费/后付费）、运行状态查询、监控、安全等高级能力，可参考[获取 Endpoint ID](https://www.volcengine.com/docs/82379/1099522)。
|
||||
|
||||
---
|
||||
|
||||
|
||||
**prompt ** `string` %%require%%
|
||||
用于生成图像的提示词，支持中英文。（查看提示词指南：[Seedream 4.0-5.0 提示词指南](https://www.volcengine.com/docs/82379/1829186)）
|
||||
建议不超过300个汉字或600个英文单词。字数过多信息容易分散，模型可能因此忽略细节，只关注重点，造成图片缺失部分元素。
|
||||
|
||||
---
|
||||
|
||||
|
||||
**image** `string/array`
|
||||
输入的图片信息，支持 URL 或 Base64 编码。其中，doubao\-seedream\-5.0\-lite/4.5/4.0 支持单图或多图输入（[查看多图融合示例](https://www.volcengine.com/docs/82379/1824121?lang=zh#4a35e28f)）。
|
||||
|
||||
* 图片URL：请确保图片URL可被访问。
|
||||
* Base64编码：请遵循此格式`data:image/<图片格式>;base64,<Base64编码>`。注意 `<图片格式>` 需小写，如 `data:image/png;base64,<base64_image>`。
|
||||
|
||||
:::tip
|
||||
|
||||
* 传入单张图片要求：
|
||||
* 图片格式：jpeg、png（doubao\-seedream\-5.0\-lite/4.5/4.0 模型新增支持 webp、bmp、tiff、gif、heic、heif 格式**==^new^==**）
|
||||
* 宽高比（宽/高）范围：
|
||||
* [1/16, 16] (适用模型：doubao\-seedream\-5.0\-lite/4.5/4.0）
|
||||
* 宽高长度（px） \> 14
|
||||
* 大小：不超过 30MB
|
||||
* 总像素：不超过 `6000x6000=36000000` px （对单张图宽度和高度的像素乘积限制，而不是对宽度或高度的单独值进行限制）
|
||||
* doubao\-seedream\-5.0\-lite/4.5/4.0 最多支持传入 14 张参考图。
|
||||
|
||||
|
||||
:::
|
||||
---
|
||||
|
||||
|
||||
**size ** `string`
|
||||
|
||||
```mixin-react
|
||||
return (<Tabs>
|
||||
<Tabs.TabPane title="doubao-seedream-5.0-lite" key="BMB6AP1M"><RenderMd content={`指定生成图像的尺寸信息，支持以下两种方式，不可混用。
|
||||
|
||||
* 方式 1 | 指定生成图像的分辨率，并在prompt中用自然语言描述图片宽高比、图片形状或图片用途，最终由模型判断生成图片的大小。
|
||||
* 可选值：\`2K\`、\`3K\`、\`4K\`
|
||||
* 方式 2 | 指定生成图像的宽高像素值：
|
||||
* 默认值：\`2048x2048\`
|
||||
* 总像素取值范围：[\`2560x1440=3686400\`, \`4096x4096=16777216\`]
|
||||
* 宽高比取值范围：[1/16, 16]
|
||||
|
||||
:::tip
|
||||
采用方式 2 时，需同时满足总像素取值范围和宽高比取值范围。其中，总像素是对单张图宽度和高度的像素乘积限制，而不是对宽度或高度的单独值进行限制。
|
||||
|
||||
* **有效示例**：\`3750x1250\`
|
||||
|
||||
总像素值 3750x1250=4687500，符合 [3686400, 16777216] 的区间要求；宽高比 3750/1250=3，符合 [1/16, 16] 的区间要求，故该示例值有效。
|
||||
|
||||
* **无效示例**：\`1500x1500\`
|
||||
|
||||
总像素值 1500x1500=2250000，未达到 3686400 的最低要求；宽高 1500/1500=1，虽符合 [1/16, 16] 的区间要求，但因其未同时满足两项限制，故该示例值无效。
|
||||
:::
|
||||
推荐的宽高像素值：
|
||||
|
||||
|分辨率 |宽高比 |宽高像素值 |
|
||||
|---|---|---|
|
||||
|<div style="text-align: center">|1:1 |2048x2048 |\\
|
||||
|2K</div>| | |\\
|
||||
| | | |
|
||||
|^^|4:3 |2304x1728 |
|
||||
|^^|3:4 |1728x2304 |
|
||||
|^^|16:9 |2848x1600 |
|
||||
|^^|9:16 |1600x2848 |
|
||||
|^^|3:2 |2496x1664 |
|
||||
|^^|2:3 |1664x2496 |
|
||||
|^^|21:9 |3136x1344 |
|
||||
|<div style="text-align: center">|1:1 |3072x3072 |\\
|
||||
|3K</div>| | |\\
|
||||
| | | |
|
||||
|^^|4:3 |3456x2592 |
|
||||
|^^|3:4 |2592x3456 |
|
||||
|^^|16:9 |4096x2304 |
|
||||
|^^|9:16 |2304x4096 |
|
||||
|^^|2:3 |2496x3744 |
|
||||
|^^|3:2 |3744x2496 |
|
||||
|^^|21:9 |4704x2016 |
|
||||
|<div style="text-align: center">|1:1 |4096x4096 |\\
|
||||
|4K</div>| | |\\
|
||||
| | | |
|
||||
|^^|3:4 |3520x4704 |
|
||||
|^^|4:3 |4704x3520 |
|
||||
|^^|16:9 |5504x3040 |
|
||||
|^^|9:16 |3040x5504 |
|
||||
|^^|2:3 |3328x4992 |
|
||||
|^^|3:2 |4992x3328 |
|
||||
|^^|21:9 |6240x2656 |
|
||||
|
||||
|
||||
`}></RenderMd></Tabs.TabPane>
|
||||
<Tabs.TabPane title="doubao-seedream-4.5" key="kghENadO"><RenderMd content={`指定生成图像的尺寸信息，支持以下两种方式，不可混用。
|
||||
|
||||
* 方式 1 | 指定生成图像的分辨率，并在prompt中用自然语言描述图片宽高比、图片形状或图片用途，最终由模型判断生成图片的大小。
|
||||
* 可选值：\`2K\`、\`4K\`
|
||||
* 方式 2 | 指定生成图像的宽高像素值：
|
||||
* 默认值：\`2048x2048\`
|
||||
* 总像素取值范围：[\`2560x1440=3686400\`, \`4096x4096=16777216\`]
|
||||
* 宽高比取值范围：[1/16, 16]
|
||||
|
||||
:::tip
|
||||
采用方式 2 时，需同时满足总像素取值范围和宽高比取值范围。其中，总像素是对单张图宽度和高度的像素乘积限制，而不是对宽度或高度的单独值进行限制。
|
||||
|
||||
* **有效示例**：\`3750x1250\`
|
||||
|
||||
总像素值 3750x1250=4687500，符合 [3686400, 16777216] 的区间要求；宽高比 3750/1250=3，符合 [1/16, 16] 的区间要求，故该示例值有效。
|
||||
|
||||
* **无效示例**：\`1500x1500\`
|
||||
|
||||
总像素值 1500x1500=2250000，未达到 3686400 的最低要求；宽高 1500/1500=1，虽符合 [1/16, 16] 的区间要求，但因其未同时满足两项限制，故该示例值无效。
|
||||
:::
|
||||
推荐的宽高像素值：
|
||||
|
||||
|分辨率 |宽高比 |宽高像素值 |
|
||||
|---|---|---|
|
||||
|<div style="text-align: center">|1:1 |2048x2048 |\\
|
||||
|2K</div>| | |\\
|
||||
| | | |
|
||||
|^^|4:3 |2304x1728 |
|
||||
|^^|3:4 |1728x2304 |
|
||||
|^^|16:9 |2848x1600 |
|
||||
|^^|9:16 |1600x2848 |
|
||||
|^^|3:2 |2496x1664 |
|
||||
|^^|2:3 |1664x2496 |
|
||||
|^^|21:9 |3136x1344 |
|
||||
|<div style="text-align: center">|1:1 |4096x4096 |\\
|
||||
|4K</div>| | |\\
|
||||
| | | |
|
||||
|^^|3:4 |3520x4704 |
|
||||
|^^|4:3 |4704x3520 |
|
||||
|^^|16:9 |5504x3040 |
|
||||
|^^|9:16 |3040x5504 |
|
||||
|^^|2:3 |3328x4992 |
|
||||
|^^|3:2 |4992x3328 |
|
||||
|^^|21:9 |6240x2656 |
|
||||
|
||||
|
||||
`}></RenderMd></Tabs.TabPane>
|
||||
<Tabs.TabPane title="doubao-seedream-4.0" key="MKsftGMr"><RenderMd content={`指定生成图像的尺寸信息，支持以下两种方式，不可混用。
|
||||
|
||||
* 方式 1 | 指定生成图像的分辨率，并在prompt中用自然语言描述图片宽高比、图片形状或图片用途，最终由模型判断生成图片的大小。
|
||||
* 可选值：\`1K\`、\`2K\`、\`4K\`
|
||||
* 方式 2 | 指定生成图像的宽高像素值：
|
||||
* 默认值：\`2048x2048\`
|
||||
* 总像素取值范围：[\`1280x720=921600\`, \`4096x4096=16777216\`]
|
||||
* 宽高比取值范围：[1/16, 16]
|
||||
|
||||
:::tip
|
||||
采用方式 2 时，需同时满足总像素取值范围和宽高比取值范围。其中，总像素是对单张图宽度和高度的像素乘积限制，而不是对宽度或高度的单独值进行限制。
|
||||
|
||||
* **有效示例**：\`1600x600\`
|
||||
|
||||
总像素值 1600x600=960000，符合 [921600, 16777216] 的区间要求；宽高比 1600/600=8/3，符合 [1/16, 16] 的区间要求，故该示例值有效。
|
||||
|
||||
* **无效示例**：\`800x800\`
|
||||
|
||||
总像素值 800x800=640000，未达到 921600 的最低要求；宽高 800/800=1，虽符合 [1/16, 16] 的区间要求，但因其未同时满足两项限制，故该示例值无效。
|
||||
:::
|
||||
推荐的宽高像素值：
|
||||
|
||||
|分辨率 |宽高比 |宽高像素值 |
|
||||
|---|---|---|
|
||||
|<div style="text-align: center">|1:1 |1024x1024 |\\
|
||||
|1K</div>| | |\\
|
||||
| | | |
|
||||
|^^|4:3 |1152x864 |
|
||||
|^^|3:4 |864x1152 |
|
||||
|^^|16:9 |1280x720 |
|
||||
|^^|9:16 |720x1280 |
|
||||
|^^|3:2 |1248x832 |
|
||||
|^^|2:3 |832x1248 |
|
||||
|^^|21:9 |1512x648 |
|
||||
|<div style="text-align: center">|1:1 |2048x2048 |\\
|
||||
|2K</div>| | |\\
|
||||
| | | |
|
||||
|^^|4:3 |2304x1728 |
|
||||
|^^|3:4 |1728x2304 |
|
||||
|^^|16:9 |2848x1600 |
|
||||
|^^|9:16 |1600x2848 |
|
||||
|^^|3:2 |2496x1664 |
|
||||
|^^|2:3 |1664x2496 |
|
||||
|^^|21:9 |3136x1344 |
|
||||
|<div style="text-align: center">|1:1 |4096x4096 |\\
|
||||
|4K</div>| | |\\
|
||||
| | | |
|
||||
|^^|3:4 |3520x4704 |
|
||||
|^^|4:3 |4704x3520 |
|
||||
|^^|16:9 |5504x3040 |
|
||||
|^^|9:16 |3040x5504 |
|
||||
|^^|2:3 |3328x4992 |
|
||||
|^^|3:2 |4992x3328 |
|
||||
|^^|21:9 |6240x2656 |
|
||||
|
||||
|
||||
`}></RenderMd></Tabs.TabPane>
|
||||
<Tabs.TabPane title="doubao-seedream-3.0-t2i" key="dUuqsxPhNL"><RenderMd content={`指定生成图像的宽高像素值。
|
||||
|
||||
* 默认值：\`1024x1024\`
|
||||
* 单张图片像素取值范围： [\`512x512\`, \`2048x2048\`]
|
||||
|
||||
推荐的宽高像素值：
|
||||
|
||||
|宽高比 |宽高像素值 |
|
||||
|---|---|
|
||||
|1:1 |1024x1024 |
|
||||
|4:3 |864x1152 |
|
||||
|3:4 |1152x864 |
|
||||
|16:9 |1280x720 |
|
||||
|9:16 |720x1280 |
|
||||
|3:2 |832x1248 |
|
||||
|2:3 |1248x832 |
|
||||
|21:9 |1512x648 |
|
||||
|
||||
`}></RenderMd></Tabs.TabPane></Tabs>);
|
||||
```
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
||||
**sequential_image_generation** `string` `默认值 disabled`
|
||||
> 仅 doubao\-seedream\-5.0\-lite/4.5/4.0 支持该参数 | [查看组图输出示例](https://www.volcengine.com/docs/82379/1824121?lang=zh#fc9f85e4)
|
||||
|
||||
控制是否关闭组图功能。
|
||||
:::tip
|
||||
组图：基于您输入的内容，生成的一组内容关联的图片。
|
||||
|
||||
:::
|
||||
* `auto`：自动判断模式，模型会根据用户提供的提示词自主判断是否返回组图以及组图包含的图片数量。
|
||||
* `disabled`：关闭组图功能，模型只会生成一张图。
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
||||
**sequential_image_generation_options ** `object`
|
||||
> 仅 doubao\-seedream\-5.0\-lite/4.5/4.0 支持该参数
|
||||
|
||||
组图功能的配置。仅当 **sequential_image_generation ** 为 `auto` 时生效。
|
||||
|
||||
属性
|
||||
|
||||
---
|
||||
|
||||
|
||||
sequential_image_generation_options.**max_images ** ** ** `integer` `默认值 15`
|
||||
指定本次请求，最多可生成的图片数量。
|
||||
|
||||
* 取值范围： [1, 15]
|
||||
|
||||
:::tip
|
||||
实际可生成的图片数量，除受到 **max_images ** 影响外 **，** 还受到输入的参考图数量影响。**输入的参考图数量+最终生成的图片数量≤15张**。
|
||||
|
||||
:::
|
||||
|
||||
---
|
||||
|
||||
|
||||
**tools==^new^==** ** ** `array of object`
|
||||
> 仅 doubao\-seedream\-5.0\-lite 支持该参数
|
||||
|
||||
配置模型要调用的工具。
|
||||
|
||||
属性
|
||||
|
||||
---
|
||||
|
||||
|
||||
tools.**type ** `string`
|
||||
指定使用的工具类型。
|
||||
|
||||
* `web_search`：联网搜索功能。
|
||||
|
||||
:::tip
|
||||
|
||||
* 开启联网搜索后，模型会根据用户的提示词自主判断是否搜索互联网内容（如商品、天气等），提升生成图片的时效性，但也会增加一定的时延。
|
||||
* 实际搜索次数可通过字段 usage.tool_usage.**web_search** 查询，如果为 0 表示未搜索。
|
||||
|
||||
:::
|
||||
|
||||
---
|
||||
|
||||
|
||||
**stream** `Boolean` `默认值 false`
|
||||
> 仅 doubao\-seedream\-5.0\-lite/4.5/4.0 支持该参数 | [查看流式输出示例](https://www.volcengine.com/docs/82379/1824121?lang=zh#e5bef0d7)
|
||||
|
||||
控制是否开启流式输出模式。
|
||||
|
||||
* `false`：非流式输出模式，等待所有图片全部生成结束后再一次性返回所有信息。
|
||||
* `true`：流式输出模式，即时返回每张图片输出的结果。在生成单图和组图的场景下，流式输出模式均生效。
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
||||
**guidance_scale ** `Float`
|
||||
> doubao\-seedream\-5.0\-lite/4.5/4.0 不支持
|
||||
|
||||
模型输出结果与prompt的一致程度，生成图像的自由度，又称为文本权重；值越大，模型自由度越小，与用户输入的提示词相关性越强。
|
||||
取值范围：[`1`, `10`] 。
|
||||
|
||||
---
|
||||
|
||||
|
||||
**output_format==^new^==**`string` `默认值 jpeg`
|
||||
> 仅 doubao\-seedream\-5.0\-lite 支持该参数
|
||||
|
||||
指定生成图像的文件格式。可选值：
|
||||
|
||||
* `png`
|
||||
* `jpeg`
|
||||
|
||||
:::tip
|
||||
doubao\-seedream\-4.5/4.0 模型生成图像的文件格式默认为 jpeg，不支持自定义设置。
|
||||
|
||||
:::
|
||||
---
|
||||
|
||||
|
||||
**response_format** `string` `默认值 url`
|
||||
指定生成图像的返回格式。支持以下两种返回方式：
|
||||
|
||||
* `url`：返回图片下载链接；**链接在图片生成后24小时内有效，请及时下载图片。**
|
||||
* `b64_json`：以 Base64 编码字符串的 JSON 格式返回图像数据。
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
||||
**watermark** `Boolean` `默认值 true`
|
||||
是否在生成的图片中添加水印。
|
||||
|
||||
* `false`：不添加水印。
|
||||
* `true`：在图片右下角添加“AI生成”字样的水印标识。
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
||||
**optimize_prompt_options ** `object`
|
||||
> 仅 doubao\-seedream\-5.0\-lite/4.5/4.0 支持该参数
|
||||
|
||||
提示词优化功能的配置。
|
||||
|
||||
属性
|
||||
optimize_prompt_options.**mode ** `string` `默认值 standard`
|
||||
设置提示词优化功能使用的模式。
|
||||
|
||||
* `standard`：标准模式，生成内容的质量更高，耗时较长。
|
||||
* `fast`：快速模式，生成内容的耗时更短，质量一般；doubao\-seedream\-5.0\-lite/4.5 当前不支持。
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
||||
|
||||
<span id="7P96iLnc"></span>
|
||||
## 响应参数
|
||||
<span id="Hrya4y9k"></span>
|
||||
### 流式响应参数
|
||||
请参见[文档](https://www.volcengine.com/docs/82379/1824137?lang=zh)。
|
||||
|
||||
<span id="1AxnwQZN"></span>
|
||||
### 非流式响应参数
|
||||
|
||||
---
|
||||
|
||||
|
||||
**model** `string`
|
||||
本次请求使用的模型 ID （`模型名称-版本`）。
|
||||
|
||||
---
|
||||
|
||||
|
||||
**created** `integer`
|
||||
本次请求创建时间的 Unix 时间戳（秒）。
|
||||
|
||||
---
|
||||
|
||||
|
||||
**data** `array`
|
||||
输出图像的信息。
|
||||
:::tip
|
||||
doubao\-seedream\-5.0\-lite/4.5/4.0 模型生成组图场景下，组图生成过程中某张图生成失败时：
|
||||
|
||||
* 若失败原因为审核不通过：仍会继续请求下一个图片生成任务，即不影响同请求内其他图片的生成流程。
|
||||
* 若失败原因为内部服务异常（500）：不会继续请求下一个图片生成任务。
|
||||
|
||||
|
||||
:::
|
||||
可能类型
|
||||
图片信息 `object`
|
||||
生成成功的图片信息。
|
||||
|
||||
属性
|
||||
data.**url ** `string`
|
||||
图片的 url 信息，当 **response_format ** 指定为 `url` 时返回。该链接将在生成后 **24 小时内失效**，请务必及时保存图像。
|
||||
推荐配置火山引擎 TOS 提供的数据订阅功能，将您的模型推理产物自动转存到自己的 TOS 桶中，便于长期备份或二次加工。详细介绍请参见 [TOS 数据订阅](https://www.volcengine.com/docs/6349/2280949?lang=zh)。
|
||||
|
||||
---
|
||||
|
||||
|
||||
data.**b64_json** `string`
|
||||
图片的 base64 信息，当 **response_format ** 指定为 `b64_json` 时返回。
|
||||
|
||||
---
|
||||
|
||||
|
||||
data.**size** `string`
|
||||
> 仅 doubao\-seedream\-5.0\-lite/4.5/4.0 支持该字段。
|
||||
|
||||
图像的宽高像素值，格式 `<宽像素>x<高像素>`，如`2048×2048`。
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
||||
错误信息 `object`
|
||||
某张图片生成失败，错误信息。
|
||||
|
||||
属性
|
||||
data.**error** `object`
|
||||
错误信息结构体。
|
||||
|
||||
属性
|
||||
|
||||
---
|
||||
|
||||
|
||||
data.error.**code**
|
||||
某张图片生成错误的错误码，请参见[错误码](https://www.volcengine.com/docs/82379/1299023)。
|
||||
|
||||
---
|
||||
|
||||
|
||||
data.error.**message**
|
||||
某张图片生成错误的提示信息。
|
||||
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
||||
**tools** `array of object`
|
||||
本次请求，配置的模型调用工具
|
||||
|
||||
属性
|
||||
|
||||
---
|
||||
|
||||
|
||||
tools.**type ** `string`
|
||||
配置的调用工具类型。
|
||||
|
||||
* web_search：联网搜索工具。
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
||||
**usage** `object`
|
||||
本次请求的用量信息。
|
||||
|
||||
属性
|
||||
|
||||
---
|
||||
|
||||
|
||||
usage.**generated_images ** `integer`
|
||||
模型成功生成的图片张数，不包含生成失败的图片。
|
||||
仅对成功生成图片按张数进行计费。
|
||||
|
||||
---
|
||||
|
||||
|
||||
usage.**output_tokens** `integer`
|
||||
模型生成的图片花费的 token 数量。
|
||||
计算逻辑为：计算 `sum(图片长*图片宽)/256` ，然后取整。
|
||||
|
||||
---
|
||||
|
||||
|
||||
usage.**total_tokens** `integer`
|
||||
本次请求消耗的总 token 数量。
|
||||
当前不计算输入 token，故与 **output_tokens** 值一致。
|
||||
|
||||
---
|
||||
|
||||
|
||||
usage.**tool_usage ** `object`
|
||||
使用工具的用量信息。
|
||||
|
||||
属性
|
||||
|
||||
---
|
||||
|
||||
|
||||
usage.tool_usage.**web_search ** `integer`
|
||||
调用联网搜索工具次数，仅开启联网搜索时返回。
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
||||
**error** `object`
|
||||
本次请求，如发生错误，对应的错误信息。
|
||||
|
||||
属性
|
||||
|
||||
---
|
||||
|
||||
|
||||
error.**code** `string`
|
||||
请参见[错误码](https://www.volcengine.com/docs/82379/1299023)。
|
||||
|
||||
---
|
||||
|
||||
|
||||
error.**message** `string`
|
||||
错误提示信息
|
||||
|
||||
|
||||
|
||||
|
||||
File diff suppressed because it is too large.
Load diff
Reference in new issue
Block a user