com.aldebaran.qi.sdk.object.conversation

Interface Conversation.Async

Enclosing interface:

Conversation

public static interface Conversation.Async

Method Summary

Modifier and Type	Method and Description
<any>	makeChat(RobotContext context, java.util.List<Chatbot> chatbots) Create a Chat in the current language
<any>	makeChat(RobotContext context, java.util.List<Chatbot> chatbots, ChatOptions chatOptions) Create a Chat in the current language, using the specified options.
<any>	makeChat(RobotContext context, java.util.List<Chatbot> chatbots, Locale locale) Create a Chat in the given language
<any>	makeChat(RobotContext context, java.util.List<Chatbot> chatbots, SpeechEngine speechEngine) Create a Chat in the current language
<any>	makeChat(RobotContext context, java.util.List<Chatbot> chatbots, SpeechEngine speechEngine, Locale locale) Create a Chat in the given language
<any>	makeDiscuss(RobotContext context, java.util.List<Topic> topics) Create a Discussion in the current language.
<any>	makeDiscuss(RobotContext context, java.util.List<Topic> topics, Locale locale) Create a Discussion in the given language.
<any>	makeListen(RobotContext context, java.util.List<PhraseSet> phraseSets) Create a listen action.
<any>	makeListen(RobotContext context, java.util.List<PhraseSet> phraseSets, BodyLanguageOption bodyLanguageOption) Create a listen action.
<any>	makeListen(RobotContext context, java.util.List<PhraseSet> phraseSets, BodyLanguageOption bodyLanguageOption, Locale locale) Create a listen action.
<any>	makeListen(RobotContext context, java.util.List<PhraseSet> phraseSets, ListenOptions listenOptions) Create a listen action, using the specified Options.
<any>	makePhraseSet(java.util.List<Phrase> phrases) Create a phrase set from a set of phrases.
<any>	makeQiChatbot(RobotContext context, java.util.List<Topic> topics) Create a Qichatbot in the current language.
<any>	makeQiChatbot(RobotContext context, java.util.List<Topic> topics, Locale locale) Create a Qichatbot in the given language.
<any>	makeSay(RobotContext context, Phrase phrase) Create a say action.
<any>	makeSay(RobotContext context, Phrase phrase, BodyLanguageOption bodyLanguageOption) Create a say action.
<any>	makeSay(RobotContext context, Phrase phrase, BodyLanguageOption bodyLanguageOption, Locale locale) Create a say action.
<any>	makeSpeechEngine(RobotContext context) Creates a SpeechEngine, that will create Say actions using the Conversation service with the given context
<any>	makeTopic(java.lang.String topicContent) Create a new Topic object.
<any>	status(RobotContext context) Access Conversation related signals and properties for the given context via a ConversationStatus object

Method Detail

makeSay

<any> makeSay(RobotContext context,
              Phrase phrase)

Create a say action.

Parameters:

context - The context to authorize the action to be effectively executed on a robot.

phrase - The phrase to say.

Returns:

A say action.

Since:

1

makeSay

<any> makeSay(RobotContext context,
              Phrase phrase,
              BodyLanguageOption bodyLanguageOption)

Create a say action.

Parameters:

context - The context to authorize the action to be effectively executed on a robot.

phrase - The phrase to say.

bodyLanguageOption - The body language policy to apply. "neutral" policy: the robot chooses animations to perform accordingly to the spoken words and the syntactic structure of the phrase.

Returns:

A say action.

Since:

1

makeSay

<any> makeSay(RobotContext context,
              Phrase phrase,
              BodyLanguageOption bodyLanguageOption,
              Locale locale)

Create a say action.

Parameters:

context - The context to authorize the action to be effectively executed on a robot.

phrase - The phrase to say.

bodyLanguageOption - The body language policy to apply. "neutral" policy: the robot chooses animations to perform accordingly to the spoken words and the syntactic structure of the phrase.

locale - The locale to be used to say the text.

Returns:

A say action.

Since:

1

makeListen

<any> makeListen(RobotContext context,
                 java.util.List<PhraseSet> phraseSets)

Create a listen action.

Parameters:

context - The context to authorize the action to be effectively executed on a robot.

phraseSets - The vector of phrase sets to detect.

Returns:

A listen action.

Since:

1

makeListen

<any> makeListen(RobotContext context,
                 java.util.List<PhraseSet> phraseSets,
                 BodyLanguageOption bodyLanguageOption)

Create a listen action.

Parameters:

context - The context to authorize the action to be effectively executed on a robot.

phraseSets - The vector of phrase sets to detect.

bodyLanguageOption - The body language policy to apply. "neutral" policy: the robot nods and gesticulates to express that he is listening. And a final head node when the robot has finished to listen.

Returns:

A listen action.

Since:

1

makeListen

<any> makeListen(RobotContext context,
                 java.util.List<PhraseSet> phraseSets,
                 BodyLanguageOption bodyLanguageOption,
                 Locale locale)

Create a listen action.

Parameters:

context - The context to authorize the action to be effectively executed on a robot.

phraseSets - The vector of phrase sets to detect.

bodyLanguageOption - The body language policy to apply. "neutral" policy: the robot nods and gesticulates to express that he is listening. And a final head nod when the robot has finished to listen.

locale - The locale to be used to listen.

Returns:

A listen action.

Since:

1

makeListen

<any> makeListen(RobotContext context,
                 java.util.List<PhraseSet> phraseSets,
                 ListenOptions listenOptions)

Create a listen action, using the specified Options.

Parameters:

context - The context to authorize the action to be effectively executed on a robot.

phraseSets - The vector of phrase sets to detect.

listenOptions - Optional data for the Listen action configuration

Returns:

A listen action.

Since:

5

makePhraseSet

<any> makePhraseSet(java.util.List<Phrase> phrases)

Create a phrase set from a set of phrases.

Parameters:

phrases - Set of phrases to put in the resulting phrase set.

Returns:

A phrase set.

Since:

1

makeDiscuss

<any> makeDiscuss(RobotContext context,
                  java.util.List<Topic> topics)

Create a Discussion in the current language.

Parameters:

context - The context to authorize the action to be effectively executed on a robot

topics - The list of topics to use with the action

Returns:

A Discuss action.

Future on error when:

• topics is empty.
• topics contains Topics with duplicate names.
• One or more of the Topics contain one or more concepts that have not been defined.
• One or more of the Topics contain one or more user defined functions that have not been defined.

Since:

1

makeDiscuss

<any> makeDiscuss(RobotContext context,
                  java.util.List<Topic> topics,
                  Locale locale)

Create a Discussion in the given language.

Parameters:

context - The context to authorize the action to be effectively executed on a robot.

topics - The list of topics to use with the action.

locale - The language of the conversation.

Returns:

A Discuss action.

Future on error when:

• topics is empty.
• topics contains Topics with duplicate names.
• One or more of the Topics contain one or more concepts that have not been defined.
• One or more of the Topics contain one or more user defined functions that have not been defined
• The given locale is not available on the robot

Since:

1

makeTopic

<any> makeTopic(java.lang.String topicContent)

Create a new Topic object.

Parameters:

topicContent - The content of the Topic

Returns:

A topic object.

Future on error when:

• The syntax of the topic given in topicContent is incorrect.

Since:

1

makeSpeechEngine

<any> makeSpeechEngine(RobotContext context)

Creates a SpeechEngine, that will create Say actions using the Conversation service with the given context

Parameters:

context - The context to authorize the created Say actions to be effectively executed on a robot

Returns:

A SpeechEngine

Since:

3

makeChat

<any> makeChat(RobotContext context,
               java.util.List<Chatbot> chatbots)

Create a Chat in the current language

Parameters:

context - The context to authorize the action to be effectively executed on a robot

chatbots - The list of Chatbots to use with the action, ordered by priority

Returns:

A Chat action

Future on error when:

• The list of chatbots is empty

Since:

3

makeChat

<any> makeChat(RobotContext context,
               java.util.List<Chatbot> chatbots,
               SpeechEngine speechEngine)

Create a Chat in the current language

Parameters:

context - The context to authorize the action to be effectively executed on a robot

chatbots - The list of Chatbots to use with the action, ordered by priority

speechEngine - The factory which is necessary to create the Say objects used to make speak the robot during a reply.

Returns:

A Chat action

Future on error when:

• The list of chatbots is empty

Since:

3

makeChat

<any> makeChat(RobotContext context,
               java.util.List<Chatbot> chatbots,
               Locale locale)

Create a Chat in the given language

Parameters:

context - The context to authorize the action to be effectively executed on a robot

chatbots - The list of Chatbots to use with the action, ordered by priority

locale - The language of the chatbot

Returns:

A Chat action

Future on error when:

• The list of chatbots is empty
• The given locale is not available on the robot

Since:

3

makeChat

<any> makeChat(RobotContext context,
               java.util.List<Chatbot> chatbots,
               SpeechEngine speechEngine,
               Locale locale)

Create a Chat in the given language

Parameters:

context - The context to authorize the action to be effectively executed on a robot

chatbots - The list of Chatbots to use with the action, ordered by priority

locale - The language of the chatbot

speechEngine - The factory which is necessary to create the Say objects used to make speak the robot during a reply.

Returns:

A Chat action

Future on error when:

• The list of chatbots is empty
• The given locale is not available on the robot

Since:

3

makeChat

<any> makeChat(RobotContext context,
               java.util.List<Chatbot> chatbots,
               ChatOptions chatOptions)

Create a Chat in the current language, using the specified options.

Parameters:

context - The context to authorize the action to be effectively executed on a robot

chatbots - The list of Chatbots to use with the action, ordered by priority

chatOptions - Optional data for the Chat action configuration

Returns:

A Chat action

Future on error when:

• The list of chatbots is empty

Since:

5

makeQiChatbot

<any> makeQiChatbot(RobotContext context,
                    java.util.List<Topic> topics)

Create a Qichatbot in the current language.

Parameters:

context - The context of the application

topics - The list of topics to use within the QiChatbot

Returns:

A QiChatbot.

Future on error when:

• topics is empty.
• topics contains Topics with duplicate names.
• One or more of the Topics contain one or more concepts that have not been defined.
• One or more of the Topics contain one or more user defined functions that have not been defined.

Since:

3

makeQiChatbot

<any> makeQiChatbot(RobotContext context,
                    java.util.List<Topic> topics,
                    Locale locale)

Create a Qichatbot in the given language.

Parameters:

context - The context of the application

topics - The list of topics to use within the QiChatbot

locale - The language of the conversation.

Returns:

A QiChatbot.

Future on error when:

• topics is empty.
• topics contains Topics with duplicate names.
• One or more of the Topics contain one or more concepts that have not been defined.
• One or more of the Topics contain one or more user defined functions that have not been defined.
• The given locale is not available on the robot

Since:

3

status

<any> status(RobotContext context)

Access Conversation related signals and properties for the given context via a ConversationStatus object

Parameters:

context - The context of the application

Returns:

A ConversationStatus object

Since:

3