aip-agents-binary 0.5.18__py3-none-any.whl → 0.5.19__py3-none-any.whl

aip_agents/middleware/todolist.pyi

@@ -0,0 +1,125 @@
+import threading
+from _typeshed import Incomplete
+from aip_agents.middleware.base import ModelRequest as ModelRequest
+from aip_agents.utils.logger import get_logger as get_logger
+from enum import StrEnum
+from langchain_core.tools import BaseTool
+from pydantic import BaseModel, SkipValidation
+from typing import Any
+
+logger: Incomplete
+
+class TodoStatus(StrEnum):
+    """Enumeration of possible todo item statuses."""
+    PENDING: str
+    IN_PROGRESS: str
+    COMPLETED: str
+
+WRITE_TODOS_SYSTEM_PROMPT: str
+EMPTY_TODO_REMINDER: str
+
+class TodoItem(BaseModel):
+    """Represents a single todo item in the agent's plan.
+
+    Attributes:
+        content: Human-readable description of the task.
+        active_form: Short imperative phrase for UI display.
+        status: Current status of the todo item.
+    """
+    content: str
+    active_form: str
+    status: TodoStatus
+
+class TodoList(BaseModel):
+    """Represents a complete todo list for a thread.
+
+    Attributes:
+        items: List of todo items in order.
+    """
+    items: list[TodoItem]
+
+WRITE_TODOS_TOOL_DESCRIPTION: str
+
+class WriteTodosInput(BaseModel):
+    """Input schema for the write_todos tool."""
+    todos: TodoList
+
+class WriteTodosTool(BaseTool):
+    """LangChain-compatible tool for managing todo lists via TodoListMiddleware."""
+    name: str
+    description: str
+    args_schema: type[BaseModel]
+    storage: SkipValidation[dict[str, TodoList]]
+    storage_lock: SkipValidation[threading.RLock]
+
+class TodoListMiddleware:
+    """Middleware that provides planning capabilities via todo list management.
+
+    Adds the write_todos tool and enhances the system prompt with planning
+    instructions, encouraging agents to break down complex tasks.
+
+    This middleware maintains thread-isolated todo lists, ensuring that
+    different conversation threads don't interfere with each other.
+
+    Each middleware instance has its own storage, preventing race conditions
+    when multiple agent instances are used concurrently.
+    """
+    tools: Incomplete
+    system_prompt_additions: Incomplete
+    def __init__(self) -> None:
+        """Initialize the TodoList middleware with planning tools and instructions."""
+    def before_model(self, state: dict[str, Any]) -> dict[str, Any]:
+        """Hook executed before model invocation.
+
+        Syncs todos FROM state TO internal storage for LangGraph agents.
+        This allows todos to be persisted via LangGraph checkpointer.
+
+        Args:
+            state: Current agent state (may contain 'todos' key).
+
+        Returns:
+            Empty dict (no state updates needed).
+        """
+    def modify_model_request(self, request: ModelRequest, state: dict[str, Any]) -> ModelRequest:
+        """Hook to modify model request before invocation.
+
+        Injects current todo list status into the system prompt, ensuring
+        the agent has visibility into its current plan on every turn.
+        This follows Claude Code's pattern of injecting system reminders.
+
+        Args:
+            request: The model request.
+            state: Current agent state.
+
+        Returns:
+            Modified request with todo status injected into system prompt.
+        """
+    def after_model(self, state: dict[str, Any]) -> dict[str, Any]:
+        """Hook executed after model invocation.
+
+        Syncs todos FROM internal storage TO state for LangGraph agents.
+        This ensures any tool updates are reflected in the checkpointed state.
+
+        Args:
+            state: Current agent state.
+
+        Returns:
+            Dict with 'todos' key containing updated TodoList, or empty dict.
+        """
+    def get_todos(self, thread_id: str = 'default') -> TodoList:
+        '''Retrieve the todo list for a specific thread.
+
+        Args:
+            thread_id: Thread identifier. Defaults to "default".
+
+        Returns:
+            TodoList for the thread, or empty list if none exists.
+        '''
+    def clear_todos(self, thread_id: str = 'default') -> None:
+        '''Clear the todo list for a specific thread.
+
+        Useful for cleanup between test runs or conversation resets.
+
+        Args:
+            thread_id: Thread identifier. Defaults to "default".
+        '''

aip_agents/schema/__init__.pyi

@@ -0,0 +1,9 @@
+from aip_agents.schema.a2a import A2AEvent as A2AEvent, A2AStreamEventType as A2AStreamEventType, ToolCallInfo as ToolCallInfo, ToolResultInfo as ToolResultInfo
+from aip_agents.schema.agent import A2AClientConfig as A2AClientConfig, AgentConfig as AgentConfig, BaseAgentConfig as BaseAgentConfig, CredentialType as CredentialType, HttpxClientOptions as HttpxClientOptions, LangflowAgentConfig as LangflowAgentConfig, StreamMode as StreamMode
+from aip_agents.schema.hitl import ApprovalDecision as ApprovalDecision, ApprovalDecisionType as ApprovalDecisionType, ApprovalLogEntry as ApprovalLogEntry, ApprovalRequest as ApprovalRequest, HitlMetadata as HitlMetadata
+from aip_agents.schema.langgraph import ToolCallResult as ToolCallResult, ToolStorageParams as ToolStorageParams
+from aip_agents.schema.model_id import ModelId as ModelId, ModelProvider as ModelProvider
+from aip_agents.schema.step_limit import MaxDelegationDepthExceededError as MaxDelegationDepthExceededError, MaxStepsExceededError as MaxStepsExceededError, StepLimitConfig as StepLimitConfig, StepLimitError as StepLimitError, StepLimitErrorResponse as StepLimitErrorResponse, StepLimitErrorType as StepLimitErrorType
+from aip_agents.schema.storage import OBJECT_STORAGE_PREFIX as OBJECT_STORAGE_PREFIX, StorageConfig as StorageConfig, StorageType as StorageType
+
+__all__ = ['A2AEvent', 'A2AStreamEventType', 'ToolCallInfo', 'ToolResultInfo', 'A2AClientConfig', 'AgentConfig', 'BaseAgentConfig', 'CredentialType', 'HttpxClientOptions', 'LangflowAgentConfig', 'StreamMode', 'ApprovalDecision', 'ApprovalDecisionType', 'ApprovalLogEntry', 'ApprovalRequest', 'HitlMetadata', 'ToolCallResult', 'ToolStorageParams', 'ModelId', 'ModelProvider', 'OBJECT_STORAGE_PREFIX', 'StorageConfig', 'StorageType', 'MaxDelegationDepthExceededError', 'MaxStepsExceededError', 'StepLimitConfig', 'StepLimitError', 'StepLimitErrorResponse', 'StepLimitErrorType']

aip_agents/schema/a2a.pyi

@@ -0,0 +1,40 @@
+from enum import Enum
+from typing import Any
+from typing_extensions import TypedDict
+
+__all__ = ['A2AStreamEventType', 'A2AEvent', 'ToolCallInfo', 'ToolResultInfo']
+
+class A2AStreamEventType(Enum):
+    """Semantic event types for A2A agent-executor communication."""
+    STATUS_UPDATE: str
+    CONTENT_CHUNK: str
+    FINAL_RESPONSE: str
+    TOOL_CALL: str
+    TOOL_RESULT: str
+    ERROR: str
+    STEP_LIMIT_EXCEEDED: str
+
+class A2AEvent(TypedDict):
+    """Structured event data used by the A2A connector."""
+    event_type: A2AStreamEventType
+    content: str
+    metadata: dict[str, Any]
+    tool_info: dict[str, Any] | None
+    is_final: bool
+    artifacts: list[dict[str, Any]] | None
+    references: list[Any] | None
+    step_usage: dict[str, Any] | None
+    total_usage: dict[str, Any] | None
+    thinking_and_activity_info: dict[str, Any] | None
+
+class ToolCallInfo(TypedDict):
+    """Structured information for tool invocation events."""
+    tool_calls: list[dict[str, Any]]
+    status: str
+
+class ToolResultInfo(TypedDict):
+    """Structured information for tool completion events."""
+    name: str
+    args: dict[str, Any]
+    output: str
+    execution_time: float | None

aip_agents/schema/agent.pyi

@@ -0,0 +1,65 @@
+from _typeshed import Incomplete
+from a2a.types import AgentCard
+from enum import StrEnum
+from gllm_core.utils.retry import RetryConfig
+from pydantic import BaseModel
+from typing import Any
+
+__all__ = ['CredentialType', 'StreamMode', 'HttpxClientOptions', 'A2AClientConfig', 'BaseAgentConfig', 'AgentConfig', 'LangflowAgentConfig']
+
+class CredentialType(StrEnum):
+    """Credential type enumeration for type safety and better developer experience."""
+    API_KEY: str
+    FILE: str
+    DICT: str
+
+class StreamMode(StrEnum):
+    """LangGraph stream modes for astream operations."""
+    VALUES: str
+    CUSTOM: str
+    MESSAGES: str
+
+class HttpxClientOptions(BaseModel):
+    """Options for the HTTP client."""
+    timeout: float
+    trust_env: bool
+    follow_redirects: bool
+    model_config: Incomplete
+    class Config:
+        """Pydantic v1 fallback config for HttpxClientOptions."""
+        extra: str
+
+class A2AClientConfig(BaseModel):
+    """Configuration for A2A client."""
+    discovery_urls: list[str] | None
+    known_agents: dict[str, AgentCard]
+    httpx_client_options: HttpxClientOptions | None
+
+class BaseAgentConfig(BaseModel):
+    """Base configuration for agent implementations."""
+    tools: list[Any] | None
+    default_hyperparameters: dict[str, Any] | None
+    model_config: Incomplete
+    class Config:
+        """Pydantic v1 fallback config for BaseAgentConfig."""
+        extra: str
+
+class AgentConfig(BaseAgentConfig):
+    """Configuration for agent implementations with language model settings."""
+    lm_name: str | None
+    lm_hyperparameters: dict[str, Any] | None
+    lm_provider: str | None
+    lm_base_url: str | None
+    lm_api_key: str | None
+    lm_credentials: str | dict[str, Any] | None
+    lm_retry_config: RetryConfig | None
+
+class LangflowAgentConfig(BaseAgentConfig):
+    """Configuration for Langflow agent implementations."""
+    flow_id: str
+    base_url: str | None
+    api_key: str | None
+    model_config: Incomplete
+    class Config:
+        """Pydantic v1 fallback config for LangflowAgentConfig."""
+        extra: str

aip_agents/schema/hitl.pyi

@@ -0,0 +1,89 @@
+from _typeshed import Incomplete
+from dataclasses import dataclass
+from datetime import datetime
+from enum import StrEnum
+from pydantic import BaseModel
+from typing import Any
+
+__all__ = ['ApprovalDecisionType', 'ApprovalRequest', 'ApprovalDecision', 'ApprovalLogEntry', 'HitlMetadata']
+
+class ApprovalDecisionType(StrEnum):
+    """Enumeration of possible approval decision types."""
+    APPROVED: str
+    REJECTED: str
+    SKIPPED: str
+    TIMEOUT_SKIP: str
+    PENDING: str
+
+@dataclass
+class ApprovalRequest:
+    """Represents an in-flight prompt shown to the operator."""
+    request_id: str
+    tool_name: str
+    arguments_preview: str
+    context: dict[str, str] | None = ...
+    created_at: datetime | None = ...
+    timeout_at: datetime | None = ...
+    def __post_init__(self) -> None:
+        """Initialize timestamps if not provided."""
+    @classmethod
+    def create(cls, tool_name: str, arguments_preview: str, context: dict[str, str] | None = None) -> ApprovalRequest:
+        """Create a new approval request with generated request_id.
+
+        Args:
+            tool_name (str): The name of the tool requiring approval.
+            arguments_preview (str): A preview of the arguments for display.
+            context (dict[str, str] | None, optional): Additional context information.
+
+        Returns:
+            ApprovalRequest: A new approval request instance.
+        """
+
+@dataclass
+class ApprovalDecision:
+    """Captures the operator outcome."""
+    request_id: str
+    decision: ApprovalDecisionType
+    operator_input: str
+    decided_at: datetime | None = ...
+    latency_ms: int | None = ...
+    def __post_init__(self) -> None:
+        """Initialize timestamp if not provided."""
+
+@dataclass
+class ApprovalLogEntry:
+    """Structured log entry for HITL decisions."""
+    request_id: str
+    tool_name: str
+    decision: str
+    event: str = ...
+    agent_id: str | None = ...
+    thread_id: str | None = ...
+    additional_context: dict[str, Any] | None = ...
+    timestamp: datetime | None = ...
+    def __post_init__(self) -> None:
+        """Initialize timestamp if not provided."""
+
+class HitlMetadata(BaseModel):
+    """Structured metadata payload included in agent streaming events."""
+    required: bool
+    decision: ApprovalDecisionType
+    request_id: str
+    timeout_seconds: int | None
+    timeout_at: datetime | None
+    model_config: Incomplete
+    def as_payload(self) -> dict[str, Any]:
+        """Return a JSON-ready metadata payload."""
+    @classmethod
+    def from_decision(cls, decision: ApprovalDecision, *, required: bool = True, timeout_seconds: int | None = None, timeout_at: datetime | None = None) -> HitlMetadata:
+        """Build metadata from an ``ApprovalDecision``.
+
+        Args:
+            decision (ApprovalDecision): The approval decision to build metadata from.
+            required (bool, optional): Whether approval is required. Defaults to True.
+            timeout_seconds (int | None, optional): Timeout in seconds for the decision.
+            timeout_at (datetime | None, optional): Specific timeout datetime.
+
+        Returns:
+            HitlMetadata: The constructed metadata instance.
+        """

aip_agents/schema/langgraph.pyi

@@ -0,0 +1,28 @@
+from dataclasses import dataclass
+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
+from typing import Any
+
+__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 = ...
+
+@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.pyi

@@ -0,0 +1,54 @@
+from _typeshed import Incomplete
+from enum import StrEnum
+
+__all__ = ['ModelId', 'ModelProvider']
+
+class ModelProvider(StrEnum):
+    """Enumeration of supported model providers for the AI agent platform."""
+    OPENAI: str
+    ANTHROPIC: str
+    AZURE_OPENAI: str
+    GOOGLE_GENAI: str
+    GROQ: str
+    TOGETHER_AI: str
+    DEEPINFRA: str
+    DEEPSEEK: str
+    OPENAI_COMPATIBLE: str
+
+class ModelId:
+    """Model identifier class for representing language models."""
+    provider: Incomplete
+    name: Incomplete
+    path: Incomplete
+    def __init__(self, provider: str, name: str, path: str | None = 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
+        """
+    @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
+        """
+    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.
+        """
+    def __hash__(self) -> int:
+        """Return hash of the ModelId."""

aip_agents/schema/step_limit.pyi

@@ -0,0 +1,63 @@
+from _typeshed import Incomplete
+from dataclasses import dataclass, field
+from enum import StrEnum
+
+class StepLimitErrorType(StrEnum):
+    """Types of step-related limit violations."""
+    STEP_LIMIT_EXCEEDED: str
+    DELEGATION_DEPTH_EXCEEDED: str
+
+@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=Incomplete)
+    max_delegation_depth: int = field(default_factory=Incomplete)
+    def __post_init__(self) -> None:
+        """Validate configuration values and normalize range."""
+
+@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 = ...
+    partial_result: str | None = ...
+
+class StepLimitError(Exception):
+    """Base exception for step and delegation limit violations.
+
+    Attributes:
+        error_response: Structured error response with details.
+    """
+    error_response: Incomplete
+    def __init__(self, error_response: StepLimitErrorResponse) -> None:
+        """Initialize with error response.
+
+        Args:
+            error_response: Structured error details.
+        """
+
+class MaxStepsExceededError(StepLimitError):
+    """Raised when agent exceeds configured max_steps limit."""
+class MaxDelegationDepthExceededError(StepLimitError):
+    """Raised when delegation would exceed max_delegation_depth limit."""

aip_agents/schema/storage.pyi

@@ -0,0 +1,21 @@
+from dataclasses import dataclass
+from enum import StrEnum
+
+__all__ = ['OBJECT_STORAGE_PREFIX', 'StorageType', 'StorageConfig']
+
+OBJECT_STORAGE_PREFIX: str
+
+class StorageType(StrEnum):
+    """Supported storage types."""
+    MEMORY: str
+    OBJECT_STORAGE: str
+
+@dataclass
+class StorageConfig:
+    """Configuration for storage providers."""
+    storage_type: StorageType = ...
+    object_prefix: str = ...
+    object_use_json: bool = ...
+    @classmethod
+    def from_env(cls) -> StorageConfig:
+        """Create StorageConfig from environment variables."""

aip_agents/sentry/__init__.pyi

@@ -0,0 +1,3 @@
+from aip_agents.sentry.sentry import setup_telemetry as setup_telemetry
+
+__all__ = ['setup_telemetry']

aip_agents/sentry/sentry.pyi

@@ -0,0 +1,48 @@
+from _typeshed import Incomplete
+from aip_agents.agent import BaseAgent as BaseAgent, GoogleADKAgent as GoogleADKAgent, LangChainAgent as LangChainAgent, LangGraphAgent as LangGraphAgent
+from aip_agents.utils.logger import get_logger as get_logger
+from fastapi import FastAPI
+
+logger: Incomplete
+SENTRY_DSN: Incomplete
+SENTRY_ENVIRONMENT: Incomplete
+SENTRY_PROJECT: Incomplete
+VERSION_NUMBER: Incomplete
+BUILD_NUMBER: Incomplete
+USE_OPENTELEMETRY: Incomplete
+CLASSES_TO_INSTRUMENT: Incomplete
+
+def get_all_methods(cls) -> list:
+    """Get all methods from a class.
+
+    Args:
+        cls: The class to get methods from.
+
+    Returns:
+        list: A list of methods.
+    """
+def instrument_bosa_functions() -> None:
+    """Instrument BOSA functions."""
+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
+    """
+def setup_sentry_with_open_telemetry(app: FastAPI) -> None:
+    """Configure telemetry with both Sentry and OpenTelemetry.
+
+    Args:
+        app: FastAPI application instance
+    """
+def setup_sentry_only() -> None:
+    """Configure telemetry with Sentry only (no OpenTelemetry)."""
+def setup_telemetry(app: FastAPI) -> None:
+    """Configure and initialize telemetry based on configuration.
+
+    Args:
+        app: FastAPI application instance
+    """

aip_agents/storage/__init__.pyi

@@ -0,0 +1,8 @@
+from aip_agents.storage.base import BaseObjectStorageClient as BaseObjectStorageClient
+from aip_agents.storage.clients.minio_client import MinioConfig as MinioConfig, MinioObjectStorage as MinioObjectStorage
+from aip_agents.storage.config import StorageConfig as StorageConfig, StorageProviderFactory as StorageProviderFactory, StorageType as StorageType
+from aip_agents.storage.providers.base import BaseStorageProvider as BaseStorageProvider, StorageError as StorageError
+from aip_agents.storage.providers.memory import InMemoryStorageProvider as InMemoryStorageProvider
+from aip_agents.storage.providers.object_storage import ObjectStorageProvider as ObjectStorageProvider
+
+__all__ = ['BaseObjectStorageClient', 'MinioConfig', 'MinioObjectStorage', 'BaseStorageProvider', 'StorageError', 'InMemoryStorageProvider', 'ObjectStorageProvider', 'StorageConfig', 'StorageType', 'StorageProviderFactory']

aip_agents/storage/base.pyi

@@ -0,0 +1,58 @@
+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.
+        """
+    @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
+        """
+    @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
+        """
+    @abstractmethod
+    def delete(self, object_key: str) -> None:
+        """Delete data from object storage.
+
+        Args:
+            object_key: The key of the object in the storage
+        """
+    @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
+        """

aip_agents/storage/clients/__init__.pyi

@@ -0,0 +1,3 @@
+from aip_agents.storage.clients.minio_client import MinioConfig as MinioConfig, MinioObjectStorage as MinioObjectStorage
+
+__all__ = ['MinioConfig', 'MinioObjectStorage']