ElasticsearchSimilarity

org.llm4s.vectorstore.elasticsearch.ElasticsearchSimilarity
See theElasticsearchSimilarity companion object
enum ElasticsearchSimilarity(val wireName: String)

The similarity an Elasticsearch dense_vector field is indexed with, fixed when the index is created.

Elasticsearch turns each similarity into a non-negative _score of its own: (1 + cosine) / 2 for ElasticsearchSimilarity.Cosine and, for unit-length vectors, (1 + dot) / 2 for ElasticsearchSimilarity.DotProduct, both in [0, 1]; 1 / (1 + l2_norm^2) for ElasticsearchSimilarity.L2Norm, in (0, 1]. ElasticsearchSimilarity.MaxInnerProduct can score above 1. A org.llm4s.vectorstore.ScoredRecord score must lie in [0, 1], so the store clamps it.

Value parameters

wireName

the value of the mapping's similarity parameter

Attributes

Companion
object
Graph
Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Members list

Type members

Enum entries

Cosine similarity, the default: no requirement on the vectors' length.

Cosine similarity, the default: no requirement on the vectors' length.

Attributes

Dot product: Elasticsearch requires every vector to have unit length and rejects others.

Dot product: Elasticsearch requires every vector to have unit length and rejects others.

Attributes

Euclidean (L2) distance.

Euclidean (L2) distance.

Attributes

Maximum inner product, for vectors that are not normalised.

Maximum inner product, for vectors that are not normalised.

Attributes