Class GuardrailTopic
Information about a topic guardrail.
Inherited Members
Namespace: Glitch9.AIDevKit.AmazonAws
Assembly: Glitch9.AIDevKit.Provider.AmazonAws.dll
Syntax
public class GuardrailTopic
Properties
| Edit this page View SourceDefinition
Required. A definition of the topic to deny.
Declaration
[JsonProperty("definition")]
public string Definition { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
Examples
Optional. A list of prompts, each of which is an example of a prompt that can be categorized as belonging to the topic.
Declaration
[JsonProperty("examples")]
public string[] Examples { get; set; }
Property Value
| Type | Description |
|---|---|
| string[] |
InputAction
Optional. The action to take when harmful content is detected in the input. Valid Values: BLOCK | NONE
Declaration
[JsonProperty("inputAction")]
public string InputAction { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
InputEnabled
Optional. Indicates whether guardrail evaluation is enabled on the input.
Declaration
[JsonProperty("inputEnabled")]
public bool? InputEnabled { get; set; }
Property Value
| Type | Description |
|---|---|
| bool? |
Name
Required. The name of the topic to deny.
Declaration
[JsonProperty("name")]
public string Name { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
OutputAction
Optional. The action to take when harmful content is detected in the output. Valid Values: BLOCK | NONE
Declaration
[JsonProperty("outputAction")]
public string OutputAction { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
OutputEnabled
Optional. Indicates whether guardrail evaluation is enabled on the output.
Declaration
[JsonProperty("outputEnabled")]
public bool? OutputEnabled { get; set; }
Property Value
| Type | Description |
|---|---|
| bool? |
Type
Optional. Specifies to deny the topic. Valid Value: DENY
Declaration
[JsonProperty("type")]
public string Type { get; set; }
Property Value
| Type | Description |
|---|---|
| string |