Coveo · Schema

Coveo Search RestFacetResult

AIAnalyticsCatalogCommerceCustomersExperiencesMachine LearningPersonalizationRecommendationsSearch

Properties

Name Type Description
field string The name of the field on which the facet is based. **Example: `author`
moreValuesAvailable boolean Whether additional values are available for the facet.
values array The returned facet values.
mlScore number The ranking score computed by Coveo ML DNE for this facet.
indexScore number The ranking score computed by the index for this facet.
isFromAutoSelect boolean Whether the facet was recommended by Coveo ML.
label string A human-readable title that describes the facet.
domain object The domain of the facet. It represents the lowest and highest values possible for this facet. **Note:** This property is only populated when the facet is a range facet and `generateAutomaticRanges: tr
View JSON Schema on GitHub

JSON Schema

coveo-search-restfacetresult-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/coveo/main/json-schema/coveo-search-restfacetresult-schema.json",
  "title": "Coveo Search RestFacetResult",
  "required": [
    "field",
    "indexScore",
    "moreValuesAvailable",
    "values"
  ],
  "type": "object",
  "properties": {
    "field": {
      "type": "string",
      "description": "The name of the field on which the facet is based.\n\n**Example: `author`",
      "example": "author"
    },
    "moreValuesAvailable": {
      "type": "boolean",
      "description": "Whether additional values are available for the facet."
    },
    "values": {
      "type": "array",
      "description": "The returned facet values.",
      "items": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/RestFacetResultValue"
          },
          {
            "$ref": "#/components/schemas/RestHierarchicalFacetResponseValue"
          }
        ]
      }
    },
    "mlScore": {
      "type": "number",
      "description": "The ranking score computed by Coveo ML DNE for this facet.",
      "format": "double"
    },
    "indexScore": {
      "type": "number",
      "description": "The ranking score computed by the index for this facet.",
      "format": "double"
    },
    "isFromAutoSelect": {
      "type": "boolean",
      "description": "Whether the facet was recommended by Coveo ML."
    },
    "label": {
      "type": "string",
      "description": "A human-readable title that describes the facet."
    },
    "domain": {
      "description": "The domain of the facet. It represents the lowest and highest values possible for this facet.\n\n**Note:** This property is only populated when the facet is a range facet and `generateAutomaticRanges: true` was requested.\n",
      "type": "object",
      "properties": {
        "start": {
          "description": "The start of the domain. It represents the lowest value possible for this facet.",
          "anyOf": [
            {
              "type": "string",
              "example": "2001-07-20T23:01:05"
            },
            {
              "type": "integer",
              "format": "int64"
            },
            {
              "type": "number"
            }
          ]
        },
        "end": {
          "description": "The end of the domain. It represents the highest value possible for this facet.",
          "anyOf": [
            {
              "type": "string",
              "example": "2001-07-20T23:01:05"
            },
            {
              "type": "integer",
              "format": "int64"
            },
            {
              "type": "number"
            }
          ]
        }
      }
    }
  }
}