Package-level declarations

Types

Link copied to clipboard

DSL for searchBatch: accumulate several searches to run in a single request.

Link copied to clipboard

DSL for the conditions inside a filter clause. Offers both function-style (match("city", "London"), range("price", gte = 100.0)) and infix-style ("city" eq "London", "price" between 100.0..450.0) entry points.

Link copied to clipboard

DSL for a context query: pairs of positive/negative examples.

Link copied to clipboard

DSL for createCollection. Configure exactly one of a single vector or one-or-more named vectors.

Link copied to clipboard

DSL for a discovery query: a target plus context example pairs.

Link copied to clipboard

DSL for a Filter's four clauses: must, should, mustNot, minShould.

Link copied to clipboard

Builds a point Payload (a JSON object) with heterogeneous values.

Link copied to clipboard

DSL for a single point's vector and payload.

Link copied to clipboard

DSL for a Prefetch sub-request. Like SearchBuilder but without response-shaping options (offset, with_payload, with_vector), which apply only to the outer request.

Link copied to clipboard

DSL for a recommend query: positive / negative examples plus an optional strategy.

Link copied to clipboard

DSL for scroll. The page size is fixed by the scroll(pageSize = ...) argument.

Link copied to clipboard

DSL for search (/points/query). Provide a query (vector, id, fusion, order-by, sample) and/or one or more prefetch sub-requests, plus a positive limit.

Link copied to clipboard

DSL for the distance-matrix analytics endpoints (searchMatrixPairs / searchMatrixOffsets).

Link copied to clipboard
Link copied to clipboard

DSL for a sparse vector's parameters.

Link copied to clipboard

DSL for updateAliases. Every action added here is applied by the server as one atomic batch, so an alias never points at nothing during a swap.

Link copied to clipboard

DSL for updateCollection. All fields optional; omitted ones keep the collection's current value.

Link copied to clipboard

DSL for upsert: accumulate points with point.

Link copied to clipboard

DSL for a single vector's parameters.

Functions

Link copied to clipboard
fun filter(configure: FilterBuilder.() -> Unit): Filter

Builds a Filter from the given clauses.

Link copied to clipboard
fun payloadOf(vararg pairs: Pair<String, Any?>): Payload

Convenience: build a Payload from key/value pairs, e.g. payloadOf("lang" to "it", "year" to 2024).