Gracias por tu visita. Esta página solo está disponible en inglés.

Property Schemas for Alexa.Cooking APIs

This document contains the schemas for properties that are used by the Alexa.Cooking interfaces. For more information, see List of Alexa Interfaces and Supported Locales.

Many properties can be expressed as either an object or a string.

Example property object

{
    "name": "cookingMode",
    "value": "TIMECOOK"
}

Example property string

"cookingMode": "TIMECOOK"

CookingMode

CookingMode represents the cooking mode for a cooking appliance like a microwave oven. CookingMode can be an object or a string. For the list of valid values, see CookingMode Values.

CookingMode Object Format

You can use the full object format for the CookingMode. You must use the object format to include the optional customName attribute. Smart Home always sends the CookingMode to your lambda function in the object format.

Example object format

"cookingMode":
{
  "value": "TIMECOOK"
}

Example object format with custom name

"cookingMode":
{
  "value": "REHEAT",
  "customName": "QUICK_REHEAT"
}

CookingMode String Format

You can also abbreviate CookingMode as a string instead of an object.

Example string format

"cookingMode": "TIMECOOK"

CookingMode Values

You can use the following values for CookingMode. The values are strings.

Value Description
DEFROST Indicates a cooking appliance's automated defrost mode.
OFF Indicates that a cooking appliance is off.
PRESET Indicates a cooking appliance's preset mode or other automated cooking.
REHEAT Indicates a cooking appliance's automated reheating mode.
TIMECOOK Indicates a time and power level cooking setting.

FoodCategory

FoodCategory represents a category of food. You can use the following values for foodCategory. The values are strings.

BEEF, BEVERAGE, CHICKEN, FISH, MEAT, PIZZA, POPCORN, PORK, POTATO, SHRIMP, SOUP, STEAK, TURKEY, VEGETABLE, WATER

FoodItem

Represents a food item. A food item consists of the name specified by the user and the category that Alexa determines for that name. For example, if a user specified "pork chop", the category determined by Alexa would be PORK.

Field Description Type
foodName Indicates the name of the food item specified by the user. String
foodCategory Describes the food category as determined by Alexa. A food category value.
foodQuantity The amount of food to be cooked, specified by count, weight or volume. A food quantity object.

Example FoodItem

{
  "name": "foodItem",
  "value": {
    "foodName": "Copper river salmon",
    "foodCategory": "FISH",
    "foodQuantity": {
      "@type": "Weight",
      "value": "2.5",
      "unit": "POUND"
    }
  }
}

FoodQuantity

Use foodQuantity to represent a quantity of food. Use the @type field to indicate the type of quantity: food count, volume, or weight.

Example foodQuantity with count

"foodQuantity":
{
    "@type": "FoodCount",
    "value": 12
}

Example foodQuantity with volume

"foodQuantity":
{
    "@type": "Volume",
    "value": 1.25,
    "unit": "LITER"
},

Example foodQuantity with weight

"foodQuantity":
{
    "@type": "Weight",
    "value": "2.5",
    "unit": "POUND"
},