eventanalytics.clients package

Submodules

eventanalytics.clients.event_operations_client module

Event Analytics API

Provides the essential functionality for a data-driven analysis of the event data. # noqa: E501

class EventOperationsClient(rest_client_config=None, mindsphere_credentials=None)

Bases: object

count_events(request_object)

Determines the number of events for a required time resolution.

The microservice takes as an input the entire dataset and the time resolution (example 100ms). The micro service will output the given time interval (startTime, endTime) and the resulted number of event occurrences.

Parameters:request_object (CountEventsRequest) – It contains the below parameters –>
( data* - Data structure with two parts <b>eventsMetadata</b>, <b>events</b>. <ul> <li> <b>eventsMetadata</b> Metadata for the events list specifying the property name of the item in the events list that contains the text of the event (<b>eventTextPropertyName</b>) and time window length in miliseconds of the period in which time interval will be split (<b>splitInterval</b>).</li> <li> <b>events</b> List with the events that will be processed.</li> </ul> ) Returns:EventCountOutput

filter_events(request_object)

Simplifies the dataset to the most meaningful data

Filtering the dataset based on the text of the event

Parameters:request_object (FilterEventsRequest) – It contains the below parameters –>
( data* - Data structure with three parts - <b>eventsMetadata</b>, <b>filterList</b>, and <b>events</b>.<ul> <li> <b>eventsMetadata</b> Metadata for the events list specifying the property name of the item in the events list that contains the text of the event. </li> <li> <b>filterList</b> Types of events to be removed </li> <li> <b>events</b> List with the events that will be processed.</li> </ul> ) Returns:EventArrayOutput

remove_duplicate_events(request_object)

Removes the duplicate events

Determine pre-existing relationships between events for a requested temporal resolution (example 500ms) and reduce the data set by aggregating events with duplicate value.

Parameters:request_object (RemoveDuplicateEventsRequest) – It contains the below parameters –>
( data* - Data structure with two parts <b>eventsMetadata</b>, <b>events</b>. <ul> <li> <b>eventsMetadata</b> Metadata for the events list specifying the property name of the item in the events list that contains the text of the event (<b>eventTextPropertyName</b>) and time window length in miliseconds of the period in which time interval will be split (<b>splitInterval</b>). </li> <li> <b>events</b> List with the events that will be processed.</li> </ul> ) Returns:DuplicateEventArrayOutput

top_events(request_object)

Find most frequent top N events

Finds the most frequent events, which are sorted by the number of appearances in a dataset in a descending order.

Parameters:request_object (TopEventsRequest) – It contains the below parameters –>
( data* - Data structure with three parts - <b>numberOfTopPositionsRequired</b>, <b>eventsMetadata</b>, and <b>events</b>. <ul> <li> <b>numberOfTopPositionsRequired</b> How many top positions will be returned in the response. Has to be a positive integer. If not specified, the default value 10 will be used.</li> <li> <b>eventsMetadata</b> Metadata for the events list specifying the property name of the item in the events list that contains the text of the event.</li> <li> <b>events</b> List with the events that will be processed.</li> </ul> ) Returns:TopEventOutput

eventanalytics.clients.pattern_operations_client module

Event Analytics API

Provides the essential functionality for a data-driven analysis of the event data. # noqa: E501

class PatternOperationsClient(rest_client_config=None, mindsphere_credentials=None)

Bases: object

match_patterns_over_events(request_object)

Applies the patterns specified in body on a list of events

Finds all instances of the specified pattern(s) in a collection of events.

Parameters:request_object (MatchPatternsOverEventsRequest) – It contains the below parameters –>
( data* - Data structure with four parts - <b>maxPatternInterval</b>, <b>patternsList</b>, <b>nonEvents</b> and <b>eventsInput</b>. <ul> <li><b>maxPatternInterval </b> The maximum time length (in milliseconds) of the sliding window where the pattern occurs (Maximum difference allowed between the first event of the pattern and the last one). </li> <li> <b>patternsList</b> The patterns to be found in events. The <b>eventText</b> can contain <b>regular expressions</b>. The acceptable syntax for the regular expressions is the java syntax. <b>minRepetitions</b> and <b>maxRepetitions</b> represent the minimum and maximum number of events of the specified type that are allowed to occur in order for the pattern to be matched on the events.</li> <li> <b>nonEvents</b> A list of events that is not allowed to be part of a pattern. Any pattern which contains a non-event is excluded from the final report.</li> <li> <b>eventsInput</b> Metadata for the events list specifying the property name of the item in the events list that contains the text of the event and the list with the events that will be processed.</li> </ul> ) Returns:PatternMatchingOutput

Module contents