AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Details about topics for the guardrail to identify and deny.

This data type is used in the following API operations:

Inheritance Hierarchy

System.Object
  Amazon.Bedrock.Model.GuardrailTopic

Namespace: Amazon.Bedrock.Model
Assembly: AWSSDK.Bedrock.dll
Version: 3.x.y.z

Syntax

C# 
public class GuardrailTopic

The GuardrailTopic type exposes the following members

Constructors

NameDescription
Public Method GuardrailTopic()

Properties

NameTypeDescription
Public Property Definition System.String

Gets and sets the property Definition.

A definition of the topic to deny.

Public Property Examples System.Collections.Generic.List<System.String>

Gets and sets the property Examples.

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

Public Property InputAction Amazon.Bedrock.GuardrailTopicAction

Gets and sets the property InputAction.

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.

Public Property InputEnabled System.Boolean

Gets and sets the property InputEnabled.

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.

Public Property Name System.String

Gets and sets the property Name.

The name of the topic to deny.

Public Property OutputAction Amazon.Bedrock.GuardrailTopicAction

Gets and sets the property OutputAction.

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.

Public Property OutputEnabled System.Boolean

Gets and sets the property OutputEnabled.

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.

Public Property Type Amazon.Bedrock.GuardrailTopicType

Gets and sets the property Type.

Specifies to deny the topic.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5