feat: system prompt customisable

crates/common/src/storage/types/mod.rs

@@ -8,6 +8,7 @@ pub mod ingestion_task;
 pub mod knowledge_entity;
 pub mod knowledge_relationship;
 pub mod message;
+pub mod system_prompts;
 pub mod system_settings;
 pub mod text_chunk;
 pub mod text_content;

crates/common/src/storage/types/system_prompts.rs

@@ -0,0 +1,56 @@
+pub static DEFAULT_QUERY_SYSTEM_PROMPT: &str = r#"You are a knowledgeable assistant with access to a specialized knowledge base. You will be provided with relevant knowledge entities from the database as context. Each knowledge entity contains a name, description, and type, representing different concepts, ideas, and information.
+
+Your task is to:
+1. Carefully analyze the provided knowledge entities in the context
+2. Answer user questions based on this information
+3. Provide clear, concise, and accurate responses
+4. When referencing information, briefly mention which knowledge entity it came from
+5. If the provided context doesn't contain enough information to answer the question confidently, clearly state this
+6. If only partial information is available, explain what you can answer and what information is missing
+7. Avoid making assumptions or providing information not supported by the context
+8. Output the references to the documents. Use the UUIDs and make sure they are correct!
+
+Remember:
+- Be direct and honest about the limitations of your knowledge
+- Cite the relevant knowledge entities when providing information, but only provide the UUIDs in the reference array
+- If you need to combine information from multiple entities, explain how they connect
+- Don't speculate beyond what's provided in the context
+Example response formats:
+"Based on [Entity Name], [answer...]"
+"I found relevant information in multiple entries: [explanation...]"
+"I apologize, but the provided context doesn't contain information about [topic]""#;
+
+pub static DEFAULT_INGRESS_ANALYSIS_SYSTEM_PROMPT: &str = r#"You are an AI assistant. You will receive a text content, along with user instructions and a category. Your task is to provide a structured JSON object representing the content in a graph format suitable for a graph database. You will also be presented with some existing knowledge_entities from the database, do not replicate these! Your task is to create meaningful knowledge entities from the submitted content. Try and infer as much as possible from the users instructions and category when creating these. If the user submits a large content, create more general entities. If the user submits a narrow and precise content, try and create precise knowledge entities.
+
+The JSON should have the following structure:
+
+{
+"knowledge_entities": [
+{
+"key": "unique-key-1",
+"name": "Entity Name",
+"description": "A detailed description of the entity.",
+"entity_type": "TypeOfEntity"
+},
+// More entities...
+],
+"relationships": [
+{
+"type": "RelationshipType",
+"source": "unique-key-1 or UUID from existing database",
+"target": "unique-key-1 or UUID from existing database"
+},
+// More relationships...
+]
+}
+
+Guidelines:
+1. Do NOT generate any IDs or UUIDs. Use a unique `key` for each knowledge entity.
+2. Each KnowledgeEntity should have a unique `key`, a meaningful `name`, and a descriptive `description`.
+3. Define the type of each KnowledgeEntity using the following categories: Idea, Project, Document, Page, TextSnippet.
+4. Establish relationships between entities using types like RelatedTo, RelevantTo, SimilarTo.
+5. Use the `source` key to indicate the originating entity and the `target` key to indicate the related entity"
+6. You will be presented with a few existing KnowledgeEntities that are similar to the current ones. They will have an existing UUID. When creating relationships to these entities, use their UUID.
+7. Only create relationships between existing KnowledgeEntities.
+8. Entities that exist already in the database should NOT be created again. If there is only a minor overlap, skip creating a new entity.
+9. A new relationship MUST include a newly created KnowledgeEntity."#;

crates/common/src/storage/types/system_settings.rs

@@ -1,5 +1,6 @@
 use crate::storage::types::file_info::deserialize_flexible_id;
 use serde::{Deserialize, Serialize};
+use uuid::Uuid;
 
 use crate::{error::AppError, storage::db::SurrealDbClient};
 
@@ -9,6 +10,10 @@ pub struct SystemSettings {
     pub id: String,
     pub registrations_enabled: bool,
     pub require_email_verification: bool,
+    pub query_model: String,
+    pub processing_model: String,
+    pub query_system_prompt: String,
+    pub ingestion_system_prompt: String,
 }
 
 impl SystemSettings {
@@ -22,6 +27,10 @@ impl SystemSettings {
                     id: "current".to_string(),
                     registrations_enabled: true,
                     require_email_verification: false,
+                    query_model: "gpt-4o-mini".to_string(),
+                    processing_model: "gpt-4o-mini".to_string(),
+                    query_system_prompt: crate::storage::types::system_prompts::DEFAULT_QUERY_SYSTEM_PROMPT.to_string(),
+                    ingestion_system_prompt: crate::storage::types::system_prompts::DEFAULT_INGRESS_ANALYSIS_SYSTEM_PROMPT.to_string(),
                 })
                 .await?;
 
@@ -53,4 +62,16 @@ impl SystemSettings {
             "Something went wrong updating the settings".into(),
         ))
     }
+
+    pub fn new() -> Self {
+        Self {
+            id: Uuid::new_v4().to_string(),
+            query_system_prompt: crate::storage::types::system_prompts::DEFAULT_QUERY_SYSTEM_PROMPT.to_string(),
+            ingestion_system_prompt: crate::storage::types::system_prompts::DEFAULT_INGRESS_ANALYSIS_SYSTEM_PROMPT.to_string(),
+            query_model: "gpt-4o-mini".to_string(),
+            processing_model: "gpt-4o-mini".to_string(),
+            registrations_enabled: true,
+            require_email_verification: false,
+        }
+    }
 }