Skip to content

Commit

Permalink
polishing
Browse files Browse the repository at this point in the history
  • Loading branch information
davorrunje committed Dec 30, 2024
1 parent 73d9cf8 commit 1b47831
Showing 1 changed file with 15 additions and 5 deletions.
20 changes: 15 additions & 5 deletions notebook/agentchat_realtime_websocket.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -9,19 +9,29 @@
"\n",
"AG2 supports **RealtimeAgent**, a powerful agent type that connects seamlessly to OpenAI's [Realtime API](https://openai.com/index/introducing-the-realtime-api). In this example we will start a local RealtimeAgent and register a mock get_weather function that the agent will be able to call.\n",
"\n",
"**Note**: This notebook cannot be run in Google Colab because it depends on local JavaScript files and HTML templates. To execute the notebook successfully, run it locally within the cloned project so that the `notebooks/agentchat_realtime_websocket/static` and `notebooks/agentchat_realtime_websocket/templates` folders are available in the correct relative paths.\n"
"**Note**: This notebook cannot be run in Google Colab because it depends on local JavaScript files and HTML templates. To execute the notebook successfully, run it locally within the cloned project so that the `notebooks/agentchat_realtime_websocket/static` and `notebooks/agentchat_realtime_websocket/templates` folders are available in the correct relative paths.\n",
"\n",
"````{=mdx}\n",
":::info Requirements\n",
"Install `ag2`:\n",
"```bash\n",
"git clone https://github.com/ag2ai/ag2.git\n",
"cd ag2\n",
"```\n",
":::\n",
"````\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"\n",
"## Install AG2 with twilio dependencies\n",
"## Install AG2 and dependencies\n",
"\n",
"To use the realtime agent we will connect it to a local websocket trough the browser.\n",
"\n",
"We have prepared a `WebsocketAudioAdapter` to enable you to connect your realtime agent to twilio service.\n",
"We have prepared a `WebsocketAudioAdapter` to enable you to connect your realtime agent to a websocket service.\n",
"\n",
"To be able to run this notebook, you will need to install ag2, fastapi and uvicorn.\n",
"````{=mdx}\n",
Expand Down Expand Up @@ -286,7 +296,7 @@
],
"metadata": {
"kernelspec": {
"display_name": ".venv",
"display_name": ".venv-3.9",
"language": "python",
"name": "python3"
},
Expand All @@ -300,7 +310,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.10.16"
"version": "3.9.20"
}
},
"nbformat": 4,
Expand Down

0 comments on commit 1b47831

Please sign in to comment.