Record Class ResultWithAgenticScope<T>

java.lang.Object
java.lang.Record
dev.langchain4j.agentic.scope.ResultWithAgenticScope<T>
Type Parameters:
T - The type of the result.
public record ResultWithAgenticScope<T>(AgenticScope agenticScope, T result) extends Record
Holds the result of an agent invocation along with its associated AgenticScope. This is useful for returning results from agents while also providing access to the cognitive scope through which that result has been generated.

  • Constructor Details

    • ResultWithAgenticScope

      public ResultWithAgenticScope(AgenticScope agenticScope, T result)
      Creates an instance of a ResultWithAgenticScope record class.
      Parameters:
      agenticScope - the value for the agenticScope record component
      result - the value for the result record component

  • Method Details

    • toString

      public final String toString()
      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()
      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)
      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. All components in this record class are compared with Objects::equals(Object,Object).
      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.

    • agenticScope

      public AgenticScope agenticScope()
      Returns the value of the agenticScope record component.
      Returns:
      the value of the agenticScope record component

    • result

      public T result()
      Returns the value of the result record component.
      Returns:
      the value of the result record component