Coveo · JSON Structure

Coveo Search Passagev3 Structure

Type: Properties: 0
AIAnalyticsCatalogCommerceCustomersExperiencesMachine LearningPersonalizationRecommendationsSearch

PassageV3 is a JSON Structure definition published by Coveo.

Meta-schema:

JSON Structure

Raw ↑
{
  "name": "PassageV3",
  "structure": {
    "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": {
        "type": "object",
        "required": [
          "title",
          "primaryid"
        ],
        "properties": {
          "title": {
            "type": "string"
          },
          "primaryid": {
            "type": "string",
            "description": "The primary identifier of the document.\n"
          }
        }
      }
    }
  }
}