通用2.1-文生图--人像人体-火山引擎

文档中心

导航

通用2.1-文生图

最近更新时间：2024.11.14 23:49:31首次发布时间：2024.10.31 21:12:23

接口简介

请求说明

名称	内容
接口地址	https://visual.volcengineapi.com
请求方式	POST
Content-Type	application/json

完整公共参数列表见公共参数
本服务Region为cn-north-1； Service为cv

Query参数

拼接到url后的参数，示例：https://visual.volcengineapi.com?Action=CVProcess&Version=2022-08-31

参数	可选/必选	类型	说明
Action	必选	String	接口名，取固定值：CVProcess
Version	必选	String	版本号，取固定值：2022-08-31

Body参数

业务请求参数，放到request.body中，MIME-Type为application/json

参数	可选/必选	类型	说明	备注
req_key	必选	string	算法名称，取固定值为high_aes_general_v21
prompt	必选	string	用于生成图像的提示词，中英文均可输入
model_version	必选	string	模型版本名称，固定值：general_v2.0
~~req_schedule_conf~~	必选	~~string~~	~~固定值：general_v20_9B_rephraser~~
~~llm_seed~~	可选	~~int~~	~~效果对齐的情况下，传0~~ ~~默认值: -1~~
negative_prompt	可选	string	用于不想要生成效果的提示词默认值："nsfw, nude, low resolution, blurry, worst quality, mutated hands and fingers, poorly drawn face, bad anatomy, distorted hands"
seed	可选	int	随机种子，-1为不随机种子；其他为指定随机种子默认值：-1
scale	可选	float	影响文本描述的程度默认值：3.5 取值范围[1, 10]
ddim_steps	可选	int	生成图像的步数默认值：25 取值范围[1-200]
width	可选	int	生成图像的宽，取值范围[256-768] 默认值：512	宽、高与512差距过大，则出图效果不佳、延迟过长概率显著增加。超分前建议比例及对应宽高：widthheight 1:1：512512 4:3：512384 3:4：384512 3:2：512341 2:3：341512 16:9：512288 9:16：288512
height	可选	int	生成图像的高，取值范围[256-768] 默认值：512
use_rephraser	可选	bool	开启中文扩写模型，随机改写prompt，提升图像多样性默认值：True
use_sr	可选	bool	True：文生图+AIGC超分 False：文生图默认值：False	内置的超分功能，开启后可将上述宽高均乘以2返回，此参数打开后延迟会有增加如上述宽高均为512和512，此参数关闭出图 512512 ，此参数打开出图1024 1024
sr_seed	可选	int	超分模型随机种子，-1为不随机种子；其他为指定随机种子，当use_sr开启时有效默认值：-1
sr_strength	可选	float	只在超分模型生效默认值：0.4 取值范围[0.0, 1.0]
sr_scale	可选	float	在超分模型上，影响文本描述的程度默认值：3.5 取值范围[1, 10]
sr_steps	可选	int	超分模型生成图像的步数默认值：20 取值范围[1-50]
is_only_sr	可选	bool	独立请求超分开关，打开后只有超分的参数（sr_前缀的参数）生效，其他base模型参数不生效默认值：False	优先级大于use_sr开关
return_url	可选	bool	输出是否返回图片链接
logo_info	可选	LogoInfo	水印信息

LogoInfo
水印相关参数

名称	类型	必选	描述
add_logo	Boolean	否	是否添加水印。True为添加，False不添加。默认不添加
position	Int	否	水印的位置，取值如下： 0-右下角 1-左下角 2-左上角 3-右上角默认0
language	Int	否	水印的语言，取值如下： 0-中文（AI生成） 1-英文（Generated by AI）默认0
logo_text_content	String	否	明水印自定义内容

输出说明

通用输出参数

请参考通用返回字段及错误码

业务输出参数

重点关注data 字段，其他字段为公共返回

字段	类型	说明
binary_data_base64	array of string	返回图片的base64数组。
image_urls	array of string	输出处理过的图片url 数组（单张图）

请求&返回完整示例

请求示例

{
    "req_key":       "high_aes_general_v21",
    "prompt":        "一个篮球砸到男人脸上",
    "model_version": "general_v2.0",
    "seed":          -1,
    "scale":         3.5,
    "ddim_steps":    25,
    "width":         512,
    "height":        512,
    "use_rephraser": false,
    "use_sr":        true,
    "sr_seed":       -1,
    "sr_strength":   0.4,
    "sr_scale":      3.5,
    "sr_steps":      20,
    "is_only_sr":    false,
    "logo_info": {
            "add_logo": false,
            "position": 0,
            "language": 0,
            "opacity":  0.3,
    }
}

输出示例

{
    "code": 10000,
    "data": {
        "algorithm_base_resp": {
            "status_code": 0,
            "status_message": "Success"
        },
        "binary_data_base64": [
            ""
        ],
        "pe_result": "",
        "predict_tags_result": "",
        "rephraser_result": "",
        "request_id": ""
    },
    "message": "Success",
    "request_id": "",
    "status": 10000,
    "time_elapsed": "7.216940183s"
}

错误码

（1）通用错误码
请参考通用返回字段及错误码
（2）业务错误码

HttpCode	错误码	错误消息	描述
200	10000	无	请求成功
400	50411	Pre Img Risk Not Pass	输入图片前审核未通过
400	50511	Post Img Risk Not Pass	输出图片后审核未通过
400	50412	Text Risk Not Pass	输入文本前审核未通过
400	50512	Post Text Risk Not Pass	输出文本后审核未通过
400	50413	Post Text Risk Not Pass	输入文本NER、IP、Blocklist等拦截

SDK使用说明

请参考SDK使用说明

人像人体