A B C D F G H I J M N O P Q R S T V W X Y

A

addIntent(NCIntentSolver.INTENT, Function<NCIntentSolverContext, NCQueryResult>) - Method in class org.nlpcraft.model.intent.NCIntentSolver

Adds given intent and its callback function to this solver.

addIntent(String, Function<NCIntentSolverContext, NCQueryResult>) - Method in class org.nlpcraft.model.intent.NCIntentSolver

Adds given text-based intent DSL and its callback function to this solver.

AND(NCIntentSolver.COMBINATOR...) - Constructor for class org.nlpcraft.model.intent.NCIntentSolver.AND

Creates new AND-combinator with a given list of combinators.

AND(String...) - Constructor for class org.nlpcraft.model.intent.NCIntentSolver.AND

Creates new AND-combinator with given text-based RULEs:

      new AND("id == x:time", "~GEO_KIND == CITY", "value %% ^[Ff]oo[Bb]ar$");

apply(NCToken) - Method in class org.nlpcraft.model.intent.NCIntentSolver.AND

apply(NCToken) - Method in class org.nlpcraft.model.intent.NCIntentSolver.NAND

apply(NCToken) - Method in class org.nlpcraft.model.intent.NCIntentSolver.NOR

apply(NCToken) - Method in class org.nlpcraft.model.intent.NCIntentSolver.NOT

apply(NCToken) - Method in class org.nlpcraft.model.intent.NCIntentSolver.OR

apply(NCToken) - Method in class org.nlpcraft.model.intent.NCIntentSolver.RULE

apply(NCToken) - Method in class org.nlpcraft.model.intent.NCIntentSolver.XNOR

apply(NCToken) - Method in class org.nlpcraft.model.intent.NCIntentSolver.XOR

ask(String) - Method in interface org.nlpcraft.model.test.NCTestClient

Tests single sentence and returns its result.

B

build() - Method in class org.nlpcraft.model.test.NCTestClientBuilder

Build new configured test client instance.

C

clear(Predicate<NCToken>) - Method in interface org.nlpcraft.model.NCConversationContext

Removes all tokens satisfying given predicate from the current conversation STM.

clearConversation() - Method in interface org.nlpcraft.model.test.NCTestClient

Clears conversation for this test client.

close() - Method in interface org.nlpcraft.model.test.NCTestClient

Closes test client connection to the server.

CONV_INTENT(String, NCIntentSolver.TERM...) - Constructor for class org.nlpcraft.model.intent.NCIntentSolver.CONV_INTENT

Creates unordered intent with conversation support.

CONV_INTENT(String, Function<NCToken, Boolean>, int, int) - Constructor for class org.nlpcraft.model.intent.NCIntentSolver.CONV_INTENT

Shortcut constructor for unordered, conversational intent with just one TERM.

CONV_INTENT(String, Function<NCToken, Boolean>) - Constructor for class org.nlpcraft.model.intent.NCIntentSolver.CONV_INTENT

Shortcut constructor for unordered, conversational intent with just one TERM.

CONV_INTENT(String, String, int, int) - Constructor for class org.nlpcraft.model.intent.NCIntentSolver.CONV_INTENT

Shortcut constructor for unordered, conversational intent with just one TERM.

CONV_INTENT(String, String) - Constructor for class org.nlpcraft.model.intent.NCIntentSolver.CONV_INTENT

Shortcut constructor for unordered, conversational intent with just one TERM.

D

DFLT_BASEURL - Static variable in class org.nlpcraft.model.test.NCTestClientBuilder

Default public REST API URL (endpoint).

DFLT_EMAIL - Static variable in class org.nlpcraft.model.test.NCTestClientBuilder

Default client email.

DFLT_ENABLED_TOKENS - Static variable in interface org.nlpcraft.model.NCModel

Default set of enabled built-in tokens.

DFLT_ENDPOINT - Static variable in class org.nlpcraft.model.test.NCTestClientBuilder

Default local endpoint to get result notifications.

DFLT_IS_DUP_SYNONYMS_ALLOWED - Static variable in interface org.nlpcraft.model.NCModel

Default value returned from NCModel.isDupSynonymsAllowed() method.

DFLT_IS_NO_NOUNS_ALLOWED - Static variable in interface org.nlpcraft.model.NCModel

Default value returned from NCModel.isNoNounsAllowed() method.

DFLT_IS_NO_USER_TOKENS_ALLOWED - Static variable in interface org.nlpcraft.model.NCModel

Default value returned from NCModel.isNoUserTokensAllowed() method.

DFLT_IS_NON_ENGLISH_ALLOWED - Static variable in interface org.nlpcraft.model.NCModel

Default value returned from NCModel.isNonEnglishAllowed() method.

DFLT_IS_NOT_LATIN_CHARSET_ALLOWED - Static variable in interface org.nlpcraft.model.NCModel

Default value returned from NCModel.isNotLatinCharsetAllowed() method.

DFLT_IS_PERMUTATE_SYNONYMS - Static variable in interface org.nlpcraft.model.NCModel

Default value returned from NCModel.isPermutateSynonyms() method.

DFLT_IS_SWEAR_WORDS_ALLOWED - Static variable in interface org.nlpcraft.model.NCModel

Default value returned from NCModel.isSwearWordsAllowed() method.

DFLT_JIGGLE_FACTOR - Static variable in interface org.nlpcraft.model.NCModel

Default value returned from NCModel.getJiggleFactor() method.

DFLT_MAX_FREE_WORDS - Static variable in interface org.nlpcraft.model.NCModel

Default value returned from NCModel.getMaxFreeWords() method.

DFLT_MAX_SUSPICIOUS_WORDS - Static variable in interface org.nlpcraft.model.NCModel

Default value returned from NCModel.getMaxSuspiciousWords() method.

DFLT_MAX_TOKENS - Static variable in interface org.nlpcraft.model.NCModel

Default value returned from NCModel.getMaxTokens() method.

DFLT_MAX_TOTAL_SYNONYMS - Static variable in interface org.nlpcraft.model.NCModel

Default value returned from NCModel.getMaxTotalSynonyms() method.

DFLT_MAX_UNKNOWN_WORDS - Static variable in interface org.nlpcraft.model.NCModel

Default value returned from NCModel.getMaxUnknownWords() method.

DFLT_MAX_WORDS - Static variable in interface org.nlpcraft.model.NCModel

Default value returned from NCModel.getMaxWords() method.

DFLT_METADATA - Static variable in interface org.nlpcraft.model.NCModel

Default value returned from NCModel.getJiggleFactor() method.

DFLT_MIN_NON_STOPWORDS - Static variable in interface org.nlpcraft.model.NCModel

Default value returned from NCModel.getMinNonStopwords() method.

DFLT_MIN_TOKENS - Static variable in interface org.nlpcraft.model.NCModel

Default value returned from NCModel.getMinTokens() method.

DFLT_MIN_WORDS - Static variable in interface org.nlpcraft.model.NCModel

Default value returned from NCModel.getMinWords() method.

DFLT_PASSWORD - Static variable in class org.nlpcraft.model.test.NCTestClientBuilder

Default client password.

DFLT_QRY_FUNCTION - Static variable in interface org.nlpcraft.model.NCModel

Default query method implementation that throw exception.

discard() - Method in interface org.nlpcraft.model.NCModel

A callback before this model instance gets discarded.

F

fromGoogle(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Whether or not this token is from Google Natural Language provider.

fromNlpCraft(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Whether or not this token is from built-in NLPCraft provider.

fromOpenNlp(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Whether or not this token is from OpenNLP provider.

fromStanfordCoreNlp(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Whether or not this token is from Stanford CoreNLP provider.

G

getAdditionalStopWords() - Method in interface org.nlpcraft.model.NCModel

Gets an optional list of stopwords to add to the built-in ones.

getAdditionalStopWords() - Method in class org.nlpcraft.model.NCModelFileAdapter

getAs(String) - Method in interface org.nlpcraft.model.NCMetadata

Gets typed mandatory metadata value.

getBody() - Method in class org.nlpcraft.model.NCQueryResult

Gets result body.

getBoolean(String) - Method in interface org.nlpcraft.model.NCMetadata

Gets mandatory boolean metadata value.

getBooleanOpt(String) - Method in interface org.nlpcraft.model.NCMetadata

Gets optional boolean metadata value.

getBooleanOrElse(String, boolean) - Method in interface org.nlpcraft.model.NCMetadata

Gets optional boolean metadata value.

getClause() - Method in interface org.nlpcraft.model.utils.NCTokenSqlAdapter

Gets part of SQL syntax with '?' for each parameter.

getClauseParameters() - Method in interface org.nlpcraft.model.utils.NCTokenSqlAdapter

Gets list parameters corresponding to NCTokenSqlAdapter.getClause() statement.

getConversationContext() - Method in interface org.nlpcraft.model.NCQueryContext

Gets current conversation context.

getCoordinateLatitude(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Gets coordinate latitude for this nlpcraft:coordinate token.

getCoordinateLongitude(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Gets coordinate longitude for this nlpcraft:coordinate token.

getData() - Method in interface org.nlpcraft.model.NCSentence

Gets optional JSON data passed in with user input.

getDateFrom(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Gets start timestamp of the date range nlpcraft:date token.

getDateTo(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Gets end timestamp of the date range nlpcraft:date token.

getDescription() - Method in interface org.nlpcraft.model.NCElement

Gets optional element description.

getDescription() - Method in interface org.nlpcraft.model.NCModel

Gets optional short model description.

getDescription() - Method in class org.nlpcraft.model.NCModelFileAdapter

getDouble(String) - Method in interface org.nlpcraft.model.NCMetadata

Gets mandatory double metadata value.

getDoubleOpt(String) - Method in interface org.nlpcraft.model.NCMetadata

Gets optional double metadata value.

getDoubleOrElse(String, double) - Method in interface org.nlpcraft.model.NCMetadata

Gets optional double metadata value.

getDownLink() - Method in interface org.nlpcraft.model.NCProbeContext

Gets downlink endpoint for this probe.

getElementId() - Method in interface org.nlpcraft.model.parsing.NCCustomElement

Gets ID of the detected model element.

getElementMetadata() - Method in interface org.nlpcraft.model.NCToken

Gets model element metadata when this token corresponds to the user element.

getElements() - Method in interface org.nlpcraft.model.NCModel

Gets a set of model elements.

getElements() - Method in class org.nlpcraft.model.NCModelFileAdapter

getEnabledTokens() - Method in interface org.nlpcraft.model.NCModel

Gets set of IDs for built-in tokens that should be enabled and detected for this model.

getEnabledTokens() - Method in class org.nlpcraft.model.NCModelFileAdapter

getEndCharIndex() - Method in interface org.nlpcraft.model.parsing.NCCustomWord

Gets end character index of this token.

getExamples() - Method in interface org.nlpcraft.model.NCModel

Gets an optional list of example sentences demonstrating what can be asked with this model.

getExamples() - Method in class org.nlpcraft.model.NCModelFileAdapter

getExcludedStopWords() - Method in interface org.nlpcraft.model.NCModel

Gets an optional list of stopwords to exclude from the built-in list of stopwords.

getExcludedStopWords() - Method in class org.nlpcraft.model.NCModelFileAdapter

getExcludedSynonyms() - Method in interface org.nlpcraft.model.NCElement

Gets the optional list of synonyms to exclude from the list returned by NCElement.getSynonyms().

getFunIndexes(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Gets indexes of the element(s) given @code nlpcraft:function} token is referencing.

getFunLimit(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Gets limit value if given nlpcraft:function token represents LIMIT function.

getGeoCity(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Gets city for given nlpcraft:geo token.

getGeoContinent(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Gets continent for given nlpcraft:geo token.

getGeoCountry(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Gets country for given nlpcraft:geo token.

getGeoLatitude(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Gets optional latitude of the given nlpcraft:geo token.

getGeoLongitude(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Gets optional longitude of the given nlpcraft:geo token.

getGeoMetro(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Gets metro area code for given nlpcraft:geo token.

getGeoRegion(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Gets region for given nlpcraft:geo token.

getGeoSubcontinent(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Gets subcontinent for given nlpcraft:geo token.

getGoogleMentionsBeginOffsets(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Gets Google Natural Language mentions begin offsets for given google: token.

getGoogleMentionsContents(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Gets Google Natural Language mentions contents for given google: token.

getGoogleMentionsTypes(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Gets Google Natural Language mentions types for given google: token.

getGoogleMeta(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Gets Google Natural Language meta data for given google: token.

getGoogleSalience(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Gets Google Natural Language salience for given google: token.

getGroups() - Method in interface org.nlpcraft.model.NCElement

Gets the list of groups this elements belongs to.

getGroups() - Method in interface org.nlpcraft.model.NCToken

Gets the list of groups this token belongs to.

getId() - Method in class org.nlpcraft.model.intent.NCIntentSolver.INTENT

Gets ID of this intent.

getId() - Method in class org.nlpcraft.model.intent.NCIntentSolver.TERM

Gets optional term ID.

getId() - Method in interface org.nlpcraft.model.NCElement

Gets unique ID of this element.

getId() - Method in interface org.nlpcraft.model.NCModel

Gets unique, immutable ID of this model.

getId() - Method in class org.nlpcraft.model.NCModelAdapter

getId() - Method in class org.nlpcraft.model.NCModelFileAdapter

getId() - Method in interface org.nlpcraft.model.NCProbeContext

Gets ID of the probe.

getId() - Method in interface org.nlpcraft.model.NCToken

If this token represents user defined model element this method returns the ID of that element.

getInteger(String) - Method in interface org.nlpcraft.model.NCMetadata

Gets mandatory integer metadata value.

getIntegerOpt(String) - Method in interface org.nlpcraft.model.NCMetadata

Gets optional integer metadata value.

getIntegerOrElse(String, int) - Method in interface org.nlpcraft.model.NCMetadata

Gets optional integer metadata value.

getIntentId() - Method in interface org.nlpcraft.model.intent.NCIntentSolverContext

Gets ID of the matched intent.

getIntents() - Method in class org.nlpcraft.model.intent.NCIntentSolver

Gets all added intents.

getIntentTokens() - Method in interface org.nlpcraft.model.intent.NCIntentSolverContext

Gets a subset of tokens representing matched intent.

getJarsFolder() - Method in interface org.nlpcraft.model.NCProbeContext

Gets optional folder to scan for model JARs.

getJiggleFactor() - Method in interface org.nlpcraft.model.NCModel

Measure of how much sparsity is allowed when user input words are reordered in attempt to match the multi-word synonyms.

getJiggleFactor() - Method in class org.nlpcraft.model.NCModelFileAdapter

getLemma() - Method in interface org.nlpcraft.model.parsing.NCCustomWord

Gets the lemma of this token, i.e.

getLemma(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Gets lemma of the given token.

getLong(String) - Method in interface org.nlpcraft.model.NCMetadata

Gets mandatory long metadata value.

getLongOpt(String) - Method in interface org.nlpcraft.model.NCMetadata

Gets optional long metadata value.

getLongOrElse(String, long) - Method in interface org.nlpcraft.model.NCMetadata

Gets optional long metadata value.

getMacros() - Method in interface org.nlpcraft.model.NCModel

Gets an optional map of macros to be used in this model.

getMacros() - Method in class org.nlpcraft.model.NCModelFileAdapter

getMax() - Method in class org.nlpcraft.model.intent.NCIntentSolver.TERM

Gets max quantifier for this term.

getMaxFreeWords() - Method in interface org.nlpcraft.model.NCModel

Gets maximum number of free words until automatic rejection.

getMaxFreeWords() - Method in class org.nlpcraft.model.NCModelFileAdapter

getMaxIndex(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Gets index of the last word in the given token.

getMaxSuspiciousWords() - Method in interface org.nlpcraft.model.NCModel

Gets maximum number of suspicious words until automatic rejection.

getMaxSuspiciousWords() - Method in class org.nlpcraft.model.NCModelFileAdapter

getMaxTokens() - Method in interface org.nlpcraft.model.NCModel

Gets maximum number of all tokens (system and user defined) above which user input will be automatically rejected as too long.

getMaxTokens() - Method in class org.nlpcraft.model.NCModelFileAdapter

getMaxTotalSynonyms() - Method in interface org.nlpcraft.model.NCModel

Total number of synonyms allowed per model.

getMaxTotalSynonyms() - Method in class org.nlpcraft.model.NCModelFileAdapter

getMaxUnknownWords() - Method in interface org.nlpcraft.model.NCModel

Gets maximum number of unknown words until automatic rejection.

getMaxUnknownWords() - Method in class org.nlpcraft.model.NCModelFileAdapter

getMaxWords() - Method in interface org.nlpcraft.model.NCModel

Gets maximum word count (including stopwords) above which user input will be automatically rejected as too long.

getMaxWords() - Method in class org.nlpcraft.model.NCModelFileAdapter

getMetadata() - Method in interface org.nlpcraft.model.NCElement

Gets optional user-defined element's metadata.

getMetadata() - Method in interface org.nlpcraft.model.NCModel

Gets optional user specific model metadata can be set by the developer and accessed later.

getMetadata() - Method in class org.nlpcraft.model.NCModelFileAdapter

getMetadata() - Method in interface org.nlpcraft.model.NCToken

Gets token metadata.

getMetadata() - Method in interface org.nlpcraft.model.parsing.NCCustomElement

Optional metadata that will be added to the resulting NCToken object and that would be accessible via NCToken.getMetadata().

getMin() - Method in class org.nlpcraft.model.intent.NCIntentSolver.TERM

Gets min quantifier for this term.

getMinIndex(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Gets index of the first word in the given token.

getMinNonStopwords() - Method in interface org.nlpcraft.model.NCModel

Gets minimum word count (excluding stopwords) below which user input will be automatically rejected as ambiguous sentence.

getMinNonStopwords() - Method in class org.nlpcraft.model.NCModelFileAdapter

getMinTokens() - Method in interface org.nlpcraft.model.NCModel

Gets minimum number of all tokens (system and user defined) below which user input will be automatically rejected as too short.

getMinTokens() - Method in class org.nlpcraft.model.NCModelFileAdapter

getMinWords() - Method in interface org.nlpcraft.model.NCModel

Gets minimum word count (including stopwords) below which user input will be automatically rejected as too short.

getMinWords() - Method in class org.nlpcraft.model.NCModelFileAdapter

getModel() - Method in interface org.nlpcraft.model.NCQueryContext

Gets model instance for this query.

getModelId() - Method in interface org.nlpcraft.model.test.NCTestResult

Gets model ID the test sentence was sent with.

getModels() - Method in interface org.nlpcraft.model.NCProbeContext

Gets model classes, potentially empty.

getName() - Method in class org.nlpcraft.model.intent.NCIntentSolver

Gets solver name.

getName() - Method in interface org.nlpcraft.model.NCElement.NCValue

Gets value name.

getName() - Method in interface org.nlpcraft.model.NCModel

Gets descriptive name of this model.

getName() - Method in class org.nlpcraft.model.NCModelAdapter

getName() - Method in class org.nlpcraft.model.NCModelFileAdapter

getNormalizedText() - Method in interface org.nlpcraft.model.NCSentence

Gets normalized text of the user input.

getNormalizedText(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Gets normalized user input text for given token.

getNormText() - Method in interface org.nlpcraft.model.parsing.NCCustomWord

Gets normalized user input text for this token.

getNumFrom(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Gets the start of the numeric range that satisfies the condition of given nlpcraft:num token.

getNumIndex(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Gets optional index of another token in the sentence that this nlpcraft:num token is referring to.

getNumTo(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Gets the end of numeric range that satisfies the condition of given nlpcraft:num token.

getNumUnit(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Gets optional unit for this nlpcraft:num token, e.g.

getNumUnitType(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Gets optional unit type for this nlpcraft:num token, e.g.

getOp() - Method in class org.nlpcraft.model.intent.NCIntentSolver.RULE

Gets binary operation of this rule.

getOpenNlpProbability(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Gets OpenNLP probability value for given opennlp: token.

getOptAs(String) - Method in interface org.nlpcraft.model.NCMetadata

Gets typed optional metadata value.

getOriginalText(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Gets original user input text for given token.

getOrigText() - Method in interface org.nlpcraft.model.parsing.NCCustomWord

Gets original user input text for this token.

getParameter() - Method in class org.nlpcraft.model.intent.NCIntentSolver.RULE

Gets left-side parameter of this rule.

getParentId() - Method in interface org.nlpcraft.model.NCElement

Gets optional ID of the immediate parent element.

getParentId() - Method in interface org.nlpcraft.model.NCToken

Gets the optional parent ID of the model element this token represents.

getParser() - Method in interface org.nlpcraft.model.NCModel

Gets optional custom user parser for model elements.

getPos() - Method in interface org.nlpcraft.model.parsing.NCCustomWord

Gets Penn Treebank POS tag for this token.

getPosDescription() - Method in interface org.nlpcraft.model.parsing.NCCustomWord

Gets description of Penn Treebank POS tag.

getPosDescription(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Gets description of Penn Treebank POS tag.

getPosTag(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Gets Penn Treebank POS tag for given token.

getPredicate() - Method in class org.nlpcraft.model.intent.NCIntentSolver.TERM

Gets term's predicate.

getProcessingTime() - Method in interface org.nlpcraft.model.test.NCTestResult

Gets total sentence processing time in milliseconds.

getQueryContext() - Method in interface org.nlpcraft.model.intent.NCIntentSolverContext

Query context from the original NCModel.query(NCQueryContext) method.

getReceiveTimestamp() - Method in interface org.nlpcraft.model.NCSentence

Gets UTC/GMT timestamp in ms when user input was received.

getRemoteAddress() - Method in interface org.nlpcraft.model.NCSentence

Gets optional address of the remote client.

getResult() - Method in interface org.nlpcraft.model.test.NCTestResult

Gets optional execution result.

getResultError() - Method in interface org.nlpcraft.model.test.NCTestResult

Gets optional execution error.

getResultType() - Method in interface org.nlpcraft.model.test.NCTestResult

Gets optional execution result type.

getSentence() - Method in interface org.nlpcraft.model.NCQueryContext

Gets fully parsed, canonical representation of user input.

getServerRequestId() - Method in interface org.nlpcraft.model.NCQueryContext

Gets ID of the current request.

getServerRequestId() - Method in interface org.nlpcraft.model.NCSentence

Gets globally unique server ID of the current request.

getServerRequestId() - Method in interface org.nlpcraft.model.NCToken

Gets ID of the server request this token is part of.

getSolver() - Method in class org.nlpcraft.model.NCModelAdapter

Gets previously set intent solver for this model or null.

getSparsity(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Gets numeric value of how sparse the given token is.

getStanfordConfidence(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Gets Stanford CoreNLP confidence value for given stanford: token.

getStanfordNne(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Gets optional Stanford CoreNLP Normalized Named Entity (NNE) value for given stanford: token.

getStartCharIndex() - Method in interface org.nlpcraft.model.parsing.NCCustomWord

Gets start character index of this token.

getStem() - Method in interface org.nlpcraft.model.parsing.NCCustomWord

Gets the stem of this token.

getStem(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Gets stem of the given token.

getString(String) - Method in interface org.nlpcraft.model.NCMetadata

Gets mandatory string metadata value.

getStringOpt(String) - Method in interface org.nlpcraft.model.NCMetadata

Gets optional string metadata value.

getStringOrElse(String, String) - Method in interface org.nlpcraft.model.NCMetadata

Gets optional string metadata value.

getSuspiciousWords() - Method in interface org.nlpcraft.model.NCModel

Gets an optional list of suspicious words.

getSuspiciousWords() - Method in class org.nlpcraft.model.NCModelFileAdapter

getSynonyms() - Method in interface org.nlpcraft.model.NCElement

Gets the list of synonyms by which this semantic element will be recognized by.

getSynonyms() - Method in interface org.nlpcraft.model.NCElement.NCValue

Gets optional list of value's synonyms.

getTerms() - Method in class org.nlpcraft.model.intent.NCIntentSolver.INTENT

Gets list of terms defining this intent.

getTermTokens(int) - Method in interface org.nlpcraft.model.intent.NCIntentSolverContext

Gets tokens for given term.

getTermTokens(String) - Method in interface org.nlpcraft.model.intent.NCIntentSolverContext

Gets tokens for given term.

getText() - Method in interface org.nlpcraft.model.test.NCTestResult

Gets test sentence text.

getToken() - Method in interface org.nlpcraft.model.NCProbeContext

Gets probe token.

getTokenIndex(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Gets index of the given token in the sentence.

getTokens() - Method in interface org.nlpcraft.model.NCConversationContext

Gets an ordered list of tokens stored in the current conversation STM for current user (i.e.

getTokens() - Method in class org.nlpcraft.model.NCQueryResult

Gets tokens that were used to produce this query result.

getType() - Method in class org.nlpcraft.model.NCQueryResult

Gets result type.

getUnid(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Gets internal globally unique system ID of the given token.

getUpLink() - Method in interface org.nlpcraft.model.NCProbeContext

Gets uplink endpoint for this probe.

getUserAvatarUrl() - Method in interface org.nlpcraft.model.NCSentence

Gets user avatar URL (data: or http: scheme URLs).

getUserClientAgent() - Method in interface org.nlpcraft.model.NCSentence

Gets string representation of the user client agent that made the call with this sentence.

getUserEmail() - Method in interface org.nlpcraft.model.NCSentence

Gets email of the user that made the request.

getUserFirstName() - Method in interface org.nlpcraft.model.NCSentence

Gets first name of the user that made the request.

getUserLastName() - Method in interface org.nlpcraft.model.NCSentence

Gets last name of the user that made the request.

getUserProperties() - Method in interface org.nlpcraft.model.NCSentence

Gets properties associated with the current user that made the call with this sentence.

getUserSignupDate() - Method in interface org.nlpcraft.model.NCSentence

Gets signup date of the user that made the request.

getValue() - Method in class org.nlpcraft.model.intent.NCIntentSolver.RULE

Gets right-side value of this rule.

getValue() - Method in interface org.nlpcraft.model.NCToken

Gets the value if this token was detected via element's value (or its synonyms).

getValues() - Method in interface org.nlpcraft.model.NCElement

Gets optional map of values for this element.

getVariants() - Method in interface org.nlpcraft.model.NCSentence

Gets collection of all parsing variants for this sentence.

getVariantTokens() - Method in interface org.nlpcraft.model.intent.NCIntentSolverContext

Gets sentence parsing variant that produced the matching for this intent.

getVersion() - Method in interface org.nlpcraft.model.NCModel

Gets the version of this model using semantic versioning.

getVersion() - Method in class org.nlpcraft.model.NCModelAdapter

getVersion() - Method in class org.nlpcraft.model.NCModelFileAdapter

getWordIndexes(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Gets list of word indexes in the given token.

getWordLength(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Gets number of individual words in the given token.

getWords() - Method in interface org.nlpcraft.model.parsing.NCCustomElement

Gets custom tokens that comprise detected model element.

H

html(String) - Static method in class org.nlpcraft.model.NCQueryResult

Creates html result.

I

initialize(Map<String, String>) - Method in class org.nlpcraft.model.factories.basic.NCBasicModelFactory

initialize(Map<String, String>) - Method in class org.nlpcraft.model.factories.spring.NCSpringModelFactory

initialize(NCProbeContext) - Method in interface org.nlpcraft.model.NCModel

Probe calls this method to initialize the model when it gets deployed in the probe.

initialize(Map<String, String>) - Method in interface org.nlpcraft.model.NCModelFactory

Initializes this factory with properties from probe.config file.

INTENT(String, boolean, boolean, NCIntentSolver.TERM...) - Constructor for class org.nlpcraft.model.intent.NCIntentSolver.INTENT

Creates new intent with given parameters.

isAdjective(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Tests whether POS tag for given token is one of JJ, JJR, or JJS.

isAdverb(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Tests whether POS tag for given token is one of RB, RBR, RBS or WRB.

isAscendingFun(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Optional value of whether this limit or sort nlpcraft:function token is ascending or descending.

isAvgFun(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Tests if given nlpcraft:function token represents AVG function of some elements.

isBracketed() - Method in interface org.nlpcraft.model.parsing.NCCustomWord

Gets whether or not this token is surrounded by any of '[', ']', '{', '}', '(', ')' brackets.

isBracketed(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Tests whether or not this token is surrounded by any of '[', ']', '{', '}', '(', ')' brackets.

isCompareFun(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Tests if given nlpcraft:function token represents COMPARE function of some elements.

isContiguous(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Tests whether or not the given token has zero sparsity.

isConversational() - Method in class org.nlpcraft.model.intent.NCIntentSolver.INTENT

Gets conversation policy flag.

isCoordinate(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Whether or not this token has nlpcraft:coordinate ID.

isCorrelationFun(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Tests if given nlpcraft:function token represents CORRELATION function of some elements.

isDate(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Whether or not this token has nlpcraft:date ID.

isDateAfter(NCToken, long) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Tests if given timestamp is after the date range for given nlpcraft:date token.

isDateBefore(NCToken, long) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Tests if given timestamp is before the date range for given nlpcraft:date token.

isDateIntersect(NCToken, long, long) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Tests if given from and to timestamps intersect (inclusively) with the date range for given nlpcraft:date token.

isDateWithin(NCToken, long) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Tests if given timestamp is within (inclusively) the date range for given nlpcraft:date token.

isDeterminer(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Tests whether POS tag for given token is one of DT, PDT, or WDT.

isDirectSynonym(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Whether or not this token was matched on direct (nor permutated) synonym.

isDupSynonymsAllowed() - Method in interface org.nlpcraft.model.NCModel

Whether or not duplicate synonyms are allowed.

isDupSynonymsAllowed() - Method in class org.nlpcraft.model.NCModelFileAdapter

isEnglish(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Tests whether the given token represents an English word.

isExactMatch() - Method in interface org.nlpcraft.model.intent.NCIntentSolverContext

Indicates whether or not the intent match was exact.

isFailed() - Method in interface org.nlpcraft.model.test.NCTestResult

Tests whether or not this result corresponds to a failed execution.

isFreeWord(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Tests whether or not given token represents a free word.

isFunction(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Whether or not this token has nlpcraft:function ID.

isGeo(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Whether or not this token has nlpcraft:geo ID.

isGeoCity(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Tests if given nlpcraft:geo token represents a city.

isGeoContinent(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Tests if given nlpcraft:geo token represents a continent.

isGeoCountry(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Tests if given nlpcraft:geo token represents a country.

isGeoMetro(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Tests if given nlpcraft:geo token represents a metro.

isGeoRegion(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Tests if given nlpcraft:geo token represents a region.

isGeoSubcontinent(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Tests if given nlpcraft:geo token represents a subcontinent.

isGroupFun(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Tests if given nlpcraft:function token represents GROUP function of some elements.

isKnownWord(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Tests whether or not this token is found in Princeton WordNet database.

isLimitFun(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Tests if given nlpcraft:function token represents LIMIT function of some elements.

isMaxFun(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Tests if given nlpcraft:function token represents MAX function of some elements.

isMinFun(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Tests if given nlpcraft:function token represents MIN function of some elements.

isNlp(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Whether or not this token has nlpcraft:nlp ID.

isNonEnglishAllowed() - Method in interface org.nlpcraft.model.NCModel

Whether or not to allow non-English language in user input.

isNonEnglishAllowed() - Method in class org.nlpcraft.model.NCModelFileAdapter

isNoNounsAllowed() - Method in interface org.nlpcraft.model.NCModel

Whether or not to allow user input without a single noun.

isNoNounsAllowed() - Method in class org.nlpcraft.model.NCModelFileAdapter

isNotLatinCharsetAllowed() - Method in interface org.nlpcraft.model.NCModel

Whether or not to allow non-Latin charset in user input.

isNotLatinCharsetAllowed() - Method in class org.nlpcraft.model.NCModelFileAdapter

isNoun(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Tests whether POS tag for given token is one of NN, NNS, NNP, or NNPS.

isNoUserTokensAllowed() - Method in interface org.nlpcraft.model.NCModel

Whether or not to allow the user input with no user token detected.

isNoUserTokensAllowed() - Method in class org.nlpcraft.model.NCModelFileAdapter

isNumEqualCondition(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Whether given nlpcraft:num token represents a equality condition or single numeric value.

isNumeric(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Whether or not this token has nlpcraft:num ID.

isNumFractional(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Whether this token's value (single numeric value of a range) is a whole or a fractional number for given nlpcraft:num token.

isNumFromInclusive(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Whether or not start of the numeric range is inclusive for given nlpcraft:num token.

isNumFromNegativeInfCondition(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Whether given nlpcraft:num token represents a range to negative infinity.

isNumNotEqualCondition(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Whether given nlpcraft:num token represents a not-equality condition.

isNumRangeCondition(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Whether given nlpcraft:num token represents a range condition.

isNumToInclusive(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Whether or not end of the numeric range is inclusive for given nlpcraft:num token.

isNumToPositiveInfCondition(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Whether given nlpcraft:num token represents a range to positive infinity.

isOk() - Method in interface org.nlpcraft.model.test.NCTestResult

Tests whether or not this result corresponds to a successful execution.

isOrdered() - Method in class org.nlpcraft.model.intent.NCIntentSolver.INTENT

Whether or not this intent is ordered, i.e.

isOwnerOf(NCToken) - Method in interface org.nlpcraft.model.NCSentence

Tests if given token is part of this sentence.

isPermutateSynonyms() - Method in interface org.nlpcraft.model.NCModel

Whether or not to permutate multi-word synonyms.

isPermutateSynonyms() - Method in class org.nlpcraft.model.NCModelFileAdapter

isPreposition(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Tests whether POS tag for given token is IN.

isPronoun(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Tests whether POS tag for given token is one of PRP or PRP$.

isQuoted() - Method in interface org.nlpcraft.model.parsing.NCCustomWord

Gets whether or not this token is surrounded by single or double quotes.

isQuoted(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Tests whether or not given token is surrounded by single or double quotes.

isSortFun(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Tests if given nlpcraft:function token represents SORT function of some elements.

isStopword() - Method in interface org.nlpcraft.model.parsing.NCCustomWord

Gets whether or not this token is a stopword.

isStopWord(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Tests whether or not the given token is a stopword.

isSumFun(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Tests if given nlpcraft:function token represents SUM function of some elements.

isSwearWord(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Tests whether or not the given token is a swear word.

isSwearWordsAllowed() - Method in interface org.nlpcraft.model.NCModel

Whether or not to allow known English swear words in user input.

isSwearWordsAllowed() - Method in class org.nlpcraft.model.NCModelFileAdapter

isSynthetic(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Tests whether given token's POS tag is a synthetic one (for multiword token).

isSystemDefined() - Method in interface org.nlpcraft.model.NCToken

Checks whether or not this token represents a built-in named entity token.

isUserAdmin() - Method in interface org.nlpcraft.model.NCSentence

Tests whether or not the user has administrative privileges.

isUserDefined() - Method in interface org.nlpcraft.model.NCToken

Checks whether or not this token represents a user defined model element.

isVerb(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Tests whether POS tag for given token is one of VB, VBD, VBG, VBN, VBP, or VBZ.

J

JAVA_CONFIG_PROP - Static variable in class org.nlpcraft.model.factories.spring.NCSpringModelFactory

Configuration property for Java Config-based Spring configuration.

json(String) - Static method in class org.nlpcraft.model.NCQueryResult

Creates json result.

M

mkModel(Class<? extends NCModel>) - Method in class org.nlpcraft.model.factories.basic.NCBasicModelFactory

mkModel(Class<? extends NCModel>) - Method in class org.nlpcraft.model.factories.spring.NCSpringModelFactory

mkModel(Class<? extends NCModel>) - Method in interface org.nlpcraft.model.NCModelFactory

Constructs a model instance.

N

NAND(NCIntentSolver.COMBINATOR...) - Constructor for class org.nlpcraft.model.intent.NCIntentSolver.NAND

Creates new NAND-combinator with a given list of inner combinators.

NAND(String...) - Constructor for class org.nlpcraft.model.intent.NCIntentSolver.NAND

Creates new NAND-combinator with given text-based RULEs:

      new NAND("id == x:time", "~GEO_KIND == CITY", "value %% ^[Ff]oo[Bb]ar$");

NCBasicModelFactory - Class in org.nlpcraft.model.factories.basic

Default implementation of NCModelFactory interface.

NCBasicModelFactory() - Constructor for class org.nlpcraft.model.factories.basic.NCBasicModelFactory

NCConversationContext - Interface in org.nlpcraft.model

Conversation context.

NCCustomElement - Interface in org.nlpcraft.model.parsing

Object returning from parse(List) method indicating detected model element.

NCCustomParser - Interface in org.nlpcraft.model.parsing

Custom user-defined model element parser.

NCCustomWord - Interface in org.nlpcraft.model.parsing

Custom token used in parse(List) method.

NCDumpReader - Class in org.nlpcraft.model.tools.dump

Data model dump reader.

NCDumpReader() - Constructor for class org.nlpcraft.model.tools.dump.NCDumpReader

NCDumpWriter - Class in org.nlpcraft.model.tools.dump

Data model dump writer.

NCDumpWriter() - Constructor for class org.nlpcraft.model.tools.dump.NCDumpWriter

NCElement - Interface in org.nlpcraft.model

Data model element.

NCElement.NCValue - Interface in org.nlpcraft.model

Element's value.

NCIntent - Annotation Type in org.nlpcraft.model.intent

Annotation to define an intent on the method serving as its callback.

NCIntentRef - Annotation Type in org.nlpcraft.model.intent

Annotations referencing an intent defined externally.

NCIntentSkip - Exception in org.nlpcraft.model.intent

Control flow exception to skip current intent.

NCIntentSkip() - Constructor for exception org.nlpcraft.model.intent.NCIntentSkip

Creates new intent skip exception.

NCIntentSkip(String) - Constructor for exception org.nlpcraft.model.intent.NCIntentSkip

Creates new intent skip exception with given debug message.

NCIntentSolver - Class in org.nlpcraft.model.intent

Main entry point for intent-based user input matcher.

NCIntentSolver() - Constructor for class org.nlpcraft.model.intent.NCIntentSolver

Creates new default intent solver.

NCIntentSolver(String) - Constructor for class org.nlpcraft.model.intent.NCIntentSolver

Creates new named intent solver with given parameters and default not-found function.

NCIntentSolver(String, Function<NCQueryContext, NCQueryResult>) - Constructor for class org.nlpcraft.model.intent.NCIntentSolver

Creates new named intent solver with given parameters.

NCIntentSolver.AND - Class in org.nlpcraft.model.intent

AND-combinator.

NCIntentSolver.COMBINATOR - Interface in org.nlpcraft.model.intent

Marker type for built-in combinators.

NCIntentSolver.CONV_INTENT - Class in org.nlpcraft.model.intent

Convenient adapter for conversational unordered intent.

NCIntentSolver.INTENT - Class in org.nlpcraft.model.intent

An intent is a collection of terms defining a formal template for user input.

NCIntentSolver.NAND - Class in org.nlpcraft.model.intent

NAND-combinator.

NCIntentSolver.NON_CONV_INTENT - Class in org.nlpcraft.model.intent

Convenient adapter for non-conversational unordered intent.

NCIntentSolver.NOR - Class in org.nlpcraft.model.intent

NOR-combinator.

NCIntentSolver.NOT - Class in org.nlpcraft.model.intent

NOT-combinator.

NCIntentSolver.OR - Class in org.nlpcraft.model.intent

OR-combinator.

NCIntentSolver.RULE - Class in org.nlpcraft.model.intent

Declarative predicate over NCToken.

NCIntentSolver.TERM - Class in org.nlpcraft.model.intent

Term is a building block of the intent.

NCIntentSolver.XNOR - Class in org.nlpcraft.model.intent

XNOR (exclusive NOR)-combinator.

NCIntentSolver.XOR - Class in org.nlpcraft.model.intent

XOR (exclusive OR)-combinator.

NCIntentSolverContext - Interface in org.nlpcraft.model.intent

A context that can be passed passed into the callback of the matched intent.

NCIntentTerm - Annotation Type in org.nlpcraft.model.intent

Annotation to mark callback parameter to receive term's tokens.

NCMetadata - Interface in org.nlpcraft.model

Convenient map-based container for user-provided metadata.

NCModel - Interface in org.nlpcraft.model

Main interface for user-defined data model.

NCModelAdapter - Class in org.nlpcraft.model

Adapter for NCModel.

NCModelAdapter(String, String, String) - Constructor for class org.nlpcraft.model.NCModelAdapter

Creates new model with the given mandatory parameters.

NCModelFactory - Interface in org.nlpcraft.model

Factory of NCModels.

NCModelFileAdapter - Class in org.nlpcraft.model

Adapter for NCModel that can load model configuration from external JSON/YAML file.

NCModelFileAdapter(String) - Constructor for class org.nlpcraft.model.NCModelFileAdapter

Creates new model loading its configuration from given file path.

NCModelFileAdapter(URI) - Constructor for class org.nlpcraft.model.NCModelFileAdapter

Creates new model loading its configuration from given URI.

NCProbeContext - Interface in org.nlpcraft.model

Probe runtime context.

NCQueryContext - Interface in org.nlpcraft.model

Data model query context.

NCQueryResult - Class in org.nlpcraft.model

Data model query result returned from NCModel.query(NCQueryContext) method.

NCQueryResult() - Constructor for class org.nlpcraft.model.NCQueryResult

No-arg constructor.

NCRejection - Exception in org.nlpcraft.model

Exception to indicate that user input cannot be processed as is.

NCRejection(String) - Constructor for exception org.nlpcraft.model.NCRejection

Creates new rejection exception with given message.

NCRejection(String, Throwable) - Constructor for exception org.nlpcraft.model.NCRejection

Creates new rejection exception with given message and cause.

NCSentence - Interface in org.nlpcraft.model

Fully parsed representation of the user input.

NCSpringModelFactory - Class in org.nlpcraft.model.factories.spring

Factory that delegates construction of NCModels to the Spring Framework.

NCSpringModelFactory() - Constructor for class org.nlpcraft.model.factories.spring.NCSpringModelFactory

NCTestClient - Interface in org.nlpcraft.model.test

Model testing client.

NCTestClientBuilder - Class in org.nlpcraft.model.test

Test client builder for NCTestClient instances.

NCTestClientBuilder() - Constructor for class org.nlpcraft.model.test.NCTestClientBuilder

NCTestClientException - Exception in org.nlpcraft.model.test

Test client exception.

NCTestResult - Interface in org.nlpcraft.model.test

Result of the test sentence processing.

NCToken - Interface in org.nlpcraft.model

A token is a part of a fully parsed user input.

NCTokenSqlAdapter<T> - Interface in org.nlpcraft.model.utils

Convenient SQL adapter for usage with JDBC prepared statements in methods in NCTokenUtils class.

NCTokenUtils - Class in org.nlpcraft.model.utils

Convenient API for NCToken metadata.

NCTokenUtils() - Constructor for class org.nlpcraft.model.utils.NCTokenUtils

newBuilder() - Method in class org.nlpcraft.model.test.NCTestClientBuilder

Creates new builder instance with all defaults set.

NON_CONV_INTENT(String, NCIntentSolver.TERM...) - Constructor for class org.nlpcraft.model.intent.NCIntentSolver.NON_CONV_INTENT

Creates new unordered intent without conversation support.

NON_CONV_INTENT(String, Function<NCToken, Boolean>, int, int) - Constructor for class org.nlpcraft.model.intent.NCIntentSolver.NON_CONV_INTENT

Shortcut constructor for unordered, non-conversational intent with just one TERM.

NON_CONV_INTENT(String, Function<NCToken, Boolean>) - Constructor for class org.nlpcraft.model.intent.NCIntentSolver.NON_CONV_INTENT

Shortcut constructor for unordered, non-conversational intent with just one TERM.

NON_CONV_INTENT(String, String, int, int) - Constructor for class org.nlpcraft.model.intent.NCIntentSolver.NON_CONV_INTENT

Shortcut constructor for unordered, non-conversational intent with just one TERM.

NON_CONV_INTENT(String, String) - Constructor for class org.nlpcraft.model.intent.NCIntentSolver.NON_CONV_INTENT

Shortcut constructor for unordered, non-conversational intent with just one TERM.

NOR(NCIntentSolver.COMBINATOR...) - Constructor for class org.nlpcraft.model.intent.NCIntentSolver.NOR

Creates new NOR-combinator with a given list of inner combinators.

NOR(String...) - Constructor for class org.nlpcraft.model.intent.NCIntentSolver.NOR

Creates new NOR-combinator with given text-based NCIntentSolver.RULEs:

      new NOR("id == x:time", "~GEO_KIND == CITY", "value %% ^[Ff]oo[Bb]ar$");

NOT(NCIntentSolver.COMBINATOR) - Constructor for class org.nlpcraft.model.intent.NCIntentSolver.NOT

Creates new NOT-combinator with a given inner combinator.

NOT(String) - Constructor for class org.nlpcraft.model.intent.NCIntentSolver.NOT

Creates new NOT-combinator with given text-based NCIntentSolver.RULE:

      new NOT("id == x:time");

O

open(String) - Method in interface org.nlpcraft.model.test.NCTestClient

Connects test client to the server for testing with given model ID.

OR(NCIntentSolver.COMBINATOR...) - Constructor for class org.nlpcraft.model.intent.NCIntentSolver.OR

Creates new OR-combinator with a given list of inner combinators.

OR(String...) - Constructor for class org.nlpcraft.model.intent.NCIntentSolver.OR

Creates new OR-combinator with given text-based NCIntentSolver.RULEs:

      new OR("id == x:time", "~GEO_KIND == CITY", "value %% ^[Ff]oo[Bb]ar$");

org.nlpcraft.model - package org.nlpcraft.model

Contains main API for defining data models.

org.nlpcraft.model.factories.basic - package org.nlpcraft.model.factories.basic

Contains basic model factory implementation.

org.nlpcraft.model.factories.spring - package org.nlpcraft.model.factories.spring

Contains Spring-based model factory implementation.

org.nlpcraft.model.intent - package org.nlpcraft.model.intent

Contains intent-based input matcher.

org.nlpcraft.model.parsing - package org.nlpcraft.model.parsing

Contains custom user-defined model element parser.

org.nlpcraft.model.test - package org.nlpcraft.model.test

Contains model testing framework.

org.nlpcraft.model.tools.dump - package org.nlpcraft.model.tools.dump

Contains data model dump utility.

org.nlpcraft.model.utils - package org.nlpcraft.model.utils

Contains model utilities.

P

parse(List<NCCustomWord>) - Method in interface org.nlpcraft.model.parsing.NCCustomParser

Analyses user input provided as a list of NCCustomWord objects and returns a list of NCCustomElement objects.

prepareDateSql(NCToken, String) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Creates SQL WHERE clause adapter for given token and SQL column name that can be conveniently used in JDBC prepared statements.

prepareNumSql(NCToken, String) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Prepares SQL WHERE clause adapter for JDBC prepared statement based on condition in given nlpcraft:num token.

Q

query(NCQueryContext) - Method in interface org.nlpcraft.model.NCModel

Processes user input provided in the given query context and either returns the query result or throws an exception.

query(NCQueryContext) - Method in class org.nlpcraft.model.NCModelAdapter

R

read(String) - Static method in class org.nlpcraft.model.tools.dump.NCDumpReader

Reads the data model dump and creates data model proxy.

read(File) - Static method in class org.nlpcraft.model.tools.dump.NCDumpReader

Reads the data model dump and creates data model proxy.

RULE(String, String, Object) - Constructor for class org.nlpcraft.model.intent.NCIntentSolver.RULE

Creates new binary operator with given parameters.

RULE(String) - Constructor for class org.nlpcraft.model.intent.NCIntentSolver.RULE

Shortcut constructor for use cases where rule expression can be expressed as a whitespace separated string of parameter, its operation and value.

S

setBaseUrl(String) - Method in class org.nlpcraft.model.test.NCTestClientBuilder

Sets non-default API base URL.

setBody(String) - Method in class org.nlpcraft.model.NCQueryResult

Sets result body.

setEndpoint(String) - Method in class org.nlpcraft.model.test.NCTestClientBuilder

Sets non-default query result endpoint.

setHttpClientSupplier(Supplier<CloseableHttpClient>) - Method in class org.nlpcraft.model.test.NCTestClientBuilder

Sets non-default CloseableHttpClient custom supplier.

setRequestConfig(RequestConfig) - Method in class org.nlpcraft.model.test.NCTestClientBuilder

Sets optional HTTP REST client configuration parameters.

setSolver(NCIntentSolver) - Method in class org.nlpcraft.model.NCModelAdapter

Sets intent solver to be used for NCModel.query(NCQueryContext) method implementation.

setTokens(Collection<NCToken>) - Method in class org.nlpcraft.model.NCQueryResult

Sets a collection of tokens that was used to produce this query result.

setType(String) - Method in class org.nlpcraft.model.NCQueryResult

Set result type.

setUser(String, String) - Method in class org.nlpcraft.model.test.NCTestClientBuilder

Sets non-default user credentials.

solve(NCQueryContext) - Method in class org.nlpcraft.model.intent.NCIntentSolver

Finds the best matching intent for given sentence and calls its callback function to get the final query result.

T

TERM(Function<NCToken, Boolean>, int, int) - Constructor for class org.nlpcraft.model.intent.NCIntentSolver.TERM

Creates new term with given predicate and quantifiers.

TERM(Function<NCToken, Boolean>) - Constructor for class org.nlpcraft.model.intent.NCIntentSolver.TERM

Shortcut constructor for term with a predicate.

TERM(String, Function<NCToken, Boolean>, int, int) - Constructor for class org.nlpcraft.model.intent.NCIntentSolver.TERM

Creates new term with given parameters.

TERM(String, Function<NCToken, Boolean>) - Constructor for class org.nlpcraft.model.intent.NCIntentSolver.TERM

Shortcut constructor for term with a predicate and ID.

TERM(String, int, int) - Constructor for class org.nlpcraft.model.intent.NCIntentSolver.TERM

Shortcut constructor for term with a text-based rule.

TERM(String) - Constructor for class org.nlpcraft.model.intent.NCIntentSolver.TERM

Shortcut constructor for term with a text-based rule.

TERM(String, String, int, int) - Constructor for class org.nlpcraft.model.intent.NCIntentSolver.TERM

Shortcut constructor for term with a text-based rule.

TERM(String, String) - Constructor for class org.nlpcraft.model.intent.NCIntentSolver.TERM

Shortcut constructor for term with a text-based rule.

terminate() - Method in class org.nlpcraft.model.factories.basic.NCBasicModelFactory

terminate() - Method in class org.nlpcraft.model.factories.spring.NCSpringModelFactory

terminate() - Method in interface org.nlpcraft.model.NCModelFactory

Terminates this factory when probe stops.

testNum(NCToken, double, double) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Compares given value against the numeric condition in given nlpcraft:num token.

testNum(NCToken, float, float) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Compares given value against the numeric condition in given nlpcraft:num token.

testNum(NCToken, long) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Compares given value against the numeric condition in given nlpcraft:num token.

testNum(NCToken, int) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Compares given value against the numeric condition in given nlpcraft:num token.

testNum(NCToken, byte) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Compares given value against the numeric condition in given nlpcraft:num token.

testNum(NCToken, short) - Static method in class org.nlpcraft.model.utils.NCTokenUtils

Compares given value against the numeric condition in given nlpcraft:num token.

text(String) - Static method in class org.nlpcraft.model.NCQueryResult

Creates text result.

toString() - Method in class org.nlpcraft.model.intent.NCIntentSolver.AND

toString() - Method in class org.nlpcraft.model.intent.NCIntentSolver.INTENT

toString() - Method in class org.nlpcraft.model.intent.NCIntentSolver.NAND

toString() - Method in class org.nlpcraft.model.intent.NCIntentSolver.NOR

toString() - Method in class org.nlpcraft.model.intent.NCIntentSolver.NOT

toString() - Method in class org.nlpcraft.model.intent.NCIntentSolver.OR

toString() - Method in class org.nlpcraft.model.intent.NCIntentSolver.RULE

toString() - Method in class org.nlpcraft.model.intent.NCIntentSolver.TERM

toString() - Method in class org.nlpcraft.model.intent.NCIntentSolver.XNOR

toString() - Method in class org.nlpcraft.model.intent.NCIntentSolver.XOR

V

validateIntentSolver() - Method in class org.nlpcraft.model.NCModelAdapter

Validates set intent solver against this model, if intent solver was set.

W

weightedApply(NCToken) - Method in class org.nlpcraft.model.intent.NCIntentSolver.AND

weightedApply(NCToken) - Method in interface org.nlpcraft.model.intent.NCIntentSolver.COMBINATOR

Weighted predicate.

weightedApply(NCToken) - Method in class org.nlpcraft.model.intent.NCIntentSolver.NAND

weightedApply(NCToken) - Method in class org.nlpcraft.model.intent.NCIntentSolver.NOR

weightedApply(NCToken) - Method in class org.nlpcraft.model.intent.NCIntentSolver.NOT

weightedApply(NCToken) - Method in class org.nlpcraft.model.intent.NCIntentSolver.OR

weightedApply(NCToken) - Method in class org.nlpcraft.model.intent.NCIntentSolver.RULE

weightedApply(NCToken) - Method in class org.nlpcraft.model.intent.NCIntentSolver.XNOR

weightedApply(NCToken) - Method in class org.nlpcraft.model.intent.NCIntentSolver.XOR

write(NCModel, String) - Static method in class org.nlpcraft.model.tools.dump.NCDumpWriter

Writes data model dump file into specified directory.

X

XML_CONFIG_PROP - Static variable in class org.nlpcraft.model.factories.spring.NCSpringModelFactory

Configuration property for XML-based Spring configuration.

XNOR(NCIntentSolver.COMBINATOR...) - Constructor for class org.nlpcraft.model.intent.NCIntentSolver.XNOR

Creates new XNOR-combinator with a given list of inner combinators.

XNOR(String...) - Constructor for class org.nlpcraft.model.intent.NCIntentSolver.XNOR

Creates new XNOR-combinator with given text-based NCIntentSolver.RULEs:

      new XNOR("id == x:time", "~GEO_KIND == CITY", "value %% ^[Ff]oo[Bb]ar$");

XOR(NCIntentSolver.COMBINATOR...) - Constructor for class org.nlpcraft.model.intent.NCIntentSolver.XOR

Creates new XOR-combinator with a given list of inner combinators.

XOR(String...) - Constructor for class org.nlpcraft.model.intent.NCIntentSolver.XOR

Creates new XOR-combinator with given text-based NCIntentSolver.RULEs:

      new XOR("id == x:time", "~GEO_KIND == CITY", "value %% ^[Ff]oo[Bb]ar$");

Y

yaml(String) - Static method in class org.nlpcraft.model.NCQueryResult

Creates yaml result.

A B C D F G H I J M N O P Q R S T V W X Y