Skip to content

Merge branch dev with rel-10.0 #24072

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 30, 2025
Merged

Merge branch dev with rel-10.0 #24072

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c35faa3
Simplify examples & update documentation
enisn Oct 21, 2025
ace1e9b
Merge pull request #24005 from abpframework/10-ai-management-docs
berkansasmaz Oct 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 10 additions & 17 deletions docs/en/modules/ai-management/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,10 @@ AI Management module packages are designed for various usage scenarios. Packages

### Menu Items

AI Management module adds the following items to the "Main" menu, under the "Administration" menu item:
AI Management module adds the following items to the "Main" menu:

* **Workspaces**: Workspace management page.
* **Chat**: AI chat interface for testing workspaces.
* **AI Management**: Root menu item for AI Management module. (`AIManagement`)
* **Workspaces**: Workspace management page. (`AIManagement.Workspaces`)

`AIManagementMenus` class has the constants for the menu item names.

Expand Down Expand Up @@ -135,14 +135,15 @@ PreConfigure<AbpAIWorkspaceOptions>(options =>
Example (data seeding):

```csharp
await _workspaceRepository.InsertAsync(new Workspace(
var workspace = new Workspace(
name: "CustomerSupportWorkspace",
provider: "OpenAI",
modelName: "gpt-4",
apiKey: "your-api-key",
systemPrompt: "You are a helpful customer support assistant.",
requiredPermissionName: "MyApp.CustomerSupport"
));
apiKey: "your-api-key"
);
workspace.ApplicationName = ApplicationInfoAccessor.ApplicationName;
workspace.SystemPrompt = "You are a helpful customer support assistant.";
await _workspaceRepository.InsertAsync(workspace);
```

### Workspace Naming Rules
Expand All @@ -155,20 +156,13 @@ await _workspaceRepository.InsertAsync(new Workspace(

The AI Management module defines the following permissions:

### Workspace Management Permissions

| Permission | Description | Default Granted To |
|------------|-------------|-------------------|
| `AIManagement.Workspaces` | View workspaces | Admin role |
| `AIManagement.Workspaces.Create` | Create new workspaces | Admin role |
| `AIManagement.Workspaces.Update` | Edit existing workspaces | Admin role |
| `AIManagement.Workspaces.Delete` | Delete workspaces | Admin role |

### Chat Permissions

| Permission | Description | Default Granted To |
|------------|-------------|-------------------|
| `AIManagement.Chat` | Access chat interface | Admin role |

### Workspace-Level Permissions

Expand All @@ -184,9 +178,8 @@ var workspace = new Workspace(
```

When a workspace has a required permission:
* Only users with that permission can access the workspace
* Only authorized users with that permission can access the workspace endpoints
* Users without the permission will receive an authorization error
* The workspace will not appear in the workspace selection dropdown for unauthorized users

## Usage Scenarios

Expand Down
Loading