vectorize_index-query-response

APIs.ioEngineeringPlatform

Properties

Name Type Description
count integer Specifies the count of vectors returned by the search
matches array Array of vectors matched by the search
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-vectorize-index-query-response-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/vectorize_index-query-response",
  "title": "vectorize_index-query-response",
  "properties": {
    "count": {
      "description": "Specifies the count of vectors returned by the search",
      "type": "integer"
    },
    "matches": {
      "description": "Array of vectors matched by the search",
      "items": {
        "properties": {
          "id": {
            "$ref": "#/components/schemas/vectorize_vector-identifier"
          },
          "metadata": {
            "nullable": true,
            "type": "object"
          },
          "score": {
            "description": "The score of the vector according to the index's distance metric",
            "type": "number"
          },
          "values": {
            "items": {
              "type": "number"
            },
            "nullable": true,
            "type": "array"
          }
        },
        "type": "object"
      },
      "type": "array"
    }
  },
  "type": "object"
}