VectorIndexApi

Interface for index management and access to vector operations.

Functions

Link copied to clipboard
abstract suspend fun createIndex(options: CreateIndexOptions.() -> Unit)

Creates a new vector index in this bucket Convenience method that automatically includes the bucket name

Link copied to clipboard
abstract suspend fun deleteIndex(indexName: String)

Deletes an index from this bucket Convenience method that automatically includes the bucket name

Link copied to clipboard
abstract suspend fun getIndex(indexName: String): VectorIndex

Retrieves metadata for a specific index in this bucket Convenience method that automatically includes the bucket name

Link copied to clipboard
abstract fun index(indexName: String): VectorDataApi

Access operations for a specific index within this bucket Returns a scoped client for vector data operations

Link copied to clipboard
abstract suspend fun listIndexes(options: ListIndexesOptions.() -> Unit = {}): ListIndexesResponse

Lists indexes in this bucket Convenience method that automatically includes the bucket name