Update docs to include managed service

2026-05-16 18:25:17 +02:00 · 2025-02-05 15:04:32 +05:30 · 2025-02-05 15:04:32 +05:30 · 206c807a6f
commit 206c807a6f
parent 7df6d6e6f3
13 changed files with 251 additions and 10 deletions
--- a/apps/docs/docs/testing.md
+++ b/apps/docs/docs/testing.md
@ -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/)
+<br>
+
+2. Once in Studio, create a new blank project or use one of the example templates:
+![Create Project](img/project-page.png)
+<br>
+
+3. Use the copilot to help you build agents:
+![Use Copilot](img/use-copilot.png)
+<br>
+
+4. Ensure that the correct agent is set as the "start agent":
+![Set Start Agent](img/start-agent.png)
+<br>
+
+5. Test out a chat in the playground to verify the agents' behavior:
+![Testing Chat](img/testing-chat.png)
+<br>
+
+### Testing the Chat API
+
+- For the open source installation, the `<HOST>` is [http://localhost:3000](http://localhost:3000)
+- When using the hosted app, the `<HOST>` is [https://app.rowboatlabs.com](https://app.rowboatlabs.com)
+- `<PROJECT_ID>` is available in the URL of the project page
+- API Key can be generated from the project config page at `<HOST>/projects/<PROJECT_ID>/config`
+
+Below is an example request and response. Modify the user message in the request, based on your example project.
+
+**Request:**
+
+```bash
+curl --location 'http://<HOST>/api/v1/<PROJECT_ID>/chat' \
+--header 'Content-Type: application/json' \
+--header 'Authorization: Bearer <API_KEY>' \
+--data '{
+    "messages": [
+        {
+            "role": "user",
+            "content": "What is my pending payment amount?"
+        }
+    ]
+}'
+```
+**Response:**
+The last message in `messages` is either a user-facing response or a tool call by the assistant.
+
+```json
+{
+    "messages": [
+        {
+            "sender": "Credit Card Hub",
+            "role": "assistant",
+            "response_type": "internal",
+            "content": null,
+            "created_at": "2025-02-01T06:55:47.843909",
+            "current_turn": true,
+            "tool_calls": [
+                {
+                    "function": {
+                    "arguments": "{\"args\":\"\",\"kwargs\":\"\"}",
+                    // Internal tool calls are used to transfer between agents
+                    "name": "transfer_to_outstanding_payment"
+                    },
+                    "id": "call_7jGpwpVvzhZFOyRgxHFkdOdU",
+                    "type": "function"
+                }
+            ]
+        },
+        {
+            "tool_name": "transfer_to_outstanding_payment",
+            "role": "tool",
+            "content": "{\"assistant\": \"Outstanding Payment\"}",
+            "tool_call_id": "call_7jGpwpVvzhZFOyRgxHFkdOdU"
+        },
+        {
+            "sender": "Outstanding Payment",
+            "role": "assistant",
+            // Response is not user-facing, to enable further post processing
+            "response_type": "internal",
+            "content": "Sure, could you provide the last four digits of your card or your registered mobile number so I can look up your pending payment amount?",
+            "created_at": "2025-02-01T06:55:49.648008",
+            "current_turn": true
+        },
+        {
+            "sender": "Outstanding Payment >> Post process",
+            "role": "assistant",
+            // Response is user-facing
+            "response_type": "external",
+            "content": "Sure, please provide the last four digits of your card or your registered mobile number so I can check your pending payment amount.",
+            "created_at": "2025-02-01T06:55:49.648008",
+            "current_turn": true
+        }
+    ],
+    "state": {
+        // .. state data
+    }
+}
+```
+
+### Testing the Python Chat SDK
+
+- For the open source installation, the `<HOST>` is [http://localhost:3000](http://localhost:3000)
+- When using the hosted app, the `<HOST>` is [https://app.rowboatlabs.com](https://app.rowboatlabs.com)
+- `<PROJECT_ID>` is available in the URL of the project page
+- API Key can be generated from the project config page at `<HOST>/projects/<PROJECT_ID>/config`
+
+```bash
+pip install rowboat
+```
+
+Modify the user message in `messages`, based on your example project.
+
+```python
+from rowboat import Client
+
+client = Client(
+    host="<HOST>",
+    project_id="<PROJECT_ID>",
+    api_key="<API_KEY>"  # Generate this from /projects/<PROJECT_ID>/config
+)
+
+# Simple chat interaction
+messages = [{"role": "user", "content": "What is my pending payment amount?"}]
+response_messages, state = client.chat(messages=messages)
+```
+The last message in `response_messages` is either a user-facing response or a tool call by the assistant.