From 0c568cc72c1c92261a3c9bab8ea213a14eeb7c87 Mon Sep 17 00:00:00 2001 From: 2pk03 Date: Sat, 21 Feb 2026 20:23:32 +0100 Subject: [PATCH 01/20] chore: rename Scalytics Connect to Scalytics Copilot --- .github/ISSUE_TEMPLATE/bug_report.yml | 2 +- CONTRIBUTING.md | 2 +- NOTICE | 2 +- README.md | 10 +++--- docs/admin/content-filtering-guide.md | 2 +- docs/admin/huggingface-setup.md | 4 +-- docs/admin/local-model-optimization.md | 4 +-- docs/admin/oauth-integration-guide.md | 6 ++-- docs/admin/prompt-controls.md | 2 +- docs/admin/scalytics-api-guide.md | 8 ++--- ...scalytics-copilot-agent-administration.md} | 30 ++++++++--------- docs/admin/scalytics-deep-search-guide.md | 4 +-- docs/developer/dependency-upgrade-plan.md | 2 +- .../integrating-with-coding-tools.md | 32 +++++++++---------- docs/developer/messaging-hub-guide.md | 4 +-- docs/developer/scalytics-api-guide.md | 16 +++++----- ...m.md => scalytics-copilot-agent-system.md} | 26 +++++++-------- docs/index.md | 4 +-- docs/user/ai-agents-guide.md | 4 +-- docs/user/chat-system-guide.md | 16 +++++----- docs/user/prompt-engineering-guide.md | 10 +++--- docs/user/scalytics-api-guide.md | 6 ++-- docs/user/scalytics-deep-search-guide.md | 4 +-- frontend/package-lock.json | 4 +-- frontend/package.json | 2 +- frontend/public/index.html | 14 ++++---- frontend/public/manifest.json | 4 +-- .../admin/local-tools/LocalToolsManager.jsx | 2 +- .../admin/statistics/StatisticsPanel.jsx | 4 +-- frontend/src/components/auth/LoginForm.jsx | 2 +- frontend/src/components/auth/RegisterForm.jsx | 2 +- frontend/src/components/chat/ChatContent.jsx | 2 +- .../src/components/dashboard/WelcomeCard.jsx | 2 +- .../src/components/settings/ThemeSettings.jsx | 2 +- frontend/src/pages/DocumentationPage.jsx | 6 ++-- frontend/src/pages/LoginPage.jsx | 2 +- frontend/src/pages/SetPasswordPage.jsx | 2 +- frontend/src/services/admin/userService.js | 4 +-- initial-prep/setup-frontend.sh | 12 +++---- package-lock.json | 4 +-- package.json | 2 +- .../migrations/003_add_scalytics_api.js | 2 +- src/config/swagger.js | 4 +-- src/controllers/admin/adminStatsController.js | 2 +- start-app.sh | 2 +- 45 files changed, 141 insertions(+), 141 deletions(-) rename docs/admin/{scalytics-connect-agent-administration.md => scalytics-copilot-agent-administration.md} (89%) rename docs/developer/{scalytics-connect-agent-system.md => scalytics-copilot-agent-system.md} (88%) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index dd9c3a3..7dd4541 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -1,5 +1,5 @@ name: Bug Report -description: Report a reproducible problem in Scalytics Connect +description: Report a reproducible problem in Scalytics Copilot title: "[Bug]: " labels: ["bug"] body: diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index eafe204..0cf731d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,4 @@ -# Contributing to Scalytics Connect +# Contributing to Scalytics Copilot Thanks for contributing. This document defines the expected workflow for issues, changes, and pull requests. diff --git a/NOTICE b/NOTICE index d493a0b..45bfe1c 100644 --- a/NOTICE +++ b/NOTICE @@ -1,4 +1,4 @@ -ScalyticsConnect +ScalyticsCopilot Copyright 2024-present Scalytics, Inc. (https://www.scalytics.io) This product includes software developed by Scalytics, Inc. diff --git a/README.md b/README.md index 682bca9..ff1c275 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,14 @@ -# Scalytics Connect +# Scalytics Copilot -[![CI](https://github.com/scalytics/ScalyticsConnect/actions/workflows/ci.yml/badge.svg)](https://github.com/scalytics/ScalyticsConnect/actions/workflows/ci.yml) [![Secrets Scan](https://github.com/scalytics/ScalyticsConnect/actions/workflows/secrets-scan.yml/badge.svg)](https://github.com/scalytics/ScalyticsConnect/actions/workflows/secrets-scan.yml) +[![CI](https://github.com/scalytics/ScalyticsCopilot/actions/workflows/ci.yml/badge.svg)](https://github.com/scalytics/ScalyticsCopilot/actions/workflows/ci.yml) [![Secrets Scan](https://github.com/scalytics/ScalyticsCopilot/actions/workflows/secrets-scan.yml/badge.svg)](https://github.com/scalytics/ScalyticsCopilot/actions/workflows/secrets-scan.yml) -Scalytics Connect is a private AI operations platform for organizations that need governance, deployment control, and auditability for GenAI workloads. +Scalytics Copilot is a private AI operations platform for organizations that need governance, deployment control, and auditability for GenAI workloads. Built by [Scalytics](https://www.scalytics.io), it is designed for teams that cannot rely on unmanaged black-box AI tooling. ## The Niche We Serve -Most AI chat stacks optimize for speed-to-demo. Scalytics Connect optimizes for production control: +Most AI chat stacks optimize for speed-to-demo. Scalytics Copilot optimizes for production control: - data locality and controlled model access - role-based permissions and policy enforcement @@ -17,7 +17,7 @@ Most AI chat stacks optimize for speed-to-demo. Scalytics Connect optimizes for ## For Enterprise Teams -Use Scalytics Connect when you need: +Use Scalytics Copilot when you need: - governed AI operations across departments - user/group/permission controls at model and provider level diff --git a/docs/admin/content-filtering-guide.md b/docs/admin/content-filtering-guide.md index c2ef76a..feb9d79 100644 --- a/docs/admin/content-filtering-guide.md +++ b/docs/admin/content-filtering-guide.md @@ -1,6 +1,6 @@ # Content Filtering Guide (Admin) -This guide explains how administrators can configure and manage the Content Filtering system within Scalytics Connect to prevent the leakage of sensitive information in AI responses. +This guide explains how administrators can configure and manage the Content Filtering system within Scalytics Copilot to prevent the leakage of sensitive information in AI responses. ## Overview diff --git a/docs/admin/huggingface-setup.md b/docs/admin/huggingface-setup.md index 2e614de..f136dcd 100644 --- a/docs/admin/huggingface-setup.md +++ b/docs/admin/huggingface-setup.md @@ -21,7 +21,7 @@ If you don't already have one, create an account on [huggingface.co](https://hug 2. Go to your **Settings** page by clicking on your profile picture in the top-right corner. 3. In the left sidebar, navigate to **Access Tokens**. 4. Click the **"New token"** button. -5. Give your token a descriptive name (e.g., "Scalytics Connect Access"). +5. Give your token a descriptive name (e.g., "Scalytics Copilot Access"). 6. Assign it the **`read`** role. The `write` role is not necessary for downloading models. 7. **Important**: In the token's **fine-grained permissions**, ensure the following are enabled: - ✅ **"Read access to public gated repositories"** - Required for downloading gated models @@ -44,7 +44,7 @@ These permissions allow the system to: ### Step 4: Use the Token in the Application 1. Copy the generated token immediately. For security reasons, you will not be able to see it again. -2. In the Scalytics Connect admin panel, go to the **Admin -> Models -> Hugging Face** page. +2. In the Scalytics Copilot admin panel, go to the **Admin -> Models -> Hugging Face** page. 3. You will see a **"Hugging Face Hub Login"** section. 4. Paste your copied token into the input field and click **"Login"**. diff --git a/docs/admin/local-model-optimization.md b/docs/admin/local-model-optimization.md index d02a04e..bd8f5d8 100644 --- a/docs/admin/local-model-optimization.md +++ b/docs/admin/local-model-optimization.md @@ -4,7 +4,7 @@ This comprehensive reference provides enterprise-grade configuration parameters ## Introduction to vLLM-Powered Inference -Scalytics Connect now uses **vLLM** (Very Fast LLM) as the unified inference engine for all local models. vLLM provides state-of-the-art serving throughput with dynamic batching, optimized attention mechanisms, and efficient memory management. All models are downloaded in PyTorch format from HuggingFace and automatically optimized by vLLM. +Scalytics Copilot now uses **vLLM** (Very Fast LLM) as the unified inference engine for all local models. vLLM provides state-of-the-art serving throughput with dynamic batching, optimized attention mechanisms, and efficient memory management. All models are downloaded in PyTorch format from HuggingFace and automatically optimized by vLLM. ## Key vLLM Advantages @@ -24,7 +24,7 @@ Scalytics Connect now uses **vLLM** (Very Fast LLM) as the unified inference eng ## Default Inference Parameters -Scalytics Connect uses the following optimized default parameters for vLLM inference: +Scalytics Copilot uses the following optimized default parameters for vLLM inference: | Parameter | Default Value | Description | |-----------|--------------|-------------| diff --git a/docs/admin/oauth-integration-guide.md b/docs/admin/oauth-integration-guide.md index 071f432..8c14b6c 100644 --- a/docs/admin/oauth-integration-guide.md +++ b/docs/admin/oauth-integration-guide.md @@ -1,10 +1,10 @@ # OAuth Integration Guide -This guide covers the OAuth integration features of Scalytics Connect, including security considerations for administrators. +This guide covers the OAuth integration features of Scalytics Copilot, including security considerations for administrators. ## Overview -Scalytics Connect supports OAuth integration with several identity providers to enable single sign-on (SSO) functionality. When enabled, users can authenticate using their accounts from supported providers such as GitHub, Google, Microsoft, Azure AD, or Okta. +Scalytics Copilot supports OAuth integration with several identity providers to enable single sign-on (SSO) functionality. When enabled, users can authenticate using their accounts from supported providers such as GitHub, Google, Microsoft, Azure AD, or Okta. ## Supported Providers @@ -89,5 +89,5 @@ If you encounter issues with OAuth: ## Related Documentation -- [Scalytics Connect Agent Administration](./scalytics-connect-agent-administration.md) +- [Scalytics Copilot Agent Administration](./scalytics-copilot-agent-administration.md) - [External API Integrations](../developer/api-integration.md) (if available) diff --git a/docs/admin/prompt-controls.md b/docs/admin/prompt-controls.md index 078ac96..31f6823 100644 --- a/docs/admin/prompt-controls.md +++ b/docs/admin/prompt-controls.md @@ -41,7 +41,7 @@ This approach allows administrators to establish mandatory final guidelines via ## Context Window Management -To prevent errors and ensure reliable responses, Scalytics Connect automatically manages the conversation history to fit within the selected AI model's context window limit. This involves several steps, primarily handled by the Inference Router service (`src/services/inferenceRouter.js`). +To prevent errors and ensure reliable responses, Scalytics Copilot automatically manages the conversation history to fit within the selected AI model's context window limit. This involves several steps, primarily handled by the Inference Router service (`src/services/inferenceRouter.js`). ### Overview diff --git a/docs/admin/scalytics-api-guide.md b/docs/admin/scalytics-api-guide.md index 93cd03c..9fcc80a 100644 --- a/docs/admin/scalytics-api-guide.md +++ b/docs/admin/scalytics-api-guide.md @@ -4,7 +4,7 @@ This guide explains how administrators can manage the Scalytics API feature, whi ## Feature Overview -The Scalytics API allows users to generate API keys that can be used to authenticate requests against the `/v1/chat/completions` endpoint. This enables integration with development tools, scripts, or other applications that support the OpenAI API format, but restricts usage to the local models hosted within this Scalytics Connect instance. +The Scalytics API allows users to generate API keys that can be used to authenticate requests against the `/v1/chat/completions` endpoint. This enables integration with development tools, scripts, or other applications that support the OpenAI API format, but restricts usage to the local models hosted within this Scalytics Copilot instance. ## Concurrency and Model Selection @@ -45,15 +45,15 @@ While users generate their own Scalytics API keys via their personal settings pa * **Key Security:** Remind users that Scalytics API keys should be treated like passwords and kept confidential. Deleting a user's key is the way to revoke their specific access. * **Rate Limiting:** Monitor overall API usage patterns (e.g., via logs or system monitoring) and adjust the global rate limits as necessary to balance usability and protect server resources. * **Global Toggle:** Use the global disable switch when the API feature needs to be temporarily or permanently deactivated for maintenance or security reasons. -* **System Prompts:** Note that the Scalytics API endpoint (`/v1/chat/completions`) does **not** automatically apply any system prompts or profiles configured for the local model within the main Scalytics Connect UI. For API usage, any desired system prompt must be explicitly included by the client application as the first message in the `messages` array with `role: "system"`. This ensures compatibility with standard OpenAI client behavior. +* **System Prompts:** Note that the Scalytics API endpoint (`/v1/chat/completions`) does **not** automatically apply any system prompts or profiles configured for the local model within the main Scalytics Copilot UI. For API usage, any desired system prompt must be explicitly included by the client application as the first message in the `messages` array with `role: "system"`. This ensures compatibility with standard OpenAI client behavior. ## Connecting to a Remote Scalytics Instance -You can configure this Scalytics Connect instance to use the models hosted on *another* Scalytics Connect instance. This is achieved by treating the remote instance's Scalytics API as an external provider and using a Global API Key. +You can configure this Scalytics Copilot instance to use the models hosted on *another* Scalytics Copilot instance. This is achieved by treating the remote instance's Scalytics API as an external provider and using a Global API Key. **Prerequisites:** -* Access to the *remote* Scalytics Connect instance. +* Access to the *remote* Scalytics Copilot instance. * An API key generated on the *remote* instance (via Settings -> API Keys -> Generate Scalytics API Key). * The base URL of the *remote* instance (e.g., `https://remote-scalytics.yourcompany.com`). diff --git a/docs/admin/scalytics-connect-agent-administration.md b/docs/admin/scalytics-copilot-agent-administration.md similarity index 89% rename from docs/admin/scalytics-connect-agent-administration.md rename to docs/admin/scalytics-copilot-agent-administration.md index 9fed112..4871d67 100644 --- a/docs/admin/scalytics-connect-agent-administration.md +++ b/docs/admin/scalytics-copilot-agent-administration.md @@ -1,10 +1,10 @@ -# Scalytics Connect Agent Administration Guide +# Scalytics Copilot Agent Administration Guide -This guide is intended for system administrators responsible for configuring, managing, and monitoring the Scalytics Connect Agent system. +This guide is intended for system administrators responsible for configuring, managing, and monitoring the Scalytics Copilot Agent system. ## Overview -The Scalytics Connect Agent system provides AI agent capabilities to your users through a WebSocket-based communication protocol. As an administrator, you'll be responsible for: +The Scalytics Copilot Agent system provides AI agent capabilities to your users through a WebSocket-based communication protocol. As an administrator, you'll be responsible for: 1. Configuring available agent types 2. Managing tool permissions @@ -13,7 +13,7 @@ The Scalytics Connect Agent system provides AI agent capabilities to your users ## System Requirements -The Scalytics Connect Agent system relies on the following components: +The Scalytics Copilot Agent system relies on the following components: - Node.js server with WebSocket support - Database for agent state persistence @@ -59,7 +59,7 @@ Tools are configured in `config/tools.json`. Each tool requires: ### Permission Levels -The Scalytics Connect Agent system uses the following permission levels: +The Scalytics Copilot Agent system uses the following permission levels: | Level | Description | Approval Required | Example Tools | |-------|-------------|-------------------|--------------| @@ -88,7 +88,7 @@ Example PM2 configuration: ```json { "apps": [{ - "name": "scalytics-connect-agent-server", + "name": "scalytics-copilot-agent-server", "script": "server.js", "instances": "max", "exec_mode": "cluster", @@ -137,7 +137,7 @@ http { ### Assigning Agent Access -Control which users have access to which agents through the Scalytics Connect Admin panel: +Control which users have access to which agents through the Scalytics Copilot Admin panel: 1. Navigate to Admin > User Management 2. Select a user @@ -240,12 +240,12 @@ All agent activities are logged for security and troubleshooting: ### Log Analysis -The Scalytics Connect Agent system writes logs to the following locations: +The Scalytics Copilot Agent system writes logs to the following locations: -- **Application logs**: `/var/log/scalyticsconnect/application.log` -- **WebSocket logs**: `/var/log/scalyticsconnect/websocket.log` -- **Agent logs**: `/var/log/scalyticsconnect/agents.log` -- **Error logs**: `/var/log/scalyticsconnect/error.log` +- **Application logs**: `/var/log/scalyticscopilot/application.log` +- **WebSocket logs**: `/var/log/scalyticscopilot/websocket.log` +- **Agent logs**: `/var/log/scalyticscopilot/agents.log` +- **Error logs**: `/var/log/scalyticscopilot/error.log` Use the log viewer in Admin > System > Logs for filtering and analysis. @@ -281,7 +281,7 @@ Consider the following for data privacy: ### Updates -When updating the Scalytics Connect Agent system: +When updating the Scalytics Copilot Agent system: 1. Review the changelog for breaking changes 2. Backup configuration files @@ -308,5 +308,5 @@ Recovery procedure: ## Support Resources - **Documentation**: `/docs/admin/agent-administration.md` -- **Knowledge Base**: Internal support portal > Scalytics Connect Agents -- **Support Contact**: support@scalyticsconnect.example.com or internal ticket system +- **Knowledge Base**: Internal support portal > Scalytics Copilot Agents +- **Support Contact**: support@scalyticscopilot.example.com or internal ticket system diff --git a/docs/admin/scalytics-deep-search-guide.md b/docs/admin/scalytics-deep-search-guide.md index 70cc0f6..72287b2 100644 --- a/docs/admin/scalytics-deep-search-guide.md +++ b/docs/admin/scalytics-deep-search-guide.md @@ -42,7 +42,7 @@ Deep Search requires a locally hosted text embedding model to convert text chunk 1. Navigate to **Admin Panel -> Models**. 2. Locate the downloaded local embedding model you wish to use (it will be marked with a purple icon and "Local Embedding" type). 3. If the model is not the current default (Status will be "Inactive (Not Preferred)"), click the **"Set as System Embedding Model"** button (checkmark icon) in the Actions column. -4. **Important:** After setting a new preferred embedding model, you **must restart the Scalytics Connect server** for the change to take effect and the new model to be loaded by the embedding worker. +4. **Important:** After setting a new preferred embedding model, you **must restart the Scalytics Copilot server** for the change to take effect and the new model to be loaded by the embedding worker. **d) CRITICAL WARNING: Changing the Embedding Model Post-Initialization** @@ -85,7 +85,7 @@ By default, Deep Search is optimized for English queries. However, it can be con * Open the `src/python_services/deep_search_service/config.py` file. * Locate the `DEEP_SEARCH_EMBEDDING_MODEL_IS_MULTILINGUAL` setting. * Change its value from `False` to `True`. - * Save the file and restart the Scalytics Connect server for the change to take effect. + * Save the file and restart the Scalytics Copilot server for the change to take effect. ## 3. Configuring Search Providers diff --git a/docs/developer/dependency-upgrade-plan.md b/docs/developer/dependency-upgrade-plan.md index c85a821..236140b 100644 --- a/docs/developer/dependency-upgrade-plan.md +++ b/docs/developer/dependency-upgrade-plan.md @@ -1,7 +1,7 @@ # Dependency Upgrade Plan ## Goal -Keep ScalyticsConnect secure and maintainable while minimizing regression risk. +Keep ScalyticsCopilot secure and maintainable while minimizing regression risk. ## Principles - Upgrade in small batches, not all-at-once. diff --git a/docs/developer/integrating-with-coding-tools.md b/docs/developer/integrating-with-coding-tools.md index d563ddc..2aa48ee 100644 --- a/docs/developer/integrating-with-coding-tools.md +++ b/docs/developer/integrating-with-coding-tools.md @@ -1,51 +1,51 @@ -# Integrating Scalytics Connect with Coding Tools & Chatbots +# Integrating Scalytics Copilot with Coding Tools & Chatbots -Scalytics Connect provides a powerful API that can be integrated into various developer tools, IDE extensions, and chatbots to leverage its AI capabilities directly within your workflow. This guide explains how to connect external tools using the OpenAI-compatible endpoint. +Scalytics Copilot provides a powerful API that can be integrated into various developer tools, IDE extensions, and chatbots to leverage its AI capabilities directly within your workflow. This guide explains how to connect external tools using the OpenAI-compatible endpoint. -**Important Note:** While Scalytics Connect offers an OpenAI-compatible API endpoint for broad compatibility, its current implementation focuses on robust **text-based interactions**. Features like direct image or audio processing via the API are not supported at this time. This focus ensures a secure and controlled environment suitable for enterprise use cases centered around code generation, text analysis, and data processing. Future updates may expand modality support. +**Important Note:** While Scalytics Copilot offers an OpenAI-compatible API endpoint for broad compatibility, its current implementation focuses on robust **text-based interactions**. Features like direct image or audio processing via the API are not supported at this time. This focus ensures a secure and controlled environment suitable for enterprise use cases centered around code generation, text analysis, and data processing. Future updates may expand modality support. ## OpenAI-Compatible Endpoint -Scalytics Connect exposes an endpoint compatible with the OpenAI API standard. This makes it easy to integrate with tools that already support connecting to OpenAI or other compatible services. +Scalytics Copilot exposes an endpoint compatible with the OpenAI API standard. This makes it easy to integrate with tools that already support connecting to OpenAI or other compatible services. -**Endpoint URL:** `https://YOUR_SCALYTICS_CONNECT_URL/v1` +**Endpoint URL:** `https://YOUR_SCALYTICS_COPILOT_URL/v1` -Replace `YOUR_SCALYTICS_CONNECT_URL` with the actual base URL of your Scalytics Connect instance. +Replace `YOUR_SCALYTICS_COPILOT_URL` with the actual base URL of your Scalytics Copilot instance. ## Authentication -Authentication is handled via API Keys generated within Scalytics Connect. +Authentication is handled via API Keys generated within Scalytics Copilot. -1. Navigate to the API Key management section in the Scalytics Connect admin interface. +1. Navigate to the API Key management section in the Scalytics Copilot admin interface. 2. Generate a new API key specifically for your tool or integration. 3. Use this key as the `Bearer` token in the `Authorization` header of your API requests, or input it into the appropriate API Key field in your tool's configuration. ## Example: Integrating with Cline -[Cline](https://cline.bot/enterprise) is an AI coding assistant available as a VS Code extension (search for "Cline" in the VS Code Marketplace) that can be configured to use Scalytics Connect as its backend. +[Cline](https://cline.bot/enterprise) is an AI coding assistant available as a VS Code extension (search for "Cline" in the VS Code Marketplace) that can be configured to use Scalytics Copilot as its backend. **Configuration Steps (within Cline VS Code Extension Settings):** 1. **Provider:** Select `OpenAI compatible`. -2. **BaseURL:** Enter your Scalytics Connect API endpoint: `https://YOUR_SCALYTICS_CONNECT_URL/v1` -3. **API Key:** Paste the API key you generated in Scalytics Connect. -4. **Model ID:** Specify the model name you want Cline to use (in case you have multiple models under an advanced enterprise license), as configured in Scalytics Connect (e.g., `deepseek-ai/deepseek-coder-6.7b-instruct`, `mistralai/Mistral-7B-Instruct-v0.3`, etc.). You can find the model name in the Scalytics Connect chat panel when you create a new chat. +2. **BaseURL:** Enter your Scalytics Copilot API endpoint: `https://YOUR_SCALYTICS_COPILOT_URL/v1` +3. **API Key:** Paste the API key you generated in Scalytics Copilot. +4. **Model ID:** Specify the model name you want Cline to use (in case you have multiple models under an advanced enterprise license), as configured in Scalytics Copilot (e.g., `deepseek-ai/deepseek-coder-6.7b-instruct`, `mistralai/Mistral-7B-Instruct-v0.3`, etc.). You can find the model name in the Scalytics Copilot chat panel when you create a new chat. **Note**: If only one model is active, the API will use the default model and ignore any incorrect model names. 5. **Model Configuration:** - **Supports Images:** Uncheck this box. -- **Context Window:** Set this to match the context window configured for the selected model in Scalytics Connect (e.g., `65536`, `32768`, `128000`, etc.). Using the correct context window size ensures optimal performance and prevents errors. +- **Context Window:** Set this to match the context window configured for the selected model in Scalytics Copilot (e.g., `65536`, `32768`, `128000`, etc.). Using the correct context window size ensures optimal performance and prevents errors. - **Max Output Tokens:** Leave it at `-1`, or set it to a value you feel comfortable with. - **Temperature:** Leave it at `0` for debug purposes and deterministic code suggestions. Values of `5` and higher are great for brainstorming and quick prototyping. -Once configured, Cline will use your self-hosted Scalytics Connect instance for code generation, analysis, and other AI-assisted tasks directly within VS Code. +Once configured, Cline will use your self-hosted Scalytics Copilot instance for code generation, analysis, and other AI-assisted tasks directly within VS Code. ## Tips for AI-Supported Coding via API * **Clear Instructions:** Provide detailed and specific instructions (prompts) to the AI. The more context you give, the better the results. * **Context is Key:** Include relevant code snippets, file context, error messages, or project details in your requests to help the AI understand the task. * **Iterative Refinement:** Don't expect perfect results on the first try. Use the AI's output as a starting point and refine your prompts or the generated code iteratively. -* **Specify the Model:** Always ensure your tool is configured to use the specific Scalytics Connect model ID that best suits your task (e.g., coding-focused models for code generation). Be mindful of the model's size and your hardware capabilities, as this impacts performance and functionality: +* **Specify the Model:** Always ensure your tool is configured to use the specific Scalytics Copilot model ID that best suits your task (e.g., coding-focused models for code generation). Be mindful of the model's size and your hardware capabilities, as this impacts performance and functionality: | Model Size Parameter Count | Typical Local Capabilities | | :------------------------- | :----------------------------------------------------------- | @@ -61,4 +61,4 @@ Once configured, Cline will use your self-hosted Scalytics Connect instance for * **Save Frequently:** When working with AI tools that can generate significant code changes, save your work often to avoid losing progress. * **Review and Test:** Always review code generated by AI before integrating it. Test it thoroughly to ensure correctness, security, and performance. -By integrating Scalytics Connect with tools like Cline, you can create a powerful, customized, and secure AI-assisted development environment. +By integrating Scalytics Copilot with tools like Cline, you can create a powerful, customized, and secure AI-assisted development environment. diff --git a/docs/developer/messaging-hub-guide.md b/docs/developer/messaging-hub-guide.md index 230b8e9..6400432 100644 --- a/docs/developer/messaging-hub-guide.md +++ b/docs/developer/messaging-hub-guide.md @@ -1,8 +1,8 @@ -# Developer Guide: Scalytics Connect Messaging Hub +# Developer Guide: Scalytics Copilot Messaging Hub ## 1. Overview -This guide explains the core messaging system within Scalytics Connect, focusing on how messages are created, stored, and distributed. Understanding this system is crucial for developers integrating new features or MCP (Model Context Protocol) tools that need to interact with the chat interface. +This guide explains the core messaging system within Scalytics Copilot, focusing on how messages are created, stored, and distributed. Understanding this system is crucial for developers integrating new features or MCP (Model Context Protocol) tools that need to interact with the chat interface. The key components involved are: diff --git a/docs/developer/scalytics-api-guide.md b/docs/developer/scalytics-api-guide.md index cc2c207..4f77570 100644 --- a/docs/developer/scalytics-api-guide.md +++ b/docs/developer/scalytics-api-guide.md @@ -1,6 +1,6 @@ # Scalytics API Developer Guide -This guide explains how developers can use the Scalytics API, an OpenAI-compatible endpoint, to interact programmatically with local models hosted on this Scalytics Connect instance. +This guide explains how developers can use the Scalytics API, an OpenAI-compatible endpoint, to interact programmatically with local models hosted on this Scalytics Copilot instance. ## Overview @@ -12,7 +12,7 @@ The Scalytics API provides a `POST /v1/chat/completions` endpoint that mirrors t * Specify a local model available on this instance. * Receive responses, either as a complete message or a stream of tokens. -**Key Restriction:** This API endpoint **only** works with models designated as "local" by the administrator (i.e., models running directly on the Scalytics Connect server infrastructure). Requests for external models (like those from OpenAI, Anthropic, etc.) will be rejected. +**Key Restriction:** This API endpoint **only** works with models designated as "local" by the administrator (i.e., models running directly on the Scalytics Copilot server infrastructure). Requests for external models (like those from OpenAI, Anthropic, etc.) will be rejected. ## Prerequisites @@ -21,7 +21,7 @@ The Scalytics API provides a `POST /v1/chat/completions` endpoint that mirrors t ## Generating an API Key -1. Log in to your Scalytics Connect account. +1. Log in to your Scalytics Copilot account. 2. Navigate to **Settings** > **API Keys**. 3. Find the section titled **"Generate Scalytics API Key"**. 4. Enter a descriptive **Key Name** (e.g., "My Local Dev Key", "Integration Script Key"). @@ -41,7 +41,7 @@ Replace `YOUR_SCALYTICS_API_KEY` with your actual key. ## Endpoint: Chat Completions -* **URL:** `/v1/chat/completions` (relative to the Scalytics Connect instance base URL) +* **URL:** `/v1/chat/completions` (relative to the Scalytics Copilot instance base URL) * **Method:** `POST` * **Headers:** * `Content-Type: application/json` @@ -139,7 +139,7 @@ Check the `error` object in the JSON response body for more details. Initiates a Deep Search task and streams results and progress updates via Server-Sent Events (SSE). This allows for complex, multi-step research on a given query, leveraging web searches, content scraping, vector analysis, and LLM-based reasoning and synthesis. -* **URL:** `/v1/deepsearch` (relative to the Scalytics Connect instance base URL) +* **URL:** `/v1/deepsearch` (relative to the Scalytics Copilot instance base URL) * **Method:** `POST` * **Headers:** * `Content-Type: application/json` @@ -238,9 +238,9 @@ The stream is terminated when the client disconnects or after a `complete`, fata ## Endpoint: Image Generations -Creates an image given a prompt, utilizing an image generation model configured on the Scalytics Connect instance. +Creates an image given a prompt, utilizing an image generation model configured on the Scalytics Copilot instance. -* **URL:** `/v1/images/generations` (relative to the Scalytics Connect instance base URL) +* **URL:** `/v1/images/generations` (relative to the Scalytics Copilot instance base URL) * **Method:** `POST` * **Headers:** * `Content-Type: application/json` @@ -339,7 +339,7 @@ In addition to common API errors: * Model does not support image generation. * Invalid parameters (e.g., unsupported `size` for the model, `n` not equal to 1). * `404 Not Found`: Specified `model` ID not found or not configured. -* `501 Not Implemented`: The provider configured for the specified model does not have image generation capabilities implemented in Scalytics Connect. +* `501 Not Implemented`: The provider configured for the specified model does not have image generation capabilities implemented in Scalytics Copilot. --- diff --git a/docs/developer/scalytics-connect-agent-system.md b/docs/developer/scalytics-copilot-agent-system.md similarity index 88% rename from docs/developer/scalytics-connect-agent-system.md rename to docs/developer/scalytics-copilot-agent-system.md index 41d63ac..74c54e8 100644 --- a/docs/developer/scalytics-connect-agent-system.md +++ b/docs/developer/scalytics-copilot-agent-system.md @@ -1,17 +1,17 @@ -# Scalytics Connect Agent System +# Scalytics Copilot Agent System ## Overview -The Scalytics Connect Agent System enables powerful AI agents to interact with external tools and resources through a WebSocket-based communication protocol. This document describes the architecture, implementation, and usage of the Scalytics Connect Agent System. +The Scalytics Copilot Agent System enables powerful AI agents to interact with external tools and resources through a WebSocket-based communication protocol. This document describes the architecture, implementation, and usage of the Scalytics Copilot Agent System. ## Architecture -The Scalytics Connect Agent System integrates with the existing infrastructure through a WebSocket interface, providing real-time bidirectional communication between clients and AI agents. +The Scalytics Copilot Agent System integrates with the existing infrastructure through a WebSocket interface, providing real-time bidirectional communication between clients and AI agents. ```mermaid graph TD A[Client Application] <-->|WebSocket| B[WebSocket Server] - B <-->|Scalytics Connect Protocol| C[Scalytics Connect Agent System] + B <-->|Scalytics Copilot Protocol| C[Scalytics Copilot Agent System] C --> D[External Tools] C --> E[External Resources] C --> F[Model A] @@ -22,21 +22,21 @@ graph TD ### Components 1. **WebSocket Server**: Handles persistent connections, authentication, and message routing -2. **Scalytics Connect Agent Interface**: Facilitates bidirectional communication with AI agents +2. **Scalytics Copilot Agent Interface**: Facilitates bidirectional communication with AI agents 3. **Tool Registry**: Manages available tools and their capabilities 4. **Resource Provider**: Supplies context and data to agents 5. **Agent Manager**: Handles agent lifecycle and state -## Scalytics Connect Communication Protocol +## Scalytics Copilot Communication Protocol -The Scalytics Connect protocol is implemented as a specialized set of WebSocket messages: +The Scalytics Copilot protocol is implemented as a specialized set of WebSocket messages: ```mermaid sequenceDiagram participant User participant Client participant Server - participant Agent as Scalytics Connect Agent + participant Agent as Scalytics Copilot Agent participant Tool as External Tool User->>Client: Send message @@ -57,7 +57,7 @@ sequenceDiagram ### Message Protocol -The Scalytics Connect system uses a structured JSON message format for all communications: +The Scalytics Copilot system uses a structured JSON message format for all communications: ```json { @@ -73,7 +73,7 @@ The Scalytics Connect system uses a structured JSON message format for all commu | Type | Direction | Purpose | |------|-----------|---------| -| `agent_action` | Server → Client | Scalytics Connect agent performing an action | +| `agent_action` | Server → Client | Scalytics Copilot agent performing an action | | `agent_result` | Client → Server | Result of agent action | | `tool_list` | Bidirectional | Available tools information | | `resource_request` | Agent → Server | Agent requesting a resource | @@ -84,7 +84,7 @@ The Scalytics Connect system uses a structured JSON message format for all commu Tools are integrated through standardized interfaces: ```javascript -class ScalyticsConnectTool { +class ScalyticsCopilotTool { // Tool definition getDefinition() { return { @@ -170,7 +170,7 @@ stateDiagram-v2 ## Security Model -The Scalytics Connect Agent System implements a multi-layered security approach: +The Scalytics Copilot Agent System implements a multi-layered security approach: 1. **Authentication**: All connections require JWT authentication 2. **Authorization**: Granular permissions for tool access @@ -212,7 +212,7 @@ class CustomAgent extends BaseAgent { ## WebSocket Integration -The Scalytics Connect Agent System connects to clients through the WebSocket server: +The Scalytics Copilot Agent System connects to clients through the WebSocket server: ```javascript // Server-side websocket handler diff --git a/docs/index.md b/docs/index.md index 2a30550..f2be2d4 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,6 +1,6 @@ -# Scalytics Connect Documentation +# Scalytics Copilot Documentation -Welcome to the Scalytics Connect documentation. Use the sidebar to navigate through different sections. +Welcome to the Scalytics Copilot documentation. Use the sidebar to navigate through different sections. ## Documentation Categories diff --git a/docs/user/ai-agents-guide.md b/docs/user/ai-agents-guide.md index 53425dd..2488de3 100644 --- a/docs/user/ai-agents-guide.md +++ b/docs/user/ai-agents-guide.md @@ -8,13 +8,13 @@ AI Agents are specialized assistants that can perform specific tasks for you usi ### Accessing AI Agents -1. Log in to your Scalytics Connect account +1. Log in to your Scalytics Copilot account 2. Click on the "AI Agents" link in the left sidebar 3. Browse available agents or select one you've used before ### Types of Available Agents -The Scalytics Connect platform offers several types of specialized agents: +The Scalytics Copilot platform offers several types of specialized agents: - **Research Assistant**: Helps find and summarize information from various sources - **Data Analyst**: Analyzes data files and creates visualizations diff --git a/docs/user/chat-system-guide.md b/docs/user/chat-system-guide.md index 702167f..fa909cf 100644 --- a/docs/user/chat-system-guide.md +++ b/docs/user/chat-system-guide.md @@ -1,8 +1,8 @@ -# Chat System in Scalytics Connect +# Chat System in Scalytics Copilot ## Overview -Scalytics Connect provides a versatile chat interface that allows you to interact with various AI models. The system is designed to support both external API-based chat services and local models, giving you flexibility in how you use AI capabilities. +Scalytics Copilot provides a versatile chat interface that allows you to interact with various AI models. The system is designed to support both external API-based chat services and local models, giving you flexibility in how you use AI capabilities. ## Key Features @@ -13,11 +13,11 @@ Scalytics Connect provides a versatile chat interface that allows you to interac ## Understanding Chat Providers -Scalytics Connect uses a provider-based architecture for its chat system: +Scalytics Copilot uses a provider-based architecture for its chat system: ### External Providers -Scalytics Connect can connect to multiple external AI providers simultaneously, including: +Scalytics Copilot can connect to multiple external AI providers simultaneously, including: - **OpenAI** (GPT models) - **Anthropic** (Claude models) @@ -34,7 +34,7 @@ Each external provider requires its own API key, which you can configure in the ### Local Model -While you can connect to multiple external providers, Scalytics Connect supports **only one local model** at a time. The local model: +While you can connect to multiple external providers, Scalytics Copilot supports **only one local model** at a time. The local model: - Runs directly on your hardware - Provides complete privacy (no data sent to external servers) @@ -76,11 +76,11 @@ For long conversations, the chat history can become extensive, potentially excee **Automatic Summarization:** -In addition to the manual `/sum` command, Scalytics Connect also has an automatic summarization feature. If a conversation becomes very long and approaches the AI model's context limit, the system will automatically summarize earlier parts of the chat to ensure new messages can be processed. This automatic summary will also appear as a system message, typically like: `[System Note: Earlier parts of this conversation have been summarized to conserve context space.]`. The `/sum` command allows you to create these summary points proactively. +In addition to the manual `/sum` command, Scalytics Copilot also has an automatic summarization feature. If a conversation becomes very long and approaches the AI model's context limit, the system will automatically summarize earlier parts of the chat to ensure new messages can be processed. This automatic summary will also appear as a system message, typically like: `[System Note: Earlier parts of this conversation have been summarized to conserve context space.]`. The `/sum` command allows you to create these summary points proactively. ## Sharing Chats (Read-Only) -You can share your conversations with other users within Scalytics Connect, granting them read-only access. +You can share your conversations with other users within Scalytics Copilot, granting them read-only access. **How to Share:** @@ -176,7 +176,7 @@ When interacting with an Assistant message, you will see thumbs-up (👍) and th **Why Provide Feedback?** -Your feedback is crucial for improving the AI models within Scalytics Connect. Specifically, we use this data to: +Your feedback is crucial for improving the AI models within Scalytics Copilot. Specifically, we use this data to: - **Optimize Reasoning:** Identify patterns in responses that demonstrate strong or weak logical reasoning, helping us fine-tune the models for better problem-solving. - **Reduce Hallucinations:** Detect instances where the model generates incorrect or fabricated information, allowing us to adjust parameters to improve factual accuracy. diff --git a/docs/user/prompt-engineering-guide.md b/docs/user/prompt-engineering-guide.md index 769a305..f2195e0 100644 --- a/docs/user/prompt-engineering-guide.md +++ b/docs/user/prompt-engineering-guide.md @@ -1,6 +1,6 @@ # Effective Prompt Engineering -This documentation provides comprehensive guidance on creating effective AI agents through proper prompt engineering in the Scalytics Connect platform. These techniques will help you maximize the capabilities of the open-source models available in your deployment. +This documentation provides comprehensive guidance on creating effective AI agents through proper prompt engineering in the Scalytics Copilot platform. These techniques will help you maximize the capabilities of the open-source models available in your deployment. ## Table of Contents @@ -16,7 +16,7 @@ This documentation provides comprehensive guidance on creating effective AI agen ## Model Selection Guide -Each model family in Scalytics Connect has distinctive strengths that make it suitable for specific use cases. Understanding these differences will help you select the optimal model for your requirements. +Each model family in Scalytics Copilot has distinctive strengths that make it suitable for specific use cases. Understanding these differences will help you select the optimal model for your requirements. ### Llama (Meta) @@ -110,7 +110,7 @@ Each model family in Scalytics Connect has distinctive strengths that make it su ## Prompt Engineering Fundamentals -Prompt engineering is the process of designing instructions that effectively communicate with AI models. In Scalytics Connect, well-crafted prompts directly impact: +Prompt engineering is the process of designing instructions that effectively communicate with AI models. In Scalytics Copilot, well-crafted prompts directly impact: ### Key Impact Areas @@ -129,7 +129,7 @@ Prompt engineering is the process of designing instructions that effectively com ## Creating Effective AI Agents -The Scalytics Connect interface allows you to create specialized AI agents for specific functions. Follow these best practices to maximize their effectiveness: +The Scalytics Copilot interface allows you to create specialized AI agents for specific functions. Follow these best practices to maximize their effectiveness: ### Professional Identity Definition @@ -592,4 +592,4 @@ Focus on enhancing clarity and impact in data communication while ensuring techn --- -By applying these prompt engineering techniques within your Scalytics Connect environment, you'll significantly enhance the performance and business value of your AI agents. Remember that effective prompting is an iterative process—continuously evaluate performance and refine your approach based on operational results. +By applying these prompt engineering techniques within your Scalytics Copilot environment, you'll significantly enhance the performance and business value of your AI agents. Remember that effective prompting is an iterative process—continuously evaluate performance and refine your approach based on operational results. diff --git a/docs/user/scalytics-api-guide.md b/docs/user/scalytics-api-guide.md index 7c712b3..5830efd 100644 --- a/docs/user/scalytics-api-guide.md +++ b/docs/user/scalytics-api-guide.md @@ -1,6 +1,6 @@ # Using the Scalytics API -The Scalytics API allows you to interact with the local AI models hosted on this Scalytics Connect instance using external tools, scripts, or development environments that support the OpenAI API format. +The Scalytics API allows you to interact with the local AI models hosted on this Scalytics Copilot instance using external tools, scripts, or development environments that support the OpenAI API format. ## What is it for? @@ -16,7 +16,7 @@ You can use the Scalytics API to: To use the Scalytics API, you first need to generate a personal API key: -1. Go to your **Settings** page within Scalytics Connect. +1. Go to your **Settings** page within Scalytics Copilot. 2. Navigate to the **API Keys** section. 3. Look for the **"Generate Scalytics API Key"** area. 4. Enter a **Key Name** that helps you remember what you'll use this key for (e.g., "My Laptop Dev Key", "Data Analysis Script"). @@ -28,7 +28,7 @@ To use the Scalytics API, you first need to generate a personal API key: When configuring your external tool or script: -1. **Endpoint URL:** Set the API endpoint URL to `https://[Your Scalytics Connect URL]/v1/chat/completions`. Replace `[Your Scalytics Connect URL]` with the actual address of this instance. +1. **Endpoint URL:** Set the API endpoint URL to `https://[Your Scalytics Copilot URL]/v1/chat/completions`. Replace `[Your Scalytics Copilot URL]` with the actual address of this instance. 2. **API Key:** Provide your generated Scalytics API key (the one starting with `sk-scalytics-`) as the API key or Bearer token. Many tools have a specific field for the API key. If configuring manually, it should be sent in the `Authorization` header like this: ``` Authorization: Bearer YOUR_SCALYTICS_API_KEY diff --git a/docs/user/scalytics-deep-search-guide.md b/docs/user/scalytics-deep-search-guide.md index ec6a30e..a3a2115 100644 --- a/docs/user/scalytics-deep-search-guide.md +++ b/docs/user/scalytics-deep-search-guide.md @@ -10,7 +10,7 @@ You can typically find the Scalytics Deep Search page in the main sidebar naviga When you submit a query: -1. **Search:** Scalytics Connect performs web searches using DuckDuckGo for general information and OpenAlex for academic/scholarly content. It can optionally use Google Search or Bing Search if configured by your admin and you have API keys set. It also scans any files you uploaded. +1. **Search:** Scalytics Copilot performs web searches using DuckDuckGo for general information and OpenAlex for academic/scholarly content. It can optionally use Google Search or Bing Search if configured by your admin and you have API keys set. It also scans any files you uploaded. 2. **Chunking & Embedding:** Relevant text snippets (chunks) from the search results and files are extracted and converted into numerical representations (embeddings) using a specialized local model configured by your administrator. 3. **Similarity Search:** The system finds the text chunks most relevant to your original query based on their embeddings. 4. **Analysis & Synthesis:** The most relevant chunks are sent to a Large Language Model (LLM) that you select, along with your original query. @@ -20,7 +20,7 @@ When you submit a query: 1. **Select Analysis Models:** * **External Analysis Model:** Choose a model like GPT-4, Claude, Gemini, etc., hosted by an external provider. Requires API keys to be configured (either globally by admin or personally by you in **Settings -> API Keys**). *Note: Use of external models may be restricted by admin settings like Privacy Mode or Air Gap Mode.* - * **Local Analysis Model:** Choose a model hosted locally on this Scalytics Connect instance. These are typically available even if external access is restricted. + * **Local Analysis Model:** Choose a model hosted locally on this Scalytics Copilot instance. These are typically available even if external access is restricted. 2. **Enter Your Query:** Type your research question or topic into the main text area. Be as specific as possible. 3. **(Optional) Add Files:** Click the paperclip icon next to the magnifier glass icon and select "Add Files". You can upload documents to be included in the search context. * **Supported Formats for Analysis:** The system can effectively process and understand text-based documents such as PDF (text-based, not scanned images), DOCX, TXT, MD, CSV, JSON, and XLSX. These formats allow for reliable text extraction, chunking, and analysis. diff --git a/frontend/package-lock.json b/frontend/package-lock.json index c48ecd7..4d0406c 100644 --- a/frontend/package-lock.json +++ b/frontend/package-lock.json @@ -1,11 +1,11 @@ { - "name": "Scalytics Connect", + "name": "Scalytics Copilot", "version": "3.5.2", "lockfileVersion": 3, "requires": true, "packages": { "": { - "name": "Scalytics Connect", + "name": "Scalytics Copilot", "version": "3.5.2", "dependencies": { "@headlessui/react": "^1.7.19", diff --git a/frontend/package.json b/frontend/package.json index 4f46455..eabae0f 100644 --- a/frontend/package.json +++ b/frontend/package.json @@ -1,5 +1,5 @@ { - "name": "Scalytics Connect", + "name": "Scalytics Copilot", "version": "3.5.2", "private": true, "dependencies": { diff --git a/frontend/public/index.html b/frontend/public/index.html index 7ec07ba..3fe0575 100644 --- a/frontend/public/index.html +++ b/frontend/public/index.html @@ -5,19 +5,19 @@ - - + + - - + + - - + +