ai.tock.bot.engine

Interface ConnectorController

public ConnectorController

Controller to connect interface Connector and interface BotDefinition.

See Also:

interface Connector, interface BotDefinition

Constructor Detail

ConnectorController

public ConnectorController()

Method Detail

getBotDefinition

@NotNull
BotDefinition getBotDefinition()

The bot definition served by the controller.

getConnector

@NotNull
Connector getConnector()

The connector used by the controller.

getConnectorType

@NotNull
ConnectorType getConnectorType()

The type of connector used by the controller.

notify

void notify(@NotNull
            PlayerId recipientId,
            @NotNull
            IntentAware intent,
            @Nullable
            StoryStep<? extends ai.tock.bot.definition.StoryHandlerDefinition> step,
            @NotNull
            java.util.Map<java.lang.String,java.lang.String> parameters,
            @Nullable
            ActionNotificationType notificationType,
            @NotNull
            kotlin.jvm.functions.Function1<? super java.lang.Throwable,kotlin.Unit> errorListener)

Sends a notification to the connector. A interface BotBus is created and the corresponding story is called.

Parameters:

recipientId - the recipient identifier

intent - the notification intent

step - the optional step target

parameters - the optional parameters

notificationType - notification type if any

errorListener - called when a message has not been delivered

See Also:

interface BotBus

handle

void handle(@NotNull
            Event event,
            @NotNull
            ConnectorData data)

Handles an event sent by the connector. the primary goal of this controller.

Parameters:

event - the event to handle

data - the optional additional data from the connector

support

double support(@NotNull
               Action action,
               @NotNull
               ConnectorData data)

Return a probability of the support by the bot of this action

• by default returns the nlp intent probability.

Returns:

a probability between 0.0 (not supported) and 1.0 (supported!)

registerServices

void registerServices(@NotNull
                      java.lang.String serviceIdentifier,
                      @NotNull
                      kotlin.jvm.functions.Function1<? super io.vertx.ext.web.Router,kotlin.Unit> installer)

Register services at startup.

unregisterServices

void unregisterServices()

Unregister services when interface Connector is unregistered.

See Also:

interface Connector

errorMessage

@NotNull
Action errorMessage(@NotNull
                             PlayerId playerId,
                             @NotNull
                             java.lang.String applicationId,
                             @NotNull
                             PlayerId recipientId)

Returns an error message (technical error).

storyDefinitionLoader

@NotNull
kotlin.jvm.functions.Function1<java.lang.String,ai.tock.bot.definition.StoryDefinition> storyDefinitionLoader()

Return a story definition provider for this controller.