Skip to main content
POST
/
doc-agent
/
api
/
v1
/
capability
/
image-quality
cURL
curl --request POST \
  --url https://agents.textin.com/doc-agent/api/v1/capability/image-quality \
  --header 'Content-Type: multipart/form-data' \
  --header 'x-ti-app-id: <x-ti-app-id>' \
  --header 'x-ti-secret-code: <x-ti-secret-code>' \
  --form files='@example-file' \
  --form material_id=8ffe03ce-4714-4b50-8daf-afee06002cc3
{
  "code": 200,
  "data": {
    "materials": [
      {
        "material_id": "8ffe03ce-4714-4b50-8daf-afee06002cc3",
        "pages": [
          {
            "page": 1,
            "risk_details": {
              "blurry": {
                "reason": [],
                "score": 0.4,
                "valid": false
              },
              "light_spot": {
                "reason": [],
                "score": 0,
                "valid": false
              },
              "photocopy": {
                "reason": [],
                "score": 0,
                "valid": false
              },
              "scan": {
                "reason": [],
                "score": 0,
                "valid": false
              },
              "screen_remark": {
                "reason": [],
                "score": 0,
                "valid": false
              },
              "un_integrity": {
                "reason": [
                  "数字遮挡"
                ],
                "score": 1,
                "valid": true
              }
            },
            "risk_type": [
              "un_integrity"
            ]
          }
        ]
      },
      {
        "material_id": "27734e23-3482-42a3-98d7-1bdb369118bc",
        "pages": [
          {
            "page": 1,
            "risk_details": {
              "blurry": {
                "reason": [],
                "score": 0.4,
                "valid": false
              },
              "light_spot": {
                "reason": [],
                "score": 0,
                "valid": false
              },
              "photocopy": {
                "reason": [],
                "score": 0,
                "valid": false
              },
              "scan": {
                "reason": [],
                "score": 0,
                "valid": false
              },
              "screen_remark": {
                "reason": [],
                "score": 0,
                "valid": false
              },
              "un_integrity": {
                "reason": [
                  "拍摄"
                ],
                "score": 1,
                "valid": true
              }
            },
            "risk_type": [
              "un_integrity"
            ]
          }
        ]
      }
    ]
  },
  "message": "OK"
}

Headers

​
x-ti-app-id
string
required
​
x-ti-secret-code
string
required

Body

multipart/form-data
​
batch_id
string

批次 ID(处理批次下所有材料)

Example:

"661be601-65c7-4025-af0f-20d357dfb090"

​
blurry_threshold
number<float>

模糊风险判定阈值。开启模糊检测后，若模型输出的模糊风险分数大于该阈值，则判定图像存在模糊风险(0~1，保留2位小数，默认 0.5)

Example:

0.5

​
detection_scope
integer<int32>

检测范围控制参数。0 表示检测图片中的所有主体，只要任一主体存在质量风险，则整体判定为存在风险；1 表示仅检测第一个主体的质量风险情况。建议采用 0(默认 0)

Example:

0

​
file_urls
string

URL 上传(与 material_id/batch_id 互斥)，JSON 数组格式

Example:

"[\"https://example.com/file1.pdf\"]"

​
files
file

文件二进制上传(支持多文件)

​
light_spot_level
integer<int32>

光斑检测的检测级别控制参数。0 表示优先检测主体边缘与背景区域是否存在光斑；1 表示优先检测主体内容区域是否存在光斑，例如文字、印章、人像等区域是否受光斑影响(默认 0)

Example:

0

​
light_spot_threshold
number<float>

光斑风险判定阈值。开启光斑检测后，若模型输出的光斑风险分数大于该阈值，则判定图像存在光斑风险(0~1，保留2位小数，默认 0.5)

Example:

0.5

​
material_id
string

已上传材料的 ID(处理单个材料，与 files/file_urls 互斥)

Example:

"8ffe03ce-4714-4b50-8daf-afee06002cc3"

​
photocopy_threshold
number<float>

复印件风险判定阈值。开启复印件检测后，若模型输出的复印件风险分数大于该阈值，则判定图像为复印件风险(0~1，保留2位小数，默认 0.5)

Example:

0.5

​
scan_threshold
number<float>

扫描件风险判定阈值。开启扫描件检测后，若模型输出的扫描件风险分数大于该阈值，则判定图像存在扫描件风险(0~1，保留2位小数，默认 0.5)

Example:

0.5

​
screen_remark_threshold
number<float>

翻拍风险判定阈值。开启翻拍检测后，若模型输出的翻拍风险分数大于该阈值，则判定图像存在翻拍风险(0~1，保留2位小数，默认 0.5)

Example:

0.5

​
un_integrity_level
integer<int32>

完整性检测的检测级别控制参数。0 表示优先检测主体边缘与背景是否完整；1 表示优先检测主体内容是否完整，例如文字、印章、人像等区域是否缺失(默认 0)

Example:

0

​
un_integrity_threshold
number<float>

完整性风险判定阈值。开启完整性检测后，若模型输出的完整性风险分数大于该阈值，则判定图像存在不完整风险。完整性风险检测包括：1.拍摄(因未拍全导致的完整性风险) 2.物理遮挡 3.数字遮挡(如马赛克) 4.物理水印(含水印文件的打印件) 5.数字水印(常规水印，如水印相机) 6.弯折 7.破损(0~1，保留2位小数，默认 0.5)

Example:

0.5

Response

200 - application/json

OK

​
code
integer

业务状态码

Example:

200

​
data
object
​
message
string

状态说明

Example:

"OK"