Constructor Detail

Method Detail

• findIntent

   Intent findIntent(String intent, String applicationId)

  Finds an Intent from an intent name.

• findStoryDefinition

   StoryDefinition findStoryDefinition(IntentAware intent, String applicationId)

  Finds a StoryDefinition from an Intent.

• findStoryDefinition

   StoryDefinition findStoryDefinition(String intent, String applicationId)

  Finds a StoryDefinition from an intent name.

  Parameters:

  intent - the intent name

  applicationId - the optional applicationId

• findStoryDefinitionById

   StoryDefinition findStoryDefinitionById(String storyId, String applicationId)

  Search story by storyId.

• findStoryByStoryHandler

   StoryDefinition findStoryByStoryHandler(StoryHandler storyHandler, String applicationId)

  Search story by storyHandler.

• errorAction

   Action errorAction(PlayerId playerId, String applicationId, PlayerId recipientId)

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

• disableBot

   Boolean disableBot(UserTimeline timeline, Dialog dialog, Action action)

  Does this action trigger bot deactivation ?

• hasDisableTagIntent

   Boolean hasDisableTagIntent(Dialog dialog)

  Returns true if the dialog current intent is a disabling intent.

• enableBot

   Boolean enableBot(UserTimeline timeline, Dialog dialog, Action action)

  Does this action trigger bot activation ?

• hasToPersistAction

   Boolean hasToPersistAction(UserTimeline timeline, Action action)

  If this method returns true, the action will be added in the stored history.

  By default, actions where the bot is not only ai.tock.bot.engine.dialog.EventState.notification are added in the bot history.

• i18n

   I18nLabelValue i18n(CharSequence defaultLabel, List<Object> args)

• entity

   Entity entity(String name, String role)

  Returns the entity with the specified name and optional role.

• i18nTranslator

   I18nTranslator i18nTranslator(Locale userLocale, ConnectorType connectorType, UserInterfaceType userInterfaceType, String contextId)

  Returns an I18nTranslator for the specified userLocale and connectorType.

• defaultDelay

   Long defaultDelay(Integer answerIndex)

  Get the default delay between two answers.

• getBotId

   abstract String getBotId()

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

• getNamespace

   abstract String getNamespace()

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

• getNlpModelName

   abstract String getNlpModelName()

  The name of the main nlp model.

• getRagConfiguration

   abstract BotRAGConfiguration getRagConfiguration()

  RAG configuration

• setRagConfiguration

   abstract Unit setRagConfiguration(BotRAGConfiguration ragConfiguration)

  RAG configuration

• getVectorStoreConfiguration

   abstract BotVectorStoreConfiguration getVectorStoreConfiguration()

  Vector Store configuration

• setVectorStoreConfiguration

   abstract Unit setVectorStoreConfiguration(BotVectorStoreConfiguration vectorStoreConfiguration)

  Vector Store configuration

• getObservabilityConfiguration

   abstract BotObservabilityConfiguration getObservabilityConfiguration()

  Observability configuration

• setObservabilityConfiguration

   abstract Unit setObservabilityConfiguration(BotObservabilityConfiguration observabilityConfiguration)

  Observability configuration

• getStories

   abstract List<StoryDefinition> getStories()

  The list of each story.

• getUnknownStory

   abstract StoryDefinition getUnknownStory()

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

• getRagExcludedStory

   abstract StoryDefinition getRagExcludedStory()

  The ragExcluded Story. Used where ragexcluded intent is found.

• getRagStory

   abstract StoryDefinition getRagStory()

  The ragStory. Used if RAG is enabled.

• getDefaultUnknownAnswer

   abstract I18nLabelValue getDefaultUnknownAnswer()

  The default unknown answer.

• getDefaultRagExcludedAnswer

   abstract I18nLabelValue getDefaultRagExcludedAnswer()

  The default rag excluded answer.

• getKeywordStory

   abstract StoryDefinition getKeywordStory()

  To handle keywords - used to bypass nlp.

• getHelloStory

   abstract StoryDefinition getHelloStory()

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

• getDefaultStory

   StoryDefinition getDefaultStory()

• getGoodbyeStory

   abstract StoryDefinition getGoodbyeStory()

  The goodbye story. Used when closing the conversation.

• getNoInputStory

   abstract StoryDefinition getNoInputStory()

  The no input story. When user does nothing!

• getUserLocationStory

   abstract StoryDefinition getUserLocationStory()

  The story that handles ai.tock.bot.engine.action.SendLocation action. If it's null, current intent is used.

• getHandleAttachmentStory

   abstract StoryDefinition getHandleAttachmentStory()

  The story that handles ai.tock.bot.engine.action.SendAttachment action. If it's null, current intent is used.

• getEventListener

   abstract EventListener getEventListener()

  To handle custom events.

• getBotDisabledStory

   abstract StoryDefinition getBotDisabledStory()

  To manage deactivation.

• getBotDisabledStories

   List<StoryDefinition> getBotDisabledStories()

• getBotEnabledStory

   abstract StoryDefinition getBotEnabledStory()

  To manage reactivation.

• getBotEnabledStories

   List<StoryDefinition> getBotEnabledStories()

• getBotEnabledListener

   Function1<Action, Unit> getBotEnabledListener()

• getTestBehaviour

   TestBehaviour getTestBehaviour()

• getFlowDefinition

   DialogFlowDefinition getFlowDefinition()