diff --git a/docs/Installation.md b/docs/Installation.md index 6c327120..d31ebb71 100644 --- a/docs/Installation.md +++ b/docs/Installation.md @@ -1,6 +1,6 @@ # Installing MemoryScope -## I. Install with docker [Recommanded] +## I. Install with docker [Recommended] 1. Clone the repository and edit settings ```bash # clone project @@ -22,7 +22,7 @@ ``` -## II. Install with docker compose [Recommanded] +## II. Install with docker compose [Recommended] 1. Clone the repository and edit settings diff --git a/examples/api/chat_example.py b/examples/api/chat_example.py index 43b1bf3d..fc4d4e99 100644 --- a/examples/api/chat_example.py +++ b/examples/api/chat_example.py @@ -75,7 +75,7 @@ def chat_example5(): def chat_example6(): with MemoryScope(arguments=arguments) as ms: memory_chat = ms.default_memory_chat - memory_chat.run_service_operation("delete_all", "锦鲤") + memory_chat.run_service_operation("delete_all", "用户") memory_chat.run_service_operation("delete_all", "浩然") print("浩然=========================") @@ -88,12 +88,12 @@ def chat_example6(): print("回答2:\n" + response.message.content) print("记忆2:\n" + response.meta_data["memories"]) - print("锦鲤=========================") - response = memory_chat.chat_with_memory(query="我的爱好是打羽毛球。", role_name="锦鲤") + print("用户=========================") + response = memory_chat.chat_with_memory(query="我的爱好是打羽毛球。", role_name="用户") print("回答1:\n" + response.message.content) - result = memory_chat.run_service_operation("consolidate_memory", role_name="锦鲤") + result = memory_chat.run_service_operation("consolidate_memory", role_name="用户") print(result) - response = memory_chat.chat_with_memory(query="你知道我的运动爱好是什么?", role_name="锦鲤", + response = memory_chat.chat_with_memory(query="你知道我的运动爱好是什么?", role_name="用户", history_message_strategy=None) print("回答2:\n" + response.message.content) print("记忆2:\n" + response.meta_data["memories"]) diff --git a/examples/cli/README.md b/examples/cli/README.md index dd3772cc..3075bf9f 100644 --- a/examples/cli/README.md +++ b/examples/cli/README.md @@ -18,13 +18,13 @@ Alternatively, you can specify all the parameters directly on the command line: ```bash memoryscope --language="cn" \ --memory_chat_class="cli_memory_chat" \ - --human_name="锦鲤" \ + --human_name="用户" \ --assistant_name="AI" \ --generation_backend="dashscope_generation" \ --generation_model="qwen-max" \ --embedding_backend="dashscope_embedding" \ --embedding_model="text-embedding-v2" \ - --use_dummy_ranker=False \ + --enable_ranker=False \ --rank_backend="dashscope_rank" \ --rank_model="gte-rerank" ``` @@ -39,6 +39,6 @@ Here are the available options that can be set through either method: - `--generation_model`: The model used for generating responses. - `--embedding_backend`: The backend used for text embeddings. - `--embedding_model`: The model used for creating text embeddings. -- `--use_dummy_ranker`: A boolean indicating whether to use a dummy ranker (default is `False`). +- `--enable_ranker`: A boolean indicating whether to use a dummy ranker (default is `False`). - `--rank_backend`: The backend used for ranking responses. - `--rank_model`: The model used for ranking responses.