Package co.elastic.clients.elasticsearch.ml

Class ClassificationInferenceOptions

java.lang.Object
co.elastic.clients.elasticsearch.ml.ClassificationInferenceOptions
All Implemented Interfaces:
InferenceConfigVariant, InferenceConfigCreateVariant, JsonpSerializable
@JsonpDeserializable
public class ClassificationInferenceOptions
extends java.lang.Object
implements InferenceConfigCreateVariant, InferenceConfigVariant, JsonpSerializable
See Also:
API specification

  • Field Details

  • Method Details

    • of

      public static ClassificationInferenceOptions of​(java.util.function.Function<ClassificationInferenceOptions.Builder,​ObjectBuilder<ClassificationInferenceOptions>> fn)

    • _inferenceConfigCreateKind

      public InferenceConfigCreate.Kind _inferenceConfigCreateKind()
      InferenceConfigCreate variant kind.
      Specified by:
      _inferenceConfigCreateKind in interface InferenceConfigCreateVariant

    • _inferenceConfigKind

      public InferenceConfig.Kind _inferenceConfigKind()
      InferenceConfig variant kind.
      Specified by:
      _inferenceConfigKind in interface InferenceConfigVariant

    • 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

      public void serialize​(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
      Serialize this object to JSON.
      Specified by:
      serialize in interface JsonpSerializable

    • serializeInternal

      protected void serializeInternal​(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)

    • toString

      public java.lang.String toString()
      Overrides:
      toString in class java.lang.Object

    • setupClassificationInferenceOptionsDeserializer

      protected static void setupClassificationInferenceOptionsDeserializer​(ObjectDeserializer<ClassificationInferenceOptions.Builder> op)