com.hound.core.model.sdk

Class HoundRequestInfo

java.lang.Object

com.hound.core.model.sdk.HoundRequestInfo

public class HoundRequestInfo
extends java.lang.Object

The request info to be sent on a voice search.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,JsonNode>	extraFields

Constructor Summary

Constructors

Constructor and Description
HoundRequestInfo()

Method Summary

Methods

Modifier and Type	Method and Description
int	getActionTimerSec()
java.lang.String	getAdId()
java.lang.String	getAppId()
java.lang.String	getCity()
java.util.Map<java.lang.String,java.lang.String>	getClientExtras()
java.util.List<ClientMatch>	getClientMatches()
ClientState	getClientState()
java.lang.String	getClientVersion()
int	getClientVersionCode()
JsonNode	getConversationState()
java.lang.String	getCountry()
int	getDeviceApiVersion()
java.lang.String	getDeviceId()
java.lang.String	getDeviceName()
java.lang.String	getDeviceOSVersion()
java.lang.String	getDeviceUnitPreference()
java.util.Map<java.lang.String,JsonNode>	getExtraFields() Retrieves map of extra fields added to HoundRequestInfo
java.lang.String	getFirstPersonSelf()
java.lang.String	getFirstPersonSelfSpoken()
java.lang.String	getInstallationId()
java.lang.String	getLanguage()
java.lang.Double	getLatitude()
java.lang.Double	getLongitude()
java.lang.Integer	getMaxResults()
java.lang.Integer	getMinResults()
java.lang.String	getNetworkType()
java.lang.String	getPhoneType()
java.lang.Double	getPositionHorizontalAccuracy()
java.lang.Long	getPreferredCalendarId()
java.lang.String	getPreferredCalendarName()
java.lang.String	getRequestId()
java.lang.String	getSearchEnginePreference()
java.util.List<java.lang.String>	getSecondPersonSelf()
java.util.List<java.lang.String>	getSecondPersonSelfSpoken()
JsonNode	getSendBack()
java.lang.String	getSessionId()
java.lang.String	getState()
java.lang.String	getStreet()
long	getTimeStamp()
java.lang.String	getTimeZone()
java.lang.String	getUserId()
java.lang.String	getWakeUpPattern() Returns the Terrier expression used to indicate the Houndify wakeup phrase being used by the client.
boolean	isAutoSync()
boolean	isCalendarIsSet()
boolean	isCharging()
boolean	isClientMatchesOnly()
boolean	isControllableTrackPlaying()
boolean	isDevMode()
boolean	isLocationPreferenceOn()
boolean	isUseContactData()
void	setActionTimerSec(int actionTimerSec)
void	setAdId(java.lang.String adId)
void	setAppId(java.lang.String appId)
void	setAutoSync(boolean autoSync)
void	setCalendarIsSet(boolean calendarIsSet)
void	setCharging(boolean charging)
void	setCity(java.lang.String city)
void	setClientExtras(java.util.Map<java.lang.String,java.lang.String> clientExtras)
void	setClientMatches(java.util.List<ClientMatch> clientMatches)
void	setClientMatchesOnly(boolean clientMatchesOnly)
void	setClientState(ClientState clientState)
void	setClientVersion(java.lang.String clientVersion)
void	setClientVersionCode(int clientVersionCode)
void	setControllableTrackPlaying(boolean controllableTrackPlaying)
void	setConversationState(JsonNode conversationState)
void	setCountry(java.lang.String country)
void	setDeviceApiVersion(int deviceApiVersion)
void	setDeviceId(java.lang.String deviceId)
void	setDeviceName(java.lang.String deviceName)
void	setDeviceOSVersion(java.lang.String deviceOSVersion)
void	setDeviceUnitPreference(java.lang.String deviceUnitPreference)
void	setDevMode(boolean devMode)
void	setExtraField(java.lang.String name, JsonNode value) Allows client to pass an additional fields needed in the HoundRequestInfo.
void	setExtraField(java.lang.String name, java.lang.String value) Allows client to pass an additional fields needed in the HoundRequestInfo.
void	setFirstPersonSelf(java.lang.String firstPersonSelf)
void	setFirstPersonSelfSpoken(java.lang.String firstPersonSelfSpoken)
void	setInstallationId(java.lang.String installationId)
void	setLanguage(java.lang.String language)
void	setLatitude(java.lang.Double latitude)
void	setLocationPreferenceOn(boolean locationPreferenceOn)
void	setLongitude(java.lang.Double longitude)
void	setMaxResults(java.lang.Integer maxResults)
void	setMaxSilenceAfterFullQuerySeconds(float maxSilenceAfterFullQuerySeconds) VoiceActivityDetection.MaxSilenceAfterFullQuerySeconds - Is used to configure server side VAD configuration settings for a particular voice search.
void	setMaxSilenceAfterPartialQuerySeconds(float maxSilenceAfterPartialQuerySeconds) VoiceActivityDetection.MaxSilenceAfterPartialQuerySeconds - Is used to configure server side VAD configuration settings for a particular voice search.
void	setMaxSilenceSeconds(float maxSilenceSeconds) VoiceActivityDetection.MaxSilenceSeconds - Is used to configure server side VAD configuration settings for a particular voice search.
void	setMinResults(java.lang.Integer minResults) This should really be set desired number or target number.
void	setNetworkType(java.lang.String networkType)
void	setPhoneType(java.lang.String phoneType)
void	setPositionHorizontalAccuracy(java.lang.Double positionHorizontalAccuracy)
void	setPreferredCalendarId(java.lang.Long preferredCalendarId)
void	setPreferredCalendarName(java.lang.String preferredCalendarName)
void	setRequestId(java.lang.String requestId)
void	setSearchEnginePreference(java.lang.String searchEnginePreference)
void	setSecondPersonSelf(java.util.List<java.lang.String> secondPersonSelf)
void	setSecondPersonSelfSpoken(java.util.List<java.lang.String> secondPersonSelfSpoken)
void	setSendBack(JsonNode sendBack)
void	setSessionId(java.lang.String sessionId)
void	setState(java.lang.String state)
void	setStreet(java.lang.String street)
void	setTimeStamp(long timeStamp)
void	setTimeZone(java.lang.String timeZone)
void	setUseContactData(boolean useContactData)
void	setUserId(java.lang.String userId)
void	setWakeUpPattern(java.lang.String wakeUpPattern) Used to set a Terrier expression for indicating to the Houndify server which wakeup phrase is being used by the client to activate a Hound search.

Methods inherited from class java.lang.Object

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

Field Detail

extraFields

protected java.util.Map<java.lang.String,JsonNode> extraFields

Constructor Detail

HoundRequestInfo

public HoundRequestInfo()

Method Detail

setMaxSilenceSeconds

public void setMaxSilenceSeconds(float maxSilenceSeconds)

VoiceActivityDetection.MaxSilenceSeconds - Is used to configure server side VAD configuration settings for a particular voice search. In general, it is recommended to use the default server values. This value should only be changed for special use cases where the client wants to allow longer pauses in the users voice query. Also see settings in the VoiceSearch for configuring client side VAD options - Builder.setClientVADSilenceDurationTrigger() and Builder.setServerVadWindow().

Parameters:

maxSilenceSeconds - If the server detects this many seconds of continuous silence, it will consider voice activity to be finished.

See Also:

VoiceActivityDetection *

setMaxSilenceAfterFullQuerySeconds

public void setMaxSilenceAfterFullQuerySeconds(float maxSilenceAfterFullQuerySeconds)

VoiceActivityDetection.MaxSilenceAfterFullQuerySeconds - Is used to configure server side VAD configuration settings for a particular voice search. In general, it is recommended to use the default server values. This value should only be changed for special use cases where the client wants to allow longer pauses in the users voice query. Also see settings in the VoiceSearch for configuring client side VAD options - Builder.setClientVADSilenceDurationTrigger() and Builder.setServerVadWindow().

Parameters:

maxSilenceAfterFullQuerySeconds - If the server detects this many seconds of silence after detecting a meaningful query, it will consider voice activity to be finished.

See Also:

VoiceActivityDetection

setMaxSilenceAfterPartialQuerySeconds

public void setMaxSilenceAfterPartialQuerySeconds(float maxSilenceAfterPartialQuerySeconds)

VoiceActivityDetection.MaxSilenceAfterPartialQuerySeconds - Is used to configure server side VAD configuration settings for a particular voice search. In general, it is recommended to use the default server values. This value should only be changed for special use cases where the client wants to allow longer pauses in the users voice query. Also see settings in the VoiceSearch for configuring client side VAD options - Builder.setClientVADSilenceDurationTrigger() and Builder.setServerVadWindow().

Parameters:

maxSilenceAfterPartialQuerySeconds - If the server detects this many seconds of silence after detecting part of a query, it will consider voice activity to be finished.

See Also:

VoiceActivityDetection

getWakeUpPattern

public java.lang.String getWakeUpPattern()

Returns the Terrier expression used to indicate the Houndify wakeup phrase being used by the client. This allows the server to ignore it if it makes it inside the request phrase.

Returns:

setWakeUpPattern

public void setWakeUpPattern(java.lang.String wakeUpPattern)

Used to set a Terrier expression for indicating to the Houndify server which wakeup phrase is being used by the client to activate a Hound search. This allows the server to ignore it if received inside the request phrase. By default the "OK Hound" phrase is passed. The client should override this if a different phrase is being used.

Parameters:

wakeUpPattern -

getDeviceOSVersion

public java.lang.String getDeviceOSVersion()

setDeviceOSVersion

public void setDeviceOSVersion(java.lang.String deviceOSVersion)

getDeviceApiVersion

public int getDeviceApiVersion()

setDeviceApiVersion

public void setDeviceApiVersion(int deviceApiVersion)

getDeviceName

public java.lang.String getDeviceName()

setDeviceName

public void setDeviceName(java.lang.String deviceName)

getUserId

public java.lang.String getUserId()

setUserId

public void setUserId(java.lang.String userId)

getAppId

public java.lang.String getAppId()

setAppId

public void setAppId(java.lang.String appId)

getRequestId

public java.lang.String getRequestId()

setRequestId

public void setRequestId(java.lang.String requestId)

getSessionId

public java.lang.String getSessionId()

setSessionId

public void setSessionId(java.lang.String sessionId)

getAdId

public java.lang.String getAdId()

setAdId

public void setAdId(java.lang.String adId)

getDeviceId

public java.lang.String getDeviceId()

setDeviceId

public void setDeviceId(java.lang.String deviceId)

getInstallationId

public java.lang.String getInstallationId()

setInstallationId

public void setInstallationId(java.lang.String installationId)

getClientVersion

public java.lang.String getClientVersion()

setClientVersion

public void setClientVersion(java.lang.String clientVersion)

getClientVersionCode

public int getClientVersionCode()

setClientVersionCode

public void setClientVersionCode(int clientVersionCode)

getPhoneType

public java.lang.String getPhoneType()

setPhoneType

public void setPhoneType(java.lang.String phoneType)

getNetworkType

public java.lang.String getNetworkType()

setNetworkType

public void setNetworkType(java.lang.String networkType)

getLanguage

public java.lang.String getLanguage()

setLanguage

public void setLanguage(java.lang.String language)

getConversationState

public JsonNode getConversationState()

setConversationState

public void setConversationState(JsonNode conversationState)

getClientState

public ClientState getClientState()

setClientState

public void setClientState(ClientState clientState)

getDeviceUnitPreference

public java.lang.String getDeviceUnitPreference()

setDeviceUnitPreference

public void setDeviceUnitPreference(java.lang.String deviceUnitPreference)

getActionTimerSec

public int getActionTimerSec()

setActionTimerSec

public void setActionTimerSec(int actionTimerSec)

isAutoSync

public boolean isAutoSync()

setAutoSync

public void setAutoSync(boolean autoSync)

getSearchEnginePreference

public java.lang.String getSearchEnginePreference()

setSearchEnginePreference

public void setSearchEnginePreference(java.lang.String searchEnginePreference)

isLocationPreferenceOn

public boolean isLocationPreferenceOn()

setLocationPreferenceOn

public void setLocationPreferenceOn(boolean locationPreferenceOn)

isUseContactData

public boolean isUseContactData()

setUseContactData

public void setUseContactData(boolean useContactData)

getMaxResults

public java.lang.Integer getMaxResults()

setMaxResults

public void setMaxResults(java.lang.Integer maxResults)

getMinResults

public java.lang.Integer getMinResults()

setMinResults

public void setMinResults(java.lang.Integer minResults)

This should really be set desired number or target number. Setting this doesn't guarantee you actually get this many results back.

Parameters:

minResults -

getLatitude

public java.lang.Double getLatitude()

setLatitude

public void setLatitude(java.lang.Double latitude)

getLongitude

public java.lang.Double getLongitude()

setLongitude

public void setLongitude(java.lang.Double longitude)

getPositionHorizontalAccuracy

public java.lang.Double getPositionHorizontalAccuracy()

setPositionHorizontalAccuracy

public void setPositionHorizontalAccuracy(java.lang.Double positionHorizontalAccuracy)

getStreet

public java.lang.String getStreet()

setStreet

public void setStreet(java.lang.String street)

getState

public java.lang.String getState()

setState

public void setState(java.lang.String state)

getCity

public java.lang.String getCity()

setCity

public void setCity(java.lang.String city)

getCountry

public java.lang.String getCountry()

setCountry

public void setCountry(java.lang.String country)

getTimeStamp

public long getTimeStamp()

setTimeStamp

public void setTimeStamp(long timeStamp)

getTimeZone

public java.lang.String getTimeZone()

setTimeZone

public void setTimeZone(java.lang.String timeZone)

isDevMode

public boolean isDevMode()

setDevMode

public void setDevMode(boolean devMode)

getClientExtras

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

setClientExtras

public void setClientExtras(java.util.Map<java.lang.String,java.lang.String> clientExtras)

isCalendarIsSet

public boolean isCalendarIsSet()

setCalendarIsSet

public void setCalendarIsSet(boolean calendarIsSet)

getPreferredCalendarName

public java.lang.String getPreferredCalendarName()

setPreferredCalendarName

public void setPreferredCalendarName(java.lang.String preferredCalendarName)

getPreferredCalendarId

public java.lang.Long getPreferredCalendarId()

setPreferredCalendarId

public void setPreferredCalendarId(java.lang.Long preferredCalendarId)

isCharging

public boolean isCharging()

setCharging

public void setCharging(boolean charging)

getFirstPersonSelf

public java.lang.String getFirstPersonSelf()

setFirstPersonSelf

public void setFirstPersonSelf(java.lang.String firstPersonSelf)

getFirstPersonSelfSpoken

public java.lang.String getFirstPersonSelfSpoken()

setFirstPersonSelfSpoken

public void setFirstPersonSelfSpoken(java.lang.String firstPersonSelfSpoken)

getSecondPersonSelfSpoken

public java.util.List<java.lang.String> getSecondPersonSelfSpoken()

setSecondPersonSelfSpoken

public void setSecondPersonSelfSpoken(java.util.List<java.lang.String> secondPersonSelfSpoken)

getSecondPersonSelf

public java.util.List<java.lang.String> getSecondPersonSelf()

setSecondPersonSelf

public void setSecondPersonSelf(java.util.List<java.lang.String> secondPersonSelf)

getClientMatches

public java.util.List<ClientMatch> getClientMatches()

setClientMatches

public void setClientMatches(java.util.List<ClientMatch> clientMatches)

isClientMatchesOnly

public boolean isClientMatchesOnly()

setClientMatchesOnly

public void setClientMatchesOnly(boolean clientMatchesOnly)

isControllableTrackPlaying

public boolean isControllableTrackPlaying()

setControllableTrackPlaying

public void setControllableTrackPlaying(boolean controllableTrackPlaying)

getSendBack

public JsonNode getSendBack()

setSendBack

public void setSendBack(JsonNode sendBack)

getExtraFields

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

Retrieves map of extra fields added to HoundRequestInfo

Returns:

setExtraField

public void setExtraField(java.lang.String name,
                 java.lang.String value)

Allows client to pass an additional fields needed in the HoundRequestInfo.

Parameters:

name - of field

value - string to be stored.

setExtraField

public void setExtraField(java.lang.String name,
                 JsonNode value)

Allows client to pass an additional fields needed in the HoundRequestInfo.

Parameters:

name - of field

value - JsonNode object.