---
name: "oralDiseasePredictionRun"
mode: "kit"
versionRequirements:
  - { name: "AIKit", version: "1.6.0" }
  - { name: "@ray-js/ray", version: "1.7.43" }
platform:
  - "iOS"
  - "Android"
async: true
title: "oralDiseasePredictionRun - Oral disease prediction analysis"
---

## oralDiseasePredictionRun

> [VERSION] AIKit >= 1.6.0 | @ray-js/ray >= 1.7.43

> [PLATFORM] iOS, Android

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

### Description

Oral disease prediction

### Parameters

| Property | Type | Required | Default | Since | Description |
| --- | --- | --- | --- | --- | --- |
| `devId` | `string` | Yes | - | `2.0.1` | Device name |
| `inputImagePath` | `string` | Yes | - | `1.6.0` | Image input path |
| `outImagePath` | `string` | Yes | - | `1.6.0` | Image output directory |
| `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 |
| --- | --- | --- | --- |
| `nonOral` | `boolean` | `1.6.0` | Whether it is a non-oral image |
| `diseaseType` | `string[]` | `1.6.0` | Prediction result Normal  Normal Calculus  Calculus Caries  Caries Gingivitis  Gingivitis Ulcers  Ulcers Discoloration  Tooth discoloration Hypodontia  Tooth hypoplasia |
| `heatMapPath` | `string` | `1.6.0` | Model heatmap |
| `sunlightPath` | `string` | `1.6.0` | Daylight mode filter |
| `chromaPath` | `string` | `1.6.0` | Periodontal mode filter image |
| `grayscalePath` | `string` | `1.6.0` | Caries mode filter image |

#### 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 |


### Examples

#### Basic usage

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

const { oralDiseasePredictionRun } = ai;

oralDiseasePredictionRun({
  devId: 'device_001',
  inputImagePath: 'example',
  outImagePath: 'example',
  success: (result) => {
    console.log('oralDiseasePredictionRun success', result);
  },
  fail: (error) => {
    console.log('oralDiseasePredictionRun fail', error.errorMsg);
  },
});
```