veadk-python 0.2.14__tar.gz → 0.2.16__tar.gz

{veadk_python-0.2.14 → veadk_python-0.2.16}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: veadk-python
-Version: 0.2.14
+Version: 0.2.16
 Summary: Volcengine agent development kit, integrations with Volcengine cloud services.
 Author-email: Yaozheng Fang <fangyozheng@gmail.com>, Guodong Li <cu.eric.lee@gmail.com>, Zhi Han <sliverydayday@gmail.com>, Meng Wang <mengwangwm@gmail.com>
 License:                                  Apache License

{veadk_python-0.2.14 → veadk_python-0.2.16}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "veadk-python"
-version = "0.2.14"
+version = "0.2.16"
 description = "Volcengine agent development kit, integrations with Volcengine cloud services."
 readme = "README.md"
 requires-python = ">=3.10"

{veadk_python-0.2.14 → veadk_python-0.2.16}/tests/test_agent.py

@@ -88,7 +88,7 @@ def test_agent_default_values():
     assert agent.sub_agents == []
     assert agent.knowledgebase is None
     assert agent.long_term_memory is None
-    assert agent.tracers == []
+    # assert agent.tracers == []
 
 
 @patch.dict("os.environ", {"MODEL_AGENT_API_KEY": "mock_api_key"})

{veadk_python-0.2.14 → veadk_python-0.2.16}/tests/test_tracing.py

@@ -82,7 +82,7 @@ async def test_tracing():
     exporters = init_exporters()
     tracer = OpentelemetryTracer(exporters=exporters)
 
-    assert len(tracer.exporters) == 3
+    assert len(tracer.exporters) == 4  # with extra 1 built-in exporters
 
     # TODO: Ensure the tracing provider is set correctly after loading SDK
 
@@ -98,7 +98,7 @@ async def test_tracing_with_global_provider():
     #
     tracer = OpentelemetryTracer(exporters=exporters)
 
-    assert len(tracer.exporters) == 3  # with extra 1 built-in exporters
+    assert len(tracer.exporters) == 4  # with extra 1 built-in exporters
 
 
 @pytest.mark.asyncio
@@ -112,5 +112,5 @@ async def test_tracing_with_apmplus_global_provider():
     # init OpentelemetryTracer
     tracer = OpentelemetryTracer(exporters=exporters)
 
-    # apmplus exporter won't init again
-    assert len(tracer.exporters) == 2  # with extra 1 built-in exporters
+    # apmplus exporter won't init again, so there are cozeloop, tls, in_memory exporter
+    assert len(tracer.exporters) == 3  # with extra 1 built-in exporters

{veadk_python-0.2.14 → veadk_python-0.2.16}/veadk/agent.py

@@ -14,6 +14,7 @@
 
 from __future__ import annotations
 
+import os
 from typing import Optional, Union
 
 from google.adk.agents import LlmAgent, RunConfig
@@ -132,6 +133,8 @@ class Agent(LlmAgent):
                 "You are trying to use your own LiteLLM client, some default request headers may be missing."
             )
 
+        self._prepare_tracers()
+
         if self.knowledgebase:
             from veadk.tools.builtin_tools.load_knowledgebase import (
                 LoadKnowledgebaseTool,
@@ -194,6 +197,42 @@ class Agent(LlmAgent):
 
         return final_output
 
+    def _prepare_tracers(self):
+        enable_apmplus_tracer = os.getenv("ENABLE_APMPLUS", "false").lower() == "true"
+        enable_cozeloop_tracer = os.getenv("ENABLE_COZELOOP", "false").lower() == "true"
+        enable_tls_tracer = os.getenv("ENABLE_TLS", "false").lower() == "true"
+
+        if not self.tracers:
+            from veadk.tracing.telemetry.opentelemetry_tracer import OpentelemetryTracer
+
+            self.tracers.append(OpentelemetryTracer())
+
+        exporters = self.tracers[0].exporters  # type: ignore
+
+        from veadk.tracing.telemetry.exporters.apmplus_exporter import APMPlusExporter
+        from veadk.tracing.telemetry.exporters.cozeloop_exporter import CozeloopExporter
+        from veadk.tracing.telemetry.exporters.tls_exporter import TLSExporter
+
+        if enable_apmplus_tracer and not any(
+            isinstance(e, APMPlusExporter) for e in exporters
+        ):
+            self.tracers[0].exporters.append(APMPlusExporter())  # type: ignore
+            logger.info("Enable APMPlus exporter by env.")
+
+        if enable_cozeloop_tracer and not any(
+            isinstance(e, CozeloopExporter) for e in exporters
+        ):
+            self.tracers[0].exporters.append(CozeloopExporter())  # type: ignore
+            logger.info("Enable CozeLoop exporter by env.")
+
+        if enable_tls_tracer and not any(isinstance(e, TLSExporter) for e in exporters):
+            self.tracers[0].exporters.append(TLSExporter())  # type: ignore
+            logger.info("Enable TLS exporter by env.")
+
+        logger.debug(
+            f"Opentelemetry Tracer init {len(self.tracers[0].exporters)} exporters"  # type: ignore
+        )
+
     async def run(
         self,
         prompt: str | list[str],

{veadk_python-0.2.14 → veadk_python-0.2.16}/veadk/cli/cli_create.py

@@ -16,26 +16,8 @@ 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
+_ENV_TEMPLATE = """\
+MODEL_AGENT_API_KEY={ark_api_key}
 """
 
 _INIT_PY_TEMPLATE = """\
@@ -49,16 +31,17 @@ root_agent = Agent(
     name="root_agent",
     description="A helpful assistant for user questions.",
     instruction="Answer user questions to the best of your knowledge",
+    model_name="doubao-seed-1-6-251015", # <---- you can change your model here
 )
 """
 
 _SUCCESS_MSG = """\
-Agent '{agent_name}' created successfully at '{agent_folder}':
-- config.yaml
-- {agent_name}/__init__.py
-- {agent_name}/agent.py
+Agent created in {agent_folder}:
+- .env
+- __init__.py
+- agent.py
 
-You can run the agent by executing: cd {agent_name} && veadk web
+You can run the agent by executing: veadk web
 """
 
 
@@ -69,37 +52,34 @@ def _prompt_for_ark_api_key() -> str:
     )
     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.")
+    click.echo("  2. Configure it later in the generated .env 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"
-        )
+        click.secho("You can set the `api_key` in the .env 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"
+def _generate_files(ark_api_key: str, target_dir_path: Path) -> None:
+    target_dir_path.mkdir(exist_ok=True)
+    env_path = target_dir_path / ".env"
+    init_file_path = target_dir_path / "__init__.py"
+    agent_file_path = target_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)
+    env_content = _ENV_TEMPLATE.format(ark_api_key=ark_api_key)
+    env_path.write_text(env_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),
+        _SUCCESS_MSG.format(agent_folder=target_dir_path),
         fg="green",
     )
 
 
 @click.command()
-@click.option("--agent-name", help="The name of the agent.")
+@click.argument("agent_name", required=False)
 @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."""
@@ -119,4 +99,4 @@ def create(agent_name: str, ark_api_key: str) -> None:
             return
         shutil.rmtree(target_dir_path)
 
-    _generate_files(agent_name, ark_api_key, target_dir_path)
+    _generate_files(ark_api_key, target_dir_path)

veadk_python-0.2.16/veadk/cli/cli_web.py

@@ -0,0 +1,112 @@
+# 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.
+
+from functools import wraps
+
+import click
+
+from veadk.utils.logger import get_logger
+
+logger = get_logger(__name__)
+
+
+def patch_adkwebserver_disable_openapi():
+    """
+    Monkey patch AdkWebServer.get_fast_api to remove openapi.json route.
+    """
+    import google.adk.cli.adk_web_server
+    from fastapi.routing import APIRoute
+    from starlette.routing import Route
+
+    original_get_fast_api = google.adk.cli.adk_web_server.AdkWebServer.get_fast_api_app
+
+    def wrapped_get_fast_api(self, *args, **kwargs):
+        app = original_get_fast_api(self, *args, **kwargs)
+
+        paths = ["/openapi.json", "/docs", "/redoc"]
+        new_routes = []
+        for route in app.router.routes:
+            if isinstance(route, (APIRoute, Route)) and route.path in paths:
+                continue
+            new_routes.append(route)
+        app.router.routes = new_routes
+
+        return app
+
+    google.adk.cli.adk_web_server.AdkWebServer.get_fast_api_app = wrapped_get_fast_api
+
+
+@click.command(
+    context_settings=dict(ignore_unknown_options=True, allow_extra_args=True)
+)
+@click.pass_context
+def web(ctx, *args, **kwargs) -> None:
+    """Launch web with long term and short term memory."""
+    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
+    )
+
+    patch_adkwebserver_disable_openapi()
+
+    from google.adk.cli.cli_tools_click import cli_web
+
+    extra_args = ctx.args
+    logger.debug(f"User args: {ctx.args}")
+    cli_web.main(args=extra_args, standalone_mode=False)

{veadk_python-0.2.14 → veadk_python-0.2.16}/veadk/config.py

@@ -15,7 +15,7 @@
 import os
 from typing import Any
 
-from dotenv import find_dotenv
+from dotenv import find_dotenv, load_dotenv
 from pydantic import BaseModel, Field
 
 from veadk.configs.database_configs import (
@@ -33,8 +33,16 @@ from veadk.configs.tracing_configs import (
     PrometheusConfig,
     TLSConfig,
 )
+from veadk.utils.logger import get_logger
 from veadk.utils.misc import set_envs
 
+logger = get_logger(__name__)
+
+if load_dotenv(find_dotenv(usecwd=True)):
+    logger.info(f"Find `.env` file in {find_dotenv(usecwd=True)}, load envs.")
+else:
+    logger.info("No env file found.")
+
 
 class VeADKConfig(BaseModel):
     model: ModelConfig = Field(default_factory=ModelConfig)
@@ -89,7 +97,10 @@ config_yaml_path = find_dotenv(filename="config.yaml", usecwd=True)
 veadk_environments = {}
 
 if config_yaml_path:
+    logger.info(f"Find `config.yaml` file in {config_yaml_path}")
     config_dict, _veadk_environments = set_envs(config_yaml_path=config_yaml_path)
     veadk_environments.update(_veadk_environments)
+else:
+    logger.warning("No `config.yaml` file found.")
 
 settings = VeADKConfig()

veadk_python-0.2.16/veadk/tools/builtin_tools/generate_image.py

@@ -0,0 +1,23 @@
+# 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.
+
+from veadk.tools.builtin_tools.image_generate import image_generate  # noqa: F401
+from veadk.utils.logger import get_logger
+
+logger = get_logger(__name__)
+
+
+logger.warning(
+    "The 'generate_image' tool is deprecated and will be removed in future versions. Use `image_generate` tool from `veadk.tools.builtin_tools.image_generate` instead."
+)

{veadk_python-0.2.14 → veadk_python-0.2.16}/veadk/tools/builtin_tools/run_code.py

@@ -42,6 +42,10 @@ def run_code(code: str, language: str, tool_context: ToolContext) -> str:
     region = getenv("AGENTKIT_TOOL_REGION", "cn-beijing")
 
     session_id = tool_context._invocation_context.session.id
+    agent_name = tool_context._invocation_context.agent.name
+    user_id = tool_context._invocation_context.user_id
+    tool_user_session_id = agent_name + "_" + user_id + "_" + session_id
+    logger.debug(f"tool_user_session_id: {tool_user_session_id}")
 
     logger.debug(
         f"Running code in language: {language}, session_id={session_id}, code={code}, tool_id={tool_id}, host={host}, service={service}, region={region}"
@@ -53,7 +57,7 @@ def run_code(code: str, language: str, tool_context: ToolContext) -> str:
     res = ve_request(
         request_body={
             "ToolId": tool_id,
-            "UserSessionId": session_id,
+            "UserSessionId": tool_user_session_id,
             "OperationType": "RunCode",
             "OperationPayload": json.dumps(
                 {

{veadk_python-0.2.14 → veadk_python-0.2.16}/veadk/tracing/telemetry/opentelemetry_tracer.py

@@ -21,7 +21,7 @@ from typing import Any
 from opentelemetry import trace as trace_api
 from opentelemetry.sdk import trace as trace_sdk
 from opentelemetry.sdk.resources import Resource
-from opentelemetry.sdk.trace import TracerProvider, SpanLimits
+from opentelemetry.sdk.trace import SpanLimits, TracerProvider
 from opentelemetry.sdk.trace.export import BatchSpanProcessor, SimpleSpanProcessor
 from pydantic import BaseModel, ConfigDict, Field, field_validator
 from typing_extensions import override
@@ -31,8 +31,8 @@ from veadk.tracing.telemetry.exporters.apmplus_exporter import APMPlusExporter
 from veadk.tracing.telemetry.exporters.base_exporter import BaseExporter
 from veadk.tracing.telemetry.exporters.inmemory_exporter import InMemoryExporter
 from veadk.utils.logger import get_logger
-from veadk.utils.patches import patch_google_adk_telemetry
 from veadk.utils.misc import get_temp_dir
+from veadk.utils.patches import patch_google_adk_telemetry
 
 logger = get_logger(__name__)
 
@@ -131,12 +131,15 @@ class OpentelemetryTracer(BaseModel, BaseTracer):
             ) + global_tracer_provider._active_span_processor._span_processors
 
             self._processors.append(self._inmemory_exporter.processor)
+            self.exporters.append(self._inmemory_exporter)
         else:
             logger.warning(
                 "InMemoryExporter processor is not initialized, cannot add to OpentelemetryTracer."
             )
 
-        logger.info(f"Init OpentelemetryTracer with {len(self._processors)} exporters.")
+        logger.info(
+            f"Init OpentelemetryTracer with {len(self._processors)} exporter(s)."
+        )
 
     @property
     def trace_file_path(self) -> str:

{veadk_python-0.2.14 → veadk_python-0.2.16}/veadk/utils/misc.py

@@ -128,6 +128,10 @@ def getenv(
 
 
 def set_envs(config_yaml_path: str) -> tuple[dict, dict]:
+    from veadk.utils.logger import get_logger
+
+    logger = get_logger(__name__)
+
     with open(config_yaml_path, "r", encoding="utf-8") as yaml_file:
         config_dict = safe_load(yaml_file)
 
@@ -138,6 +142,9 @@ def set_envs(config_yaml_path: str) -> tuple[dict, dict]:
         k = k.upper()
 
         if k in os.environ:
+            logger.info(
+                f"Environment variable {k} has been set, value in `config.yaml` will be ignored."
+            )
             veadk_environments[k] = os.environ[k]
             continue
         veadk_environments[k] = str(v)

{veadk_python-0.2.14 → veadk_python-0.2.16}/veadk/version.py

@@ -12,4 +12,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-VERSION = "0.2.14"
+VERSION = "0.2.16"

{veadk_python-0.2.14 → veadk_python-0.2.16}/veadk_python.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: veadk-python
-Version: 0.2.14
+Version: 0.2.16
 Summary: Volcengine agent development kit, integrations with Volcengine cloud services.
 Author-email: Yaozheng Fang <fangyozheng@gmail.com>, Guodong Li <cu.eric.lee@gmail.com>, Zhi Han <sliverydayday@gmail.com>, Meng Wang <mengwangwm@gmail.com>
 License:                                  Apache License

{veadk_python-0.2.14 → veadk_python-0.2.16}/veadk_python.egg-info/SOURCES.txt

@@ -157,6 +157,7 @@ veadk/tools/__init__.py
 veadk/tools/demo_tools.py
 veadk/tools/load_knowledgebase_tool.py
 veadk/tools/builtin_tools/__init__.py
+veadk/tools/builtin_tools/generate_image.py
 veadk/tools/builtin_tools/image_edit.py
 veadk/tools/builtin_tools/image_generate.py
 veadk/tools/builtin_tools/lark.py