{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/coveo/main/json-schema/coveo-search-passagev3-schema.json",
  "title": "Coveo Search PassageV3",
  "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": {
      "type": "object",
      "required": [
        "title",
        "primaryid"
      ],
      "properties": {
        "title": {
          "type": "string",
          "example": "The Benefits of Solar Energy"
        },
        "primaryid": {
          "type": "string",
          "description": "The primary identifier of the document.\n",
          "example": "bDMzdA"
        }
      },
      "additionalProperties": true
    }
  }
}