io.spokestack.spokestack.nlu

Interface NLUService

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

RasaOpenSourceNLU, TensorflowNLU

public interface NLUService
extends AutoCloseable

A simple interface for components that provide intent classification and slot recognition, either on-device or via a network request.

To participate in Spokestack's NLUManager, an NLUService must have a constructor that accepts instances of SpeechConfig and NLUContext.

Method Summary

Modifier and Type	Method and Description
AsyncResult<NLUResult>	classify(String utterance, NLUContext context) Classifies a user utterance.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

classify

AsyncResult<NLUResult> classify(String utterance,
                                NLUContext context)

Classifies a user utterance. Classification should be performed on a background thread, but the use of an AsyncResult allows the caller to either block while waiting for a result or register a callback to be executed when the result is available.

Parameters:

utterance - The user utterance to be classified.

context - The current NLU context, containing request metadata and the ability to fire trace events.

Returns:

An AsyncResult representing the result of the classification task.

See Also:

AsyncResult.registerCallback(io.spokestack.spokestack.util.Callback)