Skip to content

docs(api): document keep_recent_count param on commit() (#2284) #2315

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
r266-tech wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs(api): document keep_recent_count param on commit() (#2284) #2315

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
761fbfe
docs(api): document keep_recent_count param on commit() (#2284)
r266-tech May 29, 2026
812ed6a
docs(api): 文档化 commit() 的 keep_recent_count 参数 (#2284)
r266-tech May 29, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/en/api/05-sessions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -908,6 +908,7 @@ Commit a session. Message archiving (Phase 1) completes immediately. Summary gen
| Parameter | Type | Required | Default | Description |
|-----------|------|----------|---------|-------------|
| session_id | str | Yes | - | Session ID to commit |
| keep_recent_count | int | No | 0 | Number of recent live messages to retain (kept live, not archived) after commit. `0` (default) archives all messages. |

#### 3. Usage Examples

Expand Down
1 change: 1 addition & 0 deletions docs/zh/api/05-sessions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -908,6 +908,7 @@ await client.session_used(
| 参数 | 类型 | 必填 | 默认值 | 说明 |
|------|------|------|--------|------|
| session_id | str | 是 | - | 要提交的会话 ID |
| keep_recent_count | int | 否 | 0 | 提交后保留为 live 状态的最近消息数 (保持 live, 不归档)。`0` (默认) 归档全部消息。 |

#### 3. 使用示例

Expand Down