RankingRankingItem

Defines a search result item to display

APIs.ioEngineeringPlatform

Properties

Name	Type	Description
answerType	string	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.
htmlIndex	integer
resultIndex	integer	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.
screenshotIndex	integer
textualIndex	integer
value	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/RankingRankingItem",
  "title": "RankingRankingItem",
  "required": [
    "answerType"
  ],
  "type": "object",
  "properties": {
    "answerType": {
      "type": "string",
      "description": "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.",
      "default": "WebPages",
      "enum": [
        "WebPages",
        "Images",
        "SpellSuggestions",
        "News",
        "RelatedSearches",
        "Videos",
        "Computation",
        "TimeZone"
      ],
      "x-ms-enum": {
        "modelAsString": true,
        "name": "AnswerType"
      }
    },
    "htmlIndex": {
      "type": "integer",
      "format": "int32",
      "readOnly": true
    },
    "resultIndex": {
      "type": "integer",
      "description": "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.",
      "format": "int32",
      "readOnly": true
    },
    "screenshotIndex": {
      "type": "integer",
      "format": "int32",
      "readOnly": true
    },
    "textualIndex": {
      "type": "integer",
      "format": "int32",
      "readOnly": true
    },
    "value": {
      "$ref": "#/components/schemas/Identifiable"
    }
  },
  "description": "Defines a search result item to display",
  "x-ms-discriminator-value": "Ranking/RankingItem"
}