Search Results

Search Results

Common across all search endpoints, there are a number of fields returned in the results JSON.

results

An array of matched documents with their id and score. The id is the document ID provided during ingestion. The score is the document's calculated relevance to the query from the Vantage platform's semantic similarity search algorithm.

{
  ...
  "results": [
      {
          "id": "84740262",
          "score": 0.8804768323898315
      },
      {
          "id": "96220430",
          "score": 0.8755715489387512
      },
      ....
  ],
}

request_id

The same request_id you passed to the search endpoint.

{
  "request_id": 333666,
  ...
}

execution_time

The elapsed time in milliseconds that the Vantage platform took to search and return the results.

{
  "execution_time": 89,
  ...
}

status

The status code, matched to HTTP status codes, for the result of the search call.

Status CodeStatus Message
200Success OK
500Internal Server Error
403Unknown api key, please check your api key and try again
{
  "status": 200,
  ...
}

message

More detail on the reason for the status code. See status messages above for example messages that come with corresponding status codes.

{
  "status": 403,
  "message": "Unknown api key, please check your api key and try again"
  ...
}

πŸ“˜

Reference Guide for Search API