Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/capevace/ai-translations-for-laravel
A Laravel package that can automatically translate your Laravel application's language files using LLMs with high accuracy and context awareness. Also includes tools for validation and partial translation for maintaining quality and consistency.
https://github.com/capevace/ai-translations-for-laravel
ai anthropic automation gemini laravel laravel-package llm localization openai php translation
Last synced: about 1 month ago
JSON representation
A Laravel package that can automatically translate your Laravel application's language files using LLMs with high accuracy and context awareness. Also includes tools for validation and partial translation for maintaining quality and consistency.
- Host: GitHub
- URL: https://github.com/capevace/ai-translations-for-laravel
- Owner: Capevace
- License: mit
- Created: 2024-12-04T01:09:07.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2024-12-04T12:29:10.000Z (about 2 months ago)
- Last Synced: 2024-12-04T13:28:10.422Z (about 2 months ago)
- Topics: ai, anthropic, automation, gemini, laravel, laravel-package, llm, localization, openai, php, translation
- Language: PHP
- Homepage:
- Size: 146 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Automatic AI Translations for Laravel 🤖
> Automatically translate your Laravel application's language files with high accuracy and context awareness using the power of LLMs.
>
> Translate to completely new languages or keep your existing language files up-to-date, without completely re-generating the full file.
>
> This package also includes tools for validation of the files, maintaining quality and consistency.
> [!NOTE]
> `mateffy/ai-translations` is still pre-release software and currently in beta.
>
> You can already install and use the package, but only with `dev-main` versioning, as some stuff may still be subject to change.
## ✨ Features
- 🔄 Automatic translation of Laravel language files
- 🌐 Translate to new languages or update existing ones without full regeneration
- 🧠 Context-aware translations
- 🔍 Smart detection of missing translations
- 💬 Interactive chat mode for translation refinement
- ✅ Validation tools for quality assurance
## 🚀 Usage
### Step 1: Install the package
```bash
composer require mateffy/ai-translations
```
### Step 2: Configure your LLM provider
This package supports many different LLM providers using [`mateffy/llm-magic`](https://github.com/capevace/llm-magic).
To use this package, you will need to configure your LLM provider, preferably Anthropic or OpenAI.
To do this, add the following variables to your `.env` file.
For other LLM configurations see the [`llm-magic` documentation](https://github.com/capevace/llm-magic).
```env
AI_TRANSLATIONS_MODEL=anthropic/claude-3.5-sonnet # default
ANTHROPIC_API_KEY=your-api-key
# or if you are using OpenAI:
AI_TRANSLATIONS_MODEL=openai/gpt-4o
OPENAI_API_KEY=your-api-key
OPENAI_ORGANIZATION=your-organization # optional
```
### Step 3: Translate your files!
You are now good to go. Use the `translate` update or create a language file, and use the `translate:validate` command to check for missing translations.
```bash
$ php artisan translate
AI Translator
Model: anthropic/claude-3-haiku-20240307
Source: de
Languages: cn, en, es, fr, it, pl
Domains: test
Translating from de to en: test
Generated translations for test from de to en:
okay_what_about_this.key: Okay, what about this?
okay_what_about_this.key2: Okay, what about this?
okay_what_about_this.key3: Okay, what about this?
...
```
## 🛠️ Commands
### Translate Files
```bash
php artisan translate
```
This command translates your language files to all configured languages. It:
1. Detects missing translations
2. Uses AI to generate appropriate translations
3. Writes the translations to your language files
**Options:**
- `--dry-run` : Preview translations without saving
- `--name=` : Translate a specific file only
- `--language=` : Translate to a specific language only
- `--base-language=` : Source language (defaults to `app.locale`)
### Validate Translations
```bash
php artisan translate:validate
```
Performs comprehensive validation of your translations by checking for missing keys.
**Options:**
- `--name=` : Validate specific file
- `--language=` : Validate specific language
- `--base-language=` : Source language for validation
```bash
$ php artisan translate:validate
AI Translator: Validation
Model: anthropic/claude-3-haiku-20240307
Source: de
Languages: cn, en, es, fr, it, pl
Domains: test
Checking test in es...
No missing translations for test in es
Checking test in fr...
****************************************************
* Missing translations for `test` in `fr`: *
****************************************************
+---------------+-------------+
| Key | Value |
+---------------+-------------+
| something_new | Etwas neues |
| testing | Testen |
+---------------+-------------+
...
```
### Add New Language
```bash
php artisan translate:add {language}
```
Adds a new language to your application by:
1. Creating the language directory
2. Translating all existing files to the new language
**Options:**
- `--base-language=` : Source language for translations
### Improve Translations
```bash
php artisan translate:improve {name} {language}
```
Opens an interactive chat session with the AI to refine translations for:
- Specific translation files
- Context-aware improvements
- Cultural nuances
**Options:**
- `--base-language=` : Source language for comparison
## 🔧 How It Works
The TranslationFile class reads Laravel's PHP language files into memory, preserving their nested array structure while allowing access through dot notation (e.g., 'auth.failed' => 'message'). It handles both reading existing translations and creating new language files.
When translating, the system always provides the full source and target language files to the LLM to ensure it has complete context about the existing translations and their relationships. This helps maintain consistency in terminology and style across the application.
The LLM then returns only the translated strings that need to be added or updated, using dot notation. This selective return is efficient as it allows precise updates without regenerating the entire translation file. These dot-notated translations are automatically merged into the existing translation structure, handling both new keys and updates to existing ones.
## ⚙️ Configuration
Configuration options in `config/ai-translations.php`:
```php
return [
// Supported languages (optional)
'languages' => ['en', 'de', 'fr', 'es'],
// Additional configuration options can be added here
];
```
## 🤝 Contributing
Contributions are welcome! Please feel free to submit pull requests.
## 📄 License
This package is open-source software licensed under the [MIT license](./LICENSE).