Package app.ductape.sdk.vector.types

Record Class VectorInterfaceTypes.QueryVectorsOptions

java.lang.Object
java.lang.Record
app.ductape.sdk.vector.types.VectorInterfaceTypes.QueryVectorsOptions
Enclosing class:
VectorInterfaceTypes
public static record VectorInterfaceTypes.QueryVectorsOptions(List<Double> vector, int topK, String namespace, Object filter, Boolean includeValues, Boolean includeMetadata, Double minScore, VectorInterfaceTypes.SparseVector sparseVector, Double alpha) extends Record
TS IQueryVectorsOptions (dense + hybrid fields).

  • Constructor Details

    • QueryVectorsOptions

      public QueryVectorsOptions(List<Double> vector, int topK, String namespace, Object filter, Boolean includeValues, Boolean includeMetadata, Double minScore, VectorInterfaceTypes.SparseVector sparseVector, Double alpha)
      Creates an instance of a QueryVectorsOptions record class.
      Parameters:
      vector - the value for the vector record component
      topK - the value for the topK record component
      namespace - the value for the namespace record component
      filter - the value for the filter record component
      includeValues - the value for the includeValues record component
      includeMetadata - the value for the includeMetadata record component
      minScore - the value for the minScore record component
      sparseVector - the value for the sparseVector record component
      alpha - the value for the alpha record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • vector

      public List<Double> vector()
      Returns the value of the vector record component.
      Returns:
      the value of the vector record component

    • topK

      public int topK()
      Returns the value of the topK record component.
      Returns:
      the value of the topK record component

    • namespace

      public String namespace()
      Returns the value of the namespace record component.
      Returns:
      the value of the namespace record component

    • filter

      public Object filter()
      Returns the value of the filter record component.
      Returns:
      the value of the filter record component

    • includeValues

      public Boolean includeValues()
      Returns the value of the includeValues record component.
      Returns:
      the value of the includeValues record component

    • includeMetadata

      public Boolean includeMetadata()
      Returns the value of the includeMetadata record component.
      Returns:
      the value of the includeMetadata record component

    • minScore

      public Double minScore()
      Returns the value of the minScore record component.
      Returns:
      the value of the minScore record component

    • sparseVector

      public VectorInterfaceTypes.SparseVector sparseVector()
      Returns the value of the sparseVector record component.
      Returns:
      the value of the sparseVector record component

    • alpha

      public Double alpha()
      Returns the value of the alpha record component.
      Returns:
      the value of the alpha record component