Determines how to do aggregation by key for summary reporting.
Defaults to AggregationType.Sum.
Determines how to do aggregation by recommendationKey for summary reporting.
Defaults to AggregationType.Sum.
Customize how the attributed value is rendered in the Andi Skills Manager.
Use the token {{value}} to represent the formatted attribution value.
For example, Increase of {{value}} would render as "Increase of $18,222.22" if total attribution was 18222.22.
Defaults to: '{{value}}'
If this outcome is met, what sort of credit does the skill get?
This attribution should make sense related to outcome name and description.
Additionally, summary reporting will be rolled-up by key and recommendationKey (if it exists).
Formatting options for how to display attribution value.
Defaults to { "maximumFractionDigits": 2 }.
A determination if the defined outcome behavior has been met or not. This can be set to true on creation or will
be updated based on described user engagement with the skill.
Will be set to true if behaviorType is Behavior.NotApplicable.
Defaults to false.
Desired user behavior for the outcome. Can set to Behavior.NotApplicable if user behavior is
not required for the outcome to be met.
Defaults to Behavior.Viewed.
Sentence or two giving more context on the outcome; this may be displayed to users in Andi Skills Manager
Unique identifier associated with a target of the outcome Used with name to track a specific outcome throughout events
Name of outcome. Should be considered unique for the skill version; this may be displayed to users in Andi Skills Manager
Additional data used to evaluate value criteria or better understand specific outcomes.
A key representing a unique recommendation across skill runs for a given key.
Defaults to empty string if no additional partitioning is required.
A determination if the skill has met value criteria. This criteria is determined by the skill itself. Outcome summary reporting will report on outcomes where both value and behavior criteria have been met.
Generated using TypeDoc
Declare a potential outcome for a skill. Outcomes are generally defined as a desired user behavior and/or achievement of some value related to skill coaching. This can be as simple as accepting a skill recommendation or sending an email. The outcome definition allows for the description of a complete outcome along with metadata on how it should be summarized.