Package org.opensearch.client.opensearch.search_pipeline

Class RetrievalAugmentedGenerationResponseProcessor.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.search_pipeline.RetrievalAugmentedGenerationResponseProcessor.Builder

All Implemented Interfaces:

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

Enclosing class:

RetrievalAugmentedGenerationResponseProcessor

public static class RetrievalAugmentedGenerationResponseProcessor.Builder
extends ObjectBuilderBase
implements CopyableBuilder<RetrievalAugmentedGenerationResponseProcessor.Builder,RetrievalAugmentedGenerationResponseProcessor>

Builder for RetrievalAugmentedGenerationResponseProcessor.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
RetrievalAugmentedGenerationResponseProcessor	build()	Builds a RetrievalAugmentedGenerationResponseProcessor.
final RetrievalAugmentedGenerationResponseProcessor.Builder	contextFieldList(String value, String... values)	Required - API name: context_field_list
final RetrievalAugmentedGenerationResponseProcessor.Builder	contextFieldList(List<String> list)	Required - API name: context_field_list
RetrievalAugmentedGenerationResponseProcessor.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final RetrievalAugmentedGenerationResponseProcessor.Builder	description(String value)	API name: description
final RetrievalAugmentedGenerationResponseProcessor.Builder	modelId(String value)	Required - API name: model_id
final RetrievalAugmentedGenerationResponseProcessor.Builder	systemPrompt(String value)	API name: system_prompt
final RetrievalAugmentedGenerationResponseProcessor.Builder	tag(String value)	API name: tag
final RetrievalAugmentedGenerationResponseProcessor.Builder	userInstructions(String value)	API name: user_instructions

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 RetrievalAugmentedGenerationResponseProcessor.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<RetrievalAugmentedGenerationResponseProcessor.Builder,RetrievalAugmentedGenerationResponseProcessor>

Returns:

a new builder instance.

contextFieldList

@Nonnull
public final RetrievalAugmentedGenerationResponseProcessor.Builder contextFieldList(List<String> list)

Required - API name: context_field_list

Adds all elements of list to contextFieldList.

contextFieldList

@Nonnull
public final RetrievalAugmentedGenerationResponseProcessor.Builder contextFieldList(String value,
 String... values)

Required - API name: context_field_list

Adds one or more values to contextFieldList.

description

@Nonnull
public final RetrievalAugmentedGenerationResponseProcessor.Builder description(@Nullable
 String value)

API name: description

modelId

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

Required - API name: model_id

systemPrompt

@Nonnull
public final RetrievalAugmentedGenerationResponseProcessor.Builder systemPrompt(@Nullable
 String value)

API name: system_prompt

tag

@Nonnull
public final RetrievalAugmentedGenerationResponseProcessor.Builder tag(@Nullable
 String value)

API name: tag

userInstructions

@Nonnull
public final RetrievalAugmentedGenerationResponseProcessor.Builder userInstructions(@Nullable
 String value)

API name: user_instructions

build

@Nonnull
public RetrievalAugmentedGenerationResponseProcessor build()

Builds a RetrievalAugmentedGenerationResponseProcessor.

Specified by:

build in interface ObjectBuilder<RetrievalAugmentedGenerationResponseProcessor>

Throws:

NullPointerException - if some of the required fields are null.