Images interface

Package:

@azure/cognitiveservices-imagesearch

Defines an image answer

Properties

id	A String identifier. NOTE: This property will not be serialized. It can only be populated by the server.
nextOffset	Used as part of deduping. Tells client the next offset that client should use in the next pagination request NOTE: This property will not be serialized. It can only be populated by the server.
pivotSuggestions	A list of segments in the original query. For example, if the query was Red Flowers, Bing might segment the query into Red and Flowers. The Flowers pivot may contain query suggestions such as Red Peonies and Red Daisies, and the Red pivot may contain query suggestions such as Green Flowers and Yellow Flowers. NOTE: This property will not be serialized. It can only be populated by the server.
queryExpansions	A list of expanded queries that narrows the original query. For example, if the query was Microsoft Surface, the expanded queries might be: Microsoft Surface Pro 3, Microsoft Surface RT, Microsoft Surface Phone, and Microsoft Surface Hub. NOTE: This property will not be serialized. It can only be populated by the server.
readLink	The URL that returns this resource. NOTE: This property will not be serialized. It can only be populated by the server.
similarTerms	A list of terms that are similar in meaning to the user's query term. 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 image objects that are relevant to the query. If there are no results, the List is empty.
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

id

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

id?: string

Property Value

string

nextOffset

Used as part of deduping. Tells client the next offset that client should use in the next pagination request NOTE: This property will not be serialized. It can only be populated by the server.

nextOffset?: number

Property Value

number

pivotSuggestions

A list of segments in the original query. For example, if the query was Red Flowers, Bing might segment the query into Red and Flowers. The Flowers pivot may contain query suggestions such as Red Peonies and Red Daisies, and the Red pivot may contain query suggestions such as Green Flowers and Yellow Flowers. NOTE: This property will not be serialized. It can only be populated by the server.

pivotSuggestions?: PivotSuggestions[]

Property Value

PivotSuggestions[]

queryExpansions

A list of expanded queries that narrows the original query. For example, if the query was Microsoft Surface, the expanded queries might be: Microsoft Surface Pro 3, Microsoft Surface RT, Microsoft Surface Phone, and Microsoft Surface Hub. NOTE: This property will not be serialized. It can only be populated by the server.

queryExpansions?: Query[]

Property Value

Query[]

readLink

The URL that returns this resource. NOTE: This property will not be serialized. It can only be populated by the server.

readLink?: string

Property Value

string

similarTerms

A list of terms that are similar in meaning to the user's query term. NOTE: This property will not be serialized. It can only be populated by the server.

similarTerms?: Query[]

Property Value

Query[]

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 image objects that are relevant to the query. If there are no results, the List is empty.

value: ImageObject[]

Property Value

ImageObject[]

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