Class: Aws::Bedrock::Types::GuardrailWord

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

Overview

A word configured for the guardrail.

See Also:

Constant Summary collapse

SENSITIVE = 
[:input_action, :output_action]

Instance Attribute Summary collapse

Instance Attribute Details

#input_action ⇒ String

The action to take when harmful content is detected in the input. Supported values include:

  • BLOCK – Block the content and replace it with blocked messaging.

  • NONE – Take no action but return detection information in the trace response.

Returns:

  • (String) 


8233
8234
8235
8236
8237
8238
8239
8240
8241
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 8233

class GuardrailWord < Struct.new(
  :text,
  :input_action,
  :output_action,
  :input_enabled,
  :output_enabled)
  SENSITIVE = [:input_action, :output_action]
  include Aws::Structure
end

#input_enabled ⇒ Boolean

Indicates whether guardrail evaluation is enabled on the input. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.

Returns:

  • (Boolean) 


8233
8234
8235
8236
8237
8238
8239
8240
8241
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 8233

class GuardrailWord < Struct.new(
  :text,
  :input_action,
  :output_action,
  :input_enabled,
  :output_enabled)
  SENSITIVE = [:input_action, :output_action]
  include Aws::Structure
end

#output_action ⇒ String

The action to take when harmful content is detected in the output. Supported values include:

  • BLOCK – Block the content and replace it with blocked messaging.

  • NONE – Take no action but return detection information in the trace response.

Returns:

  • (String) 


8233
8234
8235
8236
8237
8238
8239
8240
8241
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 8233

class GuardrailWord < Struct.new(
  :text,
  :input_action,
  :output_action,
  :input_enabled,
  :output_enabled)
  SENSITIVE = [:input_action, :output_action]
  include Aws::Structure
end

#output_enabled ⇒ Boolean

Indicates whether guardrail evaluation is enabled on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.

Returns:

  • (Boolean) 


8233
8234
8235
8236
8237
8238
8239
8240
8241
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 8233

class GuardrailWord < Struct.new(
  :text,
  :input_action,
  :output_action,
  :input_enabled,
  :output_enabled)
  SENSITIVE = [:input_action, :output_action]
  include Aws::Structure
end

#text ⇒ String

Text of the word configured for the guardrail to block.

Returns:

  • (String) 


8233
8234
8235
8236
8237
8238
8239
8240
8241
 
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 8233

class GuardrailWord < Struct.new(
  :text,
  :input_action,
  :output_action,
  :input_enabled,
  :output_enabled)
  SENSITIVE = [:input_action, :output_action]
  include Aws::Structure
end