character_catalog
βββ character
β βββ data
β β βββ background.txt
β β βββ messages.csv
β β βββ xxx.md
β βββ config.yaml
βββ ...
-
Each
character
folder is an AI character -
Rename the
character
folder to your character's name -
config.yaml
fileMust Have:
character_id
: the unique identifier for the charactercharacter_name
: your character's namesystem
: the system prompt used to define the AI characteruser
: the user prompt template used to organize user input and provide context for the conversation
Optional:
text_to_speech_use
: the text to speech engine used to generate the character's voicevoice_id
: the voice used by the selected text-to-speech engineorder
: display order on the websiterebyte_api_project_id
: the Project ID if using characters on ReByte.airebyte_api_agent_id
: the Agent ID if using characters on ReByte.ai
-
data
folder- Can be the character's background information, biography, conversation history, etc.
- Information will be pulled from these documents during conversation
- Automatically converted into vector database (knowledge base) for fast retrieval
- supports plain text, markdown, csv, pdf, docx, pptx, png, epub, mbox, ipynb
- think about the character and choose a character name
- duplicate a
character
folder and rename it to your character's name - update your character name and id in
config.yaml
- update the system prompt in
config.yaml
to define the character - add documents to
data
to enhance the character's knowledge - (optional) customize the character's voice
- (optional) customize the character's avatar
- (optional) customize the user prompt in
config.yaml
file for advanced context control (in general you don't need to)