+
+
+## Obtain API key and Project ID
+
+Generate API keys via the developer configs in your project. Copy the Project ID from the same page.
+
+ 
+
+
+## API Endpoint
+
+```
+POST 
+
+
+---
+
+## How You Can Contribute
+
+
+- **Tackle Open Issues**
+ Browse our [GitHub Issues](https://github.com/rowboatlabs/rowboat/issues) for tags like `good first issue`, `help wanted`, or `bug` to find a spot that fits your skillset.
+
+- **Join the Community**
+ Our [Discord](https://discord.gg/PCkH9TWC) is the go-to hub for brainstorming, feedback, and finding contributors for bigger efforts.
+
+- **Propose Something New**
+ Have a new tool integration idea or found a bug? Open an issue and letβs discuss it!
+
+
+---
+
+## Contribution Workflow & Best Practices
+
+Whether it's your first contribution or your fiftieth, here's what a great contribution looks like:
+
+| Step / Tip | Description |
+|-------------------------------|-----------------------------------------------------------------------------------------------|
+| **1. Fork the Repository** | Create a personal copy of [rowboatlabs/rowboat](https://github.com/rowboatlabs/rowboat) to start contributing. |
+| **2. Create a New Branch** | Use a descriptive name like `fix-tool-crash` or `feature-new-mcp`. Avoid committing to `main`. |
+| **3. Make Your Changes** | Focus your PR on a single issue or feature to keep things clean and reviewable. |
+| **4. Write Tests if Needed** | If you change logic, add relevant tests so your contribution is future-proof. |
+| **5. Run Tests & Lint Locally**| Make sure your branch passes all tests and code quality checks before pushing. |
+| **6. Document or Demo It** | Add helpful context: screenshots, example scripts, or a short video/gif to demonstrate your changes. |
+| **7. Submit a Pull Request** | Open a PR with a clear description of your changes and any context reviewers should know. |
+| **8. Collaborate on Feedback** | Our maintainers may leave comments β itβs all part of the process. Letβs improve it together. |
+| **9. Donβt Be Shy to Follow Up** | Feel free to ping the PR/issue if you're waiting on feedback. We appreciate polite nudges. |
+| **10. Celebrate the Merge!** | You just made Rowboat better. Thanks for contributing π |
+
+
+
+
+## What is RowBoat?
+**RowBoat is a state-of-art platform to build multi-agent AI systems in a visual interface, with the help of a copilot.**
+
+RowBoat enables you to build, manage and deploy user-facing assistants. An assistant is made up of multiple agents, each having access to a set of tools and working together to interact with the user as a single assistant. You can connect any MCP tools to the agents.
+
+For example, you can build a *credit card assistant*, where each agent handles a workflow such as *outstanding payments*, *balance inquiries* and *transaction disputes*. You can equip agents with tools to carry out tasks such as *fetching payment options*, *checking outstanding balance* and *updating user information*. The assistant would help your end-users their credit card-related needs without having to talk to a human agent on your end.
+
+---
+
+## How RowBoat works
+
+### RowBoat Studio
+RowBoat Studio lets you create AI agents in minutes, using a visual interface and plain language.
+There are key components that you will work with:
+- Agents
+- Playground
+- Copilot
+
+
++ +2. Once in Studio, create a new blank project or use one of the example templates: + +
+ +3. Use the copilot to help you build agents: + +
+ +4. Ensure that the correct agent is set as the "start agent": + +
+ +5. Test out a chat in the playground to verify the agents' behavior: + +
+ +### Testing the Chat API + +You can use the API directly at [http://localhost:3000/api/v1/](http://localhost:3000/api/v1/) +- Project ID is available in the URL of the project page +- API Key can be generated from the project config page at `/projects/
+ +Prerequisite: + +1. **Open Source Users:** Complete the [open-source installation steps](/oss_installation/) to set up RowBoat Studio. +2. **Hosted App Users:** Sign in to [https://app.rowboatlabs.com/](https://app.rowboatlabs.com/) \ No newline at end of file diff --git a/apps/docs/docs/testing.mdx b/apps/docs/docs/testing.mdx new file mode 100644 index 000000000..3ad7f843e --- /dev/null +++ b/apps/docs/docs/testing.mdx @@ -0,0 +1,132 @@ +# Testing Your Setup + +## Testing Studio + +1. Once you are set up, you should be able to login to the Studio via Auth0's login options (Gmail, Github etc.). +- For the open source installation, the URL for Studio is [http://localhost:3000](http://localhost:3000) +- To use our hosted app, the URL for Studio is [https://app.rowboatlabs.com](https://app.rowboatlabs.com/) +
+ +2. Once in Studio, create a new blank project or browse through one of the example projects: + +
+ +3. Use the copilot to help you build agents: + +
+ +4. Ensure that the correct agent is set as the "start agent": + +
+ +5. Test out a chat in the playground to verify the agents' behavior: + +
+ +### Testing the Chat API + +- For the open source installation, the `
β’ Typically serve as the start agent (Hub Agent)| +| **Task Agents** (`internal`) | Specialized agents that perform specific tasks without direct user interaction. | β’ Focused on specific functions
β’ Return results to parent agents| +| **Pipeline Agents** (`pipeline`) | Sequential workflow execution agents that process data in a chain. | β’ Execute in sequence within a pipeline
β’ Cannot transfer to other agents directly| + + +--- + +## Agent Configuration + +Agents are configured through two main tabs in the Rowboat Studio interface: + +### **Instructions Tab** + + +#### Description +A clear description of the agent's role and responsibilities + +#### Instructions +Instructions are the backbone of the agent's behavior. Use the Copilot's structured format for consistency: + +**Recommended Structure:** +``` +## π§βπΌ Role: +[Clear description of the agent's role] + +## βοΈ Steps to Follow: +1. [Step 1] +2. [Step 2] +3. [Step 3] + +## π― Scope: +β In Scope: +- [What the agent should handle] + +β Out of Scope: +- [What the agent should NOT handle] + +## π Guidelines: +βοΈ Dos: +- [Positive behaviors] + +π« Don'ts: +- [Negative behaviors] +``` + +#### Examples +These help agents behave correctly in specific situations. Each example can include: +- A sample user message +- The expected agent response +- Any tool calls (if applicable) + +### **Configurations Tab** + +#### Name +Name of the agent + + +#### Behaviour +- **Agent Type**: Choose from `conversation`, `internal`, or `pipeline` +- **Model**: Select the LLM model (GPT-4o, GPT-4o-mini, google/gemini-2.5-flash, etc.) + +#### RAG +- **Add Source**: Connect data sources to enable RAG capabilities for the agent + +--- + +## Creating Your Initial Set of Agents + +Let Copilot bootstrap your agent graph. + +### Instruct Copilot + +Start by telling Copilot what your assistant is meant to do β it'll generate an initial set of agents with best-practice instructions, role definitions, and connected agents. + + +
+
+
+### Inspect the Output
+
+After applying the suggested agents, take a close look at each one's:
+- **Instructions**: Define how the agent behaves
+- **Examples**: Guide agent responses and tool use
+
+
+ 
+
+
+---
+
+## Updating Agent Behavior
+
+There are three ways to update an agent:
+
+### 1. With Copilot
+
+Copilot understands the current chat context and can help rewrite or improve an agent's behavior based on how it performed.
+
+
+ 
+
+
+
+
+### 2. Manual Edits
+
+You can always manually edit the agent's instructions.
+
+
+ 
+
+
+---
+
+
diff --git a/apps/docs/docs/using-rowboat/conversations.mdx b/apps/docs/docs/using-rowboat/conversations.mdx
new file mode 100644
index 000000000..c755f47d2
--- /dev/null
+++ b/apps/docs/docs/using-rowboat/conversations.mdx
@@ -0,0 +1,52 @@
+---
+title: "Conversations"
+description: "View and manage all conversations with your Rowboat agents"
+icon: "list-check"
+---
+
+## Overview
+
+The Conversations page in Rowboat shows you all the interactions between users and your agents. Here you can monitor conversations, view detailed message exchanges, and understand how your agents are performing.
+
+
+ 
+
+
+## What You'll See
+
+The Conversations page displays a list of all conversations organized by time:
+
+- **Today**: Recent conversations from today
+- **This week**: Conversations from the current week
+- **This month**: Conversations from the current month
+- **Older**: Conversations from previous months
+
+Each conversation shows:
+- **Conversation ID**: Unique identifier for the conversation
+- **Created time**: When the conversation started
+- **Reason**: What triggered the conversation (chat or job)
+
+## Viewing Conversation Details
+Click on any conversation to see the detailed view with all the message exchanges:
+
+
+ 
+
+
+**Conversation Metadata**: Shows the Conversation ID, creation time, and last update time.
+
+**Workflow**: Shows the workflow JSON
+
+**Turns**: Each conversation is made up of turns, where:
+- **Turn #1, #2, etc.**: Numbered sequence of interactions
+- **Reason badge**: Shows why each turn happened (chat, API, job, etc.)
+- **Timestamp**: When each turn occurred
+- **Input messages**: What was sent to your agents
+- **Output messages**: What your agents responded with
+
+### Turn Details
+
+Each turn displays:
+- **Input**: The messages sent to your agents (user messages, system messages)
+- **Output**: The responses from your agents
+- **Error information**: Any issues that occurred during processing
diff --git a/apps/docs/docs/using-rowboat/customise/custom-llms.mdx b/apps/docs/docs/using-rowboat/customise/custom-llms.mdx
new file mode 100644
index 000000000..dc87dc2f2
--- /dev/null
+++ b/apps/docs/docs/using-rowboat/customise/custom-llms.mdx
@@ -0,0 +1,53 @@
+---
+title: "Custom LLMs"
+description: "How to use and configure custom LLMs in Rowboat."
+
+---
+
+gpt-4.1 as the default model for agents and copilot. You can override these:
+
+ ```bash
+ export PROVIDER_DEFAULT_MODEL=claude-3-7-sonnet-latest
+ export PROVIDER_COPILOT_MODEL=gpt-4o
+ ```
+
+ **Notes:**
+ - Copilot is optimized for gpt-4o/gpt-4.1. We strongly recommend using these models for best results.
+ - You can use different models for the copilot and each agent, but all must be from the same provider (e.g., LiteLLM).
+ - Rowboat is provider-agnostic β any backend implementing the OpenAI messages format should work.
+ - OpenAI-specific tools (like web_search) will not function with non-OpenAI providers. Remove such tools to avoid errors.
+ 
+
+
+## What You'll See
+
+The Jobs page displays a list of all job runs from your triggers, including:
+
+- **External trigger executions** from webhook events
+- **One-time trigger runs** from scheduled jobs
+- **Recurring trigger executions** from cron-based schedules
+
+Each job run displays the following key information:
+- **Job ID**: Unique identifier for the job run
+- **Status**: Indicates if the job succeeded, failed, or is in progress
+- **Reason**: The trigger or cause for the job (e.g., external trigger, scheduled, cron)
+- **Created Time**: When the job was executed
+
+## Viewing Job Details
+
+### Expand a Job Run
+
+Click on any job run to expand it and see detailed information about what happened during execution:
+
+
+ 
+
+
+**Basic job details**: Job ID, Status, creation time, Updated time, Conversation ID and Turn ID. By clicking on the Conversation ID, you can view more in-depth details about the run.
+
+**Job Reason**: Why the job triggered - either external trigger, scheduled, or cron.
+
+**Job Input**: The input data sent to your assistant.
+
+**Job Output**: The final output produced by your agents.
\ No newline at end of file
diff --git a/apps/docs/docs/using-rowboat/rag.mdx b/apps/docs/docs/using-rowboat/rag.mdx
new file mode 100644
index 000000000..772d034d5
--- /dev/null
+++ b/apps/docs/docs/using-rowboat/rag.mdx
@@ -0,0 +1,68 @@
+---
+title: "RAG (Data)"
+description: "How to use our inbuilt RAG"
+icon: "database"
+---
+
+# Using RAG in Rowboat
+
+Rowboat provides multiple ways to enhance your agents' context with Retrieval-Augmented Generation (RAG). This guide will help you set up and use each RAG feature.
+
+
+
+
+
+## RAG Features
+
+### 1. Text RAG
+
+Process and reason over text content directly
+
+
+### 2. File Uploads
+
+- Upload PDF files directly from your device
+- **Open Source Version**: Files are stored locally on your machine
+- **Managed Version**: Files are stored in cloud S3 storage
+- Files are parsed using OpenAI by default
+
+Each agent handles a specific part of the conversation and performs tasks using tools and instructions. | β’ Define behavior in plain language
β’ Connect agents into a graph
β’ Attach tools and RAG sources | +| **Playground** | Interactive testbed for conversations.
Lets you simulate end-user chats with your assistant and inspect agent behavior in real time. | β’ Real-time feedback and debugging
β’ See tool calls and agent handoffs
β’ Test individual agents or the whole system | +| **Copilot** | Your AI assistant for building assistants.
Copilot creates and updates agents, tools, and instructions based on your plain-English prompts. | β’ Understands full system context
β’ Improves agents based on playground chat
β’ Builds workflows intelligently and fast | + +> **Agents are the heart of every assistant.** Learn more about how they work in the Agents page. + +
+
+
+## Tool Types
+
+| Tool Type | Description | Use Case | Availability |
+|-----------|-------------|----------|--------------|
+| **Library Tools** | Pre-built integrations with popular services | Quick setup, no configuration needed | Managed and open source |
+| **MCP Tools** | Custom tools from MCP servers | Custom functionality, specialized APIs | Managed and open source |
+| **Webhook Tools** | HTTP endpoints for custom integrations | Your own systems, custom workflows | Open source only |
+
+
+## Library (Composio Tools)
+
+- Browse a library of 500+ toolkits from popular services
+- With 3000+ tools to choose from!
+- Click on a service to see available tools and add them to your workflow
+- Users must create a Composio account and add their API key
+- Tools require authorization to work properly
+
+
+
+
+### Creating External Triggers
+
+1. **Click New External Trigger**: Start the trigger creation process
+2. **Select a Toolkit**: Browse available toolkits or search for specific services
+3. **Choose Trigger Type**: Select the specific trigger from available options, click configure
+4. **Authenticate**: Complete OAuth2 flow or enter API keys for the selected service (your preferred method)
+5. **Configure**: Set up event filters and data mapping if required
+6. **Deploy**: Activate the trigger to start listening for events
+
+### Local Setup
+
+If you're running the open source version of Rowboat, you'll need to set up external triggers manually. In the managed version, this is all handled automatically for you.
+
+
+
+
+### Creating One-Time Triggers
+1. Set the exact execution time (date and time)
+2. Configure the input messages for your agents
+3. Deploy to schedule the execution
+
+---
+
+## Recurring Triggers (Cron-based Jobs)
+
+Recurring triggers execute your agents on a repeating schedule using cron expressions. They're ideal for daily reports, periodic maintenance, regular data syncs, and continuous monitoring tasks.
+
+
+ 
+
+
+### Creating Recurring Triggers
+1. Define the cron expression (e.g., `0 9 * * *` for daily at 9 AM)
+2. Configure the recurring message structure
+3. Enable the trigger to start the recurring schedule
+
+### Common Cron Patterns
+```cron
+0 9 * * * # Daily at 9:00 AM
+0 8 * * 1 # Every Monday at 8:00 AM
+*/15 * * * * # Every 15 minutes
+0 0 1 * * # First day of month at midnight
+```
+
diff --git a/apps/docs/docs/using_rag.mdx b/apps/docs/docs/using_rag.mdx
new file mode 100644
index 000000000..52deefadf
--- /dev/null
+++ b/apps/docs/docs/using_rag.mdx
@@ -0,0 +1,103 @@
+# Using RAG in Rowboat
+
+Rowboat provides multiple ways to enhance your agents' context with Retrieval-Augmented Generation (RAG). This guide will help you set up and use each RAG features.
+
+## Quick Start
+
+Text RAG and local file uploads are enabled by default - no configuration needed! Just start using them right away.
+
+## RAG Features
+
+### 1. Text RAG
+β
Enabled by default:
+
+- Process and reason over text content directly
+- No configuration required
+
+### 2. Local File Uploads
+β
Enabled by default:
+
+- Upload PDF files directly from your device
+- Files are stored locally
+- No configuration required
+- Files are parsed using OpenAI by default
+- For larger files, we recommend using Gemini models - see section below.
+
+#### 2.1 Using Gemini for File Parsing
+To use Google's Gemini model for parsing uploaded PDFs, set the following variable:
+
+```bash
+# Enable Gemini for file parsing
+export USE_GEMINI_FILE_PARSING=true
+export GOOGLE_API_KEY=your_google_api_key
+```
+
+### 3. URL Scraping
+Rowboat uses Firecrawl for URL scraping. To enable URL scraping, set the following variables:
+
+```bash
+export USE_RAG_SCRAPING=true
+export FIRECRAWL_API_KEY=your_firecrawl_api_key
+```
+
+## Advanced RAG features
+
+### 1. File Uploads Backed by S3
+To enable S3 file uploads, set the following variables:
+
+```bash
+# Enable S3 uploads
+export USE_RAG_S3_UPLOADS=true
+
+# S3 Configuration
+export AWS_ACCESS_KEY_ID=your_access_key
+export AWS_SECRET_ACCESS_KEY=your_secret_key
+export RAG_UPLOADS_S3_BUCKET=your_bucket_name
+export RAG_UPLOADS_S3_REGION=your_region
+```
+
+### 2. Changing Default Parsing Model
+
+By default, uploaded PDF files are parsed using `gpt-4o`. You can customize this by setting the following:
+
+```bash
+# Override the default parsing model
+export FILE_PARSING_MODEL=your-preferred-model
+```
+
+You can also change the model provider like so:
+```bash
+# Optional: Override the parsing provider settings
+export FILE_PARSING_PROVIDER_BASE_URL=your-provider-base-url
+export FILE_PARSING_PROVIDER_API_KEY=your-provider-api-key
+```
+
+### 3. Embedding Model Options
+
+By default, Rowboat uses OpenAI's `text-embedding-3-small` model for generating embeddings. You can customize this by setting the following:
+
+```bash
+# Override the default embedding model
+export EMBEDDING_MODEL=your-preferred-model
+export EMBEDDING_VECTOR_SIZE=1536
+```
+
+**Important NOTE**
+
+The default size for the vectors index is 1536. If you change this value, then you must delete the index and set it up again:
+```bash
+docker-compose --profile delete_qdrant --profile qdrant up --build delete_qdrant qdrant
+```
+followed by:
+```bash
+./start # this will recreate the index
+```
+
+You can also change the model provider like so:
+```bash
+# Optional: Override the embedding provider settings
+export EMBEDDING_PROVIDER_BASE_URL=your-provider-base-url
+export EMBEDDING_PROVIDER_API_KEY=your-provider-api-key
+```
+
+If you don't specify the provider settings, Rowboat will use OpenAI as the default provider.
diff --git a/apps/docs/docs/videos/Intro-Video.gif b/apps/docs/docs/videos/Intro-Video.gif
new file mode 100644
index 000000000..d4eb387ef
Binary files /dev/null and b/apps/docs/docs/videos/Intro-Video.gif differ
diff --git a/apps/docs/docs/videos/intro.mp4 b/apps/docs/docs/videos/intro.mp4
new file mode 100644
index 000000000..4306a886e
Binary files /dev/null and b/apps/docs/docs/videos/intro.mp4 differ
diff --git a/apps/docs/public/videos/Intro-Video.gif b/apps/docs/public/videos/Intro-Video.gif
new file mode 100644
index 000000000..d4eb387ef
Binary files /dev/null and b/apps/docs/public/videos/Intro-Video.gif differ
diff --git a/apps/rowboat/app/actions/copilot.actions.ts b/apps/rowboat/app/actions/copilot.actions.ts
index 5712e0afe..de9b1baec 100644
--- a/apps/rowboat/app/actions/copilot.actions.ts
+++ b/apps/rowboat/app/actions/copilot.actions.ts
@@ -1,22 +1,25 @@
'use server';
-import {
+import {
CopilotAPIRequest,
CopilotChatContext, CopilotMessage,
DataSourceSchemaForCopilot,
-} from "../../src/application/lib/copilot/types";
+} from "../../src/entities/models/copilot";
import {
Workflow} from "../lib/types/workflow_types";
import { z } from 'zod';
import { projectAuthCheck } from "./project.actions";
-import { redisClient } from "../lib/redis";
import { authorizeUserAction, logUsage } from "./billing.actions";
import { USE_BILLING } from "../lib/feature_flags";
import { getEditAgentInstructionsResponse } from "../../src/application/lib/copilot/copilot";
import { container } from "@/di/container";
import { IUsageQuotaPolicy } from "@/src/application/policies/usage-quota.policy.interface";
import { UsageTracker } from "../lib/billing";
+import { authCheck } from "./auth.actions";
+import { ICreateCopilotCachedTurnController } from "@/src/interface-adapters/controllers/copilot/create-copilot-cached-turn.controller";
+import { BillingError } from "@/src/entities/errors/common";
const usageQuotaPolicy = container.resolve{filterByTriggers - ? 'Loading Composio toolkits with triggers...' + ? 'Loading toolkits with triggers...' : filterByTools - ? 'Loading Composio toolkits with tools...' - : 'Loading Composio toolkits...' + ? 'Loading toolkits with tools...' + : 'Loading toolkits...' }
diff --git a/apps/rowboat/app/projects/components/build-assistant-section.tsx b/apps/rowboat/app/projects/components/build-assistant-section.tsx index 4528917c8..50809578b 100644 --- a/apps/rowboat/app/projects/components/build-assistant-section.tsx +++ b/apps/rowboat/app/projects/components/build-assistant-section.tsx @@ -16,11 +16,35 @@ import { Tabs, Tab } from "@/components/ui/tabs"; import { Project } from "@/src/entities/models/project"; import { z } from "zod"; import Link from 'next/link'; +import { SHOW_PREBUILT_CARDS } from '@/app/lib/feature_flags'; const ITEMS_PER_PAGE = 6; +const copilotPrompts = { + "Blog assistant": { + prompt: "Build an assistant to help with writing a blog post and updating it on google docs", + emoji: "π" + }, + "Meeting prep workflow": { + prompt: "Build a meeting prep pipeline which takes a google calendar invite as input and performs research on the guests using Duckduckgo search and send an email to me", + emoji: "π " + }, + "Scheduling assistant": { + prompt: "Build a scheduling assistant that helps users manage their calendar, book meetings, find available time slots, send reminders, and optimize their daily schedule based on priorities and preferences", + emoji: "β " + }, + "Reddit & HN assistant": { + prompt: "Build an assistant that helps me with browsing Reddit and Hacker News", + emoji: "π" + }, + "CRM assistant": { + prompt: "Build an assistant that helps me with my CRM", + emoji: "π" + } +}; + export function BuildAssistantSection() { const [userPrompt, setUserPrompt] = useState(''); const [isCreating, setIsCreating] = useState(false); @@ -85,6 +109,12 @@ export function BuildAssistantSection() { await createProjectFromTemplate(templateId, router); }; + // Handle prompt card selection + const handlePromptSelect = (promptText: string) => { + setUserPrompt(promptText); + setPromptError(null); + }; + const fetchProjects = async () => { setProjectsLoading(true); try { @@ -310,6 +340,24 @@ export function BuildAssistantSection() { + + {/* Predefined Prompt Cards */} +
+
+ {Object.entries(copilotPrompts).map(([name, config]) => (
+
+ ))}
+
+
diff --git a/apps/rowboat/components/common/help-modal.tsx b/apps/rowboat/components/common/help-modal.tsx
index c45eb6bea..c3a4edba4 100644
--- a/apps/rowboat/components/common/help-modal.tsx
+++ b/apps/rowboat/components/common/help-modal.tsx
@@ -56,7 +56,7 @@ export function HelpModal({ isOpen, onClose, onStartTour }: HelpModalProps) {
docs or reach out on discord.',
+ content: 'Come back here anytime to restart the tour.\nStill have questions? See our docs or reach out on discord.',
title: 'Step 9/9'
}
];
diff --git a/apps/rowboat/di/container.ts b/apps/rowboat/di/container.ts
index be9bf3441..456250c85 100644
--- a/apps/rowboat/di/container.ts
+++ b/apps/rowboat/di/container.ts
@@ -145,6 +145,12 @@ import { UpdateLiveWorkflowController } from "@/src/interface-adapters/controlle
import { RevertToLiveWorkflowUseCase } from "@/src/application/use-cases/projects/revert-to-live-workflow.use-case";
import { RevertToLiveWorkflowController } from "@/src/interface-adapters/controllers/projects/revert-to-live-workflow.controller";
+// copilot
+import { CreateCopilotCachedTurnUseCase } from "@/src/application/use-cases/copilot/create-copilot-cached-turn.use-case";
+import { CreateCopilotCachedTurnController } from "@/src/interface-adapters/controllers/copilot/create-copilot-cached-turn.controller";
+import { RunCopilotCachedTurnUseCase } from "@/src/application/use-cases/copilot/run-copilot-cached-turn.use-case";
+import { RunCopilotCachedTurnController } from "@/src/interface-adapters/controllers/copilot/run-copilot-cached-turn.controller";
+
// users
import { MongoDBUsersRepository } from "@/src/infrastructure/repositories/mongodb.users.repository";
@@ -328,6 +334,13 @@ container.register({
listConversationsController: asClass(ListConversationsController).singleton(),
fetchConversationController: asClass(FetchConversationController).singleton(),
+ // copilot
+ // ---
+ createCopilotCachedTurnUseCase: asClass(CreateCopilotCachedTurnUseCase).singleton(),
+ createCopilotCachedTurnController: asClass(CreateCopilotCachedTurnController).singleton(),
+ runCopilotCachedTurnUseCase: asClass(RunCopilotCachedTurnUseCase).singleton(),
+ runCopilotCachedTurnController: asClass(RunCopilotCachedTurnController).singleton(),
+
// users
// ---
usersRepository: asClass(MongoDBUsersRepository).singleton(),
diff --git a/apps/rowboat/src/application/lib/agents-runtime/agent_instructions.ts b/apps/rowboat/src/application/lib/agents-runtime/agent_instructions.ts
index 7fc494432..56a752a67 100644
--- a/apps/rowboat/src/application/lib/agents-runtime/agent_instructions.ts
+++ b/apps/rowboat/src/application/lib/agents-runtime/agent_instructions.ts
@@ -140,7 +140,7 @@ export const PIPELINE_TYPE_INSTRUCTIONS = (): string => `
- Provide clear, actionable output that the next pipeline step can easily understand and work with.
- Do NOT attempt to handle tasks outside your specific pipeline role.
- Do NOT mention other agents or the pipeline structure to users.
-- Your response should be self-contained and ready to be consumed by the next pipeline step.
+- Your response should be self-contained and ready to be consumed by the next pipeline step. Add a prefix 'Internal message' to your response.
- Reading the message history will show you the pipeline execution flow up to your step.
- These are high level instructions only. The user will provide more specific instructions which will be below.
`;
diff --git a/apps/rowboat/src/application/lib/copilot/copilot.ts b/apps/rowboat/src/application/lib/copilot/copilot.ts
index 4a60fe94b..d8b82614c 100644
--- a/apps/rowboat/src/application/lib/copilot/copilot.ts
+++ b/apps/rowboat/src/application/lib/copilot/copilot.ts
@@ -2,7 +2,7 @@ import z from "zod";
import { createOpenAI } from "@ai-sdk/openai";
import { generateObject, streamText, tool } from "ai";
import { Workflow, WorkflowTool } from "@/app/lib/types/workflow_types";
-import { CopilotChatContext, CopilotMessage, DataSourceSchemaForCopilot } from "./types";
+import { CopilotChatContext, CopilotMessage, DataSourceSchemaForCopilot } from "../../../entities/models/copilot";
import { PrefixLogger } from "@/app/lib/utils";
import zodToJsonSchema from "zod-to-json-schema";
import { COPILOT_INSTRUCTIONS_EDIT_AGENT } from "./copilot_edit_agent";
@@ -12,6 +12,7 @@ import { CURRENT_WORKFLOW_PROMPT } from "./current_workflow";
import { USE_COMPOSIO_TOOLS } from "@/app/lib/feature_flags";
import { composio, getTool } from "../composio/composio";
import { UsageTracker } from "@/app/lib/billing";
+import { CopilotStreamEvent } from "@/src/entities/models/copilot";
const PROVIDER_API_KEY = process.env.PROVIDER_API_KEY || process.env.OPENAI_API_KEY || '';
const PROVIDER_BASE_URL = process.env.PROVIDER_BASE_URL || undefined;
@@ -35,30 +36,6 @@ const openai = createOpenAI({
compatibility: "strict",
});
-const ZTextEvent = z.object({
- content: z.string(),
-});
-
-const ZToolCallEvent = z.object({
- type: z.literal('tool-call'),
- toolName: z.string(),
- toolCallId: z.string(),
- args: z.record(z.any()),
- query: z.string().optional(),
-});
-
-const ZToolResultEvent = z.object({
- type: z.literal('tool-result'),
- toolCallId: z.string(),
- result: z.any(),
-});
-
-const ZDoneEvent = z.object({
- done: z.literal(true),
-});
-
-const ZEvent = z.union([ZTextEvent, ZToolCallEvent, ZToolResultEvent, ZDoneEvent]);
-
const composioToolSearchToolSuggestion = z.object({
toolkit: z.string(),
tool_slug: z.string(),
@@ -273,7 +250,7 @@ export async function* streamMultiAgentResponse(
messages: z.infer[],
workflow: z.infer,
dataSources: z.infer[]
-): AsyncIterable> {
+): AsyncIterable> {
const logger = new PrefixLogger('copilot /stream');
logger.log('context', context);
logger.log('projectId', projectId);
@@ -375,9 +352,4 @@ export async function* streamMultiAgentResponse(
projectId,
totalChunks: chunkCount
});
-
- // done
- yield {
- done: true,
- };
}
\ No newline at end of file
diff --git a/apps/rowboat/src/application/use-cases/copilot/create-copilot-cached-turn.use-case.ts b/apps/rowboat/src/application/use-cases/copilot/create-copilot-cached-turn.use-case.ts
new file mode 100644
index 000000000..20f70a927
--- /dev/null
+++ b/apps/rowboat/src/application/use-cases/copilot/create-copilot-cached-turn.use-case.ts
@@ -0,0 +1,87 @@
+import { z } from "zod";
+import { nanoid } from 'nanoid';
+import { ICacheService } from '@/src/application/services/cache.service.interface';
+import { IUsageQuotaPolicy } from '@/src/application/policies/usage-quota.policy.interface';
+import { IProjectActionAuthorizationPolicy } from '@/src/application/policies/project-action-authorization.policy';
+import { CopilotChatContext, CopilotMessage, DataSourceSchemaForCopilot } from '@/src/entities/models/copilot';
+import { Workflow } from '@/app/lib/types/workflow_types';
+import { USE_BILLING } from "@/app/lib/feature_flags";
+import { authorize, getCustomerIdForProject } from "@/app/lib/billing";
+import { BillingError } from "@/src/entities/errors/common";
+
+const inputSchema = z.object({
+ caller: z.enum(["user", "api"]),
+ userId: z.string().optional(),
+ apiKey: z.string().optional(),
+ data: z.object({
+ projectId: z.string(),
+ messages: z.array(CopilotMessage),
+ workflow: Workflow,
+ context: CopilotChatContext.nullable(),
+ dataSources: z.array(DataSourceSchemaForCopilot).optional(),
+ }),
+});
+
+export interface ICreateCopilotCachedTurnUseCase {
+ execute(data: z.infer): Promise<{ key: string }>;
+}
+
+export class CreateCopilotCachedTurnUseCase implements ICreateCopilotCachedTurnUseCase {
+ private readonly cacheService: ICacheService;
+ private readonly usageQuotaPolicy: IUsageQuotaPolicy;
+ private readonly projectActionAuthorizationPolicy: IProjectActionAuthorizationPolicy;
+
+ constructor({
+ cacheService,
+ usageQuotaPolicy,
+ projectActionAuthorizationPolicy,
+ }: {
+ cacheService: ICacheService,
+ usageQuotaPolicy: IUsageQuotaPolicy,
+ projectActionAuthorizationPolicy: IProjectActionAuthorizationPolicy,
+ }) {
+ this.cacheService = cacheService;
+ this.usageQuotaPolicy = usageQuotaPolicy;
+ this.projectActionAuthorizationPolicy = projectActionAuthorizationPolicy;
+ }
+
+ async execute(data: z.infer): Promise<{ key: string }> {
+ const { projectId } = data.data;
+
+ // check auth
+ await this.projectActionAuthorizationPolicy.authorize({
+ projectId,
+ caller: data.caller,
+ userId: data.userId,
+ apiKey: data.apiKey,
+ });
+ await this.usageQuotaPolicy.assertAndConsumeProjectAction(projectId);
+
+ // check billing authorization
+ if (USE_BILLING) {
+ // get billing customer id for this project
+ const billingCustomerId = await getCustomerIdForProject(projectId);
+
+ // validate enough credits
+ const result = await authorize(billingCustomerId, {
+ type: "use_credits"
+ });
+ if (!result.success) {
+ throw new BillingError(result.error || 'Billing error');
+ }
+ }
+
+ // serialize request
+ const payload = JSON.stringify(data.data);
+
+ // create unique id for stream
+ const key = nanoid();
+
+ // store in cache
+ await this.cacheService.set(`copilot-stream-${key}`, payload, 60 * 10); // expire in 10 minutes
+
+ return {
+ key,
+ }
+ }
+}
\ No newline at end of file
diff --git a/apps/rowboat/src/application/use-cases/copilot/run-copilot-cached-turn.use-case.ts b/apps/rowboat/src/application/use-cases/copilot/run-copilot-cached-turn.use-case.ts
new file mode 100644
index 000000000..7afb0a29e
--- /dev/null
+++ b/apps/rowboat/src/application/use-cases/copilot/run-copilot-cached-turn.use-case.ts
@@ -0,0 +1,104 @@
+import { z } from "zod";
+import { ICacheService } from '@/src/application/services/cache.service.interface';
+import { IUsageQuotaPolicy } from '@/src/application/policies/usage-quota.policy.interface';
+import { IProjectActionAuthorizationPolicy } from '@/src/application/policies/project-action-authorization.policy';
+import { CopilotAPIRequest, CopilotStreamEvent } from '@/src/entities/models/copilot';
+import { USE_BILLING } from "@/app/lib/feature_flags";
+import { authorize, getCustomerIdForProject, logUsage, UsageTracker } from "@/app/lib/billing";
+import { BillingError, NotFoundError } from "@/src/entities/errors/common";
+import { streamMultiAgentResponse } from "@/src/application/lib/copilot/copilot";
+
+const inputSchema = z.object({
+ caller: z.enum(["user", "api"]),
+ userId: z.string().optional(),
+ apiKey: z.string().optional(),
+ key: z.string(),
+});
+
+export interface IRunCopilotCachedTurnUseCase {
+ execute(data: z.infer): AsyncGenerator, void, unknown>;
+}
+
+export class RunCopilotCachedTurnUseCase implements IRunCopilotCachedTurnUseCase {
+ private readonly cacheService: ICacheService;
+ private readonly usageQuotaPolicy: IUsageQuotaPolicy;
+ private readonly projectActionAuthorizationPolicy: IProjectActionAuthorizationPolicy;
+
+ constructor({
+ cacheService,
+ usageQuotaPolicy,
+ projectActionAuthorizationPolicy,
+ }: {
+ cacheService: ICacheService,
+ usageQuotaPolicy: IUsageQuotaPolicy,
+ projectActionAuthorizationPolicy: IProjectActionAuthorizationPolicy,
+ }) {
+ this.cacheService = cacheService;
+ this.usageQuotaPolicy = usageQuotaPolicy;
+ this.projectActionAuthorizationPolicy = projectActionAuthorizationPolicy;
+ }
+
+ async *execute(data: z.infer): AsyncGenerator, void, unknown> {
+ // fetch cached turn
+ const lookupKey = `copilot-stream-${data.key}`;
+ const payload = await this.cacheService.get(lookupKey);
+ if (!payload) {
+ throw new NotFoundError('Cached turn not found');
+ }
+
+ // delete from cache
+ await this.cacheService.delete(lookupKey);
+
+ // parse cached turn
+ const cachedTurn = CopilotAPIRequest.parse(JSON.parse(payload));
+
+ const { projectId } = cachedTurn;
+
+ // check auth
+ await this.projectActionAuthorizationPolicy.authorize({
+ projectId,
+ caller: data.caller,
+ userId: data.userId,
+ apiKey: data.apiKey,
+ });
+
+ await this.usageQuotaPolicy.assertAndConsumeProjectAction(projectId);
+
+ // check billing authorization
+ let billingCustomerId: string | null = null;
+ if (USE_BILLING) {
+ // get billing customer id for this project
+ billingCustomerId = await getCustomerIdForProject(projectId);
+
+ // validate enough credits
+ const result = await authorize(billingCustomerId, {
+ type: "use_credits"
+ });
+ if (!result.success) {
+ throw new BillingError(result.error || 'Billing error');
+ }
+ }
+
+ // init usage tracking
+ const usageTracker = new UsageTracker();
+
+ try {
+ for await (const event of streamMultiAgentResponse(
+ usageTracker,
+ projectId,
+ cachedTurn.context,
+ cachedTurn.messages,
+ cachedTurn.workflow,
+ cachedTurn.dataSources || [],
+ )) {
+ yield event;
+ }
+ } finally {
+ if (USE_BILLING && billingCustomerId) {
+ await logUsage(billingCustomerId, {
+ items: usageTracker.flush(),
+ });
+ }
+ }
+ }
+}
\ No newline at end of file
diff --git a/apps/rowboat/src/application/lib/copilot/types.ts b/apps/rowboat/src/entities/models/copilot.ts
similarity index 78%
rename from apps/rowboat/src/application/lib/copilot/types.ts
rename to apps/rowboat/src/entities/models/copilot.ts
index 5b54f9dc3..eeff97423 100644
--- a/apps/rowboat/src/application/lib/copilot/types.ts
+++ b/apps/rowboat/src/entities/models/copilot.ts
@@ -68,4 +68,28 @@ export const CopilotAPIResponse = z.union([
z.object({
error: z.string(),
}),
+]);
+
+const CopilotStreamTextEvent = z.object({
+ content: z.string(),
+});
+
+const CopilotStreamToolCallEvent = z.object({
+ type: z.literal('tool-call'),
+ toolName: z.string(),
+ toolCallId: z.string(),
+ args: z.record(z.any()),
+ query: z.string().optional(),
+});
+
+const CopilotStreamToolResultEvent = z.object({
+ type: z.literal('tool-result'),
+ toolCallId: z.string(),
+ result: z.any(),
+});
+
+export const CopilotStreamEvent = z.union([
+ CopilotStreamTextEvent,
+ CopilotStreamToolCallEvent,
+ CopilotStreamToolResultEvent,
]);
\ No newline at end of file
diff --git a/apps/rowboat/src/interface-adapters/controllers/copilot/create-copilot-cached-turn.controller.ts b/apps/rowboat/src/interface-adapters/controllers/copilot/create-copilot-cached-turn.controller.ts
new file mode 100644
index 000000000..bd14730e0
--- /dev/null
+++ b/apps/rowboat/src/interface-adapters/controllers/copilot/create-copilot-cached-turn.controller.ts
@@ -0,0 +1,44 @@
+import { z } from "zod";
+import { CopilotChatContext, CopilotMessage, DataSourceSchemaForCopilot } from '@/src/entities/models/copilot';
+import { Workflow } from '@/app/lib/types/workflow_types';
+import { ICreateCopilotCachedTurnUseCase } from "@/src/application/use-cases/copilot/create-copilot-cached-turn.use-case";
+import { BadRequestError } from "@/src/entities/errors/common";
+
+const inputSchema = z.object({
+ caller: z.enum(["user", "api"]),
+ userId: z.string().optional(),
+ apiKey: z.string().optional(),
+ data: z.object({
+ projectId: z.string(),
+ messages: z.array(CopilotMessage),
+ workflow: Workflow,
+ context: CopilotChatContext.nullable(),
+ dataSources: z.array(DataSourceSchemaForCopilot).optional(),
+ }),
+});
+
+export interface ICreateCopilotCachedTurnController {
+ execute(request: z.infer): Promise<{ key: string }>;
+}
+
+export class CreateCopilotCachedTurnController implements ICreateCopilotCachedTurnController {
+ private readonly createCopilotCachedTurnUseCase: ICreateCopilotCachedTurnUseCase;
+
+ constructor({
+ createCopilotCachedTurnUseCase,
+ }: {
+ createCopilotCachedTurnUseCase: ICreateCopilotCachedTurnUseCase,
+ }) {
+ this.createCopilotCachedTurnUseCase = createCopilotCachedTurnUseCase;
+ }
+
+ async execute(request: z.infer): Promise<{ key: string }> {
+ // parse input
+ const result = inputSchema.safeParse(request);
+ if (!result.success) {
+ throw new BadRequestError(`Invalid request: ${JSON.stringify(result.error)}`);
+ }
+
+ return await this.createCopilotCachedTurnUseCase.execute(result.data);
+ }
+}
\ No newline at end of file
diff --git a/apps/rowboat/src/interface-adapters/controllers/copilot/run-copilot-cached-turn.controller.ts b/apps/rowboat/src/interface-adapters/controllers/copilot/run-copilot-cached-turn.controller.ts
new file mode 100644
index 000000000..d62ad3fd7
--- /dev/null
+++ b/apps/rowboat/src/interface-adapters/controllers/copilot/run-copilot-cached-turn.controller.ts
@@ -0,0 +1,37 @@
+import { z } from "zod";
+import { CopilotStreamEvent } from '@/src/entities/models/copilot';
+import { IRunCopilotCachedTurnUseCase } from "@/src/application/use-cases/copilot/run-copilot-cached-turn.use-case";
+import { BadRequestError } from "@/src/entities/errors/common";
+
+const inputSchema = z.object({
+ caller: z.enum(["user", "api"]),
+ userId: z.string().optional(),
+ apiKey: z.string().optional(),
+ key: z.string(),
+});
+
+export interface IRunCopilotCachedTurnController {
+ execute(request: z.infer): AsyncGenerator, void, unknown>;
+}
+
+export class RunCopilotCachedTurnController implements IRunCopilotCachedTurnController {
+ private readonly runCopilotCachedTurnUseCase: IRunCopilotCachedTurnUseCase;
+
+ constructor({
+ runCopilotCachedTurnUseCase,
+ }: {
+ runCopilotCachedTurnUseCase: IRunCopilotCachedTurnUseCase,
+ }) {
+ this.runCopilotCachedTurnUseCase = runCopilotCachedTurnUseCase;
+ }
+
+ async *execute(request: z.infer): AsyncGenerator, void, unknown> {
+ // parse input
+ const result = inputSchema.safeParse(request);
+ if (!result.success) {
+ throw new BadRequestError(`Invalid request: ${JSON.stringify(result.error)}`);
+ }
+
+ yield *this.runCopilotCachedTurnUseCase.execute(result.data);
+ }
+}
\ No newline at end of file