Package ai.velr

Enum Class VectorEmbeddingPurpose

java.lang.Object

java.lang.Enum<VectorEmbeddingPurpose>

ai.velr.VectorEmbeddingPurpose

All Implemented Interfaces:

Serializable, Comparable<VectorEmbeddingPurpose>, Constable

public enum VectorEmbeddingPurpose
extends Enum<VectorEmbeddingPurpose>

Why Velr is requesting vectors from a registered embedder.

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
INDEX_ENTITY	Embedding source values from a graph entity for index maintenance.
QUERY	Embedding a query payload supplied to db.index.vector.queryNodes.

Method Summary

Modifier and Type	Method	Description
static VectorEmbeddingPurpose	valueOf(String name)	Returns the enum constant of this class with the specified name.
static VectorEmbeddingPurpose[]	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

INDEX_ENTITY

public static final VectorEmbeddingPurpose INDEX_ENTITY

Embedding source values from a graph entity for index maintenance.

QUERY

public static final VectorEmbeddingPurpose QUERY

Embedding a query payload supplied to db.index.vector.queryNodes.

Method Details

values

public static VectorEmbeddingPurpose[] 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 VectorEmbeddingPurpose 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