io.pinecone.unsigned_indices_model.VectorWithUnsignedIndices Maven / Gradle / Ivy

Go to download
package io.pinecone.unsigned_indices_model;

import com.google.protobuf.Struct;

import java.util.List;

/**
 * This class represents a vector with sparse values, where the indices of the sparse values are represented
 * as unsigned 32-bit integers.
 * 
 * The {@link VectorWithUnsignedIndices} class contains the following fields:
 * - id: the identifier of the vector
 * - values: the dense vector values
 * - metadata: the metadata associated with the vector
 * - sparseValuesWithUnsignedIndices: the sparse values associated with the vector, using unsigned 32-bit integer indices
 * 
 * The class provides constructors to create {@link VectorWithUnsignedIndices} objects, as well as getter and setter
 * methods for each of the fields.
 */
public class VectorWithUnsignedIndices {

    /**
     * The identifier of the vector.
     */
    private String id;

    /**
     * The dense vector values.
     */
    private List values;

    /**
     * The metadata associated with the vector.
     */
    private Struct metadata;

    /**
     * The sparse values associated with the vector, using unsigned 32-bit integer indices.
     */
    private SparseValuesWithUnsignedIndices sparseValuesWithUnsignedIndices;

    /**
     * Constructs an empty {@link VectorWithUnsignedIndices} object.
     */
    public VectorWithUnsignedIndices() {}

    /**
     * Constructs a {@link VectorWithUnsignedIndices} object with the given identifier and dense vector values.
     *
     * @param id     The identifier of the vector
     * @param values The dense vector values
     */
    public VectorWithUnsignedIndices(String id, List values) {
        this.id = id;
        this.values = values;
    }

    /**
     * Constructs a {@link VectorWithUnsignedIndices} object with the given identifier, dense vector values, metadata,
     * and sparse values with unsigned 32-bit integer indices.
     *
     * @param id                              The identifier of the vector
     * @param values                         The dense vector values
     * @param metadata                       The metadata associated with the vector
     * @param sparseValuesWithUnsignedIndices The sparse values associated with the vector, using unsigned 32-bit integer indices
     */
    public VectorWithUnsignedIndices(String id, List values, Struct metadata, SparseValuesWithUnsignedIndices sparseValuesWithUnsignedIndices) {
        this.id = id;
        this.values = values;
        this.metadata = metadata;
        this.sparseValuesWithUnsignedIndices = sparseValuesWithUnsignedIndices;
    }

    /**
     * Returns the identifier of the vector.
     *
     * @return The identifier
     */
    public String getId() {
        return id;
    }

    /**
     * Sets the identifier of the vector.
     *
     * @param id The new identifier
     */
    public void setId(String id) {
        this.id = id;
    }

    /**
     * Returns The dense vector values.
     *
     * @return The list of values
     */
    public List getValuesList() {
        return values;
    }

    /**
     * Sets the dense vector values.
     *
     * @param values The new list of values
     */
    public void setValues(List values) {
        this.values = values;
    }

    /**
     * Returns the metadata associated with the vector.
     *
     * @return The metadata
     */
    public Struct getMetadata() {
        return metadata;
    }

    /**
     * Sets the metadata associated with the vector.
     *
     * @param metadata The new metadata
     */
    public void setMetadata(Struct metadata) {
        this.metadata = metadata;
    }

    /**
     * Returns the sparse values associated with the vector, using unsigned 32-bit integer indices.
     *
     * @return the {@link SparseValuesWithUnsignedIndices} object
     */
    public SparseValuesWithUnsignedIndices getSparseValuesWithUnsignedIndices() {
        return sparseValuesWithUnsignedIndices;
    }

    /**
     * Sets the sparse values associated with the vector, using unsigned 32-bit integer indices.
     *
     * @param sparseValuesWithUnsignedIndices the new {@link SparseValuesWithUnsignedIndices} object
     */
    public void setSparseValuesWithUnsignedIndices(SparseValuesWithUnsignedIndices sparseValuesWithUnsignedIndices) {
        this.sparseValuesWithUnsignedIndices = sparseValuesWithUnsignedIndices;
    }
}