Share via

Videos interface

  • Reference
Package:
@azure/cognitiveservices-videosearch

Defines a video answer.

Properties

followUpQueries

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.
isFamilyFriendly

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

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

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

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

Possible values include: 'List', 'SingleDominantVideo' NOTE: This property will not be serialized. It can only be populated by the server.
totalEstimatedMatches

The estimated number of webpages that are relevant to the query. Use this number along with the count and offset query parameters to page the results. NOTE: This property will not be serialized. It can only be populated by the server.
value

A list of video objects that are relevant to the query.
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

followUpQueries

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

followUpQueries?: Query[]

Property Value

Query[]

id

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

id?: string

Property Value

string

isFamilyFriendly

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

isFamilyFriendly?: boolean

Property Value

boolean

nextOffset

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

nextOffset?: number

Property Value

number

pivotSuggestions

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

pivotSuggestions?: PivotSuggestions[]

Property Value

PivotSuggestions[]

queryExpansions

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

queryExpansions?: Query[]

Property Value

Query[]

scenario

Possible values include: 'List', 'SingleDominantVideo' NOTE: This property will not be serialized. It can only be populated by the server.

scenario?: VideoQueryScenario

Property Value

VideoQueryScenario

totalEstimatedMatches

The estimated number of webpages that are relevant to the query. Use this number along with the count and offset query parameters to page the results. NOTE: This property will not be serialized. It can only be populated by the server.

totalEstimatedMatches?: number

Property Value

number

value

A list of video objects that are relevant to the query.

value: VideoObject[]

Property Value

VideoObject[]

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