Embabel Agent Documentation/com.embabel.agent.api.annotation/AchievesGoal

AchievesGoal

@Target(value = ElementType.METHOD)
@Retention(value = RetentionPolicy.RUNTIME)
@Documented
annotation class AchievesGoal

Annotation that can be added to an @Action method to indicate that its execution achieves a goal See com.embabel.agent.core.Goal for more details. A Goal object will be created for each method annotated with this annotation.

Functions

Link copied to clipboard
abstract fun annotationType(): Class<out Annotation>
Link copied to clipboard
abstract fun description(): String
Description of the goal.
Link copied to clipboard
abstract fun equals(p: Any): Boolean
Link copied to clipboard
abstract fun examples(): Array<String>
Set of example scenarios that the goal can achieve.
Link copied to clipboard
abstract fun export(): Export
How the goal should be exported as a tool Tools will not be exposed remotely by default
Link copied to clipboard
abstract fun hashCode(): Int
Link copied to clipboard
abstract fun tags(): Array<String>
Set of tags describing classes or capabilities for this goal.
Link copied to clipboard
abstract fun toString(): String
Link copied to clipboard
abstract fun value(): Double
Value of achieving the goal