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:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	InferenceProcessor.Builder	Builder for InferenceProcessor.

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch.ingest.ProcessorBase

ProcessorBase.AbstractBuilder<BuilderT extends ProcessorBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<InferenceProcessor>	_DESERIALIZER	Json deserializer for InferenceProcessor

Method Summary

Modifier and Type	Method	Description
Processor.Kind	_processorKind()	Processor variant kind.
final Map<String,JsonData>	fieldMap()	Maps the document field names to the known field names of the model.
final InferenceConfig	inferenceConfig()	Contains the inference type and its options.
final String	modelId()	Required - The ID or alias for the trained model, or the ID of the deployment.
static InferenceProcessor	of(Function<InferenceProcessor.Builder,ObjectBuilder<InferenceProcessor>> fn)
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupInferenceProcessorDeserializer(ObjectDeserializer<InferenceProcessor.Builder> op)
final String	targetField()	Field added to incoming documents to contain results objects.

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

description, if_, ignoreFailure, onFailure, serialize, setupProcessorBaseDeserializer, tag, 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.ingest.ProcessorVariant

_toProcessor

Field Details

_DESERIALIZER

public static final JsonpDeserializer<InferenceProcessor> _DESERIALIZER

Json deserializer for InferenceProcessor

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

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)