Package akka.javasdk.agent

Class SimilarityGuard

Object

akka.javasdk.agent.SimilarityGuard

All Implemented Interfaces:

Guardrail, TextGuardrail

public final class SimilarityGuard
extends Object
implements TextGuardrail

The SimilarityGuard evaluates the text by making a similarity search in a dataset of "bad examples". If the similarity exceeds a threshold, the result is flagged as blocked.

Nested Class Summary

Nested classes/interfaces inherited from interface akka.javasdk.agent.Guardrail

Guardrail.GuardrailException, Guardrail.Result

Constructor Summary

Constructors

Constructor	Description
SimilarityGuard(GuardrailContext context)	Reads bad-examples-resource-dir and threshold from the guardrail's config.

Method Summary

Modifier and Type	Method	Description
String	badExamplesResourceDir()	The classpath resource directory holding the "bad examples" dataset.
Guardrail.Result	evaluate(String text)	Evaluates if the text passes the guardrail or not.
double	threshold()	The similarity score above which text is flagged as blocked.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SimilarityGuard

public SimilarityGuard(GuardrailContext context)

Reads bad-examples-resource-dir and threshold from the guardrail's config.

Method Details

threshold

public double threshold()

The similarity score above which text is flagged as blocked.

badExamplesResourceDir

public String badExamplesResourceDir()

The classpath resource directory holding the "bad examples" dataset.

evaluate

public Guardrail.Result evaluate(String text)

Description copied from interface: TextGuardrail

Evaluates if the text passes the guardrail or not.

Specified by:

evaluate in interface TextGuardrail