Amazon Kendra · Schema

QueryResult

Amazon Kendra query result containing ranked document passages and answers.

AIEnterprise SearchKnowledge ManagementMachine LearningNatural Language

Properties

Name Type Description
QueryId string The unique identifier for the query.
ResultItems array The results of the search query.
TotalNumberOfResults integer The total number of items found.
FacetResults array Contains the facet results.
View JSON Schema on GitHub

JSON Schema

amazon-kendra-query-result-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-kendra/refs/heads/main/json-schema/amazon-kendra-query-result-schema.json",
  "title": "QueryResult",
  "description": "Amazon Kendra query result containing ranked document passages and answers.",
  "type": "object",
  "properties": {
    "QueryId": {
      "type": "string",
      "description": "The unique identifier for the query.",
      "example": "q-abc12345"
    },
    "ResultItems": {
      "type": "array",
      "description": "The results of the search query.",
      "items": {
        "type": "object"
      }
    },
    "TotalNumberOfResults": {
      "type": "integer",
      "description": "The total number of items found.",
      "example": 42
    },
    "FacetResults": {
      "type": "array",
      "description": "Contains the facet results.",
      "items": {
        "type": "object"
      }
    }
  }
}