Intervention requests give your robot the ability to request user input to determine a course of action. You can add intervention requests to your robot's logic via the Formant Agent SDK.

Selection request

You can use a selection request to prompt a user to select from a list of options.

Example

Your robot is moving along a route and detects an obstacle. It stops in its path and prompts the user, "Is this obstacle dangerous?"

If the user answers Yes the robot holds in place for 30 seconds, and then checks its surroundings again.

If the user answers No the robot continues along its path.

Labeling request

You can use a labeling request to prompt the user to draw a boundary around an object and provide a label for that object. You'll be able to use both the label provided by the user and the coordinates of each point of the boundary.

Example

Your robot is selecting and sorting objects from a bin. It detects several different types of objects. It prompts the user, "Draw a boundary around the object you want me to select, and give it a label."

The user draws a box around the object to select and gives it a label. Using the coordinates of the box drawn by the user, the robot determines which object to select, and sorts it according to its label.

API reference

Getting a list of intervention requests

GET https://api.formant.io/v1/admin/intervention-requests

Creating a new intervention request

POST https://api.formant.io/v1/admin/intervention-requests

{
    "message": "A teleop for a customer is requested",
    "interventionType": "teleop",
    "time": "2022-02-17T11:41:33.389-08:00",
    "deviceId": "b306de84-33ca-4917-9218-f686730e24e0",
    "tags": {},
    "data": {
        "instruction": "Look at the users item on the table"
    }
}

Adding response to intervention request

POST https://api.formant.io/v1/admin/intervention-responses

{
    "interventionId": "518e24fc-64ef-47bb-be5e-036a97aeafaa",
    "interventionType": "teleop",
    "data": {
        "state": "success",
        "notes": "looks good!"
    }
}

Example

For an example of how to implement intervention requests in the Agent SDK, see this sample code on our GitHub page.