Skip to content

Commit 637a8e7

Browse files
committed
docs: add bad case
1 parent 8cc04dd commit 637a8e7

File tree

4 files changed

+23
-4
lines changed

4 files changed

+23
-4
lines changed

docs/site/docs.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@
4949
{
5050
"group": "Practices",
5151
"pages": [
52+
"practices/bad",
5253
"practices/tips",
5354
"practices/openai"
5455
]

docs/site/features/profile/profile_filter.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Filter Profile
2+
title: Filter Profile when Retrieving
33
---
44
For each user, Memobase will track and model the profile.
55
You can use them in your [AI prompt](/features/context) to offer a global understanding of the user.

docs/site/practices/bad.mdx

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
title: How to Fix Bad Cases
3+
---
4+
5+
## Too many useless profile memories
6+
1. Make sure you have the idea of what a profile should have.
7+
2. [Configure](/features/profile/profile_desc) your `config.yaml` properly with profile slots' description.
8+
3. If you still have too many useless profile memories, you can enable [strict mode](/features/profile/profile_config#strict-mode)
9+
to only collect the profiles you want.
10+
11+
## Some profiles should be extracted, but it's not.
12+
1. Maybe your profile description is too hard for LLM to understand/infer, try to lower your requirements.
13+
2. If you still have this issue, you can disable the [profile validation](/features/profile/profile_config#profile-validate-mode)
14+
15+
## My profile is inaccurate/wrong.
16+
1. Add more details to your [profile description](/features/profile/profile_desc), making sure the profile description is clear and easy to understand.
17+
2. Add [update descrption](/features/profile/profile_desc#instruct-memobase-to-update-a-profile-slot) for that profile also, it will help Memobase to merge the profile wisely.
18+

docs/site/practices/tips.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,14 @@ In simple terms, Memobase can provide user profile memory for your users. You ca
1111
description: "Track the gaming preferences/achievements of the user."
1212
sub_topics:
1313
- name: "FPS"
14-
description: "Games like CSGO, Valorant, etc."
1514
- name: "LOL"
1615
...
1716
- topic: "Whatever"
1817
sub_topics:
1918
...
2019
```
2120
Memobase will generate user profile preferences based on your configuration.
22-
Refer to [Customization](/features/customization/profile) for more details.
21+
Refer to [Customization](/features/profile) for more details.
2322
2423
## How to Integrate Memory?
2524
@@ -40,7 +39,8 @@ Normally, you should call `flush` API right after a chat session is closed.
4039

4140
## User System Management
4241

43-
Users in Memobase do not need to correspond one-to-one with your actual users. One of your actual users can correspond to multiple Memobase users if a user in your application has multiple segmented memories:
42+
Users in Memobase do not need to correspond one-to-one with your actual users.
43+
One of your actual users can correspond to multiple Memobase users if a user in your application has multiple segmented memories:
4444

4545
- AI Role-Playing: Each agent should have independent memory for the user, so one user might have dozens of corresponding Memobase users for the various role agents they have interacted with.
4646
- AI Companionship + AI Education: You might provide a unified agent for the user, in which case your user can correspond one-to-one with Memobase.

0 commit comments

Comments
 (0)