Skip to content

Commit f2e72e9

Browse files
committed
docs: add more info in README
1 parent 877a915 commit f2e72e9

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,22 @@
11
# OpenAI chatkit support for Google ADK
22

3+
This repository provides the backend support for `openai/chatkit-js` (https://github.com/openai/chatkit-js) for Google ADK based agentic applications.
4+
5+
It uses and extends `openai/chatkit-python` (https://github.com/openai/chatkit-python) by providing
6+
7+
- `ADKStore` that wraps `BaseSessionService`
8+
- A function (`stream_agent_response`) that translate ADK events into chatkit events
9+
- Provides support to render `widgets`
10+
* See examples/backend/src/backend/agents/facts/_tools.py::get_weather
11+
* Use `add_widget_to_tool_response` in your tool and `widget` will be sent to client
12+
- Provides support for making calls to client tools.
13+
* Client tools typically run in browser
14+
* See examples/backend/src/backend/agents/facts/_tools.py::switch_theme
15+
* Use `add_client_tool_call_to_tool_response` in you tool
16+
17+
TODO:
18+
- Support for attachments / artifacts
19+
320
## Install
421

522
```bash

0 commit comments

Comments
 (0)