Skip to content

Commit 574a9f3

Browse files
committed
feat: update docs
1 parent bb561ce commit 574a9f3

File tree

3 files changed

+13
-0
lines changed

3 files changed

+13
-0
lines changed

agents/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Agent Templates
2+
3+
The agent implementations in this directory are templates that are meant to be used with the Agent Starter Pack templating engine. You should not clone this repository directly to use them.
4+
5+
Please follow the instructions in the main [README](/README.md) to install the templating engine and get started.

docs/cli/create.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ The following options will be prompted interactively if not provided via the com
2222
- `--deployment-target`, `-d`: Deployment target (`agent_engine` or `cloud_run`). Prompts if omitted.
2323
- `--datastore`, `-ds`: Datastore for RAG agents (`vertex_ai_search` or `vertex_ai_vector_search`). Prompted if `--include-data-ingestion` is specified, or if the selected agent (e.g., `agentic_rag`) requires data ingestion, and this option is omitted.
2424
- `--region`: GCP region for deployment (default: `us-central1`). Prompts for confirmation if not specified and `--auto-approve` is not used.
25+
- `--session-type`: Type of session storage to use (`in_memory` or `alloydb`). This is only applicable for agents that require session management and when the deployment target is `cloud_run`.
2526

2627
GCP account and project ID are detected automatically (using your active `gcloud config` settings). You will be prompted to confirm or change them unless `--auto-approve` is used.
2728

llm.txt

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,7 @@ agent-starter-pack create PROJECT_NAME [OPTIONS]
6969
* `-d, --deployment-target`: Target deployment environment (`cloud_run` or `agent_engine`).
7070
* `-ds, --datastore`: For RAG agents, the datastore (`vertex_ai_search` or `vertex_ai_vector_search`).
7171
* `-i, --include-data-ingestion`: Include data ingestion pipeline scaffolding.
72+
* `--session-type`: For agents requiring session management on Cloud Run, specifies the storage type (`in_memory` or `alloydb`).
7273
* `--region`: GCP region (e.g., `us-central1`).
7374
* `--auto-approve`: **Skips all interactive prompts (crucial for automation).**
7475
* `--debug`: Enables debug logging during creation.
@@ -186,6 +187,12 @@ uvx agent-starter-pack setup-cicd
186187
* **Deploying with UI:** `make backend IAP=true`
187188
* **Access Control:** After deploying with IAP, grant users the `IAP-secured Web App User` role in IAM to give them access.
188189

190+
### Session Management
191+
192+
For stateful agents, the starter pack supports persistent sessions.
193+
* **Cloud Run:** Choose between `in_memory` (for testing) and durable `alloydb` sessions using the `--session-type` flag.
194+
* **Agent Engine:** Provides session management automatically.
195+
189196
### Monitoring & Observability
190197
* **Technology:** Uses OpenTelemetry to emit events to Google Cloud Trace and Logging.
191198
* **Custom Tracer:** A custom tracer in `app/utils/tracing.py` handles large payloads by linking to GCS, overcoming default service limits.

0 commit comments

Comments
 (0)