Enhance Yorkie Intelligence to support OpenAI-compatible providers (#578)

This commit adds support for OpenAI and OpenAI-compatible providers in
addition to Ollama. It also allows custom base URLs and API keys for
provider configuration.

Author: emplam27

backend/.env.development

@@ -50,8 +50,14 @@ YORKIE_API_ADDR=http://localhost:8080
 YORKIE_PROJECT_SECRET_KEY=""
 
 # YORKIE_INTELLIGENCE: Whether to enable Yorkie Intelligence for collaborative editing.
-# Available options: false, ollama:llama3.1, ollama:gemma2, ollama:gemma2:2b, ollama:phi3, ollama:mistral, ollama:neural-chat, ollama:starling-lm, ollama:solar, openai:gpt-3.5-turbo, openai:gpt-4o-mini, etc.
-# If set to openai:gpt-3.5-turbo or openai:gpt-4o-mini, OPENAI_API_KEY is not required.
+# Available providers:
+#   - ollama: Use Ollama models (requires OLLAMA_HOST_URL)
+#     Example: ollama:llama3.1, ollama:gemma2, ollama:gemma2:2b, ollama:phi3, ollama:mistral, ollama:neural-chat, ollama:starling-lm, ollama:solar
+#   - openai: Use OpenAI API (optionally use OPENAI_BASE_URL for custom endpoint)
+#     Example: openai:gpt-3.5-turbo, openai:gpt-4o-mini
+#   - openai-compat: Use OpenAI-compatible API servers (requires OPENAI_COMPAT_BASE_URL)
+#     Example: openai-compat:mistral-7b (for vLLM), openai-compat:gpt-3.5-turbo (for LocalAI)
+# Set to "false" to disable.
 YORKIE_INTELLIGENCE="ollama:llama3.2:1b"
 
 # OLLAMA_HOST_URL: yorkie-intelligence ollama url
@@ -61,6 +67,17 @@ OLLAMA_HOST_URL=http://localhost:11434
 # This key is required when the YORKIE_INTELLIGENCE is set to openai:gpt-3.5-turbo or openai:gpt-4o-mini.
 # To obtain an API key, visit OpenAI: https://help.openai.com/en/articles/4936850-where-do-i-find-my-api-key
 OPENAI_API_KEY=your_openai_api_key_here
+# OPENAI_BASE_URL: Custom base URL for OpenAI API (optional).
+# Use this to connect to OpenAI-compatible servers using the openai provider.
+# Example: https://your-openai-proxy.com/v1
+OPENAI_BASE_URL=
+
+# OPENAI_COMPAT_BASE_URL: Base URL for OpenAI-compatible API server (required for openai-compat provider).
+# Use this for vLLM, LocalAI, Ollama OpenAI mode, etc.
+# Example: http://localhost:8000/v1
+OPENAI_COMPAT_BASE_URL=
+# OPENAI_COMPAT_API_KEY: API key for OpenAI-compatible server (optional, some servers don't require it).
+OPENAI_COMPAT_API_KEY=
 
 # LANGCHAIN_TRACING_V2: Whether LangSmith monitoring for YorkieIntelligence is needed.
 # Set to true if LangSmith monitoring is required.

backend/README.md

@@ -80,6 +80,50 @@ pnpm backend start
 
 Starts the server in production mode.
 
+## Yorkie Intelligence Configuration
+
+Yorkie Intelligence provides AI-powered features for collaborative editing. You can configure it using the `YORKIE_INTELLIGENCE` environment variable in `.env.development`.
+
+### Available Providers
+
+| Provider          | Format                  | Description                                             | Required Environment Variables                               |
+| ----------------- | ----------------------- | ------------------------------------------------------- | ------------------------------------------------------------ |
+| **ollama**        | `ollama:<model>`        | Use local Ollama models                                 | `OLLAMA_HOST_URL`                                            |
+| **openai**        | `openai:<model>`        | Use OpenAI API                                          | `OPENAI_API_KEY`, optionally `OPENAI_BASE_URL`               |
+| **openai-compat** | `openai-compat:<model>` | Use OpenAI-compatible API servers (vLLM, LocalAI, etc.) | `OPENAI_COMPAT_BASE_URL`, optionally `OPENAI_COMPAT_API_KEY` |
+
+### Examples
+
+```bash
+# Disable Yorkie Intelligence
+YORKIE_INTELLIGENCE="false"
+
+# Use Ollama (local)
+YORKIE_INTELLIGENCE="ollama:llama3.2:1b"
+OLLAMA_HOST_URL="http://localhost:11434"
+
+# Use OpenAI
+YORKIE_INTELLIGENCE="openai:gpt-4o-mini"
+OPENAI_API_KEY="sk-xxx"
+
+# Use OpenAI with custom endpoint (proxy)
+YORKIE_INTELLIGENCE="openai:gpt-4"
+OPENAI_API_KEY="sk-xxx"
+OPENAI_BASE_URL="https://your-proxy.com/v1"
+
+# Use vLLM server
+YORKIE_INTELLIGENCE="openai-compat:mistral-7b"
+OPENAI_COMPAT_BASE_URL="http://localhost:8000/v1"
+
+# Use LocalAI
+YORKIE_INTELLIGENCE="openai-compat:gpt-3.5-turbo"
+OPENAI_COMPAT_BASE_URL="http://localhost:8080/v1"
+
+# Use Ollama in OpenAI-compatible mode
+YORKIE_INTELLIGENCE="openai-compat:llama3"
+OPENAI_COMPAT_BASE_URL="http://localhost:11434/v1"
+```
+
 ## Directory Structure
 
 ```

backend/src/langchain/langchain.module.ts

@@ -24,13 +24,37 @@ const chatModelFactory = {
 					streaming: true,
 				});
 			} else if (provider === "openai") {
-				chatModel = new ChatOpenAI({ modelName: model });
+				const baseURL = configService.get("OPENAI_BASE_URL");
+				chatModel = new ChatOpenAI({
+					modelName: model,
+					...(baseURL && { configuration: { baseURL } }),
+				});
+			} else if (provider === "openai-compat") {
+				const baseURL = configService.get("OPENAI_COMPAT_BASE_URL");
+				const apiKey = configService.get("OPENAI_COMPAT_API_KEY");
+
+				if (!baseURL) {
+					throw new Error(
+						"OPENAI_COMPAT_BASE_URL is required for openai-compat provider"
+					);
+				}
+
+				chatModel = new ChatOpenAI({
+					modelName: model,
+					configuration: {
+						baseURL,
+						...(apiKey && { apiKey }),
+					},
+				});
 			}
 
 			if (!chatModel) throw new Error();
 
 			return chatModel;
-		} catch {
+		} catch (error) {
+			if (error instanceof Error && error.message) {
+				throw error;
+			}
 			throw new Error(`${modelType} is not found. Please check your model name`);
 		}
 	},