SearchArgs.Builder (Lettuce 7.8.0.RELEASE API)

java.lang.Object
- io.lettuce.core.search.arguments.SearchArgs.Builder<K>

Type Parameters:

K - the key type

Enclosing class:

SearchArgs<K>
```
public static class SearchArgs.Builder<K>
extends Object
```
Builder for SearchArgs.
As a final step the build() method needs to be executed to create the final SearchArgs instance.

See Also:

FT.CREATE

Constructor Summary

Constructors
Constructor and Description

Builder()

Constructors
Constructor and Description
`Builder()`

Method Summary

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

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Builder
```
public Builder()
```
- Method Detail
  - build
```
public SearchArgs<K> build()
```
    Build a new instance of the SearchArgs.
    
    Returns:
    
    a new instance of the SearchArgs
  - noContent
```
public SearchArgs.Builder<K> noContent()
```
    Returns the document ids and not the content. This is useful if RediSearch is only an index on an external document collection. Disabled by default.
    
    Returns:
    
    the instance of the current SearchArgs.Builder for the purpose of method chaining
  - verbatim
```
public SearchArgs.Builder<K> verbatim()
```
    Do not try to use stemming for query expansion but searches the query terms verbatim. Disabled by default.
    
    Returns:
    
    the instance of the current SearchArgs.Builder for the purpose of method chaining
  - withScores
```
public SearchArgs.Builder<K> withScores()
```
    Return the relative internal score of each document. This can be used to merge results from multiple instances. Disabled by default.
    
    Returns:
    
    the instance of the current SearchArgs.Builder for the purpose of method chaining
  - withSortKeys
```
public SearchArgs.Builder<K> withSortKeys()
```
    Return the value of the sorting key of each document, exposed through SearchReply.SearchResult.getSortKey(). This is usually not needed, and exists for distributed search coordination purposes (merging sorted results from several indexes or shards). This option is relevant only if used in conjunction with sortBy(SortByArgs): without SORTBY every result has a null sort key. Disabled by default.
    
    Returns:
    
    the instance of the current SearchArgs.Builder for the purpose of method chaining
  - inKey
```
public SearchArgs.Builder<K> inKey(K key)
```
    Limit the result to a given set of keys specified in the list. Non-existent keys are ignored, unless all the keys are non-existent.
    
    Parameters:
    
    key - the key to search in
    
    Returns:
    
    the instance of the current SearchArgs.Builder for the purpose of method chaining
  - inField
```
public SearchArgs.Builder<K> inField(String field)
```
    Filter the result to those appearing only in specific attributes of the document.
    
    Parameters:
    
    field - the field to search in
    
    Returns:
    
    the instance of the current SearchArgs.Builder for the purpose of method chaining
  - returnField
```
public SearchArgs.Builder<K> returnField(String field,
                                         String as)
```
    Limit the attributes returned from the document. The field is either an attribute name (for hashes and JSON) or a JSON Path expression (for JSON). as is the name of the field used in the result as an alias.
    Fields are requested in the order in which they are added. Adding a field that was already added replaces its alias but keeps its position.
    
    Parameters:
    
    field - the field to return
    
    as - the alias to use for this field in the result
    
    Returns:
    
    the instance of the current SearchArgs.Builder for the purpose of method chaining
  - returnField
```
public SearchArgs.Builder<K> returnField(String field)
```
    Limit the attributes returned from the document. The field is either an attribute name (for hashes and JSON) or a JSON Path expression (for JSON).
    Fields are requested in the order in which they are added.
    
    Parameters:
    
    field - the field to return
    
    Returns:
    
    the instance of the current SearchArgs.Builder for the purpose of method chaining
  - summarizeArgs
```
public SearchArgs.Builder<K> summarizeArgs(SummarizeArgs summarizeFilter)
```
    Return only the sections of the attribute that contain the matched text.
    
    Parameters:
    
    summarizeFilter - the summarization filter
    
    Returns:
    
    the instance of the current SearchArgs.Builder for the purpose of method chaining
    
    See Also:
    
    Highlighting
  - summarizeField
```
public SearchArgs.Builder<K> summarizeField(String field)
```
    Convenience method to build SummarizeArgs
    Add a field to summarize. Each field is summarized. If no FIELDS directive is passed, then all returned fields are summarized.
    
    Parameters:
    
    field - the field to add
    
    Returns:
    
    the instance of the current SearchArgs.Builder for the purpose of method chaining
    
    See Also:
    
    Highlighting
  - summarizeLen
```
public SearchArgs.Builder<K> summarizeLen(long len)
```
    Convenience method to build SummarizeArgs
    Set the number of context words each fragment should contain. Context words surround the found term. A higher value will return a larger block of text. If not specified, the default value is 20.
    
    Parameters:
    
    len - the field to add
    
    Returns:
    
    the instance of the current SearchArgs.Builder for the purpose of method chaining
    
    See Also:
    
    Highlighting
  - summarizeSeparator
```
public SearchArgs.Builder<K> summarizeSeparator(String separator)
```
    Convenience method to build SummarizeArgs
    The string used to divide individual summary snippets. The default is ... which is common among search engines, but you may override this with any other string if you desire to programmatically divide the snippets later on. You may also use a newline sequence, as newlines are stripped from the result body during processing.
    
    Parameters:
    
    separator - the separator between fragments
    
    Returns:
    
    the instance of the current SearchArgs.Builder for the purpose of method chaining
    
    See Also:
    
    Highlighting
  - summarizeFragments
```
public SearchArgs.Builder<K> summarizeFragments(long fragments)
```
    Convenience method to build SummarizeArgs
    Set the number of fragments to be returned. If not specified, the default is 3.
    
    Parameters:
    
    fragments - the number of fragments to return
    
    Returns:
    
    the instance of the current SearchArgs.Builder for the purpose of method chaining
    
    See Also:
    
    Highlighting
  - highlightArgs
```
public SearchArgs.Builder<K> highlightArgs(HighlightArgs highlightFilter)
```
    Format occurrences of matched text.
    
    Parameters:
    
    highlightFilter - the highlighting filter
    
    Returns:
    
    the instance of the current SearchArgs.Builder for the purpose of method chaining
    
    See Also:
    
    Highlighting
  - highlightField
```
public SearchArgs.Builder<K> highlightField(String field)
```
    Convenience method to build HighlightArgs
    Add a field to highlight. If no FIELDS directive is passed, then all returned fields are highlighted.
    
    Parameters:
    
    field - the field to summarize
    
    Returns:
    
    the instance of the current SearchArgs.Builder for the purpose of method chaining
    
    See Also:
    
    Highlighting
  - highlightTags
```
public SearchArgs.Builder<K> highlightTags(String startTag,
                                           String endTag)
```
    Convenience method to build HighlightArgs
    Tags to surround the matched terms with. If no TAGS are specified, a built-in tag pair is prepended and appended to each matched term.
    
    Parameters:
    
    startTag - the string is prepended to each matched term
    
    endTag - the string is appended to each matched term
    
    Returns:
    
    the instance of the current SearchArgs.Builder for the purpose of method chaining
    
    See Also:
    
    Highlighting
  - slop
```
public SearchArgs.Builder<K> slop(long slop)
```
    Allow for a number of intermediate terms allowed to appear between the terms of the query. Suppose you're searching for a phrase hello world, if some other terms appear in-between hello and world, a SLOP greater than 0 allows for these text attributes to match. By default, there is no SLOP constraint.
    
    Parameters:
    
    slop - the slop value how many intermediate terms are allowed
    
    Returns:
    
    the instance of the current SearchArgs.Builder for the purpose of method chaining
  - inOrder
```
public SearchArgs.Builder<K> inOrder()
```
    Require the terms in the document to have the same order as the terms in the query, regardless of the offsets between them. Typically used in conjunction with slop(long). Disabled by default.
    
    Returns:
    
    the instance of the current SearchArgs.Builder for the purpose of method chaining
  - language
```
public SearchArgs.Builder<K> language(DocumentLanguage language)
```
    Specify the language of the query. This is used to stem the query terms. The default is DocumentLanguage.ENGLISH.
    If this setting was specified as part of index creation, it doesn't need to be specified here.
    
    Parameters:
    
    language - the language of the query
    
    Returns:
    
    the instance of the current SearchArgs.Builder for the purpose of method chaining
  - expander
```
public SearchArgs.Builder<K> expander(String expander)
```
    Use a custom query expander instead of the stemmer
    
    Parameters:
    
    expander - the query expander to use
    
    Returns:
    
    the instance of the current SearchArgs.Builder for the purpose of method chaining
    
    See Also:
    
    Extensions
  - scorer
```
public SearchArgs.Builder<K> scorer(ScoringFunction scorer)
```
    Use a built-in or a user-provided scoring function
    
    Parameters:
    
    scorer - the ScoringFunction to use
    
    Returns:
    
    the instance of the current SearchArgs.Builder for the purpose of method chaining
    
    See Also:
    
    Extensions, Scoring
  - sortBy
```
public SearchArgs.Builder<K> sortBy(SortByArgs sortBy)
```
    Order the results by the value of this attribute. This applies to both text and numeric attributes. Attributes needed for SORTBY should be declared as SORTABLE in the index, to be available with very low latency.
    Note that this adds memory overhead.
    
    Parameters:
    
    sortBy - the SortByArgs to use
    
    Returns:
    
    the instance of the current SearchArgs.Builder for the purpose of method chaining
  - limit
```
public SearchArgs.Builder<K> limit(long offset,
                                   long number)
```
    Limit the results to the offset and number of results given. Note that the offset is zero-indexed. The default is 0 10, which returns 10 items starting from the first result. You can use LIMIT 0 0 to count the number of documents in the result set without actually returning them.
    LIMIT behavior: If you use the LIMIT option without sorting, the results returned are non-deterministic, which means that subsequent queries may return duplicated or missing values. Add SORTBY with a unique field, or use FT.AGGREGATE with the WITHCURSOR option to ensure deterministic result set paging.
    
    Parameters:
    
    offset - the offset to use
    
    number - the limit to use
    
    Returns:
    
    the instance of the current SearchArgs.Builder for the purpose of method chaining
  - timeout
```
public SearchArgs.Builder<K> timeout(Duration timeout)
```
    Override the maximum time to wait for the query to complete.
    
    Parameters:
    
    timeout - the timeout to use (with millisecond resolution)
    
    Returns:
    
    the instance of the current SearchArgs.Builder for the purpose of method chaining
  - param
```
public SearchArgs.Builder<K> param(String name,
                                   String value)
```
    Add a query parameter. The query references it as $name and the server substitutes the value wherever that reference appears, so values need no escaping and cannot alter the query structure, for example param("category", "electronics") with the query @category:{$category}. The value is sent as UTF-8 text. Adding a parameter with the same name again replaces its value.
    Requires QueryDialects.DIALECT2 or higher.
    
    Parameters:
    
    name - the parameter name, referenced as $name in the query, must not be null
    
    value - the parameter value, must not be null
    
    Returns:
    
    the instance of the current SearchArgs.Builder for the purpose of method chaining
  - param
```
public SearchArgs.Builder<K> param(String name,
                                   byte[] value)
```
    Add a binary query parameter, for example the query vector of a KNN clause (*=>[KNN 10 @embedding $vec]). The bytes are sent exactly as given, which the String overload cannot do for arbitrary binary data. The query references the parameter as $name; adding a parameter with the same name again replaces its value.
    Requires QueryDialects.DIALECT2 or higher.
    
    Parameters:
    
    name - the parameter name, referenced as $name in the query, must not be null
    
    value - the binary parameter value, sent as-is, must not be null
    
    Returns:
    
    the instance of the current SearchArgs.Builder for the purpose of method chaining
    
    Since:
    
    7.8
  - dialect
```
public SearchArgs.Builder<K> dialect(QueryDialects dialect)
```
    Set the query dialect. The default is QueryDialects.DIALECT2.
    
    Parameters:
    
    dialect - the dialect to use
    
    Returns:
    
    the instance of the current SearchArgs.Builder for the purpose of method chaining
    
    See Also:
    
    QueryDialects

Class SearchArgs.Builder<K>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

build

noContent

verbatim

withScores

withSortKeys

inKey

inField

returnField

returnField

summarizeArgs

summarizeField

summarizeLen

summarizeSeparator

summarizeFragments

highlightArgs

highlightField

highlightTags

slop

inOrder

language

expander

scorer

sortBy

limit

timeout

param

param

dialect