glaip-sdk 0.1.3__py3-none-any.whl → 0.6.10__py3-none-any.whl

glaip_sdk/client/agents.py

@@ -3,31 +3,37 @@
 
 Authors:
     Raymond Christopher (raymond.christopher@gdplabs.id)
+    Christian Trisno Sen Long Chen (christian.t.s.l.chen@gdplabs.id)
 """
 
+import asyncio
 import json
 import logging
 from collections.abc import AsyncGenerator, Callable, Iterator, Mapping
+from contextlib import asynccontextmanager
 from os import PathLike
 from pathlib import Path
 from typing import Any, BinaryIO
 
 import httpx
-
+from glaip_sdk.agents import Agent
 from glaip_sdk.client._agent_payloads import (
     AgentCreateRequest,
     AgentListParams,
     AgentListResult,
     AgentUpdateRequest,
 )
+from glaip_sdk.client.agent_runs import AgentRunsClient
 from glaip_sdk.client.base import BaseClient
 from glaip_sdk.client.mcps import MCPClient
 from glaip_sdk.client.run_rendering import (
     AgentRunRenderingManager,
     compute_timeout_seconds,
 )
+from glaip_sdk.client.shared import build_shared_config
 from glaip_sdk.client.tools import ToolClient
 from glaip_sdk.config.constants import (
+    AGENT_CONFIG_FIELDS,
     DEFAULT_AGENT_FRAMEWORK,
     DEFAULT_AGENT_RUN_TIMEOUT,
     DEFAULT_AGENT_TYPE,
@@ -35,7 +41,7 @@ from glaip_sdk.config.constants import (
     DEFAULT_MODEL,
 )
 from glaip_sdk.exceptions import NotFoundError, ValidationError
-from glaip_sdk.models import Agent
+from glaip_sdk.models import AgentResponse
 from glaip_sdk.payload_schemas.agent import list_server_only_fields
 from glaip_sdk.utils.agent_config import normalize_agent_config_for_import
 from glaip_sdk.utils.client_utils import (
@@ -67,6 +73,21 @@ _MERGED_SEQUENCE_FIELDS = ("tools", "agents", "mcps")
 _DEFAULT_METADATA_TYPE = "custom"
 
 
+@asynccontextmanager
+async def _async_timeout_guard(
+    timeout_seconds: float | None,
+) -> AsyncGenerator[None, None]:
+    """Apply an asyncio timeout when a custom timeout is provided."""
+    if timeout_seconds is None:
+        yield
+        return
+    try:
+        async with asyncio.timeout(timeout_seconds):
+            yield
+    except asyncio.TimeoutError as exc:
+        raise httpx.TimeoutException(f"Request timed out after {timeout_seconds}s") from exc
+
+
 def _normalise_sequence(value: Any) -> list[Any] | None:
     """Normalise optional sequence inputs to plain lists."""
     if value is None:
@@ -193,19 +214,7 @@ def _extract_original_refs(raw_definition: dict) -> dict[str, list]:
 
 def _build_cli_args(overrides_dict: dict) -> dict[str, Any]:
     """Build CLI args from overrides, filtering out None values."""
-    cli_args = {
-        key: overrides_dict.get(key)
-        for key in (
-            "name",
-            "instruction",
-            "model",
-            "tools",
-            "agents",
-            "mcps",
-            "timeout",
-        )
-        if overrides_dict.get(key) is not None
-    }
+    cli_args = {key: overrides_dict.get(key) for key in AGENT_CONFIG_FIELDS if overrides_dict.get(key) is not None}
 
     # Normalize sequence fields
     for field in _MERGED_SEQUENCE_FIELDS:
@@ -254,6 +263,7 @@ class AgentClient(BaseClient):
         self._renderer_manager = AgentRunRenderingManager(logger)
         self._tool_client: ToolClient | None = None
         self._mcp_client: MCPClient | None = None
+        self._runs_client: AgentRunsClient | None = None
 
     def list_agents(
         self,
@@ -352,7 +362,8 @@ class AgentClient(BaseClient):
                 status_code=404,
             )
 
-        return Agent(**data)._set_client(self)
+        response = AgentResponse(**data)
+        return Agent.from_response(response, client=self)
 
     def find_agents(self, name: str | None = None) -> list[Agent]:
         """Find agents by name."""
@@ -366,6 +377,11 @@ class AgentClient(BaseClient):
     # Renderer delegation helpers
     # ------------------------------------------------------------------ #
     def _get_renderer_manager(self) -> AgentRunRenderingManager:
+        """Get or create the renderer manager instance.
+
+        Returns:
+            AgentRunRenderingManager instance.
+        """
         manager = getattr(self, "_renderer_manager", None)
         if manager is None:
             manager = AgentRunRenderingManager(logger)
@@ -373,6 +389,15 @@ class AgentClient(BaseClient):
         return manager
 
     def _create_renderer(self, renderer: RichStreamRenderer | str | None, **kwargs: Any) -> RichStreamRenderer:
+        """Create or return a renderer instance.
+
+        Args:
+            renderer: Renderer instance, string identifier, or None.
+            **kwargs: Additional keyword arguments (e.g., verbose).
+
+        Returns:
+            RichStreamRenderer instance.
+        """
         manager = self._get_renderer_manager()
         verbose = kwargs.get("verbose", False)
         if isinstance(renderer, RichStreamRenderer) or hasattr(renderer, "on_start"):
@@ -387,6 +412,18 @@ class AgentClient(BaseClient):
         agent_name: str | None,
         meta: dict[str, Any],
     ) -> tuple[str, dict[str, Any], float | None, float | None]:
+        """Process stream events from an HTTP response.
+
+        Args:
+            stream_response: HTTP response stream.
+            renderer: Renderer to use for displaying events.
+            timeout_seconds: Timeout in seconds.
+            agent_name: Optional agent name.
+            meta: Metadata dictionary.
+
+        Returns:
+            Tuple of (final_text, stats_usage, started_monotonic, finished_monotonic).
+        """
         manager = self._get_renderer_manager()
         return manager.process_stream_events(
             stream_response,
@@ -404,6 +441,18 @@ class AgentClient(BaseClient):
         started_monotonic: float | None,
         finished_monotonic: float | None,
     ) -> str:
+        """Finalize the renderer and return the final response text.
+
+        Args:
+            renderer: Renderer to finalize.
+            final_text: Final text content.
+            stats_usage: Usage statistics dictionary.
+            started_monotonic: Start time (monotonic).
+            finished_monotonic: Finish time (monotonic).
+
+        Returns:
+            Final text string.
+        """
         manager = self._get_renderer_manager()
         return manager.finalize_renderer(
             renderer,
@@ -414,11 +463,21 @@ class AgentClient(BaseClient):
         )
 
     def _get_tool_client(self) -> ToolClient:
+        """Get or create the tool client instance.
+
+        Returns:
+            ToolClient instance.
+        """
         if self._tool_client is None:
             self._tool_client = ToolClient(parent_client=self)
         return self._tool_client
 
     def _get_mcp_client(self) -> MCPClient:
+        """Get or create the MCP client instance.
+
+        Returns:
+            MCPClient instance.
+        """
         if self._mcp_client is None:
             self._mcp_client = MCPClient(parent_client=self)
         return self._mcp_client
@@ -428,6 +487,15 @@ class AgentClient(BaseClient):
         entry: Any,
         fallback_iter: Iterator[Any] | None,
     ) -> tuple[str | None, str | None]:
+        """Normalize a reference entry to extract ID and name.
+
+        Args:
+            entry: Reference entry (string, dict, or other).
+            fallback_iter: Optional iterator for fallback values.
+
+        Returns:
+            Tuple of (entry_id, entry_name).
+        """
         entry_id: str | None = None
         entry_name: str | None = None
 
@@ -464,6 +532,19 @@ class AgentClient(BaseClient):
         label: str,
         plural_label: str | None = None,
     ) -> list[str] | None:
+        """Resolve a list of resource references to IDs.
+
+        Args:
+            items: List of resource references to resolve.
+            references: Optional list of reference objects for fallback.
+            fetch_by_id: Function to fetch resource by ID.
+            find_by_name: Function to find resources by name.
+            label: Singular label for error messages.
+            plural_label: Plural label for error messages.
+
+        Returns:
+            List of resolved resource IDs, or None if items is empty.
+        """
         if not items:
             return None
 
@@ -495,6 +576,22 @@ class AgentClient(BaseClient):
         singular: str,
         plural: str,
     ) -> str:
+        """Resolve a single resource reference to an ID.
+
+        Args:
+            entry: Resource reference to resolve.
+            fallback_iter: Optional iterator for fallback values.
+            fetch_by_id: Function to fetch resource by ID.
+            find_by_name: Function to find resources by name.
+            singular: Singular label for error messages.
+            plural: Plural label for error messages.
+
+        Returns:
+            Resolved resource ID string.
+
+        Raises:
+            ValueError: If the resource cannot be resolved.
+        """
         entry_id, entry_name = self._normalise_reference_entry(entry, fallback_iter)
 
         validated_id = self._validate_resource_id(fetch_by_id, entry_id)
@@ -511,6 +608,14 @@ class AgentClient(BaseClient):
 
     @staticmethod
     def _coerce_reference_value(entry: Any) -> str:
+        """Coerce a reference entry to a string value.
+
+        Args:
+            entry: Reference entry (dict, string, or other).
+
+        Returns:
+            String representation of the reference.
+        """
         if isinstance(entry, dict):
             if entry.get("id"):
                 return str(entry["id"])
@@ -520,6 +625,15 @@ class AgentClient(BaseClient):
 
     @staticmethod
     def _validate_resource_id(fetch_by_id: Callable[[str], Any], candidate_id: str | None) -> str | None:
+        """Validate a resource ID by attempting to fetch it.
+
+        Args:
+            fetch_by_id: Function to fetch resource by ID.
+            candidate_id: Candidate ID to validate.
+
+        Returns:
+            Validated ID if found, None otherwise.
+        """
         if not candidate_id:
             return None
         try:
@@ -535,6 +649,20 @@ class AgentClient(BaseClient):
         singular: str,
         plural: str,
     ) -> tuple[str, bool]:
+        """Resolve a resource by name to an ID.
+
+        Args:
+            find_by_name: Function to find resources by name.
+            entry_name: Name of the resource to find.
+            singular: Singular label for error messages.
+            plural: Plural label for error messages.
+
+        Returns:
+            Tuple of (resolved_id, success).
+
+        Raises:
+            ValueError: If resource not found or multiple matches exist.
+        """
         try:
             matches = find_by_name(entry_name)
         except Exception:
@@ -555,6 +683,15 @@ class AgentClient(BaseClient):
         tools: list[Any] | None,
         references: list[Any] | None = None,
     ) -> list[str] | None:
+        """Resolve tool references to IDs.
+
+        Args:
+            tools: List of tool references to resolve.
+            references: Optional list of reference objects for fallback.
+
+        Returns:
+            List of resolved tool IDs, or None if tools is empty.
+        """
         tool_client = self._get_tool_client()
         return self._resolve_resource_ids(
             tools,
@@ -570,6 +707,15 @@ class AgentClient(BaseClient):
         agents: list[Any] | None,
         references: list[Any] | None = None,
     ) -> list[str] | None:
+        """Resolve agent references to IDs.
+
+        Args:
+            agents: List of agent references to resolve.
+            references: Optional list of reference objects for fallback.
+
+        Returns:
+            List of resolved agent IDs, or None if agents is empty.
+        """
         return self._resolve_resource_ids(
             agents,
             references,
@@ -584,6 +730,15 @@ class AgentClient(BaseClient):
         mcps: list[Any] | None,
         references: list[Any] | None = None,
     ) -> list[str] | None:
+        """Resolve MCP references to IDs.
+
+        Args:
+            mcps: List of MCP references to resolve.
+            references: Optional list of reference objects for fallback.
+
+        Returns:
+            List of resolved MCP IDs, or None if mcps is empty.
+        """
         mcp_client = self._get_mcp_client()
         return self._resolve_resource_ids(
             mcps,
@@ -675,7 +830,8 @@ class AgentClient(BaseClient):
             get_endpoint_fmt=f"{AGENTS_ENDPOINT}{{id}}",
             json=payload_dict,
         )
-        return Agent(**full_agent_data)._set_client(self)
+        response = AgentResponse(**full_agent_data)
+        return Agent.from_response(response, client=self)
 
     def create_agent(
         self,
@@ -770,8 +926,9 @@ class AgentClient(BaseClient):
 
         payload_dict = request.to_payload(current_agent)
 
-        response = self._request("PUT", f"/agents/{agent_id}", json=payload_dict)
-        return Agent(**response)._set_client(self)
+        api_response = self._request("PUT", f"/agents/{agent_id}", json=payload_dict)
+        response = AgentResponse(**api_response)
+        return Agent.from_response(response, client=self)
 
     def update_agent(
         self,
@@ -818,6 +975,62 @@ class AgentClient(BaseClient):
         """Delete an agent."""
         self._request("DELETE", f"/agents/{agent_id}")
 
+    def upsert_agent(self, identifier: str | Agent, **kwargs) -> Agent:
+        """Create or update an agent by instance, ID, or name.
+
+        Args:
+            identifier: Agent instance, ID (UUID string), or name
+            **kwargs: Agent configuration (instruction, description, tools, etc.)
+
+        Returns:
+            The created or updated agent.
+
+        Example:
+            >>> # By name (creates if not exists)
+            >>> agent = client.agents.upsert_agent(
+            ...     "hello_agent",
+            ...     instruction="You are a helpful assistant.",
+            ...     description="A friendly agent",
+            ... )
+            >>> # By instance
+            >>> agent = client.agents.upsert_agent(existing_agent, description="Updated")
+            >>> # By ID
+            >>> agent = client.agents.upsert_agent("uuid-here", description="Updated")
+        """
+        # Handle Agent instance
+        if isinstance(identifier, Agent):
+            if identifier.id:
+                logger.info("Updating agent by instance: %s", identifier.name)
+                return self.update_agent(identifier.id, name=identifier.name, **kwargs)
+            identifier = identifier.name
+
+        # Handle string (ID or name)
+        if isinstance(identifier, str):
+            # Check if it's a UUID
+            if is_uuid(identifier):
+                logger.info("Updating agent by ID: %s", identifier)
+                return self.update_agent(identifier, **kwargs)
+
+            # It's a name - find or create
+            return self._upsert_agent_by_name(identifier, **kwargs)
+
+        raise ValueError(f"Invalid identifier type: {type(identifier)}")
+
+    def _upsert_agent_by_name(self, name: str, **kwargs) -> Agent:
+        """Find agent by name and update, or create if not found."""
+        existing = self.find_agents(name)
+
+        if len(existing) == 1:
+            logger.info("Updating existing agent: %s", name)
+            return self.update_agent(existing[0].id, name=name, **kwargs)
+
+        if len(existing) > 1:
+            raise ValueError(f"Multiple agents found with name '{name}'")
+
+        # Create new agent
+        logger.info("Creating new agent: %s", name)
+        return self.create_agent(name=name, **kwargs)
+
     def _prepare_sync_request_data(
         self,
         message: str,
@@ -882,9 +1095,32 @@ class AgentClient(BaseClient):
         tty: bool = False,
         *,
         renderer: RichStreamRenderer | str | None = "auto",
+        runtime_config: dict[str, Any] | None = None,
         **kwargs,
     ) -> str:
-        """Run an agent with a message, streaming via a renderer."""
+        """Run an agent with a message, streaming via a renderer.
+
+        Args:
+            agent_id: The ID of the agent to run.
+            message: The message to send to the agent.
+            files: Optional list of files to include with the request.
+            tty: Whether to enable TTY mode.
+            renderer: Renderer for streaming output.
+            runtime_config: Optional runtime configuration for tools, MCPs, and agents.
+                Keys should be platform IDs. Example:
+                {
+                    "tool_configs": {"tool-id": {"param": "value"}},
+                    "mcp_configs": {"mcp-id": {"setting": "on"}},
+                    "agent_config": {"planning": True},
+                }
+            **kwargs: Additional arguments to pass to the run API.
+
+        Returns:
+            The agent's response as a string.
+        """
+        # Include runtime_config in kwargs only when caller hasn't already provided it
+        if runtime_config is not None and "runtime_config" not in kwargs:
+            kwargs["runtime_config"] = runtime_config
         (
             payload,
             data_payload,
@@ -1028,7 +1264,8 @@ class AgentClient(BaseClient):
         message: str,
         files: list[str | BinaryIO] | None = None,
         *,
-        timeout: float | None = None,
+        request_timeout: float | None = None,
+        runtime_config: dict[str, Any] | None = None,
         **kwargs,
     ) -> AsyncGenerator[dict, None]:
         """Async run an agent with a message, yielding streaming JSON chunks.
@@ -1037,7 +1274,14 @@ class AgentClient(BaseClient):
             agent_id: ID of the agent to run
             message: Message to send to the agent
             files: Optional list of files to include
-            timeout: Request timeout in seconds
+            request_timeout: Optional request timeout in seconds (defaults to client timeout)
+            runtime_config: Optional runtime configuration for tools, MCPs, and agents.
+                Keys should be platform IDs. Example:
+                {
+                    "tool_configs": {"tool-id": {"param": "value"}},
+                    "mcp_configs": {"mcp-id": {"setting": "on"}},
+                    "agent_config": {"planning": True},
+                }
             **kwargs: Additional arguments (chat_history, pii_mapping, etc.)
 
         Yields:
@@ -1048,18 +1292,25 @@ class AgentClient(BaseClient):
             httpx.TimeoutException: When general timeout occurs
             Exception: For other unexpected errors
         """
+        # Include runtime_config in kwargs only when caller hasn't already provided it
+        if runtime_config is not None and "runtime_config" not in kwargs:
+            kwargs["runtime_config"] = runtime_config
+        # Derive timeout values for request/control flow
+        legacy_timeout = kwargs.get("timeout")
+        http_timeout_override = request_timeout if request_timeout is not None else legacy_timeout
+        http_timeout = http_timeout_override or self.timeout
+
         # Prepare request data
         payload, data_payload, files_payload, headers = self._prepare_request_data(message, files, **kwargs)
 
         # Create async client configuration
-        async_client_config = self._create_async_client_config(timeout, headers)
+        async_client_config = self._create_async_client_config(http_timeout_override, headers)
 
         # Get execution timeout for streaming control
         timeout_seconds = kwargs.get("timeout", DEFAULT_AGENT_RUN_TIMEOUT)
         agent_name = kwargs.get("agent_name")
 
-        try:
-            # Create async client and stream response
+        async def _chunk_stream() -> AsyncGenerator[dict, None]:
             async with httpx.AsyncClient(**async_client_config) as async_client:
                 async for chunk in self._stream_agent_response(
                     async_client,
@@ -1073,7 +1324,14 @@ class AgentClient(BaseClient):
                 ):
                     yield chunk
 
-        finally:
-            # Ensure cleanup - this is handled by the calling context
-            # but we keep this for safety in case of future changes
-            pass
+        async with _async_timeout_guard(http_timeout):
+            async for chunk in _chunk_stream():
+                yield chunk
+
+    @property
+    def runs(self) -> "AgentRunsClient":
+        """Get the agent runs client."""
+        if self._runs_client is None:
+            shared_config = build_shared_config(self)
+            self._runs_client = AgentRunsClient(**shared_config)
+        return self._runs_client

glaip_sdk/client/base.py

@@ -3,6 +3,7 @@
 
 Authors:
     Raymond Christopher (raymond.christopher@gdplabs.id)
+    Christian Trisno Sen Long Chen (christian.t.s.l.chen@gdplabs.id)
 """
 
 import logging

glaip_sdk/client/main.py

@@ -3,15 +3,24 @@
 
 Authors:
     Raymond Christopher (raymond.christopher@gdplabs.id)
+    Christian Trisno Sen Long Chen (christian.t.s.l.chen@gdplabs.id)
 """
 
-from typing import Any
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, Any
 
 from glaip_sdk.client.agents import AgentClient
 from glaip_sdk.client.base import BaseClient
 from glaip_sdk.client.mcps import MCPClient
+from glaip_sdk.client.shared import build_shared_config
 from glaip_sdk.client.tools import ToolClient
-from glaip_sdk.models import MCP, Agent, Tool
+
+if TYPE_CHECKING:  # pragma: no cover
+    from glaip_sdk.agents import Agent
+    from glaip_sdk.client._agent_payloads import AgentListResult
+    from glaip_sdk.mcps import MCP
+    from glaip_sdk.tools import Tool
 
 
 class Client(BaseClient):
@@ -25,12 +34,7 @@ class Client(BaseClient):
         """
         super().__init__(**kwargs)
         # Share the single httpx.Client + config with sub-clients
-        shared_config = {
-            "parent_client": self,
-            "api_url": self.api_url,
-            "api_key": self.api_key,
-            "timeout": self._timeout,
-        }
+        shared_config = build_shared_config(self)
         self.agents = AgentClient(**shared_config)
         self.tools = ToolClient(**shared_config)
         self.mcps = MCPClient(**shared_config)
@@ -53,7 +57,7 @@ class Client(BaseClient):
         name: str | None = None,
         version: str | None = None,
         sync_langflow_agents: bool = False,
-    ) -> list[Agent]:
+    ) -> AgentListResult:
         """List agents with optional filtering.
 
         Args:
@@ -64,7 +68,7 @@ class Client(BaseClient):
             sync_langflow_agents: Sync with LangFlow server before listing (only applies when agent_type=langflow)
 
         Returns:
-            List of agents matching the filters
+            AgentListResult with agents and pagination metadata. Supports iteration and indexing.
         """
         return self.agents.list_agents(
             agent_type=agent_type,
@@ -217,6 +221,11 @@ class Client(BaseClient):
 
     @timeout.setter
     def timeout(self, value: float) -> None:  # type: ignore[override]
+        """Set the client timeout and propagate to sub-clients.
+
+        Args:
+            value: Timeout value in seconds.
+        """
         # Rebuild the root http client
         BaseClient.timeout.fset(self, value)  # call parent setter
         # Propagate the new session to sub-clients so they don't hold a closed client