Class UserTurnResult

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

Contains the results for the user turn by the test execution.

See Also:

  • Method Details

    • input

      public final UserTurnInputSpecification input()

      Contains information about the user messages in the turn in the input.

      Returns:
      Contains information about the user messages in the turn in the input.

    • expectedOutput

      public final UserTurnOutputSpecification expectedOutput()

      Contains information about the expected output for the user turn.

      Returns:
      Contains information about the expected output for the user turn.

    • actualOutput

      public final UserTurnOutputSpecification actualOutput()

      Contains information about the actual output for the user turn.

      Returns:
      Contains information about the actual output for the user turn.

    • errorDetails

      public final ExecutionErrorDetails errorDetails()
      Returns the value of the ErrorDetails property for this object.
      Returns:
      The value of the ErrorDetails property for this object.

    • endToEndResult

      public final TestResultMatchStatus endToEndResult()

      Specifies whether the expected and actual outputs match or not, or if there is an error in execution.

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

      Returns:
      Specifies whether the expected and actual outputs match or not, or if there is an error in execution.
      See Also:

    • endToEndResultAsString

      public final String endToEndResultAsString()

      Specifies whether the expected and actual outputs match or not, or if there is an error in execution.

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

      Returns:
      Specifies whether the expected and actual outputs match or not, or if there is an error in execution.
      See Also:

    • intentMatchResult

      public final TestResultMatchStatus intentMatchResult()

      Specifies whether the expected and actual intents match or not.

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

      Returns:
      Specifies whether the expected and actual intents match or not.
      See Also:

    • intentMatchResultAsString

      public final String intentMatchResultAsString()

      Specifies whether the expected and actual intents match or not.

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

      Returns:
      Specifies whether the expected and actual intents match or not.
      See Also:

    • slotMatchResult

      public final TestResultMatchStatus slotMatchResult()

      Specifies whether the expected and actual slots match or not.

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

      Returns:
      Specifies whether the expected and actual slots match or not.
      See Also:

    • slotMatchResultAsString

      public final String slotMatchResultAsString()

      Specifies whether the expected and actual slots match or not.

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

      Returns:
      Specifies whether the expected and actual slots match or not.
      See Also:

    • speechTranscriptionResult

      public final TestResultMatchStatus speechTranscriptionResult()

      Specifies whether the expected and actual speech transcriptions match or not, or if there is an error in execution.

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

      Returns:
      Specifies whether the expected and actual speech transcriptions match or not, or if there is an error in execution.
      See Also:

    • speechTranscriptionResultAsString

      public final String speechTranscriptionResultAsString()

      Specifies whether the expected and actual speech transcriptions match or not, or if there is an error in execution.

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

      Returns:
      Specifies whether the expected and actual speech transcriptions match or not, or if there is an error in execution.
      See Also:

    • conversationLevelResult

      public final ConversationLevelResultDetail conversationLevelResult()

      Contains information about the results related to the conversation associated with the user turn.

      Returns:
      Contains information about the results related to the conversation associated with the user turn.

    • toBuilder

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

    • builder

      public static UserTurnResult.Builder builder()

    • serializableBuilderClass

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