Share via

RankingRankingItem interface

  • Reference
Package:
@azure/cognitiveservices-websearch

Defines a search result item to display

Properties

answerType

The answer that contains the item to display. Use the type to find the answer in the SearchResponse object. The type is the name of a SearchResponse field. Possible values include: 'WebPages', 'Images', 'SpellSuggestions', 'News', 'RelatedSearches', 'Videos', 'Computation', 'TimeZone'. Default value: 'WebPages'.
htmlIndex

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

A zero-based index of the item in the answer.If the item does not include this field, display all items in the answer. For example, display all news articles in the News answer. NOTE: This property will not be serialized. It can only be populated by the server.
screenshotIndex

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

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

The ID that identifies either an answer to display or an item of an answer to display. If the ID identifies an answer, display all items of the answer. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

answerType

The answer that contains the item to display. Use the type to find the answer in the SearchResponse object. The type is the name of a SearchResponse field. Possible values include: 'WebPages', 'Images', 'SpellSuggestions', 'News', 'RelatedSearches', 'Videos', 'Computation', 'TimeZone'. Default value: 'WebPages'.

answerType: AnswerType

Property Value

AnswerType

htmlIndex

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

htmlIndex?: number

Property Value

number

resultIndex

A zero-based index of the item in the answer.If the item does not include this field, display all items in the answer. For example, display all news articles in the News answer. NOTE: This property will not be serialized. It can only be populated by the server.

resultIndex?: number

Property Value

number

screenshotIndex

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

screenshotIndex?: number

Property Value

number

textualIndex

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

textualIndex?: number

Property Value

number

value

The ID that identifies either an answer to display or an item of an answer to display. If the ID identifies an answer, display all items of the answer. NOTE: This property will not be serialized. It can only be populated by the server.

value?: IdentifiableUnion

Property Value

IdentifiableUnion