Skip to content

docs(telemetry): list session create/add_message endpoints + SDK methods (#1943)#1958

Merged
qin-ctx merged 2 commits into
volcengine:mainfrom
r266-tech:docs-telemetry-sessions-create-add-message-1943
May 11, 2026
Merged

docs(telemetry): list session create/add_message endpoints + SDK methods (#1943)#1958
qin-ctx merged 2 commits into
volcengine:mainfrom
r266-tech:docs-telemetry-sessions-create-add-message-1943

Conversation

@r266-tech
Copy link
Copy Markdown
Contributor

Source: #1943 (zhoujh01 merger / MDNDDD author 2026-05-09T10:12Z) feat(server): add operation telemetry for session create/add_message/commit APIs wraps session.create, session.add_message, and session.commit HTTP handlers with run_operation so callers can opt in via TelemetryRequest. The "Supported operations" lists in the operation-telemetry guide were not updated to surface the new endpoints / SDK methods.

This PR mirrors the new surface bytewise into both EN and ZH guides:

HTTP API list — added two endpoints alongside the existing commit:

  • POST /api/v1/sessions
  • POST /api/v1/sessions/{session_id}/messages

(verified at openviking/server/routers/sessions.py lines 72/92 telemetry: TelemetryRequest = False on CreateSessionRequest/AddMessageRequest, lines 114/290 @router.post("") and @router.post("/{session_id}/messages"))

Python SDK list — added two top-level methods alongside the existing commit_session(...):

  • create_session(...)
  • add_message(...)

(verified at openviking/async_client.py lines 131/170 + openviking/sync_client.py lines 42/75; both accept telemetry: TelemetryRequest = False)

Session.commit(...) (instance method on the Session class) is already listed; Session.add_message() at openviking/client/session.py:38 does not accept a telemetry kwarg and just delegates to client.add_message(...) without it, so it is intentionally not added to the SDK list to avoid misleading users into a non-functional opt-in path on the Session helper.

8 LOC additive (4 EN + 4 ZH bullets), no other content touched.

@github-actions
Copy link
Copy Markdown

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

🎫 Ticket compliance analysis ✅

1943 - Fully compliant

Compliant requirements:

  • Updated both EN and ZH guides
  • Added new HTTP endpoints
  • Added new Python SDK methods
⏱️ 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 7c69819 into volcengine:main May 11, 2026
3 checks passed
@github-project-automation github-project-automation Bot moved this from Backlog to Done in OpenViking project May 11, 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