Package org.springframework.ai.vectorstore

Enum Class CouchbaseIndexOptimization

java.lang.Object

java.lang.Enum<CouchbaseIndexOptimization>

org.springframework.ai.vectorstore.CouchbaseIndexOptimization

All Implemented Interfaces:

Serializable, Comparable<CouchbaseIndexOptimization>, Constable

public enum CouchbaseIndexOptimization
extends Enum<CouchbaseIndexOptimization>

Choose whether the Vector store should prioritize recall or latency when returning similar vectors in search results. See https://docs.couchbase.com/server/current/search/child-field-options-reference.html for more details.

Since:

1.0.0

Author:

Laurent Doguin

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
latency	latency: The Search Service prioritizes returning results with lower latency.
recall	recall: The Search Service prioritizes returning the most accurate result.

Method Summary

Modifier and Type	Method	Description
static CouchbaseIndexOptimization	valueOf(String name)	Returns the enum constant of this class with the specified name.
static CouchbaseIndexOptimization[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

recall

public static final CouchbaseIndexOptimization recall

recall: The Search Service prioritizes returning the most accurate result. This may increase resource usage for Search queries.

latency

public static final CouchbaseIndexOptimization latency

latency: The Search Service prioritizes returning results with lower latency. This may reduce the accuracy of results.

Method Details

values

public static CouchbaseIndexOptimization[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static CouchbaseIndexOptimization valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null