Coveo Search Restqueryresult Structure

{
  "name": "RestQueryResult",
  "structure": {
    "type": "object",
    "required": [
      "absentTerms",
      "childResults",
      "clickUri",
      "excerpt",
      "excerptHighlights",
      "firstSentences",
      "firstSentencesHighlights",
      "flags",
      "hasHtmlVersion",
      "hasMobileHtmlVersion",
      "isRecommendation",
      "isTopResult",
      "isUserActionView",
      "parentResult",
      "percentScore",
      "printableUri",
      "printableUriHighlights",
      "rankingInfo",
      "rating",
      "raw",
      "score",
      "summary",
      "summaryHighlights",
      "title",
      "titleHighlights",
      "totalNumberOfChildResults",
      "uniqueId",
      "primaryid",
      "uri"
    ],
    "properties": {
      "title": {
        "type": "string",
        "description": "The item title.  \n  \n**Note:** When logging a **Click** usage analytics event for an opened query result item, the `documentTitle` field of that event should be set to the `title` value of the opened query result item."
      },
      "uri": {
        "type": "string",
        "description": "The item URI.\n\n**Notes:**\n\n- Avoid using the `uri` value to create hyperlinks to the item. Use the `ClickUri` value instead.\n- When logging a **Click** usage analytics event for an opened query result item, the `documentUrl` field of that event should be set to the `uri` value of the opened query result item."
      },
      "printableUri": {
        "type": "string",
        "description": "The human readable item URI.\n\n**Note:** Avoid using the `printableUri` value to create hyperlinks to the item. Use the `ClickUri` value instead."
      },
      "clickUri": {
        "type": "string",
        "description": "The hyperlinkable item URI.\n\n**Notes:**\n\n- Use the `clickUri` value when you want to create hyperlinks to the item, rather than the `uri` or `printableUri` value.\n- The `clickUri` value is not necessarily unique for each item."
      },
      "uniqueId": {
        "type": "string",
        "description": "The unique item identifier. You should consider the `uniqueId` value as an opaque string."
      },
      "primaryid": {
        "type": "string",
        "description": "The primary identifier of the item. See [primaryid field](https://docs.coveo.com/en/pa9c0434) for more details."
      },
      "excerpt": {
        "type": "string",
        "description": "The contextual excerpt generated for the item (see the `excerptLength` query parameter)."
      },
      "firstSentences": {
        "type": "string",
        "description": "The first sentences retrieved from the item (see the `retrieveFirstSentences` query parameter)."
      },
      "summary": {
        "type": "string",
        "description": "The item summary (see the `summaryLength` query parameter)."
      },
      "flags": {
        "type": "string",
        "description": "The flags that are set on the item by the index. Distinct values are separated by semicolons."
      },
      "hasHtmlVersion": {
        "type": "boolean",
        "description": "Whether the index contains an HTML version of this item."
      },
      "hasMobileHtmlVersion": {
        "type": "boolean",
        "description": "Whether the index contains a mobile HTML version of this item."
      },
      "score": {
        "type": "integer",
        "format": "int32",
        "description": "The total ranking score computed for the item (see the `sortCriteria` and `rankingFunctions` query parameters)."
      },
      "percentScore": {
        "type": "number",
        "format": "double",
        "description": "The item ranking score expressed as a percentage (see the `sortCriteria` and `rankingFunctions` query parameters)."
      },
      "rankingInfo": {
        "type": "string",
        "description": "The raw debug information generated by the index to detail how the item was ranked. This property is `null` unless the `debug` query parameter is set to `true`."
      },
      "rating": {
        "type": "number",
        "format": "double",
        "description": "**Note:** The value of this property is always `3`."
      },
      "isTopResult": {
        "type": "boolean",
        "description": "Whether the item score was boosted by a featured result rule in the query pipeline."
      },
      "isRecommendation": {
        "type": "boolean",
        "description": "Whether the item score was boosted as a Coveo ML recommendation."
      },
      "isUserActionView": {
        "type": "boolean",
        "description": "Whether the item score was boosted as a Coveo ML recommendation."
      },
      "rankingModifier": {
        "type": "string",
        "description": "If applicable, represents the type of ranking modification that was applied to this result.  \n  \n**Note:** When logging a **Click** usage analytics event for an opened query result item, the `rankingModifier` field of that event should be set to the `rankingModifier` value of the opened query result item, if available."
      },
      "titleHighlights": {
        "type": "array",
        "description": "The length and offset of each word to highlight in the item `title` string.",
        "items": {
          "type": "object",
          "required": [
            "length",
            "offset"
          ],
          "properties": {
            "length": {
              "type": "integer",
              "format": "int64",
              "description": "The length (in number of characters) of the word to highlight."
            },
            "offset": {
              "type": "integer",
              "format": "int64",
              "description": "The 0-based index position of the first character of the word to highlight in the string."
            }
          }
        }
      },
      "firstSentencesHighlights": {
        "type": "array",
        "description": "The length and offset of each word to highlight in the item `firstSentences` string.",
        "items": {
          "type": "object",
          "required": [
            "length",
            "offset"
          ],
          "properties": {
            "length": {
              "type": "integer",
              "format": "int64",
              "description": "The length (in number of characters) of the word to highlight."
            },
            "offset": {
              "type": "integer",
              "format": "int64",
              "description": "The 0-based index position of the first character of the word to highlight in the string."
            }
          }
        }
      },
      "excerptHighlights": {
        "type": "array",
        "description": "The length and offset of each word to highlight in the item `excerpt` string.",
        "items": {
          "type": "object",
          "required": [
            "length",
            "offset"
          ],
          "properties": {
            "length": {
              "type": "integer",
              "format": "int64",
              "description": "The length (in number of characters) of the word to highlight."
            },
            "offset": {
              "type": "integer",
              "format": "int64",
              "description": "The 0-based index position of the first character of the word to highlight in the string."
            }
          }
        }
      },
      "printableUriHighlights": {
        "type": "array",
        "description": "The length and offset of each word to highlight in the item `printableUri` string.",
        "items": {
          "type": "object",
          "required": [
            "length",
            "offset"
          ],
          "properties": {
            "length": {
              "type": "integer",
              "format": "int64",
              "description": "The length (in number of characters) of the word to highlight."
            },
            "offset": {
              "type": "integer",
              "format": "int64",
              "description": "The 0-based index position of the first character of the word to highlight in the string."
            }
          }
        }
      },
      "summaryHighlights": {
        "type": "array",
        "description": "The length and offset of each word to highlight in the item `summary` string.",
        "items": {
          "type": "object",
          "required": [
            "length",
            "offset"
          ],
          "properties": {
            "length": {
              "type": "integer",
              "format": "int64",
              "description": "The length (in number of characters) of the word to highlight."
            },
            "offset": {
              "type": "integer",
              "format": "int64",
              "description": "The 0-based index position of the first character of the word to highlight in the string."
            }
          }
        }
      },
      "parentResult": {
        "anyOf": [
          {
            "$ref": "#/components/schemas/RestQueryResult"
          },
          {
            "type": "object",
            "nullable": true
          }
        ]
      },
      "childResults": {
        "type": "array",
        "description": "An array of references to the children of this item, if result folding was applied (see the `filterField` query parameter). The query results contained in this field will have both their parent and child results set to `null`.",
        "items": {
          "anyOf": [
            {
              "$ref": "#/components/schemas/RestQueryResult"
            }
          ]
        }
      },
      "totalNumberOfChildResults": {
        "type": "integer",
        "format": "int64",
        "description": "The total number of children available in the index for this item, if result folding was applied (see the `filterField` query parameter)."
      },
      "absentTerms": {
        "type": "array",
        "description": "The basic query expression terms which this query result item does not match.\n\n**Note:**\n> This property is populated by terms from the query pipeline-processed `q` value (not from the original `q` value).",
        "items": {
          "type": "string"
        }
      },
      "raw": {
        "type": "object",
        "description": "The values of the fields which were retrieved for this item (see the `fieldsToInclude` and `fieldsToExclude` query parameters)."
      },
      "Title": {
        "type": "string",
        "description": "> This property is deprecated; it should not be populated by Search API V2 searches."
      },
      "Uri": {
        "type": "string",
        "description": "> This property is deprecated; it should not be populated by Search API V2 searches."
      },
      "PrintableUri": {
        "type": "string",
        "description": "> This property is deprecated; it should not be populated by Search API V2 searches."
      },
      "ClickUri": {
        "type": "string",
        "description": "> This property is deprecated; it should not be populated by Search API V2 searches."
      },
      "UniqueId": {
        "type": "string",
        "description": "> This property is deprecated; it should not be populated by Search API V2 searches."
      },
      "Excerpt": {
        "type": "string",
        "description": "> This property is deprecated; it should not be populated by Search API V2 searches."
      },
      "FirstSentences": {
        "type": "string",
        "description": "> This property is deprecated; it should not be populated by Search API V2 searches."
      }
    }
  }
}