live_model.h

Go to the documentation of this file.

 
#pragma once
#include "action_flags.h"
#include "continuous_action_response.h"
#include "decision_response.h"
#include "err_constants.h"
#include "factory_resolver.h"
#include "future_compat.h"
#include "multi_slot_response.h"
#include "multi_slot_response_detailed.h"
#include "multistep.h"
#include "ranking_response.h"
#include "sender.h"
 
#include <functional>
#include <memory>
 
namespace reinforcement_learning
{
class live_model_impl;   //
class ranking_response;  //
class api_status;        //
                         //
namespace model_management
{                        //
class i_data_transport;  //
class i_model;           //
}  // namespace model_management
   //
namespace utility
{                     //
class configuration;  //
}  // namespace utility
 
// Reinforcement learning client
class live_model
{
public:
  using error_fn = void (*)(const api_status&, void*);
 
  explicit live_model(const utility::configuration& config, error_fn fn = nullptr, void* err_context = nullptr,
      trace_logger_factory_t* trace_factory = &trace_logger_factory,
      data_transport_factory_t* t_factory = &data_transport_factory, model_factory_t* m_factory = &model_factory,
      sender_factory_t* s_factory = &sender_factory,
      time_provider_factory_t* time_prov_factory = &time_provider_factory);
 
  explicit live_model(const utility::configuration& config, std::function<void(const api_status&)> error_cb,
      trace_logger_factory_t* trace_factory = &trace_logger_factory,
      data_transport_factory_t* t_factory = &data_transport_factory, model_factory_t* m_factory = &model_factory,
      sender_factory_t* s_factory = &sender_factory,
      time_provider_factory_t* time_prov_factory = &time_provider_factory);
 
  int init(api_status* status = nullptr);
 
  int choose_rank(const char* event_id, string_view context_json, ranking_response& resp, api_status* status = nullptr);
 
  int choose_rank(
      string_view context_json, ranking_response& resp, api_status* status = nullptr);  // event_id is auto-generated
 
  int choose_rank(const char* event_id, string_view context_json, unsigned int flags, ranking_response& resp,
      api_status* status = nullptr);
 
  int choose_rank(string_view context_json, unsigned int flags, ranking_response& resp,
      api_status* status = nullptr);  // event_id is auto-generated
 
  RL_DEPRECATED("New unified example builder interface is coming")
  int request_continuous_action(const char* event_id, string_view context_json, unsigned int flags,
      continuous_action_response& response, api_status* status = nullptr);
 
  RL_DEPRECATED("New unified example builder interface is coming")
  int request_continuous_action(const char* event_id, string_view context_json, continuous_action_response& response,
      api_status* status = nullptr);
 
  RL_DEPRECATED("New unified example builder interface is coming")
  int request_continuous_action(
      string_view context_json, unsigned int flags, continuous_action_response& response, api_status* status = nullptr);
 
  RL_DEPRECATED("New unified example builder interface is coming")
  int request_continuous_action(
      string_view context_json, continuous_action_response& response, api_status* status = nullptr);
 
  RL_DEPRECATED("New interface unifying CB with CCB is coming")
  int request_decision(
      string_view context_json, unsigned int flags, decision_response& resp, api_status* status = nullptr);
 
  RL_DEPRECATED("New interface unifying CB with CCB is coming")
  int request_decision(string_view context_json, decision_response& resp, api_status* status = nullptr);
 
  RL_DEPRECATED("New unified example builder interface is coming")
  int request_multi_slot_decision(const char* event_id, string_view context_json, unsigned int flags,
      multi_slot_response& resp, api_status* status = nullptr);
  RL_DEPRECATED("New unified example builder interface is coming")
  int request_multi_slot_decision(
      const char* event_id, string_view context_json, multi_slot_response& resp, api_status* status = nullptr);
  RL_DEPRECATED("New unified example builder interface is coming")
  int request_multi_slot_decision(
      string_view context_json, unsigned int flags, multi_slot_response& resp, api_status* status = nullptr);
  RL_DEPRECATED("New unified example builder interface is coming")
  int request_multi_slot_decision(string_view context_json, multi_slot_response& resp, api_status* status = nullptr);
 
  RL_DEPRECATED("New unified example builder interface is coming")
  int request_multi_slot_decision(const char* event_id, string_view context_json, unsigned int flags,
      multi_slot_response& resp, const int* baseline_actions, size_t baseline_actions_size,
      api_status* status = nullptr);
 
  RL_DEPRECATED("New unified example builder interface is coming")
  int request_multi_slot_decision(const char* event_id, string_view context_json, unsigned int flags,
      multi_slot_response_detailed& resp, api_status* status = nullptr);
  RL_DEPRECATED("New unified example builder interface is coming")
  int request_multi_slot_decision(
      const char* event_id, string_view context_json, multi_slot_response_detailed& resp, api_status* status = nullptr);
  RL_DEPRECATED("New unified example builder interface is coming")
  int request_multi_slot_decision(
      string_view context_json, unsigned int flags, multi_slot_response_detailed& resp, api_status* status = nullptr);
  RL_DEPRECATED("New unified example builder interface is coming")
  int request_multi_slot_decision(
      string_view context_json, multi_slot_response_detailed& resp, api_status* status = nullptr);
 
  RL_DEPRECATED("New unified example builder interface is coming")
  int request_multi_slot_decision(const char* event_id, string_view context_json, unsigned int flags,
      multi_slot_response_detailed& resp, const int* baseline_actions, size_t baseline_actions_size,
      api_status* status = nullptr);
 
  // multistep
  int request_episodic_decision(const char* event_id, const char* previous_id, string_view context_json,
      ranking_response& resp, episode_state& episode, api_status* status = nullptr);
  int request_episodic_decision(const char* event_id, const char* previous_id, string_view context_json,
      unsigned int flags, ranking_response& resp, episode_state& episode, api_status* status = nullptr);
 
  int report_action_taken(const char* event_id, api_status* status = nullptr);
 
  int report_action_taken(const char* primary_id, const char* secondary_id, api_status* status = nullptr);
 
  int report_outcome(const char* event_id, const char* outcome, api_status* status = nullptr);
 
  int report_outcome(const char* event_id, float outcome, api_status* status = nullptr);
 
  int report_outcome(const char* primary_id, int secondary_id, float outcome, api_status* status = nullptr);
 
  int report_outcome(const char* primary_id, const char* secondary_id, float outcome, api_status* status = nullptr);
 
  int report_outcome(const char* primary_id, int secondary_id, const char* outcome, api_status* status = nullptr);
 
  int report_outcome(
      const char* primary_id, const char* secondary_id, const char* outcome, api_status* status = nullptr);
 
  /*
   * @brief Refreshes the model if it has background refresh disabled.
   * @param status  Optional field with detailed string description if there is an error
   * @return int Return error code.  This will also be returned in the api_status object
   */
  int refresh_model(api_status* status = nullptr);
 
  template <typename ErrCntxt>
  using error_fn_t = void (*)(const api_status&, ErrCntxt*);
 
  template <typename ErrCntxt>
  explicit live_model(const utility::configuration& config, error_fn_t<ErrCntxt> fn, ErrCntxt* err_context = nullptr,
      trace_logger_factory_t* trace_factory = &trace_logger_factory,
      data_transport_factory_t* t_factory = &data_transport_factory, model_factory_t* m_factory = &model_factory,
      sender_factory_t* s_factory = &sender_factory,
      time_provider_factory_t* time_prov_factory = &time_provider_factory);
 
  live_model(live_model&& other) noexcept;
 
  live_model& operator=(live_model&& other) noexcept;
 
  live_model(
      const live_model&) = delete;  
  live_model& operator=(
      live_model&) = delete;  
 
  ~live_model();
 
private:
  std::unique_ptr<live_model_impl>
      _pimpl;                 
  bool _initialized = false;  
  const std::vector<int> default_baseline_vector = std::vector<int>();
  static std::vector<int> c_array_to_vector(
      const int* c_array, size_t array_size);  
};
 
template <typename ErrCntxt>
live_model::live_model(const utility::configuration& config, error_fn_t<ErrCntxt> fn, ErrCntxt* err_context,
    trace_logger_factory_t* trace_factory, data_transport_factory_t* t_factory, model_factory_t* m_factory,
    sender_factory_t* s_factory, time_provider_factory_t* time_prov_factory)
    : live_model(config, std::bind(fn, std::placeholders::_1, err_context), trace_factory, t_factory, m_factory,
          s_factory, time_prov_factory)
{
}
}  // namespace reinforcement_learning