Skip to main content

Actions and Interface Object Notation: An open standard for LLM tools.

Project description

AIONS: Actions and Interface Object Notation

AIONS (pronounced IONS) is an open-standard, text-based data format designed specifically for AI Large Language Models (LLMs). It allows developers to decouple tool definitions from core logic, making AI "Actions" as portable as JSON but as powerful as native Python.

🛠 Why AIONS?

Traditional AI tool registration often involves bloating your Python files with massive strings for descriptions and repetitive boilerplate. AIONS solves this by:

  • Decoupling: Move your LLM prompts (descriptions) and tool mappings into external .aion files.
  • Dynamic Evaluation: Supports native Python lambdas and complex logic directly within the notation.
  • Strict Validation: Enforces a rigid property schema to prevent "ghost tools" or broken agent execution.
  • Zero-Map Architecture: No need to maintain manual dictionaries; if it’s in the .aion file, it’s in your Agent.

📜 The Laws of AIONS

To maintain the "Open Standard" integrity, every .aion file must adhere to the following rules:

1. The Array Constraint

An AIONS definition must always be an array, enclosed in square brackets [ ]. Even if you are defining a single tool, it must reside within an array.

2. The Arrow Operator

Properties are assigned using the "Action-Link" operator: -->.

  • Valid: name --> "MyTool"
  • Invalid: name: "MyTool" or name = "MyTool"

3. Property Isolation

AIONS strictly enforces identified properties. If the parser encounters a top-level key that is not in the Approved Registry, it will throw an AIONPropertyError.

  • Approved Registry: name, function, description, args_schema.

4. The Function Block

The function property is a "Smart Property." It requires a raw string representing the executable (lambda or function name) followed by an "Interface Block" { } describing the inputs and outputs.

  • Inputs must follow the arg-N pattern.
  • Outputs must follow the return-N pattern.

📂 Syntax Example

📝 AIONS Syntax Guide

The AIONS (Actions and Interface Object Notation) syntax is designed to be strictly structural yet human-readable. It follows a specific set of rules to ensure LLM compatibility and execution safety.

1. Global Wrapper

All tool definitions must be contained within a root-level array: [ ... ]

2. Tool Objects

Individual tools are defined as objects within curly braces: { ... }

3. The Action-Link Operator (-->)

AIONS uses the --> operator to map keys to values. Standard colon : or equals = assignments are invalid and will trigger a parse error.

4. Top-Level Properties

Every tool object must contain the following identified properties:

  • name: The unique identifier for the tool.
  • function: The executable logic and interface mapping.
  • args_schema (Optional): The Pydantic class name for input validation.
  • description: The natural language instruction for the LLM.

5. The Smart Function Block

The function property is split into two parts:

  1. Executable String: The lambda or function name (e.g., "lambda x: func(x)").
  2. Interface Block: A nested {} mapping that defines parameters and returns.

💡 Syntax Template:

{
    name --> "Unique_Tool_Name",
    function --> "executable_python_logic" --> {
                                                    arg-1 --> "Input description",
                                                    return-1 --> "Output description"
                                               },
    args_schema --> "PydanticClassName",
    description --> "Detailed prompt for the AI agent"
}

Example

{
   name --> "send_output",
   function --> "lambda user: send_output(user)" --> {
                                                        arg-1 --> "string",
                                                        return-1 --> "dict"
                                                     },
   args_schema --> "some_schema",
   description --> "This is the prompt that describes the function."
  },

🚀 Getting Started

  1. Project Structure Keep your tools organized. We recommend an aion_tools/ directory for modularity.
from aions import AIONS
import api_functions
from schemas import SendLikeInput

# 1. Load your tools with context
# 'globals()' allows AIONS to find your imported functions and schemas in memory
tools = AIONS.get_langchain_tools(
    source_path="aion_tools/", 
    context=globals()
)

# 2. Pass them directly to your Agent
# agent = initialize_agent(tools, llm, ...)

2. Integration with LangChain

AIONS is built to be a first-class citizen in the LangChain ecosystem.

from aions import AIONS
import api_functions
from schemas import SendLikeInput

# 1. Load your tools with context
# 'globals()' allows AIONS to find your imported functions and schemas
tools = AIONS.get_langchain_tools(
    source_path="aion_tools/", 
    context=globals()
)

# 2. Pass them directly to your Agent
# agent = initialize_agent(tools, llm, ...)

⚖️ Error Handling

AIONS is designed to fail fast. This prevents your AI Agent from attempting to use a tool that was configured incorrectly.

Error Cause
AIONPropertyError Using an unauthorized key (e.g., using desc instead of description).
AIONParseError Syntax errors, missing brackets, or function strings that don't exist in your Python code.

AIONS: Actions and Interface Object Notation

AIONS (pronounced IONS) is an open-standard, text-based data format designed specifically for AI Large Language Models (LLMs). It allows developers to decouple tool definitions from core logic, making AI "Actions" as portable as JSON but as powerful as native Python.

🛠 Extending the Framework

The AIONS class provides several utility methods for different workflows:

load_dir(path, context): Automatically stitches together all .aion files in a folder.

dumps(list_of_tools): Converts existing Python tool dictionaries into the AIONS standard text format.

get_langchain_tools(...): The high-level factory for instant LangChain mounting.

🤝 Contributing

AIONS is an open standard. Feel free to fork the framework and add support for other LLM frameworks.

📦 Installation

pip install aions-llm

Developed by Sourav Modak

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

aions_llm-1.0.2.tar.gz (5.9 kB view details)

Uploaded Source

Built Distribution

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

aions_llm-1.0.2-py3-none-any.whl (5.9 kB view details)

Uploaded Python 3

File details

Details for the file aions_llm-1.0.2.tar.gz.

File metadata

  • Download URL: aions_llm-1.0.2.tar.gz
  • Upload date:
  • Size: 5.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.20

File hashes

Hashes for aions_llm-1.0.2.tar.gz
Algorithm Hash digest
SHA256 3801b5e1afd6abc6195d8e5d68761f2fe8d83598551b2a011431b2c9a82d5faa
MD5 d6c7a1a7ef335450b4e73a97ac351c99
BLAKE2b-256 aa6cf6cba007ca41c9ff8be372994dedc351cbd2cd4b39528bfad080d636c4b2

See more details on using hashes here.

File details

Details for the file aions_llm-1.0.2-py3-none-any.whl.

File metadata

  • Download URL: aions_llm-1.0.2-py3-none-any.whl
  • Upload date:
  • Size: 5.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.20

File hashes

Hashes for aions_llm-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 1f2c85920f9e4e2b0e784cdc09849c1ff81e0949d66b6a65e46a58a03004d409
MD5 9b757354215c70d1f8a84d431355cf4f
BLAKE2b-256 f0b2f1405bb578819c7e945e4caafac826ff9fab6bad774b099d0370bcea53ee

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