Class CustomPromptInterface

java.lang.Object
software.amazon.awssdk.services.quicksight.model.CustomPromptInterface
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<CustomPromptInterface.Builder,CustomPromptInterface>
@Generated("software.amazon.awssdk:codegen") public final class CustomPromptInterface extends Object implements SdkPojo, Serializable, ToCopyableBuilder<CustomPromptInterface.Builder,CustomPromptInterface>

The custom prompt interface configuration that defines how an agent's prompt is configured.

See Also:

  • Method Details

    • modelProfileId

      public final String modelProfileId()

      The identifier of the model profile.

      Returns:
      The identifier of the model profile.

    • subscriptionId

      public final String subscriptionId()

      The subscription identifier.

      Returns:
      The subscription identifier.

    • qbsAwsAccountId

      public final String qbsAwsAccountId()

      The Amazon Web Services account ID for the Q Business service.

      Returns:
      The Amazon Web Services account ID for the Q Business service.

    • responseLength

      public final String responseLength()

      Instructions for the desired response length.

      Returns:
      Instructions for the desired response length.

    • outputStyle

      public final String outputStyle()

      Instructions for the desired output style.

      Returns:
      Instructions for the desired output style.

    • identity

      public final String identity()

      Instructions that define the agent's identity and persona.

      Returns:
      Instructions that define the agent's identity and persona.

    • tone

      public final String tone()

      Instructions for the desired tone of responses.

      Returns:
      Instructions for the desired tone of responses.

    • customInstructions

      public final String customInstructions()

      Custom instructions for the agent's behavior.

      Returns:
      Custom instructions for the agent's behavior.

    • promptSummary

      public final String promptSummary()

      A summary of the custom prompt configuration.

      Returns:
      A summary of the custom prompt configuration.

    • toBuilder

      public CustomPromptInterface.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<CustomPromptInterface.Builder,CustomPromptInterface>
      Returns:
      a builder for type T

    • builder

      public static CustomPromptInterface.Builder builder()

    • serializableBuilderClass

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