Package org.opensearch.client.opensearch.ingest

Class TextEmbeddingProcessor

java.lang.Object

org.opensearch.client.opensearch.ingest.ProcessorBase

org.opensearch.client.opensearch.ingest.TextEmbeddingProcessor

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, ProcessorVariant, ToCopyableBuilder<TextEmbeddingProcessor.Builder,TextEmbeddingProcessor>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class TextEmbeddingProcessor
extends ProcessorBase
implements ProcessorVariant, ToCopyableBuilder<TextEmbeddingProcessor.Builder,TextEmbeddingProcessor>

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.opensearch.client.opensearch.ingest.ProcessorBase

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
Processor.Kind	_processorKind()	Processor variant kind.
final Integer	batchSize()	API name: batch_size
static TextEmbeddingProcessor.Builder	builder()
boolean	equals(Object o)
final Map<String,String>	fieldMap()	Required - Contains key-value pairs that specify the mapping of a text field to a vector field.
int	hashCode()
final String	modelId()	Required - API name: model_id
static TextEmbeddingProcessor	of(Function<TextEmbeddingProcessor.Builder,ObjectBuilder<TextEmbeddingProcessor>> fn)
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupTextEmbeddingProcessorDeserializer(ObjectDeserializer<TextEmbeddingProcessor.Builder> op)
TextEmbeddingProcessor.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Methods inherited from class org.opensearch.client.opensearch.ingest.ProcessorBase

description, if_, ignoreFailure, onFailure, serialize, setupProcessorBaseDeserializer, tag

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable

toJsonString

Methods inherited from interface org.opensearch.client.opensearch.ingest.ProcessorVariant

toProcessor

Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder

copy

Field Details

_DESERIALIZER

public static final JsonpDeserializer<TextEmbeddingProcessor> _DESERIALIZER

Json deserializer for TextEmbeddingProcessor

Method Details

of

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

_processorKind

public Processor.Kind _processorKind()

Processor variant kind.

Specified by:

_processorKind in interface ProcessorVariant

batchSize

@Nullable
public final Integer batchSize()

API name: batch_size

fieldMap

@Nonnull
public final Map<String,String> fieldMap()

Required - Contains key-value pairs that specify the mapping of a text field to a vector field.

API name: field_map

modelId

@Nonnull
public final String modelId()

Required - API name: model_id

serializeInternal

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

Overrides:

serializeInternal in class ProcessorBase

toBuilder

@Nonnull
public TextEmbeddingProcessor.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<TextEmbeddingProcessor.Builder,TextEmbeddingProcessor>

Returns:

a new builder instance.

builder

@Nonnull
public static TextEmbeddingProcessor.Builder builder()

setupTextEmbeddingProcessorDeserializer

protected static void setupTextEmbeddingProcessorDeserializer(ObjectDeserializer<TextEmbeddingProcessor.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class ProcessorBase

equals

public boolean equals(Object o)

Overrides:

equals in class ProcessorBase