Class ClassificationInferenceOptions
java.lang.Object
co.elastic.clients.elasticsearch.ml.ClassificationInferenceOptions
- All Implemented Interfaces:
InferenceConfigVariant
,InferenceConfigCreateVariant
,InferenceConfigUpdateVariant
,JsonpSerializable
@JsonpDeserializable public class ClassificationInferenceOptions extends java.lang.Object implements InferenceConfigUpdateVariant, InferenceConfigCreateVariant, InferenceConfigVariant, JsonpSerializable
- See Also:
- API specification
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ClassificationInferenceOptions.Builder
Builder forClassificationInferenceOptions
. -
Field Summary
Fields Modifier and Type Field Description static JsonpDeserializer<ClassificationInferenceOptions>
_DESERIALIZER
Json deserializer forClassificationInferenceOptions
-
Method Summary
Modifier and Type Method Description InferenceConfigCreate.Kind
_inferenceConfigCreateKind()
InferenceConfigCreate variant kind.InferenceConfig.Kind
_inferenceConfigKind()
InferenceConfig variant kind.InferenceConfigUpdate.Kind
_inferenceConfigUpdateKind()
InferenceConfigUpdate variant kind.java.lang.Integer
numTopClasses()
Specifies the number of top class predictions to return.java.lang.Integer
numTopFeatureImportanceValues()
Specifies the maximum number of feature importance values per document.static ClassificationInferenceOptions
of(java.util.function.Function<ClassificationInferenceOptions.Builder,ObjectBuilder<ClassificationInferenceOptions>> fn)
java.lang.String
predictionFieldType()
Specifies the type of the predicted field to write.java.lang.String
resultsField()
The field that is added to incoming documents to contain the inference prediction.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
setupClassificationInferenceOptionsDeserializer(ObjectDeserializer<ClassificationInferenceOptions.Builder> op)
java.lang.String
topClassesResultsField()
Specifies the field to which the top classes are written.java.lang.String
toString()
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface co.elastic.clients.elasticsearch.ml.InferenceConfigCreateVariant
_toInferenceConfigCreate
Methods inherited from interface co.elastic.clients.elasticsearch.ml.InferenceConfigUpdateVariant
_toInferenceConfigUpdate
Methods inherited from interface co.elastic.clients.elasticsearch._types.aggregations.InferenceConfigVariant
_toInferenceConfig
-
Field Details
-
_DESERIALIZER
Json deserializer forClassificationInferenceOptions
-
-
Method Details
-
of
public static ClassificationInferenceOptions of(java.util.function.Function<ClassificationInferenceOptions.Builder,ObjectBuilder<ClassificationInferenceOptions>> fn) -
_inferenceConfigUpdateKind
InferenceConfigUpdate variant kind.- Specified by:
_inferenceConfigUpdateKind
in interfaceInferenceConfigUpdateVariant
-
_inferenceConfigCreateKind
InferenceConfigCreate variant kind.- Specified by:
_inferenceConfigCreateKind
in interfaceInferenceConfigCreateVariant
-
_inferenceConfigKind
InferenceConfig variant kind.- Specified by:
_inferenceConfigKind
in interfaceInferenceConfigVariant
-
numTopClasses
@Nullable public final java.lang.Integer numTopClasses()Specifies the number of top class predictions to return. Defaults to 0.API name:
num_top_classes
-
numTopFeatureImportanceValues
@Nullable public final java.lang.Integer numTopFeatureImportanceValues()Specifies the maximum number of feature importance values per document.API name:
num_top_feature_importance_values
-
predictionFieldType
@Nullable public final java.lang.String predictionFieldType()Specifies the type of the predicted field to write. Acceptable values are: string, number, boolean. When boolean is provided 1.0 is transformed to true and 0.0 to false.API name:
prediction_field_type
-
resultsField
@Nullable public final java.lang.String resultsField()The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.API name:
results_field
-
topClassesResultsField
@Nullable public final java.lang.String topClassesResultsField()Specifies the field to which the top classes are written. Defaults to top_classes.API name:
top_classes_results_field
-
serialize
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
toString
public java.lang.String toString()- Overrides:
toString
in classjava.lang.Object
-
setupClassificationInferenceOptionsDeserializer
protected static void setupClassificationInferenceOptionsDeserializer(ObjectDeserializer<ClassificationInferenceOptions.Builder> op)
-