Package software.amazon.awssdk.services.bedrockagent.model

Class PromptVariant

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

Contains details about a variant of the prompt.

See Also:

  • Method Details

    • inferenceConfiguration

      public final PromptInferenceConfiguration inferenceConfiguration()

      Contains inference configurations for the prompt variant.

      Returns:
      Contains inference configurations for the prompt variant.

    • modelId

      public final String modelId()

      The unique identifier of the model with which to run inference on the prompt.

      Returns:
      The unique identifier of the model with which to run inference on the prompt.

    • name

      public final String name()

      The name of the prompt variant.

      Returns:
      The name of the prompt variant.

    • templateConfiguration

      public final PromptTemplateConfiguration templateConfiguration()

      Contains configurations for the prompt template.

      Returns:
      Contains configurations for the prompt template.

    • templateType

      public final PromptTemplateType templateType()

      The type of prompt template to use.

      If the service returns an enum value that is not available in the current SDK version, templateType will return PromptTemplateType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from templateTypeAsString().

      Returns:
      The type of prompt template to use.
      See Also:

    • templateTypeAsString

      public final String templateTypeAsString()

      The type of prompt template to use.

      If the service returns an enum value that is not available in the current SDK version, templateType will return PromptTemplateType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from templateTypeAsString().

      Returns:
      The type of prompt template to use.
      See Also:

    • toBuilder

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

    • builder

      public static PromptVariant.Builder builder()

    • serializableBuilderClass

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