Soracom Flux

Bounding Box Action

The Bounding Box Action applies one or more bounding boxes to an image specified by URL and outputs a new image with the bounding boxes applied.

This action is typically used in combination with image acquisition or AI actions to define regions of interest within an image.

Configuration

In the Action Condition section, you can specify the conditions under which the action will be executed using the values (Message or Context) from the event source to the channel. For more details on the expressions you can input, refer to Use Expressions in Actions.

In this input field, you can enter expressions representing data related to the trigger that starts the Flux application (e.g., event.payload.temp) or data related to the channel where the action is added (e.g., payload.temp).

Configuring Bounding Box Action

Configure how bounding boxes are applied to the image.

• Image URL
  Specify the URL of the image to which bounding boxes will be applied.

  In this input field, you can enter expressions that reference data related to the trigger that starts the Flux application (for example, ${event.payload.imageUrl}) or data related to the channel where the action is added (for example, ${payload.imageUrl}).

  For details on supported expressions, refer to Use Expressions in Actions.

  For example, when using the Soracom Harvest Files event source, you can specify ${event.payload.presignedUrls.get} to apply bounding boxes to images uploaded to Soracom Harvest Files.

• Draw bounding boxes on image
  Click Draw bounding boxes on image to define bounding boxes by displaying a locally saved image and drawing bounding boxes directly on the image using the mouse.

  

• Bounding boxes
  Displays the list of configured bounding boxes, including the border color, X coordinate, Y coordinate, width, and height.

  You can configure multiple bounding boxes and edit each one individually.

  

  Click Add Box to add a new bounding box by specifying its border color and dimensions.

Output

Configure how the output of this action is handled. For details, refer to Enable Republishing of Action Output.

Output Data of the Action

The Bounding Box Action outputs metadata for the processed image, including a URL that can be used to download the image with bounding boxes applied.

Example

{
  "imageUrl": "https://flux-image-processor-action-output-jp.s3.ap-northeast-1.amazonaws.com/OP00335XXXXX/01KC09FXXXXX",
  "metadata": {
    "fileSize": 224274
  }
}