ai.api

Class AIDataService

java.lang.Object

ai.api.AIDataService

public class AIDataService
extends Object

Do simple requests to the AI Service

Constructor Summary

Constructors

Constructor and Description
AIDataService(AIConfiguration config) Create new service with unique context for given configuration
AIDataService(AIConfiguration config, AIServiceContext serviceContext) Create new service for given configuration and some predefined service context

Method Summary

Modifier and Type	Method and Description
protected String	doSoundRequest(InputStream voiceStream, String queryData) Method extracted for testing purposes
protected String	doSoundRequest(InputStream voiceStream, String queryData, Map<String,String> additionalHeaders) Method extracted for testing purposes
protected String	doTextRequest(String requestJson)
protected String	doTextRequest(String endpoint, String requestJson)
protected String	doTextRequest(String endpoint, String requestJson, Map<String,String> additionalHeaders)
AIServiceContext	getContext()
AIResponse	request(AIRequest request) Make request to the ai service.
AIResponse	request(AIRequest request, RequestExtras requestExtras) Make request to the ai service.
boolean	resetContexts() Forget all old contexts
AIResponse	uploadUserEntities(Collection<Entity> userEntities)
AIResponse	uploadUserEntity(Entity userEntity)
AIResponse	voiceRequest(InputStream voiceStream) Make requests to the ai service with voice data.
AIResponse	voiceRequest(InputStream voiceStream, List<AIContext> aiContexts) Make requests to the ai service with voice data.
AIResponse	voiceRequest(InputStream voiceStream, RequestExtras requestExtras) Make requests to the ai service with voice data.

Methods inherited from class java.lang.Object

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

Constructor Detail

AIDataService

public AIDataService(AIConfiguration config,
                     AIServiceContext serviceContext)

Create new service for given configuration and some predefined service context

Parameters:

config - Service configuration data. Cannot be null

serviceContext - Service context. If null then new context will be created

Throws:

IllegalArgumentException - If config parameter is null

AIDataService

public AIDataService(AIConfiguration config)

Create new service with unique context for given configuration

Parameters:

config - Service configuration data. Cannot be null

Throws:

IllegalArgumentException - If config parameter is null

Method Detail

getContext

public AIServiceContext getContext()

Returns:

Current context used in each request. Never null

request

public AIResponse request(AIRequest request)
                   throws AIServiceException

Make request to the ai service.

Parameters:

request - request object to the service. Cannot be null

Returns:

response object from service. Never null

Throws:

AIServiceException

request

public AIResponse request(AIRequest request,
                          RequestExtras requestExtras)
                   throws AIServiceException

Make request to the ai service.

Parameters:

request - request object to the service. Cannot be null

Returns:

response object from service. Never null

Throws:

AIServiceException

voiceRequest

public AIResponse voiceRequest(InputStream voiceStream)
                        throws AIServiceException

Make requests to the ai service with voice data. This method must not be called in the UI Thread.

Parameters:

voiceStream - voice data stream for recognition. Cannot be null

Returns:

response object from service. Never null

Throws:

AIServiceException

voiceRequest

public AIResponse voiceRequest(InputStream voiceStream,
                               List<AIContext> aiContexts)
                        throws AIServiceException

Make requests to the ai service with voice data. This method must not be called in the UI Thread.

Parameters:

voiceStream - voice data stream for recognition. Cannot be null

aiContexts - additional contexts for request

Returns:

response object from service. Never null

Throws:

AIServiceException

voiceRequest

public AIResponse voiceRequest(InputStream voiceStream,
                               RequestExtras requestExtras)
                        throws AIServiceException

Make requests to the ai service with voice data. This method must not be called in the UI Thread.

Parameters:

voiceStream - voice data stream for recognition. Cannot be null

requestExtras - object that can hold additional contexts and entities

Returns:

response object from service. Never null

Throws:

AIServiceException

resetContexts

public boolean resetContexts()

Forget all old contexts

Returns:

true if operation succeed, false otherwise

uploadUserEntity

public AIResponse uploadUserEntity(Entity userEntity)
                            throws AIServiceException

Throws:

AIServiceException

uploadUserEntities

public AIResponse uploadUserEntities(Collection<Entity> userEntities)
                              throws AIServiceException

Throws:

AIServiceException

doTextRequest

protected String doTextRequest(String requestJson)
                        throws MalformedURLException,
                               AIServiceException

Throws:

MalformedURLException

AIServiceException

doTextRequest

protected String doTextRequest(String endpoint,
                               String requestJson)
                        throws MalformedURLException,
                               AIServiceException

Throws:

MalformedURLException

AIServiceException

doTextRequest

protected String doTextRequest(String endpoint,
                               String requestJson,
                               Map<String,String> additionalHeaders)
                        throws MalformedURLException,
                               AIServiceException

Parameters:

endpoint - Cannot be null

requestJson - Cannot be null

additionalHeaders -

Returns:

Throws:

MalformedURLException

AIServiceException

doSoundRequest

protected String doSoundRequest(InputStream voiceStream,
                                String queryData)
                         throws MalformedURLException,
                                AIServiceException

Method extracted for testing purposes

Parameters:

voiceStream - Cannot be null

queryData - Cannot be null

Throws:

MalformedURLException

AIServiceException

doSoundRequest

protected String doSoundRequest(InputStream voiceStream,
                                String queryData,
                                Map<String,String> additionalHeaders)
                         throws MalformedURLException,
                                AIServiceException

Method extracted for testing purposes

Parameters:

voiceStream - Cannot be null

queryData - Cannot be null

Throws:

MalformedURLException

AIServiceException