Skip to content

docs: include_usage streaming semantics changed; dsh docs major refresh with new wire-extension reference - #17

Merged
lroolle merged 1 commit into
mainfrom
docs/sync
Aug 28, 2026
Merged

docs: include_usage streaming semantics changed; dsh docs major refresh with new wire-extension reference#17
lroolle merged 1 commit into
mainfrom
docs/sync

Conversation

@github-actions

@github-actions github-actions Bot commented Aug 26, 2026

Copy link
Copy Markdown
Contributor

Two developer-facing changes landed in this fetch. For DeepSeek API consumers, the documented include_usage streaming behavior changed in both Chat Completions and the FIM beta: there is no longer a separate usage-only chunk before data: [DONE]. Token statistics now ride on the final content chunk, whose choices array holds exactly one element with no new content and a non-null finish_reason — a wire-shape change that can break stream parsers that keyed off the old empty-choices usage chunk. Separately, the dsh (DeepSeek Harness) developer-preview docs saw a major refresh: eight new pages, one deleted tutorial, a brand-new reference for DeepSeek's official LLM API wire extensions, and regenerated module/event/config catalogs.

  • include_usage reworked in api/create-chat-completion.md and api/create-completion.md (en + zh-cn): usage is null on every stream chunk except the last when set to true; omitted/false removes the field from all chunks except the last. No separate usage-only chunk is emitted anymore.
  • guides/thinking_mode.md (en + zh-cn): whether reasoning_content must be passed back and is concatenated into context now depends on the tools parameter — with tools it must be echoed back (else 400), without tools it is ignored.
  • dsh: new deepseek-llm-api-wire-extensions.md documents the dsh_plugin_packages and dsh_session_log request-body extensions, x-deepseek-harness-* headers, and the DeepSeekLlmApiExtensionRegistry registration model.
  • dsh: cookbook adding-a-conversation-node.md deleted; new subsystem pages cover conversation assembly, Web Client architecture + slots, webhook runtime, and a Todo subsystem; new guides cover GitHub-webhook review sessions, third-party MCP memory servers, and session-local scheduling, plus a dynamic-Cordis practice page.
  • dsh: config-catalog.md adds plugin sections (api-gateway, api-session-controller, api-settings-controller, experimental-inspector, plugin-package-inventory-deepseek, sdk-app, session-log-deepseek, session-log-export), and module-graph.md / event-producer-consumer.md were regenerated with new agent/* and api-session/* events. No npm version bump in this batch (dsh/npm.md unchanged); dsh-doc-standards skill renamed to dsh-doc.

@github-actions github-actions Bot changed the title docs: include_usage streaming behavior rewritten: usage rides on the last content chunk, no separate usage-only chunk docs: include_usage streaming behavior rewritten in Chat and FIM Completion APIs Aug 26, 2026
@github-actions
github-actions Bot force-pushed the docs/sync branch 2 times, most recently from 3670213 to 7772bb5 Compare August 26, 2026 20:06
@github-actions github-actions Bot changed the title docs: include_usage streaming behavior rewritten in Chat and FIM Completion APIs docs: include_usage streaming contract changed: no separate usage-only chunk; usage rides on the final content chunk Aug 26, 2026
@github-actions github-actions Bot changed the title docs: include_usage streaming contract changed: no separate usage-only chunk; usage rides on the final content chunk docs: streaming include_usage no longer emits a separate usage chunk (chat completions + FIM) Aug 27, 2026
…sh with new wire-extension reference

Two developer-facing changes landed in this fetch. For DeepSeek API consumers, the documented `include_usage` streaming behavior changed in both Chat Completions and the FIM beta: there is no longer a separate usage-only chunk before `data: [DONE]`. Token statistics now ride on the final content chunk, whose `choices` array holds exactly one element with no new content and a non-null `finish_reason` — a wire-shape change that can break stream parsers that keyed off the old empty-`choices` usage chunk. Separately, the dsh (DeepSeek Harness) developer-preview docs saw a major refresh: eight new pages, one deleted tutorial, a brand-new reference for DeepSeek's official LLM API wire extensions, and regenerated module/event/config catalogs.

- `include_usage` reworked in `api/create-chat-completion.md` and `api/create-completion.md` (en + zh-cn): usage is `null` on every stream chunk except the last when set to `true`; omitted/false removes the field from all chunks except the last. No separate usage-only chunk is emitted anymore.
- `guides/thinking_mode.md` (en + zh-cn): whether `reasoning_content` must be passed back and is concatenated into context now depends on the `tools` parameter — with `tools` it must be echoed back (else 400), without `tools` it is ignored.
- dsh: new `deepseek-llm-api-wire-extensions.md` documents the `dsh_plugin_packages` and `dsh_session_log` request-body extensions, `x-deepseek-harness-*` headers, and the `DeepSeekLlmApiExtensionRegistry` registration model.
- dsh: cookbook `adding-a-conversation-node.md` deleted; new subsystem pages cover conversation assembly, Web Client architecture + slots, webhook runtime, and a Todo subsystem; new guides cover GitHub-webhook review sessions, third-party MCP memory servers, and session-local scheduling, plus a dynamic-Cordis practice page.
- dsh: `config-catalog.md` adds plugin sections (`api-gateway`, `api-session-controller`, `api-settings-controller`, `experimental-inspector`, `plugin-package-inventory-deepseek`, `sdk-app`, `session-log-deepseek`, `session-log-export`), and `module-graph.md` / `event-producer-consumer.md` were regenerated with new `agent/*` and `api-session/*` events. No npm version bump in this batch (`dsh/npm.md` unchanged); `dsh-doc-standards` skill renamed to `dsh-doc`.
@github-actions github-actions Bot changed the title docs: streaming include_usage no longer emits a separate usage chunk (chat completions + FIM) docs: include_usage streaming semantics changed; dsh docs major refresh with new wire-extension reference Aug 27, 2026
@lroolle
lroolle merged commit 2e1187d into main Aug 28, 2026
@lroolle
lroolle deleted the docs/sync branch August 28, 2026 07:46
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