Immutable set of parameters controlling a vector search, such as the search terms, paging and highlighting. Built with a SearchParametersBuilder, obtained from VectorSearchManager.searchParametersBuilder, and passed to VectorSearchManager.search.
Implements: Serializable
Properties
| Property | Returns | Description |
|---|---|---|
| concepts | List<String> | Search terms to match against, joined together and used both for keyword matching and to generate the query's embedding vector. A search with no concepts returns no results. |
| fragmentCount | Integer | Maximum number of highlighted content fragments to return per matching document. Defaults to 3 if null. |
| fragmentSize | Integer | Maximum length, in characters, of each highlighted content fragment. Defaults to 1000 if null. |
| limit | Integer | Maximum number of results to return. Treated as one if null or less than one. |
| offset | Integer | Number of leading results to skip, for paging through matches. Ignored if null or not greater than zero. |
| score | Float | Minimum relevance score a result must have to be included. Results are unrestricted by score if null. |
Methods
getConcepts()
Returns: List<String>
Search terms to match against, joined together and used both for keyword matching and to generate the query's embedding vector. A search with no concepts returns no results.
getLimit()
Returns: Integer
Maximum number of results to return. Treated as one if null or less than one.
getOffset()
Returns: Integer
Number of leading results to skip, for paging through matches. Ignored if null or not greater than zero.
getScore()
Returns: Float
Minimum relevance score a result must have to be included. Results are unrestricted by score if null.
getFragmentSize()
Returns: Integer
Maximum length, in characters, of each highlighted content fragment. Defaults to 1000 if null.
getFragmentCount()
Returns: Integer
Maximum number of highlighted content fragments to return per matching document. Defaults to 3 if null.