xref: /aosp_15_r20/external/libtextclassifier/native/actions/grammar-actions.h (revision 993b0882672172b81d12fad7a7ac0c3e5c824a12)
1*993b0882SAndroid Build Coastguard Worker /*
2*993b0882SAndroid Build Coastguard Worker  * Copyright (C) 2018 The Android Open Source Project
3*993b0882SAndroid Build Coastguard Worker  *
4*993b0882SAndroid Build Coastguard Worker  * Licensed under the Apache License, Version 2.0 (the "License");
5*993b0882SAndroid Build Coastguard Worker  * you may not use this file except in compliance with the License.
6*993b0882SAndroid Build Coastguard Worker  * You may obtain a copy of the License at
7*993b0882SAndroid Build Coastguard Worker  *
8*993b0882SAndroid Build Coastguard Worker  *      http://www.apache.org/licenses/LICENSE-2.0
9*993b0882SAndroid Build Coastguard Worker  *
10*993b0882SAndroid Build Coastguard Worker  * Unless required by applicable law or agreed to in writing, software
11*993b0882SAndroid Build Coastguard Worker  * distributed under the License is distributed on an "AS IS" BASIS,
12*993b0882SAndroid Build Coastguard Worker  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13*993b0882SAndroid Build Coastguard Worker  * See the License for the specific language governing permissions and
14*993b0882SAndroid Build Coastguard Worker  * limitations under the License.
15*993b0882SAndroid Build Coastguard Worker  */
16*993b0882SAndroid Build Coastguard Worker 
17*993b0882SAndroid Build Coastguard Worker #ifndef LIBTEXTCLASSIFIER_ACTIONS_GRAMMAR_ACTIONS_H_
18*993b0882SAndroid Build Coastguard Worker #define LIBTEXTCLASSIFIER_ACTIONS_GRAMMAR_ACTIONS_H_
19*993b0882SAndroid Build Coastguard Worker 
20*993b0882SAndroid Build Coastguard Worker #include <memory>
21*993b0882SAndroid Build Coastguard Worker #include <vector>
22*993b0882SAndroid Build Coastguard Worker 
23*993b0882SAndroid Build Coastguard Worker #include "actions/actions_model_generated.h"
24*993b0882SAndroid Build Coastguard Worker #include "actions/types.h"
25*993b0882SAndroid Build Coastguard Worker #include "utils/flatbuffers/mutable.h"
26*993b0882SAndroid Build Coastguard Worker #include "utils/grammar/analyzer.h"
27*993b0882SAndroid Build Coastguard Worker #include "utils/grammar/evaluated-derivation.h"
28*993b0882SAndroid Build Coastguard Worker #include "utils/grammar/text-context.h"
29*993b0882SAndroid Build Coastguard Worker #include "utils/i18n/locale.h"
30*993b0882SAndroid Build Coastguard Worker #include "utils/tokenizer.h"
31*993b0882SAndroid Build Coastguard Worker #include "utils/utf8/unilib.h"
32*993b0882SAndroid Build Coastguard Worker 
33*993b0882SAndroid Build Coastguard Worker namespace libtextclassifier3 {
34*993b0882SAndroid Build Coastguard Worker 
35*993b0882SAndroid Build Coastguard Worker // Grammar backed actions suggestions.
36*993b0882SAndroid Build Coastguard Worker class GrammarActions {
37*993b0882SAndroid Build Coastguard Worker  public:
38*993b0882SAndroid Build Coastguard Worker   explicit GrammarActions(const UniLib* unilib,
39*993b0882SAndroid Build Coastguard Worker                           const RulesModel_::GrammarRules* grammar_rules,
40*993b0882SAndroid Build Coastguard Worker                           const MutableFlatbufferBuilder* entity_data_builder,
41*993b0882SAndroid Build Coastguard Worker                           const std::string& smart_reply_action_type);
42*993b0882SAndroid Build Coastguard Worker 
43*993b0882SAndroid Build Coastguard Worker   // Suggests actions for a conversation from a message stream.
44*993b0882SAndroid Build Coastguard Worker   bool SuggestActions(const Conversation& conversation,
45*993b0882SAndroid Build Coastguard Worker                       std::vector<ActionSuggestion>* result) const;
46*993b0882SAndroid Build Coastguard Worker 
47*993b0882SAndroid Build Coastguard Worker  private:
48*993b0882SAndroid Build Coastguard Worker   // Creates action suggestions from a grammar match result.
49*993b0882SAndroid Build Coastguard Worker   bool InstantiateActionsFromMatch(const grammar::TextContext& text_context,
50*993b0882SAndroid Build Coastguard Worker                                    int message_index,
51*993b0882SAndroid Build Coastguard Worker                                    const grammar::Derivation& derivation,
52*993b0882SAndroid Build Coastguard Worker                                    std::vector<ActionSuggestion>* result) const;
53*993b0882SAndroid Build Coastguard Worker 
54*993b0882SAndroid Build Coastguard Worker   const UniLib& unilib_;
55*993b0882SAndroid Build Coastguard Worker   const RulesModel_::GrammarRules* grammar_rules_;
56*993b0882SAndroid Build Coastguard Worker   const std::unique_ptr<Tokenizer> tokenizer_;
57*993b0882SAndroid Build Coastguard Worker   const MutableFlatbufferBuilder* entity_data_builder_;
58*993b0882SAndroid Build Coastguard Worker   const grammar::Analyzer analyzer_;
59*993b0882SAndroid Build Coastguard Worker   const std::string smart_reply_action_type_;
60*993b0882SAndroid Build Coastguard Worker };
61*993b0882SAndroid Build Coastguard Worker 
62*993b0882SAndroid Build Coastguard Worker }  // namespace libtextclassifier3
63*993b0882SAndroid Build Coastguard Worker 
64*993b0882SAndroid Build Coastguard Worker #endif  // LIBTEXTCLASSIFIER_ACTIONS_GRAMMAR_ACTIONS_H_
65