Package co.elastic.clients.elasticsearch._types

Class KnnQuery.Builder

java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<KnnQuery.Builder>
co.elastic.clients.elasticsearch._types.KnnQuery.Builder
All Implemented Interfaces:
WithJson<KnnQuery.Builder>, ObjectBuilder<KnnQuery>
Enclosing class:
KnnQuery
public static class KnnQuery.Builder
extends WithJsonObjectBuilderBase<KnnQuery.Builder>
implements ObjectBuilder<KnnQuery>
Builder for KnnQuery.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • field

      public final KnnQuery.Builder field​(java.lang.String value)
      Required - The name of the vector field to search against

      API name: field

    • queryVector

      public final KnnQuery.Builder queryVector​(java.util.List<java.lang.Double> list)
      Required - The query vector

      API name: query_vector

      Adds all elements of list to queryVector.

    • queryVector

      public final KnnQuery.Builder queryVector​(java.lang.Double value, java.lang.Double... values)
      Required - The query vector

      API name: query_vector

      Adds one or more values to queryVector.

    • k

      public final KnnQuery.Builder k​(long value)
      Required - The final number of nearest neighbors to return as top hits

      API name: k

    • numCandidates

      public final KnnQuery.Builder numCandidates​(long value)
      Required - The number of nearest neighbor candidates to consider per shard

      API name: num_candidates

    • boost

      public final KnnQuery.Builder boost​(@Nullable java.lang.Float value)
      Boost value to apply to kNN scores

      API name: boost

    • filter

      public final KnnQuery.Builder filter​(java.util.List<Query> list)
      Filters for the kNN search query

      API name: filter

      Adds all elements of list to filter.

    • filter

      public final KnnQuery.Builder filter​(Query value, Query... values)
      Filters for the kNN search query

      API name: filter

      Adds one or more values to filter.

    • filter

      public final KnnQuery.Builder filter​(java.util.function.Function<Query.Builder,​ObjectBuilder<Query>> fn)
      Filters for the kNN search query

      API name: filter

      Adds a value to filter using a builder lambda.

    • self

      protected KnnQuery.Builder self()
      Specified by:
      self in class WithJsonObjectBuilderBase<KnnQuery.Builder>

    • build

      public KnnQuery build()
      Builds a KnnQuery.
      Specified by:
      build in interface ObjectBuilder<KnnQuery>
      Throws:
      java.lang.NullPointerException - if some of the required fields are null.