Package software.amazon.awssdk.services.bedrockagentcore.model

Class StartBatchEvaluationRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.bedrockagentcore.model.BedrockAgentCoreRequest
software.amazon.awssdk.services.bedrockagentcore.model.StartBatchEvaluationRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<StartBatchEvaluationRequest.Builder,StartBatchEvaluationRequest>
@Generated("software.amazon.awssdk:codegen") public final class StartBatchEvaluationRequest extends BedrockAgentCoreRequest implements ToCopyableBuilder<StartBatchEvaluationRequest.Builder,StartBatchEvaluationRequest>

  • Method Details

    • batchEvaluationName

      public final String batchEvaluationName()

      The name of the batch evaluation. Must be unique within your account.

      Returns:
      The name of the batch evaluation. Must be unique within your account.

    • hasEvaluators

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

    • evaluators

      public final List<Evaluator> evaluators()

      The list of evaluators to apply during the batch evaluation. Can include both built-in evaluators and custom evaluators. Maximum of 10 evaluators.

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

      Returns:
      The list of evaluators to apply during the batch evaluation. Can include both built-in evaluators and custom evaluators. Maximum of 10 evaluators.

    • dataSourceConfig

      public final DataSourceConfig dataSourceConfig()

      The data source configuration that specifies where to pull agent session traces from for evaluation.

      Returns:
      The data source configuration that specifies where to pull agent session traces from for evaluation.

    • clientToken

      public final String clientToken()

      A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, the service ignores the request, but does not return an error.

      Returns:
      A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, the service ignores the request, but does not return an error.

    • evaluationMetadata

      public final EvaluationMetadata evaluationMetadata()

      Optional metadata for the evaluation, including session-specific ground truth data and test scenario identifiers.

      Returns:
      Optional metadata for the evaluation, including session-specific ground truth data and test scenario identifiers.

    • description

      public final String description()

      The description of the batch evaluation.

      Returns:
      The description of the batch evaluation.

    • toBuilder

      public StartBatchEvaluationRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<StartBatchEvaluationRequest.Builder,StartBatchEvaluationRequest>
      Specified by:
      toBuilder in class BedrockAgentCoreRequest

    • builder

      public static StartBatchEvaluationRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends StartBatchEvaluationRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • 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)
      Overrides:
      getValueForField in class SdkRequest

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo