couchbase-lite-ee/kotbase/predictiveIndex

predictiveIndex

expect fun IndexBuilder.predictiveIndex(model: String, input: Expression, properties: List<String>? = null): PredictiveIndex(source)

ENTERPRISE EDITION API

Create a predictive index with the given predictive model name, input specification to the predictive model, and the properties of the prediction result.

The input given specification should be matched to the input specification given to the query prediction() function so that the predictive index can be matched and used in query.

The predictive index is different from the normal index in that the predictive index will also cache the prediction result along with creating the value index of the specified properties. If the properties are not specified, the predictive index will only cache the prediction result so that the prediction model will not be called again after indexing. If multiple properties are specified, a compound value index will be created from the given properties.

Return

The predictive index.

Parameters

model

The predictive model name.

input

The input specification that should be matched with the input specification given to the query prediction function.

properties

The prediction result's properties to be indexed.

actual fun IndexBuilder.predictiveIndex(model: String, input: Expression, properties: List<String>?): PredictiveIndex(source)
actual fun IndexBuilder.predictiveIndex(model: String, input: Expression, properties: List<String>?): PredictiveIndex(source)