diff --git a/docs/agent-q/api.md b/docs/agentq/api.md similarity index 100% rename from docs/agent-q/api.md rename to docs/agentq/api.md diff --git a/docs/agent-q/deep-dive/agentic.md b/docs/agentq/deep-dive/agentic.md similarity index 98% rename from docs/agent-q/deep-dive/agentic.md rename to docs/agentq/deep-dive/agentic.md index 54f41a527a..99b048fc21 100644 --- a/docs/agent-q/deep-dive/agentic.md +++ b/docs/agentq/deep-dive/agentic.md @@ -31,7 +31,7 @@ Before using the agentic endpoints, you must configure your LLM provider credent ### Supported Providers -The agentic endpoints support 22+ LLM providers. For the full list, see [Supported LLM Providers](../managing/add-integration.md#supported-llm-providers){:target="_blank"} in the Add Integration guide. +The agentic endpoints support 22+ LLM providers. For the full list, see [Supported LLM Providers](../how-tos/add-integration.md#supported-llm-providers){:target="_blank"} in the Add Integration guide. Common providers include: @@ -58,7 +58,7 @@ LLM configuration is managed through the Qualytics UI, just like any other integ 4. Optionally provide a **Base URL** if required by your provider 5. Click **Save** to complete the configuration -For detailed setup instructions with screenshots, see [Add Integration](../managing/add-integration.md){:target="_blank"}. +For detailed setup instructions with screenshots, see [Add Integration](../how-tos/add-integration.md){:target="_blank"}. ## Capabilities diff --git a/docs/agent-q/deep-dive/best-practices.md b/docs/agentq/deep-dive/best-practices.md similarity index 100% rename from docs/agent-q/deep-dive/best-practices.md rename to docs/agentq/deep-dive/best-practices.md diff --git a/docs/agent-q/deep-dive/conversations.md b/docs/agentq/deep-dive/conversations.md similarity index 98% rename from docs/agent-q/deep-dive/conversations.md rename to docs/agentq/deep-dive/conversations.md index 5179b5d506..a8f5c394f3 100644 --- a/docs/agent-q/deep-dive/conversations.md +++ b/docs/agentq/deep-dive/conversations.md @@ -116,13 +116,13 @@ Information from early in a long conversation is not lost. It stays available to If you navigate away from the AgentQ page while a response is being generated, the stream continues in the background. The full response is waiting for you when you return to that session. -For other interface tips like stopping a response or pasting large content, see [Chat Interface Tips](../managing/chat-interface-tips.md){:target="_blank"}. +For other interface tips like stopping a response or pasting large content, see [Chat Interface Tips](../how-tos/chat-interface-tips.md){:target="_blank"}. ### Session Persistence Every conversation is saved. When you resume a session, AgentQ restores the full message history and the conversation summary, so it picks up exactly where you left off, even across days or sessions. -For step-by-step instructions on resuming a session, see [Resume a Conversation](../managing/resume-a-conversation.md){:target="_blank"}. +For step-by-step instructions on resuming a session, see [Resume a Conversation](../how-tos/resume-a-conversation.md){:target="_blank"}. ## Example Conversations diff --git a/docs/agent-q/deep-dive/in-action.md b/docs/agentq/deep-dive/in-action.md similarity index 99% rename from docs/agent-q/deep-dive/in-action.md rename to docs/agentq/deep-dive/in-action.md index 5d216b2eb7..ef9e0a6053 100644 --- a/docs/agent-q/deep-dive/in-action.md +++ b/docs/agentq/deep-dive/in-action.md @@ -191,6 +191,6 @@ Workflow tools execute multi-step guided processes for complex tasks. Each retur ## Connecting External Clients -For step-by-step instructions on connecting ChatGPT, Claude Desktop, Cursor, and other MCP-compatible clients to the Qualytics MCP server, see [Connecting External AI Clients](../managing/connecting-external-ai-clients.md){:target="_blank"}. +For step-by-step instructions on connecting ChatGPT, Claude Desktop, Cursor, and other MCP-compatible clients to the Qualytics MCP server, see [Connecting External AI Clients](../how-tos/connecting-external-ai-clients.md){:target="_blank"}. For example conversations showing AgentQ in use, see [Conversations, Responses & Context](./conversations.md#example-conversations){:target="_blank"}. diff --git a/docs/agent-q/deep-dive/limits.md b/docs/agentq/deep-dive/limits.md similarity index 98% rename from docs/agent-q/deep-dive/limits.md rename to docs/agentq/deep-dive/limits.md index b075fb4be5..3538bca499 100644 --- a/docs/agent-q/deep-dive/limits.md +++ b/docs/agentq/deep-dive/limits.md @@ -156,7 +156,7 @@ Very short follow-ups like *"yes"* or *"that one"* are recognized as continuatio Pastes of 1,000 characters or more into the input are captured as an attachment panel rather than inserted inline. -File attachments are accepted only when the active LLM provider supports file uploads. See [Attach a File](../managing/chat-interface-tips.md#attach-a-file){:target="_blank"} for the supported formats and provider list. +File attachments are accepted only when the active LLM provider supports file uploads. See [Attach a File](../how-tos/chat-interface-tips.md#attach-a-file){:target="_blank"} for the supported formats and provider list. ## Error Reference diff --git a/docs/agent-q/deep-dive/mcp.md b/docs/agentq/deep-dive/mcp.md similarity index 96% rename from docs/agent-q/deep-dive/mcp.md rename to docs/agentq/deep-dive/mcp.md index 7582d3530a..3a9cb64c0f 100644 --- a/docs/agent-q/deep-dive/mcp.md +++ b/docs/agentq/deep-dive/mcp.md @@ -99,4 +99,4 @@ For data quality workflows, this means: ## Next Steps - [AgentQ in Action](./in-action.md){:target="_blank"} — How Qualytics implements MCP as a server. -- [Connecting External AI Clients](../managing/connecting-external-ai-clients.md){:target="_blank"} — Connect external AI clients (ChatGPT, Claude Desktop, Claude Code, Cursor, VS Code, Windsurf, Amazon Q Developer) to the Qualytics MCP server. +- [Connecting External AI Clients](../how-tos/connecting-external-ai-clients.md){:target="_blank"} — Connect external AI clients (ChatGPT, Claude Desktop, Claude Code, Cursor, VS Code, Windsurf, Amazon Q Developer) to the Qualytics MCP server. diff --git a/docs/agent-q/faq.md b/docs/agentq/faq.md similarity index 96% rename from docs/agent-q/faq.md rename to docs/agentq/faq.md index e7f615cba3..18c625a586 100644 --- a/docs/agent-q/faq.md +++ b/docs/agentq/faq.md @@ -30,7 +30,7 @@ No. AgentQ includes an automatic topic guardrail. Before processing a request, a ### What LLM providers are supported? -AgentQ supports 22+ LLM providers including OpenAI, Anthropic, Google Gemini, Amazon Bedrock, Groq, Mistral, DeepSeek, Cohere, Ollama, OpenRouter, Perplexity, and more. See the full list with example models in the [Add Integration](managing/add-integration.md#supported-llm-providers){:target="_blank"} guide. +AgentQ supports 22+ LLM providers including OpenAI, Anthropic, Google Gemini, Amazon Bedrock, Groq, Mistral, DeepSeek, Cohere, Ollama, OpenRouter, Perplexity, and more. See the full list with example models in the [Add Integration](how-tos/add-integration.md#supported-llm-providers){:target="_blank"} guide. ### Do I need my own LLM API key? @@ -58,7 +58,7 @@ Existing conversation history is preserved — sessions are stored independently ### What happens if I don't configure an LLM? -Without an LLM configured, AgentQ displays a "No LLM Integration Configured" message with a **Configure LLM** button. The platform is fully functional otherwise — only AgentQ's chat capabilities are unavailable. Follow the [Add Integration](managing/add-integration.md){:target="_blank"} guide to get started. +Without an LLM configured, AgentQ displays a "No LLM Integration Configured" message with a **Configure LLM** button. The platform is fully functional otherwise — only AgentQ's chat capabilities are unavailable. Follow the [Add Integration](how-tos/add-integration.md){:target="_blank"} guide to get started. ## Usage @@ -108,7 +108,7 @@ Yes. Click the **Export as PDF** button below any assistant message to download ### Can I upload files to AgentQ? -Yes, when your active LLM provider supports binary content. The chat input shows an **Attach** icon for PDF, Word (`.doc`, `.docx`), Excel (`.xls`, `.xlsx`), CSV, TSV, JSON, XML, plain text, and Markdown files. Limits: one file per message, up to 20 MB per file. The button is shown for Anthropic, Google Gemini, Amazon Bedrock (Claude models), OpenAI, Azure OpenAI, and Heroku. See [Attach a File](managing/chat-interface-tips.md#attach-a-file){:target="_blank"} for full details. +Yes, when your active LLM provider supports binary content. The chat input shows an **Attach** icon for PDF, Word (`.doc`, `.docx`), Excel (`.xls`, `.xlsx`), CSV, TSV, JSON, XML, plain text, and Markdown files. Limits: one file per message, up to 20 MB per file. The button is shown for Anthropic, Google Gemini, Amazon Bedrock (Claude models), OpenAI, Azure OpenAI, and Heroku. See [Attach a File](how-tos/chat-interface-tips.md#attach-a-file){:target="_blank"} for full details. ### Are there usage limits? @@ -143,7 +143,7 @@ Not directly — conversations are private to your user account. To share findin ### How long are conversations stored? -Conversations persist indefinitely until you delete them. Archived conversations are also kept until explicitly deleted. See [Delete a Conversation](managing/delete-a-conversation.md){:target="_blank"} for instructions on permanent removal. +Conversations persist indefinitely until you delete them. Archived conversations are also kept until explicitly deleted. See [Delete a Conversation](how-tos/delete-a-conversation.md){:target="_blank"} for instructions on permanent removal. ### What languages does AgentQ support? @@ -157,7 +157,7 @@ The [Model Context Protocol](https://modelcontextprotocol.io/){:target="_blank"} ### Can I connect external AI clients to Qualytics? -Yes. Beyond the built-in AgentQ, you can connect ChatGPT, Claude Desktop, Claude Code, Cursor, VS Code (GitHub Copilot), Windsurf, Amazon Q Developer, and any MCP-compatible client directly to the Qualytics MCP server using your Personal API Token. See the [Connecting External AI Clients](managing/connecting-external-ai-clients.md){:target="_blank"} guide for step-by-step instructions for each client. +Yes. Beyond the built-in AgentQ, you can connect ChatGPT, Claude Desktop, Claude Code, Cursor, VS Code (GitHub Copilot), Windsurf, Amazon Q Developer, and any MCP-compatible client directly to the Qualytics MCP server using your Personal API Token. See the [Connecting External AI Clients](how-tos/connecting-external-ai-clients.md){:target="_blank"} guide for step-by-step instructions for each client. ### Which external AI clients are supported? @@ -173,7 +173,7 @@ Qualytics provides step-by-step setup guides for the following MCP clients: | **Windsurf** | Streamable HTTP via `~/.codeium/windsurf/mcp_config.json` | | **Amazon Q Developer** | Streamable HTTP via `~/.aws/amazonq/mcp.json` | -Any other MCP-compatible client that supports **Streamable HTTP** transport can also connect. See the [Connecting External AI Clients](managing/connecting-external-ai-clients.md){:target="_blank"} guide for full instructions. +Any other MCP-compatible client that supports **Streamable HTTP** transport can also connect. See the [Connecting External AI Clients](how-tos/connecting-external-ai-clients.md){:target="_blank"} guide for full instructions. ### Do external clients have the same capabilities as AgentQ? diff --git a/docs/agent-q/managing/add-integration.md b/docs/agentq/how-tos/add-integration.md similarity index 85% rename from docs/agent-q/managing/add-integration.md rename to docs/agentq/how-tos/add-integration.md index 1b57c16b91..45ce8b59ba 100644 --- a/docs/agent-q/managing/add-integration.md +++ b/docs/agentq/how-tos/add-integration.md @@ -6,7 +6,7 @@ AgentQ requires an LLM (Large Language Model) provider to power its AI capabilit The setup below opens the **LLM Configuration** modal. Use this reference to understand what each field expects before going through the steps: -![llm-modal-fields](../../assets/agent-q/managing/add-integration/llm-modal-fields.png) +![llm-modal-fields](../../assets/agentq/how-tos/add-integration/llm-modal-fields.png) | # | Field | Description | |---|-------|-------------| @@ -29,29 +29,29 @@ The LLM Configuration modal can be opened from two places. Both paths lead to th **Step 1:** Click the **Settings** :material-cog: icon in the bottom-left sidebar. - ![settings-icon](../../assets/agent-q/managing/shared/settings-icon.png) + ![settings-icon](../../assets/agentq/how-tos/shared/settings-icon.png) **Step 2:** The Settings page opens on the **Connections** tab. - ![settings-connections](../../assets/agent-q/managing/shared/settings-connections.png) + ![settings-connections](../../assets/agentq/how-tos/shared/settings-connections.png) **Step 3:** Click the **Integrations** tab. - ![step-3-settings-integrations](../../assets/agent-q/managing/add-integration/step-3-settings-integrations.png) + ![step-3-settings-integrations](../../assets/agentq/how-tos/add-integration/step-3-settings-integrations.png) === "From AgentQ" **Step 1:** Click **AgentQ** :material-robot: in the left sidebar to open the AgentQ page. - ![step-1-agent-q-icon](../../assets/agent-q/managing/add-integration/step-1-agent-q-icon.png) + ![step-1-agentq-icon](../../assets/agentq/how-tos/add-integration/step-1-agentq-icon.png) **Step 2:** The **No LLM Integration Configured** page appears. - ![step-2-agent-q-no-llm](../../assets/agent-q/managing/add-integration/step-2-agent-q-no-llm.png) + ![step-2-agentq-no-llm](../../assets/agentq/how-tos/add-integration/step-2-agentq-no-llm.png) **Step 3:** Click **Configure LLM**. You are redirected to **Settings** > **Integrations**. - ![step-3-agent-q-configure](../../assets/agent-q/managing/add-integration/step-3-agent-q-configure.png) + ![step-3-agentq-configure](../../assets/agentq/how-tos/add-integration/step-3-agentq-configure.png) ## Configure the LLM Provider @@ -59,26 +59,26 @@ Once you are on the **Integrations** tab, continue from this step regardless of **Step 4:** The **Integrations** page lists every integration available in Qualytics, grouped by category. The **AgentQ** section is at the top with the **LLM Configuration** entry. -![step-4-integrations-page](../../assets/agent-q/managing/add-integration/step-4-integrations-page.png) +![step-4-integrations-page](../../assets/agentq/how-tos/add-integration/step-4-integrations-page.png) **Step 5:** Click **Connect** next to **LLM Configuration**. -![step-5-connect](../../assets/agent-q/managing/add-integration/step-5-connect.png) +![step-5-connect](../../assets/agentq/how-tos/add-integration/step-5-connect.png) **Step 6:** The **LLM Configuration** modal opens. Fill in the fields described in [LLM Configuration Fields](#llm-configuration-fields) above. -![step-6-modal](../../assets/agent-q/managing/add-integration/step-6-modal.png) +![step-6-modal](../../assets/agentq/how-tos/add-integration/step-6-modal.png) **Step 7:** Click **Save** to complete the configuration. -![step-7-save](../../assets/agent-q/managing/add-integration/step-7-save.png) +![step-7-save](../../assets/agentq/how-tos/add-integration/step-7-save.png) !!! info When you save, Qualytics automatically validates your API key and tests the connection to the provider. If the key is invalid or the provider is unreachable, you will see an error before the configuration is stored. Qualytics also checks whether your provider supports web search — if it does, AgentQ can optionally search the Qualytics documentation to answer platform-related questions. **Step 8:** A confirmation message appears and the **LLM Configuration** entry now shows a **Connected** badge with the active provider and model. -![step-8-connected](../../assets/agent-q/managing/add-integration/step-8-connected.png) +![step-8-connected](../../assets/agentq/how-tos/add-integration/step-8-connected.png) Once saved, AgentQ is ready to use. See [AgentQ Overview](../overview.md){:target="_blank"} for next steps. diff --git a/docs/agent-q/managing/archive-a-conversation.md b/docs/agentq/how-tos/archive-a-conversation.md similarity index 78% rename from docs/agent-q/managing/archive-a-conversation.md rename to docs/agentq/how-tos/archive-a-conversation.md index 3a3655c0df..54a8528ca5 100644 --- a/docs/agent-q/managing/archive-a-conversation.md +++ b/docs/agentq/how-tos/archive-a-conversation.md @@ -9,19 +9,19 @@ Archiving moves a conversation out of the active **Chats** list into the **Archi **Step 1:** In the sidebar, hover over the conversation you want to archive and click the **More options** :material-dots-vertical: menu icon that appears next to it. -![kebab-menu](../../assets/agent-q/managing/shared/kebab-menu.png) +![kebab-menu](../../assets/agentq/how-tos/shared/kebab-menu.png) **Step 2:** A dropdown opens with the available conversation actions. -![menu-options](../../assets/agent-q/managing/shared/menu-options.png) +![menu-options](../../assets/agentq/how-tos/shared/menu-options.png) **Step 3:** Select **Archive** :material-archive-outline:. -![archive-menu](../../assets/agent-q/managing/archive-a-conversation/archive-menu.png) +![archive-menu](../../assets/agentq/how-tos/archive-a-conversation/archive-menu.png) **Step 4:** A success message appears and the conversation moves to the **Archived** section at the bottom of the sidebar. -![chat-archived](../../assets/agent-q/managing/archive-a-conversation/chat-archived.png) +![chat-archived](../../assets/agentq/how-tos/archive-a-conversation/chat-archived.png) !!! info If you archive the conversation you are currently viewing, you are automatically redirected to the AgentQ empty state. diff --git a/docs/agent-q/managing/chat-interface-tips.md b/docs/agentq/how-tos/chat-interface-tips.md similarity index 86% rename from docs/agent-q/managing/chat-interface-tips.md rename to docs/agentq/how-tos/chat-interface-tips.md index 2732ee77be..a044989185 100644 --- a/docs/agent-q/managing/chat-interface-tips.md +++ b/docs/agentq/how-tos/chat-interface-tips.md @@ -6,7 +6,7 @@ Quick reference for the controls available in the AgentQ interface. The full-page chat opens when you click **AgentQ** in the left sidebar. It has a collapsible **Chats** sidebar on the left and the main chat area on the right. -![full-page-overview](../../assets/agent-q/managing/chat-interface-tips/full-page-overview.png) +![full-page-overview](../../assets/agentq/how-tos/chat-interface-tips/full-page-overview.png) | # | Button | Icon | Description | |---|---|---|---| @@ -23,7 +23,7 @@ The full-page chat opens when you click **AgentQ** in the left sidebar. It has a The floating chat is the persistent widget in the bottom-right corner of every page. Click the **AgentQ** button to open it; press ++q++ to toggle it from anywhere on the page (except while typing in an input). -![floating-overview](../../assets/agent-q/managing/chat-interface-tips/floating-overview.png) +![floating-overview](../../assets/agentq/how-tos/chat-interface-tips/floating-overview.png) | # | Button | Icon | Description | |---|---|---|---| @@ -38,31 +38,31 @@ The floating chat is the persistent widget in the bottom-right corner of every p While AgentQ is generating, the **Send** button becomes a **Stop** :material-stop: button. Click it to interrupt the response — whatever AgentQ produced so far is preserved as a partial response with a "Stopped" indicator. -![stop](../../assets/agent-q/managing/chat-interface-tips/stop.png) +![stop](../../assets/agentq/how-tos/chat-interface-tips/stop.png) The same control is available in the floating chat: -![stop-floating](../../assets/agent-q/managing/chat-interface-tips/stop-floating.png) +![stop-floating](../../assets/agentq/how-tos/chat-interface-tips/stop-floating.png) ## Paste Large Content When you paste text of 1,000 characters or more into the input, AgentQ captures it as an attachment rather than inserting it into the input field. The pasted content appears as a removable panel labeled **PASTED** above the input. It is included with your message when you send it, giving AgentQ full context while keeping the input clean. -![large-content](../../assets/agent-q/managing/chat-interface-tips/large-content.png) +![large-content](../../assets/agentq/how-tos/chat-interface-tips/large-content.png) In the floating chat, the pasted content appears as a compact chip: -![pasted-floating](../../assets/agent-q/managing/chat-interface-tips/pasted-floating.png) +![pasted-floating](../../assets/agentq/how-tos/chat-interface-tips/pasted-floating.png) ## Attach a File When your active LLM provider supports file uploads, click the **Attach** :material-paperclip: icon next to the message input, choose a document in the native file picker, and click **Open**. The selected file appears as a removable chip above the input — type your prompt and send the message, and the file is sent together with your text. -![attached-file](../../assets/agent-q/managing/chat-interface-tips/attached-file.png) +![attached-file](../../assets/agentq/how-tos/chat-interface-tips/attached-file.png) In the floating chat, the attached file appears as a compact chip: -![attached-file-floating](../../assets/agent-q/managing/chat-interface-tips/attached-file-floating.png) +![attached-file-floating](../../assets/agentq/how-tos/chat-interface-tips/attached-file-floating.png) **Supported file types** diff --git a/docs/agent-q/managing/connecting-external-ai-clients.md b/docs/agentq/how-tos/connecting-external-ai-clients.md similarity index 89% rename from docs/agent-q/managing/connecting-external-ai-clients.md rename to docs/agentq/how-tos/connecting-external-ai-clients.md index 4a86854991..00d58aec18 100644 --- a/docs/agent-q/managing/connecting-external-ai-clients.md +++ b/docs/agentq/how-tos/connecting-external-ai-clients.md @@ -20,19 +20,19 @@ https://your-qualytics-instance.qualytics.io/api/mcp/ **Step 1:** Log in to your ChatGPT account and click on your **profile icon** in the bottom-left corner of the screen. -![step-1-profile](../../assets/agent-q/managing/connecting-external-ai-clients/step-1-profile.png) +![step-1-profile](../../assets/agentq/how-tos/connecting-external-ai-clients/step-1-profile.png) **Step 2:** A dropdown menu appears. Click **Settings**. -![step-2-settings](../../assets/agent-q/managing/connecting-external-ai-clients/step-2-settings.png) +![step-2-settings](../../assets/agentq/how-tos/connecting-external-ai-clients/step-2-settings.png) **Step 3:** A modal window opens. Click **Apps** to manage and create new app connections. -![step-3-apps](../../assets/agent-q/managing/connecting-external-ai-clients/step-3-apps.png) +![step-3-apps](../../assets/agentq/how-tos/connecting-external-ai-clients/step-3-apps.png) **Step 4:** In the **Apps** section, click **Create app** to start creating a new app connection. -![step-4-create-app](../../assets/agent-q/managing/connecting-external-ai-clients/step-4-create-app.png) +![step-4-create-app](../../assets/agentq/how-tos/connecting-external-ai-clients/step-4-create-app.png) **Step 5:** The **New App** modal opens. Enter the required details: @@ -47,15 +47,15 @@ https://your-qualytics-instance.qualytics.io/api/mcp/ | 7 | **OAuth Client Secret** | Paste your Qualytics API token. | `` | | 8 | **Confirmation Checkbox** | Select "I understand and want to continue" to proceed. | Checked | -![step-5-modal-details](../../assets/agent-q/managing/connecting-external-ai-clients/step-5-modal-details.png) +![step-5-modal-details](../../assets/agentq/how-tos/connecting-external-ai-clients/step-5-modal-details.png) **Step 6:** Once all the details are filled in, click **Create** to complete the app setup. -![step-6-create-button](../../assets/agent-q/managing/connecting-external-ai-clients/step-6-create-button.png) +![step-6-create-button](../../assets/agentq/how-tos/connecting-external-ai-clients/step-6-create-button.png) **Step 7:** After the app is created, ChatGPT prompts you to authorize the connection. Paste the **same Qualytics API token** again to authorize. -![step-7-auth-prompt](../../assets/agent-q/managing/connecting-external-ai-clients/step-7-auth-prompt.png){: style="height:400px"} +![step-7-auth-prompt](../../assets/agentq/how-tos/connecting-external-ai-clients/step-7-auth-prompt.png){: style="height:400px"} !!! note The OAuth Client Secret and the authorization prompt both require the same Qualytics API token. diff --git a/docs/agent-q/managing/delete-a-conversation.md b/docs/agentq/how-tos/delete-a-conversation.md similarity index 78% rename from docs/agent-q/managing/delete-a-conversation.md rename to docs/agentq/how-tos/delete-a-conversation.md index 963c8d75e7..bf3cc110ed 100644 --- a/docs/agent-q/managing/delete-a-conversation.md +++ b/docs/agentq/how-tos/delete-a-conversation.md @@ -24,16 +24,16 @@ Permanently deleting a conversation will have the following effects: **Step 1:** Open the **Archived** section at the bottom of the sidebar, hover over the conversation you want to delete, and click the **More options** :material-dots-vertical: menu icon that appears next to it. -![archived-kebab-menu](../../assets/agent-q/managing/shared/archived-kebab-menu.png) +![archived-kebab-menu](../../assets/agentq/how-tos/shared/archived-kebab-menu.png) **Step 2:** A dropdown opens with the available conversation actions. -![archived-menu-options](../../assets/agent-q/managing/shared/archived-menu-options.png) +![archived-menu-options](../../assets/agentq/how-tos/shared/archived-menu-options.png) **Step 3:** Select **Delete** :material-trash-can-outline:. -![delete-menu](../../assets/agent-q/managing/delete-a-conversation/delete-menu.png) +![delete-menu](../../assets/agentq/how-tos/delete-a-conversation/delete-menu.png) **Step 4:** A success message appears and the conversation is removed from the **Archived** list. -![chat-permanently-deleted](../../assets/agent-q/managing/delete-a-conversation/chat-permanently-deleted.png) +![chat-permanently-deleted](../../assets/agentq/how-tos/delete-a-conversation/chat-permanently-deleted.png) diff --git a/docs/agent-q/managing/remove-integration.md b/docs/agentq/how-tos/remove-integration.md similarity index 71% rename from docs/agent-q/managing/remove-integration.md rename to docs/agentq/how-tos/remove-integration.md index 1f052ae1e9..575b8c976d 100644 --- a/docs/agent-q/managing/remove-integration.md +++ b/docs/agentq/how-tos/remove-integration.md @@ -6,23 +6,23 @@ Removing the LLM configuration disconnects AgentQ from your LLM provider. AgentQ **Step 1:** After logging in, click the **Settings** :material-cog: icon in the bottom-left sidebar. -![settings-icon](../../assets/agent-q/managing/shared/settings-icon.png) +![settings-icon](../../assets/agentq/how-tos/shared/settings-icon.png) **Step 2:** The Settings page opens on the **Connections** tab by default. Click the **Integrations** tab. -![settings-connections](../../assets/agent-q/managing/shared/settings-connections.png) +![settings-connections](../../assets/agentq/how-tos/shared/settings-connections.png) **Step 3:** Under the **AgentQ** section, click the **More options** :material-dots-vertical: menu next to **LLM Configuration** and select **Disconnect**. -![three-dots-menu](../../assets/agent-q/managing/remove-integration/three-dots-menu.png) +![three-dots-menu](../../assets/agentq/how-tos/remove-integration/three-dots-menu.png) **Step 4:** A confirmation dialog opens showing what will happen when the LLM configuration is disconnected. Click **Disconnect** to confirm. -![disconnect-confirmation](../../assets/agent-q/managing/remove-integration/disconnect-confirmation.png) +![disconnect-confirmation](../../assets/agentq/how-tos/remove-integration/disconnect-confirmation.png) **Step 5:** A success message appears and the **LLM Configuration** row returns to the **Connect** state. -![disconnected-successfully](../../assets/agent-q/managing/remove-integration/disconnected-successfully.png) +![disconnected-successfully](../../assets/agentq/how-tos/remove-integration/disconnected-successfully.png) !!! warning Disconnecting the LLM provider will immediately disable AgentQ for **all users** in the deployment. Your conversation history is preserved and will be available again once you [add a new integration](add-integration.md){:target="_blank"}. diff --git a/docs/agent-q/managing/rename-a-conversation.md b/docs/agentq/how-tos/rename-a-conversation.md similarity index 70% rename from docs/agent-q/managing/rename-a-conversation.md rename to docs/agentq/how-tos/rename-a-conversation.md index f26f1f177a..596d87feef 100644 --- a/docs/agent-q/managing/rename-a-conversation.md +++ b/docs/agentq/how-tos/rename-a-conversation.md @@ -9,19 +9,19 @@ Renaming a conversation gives it a descriptive title to make it easier to find i **Step 1:** In the sidebar, hover over the conversation you want to rename and click the **More options** :material-dots-vertical: menu icon that appears next to it. -![kebab-menu](../../assets/agent-q/managing/shared/kebab-menu.png) +![kebab-menu](../../assets/agentq/how-tos/shared/kebab-menu.png) **Step 2:** A dropdown opens with the available conversation actions. -![menu-options](../../assets/agent-q/managing/shared/menu-options.png) +![menu-options](../../assets/agentq/how-tos/shared/menu-options.png) **Step 3:** Select **Rename** :material-pencil-outline:. -![rename-menu](../../assets/agent-q/managing/rename-a-conversation/rename-menu.png) +![rename-menu](../../assets/agentq/how-tos/rename-a-conversation/rename-menu.png) **Step 4:** An inline input field appears with the current title pre-filled. Type the new name. -![rename-input](../../assets/agent-q/managing/rename-a-conversation/rename-input.png) +![rename-input](../../assets/agentq/how-tos/rename-a-conversation/rename-input.png) !!! info "Title constraints" - Maximum **40 characters** @@ -31,8 +31,8 @@ Renaming a conversation gives it a descriptive title to make it easier to find i **Step 5:** Press **Enter** or click the **Save** :material-check: button. -![rename-save](../../assets/agent-q/managing/rename-a-conversation/rename-save.png) +![rename-save](../../assets/agentq/how-tos/rename-a-conversation/rename-save.png) **Step 6:** A success message appears and the updated title is shown in the sidebar. -![chat-renamed](../../assets/agent-q/managing/rename-a-conversation/chat-renamed.png) +![chat-renamed](../../assets/agentq/how-tos/rename-a-conversation/chat-renamed.png) diff --git a/docs/agent-q/managing/restore-a-conversation.md b/docs/agentq/how-tos/restore-a-conversation.md similarity index 69% rename from docs/agent-q/managing/restore-a-conversation.md rename to docs/agentq/how-tos/restore-a-conversation.md index 8d27637111..6b8695ba55 100644 --- a/docs/agent-q/managing/restore-a-conversation.md +++ b/docs/agentq/how-tos/restore-a-conversation.md @@ -9,16 +9,16 @@ Restoring an archived conversation moves it back to the active **Chats** list, m **Step 1:** Open the **Archived** section at the bottom of the sidebar, hover over the conversation you want to restore, and click the **More options** :material-dots-vertical: menu icon that appears next to it. -![archived-kebab-menu](../../assets/agent-q/managing/shared/archived-kebab-menu.png) +![archived-kebab-menu](../../assets/agentq/how-tos/shared/archived-kebab-menu.png) **Step 2:** A dropdown opens with the available conversation actions. -![archived-menu-options](../../assets/agent-q/managing/shared/archived-menu-options.png) +![archived-menu-options](../../assets/agentq/how-tos/shared/archived-menu-options.png) **Step 3:** Select **Restore** :material-restore:. -![restore-menu](../../assets/agent-q/managing/restore-a-conversation/restore-menu.png) +![restore-menu](../../assets/agentq/how-tos/restore-a-conversation/restore-menu.png) **Step 4:** A success message appears and the conversation moves to the top of the active **Chats** list. -![chat-restored](../../assets/agent-q/managing/restore-a-conversation/chat-restored.png) +![chat-restored](../../assets/agentq/how-tos/restore-a-conversation/chat-restored.png) diff --git a/docs/agent-q/managing/resume-a-conversation.md b/docs/agentq/how-tos/resume-a-conversation.md similarity index 66% rename from docs/agent-q/managing/resume-a-conversation.md rename to docs/agentq/how-tos/resume-a-conversation.md index 3dcccb5af2..0e213bcc2e 100644 --- a/docs/agent-q/managing/resume-a-conversation.md +++ b/docs/agentq/how-tos/resume-a-conversation.md @@ -6,29 +6,29 @@ You can return to any previous conversation and continue from where you left off **Step 1:** Click **AgentQ** in the left sidebar to open the full-page chat interface. The **Chats** list in the sidebar shows all your active conversations. -![chats-sidebar](../../assets/agent-q/managing/resume-a-conversation/chats-sidebar.png) +![chats-sidebar](../../assets/agentq/how-tos/resume-a-conversation/chats-sidebar.png) !!! info If you are looking for a specific conversation, you can use [Search Conversations](./search-conversations.md){:target="_blank"} to filter by title or message content. **Step 2:** Locate the conversation you want to resume in the list. -![select-conversation](../../assets/agent-q/managing/resume-a-conversation/select-conversation.png) +![select-conversation](../../assets/agentq/how-tos/resume-a-conversation/select-conversation.png) **Step 3:** Click the conversation to open it. The full message history loads and you can continue the conversation by typing in the input field at the bottom. -![conversation-resumed](../../assets/agent-q/managing/resume-a-conversation/conversation-resumed.png) +![conversation-resumed](../../assets/agentq/how-tos/resume-a-conversation/conversation-resumed.png) ## Via Floating Chat **Step 1:** Open the floating chat widget by clicking the **AgentQ** button in the bottom-right corner of any page. Then click the **Chat history** :material-chevron-down: button in the floating chat header. -![floating-chat-history-button](../../assets/agent-q/managing/resume-a-conversation/floating-chat-history-button.png) +![floating-chat-history-button](../../assets/agentq/how-tos/resume-a-conversation/floating-chat-history-button.png) **Step 2:** A dropdown list of your recent conversations appears. Scroll through the list to find the conversation you want to resume. -![floating-chat-history-list](../../assets/agent-q/managing/resume-a-conversation/floating-chat-history-list.png) +![floating-chat-history-list](../../assets/agentq/how-tos/resume-a-conversation/floating-chat-history-list.png) **Step 3:** Click the conversation to open it. The full message history is displayed and you can continue interacting with AgentQ from where you left off. -![floating-conversation-resumed](../../assets/agent-q/managing/resume-a-conversation/floating-conversation-resumed.png) +![floating-conversation-resumed](../../assets/agentq/how-tos/resume-a-conversation/floating-conversation-resumed.png) diff --git a/docs/agent-q/managing/search-conversations.md b/docs/agentq/how-tos/search-conversations.md similarity index 86% rename from docs/agent-q/managing/search-conversations.md rename to docs/agentq/how-tos/search-conversations.md index caf3a1d228..667e86cb8e 100644 --- a/docs/agent-q/managing/search-conversations.md +++ b/docs/agentq/how-tos/search-conversations.md @@ -9,13 +9,13 @@ The search feature filters your active sessions by title or message content, mak **Step 1:** In the sidebar, click the **Search** :material-magnify: icon in the **Chats** header toolbar. A search input field appears below the header. -![search-button](../../assets/agent-q/managing/search-conversations/search-button.png) +![search-button](../../assets/agentq/how-tos/search-conversations/search-button.png) **Step 2:** Type to filter sessions by title or message content. Results update as you type. To clear the filter, click the **Clear** :material-close: button inside the search field. To close the search panel entirely, click the **Search** :material-magnify: icon again. -![search-results](../../assets/agent-q/managing/search-conversations/search-results.png) +![search-results](../../assets/agentq/how-tos/search-conversations/search-results.png) ## Behavior diff --git a/docs/agent-q/managing/start-a-new-conversation.md b/docs/agentq/how-tos/start-a-new-conversation.md similarity index 69% rename from docs/agent-q/managing/start-a-new-conversation.md rename to docs/agentq/how-tos/start-a-new-conversation.md index 01abf7bfa4..7002ed47ef 100644 --- a/docs/agent-q/managing/start-a-new-conversation.md +++ b/docs/agentq/how-tos/start-a-new-conversation.md @@ -6,27 +6,27 @@ Starting a new conversation clears the current chat and opens the empty state wi **Step 1:** Click **AgentQ** in the left sidebar to open the full-page chat interface. The empty state appears with personalized smart suggestions — type in the input field at the bottom to begin. -![agent-q-page](../../assets/agent-q/managing/start-a-new-conversation/agent-q-page.png) +![agentq-page](../../assets/agentq/how-tos/start-a-new-conversation/agentq-page.png) **Step 2 *(if a conversation is already open)*:** Click the **New Chat** :material-chat-plus-outline: button in the top-right corner of the chat area to clear the current conversation and return to a fresh empty state. -![new-chat-active-conversation](../../assets/agent-q/managing/start-a-new-conversation/new-chat-active-conversation.png) +![new-chat-active-conversation](../../assets/agentq/how-tos/start-a-new-conversation/new-chat-active-conversation.png) !!! note You can also click the **New Chat** :material-chat-plus-outline: button in the **Chats** sidebar toolbar. -![new-chat-button](../../assets/agent-q/managing/start-a-new-conversation/new-chat-button.png) +![new-chat-button](../../assets/agentq/how-tos/start-a-new-conversation/new-chat-button.png) ## Via Floating Chat **Step 1:** Click the **AgentQ** button in the bottom-right corner of any page to open the floating chat. -![floating-chat-fab](../../assets/agent-q/managing/start-a-new-conversation/floating-chat-fab.png) +![floating-chat-fab](../../assets/agentq/how-tos/start-a-new-conversation/floating-chat-fab.png) **Step 2:** A fresh empty state opens with personalized smart suggestions. AgentQ automatically detects the page context and uses it in the conversation. -![floating-conversation-started](../../assets/agent-q/managing/start-a-new-conversation/floating-conversation-started.png) +![floating-conversation-started](../../assets/agentq/how-tos/start-a-new-conversation/floating-conversation-started.png) **Step 3 *(if a conversation is already open)*:** Click the **New Chat** :material-chat-plus-outline: button in the floating chat header to clear the current conversation and return to a fresh empty state. -![floating-new-chat-button](../../assets/agent-q/managing/start-a-new-conversation/floating-new-chat-button.png) +![floating-new-chat-button](../../assets/agentq/how-tos/start-a-new-conversation/floating-new-chat-button.png) diff --git a/docs/agent-q/managing/update-integration.md b/docs/agentq/how-tos/update-integration.md similarity index 76% rename from docs/agent-q/managing/update-integration.md rename to docs/agentq/how-tos/update-integration.md index 6d243c8baf..ddec6c9aad 100644 --- a/docs/agent-q/managing/update-integration.md +++ b/docs/agentq/how-tos/update-integration.md @@ -6,15 +6,15 @@ A **Manager** or **Admin** can change the LLM provider, model, or API key at any **Step 1:** After logging in, click the **Settings** :material-cog: icon in the bottom-left sidebar. -![settings-icon](../../assets/agent-q/managing/shared/settings-icon.png) +![settings-icon](../../assets/agentq/how-tos/shared/settings-icon.png) **Step 2:** The Settings page opens on the **Connections** tab by default. Click the **Integrations** tab. -![settings-connections](../../assets/agent-q/managing/shared/settings-connections.png) +![settings-connections](../../assets/agentq/how-tos/shared/settings-connections.png) **Step 3:** Under the **AgentQ** section, click the **More options** :material-dots-vertical: menu next to **LLM Configuration** and select **Edit**. -![three-dots-menu](../../assets/agent-q/managing/update-integration/three-dots-menu.png) +![three-dots-menu](../../assets/agentq/how-tos/update-integration/three-dots-menu.png) **Step 4:** The **Edit LLM Configuration** modal opens with your current settings pre-filled. Update any field you want to change: @@ -26,15 +26,15 @@ A **Manager** or **Admin** can change the LLM provider, model, or API key at any | **Base URL** *(optional)* | Update the custom endpoint URL, or clear it to use the provider's default. | | **Business Context** *(required)* | Update the description of your organization's data quality focus, responsibilities, and domain. Up to 2000 characters. | -![edit-modal](../../assets/agent-q/managing/update-integration/edit-modal.png) +![edit-modal](../../assets/agentq/how-tos/update-integration/edit-modal.png) **Step 5:** Make your changes and click **Update** to apply them. -![update-fields](../../assets/agent-q/managing/update-integration/update-fields.png) +![update-fields](../../assets/agentq/how-tos/update-integration/update-fields.png) **Step 6:** A success message appears and the **LLM Configuration** row updates to reflect the new provider and model. -![saved-successfully](../../assets/agent-q/managing/update-integration/saved-successfully.png) +![saved-successfully](../../assets/agentq/how-tos/update-integration/saved-successfully.png) !!! info Qualytics re-validates your API key on every save. If the new key is invalid or the provider is unreachable, the update will not be applied and you will see an error. diff --git a/docs/agent-q/overview.md b/docs/agentq/overview.md similarity index 65% rename from docs/agent-q/overview.md rename to docs/agentq/overview.md index 49067def0a..46b053d613 100644 --- a/docs/agent-q/overview.md +++ b/docs/agentq/overview.md @@ -17,7 +17,7 @@ You can interact with AgentQ in several ways: through the **full-page chat** ope
-- :material-server-network:{ .lg .middle } **MCP** +- **MCP** --- @@ -25,7 +25,7 @@ You can interact with AgentQ in several ways: through the **full-page chat** ope [:octicons-arrow-right-24: MCP](deep-dive/mcp.md) -- :material-robot-outline:{ .lg .middle } **AgentQ in Action** +- **AgentQ in Action** --- @@ -33,7 +33,7 @@ You can interact with AgentQ in several ways: through the **full-page chat** ope [:octicons-arrow-right-24: AgentQ in Action](deep-dive/in-action.md) -- :material-chat-outline:{ .lg .middle } **Conversations, Responses & Context** +- **Conversations, Responses & Context** --- @@ -41,7 +41,7 @@ You can interact with AgentQ in several ways: through the **full-page chat** ope [:octicons-arrow-right-24: Conversations](deep-dive/conversations.md) -- :material-lightbulb-on-outline:{ .lg .middle } **Best Practices** +- **Best Practices** --- @@ -49,7 +49,7 @@ You can interact with AgentQ in several ways: through the **full-page chat** ope [:octicons-arrow-right-24: Best Practices](deep-dive/best-practices.md) -- :material-speedometer:{ .lg .middle } **AgentQ Limits** +- **AgentQ Limits** --- @@ -57,7 +57,7 @@ You can interact with AgentQ in several ways: through the **full-page chat** ope [:octicons-arrow-right-24: Limits](deep-dive/limits.md) -- :material-api:{ .lg .middle } **Agentic Endpoints** +- **Agentic Endpoints** --- @@ -67,105 +67,105 @@ You can interact with AgentQ in several ways: through the **full-page chat** ope
-## Managing +## How-tos
-- :material-puzzle-outline:{ .lg .middle } **Connecting External AI Clients** +- **Connecting External AI Clients** --- Connect ChatGPT, Claude Desktop, Claude Code, Cursor, VS Code, Windsurf, or Amazon Q Developer to the Qualytics MCP server. - [:octicons-arrow-right-24: Connect Clients](managing/connecting-external-ai-clients.md) + [:octicons-arrow-right-24: Connect Clients](how-tos/connecting-external-ai-clients.md) -- :material-connection:{ .lg .middle } **Add Integration** +- **Add Integration** --- Configure your LLM provider to power AgentQ's built-in chat. - [:octicons-arrow-right-24: Add Integration](managing/add-integration.md) + [:octicons-arrow-right-24: Add Integration](how-tos/add-integration.md) -- :material-pencil-outline:{ .lg .middle } **Update Integration** +- **Update Integration** --- Change your LLM provider, model, or API key. - [:octicons-arrow-right-24: Update](managing/update-integration.md) + [:octicons-arrow-right-24: Update](how-tos/update-integration.md) -- :material-link-variant-off:{ .lg .middle } **Remove Integration** +- **Remove Integration** --- Disconnect your LLM provider from AgentQ. - [:octicons-arrow-right-24: Remove](managing/remove-integration.md) + [:octicons-arrow-right-24: Remove](how-tos/remove-integration.md) -- :material-chat-plus-outline:{ .lg .middle } **Start a New Conversation** +- **Start a New Conversation** --- Create a fresh conversation from the sidebar, chat header, or floating chat. - [:octicons-arrow-right-24: Start](managing/start-a-new-conversation.md) + [:octicons-arrow-right-24: Start](how-tos/start-a-new-conversation.md) -- :material-history:{ .lg .middle } **Resume a Conversation** +- **Resume a Conversation** --- Return to a previous conversation and continue from where you left off. - [:octicons-arrow-right-24: Resume](managing/resume-a-conversation.md) + [:octicons-arrow-right-24: Resume](how-tos/resume-a-conversation.md) -- :material-pencil-outline:{ .lg .middle } **Rename a Conversation** +- **Rename a Conversation** --- Give a conversation a descriptive title for easier navigation. - [:octicons-arrow-right-24: Rename](managing/rename-a-conversation.md) + [:octicons-arrow-right-24: Rename](how-tos/rename-a-conversation.md) -- :material-archive-outline:{ .lg .middle } **Archive a Conversation** +- **Archive a Conversation** --- Move a conversation out of the active list into the archived section. - [:octicons-arrow-right-24: Archive](managing/archive-a-conversation.md) + [:octicons-arrow-right-24: Archive](how-tos/archive-a-conversation.md) -- :material-restore:{ .lg .middle } **Restore a Conversation** +- **Restore a Conversation** --- Bring an archived conversation back to the active list. - [:octicons-arrow-right-24: Restore](managing/restore-a-conversation.md) + [:octicons-arrow-right-24: Restore](how-tos/restore-a-conversation.md) -- :material-trash-can-outline:{ .lg .middle } **Delete a Conversation** +- **Delete a Conversation** --- Permanently remove an archived conversation. - [:octicons-arrow-right-24: Delete](managing/delete-a-conversation.md) + [:octicons-arrow-right-24: Delete](how-tos/delete-a-conversation.md) -- :material-magnify:{ .lg .middle } **Search Conversations** +- **Search Conversations** --- Filter active conversations by title or message content to find a specific conversation. - [:octicons-arrow-right-24: Search](managing/search-conversations.md) + [:octicons-arrow-right-24: Search](how-tos/search-conversations.md) -- :material-tooltip-text-outline:{ .lg .middle } **Chat Interface Tips** +- **Chat Interface Tips** --- Refresh the chat list, collapse the sidebar, attach files, paste large content, stop a response, and use prompt suggestions. - [:octicons-arrow-right-24: Tips](managing/chat-interface-tips.md) + [:octicons-arrow-right-24: Tips](how-tos/chat-interface-tips.md)
@@ -173,7 +173,7 @@ You can interact with AgentQ in several ways: through the **full-page chat** ope
-- :material-api:{ .lg .middle } **API** +- **API** --- @@ -181,7 +181,7 @@ You can interact with AgentQ in several ways: through the **full-page chat** ope [:octicons-arrow-right-24: API](api.md) -- :material-help-circle-outline:{ .lg .middle } **FAQ** +- **FAQ** --- diff --git a/docs/assets/agent-q/managing/add-integration/llm-modal-fields.png b/docs/assets/agentq/how-tos/add-integration/llm-modal-fields.png similarity index 100% rename from docs/assets/agent-q/managing/add-integration/llm-modal-fields.png rename to docs/assets/agentq/how-tos/add-integration/llm-modal-fields.png diff --git a/docs/assets/agent-q/managing/add-integration/step-1-agent-q-icon.png b/docs/assets/agentq/how-tos/add-integration/step-1-agentq-icon.png similarity index 100% rename from docs/assets/agent-q/managing/add-integration/step-1-agent-q-icon.png rename to docs/assets/agentq/how-tos/add-integration/step-1-agentq-icon.png diff --git a/docs/assets/agent-q/managing/add-integration/step-2-agent-q-no-llm.png b/docs/assets/agentq/how-tos/add-integration/step-2-agentq-no-llm.png similarity index 100% rename from docs/assets/agent-q/managing/add-integration/step-2-agent-q-no-llm.png rename to docs/assets/agentq/how-tos/add-integration/step-2-agentq-no-llm.png diff --git a/docs/assets/agent-q/managing/add-integration/step-3-agent-q-configure.png b/docs/assets/agentq/how-tos/add-integration/step-3-agentq-configure.png similarity index 100% rename from docs/assets/agent-q/managing/add-integration/step-3-agent-q-configure.png rename to docs/assets/agentq/how-tos/add-integration/step-3-agentq-configure.png diff --git a/docs/assets/agent-q/managing/add-integration/step-3-settings-integrations.png b/docs/assets/agentq/how-tos/add-integration/step-3-settings-integrations.png similarity index 100% rename from docs/assets/agent-q/managing/add-integration/step-3-settings-integrations.png rename to docs/assets/agentq/how-tos/add-integration/step-3-settings-integrations.png diff --git a/docs/assets/agent-q/managing/add-integration/step-4-integrations-page.png b/docs/assets/agentq/how-tos/add-integration/step-4-integrations-page.png similarity index 100% rename from docs/assets/agent-q/managing/add-integration/step-4-integrations-page.png rename to docs/assets/agentq/how-tos/add-integration/step-4-integrations-page.png diff --git a/docs/assets/agent-q/managing/add-integration/step-5-connect.png b/docs/assets/agentq/how-tos/add-integration/step-5-connect.png similarity index 100% rename from docs/assets/agent-q/managing/add-integration/step-5-connect.png rename to docs/assets/agentq/how-tos/add-integration/step-5-connect.png diff --git a/docs/assets/agent-q/managing/add-integration/step-6-modal.png b/docs/assets/agentq/how-tos/add-integration/step-6-modal.png similarity index 100% rename from docs/assets/agent-q/managing/add-integration/step-6-modal.png rename to docs/assets/agentq/how-tos/add-integration/step-6-modal.png diff --git a/docs/assets/agent-q/managing/add-integration/step-7-save.png b/docs/assets/agentq/how-tos/add-integration/step-7-save.png similarity index 100% rename from docs/assets/agent-q/managing/add-integration/step-7-save.png rename to docs/assets/agentq/how-tos/add-integration/step-7-save.png diff --git a/docs/assets/agent-q/managing/add-integration/step-8-connected.png b/docs/assets/agentq/how-tos/add-integration/step-8-connected.png similarity index 100% rename from docs/assets/agent-q/managing/add-integration/step-8-connected.png rename to docs/assets/agentq/how-tos/add-integration/step-8-connected.png diff --git a/docs/assets/agent-q/managing/archive-a-conversation/archive-menu.png b/docs/assets/agentq/how-tos/archive-a-conversation/archive-menu.png similarity index 100% rename from docs/assets/agent-q/managing/archive-a-conversation/archive-menu.png rename to docs/assets/agentq/how-tos/archive-a-conversation/archive-menu.png diff --git a/docs/assets/agent-q/managing/archive-a-conversation/chat-archived.png b/docs/assets/agentq/how-tos/archive-a-conversation/chat-archived.png similarity index 100% rename from docs/assets/agent-q/managing/archive-a-conversation/chat-archived.png rename to docs/assets/agentq/how-tos/archive-a-conversation/chat-archived.png diff --git a/docs/assets/agent-q/managing/chat-interface-tips/attached-file-floating.png b/docs/assets/agentq/how-tos/chat-interface-tips/attached-file-floating.png similarity index 100% rename from docs/assets/agent-q/managing/chat-interface-tips/attached-file-floating.png rename to docs/assets/agentq/how-tos/chat-interface-tips/attached-file-floating.png diff --git a/docs/assets/agent-q/managing/chat-interface-tips/attached-file.png b/docs/assets/agentq/how-tos/chat-interface-tips/attached-file.png similarity index 100% rename from docs/assets/agent-q/managing/chat-interface-tips/attached-file.png rename to docs/assets/agentq/how-tos/chat-interface-tips/attached-file.png diff --git a/docs/assets/agent-q/managing/chat-interface-tips/floating-overview.png b/docs/assets/agentq/how-tos/chat-interface-tips/floating-overview.png similarity index 100% rename from docs/assets/agent-q/managing/chat-interface-tips/floating-overview.png rename to docs/assets/agentq/how-tos/chat-interface-tips/floating-overview.png diff --git a/docs/assets/agent-q/managing/chat-interface-tips/full-page-overview.png b/docs/assets/agentq/how-tos/chat-interface-tips/full-page-overview.png similarity index 100% rename from docs/assets/agent-q/managing/chat-interface-tips/full-page-overview.png rename to docs/assets/agentq/how-tos/chat-interface-tips/full-page-overview.png diff --git a/docs/assets/agent-q/managing/chat-interface-tips/large-content.png b/docs/assets/agentq/how-tos/chat-interface-tips/large-content.png similarity index 100% rename from docs/assets/agent-q/managing/chat-interface-tips/large-content.png rename to docs/assets/agentq/how-tos/chat-interface-tips/large-content.png diff --git a/docs/assets/agent-q/managing/chat-interface-tips/pasted-floating.png b/docs/assets/agentq/how-tos/chat-interface-tips/pasted-floating.png similarity index 100% rename from docs/assets/agent-q/managing/chat-interface-tips/pasted-floating.png rename to docs/assets/agentq/how-tos/chat-interface-tips/pasted-floating.png diff --git a/docs/assets/agent-q/managing/chat-interface-tips/stop-floating.png b/docs/assets/agentq/how-tos/chat-interface-tips/stop-floating.png similarity index 100% rename from docs/assets/agent-q/managing/chat-interface-tips/stop-floating.png rename to docs/assets/agentq/how-tos/chat-interface-tips/stop-floating.png diff --git a/docs/assets/agent-q/managing/chat-interface-tips/stop.png b/docs/assets/agentq/how-tos/chat-interface-tips/stop.png similarity index 100% rename from docs/assets/agent-q/managing/chat-interface-tips/stop.png rename to docs/assets/agentq/how-tos/chat-interface-tips/stop.png diff --git a/docs/assets/agent-q/managing/connecting-external-ai-clients/step-1-profile.png b/docs/assets/agentq/how-tos/connecting-external-ai-clients/step-1-profile.png similarity index 100% rename from docs/assets/agent-q/managing/connecting-external-ai-clients/step-1-profile.png rename to docs/assets/agentq/how-tos/connecting-external-ai-clients/step-1-profile.png diff --git a/docs/assets/agent-q/managing/connecting-external-ai-clients/step-2-settings.png b/docs/assets/agentq/how-tos/connecting-external-ai-clients/step-2-settings.png similarity index 100% rename from docs/assets/agent-q/managing/connecting-external-ai-clients/step-2-settings.png rename to docs/assets/agentq/how-tos/connecting-external-ai-clients/step-2-settings.png diff --git a/docs/assets/agent-q/managing/connecting-external-ai-clients/step-3-apps.png b/docs/assets/agentq/how-tos/connecting-external-ai-clients/step-3-apps.png similarity index 100% rename from docs/assets/agent-q/managing/connecting-external-ai-clients/step-3-apps.png rename to docs/assets/agentq/how-tos/connecting-external-ai-clients/step-3-apps.png diff --git a/docs/assets/agent-q/managing/connecting-external-ai-clients/step-4-create-app.png b/docs/assets/agentq/how-tos/connecting-external-ai-clients/step-4-create-app.png similarity index 100% rename from docs/assets/agent-q/managing/connecting-external-ai-clients/step-4-create-app.png rename to docs/assets/agentq/how-tos/connecting-external-ai-clients/step-4-create-app.png diff --git a/docs/assets/agent-q/managing/connecting-external-ai-clients/step-5-modal-details.png b/docs/assets/agentq/how-tos/connecting-external-ai-clients/step-5-modal-details.png similarity index 100% rename from docs/assets/agent-q/managing/connecting-external-ai-clients/step-5-modal-details.png rename to docs/assets/agentq/how-tos/connecting-external-ai-clients/step-5-modal-details.png diff --git a/docs/assets/agent-q/managing/connecting-external-ai-clients/step-6-create-button.png b/docs/assets/agentq/how-tos/connecting-external-ai-clients/step-6-create-button.png similarity index 100% rename from docs/assets/agent-q/managing/connecting-external-ai-clients/step-6-create-button.png rename to docs/assets/agentq/how-tos/connecting-external-ai-clients/step-6-create-button.png diff --git a/docs/assets/agent-q/managing/connecting-external-ai-clients/step-7-auth-prompt.png b/docs/assets/agentq/how-tos/connecting-external-ai-clients/step-7-auth-prompt.png similarity index 100% rename from docs/assets/agent-q/managing/connecting-external-ai-clients/step-7-auth-prompt.png rename to docs/assets/agentq/how-tos/connecting-external-ai-clients/step-7-auth-prompt.png diff --git a/docs/assets/agent-q/managing/delete-a-conversation/chat-permanently-deleted.png b/docs/assets/agentq/how-tos/delete-a-conversation/chat-permanently-deleted.png similarity index 100% rename from docs/assets/agent-q/managing/delete-a-conversation/chat-permanently-deleted.png rename to docs/assets/agentq/how-tos/delete-a-conversation/chat-permanently-deleted.png diff --git a/docs/assets/agent-q/managing/delete-a-conversation/delete-menu.png b/docs/assets/agentq/how-tos/delete-a-conversation/delete-menu.png similarity index 100% rename from docs/assets/agent-q/managing/delete-a-conversation/delete-menu.png rename to docs/assets/agentq/how-tos/delete-a-conversation/delete-menu.png diff --git a/docs/assets/agent-q/managing/remove-integration/disconnect-confirmation.png b/docs/assets/agentq/how-tos/remove-integration/disconnect-confirmation.png similarity index 100% rename from docs/assets/agent-q/managing/remove-integration/disconnect-confirmation.png rename to docs/assets/agentq/how-tos/remove-integration/disconnect-confirmation.png diff --git a/docs/assets/agent-q/managing/remove-integration/disconnected-successfully.png b/docs/assets/agentq/how-tos/remove-integration/disconnected-successfully.png similarity index 100% rename from docs/assets/agent-q/managing/remove-integration/disconnected-successfully.png rename to docs/assets/agentq/how-tos/remove-integration/disconnected-successfully.png diff --git a/docs/assets/agent-q/managing/remove-integration/three-dots-menu.png b/docs/assets/agentq/how-tos/remove-integration/three-dots-menu.png similarity index 100% rename from docs/assets/agent-q/managing/remove-integration/three-dots-menu.png rename to docs/assets/agentq/how-tos/remove-integration/three-dots-menu.png diff --git a/docs/assets/agent-q/managing/rename-a-conversation/chat-renamed.png b/docs/assets/agentq/how-tos/rename-a-conversation/chat-renamed.png similarity index 100% rename from docs/assets/agent-q/managing/rename-a-conversation/chat-renamed.png rename to docs/assets/agentq/how-tos/rename-a-conversation/chat-renamed.png diff --git a/docs/assets/agent-q/managing/rename-a-conversation/rename-input.png b/docs/assets/agentq/how-tos/rename-a-conversation/rename-input.png similarity index 100% rename from docs/assets/agent-q/managing/rename-a-conversation/rename-input.png rename to docs/assets/agentq/how-tos/rename-a-conversation/rename-input.png diff --git a/docs/assets/agent-q/managing/rename-a-conversation/rename-menu.png b/docs/assets/agentq/how-tos/rename-a-conversation/rename-menu.png similarity index 100% rename from docs/assets/agent-q/managing/rename-a-conversation/rename-menu.png rename to docs/assets/agentq/how-tos/rename-a-conversation/rename-menu.png diff --git a/docs/assets/agent-q/managing/rename-a-conversation/rename-save.png b/docs/assets/agentq/how-tos/rename-a-conversation/rename-save.png similarity index 100% rename from docs/assets/agent-q/managing/rename-a-conversation/rename-save.png rename to docs/assets/agentq/how-tos/rename-a-conversation/rename-save.png diff --git a/docs/assets/agent-q/managing/restore-a-conversation/chat-restored.png b/docs/assets/agentq/how-tos/restore-a-conversation/chat-restored.png similarity index 100% rename from docs/assets/agent-q/managing/restore-a-conversation/chat-restored.png rename to docs/assets/agentq/how-tos/restore-a-conversation/chat-restored.png diff --git a/docs/assets/agent-q/managing/restore-a-conversation/restore-menu.png b/docs/assets/agentq/how-tos/restore-a-conversation/restore-menu.png similarity index 100% rename from docs/assets/agent-q/managing/restore-a-conversation/restore-menu.png rename to docs/assets/agentq/how-tos/restore-a-conversation/restore-menu.png diff --git a/docs/assets/agent-q/managing/resume-a-conversation/chats-sidebar.png b/docs/assets/agentq/how-tos/resume-a-conversation/chats-sidebar.png similarity index 100% rename from docs/assets/agent-q/managing/resume-a-conversation/chats-sidebar.png rename to docs/assets/agentq/how-tos/resume-a-conversation/chats-sidebar.png diff --git a/docs/assets/agent-q/managing/resume-a-conversation/conversation-resumed.png b/docs/assets/agentq/how-tos/resume-a-conversation/conversation-resumed.png similarity index 100% rename from docs/assets/agent-q/managing/resume-a-conversation/conversation-resumed.png rename to docs/assets/agentq/how-tos/resume-a-conversation/conversation-resumed.png diff --git a/docs/assets/agent-q/managing/resume-a-conversation/floating-chat-history-button.png b/docs/assets/agentq/how-tos/resume-a-conversation/floating-chat-history-button.png similarity index 100% rename from docs/assets/agent-q/managing/resume-a-conversation/floating-chat-history-button.png rename to docs/assets/agentq/how-tos/resume-a-conversation/floating-chat-history-button.png diff --git a/docs/assets/agent-q/managing/resume-a-conversation/floating-chat-history-list.png b/docs/assets/agentq/how-tos/resume-a-conversation/floating-chat-history-list.png similarity index 100% rename from docs/assets/agent-q/managing/resume-a-conversation/floating-chat-history-list.png rename to docs/assets/agentq/how-tos/resume-a-conversation/floating-chat-history-list.png diff --git a/docs/assets/agent-q/managing/resume-a-conversation/floating-conversation-resumed.png b/docs/assets/agentq/how-tos/resume-a-conversation/floating-conversation-resumed.png similarity index 100% rename from docs/assets/agent-q/managing/resume-a-conversation/floating-conversation-resumed.png rename to docs/assets/agentq/how-tos/resume-a-conversation/floating-conversation-resumed.png diff --git a/docs/assets/agent-q/managing/resume-a-conversation/select-conversation.png b/docs/assets/agentq/how-tos/resume-a-conversation/select-conversation.png similarity index 100% rename from docs/assets/agent-q/managing/resume-a-conversation/select-conversation.png rename to docs/assets/agentq/how-tos/resume-a-conversation/select-conversation.png diff --git a/docs/assets/agent-q/managing/search-conversations/search-button.png b/docs/assets/agentq/how-tos/search-conversations/search-button.png similarity index 100% rename from docs/assets/agent-q/managing/search-conversations/search-button.png rename to docs/assets/agentq/how-tos/search-conversations/search-button.png diff --git a/docs/assets/agent-q/managing/search-conversations/search-results.png b/docs/assets/agentq/how-tos/search-conversations/search-results.png similarity index 100% rename from docs/assets/agent-q/managing/search-conversations/search-results.png rename to docs/assets/agentq/how-tos/search-conversations/search-results.png diff --git a/docs/assets/agent-q/managing/shared/archived-kebab-menu.png b/docs/assets/agentq/how-tos/shared/archived-kebab-menu.png similarity index 100% rename from docs/assets/agent-q/managing/shared/archived-kebab-menu.png rename to docs/assets/agentq/how-tos/shared/archived-kebab-menu.png diff --git a/docs/assets/agent-q/managing/shared/archived-menu-options.png b/docs/assets/agentq/how-tos/shared/archived-menu-options.png similarity index 100% rename from docs/assets/agent-q/managing/shared/archived-menu-options.png rename to docs/assets/agentq/how-tos/shared/archived-menu-options.png diff --git a/docs/assets/agent-q/managing/shared/kebab-menu.png b/docs/assets/agentq/how-tos/shared/kebab-menu.png similarity index 100% rename from docs/assets/agent-q/managing/shared/kebab-menu.png rename to docs/assets/agentq/how-tos/shared/kebab-menu.png diff --git a/docs/assets/agent-q/managing/shared/menu-options.png b/docs/assets/agentq/how-tos/shared/menu-options.png similarity index 100% rename from docs/assets/agent-q/managing/shared/menu-options.png rename to docs/assets/agentq/how-tos/shared/menu-options.png diff --git a/docs/assets/agent-q/managing/shared/settings-connections.png b/docs/assets/agentq/how-tos/shared/settings-connections.png similarity index 100% rename from docs/assets/agent-q/managing/shared/settings-connections.png rename to docs/assets/agentq/how-tos/shared/settings-connections.png diff --git a/docs/assets/agent-q/managing/shared/settings-icon.png b/docs/assets/agentq/how-tos/shared/settings-icon.png similarity index 100% rename from docs/assets/agent-q/managing/shared/settings-icon.png rename to docs/assets/agentq/how-tos/shared/settings-icon.png diff --git a/docs/assets/agent-q/managing/start-a-new-conversation/agent-q-page.png b/docs/assets/agentq/how-tos/start-a-new-conversation/agentq-page.png similarity index 100% rename from docs/assets/agent-q/managing/start-a-new-conversation/agent-q-page.png rename to docs/assets/agentq/how-tos/start-a-new-conversation/agentq-page.png diff --git a/docs/assets/agent-q/managing/start-a-new-conversation/floating-chat-fab.png b/docs/assets/agentq/how-tos/start-a-new-conversation/floating-chat-fab.png similarity index 100% rename from docs/assets/agent-q/managing/start-a-new-conversation/floating-chat-fab.png rename to docs/assets/agentq/how-tos/start-a-new-conversation/floating-chat-fab.png diff --git a/docs/assets/agent-q/managing/start-a-new-conversation/floating-conversation-started.png b/docs/assets/agentq/how-tos/start-a-new-conversation/floating-conversation-started.png similarity index 100% rename from docs/assets/agent-q/managing/start-a-new-conversation/floating-conversation-started.png rename to docs/assets/agentq/how-tos/start-a-new-conversation/floating-conversation-started.png diff --git a/docs/assets/agent-q/managing/start-a-new-conversation/floating-new-chat-button.png b/docs/assets/agentq/how-tos/start-a-new-conversation/floating-new-chat-button.png similarity index 100% rename from docs/assets/agent-q/managing/start-a-new-conversation/floating-new-chat-button.png rename to docs/assets/agentq/how-tos/start-a-new-conversation/floating-new-chat-button.png diff --git a/docs/assets/agent-q/managing/start-a-new-conversation/new-chat-active-conversation.png b/docs/assets/agentq/how-tos/start-a-new-conversation/new-chat-active-conversation.png similarity index 100% rename from docs/assets/agent-q/managing/start-a-new-conversation/new-chat-active-conversation.png rename to docs/assets/agentq/how-tos/start-a-new-conversation/new-chat-active-conversation.png diff --git a/docs/assets/agent-q/managing/start-a-new-conversation/new-chat-button.png b/docs/assets/agentq/how-tos/start-a-new-conversation/new-chat-button.png similarity index 100% rename from docs/assets/agent-q/managing/start-a-new-conversation/new-chat-button.png rename to docs/assets/agentq/how-tos/start-a-new-conversation/new-chat-button.png diff --git a/docs/assets/agent-q/managing/update-integration/edit-modal.png b/docs/assets/agentq/how-tos/update-integration/edit-modal.png similarity index 100% rename from docs/assets/agent-q/managing/update-integration/edit-modal.png rename to docs/assets/agentq/how-tos/update-integration/edit-modal.png diff --git a/docs/assets/agent-q/managing/update-integration/saved-successfully.png b/docs/assets/agentq/how-tos/update-integration/saved-successfully.png similarity index 100% rename from docs/assets/agent-q/managing/update-integration/saved-successfully.png rename to docs/assets/agentq/how-tos/update-integration/saved-successfully.png diff --git a/docs/assets/agent-q/managing/update-integration/three-dots-menu.png b/docs/assets/agentq/how-tos/update-integration/three-dots-menu.png similarity index 100% rename from docs/assets/agent-q/managing/update-integration/three-dots-menu.png rename to docs/assets/agentq/how-tos/update-integration/three-dots-menu.png diff --git a/docs/assets/agent-q/managing/update-integration/update-fields.png b/docs/assets/agentq/how-tos/update-integration/update-fields.png similarity index 100% rename from docs/assets/agent-q/managing/update-integration/update-fields.png rename to docs/assets/agentq/how-tos/update-integration/update-fields.png diff --git a/docs/assets/integrations/mcp-quickstart/agent-q.png b/docs/assets/integrations/mcp-quickstart/agentq.png similarity index 100% rename from docs/assets/integrations/mcp-quickstart/agent-q.png rename to docs/assets/integrations/mcp-quickstart/agentq.png diff --git a/docs/assets/using-the-platform/onboarding/agent-q.png b/docs/assets/using-the-platform/onboarding/agentq.png similarity index 100% rename from docs/assets/using-the-platform/onboarding/agent-q.png rename to docs/assets/using-the-platform/onboarding/agentq.png diff --git a/docs/assets/web-app/app-navigation/agent-q.png b/docs/assets/web-app/app-navigation/agentq.png similarity index 100% rename from docs/assets/web-app/app-navigation/agent-q.png rename to docs/assets/web-app/app-navigation/agentq.png diff --git a/docs/cli/examples/connect-mcp-clients.md b/docs/cli/examples/connect-mcp-clients.md index dec21db0b0..d7961428a8 100644 --- a/docs/cli/examples/connect-mcp-clients.md +++ b/docs/cli/examples/connect-mcp-clients.md @@ -163,5 +163,5 @@ Once wired in, useful prompts: ## Related - [MCP Server command reference](../mcp-server.md) -- [AgentQ Deep Dive: MCP](../../agent-q/deep-dive/mcp.md): the conceptual model for how Qualytics exposes MCP. -- [Connecting External AI Clients](../../agent-q/managing/connecting-external-ai-clients.md): the in-product setup walkthrough. +- [AgentQ Deep Dive: MCP](../../agentq/deep-dive/mcp.md): the conceptual model for how Qualytics exposes MCP. +- [Connecting External AI Clients](../../agentq/how-tos/connecting-external-ai-clients.md): the in-product setup walkthrough. diff --git a/docs/glossary.md b/docs/glossary.md index c6d63d92d7..8cbca11430 100644 --- a/docs/glossary.md +++ b/docs/glossary.md @@ -1,296 +1,296 @@ -# Glossary - -### __Anomaly__ - -Something that deviates from the standard, normal, or expected. This can be in the form of a single data point, record, or a batch of data. - -### __Accuracy__ - -The data represents the real-world values they are expected to model. - -### __Sync Operation__ - -Detects new, changed, or removed containers and fields in a Datastore. Works incrementally by comparing the current datastore state against what Qualytics already knows, only processing the differences. Required for the proper functioning of subsequent Operations such as Profile, Hash, and Scan. Previously known as "Catalog Operation". - -### __Comparison__ - -An evaluation to determine if the structure and content of the source and target Datastores match. - -### __Comparison Runs__ - -An action to perform a comparison. - -### __Completeness__ - -Required fields are fully populated. - -### __Conformity__ - -Alignment of the content to the required standards, schemas, and formats. - -### __Connectors__ - -Components that can be easily connected to and used to integrate with other applications and databases. Common uses include sending and receiving data. - -!!! info - Qualytics provides verified connectors for a wide range of datastores, including: Files (CSV, JSON, XLSX, Parquet, Delta, Iceberg) on Object Storage (S3, Azure Blob, GCS); Data Warehouses (BigQuery, Snowflake, Redshift); and Databases (Oracle, MSSQL, MySQL, PostgreSQL, Trino, etc.). Because Qualytics is built on Apache Spark, additional JDBC-accessible datastores or file formats may be technically compatible. If yours is not listed, contact us — our team will evaluate feasibility and work with you to determine whether a supported connection can be established. - -### __Consistency__ - -The value is the same across all datastores within the organization. - -### __Container (of a Datastore)__ - -The uniquely named abstractions within a Datastore that hold data adhering to a known schema. The Containers within a RDBMS are tables, the containers in a filesystem are well formatted files, etc. - -### __Data-at-rest__ - -Data that is stored in a database, warehouse, file system, data lake, or other datastore. - -### __Data Drift__ - -Changes in a data set’s properties or characteristics over time. - -### __Data-in-flight__ - -Data that is on the move, transporting from one location to another, such as through a message queue, API, or other pipeline. - -### __Data Lake__ - -​​A centralized repository that allows you to store all your structured and unstructured data at any scale. - -### __Data Quality__ - -Ensuring data is free from errors, including duplicates, inaccuracies, inappropriate fields, irrelevant data, missing elements, non-conforming data, and poor data entry. - -### __Data Quality Check__ - -aka "Check" is an expression regarding the values of a Container that can be evaluated to determine whether the actual values are expected or not. - -### __Datastore__ - -Where data is persisted in a database, file system, or other connected retrieval systems. You can check more in [Datastore Overview](source-datastore/datastore/overview-of-a-datastore.md). - -### __Data Warehouse__ - -A system that aggregates data from different sources into a single, central, consistent datastore to support data analysis, data mining, artificial intelligence (AI), and machine learning. - -### __Distinctness (of a Field)__ - -The fraction of distinct values (appear at least once) to total values that appear in a Field. - -### __Enrichment Datastore__ - -Additional properties that are added to a data set to enhance its meaning. Qualytics enrichment includes whether a record is anomalous, what caused it to be an anomaly, what characteristics it was expected to have, and flags that allow other systems to act upon the data. - -### __Excluded Field__ - -A field that has been manually removed from quality monitoring by a user. Its quality checks are archived (except Expected Schema, which is updated), and dependent computed fields are also excluded. Excluded fields can be [restored](fields/field-status/managing-field-status/restore-a-field.md) to active status. - -### __Favorite__ - -Users can mark instances of an abstraction (Field, Container, Datastore, Check, Anomaly, etc.) as a personalized favorite to ensure it ranks higher in default ordering and is prioritized in other personalized views & workflows. - -### __Field Status__ - -A property assigned to every field in Qualytics that determines how the platform interacts with it. The four statuses are **Active**, **Masked**, **Missing**, and **Excluded**. Field status controls whether a field is included in profiling, scanning, and quality check evaluations. Learn more in [Field Status Overview](fields/field-status/overview.md). - -### __Compute Daemon__ - -An application that protects a system from contamination due to inputs, reducing the likelihood of contamination from an outside source. The Compute Daemon will quarantine data that is problematic, allowing the user to act upon quarantined items. - -### __Incremental Identifier__ - -A Field that can be used to group the records in the Table Container into distinct ordered Qualytics Partitions in support of incremental operations upon those partitions: - -* a whole number - then all records with the same partition_id value are considered part of the same partition. -* a float or timestamp - then all records between two defined values are considered part of the same partition (the defining values will be set by incremental scan/profile business logic). Since Qualytics Partitions are required to support Incremental Operations, an Incremental Identifier is required for a Table Container to support incremental Operations. - -### __Incremental Scan Operation__ - -A Scan Operation where only new records (inserted since the last Scan Operation) are analyzed. The underlying Container must support determining which records are new for incremental scanning to be a valid option for it. - -### __AI Effort__ - -A profile operation setting that controls how deeply Qualytics AI explores your data when generating checks. The labeled scale has six levels — **Off**, **Low**, **Medium**, **High**, **Extra High**, **Max** — each with a plain-language description of which check families are evaluated and the relative runtime. Each higher level builds on the previous. In the API, this is the `ai_effort` field; the legacy `inference_threshold` integer (0–5) is still accepted as a deprecated alias. - -### __AI Managed Check__ - -A data quality check managed by Qualytics AI during a Profile operation — generated, validated, and continuously tuned against your data. Previously called "Inferred Check". AI Managed checks display a purple **AI badge** (four-point star icon) on cards, rows, and detail views. Future profile runs continue to tune them unless a user edits the check, in which case the override is preserved. In the API, identified by `inferred: true` (field name preserved for backward compatibility). - -### __AI Badge__ - -A purple pill containing a four-point star icon and the text "AI" that visually identifies AI Managed checks (tooltip: "Authored by AI and is continuously tuned to your observed data") and anomalies whose every failed check is AI Managed (tooltip: "Identified by AI managed checks"). - -### __Qualytics AI (formerly Inference Engine)__ - -After the Compute Daemon gathers all the metadata generated by a profiling operation, it feeds that metadata into Qualytics AI. AI then initiates a true machine learning process (Inductive Learning) whereby the available customer data is partitioned into a training set and a testing set. AI applies numerous machine learning models and techniques to the training data in an effort to discover well-fitting data quality constraints. Those candidate constraints are then validated and backtested against the held-out testing set, and only those that assert true above a certain threshold are converted to **AI Managed** data quality checks. - -### __Masked Field__ - -A field that remains fully operational (profiled, scanned, and quality-checked) but whose actual values are hidden across the platform by default. Users with Editor permission can reveal masked values, and every access is recorded in the masking audit log. Learn more in [Field Masking](fields/field-status/concepts/field-masking.md). - -### __Merge Fields__ - -An operation that combines two fields on the same container — typically used when a column is renamed in the source data. The source field keeps its history (quality checks, anomalies, profiles) and adopts the target field's name. The target field is removed. Learn more in [Merge Fields](fields/field-status/concepts/merge-fields.md). - -### __Metadata__ - -Data about other data, including descriptions and additional information. - -### __Missing Field__ - -A field that was previously active but is no longer found in the source data during a profile operation. Missing fields are automatically restored to Active when they reappear. They cannot be manually restored by a user. Learn more in [Field Status Lifecycle](fields/field-status/concepts/field-status-lifecycle.md). - -### __Object Storage__ - -A type of data storage used for handling large amounts of unstructured data managed as objects. - -### __Operation__ - -The asynchronous (often long-running) tasks that operate on Datastores are collectively referred to as "Operations". Examples include Sync, Profile, Hash, and Scan. - -### __Partition Identifier__ - -A Field that can be used by Spark to group the records in a Dataframe into smaller sets that fit within our Spark worker’s memory. The ideal Partition Identifier is an Incremental Identifier of type datetime since that can serve as both but we identify alternatives should that not be available. - -### __Pipeline__ - -A workflow that processes and moves data between systems. - -### __Precision__ - -Your data is the resolution that is expected- How tightly can you define your data? - -### __Profile Operation__ - -An operation that generates metadata describing the characteristics of your actual data values. - -### __Profiling__ - -The process of collecting statistics on the characteristics of a dataset involving examining, analyzing, and reviewing the data. - -### __Proprietary Algorithms__ - -A procedure utilizing a combination of processes, tools, or systems of interrelated connections that are the property of a business or individual in order to solve a problem. - -### __Quality Score__ - -A measure of data quality calculated at the Field, Container, and Datastore level. Quality Scores are recorded as time-series enabling you to track movement over time. You can read more in [Quality Scoring](quality-scores/what-are-quality-scores.md). - -### __Qualytics App__ - -aka "App" this is the user interface for our Product delivered as a web application. - -### __Qualytics Deployment__ - -A single instance of our product (the k8s cluster, postgres database, controlplane/app/compute daemon pods, etc). - -### __Qualytics Compute Daemon__ - -aka "Compute Daemon" this is the layer of our Product that connects to Datastores and directly operates on users’ data. - -### __Qualytics Implementation__ - -A customer’s Deployment plus any associated integrations. - -### __Controlplane__ - -aka "controlplane" this is the layer of our Product that exposes an Application Programming Interface (API). - -### __Qualytics Partition__ - -The smallest grouping of records that can be incrementally processed. For DFS datastores, each file is a Qualytics Partition. For JDBC datastores, partitions are defined by each table’s incremental identifier values. - -### __Record (of a Container)__ - -A distinct set of values for all Fields defined for a Container (e.g. a row of a table). - -### __Schema__ - -The organization of data in a datastore. This could be the columns of a table, the header of a CSV file, the fields in a JSON file, or other structural constraints. - -### __Schema Differences__ - -Differences in the organization of information between two datastores that are supposed to hold the same content. - -### __Source__ - -The origin of data in a pipeline, migration, or other ELT/ETL process. It’s where data gets extracted. - -### __Tag__ - -Users can assign Tags to Datastores, Profiles (Files, Tables, Containers), Checks and Anomalies. Add a Description and Assign a Weight. The weight value directly correlates with the level of importance, where a higher weight indicates higher significance. - -### __Target__ - -The destination of data in a pipeline, migration, or other ELT/ETL process. It’s where data gets loaded. - -### __Third-party data__ - -Data acquired from a source outside of your company which may not be controlled by the same data quality processes. You may not have the same level of confidence in the data and it may not be as trustworthy as internally vetted datasets. - -### __Timeliness__ - -It can be calculated as the time between when information should be available and when it is actually available, focused on if data is available when it’s expected. - -### __Volumetrics__ - -Data has the same size and shape across similar cycles. It includes statistics about the size of a data set including calculations or predictions on the rate of change over time. - -### __AgentQ__ - -The AI assistant built into the Qualytics platform. Powered by the Model Context Protocol (MCP) and your choice of LLM provider, AgentQ turns natural language into action — exploring datastores, building transformations, creating quality checks, investigating anomalies, and more. Learn more in [AgentQ Overview](agent-q/overview.md). - -### __Model Context Protocol (MCP)__ - -An [open standard](https://modelcontextprotocol.io/) that enables AI assistants to securely connect to external data sources, tools, and services. MCP defines a common language for how AI models discover and call capabilities exposed by external systems. Qualytics implements an MCP server that exposes its data quality infrastructure as callable tools. Learn more in [MCP](agent-q/deep-dive/mcp.md). - -### __MCP Server__ - -An application that exposes a set of tools and resources through the Model Context Protocol. The Qualytics MCP server handles authentication, executes tool logic, and returns structured results to connected AI clients. - -### __MCP Client__ - -An AI assistant or agent (like Claude Desktop, ChatGPT, Cursor, or AgentQ) that connects to one or more MCP servers and can call their tools during a conversation. - -### __MCP Tool__ - -A discrete capability exposed by an MCP server that an AI assistant can call. Each tool has a name, description, input schema, and structured output. Examples include `list_datastores`, `create_quality_check`, and `anomaly_describe`. - -### __Agentic Endpoints__ - -Qualytics API endpoints that use an agent to service the request, bringing conversational AI capabilities directly into custom applications and automation workflows. Because they delegate to an agent, they are non-deterministic. They provide the same capabilities as MCP through standard REST calls. Learn more in [Agentic Endpoints](agent-q/deep-dive/agentic.md). - -### __LLM (Large Language Model)__ - -An AI model trained on large amounts of text data that can understand and generate natural language. AgentQ uses your configured LLM provider (e.g., OpenAI, Anthropic, Google Gemini) to interpret requests and decide which tools to call. - -### __Topic Guardrail__ - -A lightweight LLM classifier that runs before AgentQ processes a request. It checks whether the message relates to data quality, governance, databases, anomalies, transformations, or the Qualytics platform, and politely declines off-topic requests. - -### __Dynamic Tool Discovery__ - -A mechanism where AgentQ starts with a small core set of tools and loads additional tools on demand as the conversation progresses, using the `discover_tools` meta-tool. This keeps token usage lean while making all capabilities available. - -### __Context Injection__ - -When AgentQ is opened from a page with relevant data (a datastore, container, field, quality check, or anomaly), the asset's identity is automatically embedded in the conversation context. This allows the user to ask questions without specifying which asset they mean. - -### __Co-Authorship Tracking__ - -All platform changes made through AgentQ are stamped with a co-author record in the audit trail alongside the user's identity. This ensures full traceability of AI-assisted actions. - -### __Guided Workflow__ - -A multi-step tool that executes a structured process for complex tasks. AgentQ includes guided workflows for analyzing trends, investigating anomalies, interpreting quality scores, generating quality checks, and creating computed assets. - -### __Weight (Importance / Severity)__ - -The numeric weight value directly correlates with the level of importance, where a higher weight indicates higher significance. In the UI, this value is surfaced under different labels depending on the entity: - -- **Importance** — on **checks** (cards, rows, totals, sort options, observability, templates, histograms). -- **Severity** — on **anomalies** (cards, rows, highlight panel, detail modal, sort options, flow trigger filters). - -**Field weight**, **tag weight**, and **quality-score dimension weights** (Completeness, Coverage, Conformity, Consistency, Precision, Timeliness, Volumetrics, Accuracy) continue to use the term **Weight** with the existing icon. In the API, the underlying field is `weight` for both checks and anomalies, and `weight_threshold` for the flow trigger anomaly filter. +# Glossary + +### __Anomaly__ + +Something that deviates from the standard, normal, or expected. This can be in the form of a single data point, record, or a batch of data. + +### __Accuracy__ + +The data represents the real-world values they are expected to model. + +### __Sync Operation__ + +Detects new, changed, or removed containers and fields in a Datastore. Works incrementally by comparing the current datastore state against what Qualytics already knows, only processing the differences. Required for the proper functioning of subsequent Operations such as Profile, Hash, and Scan. Previously known as "Catalog Operation". + +### __Comparison__ + +An evaluation to determine if the structure and content of the source and target Datastores match. + +### __Comparison Runs__ + +An action to perform a comparison. + +### __Completeness__ + +Required fields are fully populated. + +### __Conformity__ + +Alignment of the content to the required standards, schemas, and formats. + +### __Connectors__ + +Components that can be easily connected to and used to integrate with other applications and databases. Common uses include sending and receiving data. + +!!! info + Qualytics provides verified connectors for a wide range of datastores, including: Files (CSV, JSON, XLSX, Parquet, Delta, Iceberg) on Object Storage (S3, Azure Blob, GCS); Data Warehouses (BigQuery, Snowflake, Redshift); and Databases (Oracle, MSSQL, MySQL, PostgreSQL, Trino, etc.). Because Qualytics is built on Apache Spark, additional JDBC-accessible datastores or file formats may be technically compatible. If yours is not listed, contact us — our team will evaluate feasibility and work with you to determine whether a supported connection can be established. + +### __Consistency__ + +The value is the same across all datastores within the organization. + +### __Container (of a Datastore)__ + +The uniquely named abstractions within a Datastore that hold data adhering to a known schema. The Containers within a RDBMS are tables, the containers in a filesystem are well formatted files, etc. + +### __Data-at-rest__ + +Data that is stored in a database, warehouse, file system, data lake, or other datastore. + +### __Data Drift__ + +Changes in a data set’s properties or characteristics over time. + +### __Data-in-flight__ + +Data that is on the move, transporting from one location to another, such as through a message queue, API, or other pipeline. + +### __Data Lake__ + +​​A centralized repository that allows you to store all your structured and unstructured data at any scale. + +### __Data Quality__ + +Ensuring data is free from errors, including duplicates, inaccuracies, inappropriate fields, irrelevant data, missing elements, non-conforming data, and poor data entry. + +### __Data Quality Check__ + +aka "Check" is an expression regarding the values of a Container that can be evaluated to determine whether the actual values are expected or not. + +### __Datastore__ + +Where data is persisted in a database, file system, or other connected retrieval systems. You can check more in [Datastore Overview](source-datastore/datastore/overview-of-a-datastore.md). + +### __Data Warehouse__ + +A system that aggregates data from different sources into a single, central, consistent datastore to support data analysis, data mining, artificial intelligence (AI), and machine learning. + +### __Distinctness (of a Field)__ + +The fraction of distinct values (appear at least once) to total values that appear in a Field. + +### __Enrichment Datastore__ + +Additional properties that are added to a data set to enhance its meaning. Qualytics enrichment includes whether a record is anomalous, what caused it to be an anomaly, what characteristics it was expected to have, and flags that allow other systems to act upon the data. + +### __Excluded Field__ + +A field that has been manually removed from quality monitoring by a user. Its quality checks are archived (except Expected Schema, which is updated), and dependent computed fields are also excluded. Excluded fields can be [restored](fields/field-status/managing-field-status/restore-a-field.md) to active status. + +### __Favorite__ + +Users can mark instances of an abstraction (Field, Container, Datastore, Check, Anomaly, etc.) as a personalized favorite to ensure it ranks higher in default ordering and is prioritized in other personalized views & workflows. + +### __Field Status__ + +A property assigned to every field in Qualytics that determines how the platform interacts with it. The four statuses are **Active**, **Masked**, **Missing**, and **Excluded**. Field status controls whether a field is included in profiling, scanning, and quality check evaluations. Learn more in [Field Status Overview](fields/field-status/overview.md). + +### __Compute Daemon__ + +An application that protects a system from contamination due to inputs, reducing the likelihood of contamination from an outside source. The Compute Daemon will quarantine data that is problematic, allowing the user to act upon quarantined items. + +### __Incremental Identifier__ + +A Field that can be used to group the records in the Table Container into distinct ordered Qualytics Partitions in support of incremental operations upon those partitions: + +* a whole number - then all records with the same partition_id value are considered part of the same partition. +* a float or timestamp - then all records between two defined values are considered part of the same partition (the defining values will be set by incremental scan/profile business logic). Since Qualytics Partitions are required to support Incremental Operations, an Incremental Identifier is required for a Table Container to support incremental Operations. + +### __Incremental Scan Operation__ + +A Scan Operation where only new records (inserted since the last Scan Operation) are analyzed. The underlying Container must support determining which records are new for incremental scanning to be a valid option for it. + +### __AI Effort__ + +A profile operation setting that controls how deeply Qualytics AI explores your data when generating checks. The labeled scale has six levels — **Off**, **Low**, **Medium**, **High**, **Extra High**, **Max** — each with a plain-language description of which check families are evaluated and the relative runtime. Each higher level builds on the previous. In the API, this is the `ai_effort` field; the legacy `inference_threshold` integer (0–5) is still accepted as a deprecated alias. + +### __AI Managed Check__ + +A data quality check managed by Qualytics AI during a Profile operation — generated, validated, and continuously tuned against your data. Previously called "Inferred Check". AI Managed checks display a purple **AI badge** (four-point star icon) on cards, rows, and detail views. Future profile runs continue to tune them unless a user edits the check, in which case the override is preserved. In the API, identified by `inferred: true` (field name preserved for backward compatibility). + +### __AI Badge__ + +A purple pill containing a four-point star icon and the text "AI" that visually identifies AI Managed checks (tooltip: "Authored by AI and is continuously tuned to your observed data") and anomalies whose every failed check is AI Managed (tooltip: "Identified by AI managed checks"). + +### __Qualytics AI (formerly Inference Engine)__ + +After the Compute Daemon gathers all the metadata generated by a profiling operation, it feeds that metadata into Qualytics AI. AI then initiates a true machine learning process (Inductive Learning) whereby the available customer data is partitioned into a training set and a testing set. AI applies numerous machine learning models and techniques to the training data in an effort to discover well-fitting data quality constraints. Those candidate constraints are then validated and backtested against the held-out testing set, and only those that assert true above a certain threshold are converted to **AI Managed** data quality checks. + +### __Masked Field__ + +A field that remains fully operational (profiled, scanned, and quality-checked) but whose actual values are hidden across the platform by default. Users with Editor permission can reveal masked values, and every access is recorded in the masking audit log. Learn more in [Field Masking](fields/field-status/concepts/field-masking.md). + +### __Merge Fields__ + +An operation that combines two fields on the same container — typically used when a column is renamed in the source data. The source field keeps its history (quality checks, anomalies, profiles) and adopts the target field's name. The target field is removed. Learn more in [Merge Fields](fields/field-status/concepts/merge-fields.md). + +### __Metadata__ + +Data about other data, including descriptions and additional information. + +### __Missing Field__ + +A field that was previously active but is no longer found in the source data during a profile operation. Missing fields are automatically restored to Active when they reappear. They cannot be manually restored by a user. Learn more in [Field Status Lifecycle](fields/field-status/concepts/field-status-lifecycle.md). + +### __Object Storage__ + +A type of data storage used for handling large amounts of unstructured data managed as objects. + +### __Operation__ + +The asynchronous (often long-running) tasks that operate on Datastores are collectively referred to as "Operations". Examples include Sync, Profile, Hash, and Scan. + +### __Partition Identifier__ + +A Field that can be used by Spark to group the records in a Dataframe into smaller sets that fit within our Spark worker’s memory. The ideal Partition Identifier is an Incremental Identifier of type datetime since that can serve as both but we identify alternatives should that not be available. + +### __Pipeline__ + +A workflow that processes and moves data between systems. + +### __Precision__ + +Your data is the resolution that is expected- How tightly can you define your data? + +### __Profile Operation__ + +An operation that generates metadata describing the characteristics of your actual data values. + +### __Profiling__ + +The process of collecting statistics on the characteristics of a dataset involving examining, analyzing, and reviewing the data. + +### __Proprietary Algorithms__ + +A procedure utilizing a combination of processes, tools, or systems of interrelated connections that are the property of a business or individual in order to solve a problem. + +### __Quality Score__ + +A measure of data quality calculated at the Field, Container, and Datastore level. Quality Scores are recorded as time-series enabling you to track movement over time. You can read more in [Quality Scoring](quality-scores/what-are-quality-scores.md). + +### __Qualytics App__ + +aka "App" this is the user interface for our Product delivered as a web application. + +### __Qualytics Deployment__ + +A single instance of our product (the k8s cluster, postgres database, controlplane/app/compute daemon pods, etc). + +### __Qualytics Compute Daemon__ + +aka "Compute Daemon" this is the layer of our Product that connects to Datastores and directly operates on users’ data. + +### __Qualytics Implementation__ + +A customer’s Deployment plus any associated integrations. + +### __Controlplane__ + +aka "controlplane" this is the layer of our Product that exposes an Application Programming Interface (API). + +### __Qualytics Partition__ + +The smallest grouping of records that can be incrementally processed. For DFS datastores, each file is a Qualytics Partition. For JDBC datastores, partitions are defined by each table’s incremental identifier values. + +### __Record (of a Container)__ + +A distinct set of values for all Fields defined for a Container (e.g. a row of a table). + +### __Schema__ + +The organization of data in a datastore. This could be the columns of a table, the header of a CSV file, the fields in a JSON file, or other structural constraints. + +### __Schema Differences__ + +Differences in the organization of information between two datastores that are supposed to hold the same content. + +### __Source__ + +The origin of data in a pipeline, migration, or other ELT/ETL process. It’s where data gets extracted. + +### __Tag__ + +Users can assign Tags to Datastores, Profiles (Files, Tables, Containers), Checks and Anomalies. Add a Description and Assign a Weight. The weight value directly correlates with the level of importance, where a higher weight indicates higher significance. + +### __Target__ + +The destination of data in a pipeline, migration, or other ELT/ETL process. It’s where data gets loaded. + +### __Third-party data__ + +Data acquired from a source outside of your company which may not be controlled by the same data quality processes. You may not have the same level of confidence in the data and it may not be as trustworthy as internally vetted datasets. + +### __Timeliness__ + +It can be calculated as the time between when information should be available and when it is actually available, focused on if data is available when it’s expected. + +### __Volumetrics__ + +Data has the same size and shape across similar cycles. It includes statistics about the size of a data set including calculations or predictions on the rate of change over time. + +### __AgentQ__ + +The AI assistant built into the Qualytics platform. Powered by the Model Context Protocol (MCP) and your choice of LLM provider, AgentQ turns natural language into action — exploring datastores, building transformations, creating quality checks, investigating anomalies, and more. Learn more in [AgentQ Overview](agentq/overview.md). + +### __Model Context Protocol (MCP)__ + +An [open standard](https://modelcontextprotocol.io/) that enables AI assistants to securely connect to external data sources, tools, and services. MCP defines a common language for how AI models discover and call capabilities exposed by external systems. Qualytics implements an MCP server that exposes its data quality infrastructure as callable tools. Learn more in [MCP](agentq/deep-dive/mcp.md). + +### __MCP Server__ + +An application that exposes a set of tools and resources through the Model Context Protocol. The Qualytics MCP server handles authentication, executes tool logic, and returns structured results to connected AI clients. + +### __MCP Client__ + +An AI assistant or agent (like Claude Desktop, ChatGPT, Cursor, or AgentQ) that connects to one or more MCP servers and can call their tools during a conversation. + +### __MCP Tool__ + +A discrete capability exposed by an MCP server that an AI assistant can call. Each tool has a name, description, input schema, and structured output. Examples include `list_datastores`, `create_quality_check`, and `anomaly_describe`. + +### __Agentic Endpoints__ + +Qualytics API endpoints that use an agent to service the request, bringing conversational AI capabilities directly into custom applications and automation workflows. Because they delegate to an agent, they are non-deterministic. They provide the same capabilities as MCP through standard REST calls. Learn more in [Agentic Endpoints](agentq/deep-dive/agentic.md). + +### __LLM (Large Language Model)__ + +An AI model trained on large amounts of text data that can understand and generate natural language. AgentQ uses your configured LLM provider (e.g., OpenAI, Anthropic, Google Gemini) to interpret requests and decide which tools to call. + +### __Topic Guardrail__ + +A lightweight LLM classifier that runs before AgentQ processes a request. It checks whether the message relates to data quality, governance, databases, anomalies, transformations, or the Qualytics platform, and politely declines off-topic requests. + +### __Dynamic Tool Discovery__ + +A mechanism where AgentQ starts with a small core set of tools and loads additional tools on demand as the conversation progresses, using the `discover_tools` meta-tool. This keeps token usage lean while making all capabilities available. + +### __Context Injection__ + +When AgentQ is opened from a page with relevant data (a datastore, container, field, quality check, or anomaly), the asset's identity is automatically embedded in the conversation context. This allows the user to ask questions without specifying which asset they mean. + +### __Co-Authorship Tracking__ + +All platform changes made through AgentQ are stamped with a co-author record in the audit trail alongside the user's identity. This ensures full traceability of AI-assisted actions. + +### __Guided Workflow__ + +A multi-step tool that executes a structured process for complex tasks. AgentQ includes guided workflows for analyzing trends, investigating anomalies, interpreting quality scores, generating quality checks, and creating computed assets. + +### __Weight (Importance / Severity)__ + +The numeric weight value directly correlates with the level of importance, where a higher weight indicates higher significance. In the UI, this value is surfaced under different labels depending on the entity: + +- **Importance** — on **checks** (cards, rows, totals, sort options, observability, templates, histograms). +- **Severity** — on **anomalies** (cards, rows, highlight panel, detail modal, sort options, flow trigger filters). + +**Field weight**, **tag weight**, and **quality-score dimension weights** (Completeness, Coverage, Conformity, Consistency, Precision, Timeliness, Volumetrics, Accuracy) continue to use the term **Weight** with the existing icon. In the API, the underlying field is `weight` for both checks and anomalies, and `weight_threshold` for the flow trigger anomaly filter. diff --git a/docs/using-the-platform/web-app/app-navigation.md b/docs/using-the-platform/web-app/app-navigation.md index ecb3b2dd83..1f14fd3021 100644 --- a/docs/using-the-platform/web-app/app-navigation.md +++ b/docs/using-the-platform/web-app/app-navigation.md @@ -73,7 +73,7 @@ Qualytics allows users to set up flows, enabling them to create pipelines by cha AgentQ is Qualytics' built-in AI assistant powered by the Model Context Protocol (MCP). It enables users to manage data quality workflows through natural language conversations directly within the platform. AgentQ can explore datastores, validate queries, create computed assets, manage quality checks, and investigate anomalies. It provides real-time visibility into each action performed, making complex data quality tasks faster and easier to execute. -![agent-q](../../assets/web-app/app-navigation/agent-q.png) +![agentq](../../assets/web-app/app-navigation/agentq.png) ## Global Settings diff --git a/mkdocs.yml b/mkdocs.yml index e54bcd4a70..091b7d0244 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -476,29 +476,29 @@ nav: - Filter and Sort: tags/filter-and-sort.md - Delete Tag: tags/delete-tag.md - AgentQ: - - Overview: agent-q/overview.md + - Overview: agentq/overview.md - Deep Dive: - - MCP: agent-q/deep-dive/mcp.md - - AgentQ in Action: agent-q/deep-dive/in-action.md - - Conversations, Responses & Context: agent-q/deep-dive/conversations.md - - Best Practices: agent-q/deep-dive/best-practices.md - - AgentQ Limits: agent-q/deep-dive/limits.md - - Agentic Endpoints: agent-q/deep-dive/agentic.md - - Managing: - - Connecting External AI Clients: agent-q/managing/connecting-external-ai-clients.md - - Add Integration: agent-q/managing/add-integration.md - - Update Integration: agent-q/managing/update-integration.md - - Remove Integration: agent-q/managing/remove-integration.md - - Start a New Conversation: agent-q/managing/start-a-new-conversation.md - - Resume a Conversation: agent-q/managing/resume-a-conversation.md - - Rename a Conversation: agent-q/managing/rename-a-conversation.md - - Archive a Conversation: agent-q/managing/archive-a-conversation.md - - Restore a Conversation: agent-q/managing/restore-a-conversation.md - - Delete a Conversation: agent-q/managing/delete-a-conversation.md - - Search Conversations: agent-q/managing/search-conversations.md - - Chat Interface Tips: agent-q/managing/chat-interface-tips.md - - API: agent-q/api.md - - FAQ: agent-q/faq.md + - MCP: agentq/deep-dive/mcp.md + - AgentQ in Action: agentq/deep-dive/in-action.md + - Conversations, Responses & Context: agentq/deep-dive/conversations.md + - Best Practices: agentq/deep-dive/best-practices.md + - AgentQ Limits: agentq/deep-dive/limits.md + - Agentic Endpoints: agentq/deep-dive/agentic.md + - How-tos: + - Connecting External AI Clients: agentq/how-tos/connecting-external-ai-clients.md + - Add Integration: agentq/how-tos/add-integration.md + - Update Integration: agentq/how-tos/update-integration.md + - Remove Integration: agentq/how-tos/remove-integration.md + - Start a New Conversation: agentq/how-tos/start-a-new-conversation.md + - Resume a Conversation: agentq/how-tos/resume-a-conversation.md + - Rename a Conversation: agentq/how-tos/rename-a-conversation.md + - Archive a Conversation: agentq/how-tos/archive-a-conversation.md + - Restore a Conversation: agentq/how-tos/restore-a-conversation.md + - Delete a Conversation: agentq/how-tos/delete-a-conversation.md + - Search Conversations: agentq/how-tos/search-conversations.md + - Chat Interface Tips: agentq/how-tos/chat-interface-tips.md + - API: agentq/api.md + - FAQ: agentq/faq.md - Settings: - Overview: settings/overview.md - Connections: settings/connections/manage-connections.md @@ -1095,34 +1095,56 @@ plugins: 'container/operations/export-operation.md': 'operations/export-operation/export-operation.md' 'container/operations/materialize-operation.md': 'operations/materialize-operation/materialize-operation.md' # AgentQ redirects (legacy AI integrations + AI & Agents → AgentQ top-level) - 'settings/integrations/ai/mcp.md': 'agent-q/deep-dive/mcp.md' - 'settings/integrations/ai/agentic.md': 'agent-q/deep-dive/agentic.md' - 'settings/integrations/ai/mcp-quickstart.md': 'agent-q/managing/add-integration.md' - 'settings/integrations/ai-and-agents/managing/update-llm-integration.md': 'agent-q/managing/update-integration.md' - 'settings/integrations/ai-and-agents/managing/remove-llm-integration.md': 'agent-q/managing/remove-integration.md' - 'settings/integrations/ai-and-agents/managing/how-to-use-agent-q.md': 'agent-q/overview.md' + 'settings/integrations/ai/mcp.md': 'agentq/deep-dive/mcp.md' + 'settings/integrations/ai/agentic.md': 'agentq/deep-dive/agentic.md' + 'settings/integrations/ai/mcp-quickstart.md': 'agentq/how-tos/add-integration.md' + 'settings/integrations/ai-and-agents/managing/update-llm-integration.md': 'agentq/how-tos/update-integration.md' + 'settings/integrations/ai-and-agents/managing/remove-llm-integration.md': 'agentq/how-tos/remove-integration.md' + 'settings/integrations/ai-and-agents/managing/how-to-use-agent-q.md': 'agentq/overview.md' # AI & Agents → AgentQ (move out of Integrations, drop agent-q- prefix) - 'settings/integrations/ai-and-agents/overview.md': 'agent-q/overview.md' - 'settings/integrations/ai-and-agents/agent-q-api.md': 'agent-q/api.md' - 'settings/integrations/ai-and-agents/agent-q-faq.md': 'agent-q/faq.md' - 'settings/integrations/ai-and-agents/deep-dive/mcp.md': 'agent-q/deep-dive/mcp.md' - 'settings/integrations/ai-and-agents/deep-dive/agent-q-in-action.md': 'agent-q/deep-dive/in-action.md' - 'settings/integrations/ai-and-agents/deep-dive/agent-q-conversations.md': 'agent-q/deep-dive/conversations.md' - 'settings/integrations/ai-and-agents/deep-dive/agent-q-best-practices.md': 'agent-q/deep-dive/best-practices.md' - 'settings/integrations/ai-and-agents/deep-dive/agent-q-limits.md': 'agent-q/deep-dive/limits.md' - 'settings/integrations/ai-and-agents/deep-dive/agentic.md': 'agent-q/deep-dive/agentic.md' - 'settings/integrations/ai-and-agents/managing/connecting-external-ai-clients.md': 'agent-q/managing/connecting-external-ai-clients.md' - 'settings/integrations/ai-and-agents/managing/add-agent-q-integration.md': 'agent-q/managing/add-integration.md' - 'settings/integrations/ai-and-agents/managing/update-agent-q-integration.md': 'agent-q/managing/update-integration.md' - 'settings/integrations/ai-and-agents/managing/remove-agent-q-integration.md': 'agent-q/managing/remove-integration.md' - 'settings/integrations/ai-and-agents/managing/start-a-new-conversation.md': 'agent-q/managing/start-a-new-conversation.md' - 'settings/integrations/ai-and-agents/managing/resume-a-conversation.md': 'agent-q/managing/resume-a-conversation.md' - 'settings/integrations/ai-and-agents/managing/rename-a-conversation.md': 'agent-q/managing/rename-a-conversation.md' - 'settings/integrations/ai-and-agents/managing/archive-a-conversation.md': 'agent-q/managing/archive-a-conversation.md' - 'settings/integrations/ai-and-agents/managing/restore-a-conversation.md': 'agent-q/managing/restore-a-conversation.md' - 'settings/integrations/ai-and-agents/managing/delete-a-conversation.md': 'agent-q/managing/delete-a-conversation.md' - 'settings/integrations/ai-and-agents/managing/search-conversations.md': 'agent-q/managing/search-conversations.md' - 'settings/integrations/ai-and-agents/managing/chat-interface-tips.md': 'agent-q/managing/chat-interface-tips.md' + 'settings/integrations/ai-and-agents/overview.md': 'agentq/overview.md' + 'settings/integrations/ai-and-agents/agent-q-api.md': 'agentq/api.md' + 'settings/integrations/ai-and-agents/agent-q-faq.md': 'agentq/faq.md' + 'settings/integrations/ai-and-agents/deep-dive/mcp.md': 'agentq/deep-dive/mcp.md' + 'settings/integrations/ai-and-agents/deep-dive/agent-q-in-action.md': 'agentq/deep-dive/in-action.md' + 'settings/integrations/ai-and-agents/deep-dive/agent-q-conversations.md': 'agentq/deep-dive/conversations.md' + 'settings/integrations/ai-and-agents/deep-dive/agent-q-best-practices.md': 'agentq/deep-dive/best-practices.md' + 'settings/integrations/ai-and-agents/deep-dive/agent-q-limits.md': 'agentq/deep-dive/limits.md' + 'settings/integrations/ai-and-agents/deep-dive/agentic.md': 'agentq/deep-dive/agentic.md' + 'settings/integrations/ai-and-agents/managing/connecting-external-ai-clients.md': 'agentq/how-tos/connecting-external-ai-clients.md' + 'settings/integrations/ai-and-agents/managing/add-agent-q-integration.md': 'agentq/how-tos/add-integration.md' + 'settings/integrations/ai-and-agents/managing/update-agent-q-integration.md': 'agentq/how-tos/update-integration.md' + 'settings/integrations/ai-and-agents/managing/remove-agent-q-integration.md': 'agentq/how-tos/remove-integration.md' + 'settings/integrations/ai-and-agents/managing/start-a-new-conversation.md': 'agentq/how-tos/start-a-new-conversation.md' + 'settings/integrations/ai-and-agents/managing/resume-a-conversation.md': 'agentq/how-tos/resume-a-conversation.md' + 'settings/integrations/ai-and-agents/managing/rename-a-conversation.md': 'agentq/how-tos/rename-a-conversation.md' + 'settings/integrations/ai-and-agents/managing/archive-a-conversation.md': 'agentq/how-tos/archive-a-conversation.md' + 'settings/integrations/ai-and-agents/managing/restore-a-conversation.md': 'agentq/how-tos/restore-a-conversation.md' + 'settings/integrations/ai-and-agents/managing/delete-a-conversation.md': 'agentq/how-tos/delete-a-conversation.md' + 'settings/integrations/ai-and-agents/managing/search-conversations.md': 'agentq/how-tos/search-conversations.md' + 'settings/integrations/ai-and-agents/managing/chat-interface-tips.md': 'agentq/how-tos/chat-interface-tips.md' + # agent-q/ → agentq/ (folder rename) + managing/ → how-tos/ (subfolder rename) + 'agent-q/overview.md': 'agentq/overview.md' + 'agent-q/api.md': 'agentq/api.md' + 'agent-q/faq.md': 'agentq/faq.md' + 'agent-q/deep-dive/mcp.md': 'agentq/deep-dive/mcp.md' + 'agent-q/deep-dive/in-action.md': 'agentq/deep-dive/in-action.md' + 'agent-q/deep-dive/conversations.md': 'agentq/deep-dive/conversations.md' + 'agent-q/deep-dive/best-practices.md': 'agentq/deep-dive/best-practices.md' + 'agent-q/deep-dive/limits.md': 'agentq/deep-dive/limits.md' + 'agent-q/deep-dive/agentic.md': 'agentq/deep-dive/agentic.md' + 'agent-q/managing/connecting-external-ai-clients.md': 'agentq/how-tos/connecting-external-ai-clients.md' + 'agent-q/managing/add-integration.md': 'agentq/how-tos/add-integration.md' + 'agent-q/managing/update-integration.md': 'agentq/how-tos/update-integration.md' + 'agent-q/managing/remove-integration.md': 'agentq/how-tos/remove-integration.md' + 'agent-q/managing/start-a-new-conversation.md': 'agentq/how-tos/start-a-new-conversation.md' + 'agent-q/managing/resume-a-conversation.md': 'agentq/how-tos/resume-a-conversation.md' + 'agent-q/managing/rename-a-conversation.md': 'agentq/how-tos/rename-a-conversation.md' + 'agent-q/managing/archive-a-conversation.md': 'agentq/how-tos/archive-a-conversation.md' + 'agent-q/managing/restore-a-conversation.md': 'agentq/how-tos/restore-a-conversation.md' + 'agent-q/managing/delete-a-conversation.md': 'agentq/how-tos/delete-a-conversation.md' + 'agent-q/managing/search-conversations.md': 'agentq/how-tos/search-conversations.md' + 'agent-q/managing/chat-interface-tips.md': 'agentq/how-tos/chat-interface-tips.md' # Ticketing integrations: Configure Qualytics renamed to Add Connection 'settings/integrations/ticketing/jira/managing/configure-qualytics.md': 'settings/integrations/ticketing/jira/managing/add-connection.md' 'settings/integrations/ticketing/servicenow/managing/configure-qualytics.md': 'settings/integrations/ticketing/servicenow/managing/add-connection.md'