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

## generateTranslateTask

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

> [PLATFORM] iOS, Android

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

### Description

Create internal Translate context

### Parameters

| Property | Type | Required | Default | Since | Description |
| --- | --- | --- | --- | --- | --- |
| `deviceId` | `string` | Yes | - | `0.0.1` | Device ID |
| `dataTimeout` | `number` | Yes | - | `0.0.1` | Streaming timeout, in seconds |
| `originalLanguage` | `string` | Yes | - | `0.0.1` | Near-end language |
| `targetLanguage` | `string` | Yes | - | `0.0.1` | Far-end language |
| `agentId` | `string` | Yes | - | `0.0.1` | Agent ID |
| `complete` | `() => void` | No | - | - | Completion callback (executed on both success and failure) |
| `success` | `() => void` | No | - | - | Callback on successful API call |
| `fail` | `(params: Object) => void` ↓see below | No | - | - | Failure callback |

#### 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 { generateTranslateTask } = ai;

generateTranslateTask({
  deviceId: 'device_001',
  dataTimeout: 0,
  originalLanguage: 'example',
  targetLanguage: 'example',
  agentId: 'example',
  success: () => {
    console.log('generateTranslateTask success');
  },
  fail: (error) => {
    console.log('generateTranslateTask fail', error.errorMsg);
  },
});
```