Class KnnQuery
java.lang.Object
co.elastic.clients.elasticsearch._types.query_dsl.QueryBase
co.elastic.clients.elasticsearch._types.query_dsl.KnnQuery
- All Implemented Interfaces:
QueryVariant
,JsonpSerializable
@JsonpDeserializable public class KnnQuery extends QueryBase implements QueryVariant
A k-nearest neighbor (kNN) search finds the k nearest vectors to a query
vector, as measured by a similarity metric.
- See Also:
- API specification
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
KnnQuery.Builder
Builder forKnnQuery
.Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.query_dsl.QueryBase
QueryBase.AbstractBuilder<BuilderT extends QueryBase.AbstractBuilder<BuilderT>>
-
Field Summary
Fields Modifier and Type Field Description static JsonpDeserializer<KnnQuery>
_DESERIALIZER
Json deserializer forKnnQuery
-
Method Summary
Modifier and Type Method Description Query.Kind
_queryKind()
Query variant kind.java.lang.String
field()
Required - API name:field
int
numCandidates()
Required - API name:num_candidates
static KnnQuery
of(java.util.function.Function<KnnQuery.Builder,ObjectBuilder<KnnQuery>> fn)
java.util.List<java.lang.Double>
queryVector()
Required - API name:query_vector
protected void
serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void
setupKnnQueryDeserializer(ObjectDeserializer<KnnQuery.Builder> op)
Methods inherited from class co.elastic.clients.elasticsearch._types.query_dsl.QueryBase
boost, queryName, serialize, setupQueryBaseDeserializer, toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface co.elastic.clients.elasticsearch._types.query_dsl.QueryVariant
_toQuery
-
Field Details
-
_DESERIALIZER
Json deserializer forKnnQuery
-
-
Method Details
-
of
public static KnnQuery of(java.util.function.Function<KnnQuery.Builder,ObjectBuilder<KnnQuery>> fn) -
_queryKind
Query variant kind.- Specified by:
_queryKind
in interfaceQueryVariant
-
field
public final java.lang.String field()Required - API name:field
-
numCandidates
public final int numCandidates()Required - API name:num_candidates
-
queryVector
public final java.util.List<java.lang.Double> queryVector()Required - API name:query_vector
-
serializeInternal
- Overrides:
serializeInternal
in classQueryBase
-
setupKnnQueryDeserializer
-