diff --git a/docs/java/allclasses-index.html b/docs/java/allclasses-index.html index 4cf07cb3..50294d1d 100644 --- a/docs/java/allclasses-index.html +++ b/docs/java/allclasses-index.html @@ -1,108 +1,216 @@ + - -All Classes and Interfaces (voyager 2.0.1 API) - + +All Classes (voyager 2.0.2 API) - - - - + - - + + + + + - - -
-
+
 
+ + -
-

All Classes and Interfaces

-
-
-
-
-
-
Class
-
Description
-
Index
-
+

All Classes

+
+
+
+ +

Copyright © 2023. All rights reserved.

+ diff --git a/docs/java/allclasses.html b/docs/java/allclasses.html index 4104bd03..6bfe778f 100644 --- a/docs/java/allclasses.html +++ b/docs/java/allclasses.html @@ -2,8 +2,8 @@ - -All Classes (voyager 2.0.1 API) + +All Classes (voyager 2.0.2 API) diff --git a/docs/java/allpackages-index.html b/docs/java/allpackages-index.html index f7d1eadd..5ddf1c61 100644 --- a/docs/java/allpackages-index.html +++ b/docs/java/allpackages-index.html @@ -1,78 +1,180 @@ + - -All Packages (voyager 2.0.1 API) - + +All Packages (voyager 2.0.2 API) - - - - + - - + + + + + - - -
-
+
 
+ + -

All Packages

-
Package Summary
-
-
Package
-
Description
-
com.spotify.voyager
-
+
+
-
-

Copyright © 2023. All rights reserved.

-
+ +

Copyright © 2023. All rights reserved.

+ diff --git a/docs/java/com/spotify/voyager/jni/Index.QueryResults.html b/docs/java/com/spotify/voyager/jni/Index.QueryResults.html index 362f30fd..9ca2a741 100644 --- a/docs/java/com/spotify/voyager/jni/Index.QueryResults.html +++ b/docs/java/com/spotify/voyager/jni/Index.QueryResults.html @@ -1,261 +1,433 @@ + - -Index.QueryResults (voyager 2.0.1 API) - + +Index.QueryResults (voyager 2.0.2 API) - - - - + - - + + + + + - - -
-
+
 
+ + -
-
+
-
Package com.spotify.voyager.jni
-

Class Index.QueryResults

+
Package com.spotify.voyager.jni
+

Class Index.QueryResults

-
java.lang.Object -
com.spotify.voyager.jni.Index.QueryResults
-
-
-
+
+ +
+
    +
  • +
    Enclosing class:
    Index
    -
    public static class Index.QueryResults -extends Object
    +
    public static class Index.QueryResults
+extends Object
    A container for query results, returned by Index. Note that this class is instantiated from C++, and as such, any changes to its location, visibility, or constructor will need to include corresponding C++ changes.
    -
-
-
    + +
+
+
+
    +
  • -
  • -
    -

    Field Summary

    -
    Fields
    -
    -
    Modifier and Type
    -
    Field
    -
    Description
    -
    final float[]
    -
    distances
    -
    +
    +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeFieldDescription
      float[]distances
      A list of distances from each item ID to the query vector for this query.
      - -
      final long[]
      -
      labels
      -
      +
      long[]labels
      A list of item IDs ("labels").
      - - - +
      • +
    +
    -
  • -
    -

    Constructor Summary

    -
    Constructors
    -
    -
    Constructor
    -
    Description
    -
    QueryResults(long[] labels, - float[] distances)
    -
    +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      QueryResults​(long[] labels, + float[] distances)
      Instantiates a new QueryResults object, provided two identical-length arrays of labels and their corresponding distances.
      - - - +
      • +
    +
    -
  • -
    -

    Method Summary

    -
    -
    -
    -
    -
    Modifier and Type
    -
    Method
    -
    Description
    -
    float[]
    -
    getDistances()
    -
    +
    +
    -
    -
      + +
    +
    +
    +
      +
    • -
    • -
      -

      Field Details

      -
        -
      • -
        -

        labels

        -
        public final long[] labels
        +
        +
          +
        • + + +

          Field Detail

          + + + +
            +
          • +

            labels

            +
            public final long[] labels
            A list of item IDs ("labels").
            -
        • -
      • -
        -

        distances

        -
        public final float[] distances
        +
      + + + +
        +
      • +

        distances

        +
        public final float[] distances
        A list of distances from each item ID to the query vector for this query.
        -
    -
    • +
+ -
  • -
    -

    Constructor Details

    -
      -
    • -
      -

      QueryResults

      -
      public QueryResults(long[] labels, - float[] distances)
      +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          QueryResults

          +
          public QueryResults​(long[] labels,
+                    float[] distances)
          Instantiates a new QueryResults object, provided two identical-length arrays of labels and their corresponding distances. This method should probably not be used directly, as this class is primarily used as a return type from the query method on Index.
          -
          -
          Throws:
          -
          IllegalArgumentException - if the length of the labels and distances arrays vary
          +
          +
          Throws:
          +
          IllegalArgumentException - if the length of the labels and distances arrays vary
          -
    -
    • + + -
  • -
    -

    Method Details

    -
      -
    • -
      -

      toString

      -
      public String toString()
      -
      -
      Overrides:
      -
      toString in class Object
      +
      +
      • -
    • -
      -

      getLabels

      -
      public long[] getLabels()
      +
    + + + +
      +
    • +

      getLabels

      +
      public long[] getLabels()
      Retrieve the list of item IDs ("labels") returned by this query. This array is sorted by distance: the first item is the closest to the query vector, the second is second-closest, and so on. The items in this array correspond 1:1 with the distances returned by getDistances().
      -
    • -
  • -
    -

    getDistances

    -
    public float[] getDistances()
    + + + + +
      +
    • +

      getDistances

      +
      public float[] getDistances()
      Retrieve the list of distances between query vectors and item vectors for the results of this query. This array is sorted by distance: the first distance corresponds with the item the closest to the query vector, the second is second-closest, and so on. The items in this array correspond 1:1 with the labels returned by getLabels().
      -
    • - - + + +
    +
    + + +

    Copyright © 2023. All rights reserved.

    + diff --git a/docs/java/com/spotify/voyager/jni/Index.SpaceType.html b/docs/java/com/spotify/voyager/jni/Index.SpaceType.html index fb147eb4..bbb69c76 100644 --- a/docs/java/com/spotify/voyager/jni/Index.SpaceType.html +++ b/docs/java/com/spotify/voyager/jni/Index.SpaceType.html @@ -1,244 +1,415 @@ + - -Index.SpaceType (voyager 2.0.1 API) - + +Index.SpaceType (voyager 2.0.2 API) - - - - + - - + + + + + - - -
    -
    +
     
    + + -
    -
    +
    -
    Package com.spotify.voyager.jni
    -

    Enum Index.SpaceType

    -
    -
    java.lang.Object -
    java.lang.Enum<Index.SpaceType> -
    com.spotify.voyager.jni.Index.SpaceType
    -
    +
    Package com.spotify.voyager.jni
    +

    Enum Index.SpaceType

    -
    -
    +
    + +
    +
    -
    -
      + +
    +
    +
    + - + + -
  • -
    -

    Method Details

    -
      -
    • -
      -

      values

      -
      public static Index.SpaceType[] values()
      +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static Index.SpaceType[] values()
          Returns an array containing the constants of this enum type, in -the order they are declared.
          -
          -
          Returns:
          +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (Index.SpaceType c : Index.SpaceType.values())
+    System.out.println(c);
+
    • +
    +
    Returns:
    an array containing the constants of this enum type, in the order they are declared
    - -
  • -
    -

    valueOf

    -
    public static Index.SpaceType valueOf(String name)
    + + + + +
      +
    • +

      valueOf

      +
      public static Index.SpaceType valueOf​(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      -
      -
      Parameters:
      +
      +
      Parameters:
      name - the name of the enum constant to be returned.
      -
      Returns:
      +
      Returns:
      the enum constant with the specified name
      -
      Throws:
      -
      IllegalArgumentException - if this enum type has no constant with the specified name
      -
      NullPointerException - if the argument is null
      +
      Throws:
      +
      IllegalArgumentException - if this enum type has no constant with the specified name
      +
      NullPointerException - if the argument is null
      -
    • - - + + +
    + + + +

    Copyright © 2023. All rights reserved.

    + diff --git a/docs/java/com/spotify/voyager/jni/Index.StorageDataType.html b/docs/java/com/spotify/voyager/jni/Index.StorageDataType.html index d5cecef8..65c35153 100644 --- a/docs/java/com/spotify/voyager/jni/Index.StorageDataType.html +++ b/docs/java/com/spotify/voyager/jni/Index.StorageDataType.html @@ -1,167 +1,261 @@ + - -Index.StorageDataType (voyager 2.0.1 API) - + +Index.StorageDataType (voyager 2.0.2 API) - - - - + - - + + + + + - - -
    -
    +
     
    + + -
    -
    +
    -
    Package com.spotify.voyager.jni
    -

    Enum Index.StorageDataType

    -
    -
    java.lang.Object -
    java.lang.Enum<Index.StorageDataType> -
    com.spotify.voyager.jni.Index.StorageDataType
    -
    +
    Package com.spotify.voyager.jni
    +

    Enum Index.StorageDataType

    -
    -
    +
    + +
    +
    -
    -
      + +
    +
    +
    + - + + -
  • -
    -

    Method Details

    -
      -
    • -
      -

      values

      -
      public static Index.StorageDataType[] values()
      +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static Index.StorageDataType[] values()
          Returns an array containing the constants of this enum type, in -the order they are declared.
          -
          -
          Returns:
          +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (Index.StorageDataType c : Index.StorageDataType.values())
+    System.out.println(c);
+
    • +
    +
    Returns:
    an array containing the constants of this enum type, in the order they are declared
    - -
  • -
    -

    valueOf

    -
    public static Index.StorageDataType valueOf(String name)
    + + + + +
    • - - + + + + + + +

    Copyright © 2023. All rights reserved.

    + diff --git a/docs/java/com/spotify/voyager/jni/Index.html b/docs/java/com/spotify/voyager/jni/Index.html index 68af6bbc..b6ffcd38 100644 --- a/docs/java/com/spotify/voyager/jni/Index.html +++ b/docs/java/com/spotify/voyager/jni/Index.html @@ -1,89 +1,144 @@ + - -Index (voyager 2.0.1 API) - + +Index (voyager 2.0.2 API) - - - - + - - + + + + + - - -
    -
    +
     
    + + -
    -
    +
    -
    Package com.spotify.voyager.jni
    -

    Class Index

    -
    -
    java.lang.Object -
    com.spotify.voyager.jni.Index
    +
    Package com.spotify.voyager.jni
    +

    Class Index

    -
    -
    +
    + +
    +
      +
    • +
      All Implemented Interfaces:
      -
      Closeable, AutoCloseable
      +
      Closeable, AutoCloseable
      -
      public class Index -extends Object -implements Closeable
      +
      public class Index
+extends Object
+implements Closeable
      A Voyager index, providing storage of floating-point vectors and the ability to efficiently search among those vectors. @@ -106,302 +161,407 @@

      Class Index

      // Serialize this index to use it again later: index.saveIndex("my_tiny_index.voy");
      -
    -
    -
      + +
    +
    +
    + + -
  • -
    -

    Method Details

    -
      -
    • -
      -

      load

      -
      public static Index load(String filename, - Index.SpaceType space, - int numDimensions, - Index.StorageDataType storageDataType)
      +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          load

          +
          public static Index load​(String filename,
+                         Index.SpaceType space,
+                         int numDimensions,
+                         Index.StorageDataType storageDataType)
          Load a Voyager index file and create a new Index initialized with the data in that file.
          -
          -
          Parameters:
          +
          +
          Parameters:
          filename - A filename to load.
          space - The Index.SpaceType to use when loading the index.
          numDimensions - The number of dimensions per vector.
          storageDataType - The Index.StorageDataType used by the index being loaded.
          -
          Returns:
          +
          Returns:
          An Index whose contents have been initialized with the data provided by the file.
          -
          Throws:
          -
          RuntimeException - if the index cannot be loaded from the file, or the file contains +
          Throws:
          +
          RuntimeException - if the index cannot be loaded from the file, or the file contains invalid data.
          -
      • -
    • -
      -

      load

      -
      public static Index load(String filename)
      +
    + + + +
      +
    • +

      load

      +
      public static Index load​(String filename)
      Load a Voyager index file and create a new Index initialized with the data in that file.
      -
      -
      Parameters:
      +
      +
      Parameters:
      filename - A filename to load.
      -
      Returns:
      +
      Returns:
      An Index whose contents have been initialized with the data provided by the file.
      -
      Throws:
      -
      RuntimeException - if the index cannot be loaded from the file, the file contains invalid +
      Throws:
      +
      RuntimeException - if the index cannot be loaded from the file, the file contains invalid data, or the file contains an older version of the Voyager file format that requires additional arguments to be provided.
      -
    • -
  • -
    -

    load

    -
    public static Index load(InputStream inputStream, - Index.SpaceType space, - int numDimensions, - Index.StorageDataType storageDataType)
    + + + + +
      +
    • +

      load

      +
      public static Index load​(InputStream inputStream,
+                         Index.SpaceType space,
+                         int numDimensions,
+                         Index.StorageDataType storageDataType)
      Interpret the contents of a java.io.InputStream as the contents of a Voyager index file and create a new Index initialized with the data provided by that stream.
      -
      -
      Parameters:
      -
      inputStream - A InputStream that will provide the contents of a Voyager +
      +
      Parameters:
      +
      inputStream - A InputStream that will provide the contents of a Voyager index.
      space - The Index.SpaceType to use when loading the index.
      numDimensions - The number of dimensions per vector.
      storageDataType - The Index.StorageDataType used by the index being loaded.
      -
      Returns:
      +
      Returns:
      An Index whose contents have been initialized with the data provided by the input stream.
      -
      Throws:
      -
      RuntimeException - if the index cannot be loaded from the stream, or the stream contains +
      Throws:
      +
      RuntimeException - if the index cannot be loaded from the stream, or the stream contains invalid data.
      -
    • -
  • -
    -

    load

    -
    public static Index load(InputStream inputStream)
    + + + + +
      +
    • +

      load

      +
      public static Index load​(InputStream inputStream)
      Interpret the contents of a java.io.InputStream as the contents of a Voyager index file and create a new Index initialized with the data provided by that stream.
      -
      -
      Parameters:
      -
      inputStream - A InputStream that will provide the contents of a Voyager +
      +
      Parameters:
      +
      inputStream - A InputStream that will provide the contents of a Voyager index.
      -
      Returns:
      +
      Returns:
      An Index whose contents have been initialized with the data provided by the input stream.
      -
      Throws:
      -
      RuntimeException - if the index cannot be loaded from the stream, or the stream contains +
      Throws:
      +
      RuntimeException - if the index cannot be loaded from the stream, or the stream contains invalid data, or the file contains an older version of the Voyager file format that requires additional arguments to be provided.
      -
    • -
  • -
    -

    close

    -
    public void close() - throws IOException
    + + + + +
      +
    • +

      close

      +
      public void close()
+           throws IOException
      Close this Index and release any memory held by it. Note that this method must be called to release the memory backing this Index; failing to do so may cause a memory leak.

      Any calls to methods after close() is called will fail, as the underlying native C++ object will have been deallocated.

      -
      -
      Specified by:
      -
      close in interface AutoCloseable
      -
      Specified by:
      -
      close in interface Closeable
      -
      Throws:
      -
      IOException - if the C++ destructor fails.
      +
      +
      Specified by:
      +
      close in interface AutoCloseable
      +
      Specified by:
      +
      close in interface Closeable
      +
      Throws:
      +
      IOException - if the C++ destructor fails.
      -
    • -
  • -
    -

    finalize

    -
    protected void finalize() - throws Throwable
    -
    -
    Overrides:
    -
    finalize in class Object
    -
    Throws:
    -
    Throwable
    + + + + +
    • -
  • -
    -

    setEf

    -
    public void setEf(long ef)
    + + + + +
      +
    • +

      setEf

      +
      public void setEf​(long ef)
      Set the default EF ("query search depth") to use when query(float[], int) is called.
      -
      -
      Parameters:
      +
      +
      Parameters:
      ef - The new default EF value to use. This value can be overridden on a per-query basis at query time.
      -
    • -
  • -
    -

    getEf

    -
    public int getEf()
    + + + + +
      +
    • +

      getEf

      +
      public int getEf()
      Get the default EF ("query search depth") that will be uses when query(float[], int) is called.
      -
      -
      Returns:
      +
      +
      Returns:
      The current default EF value, used by the Index if no value is provided at query time.
      -
    • -
  • -
    -

    getSpace

    -
    public Index.SpaceType getSpace()
    + + + + +
    • -
  • -
    -

    getNumDimensions

    -
    public int getNumDimensions()
    + + + + +
      +
    • +

      getNumDimensions

      +
      public int getNumDimensions()
      Get the number of dimensions used in this Index.
      -
      -
      Returns:
      +
      +
      Returns:
      The number of dimensions used by this Index, and which all vectors within this Index must have.
      -
    • -
  • -
    -

    setNumThreads

    -
    public void setNumThreads(int numThreads)
    + + + + +
      +
    • +

      setNumThreads

      +
      public void setNumThreads​(int numThreads)
      Set the default number of threads to use when adding multiple vectors in bulk, or when querying for multiple vectors simultaneously.
      -
      -
      Parameters:
      +
      +
      Parameters:
      numThreads - The default number of threads used for bulk-add or bulk-query methods if not overridden in each method call. Note that this affects the number of threads started for each method call - Voyager keeps no long-lived thread pool. For maximum efficiency, pass as much data as possible to each bulk-add or bulk-query method call to minimize overhead.
      -
    • -
  • -
    -

    getNumThreads

    -
    public int getNumThreads()
    + + + + +
      +
    • +

      getNumThreads

      +
      public int getNumThreads()
      Get the default number of threads used when adding multiple vectors in bulk oor when querying for multiple vectors simultaneously.
      -
      -
      Returns:
      +
      +
      Returns:
      The default number of threads used for bulk-add or bulk-query methods if not overridden in each method call.
      -
    • -
  • -
    -

    saveIndex

    -
    public void saveIndex(String pathToIndex)
    + + + + +
      +
    • +

      saveIndex

      +
      public void saveIndex​(String pathToIndex)
      Save this Index to a file at the provided filename. This file can be reloaded by using Index.load(...).
      -
      -
      Parameters:
      +
      +
      Parameters:
      pathToIndex - The output filename to write to.
      -
    • -
  • -
    -

    saveIndex

    -
    public void saveIndex(OutputStream outputStream)
    + + + + +
      +
    • +

      saveIndex

      +
      public void saveIndex​(OutputStream outputStream)
      Save this Index to the provided output stream. The stream will not be closed automatically - be sure to close the stream saveIndex has completed. The data written to the stream can be reloaded by using Index.load(...).
      -
      -
      Parameters:
      +
      +
      Parameters:
      outputStream - The output stream to write to. This stream will not be closed automatically.
      -
    • -
  • -
    -

    addItem

    -
    public void addItem(float[] vector)
    + + + + +
      +
    • +

      addItem

      +
      public void addItem​(float[] vector)
      Add an item (a vector) to this Index. The item will automatically be given an identifier equal to the return value of getNumElements().
      -
      -
      Parameters:
      +
      +
      Parameters:
      vector - The vector to add to the index.
      -
      Throws:
      -
      RuntimeException - If the provided vector does not contain exactly getNumDimensions() dimensions.
      +
      Throws:
      +
      RuntimeException - If the provided vector does not contain exactly getNumDimensions() dimensions.
      -
    • -
  • -
    -

    addItem

    -
    public void addItem(float[] vector, - long id)
    + + + + +
      +
    • +

      addItem

      +
      public void addItem​(float[] vector,
+                    long id)
      Add an item (a vector) to this Index with the provided identifier.
      -
      -
      Parameters:
      +
      +
      Parameters:
      vector - The vector to add to the index.
      id - The 64-bit integer denoting the identifier of this vector.
      -
      Throws:
      -
      RuntimeException - If the provided vector does not contain exactly getNumDimensions() dimensions.
      +
      Throws:
      +
      RuntimeException - If the provided vector does not contain exactly getNumDimensions() dimensions.
      -
    • -
  • -
    -

    addItems

    -
    public void addItems(float[][] vectors, - int numThreads)
    + + + + +
      +
    • +

      addItems

      +
      public void addItems​(float[][] vectors,
+                     int numThreads)
      Add multiple items (vectors) to this Index.
      -
      -
      Parameters:
      +
      +
      Parameters:
      vectors - The vectors to add to the index.
      numThreads - The number of threads to use when adding the provided vectors. If -1 (the default), the number of CPUs available on the current machine will be used.
      -
      Throws:
      -
      RuntimeException - If any of the provided vectors do not contain exactly getNumDimensions() dimensions.
      +
      Throws:
      +
      RuntimeException - If any of the provided vectors do not contain exactly getNumDimensions() dimensions.
      -
    • -
  • -
    -

    addItems

    -
    public void addItems(float[][] vectors, - long[] ids, - int numThreads)
    + + + + +
      +
    • +

      addItems

      +
      public void addItems​(float[][] vectors,
+                     long[] ids,
+                     int numThreads)
      Add multiple items (vectors) to this Index.
      -
      -
      Parameters:
      +
      +
      Parameters:
      vectors - The vectors to add to the index.
      ids - The 64-bit identifiers that correspond with each of the provided vectors.
      numThreads - The number of threads to use when adding the provided vectors. If -1 (the @@ -710,128 +926,149 @@

      addItems

      causes a temporary C++ thread pool to be used. Instead of calling addItems(float[][],int) in a tight loop, consider passing more data to each addItems(float[][],int) call instead to reduce overhead.
      -
      Throws:
      -
      RuntimeException - If any of the provided vectors do not contain exactly getNumDimensions() dimensions.
      -
      RuntimeException - If the list of IDs does not have the same length as the list of +
      Throws:
      +
      RuntimeException - If any of the provided vectors do not contain exactly getNumDimensions() dimensions.
      +
      RuntimeException - If the list of IDs does not have the same length as the list of provided vectors.
      -
    • -
  • -
    -

    getVector

    -
    public float[] getVector(long id)
    + + + + +
      +
    • +

      getVector

      +
      public float[] getVector​(long id)
      Get the vector for the provided identifier.
      -
      -
      Parameters:
      +
      +
      Parameters:
      id - The identifier whose vector will be fetched.
      -
      Returns:
      +
      Returns:
      A float array representing the values of the vector.
      -
      Throws:
      -
      RuntimeException - If the provided identifier is not present in the Index.
      +
      Throws:
      +
      RuntimeException - If the provided identifier is not present in the Index.
      -
    • -
  • -
    -

    getVectors

    -
    public float[][] getVectors(long[] ids)
    + + + + +
      +
    • +

      getVectors

      +
      public float[][] getVectors​(long[] ids)
      Get the vectors for a provided array of identifiers.
      -
      -
      Parameters:
      +
      +
      Parameters:
      ids - The identifiers whose vector will be fetched.
      -
      Returns:
      +
      Returns:
      A nested float array representing the values of the vectors corresponding with each ID.
      -
      Throws:
      -
      RuntimeException - If any of the provided identifiers are not present in the Index.
      +
      Throws:
      +
      RuntimeException - If any of the provided identifiers are not present in the Index.
      -
    • -
  • -
    -

    getIDs

    -
    public long[] getIDs()
    + + + + +
      +
    • +

      getIDs

      +
      public long[] getIDs()
      Get the list of identifiers currently stored by this index.
      -
      -
      Returns:
      +
      +
      Returns:
      a long array of identifiers.
      -
    • -
  • -
    -

    query

    -
    public Index.QueryResults query(float[] queryVector, - int k)
    + + + + +
      +
    • +

      query

      +
      public Index.QueryResults query​(float[] queryVector,
+                                int k)
      Query this Index for approximate nearest neighbors of a single query vector.
      -
      -
      Parameters:
      +
      +
      Parameters:
      queryVector - A query vector to use for searching.
      k - The number of nearest neighbors to return.
      -
      Returns:
      +
      Returns:
      A Index.QueryResults object, containing the neighbors found that are (approximately) nearest to the query vector.
      -
      Throws:
      -
      RuntimeException - if fewer than k results can be found in the index.
      +
      Throws:
      +
      RuntimeException - if fewer than k results can be found in the index.
      -
    • -
  • -
    -

    query

    -
    public Index.QueryResults[] query(float[][] queryVectors, - int k, - int numThreads)
    + + + + +
      +
    • +

      query

      +
      public Index.QueryResults[] query​(float[][] queryVectors,
+                                  int k,
+                                  int numThreads)
      Query this Index for approximate nearest neighbors of multiple query vectors.
      -
      -
      Parameters:
      +
      +
      Parameters:
      queryVectors - The query vectors to use for searching.
      k - The number of nearest neighbors to return for each query vector
      numThreads - The number of threads to use when searching. If -1, all available CPU cores will be used. Note that passing a number of threads other than 1 will cause a temporary C++ thread pool to be used. Instead of calling query(float[],int) in a tight loop, consider passing more data to each call instead to reduce overhead.
      -
      Returns:
      +
      Returns:
      An array of Index.QueryResults objects, each containing the neighbors found that are (approximately) nearest to the corresponding query vector. The returned list of Index.QueryResults will contain the same number of elements as queryVectors.
      -
      Throws:
      -
      RuntimeException - if fewer than k results can be found in the index for one or +
      Throws:
      +
      RuntimeException - if fewer than k results can be found in the index for one or more queries.
      -
    • -
  • -
    -

    query

    -
    public Index.QueryResults query(float[] queryVector, - int k, - long queryEf)
    + + + + +
      +
    • +

      query

      +
      public Index.QueryResults query​(float[] queryVector,
+                                int k,
+                                long queryEf)
      Query this Index for approximate nearest neighbors of a single query vector.
      -
      -
      Parameters:
      +
      +
      Parameters:
      queryVector - A query vector to use for searching.
      k - The number of nearest neighbors to return.
      queryEf - The per-query "ef" value to use. Larger values produce more accurate results at the expense of query time.
      -
      Returns:
      +
      Returns:
      A Index.QueryResults object, containing the neighbors found that are (approximately) nearest to the query vector.
      -
      Throws:
      -
      RuntimeException - if fewer than k results can be found in the index.
      +
      Throws:
      +
      RuntimeException - if fewer than k results can be found in the index.
      -
    • -
  • -
    -

    query

    -
    public Index.QueryResults[] query(float[][] queryVectors, - int k, - int numThreads, - long queryEf)
    + + + + +
      +
    • +

      query

      +
      public Index.QueryResults[] query​(float[][] queryVectors,
+                                  int k,
+                                  int numThreads,
+                                  long queryEf)
      Query this Index for approximate nearest neighbors of multiple query vectors.
      -
      -
      Parameters:
      +
      +
      Parameters:
      queryVectors - The query vectors to use for searching.
      k - The number of nearest neighbors to return for each query vector
      numThreads - The number of threads to use when searching. If -1, all available CPU cores @@ -840,115 +1077,194 @@

      query

      more data to each call instead to reduce overhead.
      queryEf - The per-query "ef" value to use. Larger values produce more accurate results at the expense of query time.
      -
      Returns:
      +
      Returns:
      An array of Index.QueryResults objects, each containing the neighbors found that are (approximately) nearest to the corresponding query vector. The returned list of Index.QueryResults will contain the same number of elements as queryVectors.
      -
      Throws:
      -
      RuntimeException - if fewer than k results can be found in the index for one or +
      Throws:
      +
      RuntimeException - if fewer than k results can be found in the index for one or more queries.
      -
    • -
  • -
    -

    markDeleted

    -
    public void markDeleted(long label)
    + + + + +
      +
    • +

      markDeleted

      +
      public void markDeleted​(long label)
      Mark an element of the index as deleted. Deleted elements will be skipped when querying, but will still be present in the index.
      -
      -
      Parameters:
      +
      +
      Parameters:
      label - The ID of the element to mark as deleted.
      -
      Throws:
      -
      RuntimeException - If the provided identifier is not present in the Index.
      +
      Throws:
      +
      RuntimeException - If the provided identifier is not present in the Index.
      -
    • -
  • -
    -

    unmarkDeleted

    -
    public void unmarkDeleted(long label)
    + + + + +
      +
    • +

      unmarkDeleted

      +
      public void unmarkDeleted​(long label)
      Un-mark an element of the index as deleted, making it available again.
      -
      -
      Parameters:
      +
      +
      Parameters:
      label - The ID of the element to unmark as deleted.
      -
      Throws:
      -
      RuntimeException - If the provided identifier is not present in the Index.
      +
      Throws:
      +
      RuntimeException - If the provided identifier is not present in the Index.
      -
    • -
  • -
    -

    resizeIndex

    -
    public void resizeIndex(long newSize)
    + + + + +
      +
    • +

      resizeIndex

      +
      public void resizeIndex​(long newSize)
      Change the maximum number of elements currently storable by this Index. This operation reallocates the memory used by the index and can be quite slow, so it may be useful to set the maximum number of elements in advance if that number is known.
      -
      -
      Parameters:
      +
      +
      Parameters:
      newSize - The new number of maximum elements to resize this Index to.
      -
    • -
  • -
    -

    getMaxElements

    -
    public long getMaxElements()
    + + + + +
      +
    • +

      getMaxElements

      +
      public long getMaxElements()
      Get the maximum number of elements currently storable by this Index. If more elements are added than getMaxElements(), the index will be automatically (but slowly) resized.
      -
      -
      Returns:
      +
      +
      Returns:
      The number of elements (vectors) that are currently storable in this Index.
      -
    • -
  • -
    -

    getNumElements

    -
    public long getNumElements()
    + + + + +
      +
    • +

      getNumElements

      +
      public long getNumElements()
      Get the number of elements currently in this Index.
      -
      -
      Returns:
      +
      +
      Returns:
      The number of elements (vectors) in this Index. This count includes any deleted elements.
      -
    • -
  • -
    -

    getEfConstruction

    -
    public long getEfConstruction()
    + + + + +
      +
    • +

      getEfConstruction

      +
      public long getEfConstruction()
      Get the EF Construction value used when adding new elements to this Index.
      -
      -
      Returns:
      +
      +
      Returns:
      The current EF Construction value (i.e.: the number of neighbors to search for when adding new elements).
      -
    • -
  • -
    -

    getM

    -
    public long getM()
    + + + + +
      +
    • +

      getM

      +
      public long getM()
      Get the M value used when adding new elements to this Index.
      -
      -
      Returns:
      +
      +
      Returns:
      The current M value (i.e.: the number of links between adjacent vectors to create when adding elements).
      -
    • - - + + +
    + + + +

    Copyright © 2023. All rights reserved.

    + diff --git a/docs/java/com/spotify/voyager/jni/StringIndex.QueryResults.html b/docs/java/com/spotify/voyager/jni/StringIndex.QueryResults.html index b26747cb..ecb59a12 100644 --- a/docs/java/com/spotify/voyager/jni/StringIndex.QueryResults.html +++ b/docs/java/com/spotify/voyager/jni/StringIndex.QueryResults.html @@ -1,219 +1,388 @@ + - -StringIndex.QueryResults (voyager 2.0.1 API) - + +StringIndex.QueryResults (voyager 2.0.2 API) - - - - + - - + + + + + - - -
    -
    +
     
    + + -
    -
    +
    -
    Package com.spotify.voyager.jni
    -

    Class StringIndex.QueryResults

    -
    -
    java.lang.Object -
    com.spotify.voyager.jni.StringIndex.QueryResults
    +
    Package com.spotify.voyager.jni
    +

    Class StringIndex.QueryResults

    -
    -
    +
    + +
    +
      +
    • +
      Enclosing class:
      StringIndex
      -
      public static class StringIndex.QueryResults -extends Object
      +
      public static class StringIndex.QueryResults
+extends Object
      A wrapper class for nearest neighbor query results.
      -
    -
    -
    -
    -

    Methods inherited from class java.lang.Object

    -clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    +
    +
    +
    + - + + +
    + + + +

    Copyright © 2023. All rights reserved.

    + diff --git a/docs/java/com/spotify/voyager/jni/StringIndex.html b/docs/java/com/spotify/voyager/jni/StringIndex.html index fd50e650..cf4753c9 100644 --- a/docs/java/com/spotify/voyager/jni/StringIndex.html +++ b/docs/java/com/spotify/voyager/jni/StringIndex.html @@ -1,262 +1,378 @@ + - -StringIndex (voyager 2.0.1 API) - + +StringIndex (voyager 2.0.2 API) - - - - + - - + + + + + - - -
    -
    +
     
    + + -
    -
    +
    -
    Package com.spotify.voyager.jni
    -

    Class StringIndex

    -
    -
    java.lang.Object -
    com.spotify.voyager.jni.StringIndex
    +
    Package com.spotify.voyager.jni
    +

    Class StringIndex

    -
    -
    +
    + +
    +
      +
    • +
      All Implemented Interfaces:
      -
      Closeable, AutoCloseable
      +
      Closeable, AutoCloseable
      -
      public class StringIndex -extends Object -implements Closeable
      +
      public class StringIndex
+extends Object
+implements Closeable
      Wrapper around com.spotify.voyager.jni.Index with a simplified interface which maps the index ID to a provided String.

      StringIndex can only accommodate up to 2^31 - 1 (2.1B) items, despite typical Voyager indices allowing up to 2^63 - 1 (9e18) items.

      -
    -
    -
      + +
    +
    +
    + + -
  • -
    -

    Method Details

    - + + + +
      +
    • +

      load

      +
      public static StringIndex load​(InputStream indexInputStream,
+                               InputStream nameListInputStream,
+                               Index.SpaceType spaceType,
+                               int numDimensions,
+                               Index.StorageDataType storageDataType)
      Load a previously constructed index from the provided input streams. It is important that the dimensions, space type, and storage data type provided are the same that the index was constructed with.
      -
      -
      Parameters:
      +
      +
      Parameters:
      indexInputStream - input stream pointing to the underlying HNSW index
      nameListInputStream - input stream pointing to the JSON encoded names list
      spaceType -
      numDimensions - Number of dimensions of each embedding stored in the underlying HNSW index
      storageDataType -
      -
      Returns:
      +
      Returns:
      reference to the loaded StringIndex
      -
      See Also:
      -
      - -
      +
      See Also:
      +
      Index.SpaceType, +Index.StorageDataType
      -
    • -
  • -
    -

    load

    -
    public static StringIndex load(String indexFilename, - String nameListFilename)
    -
    Load a previously constructed index from the provided file location. The space type, dimensions, and storage data type are read from the file metadata.
    -
    -
    Parameters:
    + + + + +
      +
    • +

      load

      +
      public static StringIndex load​(String indexFilename,
+                               String nameListFilename)
      +
      Load a previously constructed index from the provided file location. The space type, + dimensions, and storage data type are read from the file metadata.
      +
      +
      Parameters:
      indexFilename - Filename of the underlying HNSW index
      nameListFilename - Filename of the JSON encoded names list
      -
      Returns:
      +
      Returns:
      reference to the loaded StringIndex
      -
    • -
  • -
    -

    load

    -
    public static StringIndex load(InputStream indexInputStream, - InputStream nameListInputStream)
    -
    Load a previously constructed index from the provided input stream. The space type, dimensions, and storage data type are read from the file metadata.
    -
    -
    Parameters:
    + + + + +
      +
    • +

      load

      +
      public static StringIndex load​(InputStream indexInputStream,
+                               InputStream nameListInputStream)
      +
      Load a previously constructed index from the provided input stream. The space type, dimensions, + and storage data type are read from the file metadata.
      +
      +
      Parameters:
      indexInputStream - input stream pointing to the underlying HNSW index
      nameListInputStream - input stream pointing to the JSON encoded names list
      -
      Returns:
      +
      Returns:
      reference to the loaded StringIndex
      -
    • -
  • -
    -

    saveIndex

    -
    public void saveIndex(String outputDirectory) - throws IOException
    + + + + +
      +
    • +

      saveIndex

      +
      public void saveIndex​(String outputDirectory)
+               throws IOException
      Save the underlying index and JSON encoded name list to the provided output directory
      -
      -
      Parameters:
      +
      +
      Parameters:
      outputDirectory - directory to output files to
      -
      Throws:
      -
      IOException - when there is an error writing to JSON or saving to disk
      +
      Throws:
      +
      IOException - when there is an error writing to JSON or saving to disk
      -
    • -
  • -
    -

    saveIndex

    -
    public void saveIndex(String outputDirectory, - String indexFilename, - String nameListFilename) - throws IOException
    -
    -
    Throws:
    -
    IOException
    + + + + +
    • -
  • -
    -

    saveIndex

    -
    public void saveIndex(OutputStream indexOutputStream, - OutputStream namesListOutputStream) - throws IOException
    + + + + +
      +
    • +

      saveIndex

      +
      public void saveIndex​(OutputStream indexOutputStream,
+                      OutputStream namesListOutputStream)
+               throws IOException
      Save the underlying HNSW index and JSON encoded names list to the provided output streams
      -
      -
      Parameters:
      +
      +
      Parameters:
      indexOutputStream - output stream pointing to the location to save the HNSW index
      namesListOutputStream - output stream pointing to the location to save the JSON names list
      -
      Throws:
      -
      IOException - when there is an error writing to JSON or the output streams
      +
      Throws:
      +
      IOException - when there is an error writing to JSON or the output streams
      -
    • -
  • -
    -

    addItem

    -
    public void addItem(String name, - float[] vector)
    -
    + + + + + + + + + + + + + + + + + + + + + -
    • - + + +
    + + + +

    Copyright © 2023. All rights reserved.

    + diff --git a/docs/java/com/spotify/voyager/jni/class-use/Index.QueryResults.html b/docs/java/com/spotify/voyager/jni/class-use/Index.QueryResults.html index 3126af38..39135421 100644 --- a/docs/java/com/spotify/voyager/jni/class-use/Index.QueryResults.html +++ b/docs/java/com/spotify/voyager/jni/class-use/Index.QueryResults.html @@ -1,114 +1,226 @@ + - -Uses of Class com.spotify.voyager.jni.Index.QueryResults (voyager 2.0.1 API) - + +Uses of Class com.spotify.voyager.jni.Index.QueryResults (voyager 2.0.2 API) - - - - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Uses of Class
    com.spotify.voyager.jni.Index.QueryResults

    +

    Uses of Class
    com.spotify.voyager.jni.Index.QueryResults

    -
    Packages that use Index.QueryResults
    -
    -
    Package
    -
    Description
    -
    com.spotify.voyager.jni
    -
    +
    + +
    + +

    Copyright © 2023. All rights reserved.

    + diff --git a/docs/java/com/spotify/voyager/jni/class-use/Index.SpaceType.html b/docs/java/com/spotify/voyager/jni/class-use/Index.SpaceType.html index 6c8a267d..2ba232fd 100644 --- a/docs/java/com/spotify/voyager/jni/class-use/Index.SpaceType.html +++ b/docs/java/com/spotify/voyager/jni/class-use/Index.SpaceType.html @@ -1,186 +1,315 @@ + - -Uses of Enum com.spotify.voyager.jni.Index.SpaceType (voyager 2.0.1 API) - + +Uses of Class com.spotify.voyager.jni.Index.SpaceType (voyager 2.0.2 API) - - - - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Uses of Enum
    com.spotify.voyager.jni.Index.SpaceType

    +

    Uses of Class
    com.spotify.voyager.jni.Index.SpaceType

    -
    Packages that use Index.SpaceType
    -
    -
    Package
    -
    Description
    -
    com.spotify.voyager.jni
    -
    +
    + +
    -
    -

    Copyright © 2023. All rights reserved.

    -
    + +

    Copyright © 2023. All rights reserved.

    + diff --git a/docs/java/com/spotify/voyager/jni/class-use/Index.StorageDataType.html b/docs/java/com/spotify/voyager/jni/class-use/Index.StorageDataType.html index f7359deb..b495e421 100644 --- a/docs/java/com/spotify/voyager/jni/class-use/Index.StorageDataType.html +++ b/docs/java/com/spotify/voyager/jni/class-use/Index.StorageDataType.html @@ -1,168 +1,293 @@ + - -Uses of Enum com.spotify.voyager.jni.Index.StorageDataType (voyager 2.0.1 API) - + +Uses of Class com.spotify.voyager.jni.Index.StorageDataType (voyager 2.0.2 API) - - - - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Uses of Enum
    com.spotify.voyager.jni.Index.StorageDataType

    +

    Uses of Class
    com.spotify.voyager.jni.Index.StorageDataType

    -
    Packages that use Index.StorageDataType
    -
    -
    Package
    -
    Description
    -
    com.spotify.voyager.jni
    -
    +
    + +
    -
    -

    Copyright © 2023. All rights reserved.

    -
    + +

    Copyright © 2023. All rights reserved.

    + diff --git a/docs/java/com/spotify/voyager/jni/class-use/Index.html b/docs/java/com/spotify/voyager/jni/class-use/Index.html index a7f682a6..b0d432f3 100644 --- a/docs/java/com/spotify/voyager/jni/class-use/Index.html +++ b/docs/java/com/spotify/voyager/jni/class-use/Index.html @@ -1,116 +1,228 @@ + - -Uses of Class com.spotify.voyager.jni.Index (voyager 2.0.1 API) - + +Uses of Class com.spotify.voyager.jni.Index (voyager 2.0.2 API) - - - - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Uses of Class
    com.spotify.voyager.jni.Index

    +

    Uses of Class
    com.spotify.voyager.jni.Index

    -
    Packages that use Index
    -
    -
    Package
    -
    Description
    -
    com.spotify.voyager.jni
    -
    +
    + +
    -
    -

    Copyright © 2023. All rights reserved.

    -
    + +

    Copyright © 2023. All rights reserved.

    + diff --git a/docs/java/com/spotify/voyager/jni/class-use/StringIndex.QueryResults.html b/docs/java/com/spotify/voyager/jni/class-use/StringIndex.QueryResults.html index db8c7d69..c7a3fcb3 100644 --- a/docs/java/com/spotify/voyager/jni/class-use/StringIndex.QueryResults.html +++ b/docs/java/com/spotify/voyager/jni/class-use/StringIndex.QueryResults.html @@ -1,93 +1,199 @@ + - -Uses of Class com.spotify.voyager.jni.StringIndex.QueryResults (voyager 2.0.1 API) - + +Uses of Class com.spotify.voyager.jni.StringIndex.QueryResults (voyager 2.0.2 API) - - - - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Uses of Class
    com.spotify.voyager.jni.StringIndex.QueryResults

    +

    Uses of Class
    com.spotify.voyager.jni.StringIndex.QueryResults

    -
    Packages that use StringIndex.QueryResults
    -
    -
    Package
    -
    Description
    -
    com.spotify.voyager.jni
    -
    +
    + +
    -
    -

    Copyright © 2023. All rights reserved.

    -
    + +

    Copyright © 2023. All rights reserved.

    + diff --git a/docs/java/com/spotify/voyager/jni/class-use/StringIndex.html b/docs/java/com/spotify/voyager/jni/class-use/StringIndex.html index c33b79c9..662fe29c 100644 --- a/docs/java/com/spotify/voyager/jni/class-use/StringIndex.html +++ b/docs/java/com/spotify/voyager/jni/class-use/StringIndex.html @@ -1,116 +1,228 @@ + - -Uses of Class com.spotify.voyager.jni.StringIndex (voyager 2.0.1 API) - + +Uses of Class com.spotify.voyager.jni.StringIndex (voyager 2.0.2 API) - - - - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Uses of Class
    com.spotify.voyager.jni.StringIndex

    +

    Uses of Class
    com.spotify.voyager.jni.StringIndex

    -
    Packages that use StringIndex
    -
    -
    Package
    -
    Description
    -
    com.spotify.voyager.jni
    -
    +
    + +
    -
    -

    Copyright © 2023. All rights reserved.

    -
    + +

    Copyright © 2023. All rights reserved.

    + diff --git a/docs/java/com/spotify/voyager/jni/package-summary.html b/docs/java/com/spotify/voyager/jni/package-summary.html index 26d67965..ac831a0d 100644 --- a/docs/java/com/spotify/voyager/jni/package-summary.html +++ b/docs/java/com/spotify/voyager/jni/package-summary.html @@ -1,136 +1,217 @@ + - -com.spotify.voyager.jni (voyager 2.0.1 API) - + +com.spotify.voyager.jni (voyager 2.0.2 API) - - - - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Package com.spotify.voyager.jni

    +

    Package com.spotify.voyager.jni

    -
    -
    package com.spotify.voyager.jni
    -
    +
    +
    + +
    Java Native Interface (JNI) bindings to expose functionality from Voyager's C++ code into Java.
    -
    -
      -
    • - -
      • -
    • -
      -
      -
      -
      -
      Class
      -
      Description
      -
      Index
      -
      +
        +
      • + + + + + + + + + + + + + + + + + + + + + + + + +
        Class Summary 
        ClassDescription
        Index
        A Voyager index, providing storage of floating-point vectors and the ability to efficiently search among those vectors.
        - -
        Index.QueryResults
        -
        +
        Index.QueryResults
        A container for query results, returned by Index.
        - -
        Index.SpaceType
        -
        -
        The space, also known as distance metric, to use when searching.
        -
        -
        Index.StorageDataType
        -
        -
        The datatype used to use when storing vectors on disk.
        -
        -
        StringIndex
        -
        +
        StringIndex
        Wrapper around com.spotify.voyager.jni.Index with a simplified interface which maps the index ID to a provided String.
        - -
        StringIndex.QueryResults
        -
        +
        StringIndex.QueryResults
        A wrapper class for nearest neighbor query results.
        - - - - +
        +
        • +
      • + + + + + + + + + + + + + + + + +
        Enum Summary 
        EnumDescription
        Index.SpaceType +
        The space, also known as distance metric, to use when searching.
        +
        Index.StorageDataType +
        The datatype used to use when storing vectors on disk.
        +
      -
    +
    -
    -

    Copyright © 2023. All rights reserved.

    -
    + +

    Copyright © 2023. All rights reserved.

    + diff --git a/docs/java/com/spotify/voyager/jni/package-tree.html b/docs/java/com/spotify/voyager/jni/package-tree.html index 145045c2..a4c770d4 100644 --- a/docs/java/com/spotify/voyager/jni/package-tree.html +++ b/docs/java/com/spotify/voyager/jni/package-tree.html @@ -1,94 +1,182 @@ + - -com.spotify.voyager.jni Class Hierarchy (voyager 2.0.1 API) - + +com.spotify.voyager.jni Class Hierarchy (voyager 2.0.2 API) - - - - + - - + + + + + - - -
    -
    +
     
    + + -

    Hierarchy For Package com.spotify.voyager.jni

    -Package Hierarchies: +Package Hierarchies:
    -
    +
    +

    Class Hierarchy

    -
    +

    Enum Hierarchy

    +
    -
    -

    Copyright © 2023. All rights reserved.

    -
    + +

    Copyright © 2023. All rights reserved.

    + diff --git a/docs/java/com/spotify/voyager/jni/package-use.html b/docs/java/com/spotify/voyager/jni/package-use.html index 764458dd..a8c6e149 100644 --- a/docs/java/com/spotify/voyager/jni/package-use.html +++ b/docs/java/com/spotify/voyager/jni/package-use.html @@ -1,110 +1,220 @@ + - -Uses of Package com.spotify.voyager.jni (voyager 2.0.1 API) - + +Uses of Package com.spotify.voyager.jni (voyager 2.0.2 API) - - - - + - - + + + + + - - -
    -
    +
     
    + + -

    Uses of Package
    com.spotify.voyager.jni

    -
    Packages that use com.spotify.voyager.jni
    -
    -
    Package
    -
    Description
    -
    com.spotify.voyager.jni
    -
    +
    + - +
    -
    -

    Copyright © 2023. All rights reserved.

    -
    + +

    Copyright © 2023. All rights reserved.

    + diff --git a/docs/java/com/spotify/voyager/jni/utils/JniLibExtractor.html b/docs/java/com/spotify/voyager/jni/utils/JniLibExtractor.html index 32d74744..777a6d58 100644 --- a/docs/java/com/spotify/voyager/jni/utils/JniLibExtractor.html +++ b/docs/java/com/spotify/voyager/jni/utils/JniLibExtractor.html @@ -1,163 +1,307 @@ + - -JniLibExtractor (voyager 2.0.1 API) - + +JniLibExtractor (voyager 2.0.2 API) - - - - + - - + + + + + - - -
    -
    +
     
    + + -
    -
    +
    -
    Package com.spotify.voyager.jni.utils
    -

    Class JniLibExtractor

    +
    Package com.spotify.voyager.jni.utils
    +

    Class JniLibExtractor

    -
    java.lang.Object -
    com.spotify.voyager.jni.utils.JniLibExtractor
    -
    -
    -
    -
    public class JniLibExtractor -extends Object
    -
    -
    -
    +
    -
    -

    Copyright © 2023. All rights reserved.

    -
    + +

    Copyright © 2023. All rights reserved.

    + diff --git a/docs/java/com/spotify/voyager/jni/utils/TinyJson.html b/docs/java/com/spotify/voyager/jni/utils/TinyJson.html index 8ef67736..bc91109b 100644 --- a/docs/java/com/spotify/voyager/jni/utils/TinyJson.html +++ b/docs/java/com/spotify/voyager/jni/utils/TinyJson.html @@ -1,181 +1,330 @@ + - -TinyJson (voyager 2.0.1 API) - + +TinyJson (voyager 2.0.2 API) - - - - + - - + + + + + - - -
    -
    +
     
    + + -
    -
    +
    -
    Package com.spotify.voyager.jni.utils
    -

    Class TinyJson

    +
    Package com.spotify.voyager.jni.utils
    +

    Class TinyJson

    -
    java.lang.Object -
    com.spotify.voyager.jni.utils.TinyJson
    -
    -
    +
    + +
    +
      +
    • -
      public class TinyJson -extends Object
      +
      public class TinyJson
+extends Object
      A dependency-free, super tiny JSON serde class that only supports reading and writing lists of strings.
      -
    -
    -
    -
    -

    Methods inherited from class java.lang.Object

    -clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +
    +
    +
    + - + + +
    +
    +
    -
    -

    Copyright © 2023. All rights reserved.

    -
    + +

    Copyright © 2023. All rights reserved.

    + diff --git a/docs/java/com/spotify/voyager/jni/utils/class-use/JniLibExtractor.html b/docs/java/com/spotify/voyager/jni/utils/class-use/JniLibExtractor.html index 9360855b..2b3d08bd 100644 --- a/docs/java/com/spotify/voyager/jni/utils/class-use/JniLibExtractor.html +++ b/docs/java/com/spotify/voyager/jni/utils/class-use/JniLibExtractor.html @@ -1,62 +1,149 @@ + - -Uses of Class com.spotify.voyager.jni.utils.JniLibExtractor (voyager 2.0.1 API) - + +Uses of Class com.spotify.voyager.jni.utils.JniLibExtractor (voyager 2.0.2 API) - - - - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Uses of Class
    com.spotify.voyager.jni.utils.JniLibExtractor

    +

    Uses of Class
    com.spotify.voyager.jni.utils.JniLibExtractor

    -No usage of com.spotify.voyager.jni.utils.JniLibExtractor
    +
    No usage of com.spotify.voyager.jni.utils.JniLibExtractor
    +
    -
    -

    Copyright © 2023. All rights reserved.

    -
    + +

    Copyright © 2023. All rights reserved.

    + diff --git a/docs/java/com/spotify/voyager/jni/utils/class-use/TinyJson.html b/docs/java/com/spotify/voyager/jni/utils/class-use/TinyJson.html index 50631593..b7b3848f 100644 --- a/docs/java/com/spotify/voyager/jni/utils/class-use/TinyJson.html +++ b/docs/java/com/spotify/voyager/jni/utils/class-use/TinyJson.html @@ -1,62 +1,149 @@ + - -Uses of Class com.spotify.voyager.jni.utils.TinyJson (voyager 2.0.1 API) - + +Uses of Class com.spotify.voyager.jni.utils.TinyJson (voyager 2.0.2 API) - - - - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Uses of Class
    com.spotify.voyager.jni.utils.TinyJson

    +

    Uses of Class
    com.spotify.voyager.jni.utils.TinyJson

    -No usage of com.spotify.voyager.jni.utils.TinyJson
    +
    No usage of com.spotify.voyager.jni.utils.TinyJson
    +
    -
    -

    Copyright © 2023. All rights reserved.

    -
    + +

    Copyright © 2023. All rights reserved.

    + diff --git a/docs/java/com/spotify/voyager/jni/utils/package-summary.html b/docs/java/com/spotify/voyager/jni/utils/package-summary.html index 05e6774c..94a71419 100644 --- a/docs/java/com/spotify/voyager/jni/utils/package-summary.html +++ b/docs/java/com/spotify/voyager/jni/utils/package-summary.html @@ -1,105 +1,174 @@ + - -com.spotify.voyager.jni.utils (voyager 2.0.1 API) - + +com.spotify.voyager.jni.utils (voyager 2.0.2 API) - - - - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Package com.spotify.voyager.jni.utils

    -
    -
    -
    package com.spotify.voyager.jni.utils
    -
    -
      -
    • - -
      • -
    • -
      -
      Classes
      -
      -
      Class
      -
      Description
      -
      JniLibExtractor
      -
       
      -
      TinyJson
      -
      +
      +
        +
      • + + + + + + + + + + + + + + + + +
        Class Summary 
        ClassDescription
        JniLibExtractor 
        TinyJson
        A dependency-free, super tiny JSON serde class that only supports reading and writing lists of strings.
        - - - +
      -
    +
    -
    -

    Copyright © 2023. All rights reserved.

    -
    + +

    Copyright © 2023. All rights reserved.

    + diff --git a/docs/java/com/spotify/voyager/jni/utils/package-tree.html b/docs/java/com/spotify/voyager/jni/utils/package-tree.html index 1738bdf2..9f26b212 100644 --- a/docs/java/com/spotify/voyager/jni/utils/package-tree.html +++ b/docs/java/com/spotify/voyager/jni/utils/package-tree.html @@ -1,77 +1,165 @@ + - -com.spotify.voyager.jni.utils Class Hierarchy (voyager 2.0.1 API) - + +com.spotify.voyager.jni.utils Class Hierarchy (voyager 2.0.2 API) - - - - + - - + + + + + - - -
    -
    +
     
    + + -

    Hierarchy For Package com.spotify.voyager.jni.utils

    -Package Hierarchies: +Package Hierarchies:
    -
    +
    +

    Class Hierarchy

    +
    -
    -

    Copyright © 2023. All rights reserved.

    -
    + +

    Copyright © 2023. All rights reserved.

    + diff --git a/docs/java/com/spotify/voyager/jni/utils/package-use.html b/docs/java/com/spotify/voyager/jni/utils/package-use.html index 11c484ee..1c089783 100644 --- a/docs/java/com/spotify/voyager/jni/utils/package-use.html +++ b/docs/java/com/spotify/voyager/jni/utils/package-use.html @@ -1,62 +1,149 @@ + - -Uses of Package com.spotify.voyager.jni.utils (voyager 2.0.1 API) - + +Uses of Package com.spotify.voyager.jni.utils (voyager 2.0.2 API) - - - - + - - + + + + + - - -
    -
    +
     
    + + -

    Uses of Package
    com.spotify.voyager.jni.utils

    -No usage of com.spotify.voyager.jni.utils
    +
    No usage of com.spotify.voyager.jni.utils
    +
    -
    -

    Copyright © 2023. All rights reserved.

    -
    + +

    Copyright © 2023. All rights reserved.

    + diff --git a/docs/java/com/spotify/voyager/package-summary.html b/docs/java/com/spotify/voyager/package-summary.html index 71e42e48..6ed69d00 100644 --- a/docs/java/com/spotify/voyager/package-summary.html +++ b/docs/java/com/spotify/voyager/package-summary.html @@ -1,67 +1,105 @@ + - -com.spotify.voyager (voyager 2.0.1 API) - + +com.spotify.voyager (voyager 2.0.2 API) - - - - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Package com.spotify.voyager

    +

    Package com.spotify.voyager

    -
    -
    package com.spotify.voyager
    -
    +
    +
    + +
    Voyager is a Java and Python library that provides approximate nearest-neighbor search of vector data. For most use cases, Index will be the primary interface to Voyager's functionality. @@ -87,29 +125,54 @@

    Package com.spotify.voyage index.saveIndex("my_tiny_index.voy");

    -
    -
      -
    • - -
      • -
    -
    -
    -

    Copyright © 2023. All rights reserved.

    -
    + +

    Copyright © 2023. All rights reserved.

    + diff --git a/docs/java/com/spotify/voyager/package-tree.html b/docs/java/com/spotify/voyager/package-tree.html index bdc3e56e..b658c470 100644 --- a/docs/java/com/spotify/voyager/package-tree.html +++ b/docs/java/com/spotify/voyager/package-tree.html @@ -1,66 +1,152 @@ + - -com.spotify.voyager Class Hierarchy (voyager 2.0.1 API) - + +com.spotify.voyager Class Hierarchy (voyager 2.0.2 API) - - - - + - - + + + + + - - -
    -
    +
     
    + + -

    Hierarchy For Package com.spotify.voyager

    -Package Hierarchies: +Package Hierarchies:
    -
    -

    Copyright © 2023. All rights reserved.

    -
    + +

    Copyright © 2023. All rights reserved.

    + diff --git a/docs/java/com/spotify/voyager/package-use.html b/docs/java/com/spotify/voyager/package-use.html index 225d8f99..b672c230 100644 --- a/docs/java/com/spotify/voyager/package-use.html +++ b/docs/java/com/spotify/voyager/package-use.html @@ -1,62 +1,149 @@ + - -Uses of Package com.spotify.voyager (voyager 2.0.1 API) - + +Uses of Package com.spotify.voyager (voyager 2.0.2 API) - - - - + - - + + + + + - - -
    -
    +
     
    + + -

    Uses of Package
    com.spotify.voyager

    -No usage of com.spotify.voyager
    +
    No usage of com.spotify.voyager
    +
    -
    -

    Copyright © 2023. All rights reserved.

    -
    + +

    Copyright © 2023. All rights reserved.

    + diff --git a/docs/java/constant-values.html b/docs/java/constant-values.html index 377d6d02..8f3e48fd 100644 --- a/docs/java/constant-values.html +++ b/docs/java/constant-values.html @@ -2,8 +2,8 @@ - -Constant Field Values (voyager 2.0.1 API) + +Constant Field Values (voyager 2.0.2 API) @@ -21,7 +21,7 @@ - - + + + + + - - -
    -
    +
     
    + + -
    -

    JavaDoc Help

    - -
    -
    -

    Navigation

    -Starting from the Overview page, you can browse the documentation using the links in each page, and in the navigation bar at the top of each page. The Index and Search box allow you to navigate to specific declarations and summary pages, including: All Packages, All Classes and Interfaces - +
    +

    How This API Document Is Organized

    +
    This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.
    -
    -
    -

    Kinds of Pages

    -The following sections describe the different kinds of pages in this collection. -
    -

    Overview

    +
    +
      +
    • +
      +

      Overview

      The Overview page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.

      -
      -

      Package

      -

      Each package has a page that contains a list of its classes and interfaces, with a summary for each. These pages may contain the following categories:

      -
        + +
      • +
        +

        Package

        +

        Each package has a page that contains a list of its classes and interfaces, with a summary for each. These pages may contain six categories:

        +
        • Interfaces
        • Classes
        • Enums
          • @@ -111,10 +118,12 @@

          Package

        • Annotation Types
        -
        -

        Class or Interface

        -

        Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a declaration and description, member summary tables, and detailed member descriptions. Entries in each of these sections are omitted if they are empty or not applicable.

        -
          + +
        • +
          +

          Class or Interface

          +

          Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:

          +
          • Class Inheritance Diagram
          • Direct Subclasses
          • All Known Subinterfaces
            • @@ -123,64 +132,150 @@

            Class or Interface

          • Class or Interface Description

          -
            +
            • Nested Class Summary
              • -
            • Enum Constant Summary
            • Field Summary
            • Property Summary
            • Constructor Summary
            • Method Summary
              • -
            • Required Element Summary
              • -
            • Optional Element Summary

            -
              -
            • Enum Constant Details
              • -
            • Field Details
              • -
            • Property Details
              • -
            • Constructor Details
              • -
            • Method Details
              • -
            • Element Details
              • +
                +
              • Field Detail
                • +
              • Property Detail
                • +
              • Constructor Detail
                • +
              • Method Detail
              -

              Note: Annotation interfaces have required and optional elements, but not methods. Only enum classes have enum constants. The components of a record class are displayed as part of the declaration of the record class. Properties are a feature of JavaFX.

              -

              The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.

              +

              Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.

          -
          -

          Other Files

          -

          Packages and modules may contain pages with additional information related to the declarations nearby.

          +
          • +
        • +
          +

          Annotation Type

          +

          Each annotation type has its own separate page with the following sections:

          +
            +
          • Annotation Type Declaration
            • +
          • Annotation Type Description
            • +
          • Required Element Summary
            • +
          • Optional Element Summary
            • +
          • Element Detail
            • +
          +
          +
          • +
        • +
          +

          Enum

          +

          Each enum has its own separate page with the following sections:

          +
            +
          • Enum Declaration
            • +
          • Enum Description
            • +
          • Enum Constant Summary
            • +
          • Enum Constant Detail
            • +
          -
          -

          Use

          -

          Each documented package, class and interface has its own Use page. This page describes what packages, classes, methods, constructors and fields use any part of the given class or package. Given a class or interface A, its Use page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A. You can access this page by first going to the package, class or interface, then clicking on the USE link in the navigation bar.

          +
          • +
        • +
          +

          Use

          +

          Each documented package, class and interface has its own Use page. This page describes what packages, classes, methods, constructors and fields use any part of the given class or package. Given a class or interface A, its "Use" page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A. You can access this page by first going to the package, class or interface, then clicking on the "Use" link in the navigation bar.

          -
          -

          Tree (Class Hierarchy)

          +
          • +
        • +
          +

          Tree (Class Hierarchy)

          There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. Classes are organized by inheritance structure starting with java.lang.Object. Interfaces do not inherit from java.lang.Object.

          -
            -
          • When viewing the Overview page, clicking on TREE displays the hierarchy for all packages.
            • -
          • When viewing a particular package, class or interface page, clicking on TREE displays the hierarchy for only that package.
            • +
              +
            • When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.
              • +
            • When viewing a particular package, class or interface page, clicking on "Tree" displays the hierarchy for only that package.
          -
          -

          All Packages

          -

          The All Packages page contains an alphabetic index of all packages contained in the documentation.

          +
          • +
        • +
          +

          Deprecated API

          +

          The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.

          -
          -

          All Classes and Interfaces

          -

          The All Classes and Interfaces page contains an alphabetic index of all classes and interfaces contained in the documentation, including annotation interfaces, enum classes, and record classes.

          +
          • +
        • +
          +

          Index

          +

          The Index contains an alphabetic index of all classes, interfaces, constructors, methods, and fields, as well as lists of all packages and all classes.

          -
          -

          Index

          -

          The Index contains an alphabetic index of all classes, interfaces, constructors, methods, and fields in the documentation, as well as summary pages such as All Packages, All Classes and Interfaces.

          +
          • +
        • +
          +

          All Classes

          +

          The All Classes link shows all classes and interfaces except non-static nested types.

          -
    + +
  • +
    +

    Serialized Form

    +

    Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description.

    +
    +
    • +
  • +
    +

    Constant Field Values

    +

    The Constant Field Values page lists the static final fields and their values.

    +
    +
    • +
  • +
    +

    Search

    +

    You can search for definitions of modules, packages, types, fields, methods and other terms defined in the API, using some or all of the name. "Camel-case" abbreviations are supported: for example, "InpStr" will find "InputStream" and "InputStreamReader".

    +
    +
    • +
    -This help file applies to API documentation generated by the standard doclet.
    +This help file applies to API documentation generated by the standard doclet.
    +
    -
    -

    Copyright © 2023. All rights reserved.

    -
    + +

    Copyright © 2023. All rights reserved.

    + diff --git a/docs/java/index-all.html b/docs/java/index-all.html index 44b32893..5190f72f 100644 --- a/docs/java/index-all.html +++ b/docs/java/index-all.html @@ -1,89 +1,136 @@ + - -Index (voyager 2.0.1 API) - + +Index (voyager 2.0.2 API) - - - - + - - + + + + + - - -
    -
    +
     
    + + -
    -
    -

    Index

    -
    -A C D E F G I J L M Q R S T U V W 
    All Classes and Interfaces|All Packages -

    A

    -
    -
    addItem(float[]) - Method in class com.spotify.voyager.jni.Index
    +
    A C D E F G I J L M Q R S T U V W 
    All Classes All Packages + + +

    A

    +
    +
    addItem(float[]) - Method in class com.spotify.voyager.jni.Index
    Add an item (a vector) to this Index.
    -
    addItem(float[], long) - Method in class com.spotify.voyager.jni.Index
    +
    addItem(float[], long) - Method in class com.spotify.voyager.jni.Index
    Add an item (a vector) to this Index with the provided identifier.
    -
    addItem(String, float[]) - Method in class com.spotify.voyager.jni.StringIndex
    +
    addItem(String, float[]) - Method in class com.spotify.voyager.jni.StringIndex
     
    -
    addItem(String, List<Float>) - Method in class com.spotify.voyager.jni.StringIndex
    +
    addItem(String, List<Float>) - Method in class com.spotify.voyager.jni.StringIndex
     
    -
    addItems(float[][], int) - Method in class com.spotify.voyager.jni.Index
    +
    addItems(float[][], int) - Method in class com.spotify.voyager.jni.Index
    Add multiple items (vectors) to this Index.
    -
    addItems(float[][], long[], int) - Method in class com.spotify.voyager.jni.Index
    +
    addItems(float[][], long[], int) - Method in class com.spotify.voyager.jni.Index
    Add multiple items (vectors) to this Index.
    -
    addItems(Map<String, List<Float>>) - Method in class com.spotify.voyager.jni.StringIndex
    +
    addItems(Map<String, List<Float>>) - Method in class com.spotify.voyager.jni.StringIndex
     
    -

    C

    -
    -
    close() - Method in class com.spotify.voyager.jni.Index
    + + + +

    C

    +
    +
    close() - Method in class com.spotify.voyager.jni.Index
    Close this Index and release any memory held by it.
    -
    close() - Method in class com.spotify.voyager.jni.StringIndex
    +
    close() - Method in class com.spotify.voyager.jni.StringIndex
     
    com.spotify.voyager - package com.spotify.voyager
    @@ -96,341 +143,428 @@

    C

    com.spotify.voyager.jni.utils - package com.spotify.voyager.jni.utils
     
    -
    Cosine - Enum constant in enum com.spotify.voyager.jni.Index.SpaceType
    +
    Cosine - com.spotify.voyager.jni.Index.SpaceType
    Cosine distance; i.e.
    -

    D

    -
    -
    distances - Variable in class com.spotify.voyager.jni.Index.QueryResults
    + + + +

    D

    +
    +
    distances - Variable in class com.spotify.voyager.jni.Index.QueryResults
    A list of distances from each item ID to the query vector for this query.
    -

    E

    -
    -
    E4M3 - Enum constant in enum com.spotify.voyager.jni.Index.StorageDataType
    + + + +

    E

    +
    +
    E4M3 - com.spotify.voyager.jni.Index.StorageDataType
    A custom 8-bit floating point data type with range [-448, 448] and variable precision.
    -
    Euclidean - Enum constant in enum com.spotify.voyager.jni.Index.SpaceType
    +
    Euclidean - com.spotify.voyager.jni.Index.SpaceType
    Euclidean distance, also known as L2 distance.
    -
    extractBinaries(String) - Static method in class com.spotify.voyager.jni.utils.JniLibExtractor
    +
    extractBinaries(String) - Static method in class com.spotify.voyager.jni.utils.JniLibExtractor
     
    -

    F

    -
    -
    finalize() - Method in class com.spotify.voyager.jni.Index
    + + + +

    F

    +
    +
    finalize() - Method in class com.spotify.voyager.jni.Index
     
    -
    Float32 - Enum constant in enum com.spotify.voyager.jni.Index.StorageDataType
    +
    Float32 - com.spotify.voyager.jni.Index.StorageDataType
    A 32-bit floating point ("Float") data type.
    -
    Float8 - Enum constant in enum com.spotify.voyager.jni.Index.StorageDataType
    +
    Float8 - com.spotify.voyager.jni.Index.StorageDataType
    An 8-bit floating point data type that expects all values to be on [-1, 1].
    -

    G

    -
    -
    getDistance(int) - Method in class com.spotify.voyager.jni.StringIndex.QueryResults
    + + + +

    G

    +
    +
    getDistance(int) - Method in class com.spotify.voyager.jni.StringIndex.QueryResults
     
    -
    getDistances() - Method in class com.spotify.voyager.jni.Index.QueryResults
    +
    getDistances() - Method in class com.spotify.voyager.jni.Index.QueryResults
    Retrieve the list of distances between query vectors and item vectors for the results of this query.
    -
    getDistances() - Method in class com.spotify.voyager.jni.StringIndex.QueryResults
    +
    getDistances() - Method in class com.spotify.voyager.jni.StringIndex.QueryResults
     
    -
    getEf() - Method in class com.spotify.voyager.jni.Index
    +
    getEf() - Method in class com.spotify.voyager.jni.Index
    Get the default EF ("query search depth") that will be uses when Index.query(float[], int) is called.
    -
    getEfConstruction() - Method in class com.spotify.voyager.jni.Index
    +
    getEfConstruction() - Method in class com.spotify.voyager.jni.Index
    Get the EF Construction value used when adding new elements to this Index.
    -
    getIDs() - Method in class com.spotify.voyager.jni.Index
    +
    getIDs() - Method in class com.spotify.voyager.jni.Index
    Get the list of identifiers currently stored by this index.
    -
    getLabels() - Method in class com.spotify.voyager.jni.Index.QueryResults
    +
    getLabels() - Method in class com.spotify.voyager.jni.Index.QueryResults
    Retrieve the list of item IDs ("labels") returned by this query.
    -
    getM() - Method in class com.spotify.voyager.jni.Index
    +
    getM() - Method in class com.spotify.voyager.jni.Index
    Get the M value used when adding new elements to this Index.
    -
    getMaxElements() - Method in class com.spotify.voyager.jni.Index
    +
    getMaxElements() - Method in class com.spotify.voyager.jni.Index
    Get the maximum number of elements currently storable by this Index.
    -
    getName(int) - Method in class com.spotify.voyager.jni.StringIndex.QueryResults
    +
    getName(int) - Method in class com.spotify.voyager.jni.StringIndex.QueryResults
     
    -
    getNames() - Method in class com.spotify.voyager.jni.StringIndex.QueryResults
    +
    getNames() - Method in class com.spotify.voyager.jni.StringIndex.QueryResults
     
    -
    getNumDimensions() - Method in class com.spotify.voyager.jni.Index
    +
    getNumDimensions() - Method in class com.spotify.voyager.jni.Index
    Get the number of dimensions used in this Index.
    -
    getNumElements() - Method in class com.spotify.voyager.jni.Index
    +
    getNumElements() - Method in class com.spotify.voyager.jni.Index
    Get the number of elements currently in this Index.
    -
    getNumResults() - Method in class com.spotify.voyager.jni.StringIndex.QueryResults
    +
    getNumResults() - Method in class com.spotify.voyager.jni.StringIndex.QueryResults
     
    -
    getNumThreads() - Method in class com.spotify.voyager.jni.Index
    +
    getNumThreads() - Method in class com.spotify.voyager.jni.Index
    Get the default number of threads used when adding multiple vectors in bulk oor when querying for multiple vectors simultaneously.
    -
    getSpace() - Method in class com.spotify.voyager.jni.Index
    +
    getSpace() - Method in class com.spotify.voyager.jni.Index
    Get the Index.SpaceType that this Index uses to store and compare vectors.
    -
    getVector(long) - Method in class com.spotify.voyager.jni.Index
    +
    getVector(long) - Method in class com.spotify.voyager.jni.Index
    Get the vector for the provided identifier.
    -
    getVectors(long[]) - Method in class com.spotify.voyager.jni.Index
    +
    getVectors(long[]) - Method in class com.spotify.voyager.jni.Index
    Get the vectors for a provided array of identifiers.
    -

    I

    -
    -
    Index - Class in com.spotify.voyager.jni
    + + + +

    I

    +
    +
    Index - Class in com.spotify.voyager.jni
    A Voyager index, providing storage of floating-point vectors and the ability to efficiently search among those vectors.
    -
    Index(Index.SpaceType, int) - Constructor for class com.spotify.voyager.jni.Index
    +
    Index(Index.SpaceType, int) - Constructor for class com.spotify.voyager.jni.Index
    Create a new Index that uses the given Index.SpaceType to store and compare numDimensions-dimensional vectors.
    -
    Index(Index.SpaceType, int, long, long, long, long, Index.StorageDataType) - Constructor for class com.spotify.voyager.jni.Index
    +
    Index(Index.SpaceType, int, long, long, long, long, Index.StorageDataType) - Constructor for class com.spotify.voyager.jni.Index
    Create a new Index that uses the given Index.SpaceType to store and compare numDimensions-dimensional vectors.
    -
    Index.QueryResults - Class in com.spotify.voyager.jni
    +
    Index.QueryResults - Class in com.spotify.voyager.jni
    A container for query results, returned by Index.
    -
    Index.SpaceType - Enum in com.spotify.voyager.jni
    +
    Index.SpaceType - Enum in com.spotify.voyager.jni
    The space, also known as distance metric, to use when searching.
    -
    Index.StorageDataType - Enum in com.spotify.voyager.jni
    +
    Index.StorageDataType - Enum in com.spotify.voyager.jni
    The datatype used to use when storing vectors on disk.
    -
    InnerProduct - Enum constant in enum com.spotify.voyager.jni.Index.SpaceType
    +
    InnerProduct - com.spotify.voyager.jni.Index.SpaceType
    Inner (dot) product.
    -

    J

    -
    -
    JniLibExtractor - Class in com.spotify.voyager.jni.utils
    + + + +

    J

    +
    +
    JniLibExtractor - Class in com.spotify.voyager.jni.utils
     
    -
    JniLibExtractor() - Constructor for class com.spotify.voyager.jni.utils.JniLibExtractor
    +
    JniLibExtractor() - Constructor for class com.spotify.voyager.jni.utils.JniLibExtractor
     
    -

    L

    -
    -
    labels - Variable in class com.spotify.voyager.jni.Index.QueryResults
    + + + +

    L

    +
    +
    labels - Variable in class com.spotify.voyager.jni.Index.QueryResults
    A list of item IDs ("labels").
    -
    load(InputStream) - Static method in class com.spotify.voyager.jni.Index
    +
    load(InputStream) - Static method in class com.spotify.voyager.jni.Index
    Interpret the contents of a java.io.InputStream as the contents of a Voyager index file and create a new Index initialized with the data provided by that stream.
    -
    load(InputStream, Index.SpaceType, int, Index.StorageDataType) - Static method in class com.spotify.voyager.jni.Index
    +
    load(InputStream, Index.SpaceType, int, Index.StorageDataType) - Static method in class com.spotify.voyager.jni.Index
    Interpret the contents of a java.io.InputStream as the contents of a Voyager index file and create a new Index initialized with the data provided by that stream.
    -
    load(InputStream, InputStream) - Static method in class com.spotify.voyager.jni.StringIndex
    +
    load(InputStream, InputStream) - Static method in class com.spotify.voyager.jni.StringIndex
    Load a previously constructed index from the provided input stream.
    -
    load(InputStream, InputStream, Index.SpaceType, int, Index.StorageDataType) - Static method in class com.spotify.voyager.jni.StringIndex
    +
    load(InputStream, InputStream, Index.SpaceType, int, Index.StorageDataType) - Static method in class com.spotify.voyager.jni.StringIndex
    Load a previously constructed index from the provided input streams.
    -
    load(String) - Static method in class com.spotify.voyager.jni.Index
    +
    load(String) - Static method in class com.spotify.voyager.jni.Index
    Load a Voyager index file and create a new Index initialized with the data in that file.
    -
    load(String, Index.SpaceType, int, Index.StorageDataType) - Static method in class com.spotify.voyager.jni.Index
    +
    load(String, Index.SpaceType, int, Index.StorageDataType) - Static method in class com.spotify.voyager.jni.Index
    Load a Voyager index file and create a new Index initialized with the data in that file.
    -
    load(String, String) - Static method in class com.spotify.voyager.jni.StringIndex
    +
    load(String, String) - Static method in class com.spotify.voyager.jni.StringIndex
    Load a previously constructed index from the provided file location.
    -
    load(String, String, Index.SpaceType, int, Index.StorageDataType) - Static method in class com.spotify.voyager.jni.StringIndex
    +
    load(String, String, Index.SpaceType, int, Index.StorageDataType) - Static method in class com.spotify.voyager.jni.StringIndex
    Load a previously constructed index from the provided file location.
    -

    M

    -
    -
    markDeleted(long) - Method in class com.spotify.voyager.jni.Index
    + + + +

    M

    +
    +
    markDeleted(long) - Method in class com.spotify.voyager.jni.Index
    Mark an element of the index as deleted.
    -

    Q

    -
    -
    query(float[][], int, int) - Method in class com.spotify.voyager.jni.Index
    + + + +

    Q

    +
    +
    query(float[][], int, int) - Method in class com.spotify.voyager.jni.Index
    Query this Index for approximate nearest neighbors of multiple query vectors.
    -
    query(float[][], int, int, long) - Method in class com.spotify.voyager.jni.Index
    +
    query(float[][], int, int, long) - Method in class com.spotify.voyager.jni.Index
    Query this Index for approximate nearest neighbors of multiple query vectors.
    -
    query(float[], int) - Method in class com.spotify.voyager.jni.Index
    +
    query(float[], int) - Method in class com.spotify.voyager.jni.Index
    Query this Index for approximate nearest neighbors of a single query vector.
    -
    query(float[], int, int) - Method in class com.spotify.voyager.jni.StringIndex
    +
    query(float[], int, int) - Method in class com.spotify.voyager.jni.StringIndex
    Find the nearest neighbors of the provided embedding.
    -
    query(float[], int, long) - Method in class com.spotify.voyager.jni.Index
    +
    query(float[], int, long) - Method in class com.spotify.voyager.jni.Index
    Query this Index for approximate nearest neighbors of a single query vector.
    -
    QueryResults(long[], float[]) - Constructor for class com.spotify.voyager.jni.Index.QueryResults
    +
    QueryResults(long[], float[]) - Constructor for class com.spotify.voyager.jni.Index.QueryResults
    Instantiates a new QueryResults object, provided two identical-length arrays of labels and their corresponding distances.
    -
    QueryResults(String[], float[]) - Constructor for class com.spotify.voyager.jni.StringIndex.QueryResults
    +
    QueryResults(String[], float[]) - Constructor for class com.spotify.voyager.jni.StringIndex.QueryResults
     
    -

    R

    -
    -
    readStringList(InputStream) - Static method in class com.spotify.voyager.jni.utils.TinyJson
    + + + +

    R

    +
    +
    readStringList(InputStream) - Static method in class com.spotify.voyager.jni.utils.TinyJson
     
    -
    resizeIndex(long) - Method in class com.spotify.voyager.jni.Index
    +
    resizeIndex(long) - Method in class com.spotify.voyager.jni.Index
    Change the maximum number of elements currently storable by this Index.
    -

    S

    -
    -
    saveIndex(OutputStream) - Method in class com.spotify.voyager.jni.Index
    + + + +

    S

    +
    +
    saveIndex(OutputStream) - Method in class com.spotify.voyager.jni.Index
    Save this Index to the provided output stream.
    -
    saveIndex(OutputStream, OutputStream) - Method in class com.spotify.voyager.jni.StringIndex
    +
    saveIndex(OutputStream, OutputStream) - Method in class com.spotify.voyager.jni.StringIndex
    Save the underlying HNSW index and JSON encoded names list to the provided output streams
    -
    saveIndex(String) - Method in class com.spotify.voyager.jni.Index
    +
    saveIndex(String) - Method in class com.spotify.voyager.jni.Index
    Save this Index to a file at the provided filename.
    -
    saveIndex(String) - Method in class com.spotify.voyager.jni.StringIndex
    +
    saveIndex(String) - Method in class com.spotify.voyager.jni.StringIndex
    Save the underlying index and JSON encoded name list to the provided output directory
    -
    saveIndex(String, String, String) - Method in class com.spotify.voyager.jni.StringIndex
    +
    saveIndex(String, String, String) - Method in class com.spotify.voyager.jni.StringIndex
     
    -
    setEf(long) - Method in class com.spotify.voyager.jni.Index
    +
    setEf(long) - Method in class com.spotify.voyager.jni.Index
    Set the default EF ("query search depth") to use when Index.query(float[], int) is called.
    -
    setNumThreads(int) - Method in class com.spotify.voyager.jni.Index
    +
    setNumThreads(int) - Method in class com.spotify.voyager.jni.Index
    Set the default number of threads to use when adding multiple vectors in bulk, or when querying for multiple vectors simultaneously.
    -
    StringIndex - Class in com.spotify.voyager.jni
    +
    StringIndex - Class in com.spotify.voyager.jni
    Wrapper around com.spotify.voyager.jni.Index with a simplified interface which maps the index ID to a provided String.
    -
    StringIndex(Index.SpaceType, int) - Constructor for class com.spotify.voyager.jni.StringIndex
    +
    StringIndex(Index.SpaceType, int) - Constructor for class com.spotify.voyager.jni.StringIndex
    Instantiate a new empty index with the specified space type and dimensionality
    -
    StringIndex(Index.SpaceType, int, long, long, long, long, Index.StorageDataType) - Constructor for class com.spotify.voyager.jni.StringIndex
    +
    StringIndex(Index.SpaceType, int, long, long, long, long, Index.StorageDataType) - Constructor for class com.spotify.voyager.jni.StringIndex
    Instantiate an empty index with the specified index parameters
    -
    StringIndex.QueryResults - Class in com.spotify.voyager.jni
    +
    StringIndex.QueryResults - Class in com.spotify.voyager.jni
    A wrapper class for nearest neighbor query results.
    -

    T

    -
    -
    TinyJson - Class in com.spotify.voyager.jni.utils
    + + + +

    T

    +
    +
    TinyJson - Class in com.spotify.voyager.jni.utils
    A dependency-free, super tiny JSON serde class that only supports reading and writing lists of strings.
    -
    TinyJson() - Constructor for class com.spotify.voyager.jni.utils.TinyJson
    +
    TinyJson() - Constructor for class com.spotify.voyager.jni.utils.TinyJson
     
    -
    toString() - Method in class com.spotify.voyager.jni.Index.QueryResults
    +
    toString() - Method in class com.spotify.voyager.jni.Index.QueryResults
     
    -
    toString() - Method in class com.spotify.voyager.jni.StringIndex.QueryResults
    +
    toString() - Method in class com.spotify.voyager.jni.StringIndex.QueryResults
     
    -

    U

    -
    -
    unmarkDeleted(long) - Method in class com.spotify.voyager.jni.Index
    + + + +

    U

    +
    +
    unmarkDeleted(long) - Method in class com.spotify.voyager.jni.Index
    Un-mark an element of the index as deleted, making it available again.
    -

    V

    -
    -
    valueOf(String) - Static method in enum com.spotify.voyager.jni.Index.SpaceType
    + + + +

    V

    +
    +
    valueOf(String) - Static method in enum com.spotify.voyager.jni.Index.SpaceType
    Returns the enum constant of this type with the specified name.
    -
    valueOf(String) - Static method in enum com.spotify.voyager.jni.Index.StorageDataType
    +
    valueOf(String) - Static method in enum com.spotify.voyager.jni.Index.StorageDataType
    Returns the enum constant of this type with the specified name.
    -
    values() - Static method in enum com.spotify.voyager.jni.Index.SpaceType
    +
    values() - Static method in enum com.spotify.voyager.jni.Index.SpaceType
    Returns an array containing the constants of this enum type, in the order they are declared.
    -
    values() - Static method in enum com.spotify.voyager.jni.Index.StorageDataType
    +
    values() - Static method in enum com.spotify.voyager.jni.Index.StorageDataType
    Returns an array containing the constants of this enum type, in the order they are declared.
    -

    W

    -
    -
    writeStringList(Iterable<String>, OutputStream) - Static method in class com.spotify.voyager.jni.utils.TinyJson
    + + + +

    W

    +
    +
    writeStringList(Iterable<String>, OutputStream) - Static method in class com.spotify.voyager.jni.utils.TinyJson
     
    -A C D E F G I J L M Q R S T U V W 
    All Classes and Interfaces|All Packages
    +A C D E F G I J L M Q R S T U V W 
    All Classes All Packages
    +
    -
    -

    Copyright © 2023. All rights reserved.

    -
    + +

    Copyright © 2023. All rights reserved.

    + diff --git a/docs/java/index.html b/docs/java/index.html index 82acbf19..cd21a37f 100644 --- a/docs/java/index.html +++ b/docs/java/index.html @@ -1,80 +1,176 @@ + - -Overview (voyager 2.0.1 API) - + +Overview (voyager 2.0.2 API) - - - - + - - + + + + + - - -
    -
    +
     
    + + -
    -
    -

    voyager 2.0.1 API

    +

    voyager 2.0.2 API

    -
    -
    Packages
    -
    -
    Package
    -
    Description
    -
    com.spotify.voyager
    -
    +
    +
    + + + + + + + + + + + + + + + + + + + + +
    Packages 
    PackageDescription
    com.spotify.voyager
    Voyager is a Java and Python library that provides approximate nearest-neighbor search of vector data.
    - -
    com.spotify.voyager.jni
    -
    +
    com.spotify.voyager.jni
    Java Native Interface (JNI) bindings to expose functionality from Voyager's C++ code into Java.
    - -
    com.spotify.voyager.jni.utils
    -
     
    - +
    com.spotify.voyager.jni.utils 
    -
    -

    Copyright © 2023. All rights reserved.

    -
    + +

    Copyright © 2023. All rights reserved.

    + diff --git a/docs/java/member-search-index.js b/docs/java/member-search-index.js index 2499c325..5240a750 100644 --- a/docs/java/member-search-index.js +++ b/docs/java/member-search-index.js @@ -1 +1 @@ -memberSearchIndex = [{"p":"com.spotify.voyager.jni","c":"Index","l":"addItem(float[])"},{"p":"com.spotify.voyager.jni","c":"Index","l":"addItem(float[], long)","u":"addItem(float[],long)"},{"p":"com.spotify.voyager.jni","c":"StringIndex","l":"addItem(String, float[])","u":"addItem(java.lang.String,float[])"},{"p":"com.spotify.voyager.jni","c":"StringIndex","l":"addItem(String, List)","u":"addItem(java.lang.String,java.util.List)"},{"p":"com.spotify.voyager.jni","c":"Index","l":"addItems(float[][], int)","u":"addItems(float[][],int)"},{"p":"com.spotify.voyager.jni","c":"Index","l":"addItems(float[][], long[], int)","u":"addItems(float[][],long[],int)"},{"p":"com.spotify.voyager.jni","c":"StringIndex","l":"addItems(Map>)","u":"addItems(java.util.Map)"},{"p":"com.spotify.voyager.jni","c":"Index","l":"close()"},{"p":"com.spotify.voyager.jni","c":"StringIndex","l":"close()"},{"p":"com.spotify.voyager.jni","c":"Index.SpaceType","l":"Cosine"},{"p":"com.spotify.voyager.jni","c":"Index.QueryResults","l":"distances"},{"p":"com.spotify.voyager.jni","c":"Index.StorageDataType","l":"E4M3"},{"p":"com.spotify.voyager.jni","c":"Index.SpaceType","l":"Euclidean"},{"p":"com.spotify.voyager.jni.utils","c":"JniLibExtractor","l":"extractBinaries(String)","u":"extractBinaries(java.lang.String)"},{"p":"com.spotify.voyager.jni","c":"Index","l":"finalize()"},{"p":"com.spotify.voyager.jni","c":"Index.StorageDataType","l":"Float32"},{"p":"com.spotify.voyager.jni","c":"Index.StorageDataType","l":"Float8"},{"p":"com.spotify.voyager.jni","c":"StringIndex.QueryResults","l":"getDistance(int)"},{"p":"com.spotify.voyager.jni","c":"Index.QueryResults","l":"getDistances()"},{"p":"com.spotify.voyager.jni","c":"StringIndex.QueryResults","l":"getDistances()"},{"p":"com.spotify.voyager.jni","c":"Index","l":"getEf()"},{"p":"com.spotify.voyager.jni","c":"Index","l":"getEfConstruction()"},{"p":"com.spotify.voyager.jni","c":"Index","l":"getIDs()"},{"p":"com.spotify.voyager.jni","c":"Index.QueryResults","l":"getLabels()"},{"p":"com.spotify.voyager.jni","c":"Index","l":"getM()"},{"p":"com.spotify.voyager.jni","c":"Index","l":"getMaxElements()"},{"p":"com.spotify.voyager.jni","c":"StringIndex.QueryResults","l":"getName(int)"},{"p":"com.spotify.voyager.jni","c":"StringIndex.QueryResults","l":"getNames()"},{"p":"com.spotify.voyager.jni","c":"Index","l":"getNumDimensions()"},{"p":"com.spotify.voyager.jni","c":"Index","l":"getNumElements()"},{"p":"com.spotify.voyager.jni","c":"StringIndex.QueryResults","l":"getNumResults()"},{"p":"com.spotify.voyager.jni","c":"Index","l":"getNumThreads()"},{"p":"com.spotify.voyager.jni","c":"Index","l":"getSpace()"},{"p":"com.spotify.voyager.jni","c":"Index","l":"getVector(long)"},{"p":"com.spotify.voyager.jni","c":"Index","l":"getVectors(long[])"},{"p":"com.spotify.voyager.jni","c":"Index","l":"Index(Index.SpaceType, int)","u":"%3Cinit%3E(com.spotify.voyager.jni.Index.SpaceType,int)"},{"p":"com.spotify.voyager.jni","c":"Index","l":"Index(Index.SpaceType, int, long, long, long, long, Index.StorageDataType)","u":"%3Cinit%3E(com.spotify.voyager.jni.Index.SpaceType,int,long,long,long,long,com.spotify.voyager.jni.Index.StorageDataType)"},{"p":"com.spotify.voyager.jni","c":"Index.SpaceType","l":"InnerProduct"},{"p":"com.spotify.voyager.jni.utils","c":"JniLibExtractor","l":"JniLibExtractor()","u":"%3Cinit%3E()"},{"p":"com.spotify.voyager.jni","c":"Index.QueryResults","l":"labels"},{"p":"com.spotify.voyager.jni","c":"Index","l":"load(InputStream)","u":"load(java.io.InputStream)"},{"p":"com.spotify.voyager.jni","c":"Index","l":"load(InputStream, Index.SpaceType, int, Index.StorageDataType)","u":"load(java.io.InputStream,com.spotify.voyager.jni.Index.SpaceType,int,com.spotify.voyager.jni.Index.StorageDataType)"},{"p":"com.spotify.voyager.jni","c":"StringIndex","l":"load(InputStream, InputStream)","u":"load(java.io.InputStream,java.io.InputStream)"},{"p":"com.spotify.voyager.jni","c":"StringIndex","l":"load(InputStream, InputStream, Index.SpaceType, int, Index.StorageDataType)","u":"load(java.io.InputStream,java.io.InputStream,com.spotify.voyager.jni.Index.SpaceType,int,com.spotify.voyager.jni.Index.StorageDataType)"},{"p":"com.spotify.voyager.jni","c":"Index","l":"load(String)","u":"load(java.lang.String)"},{"p":"com.spotify.voyager.jni","c":"Index","l":"load(String, Index.SpaceType, int, Index.StorageDataType)","u":"load(java.lang.String,com.spotify.voyager.jni.Index.SpaceType,int,com.spotify.voyager.jni.Index.StorageDataType)"},{"p":"com.spotify.voyager.jni","c":"StringIndex","l":"load(String, String)","u":"load(java.lang.String,java.lang.String)"},{"p":"com.spotify.voyager.jni","c":"StringIndex","l":"load(String, String, Index.SpaceType, int, Index.StorageDataType)","u":"load(java.lang.String,java.lang.String,com.spotify.voyager.jni.Index.SpaceType,int,com.spotify.voyager.jni.Index.StorageDataType)"},{"p":"com.spotify.voyager.jni","c":"Index","l":"markDeleted(long)"},{"p":"com.spotify.voyager.jni","c":"Index","l":"query(float[], int)","u":"query(float[],int)"},{"p":"com.spotify.voyager.jni","c":"StringIndex","l":"query(float[], int, int)","u":"query(float[],int,int)"},{"p":"com.spotify.voyager.jni","c":"Index","l":"query(float[], int, long)","u":"query(float[],int,long)"},{"p":"com.spotify.voyager.jni","c":"Index","l":"query(float[][], int, int)","u":"query(float[][],int,int)"},{"p":"com.spotify.voyager.jni","c":"Index","l":"query(float[][], int, int, long)","u":"query(float[][],int,int,long)"},{"p":"com.spotify.voyager.jni","c":"Index.QueryResults","l":"QueryResults(long[], float[])","u":"%3Cinit%3E(long[],float[])"},{"p":"com.spotify.voyager.jni","c":"StringIndex.QueryResults","l":"QueryResults(String[], float[])","u":"%3Cinit%3E(java.lang.String[],float[])"},{"p":"com.spotify.voyager.jni.utils","c":"TinyJson","l":"readStringList(InputStream)","u":"readStringList(java.io.InputStream)"},{"p":"com.spotify.voyager.jni","c":"Index","l":"resizeIndex(long)"},{"p":"com.spotify.voyager.jni","c":"Index","l":"saveIndex(OutputStream)","u":"saveIndex(java.io.OutputStream)"},{"p":"com.spotify.voyager.jni","c":"StringIndex","l":"saveIndex(OutputStream, OutputStream)","u":"saveIndex(java.io.OutputStream,java.io.OutputStream)"},{"p":"com.spotify.voyager.jni","c":"Index","l":"saveIndex(String)","u":"saveIndex(java.lang.String)"},{"p":"com.spotify.voyager.jni","c":"StringIndex","l":"saveIndex(String)","u":"saveIndex(java.lang.String)"},{"p":"com.spotify.voyager.jni","c":"StringIndex","l":"saveIndex(String, String, String)","u":"saveIndex(java.lang.String,java.lang.String,java.lang.String)"},{"p":"com.spotify.voyager.jni","c":"Index","l":"setEf(long)"},{"p":"com.spotify.voyager.jni","c":"Index","l":"setNumThreads(int)"},{"p":"com.spotify.voyager.jni","c":"StringIndex","l":"StringIndex(Index.SpaceType, int)","u":"%3Cinit%3E(com.spotify.voyager.jni.Index.SpaceType,int)"},{"p":"com.spotify.voyager.jni","c":"StringIndex","l":"StringIndex(Index.SpaceType, int, long, long, long, long, Index.StorageDataType)","u":"%3Cinit%3E(com.spotify.voyager.jni.Index.SpaceType,int,long,long,long,long,com.spotify.voyager.jni.Index.StorageDataType)"},{"p":"com.spotify.voyager.jni.utils","c":"TinyJson","l":"TinyJson()","u":"%3Cinit%3E()"},{"p":"com.spotify.voyager.jni","c":"Index.QueryResults","l":"toString()"},{"p":"com.spotify.voyager.jni","c":"StringIndex.QueryResults","l":"toString()"},{"p":"com.spotify.voyager.jni","c":"Index","l":"unmarkDeleted(long)"},{"p":"com.spotify.voyager.jni","c":"Index.SpaceType","l":"valueOf(String)","u":"valueOf(java.lang.String)"},{"p":"com.spotify.voyager.jni","c":"Index.StorageDataType","l":"valueOf(String)","u":"valueOf(java.lang.String)"},{"p":"com.spotify.voyager.jni","c":"Index.SpaceType","l":"values()"},{"p":"com.spotify.voyager.jni","c":"Index.StorageDataType","l":"values()"},{"p":"com.spotify.voyager.jni.utils","c":"TinyJson","l":"writeStringList(Iterable, OutputStream)","u":"writeStringList(java.lang.Iterable,java.io.OutputStream)"}];updateSearchResults(); \ No newline at end of file +memberSearchIndex = [{"p":"com.spotify.voyager.jni","c":"Index","l":"addItem(float[], long)","url":"addItem(float[],long)"},{"p":"com.spotify.voyager.jni","c":"Index","l":"addItem(float[])"},{"p":"com.spotify.voyager.jni","c":"StringIndex","l":"addItem(String, float[])","url":"addItem(java.lang.String,float[])"},{"p":"com.spotify.voyager.jni","c":"StringIndex","l":"addItem(String, List)","url":"addItem(java.lang.String,java.util.List)"},{"p":"com.spotify.voyager.jni","c":"Index","l":"addItems(float[][], int)","url":"addItems(float[][],int)"},{"p":"com.spotify.voyager.jni","c":"Index","l":"addItems(float[][], long[], int)","url":"addItems(float[][],long[],int)"},{"p":"com.spotify.voyager.jni","c":"StringIndex","l":"addItems(Map>)","url":"addItems(java.util.Map)"},{"p":"com.spotify.voyager.jni","c":"Index","l":"close()"},{"p":"com.spotify.voyager.jni","c":"StringIndex","l":"close()"},{"p":"com.spotify.voyager.jni","c":"Index.SpaceType","l":"Cosine"},{"p":"com.spotify.voyager.jni","c":"Index.QueryResults","l":"distances"},{"p":"com.spotify.voyager.jni","c":"Index.StorageDataType","l":"E4M3"},{"p":"com.spotify.voyager.jni","c":"Index.SpaceType","l":"Euclidean"},{"p":"com.spotify.voyager.jni.utils","c":"JniLibExtractor","l":"extractBinaries(String)","url":"extractBinaries(java.lang.String)"},{"p":"com.spotify.voyager.jni","c":"Index","l":"finalize()"},{"p":"com.spotify.voyager.jni","c":"Index.StorageDataType","l":"Float32"},{"p":"com.spotify.voyager.jni","c":"Index.StorageDataType","l":"Float8"},{"p":"com.spotify.voyager.jni","c":"StringIndex.QueryResults","l":"getDistance(int)"},{"p":"com.spotify.voyager.jni","c":"Index.QueryResults","l":"getDistances()"},{"p":"com.spotify.voyager.jni","c":"StringIndex.QueryResults","l":"getDistances()"},{"p":"com.spotify.voyager.jni","c":"Index","l":"getEf()"},{"p":"com.spotify.voyager.jni","c":"Index","l":"getEfConstruction()"},{"p":"com.spotify.voyager.jni","c":"Index","l":"getIDs()"},{"p":"com.spotify.voyager.jni","c":"Index.QueryResults","l":"getLabels()"},{"p":"com.spotify.voyager.jni","c":"Index","l":"getM()"},{"p":"com.spotify.voyager.jni","c":"Index","l":"getMaxElements()"},{"p":"com.spotify.voyager.jni","c":"StringIndex.QueryResults","l":"getName(int)"},{"p":"com.spotify.voyager.jni","c":"StringIndex.QueryResults","l":"getNames()"},{"p":"com.spotify.voyager.jni","c":"Index","l":"getNumDimensions()"},{"p":"com.spotify.voyager.jni","c":"Index","l":"getNumElements()"},{"p":"com.spotify.voyager.jni","c":"StringIndex.QueryResults","l":"getNumResults()"},{"p":"com.spotify.voyager.jni","c":"Index","l":"getNumThreads()"},{"p":"com.spotify.voyager.jni","c":"Index","l":"getSpace()"},{"p":"com.spotify.voyager.jni","c":"Index","l":"getVector(long)"},{"p":"com.spotify.voyager.jni","c":"Index","l":"getVectors(long[])"},{"p":"com.spotify.voyager.jni","c":"Index","l":"Index(Index.SpaceType, int, long, long, long, long, Index.StorageDataType)","url":"%3Cinit%3E(com.spotify.voyager.jni.Index.SpaceType,int,long,long,long,long,com.spotify.voyager.jni.Index.StorageDataType)"},{"p":"com.spotify.voyager.jni","c":"Index","l":"Index(Index.SpaceType, int)","url":"%3Cinit%3E(com.spotify.voyager.jni.Index.SpaceType,int)"},{"p":"com.spotify.voyager.jni","c":"Index.SpaceType","l":"InnerProduct"},{"p":"com.spotify.voyager.jni.utils","c":"JniLibExtractor","l":"JniLibExtractor()","url":"%3Cinit%3E()"},{"p":"com.spotify.voyager.jni","c":"Index.QueryResults","l":"labels"},{"p":"com.spotify.voyager.jni","c":"Index","l":"load(InputStream, Index.SpaceType, int, Index.StorageDataType)","url":"load(java.io.InputStream,com.spotify.voyager.jni.Index.SpaceType,int,com.spotify.voyager.jni.Index.StorageDataType)"},{"p":"com.spotify.voyager.jni","c":"StringIndex","l":"load(InputStream, InputStream, Index.SpaceType, int, Index.StorageDataType)","url":"load(java.io.InputStream,java.io.InputStream,com.spotify.voyager.jni.Index.SpaceType,int,com.spotify.voyager.jni.Index.StorageDataType)"},{"p":"com.spotify.voyager.jni","c":"StringIndex","l":"load(InputStream, InputStream)","url":"load(java.io.InputStream,java.io.InputStream)"},{"p":"com.spotify.voyager.jni","c":"Index","l":"load(InputStream)","url":"load(java.io.InputStream)"},{"p":"com.spotify.voyager.jni","c":"Index","l":"load(String, Index.SpaceType, int, Index.StorageDataType)","url":"load(java.lang.String,com.spotify.voyager.jni.Index.SpaceType,int,com.spotify.voyager.jni.Index.StorageDataType)"},{"p":"com.spotify.voyager.jni","c":"StringIndex","l":"load(String, String, Index.SpaceType, int, Index.StorageDataType)","url":"load(java.lang.String,java.lang.String,com.spotify.voyager.jni.Index.SpaceType,int,com.spotify.voyager.jni.Index.StorageDataType)"},{"p":"com.spotify.voyager.jni","c":"StringIndex","l":"load(String, String)","url":"load(java.lang.String,java.lang.String)"},{"p":"com.spotify.voyager.jni","c":"Index","l":"load(String)","url":"load(java.lang.String)"},{"p":"com.spotify.voyager.jni","c":"Index","l":"markDeleted(long)"},{"p":"com.spotify.voyager.jni","c":"StringIndex","l":"query(float[], int, int)","url":"query(float[],int,int)"},{"p":"com.spotify.voyager.jni","c":"Index","l":"query(float[], int, long)","url":"query(float[],int,long)"},{"p":"com.spotify.voyager.jni","c":"Index","l":"query(float[], int)","url":"query(float[],int)"},{"p":"com.spotify.voyager.jni","c":"Index","l":"query(float[][], int, int, long)","url":"query(float[][],int,int,long)"},{"p":"com.spotify.voyager.jni","c":"Index","l":"query(float[][], int, int)","url":"query(float[][],int,int)"},{"p":"com.spotify.voyager.jni","c":"Index.QueryResults","l":"QueryResults(long[], float[])","url":"%3Cinit%3E(long[],float[])"},{"p":"com.spotify.voyager.jni","c":"StringIndex.QueryResults","l":"QueryResults(String[], float[])","url":"%3Cinit%3E(java.lang.String[],float[])"},{"p":"com.spotify.voyager.jni.utils","c":"TinyJson","l":"readStringList(InputStream)","url":"readStringList(java.io.InputStream)"},{"p":"com.spotify.voyager.jni","c":"Index","l":"resizeIndex(long)"},{"p":"com.spotify.voyager.jni","c":"StringIndex","l":"saveIndex(OutputStream, OutputStream)","url":"saveIndex(java.io.OutputStream,java.io.OutputStream)"},{"p":"com.spotify.voyager.jni","c":"Index","l":"saveIndex(OutputStream)","url":"saveIndex(java.io.OutputStream)"},{"p":"com.spotify.voyager.jni","c":"StringIndex","l":"saveIndex(String, String, String)","url":"saveIndex(java.lang.String,java.lang.String,java.lang.String)"},{"p":"com.spotify.voyager.jni","c":"Index","l":"saveIndex(String)","url":"saveIndex(java.lang.String)"},{"p":"com.spotify.voyager.jni","c":"StringIndex","l":"saveIndex(String)","url":"saveIndex(java.lang.String)"},{"p":"com.spotify.voyager.jni","c":"Index","l":"setEf(long)"},{"p":"com.spotify.voyager.jni","c":"Index","l":"setNumThreads(int)"},{"p":"com.spotify.voyager.jni","c":"StringIndex","l":"StringIndex(Index.SpaceType, int, long, long, long, long, Index.StorageDataType)","url":"%3Cinit%3E(com.spotify.voyager.jni.Index.SpaceType,int,long,long,long,long,com.spotify.voyager.jni.Index.StorageDataType)"},{"p":"com.spotify.voyager.jni","c":"StringIndex","l":"StringIndex(Index.SpaceType, int)","url":"%3Cinit%3E(com.spotify.voyager.jni.Index.SpaceType,int)"},{"p":"com.spotify.voyager.jni.utils","c":"TinyJson","l":"TinyJson()","url":"%3Cinit%3E()"},{"p":"com.spotify.voyager.jni","c":"Index.QueryResults","l":"toString()"},{"p":"com.spotify.voyager.jni","c":"StringIndex.QueryResults","l":"toString()"},{"p":"com.spotify.voyager.jni","c":"Index","l":"unmarkDeleted(long)"},{"p":"com.spotify.voyager.jni","c":"Index.SpaceType","l":"valueOf(String)","url":"valueOf(java.lang.String)"},{"p":"com.spotify.voyager.jni","c":"Index.StorageDataType","l":"valueOf(String)","url":"valueOf(java.lang.String)"},{"p":"com.spotify.voyager.jni","c":"Index.SpaceType","l":"values()"},{"p":"com.spotify.voyager.jni","c":"Index.StorageDataType","l":"values()"},{"p":"com.spotify.voyager.jni.utils","c":"TinyJson","l":"writeStringList(Iterable, OutputStream)","url":"writeStringList(java.lang.Iterable,java.io.OutputStream)"}] \ No newline at end of file diff --git a/docs/java/member-search-index.zip b/docs/java/member-search-index.zip index 4a22145a..d602f158 100644 Binary files a/docs/java/member-search-index.zip and b/docs/java/member-search-index.zip differ diff --git a/docs/java/overview-summary.html b/docs/java/overview-summary.html index c3b883c7..83de49a6 100644 --- a/docs/java/overview-summary.html +++ b/docs/java/overview-summary.html @@ -1,21 +1,18 @@ + - -voyager 2.0.1 API - + +voyager 2.0.2 API - - - - - + + - +