1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
|
// Copyright (C) 2021 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#ifndef ICING_QUERY_SUGGESTION_PROCESSOR_H_
#define ICING_QUERY_SUGGESTION_PROCESSOR_H_
#include <cstdint>
#include <memory>
#include <vector>
#include "icing/text_classifier/lib3/utils/base/statusor.h"
#include "icing/index/index.h"
#include "icing/index/numeric/numeric-index.h"
#include "icing/proto/search.pb.h"
#include "icing/schema/schema-store.h"
#include "icing/store/document-store.h"
#include "icing/tokenization/language-segmenter.h"
#include "icing/transform/normalizer.h"
#include "icing/util/clock.h"
namespace icing {
namespace lib {
// Processes SuggestionSpecProtos and retrieves the specified TermMedaData that
// satisfies the prefix and its restrictions. This also performs ranking, and
// returns TermMetaData ordered by their hit count.
class SuggestionProcessor {
public:
// Factory function to create a SuggestionProcessor which does not take
// ownership of any input components, and all pointers must refer to valid
// objects that outlive the created SuggestionProcessor instance.
//
// Returns:
// An SuggestionProcessor on success
// FAILED_PRECONDITION if any of the pointers is null.
static libtextclassifier3::StatusOr<std::unique_ptr<SuggestionProcessor>>
Create(Index* index, const NumericIndex<int64_t>* numeric_index,
const LanguageSegmenter* language_segmenter,
const Normalizer* normalizer, const DocumentStore* document_store,
const SchemaStore* schema_store, const Clock* clock);
// Query suggestions based on the given SuggestionSpecProto.
//
// Returns:
// On success,
// - One vector that represents the entire TermMetadata
// INTERNAL_ERROR on all other errors
libtextclassifier3::StatusOr<std::vector<TermMetadata>> QuerySuggestions(
const SuggestionSpecProto& suggestion_spec, int64_t current_time_ms);
private:
explicit SuggestionProcessor(Index* index,
const NumericIndex<int64_t>* numeric_index,
const LanguageSegmenter* language_segmenter,
const Normalizer* normalizer,
const DocumentStore* document_store,
const SchemaStore* schema_store,
const Clock* clock);
// Not const because we could modify/sort the TermMetaData buffer in the lite
// index.
Index& index_; // Does not own.
const NumericIndex<int64_t>& numeric_index_; // Does not own.
const LanguageSegmenter& language_segmenter_; // Does not own.
const Normalizer& normalizer_; // Does not own.
const DocumentStore& document_store_; // Does not own.
const SchemaStore& schema_store_; // Does not own.
const Clock& clock_; // Does not own.
};
} // namespace lib
} // namespace icing
#endif // ICING_QUERY_SUGGESTION_PROCESSOR_H_
|
