Translating UI text fields

Overview

You can use Instructor to translate text fields in your UI. We can instruct the model to translate only the text fields from one language to another, but leave the other fields, like emails or URLs, unchanged.

This example demonstrates how to translate text fields from English to German using structure-to-structure processing with LLM.

Example

<?php
require 'examples/boot.php';

use Cognesy\Instructor\Extras\Scalar\Scalar;
use Cognesy\Instructor\StructuredOutput;
use Cognesy\Instructor\Validation\Contracts\CanValidateObject;
use Cognesy\Instructor\Validation\ValidationResult;
use Cognesy\Instructor\Validation\Validators\SymfonyValidator;
use Cognesy\Polyglot\Inference\Enums\OutputMode;

class TextElementModel
{
    public function __construct(
        public string $headline = '',
        public string $text = '',
        public string $url = 'https://translation.com/'
    ) {}
}

$sourceModel = new TextElementModel(
    headline: 'This is my headline',
    text: '<p>This is some WYSIWYG HTML content.</p>'
);

$validator = new class implements CanValidateObject {
    public function validate(object $dataObject): ValidationResult {
        $isInGerman = (new StructuredOutput)
            //->withDebugPreset('on')
            ->withInput($dataObject)
            ->withResponseObject(Scalar::boolean())
            ->withPrompt('Are all content fields translated to German? Return result in JSON format: <|json_schema|>')
            ->withOutputMode(OutputMode::Json)
            ->get();
        return match($isInGerman) {
            true => ValidationResult::valid(),
            default => ValidationResult::invalid(['All input text fields have to be translated to German. Keep HTML tags unchanged.']),
        };
    }
};

$transformedModel = (new StructuredOutput)
    //->withDebugPreset('on')
    //->wiretap(fn($e)=>$e->print())
    ->withInput($sourceModel)
    ->withResponseClass(get_class($sourceModel))
    ->withPrompt('Translate all text fields to German. Keep HTML tags unchanged. Return result in JSON format: <|json_schema|>')
    ->withMaxRetries(2)
    ->withOptions(['temperature' => 0])
    ->withOutputMode(OutputMode::Json)
    ->withValidators($validator, SymfonyValidator::class)
    ->get();

dump($transformedModel);

assert(true === (
    str_contains($transformedModel->headline, 'Überschrift')
    || str_contains($transformedModel->headline, 'Schlagzeile')
));
assert(str_contains($transformedModel->text, 'Inhalt') === true);
assert(str_contains($transformedModel->text, '<p>') === true);
assert(str_contains(str_replace('\/', '/', $transformedModel->url), 'https://translation.com/') === true);
?>