Skip to content

/AWS1/CL_IOSEVENTDETECTION

Configuration for event detection enrichment on video time-series data.

Event detection generates embeddings from video data enabling natural language similarity search on events. This allows customers to:

  • Query video events using semantic search after enrichment completes
  • Find relevant video segments through natural language queries
  • Search across video time-series data stored in IoT SiteWise

You must specify the dataset, exactly one time-series identifier (timeSeriesId OR propertyAlias), and trim settings defining the video time window to process.

CONSTRUCTOR

IMPORTING

Required arguments:

iv_datasetid TYPE /AWS1/IOSID /AWS1/IOSID

The IoT SiteWise dataset ID containing the video time-series data to analyze. Query IoT SiteWise to discover available datasets in your workspace.

io_trimsettings TYPE REF TO /AWS1/CL_IOSENRCHMNTTRIMSTGS /AWS1/CL_IOSENRCHMNTTRIMSTGS

Time range settings defining which portion of the video time-series data to process. Required to ensure predictable processing time and prevent analyzing unbounded datasets. Start and end times must be within the dataset's time bounds.

Optional arguments:

iv_timeseriesid TYPE /AWS1/IOSTIMESERIESID /AWS1/IOSTIMESERIESID

Unique system identifier for the video time series to analyze. Specify either timeSeriesId or propertyAlias, but not both. Use this when you have the system-generated time series identifier from IoT SiteWise.

iv_propertyalias TYPE /AWS1/IOSASSETPROPERTYALIAS /AWS1/IOSASSETPROPERTYALIAS

Human-readable alias for the video time series to analyze (e.g., /camera/warehouse/zone-a). Specify either propertyAlias or timeSeriesId, but not both. Use this when you have configured friendly aliases in IoT SiteWise for better readability.

Queryable Attributes

datasetId

The IoT SiteWise dataset ID containing the video time-series data to analyze. Query IoT SiteWise to discover available datasets in your workspace.

Accessible with the following methods

Method Description
GET_DATASETID() Getter for DATASETID, with configurable default
ASK_DATASETID() Getter for DATASETID w/ exceptions if field has no value
HAS_DATASETID() Determine if DATASETID has a value

timeSeriesId

Unique system identifier for the video time series to analyze. Specify either timeSeriesId or propertyAlias, but not both. Use this when you have the system-generated time series identifier from IoT SiteWise.

Accessible with the following methods

Method Description
GET_TIMESERIESID() Getter for TIMESERIESID, with configurable default
ASK_TIMESERIESID() Getter for TIMESERIESID w/ exceptions if field has no value
HAS_TIMESERIESID() Determine if TIMESERIESID has a value

propertyAlias

Human-readable alias for the video time series to analyze (e.g., /camera/warehouse/zone-a). Specify either propertyAlias or timeSeriesId, but not both. Use this when you have configured friendly aliases in IoT SiteWise for better readability.

Accessible with the following methods

Method Description
GET_PROPERTYALIAS() Getter for PROPERTYALIAS, with configurable default
ASK_PROPERTYALIAS() Getter for PROPERTYALIAS w/ exceptions if field has no value
HAS_PROPERTYALIAS() Determine if PROPERTYALIAS has a value

trimSettings

Time range settings defining which portion of the video time-series data to process. Required to ensure predictable processing time and prevent analyzing unbounded datasets. Start and end times must be within the dataset's time bounds.

Accessible with the following methods

Method Description
GET_TRIMSETTINGS() Getter for TRIMSETTINGS