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
  • How to protect users information
  • Entity cells
  • Answer cells
  • Gen AI cell
  • Analytics

Was this helpful?

  1. BUILD DIALOGS

Data Masking of Personal Identificable Information

PreviousEnable and disable flows using Rule CellsNextDynamic Content and Contexts

Last updated 8 months ago

Was this helpful?

Due to the sensitivity of processing Personally Identifiable Information (PII) and Sensitive Personal Information (SPI), it is essential to implement measures that protect it from unauthorized access and misuse, as this data can be used to identify, contact, or locate an individual. Examples include email and home addresses, social security numbers, passport IDs, credit card numbers, medical information, just to name a few.

As of now, masking is only available for virtual agents using Syntphony NLP.

How to protect users information

When data masking is enabled, users can toggle a switch on entity and answer cells to select which data to mask.

During runtime, the platform uses unmasked data for internal processing but displays masked text to maintain security. The "text" field is masked while the unmasked data is stored in the "entity" field, protecting sensitive information. This masking behavior is also applied to generative AI services, where all data is masked by default.

Entity cells

When masking an entity, all values contained within it will be masked. Masking is applied to the cognitive engine, Syntphony CAI's database, logs, dashboards, and dialogue simulator. The value contained in the user's message will be replaced with the entity's name. The rest of the user's interaction is preserved and won't be masked. Masking is available for synonym and pattern entities.

To mask an entity:

  1. Open the modal to create or edit an entity

  2. Activate the toggle the switch as it comes disabled as default

Answer cells

For the virtual agent responses, you can flag answers that need to be masked using the technical field. Additionally, a button will be available to mask transactional answers, with specific provisions for Voice Gateway interactions. In the case of audio inputs requiring masking, a prior indication is necessary to inform users that the next input must be masked, ensuring that no user input records are left unprotected.

Gen AI cell

If $text is used in the Gen AI cell and Rephrasing in the answer, code, rule, and service (webhook and REST connector) cells, the value will be masked.

On the other hand, if $entities['CAR'][0].originalValue is used in the Gen AI cell and Rephrasing in the answer, code, rule, and service (webhook and REST connector) cells, the value will not be masked.

Masking will be applied to the text field throughout the Dialog Manager, while the value in the entity remains stored.

Examples:

  1. Using $text:

Gen AI Cell:

{
  "prompt": "How do I use the $text feature?"
}

Answer/Code/Rule/Service Cell:

{
  "message": "You can use the $text feature by following these steps..."
}

Result: The value of $text will be masked, appearing as *** in the answer.

  1. Using $entities['CAR'][0].originalValue:

Gen AI Cell:

{
  "prompt": "How do I use the $entities['CAR'][0].originalValue feature?"
}

Answer/Code/Rule/Service Cell:

{
  "message": "You can use the $entities['CAR'][0].originalValue feature by following these steps..."
}

Result: The value of $entities['CAR'][0].originalValue will not be masked, appearing as the original value in the answer.

Summary:

  • $text: When using $text, the platform will mask the value to protect sensitive information.

  • $entities['CAR'][0].originalValue: When using $entities['CAR'][0].originalValue, the platform will not mask the value, allowing it to appear as the original value.

By implementing these rules, the platform ensures that sensitive information is appropriately masked or displayed based on the context of its usage. This helps in maintaining data privacy while allowing flexibility in how information is handled within different cells.

Analytics

When masking mode is activated, data won’t be stored in Syntphony CAI nor will it be available in the Dashboards.

In analytics dashboards, masked entity names are displayed to maintain data confidentiality. Once activated, selected values are replaced with *asterisks* at the beginning and end, effectively concealing the actual data.

Masking is applied to all entities, excluding system entities, ensuring comprehensive protection.

Masked answers are displayed with their respective IDs to maintain confidentiality. Again, selected values are replaced with *asterisks*, effectively concealing the actual data.

Logs are masked in the text field to ensure that sensitive information is not exposed. For external services, all generative AI interactions will use masked data by default. In service cells, while text is masked, entities remain unmasked to allow for necessary processing. Zero-shot and few-shot masking follow the same protocols as NLP, as zero-shot classification uses NLP for entity detection.

By implementing these comprehensive masking features, the platform ensures robust protection of PII and SPI, safeguarding user data while maintaining the functionality and usability of the virtual agent and associated services.

πŸ’¬