co.elastic.clients.elasticsearch.ml.LearningToRankConfig Maven / Gradle / Ivy
Show all versions of org.apache.servicemix.bundles.elasticsearch-java
/*
* 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.Integer;
import java.lang.String;
import java.util.List;
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.LearningToRankConfig
/**
*
* @see API
* specification
*/
@JsonpDeserializable
public class LearningToRankConfig implements InferenceConfigCreateVariant, JsonpSerializable {
private final Map defaultParams;
private final List> featureExtractors;
private final int numTopFeatureImportanceValues;
// ---------------------------------------------------------------------------------------------
private LearningToRankConfig(Builder builder) {
this.defaultParams = ApiTypeHelper.unmodifiable(builder.defaultParams);
this.featureExtractors = ApiTypeHelper.unmodifiable(builder.featureExtractors);
this.numTopFeatureImportanceValues = ApiTypeHelper.requireNonNull(builder.numTopFeatureImportanceValues, this,
"numTopFeatureImportanceValues", 0);
}
public static LearningToRankConfig of(Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* InferenceConfigCreate variant kind.
*/
@Override
public InferenceConfigCreate.Kind _inferenceConfigCreateKind() {
return InferenceConfigCreate.Kind.LearningToRank;
}
/**
* API name: {@code default_params}
*/
public final Map defaultParams() {
return this.defaultParams;
}
/**
* API name: {@code feature_extractors}
*/
public final List> featureExtractors() {
return this.featureExtractors;
}
/**
* Required - API name: {@code num_top_feature_importance_values}
*/
public final int numTopFeatureImportanceValues() {
return this.numTopFeatureImportanceValues;
}
/**
* 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 (ApiTypeHelper.isDefined(this.defaultParams)) {
generator.writeKey("default_params");
generator.writeStartObject();
for (Map.Entry item0 : this.defaultParams.entrySet()) {
generator.writeKey(item0.getKey());
item0.getValue().serialize(generator, mapper);
}
generator.writeEnd();
}
if (ApiTypeHelper.isDefined(this.featureExtractors)) {
generator.writeKey("feature_extractors");
generator.writeStartArray();
for (Map item0 : this.featureExtractors) {
generator.writeStartObject();
if (item0 != null) {
for (Map.Entry item1 : item0.entrySet()) {
generator.writeKey(item1.getKey());
item1.getValue().serialize(generator, mapper);
}
}
generator.writeEnd();
}
generator.writeEnd();
}
generator.writeKey("num_top_feature_importance_values");
generator.write(this.numTopFeatureImportanceValues);
}
@Override
public String toString() {
return JsonpUtils.toString(this);
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link LearningToRankConfig}.
*/
public static class Builder extends WithJsonObjectBuilderBase
implements
ObjectBuilder {
@Nullable
private Map defaultParams;
@Nullable
private List> featureExtractors;
private Integer numTopFeatureImportanceValues;
/**
* API name: {@code default_params}
*
* Adds all entries of map to defaultParams.
*/
public final Builder defaultParams(Map map) {
this.defaultParams = _mapPutAll(this.defaultParams, map);
return this;
}
/**
* API name: {@code default_params}
*
* Adds an entry to defaultParams.
*/
public final Builder defaultParams(String key, JsonData value) {
this.defaultParams = _mapPut(this.defaultParams, key, value);
return this;
}
/**
* API name: {@code feature_extractors}
*
* Adds all elements of list to featureExtractors.
*/
public final Builder featureExtractors(List> list) {
this.featureExtractors = _listAddAll(this.featureExtractors, list);
return this;
}
/**
* API name: {@code feature_extractors}
*
* Adds one or more values to featureExtractors.
*/
public final Builder featureExtractors(Map value,
Map... values) {
this.featureExtractors = _listAdd(this.featureExtractors, value, values);
return this;
}
/**
* Required - API name: {@code num_top_feature_importance_values}
*/
public final Builder numTopFeatureImportanceValues(int value) {
this.numTopFeatureImportanceValues = value;
return this;
}
@Override
protected Builder self() {
return this;
}
/**
* Builds a {@link LearningToRankConfig}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public LearningToRankConfig build() {
_checkSingleUse();
return new LearningToRankConfig(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Json deserializer for {@link LearningToRankConfig}
*/
public static final JsonpDeserializer _DESERIALIZER = ObjectBuilderDeserializer
.lazy(Builder::new, LearningToRankConfig::setupLearningToRankConfigDeserializer);
protected static void setupLearningToRankConfigDeserializer(ObjectDeserializer op) {
op.add(Builder::defaultParams, JsonpDeserializer.stringMapDeserializer(JsonData._DESERIALIZER),
"default_params");
op.add(Builder::featureExtractors,
JsonpDeserializer.arrayDeserializer(
JsonpDeserializer.stringMapDeserializer(QueryFeatureExtractor._DESERIALIZER)),
"feature_extractors");
op.add(Builder::numTopFeatureImportanceValues, JsonpDeserializer.integerDeserializer(),
"num_top_feature_importance_values");
}
}