Class: Aws::Bedrock::Types::GuardrailContextualGroundingFilter

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

Overview

The details for the guardrails contextual grounding filter.

Constant Summary collapse

SENSITIVE =
[:action]

Instance Attribute Summary collapse

Instance Attribute Details

#action ⇒ String

The action to take when content fails the contextual grounding evaluation. 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)


8372
8373
8374
8375
8376
8377
8378
8379
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 8372

class GuardrailContextualGroundingFilter < Struct.new(
  :type,
  :threshold,
  :action,
  :enabled)
  SENSITIVE = [:action]
  include Aws::Structure
end

#enabled ⇒ Boolean

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

Returns:

  • (Boolean)


8372
8373
8374
8375
8376
8377
8378
8379
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 8372

class GuardrailContextualGroundingFilter < Struct.new(
  :type,
  :threshold,
  :action,
  :enabled)
  SENSITIVE = [:action]
  include Aws::Structure
end

#threshold ⇒ Float

The threshold details for the guardrails contextual grounding filter.

Returns:

  • (Float)


8372
8373
8374
8375
8376
8377
8378
8379
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 8372

class GuardrailContextualGroundingFilter < Struct.new(
  :type,
  :threshold,
  :action,
  :enabled)
  SENSITIVE = [:action]
  include Aws::Structure
end

#type ⇒ String

The filter type details for the guardrails contextual grounding filter.

Returns:

  • (String)


8372
8373
8374
8375
8376
8377
8378
8379
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 8372

class GuardrailContextualGroundingFilter < Struct.new(
  :type,
  :threshold,
  :action,
  :enabled)
  SENSITIVE = [:action]
  include Aws::Structure
end