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. NCDialogFlowItemAn item of the dialog flow. NCElementData model element. NCIntentMatchAn intent match context that can be passed into the callback of the matched intent. NCLifecycleLifecycle component. NCMetadataProvides support for mutable runtime-only metadata. NCModelUser-defined data model. NCModelFactoryOptional factory for data models. NCModelViewRead-only view on data model. NCRequestInformation about the user request. NCTokenDetected model element. NCTokenPredicateContextContext passed into custom user-defined IDL term token predicate. 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 parsing variant is a list of tokens representing one possible parsing variant of the user input.
Class Summary Class Description NCMacroProcessorStandalone synonym macro DSL processor. 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. NCTokenPredicateResultResult value of user-defined IDL term token predicate.
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 bind an intent with the method serving as its callback. NCIntent.NCIntentListGrouping annotation required for when more than one
NCIntentannotation is used.
NCIntentRefAnnotation referencing an intent defined outside of callback method declaration. NCIntentRef.NCIntentRefListGrouping annotation required for when more than one
NCIntentRefannotation is used.
NCIntentSampleAnnotation to define samples of the user input that should match an intent. NCIntentSample.NCIntentSampleListGrouping annotation required for when more than one
NCIntentSampleannotation is used.
NCIntentSampleRefAnnotation to define samples of the user input that should match an intent. NCIntentSampleRef.NCIntentSampleListGrouping annotation required for when more than one
NCIntentSampleRefannotation is used.
NCIntentTermAnnotation to mark callback parameter to receive intent term's tokens.