Package akka.javasdk.agent

Record Class Guardrail.Result

Object
Record
akka.javasdk.agent.Guardrail.Result
Record Components:
passed - true if the text passed the guardrail evaluation
explanation - reason for the decision, especially when it didn't pass
Enclosing interface:
Guardrail
@Deprecated(since="3.6.0", forRemoval=true) public static record Guardrail.Result(boolean passed, String explanation) extends Record
Deprecated, for removal: This API element is subject to removal in a future version.
Use Decision from ToolCallGuardrail, ModelCallGuardrail or AgentResponseGuardrail.
The result of the guardrail evaluation.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final Guardrail.Result
    OK
    Deprecated, for removal: This API element is subject to removal in a future version.
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    Result(boolean passed, String explanation)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Creates an instance of a Result record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Indicates whether some other object is "equal to" this one.
    String
    explanation()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the value of the explanation record component.
    final int
    hashCode()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns a hash code value for this object.
    boolean
    passed()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the value of the passed record component.
    final String
    toString()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Field Details

    • OK

      public static final Guardrail.Result OK
      Deprecated, for removal: This API element is subject to removal in a future version.

  • Constructor Details

    • Result

      public Result(boolean passed, String explanation)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Creates an instance of a Result record class.
      Parameters:
      passed - the value for the passed record component
      explanation - the value for the explanation record component

  • Method Details

    • toString

      public final String toString()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • passed

      public boolean passed()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns the value of the passed record component.
      Returns:
      the value of the passed record component

    • explanation

      public String explanation()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns the value of the explanation record component.
      Returns:
      the value of the explanation record component