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

Inherits:
Struct
  • Object
show all
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:

Constant Summary collapse

SENSITIVE = 
[:name, :definition, :examples]

Instance Attribute Summary collapse

Instance Attribute Details

#definition ⇒ String

A definition of the topic to deny.

Returns:

  • (String) 


3829
3830
3831
3832
3833
3834
3835
3836
 
# File 'lib/aws-sdk-bedrock/types.rb', line 3829

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


3829
3830
3831
3832
3833
3834
3835
3836
 
# File 'lib/aws-sdk-bedrock/types.rb', line 3829

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

#name ⇒ String

The name of the topic to deny.

Returns:

  • (String) 


3829
3830
3831
3832
3833
3834
3835
3836
 
# File 'lib/aws-sdk-bedrock/types.rb', line 3829

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

#type ⇒ String

Specifies to deny the topic.

Returns:

  • (String) 


3829
3830
3831
3832
3833
3834
3835
3836
 
# File 'lib/aws-sdk-bedrock/types.rb', line 3829

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