Package-level declarations

Types

Link copied to clipboard
@Serializable
class GetVectorOptions(val vectorBucketName: String, val indexName: String)

Options for batch reading vectors

Link copied to clipboard
@Serializable
class ListVectorsOptions(val vectorBucketName: String, val indexName: String)

Options for listing/scanning vectors in an index Supports parallel scanning via segment configuration

Link copied to clipboard
@Serializable
data class ListVectorsResponse(val vectors: List<VectorMatch>, val nextToken: String? = null)

Response from listing vectors

Link copied to clipboard
class QueryVectorsOptions(val vectorBucketName: String, val indexName: String)

Options for querying similar vectors (ANN search)

Link copied to clipboard
@Serializable
class QueryVectorsResponse(val vectors: List<VectorMatch>, val distanceMetric: DistanceMetric? = null)

Response from vector similarity query

Link copied to clipboard
@Serializable
class VectorData(val float32: FloatArray)

Vector data representation Vectors must be float32 arrays with dimensions matching the index

Link copied to clipboard
interface VectorDataApi

Interface for vector data operations.

Link copied to clipboard
@Serializable
data class VectorMatch(val key: String, val data: VectorData? = null, val metadata: JsonObject? = null, val distance: Int? = null)

Vector object returned from queries with optional distance

Link copied to clipboard
@Serializable
data class VectorObject(val key: String, val data: VectorData, val metadata: JsonObject)

Single vector object for insertion/update