Skip to content

Node Reference

Nodes are fundamental building blocks that are used to construct Flows and define the logic of virtual agents. Each Node represents a specific action, decision point, or interaction within the Flow. Users can create, configure, and connect Nodes to design complex conversational experiences.

Node Categories:

If you want to create a custom Node, go to the Extensions section.

Note that Nodes in the Cognigy.AI interface can belong to multiple categories for easy navigation. For example, the Code Node is in Basic and Data categories, the MongoDB Nodes are in Service and Data, and the Look up Node is in Logic and Basic. In the Node reference below, each Node is assigned to a single category to avoid duplicates in descriptions.

Basic Nodes

Basic Nodes are commonly used in basic conversational Flows. Included are typical Nodes like the Say Node, the Question Node.

Say

This Node can be used to send a message to the user on their current channel.

Question

This Node can be used to ask the user a question. When triggered, the Entry Point will shift to this Node so that the conversation can continue when the user answers, and a new Input object is generated. By default, the Entry Point will remain at this Node until a valid answer is found.

Optional Question

This Node works similar to the Question Node, except that the Entry Point is optional by default.

Send Text

This Node outputs simple text.

Code Node

This Node enables the execution of custom JavaScript or TypeScript code within the Flow. The editor has full IntelliSense and exposes all Cognigy objects and actions. For better performance, the TypeScript code will be transpiled when the Node is saved. If the transpilation fails, the code will be saved, and an error icon will appear in the top right corner of the Code Node, indicating that there is a potential issue with the code.

Logic Nodes

Logic Nodes can be used to execute a certain logic in the Flow. They include classical conditions, as well as specific Flow behavior like waiting for a user input.

Add To Context

This Node is used to store information in the Cognigy Context, so that it can be used throughout the session on subsequent user inputs.

Execute Flow

This Node can be used to execute another Flow, meaning that it will run that Flow and return to the initial Flow afterwards. This means that the Entry Point will not switch to the new Flow. This operation can be compared to a function call.

Go To

This Node can be used to jump between Flows or between Nodes. If the Go To Node is used to switch to another Flow, the Entry Point will switch to that Flow altogether (until switched back).

If

This Node evaluates a statement, and depending on the outcome, the Then or Else child Nodes are triggered. Conditions can be created using CognigyScript or using the built-in Token System.

Interval

The Interval Node can be used to only allow certain Nodes to be executed if a given time (interval) has passed. It is configurable with a number of milliseconds.

Lookup

The Lookup Node acts as a switch between different options. A certain type of input (for example, Intents) is evaluated, and based on the value, a certain branch is executed.

Once

Everything below a Once Node will be executed only once per session. This is useful in case the agent needs to greet the user or in case a database request needs to happen only once per session.

Remove From Context

This Node is used to remove information from the Cognigy Context.

Reset State

With the Reset State Node, the Flow's State can be reset.

Set State

With the Set State Node, the Flow's State can be changed.

Sleep

The Sleep Node pauses execution for a number of milliseconds. This Node used to be known as the Pause Node.

Stop and Return

This Node stops Flow execution and returns to the Entry Point at the start Node.

Switch Locale

This Node is used to change to an alternate Locale during a conversation. It is common to use this Node after language detection or based on the region of the user to execute a change to the conversational language or structure based on an assessment of the user's region or spoken language.

Think

The Think Node can be used to deliberately inject a text into the Start Node of the Flow. This is useful in case it is necessary to start the Flow again, with a specific payload. The payload could, for example, correspond to a certain Intent.

Wait for Input

The Wait for Input Node waits for user input and continues Flow execution.

Voice Nodes

Voice Nodes are for developing a voice agent.

Generic Voice Nodes

The Generic Voice Nodes are a set of Nodes for creating voice Flows that are not specific to one Endpoint. These Voice Nodes are compatible with both voice integrations: AudioCodes and Voice Gateway.

Barge In - Config

This Node is a session config that enables the interruption of the voice agent.

When executed, the settings will apply for the remainder of the session.

Continuous ASR - Config

Continuous ASR enables the system to concatenate multiple STT recognitions of the user and then send them as a single textual message to the voice agent.

DTMF Collect - Config

Enables capturing of DTMF signals by the voice agent during the entire call session.

When executed, the settings will apply for the remainder of the session.

Hang Up

This Node instructs the system to end the call.

Mute Speech Input

This Node controls when speech user inputs can be collected in your Flow.

Play URL

The Play URL Node lets you stream a sound file into the call with the ability to loop it. MP3 and WAV encoded files are supported.

Send Metadata

The Send Meta Data Node sends metadata via SIP INFO messages to the connected SIP trunk.

Session Speech Parameters - Config

This Node enables the change of speech parameters during the Flow.

Transfer

This Node lets pass an active call to a tel or sip target.

User Input Timeout - Config

This Node defines the action that the virtual agent should take if it does not receive any input from the user within a certain timeframe.

Voice Gateway Nodes

Voice Gateway Nodes help you build a voice agent using Voice Gateway configuration.

Call Recording

This Node initiates or terminates the recording of a conversation.

DTMF

This Node plays the DTMF digits to the caller.

Hang Up

This Node instructs Voice Gateway to end the call.

Mute Speech Input

This Node controls when speech and DTMF user inputs can be collected in your Flow.

Parameter Details

Cognigy Voice Gateway has many configuration settings that are controlled directly from within your Flow. These settings can be applied individually to the scopes:

Play

This Node lets you stream a sound file into the call with the ability to loop it. MP3 and WAV encoded files are supported.

Send Metadata

This Node sends metadata via SIP INFO messages to the connected SIP trunk.

Set Session Config

This Node configures the Voice Gateway session. All parameters set here are valid for the remainder of the session unless overwritten, either directly or by activity parameters.

Transfer

This Node lets you transfer an ongoing call to a Tel or SIP target.

AudioCodes

AudioCodes Nodes help you build a voice agent using AudioCodes configuration.

Call Recording

This Node controls the voice recording capabilities of the conversation.

Hang Up

This Node instructs AudioCodes to end the call.

Play URL

This Node lets you retrieve a WAV file from a URL location and play it back to the user.

Send Message

This Node sends a text (optionally with SSML) to AudioCodes, which then turns this text into speech (TTS) and outputs it to the caller.

Send Meta Data

This Node sends metadata via SIP INFO messages to the connected SIP trunk.

Set Session Parameters

This Node configures the AudioCodes Session. All parameters set within this Node are valid for the remainder of the session unless overwritten, either directly or by activity parameters.

Transfer

This Node enables the forwarding of an active call to a Tel or SIP target.

Analytics Nodes

Analytics Nodes let you take advantage of Cognigy AI's comprehensive marketing functionality. Use and update Contact Profiles within your Flow for personalized, adaptive Flows that connect with your audience.

Activate Profile

This Node can be used to activate a Contact Profile in case it has been deactivated. The Node is not configurable.

Blind Mode

The Blind Mode disables all (or selected) logging. The Node can be used whenever the virtual agent handles sensitive data that should be excluded from the logs.

  • Mask Login: Outputs XXXX in the output logs of the Agent.
  • Mask Analytics: Outputs XXXX in the analytics (including Contact Profile conversations).
  • Disable Conversations: Disables output analytics altogether.

Complete Goal

This Node can be used to add a custom Goal to the Contact Profile. Custom Goals are KPIs that can be dynamically configured and that show up in the output analytics as well as the Contact Profile overview.

Deactivate Profile

This Node can be used to deactivate the Contact Profile.

Delete Profile

This Node deletes the currently active Contact Profile.

Merge Profile

This Node can be used to merge the current session to an existing Contact Profile. The Node can be configured with an identifier that can be used as a user ID.

Overwrite Analytics

This Node provides the ability to selectively overwrite the Analytics data that will be stored in Insights Analytics.

Request Rating

The Request Rating Node is used to request a rating. If the Node is triggered in your webchat conversation, you will see the rating dialog.

Set Rating

This Node extends the analytical capabilities of Cognigy.AI together with the Insights application.

Update Profile

This Node is commonly used, as it helps update Contact Profile information. It is configurable with a drop-down of all the Contact Profile Schema attributes.

Service Nodes

Service Nodes can be used to trigger external services, like databases and email servers. Cognigy.AI ships with a number of built-in services. Additional services can be added through Extensions.

Check Agent Availability

This Node checks the availability of agents with specific skills. With this Node, you can manage your Flow, for example, send notifications to the user that the agent is unavailable at the moment, or suggest an alternative response.

Close Handover

Closes the handover conversation in the handover provider, such as Live Agent. If turned off, the user will only be returned to the virtual agent.

GPT Conversation

The GPT Conversation Node processes and comprehends natural language input from users and utilizes this input to generate relevant and contextual appropriate responses. The Node configuration includes defining a persona, knowledge, and task for the agent, allowing it to generate AI-based responses to user inputs and trigger actions. The GPT Conversation Node can support the entire conversation using Large Language Models (LLMs).

Handover to Agent

This Node enables virtual agents to pass on conversations to human agents in contact centers.

HTTP Request

The HTTP Request Node is a very convenient Node that can execute HTTP requests to other interfaces (APIs). It can be configured with typical REST operations (GET, POST, PATCH, PUT, DELETE) and has configurable JSON or Text payloads.

LLM Prompt

The LLM Prompt Node lets you use prompts with different LLM models to generate text or structured content.

MongoDB Nodes

Cognigy.AI has a built-in MongoDB connector that can be used directly within the Flow.

Microsoft SQL Nodes

Cognigy.AI has a built-in Microsoft SQL connector that can be used directly within the Flow.

Set Handover Inactivity

This Node detects and handles user inactivity, freeing up capacity for the human agent team. To configure this Node, specify the time in minutes during which the user can be inactive.

Trigger Function

This Node is used to execute a Function.

NLU Nodes

NLU Nodes are a collection of Nodes that are related to the platform's NLU. It features a range of different Nodes.

Add Lexicon Keyphrase

This Node can be used to dynamically create a Lexicons Keyphrase entry, either based on hardcoded or dynamic data.

Clean Text

This Node enables a user to clean a provided text using the Text Cleaner class, which exposes various functions for cleaning text.

Copy Slots to Context

This Node can be used to copy Slots that were detected and published in the Input object, to the conversation Context.

Disable Slot Fillers

This Node lets you disable any active Slot Fillers. For more information on Slot Fillers, refer to NLU (Natural Language Understanding).

Enable Slot Fillers

This Node lets you enable a particular Slot Filler. Use the drop-down menu to select the Slot Filler that you want to enable. For more information on Slot Fillers, refer to NLU (Natural Language Understanding.

Execute Cognigy NLU

This Node can be used to explicitly execute Cognigy NLU at a certain point in the Flow. NLU execution happens automatically at the start of the Flow and with each new user input.

This Node enables a Flow to search through a list (string array) of source data by providing a search pattern. It will return the best possible matches, based on a set of parameters.

Match Pattern

This Node enables a user to find patterns in text and expose them in the Input Object.

Regex Slot Filler

This Node can be used to create a Slot based on a regex pattern. When the pattern is detected, a Slot will be published to the Input object.

Data Nodes

Data Nodes are designed to manage, manipulate, process, or store data within a system.

Datepicker

This Node can be used to render a date selection widget in certain channels. It has an extensive list of configurable options.

Send SMTP Email

This Node can be used to send an email message directly from within the Flow. IT requires a Connection in order to work.

Email Notification

This Node allows you to send quick and easy emails during sessions or for in-house communications without requiring any provider settings to be set up in the UI. Instead, you can configure the necessary provider settings in the environment variables and secrets. Only one provider can be set up at a time.

AI Copilot Nodes

Nodes for creating the AI Copilot workspace.

Copilot: Adaptive Card Tile

This Node allows you to create and display adaptive cards in your AI Copilot Workspace. Adaptive cards can display rich content and interactive elements, such as images, text, buttons, and forms.

Copilot: HTML Tile

This Node allows you to display customized HTML content in the AI Copilot Workspace. You can create custom layouts and designs for presenting information to a human agent. HTML content can include text, images, videos, and links. The Set HTML Tile Node is useful for displaying complex information.

Copilot: IFrame Tile

This Node allows you to embed external websites directly into the AI Copilot Workspace. To do that, specify a URL for the external content you want to display. You can present web pages, forms, or applications within the AI Copilot workspace without redirecting human agents to an external site.

Copilot: Identity Tile

This Node is designed to display and process customer-specific information directly within the widget of your AI Copilot Workspace, enhancing the context and usability of the identity-related data.

Copilot: Knowledge Tile

This Node is designed to provide potential answers to human agents regarding customer questions.

Copilot: Next Action Tile

This Node is designed to determine the appropriate next step or action in a conversation or process based on the user's input or the current context.

Copilot: Sentiment Tile

This Node performs sentiment analysis on the most recent input and provides insights into the emotional tone (positive, negative, or neutral) of the last user inputs.

Copilot: Set Grid

This Node updates the existing AI Copilot workspace grid in the AI Copilot Configuration that you created via an API POST request. Additionally, you can use this Node to preview the grid before making this request.

Copilot: Transcript Tile

This Node captures the most recent customer response and displays it on a designated Widget within the AI Copilot Workspace.

xApp Nodes

Nodes for creating xApps.

xApp: Init Session

This Node initializes a new xApp session.

xApp: Get Session PIN

This Node generates a new xApp session PIN. You can access it using the xApp: Get Session PIN token or via input.apps.session.pin.

xApp: Show Adaptive Card

This Node builds an xApp Page by providing an Adaptive Card in JSON format.

xApp: Show HTML

This Node builds an xApp Page by providing custom HTML code.

Other Nodes

Nodes that did not fit into any category above.

This Node searches and retrieves content from data that was previously uploaded to the Knowledge AI solution.

Log Message

The Log Message Node writes a message into the Agent Logs.

Search Extract Output

This Node searches through data within the Knowledge AI solution, extracts a relevant answer via a Generative AI model, and creates an output.

Set Translation

This Node enables the override of real-time translation settings for the ongoing session. Translation settings are defined on the Agent Settings page.