Skip to main content Skip to page footer

Overview

Since versions 12.19.0 / 13.13.0 / 14.1.0, the AI Suite provides console commands that allow integrators to automate AI Suite operations, such as metadata generation and translations, via the command line or the TYPO3 scheduler. Additionally, there is the backend module "AI Suite CLI" under Tools as a status overview. The prerequisite for execution is the permission "Enable CLI workflow execution" (enable_cli_workflow_execution); details can be found under Permission Management.

Command: ai-suite:execute-workflow

Executes an AI Suite workflow (metadata generation or translation) and creates tasks for later CLI processing. Main options:

  • --type, -t: Workflow type page, pageTranslate, fileReferences, fileMetadata, fileMetadataTranslation
  • --model, -m: AI model to be used
  • --start-from-pid: Start page ID (for page-based types)
  • --page-type, --depth, --column: Page type filter, traversal depth, column to be processed
  • --sys-language: System language (locale-ID)
  • --source-language, --target-language, --translation-scope (all | metadata | content): for translation workflows
  • --directory: directory to be processed, e.g., /, /user_upload/ or 1:/user_upload/
  • --show-only-empty, --show-only-used: consider only empty fields or only used files

Command: ai-suite:process-tasks

Queries the AI server for the status of the CLI-processed background tasks and stores completed results. This command is the ideal candidate for a recurring scheduler task that automatically processes the tasks created by execute-workflow.

Command: ai-suite:retry-tasks

Repeats failed CLI background tasks, currently limited to the status task-error.

  • --type, -t: Filter by task type (same types as in execute-workflow)
  • --model, -m: overrides the AI model used (if not specified, the original model of the task is used)

Backend Module "AI Suite CLI"

The module is located in the Tools area. It displays pending and failed CLI tasks, grouped by scope, including statistics and type filter. Additionally, it shows whether the TYPO3 scheduler is available and whether the command ai-suite:process-tasks has already been set up as a scheduler task.

Interaction & Prerequisites

The typical process: execute-workflow generates the tasks, process-tasks (ideally via scheduler) processes them, the CLI module monitors the status, and retry-tasks resets failed tasks.

Relevant settings in the Global Settings: maxTasks (maximum number of concurrently processed background tasks) as well as the GDPR mode. For background processing, the permission "Enable background task handling" is also required (see Permission Management).

Examples

Typical calls, each copyable by click. Replace [model] with the identifier of the desired AI model.

Generate page metadata

vendor/bin/typo3 ai-suite:execute-workflow -t page --start-from-pid=123 --depth=2 --show-only-empty -m [model]

Translate entire page

vendor/bin/typo3 ai-suite:execute-workflow -t pageTranslate --start-from-pid=123 --source-language=0 --target-language=1 --translation-scope=all -m [model]

Generate file metadata

vendor/bin/typo3 ai-suite:execute-workflow -t fileMetadata --directory="1:/user_upload/" --show-only-empty -m [model]

Process tasks (Scheduler)

vendor/bin/typo3 ai-suite:process-tasks

Retry failed tasks

vendor/bin/typo3 ai-suite:retry-tasks -t page