Simple Chat - Admin Configuration
Return to Main
Once the application is running and you log in as a user assigned the Admin role, you can access the Admin Settings page. This UI provides a centralized location to configure most application features and service connections.
Setup Walkthrough
The Admin Settings page includes an interactive Setup Walkthrough feature that guides you through the initial configuration process. This is particularly helpful for first-time setup.
Starting the Walkthrough
- The walkthrough automatically appears on first-time setup when critical settings are missing
- You can manually launch it anytime by clicking the "Start Setup Walkthrough" button at the top of the Admin Settings page
- The walkthrough will automatically navigate to the relevant configuration tabs as you progress through each step
Walkthrough Features
- Automatic Tab Navigation: As you move through steps, the walkthrough automatically switches to the relevant admin settings tab and scrolls to the appropriate section
- Smart Step Skipping: Steps that aren't applicable based on your configuration choices (e.g., workspace-dependent features) are automatically skipped
- Real-time Validation: The "Next" button becomes available only when required fields for the current step are completed
- Progress Tracking: Visual progress bar shows your completion status through the setup process
- Flexible Navigation: Use "Previous" and "Next" buttons to move between steps, or close the walkthrough at any time to configure settings manually
Walkthrough Steps Overview
The walkthrough covers these key configuration areas in order:
- Application Basics (Optional) - App title and logo
- GPT API Settings (Required) - Azure OpenAI GPT endpoint and authentication
- GPT Model Selection (Required) - Select available GPT models for users
- Workspaces (Optional) - Enable personal and/or group workspaces
- Embedding API (Required if workspaces enabled) - Configure embedding service
- Azure AI Search (Required if workspaces enabled) - Configure search indexing
- Document Intelligence (Required if workspaces enabled) - Configure document processing
- Video Support (Optional, workspace-dependent) - Configure video file processing
- Audio Support (Optional, workspace-dependent) - Configure audio file processing
- Content Safety (Optional) - Configure content filtering
- User Feedback & Archiving (Optional) - Enable feedback and conversation archiving
- Enhanced Features (Optional) - Enhanced citations and image generation
The walkthrough automatically adjusts which steps are required based on your selections. For example, if you don't enable workspaces, embedding and search configuration steps become optional.
Configuration Sections
Key configuration sections include:
1. General
- Branding: Application title, custom logo upload (light and dark mode), favicon
- Home Page Text: Landing page markdown content with alignment options and optional editor
- Appearance: Default theme (light/dark mode) and navigation layout (top nav or left sidebar)
- Health Check: External health check endpoint configuration for monitoring systems
- API Documentation: Enable/disable Swagger/OpenAPI documentation endpoint
- Classification Banner: Security classification banner for data sensitivity indication
- External Links: Custom navigation links to external resources with configurable menu behavior
- System Settings: Maximum file size, conversation history limit, default system prompt
2. AI Models
3. Workspaces
- Personal Workspaces: Enable/disable "Your Workspace" (personal docs)
- Group Workspaces:
- Enable/disable "Groups" (group docs)
- Option to enforce
CreateGroups RBAC role for creating new groups
- Public Workspaces:
- Enable/disable "Public" (public docs)
- Option to enforce
CreatePublicWorkspaces RBAC role for creating new public workspaces
- File Sharing:
- Enable/disable file sharing capabilities between users and workspaces.
- Metadata Extraction:
- Enable/disable metadata extraction from documents
- Select the GPT model used for extraction
- Multi-Modal Vision Analysis:
- Enable vision-capable models for image analysis in addition to document OCR
- Automatic filtering of compatible GPT models (GPT-4o, GPT-4 Vision, etc.)
- Document Classification:
- Enable/disable classification features
- Define custom classification labels and colors
- Dynamic category management with inline editing
4. Citations
- Standard Citations: Basic text references (always enabled)
- Enhanced Citations:
- Enable/disable enhanced citation features
- Configure Azure Storage Account Connection String or Service Endpoint with Managed Identity
- Store original files for direct reference and preview
5. Safety
- Content Safety:
- Enable/disable content filtering
- Configure endpoint (Direct/APIM)
- Key/Managed Identity authentication
- Test connection
- User Feedback:
- Enable/disable thumbs up/down feedback on AI responses
- Admin Access RBAC:
- Option to require
SafetyViolationAdmin role for safety violation admin views
- Option to require
FeedbackAdmin role for feedback admin views
- Conversation Archiving:
- Enable/disable conversation archiving instead of permanent deletion
6. Search & Extract
- Azure AI Search:
- Configure connection (Endpoint, Key/Managed Identity)
- Support for Direct or APIM routing
- Test connection
- Document Intelligence:
- Configure connection (Endpoint, Key/Managed Identity)
- Support for Direct or APIM routing
- Test connection
- Multimedia Support (Video/Audio uploads):
- Video Files: Configure Azure Video Indexer using Managed Identity authentication
- Resource Group, Subscription ID, Account Name, Location, Account ID
- API Endpoint, ARM API Version, Timeout
- Audio Files: Configure Speech Service
- Endpoint, Location/Region, Locale
- Key/Managed Identity authentication
7. Agents
- Agents Configuration:
- Enable/disable Semantic Kernel-powered agents
- Configure workspace mode (per-user vs global agents)
- Agent orchestration settings (single agent vs multi-agent group chat)
- Manage global agents and select default/orchestrator agent
- Actions Configuration:
- Enable/disable core plugins (Time, HTTP, Wait, Math, Text, Fact Memory, Embedding)
- Configure user and group plugin permissions
- Manage custom OpenAPI plugins
8. Scale
- Redis Cache:
- Enable distributed session storage for horizontal scaling
- Configure Redis endpoint and authentication (Key or Managed Identity)
- Test connection
- Front Door:
- Enable Azure Front Door integration
- Configure Front Door URL for authentication flows
- Supports global load balancing and custom domains
9. Logging
- Application Insights Logging:
- Enable global logging for agents and orchestration
- Requires application restart to take effect
- Debug Logging:
- Enable/disable debug print statements
- Optional time-based auto-disable feature
- Warning: Collects tokens and keys during debug
- File Processing Logs:
- Enable logging of file processing events
- Logs stored in Cosmos DB file_processing container
- Optional time-based auto-disable feature
Navigation Options
The Admin Settings page supports two navigation layouts:
- Tab Navigation (Default): Horizontal tabs at the top for switching between configuration sections
- Left Sidebar Navigation: Collapsible left sidebar with grouped navigation items
- Can be set as the default for all users in General → Appearance settings
- Users can toggle between layouts individually
- The Setup Walkthrough works seamlessly with both navigation styles
Tips for Configuration
- Save Changes: The floating "Save Settings" button in the bottom-right becomes active (blue) when you make changes
- Test Connections: Use the "Test Connection" buttons to verify your service configurations before saving
- APIM vs Direct: When using Azure API Management (APIM), you'll need to manually specify model names as automatic model fetching is not available
- Managed Identity: When using Managed Identity authentication, ensure your Service Principal has the appropriate roles assigned:
- Azure OpenAI: Cognitive Services OpenAI User role
- Speech Service: Cognitive Services Speech Contributor role (requires custom domain name on endpoint)
- Video Indexer: Appropriate Video Indexer roles for your account
- Dependencies: The walkthrough will alert you if required services aren't configured when you enable dependent features (e.g., workspaces require embeddings, AI Search, and Document Intelligence)
- Required vs Optional: The walkthrough clearly indicates which settings are required vs optional based on your configuration choices
1---2name: simple-chat-admin-configuration3description: Once the application is running and you log in as a user assigned the Admin role, you can access the Admin Settings page.4---5# Simple Chat - Admin Configuration67[Return to Main](../README.md)89Once the application is running and you log in as a user assigned the Admin role, you can access the **Admin Settings** page. This UI provides a centralized location to configure most application features and service connections.10111213## Setup Walkthrough1415The Admin Settings page includes an interactive **Setup Walkthrough** feature that guides you through the initial configuration process. This is particularly helpful for first-time setup.1617### Starting the Walkthrough1819- The walkthrough automatically appears on first-time setup when critical settings are missing20- You can manually launch it anytime by clicking the **"Start Setup Walkthrough"** button at the top of the Admin Settings page21- The walkthrough will automatically navigate to the relevant configuration tabs as you progress through each step2223### Walkthrough Features2425- **Automatic Tab Navigation**: As you move through steps, the walkthrough automatically switches to the relevant admin settings tab and scrolls to the appropriate section26- **Smart Step Skipping**: Steps that aren't applicable based on your configuration choices (e.g., workspace-dependent features) are automatically skipped27- **Real-time Validation**: The "Next" button becomes available only when required fields for the current step are completed28- **Progress Tracking**: Visual progress bar shows your completion status through the setup process29- **Flexible Navigation**: Use "Previous" and "Next" buttons to move between steps, or close the walkthrough at any time to configure settings manually3031### Walkthrough Steps Overview3233The walkthrough covers these key configuration areas in order:34351. **Application Basics** (Optional) - App title and logo362. **GPT API Settings** (Required) - Azure OpenAI GPT endpoint and authentication373. **GPT Model Selection** (Required) - Select available GPT models for users384. **Workspaces** (Optional) - Enable personal and/or group workspaces395. **Embedding API** (Required if workspaces enabled) - Configure embedding service406. **Azure AI Search** (Required if workspaces enabled) - Configure search indexing417. **Document Intelligence** (Required if workspaces enabled) - Configure document processing428. **Video Support** (Optional, workspace-dependent) - Configure video file processing439. **Audio Support** (Optional, workspace-dependent) - Configure audio file processing4410. **Content Safety** (Optional) - Configure content filtering4511. **User Feedback & Archiving** (Optional) - Enable feedback and conversation archiving4612. **Enhanced Features** (Optional) - Enhanced citations and image generation4748The walkthrough automatically adjusts which steps are required based on your selections. For example, if you don't enable workspaces, embedding and search configuration steps become optional.4950## Configuration Sections5152Key configuration sections include:5354### 1. General55- **Branding**: Application title, custom logo upload (light and dark mode), favicon56- **Home Page Text**: Landing page markdown content with alignment options and optional editor57- **Appearance**: Default theme (light/dark mode) and navigation layout (top nav or left sidebar)58- **Health Check**: External health check endpoint configuration for monitoring systems59- **API Documentation**: Enable/disable Swagger/OpenAPI documentation endpoint60- **Classification Banner**: Security classification banner for data sensitivity indication61- **External Links**: Custom navigation links to external resources with configurable menu behavior62- **System Settings**: Maximum file size, conversation history limit, default system prompt6364### 2. AI Models65- **GPT Configuration**: 66 - Configure Azure OpenAI endpoint(s) for chat models67 - Supports Direct endpoint or APIM (API Management)68 - Allows Key or Managed Identity authentication69 - Test connection button70 - Select multiple active deployment(s) - users can choose from available models71 - Multi-model selection for users72 73- **Embeddings Configuration**:74 - Configure Azure OpenAI endpoint(s) for embedding models75 - Supports Direct/APIM, Key/Managed Identity76 - Test connection77 - Select active deployment78 79- **Image Generation** *(Optional)*:80 - Enable/disable feature81 - Configure Azure OpenAI DALL-E endpoint82 - Supports Direct/APIM, Key/Managed Identity83 - Test connection84 - Select active deployment8586### 3. Workspaces87- **Personal Workspaces**: Enable/disable "Your Workspace" (personal docs)88- **Group Workspaces**: 89 - Enable/disable "Groups" (group docs)90 - Option to enforce `CreateGroups` RBAC role for creating new groups91- **Public Workspaces**: 92 - Enable/disable "Public" (public docs)93 - Option to enforce `CreatePublicWorkspaces` RBAC role for creating new public workspaces94- **File Sharing**:95 - Enable/disable file sharing capabilities between users and workspaces.96- **Metadata Extraction**:97 - Enable/disable metadata extraction from documents98 - Select the GPT model used for extraction99- **Multi-Modal Vision Analysis**:100 - Enable vision-capable models for image analysis in addition to document OCR101 - Automatic filtering of compatible GPT models (GPT-4o, GPT-4 Vision, etc.)102- **Document Classification**:103 - Enable/disable classification features104 - Define custom classification labels and colors105 - Dynamic category management with inline editing106107### 4. Citations108- **Standard Citations**: Basic text references (always enabled)109- **Enhanced Citations**:110 - Enable/disable enhanced citation features111 - Configure Azure Storage Account Connection String or Service Endpoint with Managed Identity112 - Store original files for direct reference and preview113114### 5. Safety115- **Content Safety**:116 - Enable/disable content filtering117 - Configure endpoint (Direct/APIM)118 - Key/Managed Identity authentication119 - Test connection120- **User Feedback**:121 - Enable/disable thumbs up/down feedback on AI responses122- **Admin Access RBAC**:123 - Option to require `SafetyViolationAdmin` role for safety violation admin views124 - Option to require `FeedbackAdmin` role for feedback admin views125- **Conversation Archiving**:126 - Enable/disable conversation archiving instead of permanent deletion127128### 6. Search & Extract129- **Azure AI Search**:130 - Configure connection (Endpoint, Key/Managed Identity)131 - Support for Direct or APIM routing132 - Test connection133- **Document Intelligence**:134 - Configure connection (Endpoint, Key/Managed Identity)135 - Support for Direct or APIM routing136 - Test connection137- **Multimedia Support** (Video/Audio uploads):138 - **Video Files**: Configure Azure Video Indexer using Managed Identity authentication139 - Resource Group, Subscription ID, Account Name, Location, Account ID140 - API Endpoint, ARM API Version, Timeout141 - **Audio Files**: Configure Speech Service142 - Endpoint, Location/Region, Locale143 - Key/Managed Identity authentication144145### 7. Agents146- **Agents Configuration**:147 - Enable/disable Semantic Kernel-powered agents148 - Configure workspace mode (per-user vs global agents)149 - Agent orchestration settings (single agent vs multi-agent group chat)150 - Manage global agents and select default/orchestrator agent151- **Actions Configuration**:152 - Enable/disable core plugins (Time, HTTP, Wait, Math, Text, Fact Memory, Embedding)153 - Configure user and group plugin permissions154 - Manage custom OpenAPI plugins155156### 8. Scale157- **Redis Cache**:158 - Enable distributed session storage for horizontal scaling159 - Configure Redis endpoint and authentication (Key or Managed Identity)160 - Test connection161- **Front Door**:162 - Enable Azure Front Door integration163 - Configure Front Door URL for authentication flows164 - Supports global load balancing and custom domains165166### 9. Logging167- **Application Insights Logging**:168 - Enable global logging for agents and orchestration169 - Requires application restart to take effect170- **Debug Logging**:171 - Enable/disable debug print statements172 - Optional time-based auto-disable feature173 - Warning: Collects tokens and keys during debug174- **File Processing Logs**:175 - Enable logging of file processing events176 - Logs stored in Cosmos DB file_processing container177 - Optional time-based auto-disable feature178179## Navigation Options180181The Admin Settings page supports two navigation layouts:1821831. **Tab Navigation** (Default): Horizontal tabs at the top for switching between configuration sections1842. **Left Sidebar Navigation**: Collapsible left sidebar with grouped navigation items185 - Can be set as the default for all users in General → Appearance settings186 - Users can toggle between layouts individually187 - The Setup Walkthrough works seamlessly with both navigation styles188189## Tips for Configuration190191- **Save Changes**: The floating "Save Settings" button in the bottom-right becomes active (blue) when you make changes192- **Test Connections**: Use the "Test Connection" buttons to verify your service configurations before saving193- **APIM vs Direct**: When using Azure API Management (APIM), you'll need to manually specify model names as automatic model fetching is not available194- **Managed Identity**: When using Managed Identity authentication, ensure your Service Principal has the appropriate roles assigned:195 - **Azure OpenAI**: Cognitive Services OpenAI User role196 - **Speech Service**: Cognitive Services Speech Contributor role (requires custom domain name on endpoint)197 - **Video Indexer**: Appropriate Video Indexer roles for your account198- **Dependencies**: The walkthrough will alert you if required services aren't configured when you enable dependent features (e.g., workspaces require embeddings, AI Search, and Document Intelligence)199- **Required vs Optional**: The walkthrough clearly indicates which settings are required vs optional based on your configuration choices