From d3ec50333fd1de74090d140d5988ac06f37035e2 Mon Sep 17 00:00:00 2001 From: akhisud3195 Date: Mon, 3 Feb 2025 14:10:43 +0530 Subject: [PATCH] Update docs --- apps/docs/docs/building_in_studio.md | 15 +------------- apps/docs/docs/installation.md | 31 +++------------------------- apps/docs/docs/using_the_api.md | 4 ++-- apps/docs/docs/using_the_sdk.md | 1 + 4 files changed, 7 insertions(+), 44 deletions(-) diff --git a/apps/docs/docs/building_in_studio.md b/apps/docs/docs/building_in_studio.md index 4e3664ad..e4cb6157 100644 --- a/apps/docs/docs/building_in_studio.md +++ b/apps/docs/docs/building_in_studio.md @@ -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) \ No newline at end of file diff --git a/apps/docs/docs/installation.md b/apps/docs/docs/installation.md index 7840db5f..b655fa3c 100644 --- a/apps/docs/docs/installation.md +++ b/apps/docs/docs/installation.md @@ -77,6 +77,8 @@ curl --location 'http://localhost:3000/api/v1//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. \ No newline at end of file diff --git a/apps/docs/docs/using_the_api.md b/apps/docs/docs/using_the_api.md index 9166a273..95725e5e 100644 --- a/apps/docs/docs/using_the_api.md +++ b/apps/docs/docs/using_the_api.md @@ -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 diff --git a/apps/docs/docs/using_the_sdk.md b/apps/docs/docs/using_the_sdk.md index be242766..1343c7be 100644 --- a/apps/docs/docs/using_the_sdk.md +++ b/apps/docs/docs/using_the_sdk.md @@ -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)