From 337b814ea3c3a7c6936dafd20e817238b27360f0 Mon Sep 17 00:00:00 2001 From: 0xSelenicDove <140679517+0xSelenicDove@users.noreply.github.com> Date: Fri, 17 Jul 2026 18:02:54 +0800 Subject: [PATCH] refactor(docs): new structure, provider config update (#1712) Co-authored-by-agent: Unknown --- docs/.vitepress/config.ts | 159 +++++++++++++----- docs/.vitepress/custom/Docs.vue | 27 ++- .../zh-Hans/docs/manual/config/audio.md | 41 +++++ .../zh-Hans/docs/manual/config/common.md | 44 +++++ .../zh-Hans/docs/manual/config/index.md | 30 +++- .../content/zh-Hans/docs/manual/config/llm.md | 46 +++++ .../config/providers/artistry/comfyui.md | 38 +++++ .../manual/config/providers/artistry/index.md | 10 ++ .../config/providers/artistry/nanobanana.md | 36 ++++ .../config/providers/artistry/replicate.md | 37 ++++ .../docs/manual/config/providers/catalog.md | 72 ++++++++ .../config/providers/consciousness/302ai.md | 36 ++++ .../providers/consciousness/aihubmix.md | 24 +++ .../providers/consciousness/amazon-bedrock.md | 25 +++ .../providers/consciousness/anthropic.md | 37 ++++ .../consciousness/azure-ai-foundry.md | 25 +++ .../providers/consciousness/azure-openai.md | 25 +++ .../consciousness/byteplus-coding-plan.md | 24 +++ .../providers/consciousness/byteplus.md | 25 +++ .../providers/consciousness/cerebras.md | 24 +++ .../consciousness/cloudflare-workers-ai.md | 34 ++++ .../providers/consciousness/comet-api.md | 24 +++ .../providers/consciousness/deepseek.md | 36 ++++ .../providers/consciousness/featherless.md | 24 +++ .../providers/consciousness/fireworks.md | 36 ++++ .../providers/consciousness/google-gemini.md | 35 ++++ .../config/providers/consciousness/groq.md | 36 ++++ .../providers/consciousness/lm-studio.md | 31 ++++ .../config/providers/consciousness/mimo.md | 24 +++ .../providers/consciousness/minimax-global.md | 37 ++++ .../config/providers/consciousness/minimax.md | 36 ++++ .../config/providers/consciousness/mistral.md | 36 ++++ .../providers/consciousness/modelscope.md | 24 +++ .../providers/consciousness/moonshot.md | 36 ++++ .../config/providers/consciousness/n1n.md | 25 +++ .../config/providers/consciousness/novita.md | 36 ++++ .../config/providers/consciousness/nvidia.md | 36 ++++ .../providers/consciousness/official.md | 37 ++++ .../config/providers/consciousness/ollama.md | 48 ++++++ .../config/providers/consciousness/openai.md | 36 ++++ .../providers/consciousness/openrouter.md | 37 ++++ .../providers/consciousness/perplexity.md | 36 ++++ .../providers/consciousness/together.md | 36 ++++ .../consciousness/volcengine-coding-plan.md | 24 +++ .../config/providers/consciousness/xai.md | 35 ++++ .../config/providers/consciousness/zhipu.md | 36 ++++ .../speech/alibaba-cloud-model-studio.md | 35 ++++ .../config/providers/speech/azure-speech.md | 35 ++++ .../config/providers/speech/browser-local.md | 33 ++++ .../config/providers/speech/comet-api.md | 34 ++++ .../config/providers/speech/deepgram.md | 35 ++++ .../config/providers/speech/desktop-local.md | 33 ++++ .../config/providers/speech/elevenlabs.md | 36 ++++ .../config/providers/speech/google-gemini.md | 35 ++++ .../config/providers/speech/index-tts.md | 35 ++++ .../manual/config/providers/speech/kokoro.md | 33 ++++ .../manual/config/providers/speech/mimo.md | 34 ++++ .../manual/config/providers/speech/minimax.md | 35 ++++ .../config/providers/speech/official.md | 33 ++++ .../manual/config/providers/speech/openai.md | 37 ++++ .../config/providers/speech/openrouter.md | 36 ++++ .../manual/config/providers/speech/player2.md | 34 ++++ .../config/providers/speech/volcengine.md | 35 ++++ .../config/providers/transcription/aliyun.md | 37 ++++ .../providers/transcription/browser-local.md | 33 ++++ .../providers/transcription/comet-api.md | 34 ++++ .../providers/transcription/desktop-local.md | 33 ++++ .../config/providers/transcription/mimo.md | 34 ++++ .../providers/transcription/official.md | 33 ++++ .../config/providers/transcription/openai.md | 36 ++++ .../providers/transcription/web-speech-api.md | 34 ++++ .../zh-Hans/docs/manual/config/vision.md | 90 ++++++++++ 72 files changed, 2559 insertions(+), 49 deletions(-) create mode 100644 docs/content/zh-Hans/docs/manual/config/audio.md create mode 100644 docs/content/zh-Hans/docs/manual/config/common.md create mode 100644 docs/content/zh-Hans/docs/manual/config/llm.md create mode 100644 docs/content/zh-Hans/docs/manual/config/providers/artistry/comfyui.md create mode 100644 docs/content/zh-Hans/docs/manual/config/providers/artistry/index.md create mode 100644 docs/content/zh-Hans/docs/manual/config/providers/artistry/nanobanana.md create mode 100644 docs/content/zh-Hans/docs/manual/config/providers/artistry/replicate.md create mode 100644 docs/content/zh-Hans/docs/manual/config/providers/catalog.md create mode 100644 docs/content/zh-Hans/docs/manual/config/providers/consciousness/302ai.md create mode 100644 docs/content/zh-Hans/docs/manual/config/providers/consciousness/aihubmix.md create mode 100644 docs/content/zh-Hans/docs/manual/config/providers/consciousness/amazon-bedrock.md create mode 100644 docs/content/zh-Hans/docs/manual/config/providers/consciousness/anthropic.md create mode 100644 docs/content/zh-Hans/docs/manual/config/providers/consciousness/azure-ai-foundry.md create mode 100644 docs/content/zh-Hans/docs/manual/config/providers/consciousness/azure-openai.md create mode 100644 docs/content/zh-Hans/docs/manual/config/providers/consciousness/byteplus-coding-plan.md create mode 100644 docs/content/zh-Hans/docs/manual/config/providers/consciousness/byteplus.md create mode 100644 docs/content/zh-Hans/docs/manual/config/providers/consciousness/cerebras.md create mode 100644 docs/content/zh-Hans/docs/manual/config/providers/consciousness/cloudflare-workers-ai.md create mode 100644 docs/content/zh-Hans/docs/manual/config/providers/consciousness/comet-api.md create mode 100644 docs/content/zh-Hans/docs/manual/config/providers/consciousness/deepseek.md create mode 100644 docs/content/zh-Hans/docs/manual/config/providers/consciousness/featherless.md create mode 100644 docs/content/zh-Hans/docs/manual/config/providers/consciousness/fireworks.md create mode 100644 docs/content/zh-Hans/docs/manual/config/providers/consciousness/google-gemini.md create mode 100644 docs/content/zh-Hans/docs/manual/config/providers/consciousness/groq.md create mode 100644 docs/content/zh-Hans/docs/manual/config/providers/consciousness/lm-studio.md create mode 100644 docs/content/zh-Hans/docs/manual/config/providers/consciousness/mimo.md create mode 100644 docs/content/zh-Hans/docs/manual/config/providers/consciousness/minimax-global.md create mode 100644 docs/content/zh-Hans/docs/manual/config/providers/consciousness/minimax.md create mode 100644 docs/content/zh-Hans/docs/manual/config/providers/consciousness/mistral.md create mode 100644 docs/content/zh-Hans/docs/manual/config/providers/consciousness/modelscope.md create mode 100644 docs/content/zh-Hans/docs/manual/config/providers/consciousness/moonshot.md create mode 100644 docs/content/zh-Hans/docs/manual/config/providers/consciousness/n1n.md create mode 100644 docs/content/zh-Hans/docs/manual/config/providers/consciousness/novita.md create mode 100644 docs/content/zh-Hans/docs/manual/config/providers/consciousness/nvidia.md create mode 100644 docs/content/zh-Hans/docs/manual/config/providers/consciousness/official.md create mode 100644 docs/content/zh-Hans/docs/manual/config/providers/consciousness/ollama.md create mode 100644 docs/content/zh-Hans/docs/manual/config/providers/consciousness/openai.md create mode 100644 docs/content/zh-Hans/docs/manual/config/providers/consciousness/openrouter.md create mode 100644 docs/content/zh-Hans/docs/manual/config/providers/consciousness/perplexity.md create mode 100644 docs/content/zh-Hans/docs/manual/config/providers/consciousness/together.md create mode 100644 docs/content/zh-Hans/docs/manual/config/providers/consciousness/volcengine-coding-plan.md create mode 100644 docs/content/zh-Hans/docs/manual/config/providers/consciousness/xai.md create mode 100644 docs/content/zh-Hans/docs/manual/config/providers/consciousness/zhipu.md create mode 100644 docs/content/zh-Hans/docs/manual/config/providers/speech/alibaba-cloud-model-studio.md create mode 100644 docs/content/zh-Hans/docs/manual/config/providers/speech/azure-speech.md create mode 100644 docs/content/zh-Hans/docs/manual/config/providers/speech/browser-local.md create mode 100644 docs/content/zh-Hans/docs/manual/config/providers/speech/comet-api.md create mode 100644 docs/content/zh-Hans/docs/manual/config/providers/speech/deepgram.md create mode 100644 docs/content/zh-Hans/docs/manual/config/providers/speech/desktop-local.md create mode 100644 docs/content/zh-Hans/docs/manual/config/providers/speech/elevenlabs.md create mode 100644 docs/content/zh-Hans/docs/manual/config/providers/speech/google-gemini.md create mode 100644 docs/content/zh-Hans/docs/manual/config/providers/speech/index-tts.md create mode 100644 docs/content/zh-Hans/docs/manual/config/providers/speech/kokoro.md create mode 100644 docs/content/zh-Hans/docs/manual/config/providers/speech/mimo.md create mode 100644 docs/content/zh-Hans/docs/manual/config/providers/speech/minimax.md create mode 100644 docs/content/zh-Hans/docs/manual/config/providers/speech/official.md create mode 100644 docs/content/zh-Hans/docs/manual/config/providers/speech/openai.md create mode 100644 docs/content/zh-Hans/docs/manual/config/providers/speech/openrouter.md create mode 100644 docs/content/zh-Hans/docs/manual/config/providers/speech/player2.md create mode 100644 docs/content/zh-Hans/docs/manual/config/providers/speech/volcengine.md create mode 100644 docs/content/zh-Hans/docs/manual/config/providers/transcription/aliyun.md create mode 100644 docs/content/zh-Hans/docs/manual/config/providers/transcription/browser-local.md create mode 100644 docs/content/zh-Hans/docs/manual/config/providers/transcription/comet-api.md create mode 100644 docs/content/zh-Hans/docs/manual/config/providers/transcription/desktop-local.md create mode 100644 docs/content/zh-Hans/docs/manual/config/providers/transcription/mimo.md create mode 100644 docs/content/zh-Hans/docs/manual/config/providers/transcription/official.md create mode 100644 docs/content/zh-Hans/docs/manual/config/providers/transcription/openai.md create mode 100644 docs/content/zh-Hans/docs/manual/config/providers/transcription/web-speech-api.md create mode 100644 docs/content/zh-Hans/docs/manual/config/vision.md diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts index 1daab667d..457490a25 100644 --- a/docs/.vitepress/config.ts +++ b/docs/.vitepress/config.ts @@ -157,7 +157,6 @@ export default defineConfig({ text: 'Configuration', items: [ { text: 'Configuration Guide', link: withBase('/en/docs/manual/config/') }, - { text: 'Character Card Template', link: withBase('/en/docs/manual/tamagotchi/character-card-template') }, ], }, ], @@ -303,59 +302,134 @@ export default defineConfig({ text: '配置', items: [ { text: '配置指南', link: withBase('/zh-Hans/docs/manual/config/') }, + { text: '通用说明', link: withBase('/zh-Hans/docs/manual/config/common') }, + { text: '聊天模型', link: withBase('/zh-Hans/docs/manual/config/llm') }, + { text: '语音输入与输出', link: withBase('/zh-Hans/docs/manual/config/audio') }, + { text: '视觉理解', link: withBase('/zh-Hans/docs/manual/config/vision') }, + { text: '艺术创作', link: withBase('/zh-Hans/docs/manual/config/providers/artistry/') }, + { text: '支持的服务商目录', link: withBase('/zh-Hans/docs/manual/config/providers/catalog') }, + { text: '配置服务来源', collapsed: true, items: [ + { text: '聊天', collapsed: true, items: [ + { text: 'AIRI 官方提供商', link: withBase('/zh-Hans/docs/manual/config/providers/consciousness/official') }, + { text: 'AIHubMix', link: withBase('/zh-Hans/docs/manual/config/providers/consciousness/aihubmix') }, + { text: 'Amazon Bedrock', link: withBase('/zh-Hans/docs/manual/config/providers/consciousness/amazon-bedrock') }, + { text: 'Anthropic', link: withBase('/zh-Hans/docs/manual/config/providers/consciousness/anthropic') }, + { text: 'Azure AI Foundry', link: withBase('/zh-Hans/docs/manual/config/providers/consciousness/azure-ai-foundry') }, + { text: 'Azure OpenAI', link: withBase('/zh-Hans/docs/manual/config/providers/consciousness/azure-openai') }, + { text: 'BytePlus', link: withBase('/zh-Hans/docs/manual/config/providers/consciousness/byteplus') }, + { text: 'BytePlus Coding Plan', link: withBase('/zh-Hans/docs/manual/config/providers/consciousness/byteplus-coding-plan') }, + { text: 'Cerebras', link: withBase('/zh-Hans/docs/manual/config/providers/consciousness/cerebras') }, + { text: 'CometAPI', link: withBase('/zh-Hans/docs/manual/config/providers/consciousness/comet-api') }, + { text: 'Google Gemini', link: withBase('/zh-Hans/docs/manual/config/providers/consciousness/google-gemini') }, + { text: 'xAI', link: withBase('/zh-Hans/docs/manual/config/providers/consciousness/xai') }, + { text: 'Cloudflare Workers AI', link: withBase('/zh-Hans/docs/manual/config/providers/consciousness/cloudflare-workers-ai') }, + { text: 'LM Studio（本地模型）', link: withBase('/zh-Hans/docs/manual/config/providers/consciousness/lm-studio') }, + { text: 'OpenRouter', link: withBase('/zh-Hans/docs/manual/config/providers/consciousness/openrouter') }, + { text: 'Ollama', link: withBase('/zh-Hans/docs/manual/config/providers/consciousness/ollama') }, + { text: '深度求索 DeepSeek', link: withBase('/zh-Hans/docs/manual/config/providers/consciousness/deepseek') }, + { text: 'OpenAI (和兼容 API)', link: withBase('/zh-Hans/docs/manual/config/providers/consciousness/openai') }, + { text: '302.ai', link: withBase('/zh-Hans/docs/manual/config/providers/consciousness/302ai') }, + { text: 'fireworks', link: withBase('/zh-Hans/docs/manual/config/providers/consciousness/fireworks') }, + { text: 'Featherless.ai', link: withBase('/zh-Hans/docs/manual/config/providers/consciousness/featherless') }, + { text: 'Groq', link: withBase('/zh-Hans/docs/manual/config/providers/consciousness/groq') }, + { text: 'MiniMax', link: withBase('/zh-Hans/docs/manual/config/providers/consciousness/minimax') }, + { text: 'MiniMax Global', link: withBase('/zh-Hans/docs/manual/config/providers/consciousness/minimax-global') }, + { text: 'Mistral', link: withBase('/zh-Hans/docs/manual/config/providers/consciousness/mistral') }, + { text: '小米 MiMo', link: withBase('/zh-Hans/docs/manual/config/providers/consciousness/mimo') }, + { text: 'ModelScope', link: withBase('/zh-Hans/docs/manual/config/providers/consciousness/modelscope') }, + { text: '月之暗面', link: withBase('/zh-Hans/docs/manual/config/providers/consciousness/moonshot') }, + { text: 'Nvidia NIM', link: withBase('/zh-Hans/docs/manual/config/providers/consciousness/nvidia') }, + { text: 'n1n', link: withBase('/zh-Hans/docs/manual/config/providers/consciousness/n1n') }, + { text: 'Novita', link: withBase('/zh-Hans/docs/manual/config/providers/consciousness/novita') }, + { text: 'Perplexity', link: withBase('/zh-Hans/docs/manual/config/providers/consciousness/perplexity') }, + { text: 'Together.ai', link: withBase('/zh-Hans/docs/manual/config/providers/consciousness/together') }, + { text: 'Z.ai', link: withBase('/zh-Hans/docs/manual/config/providers/consciousness/zhipu') }, + { text: '火山引擎 Coding Plan', link: withBase('/zh-Hans/docs/manual/config/providers/consciousness/volcengine-coding-plan') }, + ] }, + { text: '语音合成（TTS）', collapsed: true, items: [ + { text: 'AIRI 官方语音合成', link: withBase('/zh-Hans/docs/manual/config/providers/speech/official') }, + { text: '阿里云百炼', link: withBase('/zh-Hans/docs/manual/config/providers/speech/alibaba-cloud-model-studio') }, + { text: '浏览器本地语音合成', link: withBase('/zh-Hans/docs/manual/config/providers/speech/browser-local') }, + { text: 'CometAPI', link: withBase('/zh-Hans/docs/manual/config/providers/speech/comet-api') }, + { text: 'Deepgram', link: withBase('/zh-Hans/docs/manual/config/providers/speech/deepgram') }, + { text: '桌面端本地语音合成', link: withBase('/zh-Hans/docs/manual/config/providers/speech/desktop-local') }, + { text: 'ElevenLabs', link: withBase('/zh-Hans/docs/manual/config/providers/speech/elevenlabs') }, + { text: 'Google Gemini', link: withBase('/zh-Hans/docs/manual/config/providers/speech/google-gemini') }, + { text: 'Index-TTS', link: withBase('/zh-Hans/docs/manual/config/providers/speech/index-tts') }, + { text: 'Kokoro', link: withBase('/zh-Hans/docs/manual/config/providers/speech/kokoro') }, + { text: 'Microsoft Azure Speech', link: withBase('/zh-Hans/docs/manual/config/providers/speech/azure-speech') }, + { text: 'MiniMax Speech', link: withBase('/zh-Hans/docs/manual/config/providers/speech/minimax') }, + { text: '小米 MiMo', link: withBase('/zh-Hans/docs/manual/config/providers/speech/mimo') }, + { text: 'OpenAI (和兼容 API)', link: withBase('/zh-Hans/docs/manual/config/providers/speech/openai') }, + { text: 'OpenRouter', link: withBase('/zh-Hans/docs/manual/config/providers/speech/openrouter') }, + { text: 'Player2 Speech', link: withBase('/zh-Hans/docs/manual/config/providers/speech/player2') }, + { text: '火山引擎', link: withBase('/zh-Hans/docs/manual/config/providers/speech/volcengine') }, + ] }, + { text: '语音识别（ASR/STT）', collapsed: true, items: [ + { text: 'AIRI 官方语音识别', link: withBase('/zh-Hans/docs/manual/config/providers/transcription/official') }, + { text: '阿里云智能语音服务', link: withBase('/zh-Hans/docs/manual/config/providers/transcription/aliyun') }, + { text: '浏览器本地语音识别', link: withBase('/zh-Hans/docs/manual/config/providers/transcription/browser-local') }, + { text: '浏览器 Web Speech API', link: withBase('/zh-Hans/docs/manual/config/providers/transcription/web-speech-api') }, + { text: 'CometAPI', link: withBase('/zh-Hans/docs/manual/config/providers/transcription/comet-api') }, + { text: '桌面端本地语音识别', link: withBase('/zh-Hans/docs/manual/config/providers/transcription/desktop-local') }, + { text: '小米 MiMo', link: withBase('/zh-Hans/docs/manual/config/providers/transcription/mimo') }, + { text: 'OpenAI (和兼容 API)', link: withBase('/zh-Hans/docs/manual/config/providers/transcription/openai') }, + ] }, + { text: '艺术创作', collapsed: true, items: [ + { text: 'ComfyUI（本地工作流）', link: withBase('/zh-Hans/docs/manual/config/providers/artistry/comfyui') }, + { text: 'Replicate', link: withBase('/zh-Hans/docs/manual/config/providers/artistry/replicate') }, + { text: 'Nano Banana', link: withBase('/zh-Hans/docs/manual/config/providers/artistry/nanobanana') }, + ] }, + ] }, + ], + }, + { + text: '贡献指南', + icon: 'lucide:users', + items: [ { - text: '角色卡模板', - link: withBase('/zh-Hans/docs/manual/tamagotchi/character-card-template'), + text: '基础配置与开发', + items: [ + { text: '环境配置与基础准备', link: withBase('/zh-Hans/docs/contributing/') }, + { text: '桌面端', link: withBase('/zh-Hans/docs/contributing/tamagotchi') }, + { text: '网页端', link: withBase('/zh-Hans/docs/contributing/webui') }, + { text: '文档站', link: withBase('/zh-Hans/docs/contributing/docs') }, + ], + }, + { + text: '游戏与社交平台', + items: [ + { text: 'Minecraft', link: withBase('/zh-Hans/docs/contributing/services/minecraft') }, + { text: 'Satori Bot', link: withBase('/zh-Hans/docs/contributing/services/satori') }, + { text: 'Telegram Bot', link: withBase('/zh-Hans/docs/contributing/services/telegram') }, + { text: 'Discord Bot', link: withBase('/zh-Hans/docs/contributing/services/discord') }, + ], + }, + { + text: '设计指南', + items: [ + { text: '介绍', link: withBase('/zh-Hans/docs/contributing/design-guidelines/') }, + { text: '艺术家与开发者 (参考资源)', link: withBase('/zh-Hans/docs/contributing/design-guidelines/resources') }, + { text: '工具', link: withBase('/zh-Hans/docs/contributing/design-guidelines/tools') }, + ], }, ], }, - ], - }, - { - text: '贡献指南', - icon: 'lucide:users', - items: [ { - text: '基础配置与开发', + text: '编年史', + icon: 'lucide:calendar-days', items: [ - { text: '环境配置与基础准备', link: withBase('/zh-Hans/docs/contributing/') }, - { text: '桌面端', link: withBase('/zh-Hans/docs/contributing/tamagotchi') }, - { text: '网页端', link: withBase('/zh-Hans/docs/contributing/webui') }, - { text: '文档站', link: withBase('/zh-Hans/docs/contributing/docs') }, + { text: '首次公开 v0.1.0', link: withBase('/zh-Hans/docs/chronicles/version-v0.1.0/') }, + { text: '先前的故事 v0.0.1', link: withBase('/zh-Hans/docs/chronicles/version-v0.0.1/') }, ], }, { - text: '游戏与社交平台', - items: [ - { text: 'Minecraft', link: withBase('/zh-Hans/docs/contributing/services/minecraft') }, - { text: 'Satori Bot', link: withBase('/zh-Hans/docs/contributing/services/satori') }, - { text: 'Telegram Bot', link: withBase('/zh-Hans/docs/contributing/services/telegram') }, - { text: 'Discord Bot', link: withBase('/zh-Hans/docs/contributing/services/discord') }, - ], - }, - { - text: '设计指南', - items: [ - { text: '介绍', link: withBase('/zh-Hans/docs/contributing/design-guidelines/') }, - { text: '艺术家与开发者 (参考资源)', link: withBase('/zh-Hans/docs/contributing/design-guidelines/resources') }, - { text: '工具', link: withBase('/zh-Hans/docs/contributing/design-guidelines/tools') }, - ], + text: '角色', + icon: 'lucide:scan-face', + link: withBase('/zh-Hans/characters/'), }, ], }, - { - text: '编年史', - icon: 'lucide:calendar-days', - items: [ - { text: '首次公开 v0.1.0', link: withBase('/zh-Hans/docs/chronicles/version-v0.1.0/') }, - { text: '先前的故事 v0.0.1', link: withBase('/zh-Hans/docs/chronicles/version-v0.0.1/') }, - ], - }, - { - text: '角色', - icon: 'lucide:scan-face', - link: withBase('/zh-Hans/characters/'), - }, ] as (DefaultTheme.SidebarItem & { icon?: string })[], homepage: { @@ -448,7 +522,6 @@ export default defineConfig({ text: '設定', items: [ { text: '設定ガイド', link: withBase('/ja/docs/manual/config/') }, - { text: 'キャラクターカードテンプレート', link: withBase('/ja/docs/manual/tamagotchi/character-card-template') }, ], }, ], diff --git a/docs/.vitepress/custom/Docs.vue b/docs/.vitepress/custom/Docs.vue index ba8b795fd..3f5287861 100644 --- a/docs/.vitepress/custom/Docs.vue +++ b/docs/.vitepress/custom/Docs.vue @@ -26,8 +26,33 @@ const { t } = useI18n() const { theme, frontmatter } = useData() const { path } = toRefs(useRoute()) +/** + * Normalizes a document route or sidebar link before matching. + * + * Before: + * - "/zh-Hans/docs/manual/config/providers/consciousness/official.html" + * - "/zh-Hans/docs/manual/config/providers/consciousness/official/" + * + * After: + * - "/zh-Hans/docs/manual/config/providers/consciousness/official" + */ +function normalizeDocumentPath(value: string): string { + const withoutDocumentExtension = value.replace(/(?:\/index)?\.(?:html|md)$/, '') + const withoutTrailingSlash = withoutDocumentExtension.replace(/\/+$/, '') + + return withoutTrailingSlash || '/' +} + const sidebar = computed(() => theme.value.sidebar as DefaultTheme.SidebarItem[]) -const activeSection = computed(() => sidebar.value.find(section => flatten(section.items ?? [], 'items')?.find(item => item.link === path.value.replace('.html', '')))) +const activeSection = computed(() => { + const currentPath = normalizeDocumentPath(path.value) + + return sidebar.value.find(section => + flatten(section.items ?? [], 'items').some(item => + item.link != null && normalizeDocumentPath(item.link) === currentPath, + ), + ) +}) const isSidebarEnabled = computed(() => { if (frontmatter.value.sidebar === false) { diff --git a/docs/content/zh-Hans/docs/manual/config/audio.md b/docs/content/zh-Hans/docs/manual/config/audio.md new file mode 100644 index 000000000..4d495ee2b --- /dev/null +++ b/docs/content/zh-Hans/docs/manual/config/audio.md @@ -0,0 +1,41 @@ +--- +title: 配置语音输入与输出 +description: 为 AIRI 配置语音合成（TTS）和语音识别（ASR/STT） +--- + +语音合成（TTS）将 AIRI 的文字回复读出来；语音识别（ASR/STT）把麦克风声音转换为文字。两者可以独立配置：只配置 TTS 也能让 AIRI 开口说话，只配置 ASR 也能使用语音输入。 + +## 配置语音合成（TTS） + +1. 打开 **设置 → 服务商 → 语音合成**，选择服务商并填写凭据。 +2. 打开 **设置 → 发声**，选择已配置的服务商、模型和音色。 +3. 在发声页面输入一段测试文本并播放。听到声音即表示配置成功。 + +如果你的服务商兼容 OpenAI 语音接口，参考 [OpenAI 兼容 API（TTS）](./providers/speech/openai.md)。使用 OpenRouter 的语音接口时，参考 [OpenRouter（TTS）](./providers/speech/openrouter.md)。 + +## 配置语音识别（ASR/STT） + +1. 打开 **设置 → 服务商 → 语音识别**，选择服务商并填写凭据。 +2. 打开 **设置 → 听觉**，选择已配置的服务商和模型。 +3. 选择正确的麦克风，启动测试并说一句简短的话。 +4. 在识别结果区域确认文字正确出现。 + +阿里云实时识别请参考[阿里云 NLS](./providers/transcription/aliyun.md)；兼容 OpenAI 转写接口的服务请参考 [OpenAI 兼容 API（ASR/STT）](./providers/transcription/openai.md)。 + +## 常见问题 + +### TTS 没有声音 + +确认已选择语音服务商、模型和音色，并检查系统输出设备与音量。若测试区显示服务商错误，请先检查 API Key、余额和模型是否支持语音合成。 + +### ASR 没有文字结果 + +确认 AIRI 已获得麦克风权限，并在“听觉”页面选择了正确的输入设备。对于实时识别服务，网络中断或浏览器/系统的麦克风权限被撤销也会导致结果为空。 + +### 识别语言或音色不正确 + +选择服务商支持目标语言的模型或音色。语音识别的语言、区域和模型设置必须与服务商实际开通的能力一致。 + +## 下一步 + +如需了解 API Key、Base URL 和验证流程的含义，请阅读[通用配置说明](./common.md)。 diff --git a/docs/content/zh-Hans/docs/manual/config/common.md b/docs/content/zh-Hans/docs/manual/config/common.md new file mode 100644 index 000000000..f07817293 --- /dev/null +++ b/docs/content/zh-Hans/docs/manual/config/common.md @@ -0,0 +1,44 @@ +--- +title: 通用配置说明 +description: 了解 AIRI 中服务商配置的流程、字段和验证方式 +--- + +本页说明 AIRI 的服务商配置如何工作。具体服务商的 API 地址、账户开通方式和模型选择，请前往对应的服务商页面。 + +## 配置流程 + +1. 打开 **设置 → 服务商**，选择功能分类：**聊天**、**语音合成**或**语音识别**。 +2. 选择服务商，填写页面要求的凭据。 +3. 如有需要，展开高级设置并填写服务商提供的 Base URL 或其他参数。 +4. 等待 AIRI 完成验证；验证通过后，在相应功能模块中选择该服务商及模型或音色。 + +::: warning 凭据安全 +凭据和服务商设置保存在当前设备的本地设置中。切勿在截图、日志、Issue 或聊天记录中公开 API Key、AccessKey Secret 等凭据。 +::: + +## 常见字段 + +| 字段 | 含义 | 填写建议 | +| --- | --- | --- | +| API Key | 服务商签发的访问令牌 | 直接粘贴完整密钥，不要添加引号或空格。 | +| Base URL | 服务商 API 的根地址 | 仅在服务商文档要求时修改。使用自定义地址时，填写完整的 `https://` 或 `http://` 地址。 | +| 模型 | 聊天、语音或识别所使用的模型 ID | 优先从 AIRI 的列表中选择；若列表加载失败，再按服务商文档手动填写。 | +| 音色 | TTS 朗读时使用的 voice ID | 先选择模型，再选择该模型支持的音色。 | +| 区域 | 部分云服务用于确定接入节点 | 必须与服务商控制台中的项目或服务区域一致。 | + +## 验证结果 + +聊天服务商通常会检查网络连通性、模型列表，以及一次简短的聊天请求。最后一项可能消耗少量服务商额度。语音服务商和语音识别服务商会在对应模块的测试区中验证实际的播放或识别结果。 + +验证失败时，请按以下顺序排查： + +1. 确认账户已开通对应服务且有可用额度。 +2. 重新复制 API Key，检查是否复制了多余的空格或换行。 +3. 将 Base URL 恢复为服务商默认值，或与服务商官方文档逐字核对。 +4. 确认网络、代理和防火墙允许访问该服务商。 +5. 选择服务商明确支持的模型；不要把展示名称当作模型 ID。 + +## 接下来 + +* 需要 AIRI 回复文字：阅读[配置聊天模型](./llm.md)。 +* 需要 AIRI 朗读回复或听取麦克风：阅读[配置语音输入与输出](./audio.md)。 diff --git a/docs/content/zh-Hans/docs/manual/config/index.md b/docs/content/zh-Hans/docs/manual/config/index.md index de520d7db..150a1efd5 100644 --- a/docs/content/zh-Hans/docs/manual/config/index.md +++ b/docs/content/zh-Hans/docs/manual/config/index.md @@ -1,18 +1,38 @@ --- -title: 配置指南 -description: 如何使用桌面版的 Project AIRI +title: 服务商配置指南 +description: 为 Project AIRI 配置聊天、视觉、语音合成和语音识别服务 --- +要让 AIRI 与你对话，至少需要配置一个聊天服务商和一个聊天模型。语音合成（TTS）让 AIRI 能够说话；语音识别（ASR/STT）让它能够听懂麦克风输入。这两项是可选的，但要获得完整的语音交互体验，建议一并配置。 + +## 先完成最小可用配置 + +1. 打开 AIRI 的 **设置 → 服务商**。 +2. 在 **聊天** 分类中选择服务商，填写凭据并完成验证。 +3. 打开 **设置 → 意识**，选择刚才配置的服务商和模型。 +4. 发送一条消息，确认 AIRI 可以回复。 + +完成聊天配置后，再按需要配置语音： + +* **[通用说明](./common.md)**：了解配置流程、字段含义、验证结果与常见问题。 +* **[配置聊天模型](./llm.md)**：配置 LLM，并在“意识”中选择模型。 +* **[配置语音输入与输出](./audio.md)**：配置 TTS 和 ASR/STT，并在“发声”和“听觉”中启用它们。 +* **[配置视觉理解](./vision.md)**：让 AIRI 使用已配置聊天服务商中支持图像输入的模型。 +* **[配置艺术创作](./providers/artistry/index.md)**：选择本地 ComfyUI 或云端图像生成服务商。 +* **[支持的服务商目录](./providers/catalog.md)**：查看当前版本已注册的聊天、视觉、语音合成和语音识别服务商。 + +> [!TIP] +> 如果你只想先验证 AIRI 能否工作，请先配置聊天服务商。TTS 和 ASR 可以在聊天正常后再添加，这样更容易定位问题。 + ## 设置 -你可以在系统托盘中打开设置以进行更多自定义，例如： -更改 AIRI 的主题颜色，或切换到其他模型，比如 Live2D（2D 模型）或 VRM（3D 模型，就像是 Grok Companion 那样）。 +服务商配置完成后，你还可以在设置中更改 AIRI 的主题颜色，或切换 Live2D（2D）与 VRM（3D）模型。 -设置中有很多选项，不妨多尝试一下，看看有哪些功能是你感兴趣的。 +配置服务商时，优先使用服务商文档提供的默认地址和模型名称。不要猜测 Base URL、模型 ID 或区域参数；它们因服务商而异。 ### 更换模型 diff --git a/docs/content/zh-Hans/docs/manual/config/llm.md b/docs/content/zh-Hans/docs/manual/config/llm.md new file mode 100644 index 000000000..195beb247 --- /dev/null +++ b/docs/content/zh-Hans/docs/manual/config/llm.md @@ -0,0 +1,46 @@ +--- +title: 配置聊天模型 +description: 为 AIRI 配置聊天服务商和模型 +--- + +聊天模型是 AIRI 的“大脑”。完成本页后，AIRI 可以生成文字回复。你需要一个支持聊天功能的服务商账户，或一个已运行的本地模型服务。 + +## 前提条件 + +* 已安装并启动 AIRI。 +* 云端服务商：已创建 API Key，并确认账户可以使用聊天模型。 +* 本地服务：模型服务已经启动，且 AIRI 所在设备可以访问它。 + +## 步骤 + +1. 打开 **设置 → 服务商 → 聊天**，选择你要使用的服务商。 + + 不确定选哪个时，可先从已有的详细指南中选择：[OpenRouter](./providers/consciousness/openrouter.md)、[DeepSeek](./providers/consciousness/deepseek.md)、[OpenAI 兼容 API](./providers/consciousness/openai.md)，或本地的 [Ollama](./providers/consciousness/ollama.md)。完整列表见[支持的服务商目录](./providers/catalog.md)。 + +2. 填写 API Key。若服务商提供了专用的 API 地址，再在高级设置中填写 Base URL；否则保留默认值。 + +3. 点击 **Ping API**，测试网络是否连通以及 API Key 是否填写正确。 + +4. 网络通畅后，点击 **选择模型**；也可以打开 **设置 → 意识**，选择刚配置的聊天服务商和模型。 + + AIRI 会在服务商支持时加载模型列表。列表无法加载时，可根据服务商官方文档手动输入精确的模型 ID。 + +5. 返回聊天界面，发送一条简短消息，例如“你好”。收到回复即表示配置成功。 + +## 排查 + +### 验证通过，但没有可选模型 + +先确认服务商允许列出模型。部分服务商不提供模型列表，或该 API Key 没有相应权限；这时在“意识”页面手动输入模型 ID 即可。模型 ID 必须与服务商文档完全一致。 + +### 验证失败或请求超时 + +检查 API Key、Base URL、账户额度和网络连接。对于本地服务，确认服务正在运行，并且 Base URL 不是只允许其他设备访问的地址。 + +### AIRI 没有回复 + +确认“意识”页面同时选中了服务商和模型。仅保存服务商凭据不会自动启用它。 + +## 下一步 + +聊天功能正常后，可继续[配置语音输入与输出](./audio.md)，让 AIRI 说话并使用麦克风输入。 diff --git a/docs/content/zh-Hans/docs/manual/config/providers/artistry/comfyui.md b/docs/content/zh-Hans/docs/manual/config/providers/artistry/comfyui.md new file mode 100644 index 000000000..b9d85f8de --- /dev/null +++ b/docs/content/zh-Hans/docs/manual/config/providers/artistry/comfyui.md @@ -0,0 +1,38 @@ +--- +title: ComfyUI（艺术创作） +description: 在 AIRI 中连接本地 ComfyUI 工作流 +--- + +ComfyUI 让 AIRI 使用你本机或可信局域网中的图像生成工作流。完成配置后，可在 **设置 → 艺术** 选择 ComfyUI，并让 AIRI 使用已保存的工作流生成图片。 + +::: info 为什么选择 ComfyUI？ +如果你希望使用自己安装的模型、节点和工作流，并把图像生成留在本地环境中，ComfyUI 是 AIRI 的本地艺术服务商。 +::: + +## 第一步：准备 ComfyUI 服务与工作流 + +1. 启动 ComfyUI。AIRI 默认连接 `http://localhost:8188`。 +2. 在 ComfyUI 中准备能够直接执行的图像工作流，并从 ComfyUI 导出其 API 工作流 JSON。 +3. 若 AIRI 与 ComfyUI 不在同一台设备，确认该地址可从 AIRI 所在设备访问。 + +::: warning 本地服务与工作流安全 +不要把 ComfyUI 的服务端口暴露给不受信任的公共网络。导入工作流前检查其中的节点、模型路径和参数，不要导入来源不明的工作流 JSON。 +::: + +## 第二步：在 AIRI 中配置 + +1. 打开 **设置 → 服务商 → 艺术 → ComfyUI**。 +2. 填写 ComfyUI Server URL；本机默认使用 `http://localhost:8188`。 +3. 点击 **测试连接**，确认 AIRI 能读取 ComfyUI 服务状态。 +4. 在“工作流”区域上传 API 工作流 JSON，填写名称，并选择要让 AIRI 暴露的输入字段。 +5. 保存工作流，并将它设为活动工作流。 + +### 3. 配置校验 + +1. 打开 **设置 → 艺术**，选择 **ComfyUI**。 +2. 选择刚保存的工作流，使用一条不含敏感信息的提示词发起生成。 +3. ComfyUI 完成任务并返回图片，即表示连接、工作流和可暴露字段配置成功。 + +## 排查 + +测试连接失败时，检查 ComfyUI 是否运行、Server URL、端口和网络访问。浏览器报跨域错误时，按 ComfyUI 设置页显示的 CORS 启动参数重新启动服务。工作流无法执行时，确认导入的是 API 格式 JSON，所用节点和模型已在 ComfyUI 中安装。 diff --git a/docs/content/zh-Hans/docs/manual/config/providers/artistry/index.md b/docs/content/zh-Hans/docs/manual/config/providers/artistry/index.md new file mode 100644 index 000000000..d34fc51e7 --- /dev/null +++ b/docs/content/zh-Hans/docs/manual/config/providers/artistry/index.md @@ -0,0 +1,10 @@ +--- +title: 艺术创作服务商 +description: 为 AIRI 的艺术模块配置图像生成服务商 +--- + +艺术模块用于让 AIRI 生成图片。当前支持 [ComfyUI](./comfyui.md)、[Replicate](./replicate.md) 和 [Nano Banana](./nanobanana.md)。先配置一个服务商，再到 **设置 → 艺术** 选择它。 + +::: info 如何选择？ +希望自定义工作流或在本地运行，选择 ComfyUI；希望使用云端模型，选择 Replicate 或 Nano Banana。 +::: diff --git a/docs/content/zh-Hans/docs/manual/config/providers/artistry/nanobanana.md b/docs/content/zh-Hans/docs/manual/config/providers/artistry/nanobanana.md new file mode 100644 index 000000000..f13e39ff9 --- /dev/null +++ b/docs/content/zh-Hans/docs/manual/config/providers/artistry/nanobanana.md @@ -0,0 +1,36 @@ +--- +title: Nano Banana（艺术创作） +description: 在 AIRI 中配置 Nano Banana 图像生成 +--- + +Nano Banana 使用 Google AI Studio API Key 生成图片。完成配置后，可在 **设置 → 艺术** 选择该服务商。 + +::: info 为什么选择 Nano Banana？ +如果你已有 Google AI Studio API Key，并希望直接使用 AIRI 内置的 Gemini 图像模型与分辨率选项，可以选择它。 +::: + +## 第一步：获取 API Key + +1. 打开并登录 [Google AI Studio API Keys](https://aistudio.google.com/app/apikey)，创建 API Key。 +2. 确认账户和所在地区可使用所选图像模型。 +3. 复制密钥并妥善保存。 + +::: warning API Key 安全 +不要将 API Key 提交到仓库、放入截图或发送给他人。密钥泄露后，请立即在 Google AI Studio 中撤销并创建新密钥。 +::: + +## 第二步：在 AIRI 中配置 + +1. 打开 **设置 → 服务商 → 艺术 → Nano Banana**，粘贴 API Key。 +2. 选择默认模型：`gemini-3.1-flash-image-preview`、`gemini-3-pro-image-preview` 或 `gemini-2.5-flash-image`。 +3. 选择默认分辨率：1K、2K 或 4K。 + +### 3. 配置校验 + +1. 打开 **设置 → 艺术**，选择 **Nano Banana**。 +2. 使用一条不含敏感信息的提示词生成图片。 +3. 成功返回图片即表示 API Key、模型和分辨率配置可用。 + +## 排查 + +认证失败时，检查 API Key 是否有效。模型不可用或请求被拒绝时，检查 Google AI Studio 账户、地区可用性与当前模型状态。生成失败时，先切换到 1K 分辨率或另一可用模型后重试。 diff --git a/docs/content/zh-Hans/docs/manual/config/providers/artistry/replicate.md b/docs/content/zh-Hans/docs/manual/config/providers/artistry/replicate.md new file mode 100644 index 000000000..ff11e6866 --- /dev/null +++ b/docs/content/zh-Hans/docs/manual/config/providers/artistry/replicate.md @@ -0,0 +1,37 @@ +--- +title: Replicate（艺术创作） +description: 在 AIRI 中配置 Replicate 图像生成 +--- + +Replicate 让 AIRI 使用云端图像生成模型。完成配置后，可在 **设置 → 艺术** 选择 Replicate 作为图像生成来源。 + +::: info 为什么选择 Replicate？ +如果你不想自行部署图像模型，并希望从 Replicate 可用模型中选择云端推理服务，可以选择它。 +::: + +## 第一步：获取 API Token + +1. 打开并登录 [Replicate API Tokens](https://replicate.com/account/api-tokens)，创建 API Token。 +2. 确认账户已配置可用的计费方式或额度。 +3. 复制 Token 并妥善保存。 + +::: warning API Token 安全 +不要将 Token 提交到仓库、放入截图或发送给他人。泄露后，请立即在 Replicate 控制台撤销并创建新 Token。 +::: + +## 第二步：在 AIRI 中配置 + +1. 打开 **设置 → 服务商 → 艺术 → Replicate**。 +2. 粘贴 API Token。 +3. 填写默认模型 ID。AIRI 默认值为 `black-forest-labs/flux-schnell`；请以 Replicate 模型页面显示的精确 ID 为准。 +4. 根据需要设置默认画面比例（默认 `16:9`）和推理步数（默认 4）。 + +### 3. 配置校验 + +1. 打开 **设置 → 艺术**，选择 **Replicate**。 +2. 使用一条不含敏感信息的提示词生成图片。 +3. 成功返回图片即表示 Token、模型 ID 和账户额度可用。 + +## 排查 + +认证失败时，检查 Token 是否粘贴完整。请求被拒绝或失败时，检查账户额度、模型访问权限和模型 ID。生成结果不符合预期时，先确认模型支持的比例和参数范围，再降低推理步数或更换模型。 diff --git a/docs/content/zh-Hans/docs/manual/config/providers/catalog.md b/docs/content/zh-Hans/docs/manual/config/providers/catalog.md new file mode 100644 index 000000000..950c8e390 --- /dev/null +++ b/docs/content/zh-Hans/docs/manual/config/providers/catalog.md @@ -0,0 +1,72 @@ +--- +title: 支持的服务商目录 +description: 查看当前版本 AIRI 支持的聊天、视觉、语音合成与语音识别服务商 +--- + +本页根据 AIRI 当前的服务商注册表整理。服务商会随版本变化，以 **设置 → 服务商** 页面实际显示的列表为准。先在该页面完成凭据配置，再在“意识”“发声”或“听觉”模块中选用它。 + +## 聊天模型 + +下列服务商在 AIRI 中注册为聊天服务商： + +| 服务商 | 类型 | 配置说明 | +| --- | --- | --- | +| AIRI 官方提供商 | 托管 | [查看指南](./consciousness/official.md) | +| 302.AI、DeepSeek、Fireworks AI、Groq、MiniMax、Mistral、Moonshot、NVIDIA NIM、Novita、OpenRouter、Perplexity、Together.ai、Z.ai | 云端 API | 已提供各自的中文指南；从侧栏“聊天”分类进入。 | +| MiniMax Global | 云端 API | [查看指南](./consciousness/minimax-global.md) | +| OpenAI、OpenAI 兼容 API | 云端 API | [查看指南](./consciousness/openai.md) | +| Anthropic | 云端 API | [查看指南](./consciousness/anthropic.md) | +| Google Gemini | 云端 API | [查看指南](./consciousness/google-gemini.md) | +| xAI | 云端 API | [查看指南](./consciousness/xai.md) | +| Cloudflare Workers AI | 账户级云端 API | [查看指南](./consciousness/cloudflare-workers-ai.md) | +| Ollama、LM Studio | 本地服务 | [Ollama](./consciousness/ollama.md)；[LM Studio](./consciousness/lm-studio.md) | +| AIHubMix | 云端 API | [查看指南](./consciousness/aihubmix.md) | +| Amazon Bedrock | 账户级云端 API | [查看指南](./consciousness/amazon-bedrock.md) | +| Azure AI Foundry | 账户级云端 API | [查看指南](./consciousness/azure-ai-foundry.md) | +| Azure OpenAI | 账户级云端 API | [查看指南](./consciousness/azure-openai.md) | +| BytePlus | 云端 API | [查看指南](./consciousness/byteplus.md) | +| BytePlus Coding Plan | 云端 API | [查看指南](./consciousness/byteplus-coding-plan.md) | +| Cerebras | 云端 API | [查看指南](./consciousness/cerebras.md) | +| CometAPI | 云端 API | [查看指南](./consciousness/comet-api.md) | +| Featherless.ai | 云端 API | [查看指南](./consciousness/featherless.md) | +| 小米 MiMo | 云端 API | [查看指南](./consciousness/mimo.md) | +| ModelScope | 云端 API | [查看指南](./consciousness/modelscope.md) | +| n1n | 云端 API | [查看指南](./consciousness/n1n.md) | +| 火山引擎 Coding Plan | 云端 API | [查看指南](./consciousness/volcengine-coding-plan.md) | + +## 语音合成（TTS） + +当前注册的语音合成服务商包括云端服务、本地服务和浏览器内置能力。具体可用项目仍以 **设置 → 服务商 → 语音合成** 为准。 + +* [AIRI 官方语音合成](./speech/official.md)、[阿里云百炼](./speech/alibaba-cloud-model-studio.md)、[ElevenLabs](./speech/elevenlabs.md)、[Deepgram](./speech/deepgram.md)、[Microsoft Azure Speech](./speech/azure-speech.md)、[MiniMax Speech](./speech/minimax.md)、[小米 MiMo](./speech/mimo.md)、[CometAPI](./speech/comet-api.md) 和 [火山引擎](./speech/volcengine.md)。 +* [Google Gemini](./speech/google-gemini.md)、[OpenAI 与兼容 API](./speech/openai.md)、[OpenRouter](./speech/openrouter.md)。 +* [Index-TTS](./speech/index-tts.md)、[Kokoro](./speech/kokoro.md)、[Player2 Speech](./speech/player2.md)、[浏览器本地语音合成](./speech/browser-local.md) 和 [桌面端本地语音合成](./speech/desktop-local.md)。 + +## 语音识别（ASR/STT） + +当前注册的语音识别服务商包括云端 API、浏览器内置识别与本地识别。具体可用项目仍以 **设置 → 服务商 → 语音识别** 为准。 + +* [AIRI 官方语音识别](./transcription/official.md)、[阿里云 NLS](./transcription/aliyun.md)、[CometAPI](./transcription/comet-api.md)、[小米 MiMo](./transcription/mimo.md) 与 [OpenAI 和兼容 API](./transcription/openai.md)。 +* [浏览器 Web Speech API](./transcription/web-speech-api.md)、[浏览器本地语音识别](./transcription/browser-local.md) 和 [桌面端本地语音识别](./transcription/desktop-local.md)。 + +## 视觉理解 + +视觉理解服务从已配置的聊天服务商派生，不需要单独申请另一套 API Key。选择支持图像输入的模型后，即可让 AIRI 分析图片。 + +* [查看视觉理解配置指南](../vision.md)。 + +## 艺术创作 + +艺术模块使用所选服务商生成图片。当前注册的艺术服务商如下： + +| 服务商 | 类型 | 配置说明 | +| --- | --- | --- | +| ComfyUI | 本地工作流 | [查看指南](./artistry/comfyui.md) | +| Replicate | 云端图像生成 | [查看指南](./artistry/replicate.md) | +| Nano Banana | 云端图像生成 | [查看指南](./artistry/nanobanana.md) | + +## 选择建议 + +* 想快速开始：先选择一个已提供详细指南的聊天服务商。 +* 重视隐私或离线使用：选择 Ollama 或 LM Studio，并确认本地服务已启动。 +* 需要完整语音交互：在聊天正常后，再分别配置 TTS 与 ASR/STT。 diff --git a/docs/content/zh-Hans/docs/manual/config/providers/consciousness/302ai.md b/docs/content/zh-Hans/docs/manual/config/providers/consciousness/302ai.md new file mode 100644 index 000000000..d918abeeb --- /dev/null +++ b/docs/content/zh-Hans/docs/manual/config/providers/consciousness/302ai.md @@ -0,0 +1,36 @@ +--- +title: 302.AI +description: 在 AIRI 中配置 302.AI 作为大模型服务商 +is_openai_compatible: true +--- + +302.AI 是一个聚合式 API 服务商。完成本页配置后，AIRI 可以在“意识”中使用 302.AI 提供的聊天模型。 + +::: info 为什么选择 302.AI？ +如果你主要在中国大陆使用 AIRI，可以优先尝试 302.AI。它提供聚合式 API，方便用一个 API Key 尝试多个模型；实际可用性仍取决于你的网络环境、支付方式和服务商政策。 +::: + +## 第一步：获取 API 密钥 + +1. 打开 [302.AI 控制台](https://302.ai/)，登录或注册账号。 +2. 在控制台中创建 API Key。 +3. 复制密钥并妥善保存。 + +::: warning API Key 安全 +不要将 API Key 提交到仓库、放入截图，或发送给他人。密钥泄露后，请立即在 302.AI 控制台撤销它并创建新密钥。 +::: + +## 第二步：在 AIRI 中配置 + +1. 打开 **设置 → 服务商 → 聊天 → 302.AI**。 +2. 将 API Key 粘贴到基础设置。 +3. 保留默认 Base URL：`https://api.302.ai/v1`。 + +### 3. 配置校验 + +1. **Ping API**: 点击此按钮测试网络是否连通以及 API 密钥是否填写正确。 +2. **选择模型**: 测试成功后，点击此处选择你想要使用的具体模型。 + +## 排查 + +如果 Ping API 失败，请检查 API Key、账户余额和网络连接。模型列表无法加载时，可在“意识”页面手动输入 302.AI 提供的精确模型 ID。 diff --git a/docs/content/zh-Hans/docs/manual/config/providers/consciousness/aihubmix.md b/docs/content/zh-Hans/docs/manual/config/providers/consciousness/aihubmix.md new file mode 100644 index 000000000..e659bfb17 --- /dev/null +++ b/docs/content/zh-Hans/docs/manual/config/providers/consciousness/aihubmix.md @@ -0,0 +1,24 @@ +--- +title: AIHubMix +description: 在 AIRI 中配置 AIHubMix 聊天模型 +--- + +AIHubMix 在 AIRI 中提供聊天模型，并可列出账户可用模型。 + +::: info 为什么选择 AIHubMix？ +如果你希望通过一个 API Key 使用 AIHubMix 账户中提供的模型，可以选择它。 +::: + +## 第一步：获取 API Key + +1. 打开并登录 [AIHubMix](https://aihubmix.com/)，在控制台创建 API Key。 + +## 第二步：在 AIRI 中配置 + +1. 打开 **设置 → 服务商 → 聊天 → AIHubMix**，填写 **API Key**。默认 Base URL 为 `https://aihubmix.com/v1/`。 +2. **Ping API**：点击此按钮测试网络是否连通以及 API Key 是否填写正确。 +3. **选择模型**：测试成功后，选择你想使用的具体模型；然后到 **设置 → 意识** 启用它。 + +::: warning API Key 安全 +不要将 API Key 提交到仓库、截图或发送给他人。 +::: diff --git a/docs/content/zh-Hans/docs/manual/config/providers/consciousness/amazon-bedrock.md b/docs/content/zh-Hans/docs/manual/config/providers/consciousness/amazon-bedrock.md new file mode 100644 index 000000000..f917ecfeb --- /dev/null +++ b/docs/content/zh-Hans/docs/manual/config/providers/consciousness/amazon-bedrock.md @@ -0,0 +1,25 @@ +--- +title: Amazon Bedrock +description: 在 AIRI 中配置 Amazon Bedrock 聊天模型 +--- + +Amazon Bedrock 使用 AWS 凭据和区域来访问已获授权的基础模型。 + +::: info 为什么选择 Amazon Bedrock？ +如果你已经在 AWS 中管理模型访问权限、区域和计费，Bedrock 可沿用这一套账户管理方式。 +::: + +## 第一步：准备 AWS 凭据 + +1. 打开并登录 [AWS Management Console](https://console.aws.amazon.com/bedrock/)，创建具备 Bedrock 权限的访问凭据。 + +## 第二步：在 AIRI 中配置 + +1. 打开 **设置 → 服务商 → 聊天 → Amazon Bedrock**，填写 AWS **API Key**，并选择区域；默认区域为 `us-east-1`。 +2. 确认该 AWS 账户已在对应区域获得目标模型的访问权限。只有在使用自定义 Bedrock Endpoint 时才填写自定义地址。 +3. **Ping API**：点击此按钮测试凭据、区域和网络是否正确。 +4. **选择模型**：测试成功后，选择账户已授权的模型，再到 **设置 → 意识** 启用。 + +::: warning AWS 凭据安全 +不要公开 AWS 访问密钥。请使用权限最小化的凭据，并在不再使用时撤销。 +::: diff --git a/docs/content/zh-Hans/docs/manual/config/providers/consciousness/anthropic.md b/docs/content/zh-Hans/docs/manual/config/providers/consciousness/anthropic.md new file mode 100644 index 000000000..dc6755d18 --- /dev/null +++ b/docs/content/zh-Hans/docs/manual/config/providers/consciousness/anthropic.md @@ -0,0 +1,37 @@ +--- +title: Anthropic +description: 在 AIRI 中配置 Anthropic Claude 聊天模型 +--- + +Anthropic 服务商让 AIRI 使用 Claude 聊天模型。AIRI 使用 Anthropic 的 API 地址和你的 API Key；模型列表由 AIRI 内置，因此无需手动填写 Base URL 或模型 ID 才能开始。 + +::: info 为什么选择 Anthropic？ +如果你已在使用 Claude API，或希望在 AIRI 中使用 Claude 模型，可以直接选择 Anthropic。 +::: + +## 第一步：创建 API Key + +1. 在 Anthropic 控制台创建一个 API Key，并确认账户已开通 API 使用权限。 +2. 为密钥设置适当的名称、有效期和额度限制。 +3. 复制密钥并妥善保存。 + +::: warning API Key 安全 +不要将 API Key 提交到仓库、放入截图，或发送给他人。密钥泄露后，请立即在 Anthropic 控制台撤销它并创建新密钥。 +::: + +## 第二步：在 AIRI 中配置 + +1. 打开 **设置 → 服务商 → 聊天 → Anthropic**。 +2. 将 API Key 粘贴到基础设置。 +3. 保留默认 Base URL：`https://api.anthropic.com/v1/`。 + +### 3. 配置校验 + +1. **Ping API**: 点击此按钮测试网络是否连通以及 API Key 是否填写正确。 +2. **选择模型**: 测试成功后，点击此处选择你想要使用的具体模型。 + +## 排查 + +Ping API 会检查网络连通性，并发送一条很短的聊天请求。若失败，请确认 API Key 可用、账户有额度，并检查网络是否能访问 Anthropic API。 + +若模型选择器没有显示预期模型，先更新 AIRI 或在“意识”页面手动输入服务商提供的精确模型 ID。 diff --git a/docs/content/zh-Hans/docs/manual/config/providers/consciousness/azure-ai-foundry.md b/docs/content/zh-Hans/docs/manual/config/providers/consciousness/azure-ai-foundry.md new file mode 100644 index 000000000..5e5f09395 --- /dev/null +++ b/docs/content/zh-Hans/docs/manual/config/providers/consciousness/azure-ai-foundry.md @@ -0,0 +1,25 @@ +--- +title: Azure AI Foundry +description: 在 AIRI 中配置 Azure AI Foundry 聊天模型 +--- + +Azure AI Foundry 需要资源名称、模型部署信息和 API Key。 + +::: info 为什么选择 Azure AI Foundry？ +如果你的模型部署和访问控制已在 Azure AI Foundry 中完成，可用此服务商直接连接部署。 +::: + +## 第一步：准备 Azure AI Foundry 资源 + +1. 打开并登录 [Azure AI Foundry](https://ai.azure.com/)，创建或打开目标项目并取得 API Key、资源名称和模型部署信息。 + +## 第二步：在 AIRI 中配置 + +1. 打开 **设置 → 服务商 → 聊天 → Azure AI Foundry**，填写 **API Key**、资源名称和模型 ID。 +2. 如控制台要求特定 API 版本，请在界面中填写；不要将普通模型名误作部署名。 +3. **Ping API**：点击此按钮测试网络、资源名称和 API Key 是否正确。 +4. **选择模型**：测试成功后，选择可用部署，再到 **设置 → 意识** 启用。 + +::: warning API Key 安全 +不要将 Azure API Key 提交到仓库、截图或发送给他人。 +::: diff --git a/docs/content/zh-Hans/docs/manual/config/providers/consciousness/azure-openai.md b/docs/content/zh-Hans/docs/manual/config/providers/consciousness/azure-openai.md new file mode 100644 index 000000000..30916efdd --- /dev/null +++ b/docs/content/zh-Hans/docs/manual/config/providers/consciousness/azure-openai.md @@ -0,0 +1,25 @@ +--- +title: Azure OpenAI +description: 在 AIRI 中配置 Azure OpenAI 聊天模型 +--- + +Azure OpenAI 通过你的 Azure 资源端点和部署访问模型。 + +::: info 为什么选择 Azure OpenAI？ +如果你的团队已在 Azure OpenAI 中部署模型并管理权限，这是直接的接入方式。 +::: + +## 第一步：准备 Azure OpenAI 资源 + +1. 打开并登录 [Azure Portal](https://portal.azure.com/)，创建或打开 Azure OpenAI 资源并取得端点和 API Key。 + +## 第二步：在 AIRI 中配置 + +1. 打开 **设置 → 服务商 → 聊天 → Azure OpenAI**，填写 **API Key** 和 Azure OpenAI 端点。 +2. 建议填写控制台提供的完整 Chat Completions 地址；如果地址中包含部署名与 `api-version`，AIRI 会据此识别配置。 +3. **Ping API**：点击此按钮测试网络、端点和 API Key 是否正确。 +4. **选择模型**：测试成功后，选择对应部署，再到 **设置 → 意识** 启用。 + +::: warning API Key 安全 +不要将 Azure API Key 提交到仓库、截图或发送给他人。 +::: diff --git a/docs/content/zh-Hans/docs/manual/config/providers/consciousness/byteplus-coding-plan.md b/docs/content/zh-Hans/docs/manual/config/providers/consciousness/byteplus-coding-plan.md new file mode 100644 index 000000000..0ae49ce42 --- /dev/null +++ b/docs/content/zh-Hans/docs/manual/config/providers/consciousness/byteplus-coding-plan.md @@ -0,0 +1,24 @@ +--- +title: BytePlus Coding Plan +description: 在 AIRI 中配置 BytePlus Coding Plan 聊天模型 +--- + +BytePlus Coding Plan 在 AIRI 中以独立服务商卡片提供。 + +::: info 为什么选择 BytePlus Coding Plan？ +如果你的 BytePlus 账户开通了 Coding Plan，应使用这个卡片而不是普通 BytePlus 配置，以匹配对应的服务计划。 +::: + +## 第一步：准备 BytePlus Coding Plan 凭据 + +1. 打开并登录 [BytePlus Console](https://console.byteplus.com/)，在 Coding Plan 对应页面取得凭据和端点信息。 + +## 第二步：在 AIRI 中配置 + +1. 打开 **设置 → 服务商 → 聊天 → BytePlus Coding Plan**，按 BytePlus 控制台填写该计划的凭据和端点信息。 +2. **Ping API**：点击此按钮测试网络与凭据是否正确。 +3. **选择模型**：测试成功后，在 **设置 → 意识** 选择可用模型。 + +::: warning API Key 安全 +不要将 API Key 或端点凭据提交到仓库、截图或发送给他人。 +::: diff --git a/docs/content/zh-Hans/docs/manual/config/providers/consciousness/byteplus.md b/docs/content/zh-Hans/docs/manual/config/providers/consciousness/byteplus.md new file mode 100644 index 000000000..56510427d --- /dev/null +++ b/docs/content/zh-Hans/docs/manual/config/providers/consciousness/byteplus.md @@ -0,0 +1,25 @@ +--- +title: BytePlus +description: 在 AIRI 中配置 BytePlus 聊天模型 +--- + +BytePlus 在 AIRI 中使用 Ark 兼容的聊天服务配置。 + +::: info 为什么选择 BytePlus？ +如果你已在 BytePlus 创建 Ark 模型端点，可在 AIRI 中直接使用该端点和凭据。 +::: + +## 第一步：准备 BytePlus 凭据 + +1. 打开并登录 [BytePlus Console](https://console.byteplus.com/)，创建或查看 Ark 端点及其访问凭据。 + +## 第二步：在 AIRI 中配置 + +1. 打开 **设置 → 服务商 → 聊天 → BytePlus**，按照 BytePlus 控制台填写 API Key、端点或模型信息。 +2. 不要猜测 Endpoint ID；请复制控制台中已创建端点的实际标识。 +3. **Ping API**：点击此按钮测试网络与凭据是否正确。 +4. **选择模型**：测试成功后，到 **设置 → 意识** 选择该服务商与模型。 + +::: warning API Key 安全 +不要将 API Key 或端点凭据提交到仓库、截图或发送给他人。 +::: diff --git a/docs/content/zh-Hans/docs/manual/config/providers/consciousness/cerebras.md b/docs/content/zh-Hans/docs/manual/config/providers/consciousness/cerebras.md new file mode 100644 index 000000000..0df4bebaa --- /dev/null +++ b/docs/content/zh-Hans/docs/manual/config/providers/consciousness/cerebras.md @@ -0,0 +1,24 @@ +--- +title: Cerebras +description: 在 AIRI 中配置 Cerebras 聊天模型 +--- + +Cerebras 在 AIRI 中通过其兼容 API 提供聊天模型。 + +::: info 为什么选择 Cerebras？ +如果你已使用 Cerebras API，并希望在 AIRI 中调用账户可用模型，可以选择它。 +::: + +## 第一步：获取 API Key + +1. 打开并登录 [Cerebras Cloud](https://cloud.cerebras.ai/)，创建 API Key。 + +## 第二步：在 AIRI 中配置 + +1. 打开 **设置 → 服务商 → 聊天 → Cerebras**，填写 **API Key**。默认 Base URL 为 `https://api.cerebras.ai/v1/`。 +2. **Ping API**：点击此按钮测试网络是否连通以及 API Key 是否填写正确。 +3. **选择模型**：测试成功后，选择模型，再到 **设置 → 意识** 启用。 + +::: warning API Key 安全 +不要将 API Key 提交到仓库、截图或发送给他人。 +::: diff --git a/docs/content/zh-Hans/docs/manual/config/providers/consciousness/cloudflare-workers-ai.md b/docs/content/zh-Hans/docs/manual/config/providers/consciousness/cloudflare-workers-ai.md new file mode 100644 index 000000000..450e60429 --- /dev/null +++ b/docs/content/zh-Hans/docs/manual/config/providers/consciousness/cloudflare-workers-ai.md @@ -0,0 +1,34 @@ +--- +title: Cloudflare Workers AI +description: 在 AIRI 中配置 Cloudflare Workers AI 聊天模型 +--- + +Cloudflare Workers AI 使用账户级凭据。除 API Token 外，AIRI 还需要 Cloudflare Account ID 才能定位你的 Workers AI 资源。 + +::: info 为什么选择 Cloudflare Workers AI？ +如果你的模型服务已部署在 Cloudflare 账户中，使用 Workers AI 能直接复用该账户的 Token 与 Account ID。 +::: + +## 第一步：准备凭据 + +1. 在 Cloudflare 控制台创建具有 Workers AI 访问权限的 API Token。 +2. 复制该 Token。 +3. 在 Cloudflare 控制台中找到并复制 Account ID。 + +::: warning 安全提醒 +API Token 与账户权限绑定。请遵循最小权限原则，只授予 AIRI 所需的 Workers AI 权限；不要将 Token 或 Account ID 与公开日志一同发布。 +::: + +## 第二步：在 AIRI 中配置 + +1. 打开 **设置 → 服务商 → 聊天 → Cloudflare Workers AI**。 +2. 填写 **API Token** 与 **Account ID**。 + +### 3. 配置校验 + +1. 确认基础凭据验证通过。 +2. **选择模型**: 测试成功后，点击此处选择你想要使用的具体模型。 + +## 排查 + +若 AIRI 提示凭据无效，分别检查 Token 权限和 Account ID 是否来自同一个 Cloudflare 账户。此服务商不使用可编辑的 Base URL，因此不应将 Worker URL 或 API 路径填入任何字段。 diff --git a/docs/content/zh-Hans/docs/manual/config/providers/consciousness/comet-api.md b/docs/content/zh-Hans/docs/manual/config/providers/consciousness/comet-api.md new file mode 100644 index 000000000..dc5674c7d --- /dev/null +++ b/docs/content/zh-Hans/docs/manual/config/providers/consciousness/comet-api.md @@ -0,0 +1,24 @@ +--- +title: CometAPI +description: 在 AIRI 中配置 CometAPI 聊天模型 +--- + +CometAPI 在 AIRI 中提供聊天模型，也有独立的 TTS 与 STT 服务商页面。 + +::: info 为什么选择 CometAPI？ +如果你希望在同一 CometAPI 账户下配置聊天、语音合成和语音识别，可以选择它。 +::: + +## 第一步：获取 API Key + +1. 打开并登录 [CometAPI 控制台](https://www.cometapi.com/console/token)，创建 API Key。 + +## 第二步：在 AIRI 中配置 + +1. 打开 **设置 → 服务商 → 聊天 → CometAPI**，填写 **API Key**。默认 Base URL 为 `https://api.cometapi.com/v1/`。 +2. **Ping API**：点击此按钮测试网络是否连通以及 API Key 是否填写正确。 +3. **选择模型**：测试成功后，选择模型，再到 **设置 → 意识** 启用。 + +::: warning API Key 安全 +不要将 API Key 提交到仓库、截图或发送给他人。 +::: diff --git a/docs/content/zh-Hans/docs/manual/config/providers/consciousness/deepseek.md b/docs/content/zh-Hans/docs/manual/config/providers/consciousness/deepseek.md new file mode 100644 index 000000000..bd35bdb27 --- /dev/null +++ b/docs/content/zh-Hans/docs/manual/config/providers/consciousness/deepseek.md @@ -0,0 +1,36 @@ +--- +title: DeepSeek +description: 在 AIRI 中配置 DeepSeek 作为大模型服务商 +is_openai_compatible: true +--- + +DeepSeek 提供兼容 OpenAI 格式的聊天 API。完成本页配置后，AIRI 可以在“意识”中使用 DeepSeek 提供的模型。 + +::: info 为什么选择 DeepSeek？ +如果你希望在 AIRI 中使用 DeepSeek 模型，或已经拥有 DeepSeek API Key，可以直接选择此服务商。 +::: + +## 第一步：获取 API 密钥 + +1. 打开 [DeepSeek 管理控制台](https://platform.deepseek.com/)。 +2. 在 API 密钥页面创建新的 API Key。 +3. 复制密钥并妥善保存。 + +::: warning API Key 安全 +不要将 API Key 提交到仓库、放入截图，或发送给他人。密钥泄露后，请立即在 DeepSeek 控制台撤销它并创建新密钥。 +::: + +## 第二步：在 AIRI 中配置 + +1. 打开 **设置 → 服务商 → 聊天 → DeepSeek**。 +2. 将 API Key 粘贴到基础设置。 +3. 保留默认 Base URL：`https://api.deepseek.com/v1`。 + +### 3. 配置校验 + +1. **Ping API**: 点击此按钮测试网络是否连通以及 API Key 是否填写正确。 +2. **选择模型**: 测试成功后，点击此处选择你想要使用的具体模型。 + +## 排查 + +如果 Ping API 失败，请检查 API Key、账户额度和网络连接。模型列表无法加载时，可在“意识”页面手动输入 DeepSeek 提供的精确模型 ID。 diff --git a/docs/content/zh-Hans/docs/manual/config/providers/consciousness/featherless.md b/docs/content/zh-Hans/docs/manual/config/providers/consciousness/featherless.md new file mode 100644 index 000000000..a2db16e9d --- /dev/null +++ b/docs/content/zh-Hans/docs/manual/config/providers/consciousness/featherless.md @@ -0,0 +1,24 @@ +--- +title: Featherless.ai +description: 在 AIRI 中配置 Featherless.ai 聊天模型 +--- + +Featherless.ai 在 AIRI 中通过兼容 API 提供聊天模型。 + +::: info 为什么选择 Featherless.ai？ +如果你已在 Featherless.ai 开通模型访问，可直接使用其 API Key 配置 AIRI。 +::: + +## 第一步：获取 API Key + +1. 打开并登录 [Featherless.ai](https://featherless.ai/)，在账户控制台创建 API Key。 + +## 第二步：在 AIRI 中配置 + +1. 打开 **设置 → 服务商 → 聊天 → Featherless.ai**，填写 **API Key**。默认 Base URL 为 `https://api.featherless.ai/v1/`。 +2. **Ping API**：点击此按钮测试网络是否连通以及 API Key 是否填写正确。 +3. **选择模型**：测试成功后，选择模型，再到 **设置 → 意识** 启用。 + +::: warning API Key 安全 +不要将 API Key 提交到仓库、截图或发送给他人。 +::: diff --git a/docs/content/zh-Hans/docs/manual/config/providers/consciousness/fireworks.md b/docs/content/zh-Hans/docs/manual/config/providers/consciousness/fireworks.md new file mode 100644 index 000000000..7323e8c8f --- /dev/null +++ b/docs/content/zh-Hans/docs/manual/config/providers/consciousness/fireworks.md @@ -0,0 +1,36 @@ +--- +title: Fireworks AI +description: 在 AIRI 中配置 Fireworks AI 作为大模型服务商 +is_openai_compatible: true +--- + +Fireworks AI 提供兼容 OpenAI 格式的聊天 API。完成本页配置后，AIRI 可以在“意识”中使用 Fireworks AI 提供的模型。 + +::: info 为什么选择 Fireworks AI？ +如果你已在 Fireworks AI 中管理模型或推理服务，可以直接复用同一套 API 凭据。 +::: + +## 第一步：获取 API 密钥 + +1. 打开 [Fireworks AI API Keys](https://fireworks.ai/account/api-keys)。 +2. 创建新的 API Key。 +3. 复制密钥并妥善保存。 + +::: warning API Key 安全 +不要将 API Key 提交到仓库、放入截图，或发送给他人。密钥泄露后，请立即在 Fireworks AI 控制台撤销它并创建新密钥。 +::: + +## 第二步：在 AIRI 中配置 + +1. 打开 **设置 → 服务商 → 聊天 → Fireworks AI**。 +2. 将 API Key 粘贴到基础设置。 +3. 保留默认 Base URL：`https://api.fireworks.ai/inference/v1`。 + +### 3. 配置校验 + +1. **Ping API**: 点击此按钮测试网络是否连通以及 API Key 是否填写正确。 +2. **选择模型**: 测试成功后，点击此处选择你想要使用的具体模型。 + +## 排查 + +如果 Ping API 失败，请检查 API Key、账户额度和网络连接。模型列表无法加载时，可在“意识”页面手动输入 Fireworks AI 提供的精确模型 ID。 diff --git a/docs/content/zh-Hans/docs/manual/config/providers/consciousness/google-gemini.md b/docs/content/zh-Hans/docs/manual/config/providers/consciousness/google-gemini.md new file mode 100644 index 000000000..8735399e4 --- /dev/null +++ b/docs/content/zh-Hans/docs/manual/config/providers/consciousness/google-gemini.md @@ -0,0 +1,35 @@ +--- +title: Google Gemini +description: 在 AIRI 中配置 Google Gemini 聊天模型 +--- + +Google Gemini 服务商使用 Google Generative Language API 的 OpenAI 兼容端点。完成配置后，在“意识”页面选择 Gemini 模型即可。 + +::: info 为什么选择 Google Gemini？ +如果你已有 Gemini API Key，或希望在 AIRI 中使用 Gemini 模型，可以选择该服务商。 +::: + +## 第一步：创建 API Key + +1. 在 Google AI 的开发者控制台创建 Gemini API Key。 +2. 确认密钥所属项目已启用 Gemini API，且可使用目标模型。 +3. 复制 API Key。 + +::: warning API Key 安全 +密钥泄露后，请立即在 Google AI 的开发者控制台撤销并重新创建；不要把密钥放进代码、截图或公开的配置文件。 +::: + +## 第二步：在 AIRI 中配置 + +1. 打开 **设置 → 服务商 → 聊天 → Google Gemini**。 +2. 填写 API Key。 +3. 保留默认 Base URL：`https://generativelanguage.googleapis.com/v1beta/openai/`。 + +### 3. 配置校验 + +1. **Ping API**: 点击此按钮测试网络是否连通以及 API Key 是否填写正确。 +2. **选择模型**: 测试成功后，点击此处选择你想要使用的具体模型。 + +## 排查 + +Ping API 会检查网络、模型列表和聊天请求。出现权限或模型不可用错误时，请先检查 API Key 对应项目的 API 启用状态与地区可用性。不要把 Google AI Studio 中展示的模型名称改写为其他格式；在 AIRI 中优先从模型列表选择。 diff --git a/docs/content/zh-Hans/docs/manual/config/providers/consciousness/groq.md b/docs/content/zh-Hans/docs/manual/config/providers/consciousness/groq.md new file mode 100644 index 000000000..9699d3e35 --- /dev/null +++ b/docs/content/zh-Hans/docs/manual/config/providers/consciousness/groq.md @@ -0,0 +1,36 @@ +--- +title: Groq +description: 在 AIRI 中配置 Groq 作为大模型服务商 +is_openai_compatible: true +--- + +Groq 提供兼容 OpenAI 格式的聊天 API。完成本页配置后，AIRI 可以在“意识”中使用 Groq 提供的模型。 + +::: info 为什么选择 Groq？ +如果你重视对话响应速度，并且目标模型在 Groq 中可用，可以尝试此服务商。 +::: + +## 第一步：获取 API 密钥 + +1. 打开 [Groq 控制台](https://console.groq.com/)。 +2. 在 API 密钥页面创建新的 API Key。 +3. 复制密钥并妥善保存。 + +::: warning API Key 安全 +不要将 API Key 提交到仓库、放入截图，或发送给他人。密钥泄露后，请立即在 Groq 控制台撤销它并创建新密钥。 +::: + +## 第二步：在 AIRI 中配置 + +1. 打开 **设置 → 服务商 → 聊天 → Groq**。 +2. 将 API Key 粘贴到基础设置。 +3. 保留默认 Base URL：`https://api.groq.com/openai/v1`。 + +### 3. 配置校验 + +1. **Ping API**: 点击此按钮测试网络是否连通以及 API Key 是否填写正确。 +2. **选择模型**: 测试成功后，点击此处选择你想要使用的具体模型。 + +## 排查 + +如果 Ping API 失败，请检查 API Key、账户额度和网络连接。模型列表无法加载时，可在“意识”页面手动输入 Groq 提供的精确模型 ID。 diff --git a/docs/content/zh-Hans/docs/manual/config/providers/consciousness/lm-studio.md b/docs/content/zh-Hans/docs/manual/config/providers/consciousness/lm-studio.md new file mode 100644 index 000000000..5c8000d75 --- /dev/null +++ b/docs/content/zh-Hans/docs/manual/config/providers/consciousness/lm-studio.md @@ -0,0 +1,31 @@ +--- +title: LM Studio（本地模型） +description: 使用本地 LM Studio 服务为 AIRI 配置聊天模型 +--- + +LM Studio 可以在本机运行模型并提供本地 API。它适合希望在自己的设备上运行模型的用户；默认情况下不需要 API Key。 + +::: info 为什么选择 LM Studio？ +如果你希望在本机运行模型并自行管理模型文件，LM Studio 是不依赖云端 API Key 的选择。 +::: + +## 第一步：启动本地服务 + +1. 在 LM Studio 中下载并加载一个聊天模型。 +2. 打开 **Local Server**，启动本地服务器。 +3. 如果 AIRI 无法访问本地服务，请在 LM Studio 的服务器设置中启用 CORS。 + +## 第二步：在 AIRI 中配置 + +1. 打开 **设置 → 服务商 → 聊天 → LM Studio**。 +2. 保留默认 Base URL：`http://localhost:1234/v1/`。 +3. 如你的 LM Studio 服务需要鉴权，再填写 API Key；否则留空。 + +### 3. 配置校验 + +1. **Ping API**: 点击此按钮测试 AIRI 能否连接本地服务。 +2. **选择模型**: 测试成功后，点击此处选择已加载的模型。 + +## 排查 + +无法连接时，先确认 Local Server 正在运行，且端口与 Base URL 一致。若 AIRI 与 LM Studio 不在同一设备，使用可从 AIRI 设备访问的局域网地址，并仅在可信网络中开放该服务。 diff --git a/docs/content/zh-Hans/docs/manual/config/providers/consciousness/mimo.md b/docs/content/zh-Hans/docs/manual/config/providers/consciousness/mimo.md new file mode 100644 index 000000000..9e4d8b59a --- /dev/null +++ b/docs/content/zh-Hans/docs/manual/config/providers/consciousness/mimo.md @@ -0,0 +1,24 @@ +--- +title: 小米 MiMo +description: 在 AIRI 中配置小米 MiMo 聊天模型 +--- + +小米 MiMo 在 AIRI 中提供聊天模型，并有独立的 TTS 与 STT 服务商页面。 + +::: info 为什么选择小米 MiMo？ +如果你希望在同一 MiMo 账户下使用聊天和音频能力，可以选择它。 +::: + +## 第一步：获取 API Key + +1. 打开并登录 [小米 MiMo 平台](https://platform.xiaomimimo.com/)，创建 API Key。 + +## 第二步：在 AIRI 中配置 + +1. 打开 **设置 → 服务商 → 聊天 → Xiaomi MiMo**，填写 **API Key**。默认 Base URL 为 `https://api.xiaomimimo.com/v1/`。 +2. **Ping API**：点击此按钮测试网络是否连通以及 API Key 是否填写正确。 +3. **选择模型**：测试成功后，选择模型，再到 **设置 → 意识** 启用。 + +::: warning API Key 安全 +不要将 API Key 提交到仓库、截图或发送给他人。 +::: diff --git a/docs/content/zh-Hans/docs/manual/config/providers/consciousness/minimax-global.md b/docs/content/zh-Hans/docs/manual/config/providers/consciousness/minimax-global.md new file mode 100644 index 000000000..371d9a8cf --- /dev/null +++ b/docs/content/zh-Hans/docs/manual/config/providers/consciousness/minimax-global.md @@ -0,0 +1,37 @@ +--- +title: MiniMax Global +description: 在 AIRI 中配置海外版 MiniMax 作为大模型服务商 +is_openai_compatible: true +--- + +本页适用于在 MiniMax 海外平台创建的 API Key。完成配置后，AIRI 可以在“意识”中使用 MiniMax Global 提供的聊天模型。 + +::: info 为什么选择 MiniMax Global？ +如果你在 MiniMax 海外平台创建 API Key，或使用海外 Token Plan，应选择 MiniMax Global。中国大陆平台创建的 Key 请使用 [MiniMax（中国大陆）](./minimax.md)；两套平台的 API Key、计费和 Base URL 不能混用。 +::: + +## 第一步：获取 API Key + +1. 打开并登录 [MiniMax Global 平台](https://platform.minimax.io/)。 +2. 在 **API Keys** 中创建按量付费 API Key；若使用 Token Plan，请在对应订阅页面获取其专用 Key。 +3. 复制密钥并妥善保存。 + +::: warning API Key 安全 +不要将 API Key 提交到仓库、放入截图或发送给他人。密钥泄露后，请立即在 MiniMax Global 平台撤销它并创建新密钥。 +::: + +## 第二步：在 AIRI 中配置 + +1. 打开 **设置 → 服务商 → 聊天 → MiniMax Global**。 +2. 将 API Key 粘贴到基础设置。 +3. 保留默认 Base URL：`https://api.minimax.io/v1/`。 + +### 3. 配置校验 + +1. **Ping API**：点击此按钮测试网络是否连通以及 API Key 是否填写正确。 +2. **选择模型**：测试成功后，点击此处选择你想使用的具体模型。 +3. 在 **设置 → 意识** 中选择 MiniMax Global 与该模型，并发送一条短消息确认 AIRI 能够回复。 + +## 排查 + +Ping API 失败时，确认 API Key 来自海外平台、Base URL 为 `https://api.minimax.io/v1/`，并检查账户额度和网络连接。出现 401 时，常见原因是中国大陆与海外平台的 Key 或地址混用。模型列表无法加载时，可在“意识”页面手动输入 MiniMax Global 提供的精确模型 ID。 diff --git a/docs/content/zh-Hans/docs/manual/config/providers/consciousness/minimax.md b/docs/content/zh-Hans/docs/manual/config/providers/consciousness/minimax.md new file mode 100644 index 000000000..b648771a9 --- /dev/null +++ b/docs/content/zh-Hans/docs/manual/config/providers/consciousness/minimax.md @@ -0,0 +1,36 @@ +--- +title: MiniMax（中国大陆） +description: 在 AIRI 中配置中国大陆版 MiniMax 作为大模型服务商 +is_openai_compatible: true +--- + +本页适用于在中国大陆 MiniMax 开放平台创建的 API Key。MiniMax 提供兼容 OpenAI 格式的聊天 API；完成配置后，AIRI 可以在“意识”中使用其模型。 + +::: info 为什么选择 MiniMax？ +如果你在中国大陆 MiniMax 开放平台创建 API Key，应选择此服务商。海外平台创建的 Key 请使用 [MiniMax Global](./minimax-global.md)。 +::: + +## 第一步：获取 API 密钥 + +1. 打开 [MiniMax 控制台](https://platform.minimaxi.com/)。 +2. 在 API 密钥页面创建新的 API Key。 +3. 复制密钥并妥善保存。 + +::: warning API Key 安全 +不要将 API Key 提交到仓库、放入截图，或发送给他人。密钥泄露后，请立即在 MiniMax 控制台撤销它并创建新密钥。 +::: + +## 第二步：在 AIRI 中配置 + +1. 打开 **设置 → 服务商 → 聊天 → MiniMax**。 +2. 将 API Key 粘贴到基础设置。 +3. 保留默认 Base URL：`https://api.minimaxi.com/v1/`。中国大陆和海外平台的 API Key、计费与 Base URL 不能混用。 + +### 3. 配置校验 + +1. **Ping API**: 点击此按钮测试网络是否连通以及 API Key 是否填写正确。 +2. **选择模型**: 测试成功后，点击此处选择你想要使用的具体模型。 + +## 排查 + +如果 Ping API 失败，请检查 API Key、账户额度和网络连接。模型列表无法加载时，可在“意识”页面手动输入 MiniMax 提供的精确模型 ID。 diff --git a/docs/content/zh-Hans/docs/manual/config/providers/consciousness/mistral.md b/docs/content/zh-Hans/docs/manual/config/providers/consciousness/mistral.md new file mode 100644 index 000000000..6f8f0494c --- /dev/null +++ b/docs/content/zh-Hans/docs/manual/config/providers/consciousness/mistral.md @@ -0,0 +1,36 @@ +--- +title: Mistral +description: 在 AIRI 中配置 Mistral 作为大模型服务商 +is_openai_compatible: true +--- + +Mistral 提供兼容 OpenAI 格式的聊天 API。完成本页配置后，AIRI 可以在“意识”中使用 Mistral 提供的模型。 + +::: info 为什么选择 Mistral？ +如果你已经使用 Mistral 模型，或希望在 AIRI 中尝试其多语言模型，可以选择此服务商。 +::: + +## 第一步：获取 API 密钥 + +1. 打开 [Mistral 控制台](https://console.mistral.ai/)。 +2. 在 API 密钥页面创建新的 API Key。 +3. 复制密钥并妥善保存。 + +::: warning API Key 安全 +不要将 API Key 提交到仓库、放入截图，或发送给他人。密钥泄露后，请立即在 Mistral 控制台撤销它并创建新密钥。 +::: + +## 第二步：在 AIRI 中配置 + +1. 打开 **设置 → 服务商 → 聊天 → Mistral**。 +2. 将 API Key 粘贴到基础设置。 +3. 保留默认 Base URL：`https://api.mistral.ai/v1`。 + +### 3. 配置校验 + +1. **Ping API**: 点击此按钮测试网络是否连通以及 API Key 是否填写正确。 +2. **选择模型**: 测试成功后，点击此处选择你想要使用的具体模型。 + +## 排查 + +如果 Ping API 失败，请检查 API Key、账户额度和网络连接。模型列表无法加载时，可在“意识”页面手动输入 Mistral 提供的精确模型 ID。 diff --git a/docs/content/zh-Hans/docs/manual/config/providers/consciousness/modelscope.md b/docs/content/zh-Hans/docs/manual/config/providers/consciousness/modelscope.md new file mode 100644 index 000000000..d5cdf23be --- /dev/null +++ b/docs/content/zh-Hans/docs/manual/config/providers/consciousness/modelscope.md @@ -0,0 +1,24 @@ +--- +title: ModelScope +description: 在 AIRI 中配置 ModelScope 聊天模型 +--- + +ModelScope 在 AIRI 中通过其推理 API 提供聊天模型。 + +::: info 为什么选择 ModelScope？ +如果你已在 ModelScope 中管理模型访问，使用此卡片可以直接填写对应 API Key。 +::: + +## 第一步：获取 API Key + +1. 打开并登录 [ModelScope](https://modelscope.cn/)，在账户控制台创建 API Key。 + +## 第二步：在 AIRI 中配置 + +1. 打开 **设置 → 服务商 → 聊天 → ModelScope**，填写 **API Key**。默认 Base URL 为 `https://api-inference.modelscope.cn/v1/`。 +2. **Ping API**：点击此按钮测试网络是否连通以及 API Key 是否填写正确。 +3. **选择模型**：测试成功后，选择模型，再到 **设置 → 意识** 启用。 + +::: warning API Key 安全 +不要将 API Key 提交到仓库、截图或发送给他人。 +::: diff --git a/docs/content/zh-Hans/docs/manual/config/providers/consciousness/moonshot.md b/docs/content/zh-Hans/docs/manual/config/providers/consciousness/moonshot.md new file mode 100644 index 000000000..70190fc57 --- /dev/null +++ b/docs/content/zh-Hans/docs/manual/config/providers/consciousness/moonshot.md @@ -0,0 +1,36 @@ +--- +title: Moonshot（月之暗面） +description: 在 AIRI 中配置 Moonshot 作为大模型服务商 +is_openai_compatible: true +--- + +Moonshot 提供兼容 OpenAI 格式的聊天 API。完成本页配置后，AIRI 可以在“意识”中使用 Moonshot 提供的模型。 + +::: info 为什么选择 Moonshot？ +如果你希望在 AIRI 中使用 Moonshot 模型，或已经拥有 Moonshot API Key，可以直接选择此服务商。 +::: + +## 第一步：获取 API 密钥 + +1. 打开 [Moonshot 控制台](https://platform.moonshot.cn/)。 +2. 在 API 密钥页面创建新的 API Key。 +3. 复制密钥并妥善保存。 + +::: warning API Key 安全 +不要将 API Key 提交到仓库、放入截图，或发送给他人。密钥泄露后，请立即在 Moonshot 控制台撤销它并创建新密钥。 +::: + +## 第二步：在 AIRI 中配置 + +1. 打开 **设置 → 服务商 → 聊天 → Moonshot**。 +2. 将 API Key 粘贴到基础设置。 +3. 保留默认 Base URL：`https://api.moonshot.cn/v1`。 + +### 3. 配置校验 + +1. **Ping API**: 点击此按钮测试网络是否连通以及 API Key 是否填写正确。 +2. **选择模型**: 测试成功后，点击此处选择你想要使用的具体模型。 + +## 排查 + +如果 Ping API 失败，请检查 API Key、账户额度和网络连接。模型列表无法加载时，可在“意识”页面手动输入 Moonshot 提供的精确模型 ID。 diff --git a/docs/content/zh-Hans/docs/manual/config/providers/consciousness/n1n.md b/docs/content/zh-Hans/docs/manual/config/providers/consciousness/n1n.md new file mode 100644 index 000000000..3b562a2eb --- /dev/null +++ b/docs/content/zh-Hans/docs/manual/config/providers/consciousness/n1n.md @@ -0,0 +1,25 @@ +--- +title: n1n +description: 在 AIRI 中配置 n1n 聊天模型 +--- + +n1n 在 AIRI 中提供兼容 API 的聊天模型接入。 + +::: info 为什么选择 n1n？ +如果你使用 n1n 的模型服务，可以在 AIRI 中填写其服务地址和账户凭据。 +::: + +## 第一步：准备服务访问方式 + +1. 打开并登录 [n1n](https://n1n.ai/)，确认你的服务地址及是否需要 API Key。 + +## 第二步：在 AIRI 中配置 + +1. 打开 **设置 → 服务商 → 聊天 → n1n**。默认 Base URL 为 `https://api.n1n.ai/v1/`。 +2. 按 n1n 当前服务要求填写 API Key；如果你的部署允许匿名访问，则按部署方说明保留为空。 +3. **Ping API**：点击此按钮测试网络、服务地址和凭据是否正确。 +4. **选择模型**：测试成功后，选择模型，再到 **设置 → 意识** 启用。 + +::: warning 凭据安全 +即使 API Key 为可选项，也不要公开你的私有服务地址、访问令牌或网关配置。 +::: diff --git a/docs/content/zh-Hans/docs/manual/config/providers/consciousness/novita.md b/docs/content/zh-Hans/docs/manual/config/providers/consciousness/novita.md new file mode 100644 index 000000000..780e9245f --- /dev/null +++ b/docs/content/zh-Hans/docs/manual/config/providers/consciousness/novita.md @@ -0,0 +1,36 @@ +--- +title: Novita AI +description: 在 AIRI 中配置 Novita AI 作为大模型服务商 +is_openai_compatible: true +--- + +Novita AI 提供兼容 OpenAI 格式的聊天 API。完成本页配置后，AIRI 可以在“意识”中使用 Novita AI 提供的模型。 + +::: info 为什么选择 Novita AI？ +如果你已在 Novita AI 中管理模型服务，可以直接复用该服务商的 API Key。 +::: + +## 第一步：获取 API 密钥 + +1. 打开 [Novita AI 控制台](https://novita.ai/dashboard)。 +2. 在 API 密钥页面创建新的 API Key。 +3. 复制密钥并妥善保存。 + +::: warning API Key 安全 +不要将 API Key 提交到仓库、放入截图，或发送给他人。密钥泄露后，请立即在 Novita AI 控制台撤销它并创建新密钥。 +::: + +## 第二步：在 AIRI 中配置 + +1. 打开 **设置 → 服务商 → 聊天 → Novita AI**。 +2. 将 API Key 粘贴到基础设置。 +3. 保留默认 Base URL：`https://api.novita.ai/v1`。 + +### 3. 配置校验 + +1. **Ping API**: 点击此按钮测试网络是否连通以及 API Key 是否填写正确。 +2. **选择模型**: 测试成功后，点击此处选择你想要使用的具体模型。 + +## 排查 + +如果 Ping API 失败，请检查 API Key、账户额度和网络连接。模型列表无法加载时，可在“意识”页面手动输入 Novita AI 提供的精确模型 ID。 diff --git a/docs/content/zh-Hans/docs/manual/config/providers/consciousness/nvidia.md b/docs/content/zh-Hans/docs/manual/config/providers/consciousness/nvidia.md new file mode 100644 index 000000000..f694001cd --- /dev/null +++ b/docs/content/zh-Hans/docs/manual/config/providers/consciousness/nvidia.md @@ -0,0 +1,36 @@ +--- +title: NVIDIA NIM +description: 在 AIRI 中配置 NVIDIA NIM 作为大模型服务商 +is_openai_compatible: true +--- + +NVIDIA NIM 提供兼容 OpenAI 格式的聊天 API。完成本页配置后，AIRI 可以在“意识”中使用 NVIDIA NIM 提供的模型。 + +::: info 为什么选择 NVIDIA NIM？ +如果你已经在 NVIDIA NIM 平台使用模型服务，可以将同一套凭据接入 AIRI。 +::: + +## 第一步：获取 API 密钥 + +1. 打开 [NVIDIA NIM 控制台](https://build.nvidia.com/)。 +2. 在 API 密钥页面创建新的 API Key。 +3. 复制密钥并妥善保存。 + +::: warning API Key 安全 +不要将 API Key 提交到仓库、放入截图，或发送给他人。密钥泄露后，请立即在 NVIDIA 控制台撤销它并创建新密钥。 +::: + +## 第二步：在 AIRI 中配置 + +1. 打开 **设置 → 服务商 → 聊天 → NVIDIA NIM**。 +2. 将 API Key 粘贴到基础设置。 +3. 保留默认 Base URL：`https://integrate.api.nvidia.com/v1`。 + +### 3. 配置校验 + +1. **Ping API**: 点击此按钮测试网络是否连通以及 API Key 是否填写正确。 +2. **选择模型**: 测试成功后，点击此处选择你想要使用的具体模型。 + +## 排查 + +如果 Ping API 失败，请检查 API Key、账户额度和网络连接。模型列表无法加载时，可在“意识”页面手动输入 NVIDIA NIM 提供的精确模型 ID。 diff --git a/docs/content/zh-Hans/docs/manual/config/providers/consciousness/official.md b/docs/content/zh-Hans/docs/manual/config/providers/consciousness/official.md new file mode 100644 index 000000000..928ec7238 --- /dev/null +++ b/docs/content/zh-Hans/docs/manual/config/providers/consciousness/official.md @@ -0,0 +1,37 @@ +--- +title: AIRI 官方提供商 +description: 使用 AIRI 官方作为聊天提供商 +--- + +如果你想快速上手 AIRI，希望简化配置，则可以使用官方提供商以开启聊天。 + +::: info 为什么选择 AIRI 官方提供商？ +如果你希望先快速体验 AIRI，而不想自行配置第三方 API Key，可以选择官方提供商。 +::: + +## 第一步：登录账户 + +1. 点击登录按钮，此时会打开一个浏览器页面。 +2. 选择登录方式。目前我们支持邮箱、Google 和 GitHub 登录。 + + ::: info 中国用户特别提醒 + 中国用户可能无法使用 Google 和 GitHub 登录。请使用邮箱登录。暂不支持手机号注册登录。 + ::: + +3. 按提示完成登录/注册。 + + ::: info + 如果没有收到邮件，请检查是否归入垃圾邮件。 + ::: + +## 第二步：检查可用电量 + +每个新账户都有 150 电量。每次对话会消耗部分电量；电量耗尽后，暂时无法继续对话。 + +## 第三步：充值电量 + +目前仅支持在 AIRI 网页版充值。登录网页版后，打开 **设置 → Flux**，选择电量包并按页面提示完成付款。桌面版暂不支持直接充值。 + +## 排查 + +如果没有收到登录邮件，请检查垃圾邮件文件夹。网页端无法显示可用电量包或无法创建付款时，请稍后重试；桌面端需要充值时，请前往 AIRI 网页版完成操作。 diff --git a/docs/content/zh-Hans/docs/manual/config/providers/consciousness/ollama.md b/docs/content/zh-Hans/docs/manual/config/providers/consciousness/ollama.md new file mode 100644 index 000000000..113fe3c43 --- /dev/null +++ b/docs/content/zh-Hans/docs/manual/config/providers/consciousness/ollama.md @@ -0,0 +1,48 @@ +--- +title: Ollama（本地模型） +description: 使用本地 Ollama 服务为 AIRI 配置聊天模型 +--- + +Ollama 是开源的本地大模型运行框架。它可以在自己的设备上运行模型并提供本地 API，默认不需要 API Key。 + +::: info 为什么选择 Ollama？ +如果你希望在本机运行模型、减少对云端 API 的依赖，或更重视对话数据的本地处理，Ollama 是合适的选择。 +::: + +## 第一步：安装 Ollama + +1. 访问 [Ollama 官网](https://ollama.com/)下载并安装适合自己系统的版本。 +2. 在终端（Terminal 或 PowerShell）运行以下命令，确认安装成功： + + ```bash + ollama --version + ``` + +## 第二步：下载并运行模型 + +1. 在终端执行以下命令下载并启动一个模型： + + ```bash + ollama run qwen2 + ``` + +2. 如需使用其他模型，将 `qwen2` 替换为相应的模型 ID。首次下载模型所需时间取决于模型大小和网络环境。 + +## 第三步：在 AIRI 中配置 + +1. 打开 **设置 → 服务商 → 聊天 → Ollama**。 +2. 保留默认 Base URL：`http://localhost:11434/v1/`；如果 Ollama 运行在其他设备上，填写该设备可访问的地址。 +3. 在“意识”中选择 Ollama 与刚才下载的模型。 + +### 4. 配置校验 + +1. **Ping API**: 点击此按钮测试 AIRI 能否连接本地服务。 +2. **选择模型**: 测试成功后，点击此处选择已下载的模型。 + +## 排查 + +无法连接时，先确认 Ollama 正在运行，且端口与 Base URL 一致。若 AIRI 与 Ollama 不在同一设备，使用可从 AIRI 设备访问的局域网地址，并仅在可信网络中开放该服务。 + +::: warning AIRI 无法连接本地 Ollama +如果 Ollama 正在运行但 AIRI 显示网络或 CORS 错误，请按 Ollama 的启动方式设置 `OLLAMA_ORIGINS`，允许 AIRI 的来源访问服务后再重启 Ollama。不要为了排查问题而将本地服务直接暴露到公网。 +::: diff --git a/docs/content/zh-Hans/docs/manual/config/providers/consciousness/openai.md b/docs/content/zh-Hans/docs/manual/config/providers/consciousness/openai.md new file mode 100644 index 000000000..2c741db56 --- /dev/null +++ b/docs/content/zh-Hans/docs/manual/config/providers/consciousness/openai.md @@ -0,0 +1,36 @@ +--- +title: OpenAI 与兼容 API +description: 在 AIRI 中配置 OpenAI 或 OpenAI 兼容的聊天服务 +is_openai_compatible: true +--- + +使用 OpenAI 官方地址时选择 **OpenAI**；使用第三方兼容地址时选择 **OpenAI 兼容 API**。完成配置后，AIRI 可以在“意识”中使用对应服务商的聊天模型。 + +::: info 为什么选择 OpenAI 或兼容 API？ +如果你已拥有 OpenAI API Key，或服务商明确提供 OpenAI 兼容的聊天接口，可以使用此配置方式。仅 API 地址以 `/v1` 结尾或密钥以 `sk-` 开头，不能保证服务兼容。 +::: + +## 第一步：获取 API 密钥 + +1. 登录所选服务商的管理控制台。 +2. 在 API 密钥或开发者设置页面创建 API Key。 +3. 复制密钥并妥善保存。 + +::: warning API Key 安全 +不要将 API Key 提交到仓库、放入截图，或发送给他人。密钥泄露后，请立即在服务商控制台撤销它并创建新密钥。 +::: + +## 第二步：在 AIRI 中配置 + +1. 打开 **设置 → 服务商 → 聊天 → OpenAI** 或 **OpenAI 兼容 API**。 +2. 将 API Key 粘贴到基础设置。 +3. 使用 OpenAI 官方服务时，保留默认 Base URL：`https://api.openai.com/v1`；使用兼容服务时，填写服务商文档提供的 API 根地址，不要附加 `/chat/completions` 路径。 + +### 3. 配置校验 + +1. **Ping API**: 点击此按钮测试网络是否连通以及 API Key 是否填写正确。 +2. **选择模型**: 测试成功后，点击此处选择你想要使用的具体模型。 + +## 排查 + +如果 Ping API 失败，请检查 API Key、账户额度和网络连接。使用兼容服务时，请确认其明确支持 OpenAI Chat Completions API，并检查 Base URL 是否为服务商文档指定的根地址。 diff --git a/docs/content/zh-Hans/docs/manual/config/providers/consciousness/openrouter.md b/docs/content/zh-Hans/docs/manual/config/providers/consciousness/openrouter.md new file mode 100644 index 000000000..b06f55865 --- /dev/null +++ b/docs/content/zh-Hans/docs/manual/config/providers/consciousness/openrouter.md @@ -0,0 +1,37 @@ +--- +title: OpenRouter +description: 在 AIRI 中配置 OpenRouter 作为大模型服务商 +is_openai_compatible: true +--- + +OpenRouter 是一个聚合式 API 服务商。完成本页配置后，AIRI 可以在“意识”中使用 OpenRouter 提供的聊天模型。 + +::: info 为什么选择 OpenRouter？ +如果你希望用一个 API Key 在 AIRI 中尝试多个模型，OpenRouter 是一个方便的选择。它将多个模型服务集中到同一套接口和账单中，因此切换模型时通常不必分别配置多个服务商。在中国大陆使用 AIRI 时，可以优先尝试 302.AI；实际可用性仍取决于你的网络环境、支付方式和服务商政策。 +::: + +## 第一步：获取 API 密钥 + +1. 打开 [OpenRouter API Keys](https://openrouter.ai/keys)，创建新的 API Key。 +2. 为密钥设置适当的名称、有效期和额度限制。 +3. 复制密钥并妥善保存。 + +::: warning API Key 安全 +不要将 API Key 提交到仓库、放入截图，或发送给他人。密钥泄露后，请立即在 OpenRouter 控制台撤销它并创建新密钥。 +::: + + +## 第二步：在 AIRI 中配置 + +1. 打开 **设置 → 服务商 → 聊天 → OpenRouter**。 +2. 将 API Key 粘贴到基础设置。 +3. 保留默认 Base URL：`https://openrouter.ai/api/v1`。 + +### 3. 配置校验 + +1. **Ping API**: 点击此按钮测试网络是否连通以及 API 密钥是否填写正确。 +2. **选择模型**: 测试成功后，点击此处选择你想要使用的具体模型（如 **google/gemini-pro-1.5**）。 + +## 排查 + +如果 Ping API 失败，请检查 API Key、账户额度和网络连接。模型列表无法加载时，可在“意识”页面手动输入 OpenRouter 提供的精确模型 ID。 diff --git a/docs/content/zh-Hans/docs/manual/config/providers/consciousness/perplexity.md b/docs/content/zh-Hans/docs/manual/config/providers/consciousness/perplexity.md new file mode 100644 index 000000000..8fa2afd86 --- /dev/null +++ b/docs/content/zh-Hans/docs/manual/config/providers/consciousness/perplexity.md @@ -0,0 +1,36 @@ +--- +title: Perplexity +description: 在 AIRI 中配置 Perplexity 作为大模型服务商 +is_openai_compatible: true +--- + +Perplexity 提供兼容 OpenAI 格式的聊天 API。完成本页配置后，AIRI 可以在“意识”中使用 Perplexity 提供的模型。 + +::: info 为什么选择 Perplexity？ +如果你已有 Perplexity API 账户，并希望在 AIRI 中使用其可用模型，可以选择此服务商。 +::: + +## 第一步：获取 API 密钥 + +1. 打开 [Perplexity API 设置](https://www.perplexity.ai/settings/api)。 +2. 在 API 密钥页面创建新的 API Key。 +3. 复制密钥并妥善保存。 + +::: warning API Key 安全 +不要将 API Key 提交到仓库、放入截图，或发送给他人。密钥泄露后，请立即在 Perplexity 控制台撤销它并创建新密钥。 +::: + +## 第二步：在 AIRI 中配置 + +1. 打开 **设置 → 服务商 → 聊天 → Perplexity**。 +2. 将 API Key 粘贴到基础设置。 +3. 保留默认 Base URL：`https://api.perplexity.ai`。 + +### 3. 配置校验 + +1. **Ping API**: 点击此按钮测试网络是否连通以及 API Key 是否填写正确。 +2. **选择模型**: 测试成功后，点击此处选择你想要使用的具体模型。 + +## 排查 + +如果 Ping API 失败，请检查 API Key、账户额度和网络连接。模型列表无法加载时，可在“意识”页面手动输入 Perplexity 提供的精确模型 ID。 diff --git a/docs/content/zh-Hans/docs/manual/config/providers/consciousness/together.md b/docs/content/zh-Hans/docs/manual/config/providers/consciousness/together.md new file mode 100644 index 000000000..397d6d92f --- /dev/null +++ b/docs/content/zh-Hans/docs/manual/config/providers/consciousness/together.md @@ -0,0 +1,36 @@ +--- +title: Together AI +description: 在 AIRI 中配置 Together AI 作为大模型服务商 +is_openai_compatible: true +--- + +Together AI 提供兼容 OpenAI 格式的聊天 API。完成本页配置后，AIRI 可以在“意识”中使用 Together AI 提供的模型。 + +::: info 为什么选择 Together AI？ +如果你已在 Together AI 中部署或使用模型，可以直接复用对应的 API Key。 +::: + +## 第一步：获取 API 密钥 + +1. 打开 [Together AI API Keys](https://api.together.ai/settings/api-keys)。 +2. 创建新的 API Key。 +3. 复制密钥并妥善保存。 + +::: warning API Key 安全 +不要将 API Key 提交到仓库、放入截图，或发送给他人。密钥泄露后，请立即在 Together AI 控制台撤销它并创建新密钥。 +::: + +## 第二步：在 AIRI 中配置 + +1. 打开 **设置 → 服务商 → 聊天 → Together AI**。 +2. 将 API Key 粘贴到基础设置。 +3. 保留默认 Base URL：`https://api.together.xyz/v1`。 + +### 3. 配置校验 + +1. **Ping API**: 点击此按钮测试网络是否连通以及 API Key 是否填写正确。 +2. **选择模型**: 测试成功后，点击此处选择你想要使用的具体模型。 + +## 排查 + +如果 Ping API 失败，请检查 API Key、账户额度和网络连接。模型列表无法加载时，可在“意识”页面手动输入 Together AI 提供的精确模型 ID。 diff --git a/docs/content/zh-Hans/docs/manual/config/providers/consciousness/volcengine-coding-plan.md b/docs/content/zh-Hans/docs/manual/config/providers/consciousness/volcengine-coding-plan.md new file mode 100644 index 000000000..ec4f980f2 --- /dev/null +++ b/docs/content/zh-Hans/docs/manual/config/providers/consciousness/volcengine-coding-plan.md @@ -0,0 +1,24 @@ +--- +title: 火山引擎 Coding Plan +description: 在 AIRI 中配置火山引擎 Coding Plan 聊天模型 +--- + +火山引擎 Coding Plan 在 AIRI 中以独立服务商卡片提供。 + +::: info 为什么选择火山引擎 Coding Plan？ +如果你的账户使用火山引擎 Coding Plan，应选择该卡片以匹配对应服务计划。 +::: + +## 第一步：准备 Coding Plan 凭据 + +1. 打开并登录[火山引擎控制台](https://console.volcengine.com/)，在 Coding Plan 对应页面取得 API Key、端点和模型信息。 + +## 第二步：在 AIRI 中配置 + +1. 打开 **设置 → 服务商 → 聊天 → Volcengine Coding Plan**，按火山引擎控制台填写该计划的 API Key、端点和模型信息。 +2. **Ping API**：点击此按钮测试网络与凭据是否正确。 +3. **选择模型**：测试成功后，在 **设置 → 意识** 选择可用模型。 + +::: warning API Key 安全 +不要将 API Key 或端点凭据提交到仓库、截图或发送给他人。 +::: diff --git a/docs/content/zh-Hans/docs/manual/config/providers/consciousness/xai.md b/docs/content/zh-Hans/docs/manual/config/providers/consciousness/xai.md new file mode 100644 index 000000000..76b87eaeb --- /dev/null +++ b/docs/content/zh-Hans/docs/manual/config/providers/consciousness/xai.md @@ -0,0 +1,35 @@ +--- +title: xAI +description: 在 AIRI 中配置 xAI Grok 聊天模型 +--- + +xAI 服务商让 AIRI 使用 Grok 聊天模型。其配置方式与常见 API Key 服务商相同。 + +::: info 为什么选择 xAI？ +如果你已有 xAI API 账户，并希望在 AIRI 中使用 Grok 模型，可以选择该服务商。 +::: + +## 第一步：创建 API Key + +1. 在 xAI 开发者控制台创建 API Key。 +2. 确认账户已开通 API 用量并有可用额度。 +3. 复制密钥。 + +::: warning API Key 安全 +只在密码管理器或 AIRI 的本地设置中保存 API Key。不要把密钥写入代码、提交到仓库或发送给他人。 +::: + +## 第二步：在 AIRI 中配置 + +1. 打开 **设置 → 服务商 → 聊天 → xAI**。 +2. 填写 API Key。 +3. 保留默认 Base URL：`https://api.x.ai/v1/`。 + +### 3. 配置校验 + +1. **Ping API**: 点击此按钮测试网络是否连通以及 API Key 是否填写正确。 +2. **选择模型**: 测试成功后，点击此处选择你想要使用的具体模型。 + +## 排查 + +如果 Ping API 失败，请先检查 API Key、账户额度和网络连接。模型列表不可用时，可以在“意识”页面手动填写 xAI 文档中给出的模型 ID。 diff --git a/docs/content/zh-Hans/docs/manual/config/providers/consciousness/zhipu.md b/docs/content/zh-Hans/docs/manual/config/providers/consciousness/zhipu.md new file mode 100644 index 000000000..384be2458 --- /dev/null +++ b/docs/content/zh-Hans/docs/manual/config/providers/consciousness/zhipu.md @@ -0,0 +1,36 @@ +--- +title: 智谱 AI +description: 在 AIRI 中配置智谱 AI 作为大模型服务商 +is_openai_compatible: true +--- + +智谱 AI 提供兼容 OpenAI 格式的聊天 API。完成本页配置后，AIRI 可以在“意识”中使用智谱 AI 提供的模型。 + +::: info 为什么选择智谱 AI？ +如果你希望在 AIRI 中使用智谱 AI 模型，或已经拥有其 API Key，可以直接选择此服务商。 +::: + +## 第一步：获取 API 密钥 + +1. 打开 [智谱 AI API Keys](https://open.bigmodel.cn/usercenter/apikeys)。 +2. 创建新的 API Key。 +3. 复制密钥并妥善保存。 + +::: warning API Key 安全 +不要将 API Key 提交到仓库、放入截图，或发送给他人。密钥泄露后，请立即在智谱 AI 控制台撤销它并创建新密钥。 +::: + +## 第二步：在 AIRI 中配置 + +1. 打开 **设置 → 服务商 → 聊天 → 智谱 AI**。 +2. 将 API Key 粘贴到基础设置。 +3. 保留默认 Base URL：`https://open.bigmodel.cn/api/paas/v4/`。 + +### 3. 配置校验 + +1. **Ping API**: 点击此按钮测试网络是否连通以及 API Key 是否填写正确。 +2. **选择模型**: 测试成功后，点击此处选择你想要使用的具体模型。 + +## 排查 + +如果 Ping API 失败，请检查 API Key、账户额度和网络连接。模型列表无法加载时，可在“意识”页面手动输入智谱 AI 提供的精确模型 ID。 diff --git a/docs/content/zh-Hans/docs/manual/config/providers/speech/alibaba-cloud-model-studio.md b/docs/content/zh-Hans/docs/manual/config/providers/speech/alibaba-cloud-model-studio.md new file mode 100644 index 000000000..28c81c5a6 --- /dev/null +++ b/docs/content/zh-Hans/docs/manual/config/providers/speech/alibaba-cloud-model-studio.md @@ -0,0 +1,35 @@ +--- +title: 阿里云百炼（TTS） +description: 在 AIRI 中配置阿里云百炼语音合成 +--- + +阿里云百炼可在 AIRI 中提供 CosyVoice 语音合成模型。 + +::: info 为什么选择阿里云百炼？ +如果你已使用阿里云百炼，并希望在 CosyVoice 音色与模型中选择，这是直接的接入方式。 +::: + +## 第一步：获取 API Key + +1. 打开并登录[阿里云百炼控制台](https://bailian.console.aliyun.com/)，确认已开通模型服务。 +2. 在 API Key 管理页面创建密钥。 +3. 复制密钥并妥善保存。 + +::: warning API Key 安全 +不要将百炼 API Key 提交到仓库、截图或发送给他人。 +::: + +## 第二步：在 AIRI 中配置 + +1. 打开 **设置 → 服务商 → 语音合成 → Alibaba Cloud Model Studio**。 +2. 将百炼 API Key 粘贴到基础设置；Base URL 使用界面默认值，除非你配置了兼容网关。 + +### 3. 配置校验 + +1. **Ping API**：点击此按钮测试网络是否连通以及 API Key 是否填写正确。 +2. **选择模型和音色**：测试成功后，选择 CosyVoice 模型与音色，再到 **设置 → 发声** 启用。 +3. 输入短文本试听，确认可正常播放。 + +## 排查 + +Ping API 失败时，检查 API Key、账户额度和网络连接。模型或音色不可选时，确认百炼账户已开通相应模型。 diff --git a/docs/content/zh-Hans/docs/manual/config/providers/speech/azure-speech.md b/docs/content/zh-Hans/docs/manual/config/providers/speech/azure-speech.md new file mode 100644 index 000000000..e59b30f19 --- /dev/null +++ b/docs/content/zh-Hans/docs/manual/config/providers/speech/azure-speech.md @@ -0,0 +1,35 @@ +--- +title: Microsoft Azure Speech（TTS） +description: 在 AIRI 中配置 Microsoft Azure Speech 语音合成 +--- + +Microsoft Azure Speech 可在 AIRI 中提供 Azure 语音合成能力。 + +::: info 为什么选择 Microsoft Azure Speech？ +如果你的团队已经在 Azure 中管理语音资源和区域配置，使用同一份凭据会更方便。 +::: + +## 第一步：准备 Azure Speech 资源 + +1. 打开并登录 [Azure Portal](https://portal.azure.com/)，创建或打开 Speech 资源。 +2. 记录资源的 **API Key** 与所属区域；两者必须来自同一 Speech 资源。 +3. 复制密钥并妥善保存。 + +::: warning API Key 安全 +Azure 密钥可访问你的语音资源。不要提交、截图或分享它。 +::: + +## 第二步：在 AIRI 中配置 + +1. 打开 **设置 → 服务商 → 语音合成 → Microsoft / Azure Speech**。 +2. 填写 API Key 和区域信息。Base URL 保持界面默认值，除非你使用兼容网关。 + +### 3. 配置校验 + +1. **Ping API**：点击此按钮测试网络、API Key 和区域是否填写正确。 +2. **选择模型和音色**：测试成功后，选择音色，并在 **设置 → 发声** 中启用。 +3. 输入短文本试听，确认可正常播放。 + +## 排查 + +验证失败时，优先检查区域是否与 Speech 资源一致。没有声音时，确认已在“发声”中选择音色，并检查该资源是否有可用额度。 diff --git a/docs/content/zh-Hans/docs/manual/config/providers/speech/browser-local.md b/docs/content/zh-Hans/docs/manual/config/providers/speech/browser-local.md new file mode 100644 index 000000000..210088da3 --- /dev/null +++ b/docs/content/zh-Hans/docs/manual/config/providers/speech/browser-local.md @@ -0,0 +1,33 @@ +--- +title: 浏览器本地语音合成（TTS） +description: 在 AIRI 网页版中使用浏览器本地语音合成 +--- + +浏览器本地语音合成使用 AIRI 的本地模型能力，不需要云端 API Key。 + +::: info 为什么选择浏览器本地语音合成？ +如果你使用网页版并希望尽量不把文本发送给第三方语音服务商，可以尝试此选项。 +::: + +## 第一步：确认浏览器环境 + +1. 使用 AIRI 网页版；该服务商不会在桌面端出现。 +2. 确认浏览器支持 WebGPU，或设备内存至少为 8 GB，才会显示此服务商卡片。 + +::: warning 设备兼容性 +该能力依赖浏览器和硬件条件。若服务商卡片未出现或模型无法运行，请改用云端 TTS 或桌面端本地方案。 +::: + +## 第二步：在 AIRI 中配置 + +1. 在网页版打开 **设置 → 服务商 → 语音合成 → Browser (Local)**。 +2. 等待模型准备完成，并选择模型和音色。 + +### 3. 配置校验 + +1. 在 **设置 → 发声** 选择该服务商、模型和音色。 +2. 输入短文本并试听；能正常播放即表示配置成功。 + +## 排查 + +卡片未出现时，检查当前是否为网页版及设备是否满足 WebGPU 或内存要求。模型无法运行时，改用云端 TTS 或桌面端本地方案。 diff --git a/docs/content/zh-Hans/docs/manual/config/providers/speech/comet-api.md b/docs/content/zh-Hans/docs/manual/config/providers/speech/comet-api.md new file mode 100644 index 000000000..eadc482f8 --- /dev/null +++ b/docs/content/zh-Hans/docs/manual/config/providers/speech/comet-api.md @@ -0,0 +1,34 @@ +--- +title: CometAPI（TTS） +description: 在 AIRI 中配置 CometAPI 语音合成 +--- + +CometAPI 通过其兼容接口提供语音合成。 + +::: info 为什么选择 CometAPI？ +如果你已使用 CometAPI 管理模型和凭据，可直接在 AIRI 中复用该 API Key。 +::: + +## 第一步：获取 API Key + +1. 打开并登录 [CometAPI 控制台](https://www.cometapi.com/console/token)，创建 API Key。 +2. 复制密钥并妥善保存。 + +::: warning API Key 安全 +不要将 API Key 提交到仓库、截图或发送给他人。 +::: + +## 第二步：在 AIRI 中配置 + +1. 打开 **设置 → 服务商 → 语音合成 → CometAPI Speech**，填写 API Key。 +2. 保留默认 Base URL：`https://api.cometapi.com/v1/`；只有使用代理或兼容网关时才修改。 + +### 3. 配置校验 + +1. **Ping API**：点击此按钮测试网络是否连通以及 API Key 是否填写正确。 +2. **选择模型和音色**：测试成功后，选择可用模型与音色，再到 **设置 → 发声** 启用。 +3. 输入短文本试听，确认可正常播放。 + +## 排查 + +验证失败时，检查 API Key、账户余额和网络连接。模型列表为空时，确认该账户当前可访问语音模型。 diff --git a/docs/content/zh-Hans/docs/manual/config/providers/speech/deepgram.md b/docs/content/zh-Hans/docs/manual/config/providers/speech/deepgram.md new file mode 100644 index 000000000..463425109 --- /dev/null +++ b/docs/content/zh-Hans/docs/manual/config/providers/speech/deepgram.md @@ -0,0 +1,35 @@ +--- +title: Deepgram（TTS） +description: 在 AIRI 中配置 Deepgram 语音合成 +--- + +Deepgram 在 AIRI 中提供 Aura 系列语音合成模型。 + +::: info 为什么选择 Deepgram？ +如果你已经使用 Deepgram，或希望在 Aura 系列语音中挑选音色，可以使用此集成。 +::: + +## 第一步：获取 API Key + +1. 打开并登录 [Deepgram Console](https://console.deepgram.com/)，在项目的 API Key 页面创建密钥。 +2. 确认该项目具备语音合成使用权限。 +3. 复制密钥并妥善保存。 + +::: warning API Key 安全 +不要将 API Key 提交到仓库、截图或发送给他人。 +::: + +## 第二步：在 AIRI 中配置 + +1. 打开 **设置 → 服务商 → 语音合成 → Deepgram**，将 API Key 粘贴到基础设置。 +2. 保留界面默认 Base URL；仅在自行部署兼容网关时修改。 + +### 3. 配置校验 + +1. **Ping API**：点击此按钮测试网络是否连通以及 API Key 是否填写正确。 +2. **选择模型和音色**：测试成功后，选择 Aura 模型与声音，再到 **设置 → 发声** 启用。 +3. 输入短文本试听，确认可正常播放。 + +## 排查 + +Ping API 失败时，检查项目 API Key、账户权限和网络连接。音色列表为空时，重新测试凭据后再选择模型。 diff --git a/docs/content/zh-Hans/docs/manual/config/providers/speech/desktop-local.md b/docs/content/zh-Hans/docs/manual/config/providers/speech/desktop-local.md new file mode 100644 index 000000000..ec5d948e6 --- /dev/null +++ b/docs/content/zh-Hans/docs/manual/config/providers/speech/desktop-local.md @@ -0,0 +1,33 @@ +--- +title: 桌面端本地语音合成（TTS） +description: 在 AIRI 桌面版中使用本地语音合成 +--- + +桌面端本地语音合成仅在 AIRI 桌面版中提供，不需要云端 API Key。 + +::: info 为什么选择桌面端本地语音合成？ +如果你使用 AIRI 桌面版，并希望减少对云端 TTS 的依赖，可以选择此项。 +::: + +## 第一步：确认桌面端环境 + +1. 使用 AIRI 桌面版；该服务商不会在网页版出现。 +2. 确保设备有足够的磁盘空间和计算资源供本地模型使用。 + +::: warning 运行环境 +此服务商不会出现在网页版。模型运行会使用本机磁盘和计算资源。 +::: + +## 第二步：在 AIRI 中配置 + +1. 在 AIRI 桌面版打开 **设置 → 服务商 → 语音合成 → App (Local)**。 +2. 选择可用模型和音色；完成准备后，到 **设置 → 发声** 启用。 + +### 3. 配置校验 + +1. 输入一段短文本并试听。 +2. 能正常播放语音即表示配置成功。 + +## 排查 + +服务商未出现时，确认你运行的是桌面版。模型准备失败时，检查磁盘空间和设备资源后重试。 diff --git a/docs/content/zh-Hans/docs/manual/config/providers/speech/elevenlabs.md b/docs/content/zh-Hans/docs/manual/config/providers/speech/elevenlabs.md new file mode 100644 index 000000000..32bac8c96 --- /dev/null +++ b/docs/content/zh-Hans/docs/manual/config/providers/speech/elevenlabs.md @@ -0,0 +1,36 @@ +--- +title: ElevenLabs（TTS） +description: 在 AIRI 中配置 ElevenLabs 语音合成 +--- + +ElevenLabs 可将 AIRI 的回复合成为语音。 + +::: info 为什么选择 ElevenLabs？ +如果你想使用 ElevenLabs 账户中的音色，并在 AIRI 中直接选择可用声音，可以选择此服务商。 +::: + +## 第一步：获取 API Key + +1. 打开并登录 [ElevenLabs API Key 设置](https://elevenlabs.io/app/settings/api-keys)，创建密钥。 +2. 为密钥设置便于识别的名称和适当的使用限制。 +3. 复制密钥并妥善保存。 + +::: warning API Key 安全 +不要将 API Key 提交到仓库、截图或发送给他人。若怀疑泄露，请立即在 ElevenLabs 控制台撤销并重新创建。 +::: + +## 第二步：在 AIRI 中配置 + +1. 打开 **设置 → 服务商 → 语音合成 → ElevenLabs**。 +2. 将 API Key 粘贴到基础设置。 +3. 保留界面默认 Base URL；只有使用自己的兼容网关时才更改。 + +### 3. 配置校验 + +1. **Ping API**：点击此按钮测试网络是否连通以及 API Key 是否填写正确。 +2. **选择模型和音色**：测试成功后，在 **设置 → 发声** 选择模型与想使用的声音。 +3. 输入一段短文本并试听；能正常播放语音即表示配置成功。 + +## 排查 + +Ping API 失败时，检查 API Key、账户额度和网络连接。能列出模型但没有声音时，确认“发声”中已选择有效的模型与音色。 diff --git a/docs/content/zh-Hans/docs/manual/config/providers/speech/google-gemini.md b/docs/content/zh-Hans/docs/manual/config/providers/speech/google-gemini.md new file mode 100644 index 000000000..35a347675 --- /dev/null +++ b/docs/content/zh-Hans/docs/manual/config/providers/speech/google-gemini.md @@ -0,0 +1,35 @@ +--- +title: Google Gemini（TTS） +description: 在 AIRI 中配置 Google Gemini 音频语音合成 +--- + +Google Gemini 音频语音合成会使用 Gemini 凭据和支持音频输出的模型。 + +::: info 为什么选择 Google Gemini？ +如果你已经在 AIRI 中配置 Google Gemini，并希望在同一服务商下使用音频输出能力，可以选择此项。 +::: + +## 第一步：获取 API Key + +1. 打开并登录 [Google AI Studio](https://aistudio.google.com/app/apikey)，创建 API Key。 +2. 确认账户可使用支持音频输出的 Gemini 模型。 +3. 复制密钥并妥善保存。 + +::: warning API Key 安全 +不要将 Gemini API Key 提交到仓库、截图或发送给他人。 +::: + +## 第二步：在 AIRI 中配置 + +1. 在 **设置 → 服务商 → 语音合成 → Google Gemini** 中填写 Gemini API Key。 +2. 保留界面默认 Base URL，除非你使用企业网关或兼容代理。 + +### 3. 配置校验 + +1. **Ping API**：点击此按钮测试网络是否连通以及 API Key 是否填写正确。 +2. **选择模型和音色**：测试成功后，选择界面列出的支持语音输出的模型，再到 **设置 → 发声** 启用。 +3. 输入短文本试听，确认可正常播放。 + +## 排查 + +验证失败时，检查 API Key、账户地区可用性和网络连接。请求成功但无声音时，确认所选模型确实支持音频输出。 diff --git a/docs/content/zh-Hans/docs/manual/config/providers/speech/index-tts.md b/docs/content/zh-Hans/docs/manual/config/providers/speech/index-tts.md new file mode 100644 index 000000000..7b05db476 --- /dev/null +++ b/docs/content/zh-Hans/docs/manual/config/providers/speech/index-tts.md @@ -0,0 +1,35 @@ +--- +title: Index-TTS（本地 TTS） +description: 在 AIRI 中连接本地 Index-TTS 服务 +--- + +Index-TTS 是通过本地 HTTP 服务接入 AIRI 的语音合成选项。 + +::: info 为什么选择 Index-TTS？ +如果你已在本机运行 Index-TTS，并希望声音数据保留在本地网络中，可以选择它。 +::: + +## 第一步：启动本地服务 + +1. 按 Index-TTS 的部署说明启动服务。 +2. AIRI 默认连接 `http://localhost:11996/tts/`；如果你使用其他主机或端口，请记录完整地址。 +3. 确认服务可返回模型和音色信息。 + +::: warning 本地服务安全 +不要将本地服务端口暴露到不受信任的公共网络。若修改了监听地址，请确认访问控制由你负责。 +::: + +## 第二步：在 AIRI 中配置 + +1. 打开 **设置 → 服务商 → 语音合成 → Index-TTS by Bilibili**。 +2. 填写与本地服务一致的 Base URL。 + +### 3. 配置校验 + +1. **Ping API**：点击此按钮测试 AIRI 是否能连接该本地服务。 +2. **选择模型和音色**：测试成功后，选择 `IndexTTS-1.5` 和服务返回的音色；再到 **设置 → 发声** 启用。 +3. 输入短文本试听，确认可正常播放。 + +## 排查 + +无法连接时，确认服务正在运行、Base URL 包含正确端口，并检查本地防火墙或反向代理。音色列表为空时，检查服务的 `audio/voices` 接口是否可用。 diff --git a/docs/content/zh-Hans/docs/manual/config/providers/speech/kokoro.md b/docs/content/zh-Hans/docs/manual/config/providers/speech/kokoro.md new file mode 100644 index 000000000..f2b4bd4c0 --- /dev/null +++ b/docs/content/zh-Hans/docs/manual/config/providers/speech/kokoro.md @@ -0,0 +1,33 @@ +--- +title: Kokoro（本地 TTS） +description: 在 AIRI 中配置本地 Kokoro 语音合成 +--- + +Kokoro 在 AIRI 中以本地模型方式运行语音合成。 + +::: info 为什么选择 Kokoro？ +如果你希望在本地处理语音内容，并且设备满足模型运行条件，可以选择 Kokoro。 +::: + +## 第一步：准备本地运行环境 + +1. 在支持 WebGPU 的环境中打开 AIRI；首次使用时，等待模型下载完成。 +2. 该选项不需要云端 API Key，但会使用本机的下载空间、内存和计算资源。 + +::: warning 本地资源使用 +本地模型会占用下载空间、内存和计算资源。不要在设备资源不足时强行启用。 +::: + +## 第二步：在 AIRI 中配置 + +1. 打开 **设置 → 服务商 → 语音合成 → Kokoro**。 +2. 选择 AIRI 提供的可用 Kokoro 模型。 + +### 3. 配置校验 + +1. **选择模型和音色**：模型准备完成后，选择音色，再到 **设置 → 发声** 启用。 +2. 输入短文本试听；能正常播放即表示模型已准备完成。 + +## 排查 + +模型无法加载时，检查浏览器是否支持 WebGPU、设备资源是否充足，并重新打开页面后等待下载完成。 diff --git a/docs/content/zh-Hans/docs/manual/config/providers/speech/mimo.md b/docs/content/zh-Hans/docs/manual/config/providers/speech/mimo.md new file mode 100644 index 000000000..5266d848d --- /dev/null +++ b/docs/content/zh-Hans/docs/manual/config/providers/speech/mimo.md @@ -0,0 +1,34 @@ +--- +title: 小米 MiMo（TTS） +description: 在 AIRI 中配置小米 MiMo 语音合成 +--- + +MiMo 支持预设音色、声音设计和声音克隆三种语音合成模式。 + +::: info 为什么选择小米 MiMo？ +如果你需要预设中文音色，或希望使用文字描述设计声音，可以选择 MiMo。 +::: + +## 第一步：获取 API Key + +1. 打开并登录 [小米 MiMo 平台](https://platform.xiaomimimo.com/)，确认账户已开通 API 使用权限。 +2. 创建 API Key，复制后妥善保存。 + +::: warning 声音样本与 API Key 安全 +声音克隆需要 Base64 data URI 格式的音频样本。只能上传你有权使用的声音；不要公开 API Key 或他人的声音样本。 +::: + +## 第二步：在 AIRI 中配置 + +1. 在 **设置 → 服务商 → 语音合成 → Xiaomi MiMo** 中填写 API Key。 +2. 保留默认 Base URL：`https://api.xiaomimimo.com/v1/`，除非服务商提供了其他地址。 + +### 3. 配置校验 + +1. **Ping API**：点击此按钮测试网络是否连通以及 API Key 是否填写正确。 +2. **选择模型和音色**：测试成功后，选择预设音色、声音设计或声音克隆模型，并在 **设置 → 发声** 启用。 +3. 输入短文本试听。声音设计需要样式描述；声音克隆还需要合法的声音样本。 + +## 排查 + +请求失败时，检查 API Key 和模型选择。声音克隆失败时，确认样本是有效的 Base64 data URI，且你有权使用该声音。 diff --git a/docs/content/zh-Hans/docs/manual/config/providers/speech/minimax.md b/docs/content/zh-Hans/docs/manual/config/providers/speech/minimax.md new file mode 100644 index 000000000..7d6146035 --- /dev/null +++ b/docs/content/zh-Hans/docs/manual/config/providers/speech/minimax.md @@ -0,0 +1,35 @@ +--- +title: MiniMax Speech（TTS） +description: 在 AIRI 中配置 MiniMax 语音合成 +--- + +MiniMax Speech 可在 AIRI 中提供语音合成模型和预设声音。 + +::: info 为什么选择 MiniMax Speech？ +如果你已经使用 MiniMax，并希望直接使用其中文或英文预设声音，可以选择它。 +::: + +## 第一步：获取 API Key + +1. 打开并登录 [MiniMax 开放平台](https://platform.minimaxi.com/)，开通 API 使用权限。 +2. 在 API Key 管理页面创建密钥。 +3. 复制密钥并妥善保存。 + +::: warning API Key 安全 +不要将 API Key 提交到仓库、截图或发送给他人。 +::: + +## 第二步：在 AIRI 中配置 + +1. 打开 **设置 → 服务商 → 语音合成 → MiniMax Speech**，粘贴 API Key。 +2. 保留默认服务地址 `https://api.minimax.io`，除非服务商明确提供了其他地址。 + +### 3. 配置校验 + +1. **Ping API**：点击此按钮测试网络是否连通以及 API Key 是否填写正确。 +2. **选择模型和音色**：测试成功后，选择如 `speech-2.8-hd` 或 `speech-2.8-turbo` 的可用模型与声音，再到 **设置 → 发声** 启用。 +3. 输入短文本试听，确认可正常播放。 + +## 排查 + +Ping API 失败时，检查 API Key、账户额度和网络连接。模型或声音不可用时，以 MiniMax 账户当前开放的列表为准。 diff --git a/docs/content/zh-Hans/docs/manual/config/providers/speech/official.md b/docs/content/zh-Hans/docs/manual/config/providers/speech/official.md new file mode 100644 index 000000000..cfb306de6 --- /dev/null +++ b/docs/content/zh-Hans/docs/manual/config/providers/speech/official.md @@ -0,0 +1,33 @@ +--- +title: AIRI 官方语音合成（TTS） +description: 在 AIRI 中使用官方提供的语音合成 +--- + +官方语音合成会使用你的 AIRI 登录状态，不需要单独填写第三方 API Key。 + +::: info 为什么选择 AIRI 官方语音合成？ +如果你已经使用 AIRI 官方提供商，并希望减少第三方凭据配置，可优先尝试这一选项。 +::: + +## 第一步：登录账户 + +1. 使用 AIRI 账户完成登录；官方语音服务依赖当前登录态。 +2. 不需要创建或填写第三方 API Key。 + +::: warning 账户与额度 +官方服务的可用模型、额度和区域由服务端决定。请不要分享账户登录状态或浏览器会话信息。 +::: + +## 第二步：在 AIRI 中配置 + +1. 打开 **设置 → 服务商 → 语音合成 → AIRI 官方语音合成**。 +2. 等待 AIRI 从服务端加载当前可用模型和音色。 + +### 3. 配置校验 + +1. 在 **设置 → 发声** 选择模型和音色，然后使用短文本试听。 +2. 能正常播放即表示配置成功。若服务端未提供流式语音，流式选项不会出现。 + +## 排查 + +模型列表无法加载时，确认账户已登录、网络正常并有可用额度。桌面端无法充值时，请前往 AIRI 网页版的 **设置 → Flux** 完成充值。 diff --git a/docs/content/zh-Hans/docs/manual/config/providers/speech/openai.md b/docs/content/zh-Hans/docs/manual/config/providers/speech/openai.md new file mode 100644 index 000000000..139b25d0f --- /dev/null +++ b/docs/content/zh-Hans/docs/manual/config/providers/speech/openai.md @@ -0,0 +1,37 @@ +--- +title: OpenAI 兼容 API（TTS） +description: 在 AIRI 中配置 OpenAI 或兼容 OpenAI 的 API 作为语音合成服务商 +--- + +本页用于配置 OpenAI 或提供 OpenAI 兼容语音接口的服务商。完成配置后，在“发声”中选择模型和音色。 + +::: info 为什么选择 OpenAI 兼容 TTS？ +如果你的语音服务商明确提供 OpenAI 兼容的语音合成接口，可以用同一种配置方式接入 AIRI。仅 API 地址以 `/v1` 结尾或密钥以 `sk-` 开头，不能保证服务兼容。 +::: + +## 第一步：获取 API Key + +1. 登录所选服务商的管理控制台。 +2. 在 API 密钥或开发者设置页面创建 API Key。 +3. 复制密钥并妥善保存。 + +::: warning API Key 安全 +不要将 API Key 提交到仓库、放入截图，或发送给他人。密钥泄露后，请立即在服务商控制台撤销它并创建新密钥。 +::: + +## 第二步：在 AIRI 中配置 + +1. 打开 **设置 → 服务商 → 语音合成 → OpenAI 兼容 API**。 +2. 填写 API Key 和要使用的 TTS 模型 ID。 +3. 使用 OpenAI 官方服务时，保留默认 Base URL：`https://api.openai.com/v1/`；使用兼容服务时，填写服务商文档提供的 API 根地址。 +4. 根据需要调整语速。 + +### 3. 配置校验 + +1. 在“发声”中选择已配置的服务商、模型和音色。 +2. 输入一段测试文本并点击测试。 +3. 能正常播放语音即表示配置成功；如果显示错误，请根据错误信息检查凭据、模型 ID 与 Base URL。 + +## 排查 + +没有声音时，先确认已选择该服务商支持的模型和音色。使用兼容服务时，请确认其明确支持 OpenAI 语音合成接口。 diff --git a/docs/content/zh-Hans/docs/manual/config/providers/speech/openrouter.md b/docs/content/zh-Hans/docs/manual/config/providers/speech/openrouter.md new file mode 100644 index 000000000..4b4116d10 --- /dev/null +++ b/docs/content/zh-Hans/docs/manual/config/providers/speech/openrouter.md @@ -0,0 +1,36 @@ +--- +title: OpenRouter（TTS） +description: 在 AIRI 中配置 OpenRouter 作为语音合成服务商 +--- + +OpenRouter 是一个聚合式 API 服务商。完成配置后，在“发声”中选择 OpenRouter 提供的语音模型和音色。 + +::: info 为什么选择 OpenRouter 语音？ +如果你希望在同一个 OpenRouter 账户中管理多个模型和语音能力，可以选择此服务商。在中国大陆使用 AIRI 时，可以优先尝试 302.AI；实际可用性仍取决于你的网络环境、支付方式和服务商政策。 +::: + +## 第一步：获取 API Key + +1. 打开 [OpenRouter API Keys](https://openrouter.ai/keys)，创建新的 API Key。 +2. 为密钥设置适当的名称、有效期和额度限制。 +3. 复制密钥并妥善保存。 + +::: warning API Key 安全 +不要将 API Key 提交到仓库、放入截图，或发送给他人。密钥泄露后，请立即在 OpenRouter 控制台撤销它并创建新密钥。 +::: + +## 第二步：在 AIRI 中配置 + +1. 打开 **设置 → 服务商 → 语音合成 → OpenRouter**。 +2. 将 API Key 粘贴到基础设置。 +3. 保留默认 Base URL：`https://openrouter.ai/api/v1/`。 + +### 3. 配置校验 + +1. 在“发声”中选择已配置的服务商、模型和音色。 +2. 输入一段测试文本并点击测试。 +3. 能正常播放语音即表示配置成功；如果显示错误，请根据错误信息检查凭据和模型。 + +## 排查 + +没有声音时，确认所选模型提供语音输出，并检查账户额度与网络连接。 diff --git a/docs/content/zh-Hans/docs/manual/config/providers/speech/player2.md b/docs/content/zh-Hans/docs/manual/config/providers/speech/player2.md new file mode 100644 index 000000000..cc526d64f --- /dev/null +++ b/docs/content/zh-Hans/docs/manual/config/providers/speech/player2.md @@ -0,0 +1,34 @@ +--- +title: Player2 Speech（TTS） +description: 在 AIRI 中连接本地 Player2 Speech 服务 +--- + +Player2 Speech 是通过本地服务连接的语音合成选项。 + +::: info 为什么选择 Player2 Speech？ +如果你已在本机或可信局域网运行 Player2 Speech，可以将 AIRI 连接到该服务并读取它提供的音色。 +::: + +## 第一步：启动本地服务 + +1. 启动 Player2 Speech 服务，并确认健康检查可用。 +2. AIRI 默认连接 `http://localhost:4315/v1/`；如果服务运行在其他地址，请记录完整 Base URL。 + +::: warning 本地服务安全 +不要将本地服务端口暴露到不受信任的公共网络。 +::: + +## 第二步：在 AIRI 中配置 + +1. 打开 **设置 → 服务商 → 语音合成 → Player2 Speech**。 +2. 填写与服务地址一致的 Base URL。 + +### 3. 配置校验 + +1. **Ping API**：点击此按钮测试 AIRI 是否能连接该服务。 +2. **选择模型和音色**：测试成功后，选择 `player2-tts` 与服务返回的声音，再到 **设置 → 发声** 启用。 +3. 输入短文本试听，确认可正常播放。 + +## 排查 + +连接失败时，检查服务的 `/health` 响应和 Base URL。音色列表为空时，确认服务的 `/tts/voices` 接口可访问。 diff --git a/docs/content/zh-Hans/docs/manual/config/providers/speech/volcengine.md b/docs/content/zh-Hans/docs/manual/config/providers/speech/volcengine.md new file mode 100644 index 000000000..2c3dfc900 --- /dev/null +++ b/docs/content/zh-Hans/docs/manual/config/providers/speech/volcengine.md @@ -0,0 +1,35 @@ +--- +title: 火山引擎（TTS） +description: 在 AIRI 中配置火山引擎语音合成 +--- + +火山引擎语音合成需要在 AIRI 中填写 API Key 和应用信息。 + +::: info 为什么选择火山引擎？ +如果你已在火山引擎创建语音应用并管理音色资源，可在 AIRI 中复用这套配置。 +::: + +## 第一步：准备应用凭据 + +1. 打开并登录[火山引擎控制台](https://console.volcengine.com/)，创建或打开语音应用。 +2. 复制该应用的 **App ID**，并创建对应的 **API Key**。 +3. 确认两项信息来自同一账户和应用配置。 + +::: warning API Key 安全 +不要公开 API Key 或 App ID 对应的凭据；泄露后应立即在服务商控制台更换密钥。 +::: + +## 第二步：在 AIRI 中配置 + +1. 打开 **设置 → 服务商 → 语音合成 → 火山引擎**。 +2. 填写 API Key 和 App ID；Base URL 使用界面默认值，除非你使用兼容网关。 + +### 3. 配置校验 + +1. **Ping API**：点击此按钮测试网络、API Key 和 App ID 是否填写正确。 +2. **选择模型和音色**：测试成功后，选择音色，再到 **设置 → 发声** 启用。 +3. 输入短文本试听，确认可正常播放。 + +## 排查 + +验证失败时，检查 App ID 与 API Key 是否来自同一应用。没有声音时，确认应用已开通语音合成并且已选择音色。 diff --git a/docs/content/zh-Hans/docs/manual/config/providers/transcription/aliyun.md b/docs/content/zh-Hans/docs/manual/config/providers/transcription/aliyun.md new file mode 100644 index 000000000..d3d3225f6 --- /dev/null +++ b/docs/content/zh-Hans/docs/manual/config/providers/transcription/aliyun.md @@ -0,0 +1,37 @@ +--- +title: 阿里云 NLS +description: 在 AIRI 中配置阿里云智能语音交互服务（ASR） +--- + +阿里云 NLS 为 AIRI 提供实时语音转文字（ASR）能力。完成配置后，在“听觉”中选择阿里云 NLS 并测试麦克风输入。 + +::: info 为什么选择阿里云 NLS？ +如果你已使用阿里云账户，并需要实时语音识别能力，可以选择阿里云 NLS。 +::: + +## 第一步：准备凭据 + +1. 在[阿里云智能语音交互控制台](https://nls-portal.console.aliyun.com/overview)开通服务并创建项目，复制该项目的 **AppKey**。 +2. 在 **AccessKey 管理** 中创建具备所需权限的 RAM 用户 AccessKey。 +3. 复制 **AccessKey ID** 和 **AccessKey Secret**；Secret 通常只会完整显示一次。 + +::: warning AccessKey 安全 +不要将 AccessKey ID、AccessKey Secret 或 AppKey 提交到仓库、放入截图，或发送给他人。请遵循最小权限原则；凭据泄露后，立即在阿里云控制台禁用并创建新凭据。 +::: + +## 第二步：在 AIRI 中配置 + +1. 打开 **设置 → 服务商 → 语音识别 → 阿里云 NLS**。 +2. 填写 **AccessKey ID**、**AccessKey Secret** 和 **AppKey**。 +3. 选择距离你最近的区域，例如华东 `cn-shanghai`、华北 `cn-beijing` 或华南 `cn-shenzhen`。 + +### 3. 配置校验 + +1. 确认页面提示基础凭据验证通过。 +2. 在“听觉”中选择阿里云 NLS 和音频输入设备。 +3. 点击“开始监听”，然后对着麦克风说话或播放一段音频。 +4. 在转写区域确认文字能实时输出；识别结果不准确时，可调整灵敏度后再次测试。 + +## 排查 + +凭据验证失败时，请确认三项凭据来自同一阿里云账户与项目，并检查 RAM 用户权限。没有文字结果时，请确认系统已授予 AIRI 麦克风权限。 diff --git a/docs/content/zh-Hans/docs/manual/config/providers/transcription/browser-local.md b/docs/content/zh-Hans/docs/manual/config/providers/transcription/browser-local.md new file mode 100644 index 000000000..3c9c245ee --- /dev/null +++ b/docs/content/zh-Hans/docs/manual/config/providers/transcription/browser-local.md @@ -0,0 +1,33 @@ +--- +title: 浏览器本地语音识别（ASR/STT） +description: 在 AIRI 网页版中使用浏览器本地语音识别 +--- + +浏览器本地语音识别使用 AIRI 的本地模型能力，不需要云端 API Key。 + +::: info 为什么选择浏览器本地语音识别？ +如果你使用网页版，并希望尽量不把音频发送给第三方服务商，可以尝试该选项。 +::: + +## 第一步：确认浏览器环境 + +1. 使用 AIRI 网页版；该服务商不会在桌面端出现。 +2. 确认浏览器支持 WebGPU，或设备内存至少为 8 GB，才会显示此服务商卡片。 + +::: warning 设备兼容性 +本地模型会占用设备资源。若服务商卡片未出现或识别无法启动，请改用 Web Speech API、云端 ASR 或桌面端本地方案。 +::: + +## 第二步：在 AIRI 中配置 + +1. 在网页版打开 **设置 → 服务商 → 语音识别 → Browser (Local)**。 +2. 等待模型准备完成后选择模型，并在 **设置 → 听觉** 中启用。 + +### 3. 配置校验 + +1. 允许浏览器访问麦克风，进行一段短语音输入。 +2. 转写文字能显示即表示配置成功。 + +## 排查 + +卡片未出现时，检查当前是否为网页版及设备是否满足 WebGPU 或内存要求。识别无法启动时，检查浏览器麦克风权限。 diff --git a/docs/content/zh-Hans/docs/manual/config/providers/transcription/comet-api.md b/docs/content/zh-Hans/docs/manual/config/providers/transcription/comet-api.md new file mode 100644 index 000000000..8e47c1bf8 --- /dev/null +++ b/docs/content/zh-Hans/docs/manual/config/providers/transcription/comet-api.md @@ -0,0 +1,34 @@ +--- +title: CometAPI（ASR/STT） +description: 在 AIRI 中配置 CometAPI 语音识别 +--- + +CometAPI 通过其兼容接口提供音频转写。 + +::: info 为什么选择 CometAPI？ +如果你已使用 CometAPI 管理模型和凭据，可在 AIRI 中直接复用同一 API Key 进行语音识别。 +::: + +## 第一步：获取 API Key + +1. 打开并登录 [CometAPI 控制台](https://www.cometapi.com/console/token)，创建 API Key。 +2. 确认账户可访问音频转写模型，复制密钥并妥善保存。 + +::: warning API Key 安全 +不要将 API Key 提交到仓库、截图或发送给他人。 +::: + +## 第二步：在 AIRI 中配置 + +1. 打开 **设置 → 服务商 → 语音识别 → CometAPI Transcription**，填写 API Key。 +2. 保留默认 Base URL：`https://api.cometapi.com/v1/`；只有使用代理或兼容网关时才修改。 + +### 3. 配置校验 + +1. **Ping API**：点击此按钮测试网络是否连通以及 API Key 是否填写正确。 +2. **选择模型**：测试成功后，选择可用转写模型；再到 **设置 → 听觉** 启用。 +3. 允许麦克风访问并进行一段短语音输入，确认文字可输出。 + +## 排查 + +Ping API 失败时，检查 API Key、账户权限和网络连接。没有文字结果时，确认 AIRI 已获得系统麦克风权限。 diff --git a/docs/content/zh-Hans/docs/manual/config/providers/transcription/desktop-local.md b/docs/content/zh-Hans/docs/manual/config/providers/transcription/desktop-local.md new file mode 100644 index 000000000..ed4ccf971 --- /dev/null +++ b/docs/content/zh-Hans/docs/manual/config/providers/transcription/desktop-local.md @@ -0,0 +1,33 @@ +--- +title: 桌面端本地语音识别（ASR/STT） +description: 在 AIRI 桌面版中使用本地语音识别 +--- + +桌面端本地语音识别只在 AIRI 桌面版中提供，不需要云端 API Key。 + +::: info 为什么选择桌面端本地语音识别？ +如果你使用 AIRI 桌面版，并希望减少对云端转写服务的依赖，可以选择此项。 +::: + +## 第一步：确认桌面端环境 + +1. 使用 AIRI 桌面版；该服务商不会在网页版出现。 +2. 确保设备有足够的磁盘空间和计算资源供本地模型使用。 + +::: warning 运行环境 +此服务商不会出现在网页版。模型运行会使用本机磁盘和计算资源。 +::: + +## 第二步：在 AIRI 中配置 + +1. 在 AIRI 桌面版打开 **设置 → 服务商 → 语音识别 → App (Local)**。 +2. 选择可用模型；完成准备后，到 **设置 → 听觉** 启用。 + +### 3. 配置校验 + +1. 允许 AIRI 使用麦克风，并进行一段短语音输入。 +2. 识别结果能显示在 AIRI 中即表示配置成功。 + +## 排查 + +服务商未出现时，确认你运行的是桌面版。模型准备失败时，检查磁盘空间和设备资源；没有文字结果时，检查系统麦克风权限。 diff --git a/docs/content/zh-Hans/docs/manual/config/providers/transcription/mimo.md b/docs/content/zh-Hans/docs/manual/config/providers/transcription/mimo.md new file mode 100644 index 000000000..ef379d61d --- /dev/null +++ b/docs/content/zh-Hans/docs/manual/config/providers/transcription/mimo.md @@ -0,0 +1,34 @@ +--- +title: 小米 MiMo（ASR/STT） +description: 在 AIRI 中配置小米 MiMo 语音识别 +--- + +MiMo 使用其原生音频理解模型完成语音转写。 + +::: info 为什么选择小米 MiMo？ +如果你已使用 MiMo，或希望使用其多模态模型处理音频内容，可以选择该服务商。 +::: + +## 第一步：获取 API Key + +1. 打开并登录 [小米 MiMo 平台](https://platform.xiaomimimo.com/)，确认账户已开通 API 使用权限。 +2. 创建 API Key，复制后妥善保存。 + +::: warning API Key 与音频数据 +不要公开 API Key。使用云端转写会把待识别音频发送给服务商，请先确认你的数据处理要求。 +::: + +## 第二步：在 AIRI 中配置 + +1. 在 **设置 → 服务商 → 语音识别 → Xiaomi MiMo** 中填写 API Key。 +2. 保留默认 Base URL：`https://api.xiaomimimo.com/v1/`，除非服务商提供了其他地址。 + +### 3. 配置校验 + +1. **Ping API**：点击此按钮测试网络是否连通以及 API Key 是否填写正确。 +2. **选择模型**：测试成功后，选择 `mimo-v2-omni` 或界面列出的可用模型；随后到 **设置 → 听觉** 启用。 +3. 允许麦克风访问并进行一段短语音输入，确认文字可输出。 + +## 排查 + +请求失败时，检查 API Key、模型选择和网络连接。没有文字结果时，确认 AIRI 已获得系统麦克风权限。 diff --git a/docs/content/zh-Hans/docs/manual/config/providers/transcription/official.md b/docs/content/zh-Hans/docs/manual/config/providers/transcription/official.md new file mode 100644 index 000000000..4d8868c5a --- /dev/null +++ b/docs/content/zh-Hans/docs/manual/config/providers/transcription/official.md @@ -0,0 +1,33 @@ +--- +title: AIRI 官方语音识别（ASR/STT） +description: 在 AIRI 中使用官方提供的实时语音识别 +--- + +官方语音识别会使用你的 AIRI 登录状态，不需要单独填写第三方 API Key。 + +::: info 为什么选择 AIRI 官方语音识别？ +如果你已使用 AIRI 官方提供商，想先快速启用实时语音输入，可优先尝试这一选项。 +::: + +## 第一步：登录账户 + +1. 使用 AIRI 账户完成登录；官方实时识别依赖当前登录态。 +2. 不需要创建或填写第三方 API Key。 + +::: warning 账户与音频数据 +实时识别会将音频发送到官方服务。不要使用包含敏感信息的测试音频，也不要分享账户会话信息。 +::: + +## 第二步：在 AIRI 中配置 + +1. 打开 **设置 → 服务商 → 语音识别 → AIRI 官方语音识别**。 +2. 选择 `Auto` 或服务端提供的模型，再到 **设置 → 听觉** 启用。 + +### 3. 配置校验 + +1. 允许 AIRI 使用麦克风，并进行一段短语音输入。 +2. 转写文字能显示即表示配置成功。 + +## 排查 + +模型无法使用时，确认账户已登录、网络正常且有可用额度。没有文字结果时，检查系统麦克风权限。 diff --git a/docs/content/zh-Hans/docs/manual/config/providers/transcription/openai.md b/docs/content/zh-Hans/docs/manual/config/providers/transcription/openai.md new file mode 100644 index 000000000..16b72e3db --- /dev/null +++ b/docs/content/zh-Hans/docs/manual/config/providers/transcription/openai.md @@ -0,0 +1,36 @@ +--- +title: OpenAI 兼容 API（ASR/STT） +description: 在 AIRI 中配置 OpenAI 或兼容 OpenAI 的 API 作为语音识别服务商 +--- + +本页用于配置 OpenAI 或提供 OpenAI 兼容转写接口的服务商。完成配置后，在“听觉”中选择模型并测试麦克风输入。 + +::: info 为什么选择 OpenAI 兼容 ASR/STT？ +如果你的语音识别服务商明确提供 OpenAI 兼容的转写接口，可以按本页方式接入 AIRI。仅 API 地址以 `/v1` 结尾或密钥以 `sk-` 开头，不能保证服务兼容。 +::: + +## 第一步：获取 API Key + +1. 登录所选服务商的管理控制台。 +2. 在 API 密钥或开发者设置页面创建 API Key。 +3. 复制密钥并妥善保存。 + +::: warning API Key 安全 +不要将 API Key 提交到仓库、放入截图，或发送给他人。密钥泄露后，请立即在服务商控制台撤销它并创建新密钥。 +::: + +## 第二步：在 AIRI 中配置 + +1. 打开 **设置 → 服务商 → 语音识别 → OpenAI 兼容 API**。 +2. 填写 API Key 和要使用的 ASR/STT 模型 ID。 +3. 使用 OpenAI 官方服务时，保留默认 Base URL：`https://api.openai.com/v1/`；使用兼容服务时，填写服务商文档提供的 API 根地址。 + +### 3. 配置校验 + +1. 在“听觉”中选择已配置的服务商和模型，并选择音频输入设备。 +2. 点击“开始监听”，然后对着麦克风说话或播放一段音频。 +3. 在转写区域确认文字能实时输出；识别结果不准确时，可调整灵敏度后再次测试。 + +## 排查 + +没有文字结果时，请先确认系统已授予 AIRI 麦克风权限。使用兼容服务时，请确认其明确支持 OpenAI 转写接口与所填模型 ID。 diff --git a/docs/content/zh-Hans/docs/manual/config/providers/transcription/web-speech-api.md b/docs/content/zh-Hans/docs/manual/config/providers/transcription/web-speech-api.md new file mode 100644 index 000000000..cff0bba99 --- /dev/null +++ b/docs/content/zh-Hans/docs/manual/config/providers/transcription/web-speech-api.md @@ -0,0 +1,34 @@ +--- +title: 浏览器 Web Speech API（ASR/STT） +description: 在 AIRI 网页版中使用浏览器内置语音识别 +--- + +Web Speech API 使用浏览器提供的语音识别能力，不需要单独申请 API Key。 + +::: info 为什么选择 Web Speech API？ +如果你只在网页版快速试用语音输入，并且浏览器支持 Web Speech API，这是最少配置的选择。 +::: + +## 第一步：确认浏览器支持 + +1. 使用 AIRI 网页版；Web Speech API 不会在桌面版（Electron）中提供。 +2. 确认当前浏览器支持 Web Speech API，并准备允许麦克风权限。 + +::: warning 浏览器限制 +Web Speech API 仅适用于浏览器环境，AIRI 桌面版（Electron）不支持它。不同浏览器、网络环境和语言的识别能力可能不同。 +::: + +## 第二步：在 AIRI 中配置 + +1. 在网页版打开 **设置 → 服务商 → 语音识别 → Web Speech API**。 +2. 选择识别语言，以及需要时的连续识别和中间结果选项。 + +### 3. 配置校验 + +1. 前往 **设置 → 听觉** 选择 Web Speech API 和音频输入设备。 +2. 允许浏览器访问麦克风，开始一次短语音输入测试。 +3. 转写文字能显示即表示配置成功。 + +## 排查 + +没有文字结果时，检查浏览器麦克风权限、所选输入设备和识别语言。若浏览器不支持该 API，请改用本地或云端 ASR。 diff --git a/docs/content/zh-Hans/docs/manual/config/vision.md b/docs/content/zh-Hans/docs/manual/config/vision.md new file mode 100644 index 000000000..0b4dd040e --- /dev/null +++ b/docs/content/zh-Hans/docs/manual/config/vision.md @@ -0,0 +1,90 @@ +--- +title: 配置视觉 +description: 为 AIRI 的视觉模块选择图像理解服务商和模型 +--- + +视觉模块会把捕获的画面发送给支持图像输入的模型，用于理解屏幕或摄像头画面。AIRI 不维护一套独立的视觉 API 凭据：它会为每个聊天服务商提供对应的视觉配置项，并复用该服务商的字段。 + +::: info 为什么视觉配置与聊天配置共用？ +同一服务商通常同时提供聊天和图像理解模型。复用凭据可减少重复配置；你仍需选择一个明确支持图像输入的模型，纯文本模型无法完成视觉任务。 +::: + +## 第一步：选择视觉服务商 + +1. 打开 **设置 → 服务商 → 视觉**。 +2. 选择一个你已经配置过或准备配置的聊天服务商。 +3. 按该服务商卡片填写凭据。字段与其聊天服务商版本一致，例如 API Key、Base URL、Azure 资源信息或 Amazon Bedrock Region。 + +可用的视觉服务商来自当前聊天服务商注册表。下面每一项都会在 **设置 → 服务商 → 视觉** 中出现相同服务商的配置卡片；凭据与对应聊天页相同。 + +## 服务商与对应聊天配置 + +| 视觉服务商 | 对应聊天配置 | +| --- | --- | +| AIRI 官方提供商 | [AIRI 官方提供商](./providers/consciousness/official.md) | +| 302.AI | [302.AI](./providers/consciousness/302ai.md) | +| AIHubMix | [AIHubMix](./providers/consciousness/aihubmix.md) | +| Amazon Bedrock | [Amazon Bedrock](./providers/consciousness/amazon-bedrock.md) | +| Anthropic | [Anthropic](./providers/consciousness/anthropic.md) | +| Azure AI Foundry | [Azure AI Foundry](./providers/consciousness/azure-ai-foundry.md) | +| Azure OpenAI | [Azure OpenAI](./providers/consciousness/azure-openai.md) | +| BytePlus | [BytePlus](./providers/consciousness/byteplus.md) | +| BytePlus Coding Plan | [BytePlus Coding Plan](./providers/consciousness/byteplus-coding-plan.md) | +| Cerebras | [Cerebras](./providers/consciousness/cerebras.md) | +| Cloudflare Workers AI | [Cloudflare Workers AI](./providers/consciousness/cloudflare-workers-ai.md) | +| CometAPI | [CometAPI](./providers/consciousness/comet-api.md) | +| DeepSeek | [DeepSeek](./providers/consciousness/deepseek.md) | +| Featherless.ai | [Featherless.ai](./providers/consciousness/featherless.md) | +| Fireworks AI | [Fireworks AI](./providers/consciousness/fireworks.md) | +| Google Gemini | [Google Gemini](./providers/consciousness/google-gemini.md) | +| Groq | [Groq](./providers/consciousness/groq.md) | +| LM Studio | [LM Studio](./providers/consciousness/lm-studio.md) | +| MiniMax | [MiniMax](./providers/consciousness/minimax.md) | +| MiniMax Global | [MiniMax Global](./providers/consciousness/minimax-global.md) | +| Mistral | [Mistral](./providers/consciousness/mistral.md) | +| ModelScope | [ModelScope](./providers/consciousness/modelscope.md) | +| Moonshot | [月之暗面](./providers/consciousness/moonshot.md) | +| 小米 MiMo | [小米 MiMo](./providers/consciousness/mimo.md) | +| n1n | [n1n](./providers/consciousness/n1n.md) | +| NVIDIA NIM | [NVIDIA NIM](./providers/consciousness/nvidia.md) | +| Novita | [Novita](./providers/consciousness/novita.md) | +| Ollama | [Ollama](./providers/consciousness/ollama.md) | +| OpenAI 与兼容 API | [OpenAI 与兼容 API](./providers/consciousness/openai.md) | +| OpenRouter | [OpenRouter](./providers/consciousness/openrouter.md) | +| Perplexity | [Perplexity](./providers/consciousness/perplexity.md) | +| Together.ai | [Together.ai](./providers/consciousness/together.md) | +| xAI | [xAI](./providers/consciousness/xai.md) | +| Z.ai | [Z.ai](./providers/consciousness/zhipu.md) | +| 火山引擎 Coding Plan | [火山引擎 Coding Plan](./providers/consciousness/volcengine-coding-plan.md) | + +这表示 AIRI 有该服务商的视觉配置入口，并不表示该服务商的每一个模型都能读图。仍须在模型列表中选择明确支持图片输入的模型。 + +::: warning 图像与凭据安全 +视觉分析会把画面发送给所选服务商。不要捕获包含 API Key、密码、个人信息或未经授权内容的画面；云端服务的凭据也不得提交到仓库、截图或发送给他人。 +::: + +## 第二步：选择视觉模型 + +1. 打开 **设置 → 视觉**。 +2. 选择刚配置的服务商。 +3. 从模型列表选择支持图片或视觉输入的模型。 +4. 启用需要的视觉功能，并按页面提示选择画面来源或捕获方式。 + +## 第三步：配置校验 + +1. 使用一张不含敏感信息的测试画面。 +2. 触发一次视觉分析。 +3. 当 AIRI 返回画面描述或相应上下文时，说明服务商、模型与画面输入已配置成功。 + +## 本地视觉模型 + +Ollama 与 LM Studio 可作为本地视觉服务商。先在本地运行一个支持图像输入的模型，并确认其服务地址可被 AIRI 访问；随后在视觉服务商页填写或保留相应 Base URL，并从模型列表选择该视觉模型。 + +## 排查 + +| 现象 | 优先检查 | +| --- | --- | +| 服务商无法保存 | 与聊天版本相同的凭据字段是否完整，例如 API Key、Azure 资源名称或 Bedrock Region。 | +| 模型无法分析图片 | 该模型是否明确支持图像输入；切换到服务商提供的视觉模型。 | +| 本地模型不可达 | 本地服务是否运行、Base URL、端口、CORS 与局域网访问设置。 | +| 请求被拒绝或额度不足 | 服务商账户权限、模型可用地区、额度和网络连接。 |