kdrant-core/dev.kdrant.model/ScrollRequest

ScrollRequest

@Serializable

data class ScrollRequest(val filter: Filter? = null, val limit: Int, val offset: PointId? = null, val withPayload: WithPayload? = null, val withVector: Boolean? = null, val orderBy: OrderBy? = null, val shardKey: ShardKey? = null)

Request body for a single POST /collections/{name}/points/scroll page.

Constructors

ScrollRequest

constructor(filter: Filter? = null, limit: Int, offset: PointId? = null, withPayload: WithPayload? = null, withVector: Boolean? = null, orderBy: OrderBy? = null, shardKey: ShardKey? = null)

Properties

filter

@SerialName(value = "filter")

val filter: Filter?

limit

@SerialName(value = "limit")

val limit: Int

offset

@SerialName(value = "offset")

val offset: PointId?

Page cursor: the point id to start at, inclusive — Qdrant returns it as ScrollPage.nextPageOffset, the first id of the next page. null for the first page.

orderBy

@SerialName(value = "order_by")

val orderBy: OrderBy?

Order the page by a payload key instead of by point id. Qdrant rejects an ordered scroll that also carries an offset and never returns a ScrollPage.nextPageOffset for one, so an ordered scroll pages through OrderBy.startFrom rather than through the id cursor.

shardKey

@SerialName(value = "shard_key")

val shardKey: ShardKey?

Restrict the scroll to the shards holding this key. null reads every shard.

withPayload

@SerialName(value = "with_payload")

val withPayload: WithPayload?

withVector

@SerialName(value = "with_vector")

val withVector: Boolean?