NeuralQuery (java-client 2.8.0 API)

java.lang.Object
- org.opensearch.client.opensearch._types.query_dsl.QueryBase
- - org.opensearch.client.opensearch._types.query_dsl.NeuralQuery

All Implemented Interfaces:: JsonpSerializable, QueryVariant

@JsonpDeserializable
public class NeuralQuery
extends QueryBase
implements QueryVariant

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 JsonpDeserializer<NeuralQuery> _DESERIALIZER

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Query.Kind`	`_queryKind()`	Query variant kind.
`java.lang.String`	`field()`	Required - The target field.
`int`	`k()`	Required - The number of neighbors to return.
`java.lang.String`	`modelId()`	Optional - The model_id field if the default model for the index or field is set.
`static NeuralQuery`	`of(java.util.function.Function<NeuralQuery.Builder,ObjectBuilder<NeuralQuery>> fn)`
`java.lang.String`	`queryText()`	Required - Search query text.
`protected void`	`serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)`
`protected static void`	`setupNeuralQueryDeserializer(ObjectDeserializer<NeuralQuery.Builder> op)`

Methods inherited from class org.opensearch.client.opensearch._types.query_dsl.QueryBase
boost, queryName, serialize, setupQueryBaseDeserializer

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.opensearch._types.query_dsl.QueryVariant
_toQuery

Field Detail

_DESERIALIZER

public static final JsonpDeserializer<NeuralQuery> _DESERIALIZER

Method Detail
- of
```
public static NeuralQuery of(java.util.function.Function<NeuralQuery.Builder,ObjectBuilder<NeuralQuery>> 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.
- queryText
```
public final java.lang.String queryText()
```
  Required - Search query text.
  
  Returns:
  
  Search query text.
- k
```
public final int k()
```
  Required - The number of neighbors to return.
  
  Returns:
  
  The number of neighbors to return.
- modelId
```
@Nullable
public final java.lang.String modelId()
```
  Optional - The model_id field if the default model for the index or field is set. Required - The model_id field if there is no default model set for the index or field.
  
  Returns:
  
  The model_id field.
- serializeInternal
```
protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
                                 JsonpMapper mapper)
```
  Overrides:
  
  serializeInternal in class QueryBase
- setupNeuralQueryDeserializer
```
protected static void setupNeuralQueryDeserializer(ObjectDeserializer<NeuralQuery.Builder> op)
```