veImageX
veImageX
- 文档首页
veImageX控制台指南组件市场批量处理
文档反馈
问问助手附加组件 2.0 支持批量处理功能。通过批量处理图像，您可以节省带宽和时间，降低使用成本并提高运行效率。相较于离线转码功能，批量处理功能具备多样化的输入和输出形式，包括 JSON、文本和文件格式。本文介绍如何使用批量处理功能。
计费说明
该能力涉及的图片计费项与您所选用的附加组件有关，详见附加组件计费说明。
注意事项
- 一个队列可提交多条任务，一个任务内提交的待处理图片建议最多不超过 10 万条。
- 开启批量处理任务后，在执行该任务内具体图片时将生成对应条目（Entry），即一个图片执行任务对应一个条目。
前提条件
- 已开通 veImageX 产品服务并创建服务。
- 已开通智能处理计费配置。
- （可选）如需完成以下操作，确保已新建模板。
- 处理输入图像：如果输入图像不符合输入限制，您可以通过模板来压缩图片大小或变更图片格式等，再将处理后的图片作为输入图像。
- 处理生成图像：对生成的图像进行二次处理，例如添加水印或调整分辨率。
使用流程
步骤一：新建并启动任务队列
veImageX 在每个账号内置了一个默认任务队列，如无特殊需求，您可直接使用默认任务队列。
- 登录 veImageX 控制台。
- 在左侧导航栏，选择组件市场 > 批量处理。
- 单击新建任务队列。
- 在弹窗中，完成以下配置并单击确定。
- 在批量处理页面的状态列，单击启动，启动该新建的任务队列。
说明
若一个队列提交了多个任务时，任务将按照提交先后顺序执行批量处理。
您也可以通过调用以下接口，实现上述操作。
- 调用 CreateImageAIProcessQueue 接口，新建任务队列。
- 调用 UpdateImageAIProcessQueueStatus 接口，将
Status取值设置为Running，启动任务队列。
（可选）步骤二：回调配置
该回调配置所应用范围为整个任务队列内所有已提交任务，但仅当各任务内每个 URL/URI 资源处理成功或失败时，才会向回调 URL 发送回调内容。
- 在批量处理页面，打开任务队列回调配置列的开关。
- 在弹窗中，完成以下配置并单击确定。
其中，回调URL支持自定义回调协议 http 或 https。
您也可以通过调用 CreateImageAIProcessQueue 或 CreateImageAITask 接口设置回调配置。其中，CreateImageAITask 的回调配置优先级更高。
步骤三：提交任务
- 在任务队列的操作列，单击提交任务。
- 在弹窗中，完成以下配置并单击确定。
其中，- 选择工作流模板ID 并输入模板配置参数。具体取值，详见开发指南 > 附加组件 2.0 目录下的各组件文档。
- 选择以下提交类型，上传图像 URL 或 URI 的文件，每行填写一个 URL 或 URI。
- URL (合法可访问即可)：图像公网可访问的 URL，例如
https://example.com/static/demo1.png。 - URI (必须归属本服务下)：当前服务下不包含
tos-*-i-*前缀的图像存储 URI，例如存储 URI 为tos-m*a-i-0ksq****qe/image-a/example.jpg，则写入image-a/example.jpg。
- URL (合法可访问即可)：图像公网可访问的 URL，例如
说明
- 若您配置了上传 Content-Type 限制，则文件的格式需在服务的 Content-Type 白名单内，否则无法成功上传。
- 当使用 ImageX-SeeDream 生图方案附加组件时，
- 图像地址为可辅助生成图像的参考图 URL 或 URI。如需仅根据提示词生成图像，请调用
AIProcess或CreateImageAITask接口。详见方式一：通过 API 调用。 - 上传的文件需遵循以下格式：每行可包含 1 到 10 个参考图地址，并使用英文逗号（,）分隔，但地址本身不包含英文逗号。
- 示例一：在文件的一行内写入
a.png,uridemo.png，表示根据提示词和参考图 a.png、uridemo.png 生成一次图像。 - 示例二：在文件中分两行写入以下内容，表示根据提示词和参考图 a.png 生成一次图像，再根据提示词和参考图 uridemo.png 生成一次图像。
a.pnguridemo.png
- 示例一：在文件的一行内写入
- 图像地址为可辅助生成图像的参考图 URL 或 URI。如需仅根据提示词生成图像，请调用
您也可以通过调用 CreateImageAITask 接口提交任务。
步骤四：获取图像处理结果
通过以下任一方式获取图像处理结果。
- 回调通知：如果您设置了回调地址，则当任务完成后，veImageX 会向该回调地址发送回调消息。详见回调。
- 主动查询：如果您未设置回调地址，调用 GetImageAIDetails 接口，获取图像处理结果。
步骤五：查看结果图
相关操作
查询队列详情
- 在批量处理页面，在任务队列的操作列，单击详情。
- 在队列详情页面，您可以查看任务队列中各 URL/URI 所在处理任务的进度、状态和执行时间等。
其中，进度中各项指标含义如下所示：- 总数：该任务中执行的条目数。
- 成功：该任务中执行成功的条目数。
- 失败：该任务中执行失败的条目数。
说明
仅支持保存并查询近 7 天的处理任务。
查询任务详情
- 在队列详情页面，单击任务操作列下的查看详情。仅支持查询近 7 天的处理条目。
- 在任务详情页面，按需完成以下操作：
- 单击操作列的详情，查看该条条目对应的任务信息、输入信息、输出信息等具体内容。
- 单击操作列的手工触发回调，手动对该条 URL/URI 处理条目发送回调内容。适用于回调地址未成功接收回调内容的场景。
- 单击操作列的删除，删除该条目。
管理任务
在批量处理页面，管理已创建的任务队列。
参考下表管理您的任务队列。
配置
操作项
说明
状态
启动
启动任务队列，开始对提交的任务执行批量处理。
暂停
暂停任务队列，暂停正在执行批量处理的任务。
回调配置
编辑
更新该任务队列的回调配置，支持更新回调 URL 和回调格式。详见（可选）步骤二：回调配置。
操作
详情
查看该任务队列中各 URL/URI 的批量处理结果，或执行手工触发回调等操作。详见查询任务详情。
提交任务
向该任务队列提交 URL/URI 批量处理任务。详见步骤三：提交任务。
删除
删除该条任务队列。您也可以在任务详情页面，选中多条任务进行批量删除操作。