AiApi
extends AbstractApi
in package
Use API to manage AI providers, prompts, and leverage AI-powered translation.
Table of Contents
Methods
- clonePrompt() : AiPrompt|null
- Clone AI Prompt
- createFileTranslation() : AiFileTranslation|null
- AI File Translations
- createPrompt() : AiPrompt|null
- Add AI Prompt
- createPromptCompletion() : AiPromptCompletion|null
- Create AI Prompt Completion
- createProvider() : AiProvider|null
- Add AI Provider
- createProviderChatCompletion() : AiProxyChatCompletion|null
- Create AI Provider Chat Completion
- createSnippet() : AiSnippet|null
- Add AI Snippet
- deleteFileTranslation() : mixed
- Cancel File Translations
- deletePrompt() : mixed
- Delete AI Prompt
- deletePromptCompletion() : mixed
- Cancel AI Prompt Completion
- deleteProvider() : mixed
- Delete AI Provider
- deleteSnippet() : mixed
- Delete AI Snippet
- downloadFileTranslation() : DownloadFile|null
- Download Translated File
- downloadFileTranslationStrings() : DownloadFile|null
- Download File Strings
- downloadPromptCompletion() : DownloadFile|null
- Download AI Prompt Completion
- downloadReport() : DownloadFile|null
- Download AI Report
- generateReport() : AiReport|null
- Generate AI Report
- getFileTranslation() : AiFileTranslation|null
- Get File Translations Status
- getPrompt() : AiPrompt|null
- Get AI Prompt
- getPromptCompletion() : AiPromptCompletion|null
- Get AI Prompt Completion Status
- getProvider() : AiProvider|null
- Get AI Provider
- getReport() : AiReport|null
- Check AI Report Generation Status
- getSettings() : AiSettings|null
- Get AI Settings
- getSnippet() : AiSnippet|null
- Get AI Snippet
- listPrompts() : ModelCollection
- List AI Prompts
- listProviderModels() : ModelCollection
- List AI Provider Models
- listProviders() : ModelCollection
- List AI Providers
- listSnippets() : ModelCollection
- List AI Snippets
- translateStrings() : AiTranslation|null
- AI Translate Strings
- updatePrompt() : AiPrompt|null
- Edit AI Prompt
- updateProvider() : AiProvider|null
- Edit AI Provider
- updateSettings() : AiSettings|null
- Edit AI Settings
- updateSnippet() : AiSnippet|null
- Edit AI Snippet
Methods
clonePrompt()
Clone AI Prompt
public
clonePrompt(int $aiPromptId, array<string|int, mixed> $data) : AiPrompt|null
Parameters
- $aiPromptId : int
- $data : array<string|int, mixed>
-
string $data[name] required
Tags
Return values
AiPrompt|nullcreateFileTranslation()
AI File Translations
public
createFileTranslation(array<string|int, mixed> $data) : AiFileTranslation|null
Parameters
- $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|nullcreatePrompt()
Add AI Prompt
public
createPrompt(array<string|int, mixed> $data) : AiPrompt|null
Parameters
- $data : array<string|int, mixed>
-
string $data[name] required
string $data[action] required
array $data[config] required
integer $data[aiProviderId]
string $data[aiModelId]
boolean $data[isEnabled]
array $data[enabledProjectIds]
Tags
Return values
AiPrompt|nullcreatePromptCompletion()
Create AI Prompt Completion
public
createPromptCompletion(int $aiPromptId, array<string|int, mixed> $data) : AiPromptCompletion|null
Parameters
- $aiPromptId : int
- $data : array<string|int, mixed>
-
array $data[resources] required
array $data[tools]
mixed $data[tool_choice]
Tags
Return values
AiPromptCompletion|nullcreateProvider()
Add AI Provider
public
createProvider(array<string|int, mixed> $data) : AiProvider|null
Parameters
- $data : array<string|int, mixed>
-
string $data[name] required
string $data[type] required
array $data[credentials]
array $data[config]
boolean $data[isEnabled]
boolean $data[useSystemCredentials]
Tags
Return values
AiProvider|nullcreateProviderChatCompletion()
Create AI Provider Chat Completion
public
createProviderChatCompletion(int $aiProviderId, array<string|int, mixed> $data) : AiProxyChatCompletion|null
Parameters
- $aiProviderId : int
- $data : array<string|int, mixed>
-
string $data[model]
boolean $data[stream]
Tags
Return values
AiProxyChatCompletion|nullcreateSnippet()
Add AI Snippet
public
createSnippet(array<string|int, mixed> $data) : AiSnippet|null
Parameters
- $data : array<string|int, mixed>
-
string $data[description] required
string $data[placeholder] required
string $data[value] required
Tags
Return values
AiSnippet|nulldeleteFileTranslation()
Cancel File Translations
public
deleteFileTranslation(string $jobIdentifier) : mixed
Parameters
- $jobIdentifier : string
Tags
deletePrompt()
Delete AI Prompt
public
deletePrompt(int $aiPromptId) : mixed
Parameters
- $aiPromptId : int
Tags
deletePromptCompletion()
Cancel AI Prompt Completion
public
deletePromptCompletion(int $aiPromptId, string $completionId) : mixed
Parameters
- $aiPromptId : int
- $completionId : string
Tags
deleteProvider()
Delete AI Provider
public
deleteProvider(int $aiProviderId) : mixed
Parameters
- $aiProviderId : int
Tags
deleteSnippet()
Delete AI Snippet
public
deleteSnippet(int $aiSnippetId) : mixed
Parameters
- $aiSnippetId : int
Tags
downloadFileTranslation()
Download Translated File
public
downloadFileTranslation(string $jobIdentifier) : DownloadFile|null
Parameters
- $jobIdentifier : string
Tags
Return values
DownloadFile|nulldownloadFileTranslationStrings()
Download File Strings
public
downloadFileTranslationStrings(string $jobIdentifier) : DownloadFile|null
Parameters
- $jobIdentifier : string
Tags
Return values
DownloadFile|nulldownloadPromptCompletion()
Download AI Prompt Completion
public
downloadPromptCompletion(int $aiPromptId, string $completionId) : DownloadFile|null
Parameters
- $aiPromptId : int
- $completionId : string
Tags
Return values
DownloadFile|nulldownloadReport()
Download AI Report
public
downloadReport(string $aiReportId) : DownloadFile|null
Parameters
- $aiReportId : string
Tags
Return values
DownloadFile|nullgenerateReport()
Generate AI Report
public
generateReport(array<string|int, mixed> $data) : AiReport|null
Parameters
- $data : array<string|int, mixed>
-
string $data[type] required
array $data[schema] required
Tags
Return values
AiReport|nullgetFileTranslation()
Get File Translations Status
public
getFileTranslation(string $jobIdentifier) : AiFileTranslation|null
Parameters
- $jobIdentifier : string
Tags
Return values
AiFileTranslation|nullgetPrompt()
Get AI Prompt
public
getPrompt(int $aiPromptId) : AiPrompt|null
Parameters
- $aiPromptId : int
Tags
Return values
AiPrompt|nullgetPromptCompletion()
Get AI Prompt Completion Status
public
getPromptCompletion(int $aiPromptId, string $completionId) : AiPromptCompletion|null
Parameters
- $aiPromptId : int
- $completionId : string
Tags
Return values
AiPromptCompletion|nullgetProvider()
Get AI Provider
public
getProvider(int $aiProviderId) : AiProvider|null
Parameters
- $aiProviderId : int
Tags
Return values
AiProvider|nullgetReport()
Check AI Report Generation Status
public
getReport(string $aiReportId) : AiReport|null
Parameters
- $aiReportId : string
Tags
Return values
AiReport|nullgetSettings()
Get AI Settings
public
getSettings() : AiSettings|null
Tags
Return values
AiSettings|nullgetSnippet()
Get AI Snippet
public
getSnippet(int $aiSnippetId) : AiSnippet|null
Parameters
- $aiSnippetId : int
Tags
Return values
AiSnippet|nulllistPrompts()
List AI Prompts
public
listPrompts([array<string|int, mixed> $params = [] ]) : ModelCollection
Parameters
- $params : array<string|int, mixed> = []
-
integer $params[projectId]
string $params[action]
integer $params[limit]
integer $params[offset]
Tags
Return values
ModelCollectionlistProviderModels()
List AI Provider Models
public
listProviderModels(int $aiProviderId[, array<string|int, mixed> $params = [] ]) : ModelCollection
Parameters
- $aiProviderId : int
- $params : array<string|int, mixed> = []
-
integer $params[limit]
integer $params[offset]
Tags
Return values
ModelCollectionlistProviders()
List AI Providers
public
listProviders([array<string|int, mixed> $params = [] ]) : ModelCollection
Parameters
- $params : array<string|int, mixed> = []
-
integer $params[limit]
integer $params[offset]
Tags
Return values
ModelCollectionlistSnippets()
List AI Snippets
public
listSnippets([array<string|int, mixed> $params = [] ]) : ModelCollection
Parameters
- $params : array<string|int, mixed> = []
-
integer $params[limit]
integer $params[offset]
Tags
Return values
ModelCollectiontranslateStrings()
AI Translate Strings
public
translateStrings(array<string|int, mixed> $data) : AiTranslation|null
Parameters
- $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]
Tags
Return values
AiTranslation|nullupdatePrompt()
Edit AI Prompt
public
updatePrompt(AiPrompt $aiPrompt) : AiPrompt|null
Parameters
- $aiPrompt : AiPrompt
Tags
Return values
AiPrompt|nullupdateProvider()
Edit AI Provider
public
updateProvider(AiProvider $aiProvider) : AiProvider|null
Parameters
- $aiProvider : AiProvider
Tags
Return values
AiProvider|nullupdateSettings()
Edit AI Settings
public
updateSettings(AiSettings $aiSettings) : AiSettings|null
Parameters
- $aiSettings : AiSettings
Tags
Return values
AiSettings|nullupdateSnippet()
Edit AI Snippet
public
updateSnippet(AiSnippet $aiSnippet) : AiSnippet|null
Parameters
- $aiSnippet : AiSnippet