Package co.elastic.clients.elasticsearch._types

Class TextSimilarityReranker.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

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

co.elastic.clients.elasticsearch._types.TextSimilarityReranker.Builder

All Implemented Interfaces:

WithJson<TextSimilarityReranker.Builder>, ObjectBuilder<TextSimilarityReranker>

Enclosing class:

TextSimilarityReranker

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

Builder for TextSimilarityReranker.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
TextSimilarityReranker	build()	Builds a TextSimilarityReranker.
final TextSimilarityReranker.Builder	field(String value)	The document field to be used for text similarity comparisons.
final TextSimilarityReranker.Builder	inferenceId(String value)	Unique identifier of the inference endpoint created using the inference API.
final TextSimilarityReranker.Builder	inferenceText(String value)	The text snippet used as the basis for similarity comparison
final TextSimilarityReranker.Builder	rankWindowSize(Integer value)	This value determines how many documents we will consider from the nested retriever.
final TextSimilarityReranker.Builder	retriever(Retriever value)	Required - The nested retriever which will produce the first-level results, that will later be used for reranking.
final TextSimilarityReranker.Builder	retriever(RetrieverVariant value)	Required - The nested retriever which will produce the first-level results, that will later be used for reranking.
final TextSimilarityReranker.Builder	retriever(Function<Retriever.Builder,ObjectBuilder<Retriever>> fn)	Required - The nested retriever which will produce the first-level results, that will later be used for reranking.
protected TextSimilarityReranker.Builder	self()

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

filter, filter, filter, filter, minScore

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

retriever

public final TextSimilarityReranker.Builder retriever(Retriever value)

Required - The nested retriever which will produce the first-level results, that will later be used for reranking.

API name: retriever

retriever

public final TextSimilarityReranker.Builder retriever(Function<Retriever.Builder,ObjectBuilder<Retriever>> fn)

Required - The nested retriever which will produce the first-level results, that will later be used for reranking.

API name: retriever

retriever

public final TextSimilarityReranker.Builder retriever(RetrieverVariant value)

Required - The nested retriever which will produce the first-level results, that will later be used for reranking.

API name: retriever

rankWindowSize

public final TextSimilarityReranker.Builder rankWindowSize(@Nullable
 Integer value)

This value determines how many documents we will consider from the nested retriever.

API name: rank_window_size

inferenceId

public final TextSimilarityReranker.Builder inferenceId(@Nullable
 String value)

Unique identifier of the inference endpoint created using the inference API.

API name: inference_id

inferenceText

public final TextSimilarityReranker.Builder inferenceText(@Nullable
 String value)

The text snippet used as the basis for similarity comparison

API name: inference_text

field

public final TextSimilarityReranker.Builder field(@Nullable
 String value)

The document field to be used for text similarity comparisons. This field should contain the text that will be evaluated against the inference_text

API name: field

self

protected TextSimilarityReranker.Builder self()

Specified by:

self in class RetrieverBase.AbstractBuilder<TextSimilarityReranker.Builder>

build

public TextSimilarityReranker build()

Builds a TextSimilarityReranker.

Specified by:

build in interface ObjectBuilder<TextSimilarityReranker>

Throws:

NullPointerException - if some of the required fields are null.