Package co.elastic.clients.elasticsearch.inference.rerank

Class RerankInput

java.lang.Object

co.elastic.clients.elasticsearch.inference.rerank.RerankInput

All Implemented Interfaces:

JsonpSerializable, TaggedUnion<RerankInput.Kind,Object>

@JsonpDeserializable
public class RerankInput
extends Object
implements TaggedUnion<RerankInput.Kind,Object>, JsonpSerializable

The documents to rank for the rerank task. Either a string, an array of strings, an object, or an array of objects. The object form additionally allows specifying non-text inputs, such as images.

info Only the elastic service currently supports non-text inputs for the rerank task.

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RerankInput.Builder
static enum	RerankInput.Kind

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<RerankInput>	_DESERIALIZER

Method Summary

Modifier and Type	Method	Description
final Object	_get()
final RerankInput.Kind	_kind()	Get the of the kind of variant held by this object.
boolean	isObject()	Is this variant instance of kind object?
boolean	isString()	Is this variant instance of kind string?
List<RerankInputObject>	object()	Get the object variant value.
static RerankInput	of(Function<RerankInput.Builder,ObjectBuilder<RerankInput>> fn)
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
List<String>	string()	Get the string variant value.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

_DESERIALIZER

public static final JsonpDeserializer<RerankInput> _DESERIALIZER

Method Details

_kind

public final RerankInput.Kind _kind()

Description copied from interface: TaggedUnion

Get the of the kind of variant held by this object.

Specified by:

_kind in interface TaggedUnion<RerankInput.Kind,Object>

Returns:

the variant kind

_get

public final Object _get()

Specified by:

_get in interface TaggedUnion<RerankInput.Kind,Object>

of

public static RerankInput of(Function<RerankInput.Builder,ObjectBuilder<RerankInput>> fn)

isObject

public boolean isObject()

Is this variant instance of kind object?

object

public List<RerankInputObject> object()

Get the object variant value.

Throws:

IllegalStateException - if the current variant is not of the object kind.

isString

public boolean isString()

Is this variant instance of kind string?

string

public List<String> string()

Get the string variant value.

Throws:

IllegalStateException - if the current variant is not of the string kind.

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Specified by:

serialize in interface JsonpSerializable

toString

public String toString()

Overrides:

toString in class Object