Package ai.tock.bot.admin.story
Class StoryDefinitionConfiguration
-
- All Implemented Interfaces:
-
ai.tock.bot.admin.story.StoryDefinitionAnswersContainer
public final class StoryDefinitionConfiguration implements StoryDefinitionAnswersContainerA StoryDefinition defined at runtime.
-
-
Field Summary
-
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)
-
Method Summary
Modifier and Type Method Description final StringgetStoryId()The story definition identifier. final StringgetBotId()The bot identifier. final IntentWithoutNamespacegetIntent()The target main intent. AnswerConfigurationTypegetCurrentType()The type of answer configuration. List<AnswerConfiguration>getAnswers()The answers available. final IntegergetVersion()The version of the story. final StringgetNamespace()The namespace of the story. final List<StoryDefinitionConfigurationMandatoryEntity>getMandatoryEntities()The mandatory entities. final List<StoryDefinitionConfigurationStep>getSteps()The optional steps. final StringgetName()The name of the story. final StringgetCategory()The category of the story. final StringgetDescription()The description of the story. final StringgetUserSentence()The user sentence sample. final LocalegetUserSentenceLocale()The user sentence sample locale. final StringgetConfigurationName()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 BooleangetMetricStory()True if the story handle metrics and is not a main tracked story List<CharSequence>findNextSteps(BotBus bus, StoryDefinitionConfiguration story)final UnitsaveMetric(Metric metric)Save one Metric final UnitsaveMetrics(List<Metric> metrics)Save many Metric final StringfindEnabledEndWithStoryId(String applicationId)-
-
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.
-
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.
-
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)
-
-
-
-