Settings page for Admins

[paullizer]

Ideas for General Settings

1. Application Title

• Description: Modify the title of the application that appears in the browser tab, login page, and header.
• Implementation: Provide a text input field where admins can enter the desired application title.
• Use Case: Allows organizations to brand the application with their preferred name.

2. Logo Upload

• Description: Add or change the application's logo displayed on the login page and header.
• Implementation: Allow admins to upload an image file (e.g., PNG, JPEG). The uploaded logo replaces the default one.
• Use Case: Enables customization to match the organization's branding guidelines.

---

AI Configuration

3. Select LLM Model

• Description: Choose which Language Model is used for generating AI responses.
• Options: Provide a dropdown menu with available models (e.g., GPT-3.5, GPT-4).
• Implementation: Update the application's configuration to use the selected model in OpenAI API calls.
• Use Case: Allows admins to select a model that balances performance and cost according to their needs.
• [NEW 12/19/2024] Add deployment name: Add new values to the drop down to improve flexibility and new models over time.

---

External Service Configuration

4a. Configure External APIs for Chunking and Embedding

• Description: Redirect the chunking and embedding processes to an external system by providing API endpoints.
• Settings:
  • Chunking API Endpoint: Input field for the external chunking service's API endpoint.
  • Embedding API Endpoint: Input field for the external embedding service's API endpoint.
  • API Keys/Credentials: Securely input and store authentication details for these services.
• Implementation: Modify the functions responsible for chunking and embedding to call the provided external APIs.
• Use Case: Facilitates scaling by offloading resource-intensive tasks to specialized services.

[NEW 12/19/2024]4b. Configure Endpoint for Azure OpenAI

• Description: Add ability to define url for Azure OpenAI, this provides support for APIM-based URLs, must follow same URL schema.
• Settings: Validate url schema https://{endpoint.domain}/openai/deployments/{model}/completions?api-version={version}

---

File Upload Settings

5. Allowed File Types

• Description: Define which file types users are permitted to upload.
• Implementation: Provide a multi-select list of file extensions (e.g., .txt, .pdf, .docx).
• Use Case: Helps in controlling the types of documents processed, enhancing security and compliance.

6. Maximum File Size

• Description: Set the maximum file size for uploads to prevent excessively large files.
• Implementation: Input field (in MB) to adjust the MAX_CONTENT_LENGTH setting.
• Use Case: Prevents performance issues and resource overconsumption.

---

Conversation Settings

7. Conversation History Limit

• Description: Adjust how many previous messages are included when generating AI responses.
• Implementation: Input field to set the maximum number of messages retained in conversation history.
• Use Case: Balances context depth with performance, ensuring relevant interactions without overloading the system.

8. Default System Prompt

• Description: Customize the default system prompt or initial message used in AI conversations.
• Implementation: Text area for admins to input the desired default prompt.
• Use Case: Aligns AI interactions with organizational policies and tone.

---

Notification Settings

9. Email Notification Templates

• Description: Edit the content of email notifications sent to users when conversations are shared.
• Implementation: Text editor for modifying email templates, supporting placeholders for dynamic content.
• Use Case: Personalizes communication and ensures consistency with branding and messaging standards.

---

User Interface Customization

10. Theme Selection

• Description: Select or customize the application's theme to match organizational branding.
• Implementation: Provide options for predefined themes or color customization via color pickers.
• Use Case: Enhances user experience by aligning the UI with familiar branding elements.

---

Security and Privacy Settings

11. Session Timeout

• Description: Set the duration of user inactivity before automatic logout.
• Implementation: Input field (in minutes) to specify the session timeout duration.
• Use Case: Enhances security by reducing the risk of unauthorized access on unattended devices.

12. Privacy Policy and Terms of Use

• Description: Input or link to the organization's privacy policy and terms of use.
• Implementation: Text fields or file upload options to provide this information.
• Use Case: Ensures users are informed about data handling practices and legal terms.

---

Analytics and Logging

13. Enable Debug Logging

• Description: Allow admins to enable or disable debug-level logging for troubleshooting.
• Implementation: Toggle switch to activate or deactivate debug logging.
• Use Case: Facilitates issue diagnosis during development or when encountering problems.

---

Additional Configurations Based on the App's Code

14. Text Chunking Parameters

• Description: Configure settings related to text chunking during document processing.
• Implementation:
  • Chunk Size: Input field to specify the number of words per chunk.
  • Overlap Size: Input field to specify the overlap between chunks.
• Use Case: Optimizes document processing for better search and embedding results.

15. Hybrid Search Parameters

• Description: Adjust parameters for the hybrid search functionality used in AI responses.
• Implementation:
  • Enable Hybrid Search: Toggle to enable or disable the hybrid search feature.
  • Top N Results: Input field to set the number of top search results to consider.
• Use Case: Fine-tunes the balance between search relevance and performance.

---

Implementation Considerations

• Access Control: Only users with administrative privileges can access and modify these settings.
• Validation and Error Handling: Implement input validation to prevent invalid or harmful configurations.
• Secure Storage: Sensitive information like API credentials should be encrypted and stored securely.
• User Interface Design: Organize settings into logical sections with clear labels and descriptions.
• Real-Time Updates: Apply configuration changes immediately without requiring a server restart when possible.
• Audit Logging: Record changes made to settings for accountability and troubleshooting.

[paullizer]

Added settings page to v0.59. Working to add App Roles for users and admins to control access to admin_settings page. Will close this when that is complete, will include app version.

1. Application Title

• Description: Modify the title of the application that appears in the browser tab, login page, and header.
• Implementation: Provide a text input field where admins can enter the desired application title.
• Use Case: Allows organizations to brand the application with their preferred name.

2. Logo Upload

• Description: Add or change the application's logo displayed on the login page and header.
• Implementation: Allow admins to upload an image file (e.g., PNG, JPEG). The uploaded logo replaces the default one.
• Use Case: Enables customization to match the organization's branding guidelines.

---

AI Configuration

3. Select LLM Model

• Description: Choose which Language Model is used for generating AI responses.
• Options: Provide a dropdown menu with available models (e.g., GPT-3.5, GPT-4).
• Implementation: Update the application's configuration to use the selected model in OpenAI API calls.
• Use Case: Allows admins to select a model that balances performance and cost according to their needs.

External Service Configuration

4. Configure External APIs for Chunking and Embedding

• Description: Redirect the chunking and embedding processes to an external system by providing API endpoints. This is a check box to enable this capability which them allows the edit of an input that contains the URL along with a test connection button that validates the URL by testing if GET URL/api/version returns a value, if so show the value and confirm connectivity, otherwise inform the admin that the test connection failed and they validate the service.

• Settings

  :

  • Chunking API Endpoint: Input field for the external chunking service's API endpoint.
  • Embedding API Endpoint: Input field for the external embedding service's API endpoint.
  • API Keys/Credentials: Securely input and store authentication details for these services.

• Implementation: Modify the functions responsible for chunking and embedding to call the provided external APIs.

• Use Case: Facilitates scaling by offloading resource-intensive tasks to specialized services.

File Upload Settings

6. Maximum File Size

• Description: Set the maximum file size for uploads to prevent excessively large files.
• Implementation: Input field (in MB) to adjust the MAX_CONTENT_LENGTH setting.
• Use Case: Prevents performance issues and resource overconsumption.

Conversation Settings

7. Conversation History Limit

• Description: Adjust how many previous messages are included when generating AI responses.
• Implementation: Input field to set the maximum number of messages retained in conversation history.
• Use Case: Balances context depth with performance, ensuring relevant interactions without overloading the system.

8. Default System Prompt

• Description: Customize the default system prompt or initial message used in AI conversations.
• Implementation: Text area for admins to input the desired default prompt.
• Use Case: Aligns AI interactions with organizational policies and tone.

[paullizer]

Application now requires being member of User or Admin app role.

User has access to the application
Admin has access to the application PLUS access to the Admin settings