MIP SDK — C++ 1.18
API Reference Documentation for C++
Loading...
Searching...
No Matches
RecommendLabelAction Class Referenceabstract

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. More...

#include <mip/upe/recommend_label_action.h>

Inheritance diagram for RecommendLabelAction:
Action

Public Member Functions

virtual const std::shared_ptr< Label > & GetLabel () const =0
 Get the label suggested.
 
virtual const std::vector< std::string > & GetClassificationIds () const =0
 Get the Classification IDs that matched and caused this label to appear.
 
virtual ~RecommendLabelAction ()
 
- Public Member Functions inherited from Action
virtual ActionType GetType () const =0
 Get the type of Action.
 
virtual ~Action ()
 
virtual void Link ()
 
virtual const std::string & GetId () const
 
virtual bool operator== (const Action &action) const
 

Protected Member Functions

 RecommendLabelAction (const std::string &id)
 
- Protected Member Functions inherited from Action
virtual bool IsEqual (const Action &action) const =0
 
 Action ()
 
 Action (const std::string &id)
 

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.

Constructor & Destructor Documentation

◆ ~RecommendLabelAction()

virtual RecommendLabelAction::~RecommendLabelAction ( )
inlinevirtual

◆ RecommendLabelAction()

RecommendLabelAction::RecommendLabelAction ( const std::string & id)
inlineprotected

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.

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