gadk-cli 0.4.0

The gadk deploy CLI: deploy gadk agents to Cloud Run and Vertex AI Agent Engine
Documentation
{
  "name": "create defaults",
  "args": [],
  "update": false,
  "projectName": "test-project",
  "region": "test-region",
  "request": {
    "parent": "projects/test-project/locations/test-region",
    "reasoningEngine": {
      "displayName": "ADK Agent: {{RFC3339}}",
      "spec": {
        "sourceCodeSpec": {
          "inlineSource": {
            "sourceArchive": "dGVzdCBhcmNoaXZl"
          },
          "imageSpec": {}
        },
        "deploymentSpec": {
          "env": [
            {
              "name": "GOOGLE_CLOUD_REGION",
              "value": "test-region"
            },
            {
              "name": "NUM_WORKERS",
              "value": "1"
            },
            {
              "name": "GOOGLE_CLOUD_AGENT_ENGINE_ENABLE_TELEMETRY",
              "value": "true"
            },
            {
              "name": "OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT",
              "value": "true"
            }
          ]
        },
        "classMethods": [
          {
            "api_mode": "async",
            "description": "Creates a new session.\n\t\t\nArgs:\n    user_id (str):\n\t        Required. The ID of the user.\n    state (dict[str, Any]):\n        Optional. The initial state of the session.\n\nReturns:\n    Session: The newly created session instance.\n",
            "name": "async_create_session",
            "parameters": {
              "properties": {
                "state": {
                  "nullable": true,
                  "type": "object"
                },
                "user_id": {
                  "type": "string"
                }
              },
              "required": [
                "user_id"
              ],
              "type": "object"
            }
          },
          {
            "api_mode": "async",
            "description": "Get a session for the given user.\n\nArgs:\n    user_id (str):\n        Required. The ID of the user.\n    session_id (str):\n        Required. The ID of the session.\n\nReturns:\n    Session: The session instance (if any). Returns an error on failure\n\n",
            "name": "async_get_session",
            "parameters": {
              "properties": {
                "session_id": {
                  "type": "string"
                },
                "user_id": {
                  "type": "string"
                }
              },
              "required": [
                "user_id",
                "session_id"
              ],
              "type": "object"
            }
          },
          {
            "api_mode": "async",
            "description": "List sessions for the given user.\n\nArgs:\n    user_id (str):\n        Required. The ID of the user.\n\nReturns:\n    ListSessionsResponse: The list of sessions with data.\n",
            "name": "async_list_sessions",
            "parameters": {
              "properties": {
                "user_id": {
                  "type": "string"
                }
              },
              "required": [
                "user_id"
              ],
              "type": "object"
            }
          },
          {
            "api_mode": "async",
            "description": "Deletes a session for the given user.\n\nArgs:\n    user_id (str):\n        Required. The ID of the user.\n    session_id (str):\n        Required. The ID of the session.\n\nReturns:\n\ton success returns an empty string. On error returns an error message.\n\n",
            "name": "async_delete_session",
            "parameters": {
              "properties": {
                "session_id": {
                  "type": "string"
                },
                "user_id": {
                  "type": "string"
                }
              },
              "required": [
                "user_id",
                "session_id"
              ],
              "type": "object"
            }
          },
          {
            "api_mode": "async_stream",
            "description": "Streams responses asynchronously from the ADK application.\nArgs:\n    message (genai.Content):\n        Required. The message to stream responses for.\n    user_id (str):\n        Required. The ID of the user.\n    session_id (str):\n        Optional. The ID of the session. If not provided, a new session will be created for the user.\n\nYields:\n    Single lines with JSON encoded event each. Errors are also emitted as JSON.\n\n",
            "name": "async_stream_query",
            "parameters": {
              "properties": {
                "message": {
                  "anyOf": [
                    {
                      "type": "string"
                    },
                    {
                      "additionalProperties": true,
                      "type": "object"
                    }
                  ]
                },
                "session_id": {
                  "nullable": true,
                  "type": "string"
                },
                "user_id": {
                  "type": "string"
                }
              },
              "required": [
                "message",
                "user_id"
              ],
              "type": "object"
            }
          },
          {
            "api_mode": "async_stream",
            "description": "Streams responses asynchronously from the ADK application.\n\nThis method is primarily meant for invocation from Gemini Enterprise.\n\nArgs:\n    request_json (str):\n        Required. A JSON-encoded request object with:\n        - user_id (str): Required. The user ID to run the agent for.\n        - session_id (str): Optional. The session ID. Gemini Enterprise may\n          send its Discovery Engine session resource on the first turn; later\n          turns should use the backend ADK session ID returned in the response.\n        - message (Content): Required. The user message, using the genai\n          Content JSON shape, for example:\n          {\"role\":\"user\",\"parts\":[{\"text\":\"Hi\"}]}\n\n",
            "name": "streaming_agent_run_with_events",
            "parameters": {
              "properties": {
                "request_json": {
                  "type": "string"
                }
              },
              "required": [
                "request_json"
              ],
              "type": "object"
            }
          }
        ],
        "agentFramework": "google-adk"
      }
    }
  }
}