veadk-python 0.2.13__py3-none-any.whl → 0.2.15__py3-none-any.whl

veadk/cli/cli.py

@@ -18,6 +18,7 @@ import click
 from veadk.cli.cli_deploy import deploy
 from veadk.cli.cli_eval import eval
 from veadk.cli.cli_init import init
+from veadk.cli.cli_create import create
 from veadk.cli.cli_kb import kb
 from veadk.cli.cli_pipeline import pipeline
 from veadk.cli.cli_prompt import prompt
@@ -37,6 +38,7 @@ def veadk():
 
 veadk.add_command(deploy)
 veadk.add_command(init)
+veadk.add_command(create)
 veadk.add_command(prompt)
 veadk.add_command(web)
 veadk.add_command(pipeline)

veadk/cli/cli_create.py

@@ -0,0 +1,122 @@
+# Copyright (c) 2025 Beijing Volcano Engine Technology Co., Ltd. and/or its affiliates.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import click
+import shutil
+from pathlib import Path
+
+_CONFIG_YAML_TEMPLATE = """\
+model:
+  agent:
+    name: doubao-seed-1-6-251015
+    api_key: {ark_api_key}
+  video:
+    name: doubao-seedance-1-0-pro-250528
+    # if you want to use different api_key, just uncomment following line and complete api_key
+    # api_key: 
+  image:
+    name: doubao-seedream-4-0-250828
+    # if you want to use different api_key, just uncomment following line and complete api_key
+    # api_key: 
+
+logging:
+  # ERROR
+  # WARNING
+  # INFO
+  # DEBUG
+  level: DEBUG
+"""
+
+_INIT_PY_TEMPLATE = """\
+from . import agent
+"""
+
+_AGENT_PY_TEMPLATE = """\
+from veadk import Agent
+
+root_agent = Agent(
+    name="root_agent",
+    description="A helpful assistant for user questions.",
+    instruction="Answer user questions to the best of your knowledge",
+)
+"""
+
+_SUCCESS_MSG = """\
+Agent '{agent_name}' created successfully at '{agent_folder}':
+- config.yaml
+- {agent_name}/__init__.py
+- {agent_name}/agent.py
+
+You can run the agent by executing: cd {agent_name} && veadk web
+"""
+
+
+def _prompt_for_ark_api_key() -> str:
+    click.secho(
+        "An API key is required to run the agent. See https://www.volcengine.com/docs/82379/1541594 for details.",
+        fg="green",
+    )
+    click.echo("You have two options:")
+    click.echo("  1. Enter the API key now.")
+    click.echo("  2. Configure it later in the generated config.yaml file.")
+    choice = click.prompt("Please select an option", type=click.Choice(["1", "2"]))
+    if choice == "1":
+        return click.prompt("Please enter your ARK API key")
+    else:
+        click.secho(
+            "You can set the `api_key` in the config.yaml file later.", fg="yellow"
+        )
+        return ""
+
+
+def _generate_files(agent_name: str, ark_api_key: str, target_dir_path: Path) -> None:
+    agent_dir_path = target_dir_path / agent_name
+    agent_dir_path.mkdir(parents=True, exist_ok=True)
+    config_yaml_path = target_dir_path / "config.yaml"
+    init_file_path = agent_dir_path / "__init__.py"
+    agent_file_path = agent_dir_path / "agent.py"
+
+    config_yaml_content = _CONFIG_YAML_TEMPLATE.format(ark_api_key=ark_api_key)
+    config_yaml_path.write_text(config_yaml_content)
+    init_file_path.write_text(_INIT_PY_TEMPLATE)
+    agent_file_path.write_text(_AGENT_PY_TEMPLATE)
+
+    click.secho(
+        _SUCCESS_MSG.format(agent_name=agent_name, agent_folder=target_dir_path),
+        fg="green",
+    )
+
+
+@click.command()
+@click.option("--agent-name", help="The name of the agent.")
+@click.option("--ark-api-key", help="The ARK API key.")
+def create(agent_name: str, ark_api_key: str) -> None:
+    """Creates a new agent in the current folder with prepopulated agent template."""
+    if not agent_name:
+        agent_name = click.prompt("Enter the agent name")
+    if not ark_api_key:
+        ark_api_key = _prompt_for_ark_api_key()
+
+    cwd = Path.cwd()
+    target_dir_path = cwd / agent_name
+
+    if target_dir_path.exists() and any(target_dir_path.iterdir()):
+        if not click.confirm(
+            f"Directory '{target_dir_path}' already exists and is not empty. Do you want to overwrite it?"
+        ):
+            click.secho("Operation cancelled.", fg="red")
+            return
+        shutil.rmtree(target_dir_path)
+
+    _generate_files(agent_name, ark_api_key, target_dir_path)

veadk/cli/cli_web.py

@@ -12,99 +12,13 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-from typing import Optional
+from functools import wraps
 
 import click
 
-from veadk.memory.long_term_memory import LongTermMemory
-from veadk.memory.short_term_memory import ShortTermMemory
+from veadk.utils.logger import get_logger
 
-
-def _get_stm_from_module(module) -> ShortTermMemory:
-    return module.agent_run_config.short_term_memory
-
-
-def _get_stm_from_env() -> ShortTermMemory:
-    import os
-
-    from veadk.utils.logger import get_logger
-
-    logger = get_logger(__name__)
-
-    short_term_memory_backend = os.getenv("SHORT_TERM_MEMORY_BACKEND")
-    if not short_term_memory_backend:  # prevent None or empty string
-        short_term_memory_backend = "local"
-    logger.info(f"Short term memory: backend={short_term_memory_backend}")
-
-    return ShortTermMemory(backend=short_term_memory_backend)  # type: ignore
-
-
-def _get_ltm_from_module(module) -> LongTermMemory | None:
-    agent = module.agent_run_config.agent
-
-    if not hasattr(agent, "long_term_memory"):
-        return None
-    else:
-        return agent.long_term_memory
-
-
-def _get_ltm_from_env() -> LongTermMemory | None:
-    import os
-
-    from veadk.utils.logger import get_logger
-
-    logger = get_logger(__name__)
-
-    long_term_memory_backend = os.getenv("LONG_TERM_MEMORY_BACKEND")
-    app_name = os.getenv("VEADK_WEB_APP_NAME", "")
-    user_id = os.getenv("VEADK_WEB_USER_ID", "")
-
-    if long_term_memory_backend:
-        logger.info(f"Long term memory: backend={long_term_memory_backend}")
-        return LongTermMemory(
-            backend=long_term_memory_backend, app_name=app_name, user_id=user_id
-        )  # type: ignore
-    else:
-        logger.warning("No long term memory backend settings detected.")
-        return None
-
-
-def _get_memory(
-    module_path: str,
-) -> tuple[ShortTermMemory, LongTermMemory | None]:
-    from veadk.utils.logger import get_logger
-    from veadk.utils.misc import load_module_from_file
-
-    logger = get_logger(__name__)
-
-    # 1. load user module
-    try:
-        module_file_path = module_path
-        module = load_module_from_file(
-            module_name="agent_and_mem", file_path=f"{module_file_path}/agent.py"
-        )
-    except Exception as e:
-        logger.error(
-            f"Failed to get memory config from `agent.py`: {e}. Fallback to get memory from environment variables."
-        )
-        return _get_stm_from_env(), _get_ltm_from_env()
-
-    if not hasattr(module, "agent_run_config"):
-        logger.error(
-            "You must export `agent_run_config` as a global variable in `agent.py`. Fallback to get memory from environment variables."
-        )
-        return _get_stm_from_env(), _get_ltm_from_env()
-
-    # 2. try to get short term memory
-    # short term memory must exist in user code, as we use `default_factory` to init it
-    short_term_memory = _get_stm_from_module(module)
-
-    # 3. try to get long term memory
-    long_term_memory = _get_ltm_from_module(module)
-    if not long_term_memory:
-        long_term_memory = _get_ltm_from_env()
-
-    return short_term_memory, long_term_memory
+logger = get_logger(__name__)
 
 
 def patch_adkwebserver_disable_openapi():
@@ -133,71 +47,66 @@ def patch_adkwebserver_disable_openapi():
     google.adk.cli.adk_web_server.AdkWebServer.get_fast_api_app = wrapped_get_fast_api
 
 
-@click.command()
-@click.option("--host", default="127.0.0.1", help="Host to run the web server on")
-@click.option(
-    "--app_name", default="", help="The `app_name` for initializing long term memory"
-)
-@click.option(
-    "--user_id", default="", help="The `user_id` for initializing long term memory"
+@click.command(
+    context_settings=dict(ignore_unknown_options=True, allow_extra_args=True)
 )
-def web(host: str, app_name: str, user_id: str) -> None:
+@click.pass_context
+def web(ctx, *args, **kwargs) -> None:
     """Launch web with long term and short term memory."""
-    import os
-    from typing import Any
-
-    from google.adk.cli.utils.shared_value import SharedValue
-
-    from veadk.utils.logger import get_logger
-
-    logger = get_logger(__name__)
-
-    def init_for_veadk(
-        self,
-        *,
-        agent_loader: Any,
-        session_service: Any,
-        memory_service: Any,
-        artifact_service: Any,
-        credential_service: Any,
-        eval_sets_manager: Any,
-        eval_set_results_manager: Any,
-        agents_dir: str,
-        extra_plugins: Optional[list[str]] = None,
-        **kwargs: Any,
-    ):
-        self.agent_loader = agent_loader
-        self.artifact_service = artifact_service
-        self.credential_service = credential_service
-        self.eval_sets_manager = eval_sets_manager
-        self.eval_set_results_manager = eval_set_results_manager
-        self.agents_dir = agents_dir
-        self.runners_to_clean = set()
-        self.current_app_name_ref = SharedValue(value="")
-        self.runner_dict = {}
-        self.extra_plugins = extra_plugins or []
-
-        for key, value in kwargs.items():
-            setattr(self, key, value)
-
-        # parse VeADK memories
-        short_term_memory, long_term_memory = _get_memory(module_path=agents_dir)
-        self.session_service = short_term_memory.session_service
-        self.memory_service = long_term_memory
-
-    os.environ["VEADK_WEB_APP_NAME"] = app_name
-    os.environ["VEADK_WEB_USER_ID"] = user_id
-
-    import google.adk.cli.adk_web_server
+    from google.adk.cli import adk_web_server
+    from google.adk.runners import Runner as ADKRunner
+
+    from veadk import Agent
+    from veadk.agents.loop_agent import LoopAgent
+    from veadk.agents.parallel_agent import ParallelAgent
+    from veadk.agents.sequential_agent import SequentialAgent
+
+    def before_get_runner_async(func):
+        logger.info("Hook before `get_runner_async`")
+
+        @wraps(func)
+        async def wrapper(*args, **kwargs) -> ADKRunner:
+            self: adk_web_server.AdkWebServer = args[0]
+            app_name: str = args[1]
+            """Returns the cached runner for the given app."""
+            agent_or_app = self.agent_loader.load_agent(app_name)
+
+            if isinstance(agent_or_app, (SequentialAgent, LoopAgent, ParallelAgent)):
+                logger.warning(
+                    "Detect VeADK workflow agent, the short-term memory and long-term memory of each sub agent are useless."
+                )
+
+            if isinstance(agent_or_app, Agent):
+                logger.info("Detect VeADK Agent.")
+
+                if agent_or_app.short_term_memory:
+                    self.session_service = (
+                        agent_or_app.short_term_memory.session_service
+                    )
+
+                if agent_or_app.long_term_memory:
+                    self.memory_service = agent_or_app.long_term_memory
+                    logger.info(
+                        f"Long term memory backend is {self.memory_service.backend}"
+                    )
+
+                logger.info(
+                    f"Current session_service={self.session_service.__class__.__name__}, memory_service={self.memory_service.__class__.__name__}"
+                )
+
+            runner = await func(*args, **kwargs)
+            return runner
+
+        return wrapper
+
+    adk_web_server.AdkWebServer.get_runner_async = before_get_runner_async(
+        adk_web_server.AdkWebServer.get_runner_async
+    )
 
-    google.adk.cli.adk_web_server.AdkWebServer.__init__ = init_for_veadk
     patch_adkwebserver_disable_openapi()
 
-    import google.adk.cli.cli_tools_click as cli_tools_click
-
-    agents_dir = os.getcwd()
-    logger.info(f"Load agents from {agents_dir}")
+    from google.adk.cli.cli_tools_click import cli_web
 
-    cli_tools_click.cli_web.main(
-        args=[agents_dir, "--host", host, "--log_level", "ERROR"]
-    )
+    extra_args = ctx.args
+    logger.debug(f"User args: {ctx.args}")
+    cli_web.main(args=extra_args, standalone_mode=False)

veadk/consts.py

@@ -62,9 +62,6 @@ DEFAULT_TOS_BUCKET_NAME = "ark-tutorial"
 
 DEFAULT_COZELOOP_SPACE_NAME = "VeADK Space"
 
-DEFAULT_TEXT_TO_IMAGE_MODEL_NAME = "doubao-seedream-3-0-t2i-250415"
-DEFAULT_TEXT_TO_IMAGE_MODEL_API_BASE = "https://ark.cn-beijing.volces.com/api/v3/"
-
 DEFAULT_IMAGE_EDIT_MODEL_NAME = "doubao-seededit-3-0-i2i-250628"
 DEFAULT_IMAGE_EDIT_MODEL_API_BASE = "https://ark.cn-beijing.volces.com/api/v3/"