otai-base

Base package with core implementations for Open Ticket AI - ticket system automation and AI integration.

Overview

otai-base provides foundational abstractions and utilities for building Open Ticket AI plugins. It includes:

• Core data models using Pydantic v2 for type-safe ticket system operations
• Plugin interfaces for extending Open Ticket AI with custom ticket system integrations
• Template rendering with Jinja2 for dynamic content generation
• Unified ticket abstractions for working across multiple ticket systems

Installation

pip install otai-base

For development:

pip install otai-base[dev]

Usage

Creating a Plugin

from otai_base.base_plugin import BasePlugin

class MyTicketSystemPlugin(BasePlugin):
    name = "my-ticket-system"

    # Implement plugin interface methods

Using Core Models

from otai_base.models import UnifiedTicket, UnifiedEntity

ticket = UnifiedTicket(
    subject="Example Ticket",
    body="Ticket description",
    queue=UnifiedEntity(name="Support"),
    priority=UnifiedEntity(name="High"),
)

Features

• 🎯 Type-safe - Full type hints and Pydantic validation
• 🔌 Extensible - Plugin system for custom integrations
• 🎨 Template support - Jinja2 integration for dynamic content
• 🔄 Unified interface - Work with multiple ticket systems using a single API
• 🐍 Modern Python - Requires Python 3.13+

Documentation

Full documentation is available at open-ticket-ai.com.

Requirements

• Python 3.13 or higher
• Pydantic 2.11.7+
• Jinja2 3.1.0+

Contributing

Contributions are welcome! Please see the main repository for contribution guidelines.

License

LGPL-2.1-only - See LICENSE for details.

Related Packages

• open-ticket-ai - Core application
• otai-zammad - Zammad integration
• otai-otobo-znuny - OTOBO/Znuny integration
• otai-hf-local - Local AI model integration

Links

• Homepage: open-ticket-ai.com
• Repository: GitHub
• Issue Tracker: GitHub Issues
• PyPI: pypi.org/project/otai-base