Skip to content

fix: correct DeepSeek API configuration example in llm docs - #33

Open
huangziquan62-cpu wants to merge 2 commits into
Open-LLM-VTuber:mainfrom
huangziquan62-cpu:main
Open

fix: correct DeepSeek API configuration example in llm docs #33
huangziquan62-cpu wants to merge 2 commits into
Open-LLM-VTuber:mainfrom
huangziquan62-cpu:main

Conversation

@huangziquan62-cpu

@huangziquan62-cpu huangziquan62-cpu commented Jul 26, 2026

Copy link
Copy Markdown

Summary by CodeRabbit

  • Documentation
    • Updated DeepSeek configuration guidance with the correct configuration key and YAML example.
    • Clarified supported model naming and documented the DeepSeek temperature range of 0–1.
    • Added a note about DeepSeek model name changes effective July 24, 2026.

The DeepSeek API section incorrectly contained the ZhiPu AI (Zhipu)
configuration example. This fixes both Chinese and English versions:

- Replace 'zhipu_llm' with 'deepseek_llm' in the config key
- Replace ZhiPu API key example with DeepSeek API key
- Replace 'glm-4-flash' model with 'deepseek-chat'
- Correct temperature to 0.7 (DeepSeek's range is 0 to 1, not 0 to 2)
- Fix the DeepSeek link from a self-reference to platform.deepseek.com
- Correct the section title from 'deepseek' to 'deepseek_llm'
@coderabbitai

coderabbitai Bot commented Jul 26, 2026

Copy link
Copy Markdown
📝 Walkthrough

Walkthrough

The DeepSeek documentation was corrected in the primary and English localized guides. Configuration examples now use deepseek_llm, updated model naming guidance, and DeepSeek’s 0–1 temperature range.

Changes

DeepSeek documentation

Layer / File(s) Summary
DeepSeek configuration examples
docs/user-guide/backend/llm.md, i18n/en/.../user-guide/backend/llm.md
Updated headings, YAML keys, model naming notes, and temperature guidance for DeepSeek configuration.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Poem

A rabbit reads the YAML bright,
DeepSeek’s keys now point just right.
Models hop with names made clear,
Temperatures stay in range here.
Wiggle ears—docs bloom anew!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly describes the main change: fixing the DeepSeek API configuration example in the LLM docs.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 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/user-guide/backend/llm.md`:
- Line 160: Update the DeepSeek temperature guidance in
docs/user-guide/backend/llm.md at lines 160-160 from 0 到 1 to 0 到 2, and in
i18n/en/docusaurus-plugin-content-docs/current/user-guide/backend/llm.md at
lines 156-156 from 0 to 1 to 0 to 2.
🪄 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: c7ca60d1-59eb-417f-9eca-76116ac304b8

📥 Commits

Reviewing files that changed from the base of the PR and between 622a307 and 3104218.

📒 Files selected for processing (2)
  • docs/user-guide/backend/llm.md
  • i18n/en/docusaurus-plugin-content-docs/current/user-guide/backend/llm.md

deepseek_llm:
llm_api_key: 'Your DeepSeek API key' # DeepSeek API 密钥
model: 'deepseek-v4-flash' # 使用的模型(自2026/7/24起,模型更名为‘deepseek-v4-flash’和‘deepseek-v4-pro’)
temperature: 0.7 # 注意,DeepSeek 的温度范围是 0 到 1

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win

Use DeepSeek’s actual temperature range in both guides.

The DeepSeek API supports temperature from 0 to 2, so both examples should document 0 to 2 rather than 0 to 1. (api-docs.deepseek.com)

  • docs/user-guide/backend/llm.md#L160-L160: change the Chinese temperature guidance to 0 到 2.
  • i18n/en/docusaurus-plugin-content-docs/current/user-guide/backend/llm.md#L156-L156: change the English temperature guidance to 0 to 2.
📍 Affects 2 files
  • docs/user-guide/backend/llm.md#L160-L160 (this comment)
  • i18n/en/docusaurus-plugin-content-docs/current/user-guide/backend/llm.md#L156-L156
🤖 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 `@docs/user-guide/backend/llm.md` at line 160, Update the DeepSeek temperature
guidance in docs/user-guide/backend/llm.md at lines 160-160 from 0 到 1 to 0 到 2,
and in i18n/en/docusaurus-plugin-content-docs/current/user-guide/backend/llm.md
at lines 156-156 from 0 to 1 to 0 to 2.

Source: MCP tools

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant