Class: Aws::Bedrock::Types::GuardrailTopic

Inherits:

Struct

• Object
• Struct
• Aws::Bedrock::Types::GuardrailTopic

Includes:

Structure

Defined in:

lib/aws-sdk-bedrock/types.rb

Overview

Details about topics for the guardrail to identify and deny.

This data type is used in the following API operations:

• GetGuardrail response body][1

^

[1]: docs.aws.amazon.com/bedrock/latest/APIReference/API_GetGuardrail.html#API_GetGuardrail_ResponseSyntax

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:name, :definition, :examples, :input_action, :output_action]

Instance Attribute Summary

• #definition ⇒ String

  A definition of the topic to deny.

• #examples ⇒ Array<String>

  A list of prompts, each of which is an example of a prompt that can be categorized as belonging to the topic.

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

• #name ⇒ String

  The name of the topic to deny.

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

  Specifies to deny the topic.

Instance Attribute Details

#definition ⇒ String

A definition of the topic to deny.

Returns:

• (String)

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

class GuardrailTopic < Struct.new(
  :name,
  :definition,
  :examples,
  :type,
  :input_action,
  :output_action,
  :input_enabled,
  :output_enabled)
  SENSITIVE = [:name, :definition, :examples, :input_action, :output_action]
  include Aws::Structure
end

#examples ⇒ Array<String>

A list of prompts, each of which is an example of a prompt that can be categorized as belonging to the topic.

Returns:

• (Array<String>)

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

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

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

Returns:

• (String)

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

class GuardrailTopic < Struct.new(
  :name,
  :definition,
  :examples,
  :type,
  :input_action,
  :output_action,
  :input_enabled,
  :output_enabled)
  SENSITIVE = [:name, :definition, :examples, :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)

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

class GuardrailTopic < Struct.new(
  :name,
  :definition,
  :examples,
  :type,
  :input_action,
  :output_action,
  :input_enabled,
  :output_enabled)
  SENSITIVE = [:name, :definition, :examples, :input_action, :output_action]
  include Aws::Structure
end

#name ⇒ String

The name of the topic to deny.

Returns:

• (String)

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

class GuardrailTopic < Struct.new(
  :name,
  :definition,
  :examples,
  :type,
  :input_action,
  :output_action,
  :input_enabled,
  :output_enabled)
  SENSITIVE = [:name, :definition, :examples, :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)

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

class GuardrailTopic < Struct.new(
  :name,
  :definition,
  :examples,
  :type,
  :input_action,
  :output_action,
  :input_enabled,
  :output_enabled)
  SENSITIVE = [:name, :definition, :examples, :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)

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

class GuardrailTopic < Struct.new(
  :name,
  :definition,
  :examples,
  :type,
  :input_action,
  :output_action,
  :input_enabled,
  :output_enabled)
  SENSITIVE = [:name, :definition, :examples, :input_action, :output_action]
  include Aws::Structure
end

#type ⇒ String

Specifies to deny the topic.

Returns:

• (String)

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

class GuardrailTopic < Struct.new(
  :name,
  :definition,
  :examples,
  :type,
  :input_action,
  :output_action,
  :input_enabled,
  :output_enabled)
  SENSITIVE = [:name, :definition, :examples, :input_action, :output_action]
  include Aws::Structure
end