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

aip_agents/schema/langgraph.py

@@ -0,0 +1,37 @@
+"""LangGraph-related schema definitions for agent tool interactions."""
+
+from __future__ import annotations
+
+from dataclasses import dataclass
+from typing import Any
+
+from gllm_core.schema import Chunk
+from langchain_core.messages import ToolMessage
+from langchain_core.messages.ai import UsageMetadata
+from langchain_core.tools import BaseTool
+
+__all__ = ["ToolCallResult", "ToolStorageParams"]
+
+
+@dataclass
+class ToolCallResult:
+    """Container for the results of a single tool call execution."""
+
+    messages: list[ToolMessage]
+    artifacts: list[dict[str, Any]]
+    metadata_delta: dict[str, Any]
+    references: list[Chunk]
+    step_usage: UsageMetadata | None
+    pii_mapping: dict[str, str] | None = None
+
+
+@dataclass
+class ToolStorageParams:
+    """Parameters required for automatically storing tool outputs."""
+
+    tool: BaseTool
+    tool_output: Any
+    tool_call: dict[str, Any]
+    tool_call_id: str
+    resolved_args: dict[str, Any]
+    state: dict[str, Any]

aip_agents/schema/model_id.py

@@ -0,0 +1,97 @@
+"""Model identifiers and provider definitions for the AI agent platform."""
+
+from __future__ import annotations
+
+from enum import StrEnum
+
+
+class ModelProvider(StrEnum):
+    """Enumeration of supported model providers for the AI agent platform."""
+
+    OPENAI = "openai"
+    ANTHROPIC = "anthropic"
+    AZURE_OPENAI = "azure-openai"
+    GOOGLE_GENAI = "google"
+    GROQ = "groq"
+    TOGETHER_AI = "together"
+    DEEPINFRA = "deepinfra"
+    DEEPSEEK = "deepseek"
+    OPENAI_COMPATIBLE = "openai-compatible"
+
+
+class ModelId:
+    """Model identifier class for representing language models."""
+
+    def __init__(self, provider: str, name: str, path: str | None = None):
+        """Initialize a ModelId.
+
+        Args:
+            provider: The model provider (e.g., 'openai', 'anthropic')
+            name: The specific model name
+            path: Optional path component for some providers
+        """
+        self.provider = provider
+        self.name = name
+        self.path = path
+
+    @classmethod
+    def from_string(cls, model_string: str) -> ModelId:
+        """Create a ModelId from a string representation.
+
+        Args:
+            model_string: String in format 'provider:name' or 'provider/path:name'
+
+        Returns:
+            ModelId instance
+
+        Raises:
+            ValueError: If the string format is invalid
+        """
+        if ":" not in model_string:
+            raise ValueError(
+                f"Invalid model string format: {model_string}. Expected 'provider:name' or 'provider/path:name'"
+            )
+
+        # Find the last colon to separate provider+path from name
+        last_colon_idx = model_string.rindex(":")
+        provider_part = model_string[:last_colon_idx]
+        name = model_string[last_colon_idx + 1 :]
+
+        # Split provider_part on "/" to separate provider from path
+        if "/" in provider_part:
+            provider, path = provider_part.split("/", 1)
+        else:
+            provider = provider_part
+            path = None
+
+        return cls(provider, name, path)
+
+    def __str__(self) -> str:
+        """String representation of the ModelId."""
+        if self.path:
+            return f"{self.provider}/{self.path}:{self.name}"
+        return f"{self.provider}:{self.name}"
+
+    def __repr__(self) -> str:
+        """String representation of the ModelId for debugging."""
+        return f"ModelId(provider='{self.provider}', name='{self.name}', path='{self.path}')"
+
+    def __eq__(self, other: object) -> bool:
+        """Check equality with another ModelId object.
+
+        Args:
+            other (object): The object to compare with.
+
+        Returns:
+            bool: True if the objects are equal, False otherwise.
+        """
+        if not isinstance(other, ModelId):
+            return NotImplemented
+        return self.provider == other.provider and self.name == other.name and self.path == other.path
+
+    def __hash__(self) -> int:
+        """Return hash of the ModelId."""
+        return hash((self.provider, self.name, self.path))
+
+
+__all__ = ["ModelId", "ModelProvider"]

aip_agents/schema/step_limit.py

@@ -0,0 +1,108 @@
+"""Step limit configuration and error classes for agent execution limits."""
+
+import os
+from dataclasses import dataclass, field
+from enum import StrEnum
+
+
+class StepLimitErrorType(StrEnum):
+    """Types of step-related limit violations."""
+
+    STEP_LIMIT_EXCEEDED = "STEP_LIMIT_EXCEEDED"
+    DELEGATION_DEPTH_EXCEEDED = "DELEGATION_DEPTH_EXCEEDED"
+
+
+@dataclass
+class StepLimitConfig:
+    """Configuration for agent step and delegation limits.
+
+    Attributes:
+        max_steps: Maximum number of execution steps allowed per invocation.
+                   Includes agent node (LLM call) and every tool call (parallel batches count per call).
+        max_delegation_depth: Maximum depth of delegation chain allowed.
+                              Depth 0 means no delegation allowed.
+    """
+
+    max_steps: int = field(
+        default_factory=lambda: int(os.getenv("STEP_LIMIT_MAX_STEPS_DEFAULT", "100")),
+    )
+    max_delegation_depth: int = field(
+        default_factory=lambda: int(os.getenv("STEP_LIMIT_MAX_DELEGATION_DEPTH_DEFAULT", "5")),
+    )
+
+    def __post_init__(self):
+        """Validate configuration values and normalize range."""
+        from aip_agents.utils.logger import get_logger
+
+        logger = get_logger(__name__)
+
+        # Validate and clamp max_steps
+        if self.max_steps < 1:
+            logger.warning(f"Invalid max_steps={self.max_steps}, resetting to default (25). max_steps must be >= 1.")
+            self.max_steps = 25
+        elif self.max_steps > 1000:
+            logger.warning(f"Invalid max_steps={self.max_steps}, capping at 1000.")
+            self.max_steps = 1000
+
+        # Validate and clamp max_delegation_depth
+        if self.max_delegation_depth < 0:
+            logger.warning(
+                f"Invalid max_delegation_depth={self.max_delegation_depth}, resetting to default (5). "
+                "max_delegation_depth must be >= 0."
+            )
+            self.max_delegation_depth = 5
+        elif self.max_delegation_depth > 10:
+            logger.warning(f"Invalid max_delegation_depth={self.max_delegation_depth}, capping at 10.")
+            self.max_delegation_depth = 10
+
+
+@dataclass
+class StepLimitErrorResponse:
+    """Structured error response for step limit violations.
+
+    Attributes:
+        error_type: The type of limit that was exceeded.
+        agent_name: Name of the agent that hit the limit.
+        current_value: Current step count or delegation depth.
+        configured_limit: The configured limit that was exceeded.
+        message: Human-readable error message.
+        delegation_chain: Full chain for delegation errors.
+        partial_result: Any output generated before hitting the limit.
+    """
+
+    error_type: StepLimitErrorType
+    agent_name: str
+    current_value: int
+    configured_limit: int
+    message: str
+    delegation_chain: list[str] | None = None
+    partial_result: str | None = None
+
+
+class StepLimitError(Exception):
+    """Base exception for step and delegation limit violations.
+
+    Attributes:
+        error_response: Structured error response with details.
+    """
+
+    def __init__(self, error_response: StepLimitErrorResponse):
+        """Initialize with error response.
+
+        Args:
+            error_response: Structured error details.
+        """
+        self.error_response = error_response
+        super().__init__(error_response.message)
+
+
+class MaxStepsExceededError(StepLimitError):
+    """Raised when agent exceeds configured max_steps limit."""
+
+    pass
+
+
+class MaxDelegationDepthExceededError(StepLimitError):
+    """Raised when delegation would exceed max_delegation_depth limit."""
+
+    pass

aip_agents/schema/storage.py

@@ -0,0 +1,40 @@
+"""Schema definitions for storage configuration."""
+
+import os
+from dataclasses import dataclass
+from enum import StrEnum
+
+__all__ = ["OBJECT_STORAGE_PREFIX", "StorageType", "StorageConfig"]
+
+OBJECT_STORAGE_PREFIX = "tool_outputs/"
+
+
+class StorageType(StrEnum):
+    """Supported storage types."""
+
+    MEMORY = "memory"
+    OBJECT_STORAGE = "object_storage"
+
+
+@dataclass
+class StorageConfig:
+    """Configuration for storage providers."""
+
+    storage_type: StorageType = StorageType.MEMORY
+    object_prefix: str = OBJECT_STORAGE_PREFIX
+    object_use_json: bool = False
+
+    @classmethod
+    def from_env(cls) -> "StorageConfig":
+        """Create StorageConfig from environment variables."""
+        storage_type_str = os.getenv("TOOL_OUTPUT_STORAGE_TYPE", StorageType.MEMORY.value).lower()
+        if storage_type_str == StorageType.MEMORY.value:
+            storage_type = StorageType.MEMORY
+        else:
+            storage_type = StorageType.OBJECT_STORAGE
+
+        object_prefix = os.getenv("TOOL_OUTPUT_OBJECT_PREFIX", OBJECT_STORAGE_PREFIX)
+        use_json_str = os.getenv("TOOL_OUTPUT_USE_JSON", "false").lower()
+        use_json = use_json_str in ("true", "1", "yes", "on")
+
+        return cls(storage_type=storage_type, object_prefix=object_prefix, object_use_json=use_json)

aip_agents/sentry/__init__.py

@@ -0,0 +1,11 @@
+"""This module provides a centralized way to handle Sentry and OpenTelemetry configuration for BOSA SDK.
+
+Authors:
+    Saul Sayers (saul.sayers@gdplabs.id)
+"""
+
+from aip_agents.sentry.sentry import setup_telemetry
+
+__all__ = [
+    "setup_telemetry",
+]

aip_agents/sentry/sentry.py

@@ -0,0 +1,151 @@
+"""This file contains the Sentry and OpenTelemetry configuration for BOSA SDK.
+
+Authors:
+    Saul Sayers (saul.sayers@gdplabs.id)
+"""
+
+import inspect
+import os
+
+from bosa_core.telemetry import (
+    FastAPIConfig,
+    OpenTelemetryConfig,
+    SentryConfig,
+    TelemetryConfig,
+    init_telemetry,
+)
+from bosa_core.telemetry.opentelemetry.instrument.functions import (
+    BOSAFunctionsInstrumentor,
+)
+from dotenv import load_dotenv
+from fastapi import FastAPI
+
+from aip_agents.agent import BaseAgent, GoogleADKAgent, LangChainAgent, LangGraphAgent
+from aip_agents.utils.logger import get_logger
+
+load_dotenv()
+
+
+logger = get_logger(__name__)
+
+SENTRY_DSN = os.getenv("SENTRY_DSN")
+SENTRY_ENVIRONMENT = os.getenv("SENTRY_ENVIRONMENT", "development")
+SENTRY_PROJECT = os.getenv("SENTRY_PROJECT")
+VERSION_NUMBER = os.getenv("VERSION_NUMBER", "0.0.0")
+BUILD_NUMBER = os.getenv("BUILD_NUMBER", "0")
+USE_OPENTELEMETRY = os.getenv("USE_OPENTELEMETRY", "true").lower() == "true"
+
+CLASSES_TO_INSTRUMENT = [
+    BaseAgent,
+    LangGraphAgent,
+    LangChainAgent,
+    GoogleADKAgent,
+]
+
+
+def get_all_methods(cls: type) -> list:
+    """Get all methods from a class.
+
+    Args:
+        cls: The class to get methods from.
+
+    Returns:
+        list: A list of methods.
+    """
+    methods = []
+    for name, member in inspect.getmembers(cls):
+        if name.startswith("_"):
+            continue  # skip dunder and private
+        if inspect.isfunction(member) or inspect.ismethod(member) or inspect.iscoroutinefunction(member):
+            methods.append(member)
+    return methods
+
+
+def instrument_bosa_functions() -> None:
+    """Instrument BOSA functions."""
+    if BOSAFunctionsInstrumentor is None:
+        return
+    agent_methods = []
+    for cls in CLASSES_TO_INSTRUMENT:
+        agent_methods.extend(get_all_methods(cls))
+    BOSAFunctionsInstrumentor().instrument(methods=agent_methods)
+
+
+def traces_sampler(*args) -> float:
+    """Determine appropriate sampling rate for Sentry transactions.
+
+    Args:
+        *args: Additional positional arguments
+
+    Returns:
+        float: Sampling rate between 0 and 1
+    """
+    # TODO: Dont sample healthcheck endpoints (return 0.0)
+    return 1.0
+
+
+def setup_sentry_with_open_telemetry(app: FastAPI) -> None:
+    """Configure telemetry with both Sentry and OpenTelemetry.
+
+    Args:
+        app: FastAPI application instance
+    """
+    try:
+        fastapi_config = FastAPIConfig(app)
+
+        # Create OpenTelemetry configuration
+        opentelemetry_init = OpenTelemetryConfig(
+            use_langchain=True,
+            fastapi_config=fastapi_config,
+        )
+
+        # Sentry configuration with OpenTelemetry
+        sentry_config = SentryConfig(
+            dsn=SENTRY_DSN,
+            traces_sampler=traces_sampler,
+            environment=SENTRY_ENVIRONMENT,
+            release=f"{SENTRY_PROJECT}@{VERSION_NUMBER}+{BUILD_NUMBER}",
+            send_default_pii=True,
+            open_telemetry_config=opentelemetry_init,
+        )
+
+        telemetry_config = TelemetryConfig(sentry_config=sentry_config)
+        init_telemetry(telemetry_config)
+        logger.info(f"Telemetry initialized with OpenTelemetry for environment: {SENTRY_ENVIRONMENT}")
+    except Exception as e:
+        logger.error(f"Failed to initialize telemetry with OpenTelemetry: {e}")
+
+
+def setup_sentry_only() -> None:
+    """Configure telemetry with Sentry only (no OpenTelemetry)."""
+    try:
+        # Sentry configuration without OpenTelemetry
+        sentry_config = SentryConfig(
+            dsn=SENTRY_DSN,
+            traces_sampler=traces_sampler,
+            environment=SENTRY_ENVIRONMENT,
+            release=f"{SENTRY_PROJECT}@{VERSION_NUMBER}+{BUILD_NUMBER}",
+            send_default_pii=True,
+        )
+
+        telemetry_config = TelemetryConfig(sentry_config=sentry_config)
+        init_telemetry(telemetry_config)
+        logger.info(f"Telemetry initialized with Sentry only for environment: {SENTRY_ENVIRONMENT}")
+    except Exception as e:
+        logger.error(f"Failed to initialize telemetry with Sentry only: {e}")
+
+
+def setup_telemetry(app: FastAPI) -> None:
+    """Configure and initialize telemetry based on configuration.
+
+    Args:
+        app: FastAPI application instance
+    """
+    if not SENTRY_DSN:
+        logger.warning("Warning: SENTRY_DSN not set. Sentry will not be enabled.")
+        return
+    if USE_OPENTELEMETRY:
+        setup_sentry_with_open_telemetry(app)
+    else:
+        setup_sentry_only()
+    instrument_bosa_functions()

aip_agents/storage/__init__.py

@@ -0,0 +1,41 @@
+"""Storage module for aip_agents.
+
+This module provides comprehensive storage functionality including object storage
+clients, storage providers for tool outputs, and configuration management.
+
+Authors:
+    Fachriza Adhiatma (fachriza.d.adhiatma@gdplabs.id)
+    Christian Trisno Sen Long Chen (christian.t.s.l.chen@gdplabs.id)
+"""
+
+# Object storage clients
+from aip_agents.storage.base import BaseObjectStorageClient
+from aip_agents.storage.clients.minio_client import MinioConfig, MinioObjectStorage
+
+# Configuration and factory
+from aip_agents.storage.config import (
+    StorageConfig,
+    StorageProviderFactory,
+    StorageType,
+)
+
+# Storage providers
+from aip_agents.storage.providers.base import BaseStorageProvider, StorageError
+from aip_agents.storage.providers.memory import InMemoryStorageProvider
+from aip_agents.storage.providers.object_storage import ObjectStorageProvider
+
+__all__ = [
+    # Object storage
+    "BaseObjectStorageClient",
+    "MinioConfig",
+    "MinioObjectStorage",
+    # Storage providers
+    "BaseStorageProvider",
+    "StorageError",
+    "InMemoryStorageProvider",
+    "ObjectStorageProvider",
+    # Configuration
+    "StorageConfig",
+    "StorageType",
+    "StorageProviderFactory",
+]

aip_agents/storage/base.py

@@ -0,0 +1,85 @@
+"""Base class for object storage clients.
+
+Authors:
+    Fachriza Adhiatma (fachriza.d.adhiatma@gdplabs.id)
+    Christian Trisno Sen Long Chen (christian.t.s.l.chen@gdplabs.id)
+"""
+
+from abc import ABC, abstractmethod
+from typing import BinaryIO
+
+
+class BaseObjectStorageClient(ABC):
+    """Abstract base class for object storage clients."""
+
+    @abstractmethod
+    def object_exists(self, object_key: str) -> bool:
+        """Check if an object exists in the storage.
+
+        Args:
+            object_key: The key of the object to check.
+
+        Returns:
+            True if the object exists, False otherwise.
+        """
+        raise NotImplementedError
+
+    @abstractmethod
+    def upload(
+        self,
+        object_key: str,
+        file_stream: bytes | BinaryIO,
+        filename: str | None = None,
+        content_type: str | None = None,
+        metadata: dict[str, str] | None = None,
+    ) -> str:
+        """Upload data to object storage.
+
+        Args:
+            object_key: The key of the object in the storage
+            file_stream: The binary data to upload
+            filename: The name of the file
+            content_type: The content type of the file
+            metadata: Additional metadata to store with the object
+
+        Returns:
+            The key of the uploaded object
+        """
+        raise NotImplementedError
+
+    @abstractmethod
+    def get(self, object_key: str) -> bytes:
+        """Get data from object storage.
+
+        Args:
+            object_key: The key of the object in the storage
+
+        Returns:
+            The binary data of the object
+        """
+        raise NotImplementedError
+
+    @abstractmethod
+    def delete(self, object_key: str) -> None:
+        """Delete data from object storage.
+
+        Args:
+            object_key: The key of the object in the storage
+        """
+        raise NotImplementedError
+
+    @abstractmethod
+    def generate_presigned_url(
+        self, object_key: str, expires: int = 24, response_headers: dict[str, str] | None = None
+    ) -> str:
+        """Generate a presigned URL for accessing the object.
+
+        Args:
+            object_key: The key of the object in the storage
+            expires: The number of hours the URL is valid for
+            response_headers: Additional headers to include in the response
+
+        Returns:
+            The presigned URL
+        """
+        raise NotImplementedError

aip_agents/storage/clients/__init__.py

@@ -0,0 +1,12 @@
+"""Storage client implementations.
+
+This module contains concrete implementations of object storage clients
+for various backends like MinIO, AWS S3, etc.
+
+Authors:
+    Fachriza Adhiatma (fachriza.d.adhiatma@gdplabs.id)
+"""
+
+from aip_agents.storage.clients.minio_client import MinioConfig, MinioObjectStorage
+
+__all__ = ["MinioConfig", "MinioObjectStorage"]