
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.Parameters
Custom Fields
Custom Fields
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.Parameter | Type | Description |
---|---|---|
Custom Value 1 | CognigyScript | Store a custom field that can be set to any string value. The default value is null . |
Custom Value 2 | CognigyScript | Store a custom field that can be set to any string value. The default value is null . |
Custom Value 3 | CognigyScript | Store a custom field that can be set to any string value. The default value is null . |
Custom Value 4 | CognigyScript | Store a custom field that can be set to any string value. The default value is null . |
Custom Value 5 | CognigyScript | Store a custom field that can be set to any string value. The default value is null . |
Custom Value 6 | CognigyScript | Store a custom field that can be set to any string value. The default value is null . |
Custom Value 7 | CognigyScript | Store a custom field that can be set to any string value. The default value is null . |
Custom Value 8 | CognigyScript | Store a custom field that can be set to any string value. The default value is null . |
Custom Value 9 | CognigyScript | Store a custom field that can be set to any string value. The default value is null . |
Custom Value 10 | CognigyScript | Store a custom field that can be set to any string value. The default value is null . |
Default Fields
Default Fields
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
.Parameter | Type | Description |
---|---|---|
Intent | CognigyScript | Store the intent name. |
IntentScore | Number | Store the intent score. |
inputText | CognigyScript | Store the input text. |
Input Data | JSON | Store additional input data. |
State | CognigyScript | Store the State information. |
Slots | JSON | Store the Slot information. |
Completed Goals | Text | Store a list of completed goals. |
Understood | Dropdown | Select one of the following options:
|
Handover Escalations | CognigyScript | Store the number of handover escalations. |
Examples
Anonymize Personal Data for Privacy in OData
Anonymize Personal Data for Privacy in OData
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?
.Clean Up NLU Metrics with Understood
Clean Up NLU Metrics with Understood
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
.