select-ai 1.2.0rc3__py3-none-any.whl

select_ai/agent/core.py

@@ -0,0 +1,511 @@
+# ------------------------------------------------------------------------------
+# Copyright (c) 2025, Oracle and/or its affiliates.
+#
+# Licensed under the Universal Permissive License v 1.0 as shown at
+# http://oss.oracle.com/licenses/upl.
+# -----------------------------------------------------------------------------
+
+from abc import ABC
+from dataclasses import dataclass
+from typing import (
+    Any,
+    AsyncGenerator,
+    Iterator,
+    Optional,
+    Union,
+)
+
+import oracledb
+
+from select_ai._abc import SelectAIDataClass
+from select_ai.agent.sql import (
+    GET_USER_AI_AGENT,
+    GET_USER_AI_AGENT_ATTRIBUTES,
+    LIST_USER_AI_AGENTS,
+)
+from select_ai.db import async_cursor, cursor
+from select_ai.errors import AgentNotFoundError
+
+
+@dataclass
+class AgentAttributes(SelectAIDataClass):
+    """AI Agent Attributes
+
+    :param str profile_name: Name of the AI Profile which agent will
+     use to send request to LLM
+    :param str role: Agent's role also sent to LLM
+    :param bool enable_human_tool: Enable human tool support. Agent
+     will ask question to the user for any clarification
+    """
+
+    profile_name: str
+    role: str
+    enable_human_tool: Optional[bool] = True
+
+
+class BaseAgent(ABC):
+
+    def __init__(
+        self,
+        agent_name: Optional[str] = None,
+        description: Optional[str] = None,
+        attributes: Optional[AgentAttributes] = None,
+    ):
+        if attributes is not None and not isinstance(
+            attributes, AgentAttributes
+        ):
+            raise TypeError(
+                "attributes must be an object of type "
+                "select_ai.agent.AgentAttributes"
+            )
+        self.agent_name = agent_name
+        self.description = description
+        self.attributes = attributes
+
+    def __repr__(self):
+        return (
+            f"{self.__class__.__name__}("
+            f"agent_name={self.agent_name}, "
+            f"attributes={self.attributes}, description={self.description})"
+        )
+
+
+class Agent(BaseAgent):
+    """
+    select_ai.agent.Agent class lets you create, delete, enable, disable
+    and list AI agents
+
+    :param str agent_name: The name of the AI Agent
+    :param str description: Optional description of the AI agent
+    :param select_ai.agent.AgentAttributes attributes: AI agent attributes
+
+    """
+
+    @staticmethod
+    def _get_attributes(agent_name: str) -> AgentAttributes:
+        with cursor() as cr:
+            cr.execute(
+                GET_USER_AI_AGENT_ATTRIBUTES, agent_name=agent_name.upper()
+            )
+            attributes = cr.fetchall()
+            if attributes:
+                post_processed_attributes = {}
+                for k, v in attributes:
+                    if isinstance(v, oracledb.LOB):
+                        post_processed_attributes[k] = v.read()
+                    else:
+                        post_processed_attributes[k] = v
+                return AgentAttributes(**post_processed_attributes)
+            else:
+                raise AgentNotFoundError(agent_name=agent_name)
+
+    @staticmethod
+    def _get_description(agent_name: str) -> Union[str, None]:
+        with cursor() as cr:
+            cr.execute(GET_USER_AI_AGENT, agent_name=agent_name.upper())
+            agent = cr.fetchone()
+            if agent:
+                if agent[1] is not None:
+                    return agent[1].read()
+                else:
+                    return None
+            else:
+                raise AgentNotFoundError(agent_name)
+
+    def create(
+        self, enabled: Optional[bool] = True, replace: Optional[bool] = False
+    ):
+        """
+        Register a new AI Agent within the Select AI framework
+
+        :param bool enabled: Whether the AI Agent should be enabled.
+         Default value is True.
+
+        :param bool replace: Whether the AI Agent should be replaced.
+         Default value is False.
+
+        """
+        if self.agent_name is None:
+            raise AttributeError("Agent must have a name")
+        if self.attributes is None:
+            raise AttributeError("Agent must have attributes")
+
+        parameters = {
+            "agent_name": self.agent_name,
+            "attributes": self.attributes.json(),
+        }
+        if self.description:
+            parameters["description"] = self.description
+
+        if not enabled:
+            parameters["status"] = "disabled"
+
+        with cursor() as cr:
+            try:
+                cr.callproc(
+                    "DBMS_CLOUD_AI_AGENT.CREATE_AGENT",
+                    keyword_parameters=parameters,
+                )
+            except oracledb.Error as err:
+                (err_obj,) = err.args
+                if err_obj.code in (20050, 20052) and replace:
+                    self.delete(force=True)
+                    cr.callproc(
+                        "DBMS_CLOUD_AI_AGENT.CREATE_AGENT",
+                        keyword_parameters=parameters,
+                    )
+                else:
+                    raise
+
+    def delete(self, force: Optional[bool] = False):
+        """
+        Delete AI Agent from the database
+
+        :param bool force: Force the deletion. Default value is False.
+
+        """
+        with cursor() as cr:
+            cr.callproc(
+                "DBMS_CLOUD_AI_AGENT.DROP_AGENT",
+                keyword_parameters={
+                    "agent_name": self.agent_name,
+                    "force": force,
+                },
+            )
+
+    def disable(self):
+        """
+        Disable AI Agent
+        """
+        with cursor as cr:
+            cr.callproc(
+                "DBMS_CLOUD_AI_AGENT.DISABLE_AGENT",
+                keyword_parameters={
+                    "agent_name": self.agent_name,
+                },
+            )
+
+    def enable(self):
+        """
+        Enable AI Agent
+        """
+        with cursor as cr:
+            cr.callproc(
+                "DBMS_CLOUD_AI_AGENT.ENABLE_AGENT",
+                keyword_parameters={
+                    "agent_name": self.agent_name,
+                },
+            )
+
+    @classmethod
+    def fetch(cls, agent_name: str) -> "Agent":
+        """
+        Fetch AI Agent attributes from the Database and build a proxy object in
+        the Python layer
+
+        :param str agent_name: The name of the AI Agent
+
+        :return: select_ai.agent.Agent
+
+        :raises select_ai.errors.AgentNotFoundError:
+         If the AI Agent is not found
+
+        """
+        attributes = cls._get_attributes(agent_name=agent_name)
+        description = cls._get_description(agent_name=agent_name)
+        return cls(
+            agent_name=agent_name,
+            attributes=attributes,
+            description=description,
+        )
+
+    @classmethod
+    def list(
+        cls, agent_name_pattern: Optional[str] = ".*"
+    ) -> Iterator["Agent"]:
+        """
+        List AI agents matching a pattern
+
+        :param str agent_name_pattern: Regular expressions can be used
+         to specify a pattern. Function REGEXP_LIKE is used to perform the
+         match. Default value is ".*" i.e. match all agent names.
+
+        :return: Iterator[Agent]
+        """
+        with cursor() as cr:
+            cr.execute(
+                LIST_USER_AI_AGENTS,
+                agent_name_pattern=agent_name_pattern,
+            )
+            for row in cr.fetchall():
+                agent_name = row[0]
+                if row[1]:
+                    description = row[1].read()  # Oracle.LOB
+                else:
+                    description = None
+                attributes = cls._get_attributes(agent_name=agent_name)
+                yield cls(
+                    agent_name=agent_name,
+                    description=description,
+                    attributes=attributes,
+                )
+
+    def set_attributes(self, attributes: AgentAttributes) -> None:
+        """
+        Set AI Agent attributes
+
+        :param select_ai.agent.AgentAttributes attributes: Multiple attributes
+         can be specified by passing an AgentAttributes object
+        """
+        parameters = {
+            "object_name": self.agent_name,
+            "object_type": "agent",
+            "attributes": attributes.json(),
+        }
+        with cursor() as cr:
+            cr.callproc(
+                "DBMS_CLOUD_AI_AGENT.SET_ATTRIBUTES",
+                keyword_parameters=parameters,
+            )
+        self.attributes = self._get_attributes(agent_name=self.agent_name)
+
+    def set_attribute(self, attribute_name: str, attribute_value: Any) -> None:
+        """
+        Set a single AI Agent attribute specified using name and value
+        """
+        parameters = {
+            "object_name": self.agent_name,
+            "object_type": "agent",
+            "attribute_name": attribute_name,
+            "attribute_value": attribute_value,
+        }
+        with cursor() as cr:
+            cr.callproc(
+                "DBMS_CLOUD_AI_AGENT.SET_ATTRIBUTE",
+                keyword_parameters=parameters,
+            )
+        self.attributes = self._get_attributes(agent_name=self.agent_name)
+
+
+class AsyncAgent(BaseAgent):
+    """
+    select_ai.agent.AsyncAgent class lets you create, delete, enable, disable
+    and list AI agents asynchronously
+
+    :param str agent_name: The name of the AI Agent
+    :param str description: Optional description of the AI agent
+    :param select_ai.agent.AgentAttributes attributes: AI agent attributes
+
+    """
+
+    @staticmethod
+    async def _get_attributes(agent_name: str) -> AgentAttributes:
+        async with async_cursor() as cr:
+            await cr.execute(
+                GET_USER_AI_AGENT_ATTRIBUTES, agent_name=agent_name.upper()
+            )
+            attributes = await cr.fetchall()
+            if attributes:
+                post_processed_attributes = {}
+                for k, v in attributes:
+                    if isinstance(v, oracledb.AsyncLOB):
+                        post_processed_attributes[k] = await v.read()
+                    else:
+                        post_processed_attributes[k] = v
+                return AgentAttributes(**post_processed_attributes)
+            else:
+                raise AgentNotFoundError(agent_name=agent_name)
+
+    @staticmethod
+    async def _get_description(agent_name: str) -> Union[str, None]:
+        async with async_cursor() as cr:
+            await cr.execute(GET_USER_AI_AGENT, agent_name=agent_name.upper())
+            agent = await cr.fetchone()
+            if agent:
+                if agent[1] is not None:
+                    return await agent[1].read()
+                else:
+                    return None
+            else:
+                raise AgentNotFoundError(agent_name)
+
+    async def create(
+        self, enabled: Optional[bool] = True, replace: Optional[bool] = False
+    ):
+        """
+        Register a new AI Agent within the Select AI framework
+
+        :param bool enabled: Whether the AI Agent should be enabled.
+         Default value is True.
+
+        :param bool replace: Whether the AI Agent should be replaced.
+         Default value is False.
+
+        """
+        if self.agent_name is None:
+            raise AttributeError("Agent must have a name")
+        if self.attributes is None:
+            raise AttributeError("Agent must have attributes")
+
+        parameters = {
+            "agent_name": self.agent_name,
+            "attributes": self.attributes.json(),
+        }
+        if self.description:
+            parameters["description"] = self.description
+
+        if not enabled:
+            parameters["status"] = "disabled"
+
+        async with async_cursor() as cr:
+            try:
+                await cr.callproc(
+                    "DBMS_CLOUD_AI_AGENT.CREATE_AGENT",
+                    keyword_parameters=parameters,
+                )
+            except oracledb.Error as err:
+                (err_obj,) = err.args
+                if err_obj.code in (20050, 20052) and replace:
+                    await self.delete(force=True)
+                    await cr.callproc(
+                        "DBMS_CLOUD_AI_AGENT.CREATE_AGENT",
+                        keyword_parameters=parameters,
+                    )
+                else:
+                    raise
+
+    async def delete(self, force: Optional[bool] = False):
+        """
+        Delete AI Agent from the database
+
+        :param bool force: Force the deletion. Default value is False.
+
+        """
+        async with async_cursor() as cr:
+            await cr.callproc(
+                "DBMS_CLOUD_AI_AGENT.DROP_AGENT",
+                keyword_parameters={
+                    "agent_name": self.agent_name,
+                    "force": force,
+                },
+            )
+
+    async def disable(self):
+        """
+        Disable AI Agent
+        """
+        async with async_cursor as cr:
+            await cr.callproc(
+                "DBMS_CLOUD_AI_AGENT.DISABLE_AGENT",
+                keyword_parameters={
+                    "agent_name": self.agent_name,
+                },
+            )
+
+    async def enable(self):
+        """
+        Enable AI Agent
+        """
+        async with async_cursor as cr:
+            await cr.callproc(
+                "DBMS_CLOUD_AI_AGENT.ENABLE_AGENT",
+                keyword_parameters={
+                    "agent_name": self.agent_name,
+                },
+            )
+
+    @classmethod
+    async def fetch(cls, agent_name: str) -> "AsyncAgent":
+        """
+        Fetch AI Agent attributes from the Database and build a proxy object in
+        the Python layer
+
+        :param str agent_name: The name of the AI Agent
+
+        :return: select_ai.agent.Agent
+
+        :raises select_ai.errors.AgentNotFoundError:
+         If the AI Agent is not found
+
+        """
+        attributes = await cls._get_attributes(agent_name=agent_name)
+        description = await cls._get_description(agent_name=agent_name)
+        return cls(
+            agent_name=agent_name,
+            attributes=attributes,
+            description=description,
+        )
+
+    @classmethod
+    async def list(
+        cls, agent_name_pattern: Optional[str] = ".*"
+    ) -> AsyncGenerator["AsyncAgent", None]:
+        """
+        List AI agents matching a pattern
+
+        :param str agent_name_pattern: Regular expressions can be used
+         to specify a pattern. Function REGEXP_LIKE is used to perform the
+         match. Default value is ".*" i.e. match all agent names.
+
+        :return: AsyncGenerator[AsyncAgent]
+        """
+        async with async_cursor() as cr:
+            await cr.execute(
+                LIST_USER_AI_AGENTS,
+                agent_name_pattern=agent_name_pattern,
+            )
+            rows = await cr.fetchall()
+            for row in rows:
+                agent_name = row[0]
+                if row[1]:
+                    description = await row[1].read()  # Oracle.AsyncLOB
+                else:
+                    description = None
+                attributes = await cls._get_attributes(agent_name=agent_name)
+                yield cls(
+                    agent_name=agent_name,
+                    description=description,
+                    attributes=attributes,
+                )
+
+    async def set_attributes(self, attributes: AgentAttributes) -> None:
+        """
+        Set AI Agent attributes
+
+        :param select_ai.agent.AgentAttributes attributes: Multiple attributes
+         can be specified by passing an AgentAttributes object
+        """
+        parameters = {
+            "object_name": self.agent_name,
+            "object_type": "agent",
+            "attributes": attributes.json(),
+        }
+        async with async_cursor() as cr:
+            await cr.callproc(
+                "DBMS_CLOUD_AI_AGENT.SET_ATTRIBUTES",
+                keyword_parameters=parameters,
+            )
+        self.attributes = await self._get_attributes(
+            agent_name=self.agent_name
+        )
+
+    async def set_attribute(
+        self, attribute_name: str, attribute_value: Any
+    ) -> None:
+        """
+        Set a single AI Agent attribute specified using name and value
+        """
+        parameters = {
+            "object_name": self.agent_name,
+            "object_type": "agent",
+            "attribute_name": attribute_name,
+            "attribute_value": attribute_value,
+        }
+        async with async_cursor() as cr:
+            await cr.callproc(
+                "DBMS_CLOUD_AI_AGENT.SET_ATTRIBUTE",
+                keyword_parameters=parameters,
+            )
+        self.attributes = await self._get_attributes(
+            agent_name=self.agent_name
+        )

select_ai/agent/sql.py

@@ -0,0 +1,82 @@
+# -----------------------------------------------------------------------------
+# Copyright (c) 2025, Oracle and/or its affiliates.
+#
+# Licensed under the Universal Permissive License v 1.0 as shown at
+# http://oss.oracle.com/licenses/upl.
+# -----------------------------------------------------------------------------
+
+
+GET_USER_AI_AGENT = """
+SELECT a.agent_name, a.description
+from USER_AI_AGENTS a
+where a.agent_name = :agent_name
+"""
+
+GET_USER_AI_AGENT_ATTRIBUTES = """
+SELECT attribute_name, attribute_value
+FROM USER_AI_AGENT_ATTRIBUTES
+WHERE agent_name = :agent_name
+"""
+
+LIST_USER_AI_AGENTS = """
+SELECT a.agent_name, a.description
+from USER_AI_AGENTS a
+where REGEXP_LIKE(a.agent_name, :agent_name_pattern, 'i')
+"""
+
+GET_USER_AI_AGENT_TASK = """
+SELECT t.task_name, t.description
+FROM USER_AI_AGENT_TASKS t
+WHERE t.task_name= :task_name
+"""
+
+GET_USER_AI_AGENT_TASK_ATTRIBUTES = """
+SELECT attribute_name, attribute_value
+FROM USER_AI_AGENT_TASK_ATTRIBUTES
+WHERE task_name= :task_name
+"""
+
+LIST_USER_AI_AGENT_TASKS = """
+SELECT t.task_name, t.description
+FROM USER_AI_AGENT_TASKS t
+WHERE REGEXP_LIKE(t.task_name, :task_name_pattern, 'i')
+"""
+
+GET_USER_AI_AGENT_TOOL = """
+SELECT t.tool_name, t.description
+FROM USER_AI_AGENT_TOOLS t
+WHERE t.tool_name = :tool_name
+"""
+
+GET_USER_AI_AGENT_TOOL_ATTRIBUTES = """
+SELECT attribute_name, attribute_value
+FROM USER_AI_AGENT_TOOL_ATTRIBUTES
+WHERE tool_name = :tool_name
+"""
+
+LIST_USER_AI_AGENT_TOOLS = """
+SELECT t.tool_name, t.description
+FROM USER_AI_AGENT_TOOLS t
+WHERE REGEXP_LIKE(t.tool_name, :tool_name_pattern, 'i')
+"""
+
+
+GET_USER_AI_AGENT_TEAM = """
+SELECT t.agent_team_name as team_name, t.description
+FROM USER_AI_AGENT_TEAMS t
+WHERE t.agent_team_name = :team_name
+"""
+
+
+GET_USER_AI_AGENT_TEAM_ATTRIBUTES = """
+SELECT attribute_name, attribute_value
+FROM USER_AI_AGENT_TEAM_ATTRIBUTES
+WHERE agent_team_name = :team_name
+"""
+
+
+LIST_USER_AI_AGENT_TEAMS = """
+SELECT t.AGENT_TEAM_NAME as team_name, description
+FROM USER_AI_AGENT_TEAMS t
+WHERE REGEXP_LIKE(t.AGENT_TEAM_NAME, :team_name_pattern, 'i')
+"""