Uses of Class
io.lettuce.core.search.arguments.SearchArgs.Builder

Packages that use SearchArgs.Builder

Package	Description
io.lettuce.core.search.arguments

Uses of SearchArgs.Builder in io.lettuce.core.search.arguments

Methods in io.lettuce.core.search.arguments that return SearchArgs.Builder

Modifier and Type	Method and Description
static <K> SearchArgs.Builder<K>	SearchArgs.builder() Used to build a new instance of the SearchArgs.
SearchArgs.Builder<K>	SearchArgs.Builder.dialect(QueryDialects dialect) Set the query dialect.
SearchArgs.Builder<K>	SearchArgs.Builder.expander(String expander) Use a custom query expander instead of the stemmer
SearchArgs.Builder<K>	SearchArgs.Builder.highlightArgs(HighlightArgs highlightFilter) Format occurrences of matched text.
SearchArgs.Builder<K>	SearchArgs.Builder.highlightField(String field) Convenience method to build HighlightArgs Add a field to highlight.
SearchArgs.Builder<K>	SearchArgs.Builder.highlightTags(String startTag, String endTag) Convenience method to build HighlightArgs Tags to surround the matched terms with.
SearchArgs.Builder<K>	SearchArgs.Builder.inField(String field) Filter the result to those appearing only in specific attributes of the document.
SearchArgs.Builder<K>	SearchArgs.Builder.inKey(K key) Limit the result to a given set of keys specified in the list.
SearchArgs.Builder<K>	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>	SearchArgs.Builder.language(DocumentLanguage language) Specify the language of the query.
SearchArgs.Builder<K>	SearchArgs.Builder.limit(long offset, long number) Limit the results to the offset and number of results given.
SearchArgs.Builder<K>	SearchArgs.Builder.noContent() Returns the document ids and not the content.
SearchArgs.Builder<K>	SearchArgs.Builder.param(String name, byte[] value) Add a binary query parameter, for example the query vector of a KNN clause (*=>[KNN 10 @embedding $vec]).
SearchArgs.Builder<K>	SearchArgs.Builder.param(String name, String value) Add a query parameter.
SearchArgs.Builder<K>	SearchArgs.Builder.returnField(String field) Limit the attributes returned from the document.
SearchArgs.Builder<K>	SearchArgs.Builder.returnField(String field, String as) Limit the attributes returned from the document.
SearchArgs.Builder<K>	SearchArgs.Builder.scorer(ScoringFunction scorer) Use a built-in or a user-provided scoring function
SearchArgs.Builder<K>	SearchArgs.Builder.slop(long slop) Allow for a number of intermediate terms allowed to appear between the terms of the query.
SearchArgs.Builder<K>	SearchArgs.Builder.sortBy(SortByArgs sortBy) Order the results by the value of this attribute.
SearchArgs.Builder<K>	SearchArgs.Builder.summarizeArgs(SummarizeArgs summarizeFilter) Return only the sections of the attribute that contain the matched text.
SearchArgs.Builder<K>	SearchArgs.Builder.summarizeField(String field) Convenience method to build SummarizeArgs Add a field to summarize.
SearchArgs.Builder<K>	SearchArgs.Builder.summarizeFragments(long fragments) Convenience method to build SummarizeArgs Set the number of fragments to be returned.
SearchArgs.Builder<K>	SearchArgs.Builder.summarizeLen(long len) Convenience method to build SummarizeArgs Set the number of context words each fragment should contain.
SearchArgs.Builder<K>	SearchArgs.Builder.summarizeSeparator(String separator) Convenience method to build SummarizeArgs The string used to divide individual summary snippets.
SearchArgs.Builder<K>	SearchArgs.Builder.timeout(Duration timeout) Override the maximum time to wait for the query to complete.
SearchArgs.Builder<K>	SearchArgs.Builder.verbatim() Do not try to use stemming for query expansion but searches the query terms verbatim.
SearchArgs.Builder<K>	SearchArgs.Builder.withScores() Return the relative internal score of each document.
SearchArgs.Builder<K>	SearchArgs.Builder.withSortKeys() Return the value of the sorting key of each document, exposed through SearchReply.SearchResult.getSortKey().