KnnQuery.Builder (java-client 2.8.0 API)

java.lang.Object
- org.opensearch.client.util.ObjectBuilderBase
- - org.opensearch.client.opensearch._types.query_dsl.QueryBase.AbstractBuilder<KnnQuery.Builder>
  - - org.opensearch.client.opensearch._types.query_dsl.KnnQuery.Builder

All Implemented Interfaces:: ObjectBuilder<KnnQuery>

Enclosing class:: KnnQuery

public static class KnnQuery.Builder
extends QueryBase.AbstractBuilder<KnnQuery.Builder>
implements ObjectBuilder<KnnQuery>

Builder for KnnQuery.

Constructor Summary

Constructors
Constructor Description

Builder()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`KnnQuery`	`build()`	Builds a `KnnQuery`.
`KnnQuery.Builder`	`field(java.lang.String field)`	Required - The target field.
`KnnQuery.Builder`	`filter(Query filter)`	Optional - A query to filter the results of the knn query.
`KnnQuery.Builder`	`k(java.lang.Integer k)`	Required - The number of neighbors the search of each graph will return.
`protected KnnQuery.Builder`	`self()`
`KnnQuery.Builder`	`vector(float[] vector)`	Required - The vector to search for.

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

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Builder
```
public Builder()
```
- Method Detail
  - field
```
public KnnQuery.Builder field(@Nullable
                              java.lang.String field)
```
    Required - The target field.
    
    Parameters:
    
    field - The target field.
    
    Returns:
    
    This builder.
  - vector
```
public KnnQuery.Builder vector(@Nullable
                               float[] vector)
```
    Required - The vector to search for.
    
    Parameters:
    
    vector - The vector to search for.
    
    Returns:
    
    This builder.
  - k
```
public KnnQuery.Builder k(@Nullable
                          java.lang.Integer k)
```
    Required - The number of neighbors the search of each graph will return.
    
    Parameters:
    
    k - The number of neighbors to return.
    
    Returns:
    
    This builder.
  - filter
```
public KnnQuery.Builder filter(@Nullable
                               Query filter)
```
    Optional - A query to filter the results of the knn query.
    
    Parameters:
    
    filter - The filter query.
    
    Returns:
    
    This builder.
  - self
```
protected KnnQuery.Builder self()
```
    Specified by:
    
    self in class QueryBase.AbstractBuilder<KnnQuery.Builder>
  - build
```
public KnnQuery build()
```
    Builds a KnnQuery.
    
    Specified by:
    
    build in interface ObjectBuilder<KnnQuery>
    
    Returns:
    
    The built KnnQuery.