Skip to content

Commit e80b0a0

Browse files
authored
docs(vlm): document backup config for automatic failover from #2040 (#2042)
* docs(vlm): document backup config for automatic failover (#2040) * docs(vlm): mirror backup config doc to zh (#2040)
1 parent 2e7a23e commit e80b0a0

2 files changed

Lines changed: 2 additions & 0 deletions

File tree

docs/en/guides/01-configuration.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -540,6 +540,7 @@ Vision Language Model for semantic extraction (L0/L1 generation).
540540
| `thinking` | bool | Enable thinking mode for VolcEngine models (default: `false`) |
541541
| `max_concurrent` | int | Maximum concurrent semantic LLM calls (default: `100`) |
542542
| `max_retries` | int | Maximum retry attempts for transient VLM provider errors (default: `3`; `0` disables retry) |
543+
| `backup` | object | Optional backup VLM configuration (same shape as `vlm`) for automatic failover when the primary fails with retryable errors such as rate limits, `5xx` responses, or connection/timeout failures. Only one level of failover is supported — the backup itself cannot define a nested `backup` |
543544
| `timeout` | float | Per-request HTTP timeout in seconds passed to the underlying OpenAI/LiteLLM client. Increase for slow endpoints (e.g., DashScope, local inference). Must be `> 0` (default: `60.0`) |
544545
| `extra_headers` | object | Custom HTTP headers for compatible HTTP providers. `kimi` also accepts header overrides, but already injects the required subscription headers by default |
545546
| `extra_request_body` | object | Extra JSON body fields for OpenAI-compatible completion requests, useful for provider-specific options such as Ollama `{"think": false}` |

docs/zh/guides/01-configuration.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -512,6 +512,7 @@ openviking-server doctor
512512
| `thinking` | bool | 启用思考模式(仅对部分火山模型生效,默认:`false`|
513513
| `max_concurrent` | int | 语义处理阶段 LLM 最大并发调用数(默认:`100`|
514514
| `max_retries` | int | VLM provider 瞬时错误的最大重试次数(默认:`3``0` 表示禁用重试) |
515+
| `backup` | object | 可选的备用 VLM 配置(结构与 `vlm` 相同),当主 VLM 遇到限流、`5xx`、超时或连接失败等可重试错误时自动切换。仅支持 1 层备用 — 备用 VLM 本身不能再嵌套 `backup` |
515516
| `timeout` | float | 单次 VLM API 请求的 HTTP 超时时间(秒),传递给底层 OpenAI/LiteLLM 客户端。慢端点(如 DashScope、本地推理)可调大。必须 `> 0`(默认:`60.0`|
516517
| `extra_headers` | object | 兼容 HTTP provider 的自定义请求头。`kimi` 默认已注入所需订阅请求头,也支持在这里覆盖或扩展 |
517518
| `extra_request_body` | object | 传给 OpenAI 兼容 completion 请求的额外 JSON body 字段,可用于 Ollama `{"think": false}` 等 provider 专有参数 |

0 commit comments

Comments
 (0)