Skip to main content

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


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.0.tar.gz (6.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ai_research-0.1.0-py3-none-any.whl (7.7 kB view details)

Uploaded Python 3

File details

Details for the file ai_research-0.1.0.tar.gz.

File metadata

  • Download URL: ai_research-0.1.0.tar.gz
  • Upload date:
  • Size: 6.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for ai_research-0.1.0.tar.gz
Algorithm Hash digest
SHA256 5e9284a2a98a56e70841db9322a895211cf88ede046cadfa5a3bc029cbb4cbb0
MD5 9575b4762a675842c0407c55d0d068b1
BLAKE2b-256 1bcae67727bce2c272eeeb0d595a78ab888447f5f78fbb77f36c9191e934a42c

See more details on using hashes here.

File details

Details for the file ai_research-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: ai_research-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 7.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for ai_research-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7687fedc4541d88379af678fcd46c0aa8980ddd17937ec0f251546970f7541ea
MD5 79ef62f3133093cd92a928af78ead433
BLAKE2b-256 be67d43e2ade523a510e156d73cfd8547fac4a6db167b040d6540e953e2d3e83

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page