---
name: "objectDetectForImage"
mode: "kit"
versionRequirements:
  - { name: "AIKit", version: "1.1.0" }
  - { name: "@ray-js/ray", version: "1.6.29" }
platform:
  - "iOS"
  - "Android"
async: true
title: "objectDetectForImage"
---

## objectDetectForImage

> [VERSION] AIKit >= 1.1.0 | @ray-js/ray >= 1.6.29

> [PLATFORM] iOS, Android

> ⚡ **Supports Promise** — Returns a Promise when success / fail / complete callbacks are omitted.

### Description

Run object recognition on an image

### Parameters

| Property | Type | Required | Default | Since | Description |
| --- | --- | --- | --- | --- | --- |
| `inputPath` | `string` | Yes | - | `1.1.0` | Image input path |
| `outputPath` | `string` | Yes | - | `1.1.0` | Image output path |
| `detectType` | `1 \| 2` | No | `1` | `1.1.0` | Recognition type |
| `imageEditType` | `1 \| 2 \| 3` | No | `1` | `1.1.0` | Image processing type |
| `complete` | `() => void` | No | - | - | Completion callback (executed on both success and failure) |
| `success` | `(params: Object) => void` ↓see below | No | - | - | Callback on successful API call |
| `fail` | `(params: Object) => void` ↓see below | No | - | - | Failure callback |

#### success callback parameters

| Property | Type | Since | Description |
| --- | --- | --- | --- |
| `path` | `string` | `1.1.0` | Output path |

#### fail callback parameters

| Property | Type | Description |
| --- | --- | --- |
| `errorMsg` | `string` | Error message |
| `errorCode` | `string \| number` | Error code |
| `innerError` | `Object` | Error extension |

##### fail(params).innerError properties

| Property | Type | Description |
| --- | --- | --- |
| `errorCode` | `string \| number` | Error extension code |
| `errorMsg` | `string` | Error extension message |


### Valid Values

##### `detectType` valid values

| Value | Description |
| --- | --- |
| `1` | Pets |
| `2` | People |

##### `imageEditType` valid values

| Value | Description |
| --- | --- |
| `1` | No effect |
| `2` | Emphasize subject |
| `3` | Privacy protection |


### Examples

#### Basic usage

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

const { objectDetectForImage } = ai;

objectDetectForImage({
  inputPath: 'example',
  outputPath: 'example',
  success: (result) => {
    console.log('objectDetectForImage success', result);
  },
  fail: (error) => {
    console.log('objectDetectForImage fail', error.errorMsg);
  },
});
```