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
  • Export virtual agent
  • Import virtual agent
  • Update (Replace) virtual agent

Was this helpful?

  1. GETTING STARTED
  2. Build a Virtual Agent

By Importing

PreviousFrom ScratchNextPre-Built Templates

Last updated 11 months ago

Was this helpful?

Export virtual agent

This feature allows you to export a virtual agent as a ZIP file for backup or to update a version in another environment. To export the virtual agent, click the “Export” option on the popup menu at the main page.

The exported virtual agent carries the entire knowledge base, settings, integrated channels, NLP, and parameters.

Components in the NLP knowledge base will be downloaded as JSON files and the components in the Automated Learning knowledge base as TXT.

If a virtual agent has both knowledge bases, the components will be downloaded in different formats (JSON and TXT) then gathered and compressed into a ZIP file.

Import virtual agent

Click the + button to add a new virtual agent.

You can use the Import option to create a new virtual agent with:

Create a new virtual agent (new ID)

When you create a virtual agent using the new ID option, the imported agent will have a new and unique ID (different from the agent exported from other environment). It will keep all of its data, except third-party integration for channels.

Upload a ZIP file containing JSON files by navigating on your computer.

Create new virtual agent (same ID)

Import with the same ID allows you to move a virtual agent from one environment to another (from dev to prod, for example) while preserving its IDs and integrations on channels of the original agent, as it is in the original environment.

Upload a ZIP file containing JSON files by navigating on your computer.

By choosing this option, you will replace an existing version with a newer one, updating all changes that you may have done, or restoring to a previous version with a backup. The imported virtual agent will overwrite the following data:

  • Name

  • Settings

  • Parameters

  • Channels

  • Flows and Cells

  • Knowledge AI base (documents and questions) - when available

The imported virtual agent will not import the following data:

  • Dialog Manager trainings


  • Automated tests


  • Dashboards

If you want to change the channels after importing it, go to the Channels section where you can add or remove a channel.

Important: If you delete a channel, all aswers attached to it will be automatically deleted.

Update (Replace) virtual agent

Once in the Cockpit, access the popup menu of the virtual agent you want to update. Click the “Update” option on the popup menu at the main page.

Choose Update if you want to replace the current version to:

  • a newer version from a recent export

  • restore a backup version

Instead of importing your ZIP file as a new virtual agent, you may want to just replace the content of a virtual agent and keep the same ID.

The updated virtual agent will overwrite the following data in the existing version:

  • Name

  • Settings

  • Parameters

  • Channels

  • Intents and Entities

  • Answers and Templates

  • Transactional Services

  • Knowledge base (flows and cells)

  • Automated Learning knowledge base (documents and questions), when available

Important

  • When updating a virtual agent, remember to review the webhooks. If you want to keep specific webhooks, edit them in environment parameters.

  • Changes in intents and entities may require a new training

  • It's not possible to update a virtual agent that are from different versions of Syntphony CAI

This action may cause instability and irreversibly compromise the virtual agent if it is imported to a production environment during peak hours. We highly recommend exporting the latest version as a backup.

Reminder: Only admins and supervisors can import a virtual agents. Review the for more information.

This proccess will fail if a virtual agent using the same ID already exists on the environment you're trying to import it. In this case, you may try to it instead.

🚀
New ID
Same ID
update
profiles definitions and permissions
Export your virtual agent by accessing the popup menu