io.lettuce.core.search

Class SearchReply.SearchResult<K>

java.lang.Object

io.lettuce.core.search.SearchReply.SearchResult<K>

Type Parameters:

K - Key type of the document id.

Enclosing class:

SearchReply<K>

public static class SearchReply.SearchResult<K>
extends Object

Represents a single search result document.

getFields() maps each field name to a FieldValue, which retains the exact bytes returned by the server and can be read as either text (FieldValue.asString()) or binary (FieldValue.asBytes()). This lets a single document mix textual/numeric fields with binary fields such as vector embeddings, where UTF-8 decoding would corrupt the value.

Constructor Summary

Constructors

Constructor and Description
SearchResult() Creates a new SearchResult without a document ID, for rows that carry none (aggregation results).
SearchResult(K id) Creates a new SearchResult with the specified document ID.

Method Summary

Modifier and Type	Method and Description
void	addField(String key, byte[] value) Adds a single document field
void	addFields(Map<String,byte[]> fields) Adds all the provided fields
Map<String,FieldValue>	getFields() Gets the document fields, mapping each field name to its FieldValue, in the order returned by the server.
K	getId() Gets the document ID.
Double	getScore() Gets the document score.
String	getSortKey() Gets the sort key of the document, as serialized by the server.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SearchResult

public SearchResult(K id)

Creates a new SearchResult with the specified document ID.

Parameters:

id - the document ID

SearchResult

public SearchResult()

Creates a new SearchResult without a document ID, for rows that carry none (aggregation results).

Method Detail

getId

public K getId()

Gets the document ID.

Rows of FT.AGGREGATE and FT.CURSOR READ replies carry no document ID, so this is null for every result of an AggregationReply. Load the key explicitly (LOAD 1 __key) if it is needed there.

Returns:

the document ID, or null if the reply carries no document IDs (aggregation results)

getScore

public Double getScore()

Gets the document score.

This is only available if WITHSCORES was used in the search.

Returns:

the document score, or null if not available

getSortKey

public String getSortKey()

Gets the sort key of the document, as serialized by the server.

This is only available if WITHSORTKEYS was used together with SORTBY. The server prefixes a textual sort key with $ (normalized to lower case unless the attribute was declared UNF, for example $hello world) and a numeric sort key with # (for example #10), so the type of the sorting attribute can be told apart. It is mostly useful for merging sorted results coming from several indexes or shards.

Returns:

the sort key, or null if WITHSORTKEYS was not used, no SORTBY was given, or the document has no value for the sorting attribute

Since:

7.8

getFields

public Map<String,FieldValue> getFields()

Gets the document fields, mapping each field name to its FieldValue, in the order returned by the server. If NOCONTENT was used in the search, this will be empty. Read each value as text via FieldValue.asString() or as raw bytes via FieldValue.asBytes().

Aggregation reducers that produce non-scalar columns (for example FT.AGGREGATE REDUCE COLLECT) are represented as FieldValue.Kind.ARRAY values with one element per collected entry; read the entries via FieldValue.asList() and each entry via FieldValue.asMap(), which normalizes the protocol-specific entry shape. Entry order within a collected column follows the server (SORTBY order); iteration order of FieldValue.Kind.MAP values is not guaranteed to match the server.

Returns:

an unmodifiable, ordered map of field name to FieldValue, or an empty map if not available

addFields

public void addFields(Map<String,byte[]> fields)

Adds all the provided fields

Parameters:

fields - the document fields, keyed by name, with raw byte values

addField

public void addField(String key,
                     byte[] value)

Adds a single document field

Parameters:

key - the field name

value - the raw field value

Since:

7.8