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
String	addActiveContext(AIContext context) Adds new active context for a session
String	addActiveContext(AIContext context, AIServiceContext serviceContext) Adds new active context for a session
List<String>	addActiveContext(Iterable<AIContext> contexts) Adds new active contexts for a session
List<String>	addActiveContext(Iterable<AIContext> contexts, AIServiceContext serviceContext) Adds new active contexts for a session
protected <TRequest,TResponse> TResponse	doRequest(TRequest request, Type responseType, String endpoint, String method)
protected <TRequest,TResponse> TResponse	doRequest(TRequest request, Type responseType, String endpoint, String method, Map<String,String> additionalHeaders)
protected <TResponse> TResponse	doRequest(Type responseType, String endpoint, String method)
protected <TResponse> TResponse	doRequest(Type responseType, String endpoint, String method, Map<String,String> additionalHeaders)
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	doSoundRequest(InputStream voiceStream, String queryData, Map<String,String> additionalHeaders, AIServiceContext serviceContext) Method extracted for testing purposes
protected String	doTextRequest(String requestJson)
protected String	doTextRequest(String requestJson, AIServiceContext serviceContext)
protected String	doTextRequest(String endpoint, String requestJson)
protected String	doTextRequest(String endpoint, String requestJson, Map<String,String> additionalHeaders)
AIContext	getActiveContext(String contextName) Retrieves the specified context for a session
AIContext	getActiveContext(String contextName, AIServiceContext serviceContext) Retrieves the specified context for a session
List<AIContext>	getActiveContexts() Retrieves the list of all currently active contexts for a session
List<AIContext>	getActiveContexts(AIServiceContext serviceContext) Retrieves the list of all currently active contexts for a session
AIServiceContext	getContext()
boolean	removeActiveContext(String contextName) Deletes the specified context for a session
boolean	removeActiveContext(String contextName, AIServiceContext serviceContext) Deletes the specified context for a session
AIResponse	request(AIRequest request) Make request to the AI service.
AIResponse	request(AIRequest request, AIServiceContext serviceContext) Make request to the AI service.
AIResponse	request(AIRequest request, RequestExtras requestExtras) Make request to the AI service.
AIResponse	request(AIRequest request, RequestExtras requestExtras, AIServiceContext serviceContext) Make request to the AI service.
void	resetActiveContexts() Deletes all active contexts for a session
void	resetActiveContexts(AIServiceContext serviceContext) Deletes all active contexts for a session
boolean	resetContexts() Deprecated.
AIResponse	uploadUserEntities(Collection<Entity> userEntities) Add a bunch of new entity to an agent entity list
AIResponse	uploadUserEntities(Collection<Entity> userEntities, AIServiceContext serviceContext) Add a bunch of new entity to an agent entity list
AIResponse	uploadUserEntity(Entity userEntity) Add new entity to an agent entity list
AIResponse	uploadUserEntity(Entity userEntity, AIServiceContext serviceContext) Add new entity to an agent entity list
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.
AIResponse	voiceRequest(InputStream voiceStream, RequestExtras requestExtras, AIServiceContext serviceContext) 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,
                          AIServiceContext serviceContext)
                   throws AIServiceException

Make request to the AI service.

Parameters:

request - request object to the service. Cannot be null

serviceContext - custom service context that should be used instead of the default context

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

requestExtras - object that can hold additional contexts and entities

Returns:

response object from service. Never null

Throws:

AIServiceException

request

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

Make request to the AI service.

Parameters:

request - request object to the service. Cannot be null

requestExtras - object that can hold additional contexts and entities

serviceContext - custom service context that should be used instead of the default context

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.

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.

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.

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

voiceRequest

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

Make requests to the AI service with voice data.

Parameters:

voiceStream - voice data stream for recognition. Cannot be null

requestExtras - object that can hold additional contexts and entities

serviceContext - custom service context that should be used instead of the default context

Returns:

response object from service. Never null

Throws:

AIServiceException

resetContexts

@Deprecated
public boolean resetContexts()

Deprecated.

Forget all old contexts

Returns:

true if operation succeed, false otherwise

getActiveContexts

public List<AIContext> getActiveContexts()
                                  throws AIServiceException

Retrieves the list of all currently active contexts for a session

Returns:

List of contexts, or empty list if there is no any active contexts

Throws:

AIServiceException

getActiveContexts

public List<AIContext> getActiveContexts(AIServiceContext serviceContext)
                                  throws AIServiceException

Retrieves the list of all currently active contexts for a session

Parameters:

serviceContext - custom service context that should be used instead of the default context

Returns:

List of contexts, or empty list if there is no any active contexts

Throws:

AIServiceException

getActiveContext

public AIContext getActiveContext(String contextName)
                           throws AIServiceException

Retrieves the specified context for a session

Parameters:

contextName - The context name

Returns:

null if context not found

Throws:

AIServiceException

getActiveContext

public AIContext getActiveContext(String contextName,
                                  AIServiceContext serviceContext)
                           throws AIServiceException

Retrieves the specified context for a session

Parameters:

contextName - The context name

serviceContext - custom service context that should be used instead of the default context

Returns:

null if context not found

Throws:

AIServiceException

addActiveContext

public List<String> addActiveContext(Iterable<AIContext> contexts)
                              throws AIServiceException

Adds new active contexts for a session

Parameters:

contexts - Iterable collection of contexts

Returns:

List of added context names, or empty list if no contexts were added

Throws:

AIServiceException

addActiveContext

public List<String> addActiveContext(Iterable<AIContext> contexts,
                                     AIServiceContext serviceContext)
                              throws AIServiceException

Adds new active contexts for a session

Parameters:

contexts - Iterable collection of contexts

serviceContext - custom service context that should be used instead of the default context

Returns:

List of added context names, or empty list if no contexts were added

Throws:

AIServiceException

addActiveContext

public String addActiveContext(AIContext context)
                        throws AIServiceException

Adds new active context for a session

Parameters:

context - New context

Returns:

Name of added context

Throws:

AIServiceException

addActiveContext

public String addActiveContext(AIContext context,
                               AIServiceContext serviceContext)
                        throws AIServiceException

Adds new active context for a session

Parameters:

context - New context

serviceContext - custom service context that should be used instead of the default context

Returns:

Name of added context

Throws:

AIServiceException

resetActiveContexts

public void resetActiveContexts()
                         throws AIServiceException

Deletes all active contexts for a session

Throws:

AIServiceException

resetActiveContexts

public void resetActiveContexts(AIServiceContext serviceContext)
                         throws AIServiceException

Deletes all active contexts for a session

Parameters:

serviceContext - custom service context that should be used instead of the default context

Throws:

AIServiceException

removeActiveContext

public boolean removeActiveContext(String contextName)
                            throws AIServiceException

Deletes the specified context for a session

Parameters:

contextName - The context name

Returns:

false if context was not delete, true in otherwise case

Throws:

AIServiceException

removeActiveContext

public boolean removeActiveContext(String contextName,
                                   AIServiceContext serviceContext)
                            throws AIServiceException

Deletes the specified context for a session

Parameters:

contextName - The context name

serviceContext - custom service context that should be used instead of the default context

Returns:

false if context was not delete, true in otherwise case

Throws:

AIServiceException

uploadUserEntity

public AIResponse uploadUserEntity(Entity userEntity)
                            throws AIServiceException

Add new entity to an agent entity list

Parameters:

userEntity - new entity data

Returns:

response object from service. Never null

Throws:

AIServiceException

uploadUserEntity

public AIResponse uploadUserEntity(Entity userEntity,
                                   AIServiceContext serviceContext)
                            throws AIServiceException

Add new entity to an agent entity list

Parameters:

userEntity - new entity data

serviceContext - custom service context that should be used instead of the default context

Returns:

response object from service. Never null

Throws:

AIServiceException

uploadUserEntities

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

Add a bunch of new entity to an agent entity list

Parameters:

userEntities - collection of a new entity data

Returns:

response object from service. Never null

Throws:

AIServiceException

uploadUserEntities

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

Add a bunch of new entity to an agent entity list

Parameters:

userEntities - collection of a new entity data

serviceContext - custom service context that should be used instead of the default context

Returns:

response object from service. Never null

Throws:

AIServiceException

doTextRequest

protected String doTextRequest(String requestJson,
                               AIServiceContext serviceContext)
                        throws MalformedURLException,
                               AIServiceException

Parameters:

requestJson - Cannot be null

serviceContext - custom service context that should be used instead of the default context

Returns:

Response string

Throws:

MalformedURLException

AIServiceException

doTextRequest

protected String doTextRequest(String requestJson)
                        throws MalformedURLException,
                               AIServiceException

Parameters:

requestJson - Cannot be null

Returns:

Response string

Throws:

MalformedURLException

AIServiceException

doTextRequest

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

Parameters:

endpoint - Cannot be null

requestJson - Cannot be null

Returns:

Response string

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:

Response string

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

doSoundRequest

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

Method extracted for testing purposes

Parameters:

voiceStream - Cannot be null

queryData - Cannot be null

Throws:

MalformedURLException

AIServiceException

doRequest

protected <TResponse> TResponse doRequest(Type responseType,
                                          String endpoint,
                                          String method)
                                   throws AIServiceException,
                                          ai.api.AIDataService.BadResponseStatusException

Throws:

AIServiceException

ai.api.AIDataService.BadResponseStatusException

doRequest

protected <TRequest,TResponse> TResponse doRequest(TRequest request,
                                                   Type responseType,
                                                   String endpoint,
                                                   String method)
                                            throws AIServiceException,
                                                   ai.api.AIDataService.BadResponseStatusException

Throws:

AIServiceException

ai.api.AIDataService.BadResponseStatusException

doRequest

protected <TResponse> TResponse doRequest(Type responseType,
                                          String endpoint,
                                          String method,
                                          Map<String,String> additionalHeaders)
                                   throws AIServiceException,
                                          ai.api.AIDataService.BadResponseStatusException

Throws:

AIServiceException

ai.api.AIDataService.BadResponseStatusException

doRequest

protected <TRequest,TResponse> TResponse doRequest(TRequest request,
                                                   Type responseType,
                                                   String endpoint,
                                                   String method,
                                                   Map<String,String> additionalHeaders)
                                            throws AIServiceException,
                                                   ai.api.AIDataService.BadResponseStatusException

Throws:

AIServiceException

ai.api.AIDataService.BadResponseStatusException