vsdk  9.1.0
Vsdk::Nlu Namespace Reference

Classes

class  Engine
 Responsible for creation of Parser instances. More...
 
struct  Entity
 
struct  Intent
 
class  Parser
 Process text into intent and entities using Natural Language Understanding techniques. More...
 
struct  Result
 

Typedefs

using EnginePtr = std::shared_ptr< Engine >
 
using ParserPtr = std::shared_ptr< Parser >
 
using EntityVector = std::vector< Entity >
 

Enumerations

enum  ParserEventCode
 
enum  ParserErrorCode { ParserErrorCode::UNEXPECTED_ERROR, ParserErrorCode::ALREADY_IN_PROGRESS }
 

Functions

void to_json (nlohmann::json &j, Intent const &intent)
 Serializes an Intent to a JSON format. More...
 
void to_json (nlohmann::json &j, Entity const &entity)
 Serializes an Entity to a JSON format. More...
 
void to_json (nlohmann::json &j, Result const &result)
 Serializes a Result to a JSON format. More...
 
void from_json (nlohmann::json const &j, Intent &intent)
 Deserializes an Intent from a JSON format. More...
 
void from_json (nlohmann::json const &j, Entity &entity)
 Deserializes an Entity from a JSON format. More...
 
void from_json (nlohmann::json const &j, Result &result)
 Deserializes a Result from a JSON format. More...
 

Typedef Documentation

◆ EnginePtr

using Vsdk::Nlu::EnginePtr = typedef std::shared_ptr<Engine>

◆ ParserPtr

using Vsdk::Nlu::ParserPtr = typedef std::shared_ptr<Parser>

◆ EntityVector

using Vsdk::Nlu::EntityVector = typedef std::vector<Entity>

Enumeration Type Documentation

◆ ParserEventCode

◆ ParserErrorCode

Enumerator
UNEXPECTED_ERROR 

Something unexpected happened, check the message for more info.

ALREADY_IN_PROGRESS 

An operation is already in progress.

Function Documentation

◆ to_json() [1/3]

void Vsdk::Nlu::to_json ( nlohmann::json &  j,
Intent const &  intent 
)

Serializes an Intent to a JSON format.

◆ to_json() [2/3]

void Vsdk::Nlu::to_json ( nlohmann::json &  j,
Entity const &  entity 
)

Serializes an Entity to a JSON format.

◆ to_json() [3/3]

void Vsdk::Nlu::to_json ( nlohmann::json &  j,
Result const &  result 
)

Serializes a Result to a JSON format.

◆ from_json() [1/3]

void Vsdk::Nlu::from_json ( nlohmann::json const &  j,
Intent intent 
)

Deserializes an Intent from a JSON format.

◆ from_json() [2/3]

void Vsdk::Nlu::from_json ( nlohmann::json const &  j,
Entity entity 
)

Deserializes an Entity from a JSON format.

◆ from_json() [3/3]

void Vsdk::Nlu::from_json ( nlohmann::json const &  j,
Result result 
)

Deserializes a Result from a JSON format.