File size: 1,652 Bytes
babeaf6 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 |
How to use character catalog
---
### Folder structure
```
character_catalog
├── ai_character_helper
│ ├── data
│ │ ├── background
│ │ ├── xxx.md
│ ├── system
│ └── user
├── loki
...
```
- Each folder is an AI character
- Just copy paste `ai_character_helper` folder and rename it to your character's name
- In `ai_character_helper` folder, there are two files and one folder
- system file
- the system prompt used to define the AI character
- user file
- the user template used for user input
- used to provide context for the AI character conversation
- /data folder
- used to pull relevant information during conversation
- automatically stored in memory vector database(Chroma) for fast retrieval
- supports following file types
- plain text file, i.e. `background`
- `.pdf`
- `.docx`
- `.pptx`
- `.png`
- `.csv`
- `.epub`
- `.md`
- `.mbox`
- `.ipynb`
### new Character PR template
- This PR added a new character `Reflection Pi`, Please use [PR#30](https://github.com/Shaunwei/RealChar/pull/30) as a template
### Character checklist
- [ ] think about the character and choose a character name
- [ ] copy paste `ai_character_helper` folder and rename it to your character's name
- [ ] update `system` file to define the character
- [ ] add `data` files to enhance the character's knowledge
- [ ] (optional) customize the character's voice
- [ ] (optional) customize the character's avatar
- [ ] (optional) update `user` file define custom user input
|