docs: fix Quick Start examples in Chat & Message API docs to match MemOSClient signatures - #1919
Merged
CarltonXiang merged 19 commits intoJul 8, 2026
Conversation
…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/.
Collaborator
|
Automated Test Results: NO EXECUTABLE SCOPE Cloud test-engine rerun against
Manual documentation/API example review is required before merge. |
## Description Please include a summary of the change, the problem it solves, the implementation approach, and relevant context. List any dependencies required for this change. Related Issue (Required): Fixes #issue_number ## Type of change Please delete options that are not relevant. - [ ] 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? Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration - [ ] Unit Test - [ ] Test Script Or Test Steps (please provide) - [ ] Pipeline Automated API Test (please provide) ## 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](https://github.com/MemTensor/MemOS-Docs) (if applicable) | 我已在 [MemOS-Docs](https://github.com/MemTensor/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
Translated an untranslated JSON `description` field in `docs/cn/open_source/modules/dream.md` from English to Chinese.
Collaborator
🤖 Open Code ReviewTarget: PR #1919 ✅ OpenCodeReview: No supported files changed. Generated by cloud-assistant via Open Code Review. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
#1742 (review)
Fix the Chat and Message API reference docs where Quick Start code examples used parameters not present in the actual
MemOSClient(seesrc/memos/api/client.py):readable_cube_ids/writable_cube_ids/modewithconversation_id/knowledgebase_idsto matchclient.chat()signaturehistory/writable_cube_ids/retrieved_memory_ids/corrected_answerwithconversation_idto matchclient.add_feedback()MemOSClient.get_suggestions()(method does not exist) with rawrequests.post()call; removed duplicate H1 headingChinese 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
How Has This Been Tested?
Verified that:
src/memos/api/client.pymethod signaturesChecklist
Reviewer Checklist