GET
/
evaluate
/
query
/
{query_id}
JavaScript
import Hyperspell from 'hyperspell';

const client = new Hyperspell({
  apiKey: 'My API Key',
});

const queryResult = await client.evaluate.getQuery('query_id');

console.log(queryResult.query_id);
{
  "query_id": "<string>",
  "errors": [
    {}
  ],
  "documents": [
    {
      "source": "collections",
      "resource_id": "<string>",
      "title": "<string>",
      "metadata": {
        "created_at": "2023-11-07T05:31:56Z",
        "indexed_at": "2023-11-07T05:31:56Z",
        "last_modified": "2023-11-07T05:31:56Z",
        "status": "pending",
        "events": [
          {
            "message": "<string>",
            "time": "2023-11-07T05:31:56Z",
            "type": "error"
          }
        ],
        "url": "<string>"
      },
      "score": 123
    }
  ],
  "answer": "<string>",
  "score": 123
}

Authorizations

​
Authorization
string
header
required

API Key or JWT User Token. If using an API Key, set the X-As-User header to act as a specific user. A JWT User Token is always scoped to a specific user.

Path Parameters

​
query_id
string
required

Response

Successful Response

​
documents
Resource · object[]
required
​
query_id
string | null

The ID of the query. This can be used to retrieve the query later, or add feedback to it. If the query failed, this will be None.

​
errors
Errors · object[] | null

Errors that occurred during the query. These are meant to help the developer debug the query, and are not meant to be shown to the user.

​
answer
string | null

The answer to the query, if the request was set to answer.

​
score
number | null

The average score of the query feedback, if any.