Node.js SDK
The Node.js SDK spice.js is the easiest way to use and query Spice.ai with Node.js.
It uses Apache Apache Flight to efficiently stream data to the client and Apache Arrow Records as data frames which are then easily converted to JavaScript objects/arrays or JSON.
Requirements
Installation
Usage
Import SpiceClient
and instantiate a new instance with an API Key.
You can then submit queries using the query
function.
SpiceClient
has the following arguments:
apiKey
(string, required): API key to authenticate with the endpoint.url
(string, optional): URL of the endpoint to use (default: flight.spiceai.io:443)
Usage with local Spice runtime
Follow the quickstart guide to install and run spice locally.
Check Spice OSS documentation to learn more.
Connection retry
From version 1.0.1 the SpiceClient
implements connection retry mechanism (3 attempts by default). The number of attempts can be configured via setMaxRetries
:
Retries are performed for connection and system internal errors. It is the SDK user's responsibility to properly handle other errors, for example RESOURCE_EXHAUSTED (HTTP 429)
.
Contributing
Contribute to or file an issue with the spice.js
library at: https://github.com/spiceai/spice.js.
Last updated