Class PromptOverrideConfiguration

java.lang.Object
software.amazon.awssdk.services.bedrockagent.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:

  • Method Details

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<PromptOverrideConfiguration.Builder,PromptOverrideConfiguration>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.