{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/coveo/main/json-schema/coveo-search-retrievepassagesresponsev3-schema.json",
  "title": "Coveo Search RetrievePassagesResponseV3",
  "type": "object",
  "required": [
    "items",
    "responseId"
  ],
  "description": "A response with the passage(s) retrieved from the user query.",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "text",
          "relevanceScore",
          "document"
        ],
        "properties": {
          "text": {
            "type": "string",
            "description": "The text associated to this passage.",
            "minLength": 0,
            "maxLength": 6000,
            "example": "Solar energy has several benefits including reducing electricity bills, providing a renewable energy source, and lowering carbon footprint.\""
          },
          "relevanceScore": {
            "type": "number",
            "format": "float",
            "example": 0.85,
            "description": "A score that indicates the relevance of a passage.\n\nThe score computation is based on cosine similarity between the passage and the query.\nThe computation logic and value range may change in the future.\n\nExample values:\n- A value of -1 (minimum) indicates that the passage is the semantic opposite of the query.\n- A value of 0 indicates that the passage is not semantically similar to the query.\n- A value of 1 (maximum) indicates that the passage is semantically similar to the query.\n"
          },
          "document": {
            "$ref": "#/components/schemas/PassageDocumentV3"
          }
        }
      }
    },
    "responseId": {
      "type": "string",
      "description": "A unique identifier for the retrieval request. This identifier can be used to track the retrieval request.\n",
      "example": "c0857557-5579-4f5e-8958-9befd7d1d4a8"
    }
  }
}