Add User Memory Feature (#390)

Author: MikeAlhayek

.github/copilot-instructions.md

@@ -276,14 +276,17 @@ If CloudSmith is inaccessible, only asset builds and code analysis are possible.
 - **Using statements**: 
   - Sort System directives first
   - Prefer simple using statements over braces when possible
+  - Remove unused usings from the code you touch
 
 #### Code Preferences  
 - **Range/Index operators**: Avoid using range/index operators (enforced as warning)
 - **Code Analysis**: `AnalysisLevel` is set to `latest-Recommended`
 - **Implicit usings**: Enabled globally
+- **Database IDs**: Use `IdGenerator.GenerateId()` when creating database IDs manually. Generated IDs are always 26 characters long.
 - **Date/time**: Never use `DateTime.UtcNow`. Always inject `IClock` in the constructor (e.g., `IClock clock`) and store it as `private readonly IClock _clock = clock;`, then call `_clock.UtcNow` in methods
 - **Localization extraction**: When using `ILocalizer`, the property/variable must be named `S`, and localized strings must use the literal pattern `S["This is a localized string"]`. Do not use variables inside the brackets because extraction tooling looks specifically for `S["..."]`.
 - **One type per file**: Every public type must live in its own file. The file name must always match the type name (e.g., `MyService.cs` for `class MyService`)
+- **Global usings**: Do not add `GlobalUsings.cs` files or new global using directives; prefer explicit file-level usings
 - **sealed classes**: Seal all classes by default (`sealed class`), **except** ViewModel classes that are consumed by any Orchard Core display driver — those must remain unsealed because the framework creates runtime proxies for them and proxies cannot be created from sealed types
 
 ### Module Structure Conventions
@@ -524,20 +527,20 @@ services.AddNavigationProvider<MyAdminMenu>();
 
 ## Anti-Patterns to Avoid
 
-- ❌ Don't use static mutable state
-- ❌ Don't create tight coupling between modules
-- ❌ Don't bypass Orchard Core's dependency injection
-- ❌ Don't hardcode connection strings or secrets
-- ❌ Don't use synchronous I/O operations (use async/await)
-- ❌ Don't ignore compiler warnings (TreatWarningsAsErrors is enabled) — fix all warnings in the entire project, not just changed files
-- ❌ Don't skip writing tests for new features
-- ❌ Don't commit commented-out code
-- ❌ Don't use `System.Range` or `System.Index` operators (enforced as warning)
-- ❌ Don't leave unused services injected through dependency injection
-- ❌ Don't leave unused `using` statements in source files
-- ❌ Don't use `DateTime.UtcNow` — inject `IClock` and use `_clock.UtcNow` instead
-- ❌ Don't seal ViewModel classes that are used by any Orchard Core display driver — the framework requires unsealed types to generate runtime proxies
-- ❌ Don't put multiple public types in a single file — each public type must be in its own file whose name matches the type name
+- Don't use static mutable state
+- Don't create tight coupling between modules
+- Don't bypass Orchard Core's dependency injection
+- Don't hardcode connection strings or secrets
+- Don't use synchronous I/O operations (use async/await)
+- Don't ignore compiler warnings (TreatWarningsAsErrors is enabled) — fix all warnings in the entire project, not just changed files
+- Don't skip writing tests for new features
+- Don't commit commented-out code
+- Don't use `System.Range` or `System.Index` operators (enforced as warning)
+- Don't leave unused services injected through dependency injection
+- Don't leave unused `using` statements in source files
+- Don't use `DateTime.UtcNow` — inject `IClock` and use `_clock.UtcNow` instead
+- Don't seal ViewModel classes that are used by any Orchard Core display driver — the framework requires unsealed types to generate runtime proxies
+- Don't put multiple public types in a single file — each public type must be in its own file whose name matches the type name
 
 ## Code Cleanup (Required After Completing Work)
 

CrestApps.OrchardCore.slnx

@@ -45,6 +45,9 @@
     <Project Path="src/Modules/CrestApps.OrchardCore.AI.Documents.OpenXml/CrestApps.OrchardCore.AI.Documents.OpenXml.csproj" />
     <Project Path="src/Modules/CrestApps.OrchardCore.AI.Documents.Pdf/CrestApps.OrchardCore.AI.Documents.Pdf.csproj" />
     <Project Path="src/Modules/CrestApps.OrchardCore.AI.Documents/CrestApps.OrchardCore.AI.Documents.csproj" />
+    <Project Path="src/Modules/CrestApps.OrchardCore.AI.Memory/CrestApps.OrchardCore.AI.Memory.csproj" />
+    <Project Path="src/Modules/CrestApps.OrchardCore.AI.Memory.AzureAI/CrestApps.OrchardCore.AI.Memory.AzureAI.csproj" />
+    <Project Path="src/Modules/CrestApps.OrchardCore.AI.Memory.Elasticsearch/CrestApps.OrchardCore.AI.Memory.Elasticsearch.csproj" />
     <Project Path="src/Modules/CrestApps.OrchardCore.AI.Mcp.Resources.Ftp/CrestApps.OrchardCore.AI.Mcp.Resources.Ftp.csproj" />
     <Project Path="src/Modules/CrestApps.OrchardCore.AI.Mcp.Resources.Sftp/CrestApps.OrchardCore.AI.Mcp.Resources.Sftp.csproj" />
     <Project Path="src/Modules/CrestApps.OrchardCore.AI.A2A/CrestApps.OrchardCore.AI.A2A.csproj" />

README.md

@@ -1,14 +1,14 @@
 # CrestApps - Orchard Core
 
-CrestApps provides a collection of open-source modules designed to enhance **Orchard Core**, a powerful application framework built on **ASP.NET Core**.  
+CrestApps provides a collection of open-source modules designed to enhance **Orchard Core**, a powerful application framework built on **ASP.NET Core**.
 
 ## 📖 Documentation
 
 For detailed guides, tutorials, and API references, visit the **[CrestApps Orchard Core Documentation](https://orchardcore.crestapps.com/)**.
 
 The documentation covers:
 - **[Getting Started](https://orchardcore.crestapps.com/docs/getting-started)** — Installation and setup
-- **[AI Suite](https://orchardcore.crestapps.com/docs/ai/overview)** — AI modules, profiles, tools, and orchestration
+- **[AI Suite](https://orchardcore.crestapps.com/docs/ai/overview)** — One place for AI integrations and solutions across chat, orchestration, management, RAG, MCP, A2A, and automation
 - **[AI Providers](https://orchardcore.crestapps.com/docs/providers/overview)** — Configuring OpenAI, Azure, Ollama, and more
 - **[Consuming AI Services](https://orchardcore.crestapps.com/docs/ai/consuming-ai-services)** — Programmatic usage via code
 - **[MCP](https://orchardcore.crestapps.com/docs/ai/mcp/)** — Model Context Protocol client and server support
@@ -91,8 +91,12 @@ You can install individual modules into your web project as needed, or install t
 
 ### Artificial Intelligence Suite
 
+The CrestApps AI Suite is a comprehensive and extensible AI ecosystem built on Orchard Core, designed to unify and streamline AI integration and management. It combines provider integrations, flexible deployment and connection management, AI profiles, and advanced orchestration into a cohesive platform.
+
+The suite enables highly customizable chat experiences, along with robust prompt and tool management, retrieval workflows, and long-term memory capabilities. It also supports MCP and Agent-to-Agent integrations, delivering a powerful foundation for building intelligent, interconnected systems—all seamlessly managed within the Orchard Core admin experience.
+
 #### AI Module
-Provides services for all AI modules and provide the interface for managing AI profiles and AI Deployments. See the [AI Services documentation](https://orchardcore.crestapps.com/docs/ai/ai-services) for more details.  
+Provides the foundation for the AI ecosystem, including shared AI services, orchestration infrastructure, profile management, connection and deployment management, and site-level AI settings. See the [AI Services documentation](https://orchardcore.crestapps.com/docs/ai/ai-services) for more details.  
 
 #### AI Chat Module
 Provides interface for interacting with AI chat models like **ChatGPT** and others. See the [AI Chat documentation](https://orchardcore.crestapps.com/docs/ai/ai-chat) for more details.  

src/Abstractions/CrestApps.OrchardCore.AI.Abstractions/AICompletionContextKeys.cs

@@ -14,4 +14,11 @@ public static class AICompletionContextKeys
     /// to be included in the tool registry.
     /// </summary>
     public const string HasDocuments = "HasDocuments";
+
+    /// <summary>
+    /// When set to <see langword="true"/> in <see cref="Models.AICompletionContext.AdditionalProperties"/>,
+    /// indicates that authenticated user memory is available for the current request. This enables
+    /// memory-related system tools to be included in the tool registry.
+    /// </summary>
+    public const string HasMemory = "HasMemory";
 }

src/Abstractions/CrestApps.OrchardCore.AI.Abstractions/AIToolPurposes.cs

@@ -21,4 +21,9 @@ public static class AIToolPurposes
     /// Tools that search data source embeddings for RAG (Retrieval-Augmented Generation).
     /// </summary>
     public const string DataSourceSearch = "data_source_search";
+
+    /// <summary>
+    /// Tools that recall, list, or store authenticated user memory.
+    /// </summary>
+    public const string Memory = "memory";
 }

src/Abstractions/CrestApps.OrchardCore.AI.Abstractions/IAIMemorySafetyService.cs

@@ -0,0 +1,6 @@
+namespace CrestApps.OrchardCore.AI;
+
+public interface IAIMemorySafetyService
+{
+    bool TryValidate(string name, string description, string content, out string errorMessage);
+}

src/Abstractions/CrestApps.OrchardCore.AI.Abstractions/IAIMemoryStore.cs

@@ -0,0 +1,13 @@
+using CrestApps.OrchardCore.AI.Models;
+using CrestApps.OrchardCore.Services;
+
+namespace CrestApps.OrchardCore.AI;
+
+public interface IAIMemoryStore : ICatalog<AIMemoryEntry>
+{
+    Task<int> CountByUserAsync(string userId);
+
+    Task<AIMemoryEntry> FindByUserAndNameAsync(string userId, string name);
+
+    Task<IReadOnlyCollection<AIMemoryEntry>> GetByUserAsync(string userId, int limit = 100);
+}

src/Abstractions/CrestApps.OrchardCore.AI.Abstractions/IMemoryVectorSearchService.cs

@@ -0,0 +1,14 @@
+using CrestApps.OrchardCore.AI.Models;
+using OrchardCore.Indexing.Models;
+
+namespace CrestApps.OrchardCore.AI;
+
+public interface IMemoryVectorSearchService
+{
+    Task<IEnumerable<AIMemorySearchResult>> SearchAsync(
+        IndexProfile indexProfile,
+        float[] embedding,
+        string userId,
+        int topN,
+        CancellationToken cancellationToken = default);
+}

src/Abstractions/CrestApps.OrchardCore.AI.Abstractions/Models/AIMemoryEntry.cs

@@ -0,0 +1,18 @@
+using CrestApps.OrchardCore.Models;
+
+namespace CrestApps.OrchardCore.AI.Models;
+
+public sealed class AIMemoryEntry : CatalogItem
+{
+    public string UserId { get; set; }
+
+    public string Name { get; set; }
+
+    public string Description { get; set; }
+
+    public string Content { get; set; }
+
+    public DateTime CreatedUtc { get; set; }
+
+    public DateTime UpdatedUtc { get; set; }
+}

src/Abstractions/CrestApps.OrchardCore.AI.Abstractions/Models/AIMemorySearchResult.cs

@@ -0,0 +1,16 @@
+namespace CrestApps.OrchardCore.AI.Models;
+
+public sealed class AIMemorySearchResult
+{
+    public string MemoryId { get; set; }
+
+    public string Name { get; set; }
+
+    public string Description { get; set; }
+
+    public string Content { get; set; }
+
+    public DateTime? UpdatedUtc { get; set; }
+
+    public float Score { get; set; }
+}