Add support for openai-compatible models

Author: icodesign

.changeset/dry-news-joke.md

@@ -0,0 +1,5 @@
+---
+'@rootapp/dolphin': patch
+---
+
+Add support for openai-compatible models

README.md

@@ -69,7 +69,9 @@ Dolphin defines an interface for translators to implement, which is responsible
 
 #### openai
 
-This is a local translator which uses OpenAI API to translate strings. To use this translator, you need to provide the OpenAI API key as an environment variable (`OPENAI_API_KEY`) or pass it to the translator with the `apiKey` option.
+This is a local translator which uses OpenAI API to translate strings. To use this translator, you need to provide the OpenAI API key as an environment variable (`OPENAI_API_KEY`) or pass it to the translator with the `apiKey` option. Optionally, you can specify the model to use with the `model` option. By default, it uses `gpt-4o` model.
+
+The translator also supports any openai-comptable models, such as gemini and deepseek. However, the model needs support json response format, for major supported models, please refer to [OpenRouter website](https://openrouter.ai/models?fmt=cards&supported_parameters=response_format&order=top-weekly). To use a custom OpenAI-compatible endpoint, you can provide the `baseUrl` option to the translator.
 
 #### api
 
@@ -145,7 +147,7 @@ The source language of the strings, which is used to translate from.
 
 Supported translators:
 
-- **openai**: OpenAI API. You need to provide the OpenAI API key as an environment variable (`OPENAI_API_KEY`) or pass it to the translator with the `apiKey` option. By default, it uses `gpt-4o` model, which can be customized with the `model` option.
+- **openai**: OpenAI API. You need to provide the OpenAI API key as an environment variable (`OPENAI_API_KEY`) or pass it to the translator with the `apiKey` option. By default, it uses `gpt-4o` model, which can be customized with the `model` option. Optionally, you can provide the `baseUrl` to use a custom OpenAI-compatible endpoint.
 - **api**: Dolphin API. You need to provide the `baseUrl` to the API endpoint.
 
 Supported modes:

packages/base/src/config.ts

@@ -72,6 +72,7 @@ const DolphinTranslatorConfigSchema = CommonTranslatorConfigSchema.extend({
 
 const OpenAITranslatorConfigSchema = CommonTranslatorConfigSchema.extend({
   agent: z.literal('openai'),
+  baseUrl: z.string().optional(),
   apiKey: z.string().optional(),
   model: z.string().optional(),
 }).merge(LLMTranslatorConfigSchema);

packages/provider/src/openai.ts

@@ -10,8 +10,9 @@ export class OpenAITranslationProvider implements TranslationProvider {
   private openai: OpenAIProvider;
   private model: LanguageModel;
 
-  constructor(options: { apiKey: string; model?: string }) {
+  constructor(options: { apiKey: string; baseUrl?: string; model?: string }) {
     this.openai = createOpenAI({
+      baseURL: options.baseUrl,
       apiKey: options.apiKey,
       compatibility: 'strict', // https://sdk.vercel.ai/providers/ai-sdk-providers/openai#provider-instance
     });

packages/translate/src/index.ts

@@ -211,6 +211,7 @@ async function translateStrings(
     }
     translator = new OpenAITranslator({
       apiKey,
+      baseUrl: config.translator.baseUrl,
       model: config.translator.model,
       maxRetry: config.translator.maxRetry,
     });

packages/translate/src/translator/openai/index.ts

@@ -22,9 +22,11 @@ export class OpenAITranslator implements Translator {
   constructor({
     apiKey,
     model,
+    baseUrl,
     maxRetry = 1,
   }: {
     apiKey: string;
+    baseUrl?: string;
     model?: string;
     maxRetry: number;
   }) {
@@ -34,7 +36,7 @@ export class OpenAITranslator implements Translator {
       totalTokens: 0,
     };
     this.maxRetry = maxRetry;
-    this.provider = new OpenAITranslationProvider({ apiKey, model });
+    this.provider = new OpenAITranslationProvider({ baseUrl, apiKey, model });
   }
 
   async config(): Promise<LLMTranslatorConfig> {