Class ChatPromptTemplateConfiguration

java.lang.Object
software.amazon.awssdk.services.bedrockagent.model.ChatPromptTemplateConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ChatPromptTemplateConfiguration.Builder,ChatPromptTemplateConfiguration>

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

Contains configurations to use a prompt in a conversational format. For more information, see Create a prompt using Prompt management.

See Also:
  • Method Details

    • hasInputVariables

      public final boolean hasInputVariables()
      For responses, this returns true if the service returned a value for the InputVariables 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.
    • inputVariables

      public final List<PromptInputVariable> inputVariables()

      An array of the variables in the prompt template.

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

      Returns:
      An array of the variables in the prompt template.
    • hasMessages

      public final boolean hasMessages()
      For responses, this returns true if the service returned a value for the Messages 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.
    • messages

      public final List<Message> messages()

      Contains messages in the chat for the prompt.

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

      Returns:
      Contains messages in the chat for the prompt.
    • hasSystem

      public final boolean hasSystem()
      For responses, this returns true if the service returned a value for the System 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.
    • system

      public final List<SystemContentBlock> system()

      Contains system prompts to provide context to the model or to describe how it should behave.

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

      Returns:
      Contains system prompts to provide context to the model or to describe how it should behave.
    • toolConfiguration

      public final ToolConfiguration toolConfiguration()

      Configuration information for the tools that the model can use when generating a response.

      Returns:
      Configuration information for the tools that the model can use when generating a response.
    • 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<ChatPromptTemplateConfiguration.Builder,ChatPromptTemplateConfiguration>
      Returns:
      a builder for type T
    • builder

      public static ChatPromptTemplateConfiguration.Builder builder()
    • serializableBuilderClass

      public static Class<? extends ChatPromptTemplateConfiguration.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.
    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.