User Guide
API DOCSVOICE GATEWAYHELPSECURITY
Current Version
Current Version
  • Welcome
  • What's New
  • 🚀GETTING STARTED
    • Login
    • Concepts and Glossary
    • Language Models
      • Syntphony NLP
      • Other NLP and LLM Connectors
      • FAQs
    • Build a Virtual Agent
      • Overview
      • From Scratch
      • By Importing
      • Pre-Built Templates
      • Training task
    • Testing
      • Automated Test
      • Advanced Request
      • Simulate Dialog
      • View Logs
    • Create and manage profiles
  • 💬BUILD DIALOGS
    • Flows
    • Dialog Cells
      • Intent
      • Entity
      • Answer
      • Input
      • Jump
      • End
      • Service
      • Rest Connector
      • Code
      • Rule
        • Variable answers using Code and Rule cells
        • Enable and disable flows using Rule Cells
    • Data Masking of Personal Identificable Information
    • Dynamic Content and Contexts
    • Voice Agent
    • Multilingual Agent (beta)
  • ✨GENERATIVE AI
    • AI features
    • Assist Answer (beta)
    • Examples Generator
    • Knowledge AI
    • Prompt cell
      • Prompt crafting
      • Practical examples
    • Rephrase Answer
    • Zero-Shot LLM
  • 🌐CHANNELS
    • Channels
      • WhatsApp (by Infobip)
      • Facebook Messenger
      • Microsoft Teams
      • Integrating Existing Channels
    • Webchat Plugin
  • ⚙️CONFIGURATIONS
    • Parameters
    • Advanced Resources
    • Other Options
      • Intent Navigator
  • 📊ANALYTICS & INSIGHTS
    • Dashboards
      • Overview
      • Funnel charts
      • User messages
      • Conversations
      • Reports
    • External Analytics Platforms
  • API DOCS
    • Overview
    • API Guidelines
      • Conversation API
      • Cloner API
      • EVG Connector
      • Management API
        • Admin API
          • Bot Admin
          • Environment
          • Organization
          • User
          • Notification
        • Instance API
          • Knowledge AI
          • Knowledge AI NLP
          • Answer
          • Automated Tests
          • Bot
          • Broker
          • Channel
          • Dashboard
          • Dialog Manager
          • Entity
          • Generative Service
          • Intent
          • Parameters
          • Tag
          • Technical Log
          • Training
          • Transactional Service
          • Rest Connector
          • Wait Input
          • Websnippet
      • Webhooks
    • Infrastructure Guidelines
      • Syntphony CAI server Installation guide
      • Maintenance Methods
      • Supported/verified third-party software
    • Data Structure
      • Admin Data Structure
      • Environment Data Structure
    • Voice Gateway
      • Genesys Cloud CX
Powered by GitBook
On this page
  • Access to the database
  • Decentralized Data
  • Finding usage data

Was this helpful?

  1. API DOCS

Data Structure

This section covers information needed to understand Syntphony CAI's data structure and how to extract useful data. Data is split between distinct schemas: 2 in admin and 1 in environment.

PreviousSupported/verified third-party softwareNextAdmin Data Structure

Last updated 8 months ago

Was this helpful?

Access to the database

Important:

The datebase access has to be given by your Syntphony CAI's deploy administrator.

How to start MySQL 5.7:

​​

Important:

The database access can be concurrent with the virtual agent use. Check with the system administrator the best time to extract data.

Decentralized Data

Syntphony CAI's 4.0.0 data structure now features data granularization on a deeper level than our previous iterations. Our admin databases contain configurations and setup, while the environment database stores the virtual agent's configurations and usage data.

  • The Admin database is responsible for:

    • Admin schema: All user-related structures, bot indexing, information regarding organizations and environments, and file management.

    • Configurations schema: All config-server and environment data setup.

    • Keycloak schema: Used by keycloak, it contain it's default Structure.

    • Honeypot Schema: An empty mirror of the instance's schema data structure.

  • The Environment database is responsible for:

    • Environment schemas: The full information from all content registered under that given environment.

Finding usage data

Different kinds of reports can be created from the information available in Syntphony CAI’s database, such as information on usage, volume, evolution in accesses and customer satisfaction.

All conversation and usage data are found in your environment database. If you desire to collect data from distinct environments, you will require multiple queries.

In order to extract data usage information from Syntphony CAI, three main tables must be understood:

They, along with all of Syntphony CAI's environment data may be found in the page.

https://dev.mysql.com/doc/refman/5.7/en/tutorial.html
Environment Data Structure
Session
User Interaction
Satisfaction