Contains main API for defining data models.
Interface Summary Interface Description NCCompanyDescriptor of the user company. NCContextData model query context. NCConversationConversation container for specific user and data model. NCCustomElementDetected model element returning from custom parser. NCCustomParserCustom model element parser for programmatic NER implementations. NCCustomWordA partially enriched token with a basic set of NLP properties used by custom NER parser. NCElementData model element. NCIntentMatchAn intent match context that can be passed into the callback of the matched intent. NCLifecycleNLPCraft lifecycle component. NCMetadataProvides support for map-based metadata. NCModelUser-defined semantic data model. NCModelFactoryOptional factory for data models. NCModelViewRead-only view on data model. NCRequestSupplemental information about the user request. NCTokenDetected model element. NCUserDescriptor of the user. NCValueModel element's value. NCValueLoaderDynamic value loader that can be used by model elements to dynamically load or create their values. NCVariantA list of tokens representing one possible parsing variant of the user input.
Class Summary Class Description NCModelAdapterAdapter for data models. NCModelFileAdapterAdapter for data models that can load model configuration from external JSON/YAML file. NCResultData model result returned from model intent callbacks.
Exception Summary Exception Description NCIntentSkipControl flow exception to skip current intent. NCRejectionException to indicate that user input cannot be processed as is.
Annotation Types Summary Annotation Type Description NCIntentAnnotation to define an intent on the method serving as its callback. NCIntentRefAnnotations referencing an intent defined externally in JSON or YAML model declaration. NCIntentSampleAnnotation to define one or more samples of the user input that should match a corresponding intent. NCIntentSample.NCIntentSampleListGrouping annotation required for when more than one
NCIntentSampleannotation is attached to the callback.
NCIntentTermAnnotation to mark callback parameter to receive intent term's tokens.