Class: Aws::Bedrock::Types::GuardrailPiiEntity

Inherits:

Struct

• Object
• Struct
• Aws::Bedrock::Types::GuardrailPiiEntity

Defined in:

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

Overview

The PII entity configured for the guardrail.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #action ⇒ String

  The configured guardrail action when PII entity is detected.

• #input_action ⇒ String

  The action to take when harmful content is detected in the input.

• #input_enabled ⇒ Boolean

  Indicates whether guardrail evaluation is enabled on the input.

• #output_action ⇒ String

  The action to take when harmful content is detected in the output.

• #output_enabled ⇒ Boolean

  Indicates whether guardrail evaluation is enabled on the output.

• #type ⇒ String

  The type of PII entity.

Instance Attribute Details

#action ⇒ String

The configured guardrail action when PII entity is detected.

Returns:

• (String)

# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 4744

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

#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.

• ANONYMIZE – Mask the content and replace it with identifier tags.

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

Returns:

• (String)

# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 4744

class GuardrailPiiEntity < Struct.new(
  :type,
  :action,
  :input_action,
  :output_action,
  :input_enabled,
  :output_enabled)
  SENSITIVE = []
  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)

# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 4744

class GuardrailPiiEntity < Struct.new(
  :type,
  :action,
  :input_action,
  :output_action,
  :input_enabled,
  :output_enabled)
  SENSITIVE = []
  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.

• ANONYMIZE – Mask the content and replace it with identifier tags.

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

Returns:

• (String)

# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 4744

class GuardrailPiiEntity < Struct.new(
  :type,
  :action,
  :input_action,
  :output_action,
  :input_enabled,
  :output_enabled)
  SENSITIVE = []
  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)

# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 4744

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

#type ⇒ String

The type of PII entity. For example, Social Security Number.

Returns:

• (String)

# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 4744

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