Share via

Recipe interface

  • Reference
Package:
@azure/cognitiveservices-visualsearch

Defines a cooking recipe.

Properties

alternateName

An alias for the item. NOTE: This property will not be serialized. It can only be populated by the server.
bingId

An ID that uniquely identifies this item. NOTE: This property will not be serialized. It can only be populated by the server.
cookTime

The amount of time the food takes to cook. For example, PT25M. For information about the time format, see http://en.wikipedia.org/wiki/ISO_8601#Durations. NOTE: This property will not be serialized. It can only be populated by the server.
datePublished

The date on which the CreativeWork was published. NOTE: This property will not be serialized. It can only be populated by the server.
description

A short description of the item. NOTE: This property will not be serialized. It can only be populated by the server.
id

A String identifier. NOTE: This property will not be serialized. It can only be populated by the server.
image

An image of the item. NOTE: This property will not be serialized. It can only be populated by the server.
name

The name of the thing represented by this object. NOTE: This property will not be serialized. It can only be populated by the server.
prepTime

The amount of time required to prepare the ingredients. For example, PT15M. For information about the time format, see http://en.wikipedia.org/wiki/ISO_8601#Durations. NOTE: This property will not be serialized. It can only be populated by the server.
provider

The source of the creative work. NOTE: This property will not be serialized. It can only be populated by the server.
readLink

The URL that returns this resource. To use the URL, append query parameters as appropriate and include the Ocp-Apim-Subscription-Key header. NOTE: This property will not be serialized. It can only be populated by the server.
text

Text content of this creative work. NOTE: This property will not be serialized. It can only be populated by the server.
thumbnailUrl

The URL to a thumbnail of the item. NOTE: This property will not be serialized. It can only be populated by the server.
totalTime

The total amount of time it takes to prepare and cook the recipe. For example, PT45M. For information about the time format, see http://en.wikipedia.org/wiki/ISO_8601#Durations. NOTE: This property will not be serialized. It can only be populated by the server.
url

The URL to get more information about the thing represented by this object. NOTE: This property will not be serialized. It can only be populated by the server.
webSearchUrl

The URL to Bing's search result for this item. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

alternateName

An alias for the item. NOTE: This property will not be serialized. It can only be populated by the server.

alternateName?: string

Property Value

string

bingId

An ID that uniquely identifies this item. NOTE: This property will not be serialized. It can only be populated by the server.

bingId?: string

Property Value

string

cookTime

The amount of time the food takes to cook. For example, PT25M. For information about the time format, see http://en.wikipedia.org/wiki/ISO_8601#Durations. NOTE: This property will not be serialized. It can only be populated by the server.

cookTime?: string

Property Value

string

datePublished

The date on which the CreativeWork was published. NOTE: This property will not be serialized. It can only be populated by the server.

datePublished?: string

Property Value

string

description

A short description of the item. NOTE: This property will not be serialized. It can only be populated by the server.

description?: string

Property Value

string

id

A String identifier. NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

image

An image of the item. NOTE: This property will not be serialized. It can only be populated by the server.

image?: ImageObject

Property Value

ImageObject

name

The name of the thing represented by this object. NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

prepTime

The amount of time required to prepare the ingredients. For example, PT15M. For information about the time format, see http://en.wikipedia.org/wiki/ISO_8601#Durations. NOTE: This property will not be serialized. It can only be populated by the server.

prepTime?: string

Property Value

string

provider

The source of the creative work. NOTE: This property will not be serialized. It can only be populated by the server.

provider?: ThingUnion[]

Property Value

ThingUnion[]

The URL that returns this resource. To use the URL, append query parameters as appropriate and include the Ocp-Apim-Subscription-Key header. NOTE: This property will not be serialized. It can only be populated by the server.

readLink?: string

Property Value

string

text

Text content of this creative work. NOTE: This property will not be serialized. It can only be populated by the server.

text?: string

Property Value

string

thumbnailUrl

The URL to a thumbnail of the item. NOTE: This property will not be serialized. It can only be populated by the server.

thumbnailUrl?: string

Property Value

string

totalTime

The total amount of time it takes to prepare and cook the recipe. For example, PT45M. For information about the time format, see http://en.wikipedia.org/wiki/ISO_8601#Durations. NOTE: This property will not be serialized. It can only be populated by the server.

totalTime?: string

Property Value

string

url

The URL to get more information about the thing represented by this object. NOTE: This property will not be serialized. It can only be populated by the server.

url?: string

Property Value

string

webSearchUrl

The URL to Bing's search result for this item. NOTE: This property will not be serialized. It can only be populated by the server.

webSearchUrl?: string

Property Value

string