mirror of
https://github.com/google/adk-docs.git
synced 2026-09-14 16:16:59 +08:00
Kristopher Overholt
a583b64aec
* Move adk web Visual Builder page content into Runtime > adk web page * Clarify Visual Builder in intro * Fix casing for consistency * More casing fixes * Move Visual Builder page under Web Interface * Fix link from runtime index page * Keep Visual Builder file at original path, nest under Web Interface in nav --------- Co-authored-by: Joe Fernandez <joefernandez@users.noreply.github.com>
116 lines
3.7 KiB
Markdown
116 lines
3.7 KiB
Markdown
# Use the Web Interface
|
|
|
|
<div class="language-support-tag">
|
|
<span class="lst-supported">Supported in ADK</span><span class="lst-python">Python v0.1.0</span><span class="lst-typescript">TypeScript v0.2.0</span><span class="lst-go">Go v0.1.0</span><span class="lst-java">Java v0.1.0</span>
|
|
</div>
|
|
|
|
The ADK web interface lets you test your agents directly in the browser. This
|
|
tool provides a simple way to interactively develop and debug your agents.
|
|
|
|
|
|
|
|
!!! warning "Caution: ADK Web for development only"
|
|
|
|
ADK Web is ***not meant for use in production deployments***. You should use
|
|
ADK Web for development and debugging purposes only.
|
|
|
|
Key features of the ADK web interface include:
|
|
|
|
- **Chat interface**: Send messages to your agents and view responses in
|
|
real-time
|
|
- **Session management**: Create and switch between sessions
|
|
- **State inspection**: View and modify session state during development
|
|
- **Event history**: Inspect all events generated during agent execution
|
|
- **Visual Builder**: Design agents visually with a drag-and-drop workflow
|
|
editor and an AI-powered assistant (Python only, [learn
|
|
more](/visual-builder/))
|
|
|
|
## Start the web interface
|
|
|
|
Use the following command to start the ADK web interface:
|
|
|
|
=== "Python"
|
|
|
|
```shell
|
|
adk web
|
|
```
|
|
|
|
=== "TypeScript"
|
|
|
|
```shell
|
|
npx adk web
|
|
```
|
|
|
|
=== "Go"
|
|
|
|
```shell
|
|
go run agent.go web api webui
|
|
```
|
|
|
|
=== "Java"
|
|
|
|
Make sure to update the port number.
|
|
=== "Maven"
|
|
With Maven, compile and run the ADK web server:
|
|
```console
|
|
mvn compile exec:java \
|
|
-Dexec.args="--adk.agents.source-dir=src/main/java/agents --server.port=8000"
|
|
```
|
|
=== "Gradle"
|
|
With Gradle, the `build.gradle` or `build.gradle.kts` build file should have the following Java plugin in its plugins section:
|
|
|
|
```groovy
|
|
plugins {
|
|
id('java')
|
|
// other plugins
|
|
}
|
|
```
|
|
Then, elsewhere in the build file, at the top-level, create a new task:
|
|
|
|
```groovy
|
|
tasks.register('runADKWebServer', JavaExec) {
|
|
dependsOn classes
|
|
classpath = sourceSets.main.runtimeClasspath
|
|
mainClass = 'com.google.adk.web.AdkWebServer'
|
|
args '--adk.agents.source-dir=src/main/java/agents', '--server.port=8000'
|
|
}
|
|
```
|
|
|
|
Finally, on the command-line, run the following command:
|
|
```console
|
|
gradle runADKWebServer
|
|
```
|
|
|
|
|
|
In Java, the web interface and the API server are bundled together.
|
|
|
|
Once started, the server prints the access URL to the console. Open it in your
|
|
browser to use the web interface:
|
|
|
|
```shell
|
|
+-----------------------------------------------------------------------------+
|
|
| ADK Web Server started |
|
|
| |
|
|
| For local testing, access at http://localhost:8000. |
|
|
+-----------------------------------------------------------------------------+
|
|
```
|
|
|
|
## Common options
|
|
|
|
Here are some commonly used options for the `adk web` command. Run `adk web
|
|
--help` to see all available options.
|
|
|
|
| Option | Description | Default |
|
|
|--------|-------------|---------|
|
|
| `--port` | Port to run the server on | `8000` |
|
|
| `--host` | Host binding address | `127.0.0.1` |
|
|
| `--session_service_uri` | Custom session storage URI | In-memory |
|
|
| `--artifact_service_uri` | Custom artifact storage URI | Local `.adk/artifacts` |
|
|
| `--reload/--no-reload` | Enable auto-reload on code changes | `true` |
|
|
|
|
For example:
|
|
|
|
```shell
|
|
adk web --port 3000 --session_service_uri "sqlite:///sessions.db"
|
|
```
|