API Reference#
The DecisionAI Client provides a comprehensive framework for building, managing, and solving optimization problems through an intuitive Python interface.
Client#
🔐 Authentication & Configuration
The main entry point for connecting to DecisionAI services. Handle authentication, configure settings, and manage your DecisionAI workspace.
DecisionAI Client - Initialize connections and manage authentication → See Client Documentation
Chat#
💬 Interactive Problem Solving
Engage in real-time conversations with DecisionAI to build, refine, and solve optimization problems through natural language.
Chat Sessions - Start and manage problem-solving conversations → See Chat Session Management
Real-time Connection - Stream responses via Server-Sent Events (SSE) → See Connection Details
Message Handling - Process user inputs, assistant responses, and tool interactions → See Message Types
Session State - Track conversation progress and maintain context → See Session State
Modeling#
🔧 Build Optimization Models
Create structured optimization problems using Python classes. Define your problem components, constraints, and objectives programmatically.
Model Definition - Base classes for creating optimization problems → See Model Classes
Input Data - Structure and validate your problem data → See Input Data
Variables - Define decision variables with constraints and bounds → See Variables
Solutions - Access and interpret optimization results → See Solutions
Decorators - Enhance models with validation and metadata → See Decorators
Components - Reusable building blocks for complex models → See Components
Types & Utilities#
🛠️ Helper Functions & Types
Common utilities, type definitions, and helper functions to streamline your DecisionAI development experience.
Type Definitions - Common types and interfaces → See Types & Utilities
🚧 Note: Additional internal components exist but are not intended for direct use. The components above provide the complete public API for the DecisionAI Client.