Class: Aws::BedrockAgentCoreControl::Types::CreateEvaluatorRequest

Inherits:

Struct

• Object
• Struct
• Aws::BedrockAgentCoreControl::Types::CreateEvaluatorRequest

Defined in:

gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:description]

Instance Attribute Summary

• #client_token ⇒ String

  A unique, case-sensitive identifier to ensure that the API request completes no more than one time.

• #description ⇒ String

  The description of the evaluator that explains its purpose and evaluation criteria.

• #evaluator_config ⇒ Types::EvaluatorConfig

  The configuration for the evaluator.

• #evaluator_name ⇒ String

  The name of the evaluator.

• #kms_key_arn ⇒ String

  The Amazon Resource Name (ARN) of a customer managed KMS key to use for encrypting sensitive evaluator data, including instructions and rating scale.

• #level ⇒ String

  The evaluation level that determines the scope of evaluation.

• #tags ⇒ Hash<String,String>

  A map of tag keys and values to assign to an AgentCore Evaluator.

Instance Attribute Details

#client_token ⇒ String

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/types.rb', line 2070

class CreateEvaluatorRequest < Struct.new(
  :client_token,
  :evaluator_name,
  :description,
  :evaluator_config,
  :level,
  :kms_key_arn,
  :tags)
  SENSITIVE = [:description]
  include Aws::Structure
end

#description ⇒ String

The description of the evaluator that explains its purpose and evaluation criteria.

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/types.rb', line 2070

class CreateEvaluatorRequest < Struct.new(
  :client_token,
  :evaluator_name,
  :description,
  :evaluator_config,
  :level,
  :kms_key_arn,
  :tags)
  SENSITIVE = [:description]
  include Aws::Structure
end

#evaluator_config ⇒ Types::EvaluatorConfig

The configuration for the evaluator. Specify either LLM-as-a-Judge settings with instructions, rating scale, and model configuration, or code-based settings with a customer-managed Lambda function.

Returns:

• (Types::EvaluatorConfig)

# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/types.rb', line 2070

class CreateEvaluatorRequest < Struct.new(
  :client_token,
  :evaluator_name,
  :description,
  :evaluator_config,
  :level,
  :kms_key_arn,
  :tags)
  SENSITIVE = [:description]
  include Aws::Structure
end

#evaluator_name ⇒ String

The name of the evaluator. Must be unique within your account.

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/types.rb', line 2070

class CreateEvaluatorRequest < Struct.new(
  :client_token,
  :evaluator_name,
  :description,
  :evaluator_config,
  :level,
  :kms_key_arn,
  :tags)
  SENSITIVE = [:description]
  include Aws::Structure
end

#kms_key_arn ⇒ String

The Amazon Resource Name (ARN) of a customer managed KMS key to use for encrypting sensitive evaluator data, including instructions and rating scale. If you don't specify a KMS key, the evaluator data is encrypted with an Amazon Web Services owned key. Only symmetric encryption KMS keys are supported. For more information, see Encryption at rest for AgentCore Evaluations.

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/types.rb', line 2070

class CreateEvaluatorRequest < Struct.new(
  :client_token,
  :evaluator_name,
  :description,
  :evaluator_config,
  :level,
  :kms_key_arn,
  :tags)
  SENSITIVE = [:description]
  include Aws::Structure
end

#level ⇒ String

The evaluation level that determines the scope of evaluation. Valid values are TOOL_CALL for individual tool invocations, TRACE for single request-response interactions, or SESSION for entire conversation sessions.

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/types.rb', line 2070

class CreateEvaluatorRequest < Struct.new(
  :client_token,
  :evaluator_name,
  :description,
  :evaluator_config,
  :level,
  :kms_key_arn,
  :tags)
  SENSITIVE = [:description]
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

A map of tag keys and values to assign to an AgentCore Evaluator. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.

Returns:

• (Hash<String,String>)

# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/types.rb', line 2070

class CreateEvaluatorRequest < Struct.new(
  :client_token,
  :evaluator_name,
  :description,
  :evaluator_config,
  :level,
  :kms_key_arn,
  :tags)
  SENSITIVE = [:description]
  include Aws::Structure
end