Repository navigation
Migrate to the task processing API #13115
Description
Translation and SpeechToText backend APIs are deprecated. Those features are now included in the task processing API (since 30).
The old APIs will stay a few more NC major version. The old SpeechToText API can now use the new providers (for TaskProcessing) so there is no rush to migrate.
The providers for the Translate API and the translation providers for the TaskProcessing API can be installed side by side so there is no rush to migrate there either.
Translation
You can use the assistant's UI to run translation tasks in the UI. If the assistant app is enabled, the OCA.Assistant.openAssistantForm function should be available.
if (OCA.Assistant.openAssistantForm) {
OCA.Assistant.openAssistantForm({
appId: 'spreed',
customId: 'message translation',
taskType: 'core:text2text:translate',
inputs: {
input: 'the content of the message',
},
closeOnResult: false,
}).then(task => {
if (task.status === 'STATUS_SUCCESSFUL') {
console.debug('assistant result task output', task.output.output)
} else {
console.debug('assistant result task', task)
}
})
}The promise will resolve if the task succeeds, fails or is scheduled for later by the user. The promise result is the task object.
The closeOnResult parameter of OCA.Assistant.openAssistantForm decides if the assistant is closed when the task succeeds of fails. It can be false to stay close to the current behaviour of the translate modal in Talk. The user sees the result in the assistant and there is a "copy" button. The user can then close the assistant modal.
SpeechToText
Transcription can be done with the core:audio2text task type of the taskProcessing API. More details on how to run such task in the backend in the Transcribe section of nextcloud/assistant#114
Activity
nickvergessen commentedon Aug 23, 2024
@julien-nc we have a bit of a problem here.
Translating chat messages
We need OCS APIs as our mobile and desktop clients are calling it, and they should "respond" with it and not be delegated to a background job (No one will wait 5 minutes on the translation of a chat message).
Transcription of call recordings
Can be done in a background job, should be fine (we do that now as well as far as I know)
nickvergessen commentedon Aug 23, 2024
Also the API endpoints in https://github.com/nextcloud/server/blob/bc5c0262af3cd375620d6534353a3842149ad6ab/core/Controller/TranslationApiController.php are not marked as
@deprecatedjulien-nc commentedon Aug 23, 2024
If the provider is an exApp, it will process tasks ASAP, no delay. If the provider is a Php app and
occ background-job:worker "OC\TaskProcessing\SynchronousBackgroundJob"is running, no delay either.Once the task is scheduled, the clients can poll it with
ocs/v2.php/taskprocessing/task/TASK_ID. That's what the assistant does in the frontend. No more blocking request as it could be too long and be killed but also it blocks a Php runner while waiting.nickvergessen commentedon Aug 23, 2024
So instead of getting a string returned the clients shall DOS the server.
The feature still breaks for existing clients.
45 remaining items
marcelklehr commentedon Feb 6, 2026
See how the text app implements this: https://github.com/nextcloud/text/blob/16a2fe039d9a9e0ac18f29e8e3b16c4795dfc9db/src/components/Modal/Translate.vue#L199-L232