Class SBDAssistant#
#include <SBDAssistant.hpp>
Inherits the following classes: SBCReferenceTarget
Public Functions#
Type | Name |
---|---|
SBDAssistant () Constructs an assistant. |
|
SB_DECLARE_DATA (SBDAssistant) |
|
virtual SBDAssistantAnswer * | act (const std::wstring & question, const std::wstring & translation) Executes an action. |
virtual SBDAssistantAnswer * | getAnswer (const std::wstring & question, const std::wstring & translation) Returns an answer to a question. |
virtual SBDAssistantAnswer * | getCompletion (const std::wstring & question, const std::wstring & translation, const std::wstring & system, const std::wstring & queryType) Returns a completion to a single question. |
const SBUUID & | getConversationUUID () const Returns the conversation UUID. |
SBGAssistant * | getGUI () const Returns a pointer to the GUI of the assistant. |
virtual SBDAssistantAnswer * | getNSLExpression (const std::wstring & question, const std::wstring & translation) Returns an NSL expression. |
virtual std::wstring | getTranscription (const std::wstring & fileName, std::wstring & language) Returns a transcription for an audio file with file name fileName and the detectedlanguage . |
virtual std::wstring | getTranslation (const std::wstring & text, const std::wstring & language) Returns the translation of text inlanguage into English. |
const SBUUID & | getUserUUID () const Returns the user UUID. |
virtual SBDAssistantAnswer * | memorize (const std::wstring & fileName) Memorizes a document. |
virtual SBDAssistantAnswer * | memorize (const std::wstring & url, const std::wstring & include=L"", const std::wstring & exclude=L"") Memorizes a webpage. |
virtual SBDAssistantAnswer * | search (const std::wstring & question, const std::wstring & translation) Performs a search. |
virtual SBDAssistantAnswer * | select (const std::wstring & question, const std::wstring & translation) Selects nodes in the document. |
void | setConversationUUID (const SBUUID & conversationUUID) Sets the conversation UUID. |
void | setGUI (SBGAssistant * gui) Sets the pointer to the GUI of the assistant. |
void | setUserUUID (const SBUUID & userUUID) Sets the user UUID. |
virtual | ~SBDAssistant () Destructs the assistant. |
Public Functions inherited from SBCReferenceTarget#
Type | Name |
---|---|
SBCReferenceTarget () |
|
unsigned int | getMemoryFootprint () const |
void | printReferencesToOwners () const |
virtual | ~SBCReferenceTarget () |
Protected Attributes inherited from SBCReferenceTarget#
Type | Name |
---|---|
SBCReferenceTargetData * | dataPointer |
Protected Functions inherited from SBCReferenceTarget#
Type | Name |
---|---|
SBCReferenceTarget (SBCReferenceTargetData * dataPointer) |
|
void | removeAllReferenceOwners () |
Detailed Description#
This class is the base class for assistants
Short name: SBAssistant
Public Functions Documentation#
function SBDAssistant#
Constructs an assistant.
function SB_DECLARE_DATA#
function act#
Executes an action.
virtual SBDAssistantAnswer * SBDAssistant::act (
const std::wstring & question,
const std::wstring & translation
)
function getAnswer#
Returns an answer to a question.
virtual SBDAssistantAnswer * SBDAssistant::getAnswer (
const std::wstring & question,
const std::wstring & translation
)
function getCompletion#
Returns a completion to a single question.
virtual SBDAssistantAnswer * SBDAssistant::getCompletion (
const std::wstring & question,
const std::wstring & translation,
const std::wstring & system,
const std::wstring & queryType
)
function getConversationUUID#
Returns the conversation UUID.
function getGUI#
Returns a pointer to the GUI of the assistant.
function getNSLExpression#
Returns an NSL expression.
virtual SBDAssistantAnswer * SBDAssistant::getNSLExpression (
const std::wstring & question,
const std::wstring & translation
)
function getTranscription#
Returns a transcription for an audio file with file name fileName
and the detectedlanguage
.
virtual std::wstring SBDAssistant::getTranscription (
const std::wstring & fileName,
std::wstring & language
)
function getTranslation#
Returns the translation of text
inlanguage
into English.
virtual std::wstring SBDAssistant::getTranslation (
const std::wstring & text,
const std::wstring & language
)
function getUserUUID#
Returns the user UUID.
function memorize [1/2]#
Memorizes a document.
function memorize [2/2]#
Memorizes a webpage.
virtual SBDAssistantAnswer * SBDAssistant::memorize (
const std::wstring & url,
const std::wstring & include=L"",
const std::wstring & exclude=L""
)
function search#
Performs a search.
virtual SBDAssistantAnswer * SBDAssistant::search (
const std::wstring & question,
const std::wstring & translation
)
function select#
Selects nodes in the document.
virtual SBDAssistantAnswer * SBDAssistant::select (
const std::wstring & question,
const std::wstring & translation
)
function setConversationUUID#
Sets the conversation UUID.
function setGUI#
Sets the pointer to the GUI of the assistant.
function setUserUUID#
Sets the user UUID.
function ~SBDAssistant#
Destructs the assistant.