Package co.elastic.clients.elasticsearch.ml

Class EvaluateDataFrameRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.ml.EvaluateDataFrameRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class EvaluateDataFrameRequest
extends RequestBase
implements JsonpSerializable

Evaluate data frame analytics.

The API packages together commonly used evaluation metrics for various types of machine learning features. This has been designed for use on indexes created by data frame analytics. Evaluation requires both a ground truth field and an analytics result field to be present.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<EvaluateDataFrameRequest>	_DESERIALIZER	Json deserializer for EvaluateDataFrameRequest
static final Endpoint<EvaluateDataFrameRequest,EvaluateDataFrameResponse,ErrorResponse>	_ENDPOINT	Endpoint "ml.evaluate_data_frame".

Method Summary

Modifier and Type	Method	Description
final DataframeEvaluation	evaluation()	Required - Defines the type of evaluation you want to perform.
final String	index()	Required - Defines the index in which the evaluation will be performed.
static EvaluateDataFrameRequest	of(Function<EvaluateDataFrameRequest.Builder,ObjectBuilder<EvaluateDataFrameRequest>> fn)
final Query	query()	A query clause that retrieves a subset of data from the source index.
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	setupEvaluateDataFrameRequestDeserializer(ObjectDeserializer<EvaluateDataFrameRequest.Builder> op)

Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase

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<EvaluateDataFrameRequest> _DESERIALIZER

Json deserializer for EvaluateDataFrameRequest

_ENDPOINT

public static final Endpoint<EvaluateDataFrameRequest,EvaluateDataFrameResponse,ErrorResponse> _ENDPOINT

Endpoint "ml.evaluate_data_frame".

Method Details

of

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

evaluation

public final DataframeEvaluation evaluation()

Required - Defines the type of evaluation you want to perform.

API name: evaluation

index

public final String index()

Required - Defines the index in which the evaluation will be performed.

API name: index

query

@Nullable
public final Query query()

A query clause that retrieves a subset of data from the source index.

API name: query

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)

setupEvaluateDataFrameRequestDeserializer

protected static void setupEvaluateDataFrameRequestDeserializer(ObjectDeserializer<EvaluateDataFrameRequest.Builder> op)