• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (C) 2018 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 #ifndef LIBTEXTCLASSIFIER_ACTIONS_RANKER_H_
18 #define LIBTEXTCLASSIFIER_ACTIONS_RANKER_H_
19 
20 #include <memory>
21 
22 #include "actions/actions_model_generated.h"
23 #include "actions/types.h"
24 #include "utils/zlib/zlib.h"
25 
26 namespace libtextclassifier3 {
27 
28 // Ranking and filtering of actions suggestions.
29 class ActionsSuggestionsRanker {
30  public:
31   static std::unique_ptr<ActionsSuggestionsRanker>
32   CreateActionsSuggestionsRanker(const RankingOptions* options,
33                                  ZlibDecompressor* decompressor,
34                                  const std::string& smart_reply_action_type);
35 
36   // Rank and filter actions.
37   bool RankActions(
38       const Conversation& conversation, ActionsSuggestionsResponse* response,
39       const reflection::Schema* entity_data_schema = nullptr,
40       const reflection::Schema* annotations_entity_data_schema = nullptr) const;
41 
42  private:
ActionsSuggestionsRanker(const RankingOptions * options,const std::string & smart_reply_action_type)43   explicit ActionsSuggestionsRanker(const RankingOptions* options,
44                                     const std::string& smart_reply_action_type)
45       : options_(options), smart_reply_action_type_(smart_reply_action_type) {}
46 
47   bool InitializeAndValidate(ZlibDecompressor* decompressor);
48 
49   const RankingOptions* const options_;
50   std::string lua_bytecode_;
51   std::string smart_reply_action_type_;
52 };
53 
54 }  // namespace libtextclassifier3
55 
56 #endif  // LIBTEXTCLASSIFIER_ACTIONS_RANKER_H_
57