apunkt/rowboat
1
0
Fork 0
mirror of https://github.com/rowboatlabs/rowboat.git synced 2026-04-25 00:16:29 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update docs

Browse source
This commit is contained in:
akhisud3195 2025-02-03 14:10:43 +05:30
parent 9948291dbd
commit d3ec50333f
4 changed files with 7 additions and 44 deletions
Download patch file Download diff file Expand all files Collapse all files

15
apps/docs/docs/building_in_studio.md
View file

@ -74,17 +74,4 @@ Create a test-bench of real-world scenarios in the simulator.
![Scenarios](img/scenarios.png)
Run the scenarios as simulated chats betweeen a user (role-played) and the assistant, in the playground.
![Simulation](img/simulate.png)
![Simulation](img/simulate.png)

31
apps/docs/docs/installation.md
View file

@ -77,6 +77,8 @@ curl --location 'http://localhost:3000/api/v1/<PROJECT_ID>/chat' \
}'
```
**Response:**
The last message in `messages` is either a user-facing response or a tool call by the assistant.
```json
{
"messages": [
@ -148,31 +150,4 @@ client = Client(
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.

4
apps/docs/docs/using_the_api.md
View file

@ -14,9 +14,9 @@ Generate API keys via the developer configs in your project. Copy the Project ID
When you provide your Project ID in the API call, RowBoat uses the version of your assistant deployed to production.
The API takes as input: a) history of all messages till now (system, user, tool and assistant messages) and b) state generated from the previous turn (this is needed because the API does not maintain state on its own).
The API takes as input: a) history of all `messages` till now (system, user, tool and assistant messages) and b) `state` generated from the previous turn (this is needed because the API does not maintain state on its own).
The API produces as response: a) assistant responses (user-facing responses or tool calls) for the current and b) the state to be passed to the next turn.
The API produces as response: a) `messages`, which are the assistant responses (user-facing responses or tool calls) for the current turn and b) the `state` to be passed to the next turn. The last message in `messages` is either a user-facing response or a tool call by the assistant.
### Example first turn of a chat

1
apps/docs/docs/using_the_sdk.md
View file

@ -58,6 +58,7 @@ response_messages, state = client.chat(
tools=tools
)
```
The last message in `response_messages` is either a user-facing response or a tool call by the assistant.
### Stateful Chat (Convenience Wrapper)