AiApi
extends AbstractApi
in package
Use API to leverage AI-powered translation of strings.
Table of Contents
Methods
- createFileTranslation() : AiFileTranslation|null
- AI File Translations
- deleteFileTranslation() : mixed
- Cancel File Translations
- downloadFileTranslation() : DownloadFile|null
- Download Translated File
- downloadFileTranslationStrings() : DownloadFile|null
- Download Translated File Strings
- getFileTranslation() : AiFileTranslation|null
- Get File Translations Status
- translateStrings() : AiTranslation|null
- AI Translate Strings
Methods
createFileTranslation()
AI File Translations
public
createFileTranslation(int $userId, array<string|int, mixed> $data) : AiFileTranslation|null
Parameters
- $userId : int
- $data : array<string|int, mixed>
-
integer $data[storageId] required
string $data[targetLanguageId] required
string $data[sourceLanguageId]
string $data[type]
integer $data[parserVersion]
array $data[tmIds]
array $data[glossaryIds]
integer $data[aiPromptId]
integer $data[aiProviderId]
string $data[aiModelId]
array $data[instructions]
array $data[attachmentIds]
Tags
Return values
AiFileTranslation|nulldeleteFileTranslation()
Cancel File Translations
public
deleteFileTranslation(int $userId, string $jobIdentifier) : mixed
Parameters
- $userId : int
- $jobIdentifier : string
Tags
downloadFileTranslation()
Download Translated File
public
downloadFileTranslation(int $userId, string $jobIdentifier) : DownloadFile|null
Parameters
- $userId : int
- $jobIdentifier : string
Tags
Return values
DownloadFile|nulldownloadFileTranslationStrings()
Download Translated File Strings
public
downloadFileTranslationStrings(int $userId, string $jobIdentifier) : DownloadFile|null
Parameters
- $userId : int
- $jobIdentifier : string
Tags
Return values
DownloadFile|nullgetFileTranslation()
Get File Translations Status
public
getFileTranslation(int $userId, string $jobIdentifier) : AiFileTranslation|null
Parameters
- $userId : int
- $jobIdentifier : string
Tags
Return values
AiFileTranslation|nulltranslateStrings()
AI Translate Strings
public
translateStrings(int $userId, array<string|int, mixed> $data) : AiTranslation|null
Parameters
- $userId : int
- $data : array<string|int, mixed>
-
array $data[strings] required
string $data[targetLanguageId] required
string $data[sourceLanguageId]
array $data[tmIds]
array $data[glossaryIds]
integer $data[aiPromptId]
integer $data[aiProviderId]
string $data[aiModelId]
array $data[instructions]
array $data[attachmentIds]