fermisdk¶

Developer-friendly & type-safe Typescript SDK specifically catered to leverage fermisdk API.

Summary¶

Fermi API: API documentation for Fermi platform including data connectors, brain visualization, and chat/session management

Table of Contents¶

• fermisdk
• SDK Installation
• Requirements
• SDK Example Usage
• Authentication
• Available Resources and Operations
• Standalone functions
• File uploads
• Retries
• Error Handling
• Server Selection
• Custom HTTP Client
• Debugging
• Development
• Maturity
• Contributions

SDK Installation¶

The SDK can be installed with either npm, pnpm, bun or yarn package managers.

NPM¶

npm i @fermidevsdk/fermi

PNPM¶

pnpm add @fermidevsdk/fermi

Bun¶

bun add @fermidevsdk/fermi

Yarn¶

yarn add @fermidevsdk/fermi

[!NOTE] This package is published with CommonJS and ES Modules (ESM) support.

Requirements¶

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage¶

Example¶

import { Fermisdk } from "@fermidevsdk/fermi";

const fermisdk = new Fermisdk({
  bearerAuth: process.env["FERMISDK_BEARER_AUTH"] ?? "",
});

async function run() {
  const result = await fermisdk.brain.performVisualization({
    action: "visualization",
  });

  console.log(result);
}

run();

Authentication¶

Per-Client Security Schemes¶

This SDK supports the following security scheme globally:

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

import { Fermisdk } from "fermisdk";

const fermisdk = new Fermisdk({
  bearerAuth: process.env["FERMISDK_BEARER_AUTH"] ?? "",
});

async function run() {
  const result = await fermisdk.brain.performVisualization({
    action: "visualization",
  });

  console.log(result);
}

run();

Available Resources and Operations¶

Standalone functions¶

All the methods listed above are available as standalone functions. These functions are ideal for use in applications running in the browser, serverless runtimes or other environments where application bundle size is a primary concern. When using a bundler to build your application, all unused functionality will be either excluded from the final bundle or tree-shaken away.

To read more about standalone functions, check FUNCTIONS.md.

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 { Fermisdk } from "fermisdk";

const fermisdk = new Fermisdk({
  bearerAuth: process.env["FERMISDK_BEARER_AUTH"] ?? "",
});

async function run() {
  const result = await fermisdk.dataConnectors.uploadDocuments({
    files: [],
  });

  console.log(result);
}

run();

Retries¶

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:

import { Fermisdk } from "fermisdk";

const fermisdk = new Fermisdk({
  bearerAuth: process.env["FERMISDK_BEARER_AUTH"] ?? "",
});

async function run() {
  const result = await fermisdk.brain.performVisualization({
    action: "visualization",
  }, {
    retries: {
      strategy: "backoff",
      backoff: {
        initialInterval: 1,
        maxInterval: 50,
        exponent: 1.1,
        maxElapsedTime: 100,
      },
      retryConnectionErrors: false,
    },
  });

  console.log(result);
}

run();

If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:

import { Fermisdk } from "fermisdk";

const fermisdk = new Fermisdk({
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
  bearerAuth: process.env["FERMISDK_BEARER_AUTH"] ?? "",
});

async function run() {
  const result = await fermisdk.brain.performVisualization({
    action: "visualization",
  });

  console.log(result);
}

run();

Error Handling¶

FermisdkError is the base class for all HTTP error responses. It has the following properties:

Example¶

import { Fermisdk } from "fermisdk";
import * as errors from "fermisdk/models/errors";

const fermisdk = new Fermisdk({
  bearerAuth: process.env["FERMISDK_BEARER_AUTH"] ?? "",
});

async function run() {
  try {
    const result = await fermisdk.brain.performVisualization({
      action: "visualization",
    });

    console.log(result);
  } catch (error) {
    // The base class for HTTP error responses
    if (error instanceof errors.FermisdkError) {
      console.log(error.message);
      console.log(error.statusCode);
      console.log(error.body);
      console.log(error.headers);

      // Depending on the method different errors may be thrown
      if (error instanceof errors.ErrorT) {
        console.log(error.data$.error); // string
        console.log(error.data$.detail); // string
      }
    }
  }
}

run();

Error Classes¶

Primary errors: * FermisdkError: The base class for HTTP error responses. * ErrorT: Generic error.

Server Selection¶

Override Server URL Per-Client¶

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

import { Fermisdk } from "fermisdk";

const fermisdk = new Fermisdk({
  serverURL: "https://api.fermi.dev/public/v1",
  bearerAuth: process.env["FERMISDK_BEARER_AUTH"] ?? "",
});

async function run() {
  const result = await fermisdk.brain.performVisualization({
    action: "visualization",
  });

  console.log(result);
}

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 { Fermisdk } from "fermisdk";
import { HTTPClient } from "fermisdk/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 Fermisdk({ httpClient: httpClient });

Debugging¶

You can setup your SDK to emit debug logs for SDK requests and responses.

You can pass a logger that matches console's interface as an SDK option.

[!WARNING] Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.

import { Fermisdk } from "fermisdk";

const sdk = new Fermisdk({ debugLogger: console });

You can also enable a default debug logger by setting an environment variable FERMISDK_DEBUG to true.

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. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.

SDK Created by Speakeasy¶