aip-agents-binary 0.6.4__py3-none-any.whl

aip_agents/storage/providers/base.pyi

@@ -0,0 +1,88 @@
+from _typeshed import Incomplete
+from abc import ABC, abstractmethod
+from aip_agents.utils.logger import get_logger as get_logger
+from typing import Any
+
+logger: Incomplete
+
+class StorageError(Exception):
+    """Base exception for storage operations."""
+
+class BaseStorageProvider(ABC):
+    """Base interface for storage providers.
+
+    This abstract class defines the contract that all storage providers
+    must implement to store and retrieve tool outputs.
+    """
+    @abstractmethod
+    def store(self, key: str, data: Any) -> None:
+        """Store data with the given key.
+
+        Args:
+            key: Unique identifier for the data
+            data: Data to store (must be serializable)
+
+        Raises:
+            StorageError: If storage operation fails
+        """
+    @abstractmethod
+    def retrieve(self, key: str) -> Any:
+        """Retrieve data by key.
+
+        Args:
+            key: Unique identifier for the data
+
+        Returns:
+            The stored data
+
+        Raises:
+            KeyError: If key not found
+            StorageError: If retrieval operation fails
+        """
+    @abstractmethod
+    def exists(self, key: str) -> bool:
+        """Check if key exists.
+
+        Args:
+            key: Unique identifier to check
+
+        Returns:
+            True if key exists, False otherwise
+        """
+    @abstractmethod
+    def delete(self, key: str) -> None:
+        """Delete data by key.
+
+        Args:
+            key: Unique identifier for the data
+
+        Note:
+            Should not raise error if key doesn't exist
+        """
+    @abstractmethod
+    def list_keys(self, prefix: str = '') -> list[str]:
+        """List all keys with optional prefix filter.
+
+        Args:
+            prefix: Optional prefix to filter keys
+
+        Returns:
+            List of matching keys
+        """
+    @abstractmethod
+    def clear(self) -> None:
+        """Clear all stored data.
+
+        Warning:
+            This operation is irreversible
+        """
+    def get_presigned_url(self, key: str, expires_hours: int = 24) -> str | None:
+        """Generate presigned URL for direct access (optional).
+
+        Args:
+            key: Storage key
+            expires_hours: URL expiration in hours
+
+        Returns:
+            Presigned URL if supported, None otherwise
+        """

aip_agents/storage/providers/memory.py

@@ -0,0 +1,114 @@
+"""In-memory storage provider implementation.
+
+Authors:
+    Christian Trisno Sen Long Chen (christian.t.s.l.chen@gdplabs.id)
+    Fachriza Adhiatma (fachriza.d.adhiatma@gdplabs.id)
+"""
+
+import sys
+from typing import Any
+
+from aip_agents.storage.providers.base import BaseStorageProvider, StorageError
+
+
+class InMemoryStorageProvider(BaseStorageProvider):
+    """In-memory storage provider for fast access to small data.
+
+    This provider stores all data in memory, providing the fastest
+    access times but limited by available RAM.
+
+    Best for:
+    - Small to medium datasets
+    - Temporary storage
+    - Development and testing
+    - High-frequency access patterns
+    """
+
+    def __init__(self):
+        """Initialize in-memory storage."""
+        self._storage: dict[str, Any] = {}
+
+    def store(self, key: str, data: Any) -> None:
+        """Store data in memory.
+
+        Args:
+            key: Unique identifier for the data
+            data: Data to store
+
+        Raises:
+            StorageError: If storage operation fails
+        """
+        try:
+            self._storage[key] = data
+        except Exception as e:
+            raise StorageError(f"Failed to store data in memory: {e}") from e
+
+    def retrieve(self, key: str) -> Any:
+        """Retrieve data from memory.
+
+        Args:
+            key: Unique identifier for the data
+
+        Returns:
+            The stored data
+
+        Raises:
+            KeyError: If key not found
+        """
+        if key not in self._storage:
+            raise KeyError(f"Key '{key}' not found in memory storage")
+        return self._storage[key]
+
+    def exists(self, key: str) -> bool:
+        """Check if key exists in memory.
+
+        Args:
+            key: Unique identifier to check
+
+        Returns:
+            True if key exists, False otherwise
+        """
+        return key in self._storage
+
+    def delete(self, key: str) -> None:
+        """Delete data from memory.
+
+        Args:
+            key: Unique identifier for the data
+        """
+        self._storage.pop(key, None)
+
+    def list_keys(self, prefix: str = "") -> list[str]:
+        """List all keys with optional prefix.
+
+        Args:
+            prefix: Optional prefix to filter keys
+
+        Returns:
+            List of matching keys
+        """
+        if prefix:
+            return [k for k in self._storage.keys() if k.startswith(prefix)]
+        return list(self._storage.keys())
+
+    def clear(self) -> None:
+        """Clear all data from memory."""
+        self._storage.clear()
+
+    @property
+    def size_bytes(self) -> int:
+        """Get approximate memory usage in bytes.
+
+        Returns:
+            Approximate memory usage in bytes
+        """
+        return sum(sys.getsizeof(v) for v in self._storage.values())
+
+    @property
+    def count(self) -> int:
+        """Get number of stored items.
+
+        Returns:
+            Number of items in storage
+        """
+        return len(self._storage)

aip_agents/storage/providers/memory.pyi

@@ -0,0 +1,79 @@
+from aip_agents.storage.providers.base import BaseStorageProvider as BaseStorageProvider, StorageError as StorageError
+from typing import Any
+
+class InMemoryStorageProvider(BaseStorageProvider):
+    """In-memory storage provider for fast access to small data.
+
+    This provider stores all data in memory, providing the fastest
+    access times but limited by available RAM.
+
+    Best for:
+    - Small to medium datasets
+    - Temporary storage
+    - Development and testing
+    - High-frequency access patterns
+    """
+    def __init__(self) -> None:
+        """Initialize in-memory storage."""
+    def store(self, key: str, data: Any) -> None:
+        """Store data in memory.
+
+        Args:
+            key: Unique identifier for the data
+            data: Data to store
+
+        Raises:
+            StorageError: If storage operation fails
+        """
+    def retrieve(self, key: str) -> Any:
+        """Retrieve data from memory.
+
+        Args:
+            key: Unique identifier for the data
+
+        Returns:
+            The stored data
+
+        Raises:
+            KeyError: If key not found
+        """
+    def exists(self, key: str) -> bool:
+        """Check if key exists in memory.
+
+        Args:
+            key: Unique identifier to check
+
+        Returns:
+            True if key exists, False otherwise
+        """
+    def delete(self, key: str) -> None:
+        """Delete data from memory.
+
+        Args:
+            key: Unique identifier for the data
+        """
+    def list_keys(self, prefix: str = '') -> list[str]:
+        """List all keys with optional prefix.
+
+        Args:
+            prefix: Optional prefix to filter keys
+
+        Returns:
+            List of matching keys
+        """
+    def clear(self) -> None:
+        """Clear all data from memory."""
+    @property
+    def size_bytes(self) -> int:
+        """Get approximate memory usage in bytes.
+
+        Returns:
+            Approximate memory usage in bytes
+        """
+    @property
+    def count(self) -> int:
+        """Get number of stored items.
+
+        Returns:
+            Number of items in storage
+        """

aip_agents/storage/providers/object_storage.py

@@ -0,0 +1,214 @@
+"""Object storage provider implementation.
+
+Authors:
+    Christian Trisno Sen Long Chen (christian.t.s.l.chen@gdplabs.id)
+    Fachriza Adhiatma (fachriza.d.adhiatma@gdplabs.id)
+"""
+
+import json
+import pickle
+from typing import Any
+
+from aip_agents.storage.base import BaseObjectStorageClient
+from aip_agents.storage.providers.base import BaseStorageProvider, StorageError
+from aip_agents.utils.logger import get_logger
+
+logger = get_logger(__name__)
+
+
+class ObjectStorageProvider(BaseStorageProvider):
+    """Object storage provider for S3-compatible storage.
+
+    Works with any S3-compatible storage including AWS S3, MinIO,
+    Google Cloud Storage (with S3 compatibility), etc.
+
+    Best for:
+    - Very large datasets
+    - Distributed systems
+    - Cloud deployments
+    - Long-term storage
+    - Multi-region access
+    """
+
+    def __init__(self, client: BaseObjectStorageClient, prefix: str = "", use_json: bool = False):
+        """Initialize object storage provider.
+
+        Args:
+            client: Object storage client instance
+            prefix: Prefix for all keys (like a directory)
+            use_json: Use JSON format (True) or pickle (False)
+        """
+        self.client = client
+        self.prefix = prefix.rstrip("/") + "/" if prefix else ""
+        self.use_json = use_json
+
+    def _get_object_key(self, key: str) -> str:
+        """Get full object key with prefix.
+
+        Args:
+            key: Storage key
+
+        Returns:
+            Full object key with prefix
+        """
+        return f"{self.prefix}{key}"
+
+    def _serialize_data(self, data: Any) -> bytes:
+        """Serialize data to bytes.
+
+        Args:
+            data: Data to serialize
+
+        Returns:
+            Serialized data as bytes
+
+        Raises:
+            StorageError: If serialization fails
+        """
+        try:
+            if self.use_json:
+                return json.dumps(data, default=str).encode("utf-8")
+            return pickle.dumps(data)
+        except Exception as e:
+            raise StorageError(f"Failed to serialize data: {e}") from e
+
+    def _deserialize_data(self, data_bytes: bytes) -> Any:
+        """Deserialize data from bytes.
+
+        Args:
+            data_bytes: Serialized data
+
+        Returns:
+            Deserialized data
+
+        Raises:
+            StorageError: If deserialization fails
+        """
+        try:
+            if self.use_json:
+                return json.loads(data_bytes.decode("utf-8"))
+            return pickle.loads(data_bytes)
+        except Exception as e:
+            raise StorageError(f"Failed to deserialize data: {e}") from e
+
+    def store(self, key: str, data: Any) -> None:
+        """Store data in object storage.
+
+        Args:
+            key: Unique identifier for the data
+            data: Data to store
+
+        Raises:
+            StorageError: If storage operation fails
+        """
+        object_key = self._get_object_key(key)
+
+        try:
+            data_bytes = self._serialize_data(data)
+
+            self.client.upload(
+                object_key=object_key,
+                file_stream=data_bytes,
+                content_type="application/json" if self.use_json else "application/octet-stream",
+                metadata={"storage_key": key, "format": "json" if self.use_json else "pickle"},
+            )
+
+            logger.debug(f"Stored data to object storage: {object_key}")
+
+        except Exception as e:
+            raise StorageError(f"Failed to store data in object storage: {e}") from e
+
+    def retrieve(self, key: str) -> Any:
+        """Retrieve data from object storage.
+
+        Args:
+            key: Unique identifier for the data
+
+        Returns:
+            The stored data
+
+        Raises:
+            KeyError: If key not found
+            StorageError: If retrieval operation fails
+        """
+        object_key = self._get_object_key(key)
+
+        try:
+            data_bytes = self.client.get(object_key)
+            return self._deserialize_data(data_bytes)
+
+        except KeyError as e:
+            raise KeyError(f"Key '{key}' not found in object storage: {e}") from e
+        except Exception as e:
+            raise StorageError(f"Failed to retrieve data from object storage: {e}") from e
+
+    def exists(self, key: str) -> bool:
+        """Check if object exists.
+
+        Args:
+            key: Unique identifier to check
+
+        Returns:
+            True if key exists, False otherwise
+        """
+        object_key = self._get_object_key(key)
+
+        try:
+            return self.client.object_exists(object_key)
+        except Exception as e:
+            logger.warning(f"Failed to check object existence: {e}")
+            return False
+
+    def delete(self, key: str) -> None:
+        """Delete object.
+
+        Args:
+            key: Unique identifier for the data
+        """
+        object_key = self._get_object_key(key)
+
+        try:
+            self.client.delete(object_key)
+            logger.debug(f"Deleted object: {object_key}")
+        except Exception as e:
+            logger.warning(f"Failed to delete object {object_key}: {e}")
+
+    def list_keys(self, prefix: str = "") -> list[str]:
+        """List all keys with optional prefix.
+
+        Args:
+            prefix: Optional prefix to filter keys
+
+        Raises:
+            NotImplementedError: list_keys is not implemented
+        """
+        raise NotImplementedError("list_keys not yet implemented for object storage")
+
+    def clear(self) -> None:
+        """Clear all objects with the configured prefix.
+
+        Warning:
+            This is a dangerous operation!
+        """
+        logger.warning("clear() not implemented for object storage - too dangerous")
+        raise NotImplementedError("Batch clear not implemented for safety reasons")
+
+    def get_presigned_url(self, key: str, expires_hours: int = 24) -> str | None:
+        """Generate presigned URL for direct access.
+
+        Args:
+            key: Storage key
+            expires_hours: URL expiration in hours
+
+        Returns:
+            Presigned URL for direct access
+
+        Raises:
+            StorageError: If URL generation fails
+        """
+        object_key = self._get_object_key(key)
+
+        try:
+            return self.client.generate_presigned_url(object_key=object_key, expires=expires_hours)
+        except Exception as e:
+            raise StorageError(f"Failed to generate presigned URL: {e}") from e

aip_agents/storage/providers/object_storage.pyi

@@ -0,0 +1,98 @@
+from _typeshed import Incomplete
+from aip_agents.storage.base import BaseObjectStorageClient as BaseObjectStorageClient
+from aip_agents.storage.providers.base import BaseStorageProvider as BaseStorageProvider, StorageError as StorageError
+from aip_agents.utils.logger import get_logger as get_logger
+from typing import Any
+
+logger: Incomplete
+
+class ObjectStorageProvider(BaseStorageProvider):
+    """Object storage provider for S3-compatible storage.
+
+    Works with any S3-compatible storage including AWS S3, MinIO,
+    Google Cloud Storage (with S3 compatibility), etc.
+
+    Best for:
+    - Very large datasets
+    - Distributed systems
+    - Cloud deployments
+    - Long-term storage
+    - Multi-region access
+    """
+    client: Incomplete
+    prefix: Incomplete
+    use_json: Incomplete
+    def __init__(self, client: BaseObjectStorageClient, prefix: str = '', use_json: bool = False) -> None:
+        """Initialize object storage provider.
+
+        Args:
+            client: Object storage client instance
+            prefix: Prefix for all keys (like a directory)
+            use_json: Use JSON format (True) or pickle (False)
+        """
+    def store(self, key: str, data: Any) -> None:
+        """Store data in object storage.
+
+        Args:
+            key: Unique identifier for the data
+            data: Data to store
+
+        Raises:
+            StorageError: If storage operation fails
+        """
+    def retrieve(self, key: str) -> Any:
+        """Retrieve data from object storage.
+
+        Args:
+            key: Unique identifier for the data
+
+        Returns:
+            The stored data
+
+        Raises:
+            KeyError: If key not found
+            StorageError: If retrieval operation fails
+        """
+    def exists(self, key: str) -> bool:
+        """Check if object exists.
+
+        Args:
+            key: Unique identifier to check
+
+        Returns:
+            True if key exists, False otherwise
+        """
+    def delete(self, key: str) -> None:
+        """Delete object.
+
+        Args:
+            key: Unique identifier for the data
+        """
+    def list_keys(self, prefix: str = '') -> list[str]:
+        """List all keys with optional prefix.
+
+        Args:
+            prefix: Optional prefix to filter keys
+
+        Raises:
+            NotImplementedError: list_keys is not implemented
+        """
+    def clear(self) -> None:
+        """Clear all objects with the configured prefix.
+
+        Warning:
+            This is a dangerous operation!
+        """
+    def get_presigned_url(self, key: str, expires_hours: int = 24) -> str | None:
+        """Generate presigned URL for direct access.
+
+        Args:
+            key: Storage key
+            expires_hours: URL expiration in hours
+
+        Returns:
+            Presigned URL for direct access
+
+        Raises:
+            StorageError: If URL generation fails
+        """

aip_agents/tools/__init__.py

@@ -0,0 +1,64 @@
+"""Initialize Tools Module for AIP Agents."""
+
+from importlib import import_module
+from typing import TYPE_CHECKING
+
+from aip_agents.tools.date_range_tool import DateRangeTool
+from aip_agents.tools.gl_connector import GLConnectorTool
+from aip_agents.tools.gl_connector_tools import (
+    BOSA_AUTOMATED_TOOLS,
+    GL_CONNECTORS_AUTOMATED_TOOLS,
+)
+from aip_agents.tools.time_tool import TimeTool
+from aip_agents.tools.web_search import GoogleSerperTool
+from aip_agents.utils.logger import get_logger
+
+logger = get_logger(__name__)
+
+__all__ = [
+    "BOSA_AUTOMATED_TOOLS",
+    "GL_CONNECTORS_AUTOMATED_TOOLS",
+    "GLConnectorTool",
+    "GoogleSerperTool",
+    "TimeTool",
+    "DateRangeTool",
+]
+
+
+def _register_optional(module_path: str, export_name: str) -> None:
+    """Try to import optional tool module and expose it in __all__.
+
+    Args:
+        module_path: The module path to import.
+        export_name: The name to export in __all__.
+    """
+    try:
+        module = import_module(module_path)
+        tool = getattr(module, export_name)
+        __all__.append(export_name)
+        globals()[export_name] = tool
+
+    except ImportError as e:
+        logger.debug(f"Module {module_path} not found: {e}")
+    except AttributeError as e:
+        logger.debug(f"Tool {export_name} not found in module {module_path}: {e}")
+    except Exception as e:
+        logger.debug(f"Unexpected error loading {export_name}: {e}")
+
+
+_register_optional("aip_agents.tools.browser_use", "BrowserUseTool")
+_register_optional("aip_agents.tools.code_sandbox", "E2BCodeSandboxTool")
+_register_optional("aip_agents.tools.document_loader", "DocxReaderTool")
+_register_optional("aip_agents.tools.document_loader", "ExcelReaderTool")
+_register_optional("aip_agents.tools.document_loader", "PDFReaderTool")
+_register_optional("aip_agents.tools.execute_ptc_code", "create_execute_ptc_code_tool")
+
+if TYPE_CHECKING:
+    from aip_agents.tools.browser_use import BrowserUseTool
+    from aip_agents.tools.code_sandbox import E2BCodeSandboxTool
+    from aip_agents.tools.document_loader import (
+        DocxReaderTool,
+        ExcelReaderTool,
+        PDFReaderTool,
+    )
+    from aip_agents.tools.execute_ptc_code import create_execute_ptc_code_tool

aip_agents/tools/__init__.pyi

@@ -0,0 +1,11 @@
+from aip_agents.tools.browser_use import BrowserUseTool as BrowserUseTool
+from aip_agents.tools.code_sandbox import E2BCodeSandboxTool as E2BCodeSandboxTool
+from aip_agents.tools.date_range_tool import DateRangeTool as DateRangeTool
+from aip_agents.tools.document_loader import DocxReaderTool as DocxReaderTool, ExcelReaderTool as ExcelReaderTool, PDFReaderTool as PDFReaderTool
+from aip_agents.tools.execute_ptc_code import create_execute_ptc_code_tool as create_execute_ptc_code_tool
+from aip_agents.tools.gl_connector import GLConnectorTool as GLConnectorTool
+from aip_agents.tools.gl_connector_tools import BOSA_AUTOMATED_TOOLS as BOSA_AUTOMATED_TOOLS, GL_CONNECTORS_AUTOMATED_TOOLS as GL_CONNECTORS_AUTOMATED_TOOLS
+from aip_agents.tools.time_tool import TimeTool as TimeTool
+from aip_agents.tools.web_search import GoogleSerperTool as GoogleSerperTool
+
+__all__ = ['BOSA_AUTOMATED_TOOLS', 'GL_CONNECTORS_AUTOMATED_TOOLS', 'GLConnectorTool', 'GoogleSerperTool', 'TimeTool', 'DateRangeTool', 'BrowserUseTool', 'E2BCodeSandboxTool', 'DocxReaderTool', 'ExcelReaderTool', 'PDFReaderTool', 'create_execute_ptc_code_tool']