Example Dialogue Generation Context

Type: object

Prompt templates for generating example dialogue lines for a character based on their description.

root globalWritableContext
Type: object

This object can be written to by templates, and it is shared among all templates across the entire lifetime of the application. The Yozakura system never reads, writes, or replaces this object. It is entirely managed by templates. It does not persist between full application shutdowns. This can be used for passing information between templates, caching, or other suitable purposes.

Each additional property must conform to the following schema

root globalWritableContext additionalProperties
Type: object

root focusedCharacter
Type: object

The character who is in focus for this prompt (maybe they are the speaker, maybe they are having memories generated, etc. The exact meaning of "in focus" depends on the specific prompt template.).

 No Additional Properties

root focusedCharacter id
Type: string

Unique identifier for the character.
Example:

"char_123"

root focusedCharacter firstName
Type: string

The first name of the character.

Must be at least 1 characters long


Example:

"Alice"

root focusedCharacter lastName
Type: string

The last name of the character (can be an empty string if the character has no last name).
Example:

"Smith"

root focusedCharacter internalDescription
Type: string

A private internal description of the character's personality, background, traits, and inner life. This is typically used to help the model roleplay the character more consistently and with more depth, and is typically not directly known to other characters.
Example:

"Alice is a curious and adventurous soul with a love for exploring new places. She has a quick wit and a warm heart, always eager to help others. Alice grew up in a small town but dreams of traveling the world and experiencing different cultures."

root focusedCharacter externalDescription
Type: string

A public description of the character that is intended to be known by all other characters (even those who have not yet met this character). This can include appearance, social status, and other surface level attributes. This is optional and might be an empty string.
Example:

"Alice is known around town as a friendly, restless traveler with a warm smile and a habit of asking everyone about their latest adventure."

root focusedCharacter baseAppearanceTags
Type: string

Comma-separated list of tags describing the character's base appearance (without reference to clothing, accessories, etc). These tags are used for image generation and should be concise. This is optional and might be an empty string.
Example:

"brown hair, green eyes, tall, athletic build"

root focusedCharacter wardrobes
Type: array of object
No Additional Items

Each item of this array must be:

root focusedCharacter wardrobes wardrobes items
Type: object

Represents a single wardrobe entry for a character. A wardrobe is a set of clothing, accessories, or even poses and facial expressions. Unlike baseAppearanceTags, enabled wardrobes can change dynamically based on the character's state or actions.

 No Additional Properties

root focusedCharacter wardrobes wardrobes items text
Type: string

A comma-separated list of tags describing this wardrobe entry. These should be concise and focused on visual details relevant for automatic image generation.

Must be at least 1 characters long


Examples:

"red dress, elegant, evening wear"

"blue jeans, casual, modern"

root focusedCharacter wardrobes wardrobes items enabled
Type: boolean

Whether this wardrobe entry is currently enabled for the character. Enabled wardrobes are included in the character description for image generation and can influence the character's appearance in generated content.

root focusedCharacter wardrobes wardrobes items autoSelectGroup
Type: string

An optional identifier for grouping wardrobe entries. If multiple wardrobe entries share the same non-empty autoSelectGroup value, only one of them will be enabled at a time by the system (though the user can still enable multiple if they wish to). This is useful for mutually exclusive options like different outfits or facial expressions.

root focusedCharacter wardrobes wardrobes items autoRevert
Type: boolean

If true, changes to the enabled state of this wardrobe during a chat will be reverted after the chat ends. This is useful for temporary states like "surprised expression" that should be turned off again after the conversation.

root focusedCharacter globalMemories
Type: string

Important memories, beliefs, or goals that the character carries with them across all conversations (with all other characters). These memories are updated via LLM after each conversation. This may be an empty string if the character has not formed any memories yet.
Example:

"Alice's goal is to find her long-lost sibling. Alice recently met Evan at a coffee shop and they had a great conversation about travel."

root focusedCharacter locationId
Type: string

The ID of the world map location where the character is currently located.
Example:

"loc_123"

root focusedCharacter exampleDialogue
Type: string

Example dialogue for the character that can be used in system prompts to help ground the character's voice and manner of speaking. This should ideally be a snippet of dialogue in first person perspective, so the model can more easily mimic the style and content. May be an empty string.
Example:

"Alice: Hi I'm Alice!\nAlice: I love going on adventures and exploring new places.\nAlice: I have a pet cat named Whiskers who is very mischievous."

root focusedCharacter rollingConversationSummaries
Type: array of object

Brief summaries of past conversations involving this character, used to help the model keep track of important past events and relationships. A new conversation is added after every conversation the character is involved in, and only the most recent ten (by default) summaries are kept in this array.

 No Additional Items

Each item of this array must be:

root focusedCharacter rollingConversationSummaries rollingConversationSummaries items
Type: object
No Additional Properties

root focusedCharacter rollingConversationSummaries rollingConversationSummaries items summary
Type: string

A summary of a conversation from the perspective of the focus character. Typically 1-3 paragraphs long.
Example:

"Alice had a great conversation with Bob at the park. They talked about their favorite books and found out they both love science fiction. Alice learned that Bob is planning a trip to Japan next month."

root focusedCharacter rollingConversationSummaries rollingConversationSummaries items chatMedium
Type: enum (of string)

The medium of the chat, which can influence the style and content of the generated messages.

Must be one of:

  • "in_person"
  • "remote"

root focusedCharacter xmlTagSafeName
Type: string

An encoding of the first and last name that is syntactically valid in the name of an XML tag
Example:

"alice_smith"

root randomPersonalityTraits
Type: array of string

A short array of random personality traits that may be used as inputs for generating character information, to keep things interesting. Using these attributes is optional, there is no requirement for the prompt to respect these suggested attributes.

 No Additional Items

Each item of this array must be:

root randomPersonalityTraits randomPersonalityTraits items
Type: string

Examples:

[
    "friendly",
    "outgoing",
    "introverted",
    "adventurous",
    "cautious"
]

[
    "sarcastic",
    "witty",
    "serious",
    "playful",
    "stoic"
]