| Package | Description |
|---|---|
| io.lettuce.core.search.arguments |
| Modifier and Type | Method and Description |
|---|---|
static <K,V> SearchArgs.Builder<K,V> |
SearchArgs.builder()
Used to build a new instance of the
SearchArgs. |
SearchArgs.Builder<K,V> |
SearchArgs.Builder.dialect(QueryDialects dialect)
Set the query dialect.
|
SearchArgs.Builder<K,V> |
SearchArgs.Builder.expander(V expander)
Use a custom query expander instead of the stemmer
|
SearchArgs.Builder<K,V> |
SearchArgs.Builder.highlightArgs(HighlightArgs<K,V> highlightFilter)
Format occurrences of matched text.
|
SearchArgs.Builder<K,V> |
SearchArgs.Builder.highlightField(K field)
Convenience method to build
HighlightArgs
Add a field to highlight. |
SearchArgs.Builder<K,V> |
SearchArgs.Builder.highlightTags(V startTag,
V endTag)
Convenience method to build
HighlightArgs
Tags to surround the matched terms with. |
SearchArgs.Builder<K,V> |
SearchArgs.Builder.inField(K field)
Filter the result to those appearing only in specific attributes of the document.
|
SearchArgs.Builder<K,V> |
SearchArgs.Builder.inKey(K key)
Limit the result to a given set of keys specified in the list.
|
SearchArgs.Builder<K,V> |
SearchArgs.Builder.inOrder()
Require the terms in the document to have the same order as the terms in the query, regardless of the offsets between
them.
|
SearchArgs.Builder<K,V> |
SearchArgs.Builder.language(DocumentLanguage language)
Specify the language of the query.
|
SearchArgs.Builder<K,V> |
SearchArgs.Builder.limit(long offset,
long number)
Limit the results to the offset and number of results given.
|
SearchArgs.Builder<K,V> |
SearchArgs.Builder.noContent()
Returns the document ids and not the content.
|
SearchArgs.Builder<K,V> |
SearchArgs.Builder.param(K name,
V value)
Add one or more value parameters.
|
SearchArgs.Builder<K,V> |
SearchArgs.Builder.returnField(K field)
Limit the attributes returned from the document.
|
SearchArgs.Builder<K,V> |
SearchArgs.Builder.returnField(K field,
K as)
Limit the attributes returned from the document.
|
SearchArgs.Builder<K,V> |
SearchArgs.Builder.scorer(ScoringFunction scorer)
Use a built-in or a user-provided scoring function
|
SearchArgs.Builder<K,V> |
SearchArgs.Builder.slop(long slop)
Allow for a number of intermediate terms allowed to appear between the terms of the query.
|
SearchArgs.Builder<K,V> |
SearchArgs.Builder.sortBy(SortByArgs<K> sortBy)
Order the results by the value of this attribute.
|
SearchArgs.Builder<K,V> |
SearchArgs.Builder.summarizeArgs(SummarizeArgs<K,V> summarizeFilter)
Return only the sections of the attribute that contain the matched text.
|
SearchArgs.Builder<K,V> |
SearchArgs.Builder.summarizeField(K field)
Convenience method to build
SummarizeArgs
Add a field to summarize. |
SearchArgs.Builder<K,V> |
SearchArgs.Builder.summarizeFragments(long fragments)
Convenience method to build
SummarizeArgs
Set the number of fragments to be returned. |
SearchArgs.Builder<K,V> |
SearchArgs.Builder.summarizeLen(long len)
Convenience method to build
SummarizeArgs
Set the number of context words each fragment should contain. |
SearchArgs.Builder<K,V> |
SearchArgs.Builder.summarizeSeparator(V separator)
Convenience method to build
SummarizeArgs
The string used to divide individual summary snippets. |
SearchArgs.Builder<K,V> |
SearchArgs.Builder.timeout(Duration timeout)
Override the maximum time to wait for the query to complete.
|
SearchArgs.Builder<K,V> |
SearchArgs.Builder.verbatim()
Do not try to use stemming for query expansion but searches the query terms verbatim.
|
SearchArgs.Builder<K,V> |
SearchArgs.Builder.withScores()
Return the relative internal score of each document.
|
SearchArgs.Builder<K,V> |
SearchArgs.Builder.withSortKeys()
Return the value of the sorting key, right after the id and score and/or payload, if requested.
|
Copyright © 2025 lettuce.io. All rights reserved.