WithPayload

@Serializable(with = WithPayloadSerializer::class)
sealed interface WithPayload

Payload projection for search/scroll results. Qdrant accepts four wire shapes:

  • true ->All

  • false ->None

  • ["a","b"] (shorthand) or {"include":["a","b"]} ->Include

  • {"exclude":["a","b"]} ->Exclude

Inheritors

Types

Link copied to clipboard
data object All : WithPayload

Return the whole payload.

Link copied to clipboard
object Companion
Link copied to clipboard
data class Exclude(val fields: List<String>) : WithPayload

Return the whole payload except the listed keys.

Link copied to clipboard
data class Include(val fields: List<String>) : WithPayload

Return only the listed keys.

Link copied to clipboard
data object None : WithPayload

Return no payload.