veadk-python 0.2.2__py3-none-any.whl → 0.2.5__py3-none-any.whl

veadk/agent.py

@@ -28,9 +28,10 @@ from typing_extensions import Any
 
 from veadk.config import getenv
 from veadk.consts import (
-    DEFALUT_MODEL_AGENT_PROVIDER,
+    DEFAULT_MODEL_AGENT_PROVIDER,
     DEFAULT_MODEL_AGENT_API_BASE,
     DEFAULT_MODEL_AGENT_NAME,
+    DEFAULT_MODEL_EXTRA_HEADERS,
 )
 from veadk.evaluation import EvalSetRecorder
 from veadk.knowledgebase import KnowledgeBase
@@ -40,6 +41,7 @@ from veadk.prompts.agent_default_prompt import DEFAULT_DESCRIPTION, DEFAULT_INST
 from veadk.tracing.base_tracer import BaseTracer
 from veadk.utils.logger import get_logger
 from veadk.utils.patches import patch_asyncio
+from veadk.version import VERSION
 
 patch_asyncio()
 logger = get_logger(__name__)
@@ -60,11 +62,10 @@ class Agent(LlmAgent):
     instruction: str = DEFAULT_INSTRUCTION
     """The instruction for the agent, such as principles of function calling."""
 
-    # factory
     model_name: str = getenv("MODEL_AGENT_NAME", DEFAULT_MODEL_AGENT_NAME)
     """The name of the model for agent running."""
 
-    model_provider: str = getenv("MODEL_AGENT_PROVIDER", DEFALUT_MODEL_AGENT_PROVIDER)
+    model_provider: str = getenv("MODEL_AGENT_PROVIDER", DEFAULT_MODEL_AGENT_PROVIDER)
     """The provider of the model for agent running."""
 
     model_api_base: str = getenv("MODEL_AGENT_API_BASE", DEFAULT_MODEL_AGENT_API_BASE)
@@ -73,6 +74,9 @@ class Agent(LlmAgent):
     model_api_key: str = Field(default_factory=lambda: getenv("MODEL_AGENT_API_KEY"))
     """The api key of the model for agent running."""
 
+    model_extra_config: dict = Field(default_factory=dict)
+    """The extra config to include in the model requests."""
+
     tools: list[ToolUnion] = []
     """The tools provided to agent."""
 
@@ -96,11 +100,27 @@ class Agent(LlmAgent):
 
     def model_post_init(self, __context: Any) -> None:
         super().model_post_init(None)  # for sub_agents init
-        self.model = LiteLlm(
-            model=f"{self.model_provider}/{self.model_name}",
-            api_key=self.model_api_key,
-            api_base=self.model_api_base,
-        )
+
+        # add model request source (veadk) in extra headers
+        if self.model_extra_config and "extra_headers" in self.model_extra_config:
+            self.model_extra_config["extra_headers"] |= DEFAULT_MODEL_EXTRA_HEADERS
+        else:
+            self.model_extra_config["extra_headers"] = DEFAULT_MODEL_EXTRA_HEADERS
+
+        if not self.model:
+            self.model = LiteLlm(
+                model=f"{self.model_provider}/{self.model_name}",
+                api_key=self.model_api_key,
+                api_base=self.model_api_base,
+                **self.model_extra_config,
+            )
+            logger.debug(
+                f"LiteLLM client created with config: {self.model_extra_config}"
+            )
+        else:
+            logger.warning(
+                "You are trying to use your own LiteLLM client, some default request headers may be missing."
+            )
 
         if self.knowledgebase:
             from veadk.tools import load_knowledgebase_tool
@@ -113,18 +133,11 @@ class Agent(LlmAgent):
 
             self.tools.append(load_memory)
 
-        if self.tracers:
-            self.before_model_callback = []
-            self.after_model_callback = []
-            self.after_tool_callback = []
-            for tracer in self.tracers:
-                self.before_model_callback.append(tracer.tracer_hook_before_model)
-                self.after_model_callback.append(tracer.tracer_hook_after_model)
-                self.after_tool_callback.append(tracer.tracer_hook_after_tool)
+        logger.info(f"VeADK version: {VERSION}")
 
-        logger.info(f"Agent `{self.name}` init done.")
+        logger.info(f"{self.__class__.__name__} `{self.name}` init done.")
         logger.debug(
-            f"Agent: {self.model_dump(include={'name', 'model_name', 'model_api_base', 'tools', 'serve_url'})}"
+            f"Agent: {self.model_dump(include={'name', 'model_name', 'model_api_base', 'tools'})}"
         )
 
     async def _run(
@@ -221,9 +234,6 @@ class Agent(LlmAgent):
             session_service=session_service,
             memory_service=self.long_term_memory,
         )
-        if getattr(self, "tracers", None):
-            for tracer in self.tracers:
-                tracer.set_app_name(app_name)
 
         logger.info(f"Begin to process prompt {prompt}")
         # run

veadk/agents/loop_agent.py

@@ -0,0 +1,55 @@
+# 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 __future__ import annotations
+
+from google.adk.agents import LoopAgent as GoogleADKLoopAgent
+from google.adk.agents.base_agent import BaseAgent
+from pydantic import ConfigDict, Field
+from typing_extensions import Any
+
+from veadk.prompts.agent_default_prompt import DEFAULT_DESCRIPTION, DEFAULT_INSTRUCTION
+from veadk.tracing.base_tracer import BaseTracer
+from veadk.utils.logger import get_logger
+from veadk.utils.patches import patch_asyncio
+
+patch_asyncio()
+logger = get_logger(__name__)
+
+
+class LoopAgent(GoogleADKLoopAgent):
+    """Loop Agent with Volcengine capabilities."""
+
+    model_config = ConfigDict(arbitrary_types_allowed=True, extra="allow")
+    """The model config"""
+
+    name: str = "veLoopAgent"
+    """The name of the agent."""
+
+    description: str = DEFAULT_DESCRIPTION
+    """The description of the agent. This will be helpful in A2A scenario."""
+
+    instruction: str = DEFAULT_INSTRUCTION
+    """The instruction for the agent, such as principles of function calling."""
+
+    sub_agents: list[BaseAgent] = Field(default_factory=list, exclude=True)
+    """The sub agents provided to agent."""
+
+    tracers: list[BaseTracer] = []
+    """The tracers provided to agent."""
+
+    def model_post_init(self, __context: Any) -> None:
+        super().model_post_init(None)  # for sub_agents init
+
+        logger.info(f"{self.__class__.__name__} `{self.name}` init done.")

veadk/agents/parallel_agent.py

@@ -0,0 +1,60 @@
+# 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 __future__ import annotations
+
+from google.adk.agents import ParallelAgent as GoogleADKParallelAgent
+from google.adk.agents.base_agent import BaseAgent
+from pydantic import ConfigDict, Field
+from typing_extensions import Any
+
+from veadk.prompts.agent_default_prompt import DEFAULT_DESCRIPTION, DEFAULT_INSTRUCTION
+from veadk.tracing.base_tracer import BaseTracer
+from veadk.utils.logger import get_logger
+from veadk.utils.patches import patch_asyncio
+
+patch_asyncio()
+logger = get_logger(__name__)
+
+
+class ParallelAgent(GoogleADKParallelAgent):
+    """LLM-based Agent with Volcengine capabilities."""
+
+    model_config = ConfigDict(arbitrary_types_allowed=True, extra="allow")
+    """The model config"""
+
+    name: str = "veParallelAgent"
+    """The name of the agent."""
+
+    description: str = DEFAULT_DESCRIPTION
+    """The description of the agent. This will be helpful in A2A scenario."""
+
+    instruction: str = DEFAULT_INSTRUCTION
+    """The instruction for the agent, such as principles of function calling."""
+
+    sub_agents: list[BaseAgent] = Field(default_factory=list, exclude=True)
+    """The sub agents provided to agent."""
+
+    tracers: list[BaseTracer] = []
+    """The tracers provided to agent."""
+
+    def model_post_init(self, __context: Any) -> None:
+        super().model_post_init(None)  # for sub_agents init
+
+        if self.tracers:
+            logger.warning(
+                "Enable tracing in ParallelAgent may cause OpenTelemetry context error. Issue see https://github.com/google/adk-python/issues/1670"
+            )
+
+        logger.info(f"{self.__class__.__name__} `{self.name}` init done.")

veadk/agents/sequential_agent.py

@@ -0,0 +1,55 @@
+# 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 __future__ import annotations
+
+from google.adk.agents import SequentialAgent as GoogleADKSequentialAgent
+from google.adk.agents.base_agent import BaseAgent
+from pydantic import ConfigDict, Field
+from typing_extensions import Any
+
+from veadk.prompts.agent_default_prompt import DEFAULT_DESCRIPTION, DEFAULT_INSTRUCTION
+from veadk.tracing.base_tracer import BaseTracer
+from veadk.utils.logger import get_logger
+from veadk.utils.patches import patch_asyncio
+
+patch_asyncio()
+logger = get_logger(__name__)
+
+
+class SequentialAgent(GoogleADKSequentialAgent):
+    """Sequential Agent with Volcengine capabilities."""
+
+    model_config = ConfigDict(arbitrary_types_allowed=True, extra="allow")
+    """The model config"""
+
+    name: str = "veSequentialAgent"
+    """The name of the agent."""
+
+    description: str = DEFAULT_DESCRIPTION
+    """The description of the agent. This will be helpful in A2A scenario."""
+
+    instruction: str = DEFAULT_INSTRUCTION
+    """The instruction for the agent, such as principles of function calling."""
+
+    sub_agents: list[BaseAgent] = Field(default_factory=list, exclude=True)
+    """The sub agents provided to agent."""
+
+    tracers: list[BaseTracer] = []
+    """The tracers provided to agent."""
+
+    def model_post_init(self, __context: Any) -> None:
+        super().model_post_init(None)  # for sub_agents init
+
+        logger.info(f"{self.__class__.__name__} `{self.name}` init done.")

veadk/cli/cli_deploy.py

@@ -29,7 +29,9 @@ TEMP_PATH = "/tmp"
     default=None,
     help="Volcengine secret key",
 )
-@click.option("--vefaas-app-name", help="Expected Volcengine FaaS application name")
+@click.option(
+    "--vefaas-app-name", required=True, help="Expected Volcengine FaaS application name"
+)
 @click.option(
     "--veapig-instance-name", default="", help="Expected Volcengine APIG instance name"
 )
@@ -131,6 +133,17 @@ def deploy(
             "No requirements.txt found in the user project, we will use a default one."
         )
 
+    # avoid upload user's config.yaml
+    if (user_proj_abs_path / "config.yaml").exists():
+        logger.warning(
+            f"Find a config.yaml in {user_proj_abs_path}/config.yaml, we will not upload it by default."
+        )
+        shutil.move(agent_dir / "config.yaml", Path(TEMP_PATH) / tmp_dir_name)
+    else:
+        logger.info(
+            "No config.yaml found in the user project. Some environment variables may not be set."
+        )
+
     # load
     logger.debug(
         f"Load deploy module from {Path(TEMP_PATH) / tmp_dir_name / 'deploy.py'}"

veadk/cli/cli_web.py

@@ -102,6 +102,32 @@ def _get_memory(
     return short_term_memory, long_term_memory
 
 
+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()
 @click.option("--host", default="127.0.0.1", help="Host to run the web server on")
 def web(host: str) -> None:
@@ -145,6 +171,7 @@ def web(host: str) -> None:
     import google.adk.cli.adk_web_server
 
     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
 

veadk/cloud/cloud_app.py

@@ -13,6 +13,7 @@
 # limitations under the License.
 
 import json
+import time
 from typing import Any
 from uuid import uuid4
 
@@ -60,9 +61,11 @@ class CloudApp:
         if not vefaas_endpoint:
             self.vefaas_endpoint = self._get_vefaas_endpoint()
 
-        if not self.vefaas_endpoint.startswith(
-            "http"
-        ) and not self.vefaas_endpoint.startswith("https"):
+        if (
+            self.vefaas_endpoint
+            and not self.vefaas_endpoint.startswith("http")
+            and not self.vefaas_endpoint.startswith("https")
+        ):
             raise ValueError(
                 f"Invalid endpoint: {vefaas_endpoint}. The endpoint must start with `http` or `https`."
             )
@@ -92,12 +95,13 @@ class CloudApp:
             raise ValueError(
                 f"VeFaaS CloudAPP with application_id `{self.vefaas_application_id}` or application_name `{self.vefaas_application_name}` not found."
             )
-        cloud_resource = json.loads(app["CloudResource"])
 
         try:
+            cloud_resource = json.loads(app["CloudResource"])
             vefaas_endpoint = cloud_resource["framework"]["url"]["system_url"]
         except Exception as e:
-            raise ValueError(f"VeFaaS cloudAPP could not get endpoint. Error: {e}")
+            logger.warning(f"VeFaaS cloudAPP could not get endpoint. Error: {e}")
+            vefaas_endpoint = ""
         return vefaas_endpoint
 
     def _get_vefaas_application_id_by_name(self) -> str:
@@ -167,7 +171,18 @@ class CloudApp:
 
             vefaas_client = VeFaaS(access_key=volcengine_ak, secret_key=volcengine_sk)
             vefaas_client.delete(self.vefaas_application_id)
-            print(f"Cloud app {self.vefaas_application_id} is deleting...")
+            print(
+                f"Cloud app {self.vefaas_application_id} delete request has been sent to VeFaaS"
+            )
+            while True:
+                try:
+                    id = self._get_vefaas_application_id_by_name()
+                    if not id:
+                        break
+                    time.sleep(3)
+                except Exception as _:
+                    break
+            print("Delete application done.")
 
     async def message_send(
         self, message: str, session_id: str, user_id: str, timeout: float = 600.0

veadk/consts.py

@@ -12,6 +12,19 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+from veadk.version import VERSION
+
 DEFAULT_MODEL_AGENT_NAME = "doubao-seed-1-6-250615"
-DEFALUT_MODEL_AGENT_PROVIDER = "openai"
+DEFAULT_MODEL_AGENT_PROVIDER = "openai"
 DEFAULT_MODEL_AGENT_API_BASE = "https://ark.cn-beijing.volces.com/api/v3/"
+DEFAULT_MODEL_EXTRA_HEADERS = {"veadk-source": "veadk", "veadk-version": VERSION}
+
+DEFAULT_APMPLUS_OTEL_EXPORTER_ENDPOINT = "http://apmplus-cn-beijing.volces.com:4317"
+DEFAULT_APMPLUS_OTEL_EXPORTER_SERVICE_NAME = "veadk_tracing"
+
+DEFAULT_COZELOOP_OTEL_EXPORTER_ENDPOINT = (
+    "https://api.coze.cn/v1/loop/opentelemetry/v1/traces"
+)
+
+DEFAULT_TLS_OTEL_EXPORTER_ENDPOINT = "https://tls-cn-beijing.volces.com:4318/v1/traces"
+DEFAULT_TLS_OTEL_EXPORTER_REGION = "cn-beijing"

veadk/database/viking/viking_database.py

@@ -387,9 +387,9 @@ class VikingDatabase(BaseModel, BaseDatabase):
             logger.error(f"Error in list_collections: {result['message']}")
             raise ValueError(f"Error in list_collections: {result['message']}")
 
-        collections = result["data"]["collection_list"]
-        if not collections:
-            raise ValueError(f"No collections found in project {self.config.project}.")
+        collections = result["data"].get("collection_list", [])
+        if len(collections) == 0:
+            return False
 
         collection_list = set()
 

veadk/evaluation/adk_evaluator/__init__.py

@@ -11,3 +11,7 @@
 # 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 .adk_evaluator import ADKEvaluator
+
+__all__ = ["ADKEvaluator"]