Added more samples for AI agent

Author: aosingh

doc/source/user_guide/agent.rst

@@ -46,22 +46,30 @@ Python layer and persist the tool in the Database using
          - ``smtp_host``
     * - ``HTTP``
       - ``select_ai.agent.Tool.create_http_tool``
-      - ``tool_name``, ``credential_name``, ``endpoint``
+      - - ``tool_name``
+        - ``credential_name``
+        - ``endpoint``
     * - ``SQL``
       - ``select_ai.agent.Tool.create_sql_tool``
-      - ``tool_name``, ``profile_name``
+      - - ``tool_name``
+        - ``profile_name``
     * - ``SLACK``
       - ``select_ai.agent.Tool.create_slack_notification_tool``
-      - ``tool_name``, ``credential_name``, ``slack_channel``
+      - - ``tool_name``
+        - ``credential_name``
+        - ``slack_channel``
     * - ``WEBSEARCH``
       - ``select_ai.agent.Tool.create_websearch_tool``
-      - ``tool_name``, ``credential_name``
+      - - ``tool_name``
+        - ``credential_name``
     * - ``PL/SQL custom tool``
       - ``select_ai.agent.Tool.create_pl_sql_tool``
-      - ``tool_name``, ``function``
+      - - ``tool_name``
+        - ``function``
     * - ``RAG``
       - ``select_ai.agent.Tool.create_rag_tool``
-      - ``tool_name``, ``profile_name``
+      - - ``tool_name``
+        - ``profile_name``
 
 .. latex:clearpage::
 

samples/agent/websearch_agent.py

@@ -0,0 +1,101 @@
+import os
+
+import select_ai
+from select_ai.agent import (
+    Agent,
+    AgentAttributes,
+    Task,
+    TaskAttributes,
+    Team,
+    TeamAttributes,
+    Tool,
+)
+
+OPEN_AI_CREDENTIAL_NAME = "OPENAI_CRED"
+OPEN_AI_PROFILE_NAME = "OPENAI_PROFILE"
+SELECT_AI_AGENT_NAME = "WEB_SEARCH_AGENT"
+SELECT_AI_TASK_NAME = "WEB_SEARCH_TASK"
+SELECT_AI_TOOL_NAME = "WEB_SEARCH_TOOL"
+SELECT_AI_TEAM_NAME = "WEB_SEARCH_TEAM"
+
+USER_QUERIES = {
+    "d917b055-e8a1-463a-a489-d4328a7b2210": "What are the key features for the product highlighted at this URL https://www.oracle.com/artificial-intelligence/database-machine-learning",
+    "c2e3ff20-f56d-40e7-987c-cc72740c75a5": "What is the main topic at this URL https://www.oracle.com/artificial-intelligence/database-machine-learning",
+    "25e23a25-07b9-4ed7-be11-f7e5e445d286": "What is the main topic at this URL https://openai.com",
+}
+
+# connect
+user = os.getenv("SELECT_AI_USER")
+password = os.getenv("SELECT_AI_PASSWORD")
+dsn = os.getenv("SELECT_AI_DB_CONNECT_STRING")
+select_ai.connect(user=user, password=password, dsn=dsn)
+
+# Create Open AI credential
+select_ai.create_credential(
+    credential={
+        "credential_name": OPEN_AI_CREDENTIAL_NAME,
+        "username": "OPENAI",
+        "password": os.getenv("OPEN_AI_API_KEY"),
+    },
+    replace=True,
+)
+print("Created credential: ", OPEN_AI_CREDENTIAL_NAME)
+
+# # Create Open AI Profile
+profile = select_ai.Profile(
+    profile_name=OPEN_AI_PROFILE_NAME,
+    attributes=select_ai.ProfileAttributes(
+        credential_name=OPEN_AI_CREDENTIAL_NAME,
+        provider=select_ai.OpenAIProvider(model="gpt-4.1"),
+    ),
+    description="My Open AI Profile",
+    replace=True,
+)
+print("Created profile: ", OPEN_AI_PROFILE_NAME)
+
+# Create an AI Agent team
+team = Team(
+    team_name=SELECT_AI_TEAM_NAME,
+    attributes=TeamAttributes(
+        agents=[{"name": SELECT_AI_AGENT_NAME, "task": SELECT_AI_TASK_NAME}]
+    ),
+)
+team.create(replace=True)
+
+# Agent
+agent = Agent(
+    agent_name=SELECT_AI_AGENT_NAME,
+    attributes=AgentAttributes(
+        profile_name=OPEN_AI_PROFILE_NAME,
+        enable_human_tool=False,
+        role="You are a specialized web search agent that can access web page contents and respond to questions based on its content.",
+    ),
+)
+agent.create(replace=True)
+
+# Task
+task = Task(
+    task_name=SELECT_AI_TASK_NAME,
+    attributes=TaskAttributes(
+        instruction="Answer the user question about the provided URL:{query}",
+        enable_human_tool=False,
+        tools=[SELECT_AI_TOOL_NAME],
+    ),
+)
+task.create(replace=True)
+
+# Tool
+web_search_tool = Tool.create_websearch_tool(
+    tool_name=SELECT_AI_TOOL_NAME,
+    credential_name=OPEN_AI_CREDENTIAL_NAME,
+    description="Web Search Tool using OpenAI",
+    replace=True,
+)
+print("Created tool: ", SELECT_AI_TOOL_NAME)
+
+# Run the Agent Team
+for conversation_id, prompt in USER_QUERIES.items():
+    response = team.run(
+        prompt=prompt, params={"conversation_id": conversation_id}
+    )
+    print(response)

samples/enable_ai_provider.py

@@ -23,6 +23,6 @@
 
 select_ai.connect(user=admin_user, password=password, dsn=dsn)
 select_ai.enable_provider(
-    users=select_ai_user, provider_endpoint="*.openai.azure.com"
+    users=select_ai_user, provider_endpoint="api.OPENAI.com"
 )
 print("Enabled AI provider for user: ", select_ai_user)

src/select_ai/agent/task.py

@@ -8,7 +8,15 @@
 import json
 from abc import ABC
 from dataclasses import dataclass
-from typing import AsyncGenerator, Iterator, List, Mapping, Optional, Union
+from typing import (
+    Any,
+    AsyncGenerator,
+    Iterator,
+    List,
+    Mapping,
+    Optional,
+    Union,
+)
 
 import oracledb
 
@@ -168,9 +176,15 @@ def delete(self, force: bool = False):
             )
 
     def disable(self):
+        """
+        Disable AI Task
+        """
         pass
 
     def enable(self):
+        """
+        Enable AI Task
+        """
         pass
 
     @classmethod
@@ -217,9 +231,15 @@ def fetch(cls, task_name: str) -> "Task":
         pass
 
     def set_attributes(self, attributes: TaskAttributes):
+        """
+        Set AI Task attributes
+        """
         pass
 
-    def set_attribute(self):
+    def set_attribute(self, attribute_name: str, attribute_value: Any):
+        """
+        Set a single AI Task attribute specified using name and value
+        """
         pass
 
 

src/select_ai/agent/team.py

@@ -168,9 +168,15 @@ def delete(self, force: Optional[bool] = False):
             )
 
     def disable(self):
+        """
+        Disable the AI agent team
+        """
         pass
 
     def enable(self):
+        """
+        Enable the AI agent team
+        """
         pass
 
     @classmethod
@@ -232,11 +238,12 @@ def run(self, prompt: str = None, params: Mapping = None):
          WAITING_FOR_HUMAN state, the input serves as the human response.
 
         :param Mapping[str, str] params: Optional parameters for the task.
-         This supports:
-         1) conversation_id: Identifies the conversation session associated
-             with the agent team
-         2) variables: key-value pairs that provide additional input to
-             the agent team.
+         Currently, the following parameters are supported:
+
+         - conversation_id: Identifies the conversation session associated
+         with the agent team
+
+         - variables: key-value pairs that provide additional input to the agent team.
 
         """
         parameters = {
@@ -260,7 +267,14 @@ def run(self, prompt: str = None, params: Mapping = None):
             return result
 
     def set_attributes(self, attributes: TeamAttributes) -> None:
+        """
+        Set the attributes of the AI Agent team
+        """
         pass
 
     def set_attribute(self, attribute_name: str, attribute_value: Any) -> None:
+        """
+        Set the attribute of the AI Agent team specified by
+        `attribute_name` and `attribute_value`.
+        """
         pass

src/select_ai/agent/tool.py

@@ -315,6 +315,7 @@ def create_built_in_tool(
         cls,
         tool_name: str,
         tool_params: ToolParams,
+        tool_type: ToolType,
         description: Optional[str] = None,
         replace: Optional[bool] = False,
     ) -> Tool:
@@ -324,6 +325,7 @@ def create_built_in_tool(
         :param str tool_name: The name of the tool
         :param select_ai.agent.ToolParams tool_params:
          Parameters required by built-in tool
+        :param select_ai.agent.ToolType tool_type: The built-in tool type
         :param str description: Description of the tool
         :param bool replace: Whether to replace the existing tool.
          Default value is False
@@ -336,7 +338,7 @@ def create_built_in_tool(
                 "type select_ai.agent.ToolParams"
             )
         attributes = ToolAttributes(
-            tool_params=tool_params, tool_type=ToolType.SQL
+            tool_params=tool_params, tool_type=tool_type
         )
         tool = cls(
             tool_name=tool_name, attributes=attributes, description=description
@@ -378,6 +380,7 @@ def create_email_notification_tool(
         )
         return cls.create_built_in_tool(
             tool_name=tool_name,
+            tool_type=ToolType.EMAIL,
             tool_params=email_notification_tool_params,
             description=description,
             replace=replace,
@@ -397,6 +400,7 @@ def create_http_tool(
         )
         return cls.create_built_in_tool(
             tool_name=tool_name,
+            tool_type=ToolType.HTTP,
             tool_params=http_tool_params,
             description=description,
             replace=replace,
@@ -450,6 +454,7 @@ def create_rag_tool(
         tool_params = RAGToolParams(profile_name=profile_name)
         return cls.create_built_in_tool(
             tool_name=tool_name,
+            tool_type=ToolType.RAG,
             tool_params=tool_params,
             description=description,
             replace=replace,
@@ -476,6 +481,7 @@ def create_sql_tool(
         tool_params = SQLToolParams(profile_name=profile_name)
         return cls.create_built_in_tool(
             tool_name=tool_name,
+            tool_type=ToolType.SQL,
             tool_params=tool_params,
             description=description,
             replace=replace,
@@ -507,6 +513,7 @@ def create_slack_notification_tool(
         )
         return cls.create_built_in_tool(
             tool_name=tool_name,
+            tool_type=ToolType.SLACK,
             tool_params=slack_notification_tool_params,
             description=description,
             replace=replace,
@@ -536,6 +543,7 @@ def create_websearch_tool(
         )
         return cls.create_built_in_tool(
             tool_name=tool_name,
+            tool_type=ToolType.WEBSEARCH,
             tool_params=web_search_tool_params,
             description=description,
             replace=replace,