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

@JsonpDeserializable
public class KnnQuery
extends QueryBase
implements QueryVariant

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	KnnQuery.Builder	Builder for KnnQuery.

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.query_dsl.QueryBase

QueryBase.AbstractBuilder<BuilderT extends QueryBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static JsonpDeserializer<KnnQuery>	_DESERIALIZER

Method Summary

Modifier and Type	Method	Description
Query.Kind	_queryKind()	Query variant kind.
java.lang.Boolean	expandNestedDocs()
java.lang.String	field()	Required - The target field.
Query	filter()	Optional - A query to filter the results of the query.
java.lang.Integer	k()	Optional - The number of neighbors the search of each graph will return.
java.lang.Float	maxDistance()	Optional - The maximum distance allowed between the vector and each of the returned search results.
java.util.Map<java.lang.String,JsonData>	methodParameters()
java.lang.Float	minScore()	Optional - The minimum score allowed for the returned search results.
static KnnQuery	of(java.util.function.Function<KnnQuery.Builder,ObjectBuilder<KnnQuery>> fn)
KnnQueryRescore	rescore()
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupKnnQueryDeserializer(ObjectDeserializer<KnnQuery.Builder> op)
KnnQuery.Builder	toBuilder()
float[]	vector()	Required - The vector to search for.

Methods inherited from class org.opensearch.client.opensearch._types.query_dsl.QueryBase

boost, queryName, serialize, setupQueryBaseDeserializer, toBuilder

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable

toJsonString

Methods inherited from interface org.opensearch.client.opensearch._types.query_dsl.QueryVariant

_toQuery, toQuery

Field Detail

_DESERIALIZER

public static final JsonpDeserializer<KnnQuery> _DESERIALIZER

Method Detail

of

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

_queryKind

public Query.Kind _queryKind()

Query variant kind.

Specified by:

_queryKind in interface QueryVariant

Returns:

The query variant kind.

field

public final java.lang.String field()

Required - The target field.

Returns:

The target field.

vector

public final float[] vector()

Required - The vector to search for.

Returns:

The vector to search for.

k

@Nullable
public final java.lang.Integer k()

Optional - The number of neighbors the search of each graph will return.

Returns:

The number of neighbors to return.

minScore

@Nullable
public final java.lang.Float minScore()

Optional - The minimum score allowed for the returned search results.

Returns:

The minimum score allowed for the returned search results.

maxDistance

@Nullable
public final java.lang.Float maxDistance()

Optional - The maximum distance allowed between the vector and each of the returned search results.

Returns:

The maximum distance allowed between the vector and each ofthe returned search results.

filter

@Nullable
public final Query filter()

Optional - A query to filter the results of the query.

Returns:

The filter query.

methodParameters

@Nonnull
public final java.util.Map<java.lang.String,JsonData> methodParameters()

rescore

@Nullable
public final KnnQueryRescore rescore()

expandNestedDocs

@Nullable
public final java.lang.Boolean expandNestedDocs()

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
                                 JsonpMapper mapper)

Overrides:

serializeInternal in class QueryBase

toBuilder

public KnnQuery.Builder toBuilder()

setupKnnQueryDeserializer

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