docs(frontend): document local FunASR transcription - #13667
Conversation
github-project-automation
Bot
moved this to 🆕 Needs initial review
in AutoGPT development kanban
|
|
github-actions
Bot
added
documentation
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
WalkthroughThe frontend environment template adds optional transcription settings, the route test validates the ChangesVoice transcription configuration
Estimated code review effort: 1 (Trivial) | ~5 minutes Possibly related PRs
Suggested reviewers: Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches 💡 1🛠️ Fix failing CI checks 💡
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
d4157fc to
459b7c9
Compare
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/platform/copilot-local-llm.md`:
- Around line 145-148: Update the documentation around the OpenAI fallback to
reflect route precedence: when TRANSCRIPTION_API_BASE_URL is unset, the route
uses OPENAI_API_BASE_URL, while OPENAI_API_KEY is applied only for the default
OpenAI endpoint. Clarify that a custom OPENAI_API_BASE_URL still receives
whisper-1 requests without bearer authentication, or adjust the documented
fallback behavior accordingly.
- Line 98: Update the documented FunASR installation command to install funasr
together with the server dependencies fastapi, uvicorn, and python-multipart, so
fresh environments can run funasr-server and support multipart uploads.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro Plus
Run ID: aaf50735-fd7d-4036-ac32-127b0b9de122
📒 Files selected for processing (2)
autogpt_platform/frontend/.env.defaultdocs/platform/copilot-local-llm.md
📜 Review details
⏰ Context from checks skipped due to timeout. (7)
- GitHub Check: check API types
- GitHub Check: integration_test
- GitHub Check: lint
- GitHub Check: Analyze (python)
- GitHub Check: Analyze (typescript)
- GitHub Check: Check PR Status
- GitHub Check: end-to-end tests
⚠️ CI failures not shown inline (1)
Commit Status: Vercel: Vercel
Conclusion: failure
Authorization required to deploy.
🧰 Additional context used
📓 Path-based instructions (2)
autogpt_platform/frontend/.env*
📄 CodeRabbit inference engine (autogpt_platform/AGENTS.md)
Frontend environment configuration:
frontend/.env.defaultprovides defaults (tracked in git),frontend/.envprovides user overrides (gitignored)
Files:
autogpt_platform/frontend/.env.default
autogpt_platform/**/.env*
📄 CodeRabbit inference engine (autogpt_platform/AGENTS.md)
Platform environment configuration:
.env.defaultprovides Supabase/shared defaults (tracked in git),.envprovides user overrides (gitignored)
Files:
autogpt_platform/frontend/.env.default
🪛 dotenv-linter (4.0.0)
autogpt_platform/frontend/.env.default
[warning] 50-50: [UnorderedKey] The TRANSCRIPTION_API_KEY key should go before the TRANSCRIPTION_MODEL key
(UnorderedKey)
🔇 Additional comments (2)
autogpt_platform/frontend/.env.default (1)
46-50: LGTM!docs/platform/copilot-local-llm.md (1)
8-9: LGTM!
![sentry[bot]](https://avatars.githubusercontent.com/in/12637?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (1)
autogpt_platform/frontend/.env.default (1)
48-50: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winReorder the transcription keys to satisfy dotenv-linter.
Place
TRANSCRIPTION_API_KEYbeforeTRANSCRIPTION_MODEL.Proposed fix
TRANSCRIPTION_API_BASE_URL= -TRANSCRIPTION_MODEL= TRANSCRIPTION_API_KEY= +TRANSCRIPTION_MODEL=🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@autogpt_platform/frontend/.env.default` around lines 48 - 50, Reorder the transcription environment variables so TRANSCRIPTION_API_KEY appears before TRANSCRIPTION_MODEL, while keeping TRANSCRIPTION_API_BASE_URL and the existing values unchanged.Source: Linters/SAST tools
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In `@autogpt_platform/frontend/.env.default`:
- Around line 48-50: Reorder the transcription environment variables so
TRANSCRIPTION_API_KEY appears before TRANSCRIPTION_MODEL, while keeping
TRANSCRIPTION_API_BASE_URL and the existing values unchanged.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro Plus
Run ID: 4513ceba-c9da-4a1b-a49c-efea56d7fd86
📒 Files selected for processing (2)
autogpt_platform/frontend/.env.defaultdocs/platform/copilot-local-llm.md
🚧 Files skipped from review as they are similar to previous changes (1)
- docs/platform/copilot-local-llm.md
📜 Review details
⏰ Context from checks skipped due to timeout. (8)
- GitHub Check: check API types
- GitHub Check: lint
- GitHub Check: integration_test
- GitHub Check: end-to-end tests
- GitHub Check: Seer Code Review
- GitHub Check: Analyze (python)
- GitHub Check: Analyze (typescript)
- GitHub Check: Check PR Status
⚠️ CI failures not shown inline (1)
Commit Status: Vercel: Vercel
Conclusion: failure
Authorization required to deploy.
🧰 Additional context used
📓 Path-based instructions (2)
autogpt_platform/frontend/.env*
📄 CodeRabbit inference engine (autogpt_platform/AGENTS.md)
Frontend environment configuration:
frontend/.env.defaultprovides defaults (tracked in git),frontend/.envprovides user overrides (gitignored)
Files:
autogpt_platform/frontend/.env.default
autogpt_platform/**/.env*
📄 CodeRabbit inference engine (autogpt_platform/AGENTS.md)
Platform environment configuration:
.env.defaultprovides Supabase/shared defaults (tracked in git),.envprovides user overrides (gitignored)
Files:
autogpt_platform/frontend/.env.default
🪛 dotenv-linter (4.0.0)
autogpt_platform/frontend/.env.default
[warning] 50-50: [UnorderedKey] The TRANSCRIPTION_API_KEY key should go before the TRANSCRIPTION_MODEL key
(UnorderedKey)
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## dev #13667 +/- ##
==========================================
- Coverage 77.95% 77.94% -0.02%
==========================================
Files 2932 2932
Lines 219804 219803 -1
Branches 20847 20785 -62
==========================================
- Hits 171352 171320 -32
- Misses 43851 43941 +90
+ Partials 4601 4542 -59
Flags with carried forward coverage won't be shown. Click here to find out more.
🚀 New features to boost your workflow:
|
github-project-automation
Bot
moved this from 🆕 Needs initial review
to 🚧 Needs work
in AutoGPT development kanban
|
@Pwuts, the branch is current again and the two requested changes remain present with all review threads resolved.
The only merge conflict was the adjacent |
Signed-off-by: zhifu gao <18321252+LauraGPT@users.noreply.github.com>
github-actions
Bot
added
the
conflicts
|
This pull request has conflicts with the base branch, please resolve those so we can evaluate the pull request. |
|
👋 Friendly reminder: This PR is waiting on a signed CLA. All contributors need to sign our Contributor License Agreement before we can merge this PR. Why do we need a CLA?The CLA protects both you and the project by clarifying the terms under which your contribution is made. It's a one-time process — once signed, it covers all your future contributions. Common issues
If you have questions, just ask! 🙂 |
Signed-off-by: zhifu gao <18321252+LauraGPT@users.noreply.github.com>
|
Conflicts have been resolved! 🎉 A maintainer will review the pull request shortly. |
github-actions
Bot
removed
the
conflicts
|
Note GitHub couldn't provide a complete incremental comparison for this pull request, so CodeRabbit is performing a full review instead. This review may take a little longer. |
|
We haven't received a signed CLA from all contributors yet. Please sign it to keep this PR open: If you're unable to sign or have questions, please let us know — we're happy to help! |
|
👋 Closing this PR due to unsigned CLA after 30 days. Thank you for your contribution! If you'd still like to contribute:
We appreciate your interest in AutoGPT and hope to see you back! 🚀 |
github-project-automation
Bot
moved this from 🚧 Needs work
to ✅ Done
in AutoGPT development kanban
3 participants
Why / What / How
Why: #13500 added custom OpenAI-compatible transcription endpoints, but the new environment variables were not discoverable in the default configuration or self-hosting docs. Users who want private AutoPilot voice input therefore had no documented path to FunASR/SenseVoice.
What: This PR exposes the three optional
TRANSCRIPTION_*settings in the frontend environment template and adds a copy-paste FunASR setup to the existing self-hosted AutoPilot guide.How: The guide starts the official
funasr-serverOpenAI-compatible endpoint, configures the server-side frontend route, distinguishes Docker Desktop, native Linux, and non-Docker addresses, documents container recreation, and calls out authentication/network safety. Empty settings preserve the existing OpenAIwhisper-1fallback.Follow-up to #13500 and #13347.
Changes 🏗️
TRANSCRIPTION_API_BASE_URL,TRANSCRIPTION_MODEL, andTRANSCRIPTION_API_KEYtofrontend/.env.defaultas optional empty settings.Current
devrefreshdev@c29ca86f885ae092fd8c2972088864e2d5b41ff2into signed+DCO head7b623d4fac8d1514f0bb1d4f340fc69f478d7409; the only conflict was the adjacent.env.defaultblock, resolved by retaining both the optional transcription variables and upstream's brain-dump feature flag guidance.+81/-2) with all review threads resolved.Checklist 📋
For code changes:
pnpm lint(ESLint and Prettier checks pass)pnpm generate:api(no tracked changes)pnpm typespnpm exec vitest run src/app/api/transcribe/__tests__/route.test.ts(9 passed)pnpm exec vitest run --coverage --maxWorkers=50%(458 files; 4,805 passed, 2 skipped)git diff --checkFor configuration changes:
.env.defaultis updated or already compatible with my changesdocker-compose.ymlis updated or already compatible with my changesThe existing frontend
env_fileorder already loads.env.defaultand then the optional.envoverride, so no Compose change is required.