Class OscovaBot
Inheritance
System.Object
OscovaBot
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Assembly: Syn.Bot.dll
Syntax
public sealed class OscovaBot : IBotWithSettings<BotUser>, IBot
Constructors
OscovaBot()
Declaration
OscovaBot(BotConfiguration)
Declaration
public OscovaBot(BotConfiguration configuration)
Parameters
Properties
Actions
Declaration
public IntentActionCollection Actions { get; }
Property Value
Configuration
Declaration
public BotConfiguration Configuration { get; }
Property Value
Cryptographer
Declaration
public ICryptographer Cryptographer { get; set; }
Property Value
DateTime
Declaration
public DateTime DateTime { get; }
Property Value
Type |
Description |
System.DateTime |
|
DefaultUserSettings
Declaration
public UserSettings DefaultUserSettings { get; }
Property Value
Dialogs
Declaration
public DialogCollection Dialogs { get; }
Property Value
ID
Declaration
public string ID { get; }
Property Value
Type |
Description |
System.String |
|
Instance
Declaration
public static OscovaBot Instance { get; }
Property Value
IsTrained
Declaration
public bool IsTrained { get; }
Property Value
Type |
Description |
System.Boolean |
|
Language
Declaration
public Language Language { get; set; }
Property Value
LastInteractionTime
Declaration
public DateTime LastInteractionTime { get; }
Property Value
Type |
Description |
System.DateTime |
|
LicenseType
Declaration
public static string LicenseType { get; }
Property Value
Type |
Description |
System.String |
|
Logger
Declaration
public static Logger Logger { get; }
Property Value
Type |
Description |
Syn.Utilities.Logging.Logger |
|
MainUser
Declaration
public BotUser MainUser { get; }
Property Value
Plugins
Declaration
public OscovaPluginCollection Plugins { get; }
Property Value
Recognizers
Declaration
public RecognizerCollection Recognizers { get; }
Property Value
ScoreEngine
Declaration
public IScoreEngine ScoreEngine { get; set; }
Property Value
ScriptEngines
Declaration
public ScriptEngineCollection ScriptEngines { get; }
Property Value
Settings
Declaration
public BotSettings Settings { get; }
Property Value
SimlInterpreter
Declaration
public SimlModernInterpreter SimlInterpreter { get; }
Property Value
Stats
Declaration
public BotStats Stats { get; }
Property Value
Timer
Declaration
public Timer Timer { get; }
Property Value
Type |
Description |
System.Timers.Timer |
|
Trainer
Declaration
public Trainer Trainer { get; }
Property Value
Users
Declaration
public BotUserCollection Users { get; }
Property Value
Version
Declaration
public static string Version { get; }
Property Value
Type |
Description |
System.String |
|
Methods
Activate(String, String, String)
Declaration
[Obsolete("Please use Activate(string licenseKey) method instead. The new licensing system just requires your license key.", false)]
public static void Activate(string licenseType, string licensee, string licenseKey)
Parameters
Type |
Name |
Description |
System.String |
licenseType |
|
System.String |
licensee |
|
System.String |
licenseKey |
|
Activate(String)
Declaration
public static void Activate(string licenseKey)
Parameters
Type |
Name |
Description |
System.String |
licenseKey |
|
CreateCompositeType(String, IEnumerable<String>, Int32)
Declaration
public void CreateCompositeType(string compositeTypeName, IEnumerable<string> childrenTypes, int wordDistance = 2)
Parameters
Type |
Name |
Description |
System.String |
compositeTypeName |
|
System.Collections.Generic.IEnumerable<System.String> |
childrenTypes |
|
System.Int32 |
wordDistance |
|
CreateMainUser(String)
Declaration
public BotUser CreateMainUser(string userId)
Parameters
Type |
Name |
Description |
System.String |
userId |
|
Returns
Declaration
public FunctionalRecognizer CreateRecognizer(string entityType, EntityExtractor extractor)
Parameters
Returns
CreateRecognizer(String, IEnumerable<String>, StringComparer)
Declaration
public EntityRecognizer CreateRecognizer(string entityType, IEnumerable<string> valueList, StringComparer comparer)
Parameters
Type |
Name |
Description |
System.String |
entityType |
|
System.Collections.Generic.IEnumerable<System.String> |
valueList |
|
System.StringComparer |
comparer |
|
Returns
CreateRecognizer(String, IEnumerable<String>)
Declaration
public EntityRecognizer CreateRecognizer(string entityType, IEnumerable<string> valueList)
Parameters
Type |
Name |
Description |
System.String |
entityType |
|
System.Collections.Generic.IEnumerable<System.String> |
valueList |
|
Returns
CreateRecognizer(String, StringComparer)
Declaration
public EntityRecognizer CreateRecognizer(string entityType, StringComparer comparer)
Parameters
Type |
Name |
Description |
System.String |
entityType |
|
System.StringComparer |
comparer |
|
Returns
CreateRecognizer(String, Regex)
Declaration
public RegexRecognizer CreateRecognizer(string entityType, Regex regex)
Parameters
Type |
Name |
Description |
System.String |
entityType |
|
System.Text.RegularExpressions.Regex |
regex |
|
Returns
CreateRecognizer(String)
Declaration
public EntityRecognizer CreateRecognizer(string entityType)
Parameters
Type |
Name |
Description |
System.String |
entityType |
|
Returns
CreateRecognizer<T>(String, StringComparer)
Declaration
public EntityRecognizer CreateRecognizer<T>(string entityType, StringComparer comparer)
where T : struct, IConvertible
Parameters
Type |
Name |
Description |
System.String |
entityType |
|
System.StringComparer |
comparer |
|
Returns
Type Parameters
CreateRecognizer<T>(String)
Declaration
public EntityRecognizer CreateRecognizer<T>(string entityType)
where T : struct, IConvertible
Parameters
Type |
Name |
Description |
System.String |
entityType |
|
Returns
Type Parameters
CreateUser()
Declaration
public BotUser CreateUser()
Returns
CreateUser(String)
Declaration
public BotUser CreateUser(string userId)
Parameters
Type |
Name |
Description |
System.String |
userId |
|
Returns
Evaluate(Request)
Declaration
public EvaluationResult Evaluate(Request request)
Parameters
Type |
Name |
Description |
Request |
request |
|
Returns
Evaluate(String)
Declaration
public EvaluationResult Evaluate(string message)
Parameters
Type |
Name |
Description |
System.String |
message |
|
Returns
Import(IEnumerable<XDocument>)
Declaration
public void Import(IEnumerable<XDocument> simlDocuments)
Parameters
Type |
Name |
Description |
System.Collections.Generic.IEnumerable<System.Xml.Linq.XDocument> |
simlDocuments |
|
Import(XDocument)
Declaration
public void Import(XDocument simlDocument)
Parameters
Type |
Name |
Description |
System.Xml.Linq.XDocument |
simlDocument |
|
ImportAgent(BotProject)
Declaration
public void ImportAgent(BotProject agentProject)
Parameters
ImportAgent(Byte[])
Declaration
public void ImportAgent(byte[] projectFileData)
Parameters
Type |
Name |
Description |
System.Byte[] |
projectFileData |
|
ImportAgent(String)
Declaration
public void ImportAgent(string filePath)
Parameters
Type |
Name |
Description |
System.String |
filePath |
|
Declaration
public void ImportEntitiesFromFile(string fileName, EntityDataFormat dataFormat)
Parameters
ImportEntitiesFromText(String, EntityDataFormat)
Declaration
public void ImportEntitiesFromText(string text, EntityDataFormat dataFormat)
Parameters
ImportFromDirectory(String)
Declaration
public void ImportFromDirectory(string directoryPath)
Parameters
Type |
Name |
Description |
System.String |
directoryPath |
|
Declaration
public void ImportTraitsFromFile(string fileName, TraitDataFormat dataFormat)
Parameters
ImportTraitsFromText(String, TraitDataFormat)
Declaration
public void ImportTraitsFromText(string text, TraitDataFormat dataFormat)
Parameters
ImportWorkspace(OscovaBotNode)
Declaration
[Obsolete("ImportWorkspace is deprecated and will be moved to a \"Legacy\" library in the next version. Please use ImportAgent instead and migrate Oryzer Workspace projects to Oscova Bot Composer.")]
public void ImportWorkspace(OscovaBotNode botNode)
Parameters
ImportWorkspace(WorkspaceGraph)
Declaration
[Obsolete("ImportWorkspace is deprecated and will be moved to a \"Legacy\" library in the next version. Please use ImportAgent instead and migrate Oryzer Workspace projects to Oscova Bot Composer.")]
public void ImportWorkspace(WorkspaceGraph workspace)
Parameters
Type |
Name |
Description |
Syn.Workspace.WorkspaceGraph |
workspace |
|
ImportWorkspace(String)
Declaration
[Obsolete("ImportWorkspace is deprecated and will be moved to a \"Legacy\" library in the next version. Please use ImportAgent instead and migrate Oryzer Workspace projects to Oscova Bot Composer.")]
public void ImportWorkspace(string filePath)
Parameters
Type |
Name |
Description |
System.String |
filePath |
|
Raise(Request)
Declaration
public void Raise(Request request)
Parameters
Type |
Name |
Description |
Request |
request |
|
Raise(String, BotUser)
Declaration
public void Raise(string eventName, BotUser user)
Parameters
Type |
Name |
Description |
System.String |
eventName |
|
BotUser |
user |
|
Raise(String)
Declaration
public void Raise(string eventName)
Parameters
Type |
Name |
Description |
System.String |
eventName |
|
Events
InvokingIntent
Declaration
public event EventHandler<InvokingIntentEventArgs> InvokingIntent
Event Type
TrainingFinished
Declaration
public event EventHandler<TrainingFinishedEventArgs> TrainingFinished
Event Type
TrainingStarted
Declaration
public event EventHandler TrainingStarted
Event Type
Type |
Description |
System.EventHandler |
|
Implements
Extension Methods