diff --git a/docs/assets/adk-api-server.png b/docs/assets/adk-api-server.png new file mode 100644 index 0000000000..305fc54d51 Binary files /dev/null and b/docs/assets/adk-api-server.png differ diff --git a/docs/assets/adk-run.png b/docs/assets/adk-run.png new file mode 100644 index 0000000000..ef5a2c6d40 Binary files /dev/null and b/docs/assets/adk-run.png differ diff --git a/docs/assets/agent-interaction.png b/docs/assets/agent-interaction.png deleted file mode 100644 index a03e5f4200..0000000000 Binary files a/docs/assets/agent-interaction.png and /dev/null differ diff --git a/docs/get-started/quickstart.md b/docs/get-started/quickstart.md index b06058533d..c16efd8785 100644 --- a/docs/get-started/quickstart.md +++ b/docs/get-started/quickstart.md @@ -35,9 +35,9 @@ Using the terminal, create the folder structure: ```bash mkdir multi_tool_agent/ touch \ -multi_tool_agent/__init__.py \ -multi_tool_agent/agent.py \ -multi_tool_agent/.env + multi_tool_agent/__init__.py \ + multi_tool_agent/agent.py \ + multi_tool_agent/.env ``` Your structure: @@ -115,8 +115,7 @@ parent_folder/ <-- navigate to this directory There are multiple ways to interact with your agent: -![agent-interaction.png](../assets/agent-interaction.png) -=== "adk web (dev UI)" +=== "Dev UI (adk web)" Run the following command to launch the **dev UI**. ``` @@ -125,11 +124,11 @@ There are multiple ways to interact with your agent: **Step 1:** Open the URL provided (usually `http://localhost:8000` or `http://127.0.0.1:8000`) directly in your browser. - **Step 2.** In the top-left corner of the UI, you can select your agent in the dropdown. Select "my_sample_agent". + **Step 2.** In the top-left corner of the UI, you can select your agent in the dropdown. Select "multi_tool_agent". !!!note "Troubleshooting" - If you do not see "my_sample_agent" in the dropdown menu, make sure you are running `adk web` in the **parent folder** of your agent folder (i.e. the parent folder of my_sample_agent). + If you do not see "multi_tool_agent" in the dropdown menu, make sure you are running `adk web` in the **parent folder** of your agent folder (i.e. the parent folder of multi_tool_agent). **Step 3.** Now you can chat with your agent using the textbox: @@ -145,10 +144,10 @@ There are multiple ways to interact with your agent: !!!note "Model support" - Currently only `gemini-2.0-flash-exp` supports talking to your agent via audio/video. For more information, see the [documentation on the Live API on Vertex AI](https://cloud.google.com/vertex-ai/generative-ai/docs/multimodal-live-api) + Currently only `gemini-2.0-flash-exp` supports talking to your agent via audio/video, and can be used either with your API key from Google AI Studio or via [Vertex AI](https://cloud.google.com/vertex-ai/generative-ai/docs/multimodal-live-api). -=== "adk run" +=== "Terminal (adk run)" Run the following command, to chat with your Google Search agent. @@ -156,8 +155,19 @@ There are multiple ways to interact with your agent: adk run multi_tool_agent ``` + ![adk-run.png](../assets/adk-run.png) + To exit, use Cmd/Ctrl+C. +=== "API Server (adk api_server)" + + `adk api_server` enables you to create a local FastAPI server in a single command, enabling you to test local cURL requests before you deploy your agent. + + ![adk-api-server.png](../assets/adk-api-server.png) + + To learn how to use `adk api_server`, see the [documentation on local testing](local-testing.md). + + ### 📝 Example prompts to try * What is the weather in New York?