mirror of
https://github.com/bytedance/deer-flow.git
synced 2026-08-15 17:28:40 +00:00
* feat: show real-time context window usage in chat UI (#3125) Adds a `context_usage` block to `GET /api/threads/{id}/token-usage` (token count from the live checkpoint, the thread model's `context_window`, and a percentage), introduces a new `ModelConfig.context_window` distinct from the per-call `max_tokens` output cap, and surfaces the percentage in the chat header — inside `TokenUsageIndicator` when token-usage tracking is on, or as a standalone badge when it's off so context capacity stays visible independent of cost tracking. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com> * feat: per-category breakdown for context window usage Replace the single-number context_usage payload with a Claude-Code-style breakdown — messages, system prompt, skills, system/MCP tools (active + deferred), custom agents, memory injection, autocompact buffer, and free space — and surface it in the chat UI with a segmented progress bar and per-row table. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com> * docs(config): document context_window across model examples Add `context_window` to every example model in config.example.yaml so the new chat-UI "% context used" indicator works out of the box for whichever example a user adopts. Each value is the published default at the time of writing; users are pointed at the official model spec to verify. Bumps config_version to 11 so `make config-upgrade` flags outdated user configs. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com> * style: ruff format (line-length 240) No behavior change — collapses two multi-line expressions that fit on one line under the project's 240-char limit. Picked up by `make format`. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com> * review: address Copilot bot comments on #3183 - token-usage-indicator: switch `{contextPercentage && (...)}` to an explicit `!= null` check. (The string `"0"` is actually truthy in JS so the original code wasn't buggy, but the explicit check is clearer.) - context-usage-breakdown: drop the `useMemo` around segments/totals — the computation is O(n) over a handful of rows and the previous memo deps omitted `t.contextUsage.categories`, so the bar's tooltips/aria-labels could stay in the old language after a locale switch. - context_usage._split_tools: snapshot MCP names from `get_cached_mcp_tools()` directly instead of re-reading `extensions_config.json` after `get_available_tools()` already loaded it. Removes redundant file I/O on every `/token-usage` poll. (`get_available_tools()` still emits its own INFO logs — silencing those is out of scope here.) Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com> * style(frontend): prettier --write context-usage-breakdown CI's `pnpm format` (prettier --check) caught two lines previously formatted by hand. Collapses one comma to fit on one line; no behavior change. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com> * fix(gateway): correct context-usage breakdown + add exact token counting The context-usage indicator shipped two bugs that silently zeroed whole breakdown rows (both caught by try/except, so the feature looked alive but produced wrong numbers): 1. _count_system_prompt passed app_config= to get_deferred_tools_prompt_section, which only accepts deferred_names -> TypeError swallowed -> system_prompt row always 0, and used_tokens/percentage undercounted by the full prompt. Also subtracted the deferred section twice (the rendered prompt already excluded it). Fix: derive deferred names deterministically and pass them to apply_prompt_template; drop the redundant subtraction. 2. _split_tools imported a non-existent get_deferred_registry -> ImportError swallowed -> all four tool-category rows always 0. Fix: classify via the public is_mcp_tool predicate + tool_search.enabled (mirrors build_deferred_tool_setup); the MCP tag is set by get_available_tools. Added token_usage.counting (approximate|exact). 'exact' routes text/schema/ message counting through the model tokenizer (tiktoken cl100k_base) via the existing memory-module machinery (lazy load + cache + cooldown + CJK-aware fallback), so CJK-heavy threads stop being undercounted by chars//4. Regression + e2e tests added; 6621 backend tests pass. * fix(gateway): harden context usage accounting * fix(gateway): count promoted MCP tools as active in context usage Promoted tools (deferred MCP tools the thread has fetched via tool_search) have their full schema bound on every subsequent turn by DeferredToolFilterMiddleware, so they consume context like any active tool. The breakdown previously left them in the reserved *_deferred rows, under- counting the thread's used_tokens. Classification now treats a tool as deferred only when tool_search is enabled, it is MCP-sourced, AND it has not been promoted. The promoted set is read from the checkpoint's channel_values and scoped by catalog hash — matching the runtime middleware, so a stale promotion from MCP-config drift cannot inflate the active count. The static system prompt still lists all deferred tool names (promotions only affect schema binding, not the prompt), so _count_system_prompt's deferred rendering is intentionally left unchanged. 8 new tests cover classification, catalog-hash scoping (match / drift / compute-failure / malformed), and checkpoint extraction. * fix(context): address review feedback * fix(context): count structured message payloads * fix(context): harden usage accounting * fix(config): bump schema for context usage fields * refactor: narrow context usage to core indicator --------- Co-authored-by: Claude Opus 4.7 <noreply@anthropic.com> Co-authored-by: Willem Jiang <willem.jiang@gmail.com>
62 lines
3.0 KiB
Python
62 lines
3.0 KiB
Python
from pydantic import BaseModel, ConfigDict, Field
|
|
|
|
|
|
class ModelConfig(BaseModel):
|
|
"""Config section for a model"""
|
|
|
|
name: str = Field(..., description="Unique name for the model")
|
|
display_name: str | None = Field(..., default_factory=lambda: None, description="Display name for the model")
|
|
description: str | None = Field(..., default_factory=lambda: None, description="Description for the model")
|
|
use: str = Field(
|
|
...,
|
|
description="Class path of the model provider(e.g. langchain_openai.ChatOpenAI)",
|
|
)
|
|
model: str = Field(..., description="Model name")
|
|
model_config = ConfigDict(extra="allow")
|
|
use_responses_api: bool | None = Field(
|
|
default=None,
|
|
description="Whether to route OpenAI ChatOpenAI calls through the /v1/responses API",
|
|
)
|
|
output_version: str | None = Field(
|
|
default=None,
|
|
description="Structured output version for OpenAI responses content, e.g. responses/v1",
|
|
)
|
|
supports_thinking: bool = Field(default_factory=lambda: False, description="Whether the model supports thinking")
|
|
supports_reasoning_effort: bool = Field(default_factory=lambda: False, description="Whether the model supports reasoning effort")
|
|
when_thinking_enabled: dict | None = Field(
|
|
default_factory=lambda: None,
|
|
description="Extra settings to be passed to the model when thinking is enabled",
|
|
)
|
|
when_thinking_disabled: dict | None = Field(
|
|
default_factory=lambda: None,
|
|
description="Extra settings to be passed to the model when thinking is disabled",
|
|
)
|
|
supports_vision: bool = Field(default_factory=lambda: False, description="Whether the model supports vision/image inputs")
|
|
context_window: int | None = Field(
|
|
default=None,
|
|
gt=0,
|
|
description=(
|
|
"Positive total context window size in tokens (prompt + completion). Used to compute the real-time "
|
|
"context usage percentage displayed in the chat UI. Distinct from `max_tokens`, which is the "
|
|
"per-call output cap passed to the provider. Leave unset if unknown; the UI will hide the "
|
|
"percentage."
|
|
),
|
|
)
|
|
stream_chunk_timeout: float | None = Field(
|
|
default=None,
|
|
description=(
|
|
"Maximum seconds to wait between successive streaming chunks before "
|
|
"langchain-openai raises StreamChunkTimeoutError. None means use the "
|
|
"factory default (240s for OpenAI-compatible clients). Tune higher for "
|
|
"reasoning models with long thinking pauses; lower for latency-sensitive "
|
|
"interactive endpoints. Has no effect on non-OpenAI-compatible providers."
|
|
),
|
|
)
|
|
thinking: dict | None = Field(
|
|
default_factory=lambda: None,
|
|
description=(
|
|
"Thinking settings for the model. If provided, these settings will be passed to the model when thinking is enabled. "
|
|
"This is a shortcut for `when_thinking_enabled` and will be merged with `when_thinking_enabled` if both are provided."
|
|
),
|
|
)
|