Cards API needs to be documented

[fe01134]

Cards enable multi modal input  voice / text and selection. They can be used in any skill to improve the experience. IE  Rather than answer back by saying  or typing back   "Sheraton at park plaza NYC  you can pick from a list of card options that also include graphics for example pictures of the hotel.   Where the user clicks on the one they want.   That example is for the POI skill     How they render is left up to the client.   For example for the weather skill Kaon wanted to show clouds or sun or partly cloudy based on images returned from Weather service in the weather skill.
 
Skills SDK/REST and JSON structure format needs to describe how to return for example images, audio and a list of choosable options. Additionally we need to do some thinking regarding specifying how to represent display / sizes impact the returned data.

[luaithrenn]

@offerakrabi
Gathering input for documenting cards. I think it be added to the Enhancing the conversation topic'.
From a high-level I'll cover:

• What's card - additional information provided to enhance a text response, for example, an image with a graphic, an image with more detailed text.
• Purpose - enhance user interaction -
• Example - a user a restaurant skill is ceasar salad is on the menu. The assistant returns a text response and an image showing the salad.

What can be included

"card": {
"type": "string",
"title": "string",
"subtitle": "string",
"content": {
}
},

Actions.js has this guideance :
//example of a card sent to the application, the action and the json most of the time will come from WCS
response.card('some action', {"some": "json"});

But need to give an example: can use POI skill to tailor a simple example : https://github.ibm.com/ConsumerIoT/ExpertiseYelp/blob/master/INTENTS.md#points-of-interest

What type of information can be included as part of a card? Any restrictions?

[luaithrenn]

fyi @troyibm