Hi all, I wanted to share some interesting workaround for utter_custom_message, I saw many people were facing difficulties while using this method(I too had faced the same issue) so I had came up with some workaround: so below is the json data that I want to sent but when I used utter_custom_message(), I used to get an empty array in the response [snip1] so what I did instead of using utter_custom_message I used utter_message and sent the above data in JSON string format using json.dumps [image] Since I am using custom channel I mean had created my own UI for Rasa Core so I can easily get the JSON data in my custom UI(i.e handled through Javascript) and then I can further process that JSON data as required. [image] I hope this helps :wink: :slight_smile:

@Mgo2 @erohmensing I just figured out, after some inspecting and comparison with quick_replies Answer is check below… If any have issue like this problems… Facebook’s example demo for generic template : curl -X POST -H "Content-Type: application/json" -d '{ "recipient":{ "id":"<PSID>" }, "message":{ "attachment":{ "type":"template", "payload":{ "template_type":"generic", "elements":[ { "title":"Welcome!", "image_url":"https://petersfancybrownhats.com/company_image.png", "subtitle":"We have the right hat for everyone.", "default_action": { "type": "web_url", "url": "https://petersfancybrownhats.com/view?item=103", "webview_height_ratio": "tall", }, "buttons":[ { "type":"web_url", "url":"https://petersfancybrownhats.com", "title":"View Website" },{ "type":"postback", "title":"Start Chatting", "payload":"DEVELOPER_DEFINED_PAYLOAD" } ] } ] } } } }' "https://graph.facebook.com/v2.6/me/messages?access_token=<PAGE_ACCESS_TOKEN>" And this way, You can use above example in our custom action file : gt = { "attachment": { "type": "template", "payload": { "template_type": "generic", "elements": [ { "title": "Welcome! 1", "image_url": "https://picsum.photos/200", "subtitle": "We have the right hat for everyone.", "default_action": { "type": "web_url", "url": "https://tithal.life", "webview_height_ratio": "tall", }, "buttons": [ { "type": "web_url", "url": "https://tithal.life", "title": "View Website" }, { "type": "postback", "title": "Start Chatting", "payload": "DEVELOPER_DEFINED_PAYLOAD" } ] }, { "title": "Welcome! 2", "image_url": "https://picsum.photos/200", "subtitle": "We have the right hat for everyone.", "default_action": { "type": "web_url", …

[image] Mgo2: utter_csmb_hardware_grid - custom: data: title: “click here to see the page with the info table, and here is the video: https://myinernalurl.com/index.html ” video: “ https://my.url.com/video ” Hey @Mgo2 After some debugging a while ago, we figured that what is missing in Rasa documentation is the mandatory data: layer in between customer and actual values :slight_smile: So ya, that’s the route that’'s cleanest, regarding if we go with the template definition or create the utterance via action code. @erohmensing Would be good for Rasa to update the Custom action documentation, especially as an example for websocket based chat ui. thank you

[image] Serge: layer in between customer and actual values What do you mean by this?

@erohmensing It means for custom utterance to work with the websocket chat the data: line MUST be present in the template layout or else it will crash. The documentation sample stops at “custom:” which does not actually work. Same as @Mgo2 found out. utter_test_custom_output: - custom: data: attachment: type: "video" payload: title: "Sample video output from domain template" src: "link to my video"

Gotcha. This is specific to the websocket then, in order to use the custom responses I would say it’s pretty reasonable to expect someone to be familiar with the relevant API. I suppose it could be made clearer that everything under custom: should be a complete payload that would be accepted by the channel (e.g. apparently for websocket it all needs to be wrapped in data), but that’s not the case for everything.

@erohmensing Yes, this is for websocket channel. And this the specific of the socket.io library that is being used. It would be very useful to update this documentation page https://rasa.com/docs/rasa/core/domains/#custom-output-payloads as the sample there is channel specific to Slack only. And mentioned no hints of websocket, so it took sometime to debug through both the back end and front end frameworks (mr.bot) to understand what the socket.io requires. Keep in mind, documentation for websocket does point to Mr. bot Chat UI, so when people want to use rasa with a chat ui, they will a lot of time end up with mr. bot chat ui and if they need a custom action, there is nothing to guide them but the slack example, which does not work for websockets :slight_smile:

Right, but the socket documentation shows relatively clearly that everything is wrapped in data to do anything custom rasa-webchat/README.md at master · mrbot-ai/rasa-webchat · GitHub

@erohmensing “Relatively” yes. This is how we figured out that the data: part is needed. But took a bit of bumping. It would he helpful to have a Mr.Bot example alongside Slacks. While it seems it’s not Rasa’s concern of what goes below the custom line, Rasa is typically not used headless and websocket channel from Mr.Bot is a popular one and referred to from the documentation, especially a yml in the domain utterance to help connect the dots easier vs mr.bots jason. But thanks, whoever comes across this page will probably find this useful :smiley:

Excellent work, Do you have any idea how could we change the class RestInput(InputChannel): so that our output format will change. what I’m looking to change(the rest input channel) or create a new channel that will store all the info that I’ll send from my custom UI. Just like I’m sending data: JSON.stringify({ “message”: message, “sender”: “senderid”, “input_channel” : “mycustom” “another_variable” : “some_text” }) What I’m trying to achieve is to change the data format[after detecting channel which rest] for my custom UI so that my same assistant would run on messenger, telegram and the custom UI [for which i’m changing the format]. [ { “recipient_id”:“default”, “custom”:{ “buttons”:[ { “payload”:"/contactinfo", “title”:“info” }, { “payload”:"/carddetails", “title”:“Details of Card” }, { “payload”:"/mymsg", “title”:“Msg from us” }, { “payload”:"/info", “title”:“Information” }, { “payload”:"/maplink", “title”:“Here is the Map” }, { “payload”:"/findoutmore", “title”:“Find Out More” }, { “payload”:"/contact_me", “title”:“Contact me” } ], “text”:“Hey, How do do you do” } } ] Firstly I tried to change the payload directly in domain.yml which will only be rendered in the custom UI and other channels ultimately fails to render it.

hi @anuragchaudhary , you can use metadata for that or the other way which you are trying to achieve is by do the following way: You can edit the recieve method of the channels.py file to accept the parameters that you are trying to send from your custom UI: RasaHQ/rasa/blob/64f3927cf91f538c6e4cfd5f40debf6bb5c5d295/rasa/core/channels/channel.py#L461 "custom_webhook_{}".format(type(self).__name__), inspect.getmodule(self).__name__, ) # noinspection PyUnusedLocal @custom_webhook.route("/", methods=["GET"]) async def health(request: Request) -> HTTPResponse: return response.json({"status": "ok"}) @custom_webhook.route("/webhook", methods=["POST"]) async def receive(request: Request) -> HTTPResponse: sender_id = await self._extract_sender(request) text = self._extract_message(request) should_use_stream = rasa.utils.endpoints.bool_arg( request, "stream", default=False ) input_channel = self._extract_input_channel(request) metadata = self.get_metadata(request) if should_use_stream: return response.stream( Thanks, Jitesh

Sending Custom JSON Payload from actions(workaround for utter_custom_message)

Rasa Open Source

anuragchaudhary (anurag singh chaudhary) June 5, 2020, 10:07am 33

look into fb messenger payload

Topic		Replies	Views
Utter_custom_message using rest input channel Tutorials, Resources & Videos	10	2160	January 14, 2020
In custom action return utter with elements Rasa Open Source	24	7891	October 31, 2019
Dump rasa response directly in json format via output channel Rasa Open Source	3	1653	December 4, 2020
Rasa Chatbot - Sending customData from website to rasa server Rasa Open Source	3	739	February 9, 2022
Custom output payloads with socket.io Rasa Open Source	5	2064	October 23, 2023

Sending Custom JSON Payload from actions(workaround for utter_custom_message)

Related topics