Skip to content

Commit 966ab7a

Browse files
QuentinGabQuentinGab
committed
refactor to allow custom base_uri
1 parent 09e5653 commit 966ab7a

File tree

7 files changed

+65
-105
lines changed

7 files changed

+65
-105
lines changed

‎README.md‎

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ Easily manage all your Laravel translation strings with powerful features:
4242
- [Using Code](#using-code)
4343
1. [Automatic Translation](#automatic-translation)
4444
- [Configuring OpenAI](#configuring-openai)
45-
- [Configuring DeepL](#configuring-deepl)
45+
- [Using Claude](#using-claude)
4646
- [CLI Translation](#cli-translation)
4747
- [Programmatic Translation](#programmatic-translation)
4848
1. [Proofreading Translations](#proofreading-translations)
@@ -296,7 +296,7 @@ Service: `translate`.
296296
Before translating, configure a translation service. The package supports:
297297

298298
- **OpenAI**
299-
- **DeepL**
299+
- Any model compatible with the OpenAI SDK
300300

301301
Custom translation services can also be implemented.
302302

@@ -313,32 +313,38 @@ return [
313313
'key' => env('OPENAI_API_KEY'),
314314
'organization' => env('OPENAI_ORGANIZATION'),
315315
'request_timeout' => env('OPENAI_REQUEST_TIMEOUT'),
316+
'base_uri' => env('OPENAI_BASE_URI'),
317+
'project' => env('OPENAI_PROJECT'),
316318
],
317319
],
318320

319321
// ...
320322
];
321323
```
322324

323-
### Configuring DeepL
325+
### Using Claude
324326

325-
Add your DeepL API key to the configuration file or environment variables:
327+
Anthropic offers an [API compatible with the OpenAI SDK](https://docs.anthropic.com/en/api/openai-sdk). To integrate Claude using this SDK, you simply need to update the `base_uri` to point to Anthropic's endpoint and use your Anthropic API key.
328+
329+
Here’s a sample configuration in PHP:
326330

327331
```php
328332
return [
329333
// ...
330334

331335
'services' => [
332-
// ...
333-
'deepl' => [
334-
'key' => env('DEEPL_KEY'),
336+
'openai' => [
337+
'key' => env('ANTHROPIC_API_KEY'),
338+
'base_uri' => 'https://api.anthropic.com/v1',
335339
],
336340
],
337341

338342
// ...
339343
];
340344
```
341345

346+
> 💡 **Note:** Ensure your `ANTHROPIC_API_KEY` is set in your environment variables.
347+
342348
### CLI Translation
343349

344350
Display all keys defined in the source locale (English) but not translated in the target (French):

‎composer.json‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@
2020
],
2121
"require": {
2222
"php": "^8.2",
23-
"deeplcom/deepl-php": "^1.7",
2423
"illuminate/contracts": "^10.0||^11.0||^12.0",
2524
"nikic/php-parser": "^5.1",
2625
"openai-php/laravel": "^0.11",

‎config/translator.php‎

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,8 @@
6262
'key' => env('OPENAI_API_KEY'),
6363
'organization' => env('OPENAI_ORGANIZATION'),
6464
'request_timeout' => env('OPENAI_REQUEST_TIMEOUT'),
65+
'base_uri' => env('OPENAI_BASE_URI'),
66+
'project' => env('OPENAI_PROJECT'),
6567
],
6668
'deepl' => [
6769
'key' => env('DEEPL_KEY'),
@@ -86,12 +88,12 @@
8688
'services' => [
8789
'openai' => [
8890
'model' => 'gpt-4o-mini',
89-
'prompt' => "
90-
As an experienced copywriter and translator specializing in website copy, your task is to translate the provided content from a specific website.
91-
Your translations should maintain the original tone while being adapted to the target language, ensuring they are both relevant and clear.
92-
The content will be provided in JSON format, and you must translate it to the locale '{targetLocale}'.
93-
Ensure that all JSON keys remain preserved and unchanged.
94-
",
91+
'prompt' => '
92+
You are an experienced copywriter and translator with a focus on website content.
93+
Your task is to translate the provided website copy, formatted in JSON, into the target locale: {targetLocale}.
94+
Preserve all JSON keys exactly as they are.
95+
Adapt the tone, clarity, and relevance of the content to suit the target language while staying true to the original intent.
96+
',
9597
],
9698
],
9799
],
@@ -115,11 +117,11 @@
115117
'openai' => [
116118
'model' => 'gpt-4o-mini',
117119
'prompt' => '
118-
Fix the grammar and syntax of the following JSON string while respecting the following rules:
119-
- Never change the keys.
120-
- Do not escape or modify HTML tags.
121-
- Do not escape or modify special characters or emojis.
122-
- Do not change the meaning or tone of the sentences.
120+
Correct the grammar and syntax of the following JSON string while strictly adhering to these rules:
121+
- Do not modify the JSON keys.
122+
- Do not escape or alter HTML tags.
123+
- Do not escape or change special characters or emojis.
124+
- Preserve the original meaning and tone of each sentence.
123125
',
124126
],
125127
],

‎src/Services/Proofread/OpenAiService.php‎

Lines changed: 18 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,7 @@
1111
class OpenAiService implements ProofreadServiceInterface
1212
{
1313
public function __construct(
14-
public string $apiKey,
15-
public ?string $organization,
16-
public int $timeout,
14+
public \OpenAI\Client $client,
1715
public string $model,
1816
public string $prompt,
1917
) {
@@ -23,27 +21,33 @@ public function __construct(
2321
public static function make(): self
2422
{
2523
return new self(
26-
apiKey: config('translator.services.openai.key') ?? config('translator.translate.services.openai.key'),
27-
organization: config('translator.services.openai.organization') ?? config('translator.translate.services.openai.organization'),
28-
timeout: config('translator.services.openai.request_timeout') ?? config('translator.translate.services.openai.request_timeout') ?? 120,
24+
client: static::makeClient(),
2925
model: config('translator.proofread.services.openai.model'),
3026
prompt: config('translator.proofread.services.openai.prompt'),
3127
);
3228
}
3329

34-
public function getOpenAI(): \OpenAI\Client
30+
public static function makeClient(): \OpenAI\Client
3531
{
36-
if (blank($this->apiKey)) {
37-
throw throw new InvalidArgumentException(
38-
'The OpenAI API Key is missing. Please publish the [translator.php] configuration file and set the [translator.translate.services.openai.key].'
32+
$baseUri = config('translator.proofread.services.openai.base_uri') ?? config('translator.services.openai.base_uri') ?? 'api.openai.com/v1';
33+
$apiKey = config('translator.proofread.services.openai.key') ?? config('translator.services.openai.key');
34+
$organization = config('translator.proofread.services.openai.organization') ?? config('translator.services.openai.organization');
35+
$project = config('translator.proofread.services.openai.project') ?? config('translator.services.openai.project');
36+
$timeout = config('translator.proofread.services.openai.request_timeout') ?? config('translator.services.openai.request_timeout') ?? 120;
37+
38+
if (blank($apiKey)) {
39+
throw new InvalidArgumentException(
40+
'The OpenAI API Key is missing. Please publish the [translator.php] configuration file and set the [translator.services.openai.key] value.'
3941
);
4042
}
4143

4244
return OpenAI::factory()
43-
->withApiKey($this->apiKey)
44-
->withOrganization($this->organization)
45+
->withBaseUri($baseUri)
46+
->withApiKey($apiKey)
47+
->withOrganization($organization)
48+
->withProject($project)
4549
->withHttpHeader('OpenAI-Beta', 'assistants=v2')
46-
->withHttpClient(new \GuzzleHttp\Client(['timeout' => $this->timeout]))
50+
->withHttpClient(new \GuzzleHttp\Client(['timeout' => $timeout]))
4751
->make();
4852
}
4953

@@ -52,7 +56,7 @@ public function proofreadAll(array $texts): array
5256
return collect($texts)
5357
->chunk(20)
5458
->map(function (Collection $chunk) {
55-
$response = $this->getOpenAI()->chat()->create([
59+
$response = $this->client->chat()->create([
5660
'model' => $this->model,
5761
'response_format' => ['type' => 'json_object'],
5862
'messages' => [

‎src/Services/Translate/DeepLService.php‎

Lines changed: 0 additions & 55 deletions
This file was deleted.

‎src/Services/Translate/OpenAiService.php‎

Lines changed: 21 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,7 @@
1010
class OpenAiService implements TranslateServiceInterface
1111
{
1212
public function __construct(
13-
public string $apiKey,
14-
public ?string $organization,
15-
public int $timeout,
13+
public \OpenAI\Client $client,
1614
public string $model,
1715
public string $prompt,
1816
) {
@@ -22,34 +20,42 @@ public function __construct(
2220
public static function make(): self
2321
{
2422
return new self(
25-
apiKey: config('translator.services.openai.key') ?? config('translator.translate.services.openai.key'),
26-
organization: config('translator.services.openai.organization') ?? config('translator.translate.services.openai.organization'),
27-
timeout: config('translator.services.openai.request_timeout') ?? config('translator.translate.services.openai.request_timeout') ?? 120,
23+
client: static::makeClient(),
2824
model: config('translator.translate.services.openai.model'),
2925
prompt: config('translator.translate.services.openai.prompt'),
3026
);
3127
}
3228

33-
public function getOpenAI(): \OpenAI\Client
29+
public static function makeClient(): \OpenAI\Client
3430
{
35-
if (blank($this->apiKey)) {
36-
throw throw new InvalidArgumentException(
37-
'The OpenAI API Key is missing. Please publish the [translator.php] configuration file and set the [translator.translate.services.openai.key].'
31+
$baseUri = config('translator.translate.services.openai.base_uri') ?? config('translator.services.openai.base_uri') ?? 'api.openai.com/v1';
32+
$apiKey = config('translator.translate.services.openai.key') ?? config('translator.services.openai.key');
33+
$organization = config('translator.translate.services.openai.organization') ?? config('translator.services.openai.organization');
34+
$project = config('translator.translate.services.openai.project') ?? config('translator.services.openai.project');
35+
$timeout = config('translator.translate.services.openai.request_timeout') ?? config('translator.services.openai.request_timeout') ?? 120;
36+
37+
if (blank($apiKey)) {
38+
throw new InvalidArgumentException(
39+
'The OpenAI API Key is missing. Please publish the [translator.php] configuration file and set the [translator.services.openai.key] value.'
3840
);
3941
}
4042

41-
return OpenAI::client(
42-
apiKey: $this->apiKey,
43-
organization: $this->organization,
44-
);
43+
return OpenAI::factory()
44+
->withBaseUri($baseUri)
45+
->withApiKey($apiKey)
46+
->withOrganization($organization)
47+
->withProject($project)
48+
->withHttpHeader('OpenAI-Beta', 'assistants=v2')
49+
->withHttpClient(new \GuzzleHttp\Client(['timeout' => $timeout]))
50+
->make();
4551
}
4652

4753
public function translateAll(array $texts, string $targetLocale): array
4854
{
4955
return collect($texts)
5056
->chunk(20)
5157
->map(function ($chunk) use ($targetLocale) {
52-
$response = $this->getOpenAI()->chat()->create([
58+
$response = $this->client->chat()->create([
5359
'model' => $this->model,
5460
'response_format' => ['type' => 'json_object'],
5561
'messages' => [

‎src/TranslatorServiceProvider.php‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,6 @@
2323
use Elegantly\Translator\Services\Proofread\ProofreadServiceInterface;
2424
use Elegantly\Translator\Services\SearchCode\PhpParserService;
2525
use Elegantly\Translator\Services\SearchCode\SearchCodeServiceInterface;
26-
use Elegantly\Translator\Services\Translate\DeepLService;
2726
use Elegantly\Translator\Services\Translate\OpenAiService;
2827
use Elegantly\Translator\Services\Translate\TranslateServiceInterface;
2928
use Elegantly\Translator\Support\LocaleValidator;
@@ -89,7 +88,6 @@ public static function getTranslateServiceFromConfig(?string $serviceName = null
8988
}
9089

9190
return match ($service) {
92-
'deepl' => DeepLService::make(),
9391
'openai' => OpenAiService::make(),
9492
default => $service::make(),
9593
};

0 commit comments

Comments
 (0)