com.hw.pinecone.entity.index.Metric Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.hw.pinecone.entity.index;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonValue;
import java.util.Arrays;
/**
* The distance metric to be used for similarity search.
*
* @author HamaWhite
*/
public enum Metric {
/**
* Euclidean metric.
*/
EUCLIDEAN("euclidean"),
/**
* Cosine metric.
*/
COSINE("cosine"),
/**
* Dotproduct metric.
*/
DOTPRODUCT("dotproduct");
private final String value;
Metric(String value) {
this.value = value;
}
@JsonValue
public String getValue() {
return value;
}
@JsonCreator
public static Metric fromValue(String value) {
return Arrays.stream(Metric.values())
.filter(metric -> metric.value.equalsIgnoreCase(value))
.findFirst()
.orElseThrow(() -> new IllegalArgumentException("Invalid Metric value: " + value));
}
}