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
Evaluates the data frame analytics for an annotated index. 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 forEvaluateDataFrameRequest
.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 JsonpDeserializer<EvaluateDataFrameRequest>
_DESERIALIZER
Json deserializer forEvaluateDataFrameRequest
static Endpoint<EvaluateDataFrameRequest,EvaluateDataFrameResponse,ErrorResponse>
_ENDPOINT
Endpoint "ml.evaluate_data_frame
". -
Method Summary
Modifier and Type Method Description DataframeEvaluation
evaluation()
Required - Defines the type of evaluation you want to perform.java.lang.String
index()
Required - Defines theindex
in which the evaluation will be performed.static EvaluateDataFrameRequest
of(java.util.function.Function<EvaluateDataFrameRequest.Builder,ObjectBuilder<EvaluateDataFrameRequest>> fn)
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 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Field Details
-
_DESERIALIZER
Json deserializer forEvaluateDataFrameRequest
-
_ENDPOINT
public static final Endpoint<EvaluateDataFrameRequest,EvaluateDataFrameResponse,ErrorResponse> _ENDPOINTEndpoint "ml.evaluate_data_frame
".
-
-
Method Details
-
of
public static EvaluateDataFrameRequest of(java.util.function.Function<EvaluateDataFrameRequest.Builder,ObjectBuilder<EvaluateDataFrameRequest>> fn) -
evaluation
Required - Defines the type of evaluation you want to perform.API name:
evaluation
-
index
public final java.lang.String index()Required - Defines theindex
in which the evaluation will be performed.API name:
index
-
query
A query clause that retrieves a subset of data from the source index.API name:
query
-
serialize
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
setupEvaluateDataFrameRequestDeserializer
protected static void setupEvaluateDataFrameRequestDeserializer(ObjectDeserializer<EvaluateDataFrameRequest.Builder> op)
-