Skip to main content

Description

With Cognigy.AI 4.91, the Understood Messages concept was deprecated, with removal from the Insights reports scheduled for version 2025.19. Use the Goals and Tasks concepts to evaluate whether your AI Agent understood a particular phrase.Respectively, the OData endpoint understood field was deprecated in the same version, with full removal scheduled for version 2025.24. Use the Goals collection in the Cognigy.AI OData endpoint.Refer to the list of all upcoming removals on the Deprecations and Removals page.
This Node allows you to selectively overwrite default values, such as Intents, text, understood messages, and more, as well as manage the analytics data stored in the Analytics database. You can view this data on the Insights reports or retrieve it via the Cognigy.AI OData Endpoint. You can also use this Node to add custom values. Empty fields don’t overwrite the initial values. If you add this Node and leave some fields empty, such as the Intent default field, the initial value stored in the Analytics database will remain unchanged.

Parameters

Custom fields allow you to store any data as a string value.Custom fields can be useful for enriching the information about a user’s conversation by adding more details. For example, if user inputs contain words such as excellent or great, you can add a custom field with the value Positive feedback to make it easier to analyze positive feedback through analytics records.
ParameterTypeDescription
Custom Value 1CognigyScriptStore a custom field that can be set to any string value. The default value is null.
Custom Value 2CognigyScriptStore a custom field that can be set to any string value. The default value is null.
Custom Value 3CognigyScriptStore a custom field that can be set to any string value. The default value is null.
Custom Value 4CognigyScriptStore a custom field that can be set to any string value. The default value is null.
Custom Value 5CognigyScriptStore a custom field that can be set to any string value. The default value is null.
Custom Value 6CognigyScriptStore a custom field that can be set to any string value. The default value is null.
Custom Value 7CognigyScriptStore a custom field that can be set to any string value. The default value is null.
Custom Value 8CognigyScriptStore a custom field that can be set to any string value. The default value is null.
Custom Value 9CognigyScriptStore a custom field that can be set to any string value. The default value is null.
Custom Value 10CognigyScriptStore a custom field that can be set to any string value. The default value is null.
Default fields allow you to change existing data or add new data to the default parameters, such as Intents, States, and inputs. If a default field is left empty, the previous value will be used in the analytics record.The table includes the most commonly used parameters for overwriting. For example, you can overwrite the Intent name. Consider the case where a user says, I need to return an item. The AI Agent recognizes this message as the Return request Intent. For more precise tracking, you can configure the AI Agent to overwrite this Intent so that it is stored in the Analytics database as Product return.
ParameterTypeDescription
IntentCognigyScriptStore the intent name.
IntentScoreNumberStore the intent score.
inputTextCognigyScriptStore the input text.
Input DataJSONStore additional input data.
StateCognigyScriptStore the State information.
SlotsJSONStore the Slot information.
Completed GoalsTextStore a list of completed goals.
UnderstoodDropdownSelect one of the following options:
  • Don’t Overwrite — the current status of the message (whether it is understood or misunderstood) will not be overridden.
  • True — the message will be counted as understood.
  • False — the message will not be counted as misunderstood.
  • Don’t Count — the message will not be included in the calculation of understood or misunderstood messages.
Handover EscalationsCognigyScriptStore the number of handover escalations.

Examples

You can anonymize specific text in the field to ensure privacy while maintaining context in OData. For example, instead of My name is Alex, how do I do something? you can replace it with My name is <Name>, how do I do something?.
To clean up NLU metrics, you can set the Understood field to null or true in specific circumstances. This approach is useful in voice AI Agents for handling Voice Gateway payloads, which are automatically set to false.

Alternatives

Alternatively, you can update analytics records using the PATCH /v2.0/analytics request.
I