shiyue/upage-git
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

chore: merge openai and openailike

Browse Source
This commit is contained in:
LIlGG
2025-09-29 11:34:40 +08:00
parent a47590fe23
commit 6ca57be607
16 changed files with 82 additions and 146 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
.env.example
View File

@@ -20,10 +20,10 @@ MAX_UPLOAD_SIZE_MB=5
DEFAULT_NUM_CTX= DEFAULT_NUM_CTX=
# LLM Configuration Options # LLM Configuration Options
# Enabled model providers, currently supporting Anthropic, Cohere, Deepseek, Google, Groq, HuggingFace, Hyperbolic, Mistral, Ollama, OpenAI, OpenRouter, OpenAILike, Perplexity, xAI, Together, LMStudio, AmazonBedrock, Github # Enabled model providers, currently supporting Anthropic, Cohere, DeepSeek, Google, Groq, HuggingFace, Hyperbolic, Mistral, Ollama, OpenAI, OpenRouter, Perplexity, xAI, Together, LMStudio, AmazonBedrock, Github
LLM_PROVIDER= LLM_PROVIDER=
# BASE URL of the current model provider, some providers require this to be set, such as OpenAILike, Ollama, LMStudio # BASE URL of the current model provider, some providers require this to be set, such as OpenAI, Ollama, LMStudio
# DONT USE http://localhost:11434 due to IPV6 issues # DONT USE http://localhost:11434 due to IPV6 issues
# USE EXAMPLE http://127.0.0.1:11434 # USE EXAMPLE http://127.0.0.1:11434
PROVIDER_BASE_URL= PROVIDER_BASE_URL=

24
.github/workflows/docs.yaml vendored
View File

@@ -7,10 +7,18 @@ on:
paths: paths:
- 'docs/**' - 'docs/**'
permissions: permissions:
contents: write contents: read
pages: write
id-token: write
jobs: jobs:
build_docs: build_docs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
concurrency:
group: "pages"
cancel-in-progress: false
steps: steps:
- uses: actions/checkout@v4 - uses: actions/checkout@v4
@@ -37,8 +45,14 @@ jobs:
- name: Build docs website - name: Build docs website
run: pnpm run docs:build run: pnpm run docs:build
- name: Deploy to GitHub Pages - name: Setup Pages
uses: peaceiris/actions-gh-pages@v3 uses: actions/configure-pages@v4
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with: with:
github_token: ${{ secrets.GITHUB_TOKEN }} path: ./docs/build
publish_dir: ./docs/build
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4

10
README.md
View File

@@ -36,9 +36,9 @@ docker run -d \
--name upage \ --name upage \
--restart unless-stopped \ --restart unless-stopped \
-p 3000:3000 \ -p 3000:3000 \
-e LLM_PROVIDER=OpenAILike \ -e LLM_PROVIDER=OpenAI \
-e PROVIDER_BASE_URL=your-provider-base-url \ -e PROVIDER_BASE_URL=your-provider-base-url \
-e PROVIDER_API_KEY=your-openai-like-api-key \ -e PROVIDER_API_KEY=your-openai-api-key \
-e LLM_DEFAULT_MODEL=your-default-model \ -e LLM_DEFAULT_MODEL=your-default-model \
-e LLM_MINOR_MODEL=your-minor-model \ -e LLM_MINOR_MODEL=your-minor-model \
-v ./data:/app/data \ -v ./data:/app/data \
@@ -48,9 +48,9 @@ docker run -d \
``` ```
其中参数说明如下： 其中参数说明如下：
- `-e LLM_PROVIDER=OpenAILike`：设置默认的 LLM 提供商为 OpenAILike，即兼容 OpenAI 的 API 接口。 - `-e LLM_PROVIDER=OpenAI`：设置默认的 LLM 提供商为 OpenAI，同时兼容支持 OpenAI 规范的 API 接口。
- `-e PROVIDER_BASE_URL=your-provider-base-url`：设置 LLM 提供商的 API 基础 URL，部分提供商需要设置此项，例如 OpenAILike, Ollama, LMStudio。 - `-e PROVIDER_BASE_URL=your-provider-base-url`：设置 LLM 提供商的 API 基础 URL，部分提供商需要设置此项，例如 Ollama, LMStudio。OpenAI 提供商可选此项。
- `-e PROVIDER_API_KEY=your-openai-like-api-key`：设置 LLM 提供商的 API 密钥，大部分提供商需要设置此项。 - `-e PROVIDER_API_KEY=your-openai-api-key`：设置 LLM 提供商的 API 密钥，大部分提供商需要设置此项。
- `-e LLM_DEFAULT_MODEL=your-default-model`：设置默认的 LLM 模型，用于构建页面。 - `-e LLM_DEFAULT_MODEL=your-default-model`：设置默认的 LLM 模型，用于构建页面。
- `-e LLM_MINOR_MODEL=your-minor-model`：设置次要的 LLM 模型，用于执行其他任务。 - `-e LLM_MINOR_MODEL=your-minor-model`：设置次要的 LLM 模型，用于执行其他任务。
- `-v ./data:/app/data`：挂载数据目录 - `-v ./data:/app/data`：挂载数据目录

8
app/lib/modules/llm/providers/deepseek.ts
View File

@@ -5,7 +5,7 @@ import type { ModelInfo } from '~/lib/modules/llm/types';
import type { IProviderSetting } from '~/types/model'; import type { IProviderSetting } from '~/types/model';
export default class DeepseekProvider extends BaseProvider { export default class DeepseekProvider extends BaseProvider {
name = 'Deepseek'; name = 'DeepSeek';
getApiKeyLink = 'https://platform.deepseek.com/apiKeys'; getApiKeyLink = 'https://platform.deepseek.com/apiKeys';
config = { config = {
@@ -14,9 +14,9 @@ export default class DeepseekProvider extends BaseProvider {
}; };
staticModels: ModelInfo[] = [ staticModels: ModelInfo[] = [
{ name: 'deepseek-coder', label: 'Deepseek-Coder', provider: 'Deepseek', maxTokenAllowed: 8000 }, { name: 'deepseek-coder', label: 'DeepSeek-Coder', provider: 'DeepSeek', maxTokenAllowed: 8000 },
{ name: 'deepseek-chat', label: 'Deepseek-Chat', provider: 'Deepseek', maxTokenAllowed: 8000 }, { name: 'deepseek-chat', label: 'DeepSeek-Chat', provider: 'DeepSeek', maxTokenAllowed: 8000 },
{ name: 'deepseek-reasoner', label: 'Deepseek-Reasoner', provider: 'Deepseek', maxTokenAllowed: 8000 }, { name: 'deepseek-reasoner', label: 'DeepSeek-Reasoner', provider: 'DeepSeek', maxTokenAllowed: 8000 },
]; ];
getModelInstance(options: { model: string; providerSettings?: Record<string, IProviderSetting> }): LanguageModel { getModelInstance(options: { model: string; providerSettings?: Record<string, IProviderSetting> }): LanguageModel {

2
app/lib/modules/llm/providers/groq.ts
View File

@@ -17,7 +17,7 @@ export default class GroqProvider extends BaseProvider {
{ name: 'llama-3.3-70b-versatile', label: 'Llama 3.3 70b (Groq)', provider: 'Groq', maxTokenAllowed: 8000 }, { name: 'llama-3.3-70b-versatile', label: 'Llama 3.3 70b (Groq)', provider: 'Groq', maxTokenAllowed: 8000 },
{ {
name: 'deepseek-r1-distill-llama-70b', name: 'deepseek-r1-distill-llama-70b',
label: 'Deepseek R1 Distill Llama 70b (Groq)', label: 'DeepSeek R1 Distill Llama 70b (Groq)',
provider: 'Groq', provider: 'Groq',
maxTokenAllowed: 131072, maxTokenAllowed: 131072,
}, },

2
app/lib/modules/llm/providers/open-router.ts
View File

@@ -37,7 +37,7 @@ export default class OpenRouterProvider extends BaseProvider {
}, },
{ {
name: 'deepseek/deepseek-coder', name: 'deepseek/deepseek-coder',
label: 'Deepseek-Coder V2 236B (OpenRouter)', label: 'DeepSeek-Coder V2 236B (OpenRouter)',
provider: 'OpenRouter', provider: 'OpenRouter',
maxTokenAllowed: 8000, maxTokenAllowed: 8000,
}, },

46
app/lib/modules/llm/providers/openai-like.ts
View File

@@ -1,46 +0,0 @@
import type { LanguageModel } from 'ai';
import { BaseProvider, getOpenAILikeModel } from '~/lib/modules/llm/base-provider';
import type { ModelInfo } from '~/lib/modules/llm/types';
import type { IProviderSetting } from '~/types/model';
export default class OpenAILikeProvider extends BaseProvider {
name = 'OpenAILike';
getApiKeyLink = undefined;
staticModels: ModelInfo[] = [];
async getDynamicModels(settings?: IProviderSetting): Promise<ModelInfo[]> {
const { baseUrl, apiKey } = this.getProviderBaseUrlAndKey(settings);
if (!baseUrl || !apiKey) {
return [];
}
const response = await fetch(`${baseUrl}/models`, {
headers: {
Authorization: `Bearer ${apiKey}`,
},
});
const res = (await response.json()) as any;
return res.data.map((model: any) => ({
name: model.id,
label: model.id,
provider: this.name,
maxTokenAllowed: 8000,
}));
}
getModelInstance(options: { model: string; providerSettings?: Record<string, IProviderSetting> }): LanguageModel {
const { model, providerSettings } = options;
const { baseUrl, apiKey } = this.getProviderBaseUrlAndKey(providerSettings?.[this.name]);
if (!baseUrl || !apiKey) {
throw new Error(`Missing configuration for ${this.name} provider`);
}
return getOpenAILikeModel(baseUrl, apiKey, model);
}
}

41
app/lib/modules/llm/providers/openai.ts
View File

@@ -4,59 +4,46 @@ import { BaseProvider } from '~/lib/modules/llm/base-provider';
import type { ModelInfo } from '~/lib/modules/llm/types'; import type { ModelInfo } from '~/lib/modules/llm/types';
import type { IProviderSetting } from '~/types/model'; import type { IProviderSetting } from '~/types/model';
export default class OpenAIProvider extends BaseProvider { export default class OpenAILikeProvider extends BaseProvider {
name = 'OpenAI'; name = 'OpenAI';
getApiKeyLink = 'https://platform.openai.com/api-keys'; getApiKeyLink = undefined;
staticModels: ModelInfo[] = [ staticModels: ModelInfo[] = [];
{ name: 'gpt-4o', label: 'GPT-4o', provider: 'OpenAI', maxTokenAllowed: 8000 },
{ name: 'gpt-4o-mini', label: 'GPT-4o Mini', provider: 'OpenAI', maxTokenAllowed: 8000 },
{ name: 'gpt-4-turbo', label: 'GPT-4 Turbo', provider: 'OpenAI', maxTokenAllowed: 8000 },
{ name: 'gpt-4', label: 'GPT-4', provider: 'OpenAI', maxTokenAllowed: 8000 },
{ name: 'gpt-3.5-turbo', label: 'GPT-3.5 Turbo', provider: 'OpenAI', maxTokenAllowed: 8000 },
];
async getDynamicModels(settings?: IProviderSetting): Promise<ModelInfo[]> { async getDynamicModels(settings?: IProviderSetting): Promise<ModelInfo[]> {
const { apiKey } = this.getProviderBaseUrlAndKey(settings); const { baseUrl, apiKey } = this.getProviderBaseUrlAndKey(settings);
if (!apiKey) { if (!baseUrl || !apiKey) {
throw `Missing Api Key configuration for ${this.name} provider`; return [];
} }
const response = await fetch(`https://api.openai.com/v1/models`, { const response = await fetch(`${baseUrl}/models`, {
headers: { headers: {
Authorization: `Bearer ${apiKey}`, Authorization: `Bearer ${apiKey}`,
}, },
}); });
const res = (await response.json()) as any; const res = (await response.json()) as any;
const staticModelIds = this.staticModels.map((m) => m.name);
const data = res.data.filter( return res.data.map((model: any) => ({
(model: any) => name: model.id,
model.object === 'model' && label: model.id,
(model.id.startsWith('gpt-') || model.id.startsWith('o') || model.id.startsWith('chatgpt-')) &&
!staticModelIds.includes(model.id),
);
return data.map((m: any) => ({
name: m.id,
label: `${m.id}`,
provider: this.name, provider: this.name,
maxTokenAllowed: m.context_window || 32000, maxTokenAllowed: 8000,
})); }));
} }
getModelInstance(options: { model: string; providerSettings?: Record<string, IProviderSetting> }): LanguageModel { getModelInstance(options: { model: string; providerSettings?: Record<string, IProviderSetting> }): LanguageModel {
const { model, providerSettings } = options; const { model, providerSettings } = options;
const { apiKey } = this.getProviderBaseUrlAndKey(providerSettings?.[this.name]); const { baseUrl, apiKey } = this.getProviderBaseUrlAndKey(providerSettings?.[this.name]);
if (!apiKey) { if (!apiKey) {
throw new Error(`Missing API key for ${this.name} provider`); throw new Error(`Missing configuration for ${this.name} provider`);
} }
const openai = createOpenAI({ const openai = createOpenAI({
baseURL: baseUrl,
apiKey, apiKey,
}); });

2
app/lib/modules/llm/registry.ts
View File

@@ -12,7 +12,6 @@ import MistralProvider from './providers/mistral';
import OllamaProvider from './providers/ollama'; import OllamaProvider from './providers/ollama';
import OpenRouterProvider from './providers/open-router'; import OpenRouterProvider from './providers/open-router';
import OpenAIProvider from './providers/openai'; import OpenAIProvider from './providers/openai';
import OpenAILikeProvider from './providers/openai-like';
import PerplexityProvider from './providers/perplexity'; import PerplexityProvider from './providers/perplexity';
import TogetherProvider from './providers/together'; import TogetherProvider from './providers/together';
import XAIProvider from './providers/xai'; import XAIProvider from './providers/xai';
@@ -29,7 +28,6 @@ export {
OllamaProvider, OllamaProvider,
OpenAIProvider, OpenAIProvider,
OpenRouterProvider, OpenRouterProvider,
OpenAILikeProvider,
PerplexityProvider, PerplexityProvider,
XAIProvider, XAIProvider,
TogetherProvider, TogetherProvider,

3
app/lib/stores/settings.ts
View File

@@ -25,9 +25,6 @@ export interface Shortcuts {
toggleTheme: Shortcut; toggleTheme: Shortcut;
} }
export const URL_CONFIGURABLE_PROVIDERS = ['Ollama', 'LMStudio', 'OpenAILike'];
export const LOCAL_PROVIDERS = ['OpenAILike', 'LMStudio', 'Ollama'];
// Simplified shortcuts store with only theme toggle // Simplified shortcuts store with only theme toggle
export const shortcutsStore = map<Shortcuts>({ export const shortcutsStore = map<Shortcuts>({
toggleTheme: { toggleTheme: {

18
docs/content/configuration.md
View File

@@ -38,7 +38,7 @@ UPage 支持多种 AI 提供商，您需要配置一个 AI 提供商才能使用
| 环境变量 | 描述 | 默认值 | 必填 | | 环境变量 | 描述 | 默认值 | 必填 |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `LLM_PROVIDER` | LLM 提供商，按照下述配置项配置一个 | - | 是 | | `LLM_PROVIDER` | LLM 提供商，按照下述配置项配置一个 | - | 是 |
| <span className="base-url-highlight">`PROVIDER_BASE_URL`</span> | LLM 提供商的 API 基础 URL，部分提供商需要设置此项，例如 OpenAILike, Ollama, LMStudio | - | 否，部分提供商不需要设置此项 | | <span className="base-url-highlight">`PROVIDER_BASE_URL`</span> | LLM 提供商的 API 基础 URL，部分提供商需要设置此项，例如 Ollama, LMStudio。 OpenAI 可选此项 | - | 否，部分提供商不需要设置此项 |
| <span className="api-key-highlight">`PROVIDER_API_KEY`</span> | LLM 提供商的 API 密钥，大部分提供商需要设置此项 | - | 否，部分提供商不需要设置此项 | | <span className="api-key-highlight">`PROVIDER_API_KEY`</span> | LLM 提供商的 API 密钥，大部分提供商需要设置此项 | - | 否，部分提供商不需要设置此项 |
| `LLM_DEFAULT_MODEL` | 生成页面所使用的模型 | - | 是 | | `LLM_DEFAULT_MODEL` | 生成页面所使用的模型 | - | 是 |
| `LLM_MINOR_MODEL` | 辅助页面生成所使用的模型 | - | 是 | | `LLM_MINOR_MODEL` | 辅助页面生成所使用的模型 | - | 是 |
@@ -95,7 +95,7 @@ UPage 支持多种 AI 提供商，您需要配置一个 AI 提供商才能使用
| 环境变量 | 描述 | 默认值 | 必填 | | 环境变量 | 描述 | 默认值 | 必填 |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `LLM_PROVIDER` | DeepSeek 提供商名称 | Deepseek | 是 | | `LLM_PROVIDER` | DeepSeek 提供商名称 | DeepSeek | 是 |
| <span className="api-key-highlight">`PROVIDER_API_KEY`</span> | DeepSeek API 密钥 | - | 是（如果使用 DeepSeek） | | <span className="api-key-highlight">`PROVIDER_API_KEY`</span> | DeepSeek API 密钥 | - | 是（如果使用 DeepSeek） |
:::info :::info
@@ -201,19 +201,12 @@ UPage 支持多种 AI 提供商，您需要配置一个 AI 提供商才能使用
前往 [OpenRouter](https://openrouter.ai/settings/keys) 获取 API 密钥。 前往 [OpenRouter](https://openrouter.ai/settings/keys) 获取 API 密钥。
::: :::
### 兼容 OpenAI 接口的服务
| 环境变量 | 描述 | 默认值 | 必填 |
| --- | --- | --- | --- |
| `LLM_PROVIDER` | OpenAILike 提供商名称 | OpenAILike | 是 |
| <span className="base-url-highlight">`PROVIDER_BASE_URL`</span> | API 基础 URL | - | 是（如果使用 OpenAILike） |
| <span className="api-key-highlight">`PROVIDER_API_KEY`</span> | API 密钥 | - | 是（如果使用 OpenAILike） |
### OpenAI ### OpenAI
| 环境变量 | 描述 | 默认值 | 必填 | | 环境变量 | 描述 | 默认值 | 必填 |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `LLM_PROVIDER` | OpenAI 提供商名称 | OpenAI | 是 | | `LLM_PROVIDER` | OpenAI 提供商名称 | OpenAI | 是 |
| <span className="base-url-highlight">`PROVIDER_BASE_URL`</span> | API 基础 URL | - | 否（不填写时，使用 OpenAI 官方 API） |
| <span className="api-key-highlight">`PROVIDER_API_KEY`</span> | OpenAI API 密钥 | - | 是（如果使用 OpenAI） | | <span className="api-key-highlight">`PROVIDER_API_KEY`</span> | OpenAI API 密钥 | - | 是（如果使用 OpenAI） |
:::info :::info
@@ -358,8 +351,9 @@ services:
ports: ports:
- "3000:3000" - "3000:3000"
environment: environment:
# 使用 OpenAI 兼容接口的提供商配置 # 使用 OpenAI 提供商配置，同时兼容 OpenAI 规范的 API 接口
- LLM_PROVIDER=OpenAILike - LLM_PROVIDER=OpenAI
# 此项可选，不填写时，使用 OpenAI 官方 API
- PROVIDER_BASE_URL=your-openai-api-base-url - PROVIDER_BASE_URL=your-openai-api-base-url
- PROVIDER_API_KEY=your-openai-api-key - PROVIDER_API_KEY=your-openai-api-key
- LLM_DEFAULT_MODEL=gpt-4.1 - LLM_DEFAULT_MODEL=gpt-4.1

6
docs/content/deployment/docker-compose.md
View File

@@ -116,9 +116,9 @@ UPage 支持通过环境变量进行配置。以下是一些比较重要的环
| 环境变量 | 描述 | 必填 | 示例 | | 环境变量 | 描述 | 必填 | 示例 |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `LLM_PROVIDER` | 默认 LLM 提供商 | 是 | `OpenAILike` | | `LLM_PROVIDER` | 默认 LLM 提供商 | 是 | `OpenAI` |
| `PROVIDER_BASE_URL` | OpenAI 兼容 API 基础 URL | 是 | `https://your-api-base-url` | | `PROVIDER_BASE_URL` | OpenAI 兼容 API 基础 URL | 否 | `https://your-api-base-url` |
| `PROVIDER_API_KEY` | OpenAI 兼容 API 密钥 | 是 | `your-openai-like-api-key` | | `PROVIDER_API_KEY` | OpenAI 兼容 API 密钥 | 否 | `your-openai-api-key` |
### 大模型配置 ### 大模型配置

18
docs/content/deployment/docker.md
View File

@@ -56,9 +56,9 @@ docker run -d \
--name upage \ --name upage \
--restart unless-stopped \ --restart unless-stopped \
-p 3000:3000 \ -p 3000:3000 \
-e LLM_PROVIDER=OpenAILike \ -e LLM_PROVIDER=OpenAI \
-e PROVIDER_BASE_URL=your-openai-like-api-base-url \ -e PROVIDER_BASE_URL=your-openai-api-base-url \
-e PROVIDER_API_KEY=your-openai-like-api-key \ -e PROVIDER_API_KEY=your-openai-api-key \
-e LLM_DEFAULT_MODEL=your-default-model \ -e LLM_DEFAULT_MODEL=your-default-model \
-e LLM_MINOR_MODEL=your-minor-model \ -e LLM_MINOR_MODEL=your-minor-model \
-v ~/upage/data:/app/data \ -v ~/upage/data:/app/data \
@@ -113,9 +113,9 @@ UPage 支持通过环境变量进行配置。以下是一些比较重要的环
| 环境变量 | 描述 | 必填 | 示例 | | 环境变量 | 描述 | 必填 | 示例 |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `LLM_PROVIDER` | 默认 LLM 提供商 | 是 | `OpenAILike` | | `LLM_PROVIDER` | 默认 LLM 提供商 | 是 | `OpenAI` |
| `PROVIDER_BASE_URL` | OpenAI 兼容 API 基础 URL | 是 | `https://your-api-base-url` | | `PROVIDER_BASE_URL` | OpenAI 或者其他兼容 OpenAI 规范的 API 基础 URL | 否 | `https://your-api-base-url` |
| `PROVIDER_API_KEY` | OpenAI 兼容 API 密钥 | 是 | `your-openai-like-api-key` | | `PROVIDER_API_KEY` | OpenAI 或者其他兼容 OpenAI 规范的 API 密钥 | 是 | `your-openai-api-key` |
### 大模型配置 ### 大模型配置
@@ -141,9 +141,9 @@ docker run -d \
--name upage \ --name upage \
--restart unless-stopped \ --restart unless-stopped \
-p 3000:3000 \ -p 3000:3000 \
-e LLM_PROVIDER=OpenAILike \ -e LLM_PROVIDER=OpenAI \
-e PROVIDER_BASE_URL=your-openai-like-api-base-url \ -e PROVIDER_BASE_URL=your-openai-api-base-url \
-e PROVIDER_API_KEY=your-openai-like-api-key \ -e PROVIDER_API_KEY=your-openai-api-key \
-e LLM_DEFAULT_MODEL=your-default-model \ -e LLM_DEFAULT_MODEL=your-default-model \
-e LLM_MINOR_MODEL=your-minor-model \ -e LLM_MINOR_MODEL=your-minor-model \
-v ~/upage/data:/app/data \ -v ~/upage/data:/app/data \

12
docs/content/deployment/source.md
View File

@@ -55,9 +55,9 @@ MAX_UPLOAD_SIZE_MB=5
STORAGE_DIR=./storage STORAGE_DIR=./storage
# AI 提供商配置 # AI 提供商配置
LLM_PROVIDER=OpenAILike LLM_PROVIDER=OpenAI
PROVIDER_BASE_URL=your-openai-like-api-base-url PROVIDER_BASE_URL=your-openai-api-base-url
PROVIDER_API_KEY=your-openai-like-api-key PROVIDER_API_KEY=your-openai-api-key
LLM_DEFAULT_MODEL=your-default-model LLM_DEFAULT_MODEL=your-default-model
LLM_MINOR_MODEL=your-minor-model LLM_MINOR_MODEL=your-minor-model
``` ```
@@ -135,9 +135,9 @@ module.exports = {
NODE_ENV: 'production', NODE_ENV: 'production',
OPERATING_ENV: 'production', OPERATING_ENV: 'production',
PORT: 3000, PORT: 3000,
LLM_PROVIDER: 'OpenAILike', LLM_PROVIDER: 'OpenAI',
PROVIDER_BASE_URL: 'your-openai-like-api-base-url', PROVIDER_BASE_URL: 'your-openai-api-base-url',
PROVIDER_API_KEY: 'your-openai-like-api-key', PROVIDER_API_KEY: 'your-openai-api-key',
LLM_DEFAULT_MODEL: 'your-default-model', LLM_DEFAULT_MODEL: 'your-default-model',
LLM_MINOR_MODEL: 'your-minor-model', LLM_MINOR_MODEL: 'your-minor-model',
} }

6
docs/content/faq.md
View File

@@ -39,9 +39,9 @@ docker run -d \
--name upage \ --name upage \
--restart unless-stopped \ --restart unless-stopped \
-p 3000:3000 \ -p 3000:3000 \
-e LLM_PROVIDER=OpenAILike \ -e LLM_PROVIDER=OpenAI \
-e PROVIDER_BASE_URL=your-openai-like-api-base-url \ -e PROVIDER_BASE_URL=your-openai-api-base-url \
-e PROVIDER_API_KEY=your-openai-like-api-key \ -e PROVIDER_API_KEY=your-openai-api-key \
-e LLM_DEFAULT_MODEL=your-default-model \ -e LLM_DEFAULT_MODEL=your-default-model \
-e LLM_MINOR_MODEL=your-minor-model \ -e LLM_MINOR_MODEL=your-minor-model \
-v ./data:/app/data \ -v ./data:/app/data \

26
docs/content/quick-start.md
View File

@@ -29,9 +29,9 @@ docker run -d \
--name upage \ --name upage \
--restart unless-stopped \ --restart unless-stopped \
-p 3000:3000 \ -p 3000:3000 \
-e LLM_PROVIDER=OpenAILike \ -e LLM_PROVIDER=OpenAI \
-e PROVIDER_BASE_URL=your-openai-like-api-base-url \ -e PROVIDER_BASE_URL=your-openai-api-base-url \
-e PROVIDER_API_KEY=your-openai-like-api-key \ -e PROVIDER_API_KEY=your-openai-api-key \
-e LLM_DEFAULT_MODEL=your-default-model \ -e LLM_DEFAULT_MODEL=your-default-model \
-e LLM_MINOR_MODEL=your-minor-model \ -e LLM_MINOR_MODEL=your-minor-model \
-v ./data:/app/data \ -v ./data:/app/data \
@@ -42,9 +42,9 @@ docker run -d \
### 参数说明 ### 参数说明
- `-e LLM_PROVIDER=OpenAILike`：设置默认的 LLM 提供商 - `-e LLM_PROVIDER=OpenAI`：设置默认的 LLM 提供商
- `-e PROVIDER_BASE_URL=your-openai-like-api-base-url`：设置 API 基础 URL - `-e PROVIDER_BASE_URL=your-openai-api-base-url`：设置 API 基础 URL
- `-e PROVIDER_API_KEY=your-openai-like-api-key`：设置 API 密钥 - `-e PROVIDER_API_KEY=your-openai-api-key`：设置 API 密钥
- `-e LLM_DEFAULT_MODEL=your-default-model`：设置用于页面生成的默认 AI 模型 - `-e LLM_DEFAULT_MODEL=your-default-model`：设置用于页面生成的默认 AI 模型
- `-e LLM_MINOR_MODEL=your-minor-model`：设置用于辅助任务的 AI 模型 - `-e LLM_MINOR_MODEL=your-minor-model`：设置用于辅助任务的 AI 模型
- `-v ./data:/app/data`：挂载数据目录，用于存储数据库文件 - `-v ./data:/app/data`：挂载数据目录，用于存储数据库文件
@@ -67,26 +67,18 @@ UPage 支持多种 AI 提供商，您需要至少配置一个 AI 提供商才能
### DeepSeek ### DeepSeek
```bash ```bash
-e LLM_PROVIDER=Deepseek \ -e LLM_PROVIDER=DeepSeek \
-e PROVIDER_API_KEY=your-deepseek-api-key \ -e PROVIDER_API_KEY=your-deepseek-api-key \
-e LLM_DEFAULT_MODEL=deepseek-chat \ -e LLM_DEFAULT_MODEL=deepseek-chat \
-e LLM_MINOR_MODEL=deepseek-reasoner -e LLM_MINOR_MODEL=deepseek-reasoner
``` ```
### 兼容 OpenAI 接口的服务
```bash
-e LLM_PROVIDER=OpenAILike \
-e PROVIDER_BASE_URL=https://your-api-base-url \
-e PROVIDER_API_KEY=your-api-key \
-e LLM_DEFAULT_MODEL=your-model-name \
-e LLM_MINOR_MODEL=your-minor-model-name
```
### OpenAI ### OpenAI
```bash ```bash
-e LLM_PROVIDER=OpenAI \ -e LLM_PROVIDER=OpenAI \
# 此项可选，不填写时，使用 OpenAI 官方 API
-e PROVIDER_BASE_URL=your-openai-api-base-url \
-e PROVIDER_API_KEY=your-openai-api-key \ -e PROVIDER_API_KEY=your-openai-api-key \
-e LLM_DEFAULT_MODEL=gpt-4-turbo \ -e LLM_DEFAULT_MODEL=gpt-4-turbo \
-e LLM_MINOR_MODEL=gpt-3.5-turbo -e LLM_MINOR_MODEL=gpt-3.5-turbo