Placement

Use task_type placement with geometry and a goal to produce placement recommendations.

What it answers

Where can this go, given the space and the goal?

task_type: placement

What to send

input.object_idstring

The object to place.

input.goalobject

Target state, region, or objective to satisfy.

input.cad_sceneobject

The scene it is being placed into.

Every field on the request schema is still accepted; these are the ones this task depends on.

What comes back

placement_result.candidates

Ranked positions and orientations.

placement_result.clearances

Per-candidate measured clearance.

placement_result.rejected

Positions ruled out, with the reason.

Example

Terminal

$ curl https://fourechelon.com/api/v1/responses \
    -H "Authorization: Bearer $FOUR_ECHELON_API_KEY" \
    -H "Content-Type: application/json" \
    -d '{
$     "model": "rowe-1.0",
$     "input": {
$       "task_type": "placement",
$       "object_id": "sensor",
$       "goal": { "objective": "maximize_clearance" },
$       "cad_scene": { "schema": "four-cad.cad_scene.v1", "solids": [] }
$     }
$   }'

Worth knowing

Supply a goal. Without one the task has no objective to rank candidates against and will return the geometrically valid set in arbitrary order.