-
Notifications
You must be signed in to change notification settings - Fork 4
docs: add chat agent and workflow user guides, remove deprecated LLM args #17
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,252 @@ | ||
| # Chat Agent Guide | ||
|
|
||
| ## What is the Chat Agent? | ||
|
|
||
| The Chat Agent is your AI-powered assistant that helps you manage your customer relationships, automate workflows, and access your business data through natural conversation. Simply chat with it like you would with a colleague, and it will understand your requests and take action. | ||
|
|
||
| ## What Can the Chat Agent Do? | ||
|
|
||
| ### 💬 Natural Conversation | ||
|
|
||
| - **Multi-turn conversations**: The agent remembers context from your entire conversation | ||
| - **File attachments**: Upload images, PDFs, documents, and the agent will analyze them | ||
| - **Smart memory**: Automatically summarizes long conversations to maintain context | ||
| - **Real-time responses**: See the agent's thinking process as it works | ||
|
|
||
| ### 📊 Customer & Product Management | ||
|
|
||
| #### Customer Operations | ||
|
|
||
| - Search for customers by email, ID, or any field | ||
| - List all customers with pagination | ||
| - View customer details, status, purchase history | ||
| - Filter customers by status, source, locale, or custom metadata | ||
|
|
||
| #### Product Operations | ||
|
|
||
| - Browse your product catalog | ||
| - Search products by ID, name, category | ||
| - View product details, pricing, stock levels | ||
| - Filter products by status, category, tags | ||
|
|
||
| **Examples:** | ||
|
|
||
| - "Show me all customers with status 'churned'" | ||
| - "Find the customer with email `john@example.com`" | ||
| - "List all active products in the 'electronics' category" | ||
| - "How many customers do I have?" | ||
|
|
||
| ### 🔍 Knowledge Base & Search | ||
|
|
||
| #### RAG Search (Semantic Search) | ||
|
|
||
| - Search your knowledge base using natural language | ||
| - Find relevant information from uploaded documents | ||
| - Get answers from your business policies, procedures, documentation | ||
| - Semantic understanding - finds meaning, not just keywords | ||
|
|
||
| #### RAG Write (Knowledge Management) | ||
|
|
||
| - Save new information to your knowledge base | ||
| - Update outdated information | ||
| - Correct mistakes in the knowledge base | ||
| - Store business policies, procedures, FAQs | ||
|
|
||
| **Examples:** | ||
|
|
||
| - "What is our return policy?" | ||
| - "Remember: Our store hours are 9am-5pm on weekdays" | ||
| - "That's wrong. The correct shipping policy is free shipping over $50" | ||
| - "Find information about sustainability in our products" | ||
|
|
||
| ### 🌐 Web & Research | ||
|
|
||
| #### Web Search | ||
|
|
||
| - Search the internet for current information | ||
| - Filter by time range (day, week, month, year) | ||
| - Search specific sites or categories | ||
| - Get news, research, technical information | ||
|
|
||
| #### Web Scraping | ||
|
|
||
| - Extract content from any webpage | ||
| - Read articles, documentation, blog posts | ||
| - Get structured data from websites | ||
|
|
||
| **Examples:** | ||
|
|
||
| - "Search for recent news about AI in customer service" | ||
| - "What's on the homepage of example.com?" | ||
| - "Find research papers about customer churn prediction" | ||
|
|
||
| ### 📄 File Operations | ||
|
|
||
| #### PDF Operations | ||
|
|
||
| - **Generate PDFs**: Create PDFs from Markdown, HTML, or web pages | ||
| - **Parse PDFs**: Extract text from uploaded PDF files | ||
| - Custom formatting, margins, page sizes | ||
|
|
||
| #### Image Generation | ||
|
|
||
| - Create screenshots from Markdown, HTML, or URLs | ||
| - Generate images from content | ||
| - Custom dimensions and styling | ||
|
|
||
| #### Excel Generation | ||
|
|
||
| - Export data to Excel spreadsheets | ||
| - Multiple sheets, custom headers | ||
| - Perfect for customer lists, product catalogs, reports | ||
|
|
||
| #### PowerPoint & Word | ||
|
|
||
| - Generate PowerPoint presentations | ||
| - Create Word documents | ||
| - Professional formatting | ||
|
|
||
| **Examples:** | ||
|
|
||
| - "Generate a PDF report of all churned customers" | ||
| - "Create an Excel file with all active products" | ||
| - "Take a screenshot of example.com" | ||
| - "Extract text from this PDF" (with file upload) | ||
|
|
||
| ### 🤖 Workflow Automation | ||
|
|
||
| #### Workflow Management | ||
|
|
||
| - Create automated workflows from natural language descriptions | ||
| - View and edit existing workflows | ||
| - Search for workflow examples | ||
| - List all available automation actions | ||
| - Test and activate workflows | ||
|
|
||
| #### Available Workflow Actions | ||
|
|
||
| The agent can create workflows using these operations: | ||
|
|
||
| - Customer operations (create, update, query, filter) | ||
| - Product operations (create, update, query, filter) | ||
| - Email operations (send, fetch, reply) | ||
| - Conversation management | ||
| - Document operations | ||
| - RAG operations (upload, sync knowledge) | ||
| - Integration with external systems (Shopify, OneDrive, etc.) | ||
| - Web scraping and crawling | ||
| - Approval workflows | ||
| - And many more... | ||
|
|
||
| **Examples:** | ||
|
|
||
| - "Create a workflow that sends welcome emails to new customers" | ||
| - "Show me all my active workflows" | ||
| - "Build an automation that identifies at-risk customers and sends them offers" | ||
| - "What workflow actions are available for products?" | ||
|
|
||
| ### 🎨 Advanced Features | ||
|
|
||
| #### Context Search | ||
|
|
||
| - Search through your conversation history | ||
| - Find relevant past discussions | ||
| - Semantic search across all your chats | ||
|
|
||
| #### Resource Checking | ||
|
|
||
| - Verify file existence and accessibility | ||
| - Check resource availability before operations | ||
|
|
||
| #### Tone of Voice | ||
|
|
||
| - Maintain consistent brand voice in communications | ||
| - Apply custom tone settings to generated content | ||
|
|
||
| ## How to Use the Chat Agent | ||
|
|
||
| ### Starting a Conversation | ||
|
|
||
| Simply type your message in the chat interface. The agent will: | ||
| 1. Understand your request | ||
| 2. Use the appropriate tools to gather information | ||
| 3. Provide a clear, well-formatted response | ||
|
|
||
| ### Uploading Files | ||
|
|
||
| You can attach files to your messages: | ||
| - **Images**: The agent will analyze and describe them | ||
| - **PDFs**: The agent will extract and read the text | ||
| - **Documents**: The agent will process and understand the content | ||
|
|
||
| ### Getting Better Results | ||
|
|
||
| #### Be specific about what you need | ||
|
|
||
| - ❌ "Show me customers" | ||
| - ✅ "Show me the 10 most recent customers with status 'active'" | ||
|
|
||
| #### Ask follow-up questions | ||
|
|
||
| - The agent remembers your conversation context | ||
| - Build on previous responses | ||
| - Refine your requests | ||
|
|
||
| #### Use natural language | ||
|
|
||
| - You don't need to use technical terms | ||
| - Describe what you want in plain English | ||
| - The agent will figure out the details | ||
|
|
||
| ## Tips & Best Practices | ||
|
|
||
| ### For Data Queries | ||
|
|
||
| - **Use database tools** for counting, listing, filtering by specific fields | ||
| - **Use RAG search** for semantic/meaning-based searches | ||
| - **Be specific** about which fields you need to reduce response time | ||
|
|
||
| ### For Workflows | ||
|
|
||
| - **Describe the goal**, not the implementation | ||
| - **Provide examples** of what should trigger the workflow | ||
| - **Test workflows** before activating them | ||
|
|
||
| ### For File Generation | ||
|
|
||
| - **Specify the format** you want (PDF, Excel, Image, etc.) | ||
| - **Provide clear content** or data to include | ||
| - **Download files immediately** - URLs may expire | ||
|
|
||
| ### For Knowledge Base | ||
|
|
||
| - **Save important information** as you learn it | ||
| - **Correct mistakes** when you find them | ||
| - **Use clear topics** when saving information | ||
|
|
||
| ## Common Use Cases | ||
|
|
||
| 1. **Customer Analysis**: "Show me all customers who haven't purchased in 90 days" | ||
| 2. **Product Reports**: "Generate an Excel file of all products with low stock" | ||
| 3. **Workflow Creation**: "Create an automation that sends product recommendations to active customers" | ||
| 4. **Research**: "Search for best practices in customer retention" | ||
| 5. **Document Generation**: "Create a PDF report of this month's customer activity" | ||
| 6. **Knowledge Management**: "What's our refund policy?" or "Remember: We offer 30-day returns" | ||
|
|
||
| ## Technical Details | ||
|
|
||
| - **Model**: Configurable AI model (default: GPT-4 or similar) | ||
| - **Max Steps**: Up to 20 tool calls per response (configurable) | ||
| - **Context**: Maintains full conversation history with automatic summarization | ||
| - **File Support**: Images, PDFs, Word, Excel, PowerPoint, and more | ||
| - **Real-time**: Responses stream as they're generated | ||
|
|
||
| ## Need Help? | ||
|
|
||
| The Chat Agent is designed to be intuitive and helpful. If you're unsure about something: | ||
| - Just ask! "What can you help me with?" | ||
| - Request examples: "Show me an example of creating a workflow" | ||
| - Ask for clarification: "What information do you need from me?" | ||
|
|
||
| The agent will guide you through any task and explain what it's doing along the way. | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.