Skip to main content

match_query

Function match_query 

Source
pub async fn match_query(
    __arg0: Path<String>,
    __arg1: State<Arc<AppState>>,
    __arg2: Json<MatchQueryRequest>,
) -> Result<Json<MatchQueryResponse>, (StatusCode, Json<MatchQueryError>)>
Expand description

Execute a MATCH query on a collection.

§Endpoint

POST /collections/{name}/match

§Example Request

{
  "query": "MATCH (a:Person)-[:KNOWS]->(b) WHERE similarity(a.vec, $v) > 0.8 RETURN a.name",
  "params": {
    "v": [0.1, 0.2, 0.3]
  }
}

§Errors

Returns error tuple with status code and JSON error in these cases:

  • 404 NOT_FOUND - Collection not found
  • 400 BAD_REQUEST - Parse error or not a MATCH query
  • 500 INTERNAL_SERVER_ERROR - Execution error