final case class VoyagerUri(value: URI, indexFile: String = VoyagerUri.IndexFile, namesFile: String = VoyagerUri.NamesFile) extends Product with Serializable
Represents the base URI for a voyager index, either on a local or a remote file system. For
remote file systems, the path should be in the form 'scheme://<bucket>/<path>/'. For local
files, it should be in the form '/<path>/'. The uri specified represents the directory where
the index and names files are.
- value
The base URI of the directory containing the index files.
- indexFile
The filename of the HNSW index file. Defaults to
index.hnsw.- namesFile
The filename of the names JSON file. Defaults to
names.json.
- Source
- Voyager.scala
Linear Supertypes
Ordering
- Alphabetic
- By Inheritance
Inherited
- VoyagerUri
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
Visibility
- Public
- Protected
Instance Constructors
- new VoyagerUri(value: URI, indexFile: String = VoyagerUri.IndexFile, namesFile: String = VoyagerUri.NamesFile)
- value
The base URI of the directory containing the index files.
- indexFile
The filename of the HNSW index file. Defaults to
index.hnsw.- namesFile
The filename of the names JSON file. Defaults to
names.json.
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def exists(implicit remoteFileUtil: RemoteFileUtil): Boolean
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- val indexFile: String
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val namesFile: String
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val value: URI
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()