com.brein.api

Class Brein

java.lang.Object

com.brein.api.Brein

public class Brein
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Brein()

Method Summary

Modifier and Type	Method and Description
void	activity(BreinActivity data, java.util.function.Consumer<BreinResult> callback) Sends an activity to the engine utilizing the API.
BreinResult	lookup(BreinLookup data) Retrieves a lookup result from the engine.
BreinRecommendationResult	recommendation(BreinRecommendation data) Sends a recommendation request to the engine utilizing the API.
BreinRecommendationResults	recommendations(BreinRecommendations data) Sends a set of recommendation requests to the engine utilizing the API.
Brein	setConfig(BreinConfig breinConfig) Sets the configuration
void	shutdown() Shutdown Breinify services
BreinTemporalDataResult	temporalData(BreinTemporalData data) Sends a temporalData to the engine utilizing the API.

Methods inherited from class java.lang.Object

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

Constructor Detail

Brein

public Brein()

Method Detail

setConfig

public Brein setConfig(BreinConfig breinConfig)

Sets the configuration

Parameters:

breinConfig - config object

activity

public void activity(BreinActivity data,
                     java.util.function.Consumer<BreinResult> callback)

Sends an activity to the engine utilizing the API. The call is done asynchronously as a POST request. It is important that a valid API-key is configured prior to using this function.

This request is asynchronous.

lookup

public BreinResult lookup(BreinLookup data)

Retrieves a lookup result from the engine. The function needs a valid API-key to be configured to succeed.

This request is synchronous.

Parameters:

data - a plain object specifying the lookup information.

Returns:

response from request wrapped in an object called BreinResponse

temporalData

public BreinTemporalDataResult temporalData(BreinTemporalData data)

Sends a temporalData to the engine utilizing the API. The call is done synchronously as a POST request. It is important that a valid API-key is configured prior to using this function.

This request is synchronous.

Returns:

result from the Breinify engine

recommendation

public BreinRecommendationResult recommendation(BreinRecommendation data)

Sends a recommendation request to the engine utilizing the API. The call is done synchronously as a POST request. It is important that a valid API-key is configured prior to using this function.

This request is synchronous.

Parameters:

data - contains the brein recommendation object

Returns:

the recommended items

recommendations

public BreinRecommendationResults recommendations(BreinRecommendations data)

Sends a set of recommendation requests to the engine utilizing the API. The call is done synchronously as a POST request. It is important that a valid API-key is configured prior to using this function.

This request is synchronous.

Parameters:

data - contains collection of the brein recommendation objects

Returns:

the recommended items

shutdown

public void shutdown()

Shutdown Breinify services