You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
-**AI Prompt Templates**: Never hardcode AI system prompts or prompt-style recovery instructions in C# code. Store them in `Templates/Prompts/*.md`, add a constant in `AITemplateIds`, and render them through `ITemplateService`.
298
+
-**AI function catalog docs**: Whenever you add, remove, rename, re-categorize, or change the description or feature requirements of an AI function/tool, update `src\CrestApps.Docs\docs\ai\tools.md` and any related feature doc (for example `ai\memory.md`) in the same change so the documented function lists stay synchronized with the codebase.
298
299
299
300
### Working with Omnichannel Modules
300
301
-**Base Module**: `CrestApps.OrchardCore.Omnichannel` - unified communication layer
Copy file name to clipboardExpand all lines: src/CrestApps.Docs/docs/ai/agent.md
+2Lines changed: 2 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -29,6 +29,8 @@ The Orchard agent module surfaces agent profiles inside Orchard Core so they can
29
29
30
30
The exact tool set available to agents depends on which Orchard modules are enabled. For example, tenant-management tools only light up when Orchard tenants support is enabled, and recipe tools depend on Orchard recipes support.
31
31
32
+
For the complete Orchard-specific AI function catalog, including the feature that enables each function and its description, see [AI Tools](tools).
33
+
32
34
## Orchard-specific role of agent profiles
33
35
34
36
In Orchard Core, agent profiles are useful when you want:
Copy file name to clipboardExpand all lines: src/CrestApps.Docs/docs/ai/tools.md
+145Lines changed: 145 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,6 +12,8 @@ The shared tool system is documented primarily in **CrestApps.Core**:
12
12
-[MCP](https://core.crestapps.com/docs/mcp/index)
13
13
-[A2A](https://core.crestapps.com/docs/a2a/index)
14
14
15
+
This page is the Orchard-specific catalog for the AI functions registered or documented in this repository. Shared framework utilities that are not registered by Orchard features in this repo, along with external MCP and A2A tools, continue to be documented in the shared Core docs.
16
+
15
17
Within Orchard Core, tools become useful through the modules that register or expose them:
16
18
17
19
-[AI Services](overview)
@@ -21,6 +23,149 @@ Within Orchard Core, tools become useful through the modules that register or ex
21
23
-[MCP](./mcp/)
22
24
-[A2A](./a2a/)
23
25
26
+
## Orchard-specific AI function catalog
27
+
28
+
Use this catalog to see which Orchard feature makes each AI function available and what it does. When the codebase adds, removes, renames, or re-describes an AI function, update this page together with the related feature docs so the catalog stays synchronized with the current registrations.
|`queryChatSessionMetrics`| Queries aggregated chat session analytics metrics with optional date range and profile filters, returning statistics for charts and reports. |
157
+
158
+
### Memory tools
159
+
160
+
**Available when:**`CrestApps.OrchardCore.AI.Memory` is enabled and user memory is enabled for the current authenticated user
161
+
162
+
| Function | Description |
163
+
| --- | --- |
164
+
| Search User Memories | Semantic search across the current user's saved memories. |
165
+
| List User Memories | Enumerates the current user's existing memories. |
166
+
| Save User Memory | Creates or updates a named memory entry for the current user. |
167
+
| Remove User Memory | Removes a saved memory entry when it should be forgotten. |
168
+
24
169
## Invocation Context (AIInvocationScope)
25
170
26
171
`AIInvocationScope` is the shared per-request context for references, tool state, and other invocation-scoped data. For the framework-level explanation, see the shared Core documentation:
Copy file name to clipboardExpand all lines: src/CrestApps.Docs/docs/changelog/v2.0.0.md
+1Lines changed: 1 addition & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -288,6 +288,7 @@ This included:
288
288
- adding dedicated Docusaurus pages for the `CrestApps.OrchardCore.AI.Memory.AzureAI` and `CrestApps.OrchardCore.AI.Memory.Elasticsearch` feature modules
289
289
- adding a manifest-backed feature-ID reference page and missing Azure Communication Services coverage
290
290
- expanding AI recipe schema guidance for provider-connection authentication fields and contained Azure Speech deployments
291
+
- adding a centralized Orchard-specific AI function catalog that maps each documented function to the feature that makes it available
291
292
- refreshing provider setup wording and the docs contributor guidance
0 commit comments