Packages

trait ElastiknnRequests extends AnyRef

Methods for creating Elastic4s requests for common elastiknn tasks. Methods are optimized for documents containing only a vector and running searches as quickly as possible. For example, we store the ID as a doc value instead of using the default stored ID which is slower to access. I am open to creating less-optimized, more-convenient methods in the future.

Linear Supertypes
AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ElastiknnRequests
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  10. def index(index: String, vecField: String, vec: Vec, storedIdField: String, id: String): IndexRequest

    Create a request for indexing a vector.

    Create a request for indexing a vector.

    index

    Name of the index.

    vecField

    Field where vector is stored.

    vec

    Vector to index.

    storedIdField

    Field where document ID is stored.

    id

    Document ID. Stored as the ID known by Elasticsearch, and in the document for faster retrieval.

    returns

    Instance of a com.sksamuel.elastic4s.requests.indexes.IndexRequest.

  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def nearestNeighbors(index: String, query: NearestNeighborsQuery, k: Int, storedIdField: String): SearchRequest

    Create a request for running a nearest neighbors query.

    Create a request for running a nearest neighbors query. Optimized for high performance, so it returns the document ID in the body. Sets the preference parameter (see: https://www.elastic.co/guide/en/elasticsearch/reference/master/consistent-scoring.html) as the hash of the query for more deterministic results.

    index

    Index being searched against.

    query

    Constructed query, containing the vector, field, etc.

    k

    Number of results to return.

    storedIdField

    Field containing the document ID. See ElastiknnRequests.index() method.

    returns

    Instance of com.sksamuel.elastic4s.requests.searches.SearchRequest.

  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. def putMapping(index: String, vecField: String, storedIdField: String, vecMapping: Mapping): PutMappingRequest

    Create a mapping containing a vector field and a stored ID field.

    Create a mapping containing a vector field and a stored ID field.

    index

    Index to which this mapping is applied.

    vecField

    Field where vector is stored.

    storedIdField

    Field where ID is stored.

    vecMapping

    Mapping for the stored vector.

    returns

    Instance of com.sksamuel.elastic4s.requests.mappings.PutMappingRequest.

  17. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  18. def toString(): String
    Definition Classes
    AnyRef → Any
  19. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  21. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from AnyRef

Inherited from Any

Ungrouped