From ae61f7890da9074cfb456a34b78f271e36e4dbe7 Mon Sep 17 00:00:00 2001 From: daniel Date: Sat, 10 Jan 2026 03:27:08 +0000 Subject: [PATCH] Add Tenant App Guide --- Tenant-App-Guide.md | 494 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 494 insertions(+) create mode 100644 Tenant-App-Guide.md diff --git a/Tenant-App-Guide.md b/Tenant-App-Guide.md new file mode 100644 index 0000000..b9c86e6 --- /dev/null +++ b/Tenant-App-Guide.md @@ -0,0 +1,494 @@ +# Tenant App Guide + +This guide shows you how to use the GT AI OS Tenant App for daily operations: creating AI agents, chatting, managing datasets, and more. + +**Prerequisites:** Complete the [Control Panel Guide](Control-Panel-Guide) first to set up your account and API keys. + +## Table of Contents + +- [Quick Reference](#quick-reference) +- [Logging In](#logging-in) +- [Understanding the Interface](#understanding-the-interface) +- [Creating Your First Agent](#creating-your-first-agent) + - [Step 1: Go to the Agents Page](#step-1-go-to-the-agents-page) + - [Step 2: Create a New Agent](#step-2-create-a-new-agent) + - [Step 3: Fill in Required Fields](#step-3-fill-in-required-fields) + - [Step 4: Configure Optional Settings](#step-4-configure-optional-settings) + - [Step 5: Save the Agent](#step-5-save-the-agent) +- [Chatting with an Agent](#chatting-with-an-agent) + - [Starting a New Conversation](#starting-a-new-conversation) + - [Sending Messages](#sending-messages) + - [Understanding Responses](#understanding-responses) + - [Message Actions](#message-actions) +- [Resuming Chat History](#resuming-chat-history) + - [Finding Past Conversations](#finding-past-conversations) + - [Opening a Conversation](#opening-a-conversation) + - [Searching Conversations](#searching-conversations) +- [Favoriting Agents](#favoriting-agents) + - [Adding Agents to Favorites](#adding-agents-to-favorites) + - [Accessing Favorite Agents](#accessing-favorite-agents) + - [Removing from Favorites](#removing-from-favorites) +- [Creating a Dataset](#creating-a-dataset) + - [Step 1: Go to Datasets Page](#step-1-go-to-datasets-page) + - [Step 2: Create New Dataset](#step-2-create-new-dataset) +- [Uploading Documents to a Dataset](#uploading-documents-to-a-dataset) + - [Supported File Types](#supported-file-types) + - [Uploading Files](#uploading-files) + - [Understanding Processing Status](#understanding-processing-status) +- [Connecting a Dataset to an Agent](#connecting-a-dataset-to-an-agent) + - [Step 1: Edit the Agent](#step-1-edit-the-agent) + - [Step 2: Add Dataset](#step-2-add-dataset) + - [How It Works](#how-it-works) +- [Exporting Agent Configuration](#exporting-agent-configuration) +- [Importing Agent Configuration](#importing-agent-configuration) +- [Managing Teams](#managing-teams) + - [Creating a Team](#creating-a-team) + - [Adding Team Members](#adding-team-members) + - [Sharing with Teams](#sharing-with-teams) +- [Tips for Better Results](#tips-for-better-results) + - [Writing Good System Prompts](#writing-good-system-prompts) + - [Organizing with Tags](#organizing-with-tags) +- [Common Issues](#common-issues) +- [What's Next?](#whats-next) + +--- + +## Quick Reference + +| Page | What You Can Do | +|------|-----------------| +| **Agents** | Create, edit, favorite, and manage AI agents | +| **Datasets** | Upload documents for AI to reference | +| **Teams** | Share agents and datasets with teammates | +| **Observability** | View conversation history, token usage, and model details | + +--- + +## Logging In + +1. Open your web browser +2. Go to http://localhost:3002 +3. Enter your credentials: + - **Email:** Your email address (created in Control Panel) + - **Password:** Your password +4. Click **Sign In** +5. If two-factor authentication is enabled, enter the 6-digit code from your authenticator app + +**First login?** If you're using the default credentials (`gtadmin@test.com` / `Test@123`), go to [Control Panel Guide](Control-Panel-Guide) first to set up properly. + +--- + +## Understanding the Interface + +After logging in, you'll see: + +- **Left Sidebar:** Navigation tabs (Agents, Datasets, Teams, Observability) +- **Conversations List:** Below the navigation tabs, shows your past conversations for quick access +- **User Profile:** At the bottom of the sidebar, click your name to log out +- **Main Area:** The content for the current page + +## Creating Your First Agent + +An agent is an AI assistant configured with specific instructions, model, and optional knowledge (datasets). + +### Step 1: Go to the Agents Page + +1. Click **Agents** in the left sidebar +2. You'll see two tabs: + - **Favorite Agents:** Shows your favorited agents for quick access + - **Agent Configuration:** Full list with all management options +3. Click **Agent Configuration** tab + +### Step 2: Create a New Agent + +1. Click the **Create Agent** button (top right) +2. A form will appear with several fields + +### Step 3: Fill in Required Fields + +| Field | What to Enter | Example | +|-------|---------------|---------| +| **Name** | A descriptive name | "Customer Support Bot" | +| **Model** | Select from dropdown | "NVIDIA Llama 3.3 Nemotron Super 49B" (Requires NVIDIA NIM External AI Inference API Key | +| **Category** | Select existing or create new | "Support" or "Research" | + +### Step 4: Configure Optional Settings + +| Field | What It Does | Recommended | +|-------|--------------|-------------| +| **Description** | Explains what the agent does | Add a brief description | +| **System Prompt** | Instructions the AI follows | "You are a helpful customer support agent..." | +| **Temperature** | Creativity level (0-2) | 0.7 for balanced responses | +| **Visibility** | Who can see this agent | Set based on your needs | +| **Disclaimer** | Warning text shown before chat | Optional legal/usage notice | +| **Easy Buttons** | Quick-action buttons for users | Pre-defined prompts users can click | +| **Tags** | Labels for organization | "support", "internal" | +| **Datasets** | Knowledge bases to reference | Select if you've created any | + +### Step 5: Save the Agent + +1. Review your settings +2. Click **Save** or **Create** +3. Your agent appears in the list + +**Verification:** You should see your new agent in the Agent Configuration list with the correct name and model. + +--- + +## Chatting with an Agent + +### Starting a New Conversation + +1. Click on an agent card from the **Favorite Agents** tab, or +2. Go to **Agent Configuration** tab and click on an agent to start chatting +3. The chat interface opens with an empty message area +4. Type your message in the text box at the bottom +5. Press **Enter** or click the **Send** button + +### Sending Messages + +- **Type your message:** Click in the input box and type +- **Send:** Press Enter or click the Send button +- **New line:** Press Shift+Enter to add a new line without sending +- **Wait:** The agent's response will appear after a moment + +### Understanding Responses + +The chat interface shows: +- **Response time:** How long the AI took to respond (e.g., "1.2s") + +> **Tip:** To see detailed information like tokens used and model name, go to **Observability** in the sidebar and view the conversation details. + +### Message Actions + +Hover over any message to see action buttons: + +- **Copy:** Copy the message text to clipboard +- **Download:** Save the response as a file + +--- + +## Resuming Chat History + +Your conversations are automatically saved. To continue a previous conversation: + +### Finding Past Conversations + +1. Look at the **Conversations List** in the left sidebar (below the navigation tabs) +2. You'll see a list of your previous conversations +3. Conversations are sorted by most recent first + +### Opening a Conversation + +1. Click on any conversation in the list +2. The conversation loads in the main chat area +3. You can see all previous messages +4. Type a new message to continue the conversation + +### Searching Conversations + +If you have many conversations: + +1. Use the search box in the conversations list area +2. Type keywords from the conversation +3. Matching conversations will be filtered + +--- + +## Favoriting Agents + +Favorite agents appear in the Favorite Agents tab for quick access. + +### Adding Agents to Favorites + +1. Go to **Agents** in the sidebar +2. Click the **Favorite Agents** tab +3. Click the **Add Favorites** button +4. A selection modal appears showing all available agents +5. Check the agents you want to add to favorites +6. Click **Save** or **Done** + +### Accessing Favorite Agents + +1. Go to **Agents** in the sidebar +2. The **Favorite Agents** tab shows your favorited agents +3. Click any agent card to start chatting immediately + +### Removing from Favorites + +1. Go to **Agents** → **Favorite Agents** tab +2. Click **Add Favorites** button +3. Uncheck the agents you want to remove +4. Click **Save** or **Done** + +--- + +## Creating a Dataset + +Datasets are collections of documents that agents can reference when answering questions (called RAG - Retrieval Augmented Generation). + +### Step 1: Go to Datasets Page + +1. Click **Datasets** in the left sidebar +2. You'll see any existing datasets and storage stats + +### Step 2: Create New Dataset + +1. Click the **New Dataset** button +2. Fill in the form: + - **Name:** A descriptive name (e.g., "Product Documentation") + - **Description:** What this dataset contains (optional) + - **Access Control:** + - **Individual:** Only you can use it + - **Team:** Share with specific team members + - **Organization:** Everyone in your organization can use it +3. Click **Create** + +**Verification:** Your new dataset appears in the list with 0 documents. + +--- + +## Uploading Documents to a Dataset + +### Supported File Types + +GT AI OS can process these file types: + +| Type | Extensions | +|------|------------| +| **Documents** | PDF, DOCX, DOC | +| **Text** | TXT, MD (Markdown) | +| **Data** | JSON, CSV, XML | +| **Web** | HTML | +| **Rich Text** | RTF | + +### Uploading Files + +1. Go to **Datasets** in the sidebar +2. Find your dataset in the list and open it +3. Click **Upload Documents** button +4. Click **Select Files** button +5. Select one or more files from your computer +6. Click **Upload** + +### Understanding Processing Status + +After upload, each document goes through processing: + +| Status | What It Means | +|--------|---------------| +| **Pending** | Waiting to be processed | +| **Processing** | Currently being analyzed and chunked | +| **Completed** | Ready for AI to use | +| **Failed** | Something went wrong (check file format) | + +Processing typically takes a few seconds to a few minutes depending on file size. + +### Verification + +After processing completes: +- Document count increases +- Chunk count shows how many pieces the document was split into +- Storage size updates + +--- + +## Connecting a Dataset to an Agent + +For an agent to use your dataset, you need to connect them: + +### Step 1: Edit the Agent + +1. Go to **Agents** → **Agent Configuration** tab +2. Find the agent you want to update +3. Click the **Edit** button (pencil icon) + +### Step 2: Add Dataset + +1. In the edit form, find the **Dataset Selection** section +2. Click to open the selection modal +3. Search or browse for your dataset(s) +4. Click on each dataset you want to connect +5. Click **Save** + +### How It Works + +When you chat with this agent: +1. Your message is compared against the dataset +2. Relevant chunks are found +3. Those chunks are included with your message to the AI +4. The AI uses that context to give informed answers + +**Tip:** Try asking the agent questions about the documents you uploaded to see RAG in action. + +--- + +## Exporting Agent Configuration + +Export your agent settings to backup or share with others. + +### Step 1: Find the Agent + +1. Go to **Agents** → **Agent Configuration** tab +2. Find the agent you want to export + +### Step 2: Export + +1. Click the **three-dot menu** (⋮) on the agent row +2. Click **Export** +3. A JSON file will download to your computer +4. The file contains all agent settings: + - Name, description + - Model configuration + - System prompt + - Temperature, max tokens + - Tags + - Dataset connections + +### What's in the Export File + +```json +{ + "name": "Customer Support Bot", + "model_id": "nvidia/llama-3.3-nemotron-super-49b-v1", + "system_prompt": "You are a helpful...", + "temperature": 0.7, + "max_tokens": 4096, + "tags": ["support", "internal"], + ... +} +``` + +--- + +## Importing Agent Configuration + +Import a previously exported agent, one shared by a colleague, or a pre-built demo agent. + +### Step 1: Get the Import File + +- Use a JSON file exported from GT AI OS +- Download a pre-built agent from [Demo Agents](Demo-Agents) +- Or receive one from a colleague + +### Step 2: Import the Agent + +1. Go to **Agents** → **Agent Configuration** tab +2. Click **Import** button (usually near Create Agent) +3. Click **Browse** or drag the JSON file +4. Review the agent settings that will be imported +5. Click **Confirm** or **Import** + +### After Import + +- The agent appears in your list +- You may need to: + - Select a model (if the original model isn't available) + - Connect datasets (imported agents don't automatically connect to your datasets) + +--- + +## Managing Teams + +Teams let you share agents and datasets with colleagues. + +### Creating a Team + +1. Click **Teams** in the left sidebar +2. Click **Create Team** +3. Fill in: + - **Name:** Team name (e.g., "Engineering") + - **Description:** What the team is for +4. Click **Create** + +### Adding Team Members + +1. Open your team (click on it) +2. Click **Add Members** or **Manage** +3. Enter email addresses of people to add +4. Click **Add** or **Save** + +> **Note:** Team members must already have accounts in GT AI OS. + +### Sharing with Teams + +When creating or editing agents/datasets: +- Set **Access Control** to **Team** +- Select which team(s) can access it + +--- + +## Tips for Better Results + +### Writing Good System Prompts + +A system prompt tells the AI how to behave. Good system prompts: + +``` +You are a helpful technical support agent for [Company]. +Your role is to: +- Answer questions about our products +- Help troubleshoot common issues +- Be polite and professional + +Always: +- Admit when you don't know something +- Suggest contacting human support for complex issues +- Use clear, simple language +``` + +### Organizing with Tags + +Use tags to categorize agents: +- By department: "engineering", "marketing", "hr" +- By purpose: "support", "research", "creative" +- By status: "production", "testing", "deprecated" + +--- + +## Common Issues + +### "No models available in dropdown" + +- Go to [Control Panel](http://localhost:3001) → API Keys +- Verify you have at least one API key configured: + - NVIDIA API key for NVIDIA NIM models + - Groq API key for Groq models +- Test each API key to ensure it's valid + +### "Agent doesn't seem to know about my documents" + +- Verify the dataset is connected to the agent (edit agent → check Datasets field) +- Check document processing status is "Completed" +- Try asking more specific questions about the document content + +### "Document stuck in 'Processing'" + +- Wait a few more minutes (large documents take longer) +- If stuck for more than 10 minutes, try re-uploading +- Check the file isn't corrupted or password-protected + +### "Chat input is disabled" + +This can happen if: +- No agent is selected (select an agent first) +- Session expired (refresh the page and log in again) + +### "Conversation history is empty" + +- Conversations are stored per user account +- If you logged in with different credentials, you won't see previous conversations +- Check you're logged in with the correct account + +--- + +## What's Next? + +Now that you know how to use the Tenant App: + +1. **Try the demo agents:** Import pre-built agents from [Demo Agents](Demo-Agents) to get started quickly +2. **Create specialized agents:** Build agents for different use cases +3. **Upload knowledge bases:** Add your company documents to datasets +4. **Share with your team:** Use Teams to collaborate + +Need help? Check the [Troubleshooting](Troubleshooting) guide.