All Implemented Interfaces:: ai.tock.bot.admin.story.StoryDefinitionAnswersContainer


public final class StoryDefinitionConfiguration
 implements StoryDefinitionAnswersContainer

A StoryDefinition defined at runtime.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private final String`	`storyId`
`private final String`	`botId`
`private final IntentWithoutNamespace`	`intent`
`private final AnswerConfigurationType`	`currentType`
`private final List<AnswerConfiguration>`	`answers`
`private final Integer`	`version`
`private final String`	`namespace`
`private final List<StoryDefinitionConfigurationMandatoryEntity>`	`mandatoryEntities`
`private final List<StoryDefinitionConfigurationStep>`	`steps`
`private final String`	`name`
`private final String`	`category`
`private final String`	`description`
`private final String`	`userSentence`
`private final Locale`	`userSentenceLocale`
`private final String`	`configurationName`
`private final List<StoryDefinitionConfigurationFeature>`	`features`
`private final Id<StoryDefinitionConfiguration>`	`_id`
`private final Set<StoryTag>`	`tags`
`private final List<DedicatedAnswerConfiguration>`	`configuredAnswers`
`private final List<StoryDefinitionConfigurationByBotStep>`	`configuredSteps`
`private final List<NlpIntentQualifier>`	`nextIntentsQualifiers`
`private final Boolean`	`metricStory`

Constructor Summary

Constructors
Constructor	Description
`StoryDefinitionConfiguration(BotDefinition botDefinition, StoryDefinition storyDefinition, String configurationName)`
StoryDefinitionConfiguration(String storyId, String botId, IntentWithoutNamespace intent, AnswerConfigurationType currentType, List<AnswerConfiguration> answers, Integer version, String namespace, List<StoryDefinitionConfigurationMandatoryEntity> mandatoryEntities, List<StoryDefinitionConfigurationStep> steps, String name, String category, String description, String userSentence, Locale userSentenceLocale, String configurationName, List<StoryDefinitionConfigurationFeature> features, Id<StoryDefinitionConfiguration> _id, Set<StoryTag> tags, List<DedicatedAnswerConfiguration> configuredAnswers, List<StoryDefinitionConfigurationByBotStep> configuredSteps, List<NlpIntentQualifier> nextIntentsQualifiers, Boolean metricStory)

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final String`	`getStoryId()`	The story definition identifier.
`final String`	`getBotId()`	The bot identifier.
`final IntentWithoutNamespace`	`getIntent()`	The target main intent.
`AnswerConfigurationType`	`getCurrentType()`	The type of answer configuration.
`List<AnswerConfiguration>`	`getAnswers()`	The answers available.
`final Integer`	`getVersion()`	The version of the story.
`final String`	`getNamespace()`	The namespace of the story.
`final List<StoryDefinitionConfigurationMandatoryEntity>`	`getMandatoryEntities()`	The mandatory entities.
`final List<StoryDefinitionConfigurationStep>`	`getSteps()`	The optional steps.
`final String`	`getName()`	The name of the story.
`final String`	`getCategory()`	The category of the story.
`final String`	`getDescription()`	The description of the story.
`final String`	`getUserSentence()`	The user sentence sample.
`final Locale`	`getUserSentenceLocale()`	The user sentence sample locale.
`final String`	`getConfigurationName()`	The configuration name if any.
`final List<StoryDefinitionConfigurationFeature>`	`getFeatures()`	Current features.
`final Id<StoryDefinitionConfiguration>`	`get_id()`	The configuration identifier.
`final Set<StoryTag>`	`getTags()`	The story definition tags that specify different story types or roles.
`final List<DedicatedAnswerConfiguration>`	`getConfiguredAnswers()`	Answers by bot application configuration
`final List<StoryDefinitionConfigurationByBotStep>`	`getConfiguredSteps()`	Steps by bot application configuration
`final List<NlpIntentQualifier>`	`getNextIntentsQualifiers()`	To filter/re-qualify next intents
`final Boolean`	`getMetricStory()`	True if the story handle metrics and is not a main tracked story
`List<CharSequence>`	`findNextSteps(BotBus bus, StoryDefinitionConfiguration story)`
`final Unit`	`saveMetric(Metric metric)`	Save one Metric
`final Unit`	`saveMetrics(List<Metric> metrics)`	Save many Metric
`final String`	`findEnabledEndWithStoryId(String applicationId)`

Methods inherited from class ai.tock.bot.admin.story.StoryDefinitionAnswersContainer
findAnswer, findCurrentAnswer, hasCurrentAnswer, storyDefinition
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StoryDefinitionConfiguration

StoryDefinitionConfiguration(BotDefinition botDefinition, StoryDefinition storyDefinition, String configurationName)

StoryDefinitionConfiguration

StoryDefinitionConfiguration(String storyId, String botId, IntentWithoutNamespace intent, AnswerConfigurationType currentType, List<AnswerConfiguration> answers, Integer version, String namespace, List<StoryDefinitionConfigurationMandatoryEntity> mandatoryEntities, List<StoryDefinitionConfigurationStep> steps, String name, String category, String description, String userSentence, Locale userSentenceLocale, String configurationName, List<StoryDefinitionConfigurationFeature> features, Id<StoryDefinitionConfiguration> _id, Set<StoryTag> tags, List<DedicatedAnswerConfiguration> configuredAnswers, List<StoryDefinitionConfigurationByBotStep> configuredSteps, List<NlpIntentQualifier> nextIntentsQualifiers, Boolean metricStory)

Method Detail

getStoryId
```
 final String getStoryId()
```
The story definition identifier.

getBotId
```
 final String getBotId()
```
The bot identifier.

getIntent

 final IntentWithoutNamespace getIntent()

The target main intent.

getCurrentType
```
 AnswerConfigurationType getCurrentType()
```
The type of answer configuration.

getAnswers
```
 List<AnswerConfiguration> getAnswers()
```
The answers available.

getVersion
```
 final Integer getVersion()
```
The version of the story.

getNamespace
```
 final String getNamespace()
```
The namespace of the story.

getMandatoryEntities

 final List<StoryDefinitionConfigurationMandatoryEntity> getMandatoryEntities()

The mandatory entities.

getSteps

 final List<StoryDefinitionConfigurationStep> getSteps()

The optional steps.

getName
```
 final String getName()
```
The name of the story.

getCategory
```
 final String getCategory()
```
The category of the story.

getDescription
```
 final String getDescription()
```
The description of the story.

getUserSentence
```
 final String getUserSentence()
```
The user sentence sample.

getUserSentenceLocale
```
 final Locale getUserSentenceLocale()
```
The user sentence sample locale.

getConfigurationName
```
 final String getConfigurationName()
```
The configuration name if any.

getFeatures

 final List<StoryDefinitionConfigurationFeature> getFeatures()

Current features.

get_id

 final Id<StoryDefinitionConfiguration> get_id()

The configuration identifier.

getTags
```
 final Set<StoryTag> getTags()
```
The story definition tags that specify different story types or roles.

getConfiguredAnswers

 final List<DedicatedAnswerConfiguration> getConfiguredAnswers()

Answers by bot application configuration

getConfiguredSteps

 final List<StoryDefinitionConfigurationByBotStep> getConfiguredSteps()

Steps by bot application configuration

getNextIntentsQualifiers

 final List<NlpIntentQualifier> getNextIntentsQualifiers()

To filter/re-qualify next intents

getMetricStory
```
 final Boolean getMetricStory()
```
True if the story handle metrics and is not a main tracked story

findNextSteps

 List<CharSequence> findNextSteps(BotBus bus, StoryDefinitionConfiguration story)

saveMetric
```
 final Unit saveMetric(Metric metric)
```
Save one Metric

Parameters:

metric - a Metric to save

saveMetrics
```
 final Unit saveMetrics(List<Metric> metrics)
```
Save many Metric

Parameters:

metrics - a set of Metric to save

findEnabledEndWithStoryId

 final String findEnabledEndWithStoryId(String applicationId)

Class StoryDefinitionConfiguration

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class ai.tock.bot.admin.story.StoryDefinitionAnswersContainer

Methods inherited from class java.lang.Object

Constructor Detail

StoryDefinitionConfiguration

StoryDefinitionConfiguration

Method Detail

getStoryId

getBotId

getIntent

getCurrentType

getAnswers

getVersion

getNamespace

getMandatoryEntities

getSteps

getName

getCategory

getDescription

getUserSentence

getUserSentenceLocale

getConfigurationName

getFeatures

get_id

getTags

getConfiguredAnswers

getConfiguredSteps

getNextIntentsQualifiers

getMetricStory

findNextSteps

saveMetric

saveMetrics

findEnabledEndWithStoryId