Skip to content

Overview

Initializing search

cognigy/documentation

AI
Voice Gateway
Webchat
xApps
AI Copilot
Live Agent
Insights
Support
Release Notes

cognigy/documentation

AI
AI
- 👋 Overview
  👋 Overview
  - What's Cognigy.AI?
  - Cognigy's AI Workforce
  - Key Features
  - Getting Started
    Getting Started
    
    Build Your Digital AI Agent in Minutes
    
    Build Your Voice AI Agent in Minutes
  - Glossary
- 🛠️ Build
  🛠️ Build
  - Chat and Voice AI Agents
  - Projects
  - Flows
  - Nodes
    Nodes
    
    Overview
    
    Node Search
    
    Channels
  - Node Reference
    Node Reference
    
    Overview
    
    Basic
    Basic
    
    Basic Nodes
    
    Say
    
    Question
    
    Optional Question
    
    Send Text
    
    Debug Message
    
    Code
    Code
    
    Code
    
    Actions
    
    Modules
    
    Channel Output
    
    AI Default Channel Formats
    
    Analytics data
    
    Logic
    Logic
    
    Logic Nodes
    
    Add To Context
    
    Execute Flow
    
    Go To
    
    If
    
    Interval
    
    Lookup
    
    Once
    
    Remove From Context
    
    Reset State
    
    Set State
    
    Stop and Return
    
    Switch Locale
    
    Sleep
    
    Think
    
    Wait for Input
    
    Voice
    Voice
    
    Voice Nodes
    
    Generic Voice Nodes
    Generic Voice Nodes
    
    Generic Voice Nodes
    
    Barge In - Config
    
    Continuous ASR - Config
    
    DTMF Collect - Config
    
    Hang Up
    
    Mute Speech Input
    
    Play URL
    
    Send Metadata
    
    Session Speech Parameters - Config
    
    Transfer
    
    User Input Timeout - Config
    
    Voice Gateway
    Voice Gateway
    
    Voice Gateway Nodes
    
    Call Recording
    
    DTMF
    
    Hang Up
    
    Mute Speech Input
    
    Parameter Details
    
    Play
    
    Send Metadata
    
    Set Session Config
    
    Transfer
    
    AudioCodes
    AudioCodes
    
    AudioCodes Nodes
    
    Call Recording
    
    Hang Up
    
    Play URL
    
    Send Meta Data
    
    Send Message
    
    Set Session Parameters
    
    Transfer
    
    Analytics
    Analytics
    
    Analytics Nodes
    
    Activate Profile
    
    Blind Mode
    
    Complete Goal
    
    Deactivate Profile
    
    Delete Profile
    
    Merge Profile
    
    Overwrite Analytics
    
    Request Rating
    
    Set Rating
    
    Update Profile
    
    Service
    Service
    
    Service Nodes
    
    Check Agent Availability
    
    Close Handover
    
    GPT Conversation
    
    Handover to Agent
    
    HTTP Request
    
    LLM Prompt
    
    Mongo DB
    
    MS SQL
    
    Set Handover Inactivity
    
    Trigger Function
    
    NLU
    NLU
    
    NLU Nodes
    
    Add Lexicon Keyphrase
    
    Clean Text
    
    Copy Slots to Context
    
    Disable Slot Fillers
    
    Enable Slot Fillers
    
    Execute Cognigy NLU
    
    Fuzzy Search
    
    Match Pattern
    
    Regex Slot Filler
    
    Data
    Data
    
    Data Nodes
    
    Datepicker
    
    Send SMTP Email
    
    Email Notification
    
    AI Copilot
    AI Copilot
    
    AI Copilot Nodes
    
    Copilot: Adaptive Card Tile
    
    Copilot: HTML Tile
    
    Copilot: IFrame Tile
    
    Copilot: Identity Tile
    
    Copilot: Knowledge Tile
    
    Copilot: Next Action Tile
    
    Copilot: Sentiment Tile
    
    Copilot: Set Grid
    
    Copilot: Transcript Tile
    
    xApps
    xApps
    
    xApp Nodes
    
    xApp: Init Session
    
    xApp: Get Session PIN
    
    xApp: Show Adaptive Card
    
    xApp: Show HTML
    
    Other Nodes
    Other Nodes
    
    Other Nodes
    
    Knowledge Search
    
    LLM Entity Extract
    
    Log Message
    
    Search Extract Output
    
    Set Translation
  - CognigyScript
  - Tokens
  - Translation and Localization
    Translation and Localization
    
    Auto-Translation
    
    Real-Time Translation
    
    Localization
  - Connections
  - Extensions
  - Packages
  - Functions
- ✨ Empower
  ✨ Empower
  - Natural Language Understanding
    Natural Language Understanding
    
    Overview
    
    Intents
    Intents
    
    Machine learning Intents
    
    Annotations
    
    Intent Conditions
    
    Intent Analyzer
    
    Intent Hierarchy
    
    Intent Mapping Priority
    
    Intent Upload and Download Formats
    
    Reject Intents
    
    Rule Intents
    
    Trigger Intent
    
    Yes/No Intents (Beta)
    
    Slots and Lexicons
    Slots and Lexicons
    
    Lexicons
    
    Slots
    
    Any Slots
    
    Slot Fillers
    
    Text Cleaner
    
    External NLU
    External NLU
    
    External NLU
    
    No NLU
    
    NLU Connectors
    
    Intent Recognition with External Embedding Model
    
    LLM-Based Intent Reranking
    
    NLU Transformers
    
    NLU Attachments
    NLU Attachments
    
    Attached Flow
    
    Attached Lexicon
    
    Attachments
    
    Other
    Other
    
    Language Support
    
    NLU Warnings
  - Large Language Models
  - Generative AI
  - Knowledge AI
    Knowledge AI
    
    Overview
    
    Activate Knowledge AI
    
    Text Formats
    Text Formats
    
    Cognigy Text Format
    
    PDF
    
    Web Page
    
    Text Extraction
    Text Extraction
    
    Overview
    
    Text Extraction with the Basic Parser
    
    Text Extraction with the Advanced Parser
    
    Text Extraction with Azure AI Document Intelligence
    
    Knowledge Source Tags
    
    Migration from Weaviate to Qdrant: Distance Value Change
- 🧪 Test and Debug
  🧪 Test and Debug
  - Interaction Panel
    Interaction Panel
    
    Interaction Panel
    
    Context
    
    Input
    
    Profile
    
    State
  - Demo Webchat
  - Logs
  - Playbooks
  - Voice Preview
- 🚀 Deploy
  🚀 Deploy
  - Endpoints
    Endpoints
    
    Overview
    
    Data Protection and Analytics
    
    Session Management
    
    Handover Settings
    
    Real-Time Translation Settings
    
    File Storage
    
    Content Conversion
    
    Testing Mode for Endpoints
    
    Inject & Notify
    
    Transformers
    Transformers
    
    Overview
    
    Input Transformer
    
    Output Transformer
    
    Execution Finished Transformer
    
    Notify Transformer
    
    Inject Transformer
  - Endpoint Reference
    Endpoint Reference
    
    Overview
    
    8x8
    
    Amazon Alexa
    
    Amazon Lex
    
    AudioCodes
    
    Avaya CPaaS
    
    Azure Bot Services
    
    Bandwidth
    
    Dialogflow
    
    Facebook (Meta) Messenger
    
    Genesys
    
    Intercom
    
    LINE Messenger
    
    Microsoft Teams
    
    NICE CXone
    
    REST
    
    RingCentral Engage
    
    Socket.io
    
    Slack
    
    Sunshine Conversations
    
    Twilio
    
    Userlike
    
    Voice Copilot
    
    Cognigy Voice Gateway
    
    Webchat
    
    Webhook
    
    WhatsApp
    
    Workplace by Facebook (Meta)
  - Snapshots
- 🤖 Train
  🤖 Train
  - Intent Trainer
- 📊 Analyze
  📊 Analyze
  - Overview
  - Collecting Data
    Collecting Data
    
    Overview
    
    User and Session Identification
  - Insights
  - OData
  - Call Tracing
  - Contact Profiles
- ☎️ Escalate
  ☎️ Escalate
  - Handovers
  - Handover Reference
    Handover Reference
    
    Overview
    
    Cognigy Live Agent
    
    Chatwoot
    
    RingCentral Engage
    
    Salesforce Service Cloud
    
    Genesys Cloud Guest Chat
    
    Genesys Cloud Open Messaging
    
    8x8
  - Handover Features
    Handover Features
    
    User Inactivity Detection and Handling
  - AI Copilot
- ⚙️ Administer
  ⚙️ Administer
  - User Menu
    User Menu
    
    Overview
    
    My Profile
    
    Hotkeys
  - Access Management
    Access Management
    
    Organizations and Users
    Organizations and Users
    
    Admin Center
    
    Access Control
    
    Project and Members
    Project and Members
    
    Project Settings
    
    Members
    
    Management UI
  - Quotas and Limits
  - Audit Events
  - Billing
- 👩‍💻 Developer Reference
  👩‍💻 Developer Reference
- 🖥️ Install, Configure, and Migrate
  🖥️ Install, Configure, and Migrate
  - Overview
  - Browser Requirements
  - Architecture
  - On-Premises
    On-Premises
    
    Overview
    
    Version Compatibility Matrix
    
    Prerequisites
    
    Pre-installation Checklist
    
    Installation Process
    
    Reset Initial Credentials
    
    Backups
    
    Upgrade and Migration Guides
    Upgrade and Migration Guides
    
    Upgrade and Migration Guides
    
    MongoDB: Single to Multi Replica
    
    Kustomize to Helm
    
    Amazon EFC Provisioner to EFC CSI
    
    Azure File Provisioner to Azure CSI
    
    Cognigy NLU: V1 to V2
    
    Redis: Single Replica to Redis HA Migration
    
    Weaviate Upgrade to v1.22.5
    
    Weaviate to Qdrant
  - SaaS
    SaaS
    
    Cognigy SaaS Service Health
    
    IP Ranges Shared Environments
  - Single Sign-On (SSO)
    Single Sign-On (SSO)
    
    Cognigy.AI Sign-in and Sign-out
    
    Single Sign-on using SAML 2.0
    
    Single Sign-on using OpenID Connect
Voice Gateway
Voice Gateway
- 👋 Overview
  👋 Overview
- 🛠️ Self-Service Portal
  🛠️ Self-Service Portal
  - Overview
  - Users
  - Accounts
  - Applications
  - Recent Calls
  - Alerts
  - Carriers
  - Speech Services
    Speech Services
    
    Speech Services
    
    Streaming
  - Phone Numbers
  - Outbound Call Routing
- 📞 Outbound Calls
  📞 Outbound Calls
  - Create Outbound Calls
- 📚 References
  📚 References
  - Voice Gateway Verbs
    Voice Gateway Verbs
    
    Voice Gateway Verbs
    
    Answering Machine Detection (AMD)
    
    Config
    
    Dial
    
    Dub
    
    DTMF
    
    Gather
    
    Hangup
    
    Listen
    
    Play
    
    Say
    
    SIP:refer
    
    SIP:request
    
    Transcribe
  - Voice Gateway Events
    Voice Gateway Events
    
    Overview
    
    ANSWERING_MACHINE_DETECTION
    
    CALL_CREATED
    
    CALL_COMPLETED
    
    CALL_FAILED
    
    CALL_RECONNECTED
    
    RECOGNIZED_DTMF
    
    RECOGNIZED_SPEECH
    
    TRANSFER_DIAL_ERROR
    
    TRANSFER_DIAL_SUCCESS
    
    TRANSFER_REFER_ERROR
    
    TRANSFER_REFER_SUCCESS
    
    USER_BUSY
    
    USER_INPUT_TIMEOUT
    
    NO_ANSWER
  - SIP Response Codes
  - TTS and STT Vendors
  - SIP Trunk Providers
- 🖥️ On-Premises Installation
  🖥️ On-Premises Installation
Webchat
Webchat
- 👋 Overview
  👋 Overview
  - What's Webchat?
  - Getting Started
- 🆕 Webchat v3
  🆕 Webchat v3
  - Overview
  - Supported Browsers
  - Key Features
  - Endpoint Configuration
    Endpoint Configuration
    
    Overview
    
    Collecting Metadata
  - Accessibility
  - Embedding
- 💬 Webchat v2 (Deprecated)
  💬 Webchat v2 (Deprecated)
- 🗂️ Miscellaneous
  🗂️ Miscellaneous
xApps
xApps
- 👋 Overview
  👋 Overview
  - What's xApp?
  - Use Cases
- 🛠️ Build an xApp
  🛠️ Build an xApp
- 🛡️ xApp Security
  🛡️ xApp Security
  - Secure xApps from XSS
- 🗂️ Miscellaneous
  🗂️ Miscellaneous
AI Copilot
AI Copilot
- 👋 Overview
  👋 Overview
  - What's AI Copilot?
  - Getting Started
- 🔗 Integrate, Configure, and Embed
  🔗 Integrate, Configure, and Embed
- 💬 Chat AI Copilot
  💬 Chat AI Copilot
  - AI Copilot for Chat
- 🗣️ Voice AI Copilot
  🗣️ Voice AI Copilot
  - AI Copilot for Voice
  - AI Copilot for Voice: Transfer Node
- 🖥️ On-Premises Installation
  🖥️ On-Premises Installation
  - Overview
  - Browser Requirements
  - Architecture
  - Version Compatibility Matrix
  - Prerequisites
  - Installation Process
  - Upgrade and Migration Guides
    Upgrade and Migration Guides
    
    Upgrade and Migration Guides
    
    Migration Guide: Agent Assist to Cognigy.AI Helm Chart
    
    Migration Guide: DNS Name Change
Live Agent
Live Agent
- 👋 Overview
  👋 Overview
  - What's Live Agent?
  - Getting Started
    Getting Started
    
    Getting Started with Live Agent
    
    Organization Setup
    
    Inbox Setup
    
    Handover Setup
    Handover Setup
    
    Overview
    
    Endpoint Setup
    
    Flow Setup
    
    Add Agents and Admins
    
    Add Another Inbox
  - Glossary
- 💬 Conversations
  💬 Conversations
  - Overview
  - Conversation Assignment
  - Conversation Queue
    Conversation Queue
    
    Overview
    
    Real-Time Queue Notifications
  - Conversation Routing
    Conversation Routing
    
    Overview
    
    Manual Mode
    
    Automatic Mode
  - Send Replies
  - Search and Filter Conversations
  - Other Operations
- 🤖 Assistants
  🤖 Assistants
- 📊 Analytics Tools
  📊 Analytics Tools
  - Reports
    Reports
    
    Overview
    
    Supervisor Report
    
    Administrator Reports
    Administrator Reports
    
    Overview
    
    Conversations
    
    Agents
    
    Labels
    
    Inboxes
    
    Teams
  - Live Agent OData Endpoint
- 🛠️ Settings
  🛠️ Settings
  - Overview
  - Agents
  - Teams
  - Inboxes
  - Labels
  - Skills
  - Automation Rules
  - Canned Responses
  - Attachments
  - Audit Logs
  - Account Settings
- 🔐 Access Management
  🔐 Access Management
  - Roles
- 📨 User Profile and Notifications
  📨 User Profile and Notifications
  - Notifications
  - Profile Settings
- 🖥️ On-Premises Installation
  🖥️ On-Premises Installation
  - Browser Requirements
  - Version Compatibility Matrix
  - Deployment
    Deployment
    
    Architecture
    
    Prerequisites
    
    Installation using Helm
    
    Cognigy Live Agent OAuth
    
    Helm Values
    Helm Values
    
    Helm Values
    
    Database
    
    Redis
    
    Storage
    
    SMTP
    
    Email Templates
  - Installation Updates
  - Upgrade and Migration Guides
    Upgrade and Migration Guides
    
    Overview
    
    Migration guide for Helm dependencies in Live Agent 4.44
    
    Migration guide for Redis Sentinel in Live Agent 4.53
- 🗂️ Miscellaneous
  🗂️ Miscellaneous
  - Questions and Answers
Insights
Insights
- 👋 Overview
  👋 Overview
  - What's Insights?
  - Glossary
- 📊 Dashboards
  📊 Dashboards
- 🔭 Explorers
  🔭 Explorers
- 🔍 Filter and Sort
  🔍 Filter and Sort
  - Global Filters
- 🗓️ Data Management
  🗓️ Data Management
  - Pre-Aggregation
    Pre-Aggregation
    
    Data Pre-Aggregation
    
    Time Zone with Pre-Aggregation
  - Time Zone
  - Data Expiration
- ⬇️ Download Reports
  ⬇️ Download Reports
  - Download Reports in CSV
Support
Support
- Technical Support
Release Notes
Release Notes
- Deprecations and Removals
- 📦 Product Versions
  📦 Product Versions
  - 4.8x
    4.8x
    
    4.87 (latest)
    
    4.86
    
    4.85
    
    4.84
    
    4.83
    
    4.82
    
    4.81
    
    4.80
  - 4.7x
    4.7x
    
    4.79
    
    4.78
    
    4.77
    
    4.76
    
    4.75
    
    4.74
    
    4.73
    
    4.72
    
    4.71
    
    4.70
  - 4.6x
    4.6x
    
    4.69
    
    4.68
    
    4.67
    
    4.66
    
    4.65
    
    4.64
    
    4.63
    
    4.62
    
    4.61
    
    4.60
  - 4.5x
    4.5x
    
    4.59
    
    4.58
    
    4.57
    
    4.56
    
    4.55
    
    4.54
    
    4.53
    
    4.52
    
    4.51
    
    4.50
  - 4.4x
    4.4x
    
    4.49
    
    4.48
    
    4.47
    
    4.46
    
    4.45
    
    4.44
    
    4.43
    
    4.42
    
    4.41
    
    4.40
  - 4.3x
    4.3x
    
    4.39
    
    4.38
    
    4.37
    
    4.36
    
    4.35
    
    4.34
    
    4.33
    
    4.32
    
    4.31
    
    4.30
- 📜 Earlier Product Versions
  📜 Earlier Product Versions

Migration Guides¶

Migration guide for Helm dependencies in Live Agent 4.44
Migration guide for Redis Sentinel in Live Agent 4.53

Copyright © 2024 Cognigy GmbH

Cookie consent

We use cookies to recognize your repeated visits and preferences, as well as to measure the effectiveness of our documentation and whether users find what they're searching for. With your consent, you're helping us to make our documentation better. To find out more about the cookies we use, see our Privacy Policy

Google Analytics
GitHub

Manage settings