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.4.tar.gz (184.3 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.4-py3-none-any.whl (35.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ai_interactor-0.1.2.4.tar.gz
  • Upload date:
  • Size: 184.3 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.4.tar.gz
Algorithm Hash digest
SHA256 f14f57581160e1c0c7c3b4bd22bf80e4bdccc3dd421e703b184d0efee2a599a0
MD5 7415a17f70e4dd4c39b3d77e2dd16d7a
BLAKE2b-256 d07043e59d1282ef7257e885378b189215b82cdda06a16fc65367d7d553a6998

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ai_interactor-0.1.2.4-py3-none-any.whl
Algorithm Hash digest
SHA256 bbc8bcc024ab4ddbb4abf648cf4bedcbd095eb701ae355b1f54d752189715bc2
MD5 30aa4e2208e64a51d54f1c8d6c2921bc
BLAKE2b-256 5b09fd38f51e24514da4f3c599abc042f9728da520cb250c9ce03bb37d94be0f

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