Package co.elastic.clients.elasticsearch.ingest

Class InferenceProcessor

java.lang.Object
co.elastic.clients.elasticsearch.ingest.ProcessorBase
co.elastic.clients.elasticsearch.ingest.InferenceProcessor
All Implemented Interfaces:
ProcessorVariant, JsonpSerializable
@JsonpDeserializable public class InferenceProcessor extends ProcessorBase implements ProcessorVariant
See Also:

  • Field Details

  • Method Details

    • of

      public static InferenceProcessor of(Function<InferenceProcessor.Builder,ObjectBuilder<InferenceProcessor>> fn)

    • _processorKind

      public Processor.Kind _processorKind()
      Processor variant kind.
      Specified by:
      _processorKind in interface ProcessorVariant

    • modelId

      public final String modelId()
      Required - The ID or alias for the trained model, or the ID of the deployment.

      API name: model_id

    • targetField

      @Nullable public final String targetField()
      Field added to incoming documents to contain results objects.

      API name: target_field

    • fieldMap

      public final Map<String,JsonData> fieldMap()
      Maps the document field names to the known field names of the model. This mapping takes precedence over any default mappings provided in the model configuration.

      API name: field_map

    • inferenceConfig

      @Nullable public final InferenceConfig inferenceConfig()
      Contains the inference type and its options.

      API name: inference_config

    • inputOutput

      public final List<InputConfig> inputOutput()
      Input fields for inference and output (destination) fields for the inference results. This option is incompatible with the target_field and field_map options.

      API name: input_output

    • ignoreMissing

      @Nullable public final Boolean ignoreMissing()
      If true and any of the input fields defined in input_ouput are missing then those missing fields are quietly ignored, otherwise a missing field causes a failure. Only applies when using input_output configurations to explicitly list the input fields.

      API name: ignore_missing

    • serializeInternal

      protected void serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
      Overrides:
      serializeInternal in class ProcessorBase

    • setupInferenceProcessorDeserializer

      protected static void setupInferenceProcessorDeserializer(ObjectDeserializer<InferenceProcessor.Builder> op)