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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: veadk-python
-Version: 0.2.13
+Version: 0.2.14
 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.13 → veadk_python-0.2.14}/pyproject.toml

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

{veadk_python-0.2.13 → veadk_python-0.2.14}/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_python-0.2.14/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_python-0.2.13 → veadk_python-0.2.14}/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/"
 

veadk_python-0.2.13/veadk/tools/builtin_tools/generate_image.py → veadk_python-0.2.14/veadk/tools/builtin_tools/image_generate.py

@@ -12,7 +12,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+import asyncio
 import base64
+import concurrent.futures
+import contextvars
 import json
 import mimetypes
 import traceback
@@ -27,16 +30,12 @@ from volcenginesdkarkruntime.types.images.images import SequentialImageGeneratio
 
 from veadk.config import getenv, settings
 from veadk.consts import (
-    DEFAULT_IMAGE_GENERATE_MODEL_NAME,
     DEFAULT_IMAGE_GENERATE_MODEL_API_BASE,
+    DEFAULT_IMAGE_GENERATE_MODEL_NAME,
 )
 from veadk.utils.logger import get_logger
 from veadk.utils.misc import formatted_timestamp, read_file_to_bytes
 from veadk.version import VERSION
-import asyncio
-import concurrent.futures
-import contextvars
-
 
 logger = get_logger(__name__)
 
@@ -48,7 +47,7 @@ client = Ark(
 )
 
 executor = concurrent.futures.ThreadPoolExecutor(max_workers=8)
-tracer = trace.get_tracer("gcp.vertex.agent")
+tracer = trace.get_tracer("veadk")
 
 
 def _build_input_parts(item: dict, task_type: str, image_field):
@@ -205,8 +204,10 @@ def handle_single_task_sync(
 
 
 async def image_generate(tasks: list[dict], tool_context) -> Dict:
-    """
-    Seedream 4.0: batch image generation via tasks.
+    """Generate images with Seedream 4.0.
+
+    Commit batch image generation requests via tasks.
+
     Args:
         tasks (list[dict]):
             A list of image-generation tasks. Each task is a dict.
@@ -284,12 +285,27 @@ async def image_generate(tasks: list[dict], tool_context) -> Dict:
     - 如果想要指定生成组图的数量，请在prompt里添加数量说明，例如："生成3张图片"。
     - size 推荐使用 2048x2048 或表格里的标准比例，确保生成质量。
     """
-    logger.debug(
-        f"Using model: {getenv('MODEL_IMAGE_NAME', DEFAULT_IMAGE_GENERATE_MODEL_NAME)}"
-    )
+    model = getenv("MODEL_IMAGE_NAME", DEFAULT_IMAGE_GENERATE_MODEL_NAME)
+
+    if model.startswith("doubao-seedream-3-0"):
+        logger.error(
+            f"Image generation by Doubao Seedream 3.0 ({model}) is depracated. Please use Doubao Seedream 4.0 (e.g., doubao-seedream-4-0-250828) instead."
+        )
+        return {
+            "status": "failed",
+            "success_list": [],
+            "error_list": [
+                "Image generation by Doubao Seedream 3.0 ({model}) is depracated. Please use Doubao Seedream 4.0 (e.g., doubao-seedream-4-0-250828) instead."
+            ],
+        }
+
+    logger.debug(f"Using model to generate image: {model}")
+
     success_list: list[dict] = []
     error_list: list[str] = []
+
     logger.debug(f"image_generate tasks: {tasks}")
+
     with tracer.start_as_current_span("image_generate"):
         base_ctx = contextvars.copy_context()
 

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

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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: veadk-python
-Version: 0.2.13
+Version: 0.2.14
 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.13 → veadk_python-0.2.14}/veadk_python.egg-info/SOURCES.txt

@@ -42,6 +42,7 @@ veadk/auth/veauth/utils.py
 veadk/auth/veauth/vesearch_veauth.py
 veadk/cli/__init__.py
 veadk/cli/cli.py
+veadk/cli/cli_create.py
 veadk/cli/cli_deploy.py
 veadk/cli/cli_eval.py
 veadk/cli/cli_init.py
@@ -156,7 +157,6 @@ 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

veadk_python-0.2.13/veadk/tools/builtin_tools/image_generate.py

@@ -1,296 +0,0 @@
-# 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 typing import Dict
-
-from google.adk.tools import ToolContext
-from veadk.config import getenv, settings
-from veadk.consts import (
-    DEFAULT_TEXT_TO_IMAGE_MODEL_NAME,
-    DEFAULT_TEXT_TO_IMAGE_MODEL_API_BASE,
-)
-import base64
-from volcenginesdkarkruntime import Ark
-from opentelemetry import trace
-import traceback
-import json
-from veadk.version import VERSION
-from opentelemetry.trace import Span
-from veadk.utils.logger import get_logger
-
-logger = get_logger(__name__)
-
-client = Ark(
-    api_key=getenv(
-        "MODEL_IMAGE_API_KEY", getenv("MODEL_AGENT_API_KEY", settings.model.api_key)
-    ),
-    base_url=getenv("MODEL_IMAGE_API_BASE", DEFAULT_TEXT_TO_IMAGE_MODEL_API_BASE),
-)
-
-
-async def image_generate(
-    params: list,
-    tool_context: ToolContext,
-) -> Dict:
-    """
-    Generate images in batch according to prompts and optional settings.
-
-    Each item in `params` describes a single image-generation request.
-
-    Args:
-        params (list[dict]):
-            A list of image generation requests. Each item supports:
-
-            Required:
-                - prompt (str):
-                    The textual description of the desired image.
-                    Supports English and Chinese.
-
-            Optional:
-                - image_name (str):
-                    Name/identifier for the generated image.
-
-                - response_format (str):
-                    Format of the returned image.
-                    * "url": JPEG link (default)
-                    * "b64_json": Base64 string in JSON
-
-                - size (str):
-                    Resolution of the generated image.
-                    Default: "1024x1024".
-                    Must be within [512x512, 2048x2048].
-                    Common options: 1024x1024, 864x1152, 1280x720, etc.
-
-                - guidance_scale (float):
-                    How strongly the prompt affects the result.
-                    Range: [1.0, 10.0], default 2.5.
-
-                - watermark (bool):
-                    Whether to add watermark.
-                    Default: True.
-
-                - seed (int):
-                    Random seed for reproducibility.
-                    Range: [-1, 2^31-1], default -1 (random).
-
-    Returns:
-        Dict: API response containing generated image metadata.
-        Example:
-        {
-            "status": "success",
-            "success_list": [{"image_name": ""}],
-            "error_list": [{}]
-        }
-
-    Notes:
-        - Best suited for creating original images from text.
-        - Use a fixed `seed` for reproducibility.
-        - Choose appropriate `size` for desired aspect ratio.
-    """
-    logger.debug(
-        f"Using model: {getenv('MODEL_IMAGE_NAME', DEFAULT_TEXT_TO_IMAGE_MODEL_NAME)}"
-    )
-    success_list = []
-    error_list = []
-    logger.debug(f"image_generate params: {params}")
-    for idx, item in enumerate(params):
-        logger.debug(f"image_generate item {idx}: {item}")
-        prompt = item.get("prompt", "")
-        image_name = item.get("image_name", f"generated_image_{idx}")
-        response_format = item.get("response_format", "url")
-        size = item.get("size", "1024x1024")
-        guidance_scale = item.get("guidance_scale", 2.5)
-        watermark = item.get("watermark", True)
-        seed = item.get("seed", -1)
-
-        try:
-            tracer = trace.get_tracer("gcp.vertex.agent")
-            with tracer.start_as_current_span("call_llm") as span:
-                inputs = {
-                    "prompt": prompt,
-                    "response_format": response_format,
-                    "size": size,
-                    "guidance_scale": guidance_scale,
-                    "watermark": watermark,
-                    "seed": seed,
-                }
-                input_part = {
-                    "role": "user",
-                    "content": json.dumps(inputs, ensure_ascii=False),
-                }
-                response = client.images.generate(
-                    model=getenv("MODEL_IMAGE_NAME", DEFAULT_TEXT_TO_IMAGE_MODEL_NAME),
-                    **inputs,
-                )
-                output_part = None
-                if response.data and len(response.data) > 0:
-                    logger.debug(f"task {idx} Image generate response: {response}")
-                    for item in response.data:
-                        if response_format == "url":
-                            image = item.url
-                            tool_context.state[f"{image_name}_url"] = image
-                            output_part = {
-                                "message.role": "model",
-                                "message.parts.0.type": "image_url",
-                                "message.parts.0.image_url.name": image_name,
-                                "message.parts.0.image_url.url": image,
-                            }
-                        elif response_format == "b64_json":
-                            image = item.b64_json
-                            image_bytes = base64.b64decode(image)
-
-                            tos_url = _upload_image_to_tos(
-                                image_bytes=image_bytes, object_key=f"{image_name}.png"
-                            )
-                            if tos_url:
-                                tool_context.state[f"{image_name}_url"] = tos_url
-                                image = tos_url
-                                output_part = {
-                                    "message.role": "model",
-                                    "message.parts.0.type": "image_url",
-                                    "message.parts.0.image_url.name": image_name,
-                                    "message.parts.0.image_url.url": image,
-                                }
-                            else:
-                                logger.error(
-                                    f"Upload image to TOS failed: {image_name}"
-                                )
-                                error_list.append(image_name)
-                                continue
-
-                            logger.debug(f"Image saved as ADK artifact: {image_name}")
-                        logger.debug(
-                            f"Image {image_name} generated successfully: {image}"
-                        )
-                        success_list.append({image_name: image})
-                else:
-                    error_details = f"No images returned by Doubao model: {response}"
-                    logger.error(error_details)
-                    error_list.append(image_name)
-
-                add_span_attributes(
-                    span,
-                    tool_context,
-                    input_part=input_part,
-                    output_part=output_part,
-                    output_tokens=response.usage.output_tokens,
-                    total_tokens=response.usage.total_tokens,
-                    request_model=getenv(
-                        "MODEL_IMAGE_NAME", DEFAULT_TEXT_TO_IMAGE_MODEL_NAME
-                    ),
-                    response_model=getenv(
-                        "MODEL_IMAGE_NAME", DEFAULT_TEXT_TO_IMAGE_MODEL_NAME
-                    ),
-                )
-
-        except Exception as e:
-            error_details = f"No images returned by Doubao model: {e}"
-            logger.error(error_details)
-            error_list.append(image_name)
-
-    if len(success_list) == 0:
-        logger.debug(
-            f"image_generate success_list: {success_list}\nerror_list: {error_list}"
-        )
-        return {
-            "status": "error",
-            "success_list": success_list,
-            "error_list": error_list,
-        }
-    else:
-        logger.debug(
-            f"image_generate success_list: {success_list}\nerror_list: {error_list}"
-        )
-        return {
-            "status": "success",
-            "success_list": success_list,
-            "error_list": error_list,
-        }
-
-
-def add_span_attributes(
-    span: Span,
-    tool_context: ToolContext,
-    input_part: dict = None,
-    output_part: dict = None,
-    input_tokens: int = None,
-    output_tokens: int = None,
-    total_tokens: int = None,
-    request_model: str = None,
-    response_model: str = None,
-):
-    try:
-        # common attributes
-        app_name = tool_context._invocation_context.app_name
-        user_id = tool_context._invocation_context.user_id
-        agent_name = tool_context.agent_name
-        session_id = tool_context._invocation_context.session.id
-        span.set_attribute("gen_ai.agent.name", agent_name)
-        span.set_attribute("openinference.instrumentation.veadk", VERSION)
-        span.set_attribute("gen_ai.app.name", app_name)
-        span.set_attribute("gen_ai.user.id", user_id)
-        span.set_attribute("gen_ai.session.id", session_id)
-        span.set_attribute("agent_name", agent_name)
-        span.set_attribute("agent.name", agent_name)
-        span.set_attribute("app_name", app_name)
-        span.set_attribute("app.name", app_name)
-        span.set_attribute("user.id", user_id)
-        span.set_attribute("session.id", session_id)
-        span.set_attribute("cozeloop.report.source", "veadk")
-
-        # llm attributes
-        span.set_attribute("gen_ai.system", "openai")
-        span.set_attribute("gen_ai.operation.name", "chat")
-        if request_model:
-            span.set_attribute("gen_ai.request.model", request_model)
-        if response_model:
-            span.set_attribute("gen_ai.response.model", response_model)
-        if total_tokens:
-            span.set_attribute("gen_ai.usage.total_tokens", total_tokens)
-        if output_tokens:
-            span.set_attribute("gen_ai.usage.output_tokens", output_tokens)
-        if input_tokens:
-            span.set_attribute("gen_ai.usage.input_tokens", input_tokens)
-        if input_part:
-            span.add_event("gen_ai.user.message", input_part)
-        if output_part:
-            span.add_event("gen_ai.choice", output_part)
-
-    except Exception:
-        traceback.print_exc()
-
-
-def _upload_image_to_tos(image_bytes: bytes, object_key: str) -> None:
-    try:
-        from veadk.integrations.ve_tos.ve_tos import VeTOS
-        import os
-        from datetime import datetime
-
-        timestamp: str = datetime.now().strftime("%Y%m%d%H%M%S%f")[:-3]
-        object_key = f"{timestamp}-{object_key}"
-        bucket_name = os.getenv("DATABASE_TOS_BUCKET")
-        ve_tos = VeTOS()
-
-        tos_url = ve_tos.build_tos_signed_url(
-            object_key=object_key, bucket_name=bucket_name
-        )
-
-        ve_tos.upload_bytes(
-            data=image_bytes, object_key=object_key, bucket_name=bucket_name
-        )
-
-        return tos_url
-    except Exception as e:
-        logger.error(f"Upload to TOS failed: {e}")
-        return None