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

A

acceptVariant(List<NCToken>) - Method in interface org.nlpcraft.model.NCModel

A callback to accept or reject a parsing variant.

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

Tests single sentence and returns its result.

B

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

Build new configured test client instance.

C

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

Clears conversation for this test client.

clearDialog(Predicate<String>) - Method in interface org.nlpcraft.model.NCConversation

Clears history of matched intents using given intent predicate.

clearStm(Predicate<NCToken>) - Method in interface org.nlpcraft.model.NCConversation

Removes all tokens satisfying given predicate from the conversation STM.

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

Closes test client connection to the server.

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_EMBEDDED - Static variable in class org.nlpcraft.model.test.NCTestClientBuilder

Default embedded mode flag.

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

Default set of enabled built-in tokens.

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

Default value returned from NCModelView.isDupSynonymsAllowed() method.

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

Default value returned from NCModelView.isNoNounsAllowed() method.

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

Default value returned from NCModelView.isNoUserTokensAllowed() method.

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

Default value returned from NCModelView.isNonEnglishAllowed() method.

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

Default value returned from NCModelView.isNotLatinCharsetAllowed() method.

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

Default value returned from NCModelView.isPermutateSynonyms() method.

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

Default value returned from NCModelView.isSwearWordsAllowed() method.

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

Default value returned from NCModelView.getJiggleFactor() method.

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

Default value returned from NCModelView.getMaxFreeWords() method.

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

Default value returned from NCModelView.getMaxSuspiciousWords() method.

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

Default value returned from NCModelView.getMaxTokens() method.

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

Default value returned from NCModelView.getMaxTotalSynonyms() method.

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

Default value returned from NCModelView.getMaxUnknownWords() method.

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

Maximum test time.

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

Default value returned from NCModelView.getMaxWords() method.

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

Default value returned from NCModelView.getJiggleFactor() method.

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

Default value returned from NCModelView.getMinNonStopwords() method.

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

Default value returned from NCModelView.getMinTokens() method.

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

Default value returned from NCModelView.getMinWords() method.

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

Default client password.

G

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

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

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

getAddress() - Method in interface org.nlpcraft.model.NCCompany

Gets optional postal address of the company.

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

Gets the list of all parent IDs from this token up to the root.

getAvatarUrl() - Method in interface org.nlpcraft.model.NCUser

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

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

Gets result body.

getBody() - Method in interface org.nlpcraft.probe.embedded.NCEmbeddedResult

Gets optional result body.

getCity() - Method in interface org.nlpcraft.model.NCCompany

Gets optional city of the company.

getClientAgent() - Method in interface org.nlpcraft.model.NCRequest

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

getCompany() - Method in interface org.nlpcraft.model.NCRequest

Gets descriptor of the user's company on behalf of which this request was submitted.

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

Gets current conversation.

getCountry() - Method in interface org.nlpcraft.model.NCCompany

Gets optional country of the company.

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

Gets optional JSON data passed in with user request.

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

Gets optional element description.

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

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

Gets optional short model description.

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

Gets ID of the detected model element.

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

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

Gets a set of model elements or named entities.

getEmail() - Method in interface org.nlpcraft.model.NCUser

Gets email of the user.

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

getEnabledTokens() - Method in interface org.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.nlpcraft.model.NCCustomWord

Gets end character index of this word in the original text.

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

Gets end character index of this token in the original text.

getErrorCode() - Method in interface org.nlpcraft.probe.embedded.NCEmbeddedResult

Gets optional error code.

getErrorMessage() - Method in interface org.nlpcraft.probe.embedded.NCEmbeddedResult

Gets optional error message.

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

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

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

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

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

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

getFirstName() - Method in interface org.nlpcraft.model.NCUser

Gets first name of the user.

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

Gets the list of groups this elements belongs to.

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

Gets the list of groups this token belongs to.

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

Gets ID of the company.

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

Gets unique ID of this element.

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

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

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

Gets unique, immutable ID of this model.

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

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

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

Gets ID of this user.

getIntentId() - Method in interface org.nlpcraft.model.NCIntentContext

Gets ID of the matched intent.

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

Gets list of intents declared in JSON/YML model definition, if any.

getIntentTokens() - Method in interface org.nlpcraft.model.NCIntentContext

Gets a subset of tokens representing matched intent.

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

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

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

getLastName() - Method in interface org.nlpcraft.model.NCUser

Gets last name of the user.

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

Gets the lemma of this word, a canonical form of this word.

getLogHolder() - Method in interface org.nlpcraft.probe.embedded.NCEmbeddedResult

Gets request processing log holder as JSON string.

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

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

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

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

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

Gets maximum number of free words until automatic rejection.

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

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

Gets maximum number of suspicious words until automatic rejection.

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

getMaxTokens() - Method in interface org.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.nlpcraft.model.NCModelFileAdapter

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

Total number of synonyms allowed per model.

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

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

Gets maximum number of unknown words until automatic rejection.

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

getMaxWords() - Method in interface org.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.nlpcraft.model.NCCustomElement

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

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

Gets optional user-defined element's metadata.

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

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

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

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

Gets token metadata.

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

getMinNonStopwords() - Method in interface org.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.nlpcraft.model.NCModelFileAdapter

getMinTokens() - Method in interface org.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.nlpcraft.model.NCModelFileAdapter

getMinWords() - Method in interface org.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.nlpcraft.model.NCQueryContext

Gets model instance for this query.

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

Gets model ID the test sentence was sent with.

getModelId() - Method in interface org.nlpcraft.probe.embedded.NCEmbeddedResult

Gets the ID of the model that produced this result.

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

Gets name of the company.

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

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

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

Gets descriptive name of this model.

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

Gets value name.

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

Gets normalized text for this word.

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

Gets normalized text of the user input.

getOriginalText() - Method in interface org.nlpcraft.model.NCCustomWord

Gets original text for this word.

getOriginalText() - Method in interface org.nlpcraft.probe.embedded.NCEmbeddedResult

Gets original text of the request that produced this result.

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.

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

getParsers() - Method in interface org.nlpcraft.model.NCModelView

Gets optional user-defined model element parsers for custom NER implementations.

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

Gets the list of tokens this tokens is composed of.

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

Gets Penn Treebank POS tag for this word.

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

Gets description of Penn Treebank POS tag.

getPostalCode() - Method in interface org.nlpcraft.model.NCCompany

Gets optional postal code of the company.

getProbeId() - Method in interface org.nlpcraft.probe.embedded.NCEmbeddedResult

Gets ID of the probe this result was generated by.

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

Gets total sentence processing time in milliseconds.

getProperties() - Method in interface org.nlpcraft.model.NCUser

Gets properties associated with the user.

getQueryContext() - Method in interface org.nlpcraft.model.NCIntentContext

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

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

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

getRegion() - Method in interface org.nlpcraft.model.NCCompany

Gets optional region of the company.

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

Gets optional address of the remote client.

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

Gets supplemental information about user request.

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.

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

Gets ID of the current request.

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

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.

getServerRequestId() - Method in interface org.nlpcraft.probe.embedded.NCEmbeddedResult

Gets ID of the request that produced this result.

getSignupTimestamp() - Method in interface org.nlpcraft.model.NCUser

Gets signup timestamp of the user.

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

Gets start character index of this word in the original text.

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

Gets start character index of this token in the original text.

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

Gets the stem of this word.

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

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

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.NCValue

Gets optional list of value's synonyms.

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

Gets tokens for given term.

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

Gets tokens for given term.

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

Gets test sentence text.

getTokens() - Method in interface org.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.nlpcraft.model.NCQueryResult

Gets tokens that were used to produce this query result.

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

Gets result type.

getType() - Method in interface org.nlpcraft.probe.embedded.NCEmbeddedResult

Gets optional result type.

getUser() - Method in interface org.nlpcraft.model.NCRequest

Gets descriptor of the user on behalf of which this request was submitted.

getUserId() - Method in interface org.nlpcraft.probe.embedded.NCEmbeddedResult

Gets ID of the user that made the request this result is for.

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

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

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

Gets optional dynamic value loader.

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

Gets optional map of values for this element.

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

Gets collection of all parsing variants for this query.

getVariantTokens() - Method in interface org.nlpcraft.model.NCIntentContext

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

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

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

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

Gets the version of this model using semantic versioning.

getWebsite() - Method in interface org.nlpcraft.model.NCCompany

Gets optional website of the company.

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

Gets a list of NLP custom words that matched detected model element.

H

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

Creates html result.

I

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

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

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

Initializes this factory with properties specified in probe configuration.

isAdmin() - Method in interface org.nlpcraft.model.NCUser

Tests whether or not the user has administrative privileges.

isAmbiguousMatch() - Method in interface org.nlpcraft.model.NCIntentContext

Indicates whether or not the intent match was ambiguous (not exact).

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

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

isChildOf(String) - Method in interface org.nlpcraft.model.NCToken

Tests whether this token is a child of given token ID.

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

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

Whether or not duplicate synonyms are allowed.

isEnglish() - Method in interface org.nlpcraft.model.NCCustomWord

Tests whether the given token represents an English word.

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

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

isKnownWord() - Method in interface org.nlpcraft.model.NCCustomWord

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Tests if given token is part of this query.

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

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

Whether or not to permutate multi-word synonyms.

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

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

isStopWord() - Method in interface org.nlpcraft.model.NCCustomWord

Gets whether or not this word is a stopword.

isSwearWord() - Method in interface org.nlpcraft.model.NCCustomWord

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

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

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

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

J

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

Configuration property for Java Config-based Spring configuration.

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

Creates json result.

L

load(NCElement) - Method in interface org.nlpcraft.model.NCValueLoader

Loads values for given model element.

M

main(String[]) - Static method in class org.nlpcraft.model.tools.NCSqlModelGenerator

Runs SQL model generator with given command line parameters.

meta(String) - Method in interface org.nlpcraft.model.NCToken

Shortcut method to get given metadata property.

meta(String, T) - Method in interface org.nlpcraft.model.NCToken

Shortcut method to get given metadata property.

metaOpt(String) - Method in interface org.nlpcraft.model.NCToken

Shortcut method to get given optional metadata property.

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

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

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

Constructs a model instance.

N

NCBaseTraceExporter - Class in org.nlpcraft.model.opencensus

Base class for OpenCensus trace exporters.

NCBaseTraceExporter(String) - Constructor for class org.nlpcraft.model.opencensus.NCBaseTraceExporter

New base tracer with given name.

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

Default implementation of NCModelFactory interface.

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

NCCompany - Interface in org.nlpcraft.model

Descriptor of the user company.

NCConversation - Interface in org.nlpcraft.model

Conversation container.

NCCustomElement - Interface in org.nlpcraft.model

Detected model element returning from custom parser.

NCCustomParser - Interface in org.nlpcraft.model

Custom model element parser for programmatic NER implementations.

NCCustomWord - Interface in org.nlpcraft.model

A partially enriched token with a basic set of NLP properties used by custom NER parser.

NCElement - Interface in org.nlpcraft.model

Data model element.

NCEmbeddedProbe - Class in org.nlpcraft.probe.embedded

Embedded probe controller.

NCEmbeddedProbe() - Constructor for class org.nlpcraft.probe.embedded.NCEmbeddedProbe

NCEmbeddedResult - Interface in org.nlpcraft.probe.embedded

Result container for the embedded probe.

NCIntent - Annotation Type in org.nlpcraft.model

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

NCIntentContext - Interface in org.nlpcraft.model

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

NCIntentRef - Annotation Type in org.nlpcraft.model

Annotations referencing an intent defined externally in JSON or YAML model declaration.

NCIntentSkip - Exception in org.nlpcraft.model

Control flow exception to skip current intent.

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

Creates new intent skip exception.

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

Creates new intent skip exception with given debug message.

NCIntentTerm - Annotation Type in org.nlpcraft.model

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

NCJaegerExporter - Class in org.nlpcraft.model.opencensus

Probe lifecycle component that manages OpenCensus Jaeger trace exporter.

NCJaegerExporter() - Constructor for class org.nlpcraft.model.opencensus.NCJaegerExporter

Creates new Jaeger OpenCensus trace export lifecycle component.

NCLifecycle - Interface in org.nlpcraft.model

NLPCraft lifecycle component.

NCModel - Interface in org.nlpcraft.model

User-defined semantic data model.

NCModelAdapter - Class in org.nlpcraft.model

Adapter for data models.

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

Creates new model with the given mandatory parameters.

NCModelFactory - Interface in org.nlpcraft.model

Optional factory for data models.

NCModelFileAdapter - Class in org.nlpcraft.model

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

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

Creates new model loading its configuration from given file path.

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

Creates new model loading its configuration from given URI.

NCModelView - Interface in org.nlpcraft.model

Read-only view on data model.

NCPrometheusExporter - Class in org.nlpcraft.model.opencensus

Probe lifecycle component that manages OpenCensus Prometheus stats exporter.

NCPrometheusExporter() - Constructor for class org.nlpcraft.model.opencensus.NCPrometheusExporter

NCQueryContext - Interface in org.nlpcraft.model

Data model query context.

NCQueryResult - Class in org.nlpcraft.model

Data model result returned from model query method.

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

Creates new result with given body and type.

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

No-arg constructor.

NCQueryState - Enum in org.nlpcraft.model

This enumeration defines state of the query processing.

NCRejection - Exception in org.nlpcraft.model

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

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

Creates new rejection exception with given message.

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

Creates new rejection exception with given message and cause.

NCRequest - Interface in org.nlpcraft.model

Supplemental information about the user request.

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

Factory that delegates construction of NCModels to the Spring Framework.

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

NCSqlModelGenerator - Class in org.nlpcraft.model.tools

Command line utility to generate NLPCraft model stub from given SQL RDBMS.

NCSqlModelGenerator() - Constructor for class org.nlpcraft.model.tools.NCSqlModelGenerator

NCStackdriverStatsExporter - Class in org.nlpcraft.model.opencensus

Probe lifecycle component that manages OpenCensus Stackdriver stats exporter.

NCStackdriverStatsExporter() - Constructor for class org.nlpcraft.model.opencensus.NCStackdriverStatsExporter

NCStackdriverTraceExporter - Class in org.nlpcraft.model.opencensus

Probe lifecycle component that manages OpenCensus Stackdriver trace exporter.

NCStackdriverTraceExporter() - Constructor for class org.nlpcraft.model.opencensus.NCStackdriverTraceExporter

Creates new Stackdriver OpenCensus trace export lifecycle component.

NCTestClient - Interface in org.nlpcraft.model.test

Model testing client.

NCTestClientBuilder - Class in org.nlpcraft.model.test

Test client builder for NCTestClient instances.

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

NCTestClientException - Exception in org.nlpcraft.model.test

Test client exception.

NCTestResult - Interface in org.nlpcraft.model.test

Result of the test sentence processing.

NCToken - Interface in org.nlpcraft.model

Detected model element.

NCUser - Interface in org.nlpcraft.model

Descriptor of the user.

NCValue - Interface in org.nlpcraft.model

Model element's value.

NCValueLoader - Interface in org.nlpcraft.model

Dynamic value loader that can be used by JSON/YAML model declarations.

NCZipkinExporter - Class in org.nlpcraft.model.opencensus

Probe lifecycle component that manages OpenCensus Zipkin trace exporter.

NCZipkinExporter() - Constructor for class org.nlpcraft.model.opencensus.NCZipkinExporter

Creates new Zipkin OpenCensus trace export lifecycle component.

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

Creates new builder instance with all defaults set.

O

onDiscard() - Method in interface org.nlpcraft.model.NCLifecycle

Called after lifecycle components is no longer needed.

onDiscard() - Method in class org.nlpcraft.model.opencensus.NCBaseTraceExporter

onInit() - Method in interface org.nlpcraft.model.NCLifecycle

Called before lifecycle component is used and just after its creation.

onInit() - Method in class org.nlpcraft.model.opencensus.NCJaegerExporter

onInit() - Method in class org.nlpcraft.model.opencensus.NCPrometheusExporter

onInit() - Method in class org.nlpcraft.model.opencensus.NCStackdriverStatsExporter

onInit() - Method in class org.nlpcraft.model.opencensus.NCStackdriverTraceExporter

onInit() - Method in class org.nlpcraft.model.opencensus.NCZipkinExporter

onQueryState(NCQueryState, NCQueryContext, NCQueryResult, Throwable) - Method in interface org.nlpcraft.model.NCModel

Optional callback on the state of the query processing.

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

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

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

Contains main API for defining data models.

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

Contains basic model factory implementation.

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

Contains Spring-based model factory implementation.

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

Contains OpenCensus integration components.

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

Contains model testing framework.

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

Contains tools and utilities.

org.nlpcraft.probe.embedded - package org.nlpcraft.probe.embedded

Contains embedded probe controller.

P

parse(NCRequest, NCModelView, List<NCCustomWord>, List<NCCustomElement>) - Method in interface org.nlpcraft.model.NCCustomParser

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

Q

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

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

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

Default implementation throws NCRejection exception.

R

registerCallback(Consumer<NCEmbeddedResult>) - Static method in class org.nlpcraft.probe.embedded.NCEmbeddedProbe

Registers the callback on query processing results.

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.

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

Sets the embedded probe mode flag.

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

Sets non-default CloseableHttpClient custom supplier.

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

Sets optional HTTP REST client configuration parameters.

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

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

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

Set result type.

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

Sets non-default user credentials.

start(String) - Static method in class org.nlpcraft.probe.embedded.NCEmbeddedProbe

Start the embedded probe with given configuration file.

start(Class<? extends NCModel>...) - Static method in class org.nlpcraft.probe.embedded.NCEmbeddedProbe

Starts the embedded probe with default configuration and specified models to deploy.

start(String, String, String, String, Class<? extends NCModel>...) - Static method in class org.nlpcraft.probe.embedded.NCEmbeddedProbe

Starts the embedded probe with default configuration and specified overrides.

stop() - Static method in class org.nlpcraft.probe.embedded.NCEmbeddedProbe

Stops the embedded probe, if it was started before.

T

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

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

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

Terminates this factory when probe stops.

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

Creates text result.

U

unregisterCallback(Consumer<NCEmbeddedResult>) - Static method in class org.nlpcraft.probe.embedded.NCEmbeddedProbe

Unregisters previously registered callback.

V

valueOf(String) - Static method in enum org.nlpcraft.model.NCQueryState

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.nlpcraft.model.NCQueryState

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.nlpcraft.model.factories.spring.NCSpringModelFactory

Configuration property for XML-based Spring configuration.

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 U V X Y