Coveo Search Retrievepassagesresponsev3 Structure

{
  "name": "RetrievePassagesResponseV3",
  "structure": {
    "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."
            },
            "relevanceScore": {
              "type": "number",
              "format": "float",
              "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": {}
          }
        }
      },
      "responseId": {
        "type": "string",
        "description": "A unique identifier for the retrieval request. This identifier can be used to track the retrieval request.\n"
      }
    }
  }
}