Zana Documentation

NLG Response

The message returned from the Dialog Manager and NLG component in Zana Brain.

JSON Representation

{
"action":
    {
     "detectedEntities":"anaphylaxis",
     "label":"treatments",
     "name":"getArticleOrIntroForIntentEntitiesHighConf",
     "range":[]
    },
"context_out":
    ["context_zana"],
"message":"I understand that you request is related to treatments of anaphylaxis. I found the following article related to your request.",
"timestamp":"2018-12-20T12:56:12Z",
"items":
    [
        {
            "URI":"http://zana.com/a/treatment.200",
            "date":"2018-12-20T12:56:12Z",
            "image_url":null,
            "payload_link":"",
            "payload_title":"",
            "source":"NHS",
            "subtitle":"",
            "summary":"Find out what to do if you think you or someone else is experiencing anaphylaxis.",
            "title":"Treatment",
            "type_template":"oneItem"

        },
        {
            "URI":"http://zana.com/a/introduction.199/",
            "date":"2018-12-20T12:56:12Z",
            "image_url":null,
            "payload_link":"",
            "payload_title":"Introduction",
            "source":"NHS",
            "subtitle":"",
            "summary":null,
            "title":"Introduction",
            "type_template":"QR"
        },
        {
            "URI":"http://zana.com/a/prevention.201/",
            "date":"2018-12-20T12:56:12Z",
            "image_url":null,
            "payload_link":"",
            "payload_title":"Prevention",
            "source":"NHS",
            "subtitle":"",
            "summary":null,
            "title":"Prevention",
            "type_template":"QR"
        },
        {
            "URI":"http://zana.com/a/symptoms.5557/",
            "date":"2018-12-20T12:56:12Z",
            "image_url":null,
            "payload_link":"",
            "payload_title":"Symptoms",
            "source":"NHS",
            "subtitle":"",
            "summary":null,
            "title":"Symptoms",
            "type_template":"QR"

        }
    ]
}

Fields
id string UUID Generated String that idenfities each response
sid String Session Id as generated by Zana Core
timestamp Date TimeStamp indicating the response time
message [String A message to display the user
items List Item Items to be returned by the NLG
context_out List Context where the utterance is based
action Action A debugg information on the action found

Testing

https://api.zana.com/brain/?sessionId=armand&utterance=how%20to%20treat%20anaphylaxis