Intent recognized from user utterance and matched to a flow
Intent recognized from user utterance and matched to a flow
Using a variable in a flow via the placeholder menu
| Flow variable | Description | Memory |
|---|---|---|
| Local variable | Includes named outputs from Define nodes, Loop nodes, Generative nodes, and Knowledge Base nodes. | Retained locally in a flow where they are created/generated while a user is active in the flow. If a user may be looped through the same flow or may revisit a flow in the same conversation later, these variables may be cleared via a state modification to avoid auto-traversal. To preserve the variable in one flow for use in other flows, use a state modification to set the variable as a Context variable |
| Slot | Captured through user utterance. Slots allow you to restrict the accepted "value" of the user's utterance using custom or built-in slot types | Retained locally to the flow where attached. If a user revisits a flow during a session, slots may be cleared via a state modification to avoid auto-traversal. To preserve a slot selection in one flow for reference in other flows, use a state modification to set the slot as a Context variable |
| Data request variable | External data retrieved first through a Data request node | Retained throughout a conversation session after variables are fetched. If the data may become outdated and the node is expected to be revisited during the session, enable the Always retrigger toggle on the Data request node to fetch updated values |
| Context variable | Usable across any flow, these are empty on their own and are set or defined by other variables | Variables that begin empty and can be set either by externally-fetched data (via Data requests or Lifecycle hooks set to 'Start' lifecycle) or by internal values you've defined or captured in a flow. If not using lifecycles, use a state modification to set or alter these variables first. Tracked and retained throughout a conversation session |
| Model Context Protocol (MCP) variables | Externally set by an LLM and passed along to NLX via MCP | Passed from the LLM interfacing with a user when an MCP-enabled flow is invoked. Retained throughout a conversation session |
| Secrets | Created at the workspace and usable across any flow in Data request node payloads | Set when integrated in the workspace and retained throughout a conversation session |
| System variable | Tracked automatically by NLX | Set and tracked by the system and retained throughout the conversation session |
| System variable | Description | Example |
|---|---|---|
System.capturedIntent | Set by the User input node | Use in a Split node using conditional rules from the match edge of a User input node |
System.capabilities | Uses the flow names and their AI descriptions of the application being executed | Use in a Generative text prompt to determine user intent from a given utterance captured prior through the NLX.Text slot. Then use in a Split node to check for the name of the flow and Redirect accordingly. |
System.conversationId | The unique id for the current conversation | Pass to Data requests to identify a unique interaction |
System.channelType | Provides the channel the user is currently using | Use in a Split node to route the user based on the channel used in conversation |
System.currentTimestamp | Indicates the time (in UTC) recorded by the system when triggered in conversation (returns the number of milliseconds elapsed since the epoch, defined as midnight at the beginning of January 1, 1970, UTC) | Use in a Split node to route the user if their query is time sensitive or for changes to verbiage (e.g., “Good morning”) or processes during or outside of hours of operation |
System.environment | Provides the environment the application is deployed to (Dev/Prod) | Use in a Split node to route users based on the production environment |
System.isVoice | Indicates whether the user is communicating through text or voice interface. Applicable to all channels, including API with Touchpoint Voice | Use in a Split node with True/False check to route the user based on whether voice or text channel |
System.language | The ISO 639-1 designated language (e.g., en) | Parameterize URLs sent in messaging to support localized versions of a webpage by language/region |
System.languageCode | The ISO 3166-1 Alpha-2 language code that the conversation session is in (e.g., en-US) | Pass to Data requests as a parameter to support translation in the Data request response |
System.lastIntent | The last flow visited by the user in the conversation session | Use in a Split node at the beginning of a flow to route the path of a user based on the context of where they were in a conversation |
System.locale | The ISO 639-1 designated locale code (e.g., US) | Parameterize URLs sent in messaging to support localized versions of a webpage by language/region |
System.voicePlusTimeoutType | Timeout occurring from a Voice+ experience. Reference in a Split node condition: blank = no timeout occurred; sessionStart = user didn't tap SMS link; inactivity = Voice+ started but inactivity between steps occurred | Use in a Split node to route users that may need to be escalated based on timeout condition |
System.nlpConfidenceScore | The value (out of 100) that the NLP confidently matched a user's input to a flow | Use to ask clarifying questions if below a threshold to ensure the correct flow has been matched |
System.resumeIntentMessage | The message relayed to a user when a flow is resumed from a previous interruption | Enabled on the Start node of a flow to pick up where a user left off |
System.sentiment | The sentiment of the user (Positive, Neutral, Negative) for the current exchange. Note: sentiment analysis must be enabled for the application | Use in a Split node to provide empathetic responses |
System.transcript | Provides the complete exchange between the human and the conversational AI application. Any sensitive information will be redacted | Use as a payload field in a Data request that creates a ticket in a help desk system |
System.userId | The user ID identifying the human in the conversation. Value varies by channel | Pass to Data requests to look up information on the user's phone number over a voice channel |
System.utterance | The most recent message received from the human | Use in a Split node and the Contains operator to determine if the user said a specific keyword |
System.timezone | The user's detected time zone in the conversation | Determine the real time a user means for NLX.Date or NLX.Time slots when passing to a Data request |
User utterance containing required variables for flow completion