ai.api

Class AIConfiguration

java.lang.Object

ai.api.AIConfiguration

public class AIConfiguration
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AIConfiguration.RecognitionEngine
static class	AIConfiguration.SupportedLanguages Currently supported languages

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	CURRENT_PROTOCOL_VERSION
protected static java.lang.String	QUESTION_ENDPOINT
protected static java.lang.String	USER_ENTITIES_ENDPOINT

Constructor Summary

Constructors

Constructor and Description
AIConfiguration(java.lang.String apiKey, java.lang.String subscriptionKey, AIConfiguration.SupportedLanguages language, AIConfiguration.RecognitionEngine recognitionEngine)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getApiKey()
java.lang.String	getLanguage()
java.lang.String	getProtocolVersion() Check list of supported protocol versions on the api.ai website.
java.lang.String	getQuestionUrl()
AIConfiguration.RecognitionEngine	getRecognitionEngine()
android.content.res.AssetFileDescriptor	getRecognizerCancelSound()
android.content.res.AssetFileDescriptor	getRecognizerStartSound()
android.content.res.AssetFileDescriptor	getRecognizerStopSound()
java.lang.String	getSubscriptionKey()
boolean	isVoiceActivityDetectionEnabled()
boolean	isWriteSoundLog() This flag is for testing purposes ONLY.
void	setProtocolVersion(java.lang.String protocolVersion) Set protocol version for API queries.
void	setRecognizerCancelSound(android.content.res.AssetFileDescriptor recognizerCancelSound)
void	setRecognizerStartSound(android.content.res.AssetFileDescriptor recognizerStartSound)
void	setRecognizerStopSound(android.content.res.AssetFileDescriptor recognizerStopSound)
void	setServiceUrl(java.lang.String serviceUrl) Set API service url.
void	setVoiceActivityDetectionEnabled(boolean voiceActivityDetectionEnabled) With setting this field to false you can disable voice activity detection for Speaktoit recognition.
void	setWriteSoundLog(boolean writeSoundLog) This flag is for testing purposes ONLY.

Methods inherited from class java.lang.Object

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

Field Detail

CURRENT_PROTOCOL_VERSION

protected static final java.lang.String CURRENT_PROTOCOL_VERSION

See Also:

Constant Field Values

QUESTION_ENDPOINT

protected static final java.lang.String QUESTION_ENDPOINT

See Also:

Constant Field Values

USER_ENTITIES_ENDPOINT

protected static final java.lang.String USER_ENTITIES_ENDPOINT

See Also:

Constant Field Values

Constructor Detail

AIConfiguration

public AIConfiguration(java.lang.String apiKey,
                       java.lang.String subscriptionKey,
                       AIConfiguration.SupportedLanguages language,
                       AIConfiguration.RecognitionEngine recognitionEngine)

Method Detail

getApiKey

public java.lang.String getApiKey()

getSubscriptionKey

public java.lang.String getSubscriptionKey()

getLanguage

public java.lang.String getLanguage()

getRecognitionEngine

public AIConfiguration.RecognitionEngine getRecognitionEngine()

isVoiceActivityDetectionEnabled

public boolean isVoiceActivityDetectionEnabled()

setVoiceActivityDetectionEnabled

public void setVoiceActivityDetectionEnabled(boolean voiceActivityDetectionEnabled)

With setting this field to false you can disable voice activity detection for Speaktoit recognition. This option does not affect System recognition.

Parameters:

voiceActivityDetectionEnabled -

setWriteSoundLog

public void setWriteSoundLog(boolean writeSoundLog)

This flag is for testing purposes ONLY. Don't change it.

Parameters:

writeSoundLog - value, indicating recorded sound will be saved in storage (if possible)

isWriteSoundLog

public boolean isWriteSoundLog()

This flag is for testing purposes ONLY. Don't use it in your code.

Returns:

value, indicating recorded sound will be saved in storage (if possible)

getProtocolVersion

public java.lang.String getProtocolVersion()

Check list of supported protocol versions on the api.ai website.

Returns:

protocol version in YYYYMMDD format

setProtocolVersion

public void setProtocolVersion(java.lang.String protocolVersion)

Set protocol version for API queries. Must be in YYYYMMDD format. This option for special cases only, should not be used in usual cases.

Parameters:

protocolVersion - Protocol version in YYYYMMDD format or empty string for the oldest version. Check list of supported protocol versions on the api.ai website.

setServiceUrl

public void setServiceUrl(java.lang.String serviceUrl)

Set API service url. Used primarily for test requests.

getQuestionUrl

public java.lang.String getQuestionUrl()

getRecognizerStartSound

public android.content.res.AssetFileDescriptor getRecognizerStartSound()

setRecognizerStartSound

public void setRecognizerStartSound(android.content.res.AssetFileDescriptor recognizerStartSound)

getRecognizerStopSound

public android.content.res.AssetFileDescriptor getRecognizerStopSound()

setRecognizerStopSound

public void setRecognizerStopSound(android.content.res.AssetFileDescriptor recognizerStopSound)

getRecognizerCancelSound

public android.content.res.AssetFileDescriptor getRecognizerCancelSound()

setRecognizerCancelSound

public void setRecognizerCancelSound(android.content.res.AssetFileDescriptor recognizerCancelSound)