store

Bases: BaseStore

Source code in airia/client/store/sync_store.py

def __init__(self, request_handler: RequestHandler):
    super().__init__(request_handler)

delete_file(project_id, file_id, correlation_id=None)

Delete a file from the Airia store.

This method deletes a specific file from the given project.

Parameters:

Name	Type	Description	Default
project_id	str	The unique identifier of the project (GUID format)	required
file_id	str	The unique identifier of the file to delete (GUID format)	required
correlation_id	Optional[str]	Optional correlation ID for request tracing	None

Returns:

Type	Description
None	None

Raises:

Type	Description
AiriaAPIError	If the API request fails, including cases where: - The project_id doesn't exist (404) - The file_id doesn't exist (404) - Authentication fails (401) - Access is forbidden (403) - Server errors (5xx)
ValueError	If required parameters are missing or invalid

Example

from airia import AiriaClient

client = AiriaClient(api_key="your_api_key")

# Delete a file
client.store.delete_file(
    project_id="your_project_id",
    file_id="your_file_id"
)

Source code in airia/client/store/sync_store.py

def delete_file(
    self,
    project_id: str,
    file_id: str,
    correlation_id: Optional[str] = None,
) -> None:
    """
    Delete a file from the Airia store.

    This method deletes a specific file from the given project.

    Args:
        project_id: The unique identifier of the project (GUID format)
        file_id: The unique identifier of the file to delete (GUID format)
        correlation_id: Optional correlation ID for request tracing

    Returns:
        None

    Raises:
        AiriaAPIError: If the API request fails, including cases where:
            - The project_id doesn't exist (404)
            - The file_id doesn't exist (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")

        # Delete a file
        client.store.delete_file(
            project_id="your_project_id",
            file_id="your_file_id"
        )
        ```
    """
    request_data = self._pre_delete_file(
        project_id=project_id,
        file_id=file_id,
        correlation_id=correlation_id,
        api_version=ApiVersion.V1.value,
    )

    self._request_handler.make_request("DELETE", request_data, return_json=False)

get_file(project_id, file_id, correlation_id=None)

Retrieve a file from the Airia store.

This method retrieves file information, download URL, and preview information for a specific file in the given project.

Parameters:

Name	Type	Description	Default
project_id	str	The unique identifier of the project (GUID format)	required
file_id	str	The unique identifier of the file (GUID format)	required
correlation_id	Optional[str]	Optional correlation ID for request tracing	None

Returns:

Name	Type	Description
GetFileResponse	GetFileResponse	File information including metadata, download info, and preview info

Raises:

Type	Description
AiriaAPIError	If the API request fails, including cases where: - The project_id doesn't exist (404) - The file_id doesn't exist (404) - Authentication fails (401) - Access is forbidden (403) - Server errors (5xx)
ValueError	If required parameters are missing or invalid

Example

from airia import AiriaClient

client = AiriaClient(api_key="your_api_key")

# Get file information
file_info = client.store.get_file(
    project_id="your_project_id",
    file_id="your_file_id"
)

# Access file metadata
if file_info.file:
    print(f"File name: {file_info.file.name}")
    print(f"File size: {file_info.file.size}")
    print(f"Status: {file_info.file.status}")

# Access download URL
if file_info.downloadInfo:
    print(f"Download URL: {file_info.download_info.url}")

# Access preview information
if file_info.previewInfo:
    print(f"Preview URL: {file_info.preview_info.preview_url}")

Note

The response includes three optional components: - file: File metadata and processing status - downloadInfo: Direct download URL for the file - previewInfo: Preview URL and connector information

Source code in airia/client/store/sync_store.py

def get_file(
    self,
    project_id: str,
    file_id: str,
    correlation_id: Optional[str] = None,
) -> GetFileResponse:
    """
    Retrieve a file from the Airia store.

    This method retrieves file information, download URL, and preview information
    for a specific file in the given project.

    Args:
        project_id: The unique identifier of the project (GUID format)
        file_id: The unique identifier of the file (GUID format)
        correlation_id: Optional correlation ID for request tracing

    Returns:
        GetFileResponse: File information including metadata, download info, and preview info

    Raises:
        AiriaAPIError: If the API request fails, including cases where:
            - The project_id doesn't exist (404)
            - The file_id doesn't exist (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 file information
        file_info = client.store.get_file(
            project_id="your_project_id",
            file_id="your_file_id"
        )

        # Access file metadata
        if file_info.file:
            print(f"File name: {file_info.file.name}")
            print(f"File size: {file_info.file.size}")
            print(f"Status: {file_info.file.status}")

        # Access download URL
        if file_info.downloadInfo:
            print(f"Download URL: {file_info.download_info.url}")

        # Access preview information
        if file_info.previewInfo:
            print(f"Preview URL: {file_info.preview_info.preview_url}")
        ```

    Note:
        The response includes three optional components:
        - file: File metadata and processing status
        - downloadInfo: Direct download URL for the file
        - previewInfo: Preview URL and connector information
    """
    request_data = self._pre_get_file(
        project_id=project_id,
        file_id=file_id,
        correlation_id=correlation_id,
        api_version=ApiVersion.V1.value,
    )

    response = self._request_handler.make_request(
        "GET", request_data, return_json=True
    )

    return GetFileResponse(**response)

get_files(project_id, store_connector_id, page_number=None, page_size=None, correlation_id=None)

Retrieve all files from a store connector in the Airia store with optional pagination.

This method retrieves information about all files in the specified store connector and project, including file metadata, download URLs, and processing status. The results can be paginated using the page_number and page_size parameters.

Parameters:

Name	Type	Description	Default
project_id	str	The unique identifier of the project (GUID format)	required
store_connector_id	str	The unique identifier of the store connector (GUID format)	required
page_number	Optional[int]	The page number to be fetched	None
page_size	Optional[int]	The number of items per page	None
correlation_id	Optional[str]	Optional correlation ID for request tracing	None

Returns:

Name	Type	Description
GetFilesResponse	GetFilesResponse	List of files with metadata, download info, and total count

Raises:

Type	Description
AiriaAPIError	If the API request fails, including cases where: - The project_id doesn't exist (404) - The store_connector_id doesn't exist (404) - Authentication fails (401) - Access is forbidden (403) - Server errors (5xx)
ValueError	If required parameters are missing or invalid

Example

from airia import AiriaClient

client = AiriaClient(api_key="your_api_key")

# Get all files from a store connector
files_response = client.store.get_files(
    project_id="your_project_id",
    store_connector_id="your_store_connector_id"
)

# Get files with pagination
files_response = client.store.get_files(
    project_id="your_project_id",
    store_connector_id="your_store_connector_id",
    page_number=1,
    page_size=20
)

# Access files list
if files_response.files:
    for file in files_response.files:
        print(f"File: {file.name}, Status: {file.status}, Size: {file.size}")

# Access download URLs
if files_response.downloadInfos:
    for download_info in files_response.downloadInfos:
        print(f"File ID: {download_info.fileId}, URL: {download_info.url}")

# Access total count
print(f"Total files: {files_response.totalCount}")

Note

The response includes: - files: List of file metadata and processing status - downloadInfos: List of direct download URLs for files - totalCount: Total number of files in the store connector

Source code in airia/client/store/sync_store.py

def get_files(
    self,
    project_id: str,
    store_connector_id: str,
    page_number: Optional[int] = None,
    page_size: Optional[int] = None,
    correlation_id: Optional[str] = None,
) -> GetFilesResponse:
    """
    Retrieve all files from a store connector in the Airia store with optional pagination.

    This method retrieves information about all files in the specified store connector
    and project, including file metadata, download URLs, and processing status.
    The results can be paginated using the page_number and page_size parameters.

    Args:
        project_id: The unique identifier of the project (GUID format)
        store_connector_id: The unique identifier of the store connector (GUID format)
        page_number: The page number to be fetched
        page_size: The number of items per page
        correlation_id: Optional correlation ID for request tracing

    Returns:
        GetFilesResponse: List of files with metadata, download info, and total count

    Raises:
        AiriaAPIError: If the API request fails, including cases where:
            - The project_id doesn't exist (404)
            - The store_connector_id doesn't exist (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 all files from a store connector
        files_response = client.store.get_files(
            project_id="your_project_id",
            store_connector_id="your_store_connector_id"
        )

        # Get files with pagination
        files_response = client.store.get_files(
            project_id="your_project_id",
            store_connector_id="your_store_connector_id",
            page_number=1,
            page_size=20
        )

        # Access files list
        if files_response.files:
            for file in files_response.files:
                print(f"File: {file.name}, Status: {file.status}, Size: {file.size}")

        # Access download URLs
        if files_response.downloadInfos:
            for download_info in files_response.downloadInfos:
                print(f"File ID: {download_info.fileId}, URL: {download_info.url}")

        # Access total count
        print(f"Total files: {files_response.totalCount}")
        ```

    Note:
        The response includes:
        - files: List of file metadata and processing status
        - downloadInfos: List of direct download URLs for files
        - totalCount: Total number of files in the store connector
    """
    request_data = self._pre_get_files(
        project_id=project_id,
        store_connector_id=store_connector_id,
        page_number=page_number,
        page_size=page_size,
        correlation_id=correlation_id,
        api_version=ApiVersion.V1.value,
    )

    response = self._request_handler.make_request(
        "GET", request_data, return_json=True
    )

    return GetFilesResponse(**response)

update_file(store_connector_id, store_file_id, project_id, file_path, pending_ingestion=True, correlation_id=None)

Update an existing file in the Airia store.

This method updates an existing file in the specified store connector and project, with optional ingestion settings.

Parameters:

Name	Type	Description	Default
store_connector_id	str	The unique identifier of the store connector (GUID format)	required
store_file_id	str	The unique identifier of the file to update (GUID format)	required
project_id	str	The unique identifier of the project (GUID format)	required
file_path	str	Path to the file on disk	required
pending_ingestion	bool	Whether the file should be marked as pending ingestion. Default is True.	True
correlation_id	Optional[str]	Optional correlation ID for request tracing	None

Returns:

Type	Description
str	The File ID of the updated file.

Raises:

Type	Description
AiriaAPIError	If the API request fails, including cases where: - The store_connector_id doesn't exist (404) - The store_file_id doesn't exist (404) - The project_id doesn't exist (404) - Authentication fails (401) - Access is forbidden (403) - Server errors (5xx)
ValueError	If required parameters are missing or invalid

Example

from airia import AiriaClient

client = AiriaClient(api_key="your_api_key")

# Update existing file
updated_file_id = client.store.update_file(
    store_connector_id="your_store_connector_id",
    store_file_id="your_store_file_id",
    project_id="your_project_id",
    file_path="document.pdf"
)

Source code in airia/client/store/sync_store.py

def update_file(
    self,
    store_connector_id: str,
    store_file_id: str,
    project_id: str,
    file_path: str,
    pending_ingestion: bool = True,
    correlation_id: Optional[str] = None,
) -> str:
    """
    Update an existing file in the Airia store.

    This method updates an existing file in the specified store connector and project,
    with optional ingestion settings.

    Args:
        store_connector_id: The unique identifier of the store connector (GUID format)
        store_file_id: The unique identifier of the file to update (GUID format)
        project_id: The unique identifier of the project (GUID format)
        file_path: Path to the file on disk
        pending_ingestion: Whether the file should be marked as pending ingestion. Default is True.
        correlation_id: Optional correlation ID for request tracing

    Returns:
        The File ID of the updated file.

    Raises:
        AiriaAPIError: If the API request fails, including cases where:
            - The store_connector_id doesn't exist (404)
            - The store_file_id doesn't exist (404)
            - The project_id doesn't exist (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")

        # Update existing file
        updated_file_id = client.store.update_file(
            store_connector_id="your_store_connector_id",
            store_file_id="your_store_file_id",
            project_id="your_project_id",
            file_path="document.pdf"
        )
        ```
    """
    request_data = self._pre_update_file(
        store_connector_id=store_connector_id,
        store_file_id=store_file_id,
        project_id=project_id,
        file_path=file_path,
        pending_ingestion=pending_ingestion,
        correlation_id=correlation_id,
        api_version=ApiVersion.V1.value,
    )
    try:
        response = self._request_handler.make_request_multipart("PUT", request_data)
        return response["fileId"]
    finally:
        request_data.files["File"][1].close()

upload_file(store_connector_id, project_id, file_path, folder_id=None, pending_ingestion=True, correlation_id=None)

Upload a file to the Airia store.

This method uploads a file to the specified store connector and project, with optional folder organization and ingestion settings.

Parameters:

Name	Type	Description	Default
store_connector_id	str	The unique identifier of the store connector (GUID format)	required
project_id	str	The unique identifier of the project (GUID format)	required
file_path	str	Path to the file on disk	required
folder_id	Optional[str]	Optional folder identifier for organizing the file (GUID format)	None
pending_ingestion	bool	Whether the file should be marked as pending ingestion. Default is True.	True
correlation_id	Optional[str]	Optional correlation ID for request tracing	None

Returns:

Name	Type	Description
File	File	object containing details about the uploaded file.

Raises:

Type	Description
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 (400) - Authentication fails (401) - Access is forbidden (403) - Server errors (5xx)
ValueError	If required parameters are missing or invalid

Example

from airia import AiriaClient

client = AiriaClient(api_key="your_api_key")

# Upload file
uploaded_file = client.store.upload_file(
    store_connector_id="your_store_connector_id",
    project_id="your_project_id",
    file_path="document.pdf"
)

# Upload with folder organization
uploaded_file = client.store.upload_file(
    store_connector_id="your_store_connector_id",
    project_id="your_project_id",
    file_path="document.pdf",
    folder_id="your_folder_id",
)

Source code in airia/client/store/sync_store.py

def upload_file(
    self,
    store_connector_id: str,
    project_id: str,
    file_path: str,
    folder_id: Optional[str] = None,
    pending_ingestion: bool = True,
    correlation_id: Optional[str] = None,
) -> File:
    """
    Upload a file to the Airia store.

    This method uploads a file to the specified store connector and project,
    with optional folder organization and ingestion settings.

    Args:
        store_connector_id: The unique identifier of the store connector (GUID format)
        project_id: The unique identifier of the project (GUID format)
        file_path: Path to the file on disk
        folder_id: Optional folder identifier for organizing the file (GUID format)
        pending_ingestion: Whether the file should be marked as pending ingestion. Default is True.
        correlation_id: Optional correlation ID for request tracing

    Returns:
        File: object containing details about the uploaded file.

    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 (400)
            - 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")

        # Upload file
        uploaded_file = client.store.upload_file(
            store_connector_id="your_store_connector_id",
            project_id="your_project_id",
            file_path="document.pdf"
        )

        # Upload with folder organization
        uploaded_file = client.store.upload_file(
            store_connector_id="your_store_connector_id",
            project_id="your_project_id",
            file_path="document.pdf",
            folder_id="your_folder_id",
        )
        ```
    """
    request_data = self._pre_upload_file(
        store_connector_id=store_connector_id,
        project_id=project_id,
        file_path=file_path,
        folder_id=folder_id,
        pending_ingestion=pending_ingestion,
        correlation_id=correlation_id,
        api_version=ApiVersion.V1.value,
    )

    try:
        response = self._request_handler.make_request_multipart(
            "POST", request_data
        )
        return File(**response)
    finally:
        request_data.files["File"][1].close()