-
Notifications
You must be signed in to change notification settings - Fork 769
Emulator transcript replay does not match OBI spec #2319
Description
The OBI spec is here: https://github.com/microsoft/botframework-obi/blob/main/fileformats/transcript/transcript.md
Matching the spec is important to be able to replay transcripts from other sources like PVA.
-
According to the spec a .transcript file should either be a list of activities or an object with a
transcriptfield that is a list of activities. The emulator saves the transcript as an array, but cannot handle a transcript that is an object. -
According to the spec recipient is optional and should be dropped when an activity is not sent to a specific recipient. If you remove the
recipientfield in the trace activity below and save the transcript you will not see anything if you open it in the emulator. If you remove the tracefromfield the transcript will still work--even though the from is required.
[
{
"type": "trace",
"channelId": null,
"from": {
"id": "61fa1c70-41b5-11ec-bf9e-097f4b8a71ac",
"name": "Bot",
"role": 0
},
"recipient": {
"id": "07a6a1dd-e0b3-4ce5-b636-1127cd19124a",
"role": 1
},
"locale": "en-US",
"label": "Bot State",
"valueType": "botState",
"value": {
"something": "foo"
}
},
{
"type": "message",
"channelId": null,
"from": {
"id": "61fa1c70-41b5-11ec-bf9e-097f4b8a71ac",
"name": "Bot",
"role": 0
},
"conversation": {
"id": "61fa91a0-41b5-11ec-8481-050b7a8a6e92|livechat"
},
"recipient": {
"id": "07a6a1dd-e0b3-4ce5-b636-1127cd19124a",
"role": 1
},
"locale": "en-US",
"text": "\r\nRequired properties include: name, bread, meat, cheese, toppings, sauces, price\r\nOptional properties include: quantity, length\r\n\r\nFor each property you can add/remove values, clear, show, change or ask for help.\r\nYou can also ask for over all help, cancel the whole form or skip a step.",
"speak": "<speak version='1.0' xmlns='http://www.w3.org/2001/10/synthesis' xml:lang='en-US'><voice name='en-US-JennyNeural'>\r\nRequired properties include: name, bread, meat, cheese, toppings, sauces, price\r\nOptional properties include: quantity, length\r\n\r\nFor each property you can add/remove values, clear, show, change or ask for help.\r\nYou can also ask for over all help, cancel the whole form or skip a step.</voice></speak>",
"replyToId": "6208e980-41b5-11ec-8481-050b7a8a6e92",
"id": "639f19e0-41b5-11ec-8481-050b7a8a6e92",
"localTimestamp": "2021-11-09T15:33:05-08:00",
"timestamp": "2021-11-09T23:33:05.790Z"
}
]
- The rendering of images in the emulator is not correct.
This URL: https://virtualagent-resource.hpcloud.hp.com/answer-resources/images/20181108194952_Note.JPG
Looks like this:

