Package org.opensearch.client.opensearch.search_pipeline

Class RetrievalAugmentedGenerationResponseProcessor

java.lang.Object

org.opensearch.client.opensearch.search_pipeline.RetrievalAugmentedGenerationResponseProcessor

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, ResponseProcessorVariant, ToCopyableBuilder<RetrievalAugmentedGenerationResponseProcessor.Builder,RetrievalAugmentedGenerationResponseProcessor>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class RetrievalAugmentedGenerationResponseProcessor
extends Object
implements ResponseProcessorVariant, PlainJsonSerializable, ToCopyableBuilder<RetrievalAugmentedGenerationResponseProcessor.Builder,RetrievalAugmentedGenerationResponseProcessor>

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
ResponseProcessor.Kind	_responseProcessorKind()	ResponseProcessor variant kind.
static RetrievalAugmentedGenerationResponseProcessor.Builder	builder()
final List<String>	contextFieldList()	Required - API name: context_field_list
final String	description()	API name: description
boolean	equals(Object o)
int	hashCode()
final String	modelId()	Required - API name: model_id
static RetrievalAugmentedGenerationResponseProcessor	of(Function<RetrievalAugmentedGenerationResponseProcessor.Builder,ObjectBuilder<RetrievalAugmentedGenerationResponseProcessor>> fn)
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupRetrievalAugmentedGenerationResponseProcessorDeserializer(ObjectDeserializer<RetrievalAugmentedGenerationResponseProcessor.Builder> op)
final String	systemPrompt()	API name: system_prompt
final String	tag()	API name: tag
RetrievalAugmentedGenerationResponseProcessor.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
final String	userInstructions()	API name: user_instructions

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.search_pipeline.ResponseProcessorVariant

toResponseProcessor

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

copy

Field Details

_DESERIALIZER

public static final JsonpDeserializer<RetrievalAugmentedGenerationResponseProcessor> _DESERIALIZER

Json deserializer for RetrievalAugmentedGenerationResponseProcessor

Method Details

of

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

_responseProcessorKind

public ResponseProcessor.Kind _responseProcessorKind()

ResponseProcessor variant kind.

Specified by:

_responseProcessorKind in interface ResponseProcessorVariant

contextFieldList

@Nonnull
public final List<String> contextFieldList()

Required - API name: context_field_list

description

@Nullable
public final String description()

API name: description

modelId

@Nonnull
public final String modelId()

Required - API name: model_id

systemPrompt

@Nullable
public final String systemPrompt()

API name: system_prompt

tag

@Nullable
public final String tag()

API name: tag

userInstructions

@Nullable
public final String userInstructions()

API name: user_instructions

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

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

toBuilder

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

Returns:

a new builder instance.

builder

@Nonnull
public static RetrievalAugmentedGenerationResponseProcessor.Builder builder()

setupRetrievalAugmentedGenerationResponseProcessorDeserializer

protected static void setupRetrievalAugmentedGenerationResponseProcessorDeserializer(ObjectDeserializer<RetrievalAugmentedGenerationResponseProcessor.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object