Class: Aws::BedrockAgentCore::Types::EvaluationResultContent

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb

Overview

The comprehensive result of an evaluation containing the score, explanation, evaluator metadata, and execution details. Provides both quantitative ratings and qualitative insights about agent performance.

See Also:

Constant Summary collapse

SENSITIVE = 
[:explanation]

Instance Attribute Summary collapse

Instance Attribute Details

#context ⇒ Types::Context

The contextual information associated with this evaluation result, including span context details that identify the specific traces and sessions that were evaluated.

Returns:



876
877
878
879
880
881
882
883
884
885
886
887
888
889
 
# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 876

class EvaluationResultContent < Struct.new(
  :evaluator_arn,
  :evaluator_id,
  :evaluator_name,
  :explanation,
  :context,
  :value,
  :label,
  :token_usage,
  :error_message,
  :error_code)
  SENSITIVE = [:explanation]
  include Aws::Structure
end

#error_code ⇒ String

The error code indicating the type of failure that occurred during evaluation. Used to programmatically identify and handle different categories of evaluation errors.

Returns:

  • (String) 


876
877
878
879
880
881
882
883
884
885
886
887
888
889
 
# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 876

class EvaluationResultContent < Struct.new(
  :evaluator_arn,
  :evaluator_id,
  :evaluator_name,
  :explanation,
  :context,
  :value,
  :label,
  :token_usage,
  :error_message,
  :error_code)
  SENSITIVE = [:explanation]
  include Aws::Structure
end

#error_message ⇒ String

The error message describing what went wrong if the evaluation failed. Provides detailed information about evaluation failures to help diagnose and resolve issues with evaluator configuration or input data.

Returns:

  • (String) 


876
877
878
879
880
881
882
883
884
885
886
887
888
889
 
# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 876

class EvaluationResultContent < Struct.new(
  :evaluator_arn,
  :evaluator_id,
  :evaluator_name,
  :explanation,
  :context,
  :value,
  :label,
  :token_usage,
  :error_message,
  :error_code)
  SENSITIVE = [:explanation]
  include Aws::Structure
end

#evaluator_arn ⇒ String

The Amazon Resource Name (ARN) of the evaluator used to generate this result. For custom evaluators, this is the full ARN; for built-in evaluators, this follows the pattern Builtin.{EvaluatorName}.

Returns:

  • (String) 


876
877
878
879
880
881
882
883
884
885
886
887
888
889
 
# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 876

class EvaluationResultContent < Struct.new(
  :evaluator_arn,
  :evaluator_id,
  :evaluator_name,
  :explanation,
  :context,
  :value,
  :label,
  :token_usage,
  :error_message,
  :error_code)
  SENSITIVE = [:explanation]
  include Aws::Structure
end

#evaluator_id ⇒ String

The unique identifier of the evaluator that produced this result. This matches the evaluatorId provided in the evaluation request and can be used to identify which evaluator generated specific results.

Returns:

  • (String) 


876
877
878
879
880
881
882
883
884
885
886
887
888
889
 
# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 876

class EvaluationResultContent < Struct.new(
  :evaluator_arn,
  :evaluator_id,
  :evaluator_name,
  :explanation,
  :context,
  :value,
  :label,
  :token_usage,
  :error_message,
  :error_code)
  SENSITIVE = [:explanation]
  include Aws::Structure
end

#evaluator_name ⇒ String

The human-readable name of the evaluator used for this evaluation. For built-in evaluators, this is the descriptive name (e.g., "Helpfulness", "Correctness"); for custom evaluators, this is the user-defined name.

Returns:

  • (String) 


876
877
878
879
880
881
882
883
884
885
886
887
888
889
 
# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 876

class EvaluationResultContent < Struct.new(
  :evaluator_arn,
  :evaluator_id,
  :evaluator_name,
  :explanation,
  :context,
  :value,
  :label,
  :token_usage,
  :error_message,
  :error_code)
  SENSITIVE = [:explanation]
  include Aws::Structure
end

#explanation ⇒ String

The detailed explanation provided by the evaluator describing the reasoning behind the assigned score. This qualitative feedback helps understand why specific ratings were given and provides actionable insights for improvement.

Returns:

  • (String) 


876
877
878
879
880
881
882
883
884
885
886
887
888
889
 
# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 876

class EvaluationResultContent < Struct.new(
  :evaluator_arn,
  :evaluator_id,
  :evaluator_name,
  :explanation,
  :context,
  :value,
  :label,
  :token_usage,
  :error_message,
  :error_code)
  SENSITIVE = [:explanation]
  include Aws::Structure
end

#label ⇒ String

The categorical label assigned by the evaluator when using a categorical rating scale. This provides a human-readable description of the evaluation result (e.g., "Excellent", "Good", "Poor") corresponding to the numerical value. For numerical scales, this field is optional and provides a natural language explanation of what the value means (e.g., value 0.5 = "Somewhat Helpful").

Returns:

  • (String) 


876
877
878
879
880
881
882
883
884
885
886
887
888
889
 
# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 876

class EvaluationResultContent < Struct.new(
  :evaluator_arn,
  :evaluator_id,
  :evaluator_name,
  :explanation,
  :context,
  :value,
  :label,
  :token_usage,
  :error_message,
  :error_code)
  SENSITIVE = [:explanation]
  include Aws::Structure
end

#token_usage ⇒ Types::TokenUsage

The token consumption statistics for this evaluation, including input tokens, output tokens, and total tokens used by the underlying language model during the evaluation process.

Returns:



876
877
878
879
880
881
882
883
884
885
886
887
888
889
 
# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 876

class EvaluationResultContent < Struct.new(
  :evaluator_arn,
  :evaluator_id,
  :evaluator_name,
  :explanation,
  :context,
  :value,
  :label,
  :token_usage,
  :error_message,
  :error_code)
  SENSITIVE = [:explanation]
  include Aws::Structure
end

#value ⇒ Float

The numerical score assigned by the evaluator according to its configured rating scale. For numerical scales, this is a decimal value within the defined range. This field is not allowed for categorical scales.

Returns:

  • (Float) 


876
877
878
879
880
881
882
883
884
885
886
887
888
889
 
# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 876

class EvaluationResultContent < Struct.new(
  :evaluator_arn,
  :evaluator_id,
  :evaluator_name,
  :explanation,
  :context,
  :value,
  :label,
  :token_usage,
  :error_message,
  :error_code)
  SENSITIVE = [:explanation]
  include Aws::Structure
end