com.volcengine.model.imagex.v2.GetImageQualityBody Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of volc-sdk-java Show documentation

The VOLC Engine SDK for Java

There is a newer version: 1.0.192

package com.volcengine.model.imagex.v2;


import com.alibaba.fastjson.JSON;

/**
 * GetImageQualityBody
 */
@lombok.Data
public final class GetImageQualityBody  {

    /**
     * 图片存储 Uri 或访问 URL。
     *
     * * 图片 Uri 格式，例如：tos-example/7a7979974.jpeg
     *
     * * 图片 URL 格式，例如：https://example.org/tos-example/7a7979974.jpeg~tplv.png
     *
     * :::tip
     *
     * 若传 URL，必须保证 URL 公网可访问。
     *
     * :::
     */
    @com.alibaba.fastjson.annotation.JSONField(name = "ImageUrl")
    private String imageUrl;

    /**
     * 评估工具。指定多个评估工具时使用英文逗号分隔，当前支持以下工具：
     *
     * * nr_index
     *
     * * vqscore
     *
     * * advcolor
     *
     * * blockiness
     *
     * * noise
     *
     * * aesmod
     *
     * * blur
     *
     * * cg
     *
     * * contrast
     *
     * * texture
     *
     * * brightness
     *
     * * overexposure
     *
     * * hue
     *
     * * saturation
     *
     * * psnr
     *
     * * ssim
     *
     * * vmaf
     *
     * * green
     *
     * * cmartifacts
     *
     * :::tip
     *
     * nr_index 工具支持评估 contrast、brightness 等多个维度。您也可以单独指定各维度，获取指定维度估值。
     *
     * :::
     */
    @com.alibaba.fastjson.annotation.JSONField(name = "VqType")
    private String vqType;

    /**
     * 指定服务下的评估参照图片存储 Uri 或访问 URL，用于和 `ImageUrl` 图片进行特定维度的对比。
     *
     * :::tip
     *
     * 当 `VqType` 中包含 `psnr、ssim、vmaf` 等任一字段时，该字段为必填，否则上述评估指标无法正常输出结果。
     *
     * :::
     */
    @com.alibaba.fastjson.annotation.JSONField(name = "ImageUrlRef")
    private String imageUrlRef;

    @Override
    public String toString() {
        return JSON.toJSONString(this);
    }
}