← 输入框|github.com|刷新
Skip to content
orq-ai
orq-node
Public

About

orq.ai TypeScript SDK

orq.ai

Resources

Readme

Contributing

Contributing
Activity
Custom properties

Stars

11 stars

Watchers

3 watching

Forks

1 fork
Report repository
BranchesTags

Repository files navigation

@orq-ai/node

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

Summary

orq.ai API: orq.ai API documentation

For more information about the API: orq.ai Documentation

Table of Contents

SDK Installation

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

NPM

npm add @orq-ai/node

PNPM

pnpm add @orq-ai/node

Bun

bun add @orq-ai/node

Yarn

yarn add @orq-ai/node

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage

Example

import { Orq } from "@orq-ai/node";

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

async function run() {
  const result = await orq.deployments.invoke({
    key: "<key>",
    identity: {
      id: "contact_01ARZ3NDEKTSV4RRFFQ69G5FAV",
      displayName: "Jane Doe",
      email: "jane.doe@example.com",
      metadata: [
        {
          "department": "Engineering",
          "role": "Senior Developer",
        },
      ],
      logoUrl: "https://example.com/avatars/jane-doe.jpg",
      tags: [
        "hr",
        "engineering",
      ],
    },
    documents: [
      {
        text:
          "The refund policy allows customers to return items within 30 days of purchase for a full refund.",
        metadata: {
          fileName: "refund_policy.pdf",
          fileType: "application/pdf",
          pageNumber: 1,
        },
      },
      {
        text: "Premium members receive free shipping on all orders over $50.",
        metadata: {
          fileName: "membership_benefits.md",
          fileType: "text/markdown",
        },
      },
    ],
  });

  console.log(result);
}

run();

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name Type Scheme Environment Variable
apiKey http HTTP Bearer ORQ_API_KEY

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

import { Orq } from "@orq-ai/node";

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

async function run() {
  const result = await orq.deployments.invoke({
    key: "<key>",
    identity: {
      id: "contact_01ARZ3NDEKTSV4RRFFQ69G5FAV",
      displayName: "Jane Doe",
      email: "jane.doe@example.com",
      metadata: [
        {
          "department": "Engineering",
          "role": "Senior Developer",
        },
      ],
      logoUrl: "https://example.com/avatars/jane-doe.jpg",
      tags: [
        "hr",
        "engineering",
      ],
    },
    documents: [
      {
        text:
          "The refund policy allows customers to return items within 30 days of purchase for a full refund.",
        metadata: {
          fileName: "refund_policy.pdf",
          fileType: "application/pdf",
          pageNumber: 1,
        },
      },
      {
        text: "Premium members receive free shipping on all orders over $50.",
        metadata: {
          fileName: "membership_benefits.md",
          fileType: "text/markdown",
        },
      },
    ],
  });

  console.log(result);
}

run();

Available Resources and Operations

Available methods

Agents

  • create - Create agent
  • list - List agents
  • delete - Delete agent
  • retrieve - Retrieve agent
  • update - Update agent
  • invoke - Execute an agent task ⚠️ Deprecated
  • run - Run an agent with configuration ⚠️ Deprecated
  • streamRun - Run agent with streaming response ⚠️ Deprecated
  • stream - Stream agent execution in real-time ⚠️ Deprecated

Agents.External

Agents.Responses

  • create - Create response ⚠️ Deprecated
  • get - Get response ⚠️ Deprecated

Alerts

AnnotationQueues

  • list - List annotation queues
  • create - Create an annotation queue
  • retrieve - Retrieve an annotation queue
  • delete - Delete an annotation queue
  • update - Update an annotation queue
  • clear - Clear an annotation queue
  • listItems - Query items from an annotation queue
  • addItems - Add items to an annotation queue
  • removeItems - Remove items from an annotation queue
  • retrieveItem - Retrieve an annotation queue item

Annotations

  • create - Annotate a span
  • delete - Remove an annotation from a span

ApiKeys

AuditLogDestinations

  • list - List audit log destinations
  • create - Create an audit log destination
  • get - Retrieve an audit log destination
  • delete - Delete an audit log destination
  • update - Update an audit log destination
  • listDeliveries - List deliveries
  • replay - Replay audit events
  • rotateSecret - Rotate the signing secret
  • test - Send a test event

Budgets

Chunking

Datasets

Deployments

Environments

  • list - List environments
  • create - Create an environment
  • get - Retrieve an environment
  • delete - Delete an environment
  • update - Update an environment

Evals

Feedback

Files

FileSystems

GuardrailRules

Hub

  • search - Search hub items
  • get - Get a hub item

HumanReviewSets

  • list - Get all human review sets ⚠️ Deprecated
  • create - Create a human review set ⚠️ Deprecated
  • get - Get a human review set by ID ⚠️ Deprecated
  • update - Update a human review set ⚠️ Deprecated
  • delete - Delete a human review set ⚠️ Deprecated

Identities

Knowledge

Logs

ManagementKeys

  • list - List management keys
  • create - Create a new management key
  • listCapabilities - List management capability catalog
  • get - Retrieve a management key
  • delete - Delete a management key
  • update - Update a management key

McpGateways

  • list - List MCP gateways
  • create - Create an MCP gateway
  • listTools - List exposed tools for a gateway
  • retrieve - Retrieve an MCP gateway
  • delete - Delete an MCP gateway
  • update - Update an MCP gateway

McpServers

  • list - List MCP servers
  • create - Create an MCP server
  • retrieve - Retrieve an MCP server
  • delete - Delete an MCP server
  • update - Update an MCP server
  • testTool - Test an MCP server tool
  • sync - Sync an MCP server

MemoryStores

ModelCatalog

  • list - List the model catalog
  • listOfferings - List model catalog offerings
  • get - Retrieve a model catalog entry

ModelFusions

  • list - List Model Fusions
  • create - Create a Model Fusion
  • get - Retrieve a Model Fusion
  • update - Replace a Model Fusion configuration
  • delete - Delete a Model Fusion
  • setEnabled - Enable or disable a Model Fusion

Models

Monitors

Notifiers

  • list - List notifiers
  • create - Create a notifier
  • get - Retrieve a notifier
  • delete - Delete a notifier
  • update - Update a notifier

Pii

Policies

Projects

  • list - List all projects
  • create - Create a new project
  • get - Retrieve a project
  • delete - Delete a project
  • update - Update a project

Prompts

Reporting

  • query - Query reporting metrics

Responses

Router

  • ocr - Extracts text content while maintaining document structure and hierarchy

Router.Audio.Speech

Router.Audio.Transcriptions

  • create - Create transcription

Router.Audio.Translations

Router.Chat.Completions

  • create - Create chat completion

Router.Classify

  • create - Classify ⚠️ Deprecated

Router.Completions

Router.Decisions

Router.Embeddings

Router.Images.Edits

Router.Images.Generations

Router.Images.Variations

  • create - Create image variation

Router.Moderations

Router.Rerank

RoutingRules

Schedules

Sessions

Skills

SmartRouters

  • list - List Smart Routers
  • create - Create a Smart Router
  • get - Retrieve a Smart Router
  • delete - Delete a Smart Router
  • update - Update a Smart Router

Telemetry

Tools

Traces

Users

  • list - List workspace users
  • get - Retrieve a workspace user
  • delete - Delete a workspace user
  • update - Update a workspace user
  • create - Create or add workspace users

Views

  • list - List visible saved views
  • create - Create a saved view
  • get - Retrieve a saved view
  • delete - Delete a saved view
  • update - Update a saved view

Webhooks

Websearch

  • search - Search the web with a selected provider

Wikis

Workspaces

  • list - List workspaces
  • get - Retrieve a workspace
  • update - Update a workspace

WorkspaceSecurity

WorkspaceSettings

  • get - Retrieve workspace settings
  • update - Update workspace settings

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.

Available standalone functions

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-ai/node";

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

async function run() {
  const result = await orq.deployments.stream({
    key: "<key>",
    identity: {
      id: "contact_01ARZ3NDEKTSV4RRFFQ69G5FAV",
      displayName: "Jane Doe",
      email: "jane.doe@example.com",
      metadata: [
        {
          "department": "Engineering",
          "role": "Senior Developer",
        },
      ],
      logoUrl: "https://example.com/avatars/jane-doe.jpg",
      tags: [
        "hr",
        "engineering",
      ],
    },
    documents: [
      {
        text:
          "The refund policy allows customers to return items within 30 days of purchase for a full refund.",
        metadata: {
          fileName: "refund_policy.pdf",
          fileType: "application/pdf",
          pageNumber: 1,
        },
      },
      {
        text: "Premium members receive free shipping on all orders over $50.",
        metadata: {
          fileName: "membership_benefits.md",
          fileType: "text/markdown",
        },
      },
    ],
  });

  for await (const event of result) {
    console.log(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 { Orq } from "@orq-ai/node";

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

async function run() {
  const result = await orq.router.audio.transcriptions.create({
    model: "Malibu",
    temperature: 0.5,
    timestampGranularities: [
      "word",
      "segment",
    ],
    retry: {
      onCodes: [
        429,
        500,
        502,
        503,
        504,
      ],
    },
    loadBalancer: {
      type: "weight_based",
      models: [
        {
          model: "openai/gpt-4o",
          weight: 0.7,
        },
      ],
    },
    timeout: {
      callTimeout: 30000,
    },
    orq: {
      fallbacks: [
        {
          model: "openai/gpt-4o-mini",
        },
      ],
      retry: {
        onCodes: [
          429,
          500,
          502,
          503,
          504,
        ],
      },
      identity: {
        id: "contact_01ARZ3NDEKTSV4RRFFQ69G5FAV",
        displayName: "Jane Doe",
        email: "jane.doe@example.com",
        metadata: [
          {
            "department": "Engineering",
            "role": "Senior Developer",
          },
        ],
        logoUrl: "https://example.com/avatars/jane-doe.jpg",
        tags: [
          "hr",
          "engineering",
        ],
      },
      loadBalancer: {
        type: "weight_based",
        models: [
          {
            model: "openai/gpt-4o",
            weight: 0.7,
          },
          {
            model: "anthropic/claude-3-5-sonnet",
            weight: 0.3,
          },
        ],
      },
      timeout: {
        callTimeout: 30000,
      },
    },
  });

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

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

async function run() {
  const result = await orq.deployments.invoke({
    key: "<key>",
    identity: {
      id: "contact_01ARZ3NDEKTSV4RRFFQ69G5FAV",
      displayName: "Jane Doe",
      email: "jane.doe@example.com",
      metadata: [
        {
          "department": "Engineering",
          "role": "Senior Developer",
        },
      ],
      logoUrl: "https://example.com/avatars/jane-doe.jpg",
      tags: [
        "hr",
        "engineering",
      ],
    },
    documents: [
      {
        text:
          "The refund policy allows customers to return items within 30 days of purchase for a full refund.",
        metadata: {
          fileName: "refund_policy.pdf",
          fileType: "application/pdf",
          pageNumber: 1,
        },
      },
      {
        text: "Premium members receive free shipping on all orders over $50.",
        metadata: {
          fileName: "membership_benefits.md",
          fileType: "text/markdown",
        },
      },
    ],
  }, {
    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 { Orq } from "@orq-ai/node";

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

async function run() {
  const result = await orq.deployments.invoke({
    key: "<key>",
    identity: {
      id: "contact_01ARZ3NDEKTSV4RRFFQ69G5FAV",
      displayName: "Jane Doe",
      email: "jane.doe@example.com",
      metadata: [
        {
          "department": "Engineering",
          "role": "Senior Developer",
        },
      ],
      logoUrl: "https://example.com/avatars/jane-doe.jpg",
      tags: [
        "hr",
        "engineering",
      ],
    },
    documents: [
      {
        text:
          "The refund policy allows customers to return items within 30 days of purchase for a full refund.",
        metadata: {
          fileName: "refund_policy.pdf",
          fileType: "application/pdf",
          pageNumber: 1,
        },
      },
      {
        text: "Premium members receive free shipping on all orders over $50.",
        metadata: {
          fileName: "membership_benefits.md",
          fileType: "text/markdown",
        },
      },
    ],
  });

  console.log(result);
}

run();

Error Handling

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

Property Type Description
error.message string Error message
error.statusCode number HTTP response status code eg 404
error.headers Headers HTTP response headers
error.body string HTTP body. Can be empty string if no body is returned.
error.rawResponse Response Raw HTTP response
error.data$ Optional. Some errors may contain structured data. See Error Classes.

Example

import { Orq } from "@orq-ai/node";
import * as errors from "@orq-ai/node/models/errors";

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

async function run() {
  try {
    const result = await orq.deployments.invoke({
      key: "<key>",
      identity: {
        id: "contact_01ARZ3NDEKTSV4RRFFQ69G5FAV",
        displayName: "Jane Doe",
        email: "jane.doe@example.com",
        metadata: [
          {
            "department": "Engineering",
            "role": "Senior Developer",
          },
        ],
        logoUrl: "https://example.com/avatars/jane-doe.jpg",
        tags: [
          "hr",
          "engineering",
        ],
      },
      documents: [
        {
          text:
            "The refund policy allows customers to return items within 30 days of purchase for a full refund.",
          metadata: {
            fileName: "refund_policy.pdf",
            fileType: "application/pdf",
            pageNumber: 1,
          },
        },
        {
          text: "Premium members receive free shipping on all orders over $50.",
          metadata: {
            fileName: "membership_benefits.md",
            fileType: "text/markdown",
          },
        },
      ],
    });

    console.log(result);
  } catch (error) {
    // The base class for HTTP error responses
    if (error instanceof errors.OrqError) {
      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.ErrorResponse) {
        console.log(error.data$.message); // string
        console.log(error.data$.code); // number
        console.log(error.data$.details); // any[]
      }
    }
  }
}

run();

Error Classes

Primary error:

  • OrqError: The base class for HTTP error responses.
Less common errors (72)

Network errors:

Inherit from OrqError:

* Check the method documentation to see if the error is applicable.

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

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

async function run() {
  const result = await orq.deployments.invoke({
    key: "<key>",
    identity: {
      id: "contact_01ARZ3NDEKTSV4RRFFQ69G5FAV",
      displayName: "Jane Doe",
      email: "jane.doe@example.com",
      metadata: [
        {
          "department": "Engineering",
          "role": "Senior Developer",
        },
      ],
      logoUrl: "https://example.com/avatars/jane-doe.jpg",
      tags: [
        "hr",
        "engineering",
      ],
    },
    documents: [
      {
        text:
          "The refund policy allows customers to return items within 30 days of purchase for a full refund.",
        metadata: {
          fileName: "refund_policy.pdf",
          fileType: "application/pdf",
          pageNumber: 1,
        },
      },
      {
        text: "Premium members receive free shipping on all orders over $50.",
        metadata: {
          fileName: "membership_benefits.md",
          fileType: "text/markdown",
        },
      },
    ],
  });

  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:

  • route requests through a proxy server using undici's ProxyAgent
  • use the "beforeRequest" hook to add a custom header and a timeout to requests
  • use the "requestError" hook to log errors
import { Orq } from "@orq-ai/node";
import { ProxyAgent } from "undici";
import { HTTPClient } from "@orq-ai/node/lib/http";

const dispatcher = new ProxyAgent("http://proxy.example.com:8080");

const httpClient = new HTTPClient({
  // 'fetcher' takes a function that has the same signature as native 'fetch'.
  fetcher: (input, init) =>
    // 'dispatcher' is specific to undici and not part of the standard Fetch API.
    fetch(input, { ...init, dispatcher } as RequestInit),
});

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: 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 { Orq } from "@orq-ai/node";

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

About

orq.ai TypeScript SDK

orq.ai

Resources

Readme

Contributing

Contributing
Activity
Custom properties

Stars

11 stars

Watchers

3 watching

Forks

1 fork
Report repository

Releases

Packages

Used by

Contributors

Languages