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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
|
// Copyright 2019 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.
syntax = "proto2";
package icing.lib;
import "icing/proto/logging.proto";
import "icing/proto/status.proto";
option java_package = "com.google.android.icing.proto";
option java_multiple_files = true;
option objc_class_prefix = "ICNG";
// Next tag: 8
message IcingSearchEngineOptions {
// Directory to persist files for Icing. Required.
// If Icing was previously initialized with this directory, it will reload
// the index saved by the last instance.
optional string base_dir = 1;
// The maximum allowable token length. All tokens in excess of this size
// will be truncated to max_token_length before being indexed.
//
// Clients may use this option to prevent unnecessary indexing of long tokens.
// Depending on the use case, indexing all of
// 'Supercalifragilisticexpialidocious' may be unnecessary - a user is
// unlikely to type that entire query. So only indexing the first n bytes may
// still provide the desired behavior without wasting resources.
//
// Valid values: [1, INT_MAX]
// Optional.
optional int32 max_token_length = 3 [default = 30];
// The size (measured in bytes) at which Icing's internal indices should be
// merged. Icing buffers changes together before merging them into a more
// compact format. When the buffer exceeds index_merge_size during a Put
// operation, the buffer is merged into the larger, more compact index.
//
// This more compact index is more efficient to search over as the index
// grows larger and has smaller system health impact.
//
// Setting a low index_merge_size increases the frequency of merges -
// increasing indexing-time latency and flash wear. Setting a high
// index_merge_size leads to larger resource usage and higher query latency.
// Valid values: [1, INT_MAX]
// Optional.
optional int32 index_merge_size = 4 [default = 1048576]; // 1 MiB
// Whether to use namespace id or namespace name to build up fingerprint for
// document_key_mapper_ and corpus_mapper_ in document store.
// TODO(b/259969017) Flip the default value of this flag to true at the time
// when we switch to use persistent hash map for document_key_mapper_ so that
// we just need one reconstruction of the internal mappers.
optional bool document_store_namespace_id_fingerprint = 5;
// The threshold of the percentage of invalid documents to rebuild index
// during optimize, i.e. we rebuild index if and only if
// |invalid_documents| / |all_documents| >= optimize_rebuild_index_threshold
//
// Rebuilding the index could be faster than optimizing the index if we have
// removed most of the documents.
// Based on benchmarks, 85%~95% seems to be a good threshold for most cases.
//
// Default to 0 for better rollout of the new index optimize.
optional float optimize_rebuild_index_threshold = 6 [default = 0.0];
// Level of compression, NO_COMPRESSION = 0, BEST_SPEED = 1,
// BEST_COMPRESSION = 9
// Valid values: [0, 9]
// Optional.
optional int32 compression_level = 7 [default = 3];
reserved 2;
}
// Result of a call to IcingSearchEngine.Initialize
// Next tag: 3
message InitializeResultProto {
// Status code can be one of:
// OK
// WARNING_DATA_LOSS
// INVALID_ARGUMENT
// NOT_FOUND
// INTERNAL
//
// See status.proto for more details.
//
// TODO(b/147699081): Fix error codes: +ABORTED, -NOT_FOUND.
// go/icing-library-apis.
optional StatusProto status = 1;
// Stats of the function call. Inside InitializeStatsProto, the function call
// latency 'latency_ms' will always be populated. The other fields will be
// accurate only when the status above is OK or WARNING_DATA_LOSS. See
// logging.proto for details.
optional InitializeStatsProto initialize_stats = 2;
// TODO(b/147699081): Add a field to indicate lost_schema and lost_documents.
// go/icing-library-apis.
}
|
