co.elastic.clients.elasticsearch.ml.evaluate_data_frame.DataframeOutlierDetectionSummary Maven / Gradle / Ivy
/*
* 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.evaluate_data_frame;
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.Double;
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.evaluate_data_frame.DataframeOutlierDetectionSummary
/**
*
* @see API
* specification
*/
@JsonpDeserializable
public class DataframeOutlierDetectionSummary implements JsonpSerializable {
@Nullable
private final DataframeEvaluationSummaryAucRoc aucRoc;
private final Map precision;
private final Map recall;
private final Map confusionMatrix;
// ---------------------------------------------------------------------------------------------
private DataframeOutlierDetectionSummary(Builder builder) {
this.aucRoc = builder.aucRoc;
this.precision = ApiTypeHelper.unmodifiable(builder.precision);
this.recall = ApiTypeHelper.unmodifiable(builder.recall);
this.confusionMatrix = ApiTypeHelper.unmodifiable(builder.confusionMatrix);
}
public static DataframeOutlierDetectionSummary of(
Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* The AUC ROC (area under the curve of the receiver operating characteristic)
* score and optionally the curve.
*
* API name: {@code auc_roc}
*/
@Nullable
public final DataframeEvaluationSummaryAucRoc aucRoc() {
return this.aucRoc;
}
/**
* Set the different thresholds of the outlier score at where the metric is
* calculated.
*
* API name: {@code precision}
*/
public final Map precision() {
return this.precision;
}
/**
* Set the different thresholds of the outlier score at where the metric is
* calculated.
*
* API name: {@code recall}
*/
public final Map recall() {
return this.recall;
}
/**
* Set the different thresholds of the outlier score at where the metrics
* (tp - true positive, fp - false positive,
* tn - true negative, fn - false negative) are
* calculated.
*
* API name: {@code confusion_matrix}
*/
public final Map confusionMatrix() {
return this.confusionMatrix;
}
/**
* 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());
generator.write(item0.getValue());
}
generator.writeEnd();
}
if (ApiTypeHelper.isDefined(this.recall)) {
generator.writeKey("recall");
generator.writeStartObject();
for (Map.Entry item0 : this.recall.entrySet()) {
generator.writeKey(item0.getKey());
generator.write(item0.getValue());
}
generator.writeEnd();
}
if (ApiTypeHelper.isDefined(this.confusionMatrix)) {
generator.writeKey("confusion_matrix");
generator.writeStartObject();
for (Map.Entry item0 : this.confusionMatrix.entrySet()) {
generator.writeKey(item0.getKey());
item0.getValue().serialize(generator, mapper);
}
generator.writeEnd();
}
}
@Override
public String toString() {
return JsonpUtils.toString(this);
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link DataframeOutlierDetectionSummary}.
*/
public static class Builder extends WithJsonObjectBuilderBase
implements
ObjectBuilder {
@Nullable
private DataframeEvaluationSummaryAucRoc aucRoc;
@Nullable
private Map precision;
@Nullable
private Map recall;
@Nullable
private Map confusionMatrix;
/**
* The AUC ROC (area under the curve of the receiver operating characteristic)
* score and optionally the curve.
*
* API name: {@code auc_roc}
*/
public final Builder aucRoc(@Nullable DataframeEvaluationSummaryAucRoc value) {
this.aucRoc = value;
return this;
}
/**
* The AUC ROC (area under the curve of the receiver operating characteristic)
* score and optionally the curve.
*
* API name: {@code auc_roc}
*/
public final Builder aucRoc(
Function> fn) {
return this.aucRoc(fn.apply(new DataframeEvaluationSummaryAucRoc.Builder()).build());
}
/**
* Set the different thresholds of the outlier score at where the metric is
* calculated.
*
* API name: {@code precision}
*
* Adds all entries of map to precision.
*/
public final Builder precision(Map map) {
this.precision = _mapPutAll(this.precision, map);
return this;
}
/**
* Set the different thresholds of the outlier score at where the metric is
* calculated.
*
* API name: {@code precision}
*
* Adds an entry to precision.
*/
public final Builder precision(String key, Double value) {
this.precision = _mapPut(this.precision, key, value);
return this;
}
/**
* Set the different thresholds of the outlier score at where the metric is
* calculated.
*
* API name: {@code recall}
*
* Adds all entries of map to recall.
*/
public final Builder recall(Map map) {
this.recall = _mapPutAll(this.recall, map);
return this;
}
/**
* Set the different thresholds of the outlier score at where the metric is
* calculated.
*
* API name: {@code recall}
*
* Adds an entry to recall.
*/
public final Builder recall(String key, Double value) {
this.recall = _mapPut(this.recall, key, value);
return this;
}
/**
* Set the different thresholds of the outlier score at where the metrics
* (tp - true positive, fp - false positive,
* tn - true negative, fn - false negative) are
* calculated.
*
* API name: {@code confusion_matrix}
*
* Adds all entries of map to confusionMatrix.
*/
public final Builder confusionMatrix(Map map) {
this.confusionMatrix = _mapPutAll(this.confusionMatrix, map);
return this;
}
/**
* Set the different thresholds of the outlier score at where the metrics
* (tp - true positive, fp - false positive,
* tn - true negative, fn - false negative) are
* calculated.
*
* API name: {@code confusion_matrix}
*
* Adds an entry to confusionMatrix.
*/
public final Builder confusionMatrix(String key, ConfusionMatrixThreshold value) {
this.confusionMatrix = _mapPut(this.confusionMatrix, key, value);
return this;
}
/**
* Set the different thresholds of the outlier score at where the metrics
* (tp - true positive, fp - false positive,
* tn - true negative, fn - false negative) are
* calculated.
*
* API name: {@code confusion_matrix}
*
* Adds an entry to confusionMatrix using a builder lambda.
*/
public final Builder confusionMatrix(String key,
Function> fn) {
return confusionMatrix(key, fn.apply(new ConfusionMatrixThreshold.Builder()).build());
}
@Override
protected Builder self() {
return this;
}
/**
* Builds a {@link DataframeOutlierDetectionSummary}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public DataframeOutlierDetectionSummary build() {
_checkSingleUse();
return new DataframeOutlierDetectionSummary(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Json deserializer for {@link DataframeOutlierDetectionSummary}
*/
public static final JsonpDeserializer _DESERIALIZER = ObjectBuilderDeserializer
.lazy(Builder::new, DataframeOutlierDetectionSummary::setupDataframeOutlierDetectionSummaryDeserializer);
protected static void setupDataframeOutlierDetectionSummaryDeserializer(
ObjectDeserializer op) {
op.add(Builder::aucRoc, DataframeEvaluationSummaryAucRoc._DESERIALIZER, "auc_roc");
op.add(Builder::precision, JsonpDeserializer.stringMapDeserializer(JsonpDeserializer.doubleDeserializer()),
"precision");
op.add(Builder::recall, JsonpDeserializer.stringMapDeserializer(JsonpDeserializer.doubleDeserializer()),
"recall");
op.add(Builder::confusionMatrix,
JsonpDeserializer.stringMapDeserializer(ConfusionMatrixThreshold._DESERIALIZER), "confusion_matrix");
}
}