Skip to main content

AI-powered natural language to REST API translation. LLM tool calling (OpenAI default, Anthropic optional), zero hardcoding.

Project description

Enable AI

Natural language to REST API translation using LLM tool calling.

Zero hardcoding - works with any OpenAPI spec. Parent module provides all configuration.

Installation

pip install enable-ai

# For Anthropic/Claude support:
pip install enable-ai[anthropic]

Quick Start

from enable_ai_v2 import Orchestrator, Config, JWTAuth

config = Config(
    openapi_schema="path/to/openapi.json",  # or dict
    base_url="https://api.example.com",
    # llm_provider="openai",  # default
    # llm_provider="anthropic",  # optional
)

ai = Orchestrator(
    config=config,
    auth=JWTAuth(token="your-jwt-token"),
)

result = ai.process("show all pending orders")
print(result.message)

Features

  • LLM tool calling - OpenAPI spec converted to LLM tools (OpenAI default, Anthropic optional)
  • Server-side scoping - doesn't inject user filters; server's get_queryset() handles permissions
  • Resource hints - status values, enums from your API for better accuracy
  • Status synonyms - map natural language ("pending") to actual values ("DRAFT")
  • Query caching - exact match + pattern match for fast repeat queries
  • Progress tracking - real-time callbacks for UI updates

Configuration

Parent module provides everything:

from enable_ai_v2 import (
    Config,
    ResourceHint,
    UserContext,
    build_resource_hints_from_api,
    build_status_synonyms,
)

# Fetch from your APIs (parent module's responsibility)
openapi_schema = your_api.get_schema()
statuses = your_api.get_service_order_statuses()
priorities = your_api.get_service_order_priorities()

config = Config(
    # Required
    openapi_schema=openapi_schema,
    base_url="https://api.example.com",

    # Recommended (for accuracy)
    resource_hints=build_resource_hints_from_api(
        openapi_schema,
        statuses,
        priorities,
    ),
    status_synonyms=build_status_synonyms(statuses),

    # Optional
    # Optional
    model="gpt-4o",  # default; or "claude-sonnet-4-20250514" with llm_provider="anthropic"
    temperature=0.0,
    cache_enabled=True,
    include_trace=False,  # True for debugging
)

User Context

Parent module provides user context (doesn't fetch from APIs):

from enable_ai_v2 import UserContext

user_ctx = UserContext(
    user_id=123,
    username="john.doe",
    role="Technician",
    company_id=456,
    is_admin=False,
)

result = ai.process("show my orders", user_context=user_ctx)

Authentication

from enable_ai_v2 import JWTAuth, APIKeyAuth, BasicAuth, NoAuth

# JWT (most common)
auth = JWTAuth(token="your-jwt-token")

# API Key
auth = APIKeyAuth(api_key="your-api-key", header_name="X-API-Key")

# Basic Auth
auth = BasicAuth(username="user", password="pass")

# No auth
auth = NoAuth()

ai = Orchestrator(config=config, auth=auth)

Progress Tracking

def on_progress(message: str, progress: float):
    print(f"[{int(progress*100)}%] {message}")

config = Config(
    openapi_schema=schema,
    base_url="https://api.example.com",
    progress_callback=on_progress,
)

Response

result = ai.process("show pending orders")

result.message   # Natural language response
result.data      # Raw API data
result.success   # True/False
result.trace     # Debug info (if include_trace=True)

Key Principle

Server handles data scoping. The system prompt instructs Claude:

Do NOT add user ID filters (like technician=, customer=, created_by=) unless the user explicitly asks to filter by a specific person.

Your backend's get_queryset() permissions handle which data each user sees.

Requirements

  • Python 3.9+
  • OPENAI_API_KEY environment variable (default provider)
  • Or ANTHROPIC_API_KEY if using llm_provider="anthropic"

License

MIT

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

enable_ai-1.2.2.tar.gz (48.9 kB view details)

Uploaded Source

Built Distribution

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

enable_ai-1.2.2-py3-none-any.whl (57.2 kB view details)

Uploaded Python 3

File details

Details for the file enable_ai-1.2.2.tar.gz.

File metadata

  • Download URL: enable_ai-1.2.2.tar.gz
  • Upload date:
  • Size: 48.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.2.1 CPython/3.9.6 Darwin/25.2.0

File hashes

Hashes for enable_ai-1.2.2.tar.gz
Algorithm Hash digest
SHA256 16f2b3f519e84cb607b414f20ecd9e248167d20233a6ca5637817ba418adac00
MD5 269263589c530b502eea72c2253ffd94
BLAKE2b-256 1e652247be4af085dd5a52b933cc97c4339c057609991a27061ae698c3820b75

See more details on using hashes here.

File details

Details for the file enable_ai-1.2.2-py3-none-any.whl.

File metadata

  • Download URL: enable_ai-1.2.2-py3-none-any.whl
  • Upload date:
  • Size: 57.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.2.1 CPython/3.9.6 Darwin/25.2.0

File hashes

Hashes for enable_ai-1.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 e29d89e7ac88fb77c6e290cbc053156f83efcc8b679c197868a190a8f23e486c
MD5 0c17b6533a205f48a7c706d39197be82
BLAKE2b-256 d424b927aa4b4d09ca8278fe3b3c04f04d69d80c054b1027db673114731ecc5a

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