airia 0.1.12__py3-none-any.whl → 0.1.14__py3-none-any.whl

airia/client/base_client.py

@@ -1,14 +1,10 @@
-import json
 import os
-from typing import Any, Dict, List, Optional
-from urllib.parse import urljoin
+from typing import Optional
 
 import loguru
 
 from ..constants import DEFAULT_BASE_URL, DEFAULT_TIMEOUT
-from ..logs import configure_logging, set_correlation_id
-from ..types._api_version import ApiVersion
-from ..types._request_data import RequestData
+from ..logs import configure_logging
 
 
 class AiriaBaseClient:
@@ -89,206 +85,3 @@ class AiriaBaseClient:
         raise ValueError(
             "Authentication required. Provide either api_key (or set AIRIA_API_KEY environment variable) or bearer_token."
         )
-
-    def _prepare_request(
-        self,
-        url: str,
-        payload: Optional[Dict[str, Any]] = None,
-        params: Optional[Dict[str, Any]] = None,
-        correlation_id: Optional[str] = None,
-    ):
-        # Set correlation ID if provided or generate a new one
-        correlation_id = set_correlation_id(correlation_id)
-
-        # Set up base headers
-        headers = {
-            "X-Correlation-ID": correlation_id,
-            "Content-Type": "application/json",
-        }
-
-        # Add authentication header based on the method used
-        if self.api_key:
-            headers["X-API-KEY"] = self.api_key
-        elif self.bearer_token:
-            headers["Authorization"] = f"Bearer {self.bearer_token}"
-
-        # Log the request if enabled
-        if self.log_requests:
-            # Create a sanitized copy of headers and params for logging
-            log_headers = headers.copy()
-            log_params = params.copy() if params is not None else {}
-
-            # Filter out sensitive headers
-            if "X-API-KEY" in log_headers:
-                log_headers["X-API-KEY"] = "[REDACTED]"
-            if "Authorization" in log_headers:
-                log_headers["Authorization"] = "[REDACTED]"
-
-            # Process payload for logging
-            log_payload = payload.copy() if payload is not None else {}
-            if "images" in log_payload and log_payload["images"] is not None:
-                log_payload["images"] = f"{len(log_payload['images'])} images"
-            if "files" in log_payload and log_payload["files"] is not None:
-                log_payload["files"] = f"{len(log_payload['files'])} files"
-            log_payload = json.dumps(log_payload)
-
-            self.logger.info(
-                f"API Request: POST {url}\n"
-                f"Headers: {json.dumps(log_headers)}\n"
-                f"Payload: {log_payload}"
-                f"Params: {json.dumps(log_params)}\n"
-            )
-
-        return RequestData(
-            **{
-                "url": url,
-                "payload": payload,
-                "headers": headers,
-                "params": params,
-                "correlation_id": correlation_id,
-            }
-        )
-
-    def _pre_execute_pipeline(
-        self,
-        pipeline_id: str,
-        user_input: str,
-        debug: bool = False,
-        user_id: Optional[str] = None,
-        conversation_id: Optional[str] = None,
-        async_output: bool = False,
-        include_tools_response: bool = False,
-        images: Optional[List[str]] = None,
-        files: Optional[List[str]] = None,
-        data_source_folders: Optional[Dict[str, Any]] = None,
-        data_source_files: Optional[Dict[str, Any]] = None,
-        in_memory_messages: Optional[List[Dict[str, str]]] = None,
-        current_date_time: Optional[str] = None,
-        save_history: bool = True,
-        additional_info: Optional[List[Any]] = None,
-        prompt_variables: Optional[Dict[str, Any]] = None,
-        correlation_id: Optional[str] = None,
-        api_version: str = ApiVersion.V2.value,
-    ):
-        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.base_url, f"{api_version}/PipelineExecution/{pipeline_id}")
-
-        payload = {
-            "userInput": user_input,
-            "debug": debug,
-            "userId": user_id,
-            "conversationId": conversation_id,
-            "asyncOutput": async_output,
-            "includeToolsResponse": include_tools_response,
-            "images": images,
-            "files": files,
-            "dataSourceFolders": data_source_folders,
-            "dataSourceFiles": data_source_files,
-            "inMemoryMessages": in_memory_messages,
-            "currentDateTime": current_date_time,
-            "saveHistory": save_history,
-            "additionalInfo": additional_info,
-            "promptVariables": prompt_variables,
-        }
-
-        request_data = self._prepare_request(
-            url=url, payload=payload, correlation_id=correlation_id
-        )
-
-        return request_data
-
-    def _pre_get_projects(
-        self,
-        correlation_id: Optional[str] = None,
-        api_version: str = ApiVersion.V1.value,
-    ):
-        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.base_url, f"{api_version}/Project/paginated")
-        request_data = self._prepare_request(url, correlation_id=correlation_id)
-
-        return request_data
-
-    def _pre_get_active_pipelines_ids(
-        self,
-        project_id: Optional[str] = None,
-        correlation_id: Optional[str] = None,
-        api_version: str = ApiVersion.V1.value,
-    ):
-        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.base_url, f"{api_version}/PipelinesConfig")
-        params = {"projectId": project_id} if project_id is not None else None
-        request_data = self._prepare_request(
-            url, params=params, correlation_id=correlation_id
-        )
-
-        return request_data
-
-    def _pre_get_pipeline_config(
-        self,
-        pipeline_id: str,
-        correlation_id: Optional[str] = None,
-        api_version: str = ApiVersion.V1.value,
-    ):
-        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.base_url, f"{api_version}/PipelinesConfig/export/{pipeline_id}"
-        )
-        request_data = self._prepare_request(url, correlation_id=correlation_id)
-
-        return request_data
-
-    def _pre_create_conversation(
-        self,
-        user_id: str,
-        title: Optional[str] = None,
-        deployment_id: Optional[str] = None,
-        data_source_files: Dict[str, Any] = {},
-        is_bookmarked: bool = False,
-        correlation_id: Optional[str] = None,
-        api_version: str = ApiVersion.V1.value,
-    ):
-        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.base_url, f"{api_version}/Conversations")
-
-        payload = {
-            "userId": user_id,
-            "title": title,
-            "deploymentId": deployment_id,
-            "dataSourceFiles": data_source_files,
-            "isBookmarked": is_bookmarked,
-        }
-
-        request_data = self._prepare_request(
-            url=url, payload=payload, correlation_id=correlation_id
-        )
-
-        return request_data
-
-    def _pre_get_projects(
-        self,
-        correlation_id: Optional[str] = None,
-        api_version: str = ApiVersion.V1.value,
-    ):
-        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.base_url, f"{api_version}/Project/paginated")
-        request_data = self._prepare_request(url, correlation_id=correlation_id)
-
-        return request_data

airia/client/conversations/__init__.py

@@ -0,0 +1,4 @@
+from .async_conversations import AsyncConversations
+from .sync_conversations import Conversations
+
+__all__ = ["Conversations", "AsyncConversations"]

airia/client/conversations/async_conversations.py

@@ -0,0 +1,187 @@
+from typing import Any, Dict, Optional
+
+from ...types._api_version import ApiVersion
+from ...types.api.conversations import (
+    CreateConversationResponse,
+    GetConversationResponse,
+)
+from .._request_handler import AsyncRequestHandler
+from .base_conversations import BaseConversations
+
+
+class AsyncConversations(BaseConversations):
+    def __init__(self, request_handler: AsyncRequestHandler):
+        super().__init__(request_handler)
+
+    async def create_conversation(
+        self,
+        user_id: str,
+        title: Optional[str] = None,
+        deployment_id: Optional[str] = None,
+        data_source_files: Dict[str, Any] = {},
+        is_bookmarked: bool = False,
+        correlation_id: Optional[str] = None,
+    ) -> CreateConversationResponse:
+        """
+        Create a new conversation.
+
+        Args:
+            user_id (str): The unique identifier of the user creating the conversation.
+            title (str, optional): The title for the conversation. If not provided,
+                the conversation will be created without a title.
+            deployment_id (str, optional): The unique identifier of the deployment
+                to associate with the conversation. If not provided, the conversation
+                will not be associated with any specific deployment.
+            data_source_files (dict): Configuration for data source files
+                to be associated with the conversation. If not provided, no data
+                source files will be associated.
+            is_bookmarked (bool): Whether the conversation should be bookmarked.
+                Defaults to False.
+            correlation_id (str, optional): A unique identifier for request tracing
+                and logging. If not provided, one will be automatically generated.
+
+        Returns:
+            CreateConversationResponse: A response object containing the created
+                conversation details including its ID, creation timestamp, and
+                all provided parameters.
+
+        Raises:
+            AiriaAPIError: If the API request fails, including cases where:
+                - The user_id doesn't exist (404)
+                - The deployment_id is invalid (404)
+                - Authentication fails (401)
+                - Access is forbidden (403)
+                - Server errors (5xx)
+
+        Example:
+            ```python
+            from airia import AiriaAsyncClient
+
+            client = AiriaAsyncClient(api_key="your_api_key")
+
+            # Create a basic conversation
+            conversation = await client.conversations.create_conversation(
+                user_id="user_123"
+            )
+            print(f"Created conversation: {conversation.conversation_id}")
+
+            # Create a conversation with all options
+            conversation = await client.conversations.create_conversation(
+                user_id="user_123",
+                title="My Research Session",
+                deployment_id="deployment_456",
+                data_source_files={"documents": ["doc1.pdf", "doc2.txt"]},
+                is_bookmarked=True
+            )
+            print(f"Created bookmarked conversation: {conversation.conversation_id}")
+            ```
+
+        Note:
+            The user_id is required and must correspond to a valid user in the system.
+            All other parameters are optional and can be set to None or their default values.
+        """
+        request_data = self._pre_create_conversation(
+            user_id=user_id,
+            title=title,
+            deployment_id=deployment_id,
+            data_source_files=data_source_files,
+            is_bookmarked=is_bookmarked,
+            correlation_id=correlation_id,
+            api_version=ApiVersion.V1.value,
+        )
+        resp = await self._request_handler.make_request("POST", request_data)
+
+        return CreateConversationResponse(**resp)
+
+    async def get_conversation(
+        self, conversation_id: str, correlation_id: Optional[str] = None
+    ) -> GetConversationResponse:
+        """
+        Retrieve detailed information about a specific conversation by its ID.
+
+        This method fetches comprehensive information about a conversation including
+        all messages, metadata, policy redactions, and execution status.
+
+        Args:
+            conversation_id (str): The unique identifier of the conversation to retrieve.
+            correlation_id (str, optional): A unique identifier for request tracing
+                and logging. If not provided, one will be automatically generated.
+
+        Returns:
+            GetConversationResponse: A response object containing the conversation
+                details including user ID, messages, title, deployment information,
+                data source files, bookmark status, policy redactions, and execution status.
+
+        Raises:
+            AiriaAPIError: If the API request fails, including cases where:
+                - The conversation_id doesn't exist (404)
+                - Authentication fails (401)
+                - Access is forbidden (403)
+                - Server errors (5xx)
+
+        Example:
+            ```python
+            from airia import AiriaAsyncClient
+
+            async def main():
+                client = AiriaAsyncClient(api_key="your_api_key")
+
+                # Get conversation details
+                conversation = await client.conversations.get_conversation(
+                    conversation_id="conversation_123"
+                )
+
+                print(f"Conversation: {conversation.title}")
+                print(f"User: {conversation.user_id}")
+                print(f"Messages: {len(conversation.messages)}")
+                print(f"Bookmarked: {conversation.is_bookmarked}")
+
+                # Access individual messages
+                for message in conversation.messages:
+                    print(f"[{message.role}]: {message.message}")
+
+            asyncio.run(main())
+            ```
+
+        Note:
+            This method only retrieves conversation information and does not
+            modify or execute any operations on the conversation.
+        """
+        request_data = self._pre_get_conversation(
+            conversation_id=conversation_id,
+            correlation_id=correlation_id,
+            api_version=ApiVersion.V1.value,
+        )
+        resp = await self._request_handler.make_request("GET", request_data)
+
+        return GetConversationResponse(**resp)
+
+    async def delete_conversation(
+        self,
+        conversation_id: str,
+        correlation_id: Optional[str] = None,
+    ) -> None:
+        """
+        Delete a conversation by its ID.
+
+        This method permanently removes a conversation and all associated data
+        from the Airia platform. This action cannot be undone.
+
+        Args:
+            conversation_id: The unique identifier of the conversation to delete
+            correlation_id: Optional correlation ID for request tracing
+
+        Returns:
+            None: This method returns nothing upon successful deletion
+
+        Raises:
+            AiriaAPIError: If the API request fails or the conversation doesn't exist
+        """
+        request_data = self._pre_delete_conversation(
+            conversation_id=conversation_id,
+            correlation_id=correlation_id,
+            api_version=ApiVersion.V1.value,
+        )
+        await self._request_handler.make_request(
+            "DELETE", request_data, return_json=False
+        )

airia/client/conversations/base_conversations.py

@@ -0,0 +1,135 @@
+from typing import Any, Dict, Optional, Union
+from urllib.parse import urljoin
+
+from ...types._api_version import ApiVersion
+from .._request_handler import AsyncRequestHandler, RequestHandler
+
+
+class BaseConversations:
+    def __init__(self, request_handler: Union[RequestHandler, AsyncRequestHandler]):
+        self._request_handler = request_handler
+
+    def _pre_create_conversation(
+        self,
+        user_id: str,
+        title: Optional[str] = None,
+        deployment_id: Optional[str] = None,
+        data_source_files: Dict[str, Any] = {},
+        is_bookmarked: bool = False,
+        correlation_id: Optional[str] = None,
+        api_version: str = ApiVersion.V1.value,
+    ):
+        """
+        Prepare request data for creating a new conversation.
+
+        This internal method constructs the URL and payload for conversation creation
+        requests, including all conversation metadata and settings.
+
+        Args:
+            user_id: ID of the user creating the conversation
+            title: Optional title for the conversation
+            deployment_id: Optional deployment to associate with the conversation
+            data_source_files: Optional data source files configuration
+            is_bookmarked: Whether the conversation should be bookmarked
+            correlation_id: Optional correlation ID for tracing
+            api_version: API version to use for the request
+
+        Returns:
+            RequestData: Prepared request data for the conversation 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}/Conversations")
+
+        payload = {
+            "userId": user_id,
+            "title": title,
+            "deploymentId": deployment_id,
+            "dataSourceFiles": data_source_files,
+            "isBookmarked": is_bookmarked,
+        }
+
+        request_data = self._request_handler.prepare_request(
+            url=url, payload=payload, correlation_id=correlation_id
+        )
+
+        return request_data
+
+    def _pre_get_conversation(
+        self,
+        conversation_id: str,
+        correlation_id: Optional[str] = None,
+        api_version: str = ApiVersion.V1.value,
+    ):
+        """
+        Prepare request data for retrieving a conversation by ID.
+
+        This internal method constructs the URL for conversation retrieval
+        requests using the provided conversation identifier.
+
+        Args:
+            conversation_id: ID of the conversation to retrieve
+            correlation_id: Optional correlation ID for tracing
+            api_version: API version to use for the request
+
+        Returns:
+            RequestData: Prepared request data for the conversation retrieval 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}/Conversations/{conversation_id}",
+        )
+        request_data = self._request_handler.prepare_request(
+            url, correlation_id=correlation_id
+        )
+
+        return request_data
+
+    def _pre_delete_conversation(
+        self,
+        conversation_id: str,
+        correlation_id: Optional[str] = None,
+        api_version: str = ApiVersion.V1.value,
+    ):
+        """
+        Prepare request data for deleting a conversation by ID.
+
+        This internal method constructs the URL for conversation deletion
+        requests using the provided conversation identifier.
+
+        Args:
+            conversation_id: ID of the conversation 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 conversation 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}/Conversations/{conversation_id}",
+        )
+        request_data = self._request_handler.prepare_request(
+            url, correlation_id=correlation_id
+        )
+
+        return request_data