All Implemented Interfaces:

ai.tock.bot.definition.BotDefinition , ai.tock.translator.I18nKeyProvider
```
public class BotDefinitionBase
 implements BotDefinition
                    
```
Base implementation of BotDefinition.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public class`	`BotDefinitionBase.Companion`

Field Summary

Fields
Modifier and Type	Field	Description
`private final I18nLabelValue`	`defaultUnknownAnswer`
`private final I18nLabelValue`	`defaultRagExcludedAnswer`
`private final String`	`botId`
`private final String`	`namespace`
`private final List<StoryDefinition>`	`stories`
`private final String`	`nlpModelName`
`private final StoryDefinition`	`unknownStory`
`private final StoryDefinition`	`helloStory`
`private final StoryDefinition`	`goodbyeStory`
`private final StoryDefinition`	`noInputStory`
`private final StoryDefinition`	`botDisabledStory`
`private final StoryDefinition`	`botEnabledStory`
`private final StoryDefinition`	`userLocationStory`
`private final StoryDefinition`	`handleAttachmentStory`
`private final EventListener`	`eventListener`
`private final StoryDefinition`	`keywordStory`
`private final DialogFlowDefinition`	`flowDefinition`
`private final Function1<Action, Unit>`	`botEnabledListener`
`private final StoryDefinition`	`ragExcludedStory`
`private final StoryDefinition`	`ragStory`
`private BotRAGConfiguration`	`ragConfiguration`
`private BotVectorStoreConfiguration`	`vectorStoreConfiguration`
`private BotObservabilityConfiguration`	`observabilityConfiguration`
`private final StoryDefinition`	`defaultStory`
`private final List<StoryDefinition>`	`botDisabledStories`
`private final List<StoryDefinition>`	`botEnabledStories`
`private final TestBehaviour`	`testBehaviour`
`public final static BotDefinitionBase.Companion`	`Companion`

Constructor Summary

Constructors
Constructor	Description
`BotDefinitionBase(String botId, Array<out StoryDefinition> stories)`	Constructor intended to be used by an enum.
BotDefinitionBase(String botId, String namespace, List<StoryDefinition> stories, String nlpModelName, StoryDefinition unknownStory, StoryDefinition helloStory, StoryDefinition goodbyeStory, StoryDefinition noInputStory, StoryDefinition botDisabledStory, StoryDefinition botEnabledStory, StoryDefinition userLocationStory, StoryDefinition handleAttachmentStory, EventListener eventListener, StoryDefinition keywordStory, DialogFlowDefinition flowDefinition, Function1<Action, Unit> botEnabledListener, StoryDefinition ragExcludedStory, StoryDefinition ragStory, BotRAGConfiguration ragConfiguration, BotVectorStoreConfiguration vectorStoreConfiguration, BotObservabilityConfiguration observabilityConfiguration)

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`I18nLabelValue`	`getDefaultUnknownAnswer()`	The default unknown answer.
`I18nLabelValue`	`getDefaultRagExcludedAnswer()`	The default rag excluded answer.
`String`	`getBotId()`	The main bot id.
`String`	`getNamespace()`	The namespace of the bot.
`List<StoryDefinition>`	`getStories()`	The list of each story.
`String`	`getNlpModelName()`	The name of the main nlp model.
`StoryDefinition`	`getUnknownStory()`	The unknown story.
`StoryDefinition`	`getHelloStory()`	The hello story.
`StoryDefinition`	`getGoodbyeStory()`	The goodbye story.
`StoryDefinition`	`getNoInputStory()`	The no input story.
`StoryDefinition`	`getBotDisabledStory()`	To manage deactivation.
`StoryDefinition`	`getBotEnabledStory()`	To manage reactivation.
`StoryDefinition`	`getUserLocationStory()`	The story that handles ai.tock.bot.engine.action.SendLocation action.
`StoryDefinition`	`getHandleAttachmentStory()`	The story that handles ai.tock.bot.engine.action.SendAttachment action.
`EventListener`	`getEventListener()`	To handle custom events.
`StoryDefinition`	`getKeywordStory()`	To handle keywords - used to bypass nlp.
`DialogFlowDefinition`	`getFlowDefinition()`
`Function1<Action, Unit>`	`getBotEnabledListener()`	Listener invoked when bot is enabled.
`StoryDefinition`	`getRagExcludedStory()`	The ragExcluded Story.
`StoryDefinition`	`getRagStory()`	The ragStory.
`BotRAGConfiguration`	`getRagConfiguration()`	RAG configuration
`Unit`	`setRagConfiguration(BotRAGConfiguration ragConfiguration)`	RAG configuration
`BotVectorStoreConfiguration`	`getVectorStoreConfiguration()`	Vector Store configuration
`Unit`	`setVectorStoreConfiguration(BotVectorStoreConfiguration vectorStoreConfiguration)`	Vector Store configuration
`BotObservabilityConfiguration`	`getObservabilityConfiguration()`	Observability configuration
`Unit`	`setObservabilityConfiguration(BotObservabilityConfiguration observabilityConfiguration)`	Observability configuration
`String`	`toString()`

Methods inherited from class ai.tock.bot.definition.BotDefinition
defaultDelay, disableBot, enableBot, entity, errorAction, findIntent, findStoryByStoryHandler, findStoryDefinition, findStoryDefinition, findStoryDefinitionById, getBotDisabledStories, getBotEnabledStories, getDefaultStory, getTestBehaviour, hasDisableTagIntent, hasToPersistAction, i18n, i18nTranslator
Methods inherited from class ai.tock.translator.I18nKeyProvider
i18n
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BotDefinitionBase

BotDefinitionBase(String botId, Array<out StoryDefinition> stories)

Constructor intended to be used by an enum.

BotDefinitionBase

BotDefinitionBase(String botId, String namespace, List<StoryDefinition> stories, String nlpModelName, StoryDefinition unknownStory, StoryDefinition helloStory, StoryDefinition goodbyeStory, StoryDefinition noInputStory, StoryDefinition botDisabledStory, StoryDefinition botEnabledStory, StoryDefinition userLocationStory, StoryDefinition handleAttachmentStory, EventListener eventListener, StoryDefinition keywordStory, DialogFlowDefinition flowDefinition, Function1<Action, Unit> botEnabledListener, StoryDefinition ragExcludedStory, StoryDefinition ragStory, BotRAGConfiguration ragConfiguration, BotVectorStoreConfiguration vectorStoreConfiguration, BotObservabilityConfiguration observabilityConfiguration)

Method Detail
- getDefaultUnknownAnswer
```
 I18nLabelValue getDefaultUnknownAnswer()
```
  The default unknown answer.
- getDefaultRagExcludedAnswer
```
 I18nLabelValue getDefaultRagExcludedAnswer()
```
  The default rag excluded answer.
- getBotId
```
 String getBotId()
```
  The main bot id. Must be different for each bot.
- getNamespace
```
 String getNamespace()
```
  The namespace of the bot. It has to be the same namespace than the NLP models.
- getStories
```
 List<StoryDefinition> getStories()
```
  The list of each story.
- getNlpModelName
```
 String getNlpModelName()
```
  The name of the main nlp model.
- getUnknownStory
```
 StoryDefinition getUnknownStory()
```
  The unknown story. Used where no valid intent is found.
- getHelloStory
```
 StoryDefinition getHelloStory()
```
  The hello story. Used for first interaction with no other input.
- getGoodbyeStory
```
 StoryDefinition getGoodbyeStory()
```
  The goodbye story. Used when closing the conversation.
- getNoInputStory
```
 StoryDefinition getNoInputStory()
```
  The no input story. When user does nothing!
- getBotDisabledStory
```
 StoryDefinition getBotDisabledStory()
```
  To manage deactivation.
- getBotEnabledStory
```
 StoryDefinition getBotEnabledStory()
```
  To manage reactivation.
- getUserLocationStory
```
 StoryDefinition getUserLocationStory()
```
  The story that handles ai.tock.bot.engine.action.SendLocation action. If it's null, current intent is used.
- getHandleAttachmentStory
```
 StoryDefinition getHandleAttachmentStory()
```
  The story that handles ai.tock.bot.engine.action.SendAttachment action. If it's null, current intent is used.
- getEventListener
```
 EventListener getEventListener()
```
  To handle custom events.
- getKeywordStory
```
 StoryDefinition getKeywordStory()
```
  To handle keywords - used to bypass nlp.
- getFlowDefinition
```
 DialogFlowDefinition getFlowDefinition()
```
- getBotEnabledListener
```
 Function1<Action, Unit> getBotEnabledListener()
```
  Listener invoked when bot is enabled.
- getRagExcludedStory
```
 StoryDefinition getRagExcludedStory()
```
  The ragExcluded Story. Used where ragexcluded intent is found.
- getRagStory
```
 StoryDefinition getRagStory()
```
  The ragStory. Used if RAG is enabled.
- getRagConfiguration
```
 BotRAGConfiguration getRagConfiguration()
```
  RAG configuration
- setRagConfiguration
```
 Unit setRagConfiguration(BotRAGConfiguration ragConfiguration)
```
  RAG configuration
- getVectorStoreConfiguration
```
 BotVectorStoreConfiguration getVectorStoreConfiguration()
```
  Vector Store configuration
- setVectorStoreConfiguration
```
 Unit setVectorStoreConfiguration(BotVectorStoreConfiguration vectorStoreConfiguration)
```
  Vector Store configuration
- getObservabilityConfiguration
```
 BotObservabilityConfiguration getObservabilityConfiguration()
```
  Observability configuration
- setObservabilityConfiguration
```
 Unit setObservabilityConfiguration(BotObservabilityConfiguration observabilityConfiguration)
```
  Observability configuration
- toString
```
 String toString()
```

Class BotDefinitionBase

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class ai.tock.bot.definition.BotDefinition

Methods inherited from class ai.tock.translator.I18nKeyProvider

Methods inherited from class java.lang.Object

Constructor Detail

BotDefinitionBase

BotDefinitionBase

Method Detail

getDefaultUnknownAnswer

getDefaultRagExcludedAnswer

getBotId

getNamespace

getStories

getNlpModelName

getUnknownStory

getHelloStory

getGoodbyeStory

getNoInputStory

getBotDisabledStory

getBotEnabledStory

getUserLocationStory

getHandleAttachmentStory

getEventListener

getKeywordStory

getFlowDefinition

getBotEnabledListener

getRagExcludedStory

getRagStory

getRagConfiguration

setRagConfiguration

getVectorStoreConfiguration

setVectorStoreConfiguration

getObservabilityConfiguration

setObservabilityConfiguration

toString