Create AddEdgeTool description to finalize Scribe Agent

Co-authored-by: Sarmisuper <stharm20@student.aau.dk>

Author: KarmaKamikaze

ChatRPG/API/Tools/AddEdgeTool.cs

@@ -75,10 +75,10 @@ private static bool TryAddEdge(NarrativeGraph graph, AddEdgeInput newEdge, out s
             errorMessages.Add($"An edge already exists between {newEdge.SourceNodeName} and {newEdge.TargetNodeName}.");
         }
 
-        if (errorMessages.Count != 0)
+        if (!ToolUtilities.NodesValidForNewEdge(sourceNode, targetNode, newEdge, out errorMessages))
         {
             errorMessage =
-                $"Invalid input provided for the node. " +
+                $"Invalid input provided for the edge. " +
                 $"Please correct the following errors:\n{string.Join("\n", errorMessages)}";
             return false;
         }

ChatRPG/API/Tools/AddNodeTool.cs

@@ -71,26 +71,9 @@ private static bool TryAddNode(NarrativeGraph graph, AddNodeInput newNode, out s
             sourceNode ??= edge.SourceNodeName == newNode.Name ? node : null;
             targetNode ??= edge.TargetNodeName == newNode.Name ? node : null;
 
-            if (targetNode is null)
+            if (ToolUtilities.NodesValidForNewEdge(sourceNode, targetNode, edge, out errorMessages))
             {
-                errorMessages.Add($"Target node with name {edge.TargetNodeName} not found.");
-            }
-
-            if (sourceNode is null)
-            {
-                errorMessages.Add($"Source node with name {edge.SourceNodeName} not found.");
-            }
-            else if (sourceNode == targetNode)
-            {
-                errorMessages.Add($"Node {sourceNode.Name} cannot have an edge to itself.");
-            }
-            else if (targetNode is not null && sourceNode.Edges.Any(e => e.TargetNode == targetNode))
-            {
-                errorMessages.Add($"An edge already exists between {edge.SourceNodeName} and {edge.TargetNodeName}.");
-            }
-            else if (targetNode is not null)
-            {
-                edgesToAdd.Add(new NarrativeEdge(edge.Conditions!, sourceNode, targetNode));
+                edgesToAdd.Add(new NarrativeEdge(edge.Conditions!, sourceNode!, targetNode!));
             }
         }
 

ChatRPG/API/Tools/ToolUtilities.cs

@@ -99,7 +99,8 @@ public static string ConstructSummary(Campaign campaign, bool shouldIncludePrevi
         if (shouldIncludePreviousMessages)
         {
             var content = campaign.Messages.TakeLast(IncludedPreviousMessages).Select(m => m.Content);
-            result += "\n\nUse these previous messages as context. They only serve to give a hint of the current scenario:";
+            result +=
+                "\n\nUse these previous messages as context. They only serve to give a hint of the current scenario:";
             foreach (var message in content)
             {
                 result += $"\n {message}";
@@ -109,5 +110,28 @@ public static string ConstructSummary(Campaign campaign, bool shouldIncludePrevi
         return result;
     }
 
+    public static bool NodesValidForNewEdge(NarrativeNode? sourceNode, NarrativeNode? targetNode, AddEdgeInput newEdge,
+        out List<string> errorMessages)
+    {
+        errorMessages = [];
+        if (targetNode is null)
+        {
+            errorMessages.Add($"Target node with name {newEdge.TargetNodeName} not found.");
+        }
 
+        if (sourceNode is null)
+        {
+            errorMessages.Add($"Source node with name {newEdge.SourceNodeName} not found.");
+        }
+        else if (sourceNode == targetNode)
+        {
+            errorMessages.Add($"Node {sourceNode.Name} cannot have an edge to itself.");
+        }
+        else if (targetNode is not null && sourceNode.Edges.Any(e => e.TargetNode == targetNode))
+        {
+            errorMessages.Add($"An edge already exists between {newEdge.SourceNodeName} and {newEdge.TargetNodeName}.");
+        }
+
+        return errorMessages.Count == 0;
+    }
 }

ChatRPG/Data/ApplicationDbContext.cs

@@ -21,12 +21,16 @@ protected override void OnModelCreating(ModelBuilder modelBuilder)
     {
         base.OnModelCreating(modelBuilder);
         modelBuilder.Entity<NarrativeEdge>()
+            .Ignore(edge => edge.SourceNodeName)
+            .Ignore(edge => edge.TargetNodeName)
             .HasOne(edge => edge.TargetNode)
             .WithMany()
             .HasForeignKey(edge => edge.TargetNodeId)
             .OnDelete(DeleteBehavior.Restrict);
 
         modelBuilder.Entity<NarrativeEdge>()
+            .Ignore(edge => edge.SourceNodeName)
+            .Ignore(edge => edge.TargetNodeName)
             .HasOne(edge => edge.SourceNode)
             .WithMany(node => node.Edges)
             .HasForeignKey(edge => edge.SourceNodeId)

ChatRPG/Data/Migrations/ApplicationDbContextModelSnapshot.cs

@@ -61,7 +61,7 @@ protected override void BuildModel(ModelBuilder modelBuilder)
 
                     b.HasIndex("UserId");
 
-                    b.ToTable("Campaigns");
+                    b.ToTable("Campaigns", (string)null);
                 });
 
             modelBuilder.Entity("ChatRPG.Data.Models.Character", b =>
@@ -104,7 +104,7 @@ protected override void BuildModel(ModelBuilder modelBuilder)
 
                     b.HasIndex("EnvironmentId");
 
-                    b.ToTable("Characters");
+                    b.ToTable("Characters", (string)null);
                 });
 
             modelBuilder.Entity("ChatRPG.Data.Models.Environment", b =>
@@ -130,7 +130,7 @@ protected override void BuildModel(ModelBuilder modelBuilder)
 
                     b.HasIndex("CampaignId");
 
-                    b.ToTable("Environments");
+                    b.ToTable("Environments", (string)null);
                 });
 
             modelBuilder.Entity("ChatRPG.Data.Models.Message", b =>
@@ -158,7 +158,7 @@ protected override void BuildModel(ModelBuilder modelBuilder)
 
                     b.HasIndex("CampaignId");
 
-                    b.ToTable("Message");
+                    b.ToTable("Message", (string)null);
                 });
 
             modelBuilder.Entity("ChatRPG.Data.Models.NarrativeEdge", b =>
@@ -188,7 +188,7 @@ protected override void BuildModel(ModelBuilder modelBuilder)
 
                     b.HasIndex("TargetNodeId");
 
-                    b.ToTable("NarrativeEdges");
+                    b.ToTable("NarrativeEdges", (string)null);
                 });
 
             modelBuilder.Entity("ChatRPG.Data.Models.NarrativeGraph", b =>
@@ -201,7 +201,7 @@ protected override void BuildModel(ModelBuilder modelBuilder)
 
                     b.HasKey("Id");
 
-                    b.ToTable("NarrativeGraphs");
+                    b.ToTable("NarrativeGraphs", (string)null);
                 });
 
             modelBuilder.Entity("ChatRPG.Data.Models.NarrativeNode", b =>
@@ -230,7 +230,7 @@ protected override void BuildModel(ModelBuilder modelBuilder)
 
                     b.HasIndex("GraphId");
 
-                    b.ToTable("NarrativeNodes");
+                    b.ToTable("NarrativeNodes", (string)null);
                 });
 
             modelBuilder.Entity("ChatRPG.Data.Models.StartScenario", b =>
@@ -251,7 +251,7 @@ protected override void BuildModel(ModelBuilder modelBuilder)
 
                     b.HasKey("Id");
 
-                    b.ToTable("StartScenarios");
+                    b.ToTable("StartScenarios", (string)null);
                 });
 
             modelBuilder.Entity("ChatRPG.Data.Models.User", b =>

ChatRPG/Data/Models/NarrativeEdge.cs

@@ -21,13 +21,25 @@ public NarrativeEdge(List<string> conditions, NarrativeNode sourceNode, Narrativ
 
     [JsonIgnore]
     public int Id { get; private set; }
+
     public ICollection<string> Conditions { get; private set; }
+
     [JsonIgnore]
     public int SourceNodeId { get; private set; }
+
+    public string SourceNodeName => SourceNode.Name;
+
+    [JsonIgnore]
     public NarrativeNode SourceNode { get; private set; }
+
     [JsonIgnore]
     public int TargetNodeId { get; private set; }
+
+    public string TargetNodeName => TargetNode.Name;
+
+    [JsonIgnore]
     public NarrativeNode TargetNode { get; private set; }
+
     public Status EdgeStatus { get; private set; } = Status.Unvisited;
 
     public enum Status
@@ -44,7 +56,7 @@ public string Serialize()
     public override string ToString()
     {
         var sb = new StringBuilder();
-        sb.Append($"{EdgeStatus} Edge from {SourceNode.Id} to {TargetNode.Id} with conditions: ");
+        sb.Append($"{EdgeStatus} Edge from {SourceNodeName} to {TargetNodeName} with conditions: ");
         sb.Append(string.Join(", ", Conditions));
 
         return sb.ToString();

ChatRPG/Data/Models/NarrativeGraph.cs

@@ -10,8 +10,10 @@ public class NarrativeGraph
 
     [JsonIgnore]
     public int Id { get; private set; }
+
     [JsonIgnore]
     public ICollection<Campaign> Campaigns { get; private set; } = new List<Campaign>();
+
     public HashSet<NarrativeNode> Nodes { get; private set; } = [];
 
     public void AddNode(NarrativeNode node)
@@ -52,20 +54,27 @@ public void PrintGraph()
     public override string ToString()
     {
         var startNode = GetStartNode();
+        if (startNode == null)
+        {
+            return "Warning: No start node found. Create a node with no incoming edges.";
+        }
+
         var sb = new StringBuilder();
-        sb.Append(startNode != null
-            ? $"Start Node: {startNode}"
-            : "Warning: No start node found. Create a node with no incoming edges.");
+        sb.AppendLine($"Start Node: {startNode}\n");
+        var visited = new HashSet<NarrativeNode>();
 
-        foreach (var node in Nodes)
+        Dfs(startNode);
+        return sb.ToString();
+
+        void Dfs(NarrativeNode node)
         {
-            sb.Append(node);
+            if (!visited.Add(node)) return; // Skip if already visited
+            sb.AppendLine(node.ToString());
             foreach (var edge in node.Edges)
             {
-                sb.Append($"  {edge}");
+                sb.AppendLine($"  {edge}");
+                Dfs(edge.TargetNode); // Recursively visit adjacent nodes
             }
         }
-
-        return sb.ToString();
     }
 }

ChatRPG/Pages/UserCampaignOverview.razor.cs

@@ -103,9 +103,9 @@ private async Task CreateAndStartCampaign()
             // UploadedFile should not be able to be null since the button is disabled if it is
             await ScenarioDocumentService!.StoreScenarioEmbedding(campaign.Id, UploadedFile!);
 
-            var graph = await ReActScribeAgent!.ScribeNarrativeGraph(UploadedFile!);
+            campaign.NarrativeGraph = await ReActScribeAgent!.ScribeNarrativeGraph(UploadedFile!);
 
-            campaign.StartScenario = await ScenarioDocumentService.GenerateStartingScenario(campaign.Id);
+            campaign.StartScenario = await ScenarioDocumentService.GenerateStartingScenario(campaign);
             await PersistenceService!.SaveAsync(campaign);
         }
 

ChatRPG/Services/ReActScribeAgent.cs

@@ -114,7 +114,48 @@ private static List<AgentTool> CreateTools(NarrativeGraph graph)
             "that traversal logic remains consistent with the scenario documents.");
         tools.Add(addNodeTool);
 
-        var addEdgeTool = new AddEdgeTool(graph, "addedgetool", "Add an edge to the narrative graph");
+        var addEdgeTool = new AddEdgeTool(graph, "addedgetool",
+            "This tool must be used to add a new edge (connection) between two existing nodes in the " +
+            "narrative graph. This tool should be used when you determine that a new pathway should be " +
+            "established between two already-defined story points.\n\nEach edge represents a story-driven " +
+            "connection between two nodes, allowing the player to progress based on specific conditions. " +
+            "These conditions act as prerequisites that must be met before the player is allowed to traverse " +
+            "the edge. An edge must include:\n " +
+            "- A source node name, which is the starting point of the edge.\n " +
+            "- A target node name, which is the destination of the edge.\n " +
+            "- A list of conditions, which describe what the player must accomplish to traverse the edge.\n " +
+            "Conditions should be framed as easy-to-answer questions, verifying if the player has completed " +
+            "specific story requirements. These could be based on prior encounters, collected items, or " +
+            "completed quests, such as:\n " +
+            "- \"Has the player spoken to the village elder?\"\n " +
+            "- \"Has the player recovered the stolen artifact from the crypt?\"\n " +
+            "- \"Has the player defeated the guardian of the temple.\"\n " +
+            "After calling this tool, you will receive an updated string representation of the graph, showing " +
+            "the newly added edge and its connection between nodes. This allows you to verify relationships " +
+            "and ensure logical story progression.\n " +
+            "Usage Format:\n " +
+            "The tool requires valid JSON input structured as follows:\n " +
+            "{ \"conditions\": [ \"condition 1 for traversing the edge\", \"condition 2 for traversing the edge\" ], " +
+            "\"sourcenodename\": \"the name of the source node which already exists in the graph\", " +
+            "\"targetnodename\": \"the name of the target node which already exists in the graph\" } " +
+            "The conditions list may be empty if the edge does not require prerequisites for traversal.\n " +
+            "Example 1: Unlocking the Crypt\n " +
+            "In this scenario, the player must obtain the Rusted Key before they can enter the Ancient Crypt.\n " +
+            "Input to AddEdgeTool:\n " +
+            "{ \"sourcenodename\": \"Old Graveyard\", \"targetnodename\": \"Ancient Crypt\", \"conditions\": " +
+            "[ \"Has the player obtained the Rusted Key?\" ] } Outcome:\n " +
+            "- The Old Graveyard is now connected to the Ancient Crypt.\n " +
+            "- The player cannot enter the crypt until they have obtained the Rusted Key.\n " +
+            "Example 2: Gaining Access to the Royal Chamber\n " +
+            "To enter the Royal Chamber, the player must have:\n " +
+            "1. Met Sir Ivan, the Wizard, who provides the key to the chamber.\n " +
+            "2. Defeated the Elite Guards stationed outside.\n " +
+            "Input to AddEdgeTool:\n " +
+            "{ \"sourcenodename\": \"Castle Courtyard\", \"targetnodename\": \"Royal Chamber\", \"conditions\": " +
+            "[ \"Has the player met Sir Ivan, the Wizard?\", \"Has the player defeated the Elite Guards?\" ] } " +
+            "Outcome:\n " +
+            "- The Castle Courtyard is now connected to the Royal Chamber.\n " +
+            "- The player cannot enter until both conditions are fulfilled.");
         tools.Add(addEdgeTool);
 
         return tools;

ChatRPG/Services/ScenarioDocumentService.cs

@@ -1,4 +1,5 @@
 using System.Text;
+using ChatRPG.Data.Models;
 using LangChain.Databases.Postgres;
 using LangChain.Providers.OpenAI;
 using LangChain.Providers.OpenAI.Predefined;
@@ -47,7 +48,7 @@ public async Task StoreScenarioEmbedding(int campaignId, byte[] scenarioDocument
                 chunkOverlap: 200)); // To pick the chunk overlap you need to estimate the size of the smallest piece of information. It may happen that one chunk ends with `Ron's hair` and the other one starts with `is red`.In this case, an embedding would miss important context, and not be generated properly. With overlap the end of the first chunk will appear in the beginning of the other, eliminating the problem.
     }
 
-    public async Task<string> GenerateStartingScenario(int campaignId)
+    public async Task<string> GenerateStartingScenario(Campaign campaign)
     {
         var provider = new OpenAiProvider(_openAiKey);
         var embeddingModel = new TextEmbeddingV3SmallModel(provider);
@@ -58,7 +59,7 @@ public async Task<string> GenerateStartingScenario(int campaignId)
 
         var vectorDatabase =
             new PostgresVectorDatabase(_connectionString);
-        var vectorCollection = await vectorDatabase.GetCollectionAsync("~collection-" + campaignId);
+        var vectorCollection = await vectorDatabase.GetCollectionAsync("~collection-" + campaign.Id);
 
         var prompt = new StringBuilder();
         prompt.Append(_startingScenarioPrompt);