Package org.opensearch.client.opensearch._types.query_dsl

Class KnnQuery

java.lang.Object
org.opensearch.client.opensearch._types.query_dsl.QueryBase
org.opensearch.client.opensearch._types.query_dsl.KnnQuery
All Implemented Interfaces:
JsonpSerializable, PlainJsonSerializable, QueryVariant, ToCopyableBuilder<KnnQuery.Builder,KnnQuery>
@JsonpDeserializable @Generated("org.opensearch.client.codegen.CodeGenerator") public class KnnQuery extends QueryBase implements QueryVariant, ToCopyableBuilder<KnnQuery.Builder,KnnQuery>

  • Field Details

  • Method Details

    • of

      public static KnnQuery of(Function<KnnQuery.Builder,ObjectBuilder<KnnQuery>> fn)

    • _queryKind

      public Query.Kind _queryKind()
      Query variant kind.
      Specified by:
      _queryKind in interface QueryVariant

    • expandNestedDocs

      @Nullable public final Boolean expandNestedDocs()
      API name: expand_nested_docs

    • field

      @Nonnull public final String field()
      Required - The target field

    • filter

      @Nullable public final Query filter()
      The filter for the k-NN search query.

      API name: filter

    • k

      @Nullable public final Integer k()
      The total number of nearest neighbors to return as top hits.

      API name: k

    • maxDistance

      @Nullable public final Float maxDistance()
      The maximum physical vector space distance required in order for a neighbor to be considered a hit.

      API name: max_distance

    • methodParameters

      @Nonnull public final Map<String,JsonData> methodParameters()
      API name: method_parameters

    • minScore

      @Nullable public final Float minScore()
      The minimum similarity score required in order for a neighbor to be considered a hit.

      API name: min_score

    • rescore

      @Nullable public final KnnQueryRescore rescore()
      API name: rescore

    • vector

      @Nonnull public final List<Float> vector()
      Required - API name: vector

    • serializeInternal

      protected void serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
      Overrides:
      serializeInternal in class QueryBase

    • toBuilder

      @Nonnull public KnnQuery.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<KnnQuery.Builder,KnnQuery>
      Returns:
      a new builder instance.

    • builder

      @Nonnull public static KnnQuery.Builder builder()

    • setupKnnQueryDeserializer

      protected static void setupKnnQueryDeserializer(ObjectDeserializer<KnnQuery.Builder> op)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class QueryBase

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class QueryBase