Chatbot (qisdk 1.6.7 API)

All Known Subinterfaces:

QiChatbot

All Known Implementing Classes:

BaseChatbot
```
public interface Chatbot
```
Object representing a Chatbot that can react in response to Phrases.

Since:

3

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`Chatbot.Async`
`static interface`	`Chatbot.OnAutonomousReactionChangedListener` Listener for autonomousReaction property changed event
`static interface`	`Chatbot.OnIsAvailableToReplyChangedListener` Listener for isAvailableToReply property changed event
`static interface`	`Chatbot.OnMaxHypothesesPerUtteranceChangedListener` Listener for maxHypothesesPerUtterance property changed event

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`acknowledgeHeard(Phrase phrase, Locale locale)` Inform the Chatbot with the last phrase heard by the robot.
`void`	`acknowledgeSaid(Phrase phrase, Locale locale)` Inform the Chatbot with the last phrase said by the robot.
`void`	`addOnAutonomousReactionChangedListener(Chatbot.OnAutonomousReactionChangedListener onAutonomousReactionChangedListener)` Add a property changed listener for autonomousReaction
`void`	`addOnIsAvailableToReplyChangedListener(Chatbot.OnIsAvailableToReplyChangedListener onIsAvailableToReplyChangedListener)` Add a property changed listener for isAvailableToReply
`void`	`addOnMaxHypothesesPerUtteranceChangedListener(Chatbot.OnMaxHypothesesPerUtteranceChangedListener onMaxHypothesesPerUtteranceChangedListener)` Add a property changed listener for maxHypothesesPerUtterance
`Chatbot.Async`	`async()`
`AutonomousReaction`	`getAutonomousReaction()` Exposes the property autonomousReaction value
`java.lang.Boolean`	`getIsAvailableToReply()` Exposes the property isAvailableToReply value
`java.lang.Integer`	`getMaxHypothesesPerUtterance()` Exposes the property maxHypothesesPerUtterance value
`void`	`removeAllOnAutonomousReactionChangedListeners()` Remove all autonomousReaction changed listeners
`void`	`removeAllOnIsAvailableToReplyChangedListeners()` Remove all isAvailableToReply changed listeners
`void`	`removeAllOnMaxHypothesesPerUtteranceChangedListeners()` Remove all maxHypothesesPerUtterance changed listeners
`void`	`removeOnAutonomousReactionChangedListener(Chatbot.OnAutonomousReactionChangedListener onAutonomousReactionChangedListener)` Remove a property changed listener for autonomousReaction
`void`	`removeOnIsAvailableToReplyChangedListener(Chatbot.OnIsAvailableToReplyChangedListener onIsAvailableToReplyChangedListener)` Remove a property changed listener for isAvailableToReply
`void`	`removeOnMaxHypothesesPerUtteranceChangedListener(Chatbot.OnMaxHypothesesPerUtteranceChangedListener onMaxHypothesesPerUtteranceChangedListener)` Remove a property changed listener for maxHypothesesPerUtterance
`ReplyReaction`	`replyTo(Phrase phrase, Locale locale)` Produce a ReplyReaction based on a given input phrase.
`void`	`setMaxHypothesesPerUtterance(java.lang.Integer maxHypothesesPerUtterance)` Set the property maxHypothesesPerUtterance value
`void`	`setOnAutonomousReactionChangedListener(Chatbot.OnAutonomousReactionChangedListener onAutonomousReactionChangedListener)` Deprecated.
`void`	`setOnIsAvailableToReplyChangedListener(Chatbot.OnIsAvailableToReplyChangedListener onIsAvailableToReplyChangedListener)` Deprecated.
`void`	`setOnMaxHypothesesPerUtteranceChangedListener(Chatbot.OnMaxHypothesesPerUtteranceChangedListener onMaxHypothesesPerUtteranceChangedListener)` Deprecated.

- Method Detail
  - async
```
Chatbot.Async async()
```
  - replyTo
```
ReplyReaction replyTo(Phrase phrase,
                      Locale locale)
```
    Produce a ReplyReaction based on a given input phrase. This phrase may be empty if the robot was not able to make out what was being said.
    
    Parameters:
    
    phrase - The input Phrase from the user
    
    locale - The Locale of the given Phrase
    
    Returns:
    
    A ReplyReaction corresponding to the given input Phrase
    
    Throws:
    
    java.lang.RuntimeException - The Chatbot has no answer at all for the given Phrase
    
    Since:
    
    3
  - acknowledgeHeard
```
void acknowledgeHeard(Phrase phrase,
                      Locale locale)
```
    Inform the Chatbot with the last phrase heard by the robot. It will be called anytime a reply not given by this Chatbot has been chosen to answer a phrase.
    
    Parameters:
    
    phrase - The input Phrase from the user
    
    locale - The Locale of the given Phrase
    
    Since:
    
    3
  - acknowledgeSaid
```
void acknowledgeSaid(Phrase phrase,
                     Locale locale)
```
    Inform the Chatbot with the last phrase said by the robot. It will be called anytime a ChatbotReaction not given by this Chatbot has been chosen to answer a phrase.
    
    Parameters:
    
    phrase - The output Phrase from the robot
    
    locale - The Locale of the given Phrase
    
    Since:
    
    3
  - getAutonomousReaction
```
AutonomousReaction getAutonomousReaction()
```
    Exposes the property autonomousReaction value
    
    Returns:
    
    the autonomousReaction value
    Represents a ChatbotReaction suggested spontaneously by the Chatbot and which is not the reaction to a Phrase (as those should be managed by Chatbot.replyTo()). Ex: The robot sees a person and the Chatbot wants to proactively greet him.
    
    Since:
    
    3
  - setOnAutonomousReactionChangedListener
```
@Deprecated
void setOnAutonomousReactionChangedListener(Chatbot.OnAutonomousReactionChangedListener onAutonomousReactionChangedListener)
```
    Deprecated.
    
    Set a property changed listener for autonomousReaction
    
    Parameters:
    
    onAutonomousReactionChangedListener - the listener
    
    Since:
    
    3
  - addOnAutonomousReactionChangedListener
```
void addOnAutonomousReactionChangedListener(Chatbot.OnAutonomousReactionChangedListener onAutonomousReactionChangedListener)
```
    Add a property changed listener for autonomousReaction
    
    Parameters:
    
    onAutonomousReactionChangedListener - the listener
    
    Since:
    
    3
  - removeOnAutonomousReactionChangedListener
```
void removeOnAutonomousReactionChangedListener(Chatbot.OnAutonomousReactionChangedListener onAutonomousReactionChangedListener)
```
    Remove a property changed listener for autonomousReaction
    
    Parameters:
    
    onAutonomousReactionChangedListener - the listener
    
    Since:
    
    3
  - removeAllOnAutonomousReactionChangedListeners
```
void removeAllOnAutonomousReactionChangedListeners()
```
    Remove all autonomousReaction changed listeners
    
    Since:
    
    3
  - getMaxHypothesesPerUtterance
```
java.lang.Integer getMaxHypothesesPerUtterance()
```
    Exposes the property maxHypothesesPerUtterance value
    
    Returns:
    
    the maxHypothesesPerUtterance value
    The maximum hypotheses per utterance for this chatbot. For every utterance, a Chat action can formulate several hypotheses, ordered from the most probable to the least probable. For each hypothesis, the Chatbots will be called in order of priority until a suitable ReplyReaction is found. This value limits the number of times a single Chatbot will be called for each utterance. For a Chatbot, the default value of this property is 2. If the provided value is negative or 0, the Chatbot won't be called at all.
    
    Since:
    
    4
  - setMaxHypothesesPerUtterance
```
void setMaxHypothesesPerUtterance(java.lang.Integer maxHypothesesPerUtterance)
```
    Set the property maxHypothesesPerUtterance value
    
    Parameters:
    
    maxHypothesesPerUtterance - the new maxHypothesesPerUtterance value
    The maximum hypotheses per utterance for this chatbot. For every utterance, a Chat action can formulate several hypotheses, ordered from the most probable to the least probable. For each hypothesis, the Chatbots will be called in order of priority until a suitable ReplyReaction is found. This value limits the number of times a single Chatbot will be called for each utterance. For a Chatbot, the default value of this property is 2. If the provided value is negative or 0, the Chatbot won't be called at all.
    
    Since:
    
    4
  - setOnMaxHypothesesPerUtteranceChangedListener
```
@Deprecated
void setOnMaxHypothesesPerUtteranceChangedListener(Chatbot.OnMaxHypothesesPerUtteranceChangedListener onMaxHypothesesPerUtteranceChangedListener)
```
    Deprecated.
    
    Set a property changed listener for maxHypothesesPerUtterance
    
    Parameters:
    
    onMaxHypothesesPerUtteranceChangedListener - the listener
    
    Since:
    
    4
  - addOnMaxHypothesesPerUtteranceChangedListener
```
void addOnMaxHypothesesPerUtteranceChangedListener(Chatbot.OnMaxHypothesesPerUtteranceChangedListener onMaxHypothesesPerUtteranceChangedListener)
```
    Add a property changed listener for maxHypothesesPerUtterance
    
    Parameters:
    
    onMaxHypothesesPerUtteranceChangedListener - the listener
    
    Since:
    
    4
  - removeOnMaxHypothesesPerUtteranceChangedListener
```
void removeOnMaxHypothesesPerUtteranceChangedListener(Chatbot.OnMaxHypothesesPerUtteranceChangedListener onMaxHypothesesPerUtteranceChangedListener)
```
    Remove a property changed listener for maxHypothesesPerUtterance
    
    Parameters:
    
    onMaxHypothesesPerUtteranceChangedListener - the listener
    
    Since:
    
    4
  - removeAllOnMaxHypothesesPerUtteranceChangedListeners
```
void removeAllOnMaxHypothesesPerUtteranceChangedListeners()
```
    Remove all maxHypothesesPerUtterance changed listeners
    
    Since:
    
    4
  - getIsAvailableToReply
```
java.lang.Boolean getIsAvailableToReply()
```
    Exposes the property isAvailableToReply value
    
    Returns:
    
    the isAvailableToReply value
    Indicates whether this Chatbot is available to reply. If the value is set to false, the Chatbot method replyTo() will not be called by the Chat when processing utterances.
    
    Since:
    
    6
  - setOnIsAvailableToReplyChangedListener
```
@Deprecated
void setOnIsAvailableToReplyChangedListener(Chatbot.OnIsAvailableToReplyChangedListener onIsAvailableToReplyChangedListener)
```
    Deprecated.
    
    Set a property changed listener for isAvailableToReply
    
    Parameters:
    
    onIsAvailableToReplyChangedListener - the listener
    
    Since:
    
    6
  - addOnIsAvailableToReplyChangedListener
```
void addOnIsAvailableToReplyChangedListener(Chatbot.OnIsAvailableToReplyChangedListener onIsAvailableToReplyChangedListener)
```
    Add a property changed listener for isAvailableToReply
    
    Parameters:
    
    onIsAvailableToReplyChangedListener - the listener
    
    Since:
    
    6
  - removeOnIsAvailableToReplyChangedListener
```
void removeOnIsAvailableToReplyChangedListener(Chatbot.OnIsAvailableToReplyChangedListener onIsAvailableToReplyChangedListener)
```
    Remove a property changed listener for isAvailableToReply
    
    Parameters:
    
    onIsAvailableToReplyChangedListener - the listener
    
    Since:
    
    6
  - removeAllOnIsAvailableToReplyChangedListeners
```
void removeAllOnIsAvailableToReplyChangedListeners()
```
    Remove all isAvailableToReply changed listeners
    
    Since:
    
    6

Interface Chatbot

Nested Class Summary

Method Summary

Method Detail

async

replyTo

acknowledgeHeard

acknowledgeSaid

getAutonomousReaction

setOnAutonomousReactionChangedListener

addOnAutonomousReactionChangedListener

removeOnAutonomousReactionChangedListener

removeAllOnAutonomousReactionChangedListeners

getMaxHypothesesPerUtterance

setMaxHypothesesPerUtterance

setOnMaxHypothesesPerUtteranceChangedListener

addOnMaxHypothesesPerUtteranceChangedListener

removeOnMaxHypothesesPerUtteranceChangedListener

removeAllOnMaxHypothesesPerUtteranceChangedListeners

getIsAvailableToReply

setOnIsAvailableToReplyChangedListener

addOnIsAvailableToReplyChangedListener

removeOnIsAvailableToReplyChangedListener

removeAllOnIsAvailableToReplyChangedListeners