---
name: "petsPictureQualityDetectForImage"
mode: "kit"
versionRequirements:
  - { name: "AIKit", version: "1.3.0" }
  - { name: "@ray-js/ray", version: "1.7.20" }
platform:
  - "iOS"
  - "Android"
async: true
title: "petsPictureQualityDetectForImage - 宠物图像质量检测"
---

## petsPictureQualityDetectForImage

> [VERSION] AIKit >= 1.3.0 | @ray-js/ray >= 1.7.20

> [PLATFORM] iOS, Android

> ⚡ **支持 Promise 调用** — 不传 success / fail / complete 回调时，该方法返回 Promise。

### 描述

宠物图像质量检测

### 参数

| 属性 | 类型 | 必填 | 默认值 | 最低版本 | 描述 |
| --- | --- | --- | --- | --- | --- |
| `inputImagePath` | `string` | 是 | - | `1.3.0` | 图片输入路径 |
| `labelAllow` | `1 \| 2` | 否 | `1` | `1.3.0` | 识别类型枚举 |
| `objectAreaPercent` | `number` | 是 | - | `1.3.0` | 识别对象大小占整个图片的比值，默认值30，含义：小于30%过滤 |
| `objectFaceRotationAngle` | `number` | 是 | - | `1.3.0` | 识别对象脸部旋转角度，默认值45，含义：超过45%过滤 |
| `objectFaceSideAngle` | `number` | 是 | - | `1.3.0` | 识别对象脸部侧脸角度，默认值40，含义：超过40%过滤 |
| `maximumPictureBrightness` | `number` | 是 | - | `1.3.0` | 最大亮度 |
| `minimumPictureBrightness` | `number` | 是 | - | `1.3.0` | 最小亮度 |
| `complete` | `() => void` | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） |
| `success` | `(params: Object) => void` ↓见下方 | 否 | - | - | 接口调用成功的回调函数 |
| `fail` | `(params: Object) => void` ↓见下方 | 否 | - | - | 接口调用失败的回调函数 |

#### success 回调参数

| 属性 | 类型 | 最低版本 | 描述 |
| --- | --- | --- | --- |
| `imagePath` | `string` | `1.3.0` | 图片地址 |
| `lowQuality` | `boolean` | `1.3.0` | 是否是低质量图片 |
| `lowQualityReason` | `number` | `1.3.0` | 低质量原因 |

#### fail 回调参数

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `errorMsg` | `string` | 错误信息 |
| `errorCode` | `string \| number` | 错误码 |
| `innerError` | `Object` | 错误扩展 |

##### fail(params).innerError 的属性

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `errorCode` | `string \| number` | 错误扩展码 |
| `errorMsg` | `string` | 错误扩展信息 |


### 合法值

##### `labelAllow` 合法值

| 值 | 说明 |
| --- | --- |
| `1` | 猫 |
| `2` | 狗 |


### 示例代码

#### 基础调用

```tsx
import { ai } from '@ray-js/ray'

const { petsPictureQualityDetectForImage } = ai;

petsPictureQualityDetectForImage({
  inputImagePath: 'example',
  objectAreaPercent: 0,
  objectFaceRotationAngle: 0,
  objectFaceSideAngle: 0,
  maximumPictureBrightness: 0,
  minimumPictureBrightness: 0,
  success: (result) => {
    console.log('petsPictureQualityDetectForImage success', result);
  },
  fail: (error) => {
    console.log('petsPictureQualityDetectForImage fail', error.errorMsg);
  },
});
```