docs: fix Quick Start examples in Chat & Message API docs to match MemOSClient signatures#1919
Open
hiasky wants to merge 1 commit into
Open
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/.
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
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