RankingRankingItem Class

Defines a search result item to display.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Inheritance
RankingRankingItem

Constructor

RankingRankingItem(*, answer_type='WebPages', **kwargs)

Parameters

answer_type
str or AnswerType
Required

Required. 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" .

Variables

result_index
int

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.

value
Identifiable

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.

html_index
int
textual_index
int
screenshot_index
int