Record Class VectorSearchFragment

java.lang.Object

java.lang.Record

org.springframework.data.neo4j.repository.query.VectorSearchFragment

Record Components:

indexName - name of the index to use for vector search

numberOfNodes - number of nodes to fetch from the index search

score - score filter

public record VectorSearchFragment(String indexName, int numberOfNodes, @Nullable Double score)
extends Record

Collected params for vector search.

Author:

Gerrit Meier

Constructor Summary

Constructors

Constructor	Description
VectorSearchFragment(String indexName, int numberOfNodes, @Nullable Double score)	Creates an instance of a VectorSearchFragment record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
String	indexName()	Returns the value of the indexName record component.
int	numberOfNodes()	Returns the value of the numberOfNodes record component.
@Nullable Double	score()	Returns the value of the score record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

VectorSearchFragment

public VectorSearchFragment(String indexName,
 int numberOfNodes,
 @Nullable Double score)

Creates an instance of a VectorSearchFragment record class.

Parameters:

indexName - the value for the indexName record component

numberOfNodes - the value for the numberOfNodes record component

score - the value for the score record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

indexName

public String indexName()

Returns the value of the indexName record component.

Returns:

the value of the indexName record component

numberOfNodes

public int numberOfNodes()

Returns the value of the numberOfNodes record component.

Returns:

the value of the numberOfNodes record component

score

public @Nullable Double score()

Returns the value of the score record component.

Returns:

the value of the score record component