Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
23 changes: 23 additions & 0 deletions code-studio-toc.html
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,29 @@
</ul>

</li>
<li>Enterprise Servers
<ul>
<li>
<a href="">Getting Started</a>
</li>
<li>
<a href="">Dashboard</a>
</li>
<li>
<a href="">Configure LLM providers and models</a>
</li>
<li>
<a href="">Manage user & Teams</a>
</li>
<li>
<a href="">Create Budget </a>
</li>
<li>
<a href="">Fallback policy configuration</a>
</li>

</ul>
</li>
<li>Features
<ul>
<li>
Expand Down
54 changes: 54 additions & 0 deletions code-studio/enterprise-server/createbudget.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# Create Budget

The Budget feature in Code Studio enables administrators to allocate and monitor AI usage budgets for teams and individual users. This helps organizations manage costs effectively and optimize AI resource utilization.

> **Note**: Only admins and Team Leads can edit and assign budget for all.

<img src="./enterprise-images/budgetnew.png" alt="budget" />


## 1. Team Budget Setup

**Steps:**

- Open the **Budget** window.
- Select the desired **Team**.
- Set the **Maximum Budget** for the team.
- Choose the **Budget Period**:
- Monthly
- Quarterly
- Half-Yearly
- Annually
- (Optional) Enable **Auto-Renewal** by checking the box. This will automatically reset the budget at the end of each period.

<img src="./enterprise-images/teambudget.png" alt="budget" />

## 2. Individual User Budget Allocation

**Steps:**

- Within the selected team, give the user’s name to edit budget limit.
- For each user:
- Set the **Maximum Budget**.
- Define the **Budget Period**.
- Monitor usage and adjust as needed.

<img src="./enterprise-images/memberbudget.png" alt="budget" />

## Usage Alerts

Administrators can set up alerts to notify when budget usage exceeds a defined threshold.

**Steps:**

- Open the **Edit usage Alert**.
- Set the **Usage Threshold** (e.g., 50%).
- Enter the **Email Subject Prefix** (required).
- Specify the **Recipients** for the alert (e.g., team leads or finance managers). An alert email will be sent to the recipient.
- Click **Update** to activate the alert.

<img src="./enterprise-images/alert.png" alt="budget" />

🔔 Alerts help proactively manage budget overruns and ensure timely action.


89 changes: 89 additions & 0 deletions code-studio/enterprise-server/dashboard.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
# Dashboard

The Code Studios Dashboard provides a centralized interface for monitoring and analyzing usage metrics across your organization. It enables administrators and team leads to track token consumption, request volumes, latency, and cost metrics, both at the organizational and individual levels.



## 1. Graphical Overview

The dashboard presents a visual summary of the following metrics:

- **Total Cost**: Cumulative cost incurred by the organization, team or individual user.

<img src="./enterprise-images/dashboard2.png" alt="dashboard" />

- **Total Tokens**: Total number of tokens consumed.

<img src="./enterprise-images/dash3.png" alt="dashboard" />

- **Total Requests**: Number of API or model requests made.

<img src="./enterprise-images/dash4.png" alt="dashboard" />


- **Average Latency**: Mean response time across all requests.

<img src="./enterprise-images/dash5.png" alt="dashboard" />


- **Top 5 Users by Token Usage**: Identifies the most active users.

<img src="./enterprise-images/dash6.png" alt="dashboard" />

- **Top 5 Models by Token Usage**: Highlights the most utilized models.

<img src="./enterprise-images/dash7.png" alt="dashboard" />

- **Individual User Metrics**: Detailed usage statistics per user.

<img src="./enterprise-images/dash8.png" alt="dashboard" />

## 2. Team & User Monitoring

You can monitor:

- **Organization-wide usage**: Aggregated data across all teams.
- **Team-specific usage**: Filter data by individual teams.
- **User-specific usage**: Drill down into individual user activity.

## 3. Date Range Filtering

- Select custom date ranges to analyze token usage and other metrics over time.
- Useful for monthly reporting, trend analysis, and budget tracking.

## How to Use the Dashboard

### Step 1: Navigate to the Dashboard

- Go to https://app.sfcodestudio.com/dashboard

<img src="./enterprise-images/dashboard1.png" alt="dashboard" />

### Step 2: Review Summary Metrics

- Observe the graphical widgets displaying cost, tokens, requests, and latency.
- Hover over charts for detailed tooltips and breakdowns.

### Step 3: Filter by Team or User

- Use the filter options to select:
- All Teams
- Specific Team
- Individual User

### Step 4: Set Date Range

- Click the date selector to choose a start and end date.
- The dashboard will refresh to show metrics for the selected period.

### Step 5: Analyze Top Usage

- Review the “Top 5 Users” and “Top 5 Models” sections to identify high-usage patterns.
- Use this data to optimize resource allocation or investigate anomalies.

## Best Practices

- **Regular Monitoring**: Check the dashboard weekly to stay on top of usage trends.
- **Budget Control**: Use cost and token data to manage spending.
- **Performance Optimization**: Track latency to identify performance bottlenecks.
- **User Accountability**: Monitor individual usage to ensure fair and efficient use of resources.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
43 changes: 43 additions & 0 deletions code-studio/enterprise-server/fallback.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Fallback Policy Configuration

Fallback Policies in Code Studio ensure uninterrupted AI workflows by automatically rerouting requests to alternative models when the primary model fails. This feature improves reliability, success rates, and cost efficiency.

> **Note**: Only admins can Configure and manage policies for Model.


## 1. How Fallback Works

1. A request is sent to the primary model.
2. If the request fails (due to timeout, error, etc.), the system automatically retries using the next model in the fallback list.
3. This process continues until a model successfully returns a result or the retry limit is reached.

✅ **Benefits**:
- Prevents stalled workflows
- Increases success rates
- Reduces costs by only paying for successful responses



## 2. Configuring Fallback Policies

**Steps**:

1. Go to the Policies page under the Configuration section.

<img src="./enterprise-images/fallback1.png" alt="fallback" />

2. Enable the Fallback Policy toggle.
3. Click on edit and set the Maximum Number of Retries.
4. Add models in the desired Fallback Order:
- Select models from available providers.
- Arrange them in priority order.

<img src="./enterprise-images/fallback2.png" alt="fallback" />

🔄 You can edit the model list and reorder them anytime to optimize fallback behavior.

## 3. Best Practices

- Choose models with varied capabilities and reliability to ensure coverage.
- Limit retries to avoid unnecessary costs.
- Regularly review fallback performance and adjust model order accordingly.
42 changes: 42 additions & 0 deletions code-studio/enterprise-server/getting-started.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# Getting Started

## Start using Code Studio

### 1. Create and Access Your Account

To start using Code Studio, visit:
🔗 https://app.sfcodestudio.com

**Sign-In Options**
You can sign in using one of the following methods:

- **Microsoft Account**: Use your personal, work, or school Microsoft credentials.
- **GitHub Account**: Sign in with your GitHub credentials.
- **Syncfusion Account**: Use your existing Syncfusion login.

<img src="./enterprise-images/sign3.png" alt="getting started" />

> **Note**: If you don’t have an account, click “SIGN UP” to create one.



### 2. Accessing the Dashboard

Once signed in:

- You’ll be directed to the Dashboard.
- Click on your **Profile Icon** to access:
- **Settings**
- **Download Code Studio**
- From the profile menu, click **Download Code Studio** to get the setup file.

<img src="./enterprise-images/profile.png" alt="getting started" />

### 3. Managing Settings

Click on **Settings** to:

- Update your **Profile Information**
- Configure your **Organization Settings**

<img src="./enterprise-images/settings.png" alt="getting started" />
41 changes: 41 additions & 0 deletions code-studio/enterprise-server/providers&models.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# Configure LLM Providers and Models

This guide provides step-by-step instructions for administrators to configure Large Language Model (LLM) providers and manage models within Code Studio.

> **Note**: Only admins can configure LLM providers and models.


## 1. Adding an LLM Provider

To integrate an LLM provider into Code Studio:

**Steps:**

1. Navigate to the **LLM Configuration** section.
2. Click on **“Add LLM Key”**.
3. In the dialog box:
- **Provider Name**: Enter the name of the LLM provider (e.g., OpenAI, Anthropic).
- **API Key**: Paste the API key provided by the LLM service.
4. Click **“Add”** to save the provider.

✅ Once added, the provider will be available for model selection.

<img src="./enterprise-images/llm and providers.png" alt="Provider" />

## 2. Adding a Model to the Enterprise List

To add a model under a configured provider:

**Steps:**

1. Go to the **Models** section.
2. Use the **search bar** to look for a specific model.
3. Click **“Add Model”**.
4. In the form:
- **Provider**: Select from the list of configured providers.
- **Model**: Choose from the dropdown list of models available under the selected provider. Each model will list with the input cost and the output cost.
5. Click **“Add”** to include the model in your enterprise model list.

<img src="./enterprise-images/add model.png" alt="provider" />


73 changes: 73 additions & 0 deletions code-studio/enterprise-server/user&teams.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
# User & Teams

Code Studio empowers administrators and team leads to manage organization members, assign roles, and organize users into teams for seamless collaboration and governance.

## Key Benefits

- **Role Assignment**: Assign roles such as Admin, Team Lead, or User to match your organizational hierarchy.
- **Team Creation**: Easily create and manage teams with intuitive controls.
- **Usage Visibility**: Monitor usage and spending at both team and individual levels.
- **Streamlined Control**: Centralized management for onboarding, governance, and collaboration.

> **Note**: Only Admins and Team Leads can manage users and teams. Regular users do not have permission to make changes to team or user settings.



## Teams Management

### Team List Panel

- Located on the left side of the interface.
- Displays all existing teams, such as:
- BoldAgent Backend Team
- BoldAgent Frontend Team
- BoldBI-AI

### Selecting a Team

- Click on a team name to view its details.
- The selected team (e.g., BoldBI-AI-CodeStudio) will display its members and management options.

### Team Actions

Accessible via the context menu (three-dot icon):

- **Add Team**: Add a new team.
- **Rename Team**: Update the team name.
- **Add Team Member**: Invite new users to the team.
- **Set Team Owner**: Assign ownership for accountability.
- **Delete Team**: Remove the team from the organization.

<img src="./enterprise-images/teams.png" alt="user&Teams" />

## User Management

### Viewing Members

- The right panel shows team members.
- Each member can be managed individually.

### Adding Members

1. Click **“Invite User”** from the context menu.
2. Select the team from the dropdown.
3. Choose the role (Admin, Team Lead, User).
4. Enter the user’s email address.
5. Send the invitation. The user will be added upon acceptance.

<img src="./enterprise-images/invite user.png" alt="user&Teams" />

### Editing or Removing Members

- Use the team panel to:
- **Edit** user's name or user's role.
- **Remove** users from the team.

<img src="./enterprise-images/edituser.png" alt="user&Teams" />

## Best Practices

- **Maintain Clear Roles**: Assign roles based on responsibilities.
- **Audit Teams Regularly**: Ensure team structures reflect current projects.
- **Monitor Usage**: Use integrated analytics to track activity and spending.
- **Secure Onboarding**: Verify user details before sending invitations.