Skip to main content

Official Python client for the Adaptive Context Layer (ACL)

Project description

ACL Python SDK (acl-core-py)

Official Python SDK for Adaptive Context Layer (ACL).

Installation

pip install acl-core-py

AI Agent Install And Infra Setup

Use this flow when agents/dev tools install and run ACL in production:

  1. Install SDK
pip install --upgrade acl-core-py
  1. Set environment variables (domain only, never raw server IP)
# Public ACL endpoint behind your domain/reverse proxy
export ACL_BASE_URL="https://backend.yourcompany.com"

# Org-scoped ACL key from ACL dashboard
export ACL_API_KEY="acl_live_xxx"

# Provider key stays only with your app/agent runtime
export OPENAI_API_KEY="sk-xxx"
  1. Initialize client using env vars
import os
from acl import ACLClient

client = ACLClient(
    api_key=os.environ["ACL_API_KEY"],
    base_url=os.environ["ACL_BASE_URL"],
)

Security notes:

  • Do not hardcode keys in source code.
  • Do not expose EC2/public IP in SDK config; always use DNS/domain.
  • Rotate keys immediately if logs/screenshots accidentally leak them.
  • Keep backend behind TLS (https) and firewall to trusted ports only.

Quick Start

from acl import ACLClient

client = ACLClient(api_key="acl_live_...")

result = client.complete(
    prompt="Summarize this incident report.",
    model="gpt-4o",
    llm_api_key="sk-...",
    max_retries=3,
)

if result["success"]:
    print(result["response"])
else:
    print(f"{result['error_code']}: {result['error_message']}")

Latency Controls (v1.9.0)

ACLClient(...) supports these runtime options:

  • emit_post_completion_telemetry (default: True): post-completion telemetry is now non-blocking.
  • precheck_cache_ttl_s (default: 20.0): short TTL cache for adaptive precheck calls.
  • precheck_cache_max_entries (default: 256): max in-memory precheck cache entries.

Every complete() response now includes timing metadata under metadata.acl_timing:

  • precheck_ms
  • provider_ms
  • post_telemetry_ms
  • wall_clock_ms

Runtime Contract

complete() always returns a stable top-level response shape on both success and failure:

  • success
  • error_code
  • error_message
  • provider
  • model
  • text and response

Validation and Safety

  • Fail-fast validation for invalid/missing prompt, unresolved model, missing keys, and malformed provider key formats.
  • Strict provider payload allowlist prevents internal ACL params from leaking to provider APIs.
  • Secrets are redacted from surfaced error messages by default.
  • Default ACL backend base URL: http://backend.fridayaicore.in.

Retry Behavior

  • Retries happen in SDK provider execution middleware (complete() path).
  • Exponential backoff with jitter and cap:
  • attempt 1: random delay 0-0.5s
  • attempt 2: random delay 0-1s
  • attempt 3: random delay 0-2s
  • max cap per attempt: 8s

Compatibility Policy

  • Python: >=3.8
  • Runtime dependencies: requests, urllib3, typing_extensions
  • Release policy: include migration notes whenever response contract or validation behavior changes.

Usage Terms

  • This SDK is proprietary and licensed for ACL service access only.
  • A valid ACL API key is required.
  • Redistribution, resale, sublicensing, and derivative redistribution are not permitted without written approval from ACL Team.

License

UNLICENSED / Proprietary. See LICENSE.

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

acl_core_py-1.9.1.tar.gz (26.3 kB view details)

Uploaded Source

Built Distribution

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

acl_core_py-1.9.1-py3-none-any.whl (33.6 kB view details)

Uploaded Python 3

File details

Details for the file acl_core_py-1.9.1.tar.gz.

File metadata

  • Download URL: acl_core_py-1.9.1.tar.gz
  • Upload date:
  • Size: 26.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.9

File hashes

Hashes for acl_core_py-1.9.1.tar.gz
Algorithm Hash digest
SHA256 1a5123bcd8f19c7455cda4d19f05e570bf4961536d757172c94c0add1c0a5154
MD5 81206e0d5898dba1799ea161aeff71e2
BLAKE2b-256 652c9c5d36c3a25d9edb843f5d33096e9365a97c95f759d4164da266280f605b

See more details on using hashes here.

File details

Details for the file acl_core_py-1.9.1-py3-none-any.whl.

File metadata

  • Download URL: acl_core_py-1.9.1-py3-none-any.whl
  • Upload date:
  • Size: 33.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.9

File hashes

Hashes for acl_core_py-1.9.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ac0cf5388ce6ee173cb5985cb51959e641ce1cc381336274b6fb6338587c2ebc
MD5 6ac4a31564d51236438a10e6a4306cae
BLAKE2b-256 c033fc9d4c2b31e99bf3518ea0bbe54a079476c40be5927e9da6cd3fdd02130d

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