Package app.ductape.sdk.vector

Record Class VectorServiceOptions

java.lang.Object
java.lang.Record
app.ductape.sdk.vector.VectorServiceOptions
public record VectorServiceOptions(VectorTypes.VectorDBType type, String endpoint, String apiKey, String index, String namespace, int dimensions, VectorTypes.DistanceMetric metric, String region, Integer timeout, Map<String,Object> extra) extends Record
Parity with TS IVectorServiceOptions (see vector.service.ts). Product-level vector definitions match TS IVectorConfig/IVectorEnvConfig; see VectorConnectionTypes and VectorConnectionMaps.

  • Constructor Details

    • VectorServiceOptions

      public VectorServiceOptions(VectorTypes.VectorDBType type, String endpoint, String apiKey, String index, String namespace, int dimensions, VectorTypes.DistanceMetric metric, String region, Integer timeout, Map<String,Object> extra)
      Creates an instance of a VectorServiceOptions record class.
      Parameters:
      type - the value for the type record component
      endpoint - the value for the endpoint record component
      apiKey - the value for the apiKey record component
      index - the value for the index record component
      namespace - the value for the namespace record component
      dimensions - the value for the dimensions record component
      metric - the value for the metric record component
      region - the value for the region record component
      timeout - the value for the timeout record component
      extra - the value for the extra record component

  • Method Details

    • toConnectionMap

      public Map<String,Object> toConnectionMap()

    • 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.

    • type

      public VectorTypes.VectorDBType type()
      Returns the value of the type record component.
      Returns:
      the value of the type record component

    • endpoint

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

    • apiKey

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

    • index

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

    • namespace

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

    • dimensions

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

    • metric

      public VectorTypes.DistanceMetric metric()
      Returns the value of the metric record component.
      Returns:
      the value of the metric record component

    • region

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

    • timeout

      public Integer timeout()
      Returns the value of the timeout record component.
      Returns:
      the value of the timeout record component

    • extra

      public Map<String,Object> extra()
      Returns the value of the extra record component.
      Returns:
      the value of the extra record component