文档中心>API 中心>腾讯混元大模型>混元生图相关接口>提交混元生图(多轮对话)任务

提交混元生图(多轮对话)任务

最近更新时间:2024-11-20 01:40:37

我的收藏

1. 接口描述

接口请求域名: hunyuan.tencentcloudapi.com 。

混元生图(多轮对话)接口基于混元大模型,将根据输入的文本描述生成图像,支持通过多轮对话的方式不断调整图像内容。分为提交任务和查询任务2个接口。
提交任务:输入文本和前置对话 ID 等,提交一个混元生图多轮对话异步任务,获得任务 ID。
查询任务:根据任务 ID 查询任务的处理状态、处理结果,任务处理完成后可获得在上一轮对话基础上继续生成的图像结果。
混元生图(多轮对话)默认提供1个并发任务数,代表最多能同时处理1个已提交的任务,上一个任务处理完毕后才能开始处理下一个任务。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:SubmitHunyuanImageChatJob。
Version String 公共参数,本接口取值:2023-09-01。
Region String 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-guangzhou 。
Prompt String 本轮对话的文本描述。
提交一个任务请求对应发起一轮生图对话,每轮对话中可输入一条 Prompt,生成一张图像,支持通过多轮输入 Prompt 来不断调整图像内容。
推荐使用中文,最多可传1024个 utf-8 字符。
输入示例:
  • 第一轮对话:一颗红色的苹果
  • 第二轮对话:将苹果改为绿色
  • 第三轮对话:苹果放在桌子上

  • 示例值:请画一个苹果在桌子上
    ChatId String 上传上一轮对话的 ChatId,本轮对话将在指定的上一轮对话结果基础上继续生成图像。
    如果不传代表新建一个对话组,重新开启一轮新的对话。
    一个对话组中,最多支持进行100轮对话。
    示例值:1248907282106990592
    LogoAdd Integer 为生成结果图添加显式水印标识的开关,默认为1。
    1:添加。
    0:不添加。
    其他数值:默认按1处理。
    建议您使用显著标识来提示结果图使用了 AI 绘画技术,是 AI 生成的图片。
    示例值:1
    LogoParam LogoParam 标识内容设置。
    默认在生成结果图右下角添加“图片由 AI 生成”字样,您可根据自身需要替换为其他的标识图片。
    示例值:{"LogoUrl": "https://xxx.com/logo.jpg", "LogoRect": {"X": 10, "Y": 10, "Width": 20, "Height": 20}}

    3. 输出参数

    参数名称 类型 描述
    JobId String 任务 ID。
    示例值:1253534368-1731657099-7276788a-a326-11ef-beeb-525400bba60c-0
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 调用成功

    调用成功

    输入示例

    POST / HTTP/1.1
    Host: hunyuan.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: SubmitHunyuanImageChatJob
    <公共请求参数>
    
    {
        "Prompt": "请画一个苹果在桌子上"
    }

    输出示例

    {
        "Response": {
            "JobId": "1253534368-1731657099-7276788a-a326-11ef-beeb-525400bba60c-0",
            "RequestId": "7276788a-a326-11ef-beeb-525400bba60c"
        }
    }

    5. 开发者资源

    腾讯云 API 平台

    腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

    API Inspector

    用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

    SDK

    云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

    命令行工具

    6. 错误码

    以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

    错误码 描述
    FailedOperation.DownloadError LogoUrl 或 LogoImage 有误,水印图下载失败。
    FailedOperation.GenerateImageFailed 图片包含敏感内容
    FailedOperation.ImageDecodeFailed 水印图解码失败
    FailedOperation.ImageDownloadError LogoUrl 或 LogoImage 有误,水印图下载失败。
    InvalidParameter.InvalidParameter 参数不合法。
    InvalidParameterValue.ParameterValueError 参数字段或者值有误
    OperationDenied.ImageIllegalDetected 图片可能包含敏感信息,请重试
    OperationDenied.TextIllegalDetected 文本包含违法违规信息,审核不通过。
    ResourceInsufficient.ChargeResourceExhaust 计费资源已耗尽。
    ResourceUnavailable.NotExist 计费状态未知,请确认是否已在控制台开通服务。
    ResourceUnavailable.StopUsing 账号已停服。