Package-level declarations

Types

Link copied to clipboard
@Serializable
data class Feedback(val query: String, val objectId: String, val label: FinetuneLabel)
Link copied to clipboard
@Serializable
data class FieldConfig(val allow: List<String>, val deny: List<String>)
Link copied to clipboard
@Serializable
data class Fields(val searchable: FieldConfig, val crawlable: FieldConfig? = null, val filterable: FieldConfig? = null, val types: Map<String, String>? = null, val segmentDelimiter: Map<String, String>? = null)
Link copied to clipboard
@Serializable
enum FinetuneLabel : Enum<FinetuneLabel>
Link copied to clipboard
@Serializable
data class Finetuning(val baseIndexId: String, val feedback: List<Feedback>)
Link copied to clipboard
@Serializable
data class Highlights(val text: Boolean)
Link copied to clipboard
@Serializable
data class Id(val id: IndexId)
Link copied to clipboard
@Serializable
data class Index(val id: String, val createdAt: Instant, val updatedAt: Instant)
Link copied to clipboard
@Serializable
data class IndexConfiguration(val indexType: IndexType = IndexType(), val fields: Fields)
Link copied to clipboard
@Serializable
data class Indexes(val indexes: List<Index>, val pagination: Pagination)
Link copied to clipboard
typealias IndexId = String
Link copied to clipboard
@Serializable
enum IndexStatus : Enum<IndexStatus>
Link copied to clipboard
@Serializable
data class IndexStatuses(val uploaded: Int, val processing: Int, val ready: Int, val error: Int) : Map<IndexStatus, Int>
Link copied to clipboard
@Serializable
data class IndexStatusResponse(val status: IndexStatuses)
Link copied to clipboard
@Serializable
data class IndexType(val name: IndexTypeName = IndexTypeName.TEXT, val highlights: Highlights? = null, val finetuning: Finetuning? = null, val version: String? = null)
Link copied to clipboard
@Serializable
enum IndexTypeName : Enum<IndexTypeName>