PraisonAI 3.0.0__py3-none-any.whl

praisonai/endpoints/discovery.py

@@ -0,0 +1,165 @@
+"""
+Unified Discovery Schema
+
+Provides versioned discovery document format for all PraisonAI serve features.
+This schema is consistent across all provider types.
+"""
+
+from dataclasses import dataclass, field, asdict
+from typing import Any, Dict, List, Optional
+from enum import Enum
+
+
+# Schema version - increment on breaking changes
+SCHEMA_VERSION = "1.0.0"
+
+
+class ProviderType(str, Enum):
+    """Supported provider types."""
+    RECIPE = "recipe"
+    AGENTS_API = "agents-api"
+    MCP = "mcp"
+    TOOLS_MCP = "tools-mcp"
+    A2A = "a2a"
+    A2U = "a2u"
+
+
+class StreamingMode(str, Enum):
+    """Supported streaming modes."""
+    NONE = "none"
+    SSE = "sse"
+    WEBSOCKET = "websocket"
+    MCP_STREAM = "mcp-stream"
+
+
+class AuthMode(str, Enum):
+    """Supported authentication modes."""
+    NONE = "none"
+    API_KEY = "api-key"
+    BEARER = "bearer"
+    JWT = "jwt"
+
+
+@dataclass
+class EndpointInfo:
+    """Information about a single endpoint."""
+    name: str
+    description: str = ""
+    provider_type: str = "recipe"
+    tags: List[str] = field(default_factory=list)
+    version: str = "1.0.0"
+    
+    # Schema information
+    input_schema: Optional[Dict[str, Any]] = None
+    output_schema: Optional[Dict[str, Any]] = None
+    
+    # Capabilities
+    streaming: List[str] = field(default_factory=lambda: ["none"])
+    auth_modes: List[str] = field(default_factory=lambda: ["none"])
+    
+    # Metadata
+    examples: List[Dict[str, Any]] = field(default_factory=list)
+    metadata: Dict[str, Any] = field(default_factory=dict)
+    
+    def to_dict(self) -> Dict[str, Any]:
+        """Convert to dictionary."""
+        return asdict(self)
+
+
+@dataclass
+class ProviderInfo:
+    """Information about a provider."""
+    type: str
+    name: str
+    version: str = "1.0.0"
+    description: str = ""
+    capabilities: List[str] = field(default_factory=list)
+    
+    def to_dict(self) -> Dict[str, Any]:
+        """Convert to dictionary."""
+        return asdict(self)
+
+
+@dataclass
+class DiscoveryDocument:
+    """
+    Unified discovery document for PraisonAI servers.
+    
+    This document is served at /__praisonai__/discovery and provides
+    a consistent interface for discovering endpoints across all provider types.
+    """
+    schema_version: str = SCHEMA_VERSION
+    server_name: str = "praisonai"
+    server_version: str = "1.0.0"
+    
+    # Provider information
+    providers: List[ProviderInfo] = field(default_factory=list)
+    
+    # Endpoint information
+    endpoints: List[EndpointInfo] = field(default_factory=list)
+    
+    # Server capabilities
+    auth_modes: List[str] = field(default_factory=lambda: ["none"])
+    streaming_modes: List[str] = field(default_factory=lambda: ["none", "sse"])
+    
+    # Metadata
+    metadata: Dict[str, Any] = field(default_factory=dict)
+    
+    def to_dict(self) -> Dict[str, Any]:
+        """Convert to dictionary for JSON serialization."""
+        return {
+            "schema_version": self.schema_version,
+            "server_name": self.server_name,
+            "server_version": self.server_version,
+            "providers": [p.to_dict() for p in self.providers],
+            "endpoints": [e.to_dict() for e in self.endpoints],
+            "auth_modes": self.auth_modes,
+            "streaming_modes": self.streaming_modes,
+            "metadata": self.metadata,
+        }
+    
+    def add_provider(self, provider: ProviderInfo) -> None:
+        """Add a provider to the discovery document."""
+        self.providers.append(provider)
+    
+    def add_endpoint(self, endpoint: EndpointInfo) -> None:
+        """Add an endpoint to the discovery document."""
+        self.endpoints.append(endpoint)
+    
+    def get_endpoints_by_type(self, provider_type: str) -> List[EndpointInfo]:
+        """Get endpoints filtered by provider type."""
+        return [e for e in self.endpoints if e.provider_type == provider_type]
+    
+    def get_endpoint_by_name(self, name: str) -> Optional[EndpointInfo]:
+        """Get an endpoint by name."""
+        for e in self.endpoints:
+            if e.name == name:
+                return e
+        return None
+
+
+def create_discovery_document(
+    server_name: str = "praisonai",
+    server_version: Optional[str] = None,
+) -> DiscoveryDocument:
+    """
+    Create a new discovery document.
+    
+    Args:
+        server_name: Name of the server
+        server_version: Version of the server (auto-detected if not provided)
+        
+    Returns:
+        DiscoveryDocument instance
+    """
+    if server_version is None:
+        try:
+            from praisonai.version import __version__
+            server_version = __version__
+        except ImportError:
+            server_version = "unknown"
+    
+    return DiscoveryDocument(
+        server_name=server_name,
+        server_version=server_version,
+    )

praisonai/endpoints/providers/__init__.py

@@ -0,0 +1,28 @@
+"""
+Provider Adapters
+
+Each provider adapter implements the BaseProvider interface
+and handles protocol-specific details for discovery and invocation.
+"""
+
+# Lazy loading for all exports
+_lazy_imports = {
+    "BaseProvider": ".base",
+    "RecipeProvider": ".recipe",
+    "AgentsAPIProvider": ".agents_api",
+    "MCPProvider": ".mcp",
+    "ToolsMCPProvider": ".tools_mcp",
+    "A2AProvider": ".a2a",
+    "A2UProvider": ".a2u",
+}
+
+def __getattr__(name: str):
+    if name in _lazy_imports:
+        module_path = _lazy_imports[name]
+        import importlib
+        module = importlib.import_module(module_path, package=__name__)
+        return getattr(module, name)
+    raise AttributeError(f"module {__name__!r} has no attribute {name!r}")
+
+def __dir__():
+    return list(_lazy_imports.keys())

praisonai/endpoints/providers/a2a.py

@@ -0,0 +1,253 @@
+"""
+A2A Provider
+
+Provider adapter for Agent-to-Agent protocol endpoints.
+"""
+
+from typing import Any, Dict, Iterator, List, Optional
+
+from .base import BaseProvider, InvokeResult, HealthResult
+from ..discovery import EndpointInfo, ProviderInfo
+
+
+class A2AProvider(BaseProvider):
+    """
+    Provider adapter for A2A (Agent-to-Agent) protocol endpoints.
+    
+    A2A enables agent-to-agent communication following the A2A protocol spec.
+    Supports discovery via /.well-known/agent.json and message passing.
+    """
+    
+    provider_type = "a2a"
+    
+    def get_provider_info(self) -> ProviderInfo:
+        """Get provider information."""
+        return ProviderInfo(
+            type=self.provider_type,
+            name="A2A Protocol",
+            description="Agent-to-Agent communication protocol",
+            capabilities=["agent-card", "message-send", "task-management"],
+        )
+    
+    def list_endpoints(self, tags: Optional[List[str]] = None) -> List[EndpointInfo]:
+        """List available A2A agents."""
+        # Try unified discovery first
+        result = self._make_request("GET", "/__praisonai__/discovery")
+        
+        if not result.get("error") and result.get("data"):
+            data = result.get("data", {})
+            endpoints = []
+            for ep in data.get("endpoints", []):
+                if ep.get("provider_type") == self.provider_type:
+                    endpoints.append(EndpointInfo(
+                        name=ep.get("name", ""),
+                        description=ep.get("description", ""),
+                        provider_type=self.provider_type,
+                        tags=ep.get("tags", []),
+                        streaming=ep.get("streaming", ["sse"]),
+                        auth_modes=ep.get("auth_modes", ["none"]),
+                    ))
+            return endpoints
+        
+        # Fallback: try agent card
+        result = self._make_request("GET", "/.well-known/agent.json")
+        
+        if result.get("error"):
+            return []
+        
+        agent_card = result.get("data", {})
+        
+        return [EndpointInfo(
+            name=agent_card.get("name", "a2a-agent"),
+            description=agent_card.get("description", "A2A Agent"),
+            provider_type=self.provider_type,
+            version=agent_card.get("version", "1.0.0"),
+            streaming=["sse"] if agent_card.get("capabilities", {}).get("streaming") else ["none"],
+            auth_modes=["none"],
+            metadata={"agent_card": agent_card},
+        )]
+    
+    def describe_endpoint(self, name: str) -> Optional[EndpointInfo]:
+        """Get detailed information about an A2A agent."""
+        # Get agent card
+        result = self._make_request("GET", "/.well-known/agent.json")
+        
+        if result.get("error"):
+            return None
+        
+        agent_card = result.get("data", {})
+        
+        return EndpointInfo(
+            name=agent_card.get("name", name),
+            description=agent_card.get("description", ""),
+            provider_type=self.provider_type,
+            version=agent_card.get("version", "1.0.0"),
+            streaming=["sse"] if agent_card.get("capabilities", {}).get("streaming") else ["none"],
+            auth_modes=["none"],
+            metadata={
+                "agent_card": agent_card,
+                "skills": agent_card.get("skills", []),
+                "capabilities": agent_card.get("capabilities", {}),
+            },
+        )
+    
+    def invoke(
+        self,
+        name: str,
+        input_data: Optional[Dict[str, Any]] = None,
+        config: Optional[Dict[str, Any]] = None,
+        stream: bool = False,
+    ) -> InvokeResult:
+        """Send a message to an A2A agent."""
+        import uuid
+        
+        # Build A2A message
+        message = input_data.get("message", "") if input_data else ""
+        if not message and config:
+            message = config.get("message", config.get("query", ""))
+        
+        body = {
+            "jsonrpc": "2.0",
+            "method": "message/send",
+            "id": str(uuid.uuid4()),
+            "params": {
+                "message": {
+                    "role": "user",
+                    "parts": [{"type": "text", "text": message}],
+                },
+            },
+        }
+        
+        result = self._make_request("POST", "/a2a", json_data=body)
+        
+        if result.get("error"):
+            return InvokeResult(
+                ok=False,
+                status="error",
+                error=result["error"].get("message", str(result["error"])),
+            )
+        
+        data = result.get("data", {})
+        
+        # Handle JSON-RPC response
+        if "result" in data:
+            return InvokeResult(
+                ok=True,
+                status="success",
+                data=data["result"],
+            )
+        elif "error" in data:
+            return InvokeResult(
+                ok=False,
+                status="error",
+                error=data["error"].get("message", str(data["error"])),
+            )
+        
+        return InvokeResult(
+            ok=True,
+            status="success",
+            data=data,
+        )
+    
+    def invoke_stream(
+        self,
+        name: str,
+        input_data: Optional[Dict[str, Any]] = None,
+        config: Optional[Dict[str, Any]] = None,
+    ) -> Iterator[Dict[str, Any]]:
+        """Send a streaming message to an A2A agent."""
+        import json
+        import urllib.request
+        import uuid
+        
+        message = input_data.get("message", "") if input_data else ""
+        if not message and config:
+            message = config.get("message", config.get("query", ""))
+        
+        body = {
+            "jsonrpc": "2.0",
+            "method": "message/stream",
+            "id": str(uuid.uuid4()),
+            "params": {
+                "message": {
+                    "role": "user",
+                    "parts": [{"type": "text", "text": message}],
+                },
+            },
+        }
+        
+        full_url = f"{self.base_url}/a2a"
+        
+        headers = {
+            "Content-Type": "application/json",
+            "Accept": "text/event-stream",
+        }
+        if self.api_key:
+            headers["X-API-Key"] = self.api_key
+        
+        data = json.dumps(body).encode("utf-8")
+        
+        try:
+            req = urllib.request.Request(full_url, data=data, headers=headers, method="POST")
+            
+            with urllib.request.urlopen(req, timeout=300) as response:
+                buffer = ""
+                for line in response:
+                    line = line.decode("utf-8")
+                    buffer += line
+                    
+                    if buffer.endswith("\n\n"):
+                        event_type = "message"
+                        event_data = ""
+                        
+                        for part in buffer.strip().split("\n"):
+                            if part.startswith("event:"):
+                                event_type = part[6:].strip()
+                            elif part.startswith("data:"):
+                                event_data = part[5:].strip()
+                        
+                        if event_data:
+                            try:
+                                yield {"event": event_type, "data": json.loads(event_data)}
+                            except json.JSONDecodeError:
+                                yield {"event": event_type, "data": event_data}
+                        
+                        buffer = ""
+                        
+        except Exception as e:
+            yield {"event": "error", "data": {"error": str(e)}}
+    
+    def health(self) -> HealthResult:
+        """Check A2A server health."""
+        # Try status endpoint first
+        result = self._make_request("GET", "/status")
+        
+        if not result.get("error"):
+            data = result.get("data", {})
+            return HealthResult(
+                healthy=data.get("status") == "ok",
+                status=data.get("status", "unknown"),
+                server_name=data.get("name", "A2A Agent"),
+                server_version=data.get("version"),
+                provider_type=self.provider_type,
+            )
+        
+        # Fallback: try agent card
+        result = self._make_request("GET", "/.well-known/agent.json")
+        
+        if result.get("error"):
+            return HealthResult(
+                healthy=False,
+                status="unhealthy",
+                provider_type=self.provider_type,
+                metadata={"error": result["error"].get("message", str(result["error"]))},
+            )
+        
+        agent_card = result.get("data", {})
+        return HealthResult(
+            healthy=True,
+            status="healthy",
+            server_name=agent_card.get("name", "A2A Agent"),
+            server_version=agent_card.get("version"),
+            provider_type=self.provider_type,
+        )

praisonai/endpoints/providers/a2u.py

@@ -0,0 +1,208 @@
+"""
+A2U Provider
+
+Provider adapter for Agent-to-User event stream endpoints.
+"""
+
+from typing import Any, Dict, Iterator, List, Optional
+
+from .base import BaseProvider, InvokeResult, HealthResult
+from ..discovery import EndpointInfo, ProviderInfo
+
+
+class A2UProvider(BaseProvider):
+    """
+    Provider adapter for A2U (Agent-to-User) event stream endpoints.
+    
+    A2U provides a protocol surface for streaming agent events to users,
+    typically via SSE or WebSocket. This enables real-time UI updates.
+    """
+    
+    provider_type = "a2u"
+    
+    def get_provider_info(self) -> ProviderInfo:
+        """Get provider information."""
+        return ProviderInfo(
+            type=self.provider_type,
+            name="A2U Event Stream",
+            description="Agent-to-User event streaming protocol",
+            capabilities=["event-stream", "subscribe", "unsubscribe"],
+        )
+    
+    def list_endpoints(self, tags: Optional[List[str]] = None) -> List[EndpointInfo]:
+        """List available A2U event streams."""
+        # Try unified discovery first
+        result = self._make_request("GET", "/__praisonai__/discovery")
+        
+        if not result.get("error") and result.get("data"):
+            data = result.get("data", {})
+            endpoints = []
+            for ep in data.get("endpoints", []):
+                if ep.get("provider_type") == self.provider_type:
+                    endpoints.append(EndpointInfo(
+                        name=ep.get("name", ""),
+                        description=ep.get("description", ""),
+                        provider_type=self.provider_type,
+                        tags=ep.get("tags", []),
+                        streaming=ep.get("streaming", ["sse"]),
+                        auth_modes=ep.get("auth_modes", ["none"]),
+                    ))
+            return endpoints
+        
+        # Fallback: check for events endpoint
+        result = self._make_request("GET", "/a2u/info")
+        
+        if result.get("error"):
+            # Return default event stream endpoint
+            return [EndpointInfo(
+                name="events",
+                description="Agent event stream",
+                provider_type=self.provider_type,
+                streaming=["sse"],
+                auth_modes=["none"],
+            )]
+        
+        data = result.get("data", {})
+        streams = data.get("streams", [{"name": "events", "description": "Agent event stream"}])
+        
+        endpoints = []
+        for stream in streams:
+            endpoints.append(EndpointInfo(
+                name=stream.get("name", "events"),
+                description=stream.get("description", "Event stream"),
+                provider_type=self.provider_type,
+                streaming=["sse", "websocket"],
+                auth_modes=["none"],
+            ))
+        
+        return endpoints
+    
+    def describe_endpoint(self, name: str) -> Optional[EndpointInfo]:
+        """Get detailed information about an A2U event stream."""
+        endpoints = self.list_endpoints()
+        for ep in endpoints:
+            if ep.name == name:
+                return ep
+        
+        # Return default info
+        return EndpointInfo(
+            name=name,
+            description=f"Event stream: {name}",
+            provider_type=self.provider_type,
+            streaming=["sse"],
+            auth_modes=["none"],
+            metadata={
+                "event_types": [
+                    "agent.started",
+                    "agent.thinking",
+                    "agent.tool_call",
+                    "agent.response",
+                    "agent.completed",
+                    "agent.error",
+                ],
+            },
+        )
+    
+    def invoke(
+        self,
+        name: str,
+        input_data: Optional[Dict[str, Any]] = None,
+        config: Optional[Dict[str, Any]] = None,
+        stream: bool = False,
+    ) -> InvokeResult:
+        """Subscribe to an A2U event stream (returns subscription info)."""
+        body = {
+            "stream": name,
+            "filters": input_data.get("filters", []) if input_data else [],
+        }
+        
+        result = self._make_request("POST", "/a2u/subscribe", json_data=body)
+        
+        if result.get("error"):
+            return InvokeResult(
+                ok=False,
+                status="error",
+                error=result["error"].get("message", str(result["error"])),
+            )
+        
+        data = result.get("data", {})
+        return InvokeResult(
+            ok=True,
+            status="subscribed",
+            data={
+                "subscription_id": data.get("subscription_id"),
+                "stream_url": data.get("stream_url", f"{self.base_url}/a2u/events/{name}"),
+            },
+        )
+    
+    def invoke_stream(
+        self,
+        name: str,
+        input_data: Optional[Dict[str, Any]] = None,
+        config: Optional[Dict[str, Any]] = None,
+    ) -> Iterator[Dict[str, Any]]:
+        """Stream events from an A2U endpoint."""
+        import json
+        import urllib.request
+        
+        stream_path = f"/a2u/events/{name}"
+        full_url = f"{self.base_url}{stream_path}"
+        
+        headers = {"Accept": "text/event-stream"}
+        if self.api_key:
+            headers["X-API-Key"] = self.api_key
+        
+        try:
+            req = urllib.request.Request(full_url, headers=headers, method="GET")
+            
+            with urllib.request.urlopen(req, timeout=300) as response:
+                buffer = ""
+                for line in response:
+                    line = line.decode("utf-8")
+                    buffer += line
+                    
+                    if buffer.endswith("\n\n"):
+                        event_type = "event"
+                        event_data = ""
+                        
+                        for part in buffer.strip().split("\n"):
+                            if part.startswith("event:"):
+                                event_type = part[6:].strip()
+                            elif part.startswith("data:"):
+                                event_data = part[5:].strip()
+                        
+                        if event_data:
+                            try:
+                                yield {"event": event_type, "data": json.loads(event_data)}
+                            except json.JSONDecodeError:
+                                yield {"event": event_type, "data": event_data}
+                        
+                        buffer = ""
+                        
+        except Exception as e:
+            yield {"event": "error", "data": {"error": str(e)}}
+    
+    def health(self) -> HealthResult:
+        """Check A2U server health."""
+        result = self._make_request("GET", "/health")
+        
+        if result.get("error"):
+            # Try a2u-specific health
+            result = self._make_request("GET", "/a2u/health")
+        
+        if result.get("error"):
+            return HealthResult(
+                healthy=False,
+                status="unhealthy",
+                provider_type=self.provider_type,
+                metadata={"error": result["error"].get("message", str(result["error"]))},
+            )
+        
+        data = result.get("data", {})
+        return HealthResult(
+            healthy=True,
+            status="healthy",
+            server_name=data.get("server_name", "A2U Server"),
+            server_version=data.get("version"),
+            provider_type=self.provider_type,
+        )