A B C D E F G H I J L M N O P R S T U V X Y
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- ask(String) - Method in interface org.apache.nlpcraft.model.tools.test.NCTestClient
-
Tests single sentence and returns its result.
B
- build() - Method in class org.apache.nlpcraft.model.tools.test.NCTestClientBuilder
-
Build new configured test client instance.
- build(NCSqlSchema, NCVariant) - Static method in class org.apache.nlpcraft.model.tools.sqlgen.NCSqlExtractorBuilder
-
Builds and returns new SQL extractor for given SQL schema and parsing variant.
C
- clearConversation() - Method in interface org.apache.nlpcraft.model.tools.test.NCTestClient
-
Clears conversation for this test client.
- clearDialog(Predicate<String>) - Method in interface org.apache.nlpcraft.model.NCConversation
-
Clears history of matched intents using given intent predicate.
- clearStm(Predicate<NCToken>) - Method in interface org.apache.nlpcraft.model.NCConversation
-
Removes all tokens satisfying given predicate from the conversation STM.
- close() - Method in interface org.apache.nlpcraft.model.tools.test.NCTestClient
-
Closes test client connection to the server.
D
- DFLT_BASEURL - Static variable in class org.apache.nlpcraft.model.tools.test.NCTestClientBuilder
-
Default public REST API URL (endpoint).
- DFLT_CONV_DEPTH - Static variable in interface org.apache.nlpcraft.model.NCModelView
-
Default value for
NCModelView.getConversationDepth()
method. - DFLT_CONV_TIMEOUT_MS - Static variable in interface org.apache.nlpcraft.model.NCModelView
-
Default value for
NCModelView.getConversationTimeout()
method. - DFLT_EMAIL - Static variable in class org.apache.nlpcraft.model.tools.test.NCTestClientBuilder
-
Default client email.
- DFLT_EMBEDDED - Static variable in class org.apache.nlpcraft.model.tools.test.NCTestClientBuilder
-
Default embedded mode flag.
- DFLT_ENABLED_BUILTIN_TOKENS - Static variable in interface org.apache.nlpcraft.model.NCModelView
-
Default set of enabled built-in tokens.
- DFLT_IS_DUP_SYNONYMS_ALLOWED - Static variable in interface org.apache.nlpcraft.model.NCModelView
-
Default value for
NCModelView.isDupSynonymsAllowed()
method. - DFLT_IS_NO_NOUNS_ALLOWED - Static variable in interface org.apache.nlpcraft.model.NCModelView
-
Default value for
NCModelView.isNoNounsAllowed()
method. - DFLT_IS_NO_USER_TOKENS_ALLOWED - Static variable in interface org.apache.nlpcraft.model.NCModelView
-
Default value for
NCModelView.isNoUserTokensAllowed()
method. - DFLT_IS_NON_ENGLISH_ALLOWED - Static variable in interface org.apache.nlpcraft.model.NCModelView
-
Default value for
NCModelView.isNonEnglishAllowed()
method. - DFLT_IS_NOT_LATIN_CHARSET_ALLOWED - Static variable in interface org.apache.nlpcraft.model.NCModelView
-
Default value for
NCModelView.isNotLatinCharsetAllowed()
method. - DFLT_IS_PERMUTATE_SYNONYMS - Static variable in interface org.apache.nlpcraft.model.NCModelView
-
Default value for
NCModelView.isPermutateSynonyms()
method. - DFLT_IS_SWEAR_WORDS_ALLOWED - Static variable in interface org.apache.nlpcraft.model.NCModelView
-
Default value for
NCModelView.isSwearWordsAllowed()
method. - DFLT_JIGGLE_FACTOR - Static variable in interface org.apache.nlpcraft.model.NCModelView
-
Default value for
NCModelView.getJiggleFactor()
method. - DFLT_MAX_ELEMENT_SYNONYMS - Static variable in interface org.apache.nlpcraft.model.NCModelView
-
Default value for
NCModelView.getMaxElementSynonyms()
method. - DFLT_MAX_FREE_WORDS - Static variable in interface org.apache.nlpcraft.model.NCModelView
-
Default value for
NCModelView.getMaxFreeWords()
method. - DFLT_MAX_SUSPICIOUS_WORDS - Static variable in interface org.apache.nlpcraft.model.NCModelView
-
Default value for
NCModelView.getMaxSuspiciousWords()
method. - DFLT_MAX_SYNONYMS_THRESHOLD_ERROR - Static variable in interface org.apache.nlpcraft.model.NCModelView
-
Default value for
NCModelView.isMaxSynonymsThresholdError()
method. - DFLT_MAX_TOKENS - Static variable in interface org.apache.nlpcraft.model.NCModelView
-
Default value for
NCModelView.getMaxTokens()
method. - DFLT_MAX_TOTAL_SYNONYMS - Static variable in interface org.apache.nlpcraft.model.NCModelView
-
Default value for
NCModelView.getMaxTotalSynonyms()
method. - DFLT_MAX_UNKNOWN_WORDS - Static variable in interface org.apache.nlpcraft.model.NCModelView
-
Default value for
NCModelView.getMaxUnknownWords()
method. - DFLT_MAX_WAIT_TIME - Static variable in class org.apache.nlpcraft.model.tools.test.NCTestClientBuilder
-
Maximum test time.
- DFLT_MAX_WORDS - Static variable in interface org.apache.nlpcraft.model.NCModelView
-
Default value for
NCModelView.getMaxWords()
method. - DFLT_METADATA - Static variable in interface org.apache.nlpcraft.model.NCModelView
-
Default value for
NCModelView.getJiggleFactor()
method. - DFLT_MIN_NON_STOPWORDS - Static variable in interface org.apache.nlpcraft.model.NCModelView
-
Default value for
NCModelView.getMinNonStopwords()
method. - DFLT_MIN_TOKENS - Static variable in interface org.apache.nlpcraft.model.NCModelView
-
Default value for
NCModelView.getMinTokens()
method. - DFLT_MIN_WORDS - Static variable in interface org.apache.nlpcraft.model.NCModelView
-
Default value for
NCModelView.getMinWords()
method. - DFLT_PASSWORD - Static variable in class org.apache.nlpcraft.model.tools.test.NCTestClientBuilder
-
Default client password.
- DFLT_RESP_LOG - Static variable in class org.apache.nlpcraft.model.tools.test.NCTestClientBuilder
-
Default response log flag.
E
- extractColumn(NCToken) - Method in interface org.apache.nlpcraft.model.tools.sqlgen.NCSqlExtractor
-
Extract column object from the token.
- extractDateRange(NCToken) - Method in interface org.apache.nlpcraft.model.tools.sqlgen.NCSqlExtractor
-
Extract date range object from given
nlpcraft:date
token. - extractLimit(NCToken) - Method in interface org.apache.nlpcraft.model.tools.sqlgen.NCSqlExtractor
-
Extracts limit object from given
nlpcraft:limit
token. - extractSort(NCToken) - Method in interface org.apache.nlpcraft.model.tools.sqlgen.NCSqlExtractor
-
Extracts sort object from given
nlpcraft:sort
token. - extractTable(NCToken) - Method in interface org.apache.nlpcraft.model.tools.sqlgen.NCSqlExtractor
-
Extract table object from the token.
F
- findPartTokens(String...) - Method in interface org.apache.nlpcraft.model.NCToken
-
Gets the list of all part tokens with given IDs or aliases traversing entire part token graph.
G
- getAdditionalStopWords() - Method in class org.apache.nlpcraft.model.NCModelFileAdapter
- getAdditionalStopWords() - Method in interface org.apache.nlpcraft.model.NCModelView
-
Gets an optional list of stopwords to add to the built-in ones.
- getAddress() - Method in interface org.apache.nlpcraft.model.NCCompany
-
Gets optional postal address of the company.
- getAliases() - Method in interface org.apache.nlpcraft.model.NCToken
-
Gets optional list of aliases this token is known by.
- getAllColumns() - Method in interface org.apache.nlpcraft.model.tools.sqlgen.NCSqlSchema
-
Creates and returns collection of all SQL columns across all tables in given schema.
- getAncestors() - Method in interface org.apache.nlpcraft.model.NCToken
-
Gets the list of all parent IDs from this token up to the root.
- getAvatarUrl() - Method in interface org.apache.nlpcraft.model.NCUser
-
Gets optional user avatar URL (
data:
orhttp:
scheme URLs). - getBody() - Method in class org.apache.nlpcraft.model.NCResult
-
Gets result body.
- getBody() - Method in interface org.apache.nlpcraft.model.tools.embedded.NCEmbeddedResult
-
Gets optional result body.
- getCity() - Method in interface org.apache.nlpcraft.model.NCCompany
-
Gets optional city of the company.
- getClientAgent() - Method in interface org.apache.nlpcraft.model.NCRequest
-
Gets string representation of the user client agent that made the call with this request.
- getColumn() - Method in interface org.apache.nlpcraft.model.tools.sqlgen.NCSqlColumn
-
Gets native name of this column.
- getColumn() - Method in interface org.apache.nlpcraft.model.tools.sqlgen.NCSqlLimit
-
Gets SQL column this limit is applied to.
- getColumn() - Method in interface org.apache.nlpcraft.model.tools.sqlgen.NCSqlSort
-
Gets SQL column this sort is applied to.
- getColumns() - Method in interface org.apache.nlpcraft.model.tools.sqlgen.NCSqlTable
-
Gets collections of this table columns.
- getCompany() - Method in interface org.apache.nlpcraft.model.NCRequest
-
Gets descriptor of the user's company on behalf of which this request was submitted.
- getContext() - Method in interface org.apache.nlpcraft.model.NCIntentMatch
-
Gets context of the user input query.
- getConversation() - Method in interface org.apache.nlpcraft.model.NCContext
-
Gets current conversation for the query's user and data model.
- getConversationDepth() - Method in class org.apache.nlpcraft.model.NCModelFileAdapter
- getConversationDepth() - Method in interface org.apache.nlpcraft.model.NCModelView
-
Gets maximum number of requests after which the unused conversation element is automatically "forgotten".
- getConversationTimeout() - Method in class org.apache.nlpcraft.model.NCModelFileAdapter
- getConversationTimeout() - Method in interface org.apache.nlpcraft.model.NCModelView
-
Gets timeout in ms after which the unused conversation element is automatically "forgotten".
- getCountry() - Method in interface org.apache.nlpcraft.model.NCCompany
-
Gets optional country of the company.
- getData() - Method in interface org.apache.nlpcraft.model.NCRequest
-
Gets optional JSON data passed in with user request.
- getDataType() - Method in interface org.apache.nlpcraft.model.tools.sqlgen.NCSqlColumn
-
Gets JDBC data type for this column.
- getDefaultDate() - Method in interface org.apache.nlpcraft.model.tools.sqlgen.NCSqlTable
-
Gets a column that defines a default date for this table.
- getDefaultSelect() - Method in interface org.apache.nlpcraft.model.tools.sqlgen.NCSqlTable
-
Gets the list of the column names for the default select set.
- getDefaultSort() - Method in interface org.apache.nlpcraft.model.tools.sqlgen.NCSqlTable
-
Gets default sort descriptor.
- getDescription() - Method in interface org.apache.nlpcraft.model.NCElement
-
Gets optional element description.
- getDescription() - Method in class org.apache.nlpcraft.model.NCModelFileAdapter
- getDescription() - Method in interface org.apache.nlpcraft.model.NCModelView
-
Gets optional short model description.
- getDialogFlow() - Method in interface org.apache.nlpcraft.model.NCConversation
-
Gets IDs for the previously matched intents sorted from oldest to newest for the current user and data model.
- getElementId() - Method in interface org.apache.nlpcraft.model.NCCustomElement
-
Gets ID of the detected model element.
- getElements() - Method in class org.apache.nlpcraft.model.NCModelFileAdapter
- getElements() - Method in interface org.apache.nlpcraft.model.NCModelView
-
Gets a set of model elements or named entities.
- getEmail() - Method in interface org.apache.nlpcraft.model.NCUser
-
Gets email of the user.
- getEnabledBuiltInTokens() - Method in class org.apache.nlpcraft.model.NCModelFileAdapter
- getEnabledBuiltInTokens() - Method in interface org.apache.nlpcraft.model.NCModelView
-
Gets a set of IDs for built-in named entities (tokens) that should be enabled and detected for this model.
- getEndCharIndex() - Method in interface org.apache.nlpcraft.model.NCCustomWord
-
Gets end character index of this word in the original text.
- getEndCharIndex() - Method in interface org.apache.nlpcraft.model.NCToken
-
Gets end character index of this token in the original text.
- getErrorCode() - Method in interface org.apache.nlpcraft.model.tools.embedded.NCEmbeddedResult
-
Gets optional error code.
- getErrorMessage() - Method in interface org.apache.nlpcraft.model.tools.embedded.NCEmbeddedResult
-
Gets optional error message.
- getExcludedStopWords() - Method in class org.apache.nlpcraft.model.NCModelFileAdapter
- getExcludedStopWords() - Method in interface org.apache.nlpcraft.model.NCModelView
-
Gets an optional list of stopwords to exclude from the built-in list of stopwords.
- getExtraTables() - Method in interface org.apache.nlpcraft.model.tools.sqlgen.NCSqlTable
-
Gets the list of extra tables this table is referencing.
- getFirstName() - Method in interface org.apache.nlpcraft.model.NCUser
-
Gets first name of the user.
- getFrom() - Method in interface org.apache.nlpcraft.model.tools.sqlgen.NCSqlDateRange
-
Gets 'from' timestamp.
- getFromColumns() - Method in interface org.apache.nlpcraft.model.tools.sqlgen.NCSqlJoin
-
Gets the list of columns in originating table.
- getFromTable() - Method in interface org.apache.nlpcraft.model.tools.sqlgen.NCSqlJoin
-
Gets the name of the originating table.
- getGroups() - Method in interface org.apache.nlpcraft.model.NCElement
-
Gets the list of groups this elements belongs to.
- getGroups() - Method in interface org.apache.nlpcraft.model.NCToken
-
Gets the list of groups this token belongs to.
- getId() - Method in interface org.apache.nlpcraft.model.NCCompany
-
Gets ID of the company.
- getId() - Method in interface org.apache.nlpcraft.model.NCElement
-
Gets unique ID of this element.
- getId() - Method in class org.apache.nlpcraft.model.NCModelAdapter
- getId() - Method in class org.apache.nlpcraft.model.NCModelFileAdapter
- getId() - Method in interface org.apache.nlpcraft.model.NCModelView
-
Gets unique, immutable ID of this model.
- getId() - Method in interface org.apache.nlpcraft.model.NCToken
-
If this token represents user defined model element this method returns the ID of that element.
- getId() - Method in interface org.apache.nlpcraft.model.NCUser
-
Gets ID of this user.
- getIndex() - Method in interface org.apache.nlpcraft.model.NCToken
-
A shortcut method that gets index of this token in the sentence.
- getIntentId() - Method in interface org.apache.nlpcraft.model.NCIntentMatch
-
Gets ID of the matched intent.
- getIntentId() - Method in class org.apache.nlpcraft.model.NCResult
-
Get optional intent ID.
- getIntentId() - Method in interface org.apache.nlpcraft.model.tools.embedded.NCEmbeddedResult
-
Gets ID of the intent that was matched against the input sentence.
- getIntentId() - Method in interface org.apache.nlpcraft.model.tools.test.NCTestResult
-
Gets ID of the intent that was matched against the input sentence.
- getIntents() - Method in class org.apache.nlpcraft.model.NCModelFileAdapter
-
Gets list of intents declared in JSON/YML model definition, if any.
- getIntentTokens() - Method in interface org.apache.nlpcraft.model.NCIntentMatch
-
Gets a subset of tokens representing matched intent.
- getJiggleFactor() - Method in class org.apache.nlpcraft.model.NCModelFileAdapter
- getJiggleFactor() - Method in interface org.apache.nlpcraft.model.NCModelView
-
Measure of how much sparsity is allowed when user input words are reordered in attempt to match the multi-word synonyms.
- getJoins() - Method in interface org.apache.nlpcraft.model.tools.sqlgen.NCSqlSchema
-
Gets collection of joins for this SQL schema.
- getLastName() - Method in interface org.apache.nlpcraft.model.NCUser
-
Gets last name of the user.
- getLemma() - Method in interface org.apache.nlpcraft.model.NCCustomWord
-
Gets the lemma of this word, a canonical form of this word.
- getLimit() - Method in interface org.apache.nlpcraft.model.tools.sqlgen.NCSqlLimit
-
Gets the numeric value of the limit.
- getLogHolder() - Method in interface org.apache.nlpcraft.model.tools.embedded.NCEmbeddedResult
-
Gets request processing log holder as JSON string.
- getMacros() - Method in class org.apache.nlpcraft.model.NCModelFileAdapter
- getMacros() - Method in interface org.apache.nlpcraft.model.NCModelView
-
Gets an optional map of macros to be used in this model.
- getMatchedTokens() - Method in interface org.apache.nlpcraft.model.NCVariant
-
Utility method that returns all non-freeword tokens.
- getMaxElementSynonyms() - Method in class org.apache.nlpcraft.model.NCModelFileAdapter
- getMaxElementSynonyms() - Method in interface org.apache.nlpcraft.model.NCModelView
-
Gets maximum number of unique synonyms per model element after which either warning or error will be triggered.
- getMaxFreeWords() - Method in class org.apache.nlpcraft.model.NCModelFileAdapter
- getMaxFreeWords() - Method in interface org.apache.nlpcraft.model.NCModelView
-
Gets maximum number of free words until automatic rejection.
- getMaxSuspiciousWords() - Method in class org.apache.nlpcraft.model.NCModelFileAdapter
- getMaxSuspiciousWords() - Method in interface org.apache.nlpcraft.model.NCModelView
-
Gets maximum number of suspicious words until automatic rejection.
- getMaxTokens() - Method in class org.apache.nlpcraft.model.NCModelFileAdapter
- getMaxTokens() - Method in interface org.apache.nlpcraft.model.NCModelView
-
Gets maximum number of all tokens (system and user defined) above which user input will be automatically rejected as too long.
- getMaxTotalSynonyms() - Method in class org.apache.nlpcraft.model.NCModelFileAdapter
- getMaxTotalSynonyms() - Method in interface org.apache.nlpcraft.model.NCModelView
-
Total number of synonyms allowed per model.
- getMaxUnknownWords() - Method in class org.apache.nlpcraft.model.NCModelFileAdapter
- getMaxUnknownWords() - Method in interface org.apache.nlpcraft.model.NCModelView
-
Gets maximum number of unknown words until automatic rejection.
- getMaxWords() - Method in class org.apache.nlpcraft.model.NCModelFileAdapter
- getMaxWords() - Method in interface org.apache.nlpcraft.model.NCModelView
-
Gets maximum word count (including stopwords) above which user input will be automatically rejected as too long.
- getMetadata() - Method in interface org.apache.nlpcraft.model.NCCustomElement
-
Optional metadata that will be added to the resulting
NCToken
object and that would be accessible viaNCMetadata.getMetadata()
. - getMetadata() - Method in interface org.apache.nlpcraft.model.NCElement
-
Gets optional user-defined element's metadata.
- getMetadata() - Method in interface org.apache.nlpcraft.model.NCMetadata
-
Gets metadata.
- getMetadata() - Method in class org.apache.nlpcraft.model.NCModelFileAdapter
- getMetadata() - Method in interface org.apache.nlpcraft.model.NCModelView
-
Gets optional user defined model metadata that can be set by the developer and accessed later.
- getMinNonStopwords() - Method in class org.apache.nlpcraft.model.NCModelFileAdapter
- getMinNonStopwords() - Method in interface org.apache.nlpcraft.model.NCModelView
-
Gets minimum word count (excluding stopwords) below which user input will be automatically rejected as ambiguous sentence.
- getMinTokens() - Method in class org.apache.nlpcraft.model.NCModelFileAdapter
- getMinTokens() - Method in interface org.apache.nlpcraft.model.NCModelView
-
Gets minimum number of all tokens (system and user defined) below which user input will be automatically rejected as too short.
- getMinWords() - Method in class org.apache.nlpcraft.model.NCModelFileAdapter
- getMinWords() - Method in interface org.apache.nlpcraft.model.NCModelView
-
Gets minimum word count (including stopwords) below which user input will be automatically rejected as too short.
- getModel() - Method in interface org.apache.nlpcraft.model.NCContext
-
Gets model instance for this query.
- getModel() - Method in interface org.apache.nlpcraft.model.NCToken
-
Gets reference to the model this token belongs to.
- getModelId() - Method in interface org.apache.nlpcraft.model.tools.embedded.NCEmbeddedResult
-
Gets the ID of the model that produced this result.
- getModelId() - Method in interface org.apache.nlpcraft.model.tools.test.NCTestResult
-
Gets model ID the test sentence was sent with.
- getName() - Method in interface org.apache.nlpcraft.model.NCCompany
-
Gets name of the company.
- getName() - Method in class org.apache.nlpcraft.model.NCModelAdapter
- getName() - Method in class org.apache.nlpcraft.model.NCModelFileAdapter
- getName() - Method in interface org.apache.nlpcraft.model.NCModelView
-
Gets descriptive name of this model.
- getName() - Method in interface org.apache.nlpcraft.model.NCValue
-
Gets value name.
- getNormalizedText() - Method in interface org.apache.nlpcraft.model.NCCustomWord
-
Gets normalized text for this word.
- getNormalizedText() - Method in interface org.apache.nlpcraft.model.NCRequest
-
Gets normalized text of the user input.
- getOrigin() - Method in class org.apache.nlpcraft.model.NCModelFileAdapter
-
Gets this file model adapter origin (file path or URI).
- getOriginalText() - Method in interface org.apache.nlpcraft.model.NCCustomWord
-
Gets original text for this word.
- getOriginalText() - Method in interface org.apache.nlpcraft.model.NCToken
-
A shortcut method that gets original user input text for this token.
- getOriginalText() - Method in interface org.apache.nlpcraft.model.tools.embedded.NCEmbeddedResult
-
Gets original text of the request that produced this result.
- getParentId() - Method in interface org.apache.nlpcraft.model.NCElement
-
Gets optional ID of the immediate parent element.
- getParentId() - Method in interface org.apache.nlpcraft.model.NCToken
-
Gets the optional parent ID of the model element this token represents.
- getParsers() - Method in class org.apache.nlpcraft.model.NCModelFileAdapter
- getParsers() - Method in interface org.apache.nlpcraft.model.NCModelView
-
Gets optional user-defined model element parsers for custom NER implementations.
- getPartTokens() - Method in interface org.apache.nlpcraft.model.NCToken
-
Gets the list of tokens this tokens is composed of.
- getPos() - Method in interface org.apache.nlpcraft.model.NCCustomWord
-
Gets Penn Treebank POS tag for this word.
- getPosDescription() - Method in interface org.apache.nlpcraft.model.NCCustomWord
-
Gets description of Penn Treebank POS tag.
- getPostalCode() - Method in interface org.apache.nlpcraft.model.NCCompany
-
Gets optional postal code of the company.
- getProbeId() - Method in interface org.apache.nlpcraft.model.tools.embedded.NCEmbeddedResult
-
Gets ID of the probe this result was generated by.
- getProcessingTime() - Method in interface org.apache.nlpcraft.model.tools.test.NCTestResult
-
Gets total sentence processing time in milliseconds.
- getProperties() - Method in interface org.apache.nlpcraft.model.NCUser
-
Gets properties associated with the user.
- getReceiveTimestamp() - Method in interface org.apache.nlpcraft.model.NCRequest
-
Gets UTC/GMT timestamp in ms when user input was received.
- getRegion() - Method in interface org.apache.nlpcraft.model.NCCompany
-
Gets optional region of the company.
- getRemoteAddress() - Method in interface org.apache.nlpcraft.model.NCRequest
-
Gets optional address of the remote client.
- getRequest() - Method in interface org.apache.nlpcraft.model.NCContext
-
Gets supplemental information about user request.
- getResult() - Method in interface org.apache.nlpcraft.model.tools.test.NCTestResult
-
Gets optional execution result.
- getResultError() - Method in interface org.apache.nlpcraft.model.tools.test.NCTestResult
-
Gets optional execution error.
- getResultType() - Method in interface org.apache.nlpcraft.model.tools.test.NCTestResult
-
Gets optional execution result type.
- getServerRequestId() - Method in interface org.apache.nlpcraft.model.NCContext
-
Gets globally unique ID of the current request.
- getServerRequestId() - Method in interface org.apache.nlpcraft.model.NCRequest
-
Gets globally unique server ID of the current request.
- getServerRequestId() - Method in interface org.apache.nlpcraft.model.NCToken
-
Gets ID of the server request this token is part of.
- getServerRequestId() - Method in interface org.apache.nlpcraft.model.tools.embedded.NCEmbeddedResult
-
Gets ID of the request that produced this result.
- getSignupTimestamp() - Method in interface org.apache.nlpcraft.model.NCUser
-
Gets signup timestamp of the user.
- getStartCharIndex() - Method in interface org.apache.nlpcraft.model.NCCustomWord
-
Gets start character index of this word in the original text.
- getStartCharIndex() - Method in interface org.apache.nlpcraft.model.NCToken
-
Gets start character index of this token in the original text.
- getStem() - Method in interface org.apache.nlpcraft.model.NCCustomWord
-
Gets the stem of this word.
- getSuspiciousWords() - Method in class org.apache.nlpcraft.model.NCModelFileAdapter
- getSuspiciousWords() - Method in interface org.apache.nlpcraft.model.NCModelView
-
Gets an optional list of suspicious words.
- getSynonyms() - Method in interface org.apache.nlpcraft.model.NCElement
-
Gets the list of synonyms by which this semantic element will be recognized by.
- getSynonyms() - Method in interface org.apache.nlpcraft.model.NCValue
-
Gets optional list of value's synonyms.
- getTable() - Method in interface org.apache.nlpcraft.model.tools.sqlgen.NCSqlColumn
-
Gets name of the table this column belongs to.
- getTable() - Method in interface org.apache.nlpcraft.model.tools.sqlgen.NCSqlTable
-
Gets table name.
- getTables() - Method in interface org.apache.nlpcraft.model.tools.sqlgen.NCSqlSchema
-
Gets collection of tables for this SQL schema.
- getTermTokens(int) - Method in interface org.apache.nlpcraft.model.NCIntentMatch
-
Gets tokens for given term.
- getTermTokens(String) - Method in interface org.apache.nlpcraft.model.NCIntentMatch
-
Gets tokens for given term.
- getText() - Method in interface org.apache.nlpcraft.model.tools.test.NCTestResult
-
Gets test sentence text.
- getTo() - Method in interface org.apache.nlpcraft.model.tools.sqlgen.NCSqlDateRange
-
Gets 'to' timestamp.
- getToColumns() - Method in interface org.apache.nlpcraft.model.tools.sqlgen.NCSqlJoin
-
Gets the list of columns in target table.
- getTokens() - Method in interface org.apache.nlpcraft.model.NCConversation
-
Gets an ordered list of tokens stored in the conversation STM for the current user and data model.
- getTokens() - Method in class org.apache.nlpcraft.model.NCResult
-
Gets tokens that were used to produce this query result.
- getToTable() - Method in interface org.apache.nlpcraft.model.tools.sqlgen.NCSqlJoin
-
Gets the name of the target table.
- getType() - Method in class org.apache.nlpcraft.model.NCResult
-
Gets result type.
- getType() - Method in interface org.apache.nlpcraft.model.tools.embedded.NCEmbeddedResult
-
Gets optional result type.
- getType() - Method in interface org.apache.nlpcraft.model.tools.sqlgen.NCSqlJoin
-
Gets type of the join.
- getUnid() - Method in interface org.apache.nlpcraft.model.NCToken
-
A shortcut method that gets internal globally unique system ID of the token.
- getUser() - Method in interface org.apache.nlpcraft.model.NCRequest
-
Gets descriptor of the user on behalf of which this request was submitted.
- getUserData() - Method in interface org.apache.nlpcraft.model.NCConversation
-
Gets modifiable user data container that can be used to store user data in the conversation.
- getUserId() - Method in interface org.apache.nlpcraft.model.tools.embedded.NCEmbeddedResult
-
Gets ID of the user that made the request this result is for.
- getValue() - Method in interface org.apache.nlpcraft.model.NCToken
-
Gets the value if this token was detected via element's value (or its synonyms).
- getValueLoader() - Method in interface org.apache.nlpcraft.model.NCElement
-
Gets optional dynamic value loader.
- getValues() - Method in interface org.apache.nlpcraft.model.NCElement
-
Gets optional map of
values
for this element. - getVariant() - Method in interface org.apache.nlpcraft.model.NCIntentMatch
-
Gets sentence parsing variant that produced the matching for this intent.
- getVariants() - Method in interface org.apache.nlpcraft.model.NCContext
-
Gets collection of all parsing variants for this query.
- getVersion() - Method in class org.apache.nlpcraft.model.NCModelAdapter
- getVersion() - Method in class org.apache.nlpcraft.model.NCModelFileAdapter
- getVersion() - Method in interface org.apache.nlpcraft.model.NCModelView
-
Gets the version of this model using semantic versioning.
- getWebsite() - Method in interface org.apache.nlpcraft.model.NCCompany
-
Gets optional website of the company.
- getWords() - Method in interface org.apache.nlpcraft.model.NCCustomElement
-
Gets a list of NLP custom words that matched detected model element.
H
- html(String) - Static method in class org.apache.nlpcraft.model.NCResult
-
Creates
html
result.
I
- initialize(Map<String, String>) - Method in class org.apache.nlpcraft.model.factories.basic.NCBasicModelFactory
- initialize(Map<String, String>) - Method in class org.apache.nlpcraft.model.factories.spring.NCSpringModelFactory
- initialize(Map<String, String>) - Method in interface org.apache.nlpcraft.model.NCModelFactory
-
Initializes this factory with properties specified in probe configuration.
- INNER - org.apache.nlpcraft.model.tools.sqlgen.NCSqlJoinType
- isAdmin() - Method in interface org.apache.nlpcraft.model.NCUser
-
Tests whether or not the user has administrative privileges.
- isAmbiguous() - Method in interface org.apache.nlpcraft.model.NCIntentMatch
-
Indicates whether or not the intent match was ambiguous (not exact).
- isAscending() - Method in interface org.apache.nlpcraft.model.tools.sqlgen.NCSqlLimit
-
Gets whether limit ascending or descending.
- isAscending() - Method in interface org.apache.nlpcraft.model.tools.sqlgen.NCSqlSort
-
Gets sorting direction.
- isBracketed() - Method in interface org.apache.nlpcraft.model.NCCustomWord
-
Gets whether or not this word is surrounded by any of
'[', ']', '{', '}', '(', ')'
brackets. - isChildOf(String) - Method in interface org.apache.nlpcraft.model.NCToken
-
Tests whether this token is a child of given token ID.
- isDupSynonymsAllowed() - Method in class org.apache.nlpcraft.model.NCModelFileAdapter
- isDupSynonymsAllowed() - Method in interface org.apache.nlpcraft.model.NCModelView
-
Whether or not duplicate synonyms are allowed.
- isEnglish() - Method in interface org.apache.nlpcraft.model.NCCustomWord
-
Tests whether the given token represents an English word.
- isFailed() - Method in interface org.apache.nlpcraft.model.tools.test.NCTestResult
-
Tests whether or not this result corresponds to a failed execution.
- isFreeWord() - Method in interface org.apache.nlpcraft.model.NCToken
-
A shortcut method checking whether or not this token represents a free word.
- isKnownWord() - Method in interface org.apache.nlpcraft.model.NCCustomWord
-
Tests whether or not this token is found in Princeton WordNet database.
- isMaxSynonymsThresholdError() - Method in class org.apache.nlpcraft.model.NCModelFileAdapter
- isMaxSynonymsThresholdError() - Method in interface org.apache.nlpcraft.model.NCModelView
-
Whether or not exceeding
NCModelView.getMaxElementSynonyms()
will trigger a warning log or throwing an exception. - isMemberOf(String) - Method in interface org.apache.nlpcraft.model.NCElement
-
Shortcut method to test if this element is a member of given group.
- isMemberOf(String) - Method in interface org.apache.nlpcraft.model.NCToken
-
Tests whether or not this token belongs to the given group.
- isNonEnglishAllowed() - Method in class org.apache.nlpcraft.model.NCModelFileAdapter
- isNonEnglishAllowed() - Method in interface org.apache.nlpcraft.model.NCModelView
-
Whether or not to allow non-English language in user input.
- isNoNounsAllowed() - Method in class org.apache.nlpcraft.model.NCModelFileAdapter
- isNoNounsAllowed() - Method in interface org.apache.nlpcraft.model.NCModelView
-
Whether or not to allow user input without a single noun.
- isNotLatinCharsetAllowed() - Method in class org.apache.nlpcraft.model.NCModelFileAdapter
- isNotLatinCharsetAllowed() - Method in interface org.apache.nlpcraft.model.NCModelView
-
Whether or not to allow non-Latin charset in user input.
- isNoUserTokensAllowed() - Method in class org.apache.nlpcraft.model.NCModelFileAdapter
- isNoUserTokensAllowed() - Method in interface org.apache.nlpcraft.model.NCModelView
-
Whether or not to allow the user input with no user token detected.
- isNullable() - Method in interface org.apache.nlpcraft.model.tools.sqlgen.NCSqlColumn
-
Tests whether or not this column is nullable.
- isOfAlias(String) - Method in interface org.apache.nlpcraft.model.NCToken
-
Tests whether or not this token has given alias.
- isOk() - Method in interface org.apache.nlpcraft.model.tools.test.NCTestResult
-
Tests whether or not this result corresponds to a successful execution.
- isOwnerOf(NCToken) - Method in interface org.apache.nlpcraft.model.NCContext
-
Tests if given token is part of this query.
- isPermutateSynonyms() - Method in class org.apache.nlpcraft.model.NCModelFileAdapter
- isPermutateSynonyms() - Method in interface org.apache.nlpcraft.model.NCModelView
-
Whether or not to permutate multi-word synonyms.
- isPk() - Method in interface org.apache.nlpcraft.model.tools.sqlgen.NCSqlColumn
-
Tests whether or not this column is a primary key column.
- isQuoted() - Method in interface org.apache.nlpcraft.model.NCCustomWord
-
Gets whether or not this word is surrounded by single or double quotes.
- isStopWord() - Method in interface org.apache.nlpcraft.model.NCCustomWord
-
Gets whether or not this word is a stopword.
- isStopWord() - Method in interface org.apache.nlpcraft.model.NCToken
-
A shortcut method checking whether or not this token is a stopword.
- isSwearWord() - Method in interface org.apache.nlpcraft.model.NCCustomWord
-
Tests whether or not the given token is a swear word.
- isSwearWordsAllowed() - Method in class org.apache.nlpcraft.model.NCModelFileAdapter
- isSwearWordsAllowed() - Method in interface org.apache.nlpcraft.model.NCModelView
-
Whether or not to allow known English swear words in user input.
- isUserDefined() - Method in interface org.apache.nlpcraft.model.NCToken
-
Tests whether or not this token is a user-defined token.
- isValid() - Static method in class org.apache.nlpcraft.model.tools.test.NCTestAutoModelValidator
-
Performs validation based on
NCIntentSample
annotations. - isValid(Class<NCModel>) - Static method in class org.apache.nlpcraft.model.tools.test.NCTestAutoModelValidator
-
Performs validation based on
NCIntentSample
annotations for given model. - isValid(String) - Static method in class org.apache.nlpcraft.model.tools.test.NCTestAutoModelValidator
-
Performs validation based on
NCIntentSample
annotations for given models. - isValid(String...) - Static method in class org.apache.nlpcraft.model.tools.test.NCTestAutoModelValidator
-
Performs validation based on
NCIntentSample
annotations for given models. - isValid(Collection<String>) - Static method in class org.apache.nlpcraft.model.tools.test.NCTestAutoModelValidator
-
Performs validation based on
NCIntentSample
annotations for given models.
J
- JAVA_CONFIG_PROP - Static variable in class org.apache.nlpcraft.model.factories.spring.NCSpringModelFactory
-
Configuration property for Java Config-based Spring configuration.
- json(String) - Static method in class org.apache.nlpcraft.model.NCResult
-
Creates
json
result.
L
- LEFT - org.apache.nlpcraft.model.tools.sqlgen.NCSqlJoinType
- load(NCElement) - Method in interface org.apache.nlpcraft.model.NCValueLoader
-
Loads values for given model element.
M
- main(String[]) - Static method in class org.apache.nlpcraft.model.tools.sqlgen.NCSqlModelGenerator
-
Runs SQL model generator with given command line parameters.
- main(String[]) - Static method in class org.apache.nlpcraft.model.tools.test.NCTestAutoModelValidator
-
Performs validation based on
NCIntentSample
annotations. - makeSchema(NCModel) - Static method in class org.apache.nlpcraft.model.tools.sqlgen.NCSqlSchemaBuilder
-
Builds object presentation for SQL schema from given data model.
- meta(String) - Method in interface org.apache.nlpcraft.model.NCMetadata
-
Shortcut method to get given metadata property.
- meta(String, T) - Method in interface org.apache.nlpcraft.model.NCMetadata
-
Shortcut method to get given metadata property.
- metaOpt(String) - Method in interface org.apache.nlpcraft.model.NCMetadata
-
Shortcut method to get given optional metadata property.
- metax(String) - Method in interface org.apache.nlpcraft.model.NCMetadata
-
Shortcut method to get given mandatory metadata property.
- mkModel(Class<? extends NCModel>) - Method in class org.apache.nlpcraft.model.factories.basic.NCBasicModelFactory
- mkModel(Class<? extends NCModel>) - Method in class org.apache.nlpcraft.model.factories.spring.NCSpringModelFactory
- mkModel(Class<? extends NCModel>) - Method in interface org.apache.nlpcraft.model.NCModelFactory
-
Constructs a model instance.
N
- NCBaseTraceExporter - Class in org.apache.nlpcraft.model.opencensus
-
Base class for OpenCensus trace exporters.
- NCBaseTraceExporter(String) - Constructor for class org.apache.nlpcraft.model.opencensus.NCBaseTraceExporter
-
New base tracer with given name.
- NCBasicModelFactory - Class in org.apache.nlpcraft.model.factories.basic
-
Default implementation of
NCModelFactory
interface. - NCBasicModelFactory() - Constructor for class org.apache.nlpcraft.model.factories.basic.NCBasicModelFactory
- NCCompany - Interface in org.apache.nlpcraft.model
-
Descriptor of the user company.
- NCContext - Interface in org.apache.nlpcraft.model
-
Data model query context.
- NCConversation - Interface in org.apache.nlpcraft.model
-
Conversation container for specific user and data model.
- NCCustomElement - Interface in org.apache.nlpcraft.model
-
Detected model element returning from custom parser.
- NCCustomParser - Interface in org.apache.nlpcraft.model
-
Custom model element parser for programmatic NER implementations.
- NCCustomWord - Interface in org.apache.nlpcraft.model
-
A partially enriched token with a basic set of NLP properties used by custom NER parser.
- NCElement - Interface in org.apache.nlpcraft.model
-
Data model element.
- NCEmbeddedProbe - Class in org.apache.nlpcraft.model.tools.embedded
-
Embedded probe controller.
- NCEmbeddedProbe() - Constructor for class org.apache.nlpcraft.model.tools.embedded.NCEmbeddedProbe
- NCEmbeddedResult - Interface in org.apache.nlpcraft.model.tools.embedded
-
Result container for the embedded probe.
- NCIntent - Annotation Type in org.apache.nlpcraft.model
-
Annotation to define an intent on the method serving as its callback.
- NCIntentMatch - Interface in org.apache.nlpcraft.model
-
An intent match context that can be passed into the callback of the matched intent.
- NCIntentRef - Annotation Type in org.apache.nlpcraft.model
-
Annotations referencing an intent defined externally in JSON or YAML model declaration.
- NCIntentSample - Annotation Type in org.apache.nlpcraft.model
-
Annotation to define one or more samples of the user input that should match a corresponding intent.
- NCIntentSample.NCIntentSampleList - Annotation Type in org.apache.nlpcraft.model
-
Grouping annotation required for when more than one
NCIntentSample
annotation is attached to the callback. - NCIntentSkip - Exception in org.apache.nlpcraft.model
-
Control flow exception to skip current intent.
- NCIntentSkip() - Constructor for exception org.apache.nlpcraft.model.NCIntentSkip
-
Creates new intent skip exception.
- NCIntentSkip(String) - Constructor for exception org.apache.nlpcraft.model.NCIntentSkip
-
Creates new intent skip exception with given debug message.
- NCIntentTerm - Annotation Type in org.apache.nlpcraft.model
-
Annotation to mark callback parameter to receive intent term's tokens.
- NCJaegerExporter - Class in org.apache.nlpcraft.model.opencensus
-
Probe lifecycle component that manages OpenCensus Jaeger trace exporter.
- NCJaegerExporter() - Constructor for class org.apache.nlpcraft.model.opencensus.NCJaegerExporter
-
Creates new Jaeger OpenCensus trace export lifecycle component.
- NCLifecycle - Interface in org.apache.nlpcraft.model
-
NLPCraft lifecycle component.
- NCMetadata - Interface in org.apache.nlpcraft.model
-
Provides support for map-based metadata.
- NCModel - Interface in org.apache.nlpcraft.model
-
User-defined semantic data model.
- NCModelAdapter - Class in org.apache.nlpcraft.model
-
Adapter for data models.
- NCModelAdapter(String, String, String) - Constructor for class org.apache.nlpcraft.model.NCModelAdapter
-
Creates new model with the given mandatory parameters.
- NCModelFactory - Interface in org.apache.nlpcraft.model
-
Optional factory for data models.
- NCModelFileAdapter - Class in org.apache.nlpcraft.model
-
Adapter for data models that can load model configuration from external JSON/YAML file.
- NCModelFileAdapter(String) - Constructor for class org.apache.nlpcraft.model.NCModelFileAdapter
-
Creates new model loading its configuration from given file path.
- NCModelFileAdapter(URI) - Constructor for class org.apache.nlpcraft.model.NCModelFileAdapter
-
Creates new model loading its configuration from given URI.
- NCModelView - Interface in org.apache.nlpcraft.model
-
Read-only view on data model.
- NCPrometheusExporter - Class in org.apache.nlpcraft.model.opencensus
-
Probe lifecycle component that manages OpenCensus Prometheus stats exporter.
- NCPrometheusExporter() - Constructor for class org.apache.nlpcraft.model.opencensus.NCPrometheusExporter
- NCRejection - Exception in org.apache.nlpcraft.model
-
Exception to indicate that user input cannot be processed as is.
- NCRejection(String) - Constructor for exception org.apache.nlpcraft.model.NCRejection
-
Creates new rejection exception with given message.
- NCRejection(String, Throwable) - Constructor for exception org.apache.nlpcraft.model.NCRejection
-
Creates new rejection exception with given message and cause.
- NCRequest - Interface in org.apache.nlpcraft.model
-
Supplemental information about the user request.
- NCResult - Class in org.apache.nlpcraft.model
-
Data model result returned from model intent callbacks.
- NCResult() - Constructor for class org.apache.nlpcraft.model.NCResult
-
No-arg constructor.
- NCResult(String, String) - Constructor for class org.apache.nlpcraft.model.NCResult
-
Creates new result with given body and type.
- NCSpringModelFactory - Class in org.apache.nlpcraft.model.factories.spring
-
Factory that delegates construction of
NCModel
s to the Spring Framework. - NCSpringModelFactory() - Constructor for class org.apache.nlpcraft.model.factories.spring.NCSpringModelFactory
- NCSqlColumn - Interface in org.apache.nlpcraft.model.tools.sqlgen
-
Object presentation of SQL column.
- NCSqlDateRange - Interface in org.apache.nlpcraft.model.tools.sqlgen
-
Object presentation of SQL date range.
- NCSqlExtractor - Interface in org.apache.nlpcraft.model.tools.sqlgen
-
Utility methods for extracting various SQL components from
NCToken
tokens. - NCSqlExtractorBuilder - Class in org.apache.nlpcraft.model.tools.sqlgen
-
Builder for
NCSqlExtractor
instances. - NCSqlExtractorBuilder() - Constructor for class org.apache.nlpcraft.model.tools.sqlgen.NCSqlExtractorBuilder
- NCSqlJoin - Interface in org.apache.nlpcraft.model.tools.sqlgen
-
Object presentation of SQL join (foreign key).
- NCSqlJoinType - Enum in org.apache.nlpcraft.model.tools.sqlgen
-
Type of the SQL join.
- NCSqlLimit - Interface in org.apache.nlpcraft.model.tools.sqlgen
-
Object presentation of SQL limit.
- NCSqlModelGenerator - Class in org.apache.nlpcraft.model.tools.sqlgen
-
Command line utility to generate YAML/JSON NLPCraft model stub from given SQL RDBMS.
- NCSqlModelGenerator() - Constructor for class org.apache.nlpcraft.model.tools.sqlgen.NCSqlModelGenerator
- NCSqlSchema - Interface in org.apache.nlpcraft.model.tools.sqlgen
-
Object presentation of SQL schema.
- NCSqlSchemaBuilder - Class in org.apache.nlpcraft.model.tools.sqlgen
-
Builder for
NCSqlSchema
instances. - NCSqlSchemaBuilder() - Constructor for class org.apache.nlpcraft.model.tools.sqlgen.NCSqlSchemaBuilder
- NCSqlSort - Interface in org.apache.nlpcraft.model.tools.sqlgen
-
Object presentation of SQL sorting.
- NCSqlTable - Interface in org.apache.nlpcraft.model.tools.sqlgen
-
Object presentation of SQL table.
- NCStackdriverStatsExporter - Class in org.apache.nlpcraft.model.opencensus
-
Probe lifecycle component that manages OpenCensus Stackdriver stats exporter.
- NCStackdriverStatsExporter() - Constructor for class org.apache.nlpcraft.model.opencensus.NCStackdriverStatsExporter
- NCStackdriverTraceExporter - Class in org.apache.nlpcraft.model.opencensus
-
Probe lifecycle component that manages OpenCensus Stackdriver trace exporter.
- NCStackdriverTraceExporter() - Constructor for class org.apache.nlpcraft.model.opencensus.NCStackdriverTraceExporter
-
Creates new Stackdriver OpenCensus trace export lifecycle component.
- NCTestAutoModelValidator - Class in org.apache.nlpcraft.model.tools.test
-
Auto-validator for models based on
NCIntentSample
annotations. - NCTestAutoModelValidator() - Constructor for class org.apache.nlpcraft.model.tools.test.NCTestAutoModelValidator
- NCTestClient - Interface in org.apache.nlpcraft.model.tools.test
-
Model testing client.
- NCTestClientBuilder - Class in org.apache.nlpcraft.model.tools.test
-
Test client builder for
NCTestClient
instances. - NCTestClientBuilder() - Constructor for class org.apache.nlpcraft.model.tools.test.NCTestClientBuilder
- NCTestClientException - Exception in org.apache.nlpcraft.model.tools.test
-
Test client exception.
- NCTestResult - Interface in org.apache.nlpcraft.model.tools.test
-
Result of the test sentence processing.
- NCToken - Interface in org.apache.nlpcraft.model
-
Detected model element.
- NCUser - Interface in org.apache.nlpcraft.model
-
Descriptor of the user.
- NCValue - Interface in org.apache.nlpcraft.model
-
Model element's value.
- NCValueLoader - Interface in org.apache.nlpcraft.model
-
Dynamic value loader that can be used by model elements to dynamically load or create their values.
- NCVariant - Interface in org.apache.nlpcraft.model
-
A list of tokens representing one possible parsing variant of the user input.
- NCZipkinExporter - Class in org.apache.nlpcraft.model.opencensus
-
Probe lifecycle component that manages OpenCensus Zipkin trace exporter.
- NCZipkinExporter() - Constructor for class org.apache.nlpcraft.model.opencensus.NCZipkinExporter
-
Creates new Zipkin OpenCensus trace export lifecycle component.
- newBuilder() - Method in class org.apache.nlpcraft.model.tools.test.NCTestClientBuilder
-
Creates new builder instance with all defaults set.
O
- onContext(NCContext) - Method in interface org.apache.nlpcraft.model.NCModel
-
A callback that is called when a fully assembled query context is ready.
- onDiscard() - Method in interface org.apache.nlpcraft.model.NCLifecycle
-
Called after lifecycle components is no longer needed.
- onDiscard() - Method in class org.apache.nlpcraft.model.opencensus.NCBaseTraceExporter
- onError(NCContext, Throwable) - Method in interface org.apache.nlpcraft.model.NCModel
-
A callback that is called when intent callback failed with unexpected exception.
- onInit() - Method in interface org.apache.nlpcraft.model.NCLifecycle
-
Called before lifecycle component is used and just after its creation.
- onInit() - Method in class org.apache.nlpcraft.model.opencensus.NCJaegerExporter
- onInit() - Method in class org.apache.nlpcraft.model.opencensus.NCPrometheusExporter
- onInit() - Method in class org.apache.nlpcraft.model.opencensus.NCStackdriverStatsExporter
- onInit() - Method in class org.apache.nlpcraft.model.opencensus.NCStackdriverTraceExporter
- onInit() - Method in class org.apache.nlpcraft.model.opencensus.NCZipkinExporter
- onMatchedIntent(NCIntentMatch) - Method in interface org.apache.nlpcraft.model.NCModel
-
A callback that is called when intent was successfully matched but right before its callback is called.
- onParsedVariant(NCVariant) - Method in interface org.apache.nlpcraft.model.NCModel
-
A callback to accept or reject a parsed variant.
- onRejection(NCIntentMatch, NCRejection) - Method in interface org.apache.nlpcraft.model.NCModel
-
A callback that is called when intent callback threw
NCRejection
exception. - onResult(NCIntentMatch, NCResult) - Method in interface org.apache.nlpcraft.model.NCModel
-
A callback that is called when successful result is obtained from the intent callback and right before sending it back to the caller.
- open(String) - Method in interface org.apache.nlpcraft.model.tools.test.NCTestClient
-
Connects test client to the server for testing with given model ID.
- org.apache.nlpcraft.model - package org.apache.nlpcraft.model
-
Contains main API for defining data models.
- org.apache.nlpcraft.model.factories.basic - package org.apache.nlpcraft.model.factories.basic
-
Contains basic model factory implementation.
- org.apache.nlpcraft.model.factories.spring - package org.apache.nlpcraft.model.factories.spring
-
Contains Spring-based model factory implementation.
- org.apache.nlpcraft.model.opencensus - package org.apache.nlpcraft.model.opencensus
-
Contains OpenCensus integration components.
- org.apache.nlpcraft.model.tools.embedded - package org.apache.nlpcraft.model.tools.embedded
-
Contains embedded probe controller.
- org.apache.nlpcraft.model.tools.sqlgen - package org.apache.nlpcraft.model.tools.sqlgen
-
Contains model stub generator for SQL RDBMS.
- org.apache.nlpcraft.model.tools.test - package org.apache.nlpcraft.model.tools.test
-
Contains model testing framework.
- OUTER - org.apache.nlpcraft.model.tools.sqlgen.NCSqlJoinType
P
- parse(NCRequest, NCModelView, List<NCCustomWord>, List<NCCustomElement>) - Method in interface org.apache.nlpcraft.model.NCCustomParser
-
Analyses user input provided as a list of
NCCustomWord
objects and returns a list ofNCCustomElement
objects.
R
- registerCallback(Consumer<NCEmbeddedResult>) - Static method in class org.apache.nlpcraft.model.tools.embedded.NCEmbeddedProbe
-
Registers the callback on query processing results.
- RIGHT - org.apache.nlpcraft.model.tools.sqlgen.NCSqlJoinType
S
- setBaseUrl(String) - Method in class org.apache.nlpcraft.model.tools.test.NCTestClientBuilder
-
Sets non-default API base URL.
- setBody(String) - Method in class org.apache.nlpcraft.model.NCResult
-
Sets result body.
- setEmbeddedMode(boolean) - Method in class org.apache.nlpcraft.model.tools.test.NCTestClientBuilder
-
Sets the embedded probe mode flag.
- setHttpClientSupplier(Supplier<CloseableHttpClient>) - Method in class org.apache.nlpcraft.model.tools.test.NCTestClientBuilder
-
Sets non-default
CloseableHttpClient
custom supplier. - setIntentId(String) - Method in class org.apache.nlpcraft.model.NCResult
-
Sets optional intent ID.
- setRequestConfig(RequestConfig) - Method in class org.apache.nlpcraft.model.tools.test.NCTestClientBuilder
-
Sets optional HTTP REST client configuration parameters.
- setResponseLog(boolean) - Method in class org.apache.nlpcraft.model.tools.test.NCTestClientBuilder
-
Sets whether or not to log responses from the probe.
- setTokens(Collection<NCToken>) - Method in class org.apache.nlpcraft.model.NCResult
-
Sets a collection of tokens that was used to produce this query result.
- setType(String) - Method in class org.apache.nlpcraft.model.NCResult
-
Set result type.
- setUser(String, String) - Method in class org.apache.nlpcraft.model.tools.test.NCTestClientBuilder
-
Sets non-default user credentials.
- start(Class<? extends NCModel>...) - Static method in class org.apache.nlpcraft.model.tools.embedded.NCEmbeddedProbe
-
Starts the embedded probe with default configuration and specified models to deploy.
- start(String) - Static method in class org.apache.nlpcraft.model.tools.embedded.NCEmbeddedProbe
-
Start the embedded probe with given configuration file.
- start(String, String, String, String, Class<? extends NCModel>...) - Static method in class org.apache.nlpcraft.model.tools.embedded.NCEmbeddedProbe
-
Starts the embedded probe with default configuration and specified overrides.
- stop() - Static method in class org.apache.nlpcraft.model.tools.embedded.NCEmbeddedProbe
-
Stops the embedded probe, if it was started before.
T
- terminate() - Method in class org.apache.nlpcraft.model.factories.basic.NCBasicModelFactory
- terminate() - Method in class org.apache.nlpcraft.model.factories.spring.NCSpringModelFactory
- terminate() - Method in interface org.apache.nlpcraft.model.NCModelFactory
-
Terminates this factory when probe stops.
- text(String) - Static method in class org.apache.nlpcraft.model.NCResult
-
Creates
text
result.
U
- unregisterCallback(Consumer<NCEmbeddedResult>) - Static method in class org.apache.nlpcraft.model.tools.embedded.NCEmbeddedProbe
-
Unregisters previously registered callback.
V
- value() - Method in annotation type org.apache.nlpcraft.model.NCIntent
-
Intent specification using intent DSL.
- value() - Method in annotation type org.apache.nlpcraft.model.NCIntentRef
-
ID of the intent defined externally.
- value() - Method in annotation type org.apache.nlpcraft.model.NCIntentSample.NCIntentSampleList
-
Gets the list of all
NCIntentSample
annotations attached to the callback. - value() - Method in annotation type org.apache.nlpcraft.model.NCIntentSample
-
Gets a list of user input samples that should match corresponding intent.
- value() - Method in annotation type org.apache.nlpcraft.model.NCIntentTerm
- valueOf(String) - Static method in enum org.apache.nlpcraft.model.tools.sqlgen.NCSqlJoinType
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum org.apache.nlpcraft.model.tools.sqlgen.NCSqlJoinType
-
Returns an array containing the constants of this enum type, in the order they are declared.
X
- XML_CONFIG_PROP - Static variable in class org.apache.nlpcraft.model.factories.spring.NCSpringModelFactory
-
Configuration property for XML-based Spring configuration.
Y
- yaml(String) - Static method in class org.apache.nlpcraft.model.NCResult
-
Creates
yaml
result.
All Classes All Packages