qisdk / com.aldebaran.qi.sdk.object.conversation / QiChatbot

QiChatbot

interface QiChatbot : Chatbot

Chatbot that can be used to make the robot able to chat with a human. The interaction will be based on the content given in the QiChatbot topics.

Since
3

Types

Async

interface Async : Async

OnBookmarkReachedListener

Listener for bookmarkReached signal

interface OnBookmarkReachedListener

OnEndedListener

Listener for ended signal

interface OnEndedListener

OnFocusedTopicChangedListener

Listener for focusedTopic property changed event

interface OnFocusedTopicChangedListener

Functions

addOnBookmarkReachedListener

Add a OnBookmarkReachedListener

abstract fun addOnBookmarkReachedListener(onBookmarkReachedListener: OnBookmarkReachedListener!): Unit

addOnEndedListener

Add a OnEndedListener

abstract fun addOnEndedListener(onEndedListener: OnEndedListener!): Unit

addOnFocusedTopicChangedListener

Add a property changed listener for focusedTopic

abstract fun addOnFocusedTopicChangedListener(onFocusedTopicChangedListener: OnFocusedTopicChangedListener!): Unit

async

abstract fun async(): Async!

bookmarkStatus

Obtain an object to observe and act on the given state of Bookmark within this QiChatbot

abstract fun bookmarkStatus(bookmark: Bookmark!): BookmarkStatus!

concept

Get the content of the concept with the given name that can be converted to a string This works with both static and dynamic concepts. (For a primer on static and dynamic concepts, please refer to the QiChat documentation)

abstract fun concept(conceptName: String!): PhraseSet!

dynamicConcept

Retrieve the dynamic concept with the given name This works only with dynamic concepts. (For a primer on static and dynamic concepts, please refer to the QiChat documentation)

abstract fun dynamicConcept(conceptName: String!): EditablePhraseSet!

focusedTopicRecommendations

Obtain a list of possible human utterances for the currently focused topic of this QiChatbot

abstract fun focusedTopicRecommendations(maxRecommendations: Int!): MutableList<Phrase!>!

getExecutors

Exposes the property executors value

abstract fun getExecutors(): MutableMap<String!, QiChatExecutor!>!

getFocusedTopic

Exposes the property focusedTopic value

abstract fun getFocusedTopic(): Topic!

getSpeakingBodyLanguage

Exposes the property speakingBodyLanguage value

abstract fun getSpeakingBodyLanguage(): BodyLanguageOption!

getTopics

Exposes the property topics value

abstract fun getTopics(): MutableList<Topic!>!

globalRecommendations

Obtain a list of possible human utterances for this QiChatbot as a whole

abstract fun globalRecommendations(maxRecommendations: Int!): MutableList<Phrase!>!

goToBookmark

Make the robot execute the interaction at the given Bookmark, only if the Bookmark can be emitted. This provokes the emission of the autonomousReaction(Reply) signal, and will return only when the run() of the emitted reply has finished.

abstract fun goToBookmark(bookmark: Bookmark!, importance: AutonomousReactionImportance!, validity: AutonomousReactionValidity!): Unit

removeAllOnBookmarkReachedListeners

Remove all OnBookmarkReachedListener

abstract fun removeAllOnBookmarkReachedListeners(): Unit

removeAllOnEndedListeners

Remove all OnEndedListener

abstract fun removeAllOnEndedListeners(): Unit

removeAllOnFocusedTopicChangedListeners

Remove all focusedTopic changed listeners

abstract fun removeAllOnFocusedTopicChangedListeners(): Unit

removeOnBookmarkReachedListener

Remove a OnBookmarkReachedListener

abstract fun removeOnBookmarkReachedListener(onBookmarkReachedListener: OnBookmarkReachedListener!): Unit

removeOnEndedListener

Remove a OnEndedListener

abstract fun removeOnEndedListener(onEndedListener: OnEndedListener!): Unit

removeOnFocusedTopicChangedListener

Remove a property changed listener for focusedTopic

abstract fun removeOnFocusedTopicChangedListener(onFocusedTopicChangedListener: OnFocusedTopicChangedListener!): Unit

scopeRecommendations

Obtain a list of possible human utterances for the current scope of this QiChatbot

abstract fun scopeRecommendations(maxRecommendations: Int!): MutableList<Phrase!>!

setExecutors

Set the property executors value

abstract fun setExecutors(executors: MutableMap<String!, QiChatExecutor!>!): Unit

setOnBookmarkReachedListener

Set a OnBookmarkReachedListener

abstract fun setOnBookmarkReachedListener(onBookmarkReachedListener: OnBookmarkReachedListener!): Unit

setOnEndedListener

Set a OnEndedListener

abstract fun setOnEndedListener(onEndedListener: OnEndedListener!): Unit

setOnFocusedTopicChangedListener

Set a property changed listener for focusedTopic

abstract fun setOnFocusedTopicChangedListener(onFocusedTopicChangedListener: OnFocusedTopicChangedListener!): Unit

setSpeakingBodyLanguage

Set the property bodyLanguageOption value

abstract fun setSpeakingBodyLanguage(bodyLanguageOption: BodyLanguageOption!): Unit

topicStatus

Obtain an object to observe and act on the given state of a Topic within this QiChatbot.

abstract fun topicStatus(topic: Topic!): TopicStatus!

variable

Obtain access to the variable with the given name

abstract fun variable(varName: String!): QiChatVariable!