- call() - Method in class com.xatkit.core.platform.action.RuntimeAction
-
- call() - Method in class com.xatkit.core.platform.action.RuntimeArtifactAction
-
- checkOutContexts(IntentDefinition) - Static method in class com.xatkit.core.recognition.dialogflow.DialogFlowCheckingUtils
-
Checks the out Context
s of the provided intentDefinition
.
- CLEAN_AGENT_ON_STARTUP_KEY - Static variable in class com.xatkit.core.recognition.dialogflow.DialogFlowApi
-
- clear() - Method in class com.xatkit.core.platform.io.EventInstanceBuilder
-
Clears the builder and reset its internal fields.
- clearEventDefinitions() - Method in class com.xatkit.core.EventDefinitionRegistry
-
Unregisters all the EventDefinition
s from this registry.
- clearRegisteredRestHandlers() - Method in class com.xatkit.core.server.XatkitServer
-
- clearRuntimePlatforms() - Method in class com.xatkit.core.RuntimePlatformRegistry
-
- clearXatkitSessions() - Method in class com.xatkit.core.XatkitCore
-
Invalidates all the
XatkitSession
s and clear the session registry.
- close() - Method in class com.xatkit.core.platform.io.RuntimeEventProvider
-
- com.xatkit - package com.xatkit
-
Xatkit base package.
- com.xatkit.core - package com.xatkit.core
-
Contains the core components of the Xatkit framework.
- com.xatkit.core.interpreter - package com.xatkit.core.interpreter
-
Contains the Xatkit Common Language interpreter.
- com.xatkit.core.interpreter.operation - package com.xatkit.core.interpreter.operation
-
Contains the abstract operations for the Xatkit Common Language interpreter.
- com.xatkit.core.interpreter.operation.object - package com.xatkit.core.interpreter.operation.object
-
Contains Object-specific operation implementations for the Xatkit Common Language interpreter.
- com.xatkit.core.platform - package com.xatkit.core.platform
-
Contains the abstract classes to implement to provide custom platforms.
- com.xatkit.core.platform.action - package com.xatkit.core.platform.action
-
Contains the abstract classes to implement to provide custom platform's actions.
- com.xatkit.core.platform.io - package com.xatkit.core.platform.io
-
Contains the abstract classes to implement to provide custom platform's input provider.
- com.xatkit.core.recognition - package com.xatkit.core.recognition
-
Contains the abstract classes to implement to provide custom intent recognition.
- com.xatkit.core.recognition.dialogflow - package com.xatkit.core.recognition.dialogflow
-
An intent recognition provider implementation for the DialogFlow platform.
- com.xatkit.core.recognition.processor - package com.xatkit.core.recognition.processor
-
- com.xatkit.core.recognition.regex - package com.xatkit.core.recognition.regex
-
- com.xatkit.core.server - package com.xatkit.core.server
-
Contains the Xatkit server implementation.
- com.xatkit.core.session - package com.xatkit.core.session
-
Contains the classes to manage sessions and contexts.
- com.xatkit.util - package com.xatkit.util
-
Utility classes that are used by the Xatkit framework.
- compute() - Method in class com.xatkit.core.platform.action.RestAction
-
Computes the REST request and returned the handled result.
- compute() - Method in class com.xatkit.core.platform.action.RuntimeAction
-
- CONFIDENCE_THRESHOLD_KEY - Static variable in class com.xatkit.core.recognition.dialogflow.DialogFlowApi
-
The
Configuration
key to store the DialogFlow confidence threshold.
- configuration - Variable in class com.xatkit.core.platform.RuntimePlatform
-
- CONFIGURATION_FOLDER_PATH_KEY - Static variable in class com.xatkit.core.XatkitCore
-
- construct(Class<T>, Object[]) - Static method in class com.xatkit.util.Loader
-
Constructs a new instance of clazz
with the given parameters
.
- construct(Class<T>) - Static method in class com.xatkit.util.Loader
-
Constructs a new instance of the provided clazz
using its default constructor.
- construct(Class<T>, Class<?>, Object) - Static method in class com.xatkit.util.Loader
-
Constructs a new instance of the provided clazz
with the given parameter
.
- construct(Class<T>, Class<?>, Class<?>, Object, Object) - Static method in class com.xatkit.util.Loader
-
Constructs a new instance of the provided clazz
with the given parameter1
and parameter2
.
- construct(Class<T>, List<Class<?>>, List<Object>) - Static method in class com.xatkit.util.Loader
-
Constructs a new instance of the provided clazz
with the given parameters
.
- constructRuntimeEventProvider(Class<? extends RuntimeEventProvider>, RuntimePlatform, Configuration) - Static method in class com.xatkit.util.Loader
-
Constructs a new instance of the provided eventProviderClass
with the given xatkitCore
and
configuration
.
- constructRuntimePlatform(Class<? extends RuntimePlatform>, XatkitCore, Configuration) - Static method in class com.xatkit.util.Loader
-
Constructs a new instance of the provided runtimePlatformClass
with the given xatkitCore
and
configuration
.
- containsKeyInternal(String) - Method in class com.xatkit.util.XatkitEnvironmentConfiguration
-
Returns true
if the configuration contains the provided key
, false
otherwise.
- ContentHttpHandler - Class in com.xatkit.core.server
-
Handles the HTTP requests performed on the /content/
path.
- ContentHttpHandler(XatkitServer) - Constructor for class com.xatkit.core.server.ContentHttpHandler
-
- convertJsonObjectToOutContext(JsonObject, EventInstanceBuilder) - Method in class com.xatkit.core.platform.io.JsonEventMatcher
-
Converts the provided jsonObject
's fields into out context values set in the provided builder
.
- convertJsonObjectToOutContext(String, JsonObject, EventInstanceBuilder) - Method in class com.xatkit.core.platform.io.JsonEventMatcher
-
Converts the provided jsonObject
's field into out context values set in the provided builder
.
- convertParameterValueToString(Value) - Method in class com.xatkit.core.recognition.dialogflow.DialogFlowApi
-
Converts the provided
value
into a
String
.
- createEmptyContentRestHandler(RestHandlerFactory.EmptyContentRestHandlerFunction) - Static method in class com.xatkit.core.server.RestHandlerFactory
-
- createErrorEntity(RestHandlerException) - Static method in class com.xatkit.core.server.HttpEntityHelper
-
- createEventInstance(String, JsonElement) - Method in class com.xatkit.core.platform.io.JsonEventMatcher
-
Creates an EventInstance
from the provided eventDefinitionName
and content
.
- createHttpEntity(Object) - Static method in class com.xatkit.core.server.HttpEntityHelper
-
Creates an HttpEntity
from the provided object
.
- createInContextNames(IntentDefinition) - Method in class com.xatkit.core.recognition.dialogflow.DialogFlowApi
-
Creates the DialogFlow input Context
names from the provided intentDefinition
.
- createJsonRestHandler(RestHandlerFactory.JsonRestHandlerFunction) - Static method in class com.xatkit.core.server.RestHandlerFactory
-
Creates a
JsonRestHandler
and sets its handling method with the provided
function
.
- createOrReplacePublicFile(XatkitSession, String, File) - Method in class com.xatkit.core.server.XatkitServer
-
Creates a publicly accessible file from the provided session
, path
, and origin
.
- createOrReplacePublicFile(XatkitSession, String, String) - Method in class com.xatkit.core.server.XatkitServer
-
Creates a publicly accessible file from the provided session
, path
, and content
.
- createOrReplacePublicFile(XatkitSession, String, byte[]) - Method in class com.xatkit.core.server.XatkitServer
-
- createOutContexts(IntentDefinition) - Method in class com.xatkit.core.recognition.dialogflow.DialogFlowApi
-
Creates the DialogFlow output Context
s from the provided intentDefinition
.
- createParameters(List<Context>) - Method in class com.xatkit.core.recognition.dialogflow.DialogFlowApi
-
Creates the DialogFlow context parameters from the provided Xatkit contexts
.
- createRestHandler() - Method in class com.xatkit.core.platform.io.WebhookEventProvider
-
Returns the concrete
RestHandler
instance that handles incoming Rest requests.
- createRuntimeAction(XMemberFeatureCall, List<Object>, XatkitSession) - Method in class com.xatkit.core.platform.RuntimePlatform
-
Creates a new
RuntimeAction
instance from the provided
XMemberFeatureCall
.
- createSession(String) - Method in class com.xatkit.core.recognition.dialogflow.DialogFlowApi
-
- createSession(String) - Method in class com.xatkit.core.recognition.IntentRecognitionProvider
-
- createSession(String) - Method in class com.xatkit.core.recognition.regex.RegExIntentRecognitionProvider
-
- createTrainingPhrase(String, List<Context>) - Method in class com.xatkit.core.recognition.dialogflow.DialogFlowApi
-
Creates the DialogFlow's Intent.TrainingPhrase
from the provided trainingSentence
and outContexts
.
- CUSTOM_FOLLOWUP_LIFESPAN - Static variable in class com.xatkit.core.recognition.dialogflow.DialogFlowApi
-
The
Configuration
key to store the lifespan value to use when creating followup intents.
- CUSTOM_LIBRARIES_KEY_PREFIX - Static variable in class com.xatkit.core.XatkitCore
-
- CUSTOM_PLATFORMS_KEY_PREFIX - Static variable in class com.xatkit.core.XatkitCore
-
- decrementLifespanCounts() - Method in class com.xatkit.core.session.RuntimeContexts
-
Decrements the lifespanCount of all the stored contexts, and remove them if there lifespanCount decreases to 0.
- DEFAULT_FALLBACK_INTENT - Static variable in class com.xatkit.core.recognition.regex.RegExIntentRecognitionProvider
-
The Default Fallback Intent that is returned when the user input does not match any registered Intent.
- DEFAULT_IS_YES_NO_VALUE - Static variable in class com.xatkit.core.recognition.processor.IsEnglishYesNoQuestionPostProcessor
-
- DEFAULT_LANGUAGE_CODE - Static variable in class com.xatkit.core.recognition.dialogflow.DialogFlowApi
-
The default language processed by DialogFlow.
- DEFAULT_MESSAGE_DELAY - Static variable in class com.xatkit.core.platform.action.RuntimeArtifactAction
-
- DEFAULT_SENTIMENT_VALUE - Static variable in class com.xatkit.core.recognition.processor.EnglishSentimentPostProcessor
-
- DEFAULT_SERVER_LOCATION - Static variable in interface com.xatkit.core.server.XatkitServerUtils
-
The default Xatkit server location.
- DEFAULT_SERVER_PORT - Static variable in interface com.xatkit.core.server.XatkitServerUtils
-
The default port to use.
- DEFAULT_VARIABLE_TIMEOUT_VALUE - Static variable in class com.xatkit.core.session.RuntimeContexts
-
The default amount of time to spend waiting for a context variable (in seconds).
- deleteEntityDefinition(EntityDefinition) - Method in class com.xatkit.core.recognition.dialogflow.DialogFlowApi
-
Deletes the provided entityDefinition
from the underlying intent recognition provider.
- deleteEntityDefinition(EntityDefinition) - Method in class com.xatkit.core.recognition.IntentRecognitionProvider
-
Deletes the provided entityDefinition
from the underlying intent recognition provider.
- deleteEntityDefinition(EntityDefinition) - Method in class com.xatkit.core.recognition.regex.RegExIntentRecognitionProvider
-
Deletes the provided entityDefinition
.
- deleteIntentDefinition(IntentDefinition) - Method in class com.xatkit.core.recognition.dialogflow.DialogFlowApi
-
Deletes the provided intentDefinition
from the underlying intent recognition provider.
- deleteIntentDefinition(IntentDefinition) - Method in class com.xatkit.core.recognition.IntentRecognitionProvider
-
Deletes the provided intentDefinition
from the underlying intent recognition provider.
- deleteIntentDefinition(IntentDefinition) - Method in class com.xatkit.core.recognition.regex.RegExIntentRecognitionProvider
-
Deletes the provided intentDefinition
.
- DialogFlowApi - Class in com.xatkit.core.recognition.dialogflow
-
A concrete wrapper for the DialogFlow API client.
- DialogFlowApi(XatkitCore, Configuration) - Constructor for class com.xatkit.core.recognition.dialogflow.DialogFlowApi
-
- DialogFlowApi(XatkitCore, Configuration, RecognitionMonitor) - Constructor for class com.xatkit.core.recognition.dialogflow.DialogFlowApi
-
- DialogFlowCheckingUtils - Class in com.xatkit.core.recognition.dialogflow
-
An utility class that provides checking methods for DialogFlow models.
- DialogFlowEntityMapper - Class in com.xatkit.core.recognition.dialogflow
-
An
EntityMapper
initialized with DialogFlow's system entities.
- DialogFlowEntityMapper() - Constructor for class com.xatkit.core.recognition.dialogflow.DialogFlowEntityMapper
-
- DialogFlowException - Exception in com.xatkit.core.recognition.dialogflow
-
Wraps all the exceptions returned by the DialogFlow API.
- DialogFlowException() - Constructor for exception com.xatkit.core.recognition.dialogflow.DialogFlowException
-
- DialogFlowException(String) - Constructor for exception com.xatkit.core.recognition.dialogflow.DialogFlowException
-
- DialogFlowException(String, Throwable) - Constructor for exception com.xatkit.core.recognition.dialogflow.DialogFlowException
-
- DialogFlowException(Throwable) - Constructor for exception com.xatkit.core.recognition.dialogflow.DialogFlowException
-
- DialogFlowException(String, Throwable, boolean, boolean) - Constructor for exception com.xatkit.core.recognition.dialogflow.DialogFlowException
-
Constructs a new
DialogFlowException
from the provided
message
,
cause
,
enableSuppression
, and
writableStackTrace
.
- DialogFlowSession - Class in com.xatkit.core.recognition.dialogflow
-
A DialogFlow
XatkitSession
implementation that relies on DialogFlow internal sessions.
- DialogFlowSession(SessionName) - Constructor for class com.xatkit.core.recognition.dialogflow.DialogFlowSession
-
- DialogFlowSession(SessionName, Configuration) - Constructor for class com.xatkit.core.recognition.dialogflow.DialogFlowSession
-
- disableAction(ActionDefinition) - Method in class com.xatkit.core.platform.RuntimePlatform
-
Disables the
RuntimeAction
defined by the provided
ActionDefinition
.
- disableAllActions() - Method in class com.xatkit.core.platform.RuntimePlatform
-
- doEvaluate(XExpression, IEvaluationContext, CancelIndicator) - Method in class com.xatkit.core.ExecutionService
-
Evaluates the provided expression
.
- get(String) - Method in class com.xatkit.core.session.XatkitSession
-
Retrieves the session value associated to the provided key
.
- getAccessControlAllowHeaders() - Method in class com.xatkit.core.server.RestHandler
-
Returns the Access-Control-Allow-Headers
HTTP header values that must be set by the server when
calling this handler.
- getActionName(XMemberFeatureCall) - Static method in class com.xatkit.util.XbaseUtils
-
Returns the name of the action corresponding to the provided actionCall
.
- getActions() - Method in class com.xatkit.core.platform.RuntimePlatform
-
- getAllEventDefinitions() - Method in class com.xatkit.core.EventDefinitionRegistry
-
Returns an unmodifiable
Collection
containing all the registered
EventDefinition
s.
- getAllIntentDefinitions() - Method in class com.xatkit.core.EventDefinitionRegistry
-
Returns an unmodifiable
Collection
containing all the registered
IntentDefinition
s.
- getAnnotation(String, XatkitSession) - Method in class com.xatkit.core.recognition.processor.StanfordNLPPostProcessor
-
Computes the Annotation
for the provided input
.
- getBaseURL() - Method in class com.xatkit.core.server.XatkitServer
-
- getClientSession() - Method in class com.xatkit.core.platform.action.RuntimeArtifactAction
-
Returns the
XatkitSession
associated to the client of the artifact to send.
- getConfiguration() - Method in class com.xatkit.core.platform.RuntimePlatform
-
- getConfiguration() - Method in class com.xatkit.core.session.XatkitSession
-
- getConfiguration() - Static method in class com.xatkit.Xatkit
-
- getContextLifespanCount(String) - Method in class com.xatkit.core.session.RuntimeContexts
-
Returns the lifespan count of the provided context
.
- getContextMap() - Method in class com.xatkit.core.session.RuntimeContexts
-
Returns an unmodifiable
Map
representing the stored context values.
- getContextValue(String, String) - Method in class com.xatkit.core.session.RuntimeContexts
-
Returns the context
value associated to the provided key
.
- getContextVariables(String) - Method in class com.xatkit.core.session.RuntimeContexts
-
Returns all the variables stored in the given context
.
- getEndpointMethod() - Method in class com.xatkit.core.platform.io.WebhookEventProvider
-
Returns the
HttpMethod
of the REST endpoint to register the provided to.
- getEndpointURI() - Method in class com.xatkit.core.platform.io.WebhookEventProvider
-
Returns the URI of the REST endpoint to register the provider to.
- getErrorCode() - Method in exception com.xatkit.core.server.RestHandlerException
-
Returns the HTTP error code associated to this exception.
- getEventDefinition(String) - Method in class com.xatkit.core.EventDefinitionRegistry
-
Returns the EventDefinition
matching the provided name
.
- getEventDefinitionName() - Method in class com.xatkit.core.platform.io.EventInstanceBuilder
-
Returns the name of the EventDefinition
to bind to the created EventInstance
.
- getEventDefinitionOutContext(String) - Method in class com.xatkit.core.EventDefinitionRegistry
-
Retrieve the Context
matching the provided contextName
from the registered
EventDefinition
s.
- getEventDefinitionRegistry() - Method in class com.xatkit.core.XatkitCore
-
- getEventProviderMap() - Method in class com.xatkit.core.platform.RuntimePlatform
-
- getExecutionModel() - Method in class com.xatkit.core.ExecutionService
-
- getExecutionModel(Configuration) - Method in class com.xatkit.core.XatkitCore
-
Retrieves the ExecutionModel
from the provided property
.
- getExecutionService() - Method in class com.xatkit.core.XatkitCore
-
- getExecutionTime() - Method in class com.xatkit.core.platform.action.RuntimeActionResult
-
- getExecutorService() - Method in class com.xatkit.core.ExecutionService
-
- getFile(String, Configuration) - Static method in class com.xatkit.util.FileUtils
-
Retrieves the
File
corresponding to the provided
path
.
- getFormatter(String) - Method in class com.xatkit.core.XatkitCore
-
Returns the
Formatter
associated to the provided
formatterName
.
- getHeaderValue(List<Header>, String) - Method in class com.xatkit.core.server.RestHandler
-
Returns the Header
value associated to the provided headerKey
.
- getHttpServer() - Method in class com.xatkit.core.server.XatkitServer
-
Returns the underlying HttpServer
used to receive requests.
- getInstance() - Static method in class com.xatkit.core.recognition.processor.StanfordNLPService
-
Returns the singleton instance of this class.
- getIntent(String, XatkitSession) - Method in class com.xatkit.core.recognition.IntentRecognitionProvider
-
Returns the RecognizedIntent
extracted from te provided input
.
- getIntentDefinition(String) - Method in class com.xatkit.core.EventDefinitionRegistry
-
Returns the IntentDefinition
matching the provided name
.
- getIntentInternal(String, XatkitSession) - Method in class com.xatkit.core.recognition.dialogflow.DialogFlowApi
-
Returns the raw RecognizedIntent
extracted from the provided input
.
- getIntentInternal(String, XatkitSession) - Method in class com.xatkit.core.recognition.IntentRecognitionProvider
-
Returns the raw RecognizedIntent
extracted from the provided input
.
- getIntentInternal(String, XatkitSession) - Method in class com.xatkit.core.recognition.regex.RegExIntentRecognitionProvider
-
Computes the RecognizedIntent
associated to the provided input
.
- getIntentRecognitionProvider(XatkitCore, Configuration) - Static method in class com.xatkit.core.recognition.IntentRecognitionProviderFactory
-
- getIntentRecognitionProvider() - Method in class com.xatkit.core.XatkitCore
-
- getJsonBody(InputStream) - Static method in class com.xatkit.core.platform.action.RestAction
-
Extracts the JsonElement
contained in the provided is
.
- getJsonElementFromHttpEntity(HttpEntity) - Static method in class com.xatkit.core.server.HttpEntityHelper
-
Returns a JsonElement
extracted from the content of the provided entity
.
- getJsonElementFromJsonObject(JsonObject, String) - Static method in class com.xatkit.core.server.JsonRestHandler.JsonHelper
-
Returns the JsonElement
associated to the given key
in the provided object
.
- getKey() - Method in class com.xatkit.core.platform.io.JsonEventMatcher.FieldValue
-
- getKey() - Method in class com.xatkit.core.platform.io.JsonEventMatcher.HeaderValue
-
- getLanguageCode() - Method in class com.xatkit.core.recognition.dialogflow.DialogFlowApi
-
Returns the code of the language processed by DialogFlow.
- getLifespanCountsMap() - Method in class com.xatkit.core.session.RuntimeContexts
-
Returns an unmodifiable
Map
representing the stored lifespan counts.
- getLoadedPlatformDefinitions() - Method in class com.xatkit.core.RuntimePlatformRegistry
-
Returns a
Collection
containing all the loaded
PlatformDefinition
s.
- getMappingFor(EntityType) - Method in class com.xatkit.core.recognition.EntityMapper
-
Returns the concreteEntity
mapped to the provided abstractEntityType
.
- getMappingFor(EntityDefinition) - Method in class com.xatkit.core.recognition.EntityMapper
-
Returns the concreteEntity
mapped to the provided abstractEntity
.
- getMappingForCustomEntity(CustomEntityDefinition) - Method in class com.xatkit.core.recognition.dialogflow.DialogFlowEntityMapper
-
Maps the provided customEntityDefinition
to its DialogFlow implementation.
- getMappingForCustomEntity(CustomEntityDefinition) - Method in class com.xatkit.core.recognition.EntityMapper
-
Returns the
String
representing the entity mapped from the provided
customEntityDefinition
.
- getMessage() - Method in class com.xatkit.core.platform.action.RuntimeMessageAction
-
Returns the processed message.
- getName() - Method in class com.xatkit.core.platform.RuntimePlatform
-
Returns the name of the platform.
- getName(EObject) - Static method in class com.xatkit.util.EMFUtils
-
Computes the name of the provided eObject
.
- getOrCreateXatkitSession(String) - Method in class com.xatkit.core.XatkitCore
-
Retrieves or creates the
XatkitSession
associated to the provided
sessionId
.
- getOutContextValues() - Method in class com.xatkit.core.platform.io.EventInstanceBuilder
-
Returns an unmodifiable
Map
containing the output context parameters to bind to the
EventInstance
.
- getParameters(HttpRequest) - Static method in class com.xatkit.core.server.HttpUtils
-
Returns a
List
containing the parameters associated to the provided
httpRequest
.
- getParameterValue(String, List<NameValuePair>) - Static method in class com.xatkit.core.server.HttpUtils
-
Returns the value associated to the provided parameterName
from the given parameters
list.
- getPath(HttpRequest) - Static method in class com.xatkit.core.server.HttpUtils
-
Returns the path associated to the provided httpRequest
.
- getPlatformDefinition(String) - Method in class com.xatkit.core.RuntimePlatformRegistry
-
- getPlatformName(XMemberFeatureCall) - Static method in class com.xatkit.util.XbaseUtils
-
Returns the name of the platform corresponding to the provided actionCall
.
- getPort() - Method in class com.xatkit.core.server.XatkitServer
-
Returns the port the server is listening to.
- getProjectId() - Method in class com.xatkit.core.recognition.dialogflow.DialogFlowApi
-
Returns the DialogFlow project unique identifier.
- getPropertyInternal(String) - Method in class com.xatkit.util.XatkitEnvironmentConfiguration
-
Retrieves the value associated to the provided key
.
- getPublicFile(XatkitSession, String) - Method in class com.xatkit.core.server.XatkitServer
-
Retrieves the public
File
associated to the provided
session
and
filePath
.
- getPublicFile(String) - Method in class com.xatkit.core.server.XatkitServer
-
Retrieves the public
File
associated to the provided
filePath
.
- getPublicURL(File) - Method in class com.xatkit.core.server.XatkitServer
-
Retrieves the public URL associated to the provided file
if it exists.
- getRecognitionMonitor() - Method in class com.xatkit.core.recognition.dialogflow.DialogFlowApi
-
- getRecognitionMonitor() - Method in class com.xatkit.core.recognition.IntentRecognitionProvider
-
- getRecognitionMonitor() - Method in class com.xatkit.core.recognition.regex.RegExIntentRecognitionProvider
-
- getRecognizedIntent(String, XatkitSession, XatkitCore) - Static method in class com.xatkit.core.platform.io.IntentRecognitionHelper
-
Returns the RecognizedIntent
from the provided user input
and session
.
- getRegisteredRestHandler(HttpMethod, String) - Method in class com.xatkit.core.server.XatkitServer
-
Returns the
RestHandler
associated to the provided
uri
with the given
httpMethod
.
- getRegisteredRestHandlers() - Method in class com.xatkit.core.server.XatkitServer
-
- getRestHandler() - Method in class com.xatkit.core.platform.io.WebhookEventProvider
-
- getResult() - Method in class com.xatkit.core.platform.action.RuntimeActionResult
-
- getRuntimeContexts() - Method in class com.xatkit.core.session.XatkitSession
-
- getRuntimeEventProvider() - Method in class com.xatkit.core.platform.RuntimePlatform.EventProviderThread
-
- getRuntimePlatform() - Method in class com.xatkit.core.platform.io.RuntimeEventProvider
-
- getRuntimePlatform(String) - Method in class com.xatkit.core.RuntimePlatformRegistry
-
- getRuntimePlatform(PlatformDefinition) - Method in class com.xatkit.core.RuntimePlatformRegistry
-
- getRuntimePlatformRegistry() - Method in class com.xatkit.core.ExecutionService
-
- getRuntimePlatformRegistry() - Method in class com.xatkit.core.XatkitCore
-
- getRuntimePlatforms() - Method in class com.xatkit.core.RuntimePlatformRegistry
-
- getSession() - Method in class com.xatkit.core.platform.action.RuntimeAction
-
- getSessionId() - Method in class com.xatkit.core.session.XatkitSession
-
- getSessionName() - Method in class com.xatkit.core.recognition.dialogflow.DialogFlowSession
-
Returns the raw DialogFlow session.
- getSessionVariables() - Method in class com.xatkit.core.session.XatkitSession
-
Returns a
Map
containing the session variables.
- getStringBody(InputStream) - Static method in class com.xatkit.core.platform.action.RestAction
-
Extracts the
String
contained in the provided
is
.
- getStringFromHttpEntity(HttpEntity) - Static method in class com.xatkit.core.server.HttpEntityHelper
-
Returns the
String
representation of the content of the provided
entity
.
- getThrownException() - Method in class com.xatkit.core.platform.action.RuntimeActionResult
-
Return the
Exception
that has been thrown during the computation.
- getURIBuilderFrom(HttpRequest) - Static method in class com.xatkit.core.server.HttpUtils
-
Returns a URIBuilder
from the provided httpRequest
.
- getValue() - Method in class com.xatkit.core.platform.io.JsonEventMatcher.FieldValue
-
- getValue() - Method in class com.xatkit.core.platform.io.JsonEventMatcher.HeaderValue
-
- getVariableTimeout() - Method in class com.xatkit.core.session.RuntimeContexts
-
Returns the amount of time the
RuntimeContexts
can spend waiting for a context variable (in seconds).
- getXatkitCore() - Method in class com.xatkit.core.platform.RuntimePlatform
-
Returns the
XatkitCore
instance associated to this platform.
- getXatkitCore() - Static method in class com.xatkit.Xatkit
-
Returns the
XatkitCore
instance used to run the bot.
- getXatkitDirectory() - Static method in class com.xatkit.util.FileUtils
-
Returns the Xatkit installation directory.
- getXatkitServer() - Method in class com.xatkit.core.XatkitCore
-
- getXatkitSession(String) - Method in class com.xatkit.core.XatkitCore
-
- getXatkitSessions() - Method in class com.xatkit.core.XatkitCore
-
- GOOGLE_CREDENTIALS_PATH_KEY - Static variable in class com.xatkit.core.recognition.dialogflow.DialogFlowApi
-
The
Configuration
key to store the path of the
JSON
credential file for DialogFlow.
- init() - Method in class com.xatkit.core.platform.action.RuntimeAction
-
- init() - Method in class com.xatkit.core.platform.action.RuntimeArtifactAction
-
Retrieve the
XatkitSession
associated to the client of the artifact and merges it with the current one.
- init() - Method in interface com.xatkit.core.recognition.processor.InputPreProcessor
-
Initializes the pre-processor.
- init() - Method in interface com.xatkit.core.recognition.processor.IntentPostProcessor
-
Initializes the post-processor.
- init() - Method in class com.xatkit.core.recognition.processor.StanfordNLPPostProcessor
-
- init() - Method in class com.xatkit.core.recognition.processor.StanfordNLPService
-
Initialize the underlying StanfordCoreNLP
pipeline with the provided annotators.
- InputPreProcessor - Interface in com.xatkit.core.recognition.processor
-
Applies a pre-processing function on the provided input
.
- intentPatterns - Variable in class com.xatkit.core.recognition.regex.RegExIntentRecognitionProvider
-
The
Map
used to store RegExp
Pattern
s associated to the registered
IntentDefinition
.
- IntentPostProcessor - Interface in com.xatkit.core.recognition.processor
-
Applies a post-processing function on the provided recognizedIntent
.
- IntentRecognitionHelper - Class in com.xatkit.core.platform.io
-
A helper class that provides method to extract intents from input text.
- IntentRecognitionHelper() - Constructor for class com.xatkit.core.platform.io.IntentRecognitionHelper
-
- IntentRecognitionProvider - Class in com.xatkit.core.recognition
-
A unified wrapper for concrete intent recognition providers.
- IntentRecognitionProvider() - Constructor for class com.xatkit.core.recognition.IntentRecognitionProvider
-
- IntentRecognitionProviderException - Exception in com.xatkit.core.recognition
-
- IntentRecognitionProviderException() - Constructor for exception com.xatkit.core.recognition.IntentRecognitionProviderException
-
- IntentRecognitionProviderException(String) - Constructor for exception com.xatkit.core.recognition.IntentRecognitionProviderException
-
- IntentRecognitionProviderException(String, Throwable) - Constructor for exception com.xatkit.core.recognition.IntentRecognitionProviderException
-
- IntentRecognitionProviderException(Throwable) - Constructor for exception com.xatkit.core.recognition.IntentRecognitionProviderException
-
- IntentRecognitionProviderException(String, Throwable, boolean, boolean) - Constructor for exception com.xatkit.core.recognition.IntentRecognitionProviderException
-
- IntentRecognitionProviderFactory - Class in com.xatkit.core.recognition
-
- IntentRecognitionProviderFactory() - Constructor for class com.xatkit.core.recognition.IntentRecognitionProviderFactory
-
- IS_YES_NO_PARAMETER_KEY - Static variable in class com.xatkit.core.recognition.processor.IsEnglishYesNoQuestionPostProcessor
-
The context parameter key used to store whether the user input is a yes/no question.
- IsEnglishYesNoQuestionPostProcessor - Class in com.xatkit.core.recognition.processor
-
Computes whether the last sentence of the user input is a yes/no question.
- IsEnglishYesNoQuestionPostProcessor() - Constructor for class com.xatkit.core.recognition.processor.IsEnglishYesNoQuestionPostProcessor
-
Constructs an instance of this post-processor.
- isError() - Method in class com.xatkit.core.platform.action.RuntimeActionResult
-
- isPlatformActionCall(XMemberFeatureCall, RuntimePlatformRegistry) - Static method in class com.xatkit.util.XbaseUtils
-
Returns true
if the provided featureCall
is a platform's action call, false
otherwise.
- isRestEndpoint(HttpMethod, String) - Method in class com.xatkit.core.server.XatkitServer
-
Returns whether the provided httpMethod
on the given uri
is associated to a REST endpoint.
- isShutdown() - Method in class com.xatkit.core.ExecutionService
-
- isShutdown() - Method in class com.xatkit.core.recognition.dialogflow.DialogFlowApi
-
Returns whether the intent recognition provider client is shutdown.
- isShutdown() - Method in class com.xatkit.core.recognition.IntentRecognitionProvider
-
Returns whether the intent recognition provider client is shutdown.
- isShutdown() - Method in class com.xatkit.core.recognition.regex.RegExIntentRecognitionProvider
-
Returns whether the intent recognition provider client is shutdown.
- isShutdown() - Method in class com.xatkit.core.XatkitCore
-
Returns whether the
XatkitCore
client is shutdown.
- isStarted() - Method in class com.xatkit.core.server.XatkitServer
-
Returns
true
if the
XatkitServer
is started,
false
otherwise.
- RECOGNITION_POSTPROCESSORS_KEY - Static variable in class com.xatkit.core.recognition.IntentRecognitionProviderFactory
-
- RECOGNITION_PREPROCESSORS_KEY - Static variable in class com.xatkit.core.recognition.IntentRecognitionProviderFactory
-
- RecognitionMonitor - Class in com.xatkit.core.recognition
-
- RecognitionMonitor(XatkitServer, Configuration) - Constructor for class com.xatkit.core.recognition.RecognitionMonitor
-
- RegExEntityMapper - Class in com.xatkit.core.recognition.regex
-
- RegExEntityMapper() - Constructor for class com.xatkit.core.recognition.regex.RegExEntityMapper
-
- RegExIntentRecognitionProvider - Class in com.xatkit.core.recognition.regex
-
- RegExIntentRecognitionProvider(Configuration) - Constructor for class com.xatkit.core.recognition.regex.RegExIntentRecognitionProvider
-
- RegExIntentRecognitionProvider(Configuration, RecognitionMonitor) - Constructor for class com.xatkit.core.recognition.regex.RegExIntentRecognitionProvider
-
- registerEntityDefinition(EntityDefinition) - Method in class com.xatkit.core.recognition.dialogflow.DialogFlowApi
-
Registers the provided entityDefinition
in the underlying intent recognition provider.
- registerEntityDefinition(EntityDefinition) - Method in class com.xatkit.core.recognition.IntentRecognitionProvider
-
Registers the provided entityDefinition
in the underlying intent recognition provider.
- registerEntityDefinition(EntityDefinition) - Method in class com.xatkit.core.recognition.regex.RegExIntentRecognitionProvider
-
Registers the provided entityDefinition
.
- registerEventDefinition(EventDefinition) - Method in class com.xatkit.core.EventDefinitionRegistry
-
Registers the provided eventDefinition
.
- registerFormatFunction(Class<T>, Function<T, String>) - Method in class com.xatkit.core.platform.Formatter
-
Registers the provided function
to the given clazz
.
- registerFormatter(String, Formatter) - Method in class com.xatkit.core.XatkitCore
-
Registers the provided formatter
with the given formatterName
.
- registerIntentDefinition(IntentDefinition) - Method in class com.xatkit.core.recognition.dialogflow.DialogFlowApi
-
Registers the provided intentDefinition
in the underlying intent recognition provider.
- registerIntentDefinition(IntentDefinition) - Method in class com.xatkit.core.recognition.IntentRecognitionProvider
-
Registers the provided intentDefinition
in the underlying intent recognition provider.
- registerIntentDefinition(IntentDefinition) - Method in class com.xatkit.core.recognition.regex.RegExIntentRecognitionProvider
-
Registers the provided IntentDefinition
.
- registerLoadedPlatformDefinition(PlatformDefinition) - Method in class com.xatkit.core.RuntimePlatformRegistry
-
Registeres the provided platformDefinition
using its name
.
- registerRestEndpoint(HttpMethod, String, RestHandler) - Method in class com.xatkit.core.server.XatkitServer
-
Registers the provided handler
as a REST endpoint for the provided uri
.
- registerRuntimePlatform(RuntimePlatform) - Method in class com.xatkit.core.RuntimePlatformRegistry
-
Registers the provided platform
using its name
.
- registerRuntimePlatform(String, RuntimePlatform) - Method in class com.xatkit.core.RuntimePlatformRegistry
-
Registers the provided platform
with the provided name
.
- registerWebhookEventProvider(WebhookEventProvider) - Method in class com.xatkit.core.server.XatkitServer
-
- RemoveEnglishStopWordsPostProcessor - Class in com.xatkit.core.recognition.processor
-
Removes the English stop words from the intent's parameter values extracted from any
entities.
- RemoveEnglishStopWordsPostProcessor() - Constructor for class com.xatkit.core.recognition.processor.RemoveEnglishStopWordsPostProcessor
-
Loads the stop words
List
.
- removeMappingFor(EntityDefinition) - Method in class com.xatkit.core.recognition.EntityMapper
-
Removes the concreteEntity
mapped to the provided abstractEntity
.
- RestAction<T extends RuntimePlatform> - Class in com.xatkit.core.platform.action
-
A generic REST action.
- RestAction(T, XatkitSession, RestAction.MethodKind, Map<String, String>, String, Map<String, Object>, JsonElement) - Constructor for class com.xatkit.core.platform.action.RestAction
-
- RestAction.MethodKind - Enum in com.xatkit.core.platform.action
-
The kind of REST methods supported by this class.
- restEndpoint - Variable in class com.xatkit.core.platform.action.RestAction
-
The REST API endpoint to request.
- RestGetAction<T extends RuntimePlatform> - Class in com.xatkit.core.platform.action
-
A generic REST GET action.
- RestGetAction(T, XatkitSession, Map<String, String>, String, Map<String, Object>) - Constructor for class com.xatkit.core.platform.action.RestGetAction
-
- RestHandler<C> - Class in com.xatkit.core.server
-
A generic Rest request handler.
- RestHandler() - Constructor for class com.xatkit.core.server.RestHandler
-
- RestHandlerException - Exception in com.xatkit.core.server
-
- RestHandlerException() - Constructor for exception com.xatkit.core.server.RestHandlerException
-
- RestHandlerException(int, String) - Constructor for exception com.xatkit.core.server.RestHandlerException
-
- RestHandlerException(String) - Constructor for exception com.xatkit.core.server.RestHandlerException
-
- RestHandlerException(String, Throwable) - Constructor for exception com.xatkit.core.server.RestHandlerException
-
- RestHandlerException(int, String, Throwable) - Constructor for exception com.xatkit.core.server.RestHandlerException
-
- RestHandlerException(Throwable) - Constructor for exception com.xatkit.core.server.RestHandlerException
-
- RestHandlerException(int, Throwable) - Constructor for exception com.xatkit.core.server.RestHandlerException
-
- RestHandlerException(String, Throwable, boolean, boolean) - Constructor for exception com.xatkit.core.server.RestHandlerException
-
Constructs a
RestHandlerException
from the provided
message
,
cause
,
enableSuppression
, and
writeableStackTrace
.
- RestHandlerFactory - Class in com.xatkit.core.server
-
- RestHandlerFactory() - Constructor for class com.xatkit.core.server.RestHandlerFactory
-
- RestHandlerFactory.EmptyContentRestHandlerFunction - Interface in com.xatkit.core.server
-
- RestHandlerFactory.JsonRestHandlerFunction - Interface in com.xatkit.core.server
-
A functional interface representing the handling function of
JsonRestHandler
.
- RestPostAction<T extends RuntimePlatform> - Class in com.xatkit.core.platform.action
-
A generic REST POST action.
- RestPostAction(T, XatkitSession, Map<String, String>, String, Map<String, Object>, JsonElement) - Constructor for class com.xatkit.core.platform.action.RestPostAction
-
- run() - Method in class com.xatkit.core.platform.io.WebhookEventProvider
-
Runs the provider.
- RuntimeAction<T extends RuntimePlatform> - Class in com.xatkit.core.platform.action
-
The concrete implementation of an ActionDefinition
definition.
- RuntimeAction(T, XatkitSession) - Constructor for class com.xatkit.core.platform.action.RuntimeAction
-
Constructs a new
RuntimeAction
with the provided
runtimePlatform
and
session
.
- RuntimeActionResult - Class in com.xatkit.core.platform.action
-
Stores the result of a computation and provides utility methods to manipulate it.
- RuntimeActionResult(Object, long) - Constructor for class com.xatkit.core.platform.action.RuntimeActionResult
-
- RuntimeActionResult(Object, Exception, long) - Constructor for class com.xatkit.core.platform.action.RuntimeActionResult
-
Constructs a new
RuntimeActionResult
from the provided
partialResult
,
thrownException
,
and
executionTime
.
- RuntimeArtifactAction<T extends RuntimePlatform> - Class in com.xatkit.core.platform.action
-
- RuntimeArtifactAction(T, XatkitSession) - Constructor for class com.xatkit.core.platform.action.RuntimeArtifactAction
-
- RuntimeContexts - Class in com.xatkit.core.session
-
- RuntimeContexts() - Constructor for class com.xatkit.core.session.RuntimeContexts
-
- RuntimeContexts(Configuration) - Constructor for class com.xatkit.core.session.RuntimeContexts
-
- RuntimeEventProvider<T extends RuntimePlatform> - Class in com.xatkit.core.platform.io
-
An abstract class representing user input providers.
- RuntimeEventProvider(T) - Constructor for class com.xatkit.core.platform.io.RuntimeEventProvider
-
- RuntimeEventProvider(T, Configuration) - Constructor for class com.xatkit.core.platform.io.RuntimeEventProvider
-
- RuntimeMessageAction<T extends RuntimePlatform> - Class in com.xatkit.core.platform.action
-
- RuntimeMessageAction(T, XatkitSession, String) - Constructor for class com.xatkit.core.platform.action.RuntimeMessageAction
-
- runtimePlatform - Variable in class com.xatkit.core.platform.action.RuntimeAction
-
- runtimePlatform - Variable in class com.xatkit.core.platform.io.RuntimeEventProvider
-
- RuntimePlatform - Class in com.xatkit.core.platform
-
The concrete implementation of a PlatformDefinition
.
- RuntimePlatform(XatkitCore, Configuration) - Constructor for class com.xatkit.core.platform.RuntimePlatform
-
- RuntimePlatform(XatkitCore) - Constructor for class com.xatkit.core.platform.RuntimePlatform
-
- RuntimePlatform.EventProviderThread - Class in com.xatkit.core.platform
-
- RuntimePlatformRegistry - Class in com.xatkit.core
-
- RuntimePlatformRegistry() - Constructor for class com.xatkit.core.RuntimePlatformRegistry
-
- sendEventInstance(EventInstance, XatkitSession) - Method in class com.xatkit.core.platform.io.RuntimeEventProvider
-
Sends the provided eventInstance
and session
for computation to the Xatkit core component.
- SENTIMENT_PARAMETER_KEY - Static variable in class com.xatkit.core.recognition.processor.EnglishSentimentPostProcessor
-
The context parameter key used to store the sentiment extracted from the user input.
- SERVER_KEYSTORE_KEY_PASSWORD_KEY - Static variable in interface com.xatkit.core.server.XatkitServerUtils
-
The
Configuration
key used to specify the
key password
of the SSL keystore.
- SERVER_KEYSTORE_LOCATION_KEY - Static variable in interface com.xatkit.core.server.XatkitServerUtils
-
The
Configuration
key used to specify the location of the keystore to create the SSL context from.
- SERVER_KEYSTORE_STORE_PASSWORD_KEY - Static variable in interface com.xatkit.core.server.XatkitServerUtils
-
The
Configuration
key used to specify the
store password
of the SSL keystore.
- SERVER_PORT_KEY - Static variable in interface com.xatkit.core.server.XatkitServerUtils
-
- SERVER_PUBLIC_URL_KEY - Static variable in interface com.xatkit.core.server.XatkitServerUtils
-
The
Configuration
key used to specify the Xatkit server location (public URL).
- session - Variable in class com.xatkit.core.platform.action.RuntimeAction
-
- setContext(ContextInstance) - Method in class com.xatkit.core.session.RuntimeContexts
-
Sets the context associated to the provided contextInstance
.
- setContext(String, int) - Method in class com.xatkit.core.session.RuntimeContexts
-
Sets the provided context
with the given lifespanCount
.
- setContextValue(String, int, String, Object) - Method in class com.xatkit.core.session.RuntimeContexts
-
Stores the provided value
in the given context
with the provided key
and lifespanCount
.
- setContextValue(ContextParameterValue) - Method in class com.xatkit.core.session.RuntimeContexts
-
Stores the provided contextParameterValue
in the context.
- setEventDefinitionName(String) - Method in class com.xatkit.core.platform.io.EventInstanceBuilder
-
Sets the name of the EventDefinition
to bind to the created EventInstance
.
- setFallbackEntityMapping(String) - Method in class com.xatkit.core.recognition.EntityMapper
-
Sets the default mapping for abstractEntities
that are not mapped to concrete implementations.
- setOutContextValue(String, String) - Method in class com.xatkit.core.platform.io.EventInstanceBuilder
-
Sets the created EventInstance
's output context parameter contextKey
with the given contextValue
.
- setPostProcessors(List<? extends IntentPostProcessor>) - Method in class com.xatkit.core.recognition.IntentRecognitionProvider
-
- setPreProcessors(List<? extends InputPreProcessor>) - Method in class com.xatkit.core.recognition.IntentRecognitionProvider
-
- shutdown() - Method in class com.xatkit.core.ExecutionService
-
- shutdown() - Method in class com.xatkit.core.platform.RuntimePlatform
-
- shutdown() - Method in class com.xatkit.core.recognition.dialogflow.DialogFlowApi
-
Shuts down the intent recognition provider client and invalidates the remaining sessions.
- shutdown() - Method in class com.xatkit.core.recognition.IntentRecognitionProvider
-
Shuts down the intent recognition provider client and invalidates the remaining sessions.
- shutdown() - Method in class com.xatkit.core.recognition.RecognitionMonitor
-
Commit the pending operations on the database and closes the connection.
- shutdown() - Method in class com.xatkit.core.recognition.regex.RegExIntentRecognitionProvider
-
Shuts down the intent recognition provider client and invalidates the remaining sessions.
- shutdown() - Method in class com.xatkit.core.XatkitCore
-
Shuts down the
XatkitCore
and the underlying engines.
- StanfordNLPPostProcessor - Class in com.xatkit.core.recognition.processor
-
- StanfordNLPPostProcessor() - Constructor for class com.xatkit.core.recognition.processor.StanfordNLPPostProcessor
-
- StanfordNLPService - Class in com.xatkit.core.recognition.processor
-
A singleton class that wraps a StanfordCoreNLP
pipeline used to process user messages.
- start() - Method in class com.xatkit.core.server.XatkitServer
-
Starts the underlying HttpServer
.
- startEventProvider(EventProviderDefinition) - Method in class com.xatkit.core.platform.RuntimePlatform
-
- stop() - Method in class com.xatkit.core.server.XatkitServer
-
Stops the underlying HttpServer
.
- store(String, Object) - Method in class com.xatkit.core.session.XatkitSession
-
Store the provided value
with the given key
as a session variable.
- storeList(String, Object) - Method in class com.xatkit.core.session.XatkitSession
-
Store the provided
value
in the
List
associated to the provided
key
as a session
variable.