Type of each objective (exact, percent, value, lessthan, etc.)
minimumBounds
array of numbers
Minimum acceptable values for each objective
maximumBounds
array of numbers
Maximum acceptable values for each objective
inverses
List of inverse optimization steps
Stop Reason Values
Value
Name
Description
0
RUNNING
Optimization is still running or being evaluated
1
SATISFIED
Optimization found a satisfactory input and output
2
STOPPED
Optimization stopped due to duplicate suggested inputs
3
EXHAUSTED
Optimization exhausted all attempts to converge
Objective Types
Type
Description
exact
Objective must be exactly the target value
percent
Objective is specified as a percentage
value
Objective is specified as an absolute value
lessthan
Objective must be less than the target value
lessthan_equal
Objective must be less than or equal to the target value
greaterthan
Objective must be greater than the target value
greaterthan_equal
Objective must be greater than or equal to the target value
minimize
Objective should be minimized
maximize
Objective should be maximized
SDK Representations
JavaScript SDK
In the JavaScript SDK, the Objective object uses snake_case naming for fields, translating from the API's camelCase:
{
id: 321,
created_at: Date("2025-01-31T10:00:00.000Z"), // Converted to Date object
updated_at: Date("2025-01-31T10:00:00.000Z"), // Converted to Date object
disabled_at: null,
optimal_inverse: null, // Will be an Inverse object if present
attempt_count: 10,
stop_reason: 1,
desired_l1_norm: 0.05,
objectives: [1500000, 850000],
objective_types: ["maximize", "minimize"],
minimum_bounds: [1000000, 700000],
maximum_bounds: [2000000, 1000000],
inverses: [
// Inverse objects
],
// Additional computed properties
get iterationCount() { /* Returns number of inverses */ },
get lastInverse() { /* Returns the last inverse in the array */ }
}
Python SDK
The Python SDK also uses snake_case naming and converts timestamps to datetime objects:
Objective(
id=321,
created_at=datetime(2025, 1, 31, 10, 0, 0), # Converted to datetime object
updated_at=datetime(2025, 1, 31, 10, 0, 0), # Converted to datetime object
disabled_at=None,
optimal_inverse=None, # Will be an Inverse object if present
attempt_count=10,
stop_reason=StopReason.SATISFIED, # Enum value
desired_l1_norm=0.05,
objectives=[1500000, 850000],
objective_types=[ObjectiveType.MAXIMIZE, ObjectiveType.MINIMIZE], # Enum values
minimum_bounds=[1000000, 700000],
maximum_bounds=[2000000, 1000000],
inverses=[
# Inverse objects
],
# Properties
@property
def iteration_count(self): # Returns number of inverses
@property
def last_inverse(self): # Returns the last inverse in the array
)
PHP SDK
The PHP SDK maintains camelCase naming to match the API and converts timestamps to DateTimeImmutable objects:
Objective(
id: 321,
createdAt: DateTimeImmutable("2025-01-31T10:00:00.000Z"),
updatedAt: DateTimeImmutable("2025-01-31T10:00:00.000Z"),
disabledAt: null,
optimalInverse: null, // Will be an Inverse object if present
number: 1, // Note: PHP SDK has an additional 'number' field not in other SDKs
attemptCount: 10,
stopReason: StopReason::Satisfied, // Enum value
desiredL1Norm: 0.05,
objectives: [1500000, 850000],
objectiveTypes: [ObjectiveType::Maximize, ObjectiveType::Minimize], // Enum values
minimumBounds: [1000000, 700000],
maximumBounds: [2000000, 1000000],
inverses: [
// Inverse objects
],
// Computed properties (via __get)
iterationCount: // Returns number of inverses
lastInverse: // Returns the last inverse in the array
)