veadk-python 0.2.8__tar.gz → 0.2.9__tar.gz

{veadk_python-0.2.8 → veadk_python-0.2.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: veadk-python
-Version: 0.2.8
+Version: 0.2.9
 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
@@ -220,7 +220,7 @@ Requires-Dist: wrapt>=1.17.2
 Requires-Dist: openai<1.100
 Requires-Dist: volcengine-python-sdk>=4.0.3
 Requires-Dist: volcengine>=1.0.193
-Requires-Dist: agent-pilot-sdk>=0.0.9
+Requires-Dist: agent-pilot-sdk>=0.1.2
 Requires-Dist: fastmcp>=2.11.3
 Requires-Dist: cookiecutter>=2.6.0
 Requires-Dist: omegaconf>=2.3.0
@@ -270,6 +270,17 @@ A [tutorial](https://github.com/volcengine/veadk-python/blob/main/veadk_tutorial
 
 ## Installation
 
+### From PyPI
+
+```python
+pip install veadk-python
+
+# install extensions
+pip install veadk-python[extensions]
+```
+
+### Build from source
+
 We use `uv` to build this project ([how-to-install-uv](https://docs.astral.sh/uv/getting-started/installation/)).
 
 ```bash

{veadk_python-0.2.8 → veadk_python-0.2.9}/README.md

@@ -15,6 +15,17 @@ A [tutorial](https://github.com/volcengine/veadk-python/blob/main/veadk_tutorial
 
 ## Installation
 
+### From PyPI
+
+```python
+pip install veadk-python
+
+# install extensions
+pip install veadk-python[extensions]
+```
+
+### Build from source
+
 We use `uv` to build this project ([how-to-install-uv](https://docs.astral.sh/uv/getting-started/installation/)).
 
 ```bash

{veadk_python-0.2.8 → veadk_python-0.2.9}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "veadk-python"
-version = "0.2.8"
+version = "0.2.9"
 description = "Volcengine agent development kit, integrations with Volcengine cloud services."
 readme = "README.md"
 requires-python = ">=3.10"
@@ -24,7 +24,7 @@ dependencies = [
     "openai<1.100", # For fix https://github.com/BerriAI/litellm/issues/13710
     "volcengine-python-sdk>=4.0.3", # For Volcengine API
     "volcengine>=1.0.193",          # For Volcengine sign
-    "agent-pilot-sdk>=0.0.9", # Prompt optimization by Volcengine AgentPilot/PromptPilot toolkits
+    "agent-pilot-sdk>=0.1.2", # Prompt optimization by Volcengine AgentPilot/PromptPilot toolkits
     "fastmcp>=2.11.3", # For running MCP
     "cookiecutter>=2.6.0", # For cloud deploy
     "omegaconf>=2.3.0", # For agent builder

{veadk_python-0.2.8 → veadk_python-0.2.9}/veadk/agent.py

@@ -84,6 +84,9 @@ class Agent(LlmAgent):
     knowledgebase: Optional[KnowledgeBase] = None
     """The knowledgebase provided to agent."""
 
+    short_term_memory: Optional[ShortTermMemory] = None
+    """The short term memory provided to agent."""
+
     long_term_memory: Optional[LongTermMemory] = None
     """The long term memory provided to agent.
 

{veadk_python-0.2.8 → veadk_python-0.2.9}/veadk/cli/cli_prompt.py

@@ -21,12 +21,15 @@ import click
 )
 @click.option("--feedback", default="", help="Suggestions for prompt optimization")
 @click.option("--api-key", default="", help="API Key of PromptPilot")
+@click.option("--workspace-id", default="", help="Workspace ID of PromptPilot")
 @click.option(
     "--model-name",
     default="doubao-1.5-pro-32k-250115",
     help="Model name for prompt optimization",
 )
-def prompt(path: str, feedback: str, api_key: str, model_name: str) -> None:
+def prompt(
+    path: str, feedback: str, api_key: str, workspace_id: str, model_name: str
+) -> None:
     """Optimize agent system prompt from a local file."""
     from pathlib import Path
 
@@ -56,7 +59,11 @@ def prompt(path: str, feedback: str, api_key: str, model_name: str) -> None:
 
         if not api_key:
             api_key = settings.prompt_pilot.api_key
-        ve_prompt_pilot = VePromptPilot(api_key)
+
+        if not workspace_id:
+            raise ValueError("Please provide workspace_id for PromptPilot service.")
+
+        ve_prompt_pilot = VePromptPilot(api_key=api_key, workspace_id=workspace_id)
         ve_prompt_pilot.optimize(
             agents=agents, feedback=feedback, model_name=model_name
         )

{veadk_python-0.2.8 → veadk_python-0.2.9}/veadk/cli/cli_web.py

@@ -12,6 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+from typing import Optional
 
 import click
 
@@ -152,6 +153,7 @@ def web(host: str) -> None:
         eval_sets_manager: Any,
         eval_set_results_manager: Any,
         agents_dir: str,
+        extra_plugins: Optional[list[str]] = None,
     ):
         self.agent_loader = agent_loader
         self.artifact_service = artifact_service
@@ -162,6 +164,7 @@ def web(host: str) -> None:
         self.runners_to_clean = set()
         self.current_app_name_ref = SharedValue(value="")
         self.runner_dict = {}
+        self.extra_plugins = extra_plugins or []
 
         # parse VeADK memories
         short_term_memory, long_term_memory = _get_memory(module_path=agents_dir)

{veadk_python-0.2.8 → veadk_python-0.2.9}/veadk/configs/database_configs.py

@@ -83,6 +83,15 @@ class RedisConfig(BaseSettings):
     """STS token for Redis auth, not supported yet."""
 
 
+class Mem0Config(BaseSettings):
+    model_config = SettingsConfigDict(env_prefix="DATABASE_MEM0_")
+
+    api_key: str = ""
+    """Mem0 API key"""
+
+    base_url: str = ""  # "https://api.mem0.ai/v1"
+
+
 class VikingKnowledgebaseConfig(BaseSettings):
     model_config = SettingsConfigDict(env_prefix="DATABASE_VIKING_")
 

{veadk_python-0.2.8 → veadk_python-0.2.9}/veadk/consts.py

@@ -27,6 +27,8 @@ DEFAULT_MODEL_EXTRA_CONFIG = {
         "x-is-encrypted": getenv("MODEL_AGENT_ENCRYPTED", "true"),
         "veadk-source": "veadk",
         "veadk-version": VERSION,
+        "User-Agent": f"VeADK/{VERSION}",
+        "X-Client-Request-Id": f"veadk/{VERSION}",
     },
     "extra_body": {
         "caching": {
@@ -59,3 +61,8 @@ DEFAULT_TLS_TRACING_INSTANCE_NAME = "veadk-tracing"
 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_IMAGE_EDIT_MODEL_NAME = "doubao-seededit-3-0-i2i-250628"
+DEFAULT_VIDEO_MODEL_NAME = "doubao-seedance-1-0-pro-250528"
+DEFAULT_IMAGE_GENERATE_MODEL_NAME = "doubao-seedream-4-0-250828"

{veadk_python-0.2.8 → veadk_python-0.2.9}/veadk/evaluation/adk_evaluator/adk_evaluator.py

@@ -24,6 +24,8 @@ from google.adk.evaluation.agent_evaluator import (
 )
 from google.adk.evaluation.eval_case import IntermediateData, Invocation
 from google.adk.evaluation.evaluator import EvalStatus
+from google.adk.evaluation.eval_set import EvalSet
+from typing import Optional
 from typing_extensions import override
 from veadk.evaluation.base_evaluator import BaseEvaluator
 from types import SimpleNamespace
@@ -52,7 +54,8 @@ class ADKEvaluator(BaseEvaluator):
     @override
     async def evaluate(
         self,
-        eval_set_file_path: str,
+        eval_set: Optional[EvalSet] = None,
+        eval_set_file_path: Optional[str] = None,
         eval_id: str = f"test_{formatted_timestamp()}",
         tool_score_threshold: float = 1.0,
         response_match_score_threshold: float = 0.8,
@@ -104,7 +107,7 @@ class ADKEvaluator(BaseEvaluator):
         # Iterate each test file and evaluate per-case, per-metric
         for test_file in test_files:
             # Build in-memory evaluation cases via BaseEvaluator from the provided file
-            self.build_eval_set(test_file)
+            self.build_eval_set(eval_set, test_file)
 
             evaluation_result_list = []
 

{veadk_python-0.2.8 → veadk_python-0.2.9}/veadk/evaluation/base_evaluator.py

@@ -17,7 +17,7 @@ import json
 import time
 import uuid
 from abc import abstractmethod
-from typing import Any
+from typing import Any, Optional
 
 from google.adk import Runner
 from google.adk.evaluation.eval_set import EvalSet
@@ -210,33 +210,43 @@ class BaseEvaluator:
 
         return evalset
 
-    def build_eval_set(self, file_path: str):
+    def build_eval_set(
+        self, eval_set: Optional[EvalSet] = None, file_path: Optional[str] = None
+    ):
         """Generate evaluation data from a given file and assign it to the class attribute `invocation_list`."""
-        eval_case_data_list: list[EvalTestCase] = []
 
-        try:
-            with open(file_path, "r", encoding="utf-8") as f:
-                file_content = json.load(f)
-        except json.JSONDecodeError as e:
-            raise ValueError(f"Invalid JSON format in file {file_path}: {e}")
-        except Exception as e:
-            raise ValueError(f"Error reading file {file_path}: {e}")
-
-        if isinstance(file_content, dict) and "eval_cases" in file_content:
-            eval_cases = self._build_eval_set_from_eval_json(file_path).eval_cases
-        elif (
-            isinstance(file_content, list)
-            and len(file_content) > 0
-            and all(
-                isinstance(span, dict) and "trace_id" in span for span in file_content
-            )
-        ):
-            eval_cases = self._build_eval_set_from_tracing_json(file_path).eval_cases
+        if eval_set is None and file_path is None:
+            raise ValueError("eval_set or file_path is required")
+        if eval_set:
+            eval_cases = eval_set.eval_cases
         else:
-            raise ValueError(
-                f"Unsupported file format in {file_path}. Please provide a valid file."
-            )
+            try:
+                with open(file_path, "r", encoding="utf-8") as f:
+                    file_content = json.load(f)
+            except json.JSONDecodeError as e:
+                raise ValueError(f"Invalid JSON format in file {file_path}: {e}")
+            except Exception as e:
+                raise ValueError(f"Error reading file {file_path}: {e}")
+
+            if isinstance(file_content, dict) and "eval_cases" in file_content:
+                eval_cases = self._build_eval_set_from_eval_json(file_path).eval_cases
+            elif (
+                isinstance(file_content, list)
+                and len(file_content) > 0
+                and all(
+                    isinstance(span, dict) and "trace_id" in span
+                    for span in file_content
+                )
+            ):
+                eval_cases = self._build_eval_set_from_tracing_json(
+                    file_path
+                ).eval_cases
+            else:
+                raise ValueError(
+                    f"Unsupported file format in {file_path}. Please provide a valid file."
+                )
 
+        eval_case_data_list: list[EvalTestCase] = []
         for eval_case in eval_cases:
             eval_case_data = EvalTestCase(invocations=[])
             if eval_case.session_input:
@@ -384,8 +394,9 @@ class BaseEvaluator:
     @abstractmethod
     async def evaluate(
         self,
-        eval_set_file_path: str,
         metrics: list[Any],
+        eval_set: Optional[EvalSet],
+        eval_set_file_path: Optional[str],
         eval_id: str,
     ):
         """An abstract method for evaluation based on metrics。"""

{veadk_python-0.2.8 → veadk_python-0.2.9}/veadk/evaluation/deepeval_evaluator/deepeval_evaluator.py

@@ -22,7 +22,8 @@ from deepeval.models import LocalModel
 from deepeval.test_case import LLMTestCase
 from deepeval.test_case.llm_test_case import ToolCall
 from typing_extensions import override
-
+from typing import Optional
+from google.adk.evaluation.eval_set import EvalSet
 from veadk.config import getenv
 from veadk.evaluation.base_evaluator import BaseEvaluator, EvalResultData, MetricResult
 from veadk.evaluation.types import EvalResultCaseData, EvalResultMetadata
@@ -77,13 +78,14 @@ class DeepevalEvaluator(BaseEvaluator):
     @override
     async def evaluate(
         self,
-        eval_set_file_path: str,
         metrics: list[BaseMetric],
+        eval_set: Optional[EvalSet] = None,
+        eval_set_file_path: Optional[str] = None,
         eval_id: str = f"test_{formatted_timestamp()}",
     ):
         """Target to Google ADK, we will use the same evaluation case format as Google ADK."""
         # Get evaluation data by parsing eval set file
-        self.build_eval_set(eval_set_file_path)
+        self.build_eval_set(eval_set, eval_set_file_path)
 
         # Get actual data by running agent
         logger.info("Start to run agent for actual data.")

{veadk_python-0.2.8 → veadk_python-0.2.9}/veadk/integrations/ve_prompt_pilot/ve_prompt_pilot.py

@@ -16,7 +16,6 @@ from __future__ import annotations
 
 import agent_pilot as ap
 from agent_pilot.models import TaskType
-
 from veadk import Agent
 from veadk.prompts import prompt_optimization
 from veadk.utils.logger import get_logger
@@ -26,9 +25,15 @@ logger = get_logger(__name__)
 
 class VePromptPilot:
     def __init__(
-        self, api_key: str, path: str = "", task_id: str | None = None
+        self,
+        api_key: str,
+        workspace_id: str,
+        path: str = "",
+        task_id: str | None = None,
     ) -> None:
         self.api_key = api_key
+        self.workspace_id = workspace_id
+
         self.path = path
 
     def optimize(
@@ -57,12 +62,13 @@ class VePromptPilot:
             usage = None
             for chunk in ap.generate_prompt_stream(
                 task_description=task_description,
-                current_prompt=agent.instruction,
+                current_prompt=str(agent.instruction),
                 model_name=model_name,
                 task_type=TaskType.DIALOG,
                 temperature=1.0,
                 top_p=0.7,
                 api_key=self.api_key,
+                workspace_id=self.workspace_id,
             ):  # stream chunks of optimized prompt
                 # Process each chunk as it arrives
                 optimized_prompt += chunk.data.content if chunk.data else ""

{veadk_python-0.2.8 → veadk_python-0.2.9}/veadk/integrations/ve_tls/utils.py

@@ -17,6 +17,7 @@ import json
 from typing import Any, Literal
 
 import httpx
+from veadk.utils.logger import get_logger
 from volcengine.ApiInfo import ApiInfo
 from volcengine.auth.SignerV4 import SignerV4
 from volcengine.tls.const import (
@@ -28,8 +29,6 @@ from volcengine.tls.const import (
 )
 from volcengine.tls.TLSService import TLSService
 
-from veadk.utils.logger import get_logger
-
 logger = get_logger(__name__)
 
 HEADER_API_VERSION = "x-tls-apiversion"

{veadk_python-0.2.8 → veadk_python-0.2.9}/veadk/integrations/ve_tls/ve_tls.py

@@ -28,9 +28,8 @@ class VeTLS:
         region: str = "cn-beijing",
     ):
         try:
-            from volcengine.tls.TLSService import TLSService
-
             from veadk.integrations.ve_tls.utils import ve_tls_request
+            from volcengine.tls.TLSService import TLSService
         except ImportError:
             raise ImportError(
                 "Please install volcengine SDK before init VeTLS: pip install volcengine"
@@ -162,11 +161,12 @@ class VeTLS:
                 client=self._client,
                 api="CreateTraceInstance",
                 body=request_body,
+                request_headers={"TraceTag": "veadk"},
             )
 
-            if res["ErrorCode"] == "TopicAlreadyExist":
+            if "ErrorCode" in res and res["ErrorCode"] == "TopicAlreadyExist":
                 logger.debug(
-                    f"Log project '{trace_instance_name}' already exists. Check its ID."
+                    f"Tracing instance '{trace_instance_name}' already exists. Check its ID."
                 )
                 return self.get_trace_instance_by_name(
                     log_project_id, trace_instance_name
@@ -176,10 +176,14 @@ class VeTLS:
             res = self._ve_tls_request(
                 client=self._client,
                 api="DescribeTraceInstance",
-                body={"TraceInstanceID": res["TraceInstanceID"]},
+                params={"TraceInstanceId": res["TraceInstanceId"]},
                 method="GET",
             )
 
+            logger.info(
+                f"Create tracing instance finished, tracing instance ID: {res['TraceInstanceId']}"
+            )
+
             return res
         except KeyError:
             raise ValueError(f"Failed to create tracing instance: {res}")