Skip to content

docs(vlm): document timeout config field (#1580)#1593

Merged
qin-ctx merged 2 commits intovolcengine:mainfrom
r266-tech:docs/vlm-timeout-1580
Apr 20, 2026
Merged

docs(vlm): document timeout config field (#1580)#1593
qin-ctx merged 2 commits intovolcengine:mainfrom
r266-tech:docs/vlm-timeout-1580

Conversation

@r266-tech
Copy link
Copy Markdown
Contributor

Summary

PR #1580 (0xble, merged 2026-04-20) added a new timeout field to VLMConfig (default 60.0, gt=0.0 validation) and wired it through both OpenAI and LiteLLM backends. Users can now set vlm.timeout in ov.conf to increase per-request HTTP timeout for slow endpoints (DashScope, local inference, large overview prompts).

docs/en/guides/01-configuration.md and docs/zh/guides/01-configuration.md list the other VLM fields (api_key, model, max_retries, extra_headers, stream, …) in the parameter tables but are missing timeout. Users who want to raise the timeout have no signal from the docs that the field exists — they have to read vlm_config.py source or the #1580 PR description.

Changes

  • docs/en/guides/01-configuration.md: +1 row in the vlm Parameters table describing timeout (type float, default 60.0, must be > 0, slow-endpoint use case mirrored from the Field description in vlm_config.py)
  • docs/zh/guides/01-configuration.md: +1 row in the 参数 table (中文描述, 与 EN 镜像)

Docs-only change; no code touched.

Related

@github-actions
Copy link
Copy Markdown

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

🎫 Ticket compliance analysis 🔶

1580 - Partially compliant

Compliant requirements:

  • Document the new timeout field in English and Chinese configuration guides

Non-compliant requirements:

  • (No code changes needed here as this is a docs-only follow-up)

Requires further human verification:

  • Verify Japanese documentation update (if applicable)
⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
🏅 Score: 100
🧪 No relevant tests
🔒 No security concerns identified
✅ No TODO sections
🔀 No multiple PR themes
⚡ No major issues detected

@github-actions
Copy link
Copy Markdown

PR Code Suggestions ✨

No code suggestions found for the PR.

@qin-ctx qin-ctx merged commit 750ccdb into volcengine:main Apr 20, 2026
1 check passed
@github-project-automation github-project-automation Bot moved this from Backlog to Done in OpenViking project Apr 20, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants