agent-starter-pack 0.0.11b0__py3-none-any.whl → 0.0.13b0__py3-none-any.whl

{agent_starter_pack-0.0.11b0.dist-info → agent_starter_pack-0.0.13b0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: agent-starter-pack
-Version: 0.0.11b0
+Version: 0.0.13b0
 Summary: CLI tool to create GCP-based AI agent projects from templates
 Author-email: Google LLC <agent-starter-pack@google.com>
 License: Apache-2.0
@@ -52,6 +52,7 @@ agent-starter-pack create my-awesome-agent
 ```
 
 **That's it!** You now have a fully functional agent project, complete with a backend, frontend, and deployment infrastructure, ready to explore and customize.
+For more installation options, see the [Installation Guide](docs/installation.md).
 
 ---
 
@@ -113,10 +114,13 @@ This project represents the next evolution of the [e2e-gen-ai-app-starter-pack](
 See the [documentation](docs/) for more details:
 
 - [Why Use the Starter Pack?](docs/why_starter_pack.md)
+- [Installation](docs/installation.md)
 - [Deployment](docs/deployment.md)
 - [Data Ingestion](docs/data-ingestion.md)
 - [Observability](docs/observability.md)
 - [CLI Reference](docs/cli/README.md)
+- [CLI Reference](docs/cli/README.md)
+- [Troubleshooting](docs/troubleshooting.md)
 
 **Video Walkthrough:** A [20-Minute Video Walkthrough](https://youtu.be/kwRG7cnqSu0) is available, showcasing the previous `e2e-gen-ai-app-starter-pack`. A new walkthrough for the `agent-starter-pack` will be released soon!
 

{agent_starter_pack-0.0.11b0.dist-info → agent_starter_pack-0.0.13b0.dist-info}/RECORD

@@ -19,9 +19,9 @@ agents/langgraph_base_react/app/agent.py,sha256=2HsbZaSLpMhJQ21geauKPfavcavPW50l
 agents/langgraph_base_react/notebooks/evaluating_langgraph_agent.ipynb,sha256=INlcKJQ_2KB9XAXloG6wKB7cHBKDhW56w1bAQm2IeLA,58048
 agents/langgraph_base_react/template/.templateconfig.yaml,sha256=NpQRZbXtCOeX0XiYtqyI73V6zH4tWWr1TpcTDsSTcjw,991
 agents/langgraph_base_react/tests/integration/test_agent.py,sha256=wg2Y8V4l7dh7rhWy7Z8zioDW5ILRsz7RZJ-mz0AhK3U,1619
-agents/multimodal_live_api/README.md,sha256=v_RsHdcmw1ed5jQ65ZgdoDldCsoQuupPTLd9YvG_U8w,3435
+agents/multimodal_live_api/README.md,sha256=t19QIXtYX8OuHy4po8dD875hDp0E5kRJOxaxGJ-i2zQ,2741
 agents/multimodal_live_api/app/agent.py,sha256=WFB7lvDiImvNyWFlds_f5TtzyrbwcquJe6JyJo8HGSs,2690
-agents/multimodal_live_api/app/server.py,sha256=2l7WgNVQAHbnhWUyXBsIt4DI2_kuBoKiEEhcmg1Hom4,6991
+agents/multimodal_live_api/app/server.py,sha256=RelFBb2iPzAUaI4huM7_5yRCXwNCtpoiT6AfYlQZvqI,7016
 agents/multimodal_live_api/app/templates.py,sha256=HgA4QGIle4Q-Nr6xAAXk1pTX7eNbZqlQUD9_fbCvDWA,3301
 agents/multimodal_live_api/app/vector_store.py,sha256=AYRSNpfevbVTt-nnWna_dp2pn4T7o1nz9-9wOoWaxsA,2045
 agents/multimodal_live_api/template/.templateconfig.yaml,sha256=gkXZxV15yY6OpJ64VWRhWlCtPhJxyacrv_e2kY3-Wo0,1082
@@ -30,7 +30,7 @@ agents/multimodal_live_api/tests/load_test/load_test.py,sha256=HHZyfC4gqiQtZVF_C
 agents/multimodal_live_api/tests/unit/test_server.py,sha256=_TjlgQgNkjerIaBGnu8P8_KB8ZlSolDcivALpUOn_Rw,4786
 src/base_template/.gitignore,sha256=mJKTZIcVdAFiIUQicRfPNGUg6WvwcfTEC2xbmAaU34g,2579
 src/base_template/Makefile,sha256=PNmyhdIRf0p6eRLYqWHfCskLmuDMG673YPEeu51XLVQ,1720
-src/base_template/README.md,sha256=PS5cKkBPgoAHPcRYMxgynx82PBcMK21xZ_eQehrI-b8,4922
+src/base_template/README.md,sha256=7HDBqs6gvoUJNagg48_apRuDkrgb0_uRkAei2OTR_II,8094
 src/base_template/pyproject.toml,sha256=Pv4nC4uh_9_sGA90Tom0ITJUAbGolhseCA9-AOaEIpY,2799
 src/base_template/app/utils/tracing.py,sha256=ovp6tgwgo_tqibpbhhHl8cWIqqUWVYfV0AL7XPDEPpM,5661
 src/base_template/app/utils/typing.py,sha256=UUFm74qiKGtT8pLuE_3yRpcmntRCt91wH_Q-LKdjQuQ,3194
@@ -60,7 +60,7 @@ src/cli/main.py,sha256=vNEV1Fdl1BhJAFbKHcN3MN1v7dPRUcAgXMnB3uCnlI0,1591
 src/cli/commands/create.py,sha256=38wc5DjUOelLtmCnkVLIq9aVc6c1EK10O0fd-refh6I,18963
 src/cli/commands/setup_cicd.py,sha256=EgVkDdA94npDHHPTuYDmWNIiRscnsXtN7CbTuelrTVU,28347
 src/cli/utils/__init__.py,sha256=x-k6jfcv68_zYS88LrA1mr0yB5y5SekJ0nc5Tvt6iDA,1064
-src/cli/utils/cicd.py,sha256=x-8PKp4aevkUwAmtbEZVwu0UlrA6ifXGbouxICu1D0o,25664
+src/cli/utils/cicd.py,sha256=W44Dt39mZMzfDqA16gG69C8vc6VvBy99QVBJxEIjMI4,26631
 src/cli/utils/gcp.py,sha256=f-XTq9AN2_KrCR8pf_gSPOng8KrvtFlNP2Ok9VtTk_Q,4118
 src/cli/utils/logging.py,sha256=0lHe4EPi1A8sOx9xkA7gS4UNl0GsIyp2ahydkkuCzLY,1570
 src/cli/utils/template.py,sha256=p7uKv5yHkXIOWo8EJJ0IjUh57lOSDL7kYHA9OZ7j-z4,25447
@@ -150,8 +150,8 @@ src/resources/setup_cicd/providers.tf,sha256=Km4z6IJt7x7PLaa0kyZbBrO2m3lpuIJZFD5
 src/utils/generate_locks.py,sha256=xu5IAhGGBPkVQGSJX4kk7_JNDwWJUEaXAHbmaQIohbg,4386
 src/utils/lock_utils.py,sha256=plw3vWkRViCMxBK3IrLRHtF_I0kbbP043T9KIYxcb20,2423
 src/utils/watch_and_rebuild.py,sha256=IdbTLReYknTXXu5KWPz3sc7Zg5HTEMS5UVlMSnuhs5E,6067
-agent_starter_pack-0.0.11b0.dist-info/METADATA,sha256=GnSk21NQg-MUxiOAg3J-c-Yjt6mSHWRCbPvbftw4K8I,7174
-agent_starter_pack-0.0.11b0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-agent_starter_pack-0.0.11b0.dist-info/entry_points.txt,sha256=U7uCxR7YulIhZ0L8R8Hui0Bsy6J7oyESBeDYJYMrQjA,56
-agent_starter_pack-0.0.11b0.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-agent_starter_pack-0.0.11b0.dist-info/RECORD,,
+agent_starter_pack-0.0.13b0.dist-info/METADATA,sha256=JCEZ64tCOLyVW6BDUo1hLzP3bB0e0RUut2B1-1EWYvE,7379
+agent_starter_pack-0.0.13b0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+agent_starter_pack-0.0.13b0.dist-info/entry_points.txt,sha256=U7uCxR7YulIhZ0L8R8Hui0Bsy6J7oyESBeDYJYMrQjA,56
+agent_starter_pack-0.0.13b0.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+agent_starter_pack-0.0.13b0.dist-info/RECORD,,

agents/multimodal_live_api/README.md

@@ -18,42 +18,6 @@ This pattern showcases a real-time conversational RAG agent powered by Google Ge
 
 ![live api demo](https://storage.googleapis.com/github-repo/generative-ai/sample-apps/e2e-gen-ai-app-starter-pack/live_api_pattern_demo.gif)
 
-## Usage
-
-1.  **Install Dependencies:**
-
-    ```bash
-    make install
-    ```
-
-2.  **Start the Backend and Frontend:**
-
-    **Backend:**
-    ```bash
-    make backend
-    ```
-    
-    The backend will be ready when you see `INFO:     Application startup complete.` in the console.
-
-    <details>
-    <summary><b>Click here if you want to use AI Studio and API Key instead of Vertex AI:</b></summary>
-
-    ```bash
-    export VERTEXAI=false
-    export GOOGLE_API_KEY=your-google-api-key
-    ```
-
-    </details>
-    <br>
-    
-    **Frontend:**
-    ```bash
-    # In a different shell
-    make ui
-    ```
-
-    This is the suggested mode for development as it allows you to see changes in real-time.
-
 Once both the backend and frontend are running, click the play button in the frontend UI to establish a connection with the backend. You can now interact with the Multimodal Live Agent! You can try asking questions such as "Using the tool you have, define Governance in the context MLOPs" to allow the agent to use the [documentation](https://cloud.google.com/architecture/deploy-operate-generative-ai-applications) it was provided to.
 
 ## Additional Resources for Multimodal Live API

agents/multimodal_live_api/app/server.py

@@ -77,7 +77,7 @@ class GeminiSession:
                 elif "setup" in data:
                     self.run_id = data["setup"]["run_id"]
                     self.user_id = data["setup"]["user_id"]
-                    logging.info(f"Setup data: {data['setup']}")
+                    logger.log_struct({**data['setup'],"type": "setup"}, severity="INFO")
                 else:
                     logging.warning(f"Received unexpected input from client: {data}")
             except ConnectionClosedError as e:

src/base_template/README.md

@@ -12,7 +12,11 @@ This project is organized as follows:
 {{cookiecutter.project_name}}/
 ├── app/                 # Core application code
 │   ├── agent.py         # Main agent logic
+{%- if cookiecutter.deployment_target == 'cloud_run' %}
+│   ├── server.py        # FastAPI Backend server
+{%- elif cookiecutter.deployment_target == 'agent_engine' %}
 │   ├── agent_engine_app.py # Agent Engine application logic
+{%- endif %}
 │   └── utils/           # Utility functions and helpers
 ├── deployment/          # Infrastructure and deployment scripts
 ├── notebooks/           # Jupyter notebooks for prototyping and evaluation
@@ -35,10 +39,10 @@ Before you begin, ensure you have:
 Install required packages using uv:
 
 ```bash
-uv sync --extra jupyter --extra streamlit --frozen
+make install
 ```
 
-### Setupx
+### Setup
 
 If not done during the initialization, set your default Google Cloud project and Location:
 
@@ -69,23 +73,108 @@ gcloud auth application-default set-quota-project $PROJECT_ID
 
 For full command options and usage, refer to the [Makefile](Makefile).
 
+{% if cookiecutter.agent_name == 'multimodal_live_api' %}
+## Usage
+
+1.  **Install Dependencies:**
+
+    ```bash
+    make install
+    ```
+
+2.  **Start the Backend and Frontend:**
+
+    **Backend:**
+    ```bash
+    make backend
+    ```
+    
+    The backend will be ready when you see `INFO:     Application startup complete.` in the console.
+
+    <details>
+    <summary><b>Click here if you want to use AI Studio and API Key instead of Vertex AI:</b></summary>
+
+    ```bash
+    export VERTEXAI=false
+    export GOOGLE_API_KEY=your-google-api-key
+    ```
+
+    </details>
+    <br>
+    
+    **Frontend:**
+    ```bash
+    # In a different shell
+    make ui
+    ```
+
+    This is the suggested mode for development as it allows you to see changes in real-time.
+
+3.  **Interact with the Agent**
+    Once both the backend and frontend are running, click the play button in the frontend UI to establish a connection with the backend. You can now interact with the Multimodal Live Agent! You can try asking questions such as "Using the tool you have, define Governance in the context MLOPs" to allow the agent to use the documentation it was provided to.
+
+**Cloud Shell usage**
+To use the `multimodal_live_api` agent in Cloud Shell, follow these steps:
+
+1.  **Start the Frontend:**
+
+    ```bash
+    make ui
+    ```
+
+    You may be prompted to run the app on a different port if port 3000 is in use. Accept by pressing Enter. You'll see a message similar to:
+
+    ```
+    You can now view multimodal-live-api-web-console in the browser.
+
+      Local:            http://localhost:3001
+      On Your Network:  http://10.88.0.4:3001
+    ```
+
+    Click the `localhost` link to open a web preview in Cloud Shell.
+
+2.  **Start the Backend:**
+
+    Open a *new* Cloud Shell terminal tab. Remember to set your Cloud Platform project in this new session using `gcloud config set project [PROJECT_ID]`. Then from the root of the repository, run:
+
+    ```bash
+    make backend
+    ```
+
+3.  **Configure Web Preview for the Backend:**
+
+    Trigger a web preview for port 8000 - you'll need to change the default port which is `8080`.  See [Cloud Shell Web Preview documentation](https://cloud.google.com/shell/docs/using-web-preview#preview_the_application) for details.
+
+4.  **Connect Frontend to Backend:**
+
+    *   The web preview will open a new tab in your browser. Copy the URL from the address bar (e.g., `https://8000-cs-8a3189b8-5295-4085-9893-c318f1724456.ql-europe-west1-ojep.cloudshell.dev/?authuser=0`).
+    *   Return to the frontend preview tab (from step 1).
+    *   Paste the copied URL into the frontend's "Server URL" connection settings.
+    *   Click the "Play button" to connect. Start interacting with it!
+
+*   When using Cloud Shell there is a known limitation when using the feedback feature in the Frontend. Feedback submission might fail due to different origins between the frontend and backend in the Cloud Shell environment.
+{%- else %}
 ## Usage
+
 1. **Prototype:** Build your Generative AI Agent using the intro notebooks in `notebooks/` for guidance. Use Vertex AI Evaluation to assess performance.
 2. **Integrate:** Import your chain into the app by editing `app/agent.py`.
 3. **Test:** Explore your chain's functionality using the Streamlit playground with `make playground`. The playground offers features like chat history, user feedback, and various input types, and automatically reloads your agent on code changes.
 4. **Deploy:** Configure and trigger the CI/CD pipelines, editing tests if needed. See the [deployment section](#deployment) for details.
 5. **Monitor:** Track performance and gather insights using Cloud Logging, Tracing, and the Looker Studio dashboard to iterate on your application.
+{% endif %}
 
 ## Deployment
 
 ### Dev Environment
 
+{%- if cookiecutter.deployment_target == 'agent_engine' %}
 You can test deployment towards a Dev Environment using the following command:
 
 ```bash
 gcloud config set project <your-dev-project-id>
 make backend
 ```
+{%- endif %}
 
 The repository includes a Terraform configuration for the setup of the Dev Google Cloud project.
 See [deployment/README.md](deployment/README.md) for instructions.

src/cli/utils/cicd.py

@@ -257,6 +257,17 @@ def create_github_connection(
             elif status == "PENDING_USER_OAUTH" or status == "PENDING_INSTALL_APP":
                 if attempt < max_retries - 1:  # Don't print waiting on last attempt
                     console.print("⏳ Waiting for GitHub authorization...")
+                    # Extract and print the action URI for user authentication
+                    try:
+                        action_uri = json.loads(result.stdout).get("installationState", {}).get("actionUri")
+                        if action_uri:
+                            console.print("\n🔑 Authentication Required:", style="bold yellow")
+                            console.print(f"Please visit [link={action_uri}]this page[/link] to authenticate Cloud Build with GitHub:")
+                            console.print(f"{action_uri}", style="bold blue")
+                            console.print("(Copy and paste the link into your browser if clicking doesn't work)")
+                            console.print("After completing authentication, return here to continue the setup.\n")
+                    except (json.JSONDecodeError, KeyError) as e:
+                        console.print(f"⚠️ Could not extract authentication link: {e}", style="yellow")
                     time.sleep(10)
                 continue
             else: