Package software.amazon.awssdk.services.bedrockagentruntime.model

Class PromptOverrideConfiguration

java.lang.Object

software.amazon.awssdk.services.bedrockagentruntime.model.PromptOverrideConfiguration

All Implemented Interfaces:

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

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

Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PromptOverrideConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static PromptOverrideConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasPromptConfigurations()	For responses, this returns true if the service returned a value for the PromptConfigurations property.
String	overrideLambda()	The ARN of the Lambda function to use when parsing the raw foundation model output in parts of the agent sequence.
List<PromptConfiguration>	promptConfigurations()	Contains configurations to override a prompt template in one part of an agent sequence.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends PromptOverrideConfiguration.Builder>	serializableBuilderClass()
PromptOverrideConfiguration.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

overrideLambda

public final String overrideLambda()

The ARN of the Lambda function to use when parsing the raw foundation model output in parts of the agent sequence. If you specify this field, at least one of the promptConfigurations must contain a parserMode value that is set to OVERRIDDEN. For more information, see Parser Lambda function in Amazon Bedrock Agents.

Returns:

The ARN of the Lambda function to use when parsing the raw foundation model output in parts of the agent sequence. If you specify this field, at least one of the promptConfigurations must contain a parserMode value that is set to OVERRIDDEN. For more information, see Parser Lambda function in Amazon Bedrock Agents.

hasPromptConfigurations

public final boolean hasPromptConfigurations()

For responses, this returns true if the service returned a value for the PromptConfigurations 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.

promptConfigurations

public final List<PromptConfiguration> promptConfigurations()

Contains configurations to override a prompt template in one part of an agent sequence. For more information, see Advanced prompts.

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 hasPromptConfigurations() method.

Returns:

Contains configurations to override a prompt template in one part of an agent sequence. For more information, see Advanced prompts.

toBuilder

public PromptOverrideConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PromptOverrideConfiguration.Builder,PromptOverrideConfiguration>

builder

public static PromptOverrideConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends PromptOverrideConfiguration.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