Augmented Operations Management API (1.0.0)

Overview

This API provides backend services for the Augmented Decision Making application, focusing on the efficient scheduling and assignment of tasks Operations to a given Resources.

The system models the following key entities:

• Locations: Representing physical areas
• Resources: Specific assignable assets within a location.
• Tasks: Represent individual events, jobs. Tasks include detailed time information (planned, expected, actual) and model uncertainty using statistical parameters (sigma, skew factor, distribution mean/earliest/latest). Tasks also support versioning to track updates.
• Operations: Represent a complete operation, linking an inbound task to an outbound task. Operations contain relevant metadata.
• Assignments: Link an Operation to a specific Resource for a given time period.
• Tags: Can be used to restrict possible assignments as well as indicate preferences or penalties.
• Rules: Can be used to specify preferences or penalties in conjunction with the tagging mechanism.

Core Functionality

The API enables users and automated systems to:

1. Manage Data: Perform CRUD operations on Locations, Resources, Tasks, Operations, and Assignments.
2. Track Operations Times: Handle various time representations and update task details, including imposing delays. Task updates create new versions, preserving history.
3. Assignments: Assign or reassign operation to resources.
4. Detect Conflicts: Identify situations where an assigned conflicting (overlapping) with another based on their expected time windows.
5. Resolve Conflicts: Offer mechanisms to resolve individual scheduling conflicts through AI.
6. Optimize Globally: Offer global optimization of the schedule using various solvers to minimize conflicts and reassignments while optimizing for rules.
7. AI Assistance: Interact with an AI agent (via the /agent/ endpoint) using natural language to query the schedule, identify conflicts, request moves, or trigger conflict resolution processes. The agent utilizes specialized tools to interact with the system's state.
8. Real-time Updates: Delivers real-time notifications about changes to Assignments and Operations via WebSockets to subscribed clients.
9. Virtual State Management: Allows temporary modifications to the schedule (virtual assignments) for "what-if" scenarios or agent-driven planning before potentially persisting changes.