Get desktop application:
View/edit binary Protocol Buffers messages
(message has no fields)
true if index is loaded (Created) or false if reloaded (Updated)
Used in: ,
default 10
default TFIDF
default 0
default 0
default ALL_TERMS_TOP_N
Used in:
Used in:
Used in: , ,
Used in: ,
STANDARD default
BM25 default
Used in:
Used in:
Used in: ,
Used in:
Used in:
Used in:
Used as request type in: ZuliaService.Clear, ZuliaService.InternalClear
Used as response type in: ZuliaService.Clear, ZuliaService.InternalClear
(message has no fields)
Used in: ,
default 10, set to -1 to get all
defaults to maxFacets * 10, ignored for single shard indexes, set to -1 to get all
0 = no limit (default, backward compatible); skip this facet if totalHits exceeds threshold
0 = use maxTotalHitsForFacet for shard-level check (default); set to tune shard-level threshold independently
Used as response type in: ZuliaService.CreateIndexAlias, ZuliaService.InternalCreateIndexAlias
(message has no fields)
A DDSketch is essentially a histogram that partitions the range of positive values into an infinite number of indexed bins whose size grows exponentially. It keeps track of the number of values (or possibly floating-point weights) added to each bin. Negative values are partitioned like positive values, symmetrically to zero. The value zero as well as its close neighborhood that would be mapped to extreme bin indexes is mapped to a specific counter.
Used in:
The mapping between positive values and the bin indexes they belong to.
The store for keeping track of positive values.
The store for keeping track of negative values. A negative value v is mapped using its positive opposite -v.
The count for the value zero and its close neighborhood (whose width depends on the mapping).
Used as request type in: ZuliaService.DeleteIndexAlias, ZuliaService.InternalDeleteIndexAlias
Used as response type in: ZuliaService.DeleteIndexAlias, ZuliaService.InternalDeleteIndexAlias
(message has no fields)
Used as request type in: ZuliaService.DeleteIndex, ZuliaService.InternalDeleteIndex
Used as response type in: ZuliaService.DeleteIndex, ZuliaService.InternalDeleteIndex
(message has no fields)
Used as request type in: ZuliaService.Delete, ZuliaService.InternalDelete
Used as field type in:
Used as response type in: ZuliaService.BatchDelete, ZuliaService.Delete, ZuliaService.InternalDelete
Used as field type in:
(message has no fields)
Used in:
default OR
default 0
Used in:
Used in: , ,
Used in:
Used in:
Used in:
Used in: ,
default 0
Used in:
Used in:
Indicates that error was discovered during shard merging
Indicates the max error bound of the summation
Internal message intended to carry around the large sketch until reaching the top level of a request
Used in:
Used as request type in: ZuliaService.Fetch, ZuliaService.InternalFetch
Used as field type in:
Used as response type in: ZuliaService.BatchFetch, ZuliaService.Fetch, ZuliaService.InternalFetch
Used as field type in:
Used in: , , ,
Used in: ,
Build a Lucene doc-values skip index on this field's sort doc-values (enables block-skipping range queries and dynamic-pruning sorts). optional so we can tell "unset" (default on for new fields) apart from an explicit opt-out. Frozen once a field exists
Used in:
Used in: ,
Used in:
Used in:
default ASC
Used in:
Used in:
default = 0
Used in:
default "latitude"
default "longitude"
Used as request type in: ZuliaService.GetFieldNames
Used as field type in:
Used as response type in: ZuliaService.GetFieldNames, ZuliaService.InternalGetFieldNames
Used as request type in: ZuliaService.GetNumberOfDocs
Used as field type in:
Used as response type in: ZuliaService.GetNumberOfDocs, ZuliaService.InternalGetNumberOfDocs
Used as request type in: ZuliaService.GetTerms
Used as field type in:
Used as response type in: ZuliaService.GetTerms
Used as field type in:
Used in:
default <em>
default </em>
default 1
default 100
Used in:
Used in: ,
kept for backward compat - first/only index
full list of indexes when alias is multi-index
designated write target; must be one of indexNames. empty means reject single-index writes for multi-index aliases
Used in:
How to map positive values to the bins they belong to.
Used in:
The gamma parameter of the mapping, such that bin index that a value v belongs to is roughly equal to log(v)/log(gamma).
An offset that can be used to shift all bin indexes.
To speed up the computation of the index a value belongs to, the computation of the log may be approximated using the fact that the log to the base 2 of powers of 2 can be computed at a low cost from the binary representation of the input value. Other values can be approximated by interpolating between successive powers of 2 (linearly, quadratically or cubically). NONE means that the log is to be computed exactly (no interpolation).
Used in:
Used in: , , ,
Used in: , , ,
default 1
default 0
server populated
default 2.0
default 2
default 0
default 512
default 256
default 5
default 3200
default 1
default 128
index has list of query request objects stored a byte array instead of a message this ensures a query message format change can be handled on serialization and just fail to load the query vs. the whole index is also removes proto file dependencies between index and query
default 5
default -1 (auto detect)
default -1 (auto detect)
default 1
NRT (near-real-time) RAM cache sizing for the index and taxonomy directories. 0 means use the default.
default 50
default 150
default 5
default 15
when true, no new segments are cached in RAM (directory stays wrapped so it can be toggled live)
server populated: the index-creation version, stamped once at create time and never changed (see ZuliaIndexVersion). Lets new indexes adopt evolving built-in defaults (e.g. id-sort doc-values skip index, default vector quantization) that cannot be expressed per field and must not change for an index that already exists. 0 means legacy (pre-versioning).
Used in:
Used in:
Used in:
Used in:
Used in:
Used in:
Used in: ,
Used in:
Source doc IDs (fetched server-side for text + vectors). If an ID exists in multiple source indexes, the first index in source order wins (source order is the queried indexes when sourceIndex is empty)
User-supplied raw text sources
STRING fields used for lexical similarity. The source text is read from these fields of each documentId doc, and the generated term query searches these same fields. Required when likeText/documentId text is used; omit for vector-only queries
Vector field for semantic similarity (optional)
KNN top-N for vector search (default 100)
User-supplied vectors (averaged with fetched doc vectors)
Server-resolved centroid (internal, set after fetch+average)
default 2
default 25
Ignore terms appearing in fewer than this many docs (counted per shard). default 5
Ignore terms appearing in more than this many docs, counted per shard (absolute, not scaled by shard count). 0 = unset. When set it overrides maxDocFreqPct
default 0
0 = unlimited
default 5000
Boost on lexical clause in hybrid mode (0 = default 1.0)
Boost on vector clause in hybrid mode (0 = default 1.0)
If false (default), documents referenced by documentId are excluded from results (by unique ID, across all queried indexes)
Indexes to fetch documentId source docs from, in priority order (first index with the doc wins on collision). If empty, source docs are fetched from the queried indexes (existing behavior)
Ignore terms appearing in more than this percent (1-100) of docs in the shard, guarding against common tokens. 0 = default 25; 100 disables the guard. This is ignored when maxDocFreq is set
Used in: ,
Used in:
Used as request type in: ZuliaService.InternalOptimize, ZuliaService.Optimize
Used as response type in: ZuliaService.InternalOptimize, ZuliaService.Optimize
(message has no fields)
Used in:
Percentile point represented
Value of the percentile at this point
Used in: , , , ,
Deprecated aliases for backward compatibility
Used in:
default OR
default 0
score multiplier applied to this clause; 0 = unset (treated as 1.0); ignored for non-scoring clause types
Used in: ,
Used in:
vector clause that contributes score but does not constrain the result set to HNSW top-K
Used as request type in: ZuliaService.Query
Used as field type in: ,
Used as request type in: ZuliaService.InternalReindex, ZuliaService.Reindex
Used as response type in: ZuliaService.InternalReindex, ZuliaService.Reindex
(message has no fields)
Used in: , ,
Used in: , ,
Used in:
Used in:
Used in:
Used in:
Used in:
Used in: ,
Used in:
Used in:
Used in:
Used in: , ,
Used in:
Used in:
Internal message to handle larger DDSketch facet stats
Used in:
Used in: , ,
default 10, set to -1 to get all
defaults to maxFacets * 10, ignored for single shard indexes, set to -1 to get all
Specify the precision to be used in this request. Default is 0.001
0 = no limit (default, backward compatible); skip this stat if totalHits exceeds threshold
0 = use maxTotalHitsForFacet for shard-level check (default); set to tune shard-level threshold independently
A Store maps bin indexes to their respective counts. Counts can be encoded sparsely using binCounts, but also in a contiguous way using contiguousBinCounts and contiguousBinIndexOffset. Given that non-empty bins are in practice usually contiguous or close to one another, the latter contiguous encoding method is usually more efficient than the sparse one. Both encoding methods can be used conjointly. If a bin appears in both the sparse and the contiguous encodings, its count value is the sum of the counts in each encodings.
Used in:
The bin counts, encoded sparsely.
The bin counts, encoded contiguously. The values of contiguousBinCounts are the counts for the bins of indexes o, o+1, o+2, etc., where o is contiguousBinIndexOffset.
Used as request type in: ZuliaService.InternalStore, ZuliaService.Store
Used as response type in: ZuliaService.InternalStore, ZuliaService.Store
(message has no fields)
default 1
default 1357
Used in: ,
Used in:
keyed by name
keyed by storedFieldName
keyed by alias
Used in:
Used in:
Used in: