airia 0.1.12__tar.gz → 0.1.13__tar.gz

airia-0.1.13/PKG-INFO

@@ -0,0 +1,219 @@
+Metadata-Version: 2.4
+Name: airia
+Version: 0.1.13
+Summary: Python SDK for Airia API
+Author-email: Airia LLC <support@airia.com>
+License: MIT
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.32.3
+Requires-Dist: aiohttp>=3.11.14
+Requires-Dist: loguru>=0.7.3
+Requires-Dist: pydantic>=2.11.0
+Provides-Extra: anthropic
+Requires-Dist: anthropic>=0.49.0; extra == "anthropic"
+Provides-Extra: openai
+Requires-Dist: openai>=1.74.0; extra == "openai"
+Provides-Extra: all
+Requires-Dist: anthropic>=0.49.0; extra == "all"
+Requires-Dist: openai>=1.74.0; extra == "all"
+Dynamic: license-file
+
+# Airia Python API Library
+
+[![PyPI version](https://badge.fury.io/py/airia.svg)](https://badge.fury.io/py/airia)
+[![Python versions](https://img.shields.io/pypi/pyversions/airia.svg)](https://pypi.org/project/airia/)
+[![License](https://img.shields.io/pypi/l/airia.svg)](https://pypi.org/project/airia/)
+
+The Airia Python library provides a clean and intuitive interface to interact with Airia API. The library offers both synchronous and asynchronous clients for maximum flexibility in your applications.
+
+## Features
+
+- **Dual Client Support**: Choose between synchronous (`AiriaClient`) and asynchronous (`AiriaAsyncClient`) implementations
+- **Pipeline Execution**: Easily run AI pipelines with customizable parameters
+- **Gateway Support**: Seamlessly integrate with OpenAI and Anthropic services through Airia gateways
+- **Error Handling**: Comprehensive error handling with custom exceptions
+- **Logging**: Built-in configurable logging with correlation ID support for request tracing
+- **Flexible Authentication**: Support for both API keys and bearer tokens with flexible configuration
+
+## Documentation and Quick Start Guides
+
+Run locally with `mkdocs`:
+
+1. [Install development dependencies](#install-with-development-dependencies)
+2. Run `mkdocs serve` to start the local server
+
+## Installation
+
+You can install the package using pip or uv:
+
+<table>
+<tr>
+<th>pip</th>
+<th>uv</th>
+</tr>
+<tr>
+<td>
+
+```bash
+pip install airia
+```
+
+</td>
+<td>
+
+```bash
+uv add airia
+```
+
+</td>
+</tr>
+</table>
+
+### Install with optional dependencies
+
+The package supports optional dependencies for gateway functionality:
+
+<table>
+<tr>
+<th>OpenAI Gateway</th>
+<th>Anthropic Gateway</th>
+<th>All Gateways</th>
+</tr>
+<tr>
+<td>
+
+```bash
+pip install "airia[openai]"
+```
+
+</td>
+<td>
+
+```bash
+pip install "airia[anthropic]"
+```
+
+</td>
+<td>
+
+```bash
+pip install "airia[all]"
+```
+
+</td>
+</tr>
+</table>
+
+### Install with development dependencies
+
+Clone the repository:
+
+```bash
+git clone https://github.com/AiriaLLC/airia-python.git
+cd airia-python
+```
+
+Then, run one of the following commands:
+
+<table>
+<tr>
+<th>pip</th>
+<th>uv</th>
+</tr>
+<tr>
+<td>
+
+```bash
+pip install dependency-groups
+dev=$(python -m dependency_groups dev)
+pip install -e .
+pip install $dev
+```
+
+</td>
+<td>
+
+```bash
+uv sync --frozen --group dev
+```
+
+</td>
+</tr>
+</table>
+
+## Building from Source
+
+First make sure you have already cloned the repository, then run one of the following commands:
+
+<table>
+<tr>
+<th>pip</th>
+<th>uv</th>
+</tr>
+<tr>
+<td>
+
+```bash
+pip install build
+python -m build
+```
+
+</td>
+<td>
+
+```bash
+uv build
+```
+
+</td>
+</tr>
+</table>
+
+This will create both wheel and source distribution in the `dist/` directory.
+
+## Requirements
+
+- Python 3.9 or higher
+- Core dependencies:
+  - requests
+  - aiohttp
+  - loguru
+  - pydantic
+
+- Optional dependencies:
+  - OpenAI gateway: `openai>=1.74.0`
+  - Anthropic gateway: `anthropic>=0.49.0`
+
+## Development
+
+To run tests (make sure you have development dependencies installed):
+
+```bash
+pytest
+```
+
+For testing gateway functionality, install the optional dependencies:
+
+```bash
+# For OpenAI gateway tests
+pip install -e .[openai]
+pytest tests/test_openai_gateway.py
+
+# For Anthropic gateway tests
+pip install -e .[anthropic]
+pytest tests/test_anthropic_gateway.py
+
+# For all tests
+pip install -e .[all]
+pytest
+```

airia-0.1.13/README.md

@@ -0,0 +1,189 @@
+# Airia Python API Library
+
+[![PyPI version](https://badge.fury.io/py/airia.svg)](https://badge.fury.io/py/airia)
+[![Python versions](https://img.shields.io/pypi/pyversions/airia.svg)](https://pypi.org/project/airia/)
+[![License](https://img.shields.io/pypi/l/airia.svg)](https://pypi.org/project/airia/)
+
+The Airia Python library provides a clean and intuitive interface to interact with Airia API. The library offers both synchronous and asynchronous clients for maximum flexibility in your applications.
+
+## Features
+
+- **Dual Client Support**: Choose between synchronous (`AiriaClient`) and asynchronous (`AiriaAsyncClient`) implementations
+- **Pipeline Execution**: Easily run AI pipelines with customizable parameters
+- **Gateway Support**: Seamlessly integrate with OpenAI and Anthropic services through Airia gateways
+- **Error Handling**: Comprehensive error handling with custom exceptions
+- **Logging**: Built-in configurable logging with correlation ID support for request tracing
+- **Flexible Authentication**: Support for both API keys and bearer tokens with flexible configuration
+
+## Documentation and Quick Start Guides
+
+Run locally with `mkdocs`:
+
+1. [Install development dependencies](#install-with-development-dependencies)
+2. Run `mkdocs serve` to start the local server
+
+## Installation
+
+You can install the package using pip or uv:
+
+<table>
+<tr>
+<th>pip</th>
+<th>uv</th>
+</tr>
+<tr>
+<td>
+
+```bash
+pip install airia
+```
+
+</td>
+<td>
+
+```bash
+uv add airia
+```
+
+</td>
+</tr>
+</table>
+
+### Install with optional dependencies
+
+The package supports optional dependencies for gateway functionality:
+
+<table>
+<tr>
+<th>OpenAI Gateway</th>
+<th>Anthropic Gateway</th>
+<th>All Gateways</th>
+</tr>
+<tr>
+<td>
+
+```bash
+pip install "airia[openai]"
+```
+
+</td>
+<td>
+
+```bash
+pip install "airia[anthropic]"
+```
+
+</td>
+<td>
+
+```bash
+pip install "airia[all]"
+```
+
+</td>
+</tr>
+</table>
+
+### Install with development dependencies
+
+Clone the repository:
+
+```bash
+git clone https://github.com/AiriaLLC/airia-python.git
+cd airia-python
+```
+
+Then, run one of the following commands:
+
+<table>
+<tr>
+<th>pip</th>
+<th>uv</th>
+</tr>
+<tr>
+<td>
+
+```bash
+pip install dependency-groups
+dev=$(python -m dependency_groups dev)
+pip install -e .
+pip install $dev
+```
+
+</td>
+<td>
+
+```bash
+uv sync --frozen --group dev
+```
+
+</td>
+</tr>
+</table>
+
+## Building from Source
+
+First make sure you have already cloned the repository, then run one of the following commands:
+
+<table>
+<tr>
+<th>pip</th>
+<th>uv</th>
+</tr>
+<tr>
+<td>
+
+```bash
+pip install build
+python -m build
+```
+
+</td>
+<td>
+
+```bash
+uv build
+```
+
+</td>
+</tr>
+</table>
+
+This will create both wheel and source distribution in the `dist/` directory.
+
+## Requirements
+
+- Python 3.9 or higher
+- Core dependencies:
+  - requests
+  - aiohttp
+  - loguru
+  - pydantic
+
+- Optional dependencies:
+  - OpenAI gateway: `openai>=1.74.0`
+  - Anthropic gateway: `anthropic>=0.49.0`
+
+## Development
+
+To run tests (make sure you have development dependencies installed):
+
+```bash
+pytest
+```
+
+For testing gateway functionality, install the optional dependencies:
+
+```bash
+# For OpenAI gateway tests
+pip install -e .[openai]
+pytest tests/test_openai_gateway.py
+
+# For Anthropic gateway tests
+pip install -e .[anthropic]
+pytest tests/test_anthropic_gateway.py
+
+# For all tests
+pip install -e .[all]
+pytest
+```

{airia-0.1.12 → airia-0.1.13}/airia/client/async_client.py

@@ -16,6 +16,7 @@ from ..types._api_version import ApiVersion
 from ..types._request_data import RequestData
 from ..types.api import (
     CreateConversationResponse,
+    GetConversationResponse,
     GetPipelineConfigResponse,
     PipelineExecutionAsyncStreamedResponse,
     PipelineExecutionDebugResponse,
@@ -219,8 +220,8 @@ class AiriaAsyncClient(AiriaBaseClient):
         raise AiriaAPIError(status_code=e.status, message=sanitized_message) from e
 
     async def _make_request(
-        self, method: str, request_data: RequestData
-    ) -> Dict[str, Any]:
+        self, method: str, request_data: RequestData, return_json: bool = True
+    ) -> Optional[Dict[str, Any]]:
         """
         Makes an asynchronous HTTP request to the Airia API.
 
@@ -231,6 +232,7 @@ class AiriaAsyncClient(AiriaBaseClient):
                 - headers: HTTP headers to include in the request
                 - payload: The JSON payload/body for the request
                 - correlation_id: Unique identifier for request tracing
+            return_json (bool): Whether to return the response as JSON. Default is True.
 
         Returns:
             resp ([Dict[str, Any]): The JSON response from the API as a dictionary.
@@ -265,7 +267,8 @@ class AiriaAsyncClient(AiriaBaseClient):
                 response.raise_for_status()
 
                 # Return the response as a dictionary
-                return await response.json()
+                if return_json:
+                    return await response.json()
 
         except aiohttp.ClientResponseError as e:
             self._handle_exception(e, request_data.url, request_data.correlation_id)
@@ -737,3 +740,94 @@ class AiriaAsyncClient(AiriaBaseClient):
         resp = await self._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.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._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._make_request("DELETE", request_data, return_json=False)