io.lettuce.core.search

Class HybridReply<K,V>

java.lang.Object

io.lettuce.core.search.HybridReply<K,V>

Type Parameters:

K - Key type.

V - Value type.

@Experimental
public class HybridReply<K,V>
extends Object

Represents the results of an FT.HYBRID command. Contains total result count, execution time, warnings, and a list of result field maps.

Each result is a Map of field names to values. The document key is available under the reserved field name __key when returning individual documents. Score information (text score, vector distance, combined score) is included when using YIELD_SCORE_AS in the query.

Since:

7.2

Author:

Aleksandar Todorov

Constructor Summary

Constructors

Constructor and Description
HybridReply() Creates a new empty HybridReply instance.

Method Summary

Modifier and Type	Method and Description
void	addResult(Map<K,V> result) Add a new result entry.
void	addWarning(V warning) Add a warning message.
double	getExecutionTime()
List<Map<K,V>>	getResults()
long	getTotalResults()
List<V>	getWarnings()
boolean	isEmpty()
void	setExecutionTime(double executionTime) Set the execution time reported by the server.
void	setTotalResults(long totalResults) Set the total number of matching documents.
int	size()

Methods inherited from class java.lang.Object

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

Constructor Detail

HybridReply

public HybridReply()

Creates a new empty HybridReply instance.

Method Detail

getTotalResults

public long getTotalResults()

Returns:

the total number of matching documents reported by the server

setTotalResults

public void setTotalResults(long totalResults)

Set the total number of matching documents.

Parameters:

totalResults - the total number of results

getExecutionTime

public double getExecutionTime()

Returns:

the execution time reported by the server in seconds (or 0.0 if not available)

setExecutionTime

public void setExecutionTime(double executionTime)

Set the execution time reported by the server.

Parameters:

executionTime - execution time in seconds

getResults

public List<Map<K,V>> getResults()

Returns:

an unmodifiable view of all results returned by the command. Each result is a map of field names to values.

addResult

public void addResult(Map<K,V> result)

Add a new result entry.

Parameters:

result - the result map to add

getWarnings

public List<V> getWarnings()

Returns:

a read-only view of all warnings reported by the server

addWarning

public void addWarning(V warning)

Add a warning message.

Parameters:

warning - the warning to add

size

public int size()

Returns:

the number of result entries

isEmpty

public boolean isEmpty()

Returns:

true if no results were returned