xref: /plugin/dokullm/doc/profiles.txt (revision 68020f72f4901f01b3fb3999d06b18933dbb178d)
1*68020f72SCostin Stroie====== Profiles ======
2*68020f72SCostin Stroie
3*68020f72SCostin StroieProfiles in DokuLLM allow you to organize and customize your AI interactions. Each profile can have its own set of actions, prompts, and configurations. By default, the plugin uses the [[.:default|default]] profile, but you can create and switch between multiple profiles as needed.
4*68020f72SCostin Stroie
5*68020f72SCostin Stroie===== Available Profiles =====
6*68020f72SCostin Stroie
7*68020f72SCostin StroieThe following profiles are currently available:
8*68020f72SCostin Stroie  * [[.:default|default]] - The standard profile with basic actions
9*68020f72SCostin Stroie  * //Add your custom profiles here//
10*68020f72SCostin Stroie
11*68020f72SCostin Stroie===== Creating a New Profile =====
12*68020f72SCostin Stroie
13*68020f72SCostin StroieTo create a new profile:
14*68020f72SCostin Stroie
15*68020f72SCostin Stroie  - Create a new page at ''dokullm:profiles:PROFILE_NAME'' (replace PROFILE_NAME with your desired profile name)
16*68020f72SCostin Stroie  - Add a table defining the actions available in this profile (see below for format)
17*68020f72SCostin Stroie  - Configure the plugin to use your new profile in the plugin settings
18*68020f72SCostin Stroie
19*68020f72SCostin Stroie===== Profile Action Table Format =====
20*68020f72SCostin Stroie
21*68020f72SCostin StroieEach profile page should contain a table defining the available actions. The table must have the following columns:
22*68020f72SCostin Stroie
23*68020f72SCostin Stroie^ ID ^ Label ^ Description ^ Icon ^ Result ^
24*68020f72SCostin Stroie| action_id | Button Text | Description of what the action does | icon_name | result_action_type |
25*68020f72SCostin Stroie
26*68020f72SCostin StroieColumn details:
27*68020f72SCostin Stroie  * **ID**: The action identifier, which corresponds to the prompt name
28*68020f72SCostin Stroie  * **Label**: The text displayed on the button
29*68020f72SCostin Stroie  * **Description**: A detailed description of the action, used as a tooltip
30*68020f72SCostin Stroie  * **Icon**: The icon displayed on the button (can be empty)
31*68020f72SCostin Stroie  * **Result**: The action to perform with the LLM result:
32*68020f72SCostin Stroie    * ''show'': Display the result in a modal dialog
33*68020f72SCostin Stroie    * ''append'': Add the result to the end of the current content
34*68020f72SCostin Stroie    * ''replace'': Replace the selected content with the result
35*68020f72SCostin Stroie    * ''insert'': Insert the result at the cursor position
36*68020f72SCostin Stroie
37*68020f72SCostin Stroie==== Example Profile Table ====
38*68020f72SCostin Stroie
39*68020f72SCostin StroieHere's an example of how to structure your profile action table:
40*68020f72SCostin Stroie
41*68020f72SCostin Stroie^ ID ^ Label ^ Description ^ Icon ^ Result ^
42*68020f72SCostin Stroie| summarize | Summarize | Create a summary of the selected text | file-icons:summary | show |
43*68020f72SCostin Stroie| expand | Expand | Expand the selected text with more details | file-icons:expand | replace |
44*68020f72SCostin Stroie| fix_grammar | Fix Grammar | Correct grammar and spelling errors | file-icons:spellcheck | replace |
45*68020f72SCostin Stroie
46*68020f72SCostin Stroie===== Using Profiles =====
47*68020f72SCostin Stroie
48*68020f72SCostin StroieTo use a specific profile:
49*68020f72SCostin Stroie  - Go to the plugin configuration page
50*68020f72SCostin Stroie  - Find the "Prompt Profile" setting
51*68020f72SCostin Stroie  - Enter the name of the profile you want to use
52*68020f72SCostin Stroie  - Save the configuration
53*68020f72SCostin Stroie
54*68020f72SCostin StroieThe selected profile will be used for all LLM interactions until you change it.
55*68020f72SCostin Stroie
56*68020f72SCostin Stroie===== Adding Custom User Prompts =====
57*68020f72SCostin Stroie
58*68020f72SCostin StroieEach action in your profile corresponds to a prompt page. To add a custom prompt:
59*68020f72SCostin Stroie  - Create a new page at ''dokullm:profiles:PROFILE_NAME:PROMPT_NAME'' (replace PROFILE_NAME with your new profile and PROMPT_NAME with your action ID)
60*68020f72SCostin Stroie  - Write your prompt in this page, using placeholders as needed:
61*68020f72SCostin Stroie    * ''{text}'' - The selected text from the editor or the entire text
62*68020f72SCostin Stroie    * ''{template}'' - The template associated with the request
63*68020f72SCostin Stroie    * The prompt will automatically be available through the action defined in your profile
64*68020f72SCostin Stroie
65*68020f72SCostin Stroie===== Metadata Support =====
66*68020f72SCostin Stroie
67*68020f72SCostin StroieDokuLLM supports metadata in your wiki pages, which can be used to provide additional context to the LLM (spaces inserted to prevent processing, remove them):
68*68020f72SCostin Stroie  * ''~ ~LLM_TEMPLATE:template_id~~'' - Specifies a template to use as context
69*68020f72SCostin Stroie  * ''~ ~LLM_EXAMPLES:example1,example2~~'' - Specifies example pages to use as context
70*68020f72SCostin Stroie  * ''~ ~LLM_PREVIOUS:previous_page~~'' - Specifies a previous document to use as context
71*68020f72SCostin Stroie
72*68020f72SCostin StroieThese metadata tags should be placed at the beginning of your wiki page.
73