ai.tock.bot.definition

Interface BotDefinition

All Known Implementing Classes:

BotDefinitionBase, SimpleBotDefinition

public BotDefinition

The main interface used to define the behaviour of the bot.

New bots should usually not directly extend this class, but instead extend class BotDefinitionBase.

See Also:

class BotDefinitionBase

Field Detail

Companion

static ai.tock.bot.definition.BotDefinition.Companion Companion

Method Detail

getBotId

@NotNull
java.lang.String getBotId()

The main bot id. Must be different for each bot.

getNamespace

@NotNull
java.lang.String getNamespace()

The namespace of the bot. It has to be the same namespace than the NLP models.

getNlpModelName

@NotNull
java.lang.String getNlpModelName()

The name of the main nlp model.

getStories

@NotNull
java.util.List<ai.tock.bot.definition.StoryDefinition> getStories()

The list of each stories.

findIntent

@NotNull
Intent findIntent(@NotNull
                           java.lang.String intent)

Finds an class Intent from an intent name.

See Also:

class Intent

findStoryDefinition

@NotNull
StoryDefinition findStoryDefinition(@Nullable
                                             IntentAware intent)

Finds a interface StoryDefinition from an class Intent.

See Also:

interface StoryDefinition, class Intent

findStoryDefinition

@NotNull
StoryDefinition findStoryDefinition(@Nullable
                                             java.lang.String intent,
                                             @Nullable
                                             java.lang.String applicationId)

Finds a interface StoryDefinition from an intent name.

Parameters:

intent - the intent name

applicationId - the optional applicationId

See Also:

interface StoryDefinition

getUnknownStory

@NotNull
StoryDefinition getUnknownStory()

The unknown story. Used where no valid intent is found.

getDefaultUnknownAnswer

@NotNull
ai.tock.translator.I18nLabelValue getDefaultUnknownAnswer()

The default unknown answer.

getKeywordStory

@NotNull
StoryDefinition getKeywordStory()

To handle keywords - used to bypass nlp.

getHelloStory

@Nullable
StoryDefinition getHelloStory()

The hello story. Used for first interaction with no other input.

getGoodbyeStory

@Nullable
StoryDefinition getGoodbyeStory()

The goodbye story. Used when closing the conversation.

getNoInputStory

@Nullable
StoryDefinition getNoInputStory()

The no input story. When user does nothing!

getUserLocationStory

@Nullable
StoryDefinition getUserLocationStory()

The story that handles class SendLocation action. If it's null, current intent is used.

See Also:

class SendLocation

getHandleAttachmentStory

@Nullable
StoryDefinition getHandleAttachmentStory()

The story that handles class SendAttachment action. If it's null, current intent is used.

See Also:

class SendAttachment

getEventListener

@NotNull
EventListener getEventListener()

To handle custom events.

errorAction

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

Called when error occurs. By default send "technical error".

getBotDisabledStory

@Nullable
StoryDefinition getBotDisabledStory()

To manage deactivation.

isBotDisabledIntent

boolean isBotDisabledIntent(@Nullable
                            Intent intent)

Is this intent disable the bot?

getBotEnabledStory

@Nullable
StoryDefinition getBotEnabledStory()

To manage reactivation.

isBotEnabledIntent

boolean isBotEnabledIntent(@Nullable
                           Intent intent)

Is this intent is reactivating the bot?

getBotEnabledListener

@NotNull
kotlin.jvm.functions.Function1<ai.tock.bot.engine.action.Action,kotlin.Unit> getBotEnabledListener()

Listener invoked when bot is enabled.

getTestBehaviour

@NotNull
TestBehaviour getTestBehaviour()

Returns a interface TestBehaviour. Used in Integration Tests.

See Also:

interface TestBehaviour

i18n

@NotNull
ai.tock.translator.I18nLabelValue i18n(@NotNull
                                                java.lang.CharSequence defaultLabel,
                                                @NotNull
                                                java.util.List<? extends java.lang.Object> args)

entity

@NotNull
ai.tock.nlp.api.client.model.Entity entity(@NotNull
                                                    java.lang.String name,
                                                    @Nullable
                                                    java.lang.String role)

Returns the entity with the specified name and optional role.

i18nTranslator

@NotNull
I18nTranslator i18nTranslator(@NotNull
                                       java.util.Locale userLocale,
                                       @NotNull
                                       ConnectorType connectorType,
                                       @NotNull
                                       ai.tock.translator.UserInterfaceType userInterfaceType,
                                       @Nullable
                                       java.lang.String contextId)

Returns an interface I18nTranslator for the specified userLocale and connectorType.

See Also:

interface I18nTranslator, userLocale, connectorType

defaultDelay

long defaultDelay(int answerIndex)

Get the default delay between two answers.

getFlowDefinition

@Nullable
DialogFlowDefinition getFlowDefinition()