Skip to content

RealtimeOutputGuardrail

Extends

Section titled “Extends”
  • OutputGuardrail

Properties

Section titled “Properties”

execute

Section titled “execute”
execute: OutputGuardrailFunction<"text">;

The function that performs the guardrail check.

Inherited from

Section titled “Inherited from”
OutputGuardrail.execute

name

Section titled “name”
name: string;

The name of the guardrail.

Inherited from

Section titled “Inherited from”
OutputGuardrail.name

policyHint?

Section titled “policyHint?”
optional policyHint: string;

This will be passed to the model to inform it about why the guardrail was triggered and to correct the behavior. If it’s not specified the name of your guardrail will be passed instead.