ai.api.android

Class AIService

java.lang.Object

ai.api.android.AIService

Direct Known Subclasses:

GoogleRecognitionServiceImpl, SpeaktoitRecognitionServiceImpl

public abstract class AIService
extends java.lang.Object

Main SDK class for working with API.AI service.

Field Summary

Fields

Modifier and Type	Field and Description
protected AIDataService	aiDataService
protected AIConfiguration	config
protected android.content.Context	context

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AIService(AIConfiguration config, android.content.Context context)

Method Summary

Modifier and Type	Method and Description
abstract void	cancel() Cancel listening process and don't request to AI service
protected boolean	checkPermissions()
static AIService	getService(android.content.Context context, AIConfiguration config) Use this method to get ready to work instance
protected void	onAudioLevelChanged(float audioLevel)
protected void	onError(ai.api.model.AIError error)
protected void	onListeningCancelled()
protected void	onListeningFinished()
protected void	onListeningStarted()
protected void	onResult(ai.api.model.AIResponse response)
void	pause()
boolean	resetContexts() Forget all old contexts
void	resume()
void	setListener(AIListener listener) Sets listener, which used to notify about process steps
abstract void	startListening() Starts listening process
abstract void	startListening(java.util.List<ai.api.model.AIContext> contexts) Starts listening process.
abstract void	startListening(ai.api.RequestExtras requestExtras) Starts listening process.
abstract void	stopListening() Stop listening and start request to the AI service with current recognition results
ai.api.model.AIResponse	textRequest(ai.api.model.AIRequest request)
ai.api.model.AIResponse	textRequest(java.lang.String textRequest, ai.api.RequestExtras requestExtras)
ai.api.model.AIResponse	uploadUserEntities(java.util.Collection<ai.api.model.Entity> userEntities) Upload user entities for using while session
ai.api.model.AIResponse	uploadUserEntity(ai.api.model.Entity userEntity) Upload user entity for using while session

Methods inherited from class java.lang.Object

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

Field Detail

config

protected final AIConfiguration config

context

protected final android.content.Context context

aiDataService

protected final AIDataService aiDataService

Constructor Detail

AIService

protected AIService(AIConfiguration config,
                    android.content.Context context)

Method Detail

getService

public static AIService getService(android.content.Context context,
                                   AIConfiguration config)

Use this method to get ready to work instance

Parameters:

context -

config -

Returns:

instance of AIService implementation

startListening

public abstract void startListening()

Starts listening process

startListening

public abstract void startListening(java.util.List<ai.api.model.AIContext> contexts)

Starts listening process. Request to the AI service will be done with specified contexts.

startListening

public abstract void startListening(ai.api.RequestExtras requestExtras)

Starts listening process. Request to the AI service will be done with specified extra data.

Parameters:

requestExtras - extras can hold additional contexts and entities

stopListening

public abstract void stopListening()

Stop listening and start request to the AI service with current recognition results

cancel

public abstract void cancel()

Cancel listening process and don't request to AI service

setListener

public void setListener(AIListener listener)

Sets listener, which used to notify about process steps

Parameters:

listener - AIListener implementation

onResult

protected void onResult(ai.api.model.AIResponse response)

onError

protected void onError(ai.api.model.AIError error)

onAudioLevelChanged

protected void onAudioLevelChanged(float audioLevel)

onListeningStarted

protected void onListeningStarted()

onListeningCancelled

protected void onListeningCancelled()

onListeningFinished

protected void onListeningFinished()

pause

public void pause()

resume

public void resume()

textRequest

public ai.api.model.AIResponse textRequest(ai.api.model.AIRequest request)
                                    throws ai.api.AIServiceException

Throws:

ai.api.AIServiceException

textRequest

public ai.api.model.AIResponse textRequest(java.lang.String textRequest,
                                           ai.api.RequestExtras requestExtras)
                                    throws ai.api.AIServiceException

Throws:

ai.api.AIServiceException

resetContexts

public boolean resetContexts()

Forget all old contexts

Returns:

true if operation succeed, false otherwise

uploadUserEntity

public ai.api.model.AIResponse uploadUserEntity(ai.api.model.Entity userEntity)
                                         throws ai.api.AIServiceException

Upload user entity for using while session

Parameters:

userEntity - entity to upload

Returns:

uploading result

Throws:

ai.api.AIServiceException

uploadUserEntities

public ai.api.model.AIResponse uploadUserEntities(java.util.Collection<ai.api.model.Entity> userEntities)
                                           throws ai.api.AIServiceException

Upload user entities for using while session

Parameters:

userEntities - collection of user entities

Returns:

uploading result

Throws:

ai.api.AIServiceException - if request to the API.AI service failed

checkPermissions

protected boolean checkPermissions()