调用方式 V2--图像技术-火山引擎

文档中心

导航

调用方式 V2

最近更新时间：2023.11.03 11:08:07首次发布时间：2022.09.27 12:32:51

接口简介

对输入图像进行多维度画质评分，包括清晰度、亮度、噪声、色彩、美观度、有无边框等。

限制条件

名称	内容
图片要求	1. 图片格式：JPG、JPEG、PNG、BMP等常见格式，建议使用JPG格式。 2. 图片大小及分辨率：最大 5 MB，分辨率需要大于64x64，小于4096x4096。

请求说明

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

请求参数

（1）header请求参数
公共请求参数
以下请求参数列表仅列出了接口请求参数和必要公共参数，完整公共参数列表见公共参数

名称	类型	是否必填	描述
X-Date	String	是	使用UTC时间，精确到秒。请使用格式：`YYYYMMDD'T'HHMMSS'Z'` ，例如：`20201103T104027Z`
Authorization	String	是	HMAC-SHA256：签名方法 -Credential为签名凭证，其中: -AccessKeyId为访问密钥ID，可在访问密钥（Access Key）获取； -ShortDate为请求的短时间，使用UTC时间，精确到日。请使用格式：`YYYYMMDD`，例如：`20180201`； -Region为请求地区，国内一般为为`cn-north-1`； -Service为请求的服务，一般为`cv`； -SignedHeaders为参与签名计算的头部信息，`content-type` 和 `host` 为必选头部； -Signature为签名，可在签名方法获取。注：我们提供了SDK及签名示例供您实现服务快速接入，具体可参考快速接入例如：`HMAC-SHA256 Credential={AccessKeyId}/{ShortDate}/{Region}/{Service}/request, SignedHeaders={SignedHeaders}, Signature={Signature}`
X-Security-Token	String	否	指安全令牌服务（Security Token Service，STS）颁发的临时安全凭证中的SessionToken，使用长期密钥时无需填写该参数。

（2）Query参数

业务请求参数

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

（3）Body参数

业务请求参数

参数	可选/必选	类型	说明
req_key	必选	string	算法名称，取固定值为lens_vida_single_pic
binary_data_base64	必选（二选一，优先生效）	array of string	图片文件，base64编码。此算法需要输入1张图片
image_urls	必选（二选一）	array of string	图片文件URL
vida_mode	可选	string	对输出结果的维度进行自定义控制，取值为`vida_custom`
vida_enable_module	可选	stirng	目前只支持`score_total_ds`值(电商定制化场景)

输出说明

（1）通用输出参数

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

（2）业务输出参数

data 字段说明

分类	输出维度	类型	参数范围	说明	描述
总分	score_total	float		总分输出	拟合大众主观上对图片、视频的画质感受，分值越高表示画质越清晰。
电商总分	score_total_ds	float		总分输出(电商定制化场景)	拟合大众主观上对图片、视频的画质感受，更侧重于对电商图像作质量评估，分值越高画质越清晰
三明治检测	is_sandwitch_video	int	0/1	是否三明治视频	判断视频是否添加模糊边或者黑边。
三明治检测坐标	sandwitch_top	int		三明治坐标
三明治检测坐标	sandwitch_bottom	int		三明治坐标
三明治检测坐标	sandwitch_left	int		三明治坐标
三明治检测坐标	sandwitch_right	int		三明治坐标
纯色背景检测	is_pure_background	int	0/1	是否纯色视频	画面较为平坦，几乎无纹理或者无实质内容。
白天夜晚检测	is_night	int	0/1	白天/夜晚	检测白天/夜晚场景。
黑边检测	has_black_edge	int	0/1	视频是否有黑边	视频是否添加黑边。
亮度检测	score_luma	float		亮度总分	从亮度，对比度，过欠曝程度等多角度对图像亮度维度做出评价。分值越高表示亮度越适中。
	brightness	float		全局亮度	全局亮度的衡量指标，分值越小代表越黑。
	under_exposure	float		欠曝程度	欠曝区域的衡量指标，分值越小代表欠曝区域越小。
	over_exposure	float		过曝程度	过曝区域的衡量指标，分值越小代表过曝区域越小。
	contrast	float		全局对比度	对比度的衡量指标，分值越小代表对比度越低。
清晰度打分	score_detail	float		全局细节	从artifact角度对图像的细节失真程度做出评价，例如模糊、振铃、快效应。分值越小代表清晰度越差。
美学打分	score_aesthetics	float		美学打分	拟合大众对图像美观度的主观感受，分值越高表示图像越美观。
美学打分2.0	score_aesthetics_v2	float		美学打分2.0	拟合大众对图像美观度的主观感受，分值越高表示图像越美观。
人脸打分	score_face	float		人脸打分	依据人脸清晰度、有无遮挡、偏转角度等综合评价人脸质量，人脸越易于辨识质量越高。

（3）输出示例

{
    "code":10000,
    "data":{
        "algorithm_base_resp":{
            "status_code":0,
            "status_message":"success"
        },
        "binary_data_base64":[

        ],
        "brightness":38.8320426940918,
        "contrast":74.91159057617188,
        "has_black_edge":0,
        "is_night":0,
        "is_pure_background":0,
        "is_sandwitch_video":0,
        "over_exposure":0.00046296295477077365,
        "sandwitch_bottom":0,
        "sandwitch_left":0,
        "sandwitch_right":0,
        "sandwitch_top":0,
        "score_aesthetics_v2":0.8835602402687073,
        "score_detail":91.17546081542969,
        "score_face":0.16552981734275818,
        "score_luma":99,
        "score_total":84.37092590332031,
        "under_exposure":17.32638931274414
    },
    "message":"Success",
    "request_id":"20220927112639010212087079095F63CA",
    "status":10000,
    "time_elapsed":"359.419019ms"
}

错误码

（1）通用错误码

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

（2）业务错误码

HttpCode	错误码	错误消息	描述
200	10000	无	请求成功