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.
NCElement	Data model element.
NCIntentMatch	An intent match context that can be passed into the callback of the matched intent.
NCLifecycle	NLPCraft lifecycle component.
NCMetadata	Provides support for map-based metadata.
NCModel	User-defined semantic data model.
NCModelFactory	Optional factory for data models.
NCModelView	Read-only view on data model.
NCRequest	Supplemental information about the user request.
NCToken	Detected model element.
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 list of tokens representing one possible parsing variant of the user input.

Class Summary

Class	Description
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.

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 define an intent on the method serving as its callback.
NCIntentRef	Annotations referencing an intent defined externally in JSON or YAML model declaration.
NCIntentSample	Annotation to define one or more samples of the user input that should match a corresponding intent.
NCIntentSample.NCIntentSampleList	Grouping annotation required for when more than one NCIntentSample annotation is attached to the callback.
NCIntentTerm	Annotation to mark callback parameter to receive intent term's tokens.