ambertraceai 0.1.0__tar.gz

ambertraceai-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Pilot Generative AI Ltd.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

ambertraceai-0.1.0/PKG-INFO

@@ -0,0 +1,113 @@
+Metadata-Version: 2.4
+Name: ambertraceai
+Version: 0.1.0
+Summary: Python SDK for the Ambertrace neurosymbolic AI platform API
+Author-email: Pilot Generative AI <hello@ambertrace.ai>
+License-Expression: MIT
+Project-URL: Homepage, https://ambertrace.ai
+Project-URL: Documentation, https://app.ambertrace.ai/openapi/redoc
+Project-URL: Repository, https://github.com/Pilot-Generative-AI/ambertraceai-python
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: httpx>=0.24.0
+Requires-Dist: attrs>=23.1.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: pytest-httpx>=0.22; extra == "dev"
+Requires-Dist: respx>=0.20; extra == "dev"
+Dynamic: license-file
+
+# AmbertraceAI Python SDK
+
+Python client for the [Ambertrace](https://ambertrace.ai) neurosymbolic AI platform API.
+
+## Install
+
+```bash
+pip install ambertraceai
+```
+
+## Quick Start
+
+```python
+from ambertraceai import AmbertraceAPI
+
+api = AmbertraceAPI(
+    base_url="https://app.ambertrace.ai",
+    api_key="at_...",
+)
+
+# Create a domain
+domain = api.domains.create(
+    name="Legal Contracts",
+    description="Contract analysis for risk and compliance",
+)
+
+# Upload data
+dataset = api.datasets.upload(
+    domain_id=domain["id"],
+    file_path="contracts.csv",
+)
+
+# Build a platform (async — returns a job)
+result = api.platforms.create(
+    domain_id=domain["id"],
+    dataset_id=dataset["id"],
+)
+
+# Wait for the build to finish
+job = api.wait_for_job(result["job_id"], timeout=600)
+
+# Query the platform
+answer = api.platforms.query(
+    platform_id=result["platform_id"],
+    query="What are the highest-risk clauses?",
+)
+print(answer["answer"])
+print(answer["explanation"])
+```
+
+## Resources
+
+| Resource | Methods |
+|----------|---------|
+| `api.domains` | `list`, `create`, `get`, `update`, `delete`, `build_ontology` |
+| `api.datasets` | `list`, `get`, `upload`, `fetch`, `quality`, `clean`, `preview`, `delete` |
+| `api.platforms` | `list`, `create`, `get`, `status`, `query`, `suggest_rules`, `list_suggestions`, `graph` |
+| `api.predictions` | `predict`, `list_configs`, `create_config`, `train`, `list_predictions` |
+| `api.jobs` | `get` |
+
+## Job Polling
+
+Long-running operations (platform builds, data cleaning, training) return a `job_id`. Use `wait_for_job` to poll:
+
+```python
+job = api.wait_for_job(job_id, timeout=300, poll_interval=5)
+if job["status"] == "error":
+    print(f"Failed: {job.get('error_message')}")
+```
+
+## Error Handling
+
+```python
+from ambertraceai import AmbertraceAPI, AmbertraceError
+
+try:
+    api.domains.get(999)
+except AmbertraceError as e:
+    print(e.status_code)  # 404
+    print(e.code)         # "not_found"
+    print(str(e))         # "Domain not found."
+```
+
+## API Documentation
+
+Full API reference: [app.ambertrace.ai/openapi/redoc](https://app.ambertrace.ai/openapi/redoc)

ambertraceai-0.1.0/README.md

@@ -0,0 +1,86 @@
+# AmbertraceAI Python SDK
+
+Python client for the [Ambertrace](https://ambertrace.ai) neurosymbolic AI platform API.
+
+## Install
+
+```bash
+pip install ambertraceai
+```
+
+## Quick Start
+
+```python
+from ambertraceai import AmbertraceAPI
+
+api = AmbertraceAPI(
+    base_url="https://app.ambertrace.ai",
+    api_key="at_...",
+)
+
+# Create a domain
+domain = api.domains.create(
+    name="Legal Contracts",
+    description="Contract analysis for risk and compliance",
+)
+
+# Upload data
+dataset = api.datasets.upload(
+    domain_id=domain["id"],
+    file_path="contracts.csv",
+)
+
+# Build a platform (async — returns a job)
+result = api.platforms.create(
+    domain_id=domain["id"],
+    dataset_id=dataset["id"],
+)
+
+# Wait for the build to finish
+job = api.wait_for_job(result["job_id"], timeout=600)
+
+# Query the platform
+answer = api.platforms.query(
+    platform_id=result["platform_id"],
+    query="What are the highest-risk clauses?",
+)
+print(answer["answer"])
+print(answer["explanation"])
+```
+
+## Resources
+
+| Resource | Methods |
+|----------|---------|
+| `api.domains` | `list`, `create`, `get`, `update`, `delete`, `build_ontology` |
+| `api.datasets` | `list`, `get`, `upload`, `fetch`, `quality`, `clean`, `preview`, `delete` |
+| `api.platforms` | `list`, `create`, `get`, `status`, `query`, `suggest_rules`, `list_suggestions`, `graph` |
+| `api.predictions` | `predict`, `list_configs`, `create_config`, `train`, `list_predictions` |
+| `api.jobs` | `get` |
+
+## Job Polling
+
+Long-running operations (platform builds, data cleaning, training) return a `job_id`. Use `wait_for_job` to poll:
+
+```python
+job = api.wait_for_job(job_id, timeout=300, poll_interval=5)
+if job["status"] == "error":
+    print(f"Failed: {job.get('error_message')}")
+```
+
+## Error Handling
+
+```python
+from ambertraceai import AmbertraceAPI, AmbertraceError
+
+try:
+    api.domains.get(999)
+except AmbertraceError as e:
+    print(e.status_code)  # 404
+    print(e.code)         # "not_found"
+    print(str(e))         # "Domain not found."
+```
+
+## API Documentation
+
+Full API reference: [app.ambertrace.ai/openapi/redoc](https://app.ambertrace.ai/openapi/redoc)

ambertraceai-0.1.0/ambertraceai/__init__.py

@@ -0,0 +1,24 @@
+"""AmbertraceAI Python SDK"""
+
+from .client import AuthenticatedClient, Client
+from .convenience import (
+    AmbertraceAPI,
+    AmbertraceError,
+    DatasetResource,
+    DomainResource,
+    JobResource,
+    PlatformResource,
+    PredictionResource,
+)
+
+__all__ = (
+    "AmbertraceAPI",
+    "AmbertraceError",
+    "AuthenticatedClient",
+    "Client",
+    "DatasetResource",
+    "DomainResource",
+    "JobResource",
+    "PlatformResource",
+    "PredictionResource",
+)

ambertraceai-0.1.0/ambertraceai/api/__init__.py

@@ -0,0 +1 @@
+"""Contains methods for accessing the API"""

ambertraceai-0.1.0/ambertraceai/api/default/__init__.py

@@ -0,0 +1 @@
+"""Contains endpoint functions for accessing the API"""

ambertraceai-0.1.0/ambertraceai/api/default/api_keys_api_keys_get.py

@@ -0,0 +1,128 @@
+from http import HTTPStatus
+from typing import Any
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.api_keys_api_keys_get_response_200 import ApiKeysApiKeysGetResponse200
+from ...types import Response
+
+
+def _get_kwargs() -> dict[str, Any]:
+
+    _kwargs: dict[str, Any] = {
+        "method": "get",
+        "url": "/api/v1/api-keys",
+    }
+
+    return _kwargs
+
+
+def _parse_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> ApiKeysApiKeysGetResponse200 | None:
+    if response.status_code == 200:
+        response_200 = ApiKeysApiKeysGetResponse200.from_dict(response.json())
+
+        return response_200
+
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> Response[ApiKeysApiKeysGetResponse200]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    *,
+    client: AuthenticatedClient | Client,
+) -> Response[ApiKeysApiKeysGetResponse200]:
+    """List all API keys for the current organisation.
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[ApiKeysApiKeysGetResponse200]
+    """
+
+    kwargs = _get_kwargs()
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: AuthenticatedClient | Client,
+) -> ApiKeysApiKeysGetResponse200 | None:
+    """List all API keys for the current organisation.
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        ApiKeysApiKeysGetResponse200
+    """
+
+    return sync_detailed(
+        client=client,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: AuthenticatedClient | Client,
+) -> Response[ApiKeysApiKeysGetResponse200]:
+    """List all API keys for the current organisation.
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[ApiKeysApiKeysGetResponse200]
+    """
+
+    kwargs = _get_kwargs()
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    *,
+    client: AuthenticatedClient | Client,
+) -> ApiKeysApiKeysGetResponse200 | None:
+    """List all API keys for the current organisation.
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        ApiKeysApiKeysGetResponse200
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+        )
+    ).parsed

ambertraceai-0.1.0/ambertraceai/api/default/api_keys_api_keys_int_id_delete.py

@@ -0,0 +1,160 @@
+from http import HTTPStatus
+from typing import Any
+from urllib.parse import quote
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.validation_error_model import ValidationErrorModel
+from ...types import Response
+
+
+def _get_kwargs(
+    id: int,
+) -> dict[str, Any]:
+
+    _kwargs: dict[str, Any] = {
+        "method": "delete",
+        "url": "/api/v1/api-keys/{id}".format(
+            id=quote(str(id), safe=""),
+        ),
+    }
+
+    return _kwargs
+
+
+def _parse_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> list[ValidationErrorModel] | None:
+    if response.status_code == 422:
+        response_422 = []
+        _response_422 = response.json()
+        for response_422_item_data in _response_422:
+            response_422_item = ValidationErrorModel.from_dict(response_422_item_data)
+
+            response_422.append(response_422_item)
+
+        return response_422
+
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> Response[list[ValidationErrorModel]]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    id: int,
+    *,
+    client: AuthenticatedClient | Client,
+) -> Response[list[ValidationErrorModel]]:
+    """Revoke (deactivate) an API key.
+
+    Args:
+        id (int): Resource ID
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[list[ValidationErrorModel]]
+    """
+
+    kwargs = _get_kwargs(
+        id=id,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    id: int,
+    *,
+    client: AuthenticatedClient | Client,
+) -> list[ValidationErrorModel] | None:
+    """Revoke (deactivate) an API key.
+
+    Args:
+        id (int): Resource ID
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        list[ValidationErrorModel]
+    """
+
+    return sync_detailed(
+        id=id,
+        client=client,
+    ).parsed
+
+
+async def asyncio_detailed(
+    id: int,
+    *,
+    client: AuthenticatedClient | Client,
+) -> Response[list[ValidationErrorModel]]:
+    """Revoke (deactivate) an API key.
+
+    Args:
+        id (int): Resource ID
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[list[ValidationErrorModel]]
+    """
+
+    kwargs = _get_kwargs(
+        id=id,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    id: int,
+    *,
+    client: AuthenticatedClient | Client,
+) -> list[ValidationErrorModel] | None:
+    """Revoke (deactivate) an API key.
+
+    Args:
+        id (int): Resource ID
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        list[ValidationErrorModel]
+    """
+
+    return (
+        await asyncio_detailed(
+            id=id,
+            client=client,
+        )
+    ).parsed

ambertraceai-0.1.0/ambertraceai/api/default/api_keys_api_keys_post.py

@@ -0,0 +1,128 @@
+from http import HTTPStatus
+from typing import Any
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.api_keys_api_keys_post_response_200 import ApiKeysApiKeysPostResponse200
+from ...types import Response
+
+
+def _get_kwargs() -> dict[str, Any]:
+
+    _kwargs: dict[str, Any] = {
+        "method": "post",
+        "url": "/api/v1/api-keys",
+    }
+
+    return _kwargs
+
+
+def _parse_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> ApiKeysApiKeysPostResponse200 | None:
+    if response.status_code == 200:
+        response_200 = ApiKeysApiKeysPostResponse200.from_dict(response.json())
+
+        return response_200
+
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> Response[ApiKeysApiKeysPostResponse200]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    *,
+    client: AuthenticatedClient | Client,
+) -> Response[ApiKeysApiKeysPostResponse200]:
+    """Create a new API key. Returns the full key exactly once.
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[ApiKeysApiKeysPostResponse200]
+    """
+
+    kwargs = _get_kwargs()
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: AuthenticatedClient | Client,
+) -> ApiKeysApiKeysPostResponse200 | None:
+    """Create a new API key. Returns the full key exactly once.
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        ApiKeysApiKeysPostResponse200
+    """
+
+    return sync_detailed(
+        client=client,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: AuthenticatedClient | Client,
+) -> Response[ApiKeysApiKeysPostResponse200]:
+    """Create a new API key. Returns the full key exactly once.
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[ApiKeysApiKeysPostResponse200]
+    """
+
+    kwargs = _get_kwargs()
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    *,
+    client: AuthenticatedClient | Client,
+) -> ApiKeysApiKeysPostResponse200 | None:
+    """Create a new API key. Returns the full key exactly once.
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        ApiKeysApiKeysPostResponse200
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+        )
+    ).parsed