Package co.elastic.clients.elasticsearch.ingest

Class InferenceProcessor.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch.ingest.ProcessorBase.AbstractBuilder<InferenceProcessor.Builder>

co.elastic.clients.elasticsearch.ingest.InferenceProcessor.Builder

All Implemented Interfaces:

WithJson<InferenceProcessor.Builder>, ObjectBuilder<InferenceProcessor>

Enclosing class:

InferenceProcessor

public static class InferenceProcessor.Builder
extends ProcessorBase.AbstractBuilder<InferenceProcessor.Builder>
implements ObjectBuilder<InferenceProcessor>

Builder for InferenceProcessor.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
InferenceProcessor	build()	Builds a InferenceProcessor.
final InferenceProcessor.Builder	fieldMap(String key, JsonData value)	Maps the document field names to the known field names of the model.
final InferenceProcessor.Builder	fieldMap(Map<String,JsonData> map)	Maps the document field names to the known field names of the model.
final InferenceProcessor.Builder	ignoreMissing(Boolean value)	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.
final InferenceProcessor.Builder	inferenceConfig(InferenceConfig value)	Contains the inference type and its options.
final InferenceProcessor.Builder	inferenceConfig(InferenceConfigVariant value)	Contains the inference type and its options.
final InferenceProcessor.Builder	inferenceConfig(Function<InferenceConfig.Builder,ObjectBuilder<InferenceConfig>> fn)	Contains the inference type and its options.
final InferenceProcessor.Builder	inputOutput(InputConfig value, InputConfig... values)	Input fields for inference and output (destination) fields for the inference results.
final InferenceProcessor.Builder	inputOutput(Function<InputConfig.Builder,ObjectBuilder<InputConfig>> fn)	Input fields for inference and output (destination) fields for the inference results.
final InferenceProcessor.Builder	inputOutput(List<InputConfig> list)	Input fields for inference and output (destination) fields for the inference results.
final InferenceProcessor.Builder	modelId(String value)	Required - The ID or alias for the trained model, or the ID of the deployment.
protected InferenceProcessor.Builder	self()
final InferenceProcessor.Builder	targetField(String value)	Field added to incoming documents to contain results objects.

Methods inherited from class co.elastic.clients.elasticsearch.ingest.ProcessorBase.AbstractBuilder

description, if_, if_, ignoreFailure, onFailure, onFailure, onFailure, onFailure, tag

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

modelId

public final InferenceProcessor.Builder modelId(String value)

Required - The ID or alias for the trained model, or the ID of the deployment.

API name: model_id

targetField

public final InferenceProcessor.Builder targetField(@Nullable
 String value)

Field added to incoming documents to contain results objects.

API name: target_field

fieldMap

public final InferenceProcessor.Builder fieldMap(Map<String,JsonData> map)

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

Adds all entries of map to fieldMap.

fieldMap

public final InferenceProcessor.Builder fieldMap(String key,
 JsonData value)

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

Adds an entry to fieldMap.

inferenceConfig

public final InferenceProcessor.Builder inferenceConfig(@Nullable
 InferenceConfig value)

Contains the inference type and its options.

API name: inference_config

inferenceConfig

public final InferenceProcessor.Builder inferenceConfig(Function<InferenceConfig.Builder,ObjectBuilder<InferenceConfig>> fn)

Contains the inference type and its options.

API name: inference_config

inferenceConfig

public final InferenceProcessor.Builder inferenceConfig(InferenceConfigVariant value)

Contains the inference type and its options.

API name: inference_config

inputOutput

public final InferenceProcessor.Builder inputOutput(List<InputConfig> list)

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

Adds all elements of list to inputOutput.

inputOutput

public final InferenceProcessor.Builder inputOutput(InputConfig value,
 InputConfig... values)

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

Adds one or more values to inputOutput.

inputOutput

public final InferenceProcessor.Builder inputOutput(Function<InputConfig.Builder,ObjectBuilder<InputConfig>> fn)

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

Adds a value to inputOutput using a builder lambda.

ignoreMissing

public final InferenceProcessor.Builder ignoreMissing(@Nullable
 Boolean value)

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

self

protected InferenceProcessor.Builder self()

Specified by:

self in class ProcessorBase.AbstractBuilder<InferenceProcessor.Builder>

build

public InferenceProcessor build()

Builds a InferenceProcessor.

Specified by:

build in interface ObjectBuilder<InferenceProcessor>

Throws:

NullPointerException - if some of the required fields are null.