org.redisson.api.search.index.HNSWVectorIndexParams Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of redisson-all Show documentation

Easy Redis Java client and Real-Time Data Platform. Valkey compatible. Sync/Async/RxJava3/Reactive API. Client side caching. Over 50 Redis based Java objects and services: JCache API, Apache Tomcat, Hibernate, Spring, Set, Multimap, SortedSet, Map, List, Queue, Deque, Semaphore, Lock, AtomicLong, Map Reduce, Bloom filter, Scheduler, RPC

There is a newer version: 3.40.2

Show newest version

/**
 * Copyright (c) 2013-2024 Nikita Koksharov
 *
 * Licensed 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 org.redisson.api.search.index;

/**
 *
 * @author Nikita Koksharov
 *
 */
public final class HNSWVectorIndexParams implements HNSWVectorIndex,
                                            VectorDimParam,
                                            VectorDistParam,
        HNSWVectorOptionalArgs {

    private final String fieldName;
    private Type type;
    private int dim;
    private DistanceMetric distanceMetric;
    private Integer initialCap;
    private Integer m;
    private Integer efConstruction;
    private Integer efRuntime;
    private Double epsilon;
    private int count;
    private String as;

    HNSWVectorIndexParams(String name) {
        this.fieldName = name;
    }

    @Override
    public HNSWVectorIndexParams as(String as) {
        this.as = as;
        return this;
    }

    @Override
    public VectorDimParam type(Type type) {
        count++;
        this.type = type;
        return this;
    }

    @Override
    public VectorDistParam dim(int value) {
        count++;
        this.dim = value;
        return this;
    }

    @Override
    public HNSWVectorOptionalArgs distance(DistanceMetric metric) {
        count++;
        this.distanceMetric = metric;
        return this;
    }

    @Override
    public HNSWVectorOptionalArgs initialCapacity(int value) {
        count++;
        this.initialCap = value;
        return this;
    }

    @Override
    public HNSWVectorOptionalArgs m(int value) {
        count++;
        this.m = value;
        return this;
    }

    @Override
    public HNSWVectorOptionalArgs efConstruction(int value) {
        count++;
        this.efConstruction = value;
        return this;
    }

    @Override
    public HNSWVectorOptionalArgs efRuntime(int value) {
        count++;
        this.efRuntime = value;
        return this;
    }

    @Override
    public HNSWVectorOptionalArgs epsilon(double value) {
        count++;
        this.epsilon = value;
        return this;
    }

    public String getFieldName() {
        return fieldName;
    }

    public Type getType() {
        return type;
    }

    public int getDim() {
        return dim;
    }

    public DistanceMetric getDistanceMetric() {
        return distanceMetric;
    }

    public Integer getInitialCap() {
        return initialCap;
    }

    public Integer getM() {
        return m;
    }

    public Integer getEfConstruction() {
        return efConstruction;
    }

    public Integer getEfRuntime() {
        return efRuntime;
    }

    public Double getEpsilon() {
        return epsilon;
    }

    public int getCount() {
        return count;
    }

    public String getAs() {
        return as;
    }
}