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

Class NeuralQuery

java.lang.Object

org.opensearch.client.opensearch._types.query_dsl.QueryBase

org.opensearch.client.opensearch._types.query_dsl.NeuralQuery

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, QueryVariant, ToCopyableBuilder<NeuralQuery.Builder,NeuralQuery>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class NeuralQuery
extends QueryBase
implements QueryVariant, ToCopyableBuilder<NeuralQuery.Builder,NeuralQuery>

Nested Class Summary

Nested Classes

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

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 final JsonpDeserializer<NeuralQuery>	_DESERIALIZER	Json deserializer for NeuralQuery

Method Summary

Modifier and Type	Method	Description
Query.Kind	_queryKind()	Query variant kind.
static NeuralQuery.Builder	builder()
boolean	equals(Object o)
final String	field()	Required - The target field
final Query	filter()	API name: filter
int	hashCode()
final Integer	k()	API name: k
final Float	maxDistance()	API name: max_distance
final Float	minScore()	API name: min_score
final String	modelId()	API name: model_id
static NeuralQuery	of(Function<NeuralQuery.Builder,ObjectBuilder<NeuralQuery>> fn)
final String	queryImage()	API name: query_image
final String	queryText()	API name: query_text
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupNeuralQueryDeserializer(ObjectDeserializer<NeuralQuery.Builder> op)
NeuralQuery.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

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

boost, queryName, serialize, setupQueryBaseDeserializer

Methods inherited from class java.lang.Object

clone, finalize, getClass, 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

Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder

copy

Field Details

_DESERIALIZER

public static final JsonpDeserializer<NeuralQuery> _DESERIALIZER

Json deserializer for NeuralQuery

Method Details

of

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

_queryKind

public Query.Kind _queryKind()

Query variant kind.

Specified by:

_queryKind in interface QueryVariant

field

@Nonnull
public final String field()

Required - The target field

filter

@Nullable
public final Query filter()

API name: filter

k

@Nullable
public final Integer k()

API name: k

maxDistance

@Nullable
public final Float maxDistance()

API name: max_distance

minScore

@Nullable
public final Float minScore()

API name: min_score

modelId

@Nullable
public final String modelId()

API name: model_id

queryImage

@Nullable
public final String queryImage()

API name: query_image

queryText

@Nullable
public final String queryText()

API name: query_text

serializeInternal

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

Overrides:

serializeInternal in class QueryBase

toBuilder

@Nonnull
public NeuralQuery.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<NeuralQuery.Builder,NeuralQuery>

Returns:

a new builder instance.

builder

@Nonnull
public static NeuralQuery.Builder builder()

setupNeuralQueryDeserializer

protected static void setupNeuralQueryDeserializer(ObjectDeserializer<NeuralQuery.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class QueryBase

equals

public boolean equals(Object o)

Overrides:

equals in class QueryBase