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

Class RerankQuery

java.lang.Object

co.elastic.clients.elasticsearch.inference.rerank.RerankQuery

All Implemented Interfaces:

JsonpSerializable, TaggedUnion<RerankQuery.Kind,Object>

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

Query input for the rerank task. Either a string, or an object. The object form additionally allows specifying non-text inputs, such as images.

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

See Also:

• API specification

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
final Object	_get()
final RerankQuery.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?
RerankInputObject	object()	Get the object variant value.
static RerankQuery	of(Function<RerankQuery.Builder,ObjectBuilder<RerankQuery>> fn)
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
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<RerankQuery> _DESERIALIZER

Method Details

_kind

public final RerankQuery.Kind _kind()

Description copied from interface: TaggedUnion

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

Specified by:

_kind in interface TaggedUnion<RerankQuery.Kind,Object>

Returns:

the variant kind

_get

public final Object _get()

Specified by:

_get in interface TaggedUnion<RerankQuery.Kind,Object>

of

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

isObject

public boolean isObject()

Is this variant instance of kind object?

object

public 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 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