Merge pull request #1280 from iceljc/master

iceljc · web-flow · commit 48a5427113b9 · 2026-01-20T11:00:41.000-06:00
rename graph query
diff --git a/src/Infrastructure/BotSharp.Abstraction/Graph/IGraphDb.cs b/src/Infrastructure/BotSharp.Abstraction/Graph/IGraphDb.cs
@@ -9,7 +9,7 @@ public interface IGraphDb
 {
     public string Provider { get; }
 
-    Task<GraphSearchResult> SearchAsync(string query, GraphSearchOptions? options = null)
+    Task<GraphQueryResult> ExecuteQueryAsync(string query, GraphQueryExecuteOptions? options = null)
         => throw new NotImplementedException();
 
     #region Node
diff --git a/src/Infrastructure/BotSharp.Abstraction/Graph/IGraphKnowledgeService.cs b/src/Infrastructure/BotSharp.Abstraction/Graph/IGraphKnowledgeService.cs
@@ -7,7 +7,7 @@ namespace BotSharp.Abstraction.Graph;
 
 public interface IGraphKnowledgeService
 {
-    Task<GraphSearchResult> SearchAsync(string query, GraphSearchOptions? options = null);
+    Task<GraphQueryResult> ExecuteQueryAsync(string query, GraphQueryOptions? options = null);
 
     #region Node
     Task<GraphNode?> GetNodeAsync(string graphId, string nodeId, GraphNodeOptions? options = null);
diff --git a/src/Infrastructure/BotSharp.Abstraction/Graph/Models/GraphQueryResult.cs b/src/Infrastructure/BotSharp.Abstraction/Graph/Models/GraphQueryResult.cs
@@ -1,6 +1,6 @@
 namespace BotSharp.Abstraction.Graph.Models;
 
-public class GraphSearchResult
+public class GraphQueryResult
 {
     public string Result { get; set; } = string.Empty;
     public string[] Keys { get; set; } = [];
diff --git a/src/Infrastructure/BotSharp.Abstraction/Graph/Options/GraphQueryOptions.cs b/src/Infrastructure/BotSharp.Abstraction/Graph/Options/GraphQueryOptions.cs
@@ -1,9 +1,13 @@
 namespace BotSharp.Abstraction.Graph.Options;
 
-public class GraphSearchOptions
+public class GraphQueryOptions : GraphQueryExecuteOptions
+{
+    public string Provider { get; set; }
+}
+
+public class GraphQueryExecuteOptions
 {
-    public string? Provider { get; set; }
     public string? GraphId { get; set; }
     public Dictionary<string, object>? Arguments { get; set; }
     public string? Method { get; set; }
-}
+}
diff --git a/src/Infrastructure/BotSharp.OpenAPI/Controllers/KnowledgeBase/KnowledgeBaseController.cs b/src/Infrastructure/BotSharp.OpenAPI/Controllers/KnowledgeBase/KnowledgeBaseController.cs
@@ -208,15 +208,15 @@ public async Task<bool> DeleteVectorCollectionSnapshots([FromRoute] string colle
     [HttpPost("/knowledge/graph/search")]
     public async Task<GraphKnowledgeViewModel> SearchGraphKnowledge([FromBody] SearchGraphKnowledgeRequest request)
     {
-        var options = new GraphSearchOptions
+        var options = new GraphQueryOptions
         {
             Provider = request.Provider,
             GraphId = request.GraphId,
             Arguments = request.Arguments,
             Method = request.Method
         };
 
-        var result = await _graphKnowledgeService.SearchAsync(request.Query, options);
+        var result = await _graphKnowledgeService.ExecuteQueryAsync(request.Query, options);
         return new GraphKnowledgeViewModel
         {
             Result = result.Result
diff --git a/src/Plugins/BotSharp.Plugin.Graph/GraphDb.cs b/src/Plugins/BotSharp.Plugin.Graph/GraphDb.cs
@@ -38,11 +38,11 @@ public GraphDb(
 
     public string Provider => "Remote";
 
-    public async Task<GraphSearchResult> SearchAsync(string query, GraphSearchOptions? options = null)
+    public async Task<GraphQueryResult> ExecuteQueryAsync(string query, GraphQueryExecuteOptions? options = null)
     {
         if (string.IsNullOrWhiteSpace(_settings.BaseUrl))
         {
-            return new GraphSearchResult();
+            return new GraphQueryResult();
         }
 
         var url = $"{_settings.BaseUrl}{_settings.SearchPath}";
@@ -56,9 +56,9 @@ public async Task<GraphSearchResult> SearchAsync(string query, GraphSearchOption
 
 
     #region Private methods
-    private async Task<GraphSearchResult> SendRequest(string url, GraphQueryRequest request)
+    private async Task<GraphQueryResult> SendRequest(string url, GraphQueryRequest request)
     {
-        var result = new GraphSearchResult();
+        var result = new GraphQueryResult();
         var http = _services.GetRequiredService<IHttpClientFactory>();
 
         using (var client = http.CreateClient())
@@ -79,7 +79,7 @@ private async Task<GraphSearchResult> SendRequest(string url, GraphQueryRequest
                 rawResponse.EnsureSuccessStatusCode();
 
                 var responseStr = await rawResponse.Content.ReadAsStringAsync();
-                result = JsonSerializer.Deserialize<GraphSearchResult>(responseStr, _jsonOptions);
+                result = JsonSerializer.Deserialize<GraphQueryResult>(responseStr, _jsonOptions);
                 return result;
             }
             catch (Exception ex)
diff --git a/src/Plugins/BotSharp.Plugin.KnowledgeBase/Graph/GraphKnowledgeService.cs b/src/Plugins/BotSharp.Plugin.KnowledgeBase/Graph/GraphKnowledgeService.cs
@@ -18,18 +18,18 @@ public GraphKnowledgeService(
         _settings = settings;
     }
 
-    public async Task<GraphSearchResult> SearchAsync(string query, GraphSearchOptions? options = null)
+    public async Task<GraphQueryResult> ExecuteQueryAsync(string query, GraphQueryOptions? options = null)
     {
         try
         {
             var db = GetGraphDb(options?.Provider);
-            var result = await db.SearchAsync(query, options);
+            var result = await db.ExecuteQueryAsync(query, options);
             return result;
         }
         catch (Exception ex)
         {
             _logger.LogError(ex, $"Error when searching graph knowledge (Query: {query}).");
-            return new GraphSearchResult();
+            return new GraphQueryResult();
         }
     }
 
diff --git a/src/Plugins/BotSharp.Plugin.KnowledgeBase/Hooks/KnowledgeHook.cs b/src/Plugins/BotSharp.Plugin.KnowledgeBase/Hooks/KnowledgeHook.cs
@@ -36,11 +36,12 @@ public async Task<List<string>> GetDomainKnowledges(RoleDialogModel message, str
         {
             if (knowledgeBase.Type == "relationships")
             {
-                var options = new GraphSearchOptions
+                var options = new GraphQueryOptions
                 {
+                    Provider = "Remote",
                     Method = "local"
                 };
-                var result = await _graphKnowledgeService.SearchAsync(text, options);
+                var result = await _graphKnowledgeService.ExecuteQueryAsync(text, options);
                 results.Add(result.Result);
             }
             else if (knowledgeBase.Type == "document")
@@ -89,11 +90,12 @@ public async Task<List<string>> GetGlobalKnowledges(RoleDialogModel message)
         {
             if (knowledgeBase.Type == "relationships")
             {
-                var options = new GraphSearchOptions
+                var options = new GraphQueryOptions
                 {
+                    Provider = "Remote",
                     Method = "local"
                 };
-                var result = await _graphKnowledgeService.SearchAsync(text, options);
+                var result = await _graphKnowledgeService.ExecuteQueryAsync(text, options);
                 results.Add(result.Result);
             }
             else
diff --git a/src/Plugins/BotSharp.Plugin.Membase/Controllers/MembaseController.cs b/src/Plugins/BotSharp.Plugin.Membase/Controllers/MembaseController.cs
@@ -40,7 +40,7 @@ public async Task<IActionResult> ExecuteGraphQuery(string graphId, [FromBody] Cy
         try
         {
             var graph = _services.GetServices<IGraphDb>().First(x => x.Provider == "membase");
-            var result = await graph.SearchAsync(query: request.Query, options: new()
+            var result = await graph.ExecuteQueryAsync(query: request.Query, options: new()
             {
                 GraphId = graphId,
                 Arguments = request.Parameters
diff --git a/src/Plugins/BotSharp.Plugin.Membase/GraphDb/MembaseGraphDb.cs b/src/Plugins/BotSharp.Plugin.Membase/GraphDb/MembaseGraphDb.cs
@@ -24,7 +24,7 @@ public MembaseGraphDb(
 
     public string Provider => "membase";
 
-    public async Task<GraphSearchResult> SearchAsync(string query, GraphSearchOptions? options = null)
+    public async Task<GraphQueryResult> ExecuteQueryAsync(string query, GraphQueryExecuteOptions? options = null)
     {
         if (string.IsNullOrEmpty(options?.GraphId))
         {
@@ -39,7 +39,7 @@ public async Task<GraphSearchResult> SearchAsync(string query, GraphSearchOption
                 Parameters = options.Arguments ?? new Dictionary<string, object>()
             });
 
-            return new GraphSearchResult
+            return new GraphQueryResult
             {
                 Keys = response.Columns,
                 Values = response.Data,
diff --git a/src/Plugins/BotSharp.Plugin.Membase/Services/MembaseService.cs b/src/Plugins/BotSharp.Plugin.Membase/Services/MembaseService.cs
@@ -14,15 +14,15 @@ public MembaseService(IServiceProvider services, IMembaseApi membase)
         _membase = membase;
     }
 
-    public async Task<GraphSearchResult> Execute(string graphId, string query, Dictionary<string, object>? args = null)
+    public async Task<GraphQueryResult> Execute(string graphId, string query, Dictionary<string, object>? args = null)
     {
         var response = await _membase.CypherQueryAsync(graphId, new CypherQueryRequest
         {
             Query = query,
             Parameters = args ?? []
         });
 
-        return new GraphSearchResult
+        return new GraphQueryResult
         {
             Keys = response.Columns,
             Values = response.Data

Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@ public interface IGraphDb`
`9`	`9`	`{`
`10`	`10`	`public string Provider { get; }`
`11`	`11`
`12`		`- Task<GraphSearchResult> SearchAsync(string query, GraphSearchOptions? options = null)`
	`12`	`+ Task<GraphQueryResult> ExecuteQueryAsync(string query, GraphQueryExecuteOptions? options = null)`
`13`	`13`	`=> throw new NotImplementedException();`
`14`	`14`
`15`	`15`	`#region Node`
Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@ namespace BotSharp.Abstraction.Graph;`
`7`	`7`
`8`	`8`	`public interface IGraphKnowledgeService`
`9`	`9`	`{`
`10`		`- Task<GraphSearchResult> SearchAsync(string query, GraphSearchOptions? options = null);`
	`10`	`+ Task<GraphQueryResult> ExecuteQueryAsync(string query, GraphQueryOptions? options = null);`
`11`	`11`
`12`	`12`	`#region Node`
`13`	`13`	`Task<GraphNode?> GetNodeAsync(string graphId, string nodeId, GraphNodeOptions? options = null);`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`namespace BotSharp.Abstraction.Graph.Models;`
`2`	`2`
`3`		`-public class GraphSearchResult`
	`3`	`+public class GraphQueryResult`
`4`	`4`	`{`
`5`	`5`	`public string Result { get; set; } = string.Empty;`
`6`	`6`	`public string[] Keys { get; set; } = [];`
Original file line number	Diff line number	Diff line change
`@@ -208,15 +208,15 @@ public async Task<bool> DeleteVectorCollectionSnapshots([FromRoute] string colle`
`208`	`208`	`[HttpPost("/knowledge/graph/search")]`
`209`	`209`	`public async Task<GraphKnowledgeViewModel> SearchGraphKnowledge([FromBody] SearchGraphKnowledgeRequest request)`
`210`	`210`	`{`
`211`		`- var options = new GraphSearchOptions`
	`211`	`+ var options = new GraphQueryOptions`
`212`	`212`	`{`
`213`	`213`	`Provider = request.Provider,`
`214`	`214`	`GraphId = request.GraphId,`
`215`	`215`	`Arguments = request.Arguments,`
`216`	`216`	`Method = request.Method`
`217`	`217`	`};`
`218`	`218`
`219`		`- var result = await _graphKnowledgeService.SearchAsync(request.Query, options);`
	`219`	`+ var result = await _graphKnowledgeService.ExecuteQueryAsync(request.Query, options);`
`220`	`220`	`return new GraphKnowledgeViewModel`
`221`	`221`	`{`
`222`	`222`	`Result = result.Result`
Original file line number	Diff line number	Diff line change
`@@ -38,11 +38,11 @@ public GraphDb(`
`38`	`38`
`39`	`39`	`public string Provider => "Remote";`
`40`	`40`
`41`		`- public async Task<GraphSearchResult> SearchAsync(string query, GraphSearchOptions? options = null)`
	`41`	`+ public async Task<GraphQueryResult> ExecuteQueryAsync(string query, GraphQueryExecuteOptions? options = null)`
`42`	`42`	`{`
`43`	`43`	`if (string.IsNullOrWhiteSpace(_settings.BaseUrl))`
`44`	`44`	`{`
`45`		`- return new GraphSearchResult();`
	`45`	`+ return new GraphQueryResult();`
`46`	`46`	`}`
`47`	`47`
`48`	`48`	`var url = $"{_settings.BaseUrl}{_settings.SearchPath}";`
`@@ -56,9 +56,9 @@ public async Task<GraphSearchResult> SearchAsync(string query, GraphSearchOption`
`56`	`56`
`57`	`57`
`58`	`58`	`#region Private methods`
`59`		`- private async Task<GraphSearchResult> SendRequest(string url, GraphQueryRequest request)`
	`59`	`+ private async Task<GraphQueryResult> SendRequest(string url, GraphQueryRequest request)`
`60`	`60`	`{`
`61`		`- var result = new GraphSearchResult();`
	`61`	`+ var result = new GraphQueryResult();`
`62`	`62`	`var http = _services.GetRequiredService<IHttpClientFactory>();`
`63`	`63`
`64`	`64`	`using (var client = http.CreateClient())`
`@@ -79,7 +79,7 @@ private async Task<GraphSearchResult> SendRequest(string url, GraphQueryRequest`
`79`	`79`	`rawResponse.EnsureSuccessStatusCode();`
`80`	`80`
`81`	`81`	`var responseStr = await rawResponse.Content.ReadAsStringAsync();`
`82`		`- result = JsonSerializer.Deserialize<GraphSearchResult>(responseStr, _jsonOptions);`
	`82`	`+ result = JsonSerializer.Deserialize<GraphQueryResult>(responseStr, _jsonOptions);`
`83`	`83`	`return result;`
`84`	`84`	`}`
`85`	`85`	`catch (Exception ex)`
Original file line number	Diff line number	Diff line change
`@@ -18,18 +18,18 @@ public GraphKnowledgeService(`
`18`	`18`	`_settings = settings;`
`19`	`19`	`}`
`20`	`20`
`21`		`- public async Task<GraphSearchResult> SearchAsync(string query, GraphSearchOptions? options = null)`
	`21`	`+ public async Task<GraphQueryResult> ExecuteQueryAsync(string query, GraphQueryOptions? options = null)`
`22`	`22`	`{`
`23`	`23`	`try`
`24`	`24`	`{`
`25`	`25`	`var db = GetGraphDb(options?.Provider);`
`26`		`- var result = await db.SearchAsync(query, options);`
	`26`	`+ var result = await db.ExecuteQueryAsync(query, options);`
`27`	`27`	`return result;`
`28`	`28`	`}`
`29`	`29`	`catch (Exception ex)`
`30`	`30`	`{`
`31`	`31`	`_logger.LogError(ex, $"Error when searching graph knowledge (Query: {query}).");`
`32`		`- return new GraphSearchResult();`
	`32`	`+ return new GraphQueryResult();`
`33`	`33`	`}`
`34`	`34`	`}`
`35`	`35`
Original file line number	Diff line number	Diff line change
`@@ -36,11 +36,12 @@ public async Task<List<string>> GetDomainKnowledges(RoleDialogModel message, str`
`36`	`36`	`{`
`37`	`37`	`if (knowledgeBase.Type == "relationships")`
`38`	`38`	`{`
`39`		`- var options = new GraphSearchOptions`
	`39`	`+ var options = new GraphQueryOptions`
`40`	`40`	`{`
	`41`	`+ Provider = "Remote",`
`41`	`42`	`Method = "local"`
`42`	`43`	`};`
`43`		`- var result = await _graphKnowledgeService.SearchAsync(text, options);`
	`44`	`+ var result = await _graphKnowledgeService.ExecuteQueryAsync(text, options);`
`44`	`45`	`results.Add(result.Result);`
`45`	`46`	`}`
`46`	`47`	`else if (knowledgeBase.Type == "document")`
`@@ -89,11 +90,12 @@ public async Task<List<string>> GetGlobalKnowledges(RoleDialogModel message)`
`89`	`90`	`{`
`90`	`91`	`if (knowledgeBase.Type == "relationships")`
`91`	`92`	`{`
`92`		`- var options = new GraphSearchOptions`
	`93`	`+ var options = new GraphQueryOptions`
`93`	`94`	`{`
	`95`	`+ Provider = "Remote",`
`94`	`96`	`Method = "local"`
`95`	`97`	`};`
`96`		`- var result = await _graphKnowledgeService.SearchAsync(text, options);`
	`98`	`+ var result = await _graphKnowledgeService.ExecuteQueryAsync(text, options);`
`97`	`99`	`results.Add(result.Result);`
`98`	`100`	`}`
`99`	`101`	`else`
Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,7 @@ public async Task<IActionResult> ExecuteGraphQuery(string graphId, [FromBody] Cy`
`40`	`40`	`try`
`41`	`41`	`{`
`42`	`42`	`var graph = _services.GetServices<IGraphDb>().First(x => x.Provider == "membase");`
`43`		`- var result = await graph.SearchAsync(query: request.Query, options: new()`
	`43`	`+ var result = await graph.ExecuteQueryAsync(query: request.Query, options: new()`
`44`	`44`	`{`
`45`	`45`	`GraphId = graphId,`
`46`	`46`	`Arguments = request.Parameters`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@ public MembaseGraphDb(`
`24`	`24`
`25`	`25`	`public string Provider => "membase";`
`26`	`26`
`27`		`- public async Task<GraphSearchResult> SearchAsync(string query, GraphSearchOptions? options = null)`
	`27`	`+ public async Task<GraphQueryResult> ExecuteQueryAsync(string query, GraphQueryExecuteOptions? options = null)`
`28`	`28`	`{`
`29`	`29`	`if (string.IsNullOrEmpty(options?.GraphId))`
`30`	`30`	`{`
`@@ -39,7 +39,7 @@ public async Task<GraphSearchResult> SearchAsync(string query, GraphSearchOption`
`39`	`39`	`Parameters = options.Arguments ?? new Dictionary<string, object>()`
`40`	`40`	`});`
`41`	`41`
`42`		`- return new GraphSearchResult`
	`42`	`+ return new GraphQueryResult`
`43`	`43`	`{`
`44`	`44`	`Keys = response.Columns,`
`45`	`45`	`Values = response.Data,`