Package co.elastic.clients.elasticsearch._types.query_dsl

Class SparseVectorQuery.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

co.elastic.clients.elasticsearch._types.query_dsl.QueryBase.AbstractBuilder<SparseVectorQuery.Builder>

co.elastic.clients.elasticsearch._types.query_dsl.SparseVectorQuery.Builder

All Implemented Interfaces:

WithJson<SparseVectorQuery.Builder>, ObjectBuilder<SparseVectorQuery>

Enclosing class:

SparseVectorQuery

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	SparseVectorQuery.Builder.ContainerBuilder

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SparseVectorQuery	build()
final SparseVectorQuery.Builder	field(String value)	Required - The name of the field that contains the token-weight pairs to be searched against.
SparseVectorQuery.Builder.ContainerBuilder	inferenceId(String v)
final SparseVectorQuery.Builder	prune(Boolean value)	Whether to perform pruning, omitting the non-significant tokens from the query to improve query performance.
final SparseVectorQuery.Builder	pruningConfig(TokenPruningConfig value)	Optional pruning configuration.
final SparseVectorQuery.Builder	pruningConfig(Function<TokenPruningConfig.Builder,ObjectBuilder<TokenPruningConfig>> fn)	Optional pruning configuration.
final SparseVectorQuery.Builder	query(String value)	The query text you want to use for search.
SparseVectorQuery.Builder.ContainerBuilder	queryVector(Map<String,Float> v)
protected SparseVectorQuery.Builder	self()

Methods inherited from class co.elastic.clients.elasticsearch._types.query_dsl.QueryBase.AbstractBuilder

boost, queryName

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 SparseVectorQuery.Builder field(String value)

Required - The name of the field that contains the token-weight pairs to be searched against. This field must be a mapped sparse_vector field.

API name: field

query

public final SparseVectorQuery.Builder query(@Nullable
 String value)

The query text you want to use for search. If inference_id is specified, query must also be specified.

API name: query

prune

public final SparseVectorQuery.Builder prune(@Nullable
 Boolean value)

Whether to perform pruning, omitting the non-significant tokens from the query to improve query performance. If prune is true but the pruning_config is not specified, pruning will occur but default values will be used. Default: false

API name: prune

pruningConfig

public final SparseVectorQuery.Builder pruningConfig(@Nullable
 TokenPruningConfig value)

Optional pruning configuration. If enabled, this will omit non-significant tokens from the query in order to improve query performance. This is only used if prune is set to true. If prune is set to true but pruning_config is not specified, default values will be used.

API name: pruning_config

pruningConfig

public final SparseVectorQuery.Builder pruningConfig(Function<TokenPruningConfig.Builder,ObjectBuilder<TokenPruningConfig>> fn)

Optional pruning configuration. If enabled, this will omit non-significant tokens from the query in order to improve query performance. This is only used if prune is set to true. If prune is set to true but pruning_config is not specified, default values will be used.

API name: pruning_config

self

protected SparseVectorQuery.Builder self()

Specified by:

self in class QueryBase.AbstractBuilder<SparseVectorQuery.Builder>

queryVector

public SparseVectorQuery.Builder.ContainerBuilder queryVector(Map<String,Float> v)

inferenceId

public SparseVectorQuery.Builder.ContainerBuilder inferenceId(String v)

build

public SparseVectorQuery build()

Specified by:

build in interface ObjectBuilder<SparseVectorQuery>