|
| 1 | +__author__ = "lucaspavanelli" |
| 2 | + |
| 3 | +""" |
| 4 | +Copyright 2024 The aiXplain SDK authors |
| 5 | +
|
| 6 | +Licensed under the Apache License, Version 2.0 (the "License"); |
| 7 | +you may not use this file except in compliance with the License. |
| 8 | +You may obtain a copy of the License at |
| 9 | +
|
| 10 | + http://www.apache.org/licenses/LICENSE-2.0 |
| 11 | +
|
| 12 | +Unless required by applicable law or agreed to in writing, software |
| 13 | +distributed under the License is distributed on an "AS IS" BASIS, |
| 14 | +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 15 | +See the License for the specific language governing permissions and |
| 16 | +limitations under the License. |
| 17 | +
|
| 18 | +Author: Thiago Castro Ferreira and Lucas Pavanelli |
| 19 | +Date: May 16th 2024 |
| 20 | +Description: |
| 21 | + Agent Factory Class |
| 22 | +""" |
| 23 | + |
| 24 | +import json |
| 25 | +import logging |
| 26 | + |
| 27 | +from aixplain.enums.supplier import Supplier |
| 28 | +from aixplain.modules.agent import Agent, Tool |
| 29 | +from aixplain.modules.agent.tool.model_tool import ModelTool |
| 30 | +from aixplain.modules.agent.tool.pipeline_tool import PipelineTool |
| 31 | +from aixplain.utils import config |
| 32 | +from typing import Dict, List, Optional, Text, Union |
| 33 | + |
| 34 | +from aixplain.factories.agent_factory.utils import build_agent |
| 35 | +from aixplain.utils.file_utils import _request_with_retry |
| 36 | +from urllib.parse import urljoin |
| 37 | + |
| 38 | + |
| 39 | +class AgentFactory: |
| 40 | + @classmethod |
| 41 | + def create( |
| 42 | + cls, |
| 43 | + name: Text, |
| 44 | + llm_id: Text, |
| 45 | + tools: List[Tool] = [], |
| 46 | + description: Text = "", |
| 47 | + api_key: Text = config.TEAM_API_KEY, |
| 48 | + supplier: Union[Dict, Text, Supplier, int] = "aiXplain", |
| 49 | + version: Optional[Text] = None, |
| 50 | + ) -> Agent: |
| 51 | + """Create a new agent in the platform.""" |
| 52 | + try: |
| 53 | + agent = None |
| 54 | + url = urljoin(config.BACKEND_URL, "sdk/agents") |
| 55 | + headers = {"x-api-key": api_key} |
| 56 | + |
| 57 | + if isinstance(supplier, dict): |
| 58 | + supplier = supplier["code"] |
| 59 | + elif isinstance(supplier, Supplier): |
| 60 | + supplier = supplier.value["code"] |
| 61 | + |
| 62 | + tool_payload = [] |
| 63 | + for tool in tools: |
| 64 | + if isinstance(tool, ModelTool): |
| 65 | + tool_payload.append( |
| 66 | + { |
| 67 | + "function": tool.function.value, |
| 68 | + "type": "model", |
| 69 | + "description": tool.description, |
| 70 | + "supplier": tool.supplier.value["code"] if tool.supplier else None, |
| 71 | + "version": tool.version if tool.version else None, |
| 72 | + } |
| 73 | + ) |
| 74 | + elif isinstance(tool, PipelineTool): |
| 75 | + tool_payload.append( |
| 76 | + { |
| 77 | + "assetId": tool.pipeline, |
| 78 | + "description": tool.description, |
| 79 | + "type": "pipeline", |
| 80 | + } |
| 81 | + ) |
| 82 | + else: |
| 83 | + raise Exception("Agent Creation Error: Tool type not supported.") |
| 84 | + |
| 85 | + payload = { |
| 86 | + "name": name, |
| 87 | + "assets": tool_payload, |
| 88 | + "description": description, |
| 89 | + "supplier": supplier, |
| 90 | + "version": version, |
| 91 | + } |
| 92 | + if llm_id is not None: |
| 93 | + payload["llmId"] = llm_id |
| 94 | + |
| 95 | + logging.info(f"Start service for POST Create Agent - {url} - {headers} - {json.dumps(payload)}") |
| 96 | + r = _request_with_retry("post", url, headers=headers, json=payload) |
| 97 | + if 200 <= r.status_code < 300: |
| 98 | + response = r.json() |
| 99 | + agent = build_agent(payload=response, api_key=api_key) |
| 100 | + else: |
| 101 | + error = r.json() |
| 102 | + error_msg = "Agent Onboarding Error: Please contant the administrators." |
| 103 | + if "message" in error: |
| 104 | + msg = error["message"] |
| 105 | + if error["message"] == "err.name_already_exists": |
| 106 | + msg = "Agent name already exists." |
| 107 | + elif error["message"] == "err.asset_is_not_available": |
| 108 | + msg = "Some the tools are not available." |
| 109 | + error_msg = f"Agent Onboarding Error (HTTP {r.status_code}): {msg}" |
| 110 | + logging.exception(error_msg) |
| 111 | + raise Exception(error_msg) |
| 112 | + except Exception as e: |
| 113 | + raise Exception(e) |
| 114 | + return agent |
| 115 | + |
| 116 | + @classmethod |
| 117 | + def list(cls) -> Dict: |
| 118 | + """List all agents available in the platform.""" |
| 119 | + url = urljoin(config.BACKEND_URL, "sdk/agents") |
| 120 | + headers = {"x-api-key": config.TEAM_API_KEY, "Content-Type": "application/json"} |
| 121 | + |
| 122 | + payload = {} |
| 123 | + logging.info(f"Start service for GET List Agents - {url} - {headers} - {json.dumps(payload)}") |
| 124 | + try: |
| 125 | + r = _request_with_retry("get", url, headers=headers) |
| 126 | + resp = r.json() |
| 127 | + |
| 128 | + if 200 <= r.status_code < 300: |
| 129 | + agents, page_total, total = [], 0, 0 |
| 130 | + results = resp |
| 131 | + page_total = len(results) |
| 132 | + total = len(results) |
| 133 | + logging.info(f"Response for GET List Agents - Page Total: {page_total} / Total: {total}") |
| 134 | + for agent in results: |
| 135 | + agents.append(build_agent(agent)) |
| 136 | + return {"results": agents, "page_total": page_total, "page_number": 0, "total": total} |
| 137 | + else: |
| 138 | + error_msg = "Agent Listing Error: Please contant the administrators." |
| 139 | + if "message" in resp: |
| 140 | + msg = resp["message"] |
| 141 | + error_msg = f"Agent Listing Error (HTTP {r.status_code}): {msg}" |
| 142 | + logging.exception(error_msg) |
| 143 | + raise Exception(error_msg) |
| 144 | + except Exception as e: |
| 145 | + raise Exception(e) |
| 146 | + |
| 147 | + @classmethod |
| 148 | + def get(cls, agent_id: Text, api_key: Optional[Text] = None) -> Agent: |
| 149 | + """Get agent by id.""" |
| 150 | + url = urljoin(config.BACKEND_URL, f"sdk/agents/{agent_id}") |
| 151 | + if config.AIXPLAIN_API_KEY != "": |
| 152 | + headers = {"x-aixplain-key": f"{config.AIXPLAIN_API_KEY}", "Content-Type": "application/json"} |
| 153 | + else: |
| 154 | + api_key = api_key if api_key is not None else config.TEAM_API_KEY |
| 155 | + headers = {"x-api-key": api_key, "Content-Type": "application/json"} |
| 156 | + logging.info(f"Start service for GET Agent - {url} - {headers}") |
| 157 | + r = _request_with_retry("get", url, headers=headers) |
| 158 | + resp = r.json() |
| 159 | + if 200 <= r.status_code < 300: |
| 160 | + return build_agent(resp) |
| 161 | + else: |
| 162 | + msg = "Please contant the administrators." |
| 163 | + if "message" in resp: |
| 164 | + msg = resp["message"] |
| 165 | + error_msg = f"Agent Get Error (HTTP {r.status_code}): {msg}" |
| 166 | + raise Exception(error_msg) |
0 commit comments