airia 0.1.26__tar.gz → 0.1.27__tar.gz

{airia-0.1.26 → airia-0.1.27}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: airia
-Version: 0.1.26
+Version: 0.1.27
 Summary: Python SDK for Airia API
 Author-email: Airia LLC <support@airia.com>
 License: MIT

{airia-0.1.26 → airia-0.1.27}/airia/client/async_client.py

@@ -21,6 +21,7 @@ from .pipeline_import import AsyncPipelineImport
 from .pipelines_config import AsyncPipelinesConfig
 from .project import AsyncProject
 from .store import AsyncStore
+from .tools import AsyncTools
 
 
 class AiriaAsyncClient(AiriaBaseClient):
@@ -74,6 +75,7 @@ class AiriaAsyncClient(AiriaBaseClient):
         self.data_vector_search = AsyncDataVectorSearch(self._request_handler)
         self.library = AsyncLibrary(self._request_handler)
         self.models = AsyncModels(self._request_handler)
+        self.tools = AsyncTools(self._request_handler)
 
     @classmethod
     def with_openai_gateway(

{airia-0.1.26 → airia-0.1.27}/airia/client/pipelines_config/async_pipelines_config.py

@@ -188,3 +188,53 @@ class AsyncPipelinesConfig(BasePipelinesConfig):
         resp = await self._request_handler.make_request("GET", request_data)
 
         return GetPipelinesConfigResponse(**resp)
+
+    async def delete_pipeline(
+        self,
+        pipeline_id: str,
+        correlation_id: Optional[str] = None,
+    ) -> None:
+        """
+        Delete a pipeline by its ID.
+
+        This method permanently removes a pipeline and all its configuration
+        from the Airia platform. This action cannot be undone.
+
+        Args:
+            pipeline_id (str): The unique identifier of the pipeline to delete.
+            correlation_id (str, optional): A unique identifier for request tracing
+                and logging. If not provided, one will be automatically generated.
+
+        Returns:
+            None: This method returns nothing upon successful deletion (204 No Content).
+
+        Raises:
+            AiriaAPIError: If the API request fails, including cases where:
+                - The pipeline_id doesn't exist (404)
+                - Authentication fails (401)
+                - Access is forbidden (403)
+                - Server errors (5xx)
+
+        Example:
+            ```python
+            from airia import AiriaAsyncClient
+
+            client = AiriaAsyncClient(api_key="your_api_key")
+
+            # Delete a pipeline
+            await client.pipelines_config.delete_pipeline(
+                pipeline_id="your_pipeline_id"
+            )
+            print("Pipeline deleted successfully")
+            ```
+
+        Warning:
+            This operation is permanent and cannot be reversed. Ensure you have
+            the correct pipeline_id before calling this method.
+        """
+        request_data = self._pre_delete_pipeline(
+            pipeline_id=pipeline_id,
+            correlation_id=correlation_id,
+            api_version=ApiVersion.V1.value,
+        )
+        await self._request_handler.make_request("DELETE", request_data, return_json=False)

{airia-0.1.26 → airia-0.1.27}/airia/client/pipelines_config/base_pipelines_config.py

@@ -114,3 +114,40 @@ class BasePipelinesConfig:
         )
 
         return request_data
+
+    def _pre_delete_pipeline(
+        self,
+        pipeline_id: str,
+        correlation_id: Optional[str] = None,
+        api_version: str = ApiVersion.V1.value,
+    ):
+        """
+        Prepare request data for deleting a pipeline by ID.
+
+        This internal method constructs the URL for pipeline deletion
+        requests using the provided pipeline identifier.
+
+        Args:
+            pipeline_id: ID of the pipeline to delete
+            correlation_id: Optional correlation ID for tracing
+            api_version: API version to use for the request
+
+        Returns:
+            RequestData: Prepared request data for the pipeline deletion endpoint
+
+        Raises:
+            ValueError: If an invalid API version is provided
+        """
+        if api_version not in ApiVersion.as_list():
+            raise ValueError(
+                f"Invalid API version: {api_version}. Valid versions are: {', '.join(ApiVersion.as_list())}"
+            )
+        url = urljoin(
+            self._request_handler.base_url,
+            f"{api_version}/PipelinesConfig/{pipeline_id}",
+        )
+        request_data = self._request_handler.prepare_request(
+            url, correlation_id=correlation_id
+        )
+
+        return request_data

{airia-0.1.26 → airia-0.1.27}/airia/client/pipelines_config/sync_pipelines_config.py

@@ -188,3 +188,53 @@ class PipelinesConfig(BasePipelinesConfig):
         resp = self._request_handler.make_request("GET", request_data)
 
         return GetPipelinesConfigResponse(**resp)
+
+    def delete_pipeline(
+        self,
+        pipeline_id: str,
+        correlation_id: Optional[str] = None,
+    ) -> None:
+        """
+        Delete a pipeline by its ID.
+
+        This method permanently removes a pipeline and all its configuration
+        from the Airia platform. This action cannot be undone.
+
+        Args:
+            pipeline_id (str): The unique identifier of the pipeline to delete.
+            correlation_id (str, optional): A unique identifier for request tracing
+                and logging. If not provided, one will be automatically generated.
+
+        Returns:
+            None: This method returns nothing upon successful deletion (204 No Content).
+
+        Raises:
+            AiriaAPIError: If the API request fails, including cases where:
+                - The pipeline_id doesn't exist (404)
+                - Authentication fails (401)
+                - Access is forbidden (403)
+                - Server errors (5xx)
+
+        Example:
+            ```python
+            from airia import AiriaClient
+
+            client = AiriaClient(api_key="your_api_key")
+
+            # Delete a pipeline
+            client.pipelines_config.delete_pipeline(
+                pipeline_id="your_pipeline_id"
+            )
+            print("Pipeline deleted successfully")
+            ```
+
+        Warning:
+            This operation is permanent and cannot be reversed. Ensure you have
+            the correct pipeline_id before calling this method.
+        """
+        request_data = self._pre_delete_pipeline(
+            pipeline_id=pipeline_id,
+            correlation_id=correlation_id,
+            api_version=ApiVersion.V1.value,
+        )
+        self._request_handler.make_request("DELETE", request_data, return_json=False)

{airia-0.1.26 → airia-0.1.27}/airia/client/sync_client.py

@@ -21,6 +21,7 @@ from .pipeline_import import PipelineImport
 from .pipelines_config import PipelinesConfig
 from .project import Project
 from .store import Store
+from .tools import Tools
 
 
 class AiriaClient(AiriaBaseClient):
@@ -74,6 +75,7 @@ class AiriaClient(AiriaBaseClient):
         self.data_vector_search = DataVectorSearch(self._request_handler)
         self.library = Library(self._request_handler)
         self.models = Models(self._request_handler)
+        self.tools = Tools(self._request_handler)
 
     @classmethod
     def with_openai_gateway(

airia-0.1.27/airia/client/tools/__init__.py

@@ -0,0 +1,4 @@
+from .async_tools import AsyncTools
+from .sync_tools import Tools
+
+__all__ = ["Tools", "AsyncTools"]

airia-0.1.27/airia/client/tools/async_tools.py

@@ -0,0 +1,259 @@
+from typing import Any, Dict, List, Optional, Literal
+
+from ...types._api_version import ApiVersion
+from ...types.api.tools import CreateToolResponse
+from .._request_handler import AsyncRequestHandler
+from .base_tools import BaseTools
+
+
+class AsyncTools(BaseTools):
+    def __init__(self, request_handler: AsyncRequestHandler):
+        super().__init__(request_handler)
+
+    async def create_tool(
+        self,
+        name: str,
+        description: str,
+        purpose: str,
+        api_endpoint: str,
+        method_type: str,
+        body: str,
+        tool_credentials: Dict[str, Any],
+        headers: List[Dict[str, str]] = [],
+        parameters: List[Dict[str, Any]] = [],
+        request_timeout: int = 100,
+        body_type: Literal["Json", "XFormUrlEncoded", "None"] = "Json",
+        category: Literal["Action", "Airia", "Mcp"] = "Airia",
+        tool_type: str = "Custom",
+        provider: str = "Custom",
+        route_through_acc: bool = False,
+        should_redirect: bool = True,
+        acc_group: Optional[str] = None,
+        documentation: Optional[str] = None,
+        project_id: Optional[str] = None,
+        tags: Optional[List[str]] = None,
+        tool_metadata: Optional[List[Dict[str, Any]]] = None,
+        correlation_id: Optional[str] = None,
+    ) -> CreateToolResponse:
+        """
+        Create a new tool in the Airia platform.
+
+        Args:
+            name (str): Name of the tool.
+            description (str): Brief description of what the tool does.
+                Example: "Use this tool to get the current weather in a given location."
+            api_endpoint (str): Web API endpoint where the tool sends its requests to
+                perform its task.
+            method_type (str): HTTP method type. Valid values: "Get", "Post", "Put", "Delete".
+            purpose (str): When and why to use this tool.
+                Example: "When a user asks about the weather, including current conditions,
+                forecasts, or specific weather events."
+            body_type (str): Type of the request body. Valid values: "Json", "XFormUrlEncoded", "None".
+            category (str): Category of the tool. Valid values: "Action", "Airia", "Mcp".
+            provider (str): Provider of the tool.
+            tool_type (str): Type of the tool. Valid values: "Custom", "Calculator", "MCP",
+                "LoadMemory", "StoreMemory", etc.
+            body (str): Body of the request that the tool sends to the API.
+            headers (list[dict]): List of headers required when making the API request.
+                Each header should be a dictionary with "key" and "value" fields.
+                Example: [{"key": "Content-Type", "value": "application/json"}]
+            parameters (list[dict]): Collection of parameters required by the tool
+                to execute its function.
+            request_timeout (int): Request timeout in seconds for tool execution.
+            route_through_acc (bool): Flag indicating whether the tool should route
+                through the ACC.
+            should_redirect (bool): Flag indicating whether the tool should redirect
+                with authorization header attached.
+            tool_credentials (dict): Tool credentials model.
+            acc_group (str, optional): ACC specific group name. If provided, the tool will
+                route through this ACC group.
+            documentation (str, optional): Documentation for the tool.
+            project_id (str, optional): Unique identifier of the project to which the tool
+                is associated.
+            tags (list[str], optional): List of tags for the tool.
+            tool_metadata (list[dict], optional): User provided metadata for the tool definition.
+            correlation_id (str, optional): A unique identifier for request tracing
+                and logging. If not provided, one will be automatically generated.
+
+        Returns:
+            CreateToolResponse: A response object containing the created tool details
+                including its ID, creation timestamp, configuration, credentials,
+                parameters, and all provided metadata.
+
+        Raises:
+            AiriaAPIError: If the API request fails, including cases where:
+                - Invalid parameters are provided (400)
+                - Authentication fails (401)
+                - Access is forbidden (403)
+                - Server errors (5xx)
+
+        Example:
+            ```python
+            from airia import AiriaAsyncClient
+            import asyncio
+
+            async def main():
+                client = AiriaAsyncClient(api_key="your_api_key")
+
+                # Create a weather tool with all required parameters
+                tool = await client.tools.create_tool(
+                    name="get_weather",
+                    description="Use this tool to get the current weather in a given location.",
+                    api_endpoint="https://api.weather.com/v1/current",
+                    method_type="Get",
+                    purpose="When a user asks about the weather, including current conditions.",
+                    body_type="None",
+                    category="Action",
+                    provider="WeatherAPI",
+                    tool_type="Custom",
+                    body="",
+                    headers=[],
+                    parameters=[],
+                    request_timeout=100,
+                    route_through_acc=False,
+                    should_redirect=False,
+                    tool_credentials={}
+                )
+                print(f"Created tool: {tool.id}")
+
+                # Create an email tool with headers and optional parameters
+                tool = await client.tools.create_tool(
+                    name="send_email",
+                    description="Send an email to a recipient.",
+                    api_endpoint="https://api.email-service.com/v1/send",
+                    method_type="Post",
+                    purpose="When a user wants to send an email message.",
+                    body_type="Json",
+                    category="Action",
+                    provider="EmailService",
+                    tool_type="Custom",
+                    body='{"to": "{{recipient}}", "subject": "{{subject}}", "body": "{{message}}"}',
+                    headers=[
+                        {"key": "Content-Type", "value": "application/json"},
+                        {"key": "Authorization", "value": "Bearer {{api_key}}"}
+                    ],
+                    parameters=[
+                        {"name": "recipient", "type": "string", "required": True},
+                        {"name": "subject", "type": "string", "required": True},
+                        {"name": "message", "type": "string", "required": True}
+                    ],
+                    request_timeout=120,
+                    route_through_acc=False,
+                    should_redirect=False,
+                    tool_credentials={},
+                    documentation="This tool sends emails using the Email Service API.",
+                    tags=["email", "communication"]
+                )
+                print(f"Created email tool: {tool.id}")
+
+                await client.close()
+
+            asyncio.run(main())
+            ```
+
+        Note:
+            - Required parameters: name, description, api_endpoint, method_type, purpose,
+              body_type, category, provider, tool_type, body, headers, parameters,
+              request_timeout, route_through_acc, should_redirect, and tool_credentials.
+            - Optional parameters: acc_group, documentation, project_id, tags, and tool_metadata.
+            - The method_type must be one of: "Get", "Post", "Put", "Delete"
+            - The body_type must be one of: "Json", "XFormUrlEncoded", "None"
+            - The category must be one of: "Action", "Airia", "Mcp"
+            - The tool_type must be one of: "Custom", "Calculator", "MCP", "LoadMemory",
+              "StoreMemory", etc.
+        """
+        request_data = self._pre_create_tool(
+            name=name,
+            description=description,
+            api_endpoint=api_endpoint,
+            method_type=method_type,
+            purpose=purpose,
+            body_type=body_type,
+            category=category,
+            provider=provider,
+            tool_type=tool_type,
+            body=body,
+            headers=headers,
+            parameters=parameters,
+            request_timeout=request_timeout,
+            route_through_acc=route_through_acc,
+            should_redirect=should_redirect,
+            tool_credentials=tool_credentials,
+            acc_group=acc_group,
+            documentation=documentation,
+            project_id=project_id,
+            tags=tags,
+            tool_metadata=tool_metadata,
+            correlation_id=correlation_id,
+            api_version=ApiVersion.V1.value,
+        )
+        resp = await self._request_handler.make_request("POST", request_data)
+
+        return CreateToolResponse(**resp)
+
+    async def delete_tool(
+        self,
+        tool_id: str,
+        correlation_id: Optional[str] = None,
+    ) -> None:
+        """
+        Delete a tool by its ID.
+
+        This method permanently removes a tool from the Airia platform.
+        This action cannot be undone.
+
+        Args:
+            tool_id (str): The unique identifier of the tool to delete.
+            correlation_id (str, optional): A unique identifier for request tracing
+                and logging. If not provided, one will be automatically generated.
+
+        Returns:
+            None: This method returns nothing upon successful deletion.
+
+        Raises:
+            AiriaAPIError: If the API request fails, including cases where:
+                - The tool_id doesn't exist (404)
+                - Authentication fails (401)
+                - Access is forbidden (403)
+                - Server errors (5xx)
+
+        Example:
+            ```python
+            from airia import AiriaAsyncClient
+            import asyncio
+
+            async def main():
+                client = AiriaAsyncClient(api_key="your_api_key")
+
+                # Delete a tool
+                await client.tools.delete_tool(tool_id="tool_123")
+                print("Tool deleted successfully")
+
+                # Handle deletion errors
+                from airia.exceptions import AiriaAPIError
+
+                try:
+                    await client.tools.delete_tool(tool_id="nonexistent_id")
+                except AiriaAPIError as e:
+                    if e.status_code == 404:
+                        print("Tool not found")
+                    else:
+                        print(f"Error deleting tool: {e.message}")
+
+                await client.close()
+
+            asyncio.run(main())
+            ```
+
+        Note:
+            This operation is permanent and cannot be undone. Make sure you have
+            the correct tool_id before calling this method.
+        """
+        request_data = self._pre_delete_tool(
+            tool_id=tool_id,
+            correlation_id=correlation_id,
+            api_version=ApiVersion.V1.value,
+        )
+        await self._request_handler.make_request(
+            "DELETE", request_data, return_json=False
+        )

airia-0.1.27/airia/client/tools/base_tools.py

@@ -0,0 +1,153 @@
+from typing import Any, Dict, List, Optional, Union
+from urllib.parse import urljoin
+
+from ...types._api_version import ApiVersion
+from .._request_handler import AsyncRequestHandler, RequestHandler
+
+
+class BaseTools:
+    def __init__(self, request_handler: Union[RequestHandler, AsyncRequestHandler]):
+        self._request_handler = request_handler
+
+    def _pre_create_tool(
+        self,
+        name: str,
+        description: str,
+        api_endpoint: str,
+        method_type: str,
+        purpose: str,
+        body_type: str,
+        category: str,
+        provider: str,
+        tool_type: str,
+        body: str,
+        headers: List[Dict[str, str]],
+        parameters: List[Dict[str, Any]],
+        request_timeout: int,
+        route_through_acc: bool,
+        should_redirect: bool,
+        tool_credentials: Dict[str, Any],
+        acc_group: Optional[str] = None,
+        documentation: Optional[str] = None,
+        project_id: Optional[str] = None,
+        tags: Optional[List[str]] = None,
+        tool_metadata: Optional[List[Dict[str, Any]]] = None,
+        correlation_id: Optional[str] = None,
+        api_version: str = ApiVersion.V1.value,
+    ):
+        """
+        Prepare request data for creating a new tool.
+
+        This internal method constructs the URL and payload for tool creation
+        requests, including all tool configuration and metadata.
+
+        Args:
+            name: Name of the tool
+            description: Brief description of what the tool does
+            api_endpoint: Web API endpoint where the tool sends its requests
+            method_type: HTTP method type (Get, Post, Put, Delete)
+            purpose: When and why to use this tool
+            body_type: Type of the request body (Json, XFormUrlEncoded, None)
+            category: Category of the tool (Action, Airia, Mcp)
+            provider: Provider of the tool
+            tool_type: Type of the tool (Custom, Calculator, MCP, etc.)
+            body: Body of the request that the tool sends to the API
+            headers: List of headers required when making the API request
+            parameters: Collection of parameters required by the tool
+            request_timeout: Request timeout in seconds for tool execution
+            route_through_acc: Flag indicating whether the tool should route through the ACC
+            should_redirect: Flag indicating whether the tool should redirect with authorization header
+            tool_credentials: Tool credentials
+            acc_group: Optional ACC specific group name
+            documentation: Optional documentation for the tool
+            project_id: Optional unique identifier of the project to which the tool is associated
+            tags: Optional list of tags for the tool
+            tool_metadata: Optional user provided metadata for the tool definition
+            correlation_id: Optional correlation ID for tracing
+            api_version: API version to use for the request
+
+        Returns:
+            RequestData: Prepared request data for the tool creation endpoint
+
+        Raises:
+            ValueError: If an invalid API version is provided
+        """
+        if api_version not in ApiVersion.as_list():
+            raise ValueError(
+                f"Invalid API version: {api_version}. Valid versions are: {', '.join(ApiVersion.as_list())}"
+            )
+        url = urljoin(self._request_handler.base_url, f"{api_version}/Tools")
+
+        payload: Dict[str, Any] = {
+            "name": name,
+            "description": description,
+            "apiEndpoint": api_endpoint,
+            "methodType": method_type,
+            "purpose": purpose,
+            "bodyType": body_type,
+            "category": category,
+            "provider": provider,
+            "toolType": tool_type,
+            "body": body,
+            "headers": headers,
+            "parameters": parameters,
+            "requestTimeout": request_timeout,
+            "routeThroughACC": route_through_acc,
+            "shouldRedirect": should_redirect,
+            "toolCredentials": tool_credentials,
+        }
+
+        # Add optional fields only if they are provided
+        if acc_group is not None:
+            payload["accGroup"] = acc_group
+        if documentation is not None:
+            payload["documentation"] = documentation
+        if project_id is not None:
+            payload["projectId"] = project_id
+        if tags is not None:
+            payload["tags"] = tags
+        if tool_metadata is not None:
+            payload["toolMetadata"] = tool_metadata
+
+        request_data = self._request_handler.prepare_request(
+            url=url, payload=payload, correlation_id=correlation_id
+        )
+
+        return request_data
+
+    def _pre_delete_tool(
+        self,
+        tool_id: str,
+        correlation_id: Optional[str] = None,
+        api_version: str = ApiVersion.V1.value,
+    ):
+        """
+        Prepare request data for deleting a tool by ID.
+
+        This internal method constructs the URL for tool deletion
+        requests using the provided tool identifier.
+
+        Args:
+            tool_id: ID of the tool to delete
+            correlation_id: Optional correlation ID for tracing
+            api_version: API version to use for the request
+
+        Returns:
+            RequestData: Prepared request data for the tool deletion endpoint
+
+        Raises:
+            ValueError: If an invalid API version is provided
+        """
+        if api_version not in ApiVersion.as_list():
+            raise ValueError(
+                f"Invalid API version: {api_version}. Valid versions are: {', '.join(ApiVersion.as_list())}"
+            )
+        url = urljoin(
+            self._request_handler.base_url,
+            f"{api_version}/Tools/{tool_id}",
+        )
+        request_data = self._request_handler.prepare_request(
+            url, correlation_id=correlation_id
+        )
+
+        return request_data