vectorize_index-query-request

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/vectorize_index-query-request",
  "title": "vectorize_index-query-request",
  "properties": {
    "filter": {
      "description": "A metadata filter expression used to limit nearest neighbor results.",
      "example": {
        "has_viewed": {
          "$ne": true
        },
        "streaming_platform": "netflix"
      },
      "type": "object"
    },
    "returnMetadata": {
      "default": false,
      "description": "Whether to return the metadata associated with the closest vectors.",
      "type": "boolean"
    },
    "returnValues": {
      "default": false,
      "description": "Whether to return the values associated with the closest vectors.",
      "type": "boolean"
    },
    "topK": {
      "default": 5,
      "description": "The number of nearest neighbors to find.",
      "example": 5,
      "type": "number"
    },
    "vector": {
      "description": "The search vector that will be used to find the nearest neighbors.",
      "example": [
        0.5,
        0.5,
        0.5
      ],
      "items": {
        "type": "number"
      },
      "type": "array"
    }
  },
  "required": [
    "vector"
  ],
  "type": "object"
}