Package akka.javasdk.agent

Class ModelCallSimilarityGuard

Object

akka.javasdk.agent.ModelCallSimilarityGuard

All Implemented Interfaces:

Guardrail, ModelCallGuardrail

public final class ModelCallSimilarityGuard
extends Object
implements ModelCallGuardrail

Built-in ModelCallGuardrail. Denies a model call when a user message or tool result matches a "bad example" at or above the threshold.

Its config must not define use-for.

Nested Class Summary

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

Guardrail.GuardrailException, Guardrail.Message, Guardrail.Result

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

ModelCallGuardrail.CallContext

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Decision	decide(ModelCallGuardrail.CallContext ctx)	Not supported.
CompletionStage<Decision>	decideAsync(ModelCallGuardrail.CallContext ctx)	Not supported.

Methods inherited from class java.lang.Object

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

Constructor Details

ModelCallSimilarityGuard

public ModelCallSimilarityGuard(GuardrailContext context)

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

Throws:

IllegalArgumentException - if threshold is not in (0, 1], or if bad-examples-resource-dir is not on the classpath

Method Details

decide

public Decision decide(ModelCallGuardrail.CallContext ctx)

Not supported. Throws IllegalStateException.

Specified by:

decide in interface ModelCallGuardrail

Returns:

the decision

decideAsync

public CompletionStage<Decision> decideAsync(ModelCallGuardrail.CallContext ctx)

Not supported. Throws IllegalStateException.

Specified by:

decideAsync in interface ModelCallGuardrail

Returns:

a CompletionStage with the decision