orq-node-client

Developer-friendly & type-safe Typescript SDK specifically catered to leverage orq-node-client API.

[!IMPORTANT] This SDK is not yet ready for production use. To complete setup please follow the steps outlined in your workspace. Delete this section before > publishing to a package manager.

Summary

[Dev] orq.ai API: The Orquesta API

For more information about the API: orq.ai Documentation

Table of Contents

• SDK Installation
• Requirements
• SDK Example Usage
• Available Resources and Operations
• Standalone functions
• Server-sent event streaming
• Retries
• Error Handling
• Server Selection
• Custom HTTP Client
• Authentication
• Debugging

SDK Installation

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

NPM

npm add <UNSET>

PNPM

pnpm add <UNSET>

Bun

bun add <UNSET>

Yarn

yarn add <UNSET> 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 { Orq } from "orq-node-client";

const orq = new Orq({
  bearer: process.env["ORQ_BEARER"] ?? "",
});

async function run() {
  const result = await orq.contacts.postContacts({
    externalId: "<id>",
  });

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

run();

Available Resources and Operations

contacts

• postContacts - Update user information

deployments

• postV2DeploymentsGetConfig - Get config
• postV2DeploymentsInvoke - Invoke
• postV2DeploymentsIdMetrics - Add metrics

feedback

• postFeedback - Submit feedback

files

• postV2Files - Upload file
• postV2FilesBulk - Bulk upload file

public

• postV2DeploymentsGetConfig - Get config
• postV2DeploymentsInvoke - Invoke
• postV2DeploymentsIdMetrics - Add metrics
• postV2Files - Upload file
• postV2FilesBulk - Bulk upload file
• postV2RouterEmbeddings - Embeddings
• postV2RouterChatCompletions - Chat
• postV2RouterCompletions - legacy completions route
• postV2RouterRerank - rerank route
• postV2RouterImagesGenerations
• postV2ResourcesDatasets - Create a dataset
• getV2ResourcesDatasets - Get all datasets
• deleteV2ResourcesDatasetsDatasetId - Delete a dataset
• getV2ResourcesDatasetsDatasetId - Get one dataset
• patchV2ResourcesDatasetsDatasetId - Update a dataset
• postV2ResourcesDatasetsDatasetIdRowsBulk - Create a list of dataset rows
• deleteV2ResourcesDatasetsDatasetIdRowsBulk - Delete a list of dataset rows
• postV2ResourcesDatasetsDatasetIdRows - Create a dataset row
• getV2ResourcesDatasetsDatasetIdRows - Retrieve all dataset rows
• deleteV2ResourcesDatasetsDatasetIdRowsRowId - Delete a dataset row
• getV2ResourcesDatasetsDatasetIdRowsRowId - Get one dataset row
• patchV2ResourcesDatasetsDatasetIdRowsRowId - Update a dataset row

resources

• postV2ResourcesDatasets - Create a dataset
• getV2ResourcesDatasets - Get all datasets
• deleteV2ResourcesDatasetsDatasetId - Delete a dataset
• getV2ResourcesDatasetsDatasetId - Get one dataset
• patchV2ResourcesDatasetsDatasetId - Update a dataset
• postV2ResourcesDatasetsDatasetIdRowsBulk - Create a list of dataset rows
• deleteV2ResourcesDatasetsDatasetIdRowsBulk - Delete a list of dataset rows
• postV2ResourcesDatasetsDatasetIdRows - Create a dataset row
• getV2ResourcesDatasetsDatasetIdRows - Retrieve all dataset rows
• deleteV2ResourcesDatasetsDatasetIdRowsRowId - Delete a dataset row
• getV2ResourcesDatasetsDatasetIdRowsRowId - Get one dataset row
• patchV2ResourcesDatasetsDatasetIdRowsRowId - Update a dataset row

router

• postV2RouterEmbeddings - Embeddings
• postV2RouterChatCompletions - Chat
• postV2RouterCompletions - legacy completions route
• postV2RouterRerank - rerank route
• postV2RouterImagesGenerations

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.

• contactsPostContacts - Update user information
• deploymentsPostV2DeploymentsGetConfig - Get config
• deploymentsPostV2DeploymentsIdMetrics - Add metrics
• deploymentsPostV2DeploymentsInvoke - Invoke
• feedbackPostFeedback - Submit feedback
• filesPostV2Files - Upload file
• filesPostV2FilesBulk - Bulk upload file
• publicDeleteV2ResourcesDatasetsDatasetId - Delete a dataset
• publicDeleteV2ResourcesDatasetsDatasetIdRowsBulk - Delete a list of dataset rows
• publicDeleteV2ResourcesDatasetsDatasetIdRowsRowId - Delete a dataset row
• publicGetV2ResourcesDatasets - Get all datasets
• publicGetV2ResourcesDatasetsDatasetId - Get one dataset
• publicGetV2ResourcesDatasetsDatasetIdRows - Retrieve all dataset rows
• publicGetV2ResourcesDatasetsDatasetIdRowsRowId - Get one dataset row
• publicPatchV2ResourcesDatasetsDatasetId - Update a dataset
• publicPatchV2ResourcesDatasetsDatasetIdRowsRowId - Update a dataset row
• publicPostV2DeploymentsGetConfig - Get config
• publicPostV2DeploymentsIdMetrics - Add metrics
• publicPostV2DeploymentsInvoke - Invoke
• publicPostV2Files - Upload file
• publicPostV2FilesBulk - Bulk upload file
• publicPostV2ResourcesDatasets - Create a dataset
• publicPostV2ResourcesDatasetsDatasetIdRows - Create a dataset row
• publicPostV2ResourcesDatasetsDatasetIdRowsBulk - Create a list of dataset rows
• publicPostV2RouterChatCompletions - Chat
• publicPostV2RouterCompletions - legacy completions route
• publicPostV2RouterEmbeddings - Embeddings
• publicPostV2RouterImagesGenerations
• publicPostV2RouterRerank - rerank route
• resourcesDeleteV2ResourcesDatasetsDatasetId - Delete a dataset
• resourcesDeleteV2ResourcesDatasetsDatasetIdRowsBulk - Delete a list of dataset rows
• resourcesDeleteV2ResourcesDatasetsDatasetIdRowsRowId - Delete a dataset row
• resourcesGetV2ResourcesDatasets - Get all datasets
• resourcesGetV2ResourcesDatasetsDatasetId - Get one dataset
• resourcesGetV2ResourcesDatasetsDatasetIdRows - Retrieve all dataset rows
• resourcesGetV2ResourcesDatasetsDatasetIdRowsRowId - Get one dataset row
• resourcesPatchV2ResourcesDatasetsDatasetId - Update a dataset
• resourcesPatchV2ResourcesDatasetsDatasetIdRowsRowId - Update a dataset row
• resourcesPostV2ResourcesDatasets - Create a dataset
• resourcesPostV2ResourcesDatasetsDatasetIdRows - Create a dataset row
• resourcesPostV2ResourcesDatasetsDatasetIdRowsBulk - Create a list of dataset rows
• routerPostV2RouterChatCompletions - Chat
• routerPostV2RouterCompletions - legacy completions route
• routerPostV2RouterEmbeddings - Embeddings
• routerPostV2RouterImagesGenerations
• routerPostV2RouterRerank - rerank route

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 { Orq } from "orq-node-client";

const orq = new Orq({
  bearer: process.env["ORQ_BEARER"] ?? "",
});

async function run() {
  const result = await orq.deployments.postV2DeploymentsInvoke({
    key: "<key>",
  });

  for await (const event of result) {
    // Handle the event
    console.log(event);
  }
}

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 { Orq } from "orq-node-client";

const orq = new Orq({
  bearer: process.env["ORQ_BEARER"] ?? "",
});

async function run() {
  const result = await orq.contacts.postContacts({
    externalId: "<id>",
  }, {
    retries: {
      strategy: "backoff",
      backoff: {
        initialInterval: 1,
        maxInterval: 50,
        exponent: 1.1,
        maxElapsedTime: 100,
      },
      retryConnectionErrors: false,
    },
  });

  // Handle the result
  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 { Orq } from "orq-node-client";

const orq = new Orq({
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
  bearer: process.env["ORQ_BEARER"] ?? "",
});

async function run() {
  const result = await orq.contacts.postContacts({
    externalId: "<id>",
  });

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

run();

Error Handling

All SDK methods return a response object or throw an error. By default, an API error will throw a errors.SDKError.

If a HTTP request fails, an operation my also throw an error from the models/errors/httpclienterrors.ts module:

| HTTP Client Error | Description | | ---------------------------------------------------- | ---------------------------------------------------- | | RequestAbortedError | HTTP request was aborted by the client | | RequestTimeoutError | HTTP request timed out due to an AbortSignal signal | | ConnectionError | HTTP client was unable to make a request to a server | | InvalidRequestError | Any input used to create a request is invalid | | UnexpectedClientError | Unrecognised or unexpected error |

In addition, when custom error responses are specified for an operation, the SDK may throw their associated Error type. You can refer to respective Errors tables in SDK docs for more details on possible error types for each operation. For example, the getV2ResourcesDatasetsDatasetId method may throw the following errors:

| Error Type | Status Code | Content Type | | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | | errors.GetV2ResourcesDatasetsDatasetIdResponseBody | 404 | application/json | | errors.SDKError | 4XX, 5XX | */* |

import { Orq } from "orq-node-client";
import {
  GetV2ResourcesDatasetsDatasetIdResponseBody,
  SDKValidationError,
} from "orq-node-client/models/errors";

const orq = new Orq({
  bearer: process.env["ORQ_BEARER"] ?? "",
});

async function run() {
  let result;
  try {
    result = await orq.public.getV2ResourcesDatasetsDatasetId({
      datasetId: "<id>",
    });

    // Handle the result
    console.log(result);
  } 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 GetV2ResourcesDatasetsDatasetIdResponseBody): {
        // Handle err.data$: GetV2ResourcesDatasetsDatasetIdResponseBodyData
        console.error(err);
        return;
      }
      default: {
        throw err;
      }
    }
  }
}

run();

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.

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://my.dev.orq.ai | None |

import { Orq } from "orq-node-client";

const orq = new Orq({
  serverIdx: 0,
  bearer: process.env["ORQ_BEARER"] ?? "",
});

async function run() {
  const result = await orq.contacts.postContacts({
    externalId: "<id>",
  });

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

run();

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 { Orq } from "orq-node-client";

const orq = new Orq({
  serverURL: "https://my.dev.orq.ai",
  bearer: process.env["ORQ_BEARER"] ?? "",
});

async function run() {
  const result = await orq.contacts.postContacts({
    externalId: "<id>",
  });

  // Handle the result
  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 { Orq } from "orq-node-client";
import { HTTPClient } from "orq-node-client/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 Orq({ httpClient });

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

| Name | Type | Scheme | Environment Variable | | -------------------- | -------------------- | -------------------- | -------------------- | | bearer | http | HTTP Bearer | ORQ_BEARER |

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

import { Orq } from "orq-node-client";

const orq = new Orq({
  bearer: process.env["ORQ_BEARER"] ?? "",
});

async function run() {
  const result = await orq.contacts.postContacts({
    externalId: "<id>",
  });

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

run();

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 { Orq } from "orq-node-client";

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

You can also enable a default debug logger by setting an environment variable ORQ_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