Default package

optional Facet facetField = 1
uint32 maxFacets = 2
default 10, set to -1 to get all
uint32 shardFacets = 3
defaults to maxFacets * 10, ignored for single shard indexes, set to -1 to get all
uint64 maxTotalHitsForFacet = 4
0 = no limit (default, backward compatible); skip this facet if totalHits exceeds threshold
uint64 maxShardHitsForFacet = 5
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: FacetStatsInternal

optional IndexMapping mapping = 1
The mapping between positive values and the bin indexes they belong to.
optional Store positiveValues = 2
The store for keeping track of positive values.
optional Store negativeValues = 3
The store for keeping track of negative values. A negative value v is mapped using its positive opposite -v.
double zeroCount = 4
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

string aliasName = 1

Used as response type in: ZuliaService.DeleteIndexAlias, ZuliaService.InternalDeleteIndexAlias

(message has no fields)

Used as request type in: ZuliaService.DeleteIndex, ZuliaService.InternalDeleteIndex

string indexName = 1
bool deleteAssociated = 2

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: BatchDeleteRequest

string indexName = 1
string uniqueId = 2
string filename = 3
bool deleteDocument = 4
bool deleteAllAssociated = 5

Used as response type in: ZuliaService.BatchDelete, ZuliaService.Delete, ZuliaService.InternalDelete

Used as field type in: BatchDeleteResponse

(message has no fields)

Used in: FacetRequest

string label = 1
repeated Facet facetValue = 2
Query.Operator operator = 3
default OR
uint32 mm = 4
default 0
bool exclude = 5

Used in: StoreRequest

string filename = 1
string documentUniqueId = 2
string indexName = 3
bytes registration = 4
int64 timestamp = 5

Used in: CountRequest, DrillDown, StatRequest

string label = 1
string value = 2
repeated string path = 3

Used in: FieldConfig

string facetName = 1
FacetAs.DateHandling dateHandling = 2
bool hierarchical = 3
repeated string facetGroups = 4
bool storeInOwnGroup = 5

Used in: FacetAs

DATE_YYYY_MM_DD = 0
DATE_YYYYMMDD = 1

Used in: FacetGroup

string facet = 1
uint64 count = 2
uint64 maxError = 3

Used in: QueryResponse, ShardQueryResponse

optional CountRequest countRequest = 1
repeated FacetCount facetCount = 2
bool possibleMissing = 3
uint64 maxValuePossibleMissing = 4
default 0

Used in: QueryRequest

repeated CountRequest countRequest = 1
repeated StatRequest statRequest = 3
repeated DrillDown drillDown = 4

Used in: StatGroup

string facet = 1
optional SortValue min = 2
optional SortValue max = 3
optional SortValue sum = 4
uint64 docCount = 5
uint64 allDocCount = 6
uint64 valueCount = 7
repeated Percentile percentiles = 8
bool hasError = 9
Indicates that error was discovered during shard merging
optional SortValue maxSumError = 10
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: StatGroupInternal

string facet = 1
optional SortValue min = 2
optional SortValue max = 3
optional SortValue sum = 4
uint64 docCount = 5
uint64 allDocCount = 6
uint64 valueCount = 7
optional DDSketch statSketch = 8

Used as request type in: ZuliaService.Fetch, ZuliaService.InternalFetch

Used as field type in: BatchFetchRequest

string uniqueId = 1
string indexName = 2
string filename = 3
FetchType resultFetchType = 4
FetchType associatedFetchType = 5
repeated string documentFields = 6
repeated string documentMaskedFields = 7
PrimaryReplicaSettings primaryReplicaSettings = 8
bool realtime = 9

Used as response type in: ZuliaService.BatchFetch, ZuliaService.Fetch, ZuliaService.InternalFetch

Used as field type in: BatchFetchResponse

optional ResultDocument resultDocument = 1
repeated AssociatedDocument associatedDocument = 2

Used in: BatchFetchGroup, FetchRequest, InternalShardBatchFetchRequest, QueryRequest

FULL = 0
META = 1
NONE = 2
ALL = 3

Used in: IndexSettings, UpdateIndexSettings

FieldConfig.FieldType fieldType = 1
string storedFieldName = 2
repeated IndexAs indexAs = 3
repeated FacetAs facetAs = 4
repeated SortAs sortAs = 5
string displayName = 7
string description = 8
optional GeoPointConfig geoPointConfig = 9
optional bool docValueSkipIndex = 10
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
optional VectorDescription vectorDescription = 11
for VECTOR / UNIT_VECTOR fields: dimensions, similarity, model provenance

Used in: FieldConfig

STRING = 0
NUMERIC_INT = 1
NUMERIC_LONG = 2
NUMERIC_FLOAT = 3
NUMERIC_DOUBLE = 4
DATE = 5
BOOL = 6
UNIT_VECTOR = 7
VECTOR = 8
GEO_POINT = 9

Used in: IndexSettings, UpdateIndexSettings

string alias = 1
repeated string fieldOrFieldPattern = 2
bool includeSelf = 3

Used in: QueryRequest

string field = 1
Similarity similarity = 2

Used in: SortRequest

string sortField = 1
FieldSort.Direction direction = 2
default ASC
bool missingLast = 3

Used in: FieldSort

ASCENDING = 0
DESCENDING = 1

Used in: GetTermsRequest

string term = 1
uint32 editDistance = 2
uint32 prefixLength = 3
default = 0
bool noTranspositions = 4

Used in: FieldConfig

string latitudeKey = 1
default "latitude"
string longitudeKey = 2
default "longitude"

Used as request type in: ZuliaService.GetFieldNames

Used as field type in: InternalGetFieldNamesRequest

string indexName = 1
PrimaryReplicaSettings primaryReplicaSettings = 2
bool realtime = 3

Used as response type in: ZuliaService.GetFieldNames, ZuliaService.InternalGetFieldNames

repeated string fieldName = 1

Used as request type in: ZuliaService.GetNumberOfDocs

Used as field type in: InternalGetNumberOfDocsRequest

string indexName = 1
PrimaryReplicaSettings primaryReplicaSettings = 2
bool realtime = 3

Used as response type in: ZuliaService.GetNumberOfDocs, ZuliaService.InternalGetNumberOfDocs

uint64 numberOfDocs = 1
repeated ShardCountResponse shardCountResponse = 2
uint64 sizeOnDiskBytes = 3

Used as request type in: ZuliaService.GetTerms

Used as field type in: InternalGetTermsRequest

string indexName = 1
string fieldName = 2
uint32 amount = 3
string startTerm = 4
string endTerm = 5
uint32 minDocFreq = 6
uint32 minTermFreq = 7
string termFilter = 8
string termMatch = 9
repeated string includeTerm = 10
optional FuzzyTerm fuzzyTerm = 11
PrimaryReplicaSettings primaryReplicaSettings = 12
bool realtime = 13

Used as response type in: ZuliaService.GetTerms

Used as field type in: InternalGetTermsResponse

repeated Term term = 1
optional Term lastTerm = 2

Used in: QueryRequest

string field = 1
string preTag = 2
default <em>
string postTag = 3
default </em>
uint32 numberOfFragments = 4
default 1
uint32 fragmentLength = 5
default 100

Used in: ScoredResult

string field = 1
repeated string fragments = 2

string id = 1
uint64 timestamp = 2
uint32 majorVersion = 3
uint32 minorVersion = 4
bool compressedDoc = 5

Used in: CreateIndexAliasRequest, GetNodesResponse

string aliasName = 1
string indexName = 2
kept for backward compat - first/only index
repeated string indexNames = 3
full list of indexes when alias is multi-index
string writeIndex = 4
designated write target; must be one of indexNames. empty means reject single-index writes for multi-index aliases

Used in: FieldConfig

string indexFieldName = 1
string analyzerName = 2
optional VectorIndexingConfig vectorIndexingConfig = 3
for VECTOR / UNIT_VECTOR fields: quantization and HNSW graph for this representation

How to map positive values to the bins they belong to.

Used in: DDSketch

double gamma = 1
The gamma parameter of the mapping, such that bin index that a value v belongs to is roughly equal to log(v)/log(gamma).
double indexOffset = 2
An offset that can be used to shift all bin indexes.
IndexMapping.Interpolation interpolation = 3
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: IndexMapping

NONE = 0
LINEAR = 1
QUADRATIC = 2
CUBIC = 3
QUARTIC = 4

Used in: InternalGetFieldNamesRequest, InternalGetNumberOfDocsRequest, InternalGetTermsRequest, InternalQueryRequest

string index = 1
repeated uint32 shard = 2

Used in: CreateIndexRequest, GetIndexSettingsResponse, RestIndexSettingsResponse, UpdateIndexResponse

string indexName = 1
uint32 numberOfShards = 2
default 1
uint32 numberOfReplicas = 3
default 0
int64 createTime = 4
server populated
int64 updateTime = 5
repeated string defaultSearchField = 6
repeated AnalyzerSettings analyzerSettings = 7
repeated FieldConfig fieldConfig = 8
double requestFactor = 9
default 2.0
uint32 minShardRequest = 10
default 2
double shardTolerance = 11
default 0
uint32 shardQueryCacheSize = 12
default 512
uint32 shardQueryCacheMaxAmount = 13
default 256
uint32 idleTimeWithoutCommit = 14
default 5
uint32 shardCommitInterval = 15
default 3200
uint32 indexWeight = 16
default 1
uint32 ramBufferMB = 17
default 128
bytes meta = 18
repeated bytes warmingSearches = 19
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
uint32 commitToWarmTime = 20
default 5
repeated FieldMapping fieldMapping = 21
bool disableCompression = 22
uint32 defaultConcurrency = 23
string description = 24
int32 maxMergeThreads = 25
default -1 (auto detect)
int32 maxMergePending = 26
default -1 (auto detect)
uint32 indexingThrottle = 27
default 1
uint32 nrtIndexMaxMergeSizeMB = 28
NRT (near-real-time) RAM cache sizing for the index and taxonomy directories. 0 means use the default.
default 50
uint32 nrtIndexMaxCachedMB = 29
default 150
uint32 nrtTaxoMaxMergeSizeMB = 30
default 5
uint32 nrtTaxoMaxCachedMB = 31
default 15
bool nrtCachingDisabled = 32
when true, no new segments are cached in RAM (directory stays wrapped so it can be toggled live)
uint32 createdIndexVersion = 33
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).
bool transientIndex = 34
when true the index loads lazily and may be unloaded from memory after idle time or under the node's transient cache bound, then reloaded on demand. By default false which means the index loads at startup and stays resident, which is the behavior of all indexes created before this flag existed.

Used in: GetNodesResponse

string indexName = 1
uint32 numberOfShards = 2
repeated ShardMapping shardMapping = 3

Used in: InternalQueryResponse

string indexName = 1
repeated ShardQueryResponse shardQueryResponse = 2

Used in: NodeStats

string indexName = 1
repeated ShardCacheStats shardCacheStat = 2
bool resident = 3
false for a transient index currently unloaded from memory, and such entries carry no shard cache stats

Used in: InternalBatchDeleteRequest

string indexName = 1
uint32 shardNumber = 2
repeated string uniqueId = 3
bool deleteDocument = 4
bool deleteAllAssociated = 5
string filename = 6

Used in: InternalBatchFetchRequest

string indexName = 1
uint32 shardNumber = 2
repeated string uniqueId = 3
FetchType resultFetchType = 4
repeated string documentFields = 5
repeated string documentMaskedFields = 6
bool realtime = 7
FetchType associatedFetchType = 8
string filename = 9

string indexName = 1

Used in: LastResult

string indexName = 1
repeated ScoredResult lastForShard = 2

Used in: QueryRequest, QueryResponse

repeated LastIndexResult lastIndexResult = 1

Used in: Query

repeated string documentId = 1
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)
repeated string likeText = 2
User-supplied raw text sources
repeated string field = 3
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
string vectorField = 4
Vector field for semantic similarity (optional)
uint32 vectorTopN = 5
KNN top-N for vector search (default 100)
repeated VectorInput likeVector = 6
User-supplied vectors (averaged with fetched doc vectors)
repeated float resolvedVector = 7
Server-resolved centroid (internal, set after fetch+average)
uint32 minTermFreq = 8
default 2
uint32 maxQueryTerms = 9
default 25
uint32 minDocFreq = 10
Ignore terms appearing in fewer than this many docs (counted per shard). default 5
uint32 maxDocFreq = 11
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
uint32 minWordLen = 12
default 0
uint32 maxWordLen = 13
0 = unlimited
uint32 maxNumTokensParsed = 14
default 5000
float textWeight = 15
Boost on lexical clause in hybrid mode (0 = default 1.0)
float vectorWeight = 16
Boost on vector clause in hybrid mode (0 = default 1.0)
bool includeSourceDocs = 17
If false (default), documents referenced by documentId are excluded from results (by unique ID, across all queried indexes)
repeated string sourceIndex = 18
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)
uint32 maxDocFreqPct = 19
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: GetNodesResponse, ShardMapping

string serverAddress = 1
uint32 servicePort = 2
uint32 restPort = 3
int64 heartbeat = 4
string version = 5

uint64 jvmUsedMemoryMB = 2
uint64 jvmFreeMemoryMB = 3
uint64 jvmTotalMemoryMB = 4
uint64 jvmMaxMemoryMB = 5
double freeDataDirSpaceGB = 6
double totalDataDirSpaceGB = 7
double usedDataDirSpaceGB = 8
string zuliaVersion = 9
repeated IndexStats indexStat = 10
uint32 residentIndexCount = 11
residency and churn stats for transient indexes on this node
uint64 indexLoadCount = 12
uint64 indexEvictionCount = 13

Used in: Query

repeated int32 integerValue = 1
repeated int64 longValue = 2
repeated float floatValue = 3
repeated double doubleValue = 4

Used as request type in: ZuliaService.InternalOptimize, ZuliaService.Optimize

string indexName = 1
int32 maxNumberOfSegments = 2

Used as response type in: ZuliaService.InternalOptimize, ZuliaService.Optimize

(message has no fields)

Used in: FacetStats

double point = 1
Percentile point represented
double value = 2
Value of the percentile at this point

Used in: FetchRequest, GetFieldNamesRequest, GetNumberOfDocsRequest, GetTermsRequest, QueryRequest

PRIMARY_ONLY = 0
REPLICA_ONLY = 1
PRIMARY_IF_AVAILABLE = 2
MASTER_ONLY = 0
Deprecated aliases for backward compatibility
SLAVE_ONLY = 1
MASTER_IF_AVAILABLE = 2

Used in: QueryRequest

Query.QueryType queryType = 1
string q = 2
Query.Operator defaultOp = 3
default OR
repeated string qf = 4
uint32 mm = 5
default 0
repeated string term = 8
repeated float vector = 10
string scoreFunction = 11
uint32 vectorTopN = 13
repeated Query vectorPreQuery = 14
optional NumericSet numericSet = 15
float boost = 16
score multiplier applied to this clause; 0 = unset (treated as 1.0); ignored for non-scoring clause types
optional MoreLikeThisParams moreLikeThisParams = 17
float vectorOversample = 18
Oversampling for quantized vector fields: fetch ceil(vectorTopN * vectorOversample) candidates, rescore with full-precision vectors, keep vectorTopN. 0 = encoding default (BBQ rescores, INT8/FLOAT32 do not), 1.0 = off, capped server-side at 32x

Used in: DrillDown, Query

OR = 0
AND = 1

Used in: Query

FILTER = 0
SCORE_MUST = 1
SCORE_SHOULD = 2
TERMS = 3
VECTOR = 4
TERMS_NOT = 5
FILTER_NOT = 6
NUMERIC_SET = 7
NUMERIC_SET_NOT = 8
VECTOR_SHOULD = 9
vector clause that contributes score but does not constrain the result set to HNSW top-K
MORE_LIKE_THIS = 10

Used as request type in: ZuliaService.Query

Used as field type in: InternalQueryRequest, RestIndexSettingsResponse

repeated string index = 1
repeated Query query = 2
uint32 amount = 3
optional FacetRequest facetRequest = 4
optional SortRequest sortRequest = 5
uint32 start = 6
optional LastResult lastResult = 7
FetchType resultFetchType = 8
repeated string documentFields = 9
repeated string documentMaskedFields = 10
bool fetchFull = 11
repeated FieldSimilarity fieldSimilarity = 12
repeated HighlightRequest highlightRequest = 13
repeated AnalysisRequest analysisRequest = 14
bool debug = 15
bool dontCache = 16
PrimaryReplicaSettings primaryReplicaSettings = 17
bool pinToCache = 18
string searchLabel = 19
bool realtime = 20
uint32 concurrency = 21

Used as request type in: ZuliaService.InternalReindex, ZuliaService.Reindex

string indexName = 1

Used as response type in: ZuliaService.InternalReindex, ZuliaService.Reindex

(message has no fields)

optional IndexSettings indexSettings = 1
repeated QueryRequest warmingSearch = 2

Used in: FetchResponse, ScoredResult, StoreRequest

string uniqueId = 1
string indexName = 2
bytes document = 3
bytes metadata = 4
int64 timestamp = 5

Used in: LastIndexResult, QueryResponse, ShardQueryResponse

string uniqueId = 1
float score = 2
uint32 luceneShardId = 3
string indexName = 4
uint32 shard = 5
uint32 resultIndex = 6
optional SortValues sortValues = 7
int64 timestamp = 8
optional ResultDocument resultDocument = 9
repeated HighlightResult highlightResult = 10
repeated AnalysisResult analysisResult = 11

Used in: GetSegmentFileInfoResponse

string fileName = 1
int64 length = 2
string checksum = 3

Used in: IndexStats

bool primary = 1
optional CacheStats pinnedCache = 2
optional CacheStats generalCache = 3

Used in: GetNumberOfDocsResponse

uint32 shardNumber = 1
uint32 numberOfDocs = 2
uint64 sizeOnDiskBytes = 3

Used in: IndexShardMapping

uint32 shardNumber = 1
optional Node primaryNode = 2
repeated Node replicaNode = 3

Used in: IndexShardResponse

uint32 shardNumber = 1
string indexName = 2
uint32 totalHits = 3
repeated ScoredResult scoredResult = 4
optional ScoredResult next = 5
repeated FacetGroup facetGroup = 6
repeated AnalysisResult analysisResult = 7
repeated StatGroupInternal statGroup = 8
bool cached = 9
bool pinned = 10

Used in: AnalyzerSettings, FieldSimilarity

BM25 = 0
TFIDF = 1
CONSTANT = 2
TF = 3

Used in: FieldConfig

string sortFieldName = 1
SortAs.StringHandling stringHandling = 2

Used in: SortAs

STANDARD = 0
LOWERCASE = 1
FOLDING = 2
LOWERCASE_FOLDING = 3

Used in: QueryRequest

repeated FieldSort fieldSort = 1

Used in: FacetStats, FacetStatsInternal, SortValues

bool exists = 1
string stringValue = 2
int32 integerValue = 3
int64 longValue = 4
float floatValue = 5
double doubleValue = 6
int64 dateValue = 7

Used in: ScoredResult

repeated SortValue sortValue = 1

Used in: QueryResponse

optional StatRequest statRequest = 1
optional FacetStats globalStats = 2
repeated FacetStats facetStats = 3

Internal message to handle larger DDSketch facet stats

Used in: ShardQueryResponse

optional StatRequest statRequest = 1
optional FacetStatsInternal globalStats = 2
repeated FacetStatsInternal facetStats = 3

Used in: FacetRequest, StatGroup, StatGroupInternal

string numericField = 1
optional Facet facetField = 2
uint32 maxFacets = 3
default 10, set to -1 to get all
uint32 shardFacets = 4
defaults to maxFacets * 10, ignored for single shard indexes, set to -1 to get all
double precision = 5
Specify the precision to be used in this request. Default is 0.001
repeated double percentiles = 6
uint64 maxTotalHitsForFacet = 7
0 = no limit (default, backward compatible); skip this stat if totalHits exceeds threshold
uint64 maxShardHitsForFacet = 8
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: DDSketch

map<sint32, double> binCounts = 1
The bin counts, encoded sparsely.
repeated double contiguousBinCounts = 2
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.
sint32 contiguousBinIndexOffset = 3

Used as request type in: ZuliaService.InternalStore, ZuliaService.Store

string uniqueId = 1
string indexName = 2
optional ResultDocument resultDocument = 3
repeated AssociatedDocument associatedDocument = 4
repeated ExternalDocument externalDocument = 5
bool clearExistingAssociated = 6

Used as response type in: ZuliaService.InternalStore, ZuliaService.Store

(message has no fields)

uint32 inputDim = 1
uint32 batches = 2
default 1
uint32 seed = 3
default 1357

Used in: AnalysisResult, GetTermsResponse

string value = 1
uint64 docFreq = 2
uint64 termFreq = 3
double score = 4

Used in: UpdateIndexRequest

bool setDefaultSearchField = 1
repeated string defaultSearchField = 2
repeated AnalyzerSettings analyzerSettings = 3
optional UpdateIndexSettings.Operation analyzerSettingsOperation = 4
keyed by name
repeated FieldConfig fieldConfig = 5
optional UpdateIndexSettings.Operation fieldConfigOperation = 6
keyed by storedFieldName
bool setRequestFactor = 7
double requestFactor = 8
bool setMinShardRequest = 9
uint32 minShardRequest = 10
bool setShardTolerance = 11
double shardTolerance = 12
bool setShardQueryCacheSize = 13
uint32 shardQueryCacheSize = 14
bool setShardQueryCacheMaxAmount = 15
uint32 shardQueryCacheMaxAmount = 16
bool setIdleTimeWithoutCommit = 17
uint32 idleTimeWithoutCommit = 18
bool setShardCommitInterval = 19
uint32 shardCommitInterval = 20
bool setIndexWeight = 21
uint32 indexWeight = 22
bool setRamBufferMB = 23
uint32 ramBufferMB = 24
optional UpdateIndexSettings.Operation metaUpdateOperation = 25
bytes metadata = 26
optional UpdateIndexSettings.Operation warmingSearchesOperation = 27
repeated bytes warmingSearches = 28
repeated FieldMapping fieldMapping = 29
optional UpdateIndexSettings.Operation fieldMappingOperation = 30
keyed by alias
bool setDisableCompression = 31
bool disableCompression = 32
bool setDefaultConcurrency = 33
uint32 defaultConcurrency = 34
bool setDescription = 35
string description = 36
bool setMaxMergeThreads = 37
int32 maxMergeThreads = 38
bool setMaxMergePending = 39
int32 maxMergePending = 40
bool setIndexingThrottle = 41
uint32 indexingThrottle = 42
bool setNrtIndexMaxMergeSizeMB = 43
uint32 nrtIndexMaxMergeSizeMB = 44
bool setNrtIndexMaxCachedMB = 45
uint32 nrtIndexMaxCachedMB = 46
bool setNrtTaxoMaxMergeSizeMB = 47
uint32 nrtTaxoMaxMergeSizeMB = 48
bool setNrtTaxoMaxCachedMB = 49
uint32 nrtTaxoMaxCachedMB = 50
bool setNrtCachingDisabled = 51
bool nrtCachingDisabled = 52
bool setNumberOfReplicas = 53
uint32 numberOfReplicas = 54
bool setTransientIndex = 55
bool transientIndex = 56

Used in: UpdateIndexSettings

bool enable = 1
Operation.OperationType operationType = 2
repeated string removedKeys = 3

Used in: Operation

MERGE = 0
REPLACE = 1

message VectorDescription

zulia_index.proto:230

Properties of the vector data itself, shared by every indexed representation of the field. Per-representation indexing choices (quantization, HNSW) live in VectorIndexingConfig on each IndexAs.

Used in: FieldConfig

VectorDescription.Similarity similarity = 1
uint32 dimensions = 2
0 = infer at index time. When set, vector length is validated on store
string modelName = 3
Provenance only. Records which embedding model produced these vectors. The server does not run inference
e.g. "BAAI/bge-large-en-v1.5"
string modelDescription = 4
optional free-text notes about the model/vectors

enum VectorDescription.Similarity

zulia_index.proto:231

Used in: VectorDescription

DEFAULT = 0
derive from field type (VECTOR=COSINE, UNIT_VECTOR=DOT_PRODUCT)
COSINE = 1
DOT_PRODUCT = 2
EUCLIDEAN = 3
MAX_INNER_PRODUCT = 4

How one indexed representation of a dense-vector field is encoded on disk. Lives on IndexAs, so one stored field indexed under multiple names can carry a different encoding per name. With no config the encoding resolves by createdIndexVersion (INT8 for new indexes, FLOAT32 for legacy).

Used in: IndexAs

VectorIndexingConfig.Encoding encoding = 1
an explicit value (incl FLOAT32) is authoritative
VectorIndexingConfig.IndexType indexType = 2
uint32 hnswM = 3
0 means 16
uint32 hnswEfConstruction = 4
0 means 100

Used in: VectorIndexingConfig

ENCODING_UNSPECIFIED = 0
no explicit choice, the server applies the index-creation-version default
FLOAT32 = 1
raw float32 HNSW (Lucene99HnswVectorsFormat). Explicit opt-out of quantization
INT8 = 2
8-bit scalar quant (UNSIGNED_BYTE)
INT7 = 3
7-bit scalar quant (SEVEN_BIT)
INT4 = 4
4-bit scalar quant (PACKED_NIBBLE)
BBQ = 5
1-bit Better Binary Quantization (SINGLE_BIT_QUERY_NIBBLE)
BBQ_2BIT = 6
2-bit binary quant (DIBIT_QUERY_NIBBLE)

Used in: VectorIndexingConfig

HNSW = 0
approximate nearest neighbor graph
FLAT = 1
exact brute force (quantized flat)

Used in: MoreLikeThisParams

repeated float values = 1

Default package

service ZuliaService

rpc BatchDelete (BatchDeleteRequest, stream DeleteResponse)

message BatchDeleteRequest

repeated DeleteRequest request = 1

repeated BatchDeleteGroup batchDeleteGroup = 2

rpc BatchFetch (BatchFetchRequest, stream FetchResponse)

message BatchFetchRequest

repeated FetchRequest fetchRequest = 1

repeated BatchFetchGroup batchFetchGroup = 2

rpc Clear (ClearRequest, ClearResponse)

rpc CreateIndex (CreateIndexRequest, CreateIndexResponse)

message CreateIndexRequest

optional IndexSettings indexSettings = 1

message CreateIndexResponse

bool changed = 1

rpc CreateIndexAlias (CreateIndexAliasRequest, CreateIndexAliasResponse)

message CreateIndexAliasRequest

optional IndexAlias indexAlias = 1

rpc Delete (DeleteRequest, DeleteResponse)

rpc DeleteIndex (DeleteIndexRequest, DeleteIndexResponse)

rpc DeleteIndexAlias (DeleteIndexAliasRequest, DeleteIndexAliasResponse)

rpc Fetch (FetchRequest, FetchResponse)

rpc GetFieldNames (GetFieldNamesRequest, GetFieldNamesResponse)

rpc GetIndexSettings (GetIndexSettingsRequest, GetIndexSettingsResponse)

message GetIndexSettingsRequest

string indexName = 1

message GetIndexSettingsResponse

optional IndexSettings indexSettings = 1

rpc GetIndexes (GetIndexesRequest, GetIndexesResponse)

message GetIndexesRequest

message GetIndexesResponse

repeated string indexName = 1

rpc GetNodes (GetNodesRequest, GetNodesResponse)

message GetNodesRequest

bool activeOnly = 1

message GetNodesResponse

repeated Node node = 1

repeated IndexShardMapping indexShardMapping = 2

repeated IndexAlias indexAlias = 3

rpc GetNumberOfDocs (GetNumberOfDocsRequest, GetNumberOfDocsResponse)

rpc GetTerms (GetTermsRequest, GetTermsResponse)

rpc InternalBatchDelete (InternalBatchDeleteRequest, BatchDeleteResponse)

message InternalBatchDeleteRequest

repeated InternalShardBatchDeleteRequest shardBatchDeleteRequest = 1

message BatchDeleteResponse

repeated DeleteResponse deleteResponse = 1

rpc InternalBatchFetch (InternalBatchFetchRequest, BatchFetchResponse)

message InternalBatchFetchRequest

repeated InternalShardBatchFetchRequest shardBatchFetchRequest = 1

message BatchFetchResponse

repeated FetchResponse fetchResponse = 1

rpc InternalClear (ClearRequest, ClearResponse)

rpc InternalCreateIndexAlias (InternalCreateIndexAliasRequest, CreateIndexAliasResponse)

message InternalCreateIndexAliasRequest

string aliasName = 1

rpc InternalCreateOrUpdateIndex (InternalCreateOrUpdateIndexRequest, InternalCreateOrUpdateIndexResponse)

message InternalCreateOrUpdateIndexRequest

string indexName = 1

message InternalCreateOrUpdateIndexResponse

bool loaded = 1

rpc InternalDelete (DeleteRequest, DeleteResponse)

rpc InternalDeleteIndex (DeleteIndexRequest, DeleteIndexResponse)

rpc InternalDeleteIndexAlias (DeleteIndexAliasRequest, DeleteIndexAliasResponse)

rpc InternalFetch (FetchRequest, FetchResponse)

rpc InternalGetFieldNames (InternalGetFieldNamesRequest, GetFieldNamesResponse)

message InternalGetFieldNamesRequest

optional GetFieldNamesRequest getFieldNamesRequest = 1

optional IndexRouting indexRouting = 2

rpc InternalGetNumberOfDocs (InternalGetNumberOfDocsRequest, GetNumberOfDocsResponse)

message InternalGetNumberOfDocsRequest

optional GetNumberOfDocsRequest getNumberOfDocsRequest = 1

optional IndexRouting indexRouting = 2

rpc InternalGetSegmentFileInfo (GetSegmentFileInfoRequest, GetSegmentFileInfoResponse)

message GetSegmentFileInfoRequest

string indexName = 1

int32 shardNumber = 2

bool taxonomy = 3

message GetSegmentFileInfoResponse

int64 generation = 1