Package software.amazon.awssdk.services.bedrock.model

Class GenerationConfiguration

java.lang.Object

software.amazon.awssdk.services.bedrock.model.GenerationConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<GenerationConfiguration.Builder,GenerationConfiguration>

@Generated("software.amazon.awssdk:codegen")
public final class GenerationConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<GenerationConfiguration.Builder,GenerationConfiguration>

The configuration details for response generation based on retrieved text chunks.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GenerationConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
Map<String,Document>	additionalModelRequestFields()	Additional model parameters and corresponding values not included in the textInferenceConfig structure for a knowledge base.
static GenerationConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
GuardrailConfiguration	guardrailConfiguration()	Contains configuration details for the guardrail.
boolean	hasAdditionalModelRequestFields()	For responses, this returns true if the service returned a value for the AdditionalModelRequestFields property.
int	hashCode()
KbInferenceConfig	kbInferenceConfig()	Contains configuration details for inference for knowledge base retrieval and response generation.
PromptTemplate	promptTemplate()	Contains the template for the prompt that's sent to the model for response generation.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends GenerationConfiguration.Builder>	serializableBuilderClass()
GenerationConfiguration.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

promptTemplate

public final PromptTemplate promptTemplate()

Contains the template for the prompt that's sent to the model for response generation.

Returns:

Contains the template for the prompt that's sent to the model for response generation.

guardrailConfiguration

public final GuardrailConfiguration guardrailConfiguration()

Contains configuration details for the guardrail.

Returns:

Contains configuration details for the guardrail.

kbInferenceConfig

public final KbInferenceConfig kbInferenceConfig()

Contains configuration details for inference for knowledge base retrieval and response generation.

Returns:

Contains configuration details for inference for knowledge base retrieval and response generation.

hasAdditionalModelRequestFields

public final boolean hasAdditionalModelRequestFields()

For responses, this returns true if the service returned a value for the AdditionalModelRequestFields property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

additionalModelRequestFields

public final Map<String,Document> additionalModelRequestFields()

Additional model parameters and corresponding values not included in the textInferenceConfig structure for a knowledge base. This allows you to provide custom model parameters specific to the language model being used.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAdditionalModelRequestFields() method.

Returns:

Additional model parameters and corresponding values not included in the textInferenceConfig structure for a knowledge base. This allows you to provide custom model parameters specific to the language model being used.

toBuilder

public GenerationConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GenerationConfiguration.Builder,GenerationConfiguration>

builder

public static GenerationConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends GenerationConfiguration.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo