vectorize_index-query-v2-request

APIs.ioEngineeringPlatform

Properties

Name	Type	Description
filter	object	A metadata filter expression used to limit nearest neighbor results.
returnMetadata	string	Whether to return no metadata, indexed metadata or all metadata associated with the closest vectors.
returnValues	boolean	Whether to return the values associated with the closest vectors.
topK	number	The number of nearest neighbors to find.
vector	array	The search vector that will be used to find the nearest neighbors.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/vectorize_index-query-v2-request",
  "title": "vectorize_index-query-v2-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": "none",
      "description": "Whether to return no metadata, indexed metadata or all metadata associated with the closest vectors.",
      "enum": [
        "none",
        "indexed",
        "all"
      ],
      "type": "string"
    },
    "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"
}