Package co.elastic.clients.elasticsearch.core.knn_search

Class KnnSearchQuery.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • field

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

      API name: field

    • queryVector

      public final KnnSearchQuery.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 KnnSearchQuery.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 KnnSearchQuery.Builder k​(long value)
      Required - The final number of nearest neighbors to return as top hits

      API name: k

    • numCandidates

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

      API name: num_candidates

    • self

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

    • build

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