ai.api

Class AIConfiguration

java.lang.Object

ai.api.AIConfiguration

All Implemented Interfaces:

Cloneable

public class AIConfiguration
extends Object
implements Cloneable

AI service configuration

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	CONTEXTS_ENDPOINT
protected static String	CURRENT_PROTOCOL_VERSION
protected static String	QUESTION_ENDPOINT
protected static String	USER_ENTITIES_ENDPOINT

Constructor Summary

Constructors

Constructor and Description
AIConfiguration(String clientAccessToken) Create configuration with given client access token.
AIConfiguration(String clientAccessToken, AIConfiguration.SupportedLanguages language) Create configuration with given client access token and language.

Method Summary

Modifier and Type	Method and Description
AIConfiguration	clone() Clone the configuration
String	getApiAiLanguage() Get api.ai agent language
String	getApiKey() Get client access key
String	getLanguage() Get client agent language
String	getProtocolVersion() Check list of supported protocol versions on the api.ai website.
Proxy	getProxy() Get connection proxy information.
boolean	isWriteSoundLog() This flag is for testing purposes ONLY.
void	setProtocolVersion(String protocolVersion) Set protocol version for API queries.
void	setProxy(Proxy proxy) Set connection proxy information.
void	setServiceUrl(String serviceUrl) Set API service url.
void	setWriteSoundLog(boolean writeSoundLog) This flag is for testing purposes ONLY.

Methods inherited from class java.lang.Object

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

Field Detail

CURRENT_PROTOCOL_VERSION

protected static final String CURRENT_PROTOCOL_VERSION

See Also:

Constant Field Values

QUESTION_ENDPOINT

protected static final String QUESTION_ENDPOINT

See Also:

Constant Field Values

USER_ENTITIES_ENDPOINT

protected static final String USER_ENTITIES_ENDPOINT

See Also:

Constant Field Values

CONTEXTS_ENDPOINT

protected static final String CONTEXTS_ENDPOINT

See Also:

Constant Field Values

Constructor Detail

AIConfiguration

public AIConfiguration(String clientAccessToken,
                       AIConfiguration.SupportedLanguages language)

Create configuration with given client access token and language. See https://docs.api.ai/v20/docs/authentication for details

Parameters:

clientAccessToken - An agent unique key. Cannot be null

language - An agent language

AIConfiguration

public AIConfiguration(String clientAccessToken)

Create configuration with given client access token. See https://docs.api.ai/v20/docs/authentication for details

Parameters:

clientAccessToken - An agent unique key. Cannot be null

Method Detail

getApiKey

public String getApiKey()

Get client access key

getLanguage

public String getLanguage()

Get client agent language

Returns:

Never null

getApiAiLanguage

public String getApiAiLanguage()

Get api.ai agent language

Returns:

Never null

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 String getProtocolVersion()

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

Returns:

protocol version in YYYYMMDD format

setProtocolVersion

public void setProtocolVersion(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(String serviceUrl)

Set API service url. Used primarily for test requests.

getProxy

public Proxy getProxy()

Get connection proxy information. If null then direct connection would be used.

setProxy

public void setProxy(Proxy proxy)

Set connection proxy information.

Parameters:

proxy - If null then direct connection would be used.

clone

public AIConfiguration clone()

Clone the configuration

Overrides:

clone in class Object