Package co.elastic.clients.elasticsearch.inference

Class RankedDocument

java.lang.Object

co.elastic.clients.elasticsearch.inference.RankedDocument

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class RankedDocument
extends Object
implements JsonpSerializable

The rerank result object representing a single ranked document id: the original index of the document in the request relevance_score: the relevance_score of the document relative to the query text: Optional, the text of the document, if requested

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RankedDocument.Builder	Builder for RankedDocument.

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<RankedDocument>	_DESERIALIZER	Json deserializer for RankedDocument

Method Summary

Modifier and Type	Method	Description
final int	index()	Required - API name: index
static RankedDocument	of(Function<RankedDocument.Builder,ObjectBuilder<RankedDocument>> fn)
final float	relevanceScore()	Required - API name: relevance_score
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupRankedDocumentDeserializer(ObjectDeserializer<RankedDocument.Builder> op)
final String	text()	API name: text
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<RankedDocument> _DESERIALIZER

Json deserializer for RankedDocument

Method Details

of

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

index

public final int index()

Required - API name: index

relevanceScore

public final float relevanceScore()

Required - API name: relevance_score

text

@Nullable
public final String text()

API name: text

serialize

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

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

toString

public String toString()

Overrides:

toString in class Object

setupRankedDocumentDeserializer

protected static void setupRankedDocumentDeserializer(ObjectDeserializer<RankedDocument.Builder> op)