RecommendLabelAction Class Reference

Recommend label actions is meant to suggest a label to the users. More...

#include <src/api/mip/upe/recommend_label_action.h>

Inheritance diagram for RecommendLabelAction:

Collaboration diagram for RecommendLabelAction:

Public Member Functions
virtual const std::vector< std::string > &	GetClassificationIds () const =0
	Get the Classification IDs that matched and caused this label to appear.
virtual const std::shared_ptr< Label > &	GetLabel () const =0
	Get the label suggested.
virtual ActionType	GetType () const =0
	Get the type of Action.

Detailed Description

Recommend label actions is meant to suggest a label to the users.

Suppressing this call after a user ignores the recommended label should be done through the supported actions on the execution state.

Definition at line 48 of file recommend_label_action.h.

Member Function Documentation

GetClassificationIds()

virtual const std::vector< std::string > & RecommendLabelAction::GetClassificationIds ( ) const

pure virtual

Get the Classification IDs that matched and caused this label to appear.

Returns

const std::vector<std::string>& a list of classification IDs that caused this label to appear.

GetLabel()

virtual const std::shared_ptr< Label > & RecommendLabelAction::GetLabel ( ) const

pure virtual

Get the label suggested.

Returns

the label.

GetType()

virtual ActionType Action::GetType ( ) const

pure virtualinherited

Get the type of Action.

Returns

ActionType The type of derived action this base class can be cast to.

---

The documentation for this class was generated from the following file:

• src/api/mip/upe/recommend_label_action.h