From 58f96e779a34fb72b995ddbb335c3792a491366e Mon Sep 17 00:00:00 2001 From: Jeremy Ruston Date: Sun, 28 Jul 2024 12:52:43 +0100 Subject: [PATCH] Add documentation for the conversation format --- plugins/tiddlywiki/ai-tools/docs.tid | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/plugins/tiddlywiki/ai-tools/docs.tid b/plugins/tiddlywiki/ai-tools/docs.tid index 3f3e3bbcf..a000cf905 100644 --- a/plugins/tiddlywiki/ai-tools/docs.tid +++ b/plugins/tiddlywiki/ai-tools/docs.tid @@ -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 <> 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 <> | +|''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'' | +