Documentation

This page will explain how to create bots on our platform in an effective manner.

Here’s a temporary documentation of information you can use as we put together our own documentation.

Getting your bot to use user's name

Use the tag {{user}} in your bot greeting message.

Description Section:

This section is used for a quick description to users so they know what your bot is about. The AI does not use this information in any way.

Example: "I am a friendly assistant here to help with your tech support needs!"

Greeting Section:

This is what your bot will begin the conversation with. A good greeting should be welcoming and personalized.

Example: "Hello, {{user}}! How can I assist you today?"

Scenario Section:

This section should include the scenario or any additional context that the bot should remember. This could be a current conversation theme or information to personalize the interaction.

Example: "You are a helpful assistant in a library." This will inform the bot about its role in the conversation.

Persona Section:

Describe your bot's personality, using the W++ format if desired. This will define how the bot reacts and interacts with users based on its character traits.

Example: "Bot Personality: Friendly, Patient, Enthusiastic. Always eager to help and encourage users."

Persona helps shape the tone of the responses, e.g., is your bot sarcastic, cheerful, or formal?

Example Dialogue

Here is an example of how a conversation might look between the user and the assistant. This will help you understand how the bot's greeting, context, and persona work together to create a natural dialogue.

Assistant: "Hello, {{user}}! How can I assist you today?"
User: "Can you help me with my homework?"
Assistant: "Of course! What subject are you working on?"
User: "I'm working on my math assignment."
Assistant: "Great! What’s the question you’re stuck on?"


In this example, the bot follows a friendly and helpful tone, acknowledging the user's request and then diving into the specifics of the task. Notice how the bot’s responses are aligned with its persona (Friendly, Patient, Enthusiastic) and the context (helping with homework).

Tip: Ensure your dialogue maintains natural flow by varying the responses, asking open-ended questions, and addressing user needs directly.

Temperature (0.2 to 1.2)

How predictable or unpredictable message responses from the bot are. A higher temperature is generally more creative.

nethraliq (Recommended)

Our recommended model, optimized for better efficiency.

Thespis Mistral 7B

Another good model for roleplay, typically playful.

Thespis 13B (Selective, Unavailable)

A larger model, available during select times due to resource limitations.

Dolphin 3B

A lightweight storytelling model that can be hosted by anyone. Currently the results are subpar.

[3rd Party]

Means a model is hosted by a user within the community, though we do our best, you should especially avoid sending personal information while using these APIs.

Need Help?

If you encounter issues, feel free to reach out at [email protected].