Module org.elasticsearch.server

Package org.elasticsearch.index.mapper.vectors

Class DenseVectorFieldMapper.VectorSimilarityFunctionConfig

java.lang.Object

org.elasticsearch.index.mapper.vectors.DenseVectorFieldMapper.VectorSimilarityFunctionConfig

All Implemented Interfaces:

BlockLoaderFunctionConfig

Enclosing class:

DenseVectorFieldMapper

public static class DenseVectorFieldMapper.VectorSimilarityFunctionConfig
extends Object
implements BlockLoaderFunctionConfig

Configuration for a BlockLoaderFunctionConfig that calculates vector similarity. Functions that use this config should use SIMILARITY_FUNCTION_NAME as their name.

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.index.mapper.blockloader.BlockLoaderFunctionConfig

BlockLoaderFunctionConfig.Function, BlockLoaderFunctionConfig.JustFunction, BlockLoaderFunctionConfig.JustWarnings

Constructor Summary

Constructors

Constructor	Description
VectorSimilarityFunctionConfig(DenseVectorFieldMapper.SimilarityFunction similarityFunction, byte[] vectorAsBytes)
VectorSimilarityFunctionConfig(DenseVectorFieldMapper.SimilarityFunction similarityFunction, float[] vector)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
BlockLoaderFunctionConfig.Function	function()	Name used in descriptions.
int	hashCode()
DenseVectorFieldMapper.SimilarityFunction	similarityFunction()
float[]	vector()
byte[]	vectorAsBytes()

Methods inherited from class java.lang.Object

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

Constructor Details

VectorSimilarityFunctionConfig

public VectorSimilarityFunctionConfig(DenseVectorFieldMapper.SimilarityFunction similarityFunction,
 float[] vector)

VectorSimilarityFunctionConfig

public VectorSimilarityFunctionConfig(DenseVectorFieldMapper.SimilarityFunction similarityFunction,
 byte[] vectorAsBytes)

Method Details

function

public BlockLoaderFunctionConfig.Function function()

Description copied from interface: BlockLoaderFunctionConfig

Name used in descriptions.

Specified by:

function in interface BlockLoaderFunctionConfig

vectorAsBytes

public byte[] vectorAsBytes()

vector

public float[] vector()

similarityFunction

public DenseVectorFieldMapper.SimilarityFunction similarityFunction()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object