ai.tock.bot.engine.dialog

Class DialogState

ai.tock.bot.engine.dialog.DialogState

public class DialogState

The class Dialog state.

See Also:

class Dialog

Field Detail

Companion

public static ai.tock.bot.engine.dialog.DialogState.Companion Companion

Constructor Detail

DialogState

public DialogState(@Nullable
                   Intent currentIntent,
                   @NotNull
                   java.util.Map<java.lang.String,ai.tock.bot.engine.dialog.EntityStateValue> entityValues,
                   @NotNull
                   java.util.Map<java.lang.String,java.lang.Object> context,
                   @Nullable
                   UserLocation userLocation,
                   @Nullable
                   NextUserActionState nextActionState)

The class Dialog state.

Parameters:

currentIntent - The current class Intent of the dialog, can be null.

entityValues - The current entity values (with their history).

context - The context of the dialog, a versatile map.

userLocation - The current class UserLocation if any.

nextActionState - The class NextUserActionState if any.If not null, it will be applied to the next user action, with NLP custom qualifiers.

See Also:

class Dialog

DialogState

public DialogState()

The class Dialog state.

See Also:

class Dialog

Method Detail

setContextValue

public void setContextValue(@NotNull
                            java.lang.String name,
                            @Nullable
                            java.lang.Object value)

Updates persistent context value. Do not store Collection or Map in the context, only plain objects or typed arrays.

setValue

public void setValue(@NotNull
                     java.lang.String role,
                     @NotNull
                     EntityValue value)

Set a new entity value. Remove previous entity values history.

setValue

public void setValue(@NotNull
                     ai.tock.nlp.api.client.model.Entity entity,
                     @NotNull
                     ai.tock.nlp.entity.Value value)

Set a new entity value. Remove previous entity values history.

changeValue

public void changeValue(@NotNull
                        ai.tock.nlp.api.client.model.Entity entity,
                        @Nullable
                        ai.tock.nlp.entity.Value newValue)

Change an entity value. Keep previous entity values history.

changeValue

public void changeValue(@NotNull
                        EntityValue newValue)

Change an entity value. Keep previous entity values history.

changeValue

public void changeValue(@NotNull
                        java.lang.String role,
                        @Nullable
                        EntityValue newValue)

Change an entity value. Keep previous entity values history.

resetAllEntityValues

public void resetAllEntityValues()

Reset all entity values. Keep entity values history.

resetValue

public void resetValue(@NotNull
                       java.lang.String role)

Reset the value of an entity. Keep entity values history.

cleanupState

public void cleanupState()

Same than resetState but remove also entity values history.

See Also:

resetState

resetState

public void resetState()

Reset all entity values, context values, userLocation and nextActionState but keep entity values history.

getCurrentIntent

@Nullable
public Intent getCurrentIntent()

The current

class Intent of the dialog, can be null.

See Also:

class Intent

setCurrentIntent

public void setCurrentIntent(@Nullable
                             Intent p)

The current

class Intent of the dialog, can be null.

Parameters:

p - The current class Intent of the dialog, can be null.

See Also:

class Intent

getEntityValues

@NotNull
public java.util.Map<java.lang.String,ai.tock.bot.engine.dialog.EntityStateValue> getEntityValues()

The current entity values

(with their history).

getContext

@NotNull
public java.util.Map<java.lang.String,java.lang.Object> getContext()

The context of the dialog,

a versatile map.

getUserLocation

@Nullable
public UserLocation getUserLocation()

The current

class UserLocation if any.

See Also:

class UserLocation

setUserLocation

public void setUserLocation(@Nullable
                            UserLocation p)

The current

class UserLocation if any.

Parameters:

p - The current class UserLocation if any.

See Also:

class UserLocation

getNextActionState

@Nullable
public NextUserActionState getNextActionState()

The

class NextUserActionState if any.If not null, it will be applied to the next user action, with NLP custom qualifiers.

See Also:

class NextUserActionState

setNextActionState

public void setNextActionState(@Nullable
                               NextUserActionState p)

The

class NextUserActionState if any.If not null, it will be applied to the next user action, with NLP custom qualifiers.

Parameters:

p - The class NextUserActionState if any.If not null, it will be applied to the next user action, with NLP custom qualifiers.

See Also:

class NextUserActionState

component1

@Nullable
public Intent component1()

The current

class Intent of the dialog, can be null.

See Also:

class Intent

component2

@NotNull
public java.util.Map<java.lang.String,ai.tock.bot.engine.dialog.EntityStateValue> component2()

The current entity values

(with their history).

component3

@NotNull
public java.util.Map<java.lang.String,java.lang.Object> component3()

The context of the dialog,

a versatile map.

component4

@Nullable
public UserLocation component4()

The current

class UserLocation if any.

See Also:

class UserLocation

component5

@Nullable
public NextUserActionState component5()

The

class NextUserActionState if any.If not null, it will be applied to the next user action, with NLP custom qualifiers.

See Also:

class NextUserActionState

copy

@NotNull
public DialogState copy(@Nullable
                                 Intent currentIntent,
                                 @NotNull
                                 java.util.Map<java.lang.String,ai.tock.bot.engine.dialog.EntityStateValue> entityValues,
                                 @NotNull
                                 java.util.Map<java.lang.String,java.lang.Object> context,
                                 @Nullable
                                 UserLocation userLocation,
                                 @Nullable
                                 NextUserActionState nextActionState)

The class Dialog state.

See Also:

class Dialog

toString

@NotNull
public java.lang.String toString()

The class Dialog state.

See Also:

class Dialog

hashCode

public int hashCode()

The class Dialog state.

See Also:

class Dialog

equals

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

The class Dialog state.

See Also:

class Dialog