Comment out example configurations

This commit is contained in:
Thorsten Sommer 2026-01-31 20:50:44 +01:00
parent f6091be1b0
commit 61cf77a463
Signed by untrusted user who does not match committer: tsommer
GPG Key ID: 371BBA77A02C0108

View File

@ -49,26 +49,26 @@ CONFIG = {}
CONFIG["LLM_PROVIDERS"] = {} CONFIG["LLM_PROVIDERS"] = {}
-- An example of a configuration for a self-hosted server: -- An example of a configuration for a self-hosted server:
CONFIG["LLM_PROVIDERS"][#CONFIG["LLM_PROVIDERS"]+1] = { -- CONFIG["LLM_PROVIDERS"][#CONFIG["LLM_PROVIDERS"]+1] = {
["Id"] = "00000000-0000-0000-0000-000000000000", -- ["Id"] = "00000000-0000-0000-0000-000000000000",
["InstanceName"] = "<user-friendly name for the combination of server and model>", -- ["InstanceName"] = "<user-friendly name for the combination of server and model>",
["UsedLLMProvider"] = "SELF_HOSTED", -- ["UsedLLMProvider"] = "SELF_HOSTED",
--
-- Allowed values for Host are: LM_STUDIO, LLAMACPP, OLLAMA, and VLLM -- -- Allowed values for Host are: LM_STUDIO, LLAMACPP, OLLAMA, and VLLM
["Host"] = "OLLAMA", -- ["Host"] = "OLLAMA",
["Hostname"] = "<https address of the server>", -- ["Hostname"] = "<https address of the server>",
--
-- Optional: Additional parameters for the API. -- -- Optional: Additional parameters for the API.
-- Please refer to the documentation of the selected host for details. -- -- Please refer to the documentation of the selected host for details.
-- Might be something like ... \"temperature\": 0.5 ... for one parameter. -- -- Might be something like ... \"temperature\": 0.5 ... for one parameter.
-- Could be something like ... \"temperature\": 0.5, \"max_tokens\": 1000 ... for multiple parameters. -- -- Could be something like ... \"temperature\": 0.5, \"max_tokens\": 1000 ... for multiple parameters.
-- Please do not add the enclosing curly braces {} here. Also, no trailing comma is allowed. -- -- Please do not add the enclosing curly braces {} here. Also, no trailing comma is allowed.
["AdditionalJsonApiParameters"] = "", -- ["AdditionalJsonApiParameters"] = "",
["Model"] = { -- ["Model"] = {
["Id"] = "<the model ID>", -- ["Id"] = "<the model ID>",
["DisplayName"] = "<user-friendly name of the model>", -- ["DisplayName"] = "<user-friendly name of the model>",
} -- }
} -- }
-- Transcription providers for voice-to-text functionality: -- Transcription providers for voice-to-text functionality:
CONFIG["TRANSCRIPTION_PROVIDERS"] = {} CONFIG["TRANSCRIPTION_PROVIDERS"] = {}
@ -167,52 +167,53 @@ CONFIG["SETTINGS"] = {}
CONFIG["CHAT_TEMPLATES"] = {} CONFIG["CHAT_TEMPLATES"] = {}
-- A simple example chat template: -- A simple example chat template:
CONFIG["CHAT_TEMPLATES"][#CONFIG["CHAT_TEMPLATES"]+1] = { -- CONFIG["CHAT_TEMPLATES"][#CONFIG["CHAT_TEMPLATES"]+1] = {
["Id"] = "00000000-0000-0000-0000-000000000000", -- ["Id"] = "00000000-0000-0000-0000-000000000000",
["Name"] = "<user-friendly name of the chat template>", -- ["Name"] = "<user-friendly name of the chat template>",
["SystemPrompt"] = "You are <Company Name>'s helpful AI assistant for <Department Name>. Your task is ...", -- ["SystemPrompt"] = "You are <Company Name>'s helpful AI assistant for <Department Name>. Your task is ...",
["PredefinedUserPrompt"] = "Please help me with ...", -- ["PredefinedUserPrompt"] = "Please help me with ...",
["AllowProfileUsage"] = true, -- ["AllowProfileUsage"] = true,
["ExampleConversation"] = { -- ["ExampleConversation"] = {
{ -- {
-- Allowed values are: USER, AI, SYSTEM -- -- Allowed values are: USER, AI, SYSTEM
["Role"] = "USER", -- ["Role"] = "USER",
["Content"] = "Hello! Can you help me with a quick task?" -- ["Content"] = "Hello! Can you help me with a quick task?"
}, -- },
{ -- {
-- Allowed values are: USER, AI, SYSTEM -- -- Allowed values are: USER, AI, SYSTEM
["Role"] = "AI", -- ["Role"] = "AI",
["Content"] = "Of course. What do you need?" -- ["Content"] = "Of course. What do you need?"
} -- }
} -- }
} -- }
-- An example chat template with file attachments: -- An example chat template with file attachments:
-- This template automatically attaches specified files when the user selects it. -- This template automatically attaches specified files when the user selects it.
CONFIG["CHAT_TEMPLATES"][#CONFIG["CHAT_TEMPLATES"]+1] = { -- CONFIG["CHAT_TEMPLATES"][#CONFIG["CHAT_TEMPLATES"]+1] = {
["Id"] = "00000000-0000-0000-0000-000000000001", -- ["Id"] = "00000000-0000-0000-0000-000000000001",
["Name"] = "Document Analysis Template", -- ["Name"] = "Document Analysis Template",
["SystemPrompt"] = "You are an expert document analyst. Please analyze the attached documents and provide insights.", -- ["SystemPrompt"] = "You are an expert document analyst. Please analyze the attached documents and provide insights.",
["PredefinedUserPrompt"] = "Please analyze the attached company guidelines and summarize the key points.", -- ["PredefinedUserPrompt"] = "Please analyze the attached company guidelines and summarize the key points.",
["AllowProfileUsage"] = true, -- ["AllowProfileUsage"] = true,
-- Optional: Pre-attach files that will be automatically included when using this template. -- -- Optional: Pre-attach files that will be automatically included when using this template.
-- These files will be loaded when the user selects this chat template. -- -- These files will be loaded when the user selects this chat template.
-- Note: File paths must be absolute paths and accessible to all users. -- -- Note: File paths must be absolute paths and accessible to all users.
["FileAttachments"] = { -- ["FileAttachments"] = {
"G:\\Company\\Documents\\Guidelines.pdf", -- "G:\\Company\\Documents\\Guidelines.pdf",
"G:\\Company\\Documents\\CompanyPolicies.docx" -- "G:\\Company\\Documents\\CompanyPolicies.docx"
}, -- },
["ExampleConversation"] = { -- ["ExampleConversation"] = {
{ -- {
["Role"] = "USER", -- ["Role"] = "USER",
["Content"] = "I have attached the company documents for analysis." -- ["Content"] = "I have attached the company documents for analysis."
}, -- },
{ -- {
["Role"] = "AI", -- ["Role"] = "AI",
["Content"] = "Thank you. I'll analyze the documents and provide a comprehensive summary." -- ["Content"] = "Thank you. I'll analyze the documents and provide a comprehensive summary."
} -- }
} -- }
} -- }
-- Document analysis policies for this configuration: -- Document analysis policies for this configuration:
CONFIG["DOCUMENT_ANALYSIS_POLICIES"] = {} CONFIG["DOCUMENT_ANALYSIS_POLICIES"] = {}
@ -247,9 +248,9 @@ CONFIG["DOCUMENT_ANALYSIS_POLICIES"] = {}
CONFIG["PROFILES"] = {} CONFIG["PROFILES"] = {}
-- A simple profile template: -- A simple profile template:
CONFIG["PROFILES"][#CONFIG["PROFILES"]+1] = { -- CONFIG["PROFILES"][#CONFIG["PROFILES"]+1] = {
["Id"] = "00000000-0000-0000-0000-000000000000", -- ["Id"] = "00000000-0000-0000-0000-000000000000",
["Name"] = "<user-friendly name of the profile>", -- ["Name"] = "<user-friendly name of the profile>",
["NeedToKnow"] = "I like to cook in my free time. My favorite meal is ...", -- ["NeedToKnow"] = "I like to cook in my free time. My favorite meal is ...",
["Actions"] = "Please always ensure the portion size is ..." -- ["Actions"] = "Please always ensure the portion size is ..."
} -- }