Voyage TypeScript Library


The Voyage TypeScript library provides convenient access to the Voyage APIs from TypeScript.

Table of Contents

- Documentation
- Installation
- Batch Request
- Usage
- Request and Response Types
- Exception Handling
- Advanced
- Retries
- Timeouts
- Aborting Requests
- Runtime Compatibility
- Contributing
- Reference

Documentation

API reference documentation is available here.

Installation

``sh
npm i -s voyageai
`

Batch request

The SDK supports batch requests. Instantiate and use the client similarly as above:

`typescript
import { VoyageAIClient } from "voyageai";

const client = new VoyageAIClient({ apiKey: "YOUR_API_KEY" });
await client.embed({
input: ["input1", "input2", "input3", "input4"],
model: "model",
});
`

Usage

Instantiate and use the client with the following:

`typescript
import { VoyageAIClient } from "voyageai";

const client = new VoyageAIClient({ apiKey: "YOUR_API_KEY" });
await client.embed({
input: "input",
model: "model",
});
`

Request and Response Types

The SDK exports all request and response types as TypeScript interfaces. Simply import them with the
following namespace:

`typescript
import { VoyageAI } from "voyageai";

const request: VoyageAI.EmbedRequest = {
...
};
`

Exception Handling

When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error
will be thrown.

`typescript
import { VoyageAIError } from "voyageai";

try {
await client.embed(...);
} catch (err) {
if (err instanceof VoyageAIError) {
console.log(err.statusCode);
console.log(err.message);
console.log(err.body);
}
}
`

Advanced

$3

The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long
as the request is deemed retriable and the number of retry attempts has not grown larger than the configured
retry limit (default: 2).

A request is deemed retriable when any of the following HTTP status codes is returned:

- 408 (Timeout)
- 429 (Too Many Requests)
- 5XX (Internal Server Errors)

Use the maxRetries request option to configure this behavior.

`typescript
const response = await client.embed(..., {
maxRetries: 0 // override maxRetries at the request level
});
`

$3

The SDK defaults to a 60 second timeout. Use the timeoutInSeconds option to configure this behavior.

`typescript
const response = await client.embed(..., {
timeoutInSeconds: 30 // override timeout to 30s
});
`

$3

The SDK allows users to abort requests at any point by passing in an abort signal.

`typescript
const controller = new AbortController();
const response = await client.embed(..., {
abortSignal: controller.signal
});
controller.abort(); // aborts the request
`

$3

The SDK defaults to node-fetch but will use the global fetch client if present. The SDK works in the following
runtimes:

- Node.js 18+
- Vercel
- Cloudflare Workers
- Deno v1.25+
- Bun 1.0+
- React Native

$3

The SDK provides a way for your to customize the underlying HTTP client / Fetch function. If you're running in an
unsupported environment, this provides a way for you to break glass and ensure the SDK works.

`typescript
import { VoyageAIClient } from "voyageai";

const client = new VoyageAIClient({
...
fetcher: // provide your implementation here
});
``

Contributing

While we value open-source contributions to this SDK, this library is generated programmatically.
Additions made directly to this library would have to be moved over to our generation code,
otherwise they would be overwritten upon the next generated release. Feel free to open a PR as
a proof of concept, but know that we will not be able to merge it as-is. We suggest opening
an issue first to discuss with us!

On the other hand, contributions to the README are always very welcome!

Reference

A full reference for this library is available here.