Skip to content

VectorService

Vector search operations.

Proto source

query/vector.proto

Transport

All methods are available via:

  • gRPC on port 7080 — native high-performance API
  • REST/JSON on port 7081 — HTTP/JSON transcoding via embedded structured-proxy

Methods

VectorSearch

Search for nearest neighbors by vector similarity.

HTTP: POST /v1/query/vector/search

Request: VectorSearchRequest

FieldTypeDescription
labelstringLabel to search within.
propertystringProperty name containing vectors.
query_vectorVectorQuery vector.
top_kuint32Number of nearest neighbors to return.
metricDistanceMetricDistance metric (cosine, l2, dot, l1).

Response: VectorSearchResponse

FieldTypeDescription
resultsVectorResult[]

HybridSearch

Hybrid search combining graph traversal and vector similarity.

HTTP: POST /v1/query/vector/hybrid

Request: HybridSearchRequest

FieldTypeDescription
start_node_iduint64Starting node for graph traversal.
edge_typestringEdge type to traverse.
max_depthuint32Max traversal depth.
vector_propertystringVector search parameters applied after traversal.
query_vectorVector
top_kuint32
metricDistanceMetric

Response: HybridSearchResponse

FieldTypeDescription
resultsVectorResult[]

Types

HybridSearchRequest

FieldTypeDescription
start_node_iduint64Starting node for graph traversal.
edge_typestringEdge type to traverse.
max_depthuint32Max traversal depth.
vector_propertystringVector search parameters applied after traversal.
query_vectorVector
top_kuint32
metricDistanceMetric

HybridSearchResponse

FieldTypeDescription
resultsVectorResult[]

VectorResult

FieldTypeDescription
nodeNode
distancefloat

VectorSearchRequest

FieldTypeDescription
labelstringLabel to search within.
propertystringProperty name containing vectors.
query_vectorVectorQuery vector.
top_kuint32Number of nearest neighbors to return.
metricDistanceMetricDistance metric (cosine, l2, dot, l1).

VectorSearchResponse

FieldTypeDescription
resultsVectorResult[]

Enums

DistanceMetric

ValueNumberDescription
DISTANCE_METRIC_UNSPECIFIED0
DISTANCE_METRIC_COSINE1
DISTANCE_METRIC_L22
DISTANCE_METRIC_DOT3
DISTANCE_METRIC_L14