Skip to content

docs: fix Quick Start examples in Chat & Message API docs to match MemOSClient signatures#1919

Open
hiasky wants to merge 2 commits into
MemTensor:mainfrom
hiasky:fix/docs-sdk-example-alignment
Open

docs: fix Quick Start examples in Chat & Message API docs to match MemOSClient signatures#1919
hiasky wants to merge 2 commits into
MemTensor:mainfrom
hiasky:fix/docs-sdk-example-alignment

Conversation

@hiasky

@hiasky hiasky commented Jun 14, 2026

Copy link
Copy Markdown
Contributor

Description

#1742 (review)
Fix the Chat and Message API reference docs where Quick Start code examples used parameters not present in the actual MemOSClient (see src/memos/api/client.py):

  • chat/chat.md: replaced readable_cube_ids/writable_cube_ids/mode with conversation_id/knowledgebase_ids to match client.chat() signature
  • feedback.md: replaced history/writable_cube_ids/retrieved_memory_ids/corrected_answer with conversation_id to match client.add_feedback()
  • get_suggestion_queries.md: replaced MemOSClient.get_suggestions() (method does not exist) with raw requests.post() call; removed duplicate H1 heading
  • feedback.md: fixed comment mismatch (said "occupation" but example was about diet)

Chinese source (docs/cn/) and English translation (docs/en/) aligned to stay in sync.

Also added English translations for Chat & Message API reference (inherited from previous PR, now synced with the corrected examples).

Related Issue (Required): Fixes #

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Refactor (does not change functionality, e.g. code style improvements, linting)
  • Documentation update

How Has This Been Tested?

  • Unit Test
  • Test Script Or Test Steps (please provide)
  • Pipeline Automated API Test (please provide)

Verified that:

  1. All examples use parameters matching src/memos/api/client.py method signatures
  2. Chinese and English files share identical API paths, parameter tables, and code blocks
  3. Markdown renders correctly

Checklist

  • I have performed a self-review of my own code | 我已自行检查了自己的代码
  • I have commented my code in hard-to-understand areas | 我已在难以理解的地方对代码进行了注释
  • I have added tests that prove my fix is effective or that my feature works | 我已添加测试以证明我的修复有效或功能正常
  • I have created related documentation issue/PR in MemOS-Docs (if applicable) | 我已在 MemOS-Docs 中创建了相关的文档 issue/PR(如果适用)
  • I have linked the issue to this PR (if applicable) | 我已将 issue 链接到此 PR(如果适用)
  • I have mentioned the person who will review this PR | 我已提及将审查此 PR 的人

Reviewer Checklist

  • closes #xxxx (Replace xxxx with the GitHub issue number)
  • Made sure Checks passed
  • Tests have been provided

…EN translations

Fix the Chat and Message API reference docs where Quick Start code
examples used parameters not present in the actual MemOSClient:

- chat/chat.md: replace readable_cube_ids/writable_cube_ids/mode with
  conversation_id/knowledgebase_ids to match client.chat() signature
- message/feedback.md: replace history/writable_cube_ids/retrieved_memory_ids/
  corrected_answer with conversation_id to match client.add_feedback()
- message/get_suggestion_queries.md: replace MemOSClient.get_suggestions()
  (method does not exist) with raw HTTP POST request; remove duplicate H1 heading

Also add English translations for all four files under docs/en/.
@Memtensor-AI Memtensor-AI changed the base branch from dev-20260604-v2.0.19 to dev-v2.0.22 July 1, 2026 13:15
@Memtensor-AI

Copy link
Copy Markdown
Collaborator

Automated Test Results: NO EXECUTABLE SCOPE

Cloud test-engine rerun against dev-v2.0.22 completed after migrating this run from the old 10010 queue, but no automated test scope applies to this PR.

  • Run: tr-f25fb792-af7 on cloud test-engine 10011
  • Changed paths: API documentation under docs/cn/** and docs/en/**
  • Result: automated tests were not run because this is a documentation-only path with no executable scope mapping.

Manual documentation/API example review is required before merge.

@CarltonXiang CarltonXiang deleted the branch MemTensor:main July 3, 2026 07:25
@syzsunshine219 syzsunshine219 reopened this Jul 3, 2026
@syzsunshine219 syzsunshine219 changed the base branch from dev-v2.0.22 to main July 3, 2026 08:21
@syzsunshine219 syzsunshine219 added the needs-audit Requires manual audit before merge label Jul 3, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

needs-audit Requires manual audit before merge

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants