Environment Data Structure
Each environment has all their data contained within their own, isolated database structure
Last updated
Each environment has all their data contained within their own, isolated database structure
Last updated
The answer table stores the settings for the response that are created in the virtual agent. The answer can be identified by a name (for example “Welcome”), a description and tags related to the answer subject. It also can be configured to be evaluable and/or transactional.
This table is used on Virtual Agents where Automated Learning is not used; if you want the AL's counterpart, go to question.
The answer_template is the content of an answer that was created in either the answer table or the question table, but never in both. Either can have many records in the answer_template table, since each channel that a particular answer is delivered to may have a custom template. The content is the answer that will be sent to the user. For example, the name of the answer is “Welcome” and the content is “Hello, I’m a virtual assistant”
The api_key table stores API keys used to validate Syntphony CAI’s service calls.
The automated_tests stores general information about automated tests. To execute an automated test, the user must fill a spreadsheet and insert it in the Cockpit. Once executed, the results are stored in the automated_tests_execution table.
The automated tests execution table stores the results of an automated tests, by attempt. In previous versions, this data was located within the automated test itself and was overwritten on execution.
An automated_test_utterance is a single instance of exemple provided for an automated test. They belong to automated_tests.
The automated_test_utterance_execution table stores the individual execution results per utterance.
This table stores all information from a virtual agent(VA), internally named bot. There is a homonym table in the admin data structure, which stores the bot's permission access and envorinment relations, while this one stores Cockpit data and it's logical functions.
Bulk trainings contains bulk-inserted intents and utterances. This table refers to the bulk as a whole and it's execution status. Each individual intent and utterance are stored in bulk_training_item.
The bulk_training_item represents one line of a provided file in a bulk_training.
The channel table stores channel data creation. It is possible to identify to which virtual agent the channel is associated, the channel name and type.
The channel_type table stores the types of channels. Within each classification, there are of channels types, such as:
Smart Speakers & Social Robots: Amazon Echo e Google Home
Smart Assistants: Alexa, Cortana e Siri
Messaging Platform: Facebook, Twitter e Skype
Synthetic Reality: ARCore e Samsung Gear VR
Mobile/Tablet/Desktop: Andriod, iOS e Web
Cognitive Contact Center: IVR e VR
The channel_classification table stores the classifications of channels, each one identified by an ID. These groups are:
Smart Speakers & Social Robots
Smart Assistants
Messaging Platform
Synthetic Reality
Mobile/Tablet/Desktop
Cognitive Contact Center
The configuration tables stores environment's configuration keys. Those may be bot-specific, if a bot_uuid is provided, otherwise they behave as global configurations for the whole environment.
The entity table stores configurations for entities created in the virtual agent. An example would be the entity “sport”.
The document table stores documents supplied by a user to properly configure the Automated Learning functionality. This structure stores data regarding a document and their path to your private bucket.
The entity_value table stores the entity content. So, in the entity “sport”, the values would be “football”, “basketball” or “tennis”.
The entity_sample table stores words that has a similar meaning to the entity value. For example, if the entity value is “football”, it could store “soccer” or “association football”.
The entity_system table contains a map of all existing system entities.
The facebook_configuration stores the chat configuration in a Facebook page.
The facebook_user table stores the data of the facebook user who interacted with the virtual agent.
The input table contains possible Wait input cells within a dialog flow and their call to actions.
A map of all existing Input types.
The intents table stores the configuration of intents created in the virtual agent.
To learn more how to use Intents in Syntphony CAI
The nlp_engine stores NLP integration data.
The question table stores questions related to the Automated Learning functionality. It relates to a document in which it should have it's text consulted for replies. This table has fields akin to Answer and is it's counterpart for AL using agents.
The question table stores variables associated to questions. A question may have more than on variable assigned to it. Variables are freeform samples of queries for a question such as "What is a Virtual Agent?" or "Where can i find documentations about Virtual Agents?".
The satisfaction table stores the user's assessment of virtual agent attendance. At the end of the session, the user is asked to evaluate the virtual agent service and comment their experience. This table can generate the following reports:
Satisfaction survey result: shows the result of the satisfaction survey, that allows to analyse the level of user satisfaction with a grading system.
Volume of answer: total amount of responses from the satisfaction survey
Solved questions: number of users who had their questions answered
The session table has all the services made by the virtual agent. No matter how many questions the user has asked during a session, only one record will appear for each session. This table can generate reports such as:
Average daily sessions: how many sessions are run per day.
Volume of session: total sessions. It can be broke down in different time frames, such as month or timeframe/total sessions.
Channel/session evolution: a line graph showing the evolution of the number of sessions, making possible to see if there was a increase or decrease.
The tags table stores the tags created in the virtual agent. Tags helps to identify objects, and they are shared between all objects with same-named tags in a bot.
The tag_uses table stores tag data and which repository it is related to, allowing to identify the tag, repository type and which repository ID the tag is related to. They must connect to an object among entity, answer, intent, service or flow; but may not connect to more than one.
The technical_log table stores technical information from user questions, such as response times and service calls, information about calls and execution errors on a non-volatile fashion. When the response from the Syntphony CAI chat service returns an error, it also sends a UUID for troubleshooting, found within this table.
This table is currently disabled at Syntphony CAI 4.1.0.
The structure is present, but no logs will be registered until further notice.
The training table stores a virtual agent training proccess whenever it is not using Automated Learning. When a user trains a virtual agent in the Cockpit, the ongoing and resulting data are stored in this table.
The training_al table stores a virtual agent training proccess whenever it is using Automated Learning. When a user trains a virtual agent in the Cockpit, the ongoing and resulting data are stored in this table.
The training_al_documents table stores a virtual agent's training proccess detail document-wise, describing each's document's status regarding this one training proccess.
The transactional_service table stores the transactional calls performed during a session. One may identify which service was called and the answer content by the webhook field.
The user_interaction table stores each one of the users interactions, be the question asked or the answer sent by the virtual agent. The interactions between user and virtual agent are stored and identified by the session code. It is also possible to identify whether it was a user or a virtual agent interaction. This table can generate the following reports:
Volume of questions: total amount of questions asked by users
Number of questions per channel: total number of user questions per channel
Question evolution: a graph showing the number of questions from the users evolution.
Average question per user: shows the average number of questions per user.
Top 10 words: ranking with the 10 most typed words by users
The utterances table stores intent examples. When a user creates an intent in the virtual agent, he must add sentences that can appear in a conversation with the virtual agent. Those are these sentences.
This table stores data regarding the 'user' your infobip whatsapp channel is using.
The bot_nlp_engine table stores information connecting a bot to an instance of a chosen nlp_engine.
The nlp_engine_entity_system table connects System Entities to Nlp Engines. When the Cockpit user configures the usage of a System Entity on a given bot, this connection is created. When connected, an System Entity is enabled for the NLP, while it's absence means it is disabled.
Column Name
Data Type
Not Null
Description
uuid
varchar(36)
Yes
UUID representing a. Answer
name
varchar(80)
Yes
Name identifying the Answer title. This name is only visible in the Cockpit.
description
text
No
The Answer's description
evaluable
tinyint(1)
No
Shows if the message can be evaluated by the user
transactional
tinyint(1)
No
Show if the response is transactional
removed
tinyint(1)
Yes
True if the answer was deleted. This may be reverted.
created_at
datetime
No
The date this object was created
updated_at
datetime
No
The date this object was last updated
created_by
varchar(36)
No
UUID representing the user who created this object
updated_by
varchar(36)
No
UUID representing the user who updated this object
bot_uuid
varchar(36)
Yes
ID representing a virtual agent, related to the virtual agent table
webhook
varchar(255)
Yes
API URL that will be called when this response is executed
headers
longtext
No
Freeform headers to configure webhooks.
execution_limit
int(3)
No
An Integer lnumber representing the maximum ammount of times this answer will be presented in sequence. If 0, there is no limit.
Column Name
Data Type
Not Null
Description
uuid
varchar(36)
Yes
UUID representing the answer template
content
text
No
JSON representing the selected template. This JSON can vary depending on what was selected by the user in the Cockpit
answer_uuid
varchar(36)
No
UUID representing the answer this template belongs to. If this field is filled, question_uuid is not.
question_uuid
varchar(36)
No
UUID representing the answer this template belongs to. If this field is filled, answer_uuid is not.
channel_uuid
varchar(36)
No
UUID representing the channel this answer template refers to.
channel_type_id
bigint(20)
No
ID identifying the type of the channel. Those are mapped at the channel_type table.
type
varchar(20)
Yes
The selected template type
removed
tinyint(1)
Yes
True if the answer template was deleted. This may be reverted.
technical_text
text
No
Technical text in JSON format
created_at
datetime
No
The date this object was created
updated_at
datetime
No
The date this object was last updated
created_by
varchar(36)
No
UUID representing the user who created this object
updated_by
varchar(36)
No
UUID representing the user who updated this object
Column Name
Data Type
Not Null
Description
api_key
varchar(50)
Yes
Stores the safety key value
created_date
datetime
Yes
When this key was created
Column Name
Data Type
Not Null
Description
uuid
varchar(36)
Yes
This automated test's UUID
bot_uuid
varchar(36)
Yes
UUID of the bot being tested.
channel_uuid
varchar(36)
Yes
UUID of the channel where the tests will be run.
user_uuid
varchar(36)
Yes
UUId of the user that created this test.
name
varchar(200)
No
The automated test's name
utterances
int(11)
No
Number of examples in the test
removed
tinyint(1)
No
True if the object was deleted. This may be reverted, but the executions will be lost.
created_at
datetime
No
The date this object was created
updated_at
datetime
No
The date this object was last updated
Column Name
Data Type
Not Null
Description
uuid
varchar(36)
Yes
UUID of this execution
automated_test_uuid
varchar(36)
Yes
UUID of the automated test that produced this result
avg_score
decimal(12,10)
Yes
Shows the average confidence level.
precision_score
decimal(12,10)
Yes
Shows the precise confidence level.
status
varchar(10)
Yes
A text status of wether this execution is yet to run, is executing, is finished, etc.
updated_at
datetime
No
The date this object was last updated
Column Name
Data Type
Not Null
Description
uuid
varchar(36)
Yes
ID representing the example
automated_test_
uuid
varchar(36)
No
UUID of the automated test this exampel belongs to
description
text
No
A short description of this example
utterance
text
No
The tested phrase
expected_
category
varchar(200)
No
Category expected to be matched
expected_value
varchar(255)
No
Value expected to be matched
expected_answer
text
No
Textual answer expected to be returned by the VA on this automated_tests channel
removed
tinyint(1)
No
True if the object was deleted. This may be reverted.
created_at
datetime
No
The date this object was created
updated_at
datetime
No
The date this object was last updated
created_by
varchar(36)
No
UUID representing the user who created this object
updated_by
varchar(36)
No
UUID representing the user who updated this object
Column Name
Data Type
Not Null
Description
uuid
varchar(36)
Yes
UUID of this utterance execution
automated_test_utterance_uuid
varchar(36)
Yes
UUID of the automated test's utterance this execution refers to
automated_test_execution_uuid
varchar(36)
Yes
UUID of the automated tests
given_category
varchar(200)
No
Category given on this execution
given_value
text
No
Value given on this execution
given_answer
text
No
Textual answer returned by the VA on this automated_test's channel execution
session_code
varchar(200)
No
UUID of the session code
score
decimal(12,10)
Yes
Score of this execution
proccess_time
int(11)
No
Proccessed time in millis
description
text
No
An optional description.
Column Name
Data Type
Not Null
Description
uuid
varchar(36)
Yes
This bot's UUID
name
varchar(50)
Yes
This bot's Name
locale
varchar(6)
Yes
The main locale used by this bot
description
text
No
A freeform description for this bot
image
mediumblob
No
Stores this bot's image or it's url
image_content_type
varchar(50)
No
The bot's image's content type
bot_analytic_api_key
varchar(50)
No
An API key which allows the bot to be tracked by it
removed
tinyint(1)
No
True if the object was deleted. This may be reverted.
created_at
datetime
No
The date this object was created
updated_at
datetime
No
The date this object was last updated
created_by
varchar(36)
Yes
UUID representing the user who created this object
updated_by
varchar(36)
No
UUID representing the user who updated this object
Column Name
Data Type
Not Null
Description
uuid
varchar(36)
Yes
UUID of this bulk training
bot_uuid
varchar(36)
Yes
UUID from the bot this file was submitted
type
enum('INTENTS','UTTERANCES')
Yes
Type of the bulk insertion, defaulted to INTENTS.
percentage
int(11)
Yes
Active progress for this bulk training's worker
status
enum('PENDING','FINISH','ERROR')
Yes
This bulk training's status.
result
longtext
No
Inserted objects
file_name
text
No
Name of the submitted file.
created_at
datetime
No
The date this object was created
created_by
varchar(36)
No
UUID representing the user who created this object
Column Name
Data Type
Not Null
Description
uuid
varchar(36)
Yes
UUID of this item.
bulk_training_uuid
varchar(36)
Yes
UUID from the bulk training this item refers to
bot_uuid
varchar(36)
Yes
UUID from the bot this bulk training refers to
intent
varchar(255)
Yes
A text containing an intent name
utterance
varchar(1000)
Yes
An example/utterance for the intent above
created_at
datetime
No
The date this object was created
created_by
varchar(36)
No
UUID representing the user who created this object
Column Name
Data Type
Not Null
Description
uuid
varchar(36)
Yes
This channel's UUID
bot_uuid
varchar(36)
Yes
UUID of the bot this channel belongs to.
channel_type_id
bigint(20) unsigned
Yes
ID identifying the channel type, related to the channel_type table
name
varchar(45)
Yes
This channel's name
description
text
No
A freeform description
removed
tinyint(1)
No
True if the object was deleted. This may be reverted.
created_at
datetime
No
The date this object was created
updated_at
datetime
No
The date this object was last updated
created_by
varchar(36)
No
UUID representing the user who created this object
updated_by
varchar(36)
No
UUID representing the user who updated this object
Column Name
Data Type
Not Null
Description
id
bigint(20) unsigned
Yes
ID representing the type of channel
channel_classification_id
bigint(20) unsigned
Yes
ID identifying the channel classification, related to the channel_classification table
name
varchar(50)
Yes
The channel type's name
image
varchar(30)
No
Stores the image that is being used to represent the channel type
created_at
datetime
No
The date this object was created
updated_at
datetime
No
The date this object was last updated
created_by
varchar(36)
No
UUID representing the user who created this object
updated_by
varchar(36)
No
UUID representing the user who updated this object
Column Name
Data Type
Not Null
Description
id
bigint(20) unsigned
Yes
ID representing this channel classification
name
varchar(50)
Yes
Name of this classification
created_at
datetime
No
The date this object was created
updated_at
datetime
No
The date this object was last updated
created_by
varchar(36)
No
UUID representing the user who created this object
updated_by
varchar(36)
No
UUID representing the user who updated this object
Column Name
Data Type
Not Null
Description
uuid
varchar(36)
Yes
UUID representing a custom configuration key
bot_uuid
varchar(36)
No
UUID representing a bot that this configuration reflect, if it's bot-specific.
key
varchar(50)
Yes
The configuration' key
value
varchar(255)
No
The configuration's key value
description
varchar(300)
No
Parameter description
enabled
tinyint(1)
No
True, if this configuration is enabled
eraseable
tinyint(1)
No
True, if this configuration may be fully erased
created_at
datetime
No
The date this object was created
updated_at
datetime
No
The date this object was last updated
created_by
varchar(36)
No
UUID representing the user who created this object
updated_by
varchar(36)
No
UUID representing the user who updated this object
Column Name
Data Type
Not Null
Description
uuid
varchar(36)
Yes
UUID representing the entity
bot_uuid
varchar(36)
Yes
UUID of the VA the entity belongs to
name
varchar(255)
Yes
The entity's name
metadata
varchar(200)
No
Contains the entity's metadata values, related to the VA's NLP if distinct from Syntphony NLP.
enabled
tinyint(1)
No
True, if the object is enabled. This may be reverted.
removed
tinyint(1)
Yes
True if the object was deleted. This may not be reverted.
created_at
datetime
No
The date this object was created
updated_at
datetime
No
The date this object was last updated
created_by
varchar(36)
Yes
UUID representing the user who created this object
updated_by
varchar(36)
No
UUID representing the user who updated this object
Column Name
Data Type
Not Null
Description
uuid
varchar(36)
Yes
UUID representing the document
bot_uuid
varchar(36)
Yes
UUID of the VA the document belongs to
storage_filename
varchar(40)
Yes
Path to this document's file.
training_status
varchar(30)
No
The status of this document regarding it's training proccess
filename
varchar(255)
Yes
Name of the document
enabled
tinyint(1)
No
True, if the object is enabled. This may be reverted.
removed
tinyint(1)
Yes
True if the object was deleted. This may not be reverted.
created_at
datetime
No
The date this object was created
updated_at
datetime
No
The date this object was last updated
created_by
varchar(36)
Yes
UUID representing the user who created this object
updated_by
varchar(36)
No
UUID representing the user who updated this object
Column Name
Data Type
Not Null
Description
uuid
varchar(36)
Yes
UUID of this entity value
entity_uuid
varchar(36)
Yes
UUID of the entity this value belongs to
value
varchar(255)
Yes
The value of this object
type
varchar(20)
Yes
Contains the entity value: Synonym or Pattern
created_at
datetime
No
The date this object was created
updated_at
datetime
No
The date this object was last updated
created_by
varchar(36)
Yes
UUID representing the user who created this object
updated_by
varchar(36)
Yes
UUID representing the user who updated this object
Column Name
Data Type
Not Null
Description
uuid
varchar(36)
Yes
UUID of this sample
entity_value_uuid
varchar(36)
Yes
UUID of the empty value this object is sampling
value
varchar(255)
Yes
The provided synonym or pattern
created_at
datetime
No
The date this object was created
updated_at
datetime
No
The date this object was last updated
created_by
varchar(36)
Yes
UUID representing the user who created this object
updated_by
varchar(36)
Yes
UUID representing the user who updated this object
Column Name
Data Type
Not Null
Description
id
bigint(20)
Yes
This system entity's UUID
name
varchar(255)
Yes
This system entity's name
Column Name
Data Type
Not Null
Description
page_id
varchar(45)
No
The facebook page's ID, identified by it's URL
page_name
varchar(45)
No
The facebook page's name
hub_token
varchar(100)
Yes
Verification code to be used with facebook's webhook
page_access_token
varchar(225)
No
Verification code to validate page access
channel_uuid
varchar(36)
Yes
UUIID representing the channel in the channel table
Column Name
Data Type
Not Null
Description
user_id
varchar(20)
Yes
ID that identifies the facebook user who interacted.
create_date
datetime
No
Record creation date
user_blocked
tinyint(2)
No
Shows if the user is blocked
last_interaction
datetime
No
Shows the user's last interaction date and time
Column Name
Data Type
Not Null
Description
uuid
varchar(36)
Yes
This input's UUID
bot_uuid
varchar(36)
Yes
UUID of the bot the input refers to
type_id
bigint(20)
Yes
This input type ID, refers to the input_type table
description
mediumtext
No
A freeform description
pattern
mediumtext
No
This input's pattern
call_to_action
mediumtext
No
This input's call to action
remember_input
tinyint(4)
No
Wether this input is to be stored
stored
varchar(100)
No
This input's stored value
created_at
datetime
No
The date this object was created
updated_at
datetime
No
The date this object was last updated
created_by
varchar(36)
No
UUID representing the user who created this object
updated_by
varchar(36)
No
UUID representing the user who updated this object
Column Name
Data Type
Not Null
Description
id
bigint(20)
Yes
This type's ID
type
varchar(100)
Yes
This type's name
Column Name
Data Type
Not Null
Description
uuid
varchar(36)
Yes
This Intent's UUID
bot_uuid
varchar(36)
Yes
UUID of the bot this intent belongs to
name
varchar(255)
Yes
The intent's Name
description
text
No
The intent's description
metadata
varchar(200)
No
The intent's metada, present on some NLPs. Absent in Syntphony NLP.
enabled
tinyint(1)
Yes
Wether the intent is enabled
removed
tinyint(1)
Yes
Wether the intent was deleted
created_at
datetime
No
The date this object was created
updated_at
datetime
No
The date this object was last updated
created_by
varchar(36)
No
UUID representing the user who created this object
updated_by
varchar(36)
No
UUID representing the user who updated this object
Column Name
Data Type
Not Null
Description
id
bigint(20) unsigned
Yes
ID representing a cognitive engine
engine
varchar(20)
Yes
Shows the cognitive engine used: Syntphony NLP, DialogFlow, Watson or Luis
metadata
text
Yes
Shows the cognitive engine metada values
created_at
datetime
No
The date this object was last created
updated_at
datetime
No
The date this object was last updated
created_by
varchar(36)
No
UUID representing the user who created this object
updated_by
varchar(36)
No
UUID representing the user who last updated this object
Column Name
Data Type
Not Null
Description
uuid
varchar(36)
Yes
UUID representing the Question
bot_uuid
varchar(36)
Yes
UUID of the VA the Question belongs to
document_uuid
varchar(36)
Yes
UUID of the Document this Question refers to.
name
varchar(255)
No
This Question's name
description
varchar(255)
No
The Answer's description
webhook
varchar(255)
No
API URL that will be called when this response is executed
headers
text
No
Freeform headers to configure webhooks.
transactional
tinyint(1)
No
Show if the response is transactional
evaluable
tinyint(1)
No
Shows if the message can be evaluated by the user
enabled
tinyint(1)
No
True, if the object is enabled. This may be reverted.
removed
tinyint(1)
Yes
True if the object was deleted. This may not be reverted.
created_at
datetime
No
The date this object was created
updated_at
datetime
No
The date this object was last updated
created_by
varchar(36)
Yes
UUID representing the user who created this object
updated_by
varchar(36)
No
UUID representing the user who updated this object
Column Name
Data Type
Not Null
Description
uuid
varchar(36)
Yes
UUID representing the Variable
question_uuid
varchar(36)
Yes
UUID of the Question this variable belongs to
question_variable
varchar(255)
No
The variable itself, coming as a freeform text.
Column Name
Data Type
Not Null
Description
uuid
varchar(36)
Yes
Column identifier
session_code
varchar(50)
Yes
Code representing a session
evaluation
tinyint(4)
Yes
The user's evaluation as a score
answered
tinyint(1)
Yes
Indicates if users had their questions answered
user_comments
varchar(500)
No
Any user written comments
create_date
datetime
Yes
Creation date
Column Name
Data Type
Not Null
Description
session_code
varchar(50)
Yes
UUID/GUID code that represents a user session
create_date
datetime
Yes
Session creation date
expire_date
datetime
No
Session expiration date
business_key
varchar(100)
No
The business key is defined by the customer. It is used to identify the customer. Examples of business key: phone and customer ID.
This field is optional and may have no value.
session_type
varchar(10)
Yes
Shows the session status: created, updated or expired
bot_uuid
varchar(36)
Yes
UUID of the bot this session is running on
channel_uuid
varchar(36)
No
UUID of the channel this session is running on
operating_system
varchar(20)
No
Identifies the operating system
operating_system_version
varchar(30)
No
Identifies the operating system version
browser
varchar(50)
No
Shows the used browser
browser_version
varchar(30)
No
Shows the used browser version
user_ref
varchar(50)
Yes
User reference, shows where the user accessed from. This value is dependent on the channel being used, for example: WEB uses IP, IVR uses the customer`s contact phone and Facebook uses facebook user ID
locale
varchar(6)
No
Identifies the language and country
test
tinyint(1)
Yes
Informs if the sessions is an automated test request or if it is from the user.
Column Name
Data Type
Not Null
Description
uuid
varchar(36)
Yes
The tag's UUID
bot_uuid
varchar(36)
Yes
UUID of the bot containing this bot
name
varchar(80)
Yes
The tag's name
created_at
datetime
No
The date this object was created
updated_at
datetime
No
The date this object was last updated
Column Name
Data Type
Not Null
Description
id
bigint(20)
Yes
This tag uses's ID
tag_uuid
varchar(36)
Yes
UUID of the tag this connection represents
tag_type_id
int(11)
Yes
ID identifying the type of tag according to the element that contains it, where:
1 - Intent 2 - Entity 3 - Answer 4 - Flow 5 - Prototype 6 - Service 7 - Question 8 - Rest Connector 9 - Generative Service 10 - Document
answer_uuid
varchar(36)
No
UUID of an answer, if the connected object is an answer. Otherwise always empty.
entity_uuid
varchar(36)
No
UUID of an entity, if the connected object is an entity. Otherwise always empty.
flow_uuid
varchar(36)
No
UUID of a flow, if the connected object is a flow. Otherwise always empty.
intent_uuid
varchar(36)
No
UUID of an intent, if the connected object is an intent. Otherwise always empty.
question_uuid
varchar(36)
No
Unused in version 4.0.0
service_uuid
varchar(36)
No
UUID of a service, if the connected object is a service. Otherwise always empty.
created_at
datetime
No
The date this object was created
updated_at
datetime
No
The date this object was last updated
Column Name
Data Type
Not Null
Description
id
bigint(20)
Yes
ID that identifies a log
session_code
varchar(50)
No
Code representing a session. May be absent if the log does not refer to a conversation.
log_code
varchar(50)
Yes
Log code that is returned by Syntphony CAI when an error is generated. This field is also outputted by the console logs.
This field may be used to search and the troubleshoot issues.
type
tinyint(4)
Yes
Indicates wether this log represents an error, a warning or an information.
0 = error
1 = warning
2 = information
message
text
No
The log's message
stacktrace
varchar(1000)
No
Contains a stacktrace if this log was that of an error
module_type
varchar(50)
Yes
Represents which architecture module generated the log
create_date
datetime
Yes
The date this object was created
processing_time
int(11)
No
Processing time in milliseconds
Column Name
Data Type
Not Null
Description
uuid
varchar(36)
Yes
This training's UUID
version
varchar(5)
Yes
Indicates how many times this virtual agent was trained, using a version number
status
varchar(40)
Yes
Shows the training status, where:
1 – training 2 – ready 3 – error
user_uuid
varchar(36)
Yes
UUID of the user responsible for starting this training proccess
accuracy
tinyin(4)
Yes
The training accuracy value
bot_uuid
varchar(36)
Yes
UUID of the virtual agent this training is running to
updatedAt
datetime
No
The date this object was last updated
error_msg
varchar(255)
No
Stores any error message that may be prompted for the Cockpit administrator
Column Name
Data Type
Not Null
Description
uuid
varchar(36)
Yes
This training's UUID
bot_uuid
varchar(36)
Yes
UUID of the virtual agent this training is running to
user_uuid
varchar(36)
Yes
UUID of the user responsible for starting this training proccess
version
varchar(5)
Yes
Indicates how many times this virtual agent was trained, using a version number
status_document
varchar(40)
Yes
Shows the training status regarding docs, where:
1 – training 2 – ready 3 – error 4 – forbidden 5 – partial
status_faq
varchar(40)
Yes
Shows the training status regarding FAQs, where:
1 – training 2 – ready 3 – error
error_document
varchar(255)
No
Stores any error message that may be prompted for the Cockpit administrator regarding documents
error_faq
varchar(255)
No
Stores any error message that may be prompted for the Cockpit administrator regarding FAQs
updatedAt
datetime
No
The date this object was last updated
Column Name
Data Type
Not Null
Description
uuid
varchar(36)
Yes
This relationship's UUID
training_al_uuid
varchar(36)
Yes
UUID of a training_al this status refers to.
document_uuid
varchar(36)
Yes
UUID of the document this status refers to.
document_training_status
varchar(30)
No
Shows the training status, where:
1 – training 2 – ready 3 – error 4 – forbidden
error_document
tinyin(255)
No
The training accuracy value
Column Name
Data Type
Not Null
Description
uuid
varchar(36)
Yes
The Transactional Service's UUID
bot_uuid
varchar(36)
Yes
UUID representing of the bot containing this Transactional Service
name
varchar(50)
Yes
Service call name
webhook
text
Yes
API URL to be called
content
text
Yes
Content that will be used in the transactional call
headers
longtext
No
Any Headers required to be used in the API call
description
text
No
A service call description
removed
tinyint(1)
No
True if this transaction service was deleted.
created_at
datetime
No
The date this object was created
updated_at
datetime
No
The date this object was last updated
created_by
varchar(36)
No
UUID representing the user who created this object
updated_by
varchar(36)
No
UUID representing the user who last updated this object
Column Name
Data Type
Not Null
Description
uuid
varchar(36)
Yes
UUID identifying the interaction between virtual agent and user
create_date
datetime
Yes
The date this object was created
session_code
varchar(50)
Yes
Code representing a session
user_sent
tinyint(4)
Yes
Identifies if this interaction is a user message
answer_uuid
varchar(36)
No
UUID of the delivered answer that prompted the interaction.
question_uuid
varchar(36)
No
Unused in Syntphony CAI 4.0.0
text
text
No
Shows the conversation content
confidence
decimal(12,10)
No
Shows the level of confidence returned by the NLP
user_sent_uuid
varchar(36)
No
Identifies to which user UUID the response was sent. It is related to the UUID column on the user_interaction table. When a response is sent to the user, this field will be filled with the question that generated the response.
evaluation
tinyint(1)
No
Deprecated in Syntphony CAI 4.0.0, will be removed in the future. Refer to Satisfaction instead.
entities
varchar(200)
No
Names of the entities that were identified, separated by commas (i.e "entityName1,entityName2")
intent
varchar(100)
No
Name of the intent that was identified
Column Name
Data Type
Not Null
Description
uuid
varchar(36)
Yes
The Utterance's UUID
intent_uuid
varchar(36)
Yes
UUID of the intent this utterance is exemplifying
bot_uuid
varchar(36)
Yes
UUID of the bot this utterance belongs to
example
varchar(1000)
Yes
The exemple's text
metadata
varchar(100)
No
Metadata present in fomr NLP imported utterances. Empty on Syntphony CAI NLPs.
created_at
datetime
No
The date this object was created
updated_at
datetime
No
The date this object was last updated
created_by
varchar(36)
No
UUID representing the user who created this object
updated_by
varchar(36)
No
UUID representing the user who updated this object
Column Name
Data Type
Not Null
Description
phone number
bigint(15)
Yes
The Phone number to be used
create_date
datetime
No
The date this object was created
scenario_key
varchar(100)
No
Your whatsapp scenario key.
Column Name
Data Type
Not Null
Description
bot_uuid
varchar(36)
Yes
The VA's UUID
nlp_engine_uuid
varchar(36)
Yes
The engine's UUID
created_at
datetime
No
The date this object was created
updated_at
datetime
No
The date this object was last updated
created_by
varchar(36)
No
UUID representing the user who created this object
updated_by
varchar(36)
No
UUID representing the user who updated this object
Column Name
Data Type
Not Null
Description
nlp_engine_id
bigint(20) unsigned
Yes
The NLP Engine's ID
entity_system_id
bigint(20)
Yes
The System Entity's ID