Package org.apache.nlpcraft.model

Contains main API for defining data models.

Interface Summary

Interface	Description
NCCompany	Descriptor of the user company.
NCContext	Data model query context.
NCConversation	Conversation container for specific user and data model.
NCCustomElement	Detected model element returning from custom parser.
NCCustomParser	Custom model element parser for programmatic NER implementations.
NCCustomWord	A partially enriched token with a basic set of NLP properties used by custom NER parser.
NCDialogFlowItem	An item of the dialog flow.
NCElement	Data model element.
NCIntentMatch	An intent match context that can be passed into the callback of the matched intent.
NCLifecycle	Lifecycle component.
NCMetadata	Provides support for mutable runtime-only metadata.
NCModel	User-defined data model.
NCModelFactory	Optional factory for data models.
NCModelView	Read-only view on data model.
NCRequest	Information about the user request.
NCToken	Detected model element.
NCTokenPredicateContext	Context passed into custom user-defined IDL term token predicate.
NCUser	Descriptor of the user.
NCValue	Model element's value.
NCValueLoader	Dynamic value loader that can be used by model elements to dynamically load or create their values.
NCVariant	A parsing variant is a list of tokens representing one possible parsing variant of the user input.

Class Summary

Class	Description
NCMacroProcessor	Standalone synonym macro DSL processor.
NCModelAdapter	Adapter for data models.
NCModelFileAdapter	Adapter for data models that can load model configuration from external JSON/YAML file.
NCResult	Data model result returned from model intent callbacks.
NCTokenPredicateResult	Result value of user-defined IDL term token predicate.

Exception Summary

Exception	Description
NCIntentSkip	Control flow exception to skip current intent.
NCRejection	Exception to indicate that user input cannot be processed as is.

Annotation Types Summary

Annotation Type	Description
NCIntent	Annotation to bind an intent with the method serving as its callback.
NCIntent.NCIntentList	Grouping annotation required for when more than one NCIntent annotation is used.
NCIntentRef	Annotation referencing an intent defined outside of callback method declaration.
NCIntentRef.NCIntentRefList	Grouping annotation required for when more than one NCIntentRef annotation is used.
NCIntentSample	Annotation to define samples of the user input that should match an intent.
NCIntentSample.NCIntentSampleList	Grouping annotation required for when more than one NCIntentSample annotation is used.
NCIntentSampleRef	Annotation to define samples of the user input that should match an intent.
NCIntentSampleRef.NCIntentSampleList	Grouping annotation required for when more than one NCIntentSampleRef annotation is used.
NCIntentTerm	Annotation to mark callback parameter to receive intent term's tokens.