AchievesGoal

All Implemented Interfaces:

java.lang.annotation.Annotation
```
@Target(value = ElementType.METHOD)@Retention(value = RetentionPolicy.RUNTIME)@Documented() 
public @interface 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.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`abstract String`	`description()`	Description of the goal.
`abstract double`	`value()`	Value of achieving the goal
`abstract Array<String>`	`tags()`	Set of tags describing classes or capabilities for this goal.
`abstract Array<String>`	`examples()`	Set of example scenarios that the goal can achieve.
`abstract Export`	`export()`	How the goal should be exported as a tool Tools will not be exposed remotely by default

Methods inherited from class java.lang.annotation.Annotation
annotationType, equals, hashCode, toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - description
```
 abstract String description()
```
    Description of the goal. Take care in writing this description as it will be used to choose a goal based on user input.
  - value
```
 abstract double value()
```
    Value of achieving the goal
  - tags
```
 abstract Array<String> tags()
```
    Set of tags describing classes or capabilities for this goal. Example: ["cooking", "customer support", "billing"]
  - examples
```
 abstract Array<String> examples()
```
    Set of example scenarios that the goal can achieve. Example: ["I need a recipe for bread", "I want to support a customer with a billing issue"]
  - export
```
 abstract Export export()
```
    How the goal should be exported as a tool Tools will not be exposed remotely by default