Skip to main content

Universal AI interaction library with session and tool support

Project description

Interactor

A modular AI interaction framework with streaming, tool calling, context history, session management, retry/backoff logic, multi-provider support, and optional real-time logging.

Built for testability, extensibility, and CLI or programmatic use.

Features

  • Supports OpenAI, Ollama, NVIDIA, Google (Gemini), Anthropic out-of-the-box
  • Streamed output with markdown rendering
  • Tool calling with auto-registration from Python functions
  • Token-aware message cycling (to respect context limits)
  • Persistent sessions with metadata and CRUD via session.py
  • Optional per-instance logging of all interactions
  • Retry logic for rate-limiting and transient failures
  • CLI runner with interactive loop and safe shell command execution

Installation

To install directly from GitHub:

pip install git+https://github.com/woodyk/interactor.git#egg=interactor

Or clone locally and install for development:

git clone https://github.com/woodyk/interactor.git
cd interactor
pip install -e .

Requirements

Defined in requirements.txt:

  • openai
  • aiohttp
  • tiktoken
  • rich

Usage (CLI)

After installing:

interactor

Command-line options:

  • --model: Model in format provider:model (e.g., openai:gpt-4o)
  • --api-key: Optional override (default uses env var)
  • --base-url: Optional custom API base
  • --tools: Enable tool calling
  • --stream: Stream assistant replies
  • --markdown: Render streamed output as markdown

Use /exit or /quit to end the session.

Usage (Python)

from interactor import Interactor, Session

inter = Interactor(
    model="openai:gpt-4o",
    session_enabled=True,
    session_path="~/.interactor_sessions",
    log_path="~/interactor.log"
)

def say_hello(name: str) -> str:
    return f"Hello, {name}!"

inter.add_function(say_hello)

reply = inter.interact("Please greet Ada.")
print(reply)

Session Support

Sessions are JSON files stored on disk.

You can:

  • List and load sessions
  • Create branches from message midpoints
  • Search and update content
  • Automatically summarize a session with interactor.summarize()

Logging

To enable logging:

inter = Interactor(..., log_path="~/my_session.log")

Logs include:

  • User and assistant messages
  • Tool call arguments and results
  • Model switches, session transitions
  • Retry events and exceptions

License

Copyright (c) Wadih Khairallah. All rights reserved.

Licensed for use and modification under the MIT 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

ai_interactor-0.1.2.2.tar.gz (184.2 kB view details)

Uploaded Source

Built Distribution

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

ai_interactor-0.1.2.2-py3-none-any.whl (35.2 kB view details)

Uploaded Python 3

File details

Details for the file ai_interactor-0.1.2.2.tar.gz.

File metadata

  • Download URL: ai_interactor-0.1.2.2.tar.gz
  • Upload date:
  • Size: 184.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.3

File hashes

Hashes for ai_interactor-0.1.2.2.tar.gz
Algorithm Hash digest
SHA256 e4ed609a4f995414f213cf9d4b1dfce08b2773146c5f3165799c9cf4696ebdc5
MD5 6cb4c3ca9e8f030bbf3141d14e281f00
BLAKE2b-256 7fb7fbadb90e38fdd8ecaf21dc51a564524696635f5cb0a76e90fb8b79aefaa6

See more details on using hashes here.

File details

Details for the file ai_interactor-0.1.2.2-py3-none-any.whl.

File metadata

File hashes

Hashes for ai_interactor-0.1.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 c2d78620e742467a69e2fbdea1d8dbc1e44dffa14b7bd1d03e67c4ee68c3d151
MD5 8cbb549022fe1d246676625125aa95c9
BLAKE2b-256 07bc9620e3e4b6b7d32b3f8133e6c7438fc171be9ed606673822c25c3101a1a8

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