GuardrailTopic

Details about topics for the guardrail to identify and deny.

This data type is used in the following API operations:

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard

A definition of the topic to deny.

Link copied to clipboard

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

Link copied to clipboard

The action to take when harmful content is detected in the input. Supported values include:

Link copied to clipboard

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.

Link copied to clipboard

The name of the topic to deny.

Link copied to clipboard

The action to take when harmful content is detected in the output. Supported values include:

Link copied to clipboard

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.

Link copied to clipboard

Specifies to deny the topic.

Functions

Link copied to clipboard
inline fun copy(block: GuardrailTopic.Builder.() -> Unit = {}): GuardrailTopic
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String