CollectionInfo

@Serializable
data class CollectionInfo(val status: CollectionStatus = CollectionStatus.UNKNOWN, val pointsCount: Long? = null, val indexedVectorsCount: Long? = null, val segmentsCount: Int? = null, val config: CollectionConfig? = null, val payloadSchema: Map<String, PayloadIndexInfo> = emptyMap())

Summary of a collection returned by getCollection.

Constructors

Link copied to clipboard
constructor(status: CollectionStatus = CollectionStatus.UNKNOWN, pointsCount: Long? = null, indexedVectorsCount: Long? = null, segmentsCount: Int? = null, config: CollectionConfig? = null, payloadSchema: Map<String, PayloadIndexInfo> = emptyMap())

Properties

Link copied to clipboard
@SerialName(value = "config")
val config: CollectionConfig?

The collection's stored configuration. This is the read-back that makes a rerunnable bootstrap script able to check what it found rather than assume it — see ensureCollection.

Link copied to clipboard
@SerialName(value = "indexed_vectors_count")
val indexedVectorsCount: Long?
Link copied to clipboard
@SerialName(value = "payload_schema")
val payloadSchema: Map<String, PayloadIndexInfo>

The payload field indexes that exist, keyed by field name.

Link copied to clipboard
@SerialName(value = "points_count")
val pointsCount: Long?
Link copied to clipboard
@SerialName(value = "segments_count")
val segmentsCount: Int?
Link copied to clipboard
@SerialName(value = "status")
val status: CollectionStatus