airia 0.1.37__tar.gz → 0.1.39__tar.gz

{airia-0.1.37 → airia-0.1.39}/PKG-INFO

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

{airia-0.1.37 → airia-0.1.39}/airia/client/async_client.py

@@ -11,6 +11,7 @@ from ._request_handler import AsyncRequestHandler
 from .attachments import AsyncAttachments
 from .base_client import AiriaBaseClient
 from .conversations import AsyncConversations
+from .data_store import AsyncDataStore
 from .data_vector_search import AsyncDataVectorSearch
 from .deployments import AsyncDeployments
 from .library import AsyncLibrary
@@ -70,6 +71,7 @@ class AiriaAsyncClient(AiriaBaseClient):
         self.project = AsyncProject(self._request_handler)
         self.conversations = AsyncConversations(self._request_handler)
         self.store = AsyncStore(self._request_handler)
+        self.data_store = AsyncDataStore(self._request_handler)
         self.deployments = AsyncDeployments(self._request_handler)
         self.data_vector_search = AsyncDataVectorSearch(self._request_handler)
         self.library = AsyncLibrary(self._request_handler)

airia-0.1.39/airia/client/attachments/async_attachments.py

@@ -0,0 +1,105 @@
+from typing import Optional
+
+from ...types._api_version import ApiVersion
+from ...types.api.attachments import AttachmentResponse, GetFileUrlResponse
+from .._request_handler import AsyncRequestHandler
+from .base_attachments import BaseAttachments
+
+
+class AsyncAttachments(BaseAttachments):
+    def __init__(self, request_handler: AsyncRequestHandler):
+        super().__init__(request_handler)
+
+    async def upload_file(
+        self,
+        file_path: str,
+        correlation_id: Optional[str] = None,
+    ) -> AttachmentResponse:
+        """
+        Upload a file and get attachment information.
+
+        Args:
+            file_path: Path to the file on disk
+            correlation_id: Optional correlation ID for request tracing. If not provided,
+                        one will be generated automatically.
+
+        Returns:
+            AttachmentResponse: Response containing the attachment ID and URL.
+
+        Raises:
+            AiriaAPIError: If the API request fails with details about the error.
+            aiohttp.ClientError: For other request-related errors.
+
+        Example:
+            ```python
+            async_client = AiriaAsyncClient(api_key="your_api_key")
+
+            # Upload a file
+            response = await async_client.attachments.upload_file(
+                file_path="example.jpg"
+            )
+            print(f"Uploaded attachment ID: {response.id}")
+            print(f"Attachment URL: {response.image_url}")
+            ```
+        """
+        request_data = self._pre_upload_file(
+            file_path=file_path,
+            correlation_id=correlation_id,
+            api_version=ApiVersion.V1.value,
+        )
+
+        resp = await self._request_handler.make_request_multipart("POST", request_data)
+        return AttachmentResponse(**resp)
+
+    async def get_file_url(
+        self,
+        file_id: str,
+        correlation_id: Optional[str] = None,
+    ) -> GetFileUrlResponse:
+        """
+        Get a refreshed signed URL for an existing attachment.
+
+        This method retrieves a new time-limited signed URL for accessing
+        an attachment that was previously uploaded. Useful when the original
+        signed URL has expired or is about to expire.
+
+        Args:
+            file_id: The unique identifier of the attachment
+            correlation_id: Optional correlation ID for request tracing. If not provided,
+                        one will be generated automatically.
+
+        Returns:
+            GetFileUrlResponse: Response containing the attachment ID and refreshed signed URL.
+
+        Raises:
+            AiriaAPIError: If the API request fails with details about the error.
+            aiohttp.ClientError: For other request-related errors.
+
+        Example:
+            ```python
+            async_client = AiriaAsyncClient(api_key="your_api_key")
+
+            # First, upload a file
+            upload_response = await async_client.attachments.upload_file(
+                file_path="example.jpg"
+            )
+            file_id = upload_response.id
+
+            # Later, get a refreshed URL for the same file
+            url_response = await async_client.attachments.get_file_url(
+                file_id=file_id
+            )
+            print(f"Attachment ID: {url_response.id}")
+            print(f"Refreshed URL: {url_response.signed_url}")
+            ```
+        """
+        request_data = self._pre_get_file_url(
+            file_id=file_id,
+            correlation_id=correlation_id,
+            api_version=ApiVersion.V1.value,
+        )
+
+        resp = await self._request_handler.make_request(
+            "GET", request_data, return_json=True
+        )
+        return GetFileUrlResponse(**resp)

{airia-0.1.37 → airia-0.1.39}/airia/client/attachments/base_attachments.py

@@ -52,3 +52,42 @@ class BaseAttachments:
         )
 
         return request_data
+
+    def _pre_get_file_url(
+        self,
+        file_id: str,
+        correlation_id: Optional[str] = None,
+        api_version: str = ApiVersion.V1.value,
+    ):
+        """
+        Prepare request data for get file URL endpoint.
+
+        This internal method constructs the URL for refreshing a file's signed URL,
+        validating the API version and preparing all request components.
+
+        Args:
+            file_id: The unique identifier of the file
+            correlation_id: Optional correlation ID for tracing
+            api_version: API version to use for the request
+
+        Returns:
+            RequestData: Prepared request data for the get file URL 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}/upload/refresh/{file_id}",
+        )
+
+        request_data = self._request_handler.prepare_request(
+            url=url, payload=None, correlation_id=correlation_id
+        )
+
+        return request_data

airia-0.1.39/airia/client/attachments/sync_attachments.py

@@ -0,0 +1,103 @@
+from typing import Optional
+
+from ...types._api_version import ApiVersion
+from ...types.api.attachments import AttachmentResponse, GetFileUrlResponse
+from .._request_handler import RequestHandler
+from .base_attachments import BaseAttachments
+
+
+class Attachments(BaseAttachments):
+    def __init__(self, request_handler: RequestHandler):
+        super().__init__(request_handler)
+
+    def upload_file(
+        self,
+        file_path: str,
+        correlation_id: Optional[str] = None,
+    ) -> AttachmentResponse:
+        """
+        Upload a file and get attachment information.
+
+        Args:
+            file_path: Path to the file on disk
+            correlation_id: Optional correlation ID for request tracing. If not provided,
+                        one will be generated automatically.
+
+        Returns:
+            AttachmentResponse: Response containing the attachment ID and URL.
+
+        Raises:
+            AiriaAPIError: If the API request fails with details about the error.
+            requests.RequestException: For other request-related errors.
+
+        Example:
+            ```python
+            client = AiriaClient(api_key="your_api_key")
+
+            # Upload a file
+            response = client.attachments.upload_file(
+                file_path="example.jpg"
+            )
+            print(f"Uploaded attachment ID: {response.id}")
+            print(f"Attachment URL: {response.image_url}")
+            ```
+        """
+        request_data = self._pre_upload_file(
+            file_path=file_path,
+            correlation_id=correlation_id,
+            api_version=ApiVersion.V1.value,
+        )
+
+        resp = self._request_handler.make_request_multipart("POST", request_data)
+        return AttachmentResponse(**resp)
+
+    def get_file_url(
+        self,
+        file_id: str,
+        correlation_id: Optional[str] = None,
+    ) -> GetFileUrlResponse:
+        """
+        Get a refreshed signed URL for an existing attachment.
+
+        This method retrieves a new time-limited signed URL for accessing
+        an attachment that was previously uploaded. Useful when the original
+        signed URL has expired or is about to expire.
+
+        Args:
+            file_id: The unique identifier of the attachment
+            correlation_id: Optional correlation ID for request tracing. If not provided,
+                        one will be generated automatically.
+
+        Returns:
+            GetFileUrlResponse: Response containing the attachment ID and refreshed signed URL.
+
+        Raises:
+            AiriaAPIError: If the API request fails with details about the error.
+            requests.RequestException: For other request-related errors.
+
+        Example:
+            ```python
+            client = AiriaClient(api_key="your_api_key")
+
+            # First, upload a file
+            upload_response = client.attachments.upload_file(
+                file_path="example.jpg"
+            )
+            file_id = upload_response.id
+
+            # Later, get a refreshed URL for the same file
+            url_response = client.attachments.get_file_url(
+                file_id=file_id
+            )
+            print(f"Attachment ID: {url_response.id}")
+            print(f"Refreshed URL: {url_response.signed_url}")
+            ```
+        """
+        request_data = self._pre_get_file_url(
+            file_id=file_id,
+            correlation_id=correlation_id,
+            api_version=ApiVersion.V1.value,
+        )
+
+        resp = self._request_handler.make_request("GET", request_data, return_json=True)
+        return GetFileUrlResponse(**resp)

airia-0.1.39/airia/client/data_store/__init__.py

@@ -0,0 +1,4 @@
+from .async_data_store import AsyncDataStore
+from .sync_data_store import DataStore
+
+__all__ = ["DataStore", "AsyncDataStore"]

airia-0.1.39/airia/client/data_store/async_data_store.py

@@ -0,0 +1,15 @@
+from .._request_handler import AsyncRequestHandler
+from .store import AsyncStore
+
+
+class AsyncDataStore:
+    """Async Data Store client for browsing files and folders in store connectors."""
+
+    def __init__(self, request_handler: AsyncRequestHandler):
+        """
+        Initialize the AsyncDataStore client.
+
+        Args:
+            request_handler: The async request handler for making API calls
+        """
+        self.store = AsyncStore(request_handler)

airia-0.1.39/airia/client/data_store/store/async_store.py

@@ -0,0 +1,114 @@
+from typing import Optional
+
+from ....types.api.data_store.store import GetFilesAndFoldersResponse
+from ..._request_handler import AsyncRequestHandler
+from .base_store import BaseStore
+
+
+class AsyncStore(BaseStore):
+    """Async Store client for browsing files and folders."""
+
+    def __init__(self, request_handler: AsyncRequestHandler):
+        super().__init__(request_handler)
+
+    async def get_files_and_folders(
+        self,
+        store_connector_id: str,
+        project_id: str,
+        folder_id: Optional[str] = None,
+        page_number: Optional[int] = None,
+        page_size: Optional[int] = None,
+        sort_by: Optional[str] = None,
+        sort_order: Optional[str] = None,
+        filter_by: Optional[str] = None,
+        filter_value: Optional[str] = None,
+        correlation_id: Optional[str] = None,
+    ) -> GetFilesAndFoldersResponse:
+        """
+        Retrieve files and folders from a store connector in the Airia data store.
+
+        This method retrieves information about files and folders in the specified
+        store connector, with optional navigation into specific folders and support
+        for pagination, sorting, and filtering.
+
+        Args:
+            store_connector_id: The unique identifier of the store connector (GUID format)
+            project_id: The unique identifier of the project (GUID format)
+            folder_id: Optional folder ID to browse within a specific folder (GUID format).
+                If not provided, retrieves items from the root level.
+            page_number: Page number for pagination (1-indexed)
+            page_size: Number of items per page
+            sort_by: Field to sort by (e.g., "lastSyncAt", "name")
+            sort_order: Sort order ("ASC" or "DESC")
+            filter_by: Field to filter by
+            filter_value: Value to filter by
+            correlation_id: Optional correlation ID for request tracing
+
+        Returns:
+            GetFilesAndFoldersResponse: List of files and folders with metadata and total count
+
+        Raises:
+            AiriaAPIError: If the API request fails, including cases where:
+                - The store_connector_id doesn't exist (404)
+                - The project_id doesn't exist (404)
+                - The folder_id is invalid (404)
+                - Authentication fails (401)
+                - Access is forbidden (403)
+                - Server errors (5xx)
+            ValueError: If required parameters are missing or invalid
+
+        Example:
+            ```python
+            from airia import AiriaAsyncClient
+
+            async with AiriaAsyncClient(api_key="your_api_key") as client:
+                # Get files and folders from root level
+                response = await client.data_store.store.get_files_and_folders(
+                    store_connector_id="02b2ef8b-8bff-42c3-9ddb-e325c893176e",
+                    project_id="0196162b-1553-71b2-8ebf-44594717936e"
+                )
+
+                # Browse a specific folder with pagination and sorting
+                response = await client.data_store.store.get_files_and_folders(
+                    store_connector_id="02b2ef8b-8bff-42c3-9ddb-e325c893176e",
+                    project_id="0196162b-1553-71b2-8ebf-44594717936e",
+                    folder_id="3292db69-f365-4bb6-a2b6-a017a187fb77",
+                    page_number=1,
+                    page_size=50,
+                    sort_by="lastSyncAt",
+                    sort_order="DESC"
+                )
+
+                # Access the results
+                if response.files_and_folders:
+                    for item in response.files_and_folders:
+                        print(f"{item.name} ({item.type})")
+                        if item.type == "folder":
+                            print(f"  Contains {item.file_count} files, {item.folder_count} folders")
+
+                print(f"Total items: {response.total_count}")
+            ```
+
+        Note:
+            The response includes:
+            - files_and_folders: List of file and folder objects with metadata
+            - total_count: Total number of items (useful for pagination)
+        """
+        request_data = self._pre_get_files_and_folders(
+            store_connector_id=store_connector_id,
+            project_id=project_id,
+            folder_id=folder_id,
+            page_number=page_number,
+            page_size=page_size,
+            sort_by=sort_by,
+            sort_order=sort_order,
+            filter_by=filter_by,
+            filter_value=filter_value,
+            correlation_id=correlation_id,
+        )
+
+        response = await self._request_handler.make_request(
+            "GET", request_data, return_json=True
+        )
+
+        return GetFilesAndFoldersResponse(**response)

airia-0.1.39/airia/client/data_store/store/base_store.py

@@ -0,0 +1,73 @@
+from typing import Optional, Union
+from urllib.parse import urljoin
+
+from ..._request_handler import AsyncRequestHandler, RequestHandler
+
+
+class BaseStore:
+    def __init__(self, request_handler: Union[RequestHandler, AsyncRequestHandler]):
+        self._request_handler = request_handler
+
+    def _pre_get_files_and_folders(
+        self,
+        store_connector_id: str,
+        project_id: str,
+        folder_id: Optional[str] = None,
+        page_number: Optional[int] = None,
+        page_size: Optional[int] = None,
+        sort_by: Optional[str] = None,
+        sort_order: Optional[str] = None,
+        filter_by: Optional[str] = None,
+        filter_value: Optional[str] = None,
+        correlation_id: Optional[str] = None,
+    ):
+        """
+        Prepare request data for get files and folders endpoint.
+
+        This internal method constructs the URL and query parameters for
+        retrieving files and folders from a store connector.
+
+        Args:
+            store_connector_id: ID of the store connector
+            project_id: ID of the project
+            folder_id: Optional folder ID to browse within a specific folder
+            page_number: Page number for pagination
+            page_size: Number of items per page
+            sort_by: Field to sort by
+            sort_order: Sort order (ASC or DESC)
+            filter_by: Field to filter by
+            filter_value: Value to filter by
+            correlation_id: Optional correlation ID for tracing
+
+        Returns:
+            RequestData: Prepared request data for the get files and folders endpoint
+        """
+        # Build URL with optional folder_id
+        if folder_id:
+            url_path = f"datastore/v1/store/{store_connector_id}/folders/{folder_id}"
+        else:
+            url_path = f"datastore/v1/store/{store_connector_id}/folders/"
+
+        url = urljoin(self._request_handler.base_url, url_path)
+
+        # Build query parameters
+        params = {"projectId": project_id}
+
+        if page_number is not None:
+            params["pagingParameters.pageNumber"] = page_number
+        if page_size is not None:
+            params["pagingParameters.pageSize"] = page_size
+        if sort_by is not None:
+            params["sortingParameters.sortBy"] = sort_by
+        if sort_order is not None:
+            params["sortingParameters.sortOrder"] = sort_order
+        if filter_by is not None:
+            params["filteringParameters.filterBy"] = filter_by
+        if filter_value is not None:
+            params["filteringParameters.filterValue"] = filter_value
+
+        request_data = self._request_handler.prepare_request(
+            url, params=params, payload=None, correlation_id=correlation_id
+        )
+
+        return request_data

airia-0.1.39/airia/client/data_store/store/sync_store.py

@@ -0,0 +1,115 @@
+from typing import Optional
+
+from ....types.api.data_store.store import GetFilesAndFoldersResponse
+from ..._request_handler import RequestHandler
+from .base_store import BaseStore
+
+
+class Store(BaseStore):
+    """Store client for browsing files and folders."""
+
+    def __init__(self, request_handler: RequestHandler):
+        super().__init__(request_handler)
+
+    def get_files_and_folders(
+        self,
+        store_connector_id: str,
+        project_id: str,
+        folder_id: Optional[str] = None,
+        page_number: Optional[int] = None,
+        page_size: Optional[int] = None,
+        sort_by: Optional[str] = None,
+        sort_order: Optional[str] = None,
+        filter_by: Optional[str] = None,
+        filter_value: Optional[str] = None,
+        correlation_id: Optional[str] = None,
+    ) -> GetFilesAndFoldersResponse:
+        """
+        Retrieve files and folders from a store connector in the Airia data store.
+
+        This method retrieves information about files and folders in the specified
+        store connector, with optional navigation into specific folders and support
+        for pagination, sorting, and filtering.
+
+        Args:
+            store_connector_id: The unique identifier of the store connector (GUID format)
+            project_id: The unique identifier of the project (GUID format)
+            folder_id: Optional folder ID to browse within a specific folder (GUID format).
+                If not provided, retrieves items from the root level.
+            page_number: Page number for pagination (1-indexed)
+            page_size: Number of items per page
+            sort_by: Field to sort by (e.g., "lastSyncAt", "name")
+            sort_order: Sort order ("ASC" or "DESC")
+            filter_by: Field to filter by
+            filter_value: Value to filter by
+            correlation_id: Optional correlation ID for request tracing
+
+        Returns:
+            GetFilesAndFoldersResponse: List of files and folders with metadata and total count
+
+        Raises:
+            AiriaAPIError: If the API request fails, including cases where:
+                - The store_connector_id doesn't exist (404)
+                - The project_id doesn't exist (404)
+                - The folder_id is invalid (404)
+                - Authentication fails (401)
+                - Access is forbidden (403)
+                - Server errors (5xx)
+            ValueError: If required parameters are missing or invalid
+
+        Example:
+            ```python
+            from airia import AiriaClient
+
+            client = AiriaClient(api_key="your_api_key")
+
+            # Get files and folders from root level
+            response = client.data_store.store.get_files_and_folders(
+                store_connector_id="02b2ef8b-8bff-42c3-9ddb-e325c893176e",
+                project_id="0196162b-1553-71b2-8ebf-44594717936e"
+            )
+
+            # Browse a specific folder with pagination and sorting
+            response = client.data_store.store.get_files_and_folders(
+                store_connector_id="02b2ef8b-8bff-42c3-9ddb-e325c893176e",
+                project_id="0196162b-1553-71b2-8ebf-44594717936e",
+                folder_id="3292db69-f365-4bb6-a2b6-a017a187fb77",
+                page_number=1,
+                page_size=50,
+                sort_by="lastSyncAt",
+                sort_order="DESC"
+            )
+
+            # Access the results
+            if response.files_and_folders:
+                for item in response.files_and_folders:
+                    print(f"{item.name} ({item.type})")
+                    if item.type == "folder":
+                        print(f"  Contains {item.file_count} files, {item.folder_count} folders")
+
+            print(f"Total items: {response.total_count}")
+            ```
+
+        Note:
+            The response includes:
+            - files_and_folders: List of file and folder objects with metadata
+            - total_count: Total number of items (useful for pagination)
+        """
+        request_data = self._pre_get_files_and_folders(
+            store_connector_id=store_connector_id,
+            project_id=project_id,
+            folder_id=folder_id,
+            page_number=page_number,
+            page_size=page_size,
+            sort_by=sort_by,
+            sort_order=sort_order,
+            filter_by=filter_by,
+            filter_value=filter_value,
+            correlation_id=correlation_id,
+        )
+
+        response = self._request_handler.make_request(
+            "GET", request_data, return_json=True
+        )
+
+        return GetFilesAndFoldersResponse(**response)

airia-0.1.39/airia/client/data_store/sync_data_store.py

@@ -0,0 +1,15 @@
+from .._request_handler import RequestHandler
+from .store import Store
+
+
+class DataStore:
+    """Data Store client for browsing files and folders in store connectors."""
+
+    def __init__(self, request_handler: RequestHandler):
+        """
+        Initialize the DataStore client.
+
+        Args:
+            request_handler: The request handler for making API calls
+        """
+        self.store = Store(request_handler)

{airia-0.1.37 → airia-0.1.39}/airia/client/data_vector_search/base_data_vector_search.py

@@ -48,7 +48,9 @@ class BaseDataVectorSearch:
         )
 
         request_data = self._request_handler.prepare_request(
-            url, correlation_id=correlation_id, params={"pageNumber": page_number, "pageSize": page_size}
+            url,
+            correlation_id=correlation_id,
+            params={"pageNumber": page_number, "pageSize": page_size},
         )
 
         return request_data

{airia-0.1.37 → airia-0.1.39}/airia/client/pipelines_config/async_pipelines_config.py

@@ -133,7 +133,9 @@ class AsyncPipelinesConfig(BasePipelinesConfig):
         sort_direction: Optional[Literal["ASC", "DESC"]] = None,
         filter: Optional[str] = None,
         project_id: Optional[str] = None,
-        model_credential_source_type: Optional[Literal["UserProvided", "Library"]] = None,
+        model_credential_source_type: Optional[
+            Literal["UserProvided", "Library"]
+        ] = None,
         correlation_id: Optional[str] = None,
     ) -> GetPipelinesConfigResponse:
         """
@@ -267,4 +269,6 @@ class AsyncPipelinesConfig(BasePipelinesConfig):
             correlation_id=correlation_id,
             api_version=ApiVersion.V1.value,
         )
-        await self._request_handler.make_request("DELETE", request_data, return_json=False)
+        await self._request_handler.make_request(
+            "DELETE", request_data, return_json=False
+        )

{airia-0.1.37 → airia-0.1.39}/airia/client/pipelines_config/base_pipelines_config.py

@@ -85,7 +85,9 @@ class BasePipelinesConfig:
         sort_direction: Optional[Literal["ASC", "DESC"]] = None,
         filter: Optional[str] = None,
         project_id: Optional[str] = None,
-        model_credential_source_type: Optional[Literal["UserProvided", "Library"]] = None,
+        model_credential_source_type: Optional[
+            Literal["UserProvided", "Library"]
+        ] = None,
         correlation_id: Optional[str] = None,
         api_version: str = ApiVersion.V1.value,
     ):

{airia-0.1.37 → airia-0.1.39}/airia/client/pipelines_config/sync_pipelines_config.py

@@ -133,7 +133,9 @@ class PipelinesConfig(BasePipelinesConfig):
         sort_direction: Optional[Literal["ASC", "DESC"]] = None,
         filter: Optional[str] = None,
         project_id: Optional[str] = None,
-        model_credential_source_type: Optional[Literal["UserProvided", "Library"]] = None,
+        model_credential_source_type: Optional[
+            Literal["UserProvided", "Library"]
+        ] = None,
         correlation_id: Optional[str] = None,
     ) -> GetPipelinesConfigResponse:
         """

airia-0.1.39/airia/client/store/__init__.py

@@ -0,0 +1,4 @@
+from .async_store import AsyncStore
+from .sync_store import Store
+
+__all__ = ["Store", "AsyncStore"]