Python SDK for the AIR Backend API
Project description
AIR SDK
Python SDK for the AIR Backend API.
Installation
pip install air-sdk
Quick Start
import air
client = air.AIR(api_key="air_k1_...", base_url="http://localhost:8000")
# Standalone tools
keywords = client.keywords("dark matter and lensing", n=5, kw_type="aas")
enhanced = client.enhance("My research with https://arxiv.org/abs/2301.12345")
# Full research workflow
project = client.create_project("my-research", data_description="We study...")
idea = project.idea()
project.literature()
project.methods()
project.paper(journal="AAS")
review = project.review()
# File access
print(project.get_file("Iteration0/input_files/idea.md"))
print(project.list_files())
Configuration
Set AIR_API_KEY and optionally AIR_BASE_URL as environment variables, or pass them directly:
client = air.AIR(api_key="air_k1_...", base_url="https://api.example.com")
API Reference
AIR class
| Method | Description |
|---|---|
keywords(text, n=5, kw_type="unesco") |
Extract keywords |
arxiv(text) |
Download arXiv papers from URLs in text |
enhance(text, max_workers=2, max_depth=10) |
Enhance text with arXiv context |
ocr(file_path) |
Process PDF with OCR (server path) |
create_project(name, data_description, iteration) |
Create a project |
get_project(name) |
Get existing project |
list_projects() |
List all projects |
delete_project(name) |
Delete a project |
Project class
| Method | Description |
|---|---|
idea(mode="fast", timeout=600) |
Generate research idea |
literature(timeout=600) |
Run literature search |
methods(mode="fast", timeout=600) |
Develop methods |
paper(journal="NONE", timeout=900) |
Write paper |
review(timeout=600) |
Run review |
get_file(path) |
Read a project file |
list_files() |
List all project files |
write_file(path, content) |
Write a file |
delete() |
Delete the project |
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
ai_research-0.1.2.tar.gz
(14.2 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file ai_research-0.1.2.tar.gz.
File metadata
- Download URL: ai_research-0.1.2.tar.gz
- Upload date:
- Size: 14.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
93fd6733c77736500179242fe746f2d245c312dcf0a904a3d43bbfadc6b3ea78
|
|
| MD5 |
16aa09d191312ae3d32cc6c93c138af7
|
|
| BLAKE2b-256 |
59e5767a96c4f8b77a36d34eb0709586a78314d8fad01067b27df11c20561841
|
File details
Details for the file ai_research-0.1.2-py3-none-any.whl.
File metadata
- Download URL: ai_research-0.1.2-py3-none-any.whl
- Upload date:
- Size: 16.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
afb4166fe5ffab5cb8a74a931f1ca6b71a119611e7452567086a365660036f12
|
|
| MD5 |
1e2c16f6dab3e6c7423478d799a8567c
|
|
| BLAKE2b-256 |
4be98e7987d63b9e2eb64a03e29faa1eff1df4c239092fd4e9f596718fddd37c
|