org.imixs.ml.workflow

Class MLService

java.lang.Object

org.imixs.ml.workflow.MLService

All Implemented Interfaces:

Serializable

public class MLService
extends Object
implements Serializable

The MLService reacts on Processing events and updates the ml.status item. If no ml.status item exists, and ml.items is not empty, than the status is set to 'suggest'. If the status is 'suggest' and the current event is 'public' than the status is set to 'confirmed'

If the status was already confirmed, the workitem type is 'archive', than the ml status is set to 'training' and a eventLog entry is created to indicate that this workitem can be send to the training service. (Note: the training service can reject the workitem for training if the data is insufficient of quality)

Author:

rsoika

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected javax.enterprise.event.Event<EntityObjectEvent>	entityObjectEvents
static String	EVENTLOG_TOPIC_TRAINING
protected org.imixs.workflow.engine.EventLogService	eventLogService
static String	ITEM_ML_DEFINITIONS
static String	ITEM_ML_ENDPOINT
static String	ITEM_ML_ITEMS
static String	ITEM_ML_LOCALES
static String	ITEM_ML_MODEL
static String	ITEM_ML_QUALITY
static String	ITEM_ML_STATUS
static String	ML_STATUS_CONFIRMED
static String	ML_STATUS_SUGGEST
static String	ML_STATUS_TRAINING
protected org.imixs.workflow.engine.ModelService	modelService
protected org.imixs.workflow.engine.WorkflowService	workflowService

Constructor Summary

Constructors

Constructor and Description
MLService()

Method Summary

Modifier and Type	Method and Description
String	getAllDocumentText(org.imixs.workflow.ItemCollection workitem) This method returns a string with all the text content of all documents attached to a workitem.
List<org.imixs.workflow.ItemCollection>	getMLDefinitions(org.imixs.workflow.ItemCollection workitem) This method returns a list of ItemCollection object holding the ml.definitions stored in a given workitem.
void	onWorkflowEvent(org.imixs.workflow.engine.ProcessingEvent processingEvent) WorkflowEvent listener to update the ml.status property.
void	trainWorkitem(String uid) This method sends a given workitem to each ML Training Service defined in the item 'ml.definitions'.
void	updateMLDefinition(org.imixs.workflow.ItemCollection workitem, org.imixs.workflow.ItemCollection newMLDefinition) This method updates the item 'ml.definitions' of a workitem holding a list of ML Endpoint definitions.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ITEM_ML_DEFINITIONS

public static final String ITEM_ML_DEFINITIONS

See Also:

Constant Field Values

ITEM_ML_ENDPOINT

public static final String ITEM_ML_ENDPOINT

See Also:

Constant Field Values

ITEM_ML_ITEMS

public static final String ITEM_ML_ITEMS

See Also:

Constant Field Values

ITEM_ML_LOCALES

public static final String ITEM_ML_LOCALES

See Also:

Constant Field Values

ITEM_ML_STATUS

public static final String ITEM_ML_STATUS

See Also:

Constant Field Values

ITEM_ML_MODEL

public static final String ITEM_ML_MODEL

See Also:

Constant Field Values

ITEM_ML_QUALITY

public static final String ITEM_ML_QUALITY

See Also:

Constant Field Values

ML_STATUS_SUGGEST

public static final String ML_STATUS_SUGGEST

See Also:

Constant Field Values

ML_STATUS_CONFIRMED

public static final String ML_STATUS_CONFIRMED

See Also:

Constant Field Values

ML_STATUS_TRAINING

public static final String ML_STATUS_TRAINING

See Also:

Constant Field Values

EVENTLOG_TOPIC_TRAINING

public static final String EVENTLOG_TOPIC_TRAINING

See Also:

Constant Field Values

entityObjectEvents

@Inject
protected javax.enterprise.event.Event<EntityObjectEvent> entityObjectEvents

modelService

@Inject
protected org.imixs.workflow.engine.ModelService modelService

workflowService

@Inject
protected org.imixs.workflow.engine.WorkflowService workflowService

eventLogService

@Inject
protected org.imixs.workflow.engine.EventLogService eventLogService

Constructor Detail

MLService

public MLService()

Method Detail

onWorkflowEvent

public void onWorkflowEvent(@Observes
                            org.imixs.workflow.engine.ProcessingEvent processingEvent)

WorkflowEvent listener to update the ml.status property.

If no ml.status item exists, and ml.item is not empty, than the status is set to 'suggest'

If the status is 'suggest' and the current event is 'public' than the status is set to 'confirmed'

Parameters:

processingEvent -

getAllDocumentText

public String getAllDocumentText(org.imixs.workflow.ItemCollection workitem)

This method returns a string with all the text content of all documents attached to a workitem.

Returns:

trainWorkitem

public void trainWorkitem(String uid)

This method sends a given workitem to each ML Training Service defined in the item 'ml.definitions'.

The method is called by the MLTrainingScheduler.

Parameters:

uid -

updateMLDefinition

public void updateMLDefinition(org.imixs.workflow.ItemCollection workitem,
                               org.imixs.workflow.ItemCollection newMLDefinition)

This method updates the item 'ml.definitions' of a workitem holding a list of ML Endpoint definitions. Each endpoint definition is defined by a set of items stored in a map. The Map can be converted into a ItemCollection

If a endpoint definition with the same service endpoint and model name already exists, the method overwrites this entry.

Parameters:

workitem - - the workitem holding a list of existing endpoint definitions

newEndpointDefinition - - the new Endpoint definition to be stored.

getMLDefinitions

public List<org.imixs.workflow.ItemCollection> getMLDefinitions(org.imixs.workflow.ItemCollection workitem)

This method returns a list of ItemCollection object holding the ml.definitions stored in a given workitem. Each endpoint definition is defined by a set of items stored in a map. The Map can be conferted into a ItemCollection