ai.tock.nlp.front.shared

Interface ApplicationConfiguration

public ApplicationConfiguration

Method Summary

Modifier and Type	Method and Description
void	deleteApplicationById(org.litote.kmongo.Id<ai.tock.nlp.front.shared.config.ApplicationDefinition> id)
boolean	deleteEntityTypeByName(java.lang.String name) Delete the class EntityTypeDefinition and cleanup all sentences from this entity type.
void	deletePredefinedValueByName(java.lang.String entityTypeName, java.lang.String predefinedValue)
void	deletePredefinedValueLabelByName(java.lang.String entityTypeName, java.lang.String predefinedValue, java.util.Locale locale, java.lang.String label)
void	deleteSentencesByStatus(ClassifiedSentenceStatus status)
ApplicationDefinition	getApplicationById(org.litote.kmongo.Id<ai.tock.nlp.front.shared.config.ApplicationDefinition> id)
ApplicationDefinition	getApplicationByNamespaceAndName(java.lang.String namespace, java.lang.String name)
java.util.List<ai.tock.nlp.front.shared.config.ApplicationDefinition>	getApplications()
ai.tock.nlp.core.configuration.NlpApplicationConfiguration	getCurrentModelConfiguration(java.lang.String applicationName, ai.tock.nlp.core.NlpEngineType nlpEngineType) Returns the current model configuration.
ai.tock.nlp.core.DictionaryData	getDictionaryDataByEntityName(java.lang.String qualifiedName) Load DictionaryData for entity qualified name.
EntityTypeDefinition	getEntityTypeByName(java.lang.String name)
java.util.List<ai.tock.nlp.front.shared.config.EntityTypeDefinition>	getEntityTypes()
IntentDefinition	getIntentById(org.litote.kmongo.Id<ai.tock.nlp.front.shared.config.IntentDefinition> id)
IntentDefinition	getIntentByNamespaceAndName(java.lang.String namespace, java.lang.String name)
org.litote.kmongo.Id<ai.tock.nlp.front.shared.config.IntentDefinition>	getIntentIdByQualifiedName(java.lang.String name)
java.util.List<ai.tock.nlp.front.shared.config.IntentDefinition>	getIntentsByApplicationId(org.litote.kmongo.Id<ai.tock.nlp.front.shared.config.ApplicationDefinition> applicationId)
java.util.List<ai.tock.nlp.front.shared.config.ClassifiedSentence>	getSentences(java.util.Set<? extends org.litote.kmongo.Id<ai.tock.nlp.front.shared.config.IntentDefinition>> intents, java.util.Locale language, ClassifiedSentenceStatus status) Get the sentences with the specified criteria.
java.util.Set<ai.tock.nlp.core.NlpEngineType>	getSupportedNlpEngineTypes() Returns supported NLP engines.
void	initializeConfiguration() Load the configuration cache.
boolean	removeEntityFromIntent(ApplicationDefinition application, IntentDefinition intent, java.lang.String entityType, java.lang.String role) Remove entity from intent.
boolean	removeIntentFromApplication(ApplicationDefinition application, org.litote.kmongo.Id<ai.tock.nlp.front.shared.config.IntentDefinition> intentId) Remove intent from application.
boolean	removeSubEntityFromEntity(ApplicationDefinition application, EntityTypeDefinition entityType, java.lang.String role) Remove a sub entity from an entity.
ApplicationDefinition	save(ApplicationDefinition application)
void	save(ClassifiedSentence sentence, java.lang.String user)
void	save(EntityTypeDefinition entityType)
void	save(ai.tock.nlp.core.DictionaryData data) Save DictionaryData.
void	save(IntentDefinition intent)
SentencesQueryResult	search(SentencesQuery query)
int	switchSentencesEntity(java.util.List<ai.tock.nlp.front.shared.config.ClassifiedSentence> sentences, ApplicationDefinition targetApplication, EntityDefinition oldEntity, EntityDefinition newEntity) Switch old entity to new entity.
int	switchSentencesIntent(java.util.List<ai.tock.nlp.front.shared.config.ClassifiedSentence> sentences, ApplicationDefinition targetApplication, org.litote.kmongo.Id<ai.tock.nlp.front.shared.config.IntentDefinition> targetIntentId) Switch specified sentences to a new intent.
void	switchSentencesStatus(java.util.List<ai.tock.nlp.front.shared.config.ClassifiedSentence> sentences, ClassifiedSentenceStatus newStatus)
void	updateEntityDefinition(java.lang.String namespace, java.lang.String applicationName, EntityDefinition entity) Update matching entity definition of all intents of the specified application.
void	updateModelConfiguration(java.lang.String applicationName, ai.tock.nlp.core.NlpEngineType engineType, ai.tock.nlp.core.configuration.NlpApplicationConfiguration configuration) Updates the model configuration for the given application name.

Method Detail

save

@NotNull
ApplicationDefinition save(@NotNull
                                    ApplicationDefinition application)

deleteApplicationById

void deleteApplicationById(@NotNull
                           org.litote.kmongo.Id<ai.tock.nlp.front.shared.config.ApplicationDefinition> id)

getApplicationByNamespaceAndName

@Nullable
ApplicationDefinition getApplicationByNamespaceAndName(@NotNull
                                                                 java.lang.String namespace,
                                                                 @NotNull
                                                                 java.lang.String name)

getApplicationById

@Nullable
ApplicationDefinition getApplicationById(@NotNull
                                                   org.litote.kmongo.Id<ai.tock.nlp.front.shared.config.ApplicationDefinition> id)

getApplications

@NotNull
java.util.List<ai.tock.nlp.front.shared.config.ApplicationDefinition> getApplications()

removeIntentFromApplication

boolean removeIntentFromApplication(@NotNull
                                    ApplicationDefinition application,
                                    @NotNull
                                    org.litote.kmongo.Id<ai.tock.nlp.front.shared.config.IntentDefinition> intentId)

Remove intent from application.

Returns:

true if intent is also deleted, false either

getSentences

@NotNull
java.util.List<ai.tock.nlp.front.shared.config.ClassifiedSentence> getSentences(@Nullable
                                                                                         java.util.Set<? extends org.litote.kmongo.Id<ai.tock.nlp.front.shared.config.IntentDefinition>> intents,
                                                                                         @Nullable
                                                                                         java.util.Locale language,
                                                                                         @Nullable
                                                                                         ClassifiedSentenceStatus status)

Get the sentences with the specified criteria.

Throws:

error - if all parameters are null

deleteSentencesByStatus

void deleteSentencesByStatus(@NotNull
                             ClassifiedSentenceStatus status)

save

void save(@NotNull
          ClassifiedSentence sentence,
          @Nullable
          java.lang.String user)

search

@NotNull
SentencesQueryResult search(@NotNull
                                     SentencesQuery query)

switchSentencesStatus

void switchSentencesStatus(@NotNull
                           java.util.List<ai.tock.nlp.front.shared.config.ClassifiedSentence> sentences,
                           @NotNull
                           ClassifiedSentenceStatus newStatus)

switchSentencesIntent

int switchSentencesIntent(@NotNull
                          java.util.List<ai.tock.nlp.front.shared.config.ClassifiedSentence> sentences,
                          @NotNull
                          ApplicationDefinition targetApplication,
                          @NotNull
                          org.litote.kmongo.Id<ai.tock.nlp.front.shared.config.IntentDefinition> targetIntentId)

Switch specified sentences to a new intent.

Returns:

the number of sentences updated

switchSentencesEntity

int switchSentencesEntity(@NotNull
                          java.util.List<ai.tock.nlp.front.shared.config.ClassifiedSentence> sentences,
                          @NotNull
                          ApplicationDefinition targetApplication,
                          @NotNull
                          EntityDefinition oldEntity,
                          @NotNull
                          EntityDefinition newEntity)

Switch old entity to new entity.

Returns:

the number of sentences updated

save

void save(@NotNull
          EntityTypeDefinition entityType)

getEntityTypes

@NotNull
java.util.List<ai.tock.nlp.front.shared.config.EntityTypeDefinition> getEntityTypes()

getEntityTypeByName

@Nullable
EntityTypeDefinition getEntityTypeByName(@NotNull
                                                   java.lang.String name)

getDictionaryDataByEntityName

@Nullable
ai.tock.nlp.core.DictionaryData getDictionaryDataByEntityName(@NotNull
                                                                        java.lang.String qualifiedName)

Load DictionaryData for entity qualified name.

save

void save(@NotNull
          ai.tock.nlp.core.DictionaryData data)

Save DictionaryData.

deleteEntityTypeByName

boolean deleteEntityTypeByName(@NotNull
                               java.lang.String name)

Delete the class EntityTypeDefinition and cleanup all sentences from this entity type.

See Also:

class EntityTypeDefinition

updateEntityDefinition

void updateEntityDefinition(@NotNull
                            java.lang.String namespace,
                            @NotNull
                            java.lang.String applicationName,
                            @NotNull
                            EntityDefinition entity)

Update matching entity definition of all intents of the specified application.

getIntentsByApplicationId

@NotNull
java.util.List<ai.tock.nlp.front.shared.config.IntentDefinition> getIntentsByApplicationId(@NotNull
                                                                                                    org.litote.kmongo.Id<ai.tock.nlp.front.shared.config.ApplicationDefinition> applicationId)

getIntentById

@Nullable
IntentDefinition getIntentById(@NotNull
                                         org.litote.kmongo.Id<ai.tock.nlp.front.shared.config.IntentDefinition> id)

getIntentByNamespaceAndName

@Nullable
IntentDefinition getIntentByNamespaceAndName(@NotNull
                                                       java.lang.String namespace,
                                                       @NotNull
                                                       java.lang.String name)

save

void save(@NotNull
          IntentDefinition intent)

getIntentIdByQualifiedName

@Nullable
org.litote.kmongo.Id<ai.tock.nlp.front.shared.config.IntentDefinition> getIntentIdByQualifiedName(@NotNull
                                                                                                            java.lang.String name)

removeEntityFromIntent

boolean removeEntityFromIntent(@NotNull
                               ApplicationDefinition application,
                               @NotNull
                               IntentDefinition intent,
                               @NotNull
                               java.lang.String entityType,
                               @NotNull
                               java.lang.String role)

Remove entity from intent.

Returns:

true if the entity type is also deleted, false either.

removeSubEntityFromEntity

boolean removeSubEntityFromEntity(@NotNull
                                  ApplicationDefinition application,
                                  @NotNull
                                  EntityTypeDefinition entityType,
                                  @NotNull
                                  java.lang.String role)

Remove a sub entity from an entity.

Returns:

true if the entity type is also deleted, false either.

getSupportedNlpEngineTypes

@NotNull
java.util.Set<ai.tock.nlp.core.NlpEngineType> getSupportedNlpEngineTypes()

Returns supported NLP engines.

deletePredefinedValueByName

void deletePredefinedValueByName(@NotNull
                                 java.lang.String entityTypeName,
                                 @NotNull
                                 java.lang.String predefinedValue)

deletePredefinedValueLabelByName

void deletePredefinedValueLabelByName(@NotNull
                                      java.lang.String entityTypeName,
                                      @NotNull
                                      java.lang.String predefinedValue,
                                      @NotNull
                                      java.util.Locale locale,
                                      @NotNull
                                      java.lang.String label)

initializeConfiguration

void initializeConfiguration()

Load the configuration cache.

getCurrentModelConfiguration

@NotNull
ai.tock.nlp.core.configuration.NlpApplicationConfiguration getCurrentModelConfiguration(@NotNull
                                                                                                 java.lang.String applicationName,
                                                                                                 @NotNull
                                                                                                 ai.tock.nlp.core.NlpEngineType nlpEngineType)

Returns the current model configuration.

updateModelConfiguration

void updateModelConfiguration(@NotNull
                              java.lang.String applicationName,
                              @NotNull
                              ai.tock.nlp.core.NlpEngineType engineType,
                              @NotNull
                              ai.tock.nlp.core.configuration.NlpApplicationConfiguration configuration)

Updates the model configuration for the given application name.