ai.tock.nlp.front.shared.config

Class IntentDefinition

ai.tock.nlp.front.shared.config.IntentDefinition

public class IntentDefinition

Definition of an intent.

Constructor Summary

Constructors

Constructor and Description

IntentDefinition(java.lang.String name, java.lang.String namespace, java.util.Set<? extends org.litote.kmongo.Id<ai.tock.nlp.front.shared.config.ApplicationDefinition>> applications, java.util.Set<ai.tock.nlp.front.shared.config.EntityDefinition> entities, java.util.Map<java.util.Locale,? extends java.util.LinkedHashSet<ai.tock.nlp.core.EntitiesRegexp>> entitiesRegexp, java.util.Set<java.lang.String> mandatoryStates, java.util.Set<? extends org.litote.kmongo.Id<ai.tock.nlp.front.shared.config.IntentDefinition>> sharedIntents, java.lang.String label, java.lang.String description, java.lang.String category, org.litote.kmongo.Id<ai.tock.nlp.front.shared.config.IntentDefinition> _id) Definition of an intent.

Method Summary

Modifier and Type	Method and Description
java.lang.String	component1() The name of the intent.
java.lang.String	component10() The optional category of the intent.
org.litote.kmongo.Id<ai.tock.nlp.front.shared.config.IntentDefinition>	component11() The unique
java.lang.String	component2() The namespace of the intent.
java.util.Set<org.litote.kmongo.Id>	component3() The applications using this intent.
java.util.Set<ai.tock.nlp.front.shared.config.EntityDefinition>	component4() The
java.util.Map<java.util.Locale,java.util.LinkedHashSet>	component5()
java.util.Set<java.lang.String>	component6() This intent is returned as a classification result
java.util.Set<org.litote.kmongo.Id>	component7() The qualified sentences of each
java.lang.String	component8() The optional displayed label of the intent.
java.lang.String	component9() The optional description of the intent.
IntentDefinition	copy(java.lang.String name, java.lang.String namespace, java.util.Set<? extends org.litote.kmongo.Id<ai.tock.nlp.front.shared.config.ApplicationDefinition>> applications, java.util.Set<ai.tock.nlp.front.shared.config.EntityDefinition> entities, java.util.Map<java.util.Locale,? extends java.util.LinkedHashSet<ai.tock.nlp.core.EntitiesRegexp>> entitiesRegexp, java.util.Set<java.lang.String> mandatoryStates, java.util.Set<? extends org.litote.kmongo.Id<ai.tock.nlp.front.shared.config.IntentDefinition>> sharedIntents, java.lang.String label, java.lang.String description, java.lang.String category, org.litote.kmongo.Id<ai.tock.nlp.front.shared.config.IntentDefinition> _id) Definition of an intent.
boolean	equals(java.lang.Object p)
EntityDefinition	findEntity(java.lang.String type, java.lang.String role)
EntityDefinition	findEntity(java.lang.String role)
EntityDefinition	findEntity(ai.tock.nlp.core.Entity entity)
java.util.Set<org.litote.kmongo.Id>	getApplications() The applications using this intent.
java.lang.String	getCategory() The optional category of the intent.
java.lang.String	getDescription() The optional description of the intent.
java.util.Set<ai.tock.nlp.front.shared.config.EntityDefinition>	getEntities() The
java.util.Map<java.util.Locale,java.util.LinkedHashSet>	getEntitiesRegexp()
java.lang.String	getLabel() The optional displayed label of the intent.
java.util.Set<java.lang.String>	getMandatoryStates() This intent is returned as a classification result
java.lang.String	getName() The name of the intent.
java.lang.String	getNamespace() The namespace of the intent.
java.lang.String	getQualifiedName() Qualified name (ie "namespace:name") of the intent.
java.util.Set<org.litote.kmongo.Id>	getSharedIntents() The qualified sentences of each
org.litote.kmongo.Id<ai.tock.nlp.front.shared.config.IntentDefinition>	get_id() The unique
boolean	hasEntity(ai.tock.nlp.core.Entity entity)
boolean	hasEntity(ClassifiedEntity entity)
int	hashCode()
boolean	supportStates(java.util.Set<java.lang.String> states)
java.lang.String	toString()

Constructor Detail

IntentDefinition

public IntentDefinition(@NotNull
                        java.lang.String name,
                        @NotNull
                        java.lang.String namespace,
                        @NotNull
                        java.util.Set<? extends org.litote.kmongo.Id<ai.tock.nlp.front.shared.config.ApplicationDefinition>> applications,
                        @NotNull
                        java.util.Set<ai.tock.nlp.front.shared.config.EntityDefinition> entities,
                        @NotNull
                        java.util.Map<java.util.Locale,? extends java.util.LinkedHashSet<ai.tock.nlp.core.EntitiesRegexp>> entitiesRegexp,
                        @NotNull
                        java.util.Set<java.lang.String> mandatoryStates,
                        @NotNull
                        java.util.Set<? extends org.litote.kmongo.Id<ai.tock.nlp.front.shared.config.IntentDefinition>> sharedIntents,
                        @Nullable
                        java.lang.String label,
                        @Nullable
                        java.lang.String description,
                        @Nullable
                        java.lang.String category,
                        @NotNull
                        org.litote.kmongo.Id<ai.tock.nlp.front.shared.config.IntentDefinition> _id)

Definition of an intent.

Parameters:

name - The name of the intent.

namespace - The namespace of the intent.

applications - The applications using this intent.

entities - The class EntityDefinitions of this intent.

mandatoryStates - This intent is returned as a classification resultonly if at least one of the mandatory states is requested.There is no restriction for intents with empty mandatory states set.

sharedIntents - The qualified sentences of each "shared intent" that contains only entities supported by the current intentare used to build the entity model of this intent.

label - The optional displayed label of the intent.

description - The optional description of the intent.

category - The optional category of the intent.

_id - The unique Id of the intent.

Method Detail

getQualifiedName

@NotNull
public java.lang.String getQualifiedName()

Qualified name (ie "namespace:name") of the intent.

findEntity

@Nullable
public EntityDefinition findEntity(@NotNull
                                             java.lang.String type,
                                             @NotNull
                                             java.lang.String role)

findEntity

@Nullable
public EntityDefinition findEntity(@NotNull
                                             java.lang.String role)

findEntity

@Nullable
public EntityDefinition findEntity(@NotNull
                                             ai.tock.nlp.core.Entity entity)

hasEntity

public boolean hasEntity(@NotNull
                         ai.tock.nlp.core.Entity entity)

hasEntity

public boolean hasEntity(@NotNull
                         ClassifiedEntity entity)

supportStates

public boolean supportStates(@NotNull
                             java.util.Set<java.lang.String> states)

getName

@NotNull
public java.lang.String getName()

The name of the intent.

getNamespace

@NotNull
public java.lang.String getNamespace()

The namespace of the intent.

getApplications

@NotNull
public java.util.Set<org.litote.kmongo.Id> getApplications()

The applications using this intent.

getEntities

@NotNull
public java.util.Set<ai.tock.nlp.front.shared.config.EntityDefinition> getEntities()

The

class EntityDefinitions of this intent.

See Also:

class EntityDefinition

getEntitiesRegexp

@NotNull
public java.util.Map<java.util.Locale,java.util.LinkedHashSet> getEntitiesRegexp()

getMandatoryStates

@NotNull
public java.util.Set<java.lang.String> getMandatoryStates()

This intent is returned as a classification result

only if at least one of the mandatory states is requested.There is no restriction for intents with empty mandatory states set.

getSharedIntents

@NotNull
public java.util.Set<org.litote.kmongo.Id> getSharedIntents()

The qualified sentences of each

"shared intent" that contains only entities supported by the current intentare used to build the entity model of this intent.

getLabel

@Nullable
public java.lang.String getLabel()

The optional displayed label of the intent.

getDescription

@Nullable
public java.lang.String getDescription()

The optional description of the intent.

getCategory

@Nullable
public java.lang.String getCategory()

The optional category of the intent.

get_id

@NotNull
public org.litote.kmongo.Id<ai.tock.nlp.front.shared.config.IntentDefinition> get_id()

The unique

Id of the intent.

component1

@NotNull
public java.lang.String component1()

The name of the intent.

component2

@NotNull
public java.lang.String component2()

The namespace of the intent.

component3

@NotNull
public java.util.Set<org.litote.kmongo.Id> component3()

The applications using this intent.

component4

@NotNull
public java.util.Set<ai.tock.nlp.front.shared.config.EntityDefinition> component4()

The

class EntityDefinitions of this intent.

See Also:

class EntityDefinition

component5

@NotNull
public java.util.Map<java.util.Locale,java.util.LinkedHashSet> component5()

component6

@NotNull
public java.util.Set<java.lang.String> component6()

This intent is returned as a classification result

only if at least one of the mandatory states is requested.There is no restriction for intents with empty mandatory states set.

component7

@NotNull
public java.util.Set<org.litote.kmongo.Id> component7()

The qualified sentences of each

"shared intent" that contains only entities supported by the current intentare used to build the entity model of this intent.

component8

@Nullable
public java.lang.String component8()

The optional displayed label of the intent.

component9

@Nullable
public java.lang.String component9()

The optional description of the intent.

component10

@Nullable
public java.lang.String component10()

The optional category of the intent.

component11

@NotNull
public org.litote.kmongo.Id<ai.tock.nlp.front.shared.config.IntentDefinition> component11()

The unique

Id of the intent.

copy

@NotNull
public IntentDefinition copy(@NotNull
                                      java.lang.String name,
                                      @NotNull
                                      java.lang.String namespace,
                                      @NotNull
                                      java.util.Set<? extends org.litote.kmongo.Id<ai.tock.nlp.front.shared.config.ApplicationDefinition>> applications,
                                      @NotNull
                                      java.util.Set<ai.tock.nlp.front.shared.config.EntityDefinition> entities,
                                      @NotNull
                                      java.util.Map<java.util.Locale,? extends java.util.LinkedHashSet<ai.tock.nlp.core.EntitiesRegexp>> entitiesRegexp,
                                      @NotNull
                                      java.util.Set<java.lang.String> mandatoryStates,
                                      @NotNull
                                      java.util.Set<? extends org.litote.kmongo.Id<ai.tock.nlp.front.shared.config.IntentDefinition>> sharedIntents,
                                      @Nullable
                                      java.lang.String label,
                                      @Nullable
                                      java.lang.String description,
                                      @Nullable
                                      java.lang.String category,
                                      @NotNull
                                      org.litote.kmongo.Id<ai.tock.nlp.front.shared.config.IntentDefinition> _id)

Definition of an intent.

toString

@NotNull
public java.lang.String toString()

hashCode

public int hashCode()

equals

public boolean equals(@Nullable
                      java.lang.Object p)