beezyai

🏗 Welcome to your new SDK! 🏗

It has been generated successfully based on your OpenAPI spec. However, it is not yet ready for production use. Here are some next steps:

• [ ] 🛠 Make your SDK feel handcrafted by customizing it
• [ ] ♻️ Refine your SDK quickly by iterating locally with the Speakeasy CLI
• [ ] 🎁 Publish your SDK to package managers by configuring automatic publishing
• [ ] ✨ When ready to productionize, delete this section from the README

SDK Installation

NPM

npm add @speakeasy-sdks/beezyai

PNPM

pnpm add @speakeasy-sdks/beezyai

Bun

bun add @speakeasy-sdks/beezyai

Yarn

yarn add @speakeasy-sdks/beezyai zod

# Note that Yarn does not install peer dependencies automatically. You will need
# to install zod as shown above.

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage

Example

import { Beezy } from "@speakeasy-sdks/beezyai";

const beezy = new Beezy({
    token: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
    const result = await beezy.chat.stream({
        prompt: "<value>",
        model: "ex-30b",
    });

    for await (const event of result) {
        // Handle the event
    }
}

run();

Available Resources and Operations

chat

• stream - Stream a chat completion

finetune

• upload - Upload a file for fine-tuning

Server-sent event streaming

Server-sent events are used to stream content from certain operations. These operations will expose the stream as an async iterable that can be consumed using a for await...of loop. The loop will terminate when the server no longer has any events to send and closes the underlying connection.

import { Beezy } from "@speakeasy-sdks/beezyai";

const beezy = new Beezy({
    token: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
    const result = await beezy.chat.stream({
        prompt: "<value>",
        model: "ex-30b",
    });

    for await (const event of result) {
        // Handle the event
    }
}

run();

File uploads

Certain SDK methods accept files as part of a multi-part request. It is possible and typically recommended to upload files as a stream rather than reading the entire contents into memory. This avoids excessive memory consumption and potentially crashing with out-of-memory errors when working with very large files. The following example demonstrates how to attach a file stream to a request.

[!TIP]

Depending on your JavaScript runtime, there are convenient utilities that return a handle to a file without reading the entire contents into memory:

• Node.js v20+: Since v20, Node.js comes with a native openAsBlob function in node:fs.
• Bun: The native Bun.file function produces a file handle that can be used for streaming file uploads.
• Browsers: All supported browsers return an instance to a File when reading the value from an <input type="file"> element.
• Node.js v18: A file stream can be created using the fileFrom helper from fetch-blob/from.js.

import { Beezy } from "@speakeasy-sdks/beezyai";
import { openAsBlob } from "node:fs";

const beezy = new Beezy({
    token: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
    const result = await beezy.finetune.upload({
        file: await openAsBlob("./sample-file"),
        model: "ex-7b",
    });

    // Handle the result
    console.log(result);
}

run();

Error Handling

All SDK methods return a response object or throw an error. If Error objects are specified in your OpenAPI Spec, the SDK will throw the appropriate Error type.

| Error Object | Status Code | Content Type | | ------------------------------ | ------------------------------ | ------------------------------ | | errors.TooManyRequestsResponse | 429 | application/json | | errors.SDKError | 4xx-5xx | / |

Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The SDKValidationError that is thrown as a result will capture the raw value that failed validation in an attribute called rawValue. Additionally, a pretty() method is available on this error that can be used to log a nicely formatted string since validation errors can list many issues and the plain error string may be difficult read when debugging.

import { Beezy } from "@speakeasy-sdks/beezyai";
import { SDKValidationError } from "@speakeasy-sdks/beezyai/models/errors/sdkvalidationerror.js";

const beezy = new Beezy({
    token: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
    let result;
    try {
        result = await beezy.chat.stream({
            prompt: "<value>",
            model: "ex-30b",
        });
    } catch (err) {
        switch (true) {
            case err instanceof SDKValidationError: {
                // Validation errors can be pretty-printed
                console.error(err.pretty());
                // Raw value may also be inspected
                console.error(err.rawValue);
                return;
            }
            case err instanceof TooManyRequestsResponse: {
                console.error(err); // handle exception
                return;
            }
            default: {
                throw err;
            }
        }
    }

    for await (const event of result) {
        // Handle the event
    }
}

run();

Server Selection

Select Server by Index

You can override the default server globally by passing a server index to the serverIdx optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:

| # | Server | Variables | | - | ------ | --------- | | 0 | https://{env}.api.speakeasyapi.dev | env (default is prd) |

import { Beezy } from "@speakeasy-sdks/beezyai";

const beezy = new Beezy({
    serverIdx: 0,
    token: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
    const result = await beezy.chat.stream({
        prompt: "<value>",
        model: "ex-30b",
    });

    for await (const event of result) {
        // Handle the event
    }
}

run();

Variables

Some of the server options above contain variables. If you want to set the values of those variables, the following optional parameters are available when initializing the SDK client instance:

• env: models.ServerEnv

Override Server URL Per-Client

The default server can also be overridden globally by passing a URL to the serverURL optional parameter when initializing the SDK client instance. For example:

import { Beezy } from "@speakeasy-sdks/beezyai";

const beezy = new Beezy({
    serverURL: "https://{env}.api.speakeasyapi.dev",
    token: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
    const result = await beezy.chat.stream({
        prompt: "<value>",
        model: "ex-30b",
    });

    for await (const event of result) {
        // Handle the event
    }
}

run();

Custom HTTP Client

The TypeScript SDK makes API calls using an HTTPClient that wraps the native Fetch API. This client is a thin wrapper around fetch and provides the ability to attach hooks around the request lifecycle that can be used to modify the request or handle errors and response.

The HTTPClient constructor takes an optional fetcher argument that can be used to integrate a third-party HTTP client or when writing tests to mock out the HTTP client and feed in fixtures.

The following example shows how to use the "beforeRequest" hook to to add a custom header and a timeout to requests and how to use the "requestError" hook to log errors:

import { Beezy } from "@speakeasy-sdks/beezyai";
import { HTTPClient } from "@speakeasy-sdks/beezyai/lib/http";

const httpClient = new HTTPClient({
  // fetcher takes a function that has the same signature as native `fetch`.
  fetcher: (request) => {
    return fetch(request);
  }
});

httpClient.addHook("beforeRequest", (request) => {
  const nextRequest = new Request(request, {
    signal: request.signal || AbortSignal.timeout(5000)
  });

  nextRequest.headers.set("x-custom-header", "custom value");

  return nextRequest;
});

httpClient.addHook("requestError", (error, request) => {
  console.group("Request Error");
  console.log("Reason:", `${error}`);
  console.log("Endpoint:", `${request.method} ${request.url}`);
  console.groupEnd();
});

const sdk = new Beezy({ httpClient });

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

| Name | Type | Scheme | | ----------- | ----------- | ----------- | | token | http | HTTP Bearer |

To authenticate with the API the token parameter must be set when initializing the SDK client instance. For example:

import { Beezy } from "@speakeasy-sdks/beezyai";

const beezy = new Beezy({
    token: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
    const result = await beezy.chat.stream({
        prompt: "<value>",
        model: "ex-30b",
    });

    for await (const event of result) {
        // Handle the event
    }
}

run();

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!

SDK Created by Speakeasy