mirrors/TiddlyWiki5
1
0
Fork 0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2025-04-06 02:37:14 +00:00
Code Issues Releases Wiki Activity

Add documentation for the conversation format

Browse Source
This commit is contained in:
Jeremy Ruston 2024-07-28 12:52:43 +01:00
parent a32a1a3802
commit 58f96e779a
1 changed files with 26 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
plugins/tiddlywiki/ai-tools/docs.tid
View File

@ -25,3 +25,29 @@ See the ''settings'' tab for set up instructions.
# See the imported conversations listed in the ''tools'' tab
# The imported tiddler `conversations.json` is no longer required and can be deleted
!! Conversation Format
This plugin defines a simple schema for representing conversations with an LLM.
In a nutshell, tiddlers tagged <<tag $:/tags/AI/Conversation>> define conversations. The individual messages are tiddlers that are tagged with the title of the conversation tiddler.
Currently, the ordering of the messages is determined by the value of their "created" field. The ordering defined by the tag mechanism is ignored. It is intended to change this behaviour so that the ordering of messages is defined by the tag mechanism.
The fields with defined meanings for conversation tiddlers are:
|!Field |!Description |
|''system-prompt'' |Defines the system prompt for the conversation |
|''tags'' |Must include <<tag $:/tags/AI/Conversation>> |
|''text'' |Optional description or notes displayed at the top of the conversation |
|''current-response-image'' |Optional title of an image tiddler to be attached to the current user response |
|''current-response-text'' |Text of the current user response before it is sent |
The fields with defined meanings for conversation tiddlers are:
|!Field |!Description |
|''created'' |Creation date of the message (currently used for ordering) |
|''image'' |Optional image associated with this message |
|''role'' |Possible values include ''user'' and ''assistant'' |
|''tags'' |Must include the title of the parent conversation |
|''type'' |Typically ''text/markdown'' |