Skip navigation links
NLPCraft 0.4.0
A B C D G H I J L M N O P Q R S T W X Y 

A

addAdditionalStopWords(String...) - Method in class org.nlpcraft.model.builder.NCModelBuilder
Adds additional stopword.
addAdditionalStopWords(Collection<String>) - Method in class org.nlpcraft.model.builder.NCModelBuilder
Adds additional stopword.
addElement(NCElement) - Method in class org.nlpcraft.model.builder.NCModelBuilder
Adds model element.
addExamples(String...) - Method in class org.nlpcraft.model.builder.NCModelBuilder
Adds examples to the model.
addExamples(Collection<String>) - Method in class org.nlpcraft.model.builder.NCModelBuilder
Adds examples to the model.
addExcludedStopWords(String...) - Method in class org.nlpcraft.model.builder.NCModelBuilder
Adds excluding stopwords.
addExcludedStopWords(Collection<String>) - Method in class org.nlpcraft.model.builder.NCModelBuilder
Adds excluding stopwords.
addExcludedSynonyms(String...) - Method in class org.nlpcraft.model.builder.NCElementBuilder
Adds excluding synonyms.
addExcludedSynonyms(Collection<String>) - Method in class org.nlpcraft.model.builder.NCElementBuilder
Adds excluding synonyms.
addIntent(NCIntentSolver.INTENT, NCIntentSolver.IntentCallback) - Method in class org.nlpcraft.model.intent.NCIntentSolver
Adds given intent, its ID and its callback function to this solver.
addMacro(String, String) - Method in class org.nlpcraft.model.builder.NCModelBuilder
Adds macro.
addMetadata(String, Serializable) - Method in class org.nlpcraft.model.builder.NCElementBuilder
Adds user defined metadata.
addSuspiciousWords(String...) - Method in class org.nlpcraft.model.builder.NCModelBuilder
Adds suspicious stopword.
addSuspiciousWords(Collection<String>) - Method in class org.nlpcraft.model.builder.NCModelBuilder
Adds suspicious stopword.
addSynonyms(String...) - Method in class org.nlpcraft.model.builder.NCElementBuilder
Adds synonyms.
addSynonyms(Collection<String>) - Method in class org.nlpcraft.model.builder.NCElementBuilder
Adds synonyms.
addUserMetadata(String, Serializable) - Method in class org.nlpcraft.model.builder.NCModelBuilder
Adds model metadata.
addValue(String, Collection<String>) - Method in class org.nlpcraft.model.builder.NCElementBuilder
Adds value.
addValue(String, String...) - Method in class org.nlpcraft.model.builder.NCElementBuilder
Adds value.
AND(NCIntentSolver.Predicate...) - Constructor for class org.nlpcraft.model.intent.NCIntentSolver.AND
Creates new AND-combinator with given items.
AND(String...) - Constructor for class org.nlpcraft.model.intent.NCIntentSolver.AND
Creates new AND-combinator with given string-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.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.builder.NCElementBuilder
Builds and returns mode element.
build() - Method in class org.nlpcraft.model.builder.NCModelBuilder
Returns newly built model.
build() - Method in class org.nlpcraft.model.builder.NCModelDescriptorBuilder
Builds and returns model descriptor instance.
build() - Method in class org.nlpcraft.model.test.NCTestClientBuilder
Build new configured test client instance.

C

classPathFile(String) - Static method in class org.nlpcraft.model.builder.NCModelBuilder
Utility method for locating resource on a classpath.
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 new exact match, unordered intent with conversation support and number of free tokens equal to 3 (which is a good general default value).
CONV_INTENT(String, NCIntentSolver.Predicate, int, int) - Constructor for class org.nlpcraft.model.intent.NCIntentSolver.CONV_INTENT
Shortcut constructor for an exact match, 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 an exact match, 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_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_DATE_TOKENS - Static variable in interface org.nlpcraft.model.NCModel
Default value returned from NCModel.getMaxDateTokens() method.
DFLT_MAX_FREE_WORDS - Static variable in interface org.nlpcraft.model.NCModel
Default value returned from NCModel.getMaxFreeWords() method.
DFLT_MAX_FUNCTION_TOKENS - Static variable in interface org.nlpcraft.model.NCModel
Default value returned from NCModel.getMaxFunctionTokens() method.
DFLT_MAX_GEO_TOKENS - Static variable in interface org.nlpcraft.model.NCModel
Default value returned from NCModel.getMaxGeoTokens() method.
DFLT_MAX_NUM_TOKENS - Static variable in interface org.nlpcraft.model.NCModel
Default value returned from NCModel.getMaxNumTokens() 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_MIN_DATE_TOKENS - Static variable in interface org.nlpcraft.model.NCModel
Default value returned from NCModel.getMinDateTokens() method.
DFLT_MIN_FUNCTION_TOKENS - Static variable in interface org.nlpcraft.model.NCModel
Default value returned from NCModel.getMinFunctionTokens() method.
DFLT_MIN_GEO_TOKENS - Static variable in interface org.nlpcraft.model.NCModel
Default value returned from NCModel.getMinGeoTokens() method.
DFLT_MIN_NON_STOPWORDS - Static variable in interface org.nlpcraft.model.NCModel
Default value returned from NCModel.getMinNonStopwords() method.
DFLT_MIN_NUM_TOKENS - Static variable in interface org.nlpcraft.model.NCModel
Default value returned from NCModel.getMinNumTokens() 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.
discard() - Method in interface org.nlpcraft.model.NCModel
A callback before this model instance gets discarded.

G

getAdditionalStopWords() - Method in interface org.nlpcraft.model.NCModel
Gets an optional list of stopwords to add to the built-in ones.
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 nlp:coordinate token.
getCoordinateLongitude(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils
Gets coordinate longitude for this nlp: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 nlp:date token.
getDateTo(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils
Gets end timestamp of the date range nlp: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.
getDescriptor() - Method in interface org.nlpcraft.model.NCModel
Gets descriptor for this model.
getDescriptors() - Method in interface org.nlpcraft.model.NCModelProvider
Gets the list, possibly empty but never null, of model descriptors supported by this provider.
getDescriptors() - Method in class org.nlpcraft.model.NCModelProviderAdapter
 
getDocsUrl() - Method in interface org.nlpcraft.model.NCModel
Gets optional URL to model documentation.
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.
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.
getExamples() - Method in interface org.nlpcraft.model.NCModel
Gets an optional list of example sentences demonstrating what can be asked with this model.
getExcludedStopWords() - Method in interface org.nlpcraft.model.NCModel
Gets an optional list of stopwords to exclude from the built-in list of stopwords.
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 nlp:function} token is referencing.
getFunLimit(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils
Gets limit value if given nlp:function token represents LIMIT function.
getGeoCity(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils
Gets city for given nlp:geo token.
getGeoContinent(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils
Gets continent for given nlp:geo token.
getGeoCountry(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils
Gets country for given nlp:geo token.
getGeoLatitude(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils
Gets optional latitude of the given nlp:geo token.
getGeoLongitude(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils
Gets optional longitude of the given nlp:geo token.
getGeoMetro(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils
Gets metro area code for given nlp:geo token.
getGeoRegion(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils
Gets region for given nlp:geo token.
getGeoSubcontinent(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils
Gets subcontinent for given nlp:geo token.
getGroup() - Method in interface org.nlpcraft.model.NCElement
Gets optional group name this element belongs to.
getGroup() - Method in interface org.nlpcraft.model.NCToken
Gets optional group this token's element belongs to.
getId() - Method in class org.nlpcraft.model.intent.NCIntentSolver.INTENT
Gets ID of this intent.
getId() - Method in interface org.nlpcraft.model.NCElement
Gets unique ID of this element.
getId() - Method in interface org.nlpcraft.model.NCModelDescriptor
Gets unique, immutable ID of this model.
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.
getItems() - Method in class org.nlpcraft.model.intent.NCIntentSolver.TERM
Gets the collection of term items.
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.
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.
getMax() - Method in class org.nlpcraft.model.intent.NCIntentSolver.ITEM
Gets maximum inclusive quantifier.
getMaxDateTokens() - Method in interface org.nlpcraft.model.NCModel
Gets maximum number of nlp:date tokens above which user input will be automatically rejected.
getMaxFreeWords() - Method in interface org.nlpcraft.model.NCModel
Gets maximum number of free words until automatic rejection.
getMaxFunctionTokens() - Method in interface org.nlpcraft.model.NCModel
Gets maximum number of nlp:function tokens above which user input will be automatically rejected.
getMaxGeoTokens() - Method in interface org.nlpcraft.model.NCModel
Gets maximum number of nlp:geo tokens above which user input will be automatically rejected.
getMaxIndex(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils
Gets index of the last word in the given token.
getMaxNumTokens() - Method in interface org.nlpcraft.model.NCModel
Gets maximum number of nlp:num tokens above which user input will be automatically rejected.
getMaxSuspiciousWords() - Method in interface org.nlpcraft.model.NCModel
Gets maximum number of suspicious words until automatic rejection.
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.
getMaxTotalSynonyms() - Method in interface org.nlpcraft.model.NCModel
Total number of synonyms allowed per model.
getMaxUnknownWords() - Method in interface org.nlpcraft.model.NCModel
Gets maximum number of unknown words until automatic rejection.
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.
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 interface org.nlpcraft.model.NCToken
Gets token metadata.
getMin() - Method in class org.nlpcraft.model.intent.NCIntentSolver.ITEM
Gets minimum inclusive quantifier.
getMinDateTokens() - Method in interface org.nlpcraft.model.NCModel
Gets minimum number of nlp:date tokens below which user input will be automatically rejected.
getMinFunctionTokens() - Method in interface org.nlpcraft.model.NCModel
Gets minimum number of nlp:function tokens below which user input will be automatically rejected.
getMinGeoTokens() - Method in interface org.nlpcraft.model.NCModel
Gets minimum number of nlp:geo tokens below which user input will be automatically rejected.
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.
getMinNumTokens() - Method in interface org.nlpcraft.model.NCModel
Gets minimum number of nlp:num tokens below which user input will be automatically rejected.
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.
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.
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.
getModelProviders() - Method in interface org.nlpcraft.model.NCProbeContext
Gets model provider 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.NCModelDescriptor
Gets descriptive name of this model.
getNamedEntityText(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils
Gets optional named entity text for given token.
getNormalizedNamedEntityText(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils
Gets optional normalized named entity text for given token.
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.
getNumFrom(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils
Gets the start of the numeric range that satisfies the condition of given nlp:num token.
getNumIndex(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils
Gets optional index of another token in the sentence that this nlp: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 nlp:num token.
getNumUnit(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils
Gets optional unit for this nlp:num token, e.g.
getNumUnitType(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils
Gets optional unit type for this nlp:num token, e.g.
getOp() - Method in class org.nlpcraft.model.intent.NCIntentSolver.RULE
Gets binary operation of this rule.
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.
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.
getPattern() - Method in class org.nlpcraft.model.intent.NCIntentSolver.ITEM
Gets token predicate for this item.
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.
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.
getSparsity(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils
Gets numeric value of how sparse the given token is.
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.
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.
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 unordered set of tokens stored in the current conversation STM for current user and data model.
getTokens() - Method in interface org.nlpcraft.model.NCVariant
Gets this variant tokens.
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.
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.
getVariant() - Method in interface org.nlpcraft.model.intent.NCIntentSolverContext
Gets sentence variant that produced the matching for this intent.
getVariant() - Method in class org.nlpcraft.model.NCQueryResult
Gets optional sentence variant associated with this result.
getVariants() - Method in interface org.nlpcraft.model.NCSentence
Gets the list of all parsing variants for this sentence.
getVendorContact() - Method in interface org.nlpcraft.model.NCModel
Gets optional contact name of model vendor.
getVendorEmail() - Method in interface org.nlpcraft.model.NCModel
Gets optional email of model vendor.
getVendorName() - Method in interface org.nlpcraft.model.NCModel
Gets optional name of model vendor.
getVendorUrl() - Method in interface org.nlpcraft.model.NCModel
Gets optional URL of model vendor.
getVersion() - Method in interface org.nlpcraft.model.NCModelDescriptor
Gets the version of this model using semantic versioning.
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.

H

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

I

initialize(NCProbeContext) - Method in interface org.nlpcraft.model.NCModel
Probe calls this method to initialize the model when it gets deployed in the probe.
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 nlp:function token is ascending or descending.
isAvgFun(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils
Tests if given nlp:function token represents AVG function of some elements.
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 nlp: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.
isCorrelationFun(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils
Tests if given nlp: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 nlp: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 nlp: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 nlp: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 nlp: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 nlp: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.
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 nlp:function ID.
isGeo(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils
Whether or not this token has nlp:geo ID.
isGeoCity(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils
Tests if given nlp:geo token represents a city.
isGeoContinent(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils
Tests if given nlp:geo token represents a continent.
isGeoCountry(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils
Tests if given nlp:geo token represents a country.
isGeoMetro(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils
Tests if given nlp:geo token represents a metro.
isGeoRegion(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils
Tests if given nlp:geo token represents a region.
isGeoSubcontinent(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils
Tests if given nlp:geo token represents a subcontinent.
isGroupFun(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils
Tests if given nlp:function token represents GROUP function of some elements.
isIncludeConversation() - Method in class org.nlpcraft.model.intent.NCIntentSolver.INTENT
Gets conversation policy flag.
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 nlp:function token represents LIMIT function of some elements.
isMaxFun(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils
Tests if given nlp:function token represents MAX function of some elements.
isMinFun(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils
Tests if given nlp: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 nlp:nlp ID.
isNonEnglishAllowed() - Method in interface org.nlpcraft.model.NCModel
Whether or not to allow non-English language in user input.
isNoNounsAllowed() - Method in interface org.nlpcraft.model.NCModel
Whether or not to allow user input without a single noun.
isNotLatinCharsetAllowed() - Method in interface org.nlpcraft.model.NCModel
Whether or not to allow non-Latin charset in user input.
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.
isNumEqualCondition(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils
Whether given nlp:num token represents a equality condition.
isNumeric(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils
Whether or not this token has nlp: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 nlp: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 nlp:num token.
isNumFromNegativeInfCondition(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils
Whether given nlp:num token represents a range to negative infinity.
isNumNotEqualCondition(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils
Whether given nlp:num token represents a not-equality condition.
isNumRangeCondition(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils
Whether given nlp:num token represents a range condition.
isNumSingleValue(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils
Whether given nlp:num token represents a single numeric value vs.
isNumToInclusive(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils
Whether or not end of the numeric range is inclusive for given nlp:num token.
isNumToPositiveInfCondition(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils
Whether given nlp:num token represents a range to positive infinity.
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.
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(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 nlp:function token represents SORT function of some elements.
isStopWord(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils
Tests whether or not the given token is a stopword.
isSuccessful() - Method in interface org.nlpcraft.model.test.NCTestResult
Tests whether or not this result corresponds to a successful execution.
isSumFun(NCToken) - Static method in class org.nlpcraft.model.utils.NCTokenUtils
Tests if given nlp: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.
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 system 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 (vs.
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.
ITEM(NCIntentSolver.Predicate, int, int) - Constructor for class org.nlpcraft.model.intent.NCIntentSolver.ITEM
Creates new item with given parameters.

J

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

L

loadFromDump(String) - Method in class org.nlpcraft.model.builder.NCModelBuilder
Loads and creates data model proxy from given model dump.

M

makeModel(String) - Method in interface org.nlpcraft.model.NCModelProvider
Gets fully initialized model instance for given model ID.
makeModel(String) - Method in class org.nlpcraft.model.NCModelProviderAdapter
 

N

NAND(NCIntentSolver.Predicate...) - Constructor for class org.nlpcraft.model.intent.NCIntentSolver.NAND
Creates new NAND-combinator with given items.
NAND(String...) - Constructor for class org.nlpcraft.model.intent.NCIntentSolver.NAND
Creates new NAND-combinator with given string-based RULEs:
      new NAND("id == x:time", "~GEO_KIND == CITY", "value %% ^[Ff]oo[Bb]ar$");
NCBuilderException - Exception in org.nlpcraft.model.builder
Exception used by builders.
NCBuilderException(String) - Constructor for exception org.nlpcraft.model.builder.NCBuilderException
Creates builder exception with given message.
NCBuilderException(String, Throwable) - Constructor for exception org.nlpcraft.model.builder.NCBuilderException
Creates builder exception with given error message and cause.
NCConversationContext - Interface in org.nlpcraft.model
Conversation context.
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
Semantic model element.
NCElement.NCValue - Interface in org.nlpcraft.model
Element's value.
NCElementBuilder - Class in org.nlpcraft.model.builder
Model element builder for NCElement instances.
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 token solver.
NCIntentSolver(String) - Constructor for class org.nlpcraft.model.intent.NCIntentSolver
Creates new named token solver with given parameters and default not-found function.
NCIntentSolver(String, Supplier<NCQueryResult>) - Constructor for class org.nlpcraft.model.intent.NCIntentSolver
Creates new named token solver with given parameters.
NCIntentSolver.AND - Class in org.nlpcraft.model.intent
AND-combinator for token predicates.
NCIntentSolver.CONV_INTENT - Class in org.nlpcraft.model.intent
Convenient adapter for conversational intent.
NCIntentSolver.INTENT - Class in org.nlpcraft.model.intent
Token solver intent.
NCIntentSolver.IntentCallback - Interface in org.nlpcraft.model.intent
Callback provided by the user for an intent when it is matched.
NCIntentSolver.ITEM - Class in org.nlpcraft.model.intent
Item is a token predicate plus quantifiers.
NCIntentSolver.NAND - Class in org.nlpcraft.model.intent
NAND-combinator for token predicates.
NCIntentSolver.NON_CONV_INTENT - Class in org.nlpcraft.model.intent
Convenient adapter for non-conversational intent.
NCIntentSolver.NOR - Class in org.nlpcraft.model.intent
NOR-combinator for token predicates.
NCIntentSolver.OR - Class in org.nlpcraft.model.intent
OR-combinator for token predicates.
NCIntentSolver.Predicate - Interface in org.nlpcraft.model.intent
Marker type of pattern items.
NCIntentSolver.RULE - Class in org.nlpcraft.model.intent
Binary operator DSL based on declarative condition over token.
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 for token predicates.
NCIntentSolver.XOR - Class in org.nlpcraft.model.intent
XOR (exclusive OR)-combinator for token predicates.
NCIntentSolverContext - Interface in org.nlpcraft.model.intent
A context that is passed into callback of the matched intent.
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 semantic data model.
NCModelBuilder - Class in org.nlpcraft.model.builder
Model builder for NCModel instances.
NCModelDescriptor - Interface in org.nlpcraft.model
Model descriptor.
NCModelDescriptorBuilder - Class in org.nlpcraft.model.builder
Model descriptor builder for NCModelDescriptor instances.
NCModelProvider - Interface in org.nlpcraft.model
Model provider.
NCModelProviderAdapter - Class in org.nlpcraft.model
Convenient model provider adapter.
NCModelProviderAdapter() - Constructor for class org.nlpcraft.model.NCModelProviderAdapter
 
NCProbeContext - Interface in org.nlpcraft.model
Probe runtime context.
NCQueryContext - Interface in org.nlpcraft.model
Model query context.
NCQueryResult - Class in org.nlpcraft.model
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
When thrown indicates 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.
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
Test sentence result.
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
 
NCVariant - Interface in org.nlpcraft.model
Parsing variant of the user input represented as a list of tokens.
newBuilder() - Method in class org.nlpcraft.model.test.NCTestClientBuilder
Creates new builder instance with all defaults set.
newDescriptor() - Static method in class org.nlpcraft.model.builder.NCModelDescriptorBuilder
Creates new model descriptor builder.
newDescriptor(String, String, String) - Static method in class org.nlpcraft.model.builder.NCModelDescriptorBuilder
Creates new model descriptor builder with given parameters.
newElement() - Static method in class org.nlpcraft.model.builder.NCElementBuilder
Creates new element builder.
newElement(String) - Static method in class org.nlpcraft.model.builder.NCElementBuilder
Creates model element builder with given element ID.
newElement(String, String) - Static method in class org.nlpcraft.model.builder.NCElementBuilder
Creates model element builder with given element ID and group.
newJsonModel(String) - Static method in class org.nlpcraft.model.builder.NCModelBuilder
Creates new model builder and loads model definition from JSON file.
newJsonModel(InputStream) - Static method in class org.nlpcraft.model.builder.NCModelBuilder
Creates new model builder and loads JSON model definition from input stream.
newJsonStringModel(String) - Static method in class org.nlpcraft.model.builder.NCModelBuilder
Creates new model builder and loads JSON model definition from given JSON string.
newModel() - Static method in class org.nlpcraft.model.builder.NCModelBuilder
Creates new model builder.
newModel(String, String, String) - Static method in class org.nlpcraft.model.builder.NCModelBuilder
Creates new model builder with given parameters.
newYamlModel(String) - Static method in class org.nlpcraft.model.builder.NCModelBuilder
Creates new model builder and loads model definition from YAML file.
newYamlModel(InputStream) - Static method in class org.nlpcraft.model.builder.NCModelBuilder
Creates new model builder and loads YAML model definition from input stream.
newYamlStringModel(String) - Static method in class org.nlpcraft.model.builder.NCModelBuilder
Creates new model builder and loads YAML model definition from given YAML string.
NON_CONV_INTENT(String, NCIntentSolver.TERM...) - Constructor for class org.nlpcraft.model.intent.NCIntentSolver.NON_CONV_INTENT
Creates new exact match, unordered, intent without conversation support and number of free tokens equal to 3 (which is a good general default value).
NON_CONV_INTENT(String, NCIntentSolver.Predicate, int, int) - Constructor for class org.nlpcraft.model.intent.NCIntentSolver.NON_CONV_INTENT
Shortcut constructor for an exact match, 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 an exact match, unordered, non-conversational intent with just one TERM.
NOR(NCIntentSolver.Predicate...) - Constructor for class org.nlpcraft.model.intent.NCIntentSolver.NOR
Creates new NOR-combinator with given items.
NOR(String...) - Constructor for class org.nlpcraft.model.intent.NCIntentSolver.NOR
Creates new NOR-combinator with given string-based NCIntentSolver.RULEs:
      new NOR("id == x:time", "~GEO_KIND == CITY", "value %% ^[Ff]oo[Bb]ar$");

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.Predicate...) - Constructor for class org.nlpcraft.model.intent.NCIntentSolver.OR
Creates new OR-combinator with given items.
OR(String...) - Constructor for class org.nlpcraft.model.intent.NCIntentSolver.OR
Creates new OR-combinator with given string-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.builder - package org.nlpcraft.model.builder
Contains model builder.
org.nlpcraft.model.intent - package org.nlpcraft.model.intent
Contains intent-based input matcher.
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

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 nlp: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.

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.
setDescription(String) - Method in class org.nlpcraft.model.builder.NCElementBuilder
Sets element description.
setDescription(String) - Method in class org.nlpcraft.model.builder.NCModelBuilder
Sets model descriptor.
setDescriptor(NCModelDescriptor) - Method in class org.nlpcraft.model.builder.NCModelBuilder
Sets model descriptor.
setDiscardFunction(Runnable) - Method in class org.nlpcraft.model.builder.NCModelBuilder
Sets model's discard function.
setDocsUrl(String) - Method in class org.nlpcraft.model.builder.NCModelBuilder
Sets NCModel.getDocsUrl() configuration value.
setDupSynonymsAllowed(boolean) - Method in class org.nlpcraft.model.builder.NCModelBuilder
Sets NCModel.isDupSynonymsAllowed() configuration value.
setEndpoint(String) - Method in class org.nlpcraft.model.test.NCTestClientBuilder
Sets non-default query result endpoint.
setGroup(String) - Method in class org.nlpcraft.model.builder.NCElementBuilder
Sets group.
setHttpClientSupplier(Supplier<CloseableHttpClient>) - Method in class org.nlpcraft.model.test.NCTestClientBuilder
Sets non-default CloseableHttpClient custom supplier.
setId(String) - Method in class org.nlpcraft.model.builder.NCElementBuilder
Sets element ID.
setId(String) - Method in class org.nlpcraft.model.builder.NCModelDescriptorBuilder
Sets unique, immutable ID of the model.
setInitFunction(Consumer<NCProbeContext>) - Method in class org.nlpcraft.model.builder.NCModelBuilder
Sets model's initialize function.
setJiggleFactor(int) - Method in class org.nlpcraft.model.builder.NCModelBuilder
Sets NCModel.getJiggleFactor() configuration value.
setMaxDateTokens(int) - Method in class org.nlpcraft.model.builder.NCModelBuilder
Sets NCModel.getMaxDateTokens() configuration value.
setMaxFreeWords(int) - Method in class org.nlpcraft.model.builder.NCModelBuilder
Sets NCModel.getMaxFreeWords() configuration value.
setMaxFunctionTokens(int) - Method in class org.nlpcraft.model.builder.NCModelBuilder
Sets NCModel.getMaxFunctionTokens() configuration value.
setMaxGeoTokens(int) - Method in class org.nlpcraft.model.builder.NCModelBuilder
Sets NCModel.getMaxGeoTokens() configuration value.
setMaxNumTokens(int) - Method in class org.nlpcraft.model.builder.NCModelBuilder
Sets NCModel.getMaxNumTokens() configuration value.
setMaxSuspiciousWords(int) - Method in class org.nlpcraft.model.builder.NCModelBuilder
Sets NCModel.getMaxSuspiciousWords() configuration value.
setMaxTokens(int) - Method in class org.nlpcraft.model.builder.NCModelBuilder
Sets NCModel.getMaxTokens() configuration value.
setMaxTotalSynonyms(int) - Method in class org.nlpcraft.model.builder.NCModelBuilder
Sets NCModel.getMaxTotalSynonyms() configuration value.
setMaxUnknownWords(int) - Method in class org.nlpcraft.model.builder.NCModelBuilder
Sets NCModel.getMaxUnknownWords() configuration value.
setMaxWords(int) - Method in class org.nlpcraft.model.builder.NCModelBuilder
Sets NCModel.getMaxWords() configuration value.
setMinDateTokens(int) - Method in class org.nlpcraft.model.builder.NCModelBuilder
Sets NCModel.getMinDateTokens() configuration value.
setMinFunctionTokens(int) - Method in class org.nlpcraft.model.builder.NCModelBuilder
Sets NCModel.getMinFunctionTokens() configuration value.
setMinGeoTokens(int) - Method in class org.nlpcraft.model.builder.NCModelBuilder
Sets NCModel.getMinGeoTokens() configuration value.
setMinNonStopwords(int) - Method in class org.nlpcraft.model.builder.NCModelBuilder
Sets NCModel.getMinNonStopwords() configuration value.
setMinNumTokens(int) - Method in class org.nlpcraft.model.builder.NCModelBuilder
Sets NCModel.getMinNumTokens() configuration value.
setMinTokens(int) - Method in class org.nlpcraft.model.builder.NCModelBuilder
Sets NCModel.getMinTokens() configuration value.
setMinWords(int) - Method in class org.nlpcraft.model.builder.NCModelBuilder
Sets NCModel.getMinWords() configuration value.
setName(String) - Method in class org.nlpcraft.model.builder.NCModelDescriptorBuilder
Sets descriptive name of this model.
setNonEnglishAllowed(boolean) - Method in class org.nlpcraft.model.builder.NCModelBuilder
Sets NCModel.isNonEnglishAllowed() configuration value.
setNoNounsAllowed(boolean) - Method in class org.nlpcraft.model.builder.NCModelBuilder
Sets NCModel.isNoNounsAllowed() configuration value.
setNotLatinCharsetAllowed(boolean) - Method in class org.nlpcraft.model.builder.NCModelBuilder
Sets NCModel.isNotLatinCharsetAllowed() configuration value.
setNoUserTokensAllowed(boolean) - Method in class org.nlpcraft.model.builder.NCModelBuilder
Sets NCModel.isNoUserTokensAllowed() configuration value.
setParentId(String) - Method in class org.nlpcraft.model.builder.NCElementBuilder
Sets parent ID.
setPermutateSynonyms(boolean) - Method in class org.nlpcraft.model.builder.NCModelBuilder
Sets NCModel.isPermutateSynonyms() configuration value.
setQueryFunction(Function<NCQueryContext, NCQueryResult>) - Method in class org.nlpcraft.model.builder.NCModelBuilder
Sets query function.
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.builder.NCModelBuilder
Sets intent solver to be used for this model's NCModel.query(NCQueryContext) method implementation.
setSwearWordsAllowed(boolean) - Method in class org.nlpcraft.model.builder.NCModelBuilder
Sets NCModel.isSwearWordsAllowed() configuration value.
setType(String) - Method in class org.nlpcraft.model.NCQueryResult
Set result type.
setup(NCModel...) - Method in class org.nlpcraft.model.NCModelProviderAdapter
Sets up this provider with given model instances.
setup(Collection<NCModel>) - Method in class org.nlpcraft.model.NCModelProviderAdapter
Sets up this provider with given model instances.
setUser(String, String) - Method in class org.nlpcraft.model.test.NCTestClientBuilder
Sets non-default user credentials.
setVariant(NCVariant) - Method in class org.nlpcraft.model.NCQueryResult
Sets optional sentence variant this result originated from.
setVendorContact(String) - Method in class org.nlpcraft.model.builder.NCModelBuilder
Sets NCModel.getVendorContact() configuration value.
setVendorEmail(String) - Method in class org.nlpcraft.model.builder.NCModelBuilder
Sets NCModel.getVendorEmail() configuration value.
setVendorName(String) - Method in class org.nlpcraft.model.builder.NCModelBuilder
Sets NCModel.getVendorName() configuration value.
setVendorUrl(String) - Method in class org.nlpcraft.model.builder.NCModelBuilder
Sets NCModel.getVendorUrl() configuration value.
setVersion(String) - Method in class org.nlpcraft.model.builder.NCModelDescriptorBuilder
Sets version of this model using semantic versioning compatible with (www.semver.org) specification.
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(NCIntentSolver.ITEM...) - Constructor for class org.nlpcraft.model.intent.NCIntentSolver.TERM
Creates new term with given parameters.
TERM(NCIntentSolver.Predicate, int, int) - Constructor for class org.nlpcraft.model.intent.NCIntentSolver.TERM
Shortcut constructor for term with a single item.
TERM(String, int, int) - Constructor for class org.nlpcraft.model.intent.NCIntentSolver.TERM
Shortcut constructor for term with a single string-based rule.
testNum(NCToken, double, double) - Static method in class org.nlpcraft.model.utils.NCTokenUtils
Compares given value against the numeric condition in given nlp:num token.
testNum(NCToken, float, float) - Static method in class org.nlpcraft.model.utils.NCTokenUtils
Compares given value against the numeric condition in given nlp:num token.
testNum(NCToken, long) - Static method in class org.nlpcraft.model.utils.NCTokenUtils
Compares given value against the numeric condition in given nlp:num token.
testNum(NCToken, int) - Static method in class org.nlpcraft.model.utils.NCTokenUtils
Compares given value against the numeric condition in given nlp:num token.
testNum(NCToken, byte) - Static method in class org.nlpcraft.model.utils.NCTokenUtils
Compares given value against the numeric condition in given nlp:num token.
testNum(NCToken, short) - Static method in class org.nlpcraft.model.utils.NCTokenUtils
Compares given value against the numeric condition in given nlp: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.ITEM
 
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.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
 
twoOrMore(String, String) - Method in interface org.nlpcraft.model.intent.NCIntentSolver.Predicate
 

W

write(NCModel, NCIntentSolver, String) - Static method in class org.nlpcraft.model.tools.dump.NCDumpWriter
Writes data model dump file into specified directory.

X

XNOR(NCIntentSolver.Predicate...) - Constructor for class org.nlpcraft.model.intent.NCIntentSolver.XNOR
Creates new XNOR-combinator with given items.
XNOR(String...) - Constructor for class org.nlpcraft.model.intent.NCIntentSolver.XNOR
Creates new XNOR-combinator with given string-based NCIntentSolver.RULEs:
      new XNOR("id == x:time", "~GEO_KIND == CITY", "value %% ^[Ff]oo[Bb]ar$");
XOR(NCIntentSolver.Predicate...) - Constructor for class org.nlpcraft.model.intent.NCIntentSolver.XOR
Creates new XOR-combinator with given items.
XOR(String...) - Constructor for class org.nlpcraft.model.intent.NCIntentSolver.XOR
Creates new XOR-combinator with given string-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 G H I J L M N O P Q R S T W X Y 
Skip navigation links
NLPCraft 0.4.0 Watch Star Fork

Copyright © 2013-2019 NLPCraft Project. All rights reserved.