com.amazonaws.mobileconnectors.lex.interactionkit.config

Class InteractionConfig

java.lang.Object

com.amazonaws.mobileconnectors.lex.interactionkit.config.InteractionConfig

public class InteractionConfig
extends java.lang.Object

Contains configuration for SDK's interaction with the users.

Field Summary

Fields

Modifier and Type	Field and Description
static AudioEncoding	DEFAULT_AUDIO_ENCODING
static int	DEFAULT_END_POINTING_THRESHOLD
static float	DEFAULT_LRT_THRESHOLD
static int	DEFAULT_MAX_SPEECH_TIMEOUT_INTERVAL
static int	DEFAULT_NO_SPEECH_TIMEOUT_INTERVAL
static int	DEFAULT_START_POINTING_THRESHOLD

Constructor Summary

Constructors

Constructor and Description
InteractionConfig(java.lang.String botName, java.lang.String botAlias) Creates a new instance of this object, with no global attributes.
InteractionConfig(java.lang.String botName, java.lang.String botAlias, java.lang.String userId) Creates a new instance of this object, with no global attributes.
InteractionConfig(java.lang.String botName, java.lang.String botAlias, java.lang.String userId, java.util.Map<java.lang.String,java.lang.String> globalSessionAttributes) Creates a new instance of this object, with global attributes.

Method Summary

Modifier and Type	Method and Description
AudioEncoding	getAudioEncoding() Returns current audio encoding, if no encoding is set returns default encoding.
java.lang.String	getBotAlias() Returns bot alias.
java.lang.String	getBotName() Returns bot name.
int	getEndPointingThreshold() Get current end point threshold.
java.util.Map<java.lang.String,java.lang.String>	getGlobalSessionAttributes() Get the global SessionAtributes
float	getLrtThreshold() Returns the likely hood ration threshold
int	getMaxSpeechTimeoutInterval() Returns maximum interval for speech.
int	getNoSpeechTimeoutInterval() Returns current no speech time-out value.
int	getStartPointingThreshold() Get current star point threshold.
java.lang.String	getUserId() Get the user id
boolean	isEnableAudioPlayback() Returns current audio playback setting.
void	setAudioEncoding(AudioEncoding audioEncoding) Set audio encoding.
void	setBotAlias(java.lang.String botAlias) Sets bot alias.
void	setBotName(java.lang.String botName) Sets bot name.
void	setEnableAudioPlayback(boolean enableAudioPlayback) Set this to true if the audio response from Amazon Lex service should be played back by the SDK.
void	setEndPointingThreshold(int endPointingThreshold) Set endpoint threshold.
void	setGlobalSessionAttributes(java.util.Map<java.lang.String,java.lang.String> globalSessionAttributes) Set the global SessionAtributes
void	setLrtThreshold(float lrtThreshold) Sets the Likely hood ration threshold for the VAD
void	setMaxSpeechTimeoutInterval(int maxSpeechTimeoutInterval) Set maximum interval for speech.
void	setNoSpeechTimeoutInterval(int noSpeechTimeoutInterval) Set no speech time out interval.
void	setStartPointingThreshold(int startPointingThreshold) Set start point threshold.
void	setUserId(java.lang.String userId) Sets the user id
InteractionConfig	withAudioEncoding(AudioEncoding audioEncoding) Set audio encoding.
InteractionConfig	WithEnableAudioPlayback(boolean enableAudioPlayback) Set this to true if the audio response from Amazon Lex service should be played back by the SDK.
InteractionConfig	withEndPointingThreshold(int endPointingThreshold) Set endpoint threshold.
InteractionConfig	withGlobalSessionAttributes(java.util.Map<java.lang.String,java.lang.String> globalSessionAttributes) Set the global SessionAtributes
InteractionConfig	withLrtThreshold(float lrtThreshold) Sets the Likely hood ration threshold for the VAD
InteractionConfig	withMaxSpeechTimeoutInterval(int maxSpeechTimeoutInterval) Set maximum interval for speech.
InteractionConfig	withNoSpeechTimeoutInterval(int noSpeechTimeoutInterval) Set no speech time out interval.
InteractionConfig	withStartPointingThreshold(int startPointingThreshold) Set start point threshold.
InteractionConfig	withUserId(java.lang.String userId) Sets the user id

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_NO_SPEECH_TIMEOUT_INTERVAL

public static final int DEFAULT_NO_SPEECH_TIMEOUT_INTERVAL

See Also:

Constant Field Values

DEFAULT_MAX_SPEECH_TIMEOUT_INTERVAL

public static final int DEFAULT_MAX_SPEECH_TIMEOUT_INTERVAL

See Also:

Constant Field Values

DEFAULT_START_POINTING_THRESHOLD

public static final int DEFAULT_START_POINTING_THRESHOLD

See Also:

Constant Field Values

DEFAULT_END_POINTING_THRESHOLD

public static final int DEFAULT_END_POINTING_THRESHOLD

See Also:

Constant Field Values

DEFAULT_LRT_THRESHOLD

public static final float DEFAULT_LRT_THRESHOLD

See Also:

Constant Field Values

DEFAULT_AUDIO_ENCODING

public static final AudioEncoding DEFAULT_AUDIO_ENCODING

Constructor Detail

InteractionConfig

public InteractionConfig(java.lang.String botName,
                         java.lang.String botAlias,
                         java.lang.String userId)

Creates a new instance of this object, with no global attributes.

Parameters:

botName - Name of the bot, should match a bot in set in the service.

botAlias - Bot alias.

InteractionConfig

public InteractionConfig(java.lang.String botName,
                         java.lang.String botAlias)

Creates a new instance of this object, with no global attributes.

Parameters:

botName - Name of the bot, should match a bot in set in the service.

botAlias - Bot alias.

InteractionConfig

public InteractionConfig(java.lang.String botName,
                         java.lang.String botAlias,
                         java.lang.String userId,
                         java.util.Map<java.lang.String,java.lang.String> globalSessionAttributes)

Creates a new instance of this object, with global attributes.

Parameters:

botName - Name of the bot, should match a bot in set in the service.

botAlias - Bot alias.

globalSessionAttributes - Map.

Method Detail

getBotName

public java.lang.String getBotName()

Returns bot name.

Returns:

bot name as a String.

setBotName

public void setBotName(java.lang.String botName)

Sets bot name.

Parameters:

botName - Bot name as a String.

getBotAlias

public java.lang.String getBotAlias()

Returns bot alias.

Returns:

bot alias as a String.

setBotAlias

public void setBotAlias(java.lang.String botAlias)

Sets bot alias.

Parameters:

botAlias - Bots alias as a String.

getAudioEncoding

public AudioEncoding getAudioEncoding()

Returns current audio encoding, if no encoding is set returns default encoding.

Returns:

AudioEncoding

withAudioEncoding

public InteractionConfig withAudioEncoding(AudioEncoding audioEncoding)

Set audio encoding.

Parameters:

audioEncoding - AudioEncoding, encoding used for audio streamed to the service.

Returns:

InteractionConfig

setAudioEncoding

public void setAudioEncoding(AudioEncoding audioEncoding)

Set audio encoding.

Parameters:

audioEncoding - AudioEncoding, encoding used for audio streamed to the service.

isEnableAudioPlayback

public boolean isEnableAudioPlayback()

Returns current audio playback setting.

Returns:

true if the audio playback from the SDK has been enabled.

setEnableAudioPlayback

public void setEnableAudioPlayback(boolean enableAudioPlayback)

Set this to true if the audio response from Amazon Lex service should be played back by the SDK.

Parameters:

enableAudioPlayback - boolean

WithEnableAudioPlayback

public InteractionConfig WithEnableAudioPlayback(boolean enableAudioPlayback)

Set this to true if the audio response from Amazon Lex service should be played back by the SDK.

Parameters:

enableAudioPlayback - boolean

Returns:

InteractionConfig

setNoSpeechTimeoutInterval

public void setNoSpeechTimeoutInterval(int noSpeechTimeoutInterval)

Set no speech time out interval.

Parameters:

noSpeechTimeoutInterval - time out interval in milli-seconds.

withNoSpeechTimeoutInterval

public InteractionConfig withNoSpeechTimeoutInterval(int noSpeechTimeoutInterval)

Set no speech time out interval.

Parameters:

noSpeechTimeoutInterval - time out interval in milli-seconds.

Returns:

InteractionConfig

getNoSpeechTimeoutInterval

public int getNoSpeechTimeoutInterval()

Returns current no speech time-out value.

Returns:

setMaxSpeechTimeoutInterval

public void setMaxSpeechTimeoutInterval(int maxSpeechTimeoutInterval)

Set maximum interval for speech.

Parameters:

maxSpeechTimeoutInterval - maximum speech time out interval in milli-seconds.

withMaxSpeechTimeoutInterval

public InteractionConfig withMaxSpeechTimeoutInterval(int maxSpeechTimeoutInterval)

Set maximum interval for speech.

Parameters:

maxSpeechTimeoutInterval - maximum speech time out interval in milli-seconds.

Returns:

InteractionConfig

getMaxSpeechTimeoutInterval

public int getMaxSpeechTimeoutInterval()

Returns maximum interval for speech.

Returns:

setStartPointingThreshold

public void setStartPointingThreshold(int startPointingThreshold)

Set start point threshold.

Parameters:

startPointingThreshold -

withStartPointingThreshold

public InteractionConfig withStartPointingThreshold(int startPointingThreshold)

Set start point threshold.

Parameters:

startPointingThreshold -

Returns:

InteractionConfig

getStartPointingThreshold

public int getStartPointingThreshold()

Get current star point threshold.

Returns:

setEndPointingThreshold

public void setEndPointingThreshold(int endPointingThreshold)

Set endpoint threshold.

Parameters:

endPointingThreshold -

withEndPointingThreshold

public InteractionConfig withEndPointingThreshold(int endPointingThreshold)

Set endpoint threshold.

Parameters:

endPointingThreshold -

Returns:

InteractionConfig

getEndPointingThreshold

public int getEndPointingThreshold()

Get current end point threshold.

Returns:

the end pointing threshold.

getGlobalSessionAttributes

public java.util.Map<java.lang.String,java.lang.String> getGlobalSessionAttributes()

Get the global SessionAtributes

Returns:

the global session attributes

setGlobalSessionAttributes

public void setGlobalSessionAttributes(java.util.Map<java.lang.String,java.lang.String> globalSessionAttributes)

Set the global SessionAtributes

Parameters:

globalSessionAttributes - the global session attributes.

withGlobalSessionAttributes

public InteractionConfig withGlobalSessionAttributes(java.util.Map<java.lang.String,java.lang.String> globalSessionAttributes)

Set the global SessionAtributes

Parameters:

globalSessionAttributes - the global session attributes.

Returns:

InteractionConfig

getUserId

public java.lang.String getUserId()

Get the user id

Returns:

the userid

setUserId

public void setUserId(java.lang.String userId)

Sets the user id

Parameters:

userId -

withUserId

public InteractionConfig withUserId(java.lang.String userId)

Sets the user id

Parameters:

userId -

Returns:

InteractionConfig

getLrtThreshold

public float getLrtThreshold()

Returns the likely hood ration threshold

Returns:

setLrtThreshold

public void setLrtThreshold(float lrtThreshold)

Sets the Likely hood ration threshold for the VAD

Parameters:

lrtThreshold -

withLrtThreshold

public InteractionConfig withLrtThreshold(float lrtThreshold)

Sets the Likely hood ration threshold for the VAD

Parameters:

lrtThreshold -