SimilaritySearchRequest

data class SimilaritySearchRequest(val queryText: String, val limit: Int = 10, val offset: Int = 0, val minScore: Double? = null, val filterExpression: String? = null) : SearchRequest, HasTextQuery, HasScoreThreshold, HasFilterExpression(source)

A search request that performs similarity (vector) search using the provided query text.

The query text is typically converted into an embedding vector by the storage backend and compared against stored document vectors.

Constructors

Link copied to clipboard
constructor(queryText: String, limit: Int = 10, offset: Int = 0, minScore: Double? = null, filterExpression: String? = null)

Properties

Link copied to clipboard
open override val filterExpression: String?

optional filter expression to narrow down results

Link copied to clipboard
open override val limit: Int

maximum number of results to return (default: 10)

Link copied to clipboard
open override val minScore: Double?

optional minimum similarity score threshold

Link copied to clipboard
open override val offset: Int

number of results to skip for pagination (default: 0)

Link copied to clipboard
open override val queryText: String

the text query to find similar documents for