veadk-python 0.2.4__py3-none-any.whl → 0.2.6__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_API_BASE,
     DEFAULT_MODEL_AGENT_NAME,
+    DEFAULT_MODEL_AGENT_PROVIDER,
+    DEFAULT_MODEL_EXTRA_CONFIG,
 )
 from veadk.evaluation import EvalSetRecorder
 from veadk.knowledgebase import KnowledgeBase
@@ -64,7 +65,7 @@ class Agent(LlmAgent):
     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,39 @@ 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,
-        )
+
+        # combine user model config with VeADK defaults
+        headers = DEFAULT_MODEL_EXTRA_CONFIG["extra_headers"].copy()
+        body = DEFAULT_MODEL_EXTRA_CONFIG["extra_body"].copy()
+
+        if self.model_extra_config:
+            user_headers = self.model_extra_config.get("extra_headers", {})
+            user_body = self.model_extra_config.get("extra_body", {})
+
+            headers |= user_headers
+            body |= user_body
+
+        self.model_extra_config |= {
+            "extra_headers": headers,
+            "extra_body": body,
+        }
+
+        logger.info(f"Model extra config: {self.model_extra_config}")
+
+        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
@@ -117,7 +149,7 @@ class Agent(LlmAgent):
 
         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(

veadk/cli/cli_deploy.py

@@ -14,6 +14,7 @@
 
 
 import click
+from veadk.version import VERSION
 
 TEMP_PATH = "/tmp"
 
@@ -29,7 +30,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"
 )
@@ -92,6 +95,7 @@ def deploy(
         "veapig_service_name": veapig_service_name,
         "veapig_upstream_name": veapig_upstream_name,
         "use_adk_web": use_adk_web,
+        "veadk_version": VERSION,
     }
 
     cookiecutter(

veadk/cli/cli_init.py

@@ -16,6 +16,8 @@ import warnings
 from typing import Any
 
 import click
+from veadk.version import VERSION
+
 
 warnings.filterwarnings(
     "ignore", category=UserWarning, module="pydantic._internal._fields"
@@ -58,12 +60,21 @@ def _render_prompts() -> dict[str, Any]:
         "veapig_service_name": veapig_service_name,
         "veapig_upstream_name": veapig_upstream_name,
         "use_adk_web": deploy_mode == "2",
+        "veadk_version": VERSION,
     }
 
 
 @click.command()
-def init() -> None:
-    """Init a veadk project that can be deployed to Volcengine VeFaaS."""
+@click.option(
+    "--vefaas-template-type", default="template", help="Expected template type"
+)
+def init(
+    vefaas_template_type: str,
+) -> None:
+    """Init a veadk project that can be deployed to Volcengine VeFaaS.
+
+    `template` is A2A/MCP/Web server template, `web_template` is for web applications (i.e., a simple blog).
+    """
     import shutil
     from pathlib import Path
 
@@ -71,9 +82,14 @@ def init() -> None:
 
     import veadk.integrations.ve_faas as vefaas
 
-    click.echo(
-        "Welcome use VeADK to create your project. We will generate a `weather-reporter` application for you."
-    )
+    if vefaas_template_type == "web_template":
+        click.echo(
+            "Welcome use VeADK to create your project. We will generate a `simple-blog` web application for you."
+        )
+    else:
+        click.echo(
+            "Welcome use VeADK to create your project. We will generate a `weather-reporter` application for you."
+        )
 
     cwd = Path.cwd()
     local_dir_name = click.prompt("Local directory name", default="veadk-cloud-proj")
@@ -89,7 +105,10 @@ def init() -> None:
     settings = _render_prompts()
     settings["local_dir_name"] = local_dir_name
 
-    template_dir_path = Path(vefaas.__file__).parent / "template"
+    if not vefaas_template_type:
+        vefaas_template_type = "template"
+
+    template_dir_path = Path(vefaas.__file__).parent / vefaas_template_type
 
     cookiecutter(
         template=str(template_dir_path),

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,38 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+import time
+
+from veadk.config import getenv
+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_CONFIG = {
+    "extra_headers": {
+        "x-is-encrypted": getenv("MODEL_AGENT_ENCRYPTED", "true"),
+        "veadk-source": "veadk",
+        "veadk-version": VERSION,
+    },
+    "extra_body": {
+        "caching": {
+            "type": getenv("MODEL_AGENT_CACHING", "enabled"),
+        },
+        "expire_at": int(time.time()) + 3600,  # expire after 1 hour
+    },
+}
+
+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"
+
+DEFAULT_CR_INSTANCE_NAME = "veadk-user-instance"
+DEFAULT_CR_NAMESPACE_NAME = "veadk-user-namespace"
+DEFAULT_CR_REPO_NAME = "veadk-user-repo"

veadk/database/database_adapter.py

@@ -54,6 +54,33 @@ class KVDatabaseAdapter:
             logger.error(f"Failed to search from Redis: index={index} error={e}")
             raise e
 
+    def delete_doc(self, index: str, id: str) -> bool:
+        logger.debug(f"Deleting document from Redis database: index={index} id={id}")
+        try:
+            # For Redis, we need to handle deletion differently since RedisDatabase.delete_doc
+            # takes a key and a single id
+            result = self.client.delete_doc(key=index, id=id)
+            return result
+        except Exception as e:
+            logger.error(
+                f"Failed to delete document from Redis database: index={index} id={id} error={e}"
+            )
+            return False
+
+    def list_docs(self, index: str, offset: int = 0, limit: int = 100) -> list[dict]:
+        logger.debug(f"Listing documents from Redis database: index={index}")
+        try:
+            # Get all documents from Redis
+            docs = self.client.list_docs(key=index)
+
+            # Apply offset and limit for pagination
+            return docs[offset : offset + limit]
+        except Exception as e:
+            logger.error(
+                f"Failed to list documents from Redis database: index={index} error={e}"
+            )
+            return []
+
 
 class RelationalDatabaseAdapter:
     def __init__(self, client):
@@ -108,6 +135,28 @@ class RelationalDatabaseAdapter:
 
         return [item["data"] for item in results]
 
+    def delete_doc(self, index: str, id: str) -> bool:
+        logger.debug(f"Deleting document from SQL database: table_name={index} id={id}")
+        try:
+            # Convert single id to list for the client method
+            result = self.client.delete_doc(table=index, ids=[int(id)])
+            return result
+        except Exception as e:
+            logger.error(
+                f"Failed to delete document from SQL database: table_name={index} id={id} error={e}"
+            )
+            return False
+
+    def list_docs(self, index: str, offset: int = 0, limit: int = 100) -> list[dict]:
+        logger.debug(f"Listing documents from SQL database: table_name={index}")
+        try:
+            return self.client.list_docs(table=index, offset=offset, limit=limit)
+        except Exception as e:
+            logger.error(
+                f"Failed to list documents from SQL database: table_name={index} error={e}"
+            )
+            return []
+
 
 class VectorDatabaseAdapter:
     def __init__(self, client):
@@ -152,6 +201,23 @@ class VectorDatabaseAdapter:
             top_k=top_k,
         )
 
+    def delete_doc(self, index: str, id: str) -> bool:
+        self._validate_index(index)
+        logger.debug(f"Deleting documents from vector database: index={index} id={id}")
+        try:
+            self.client.delete_by_id(collection_name=index, id=id)
+            return True
+        except Exception as e:
+            logger.error(
+                f"Failed to delete document from vector database: index={index} id={id} error={e}"
+            )
+            return False
+
+    def list_docs(self, index: str, offset: int = 0, limit: int = 1000) -> list[dict]:
+        self._validate_index(index)
+        logger.debug(f"Listing documents from vector database: index={index}")
+        return self.client.list_docs(collection_name=index, offset=offset, limit=limit)
+
 
 class VikingDatabaseAdapter:
     def __init__(self, client):
@@ -212,6 +278,16 @@ class VikingDatabaseAdapter:
 
         return self.client.query(query, collection_name=index, top_k=top_k)
 
+    def delete_doc(self, index: str, id: str) -> bool:
+        self._validate_index(index)
+        logger.debug(f"Deleting documents from vector database: index={index} id={id}")
+        return self.client.delete_by_id(collection_name=index, id=id)
+
+    def list_docs(self, index: str, offset: int, limit: int) -> list[dict]:
+        self._validate_index(index)
+        logger.debug(f"Listing documents from vector database: index={index}")
+        return self.client.list_docs(collection_name=index, offset=offset, limit=limit)
+
 
 class VikingMemoryDatabaseAdapter:
     def __init__(self, client):
@@ -248,6 +324,12 @@ class VikingMemoryDatabaseAdapter:
         result = self.client.query(query, collection_name=index, top_k=top_k, **kwargs)
         return result
 
+    def delete_docs(self, index: str, ids: list[int]):
+        raise NotImplementedError("VikingMemoryDatabase does not support delete_docs")
+
+    def list_docs(self, index: str):
+        raise NotImplementedError("VikingMemoryDatabase does not support list_docs")
+
 
 class LocalDatabaseAdapter:
     def __init__(self, client):
@@ -261,6 +343,12 @@ class LocalDatabaseAdapter:
     def query(self, query: str, **kwargs):
         return self.client.query(query, **kwargs)
 
+    def delete_doc(self, index: str, id: str) -> bool:
+        return self.client.delete_doc(id)
+
+    def list_docs(self, index: str, offset: int = 0, limit: int = 100) -> list[dict]:
+        return self.client.list_docs(offset=offset, limit=limit)
+
 
 MAPPING = {
     "RedisDatabase": KVDatabaseAdapter,

veadk/database/kv/redis_database.py

@@ -110,3 +110,50 @@ class RedisDatabase(BaseModel, BaseDatabase):
         except Exception as e:
             logger.error(f"Failed to delete key `{key}`: {e}")
             raise e
+
+    def delete_doc(self, key: str, id: str) -> bool:
+        """Delete a specific document by ID from a Redis list.
+
+        Args:
+            key: The Redis key (list) to delete from
+            id: The ID of the document to delete
+
+        Returns:
+            bool: True if deletion was successful, False otherwise
+        """
+        try:
+            # Get all items in the list
+            items = self._client.lrange(key, 0, -1)
+
+            # Find the index of the item to delete
+            for i, item in enumerate(items):
+                # Assuming the item is stored as a JSON string with an 'id' field
+                # If it's just the content, we'll use the list index as ID
+                if str(i) == id:
+                    self._client.lrem(key, 1, item)
+                    return True
+
+            logger.warning(f"Document with id {id} not found in key {key}")
+            return False
+        except Exception as e:
+            logger.error(f"Failed to delete document with id {id} from key {key}: {e}")
+            return False
+
+    def list_docs(self, key: str) -> list[dict]:
+        """List all documents in a Redis list.
+
+        Args:
+            key: The Redis key (list) to list documents from
+
+        Returns:
+            list[dict]: List of documents with id and content
+        """
+        try:
+            items = self._client.lrange(key, 0, -1)
+            return [
+                {"id": str(i), "content": item, "metadata": {}}
+                for i, item in enumerate(items)
+            ]
+        except Exception as e:
+            logger.error(f"Failed to list documents from key {key}: {e}")
+            return []

veadk/database/local_database.py

@@ -24,20 +24,38 @@ class LocalDataBase(BaseDatabase):
 
     def __init__(self, **kwargs):
         super().__init__()
-        self.data = []
+        self.data = {}
         self._type = "local"
+        self._next_id = 0  # Used to generate unique IDs
 
     def add_texts(self, texts: list[str], **kwargs):
-        self.data.extend(texts)
+        for text in texts:
+            self.data[str(self._next_id)] = text
+            self._next_id += 1
 
     def is_empty(self):
         return len(self.data) == 0
 
     def query(self, query: str, **kwargs: Any) -> list[str]:
-        return self.data
+        return list(self.data.values())
 
     def delete(self, **kwargs: Any):
-        self.data = []
+        self.data = {}
 
     def add(self, texts: list[str], **kwargs: Any):
         return self.add_texts(texts)
+
+    def list_docs(self, **kwargs: Any) -> list[dict]:
+        return [
+            {"id": id, "content": content, "metadata": {}}
+            for id, content in self.data.items()
+        ]
+
+    def delete_doc(self, id: str, **kwargs: Any):
+        if id not in self.data:
+            raise ValueError(f"id {id} not found")
+        try:
+            del self.data[id]
+            return True
+        except Exception:
+            return False

veadk/database/relational/mysql_database.py

@@ -111,5 +111,63 @@ class MysqlDatabase(BaseModel, BaseDatabase):
             logger.error(f"Failed to drop table {table}: {e}")
             raise e
 
+    def delete_doc(self, table: str, ids: list[int]) -> bool:
+        """Delete documents by IDs from a MySQL table.
+
+        Args:
+            table: The table name to delete from
+            ids: List of document IDs to delete
+
+        Returns:
+            bool: True if deletion was successful, False otherwise
+        """
+        if not self.table_exists(table):
+            logger.warning(f"Table {table} does not exist. Skipping delete operation.")
+            return False
+
+        if not ids:
+            return True  # Nothing to delete
+
+        try:
+            with self._connection.cursor() as cursor:
+                # Create placeholders for the IDs
+                placeholders = ",".join(["%s"] * len(ids))
+                sql = f"DELETE FROM `{table}` WHERE id IN ({placeholders})"
+                cursor.execute(sql, ids)
+                self._connection.commit()
+                logger.info(f"Deleted {cursor.rowcount} documents from table {table}")
+                return True
+        except Exception as e:
+            logger.error(f"Failed to delete documents from table {table}: {e}")
+            return False
+
+    def list_docs(self, table: str, offset: int = 0, limit: int = 100) -> list[dict]:
+        """List documents from a MySQL table.
+
+        Args:
+            table: The table name to list documents from
+            offset: Offset for pagination
+            limit: Limit for pagination
+
+        Returns:
+            list[dict]: List of documents with id and content
+        """
+        if not self.table_exists(table):
+            logger.warning(f"Table {table} does not exist. Returning empty list.")
+            return []
+
+        try:
+            with self._connection.cursor() as cursor:
+                sql = f"SELECT id, data FROM `{table}` ORDER BY created_at DESC LIMIT %s OFFSET %s"
+                cursor.execute(sql, (limit, offset))
+                results = cursor.fetchall()
+                return [
+                    {"id": str(row["id"]), "content": row["data"], "metadata": {}}
+                    for row in results
+                ]
+        except Exception as e:
+            logger.error(f"Failed to list documents from table {table}: {e}")
+            return []
+
     def is_empty(self):
         pass

veadk/database/vector/opensearch_vector_database.py

@@ -219,7 +219,9 @@ class OpenSearchVectorDatabase(BaseModel, BaseDatabase):
         response = self._opensearch_client.indices.get_alias()
         return list(response.keys())
 
-    def get_all_docs(self, collection_name: str, size: int = 10000) -> list[dict]:
+    def list_docs(
+        self, collection_name: str, offset: int = 0, limit: int = 10000
+    ) -> list[dict]:
         """Match all docs in one index of OpenSearch"""
         if not self.collection_exists(collection_name):
             logger.warning(
@@ -227,12 +229,13 @@ class OpenSearchVectorDatabase(BaseModel, BaseDatabase):
             )
             return []
 
-        query = {"size": size, "query": {"match_all": {}}}
+        query = {"size": limit, "from": offset, "query": {"match_all": {}}}
         response = self._opensearch_client.search(index=collection_name, body=query)
         return [
             {
                 "id": hit["_id"],
-                "page_content": hit["_source"]["page_content"],
+                "content": hit["_source"]["page_content"],
+                "metadata": {},
             }
             for hit in response["hits"]["hits"]
         ]

veadk/database/viking/viking_database.py

@@ -41,6 +41,8 @@ get_collections_path = "/api/knowledge/collection/info"
 doc_add_path = "/api/knowledge/doc/add"
 doc_info_path = "/api/knowledge/doc/info"
 doc_del_path = "/api/collection/drop"
+list_docs_path = "/api/knowledge/point/list"
+delete_docs_path = "/api/knowledge/point/delete"
 
 
 class VolcengineTOSConfig(BaseModel):
@@ -387,9 +389,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()
 
@@ -400,3 +402,70 @@ class VikingDatabase(BaseModel, BaseDatabase):
             return True
         else:
             return False
+
+    def list_docs(
+        self, collection_name: str, offset: int = 0, limit: int = -1
+    ) -> list[dict]:
+        request_params = {
+            "collection_name": collection_name,
+            "project": self.config.project,
+            "offset": offset,
+            "limit": limit,
+        }
+
+        create_collection_req = prepare_request(
+            method="POST",
+            path=list_docs_path,
+            config=self.config,
+            data=request_params,
+        )
+        resp = requests.request(
+            method=create_collection_req.method,
+            url="https://{}{}".format(
+                g_knowledge_base_domain, create_collection_req.path
+            ),
+            headers=create_collection_req.headers,
+            data=create_collection_req.body,
+        )
+
+        result = resp.json()
+        if result["code"] != 0:
+            logger.error(f"Error in list_docs: {result['message']}")
+            raise ValueError(f"Error in list_docs: {result['message']}")
+
+        data = [
+            {
+                "id": res["point_id"],
+                "content": res["content"],
+                "metadata": res["doc_info"],
+            }
+            for res in result["data"]["point_list"]
+        ]
+        return data
+
+    def delete_by_id(self, collection_name: str, id: str) -> bool:
+        request_params = {
+            "collection_name": collection_name,
+            "project": self.config.project,
+            "point_id": id,
+        }
+
+        create_collection_req = prepare_request(
+            method="POST",
+            path=delete_docs_path,
+            config=self.config,
+            data=request_params,
+        )
+        resp = requests.request(
+            method=create_collection_req.method,
+            url="https://{}{}".format(
+                g_knowledge_base_domain, create_collection_req.path
+            ),
+            headers=create_collection_req.headers,
+            data=create_collection_req.body,
+        )
+
+        result = resp.json()
+        if result["code"] != 0:
+            return False
+        return True