Processing item group

Represents processing items to perform by channel.

Elements of a processing item group object literal
Element	Type	Description
id	String	UUID of the processing item group
channelProcessingItemsMap	Object	Key-value pairs where the key is a channel UUID and the value contains a processing item list for the specified channel
lastModified	String	Date and time of the last modification, in this format: YYYY-MM-DD hh:mm:ssZ—for example, 2019-08-21T08:34:27Z
parentNodeId	String	UUID of the parent node

Processing item group example

{
    "id": "af10e3a6-cb40-44eb-b584-45196ffdaa5c",
    "channelProcessingItemsMap": {
        "b19690e3-d92d-4052-b343-ceac768bf5a9": {
            "processingItems": [{
                    "condition": {
                        "id": "a4048ee6-9ea8-4989-863c-49ccc52f84d7",
                        "statementType": "ALWAYS_TYPE",
                        "processingItems": [{
                                "promptGroup": {
                                    "id": "38e68bc5-6d60-47ea-90c7-574ebcb8c468",
                                    "name": "tell_me_again_how_can_i_help_you_today_or_say_\"wha",
                                    "prompts": [{
                                            "payload": {
                                                "displayText": "I need more information. Would you repeat your question in a different way?",
                                                "ttsText": "Tell me again. How can I help you today? Or say \"what are my options?\"",
                                                "audioFile": "",
                                                "displayTextAnnotations": [],
                                                "ttsTextAnnotations": [],
                                                "ttsAudioBackup": "",
                                                "ttsAudioBackupAnnotations": []
                                            },
                                            "language": "en-US",
                                            "channel": "b19690e3-d92d-4052-b343-ceac768bf5a9",
                                            "lastModified": "2022-05-03T00:47:30.012Z"
                                        }
                                    ],
                                    "audioFileId": "",
                                    "bargeinDisabled": false,
                                    "lastModified": "2022-05-03T00:47:30.010Z"
                                },
                                "id": "f102df4c-266c-4756-8c3e-453244d18375",
                                "note": "",
                                "promptGroupId": "38e68bc5-6d60-47ea-90c7-574ebcb8c468"
                            }
                        ],
                        "expressionId": ""
                    },
                    "id": "be936a1a-6258-40d5-afc2-5fc6c8fe8459",
                    "note": ""
                }
            ]
        }
    },
    "lastModified": "2022-05-03T00:47:31.581Z",
    "parentNodeId": "960162d6-4c7c-437e-bbc0-dbf96bf5fa94"
}

Processing item list

Represents the processing items to perform for a specific channel, in a processing item group.

Element of a processing item list object literal
Element	Type	Description
processingItems	Array of processing items	Processing items to perform

Processing item

Represents a processing item in a processing item list.

Elements of a processing item object literal
Element	Type	Description
processing item	Object	One of the supported processing item types
id	String	UUID of the processing item
note	String	Designer notes such as a description or reminder (maximum 4000 characters)
promptGroupId	String	Only present if the processing item is of type `promptGroup`; UUID of the prompt group

Processing item example of type condition, with an assign action and a prompt group

{
    "condition": {
        "id": "9e435be4-813b-4a79-95c0-22ed25f4b561",
        "statementType": "IF_TYPE",
        "expression": {
            "id": "1f298326-34f5-4d67-840a-3273fabd9bc3",
            "leftVariable": {
                "id": "ee86193a-ee72-406b-a7af-120e40884cf3",
                "name": "isFirstTime",
                "description": "",
                "possibleValues": ["true", "false"],
                "uiDefaultValue": "",
                "isReserved": false,
                "masked": false,
                "reportingType": "REPORTING_TYPE_NONE",
                "simpleVariableType": "BOOLEAN_TYPE",
                "timestamp": "2021-10-26T22:58:53.970Z"
            },
            "relationalOperator": "EQUAL_OPERATOR",
            "rightConstant": "true",
            "lastModified": "2021-10-29T18:39:08.455Z",
            "leftVariableId": "ee86193a-ee72-406b-a7af-120e40884cf3"
        },
        "processingItems": [{
                "action": {
                    "assign": {
                        "lhsVariable": {
                            "id": "ee86193a-ee72-406b-a7af-120e40884cf3",
                            "name": "isFirstTime",
                            "description": "",
                            "possibleValues": ["true", "false"],
                            "uiDefaultValue": "",
                            "isReserved": false,
                            "masked": false,
                            "reportingType": "REPORTING_TYPE_NONE",
                            "simpleVariableType": "BOOLEAN_TYPE",
                            "timestamp": "2021-10-26T22:58:53.970Z"
                        },
                        "constant": "false",
                        "lhsVariableId": "ee86193a-ee72-406b-a7af-120e40884cf3"
                    }
                },
                "id": "4dfcad8b-4c66-483a-ae9c-db01b9509f66",
                "note": ""
            }, {
                "promptGroup": {
                    "id": "a0ad4459-e55e-42b9-ac84-507b3ca2710f",
                    "name": "let_me_get_your_file_",
                    "prompts": [{
                            "payload": {
                                "displayText": "Let me get your file...",
                                "ttsText": "",
                                "audioFile": "",
                                "displayTextAnnotations": [],
                                "ttsTextAnnotations": [],
                                "ttsAudioBackup": "",
                                "ttsAudioBackupAnnotations": []
                            },
                            "language": "en-US",
                            "channel": "9e29ee39-75f9-4f9f-a8af-01a6fb7f5df8",
                            "lastModified": "2021-10-29T18:39:52.982Z"
                        }
                    ],
                    "audioFileId": "",
                    "bargeinDisabled": false,
                    "lastModified": "2021-10-29T18:41:08.984Z"
                },
                "id": "6d14faa4-59aa-4ed3-8992-57478b2112d0",
                "note": "",
                "promptGroupId": "a0ad4459-e55e-42b9-ac84-507b3ca2710f"
            }
        ],
        "expressionId": "1f298326-34f5-4d67-840a-3273fabd9bc3"
    },
    "id": "5e1a9ec5-baf7-4cfd-be09-51b0f8bbd573",
    "note": ""
}

Supported processing item types

Dialog models support these types of processing item:

Types of processing item
Element key	Processing item type	Description
condition	Condition	Sets a condition (such as if, else if, else) to control the dialog flow
action	Action	Performs one of these actions: assign a value to a variable or set a log message
promptGroup	Prompt group	Sets a prompt
transition	Transition	Sets a transition to another node or throws an event
placeholderProcessingType	String	`note` for designer notes; `action` for an action that is not yet defined; `prompt_tts`, `prompt_text`, or `prompt_ttsAudio` for a message that is not yet defined

Feedback

Was this page helpful?

Glad to hear it! Please tell us how we can improve.

Sorry to hear that. Please tell us how we can improve.