Package org.opensearch.client.opensearch.ingest

Class TextEmbeddingProcessor.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.ingest.ProcessorBase.AbstractBuilder<TextEmbeddingProcessor.Builder>

org.opensearch.client.opensearch.ingest.TextEmbeddingProcessor.Builder

All Implemented Interfaces:

CopyableBuilder<TextEmbeddingProcessor.Builder,TextEmbeddingProcessor>, MutableBuilder<TextEmbeddingProcessor.Builder,TextEmbeddingProcessor>, ObjectBuilder<TextEmbeddingProcessor>

Enclosing class:

TextEmbeddingProcessor

public static class TextEmbeddingProcessor.Builder
extends ProcessorBase.AbstractBuilder<TextEmbeddingProcessor.Builder>
implements CopyableBuilder<TextEmbeddingProcessor.Builder,TextEmbeddingProcessor>

Builder for TextEmbeddingProcessor.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final TextEmbeddingProcessor.Builder	batchSize(Integer value)	API name: batch_size
TextEmbeddingProcessor	build()	Builds a TextEmbeddingProcessor.
TextEmbeddingProcessor.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final TextEmbeddingProcessor.Builder	fieldMap(String key, String value)	Required - Contains key-value pairs that specify the mapping of a text field to a vector field.
final TextEmbeddingProcessor.Builder	fieldMap(Map<String,String> map)	Required - Contains key-value pairs that specify the mapping of a text field to a vector field.
final TextEmbeddingProcessor.Builder	modelId(String value)	Required - API name: model_id
protected TextEmbeddingProcessor.Builder	self()

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

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

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

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

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public TextEmbeddingProcessor.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<TextEmbeddingProcessor.Builder,TextEmbeddingProcessor>

Returns:

a new builder instance.

self

@Nonnull
protected TextEmbeddingProcessor.Builder self()

Specified by:

self in class ProcessorBase.AbstractBuilder<TextEmbeddingProcessor.Builder>

batchSize

@Nonnull
public final TextEmbeddingProcessor.Builder batchSize(@Nullable
 Integer value)

API name: batch_size

fieldMap

@Nonnull
public final TextEmbeddingProcessor.Builder fieldMap(Map<String,String> map)

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

API name: field_map

Adds all elements of map to fieldMap.

fieldMap

@Nonnull
public final TextEmbeddingProcessor.Builder fieldMap(String key,
 String value)

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

API name: field_map

Adds an entry to fieldMap.

modelId

@Nonnull
public final TextEmbeddingProcessor.Builder modelId(String value)

Required - API name: model_id

build

@Nonnull
public TextEmbeddingProcessor build()

Builds a TextEmbeddingProcessor.

Specified by:

build in interface ObjectBuilder<TextEmbeddingProcessor>

Throws:

NullPointerException - if some of the required fields are null.