co.elastic.clients.elasticsearch.ml.DataframeEvaluationMetrics Maven / Gradle / Ivy
Show all versions of elasticsearch-java Show documentation
/*
* Licensed to Elasticsearch B.V. under one or more contributor
* license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright
* ownership. Elasticsearch B.V. licenses this file to you under
* the Apache License, Version 2.0 (the "License"); you may
* not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package co.elastic.clients.elasticsearch.ml;
import co.elastic.clients.json.JsonData;
import co.elastic.clients.json.JsonpDeserializable;
import co.elastic.clients.json.JsonpDeserializer;
import co.elastic.clients.json.JsonpMapper;
import co.elastic.clients.json.JsonpSerializable;
import co.elastic.clients.json.JsonpUtils;
import co.elastic.clients.json.ObjectBuilderDeserializer;
import co.elastic.clients.json.ObjectDeserializer;
import co.elastic.clients.util.ApiTypeHelper;
import co.elastic.clients.util.ObjectBuilder;
import co.elastic.clients.util.WithJsonObjectBuilderBase;
import jakarta.json.stream.JsonGenerator;
import java.lang.String;
import java.util.Map;
import java.util.Objects;
import java.util.function.Function;
import javax.annotation.Nullable;
//----------------------------------------------------------------
// THIS CODE IS GENERATED. MANUAL EDITS WILL BE LOST.
//----------------------------------------------------------------
//
// This code is generated from the Elasticsearch API specification
// at https://github.com/elastic/elasticsearch-specification
//
// Manual updates to this file will be lost when the code is
// re-generated.
//
// If you find a property that is missing or wrongly typed, please
// open an issue or a PR on the API specification repository.
//
//----------------------------------------------------------------
// typedef: ml._types.DataframeEvaluationMetrics
/**
*
* @see API
* specification
*/
public abstract class DataframeEvaluationMetrics implements JsonpSerializable {
@Nullable
private final DataframeEvaluationClassificationMetricsAucRoc aucRoc;
private final Map precision;
private final Map recall;
// ---------------------------------------------------------------------------------------------
protected DataframeEvaluationMetrics(AbstractBuilder builder) {
this.aucRoc = builder.aucRoc;
this.precision = ApiTypeHelper.unmodifiable(builder.precision);
this.recall = ApiTypeHelper.unmodifiable(builder.recall);
}
/**
* The AUC ROC (area under the curve of the receiver operating characteristic)
* score and optionally the curve. It is calculated for a specific class
* (provided as "class_name") treated as positive.
*
* API name: {@code auc_roc}
*/
@Nullable
public final DataframeEvaluationClassificationMetricsAucRoc aucRoc() {
return this.aucRoc;
}
/**
* Precision of predictions (per-class and average).
*
* API name: {@code precision}
*/
public final Map precision() {
return this.precision;
}
/**
* Recall of predictions (per-class and average).
*
* API name: {@code recall}
*/
public final Map recall() {
return this.recall;
}
/**
* Serialize this object to JSON.
*/
public void serialize(JsonGenerator generator, JsonpMapper mapper) {
generator.writeStartObject();
serializeInternal(generator, mapper);
generator.writeEnd();
}
protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
if (this.aucRoc != null) {
generator.writeKey("auc_roc");
this.aucRoc.serialize(generator, mapper);
}
if (ApiTypeHelper.isDefined(this.precision)) {
generator.writeKey("precision");
generator.writeStartObject();
for (Map.Entry item0 : this.precision.entrySet()) {
generator.writeKey(item0.getKey());
item0.getValue().serialize(generator, mapper);
}
generator.writeEnd();
}
if (ApiTypeHelper.isDefined(this.recall)) {
generator.writeKey("recall");
generator.writeStartObject();
for (Map.Entry item0 : this.recall.entrySet()) {
generator.writeKey(item0.getKey());
item0.getValue().serialize(generator, mapper);
}
generator.writeEnd();
}
}
@Override
public String toString() {
return JsonpUtils.toString(this);
}
public abstract static class AbstractBuilder>
extends
WithJsonObjectBuilderBase {
@Nullable
private DataframeEvaluationClassificationMetricsAucRoc aucRoc;
@Nullable
private Map precision;
@Nullable
private Map recall;
/**
* The AUC ROC (area under the curve of the receiver operating characteristic)
* score and optionally the curve. It is calculated for a specific class
* (provided as "class_name") treated as positive.
*
* API name: {@code auc_roc}
*/
public final BuilderT aucRoc(@Nullable DataframeEvaluationClassificationMetricsAucRoc value) {
this.aucRoc = value;
return self();
}
/**
* The AUC ROC (area under the curve of the receiver operating characteristic)
* score and optionally the curve. It is calculated for a specific class
* (provided as "class_name") treated as positive.
*
* API name: {@code auc_roc}
*/
public final BuilderT aucRoc(
Function> fn) {
return this.aucRoc(fn.apply(new DataframeEvaluationClassificationMetricsAucRoc.Builder()).build());
}
/**
* Precision of predictions (per-class and average).
*
* API name: {@code precision}
*
* Adds all entries of map to precision.
*/
public final BuilderT precision(Map map) {
this.precision = _mapPutAll(this.precision, map);
return self();
}
/**
* Precision of predictions (per-class and average).
*
* API name: {@code precision}
*
* Adds an entry to precision.
*/
public final BuilderT precision(String key, JsonData value) {
this.precision = _mapPut(this.precision, key, value);
return self();
}
/**
* Recall of predictions (per-class and average).
*
* API name: {@code recall}
*
* Adds all entries of map to recall.
*/
public final BuilderT recall(Map map) {
this.recall = _mapPutAll(this.recall, map);
return self();
}
/**
* Recall of predictions (per-class and average).
*
* API name: {@code recall}
*
* Adds an entry to recall.
*/
public final BuilderT recall(String key, JsonData value) {
this.recall = _mapPut(this.recall, key, value);
return self();
}
protected abstract BuilderT self();
}
// ---------------------------------------------------------------------------------------------
protected static > void setupDataframeEvaluationMetricsDeserializer(
ObjectDeserializer op) {
op.add(AbstractBuilder::aucRoc, DataframeEvaluationClassificationMetricsAucRoc._DESERIALIZER, "auc_roc");
op.add(AbstractBuilder::precision, JsonpDeserializer.stringMapDeserializer(JsonData._DESERIALIZER),
"precision");
op.add(AbstractBuilder::recall, JsonpDeserializer.stringMapDeserializer(JsonData._DESERIALIZER), "recall");
}
}