feat: enhance channel options with tips and descriptions for better user guidance

2025-11-04 07:43:41 +08:00 · 2025-02-09 12:03:31 +08:00
parent 3e3b8230ac
commit 4375246e24
4 changed files with 94 additions and 70 deletions
--- a/web/default/src/constants/channel.constants.js
+++ b/web/default/src/constants/channel.constants.js
@@ -1,48 +1,60 @@
 export const CHANNEL_OPTIONS = [
-    { key: 1, text: 'OpenAI', value: 1, color: 'green' },
-    { key: 14, text: 'Anthropic Claude', value: 14, color: 'black' },
-    { key: 33, text: 'AWS', value: 33, color: 'black' },
-    { key: 3, text: 'Azure OpenAI', value: 3, color: 'olive' },
-    { key: 11, text: 'Google PaLM2', value: 11, color: 'orange' },
-    { key: 24, text: 'Google Gemini', value: 24, color: 'orange' },
-    { key: 28, text: 'Mistral AI', value: 28, color: 'orange' },
-    { key: 41, text: 'Novita', value: 41, color: 'purple' },
-    {key: 40, text: '火山引擎', value: 40, color: 'blue'},
-    { key: 15, text: '百度文心千帆', value: 15, color: 'blue' },
-    { key: 17, text: '阿里通义千问', value: 17, color: 'orange' },
-    { key: 18, text: '讯飞星火认知', value: 18, color: 'blue' },
-    { key: 16, text: '智谱 ChatGLM', value: 16, color: 'violet' },
-    { key: 19, text: '360 智脑', value: 19, color: 'blue' },
-    { key: 25, text: 'Moonshot AI', value: 25, color: 'black' },
-    { key: 23, text: '腾讯混元', value: 23, color: 'teal' },
-    { key: 26, text: '百川大模型', value: 26, color: 'orange' },
-    { key: 27, text: 'MiniMax', value: 27, color: 'red' },
-    { key: 29, text: 'Groq', value: 29, color: 'orange' },
-    { key: 30, text: 'Ollama', value: 30, color: 'black' },
-    { key: 31, text: '零一万物', value: 31, color: 'green' },
-    { key: 32, text: '阶跃星辰', value: 32, color: 'blue' },
-    { key: 34, text: 'Coze', value: 34, color: 'blue' },
-    { key: 35, text: 'Cohere', value: 35, color: 'blue' },
-    { key: 36, text: 'DeepSeek', value: 36, color: 'black' },
-    { key: 37, text: 'Cloudflare', value: 37, color: 'orange' },
-    { key: 38, text: 'DeepL', value: 38, color: 'black' },
-    { key: 39, text: 'together.ai', value: 39, color: 'blue' },
-    { key: 42, text: 'VertexAI', value: 42, color: 'blue' },
-    { key: 43, text: 'Proxy', value: 43, color: 'blue' },
-    { key: 44, text: 'SiliconFlow', value: 44, color: 'blue' },
-    { key: 45, text: 'xAI', value: 45, color: 'blue' },
-    { key: 46, text: 'Replicate', value: 46, color: 'blue' },
-    { key: 8, text: '自定义渠道', value: 8, color: 'pink' },
-    { key: 22, text: '知识库：FastGPT', value: 22, color: 'blue' },
-    { key: 21, text: '知识库：AI Proxy', value: 21, color: 'purple' },
-    { key: 20, text: '代理：OpenRouter', value: 20, color: 'black' },
-    { key: 2, text: '代理：API2D', value: 2, color: 'blue' },
-    { key: 5, text: '代理：OpenAI-SB', value: 5, color: 'brown' },
-    { key: 7, text: '代理：OhMyGPT', value: 7, color: 'purple' },
-    { key: 10, text: '代理：AI Proxy', value: 10, color: 'purple' },
-    { key: 4, text: '代理：CloseAI', value: 4, color: 'teal' },
-    { key: 6, text: '代理：OpenAI Max', value: 6, color: 'violet' },
-    { key: 9, text: '代理：AI.LS', value: 9, color: 'yellow' },
-    { key: 12, text: '代理：API2GPT', value: 12, color: 'blue' },
-    { key: 13, text: '代理：AIGC2D', value: 13, color: 'purple' }
+  {key: 1, text: 'OpenAI', value: 1, color: 'green'},
+  {key: 14, text: 'Anthropic Claude', value: 14, color: 'black'},
+  {key: 33, text: 'AWS', value: 33, color: 'black'},
+  {key: 3, text: 'Azure OpenAI', value: 3, color: 'olive'},
+  {key: 11, text: 'Google PaLM2', value: 11, color: 'orange'},
+  {key: 24, text: 'Google Gemini', value: 24, color: 'orange'},
+  {key: 28, text: 'Mistral AI', value: 28, color: 'orange'},
+  {key: 41, text: 'Novita', value: 41, color: 'purple'},
+  {
+    key: 40,
+    text: '火山引擎',
+    value: 40,
+    color: 'blue',
+    description: '原字节跳动豆包',
+  },
+  {
+    key: 15,
+    text: '百度文心千帆',
+    value: 15,
+    color: 'blue',
+    tip: '请前往<a href="https://console.bce.baidu.com/qianfan/ais/console/applicationConsole/application/v1" target="_blank">此处</a>获取 AK（API Key）以及 SK（Secret Key）',
+  },
+  {key: 17, text: '阿里通义千问', value: 17, color: 'orange'},
+  {key: 18, text: '讯飞星火认知', value: 18, color: 'blue'},
+  {key: 16, text: '智谱 ChatGLM', value: 16, color: 'violet'},
+  {key: 19, text: '360 智脑', value: 19, color: 'blue'},
+  {key: 25, text: 'Moonshot AI', value: 25, color: 'black'},
+  {key: 23, text: '腾讯混元', value: 23, color: 'teal'},
+  {key: 26, text: '百川大模型', value: 26, color: 'orange'},
+  {key: 27, text: 'MiniMax', value: 27, color: 'red'},
+  {key: 29, text: 'Groq', value: 29, color: 'orange'},
+  {key: 30, text: 'Ollama', value: 30, color: 'black'},
+  {key: 31, text: '零一万物', value: 31, color: 'green'},
+  {key: 32, text: '阶跃星辰', value: 32, color: 'blue'},
+  {key: 34, text: 'Coze', value: 34, color: 'blue'},
+  {key: 35, text: 'Cohere', value: 35, color: 'blue'},
+  {key: 36, text: 'DeepSeek', value: 36, color: 'black'},
+  {key: 37, text: 'Cloudflare', value: 37, color: 'orange'},
+  {key: 38, text: 'DeepL', value: 38, color: 'black'},
+  {key: 39, text: 'together.ai', value: 39, color: 'blue'},
+  {key: 42, text: 'VertexAI', value: 42, color: 'blue'},
+  {key: 43, text: 'Proxy', value: 43, color: 'blue'},
+  {key: 44, text: 'SiliconFlow', value: 44, color: 'blue'},
+  {key: 45, text: 'xAI', value: 45, color: 'blue'},
+  {key: 46, text: 'Replicate', value: 46, color: 'blue'},
+  {key: 8, text: '自定义渠道', value: 8, color: 'pink'},
+  {key: 22, text: '知识库：FastGPT', value: 22, color: 'blue'},
+  {key: 21, text: '知识库：AI Proxy', value: 21, color: 'purple'},
+  {key: 20, text: '代理：OpenRouter', value: 20, color: 'black'},
+  {key: 2, text: '代理：API2D', value: 2, color: 'blue'},
+  {key: 5, text: '代理：OpenAI-SB', value: 5, color: 'brown'},
+  {key: 7, text: '代理：OhMyGPT', value: 7, color: 'purple'},
+  {key: 10, text: '代理：AI Proxy', value: 10, color: 'purple'},
+  {key: 4, text: '代理：CloseAI', value: 4, color: 'teal'},
+  {key: 6, text: '代理：OpenAI Max', value: 6, color: 'violet'},
+  {key: 9, text: '代理：AI.LS', value: 9, color: 'yellow'},
+  {key: 12, text: '代理：API2GPT', value: 12, color: 'blue'},
+  {key: 13, text: '代理：AIGC2D', value: 13, color: 'purple'},
 ];
--- a/web/default/src/helpers/helper.js
+++ b/web/default/src/helpers/helper.js
@@ -0,0 +1,13 @@
+import {CHANNEL_OPTIONS} from '../constants';
+
+let channelMap = undefined;
+
+export function getChannelOption(channelId) {
+    if (channelMap === undefined) {
+        channelMap = {};
+        CHANNEL_OPTIONS.forEach((option) => {
+            channelMap[option.key] = option;
+        });
+    }
+    return channelMap[channelId];
+}
--- a/web/default/src/helpers/render.js
+++ b/web/default/src/helpers/render.js
@@ -1,5 +1,6 @@
-import { Label } from 'semantic-ui-react';
-import { useTranslation } from 'react-i18next';
+import {Label, Message} from 'semantic-ui-react';
+import {getChannelOption} from './helper';
+import React from 'react';

 export function renderText(text, limit) {
  if (text.length > limit) {
@@ -98,3 +99,15 @@ export function renderColorLabel(text) {
    </Label>
  );
 }
+
+export function renderChannelTip(channelId) {
+  let channel = getChannelOption(channelId);
+  if (channel === undefined || channel.tip === undefined) {
+    return <></>;
+  }
+  return (
+      <Message>
+        <div dangerouslySetInnerHTML={{__html: channel.tip}}></div>
+      </Message>
+  );
+}
--- a/web/default/src/pages/Channel/EditChannel.js
+++ b/web/default/src/pages/Channel/EditChannel.js
@@ -1,25 +1,10 @@
-import React, { useEffect, useState } from 'react';
-import { useTranslation } from 'react-i18next';
-import {
-  Button,
-  Form,
-  Header,
-  Input,
-  Message,
-  Segment,
-  Card,
-} from 'semantic-ui-react';
-import { useNavigate, useParams } from 'react-router-dom';
-import {
-  API,
-  copy,
-  getChannelModels,
-  showError,
-  showInfo,
-  showSuccess,
-  verifyJSON,
-} from '../../helpers';
-import { CHANNEL_OPTIONS } from '../../constants';
+import React, {useEffect, useState} from 'react';
+import {useTranslation} from 'react-i18next';
+import {Button, Card, Form, Input, Message,} from 'semantic-ui-react';
+import {useNavigate, useParams} from 'react-router-dom';
+import {API, copy, getChannelModels, showError, showInfo, showSuccess, verifyJSON,} from '../../helpers';
+import {CHANNEL_OPTIONS} from '../../constants';
+import {renderChannelTip} from '../../helpers/render';

 const MODEL_MAPPING_EXAMPLE = {
  'gpt-3.5-turbo-0301': 'gpt-3.5-turbo',
@@ -310,6 +295,7 @@ const EditChannel = () => {
                options={groupOptions}
              />
            </Form.Field>
+            {renderChannelTip(inputs.type)}

            {/* Azure OpenAI specific fields */}
            {inputs.type === 3 && (