io.spokestack.spokestack.nlu

Class NLUResult.Builder

java.lang.Object

io.spokestack.spokestack.nlu.NLUResult.Builder

Enclosing class:

NLUResult

public static final class NLUResult.Builder
extends Object

NLU result builder API.

Constructor Summary

Constructors

Constructor and Description
Builder(String utterance) Creates a new result builder.

Method Summary

Modifier and Type	Method and Description
NLUResult	build() Uses the current builder state to create an NLU result.
NLUResult.Builder	withConfidence(float confidence) Set the confidence for the intent classification.
NLUResult.Builder	withContext(Map<String,Object> context) Attaches the context returned by the NLU service.
NLUResult.Builder	withError(Throwable error) Attaches an error encountered while performing NLU.
NLUResult.Builder	withIntent(String intent) Attaches the user intent classified by the NLU service.
NLUResult.Builder	withSlots(Map<String,Slot> slots) Attaches the slot values extracted from the user utterance.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(String utterance)

Creates a new result builder.

Parameters:

utterance - The user's original utterance.

Method Detail

withError

public NLUResult.Builder withError(Throwable error)

Attaches an error encountered while performing NLU.

Parameters:

error - The error to attach.

Returns:

this

withIntent

public NLUResult.Builder withIntent(String intent)

Attaches the user intent classified by the NLU service.

Parameters:

intent - The user intent.

Returns:

this

withConfidence

public NLUResult.Builder withConfidence(float confidence)

Set the confidence for the intent classification.

Parameters:

confidence - The classifier's confidence for its intent prediction.

Returns:

this

withSlots

public NLUResult.Builder withSlots(Map<String,Slot> slots)

Attaches the slot values extracted from the user utterance.

Parameters:

slots - The slots present in the user utterance.

Returns:

this

withContext

public NLUResult.Builder withContext(Map<String,Object> context)

Attaches the context returned by the NLU service.

Parameters:

context - The context to attach.

Returns:

this

build

public NLUResult build()

Uses the current builder state to create an NLU result.

Returns:

A populated NLU result instance.