google__adk-docs/docs/api-reference/cli/searchindex.js

Search.setIndex({"alltitles":{"CLI Reference":[[0,null]],"Contents:":[[1,null]],"adk":[[0,"adk"]],"adk cli documentation":[[1,null]],"agent_engine":[[0,"adk-deploy-agent-engine"]],"api_server":[[0,"adk-api-server"]],"cloud_run":[[0,"adk-deploy-cloud-run"]],"create":[[0,"adk-create"]],"deploy":[[0,"adk-deploy"]],"eval":[[0,"adk-eval"]],"run":[[0,"adk-run"]],"web":[[0,"adk-web"]]},"docnames":["cli","index"],"envversion":{"sphinx":65,"sphinx.domains.c":3,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":9,"sphinx.domains.index":1,"sphinx.domains.javascript":3,"sphinx.domains.math":2,"sphinx.domains.python":4,"sphinx.domains.rst":2,"sphinx.domains.std":2},"filenames":["cli.rst","index.rst"],"indexentries":{"--a2a":[[0,"cmdoption-adk-api_server-a2a",false],[0,"cmdoption-adk-deploy-cloud_run-a2a",false],[0,"cmdoption-adk-web-a2a",false]],"--adk_app":[[0,"cmdoption-adk-deploy-agent_engine-adk_app",false]],"--adk_version":[[0,"cmdoption-adk-deploy-cloud_run-adk_version",false]],"--allow_origins":[[0,"cmdoption-adk-api_server-allow_origins",false],[0,"cmdoption-adk-deploy-cloud_run-allow_origins",false],[0,"cmdoption-adk-web-allow_origins",false]],"--api_key":[[0,"cmdoption-adk-create-api_key",false]],"--app_name":[[0,"cmdoption-adk-deploy-cloud_run-app_name",false]],"--artifact_service_uri":[[0,"cmdoption-adk-api_server-artifact_service_uri",false],[0,"cmdoption-adk-deploy-cloud_run-artifact_service_uri",false],[0,"cmdoption-adk-web-artifact_service_uri",false]],"--artifact_storage_uri":[[0,"cmdoption-adk-api_server-artifact_storage_uri",false],[0,"cmdoption-adk-deploy-cloud_run-artifact_storage_uri",false],[0,"cmdoption-adk-web-artifact_storage_uri",false]],"--config_file_path":[[0,"cmdoption-adk-eval-config_file_path",false]],"--description":[[0,"cmdoption-adk-deploy-agent_engine-description",false]],"--display_name":[[0,"cmdoption-adk-deploy-agent_engine-display_name",false]],"--env_file":[[0,"cmdoption-adk-deploy-agent_engine-env_file",false]],"--eval_storage_uri":[[0,"cmdoption-adk-api_server-eval_storage_uri",false],[0,"cmdoption-adk-deploy-cloud_run-eval_storage_uri",false],[0,"cmdoption-adk-eval-eval_storage_uri",false],[0,"cmdoption-adk-web-eval_storage_uri",false]],"--host":[[0,"cmdoption-adk-api_server-host",false],[0,"cmdoption-adk-web-host",false]],"--log_level":[[0,"cmdoption-adk-api_server-log_level",false],[0,"cmdoption-adk-deploy-cloud_run-log_level",false],[0,"cmdoption-adk-web-log_level",false]],"--memory_service_uri":[[0,"cmdoption-adk-api_server-memory_service_uri",false],[0,"cmdoption-adk-deploy-cloud_run-memory_service_uri",false],[0,"cmdoption-adk-web-memory_service_uri",false]],"--model":[[0,"cmdoption-adk-create-model",false]],"--no-reload":[[0,"cmdoption-adk-api_server-reload",false],[0,"cmdoption-adk-deploy-cloud_run-reload",false],[0,"cmdoption-adk-web-reload",false]],"--port":[[0,"cmdoption-adk-api_server-port",false],[0,"cmdoption-adk-deploy-cloud_run-port",false],[0,"cmdoption-adk-web-port",false]],"--print_detailed_results":[[0,"cmdoption-adk-eval-print_detailed_results",false]],"--project":[[0,"cmdoption-adk-create-project",false],[0,"cmdoption-adk-deploy-agent_engine-project",false],[0,"cmdoption-adk-deploy-cloud_run-project",false]],"--region":[[0,"cmdoption-adk-create-region",false],[0,"cmdoption-adk-deploy-agent_engine-region",false],[0,"cmdoption-adk-deploy-cloud_run-region",false]],"--reload":[[0,"cmdoption-adk-api_server-reload",false],[0,"cmdoption-adk-deploy-cloud_run-reload",false],[0,"cmdoption-adk-web-reload",false]],"--reload_agents":[[0,"cmdoption-adk-api_server-reload_agents",false],[0,"cmdoption-adk-deploy-cloud_run-reload_agents",false],[0,"cmdoption-adk-web-reload_agents",false]],"--replay":[[0,"cmdoption-adk-run-replay",false]],"--requirements_file":[[0,"cmdoption-adk-deploy-agent_engine-requirements_file",false]],"--resume":[[0,"cmdoption-adk-run-resume",false]],"--save_session":[[0,"cmdoption-adk-run-save_session",false]],"--service_name":[[0,"cmdoption-adk-deploy-cloud_run-service_name",false]],"--session_db_url":[[0,"cmdoption-adk-api_server-session_db_url",false],[0,"cmdoption-adk-deploy-cloud_run-session_db_url",false],[0,"cmdoption-adk-web-session_db_url",false]],"--session_id":[[0,"cmdoption-adk-run-session_id",false]],"--session_service_uri":[[0,"cmdoption-adk-api_server-session_service_uri",false],[0,"cmdoption-adk-deploy-cloud_run-session_service_uri",false],[0,"cmdoption-adk-web-session_service_uri",false]],"--staging_bucket":[[0,"cmdoption-adk-deploy-agent_engine-staging_bucket",false]],"--temp_folder":[[0,"cmdoption-adk-deploy-agent_engine-temp_folder",false],[0,"cmdoption-adk-deploy-cloud_run-temp_folder",false]],"--trace_to_cloud":[[0,"cmdoption-adk-api_server-trace_to_cloud",false],[0,"cmdoption-adk-deploy-agent_engine-trace_to_cloud",false],[0,"cmdoption-adk-deploy-cloud_run-trace_to_cloud",false],[0,"cmdoption-adk-web-trace_to_cloud",false]],"--verbosity":[[0,"cmdoption-adk-deploy-cloud_run-verbosity",false]],"--version":[[0,"cmdoption-adk-version",false]],"--with_ui":[[0,"cmdoption-adk-deploy-cloud_run-with_ui",false]],"adk command line option":[[0,"cmdoption-adk-version",false]],"adk-api_server command line option":[[0,"cmdoption-adk-api_server-a2a",false],[0,"cmdoption-adk-api_server-allow_origins",false],[0,"cmdoption-adk-api_server-arg-AGENTS_DIR",false],[0,"cmdoption-adk-api_server-artifact_service_uri",false],[0,"cmdoption-adk-api_server-artifact_storage_uri",false],[0,"cmdoption-adk-api_server-eval_storage_uri",false],[0,"cmdoption-adk-api_server-host",false],[0,"cmdoption-adk-api_server-log_level",false],[0,"cmdoption-adk-api_server-memory_service_uri",false],[0,"cmdoption-adk-api_server-port",false],[0,"cmdoption-adk-api_server-reload",false],[0,"cmdoption-adk-api_server-reload_agents",false],[0,"cmdoption-adk-api_server-session_db_url",false],[0,"cmdoption-adk-api_server-session_service_uri",false],[0,"cmdoption-adk-api_server-trace_to_cloud",false]],"adk-create command line option":[[0,"cmdoption-adk-create-api_key",false],[0,"cmdoption-adk-create-arg-APP_NAME",false],[0,"cmdoption-adk-create-model",false],[0,"cmdoption-adk-create-project",false],[0,"cmdoption-adk-create-region",false]],"adk-deploy-agent_engine command line option":[[0,"cmdoption-adk-deploy-agent_engine-adk_app",false],[0,"cmdoption-adk-deploy-agent_engine-arg-AGENT",false],[0,"cmdoption-adk-deploy-agent_engine-description",false],[0,"cmdoption-adk-deploy-agent_engine-display_name",false],[0,"cmdoption-adk-deploy-agent_engine-env_file",false],[0,"cmdoption-adk-deploy-agent_engine-project",false],[0,"cmdoption-adk-deploy-agent_engine-region",false],[0,"cmdoption-adk-deploy-agent_engine-requirements_file",false],[0,"cmdoption-adk-deploy-agent_engine-staging_bucket",false],[0,"cmdoption-adk-deploy-agent_engine-temp_folder",false],[0,"cmdoption-adk-deploy-agent_engine-trace_to_cloud",false]],"adk-deploy-cloud_run command line option":[[0,"cmdoption-adk-deploy-cloud_run-a2a",false],[0,"cmdoption-adk-deploy-cloud_run-adk_version",false],[0,"cmdoption-adk-deploy-cloud_run-allow_origins",false],[0,"cmdoption-adk-deploy-cloud_run-app_name",false],[0,"cmdoption-adk-deploy-cloud_run-arg-AGENT",false],[0,"cmdoption-adk-deploy-cloud_run-artifact_service_uri",false],[0,"cmdoption-adk-deploy-cloud_run-artifact_storage_uri",false],[0,"cmdoption-adk-deploy-cloud_run-eval_storage_uri",false],[0,"cmdoption-adk-deploy-cloud_run-log_level",false],[0,"cmdoption-adk-deploy-cloud_run-memory_service_uri",false],[0,"cmdoption-adk-deploy-cloud_run-port",false],[0,"cmdoption-adk-deploy-cloud_run-project",false],[0,"cmdoption-adk-deploy-cloud_run-region",false],[0,"cmdoption-adk-deploy-cloud_run-reload",false],[0,"cmdoption-adk-deploy-cloud_run-reload_agents",false],[0,"cmdoption-adk-deploy-cloud_run-service_name",false],[0,"cmdoption-adk-deploy-cloud_run-session_db_url",false],[0,"cmdoption-adk-deploy-cloud_run-session_service_uri",false],[0,"cmdoption-adk-deploy-cloud_run-temp_folder",false],[0,"cmdoption-adk-deploy-cloud_run-trace_to_cloud",false],[0,"cmdoption-adk-deploy-cloud_run-verbosity",false],[0,"cmdoption-adk-deploy-cloud_run-with_ui",false]],"adk-eval command line option":[[0,"cmdoption-adk-eval-arg-AGENT_MODULE_FILE_PATH",false],[0,"cmdoption-adk-eval-arg-EVAL_SET_FILE_PATH",false],[0,"cmdoption-adk-eval-config_file_path",false],[0,"cmdoption-adk-eval-eval_storage_uri",false],[0,"cmdoption-adk-eval-print_detailed_results",false]],"adk-run command line option":[[0,"cmdoption-adk-run-arg-AGENT",false],[0,"cmdoption-adk-run-replay",false],[0,"cmdoption-adk-run-resume",false],[0,"cmdoption-adk-run-save_session",false],[0,"cmdoption-adk-run-session_id",false]],"adk-web command line option":[[0,"cmdoption-adk-web-a2a",false],[0,"cmdoption-adk-web-allow_origins",false],[0,"cmdoption-adk-web-arg-AGENTS_DIR",false],[0,"cmdoption-adk-web-artifact_service_uri",false],[0,"cmdoption-adk-web-artifact_storage_uri",false],[0,"cmdoption-adk-web-eval_storage_uri",false],[0,"cmdoption-adk-web-host",false],[0,"cmdoption-adk-web-log_level",false],[0,"cmdoption-adk-web-memory_service_uri",false],[0,"cmdoption-adk-web-port",false],[0,"cmdoption-adk-web-reload",false],[0,"cmdoption-adk-web-reload_agents",false],[0,"cmdoption-adk-web-session_db_url",false],[0,"cmdoption-adk-web-session_service_uri",false],[0,"cmdoption-adk-web-trace_to_cloud",false]],"agent":[[0,"cmdoption-adk-deploy-agent_engine-arg-AGENT",false],[0,"cmdoption-adk-deploy-cloud_run-arg-AGENT",false],[0,"cmdoption-adk-run-arg-AGENT",false]],"agent_module_file_path":[[0,"cmdoption-adk-eval-arg-AGENT_MODULE_FILE_PATH",false]],"agents_dir":[[0,"cmdoption-adk-api_server-arg-AGENTS_DIR",false],[0,"cmdoption-adk-web-arg-AGENTS_DIR",false]],"app_name":[[0,"cmdoption-adk-create-arg-APP_NAME",false]],"eval_set_file_path":[[0,"cmdoption-adk-eval-arg-EVAL_SET_FILE_PATH",false]]},"objects":{"adk":[[0,0,1,"cmdoption-adk-version","--version"]],"adk-api_server":[[0,0,1,"cmdoption-adk-api_server-a2a","--a2a"],[0,0,1,"cmdoption-adk-api_server-allow_origins","--allow_origins"],[0,0,1,"cmdoption-adk-api_server-artifact_service_uri","--artifact_service_uri"],[0,0,1,"cmdoption-adk-api_server-artifact_storage_uri","--artifact_storage_uri"],[0,0,1,"cmdoption-adk-api_server-eval_storage_uri","--eval_storage_uri"],[0,0,1,"cmdoption-adk-api_server-host","--host"],[0,0,1,"cmdoption-adk-api_server-log_level","--log_level"],[0,0,1,"cmdoption-adk-api_server-memory_service_uri","--memory_service_uri"],[0,0,1,"cmdoption-adk-api_server-reload","--no-reload"],[0,0,1,"cmdoption-adk-api_server-port","--port"],[0,0,1,"cmdoption-adk-api_server-reload","--reload"],[0,0,1,"cmdoption-adk-api_server-reload_agents","--reload_agents"],[0,0,1,"cmdoption-adk-api_server-session_db_url","--session_db_url"],[0,0,1,"cmdoption-adk-api_server-session_service_uri","--session_service_uri"],[0,0,1,"cmdoption-adk-api_server-trace_to_cloud","--trace_to_cloud"],[0,0,1,"cmdoption-adk-api_server-arg-AGENTS_DIR","AGENTS_DIR"]],"adk-create":[[0,0,1,"cmdoption-adk-create-api_key","--api_key"],[0,0,1,"cmdoption-adk-create-model","--model"],[0,0,1,"cmdoption-adk-create-project","--project"],[0,0,1,"cmdoption-adk-create-region","--region"],[0,0,1,"cmdoption-adk-create-arg-APP_NAME","APP_NAME"]],"adk-deploy-agent_engine":[[0,0,1,"cmdoption-adk-deploy-agent_engine-adk_app","--adk_app"],[0,0,1,"cmdoption-adk-deploy-agent_engine-description","--description"],[0,0,1,"cmdoption-adk-deploy-agent_engine-display_name","--display_name"],[0,0,1,"cmdoption-adk-deploy-agent_engine-env_file","--env_file"],[0,0,1,"cmdoption-adk-deploy-agent_engine-project","--project"],[0,0,1,"cmdoption-adk-deploy-agent_engine-region","--region"],[0,0,1,"cmdoption-adk-deploy-agent_engine-requirements_file","--requirements_file"],[0,0,1,"cmdoption-adk-deploy-agent_engine-staging_bucket","--staging_bucket"],[0,0,1,"cmdoption-adk-deploy-agent_engine-temp_folder","--temp_folder"],[0,0,1,"cmdoption-adk-deploy-agent_engine-trace_to_cloud","--trace_to_cloud"],[0,0,1,"cmdoption-adk-deploy-agent_engine-arg-AGENT","AGENT"]],"adk-deploy-cloud_run":[[0,0,1,"cmdoption-adk-deploy-cloud_run-a2a","--a2a"],[0,0,1,"cmdoption-adk-deploy-cloud_run-adk_version","--adk_version"],[0,0,1,"cmdoption-adk-deploy-cloud_run-allow_origins","--allow_origins"],[0,0,1,"cmdoption-adk-deploy-cloud_run-app_name","--app_name"],[0,0,1,"cmdoption-adk-deploy-cloud_run-artifact_service_uri","--artifact_service_uri"],[0,0,1,"cmdoption-adk-deploy-cloud_run-artifact_storage_uri","--artifact_storage_uri"],[0,0,1,"cmdoption-adk-deploy-cloud_run-eval_storage_uri","--eval_storage_uri"],[0,0,1,"cmdoption-adk-deploy-cloud_run-log_level","--log_level"],[0,0,1,"cmdoption-adk-deploy-cloud_run-memory_service_uri","--memory_service_uri"],[0,0,1,"cmdoption-adk-deploy-cloud_run-reload","--no-reload"],[0,0,1,"cmdoption-adk-deploy-cloud_run-port","--port"],[0,0,1,"cmdoption-adk-deploy-cloud_run-project","--project"],[0,0,1,"cmdoption-adk-deploy-cloud_run-region","--region"],[0,0,1,"cmdoption-adk-deploy-cloud_run-reload","--reload"],[0,0,1,"cmdoption-adk-deploy-cloud_run-reload_agents","--reload_agents"],[0,0,1,"cmdoption-adk-deploy-cloud_run-service_name","--service_name"],[0,0,1,"cmdoption-adk-deploy-cloud_run-session_db_url","--session_db_url"],[0,0,1,"cmdoption-adk-deploy-cloud_run-session_service_uri","--session_service_uri"],[0,0,1,"cmdoption-adk-deploy-cloud_run-temp_folder","--temp_folder"],[0,0,1,"cmdoption-adk-deploy-cloud_run-trace_to_cloud","--trace_to_cloud"],[0,0,1,"cmdoption-adk-deploy-cloud_run-verbosity","--verbosity"],[0,0,1,"cmdoption-adk-deploy-cloud_run-with_ui","--with_ui"],[0,0,1,"cmdoption-adk-deploy-cloud_run-arg-AGENT","AGENT"]],"adk-eval":[[0,0,1,"cmdoption-adk-eval-config_file_path","--config_file_path"],[0,0,1,"cmdoption-adk-eval-eval_storage_uri","--eval_storage_uri"],[0,0,1,"cmdoption-adk-eval-print_detailed_results","--print_detailed_results"],[0,0,1,"cmdoption-adk-eval-arg-AGENT_MODULE_FILE_PATH","AGENT_MODULE_FILE_PATH"],[0,0,1,"cmdoption-adk-eval-arg-EVAL_SET_FILE_PATH","EVAL_SET_FILE_PATH"]],"adk-run":[[0,0,1,"cmdoption-adk-run-replay","--replay"],[0,0,1,"cmdoption-adk-run-resume","--resume"],[0,0,1,"cmdoption-adk-run-save_session","--save_session"],[0,0,1,"cmdoption-adk-run-session_id","--session_id"],[0,0,1,"cmdoption-adk-run-arg-AGENT","AGENT"]],"adk-web":[[0,0,1,"cmdoption-adk-web-a2a","--a2a"],[0,0,1,"cmdoption-adk-web-allow_origins","--allow_origins"],[0,0,1,"cmdoption-adk-web-artifact_service_uri","--artifact_service_uri"],[0,0,1,"cmdoption-adk-web-artifact_storage_uri","--artifact_storage_uri"],[0,0,1,"cmdoption-adk-web-eval_storage_uri","--eval_storage_uri"],[0,0,1,"cmdoption-adk-web-host","--host"],[0,0,1,"cmdoption-adk-web-log_level","--log_level"],[0,0,1,"cmdoption-adk-web-memory_service_uri","--memory_service_uri"],[0,0,1,"cmdoption-adk-web-reload","--no-reload"],[0,0,1,"cmdoption-adk-web-port","--port"],[0,0,1,"cmdoption-adk-web-reload","--reload"],[0,0,1,"cmdoption-adk-web-reload_agents","--reload_agents"],[0,0,1,"cmdoption-adk-web-session_db_url","--session_db_url"],[0,0,1,"cmdoption-adk-web-session_service_uri","--session_service_uri"],[0,0,1,"cmdoption-adk-web-trace_to_cloud","--trace_to_cloud"],[0,0,1,"cmdoption-adk-web-arg-AGENTS_DIR","AGENTS_DIR"]]},"objnames":{"0":["std","cmdoption","program option"]},"objtypes":{"0":"std:cmdoption"},"terms":{"":0,"0":0,"1":0,"12345":0,"127":0,"20":0,"7":0,"A":0,"And":0,"For":0,"If":0,"It":0,"Not":0,"The":0,"__init__":0,"a2a":0,"absent":0,"access":0,"add":[0,1],"addit":0,"adk":[],"adk_app":0,"adk_vers":0,"againt":0,"agent":0,"agent_engine_app":0,"agent_engine_resource_id":0,"agent_module_file_path":0,"agentengin":0,"agents_dir":0,"ai":0,"all":0,"allow":0,"allow_origin":0,"alreadi":0,"an":0,"ani":0,"api":0,"api_kei":0,"app":0,"app_nam":0,"applic":0,"ar":0,"arg":0,"argument":0,"artifact":0,"artifact_service_uri":0,"artifact_storage_uri":0,"auto":0,"backend":0,"bank":0,"bind":0,"bucket":0,"can":0,"cannot":0,"certain":0,"chang":0,"cloud":0,"code":0,"comma":0,"command":0,"config":0,"config_file_path":0,"connect":0,"consol":0,"contain":0,"content":0,"continu":0,"cor":0,"core":0,"critic":0,"current":0,"databas":0,"db":0,"debug":0,"default":0,"defin":0,"demarc":0,"deploy":0,"deprec":0,"descript":0,"detail":[0,1],"dev":0,"develop":0,"directori":0,"displai":0,"display_nam":0,"doc":0,"e":0,"each":0,"en":0,"enabl":0,"endpoint":0,"engin":0,"enter":0,"env":0,"env_fil":0,"environ":0,"error":0,"eval_1":0,"eval_2":0,"eval_3":0,"eval_set_file_path":0,"eval_storage_uri":0,"evalu":0,"exampl":0,"exist":0,"exit":0,"fals":0,"fastapi":0,"file":0,"filepath":0,"first":0,"folder":0,"from":0,"g":0,"gc":0,"gcloud":0,"gener":0,"given":0,"googl":0,"google_cloud_loc":0,"google_cloud_project":0,"host":0,"html":0,"http":0,"i":0,"id":0,"info":0,"initi":0,"instead":0,"interact":0,"its":0,"json":0,"kei":0,"kit":0,"later":0,"least":0,"level":0,"line":0,"list":0,"live":0,"log":0,"log_level":0,"memori":0,"memory_service_uri":0,"model":0,"modul":0,"more":0,"my_ag":0,"my_app":0,"name":0,"need":0,"new":0,"newli":0,"one":0,"onli":0,"option":0,"org":0,"origin":0,"overrid":0,"page":0,"path":0,"path_to_sqlite_fil":0,"port":0,"prepopul":0,"previou":0,"previous":0,"print":0,"print_detailed_result":0,"project":0,"prompt":0,"py":0,"python":0,"queri":0,"rag":0,"rag_corpus_id":0,"re":0,"refer":1,"region":0,"reload":0,"reload_ag":0,"remov":0,"replai":0,"requir":0,"requirements_fil":0,"restructuredtext":1,"result":0,"resum":0,"root":0,"root_ag":0,"sample_eval_set_fil":0,"save":0,"save_sess":0,"see":[0,1],"separ":0,"server":0,"servic":0,"service_nam":0,"session":0,"session_db_url":0,"session_id":0,"session_service_uri":0,"set":0,"show":0,"singl":0,"sourc":0,"specif":0,"specifi":0,"sqlalchemi":0,"sqlite":0,"stage":0,"staging_bucket":0,"start":0,"state":0,"storag":0,"store":0,"sub":0,"suffix":0,"support":0,"syntax":1,"system":0,"telemetri":0,"temp":0,"temp_fold":0,"templat":0,"thi":0,"timestamp":0,"tool":0,"trace":0,"trace_to_cloud":0,"true":0,"txt":0,"ui":0,"uri":0,"url":0,"us":[0,1],"user":0,"variabl":0,"verbos":0,"version":0,"vertex":0,"vertexai":0,"want":0,"warn":0,"when":0,"where":0,"whether":0,"with_ui":0,"you":0,"your":1},"titles":["CLI Reference","adk cli documentation"],"titleterms":{"adk":[0,1],"agent_engin":0,"api_serv":0,"cli":[0,1],"cloud_run":0,"content":1,"creat":0,"deploi":0,"document":1,"eval":0,"refer":0,"run":0,"web":0}})