com.ibm.watson.developer_cloud.conversation.v1.model

Class Intent

java.lang.Object

com.ibm.watson.developer_cloud.conversation.v1.model.Intent

public class Intent
extends Object

A class representing an Intent as detected by the service. The intent is the 'intent' of the user utterance, e.g. "pay_bill", "check_balance" etc.. The intent is accompanied by a confidence score ranging between 0.0 and 1.0, with 1.0 being the most confident.

Constructor Summary

Constructors

Constructor and Description
Intent(String intent, Double confidence) Instantiates a new intent.

Method Summary

Modifier and Type	Method and Description
Double	getConfidence() Returns the confidence associated with the intent.
String	getIntent() Returns the name of the intent that the system detected in the user input.
void	setConfidence(Double confidence) Sets the system confidence in the intent.
void	setIntent(String intent) Sets the name of the intent the system understood the user to have 'said'.

Methods inherited from class java.lang.Object

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

Constructor Detail

Intent

public Intent(String intent,
              Double confidence)

Instantiates a new intent.

Parameters:

intent - the intent

confidence - the confidence

Method Detail

getConfidence

public Double getConfidence()

Returns the confidence associated with the intent. When the service parses/analyzes the user input it tries to determine the 'intent' of what the user said. The service will be trained to expect n different intents and the service tries to match the input with one of the intents. The confidence is the value assigned by the system to the returned intent. High confidence scores (close to 1.0) imply that the system is very confident that the user meant the returned intent. Low confidence scores indicate that the system is not confident in its response.

Returns:

a float representing system confidence

getIntent

public String getIntent()

Returns the name of the intent that the system detected in the user input.

Returns:

a string representing an intent name

setConfidence

public void setConfidence(Double confidence)

Sets the system confidence in the intent.

Parameters:

confidence - a float between 0.0 and 1.0

setIntent

public void setIntent(String intent)

Sets the name of the intent the system understood the user to have 'said'.

Parameters:

intent - a string representing one of the trained intents