Result Schema

Results represent individual objective satisfaction checks in the optimization process.

Schema

{
    "id": 123,
    "created_at": "2025-01-31T10:00:00.000Z",
    "updated_at": "2025-01-31T10:00:00.000Z", 
    "disabled_at": null,
    "number": 0,
    "objective": 1.0,
    "objective_type": "exact",
    "minimum_bound": 0.0,
    "maximum_bound": 0.0,
    "output": 0.98,
    "error": 0.02,
    "detail": "Error explanation",
    "satisfied": true
}

Fields

Field
Type
Required
Description

id

integer

Yes

Unique identifier

created_at

string

Yes

Creation timestamp

updated_at

string

Yes

Last update timestamp

disabled_at

string

No

Disable timestamp

number

integer

Yes

Objective number (>= 0)

objective

float

Yes

Target objective value

objective_type

string

Yes

Type of objective check

minimum_bound

float

Yes

Lower bound (0.0 for exact)

maximum_bound

float

Yes

Upper bound (0.0 for exact)

output

float

Yes

Actual output value

error

float

Yes

Error from target

detail

string

No

Explanation message

satisfied

boolean

Yes

Whether objective is satisfied

Objective Types

The objective_type field must be one of:

  • exact

  • percent

  • value

  • lessthan

  • lessthan_equal

  • greaterthan

  • greaterthan_equal

  • minimize

  • maximize

Error Calculation

Error values are calculated differently based on objective type:

  • exact: Absolute difference from target

  • percent: Percentage difference from target

  • value: Absolute difference within bounds

  • lessthan/greaterthan: Distance to constraint violation

Satisfaction Rules

When an objective is considered satisfied:

  1. exact

    • Error less than specified L1 norm

  2. percent

    • Error within percentage bounds

  3. value

    • Error within absolute bounds

  4. lessthan/lessthan_equal

    • Output below/at target

  5. greaterthan/greaterthan_equal

    • Output above/at target

  6. minimize/maximize

    • Any value (tracks progress)

Last updated