Package co.elastic.clients.elasticsearch._types

Class KnnRetriever.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch._types.RetrieverBase.AbstractBuilder<KnnRetriever.Builder>

co.elastic.clients.elasticsearch._types.KnnRetriever.Builder

All Implemented Interfaces:

WithJson<KnnRetriever.Builder>, ObjectBuilder<KnnRetriever>

Enclosing class:

KnnRetriever

public static class KnnRetriever.Builder
extends RetrieverBase.AbstractBuilder<KnnRetriever.Builder>
implements ObjectBuilder<KnnRetriever>

Builder for KnnRetriever.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
KnnRetriever	build()	Builds a KnnRetriever.
final KnnRetriever.Builder	field(String value)	Required - The name of the vector field to search against.
final KnnRetriever.Builder	k(int value)	Required - Number of nearest neighbors to return as top hits.
final KnnRetriever.Builder	numCandidates(int value)	Required - Number of nearest neighbor candidates to consider per shard.
final KnnRetriever.Builder	queryVector(Float value, Float... values)	Query vector.
final KnnRetriever.Builder	queryVector(List<Float> list)	Query vector.
final KnnRetriever.Builder	queryVectorBuilder(QueryVectorBuilder value)	Defines a model to build a query vector.
final KnnRetriever.Builder	queryVectorBuilder(Function<QueryVectorBuilder.Builder,ObjectBuilder<QueryVectorBuilder>> fn)	Defines a model to build a query vector.
protected KnnRetriever.Builder	self()
final KnnRetriever.Builder	similarity(Float value)	The minimum similarity required for a document to be considered a match.

Methods inherited from class co.elastic.clients.elasticsearch._types.RetrieverBase.AbstractBuilder

filter, filter, filter

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

field

public final KnnRetriever.Builder field(String value)

Required - The name of the vector field to search against.

API name: field

queryVector

public final KnnRetriever.Builder queryVector(List<Float> list)

Query vector. Must have the same number of dimensions as the vector field you are searching against. You must provide a query_vector_builder or query_vector, but not both.

API name: query_vector

Adds all elements of list to queryVector.

queryVector

public final KnnRetriever.Builder queryVector(Float value,
 Float... values)

Query vector. Must have the same number of dimensions as the vector field you are searching against. You must provide a query_vector_builder or query_vector, but not both.

API name: query_vector

Adds one or more values to queryVector.

queryVectorBuilder

public final KnnRetriever.Builder queryVectorBuilder(@Nullable
 QueryVectorBuilder value)

Defines a model to build a query vector.

API name: query_vector_builder

queryVectorBuilder

public final KnnRetriever.Builder queryVectorBuilder(Function<QueryVectorBuilder.Builder,ObjectBuilder<QueryVectorBuilder>> fn)

Defines a model to build a query vector.

API name: query_vector_builder

k

public final KnnRetriever.Builder k(int value)

Required - Number of nearest neighbors to return as top hits.

API name: k

numCandidates

public final KnnRetriever.Builder numCandidates(int value)

Required - Number of nearest neighbor candidates to consider per shard.

API name: num_candidates

similarity

public final KnnRetriever.Builder similarity(@Nullable
 Float value)

The minimum similarity required for a document to be considered a match.

API name: similarity

self

protected KnnRetriever.Builder self()

Specified by:

self in class RetrieverBase.AbstractBuilder<KnnRetriever.Builder>

build

public KnnRetriever build()

Builds a KnnRetriever.

Specified by:

build in interface ObjectBuilder<KnnRetriever>

Throws:

NullPointerException - if some of the required fields are null.