Package org.apache.nlpcraft.model

Annotation Type NCIntentSample

@Retention(RUNTIME)
@Target(METHOD)
@Repeatable(NCIntentSampleList.class)
public @interface NCIntentSample

Annotation to define one or more samples of the user input that should match a corresponding intent. This annotation can only be used together with NCIntent or NCIntentRef annotations on the callback methods. Method can have multiple annotations of this type and each annotation can define multiple input examples.

Note that the samples provided by this annotation not only serve the documentation purpose but are also used by NCTestAutoModelValidator class from built-in test framework for auto-validation between data models and intents.

Read full documentation in Intent Matching section and review examples.

See Also:

NCIntent, NCIntentRef, NCIntentTerm, NCIntentSkip, NCIntentMatch, NCModel.onMatchedIntent(NCIntentMatch), NCTestAutoModelValidator

Required Element Summary

Required Elements

Modifier and Type	Required Element	Description
String[]	value	Gets a list of user input samples that should match corresponding intent.

Element Detail

value

String[] value

Gets a list of user input samples that should match corresponding intent. This annotation should be attached the intent callback method.

Returns:

Set of user input examples that should match corresponding intent.