@orq-ai/node 1.7.0 → 1.31.0-rc.7

package/README.md

@@ -1,236 +1,556 @@
-<p align="left">
-  <a href="https://orq.ai" target="_blank">
-    <img src="https://asset.brandfetch.io/idtBhDRr2x/idcrPsCm4K.png" alt="Orq">
-  </a>
-</p>
+# @orq-ai/node
 
-Build AI Applications from Playground to Production
+Developer-friendly & type-safe Typescript SDK specifically catered to leverage *@orq-ai/node* API.
 
-# orq.ai Node SDK
+<div align="left">
+    <a href="https://www.speakeasy.com/?utm_source=@orq-ai/node&utm_campaign=typescript"><img src="https://custom-icon-badges.demolab.com/badge/-Built%20By%20Speakeasy-212015?style=for-the-badge&logoColor=FBE331&logo=speakeasy&labelColor=545454" /></a>
+    <a href="https://opensource.org/licenses/MIT">
+        <img src="https://img.shields.io/badge/License-MIT-blue.svg" style="width: 100px; height: 28px;" />
+    </a>
+</div>
 
-The orq.ai Node library enables easy orq.ai REST API integration in NodeJS 16+ apps.
 
-# Documentation
+<br /><br />
+> [!IMPORTANT]
+> This SDK is not yet ready for production use. To complete setup please follow the steps outlined in your [workspace](https://app.speakeasy.com/org/orq/orq). Delete this section before > publishing to a package manager.
 
-The REST API documentation can be found on [docs.orq.ai](https://docs.orq.ai/reference/authentication).
+<!-- Start Summary [summary] -->
+## Summary
 
-## Installation
+[Dev] orq.ai API: The Orquesta API
+
+For more information about the API: [orq.ai Documentation](https://docs.orq.ai)
+<!-- End Summary [summary] -->
+
+<!-- Start Table of Contents [toc] -->
+## Table of Contents
+<!-- $toc-max-depth=2 -->
+* [@orq-ai/node](#orq-ainode)
+  * [SDK Installation](#sdk-installation)
+  * [Requirements](#requirements)
+  * [SDK Example Usage](#sdk-example-usage)
+  * [Authentication](#authentication)
+  * [Available Resources and Operations](#available-resources-and-operations)
+  * [Standalone functions](#standalone-functions)
+  * [Server-sent event streaming](#server-sent-event-streaming)
+  * [File uploads](#file-uploads)
+  * [Retries](#retries)
+  * [Error Handling](#error-handling)
+  * [Server Selection](#server-selection)
+  * [Custom HTTP Client](#custom-http-client)
+  * [Debugging](#debugging)
+* [Development](#development)
+  * [Maturity](#maturity)
+  * [Contributions](#contributions)
+
+<!-- End Table of Contents [toc] -->
+
+<!-- Start SDK Installation [installation] -->
+## SDK Installation
+
+The SDK can be installed with either [npm](https://www.npmjs.com/), [pnpm](https://pnpm.io/), [bun](https://bun.sh/) or [yarn](https://classic.yarnpkg.com/en/) package managers.
+
+### NPM
 
 ```bash
-npm install @orq-ai/node
+npm add @orq-ai/node
 ```
 
+### PNPM
+
 ```bash
-yarn add @orq-ai/node
+pnpm add @orq-ai/node
 ```
 
-## Usage
+### Bun
+
+```bash
+bun add @orq-ai/node
+```
+
+### Yarn
+
+```bash
+yarn add @orq-ai/node zod
+
+# Note that Yarn does not install peer dependencies automatically. You will need
+# to install zod as shown above.
+```
+<!-- End SDK Installation [installation] -->
+
+<!-- Start Requirements [requirements] -->
+## Requirements
+
+For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).
+<!-- End Requirements [requirements] -->
 
-_You can get your workspace API key from the settings section in your orq.ai workspace. `https://my.orq.ai/<workspace>/settings/developers`_
+<!-- Start SDK Example Usage [usage] -->
+## SDK Example Usage
 
-Initialize the orq.ai client with your API key:
+### Example
 
-```ts
-import { createClient } from '@orq-ai/node';
+```typescript
+import { Orq } from "@orq-ai/node";
 
-const client = createClient({
-  apiKey: 'orquesta-api-key',
-  environment: 'production',
+const orq = new Orq({
+  apiKey: process.env["ORQ_API_KEY"] ?? "",
 });
 
-generation = await client.deployments.invoke(
-  key: 'customer_service',
-  context: { environments: 'production', country: 'NLD' },
-  inputs: { firstname: 'John', city: 'New York' },
-  metadata: { customer_id: 'Qwtqwty90281' },
-);
+async function run() {
+  const result = await orq.contacts.create({
+    externalId: "<id>",
+  });
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+
 ```
+<!-- End SDK Example Usage [usage] -->
 
-## Deployments
+<!-- Start Authentication [security] -->
+## Authentication
 
-The Deployments API delivers text outputs, images or tool calls based on the configuration established within orq.ai for your deployments. Additionally, this API supports streaming. To ensure ease of use and minimize errors, using the code snippets from the orq.ai Admin panel is highly recommended.
+### Per-Client Security Schemes
 
-### Invoke a deployment
+This SDK supports the following security scheme globally:
 
-#### `invoke()`
+| Name     | Type | Scheme      | Environment Variable |
+| -------- | ---- | ----------- | -------------------- |
+| `apiKey` | http | HTTP Bearer | `ORQ_API_KEY`        |
 
-```ts
-const generation = await client.deployments.invoke({
-  key: 'customer_service',
-  context: { environments: 'production', country: 'NLD' },
-  inputs: { firstname: 'John', city: 'New York' },
-  metadata: { customer_id: 'Qwtqwty90281' },
+To authenticate with the API the `apiKey` parameter must be set when initializing the SDK client instance. For example:
+```typescript
+import { Orq } from "@orq-ai/node";
+
+const orq = new Orq({
+  apiKey: process.env["ORQ_API_KEY"] ?? "",
 });
 
-console.log(generation?.choices[0].message.content);
+async function run() {
+  const result = await orq.contacts.create({
+    externalId: "<id>",
+  });
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+
 ```
+<!-- End Authentication [security] -->
+
+<!-- Start Available Resources and Operations [operations] -->
+## Available Resources and Operations
+
+<details open>
+<summary>Available methods</summary>
+
+### [contacts](docs/sdks/contacts/README.md)
+
+* [create](docs/sdks/contacts/README.md#create) - Update user information
+
+### [deployments](docs/sdks/deployments/README.md)
+
+* [all](docs/sdks/deployments/README.md#all) - List all deployments
+* [invalidate](docs/sdks/deployments/README.md#invalidate) - Invalidates cache
+* [getConfig](docs/sdks/deployments/README.md#getconfig) - Get config
+* [invoke](docs/sdks/deployments/README.md#invoke) - Invoke
+
+#### [deployments.metrics](docs/sdks/metrics/README.md)
 
-#### `invoke_with_stream()`
+* [create](docs/sdks/metrics/README.md#create) - Add metrics
 
-```ts
-const deployment = await client.deployments.invoke({
-  key: 'customer_service',
-  context: { environments: 'production', country: 'NLD' },
-  inputs: { firstname: 'John', city: 'New York' },
-  metadata: { customer_id: 'Qwtqwty90281' },
+### [feedback](docs/sdks/feedback/README.md)
+
+* [create](docs/sdks/feedback/README.md#create) - Submit feedback
+
+### [files](docs/sdks/files/README.md)
+
+* [upload](docs/sdks/files/README.md#upload) - Upload file
+* [bulkUpload](docs/sdks/files/README.md#bulkupload) - Bulk upload file
+
+
+### [prompt](docs/sdks/prompt/README.md)
+
+
+#### [prompt.snippets](docs/sdks/snippets/README.md)
+
+* [findOne](docs/sdks/snippets/README.md#findone) - Get one prompt snippet
+
+#### [prompt.templates](docs/sdks/templates/README.md)
+
+* [getAll](docs/sdks/templates/README.md#getall) - Get all prompt templates
+
+### [prompts](docs/sdks/prompts/README.md)
+
+* [create](docs/sdks/prompts/README.md#create) - Create a new prompt
+* [createVersion](docs/sdks/prompts/README.md#createversion) - Create a new prompt version
+* [delete](docs/sdks/prompts/README.md#delete) - Delete a prompt
+* [getOne](docs/sdks/prompts/README.md#getone) - Get one prompt
+* [update](docs/sdks/prompts/README.md#update) - Update a prompt
+* [duplicate](docs/sdks/prompts/README.md#duplicate) - Duplicate a prompt
+* [getAll](docs/sdks/prompts/README.md#getall) - Get all prompts
+
+### [remoteconfig](docs/sdks/remoteconfig/README.md)
+
+* [getConfig](docs/sdks/remoteconfig/README.md#getconfig) - Get Configurations
+
+</details>
+<!-- End Available Resources and Operations [operations] -->
+
+<!-- Start Standalone functions [standalone-funcs] -->
+## 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](./FUNCTIONS.md).
+
+<details>
+
+<summary>Available standalone functions</summary>
+
+- [`contactsCreate`](docs/sdks/contacts/README.md#create) - Update user information
+- [`deploymentsAll`](docs/sdks/deployments/README.md#all) - List all deployments
+- [`deploymentsGetConfig`](docs/sdks/deployments/README.md#getconfig) - Get config
+- [`deploymentsInvalidate`](docs/sdks/deployments/README.md#invalidate) - Invalidates cache
+- [`deploymentsInvoke`](docs/sdks/deployments/README.md#invoke) - Invoke
+- [`deploymentsMetricsCreate`](docs/sdks/metrics/README.md#create) - Add metrics
+- [`feedbackCreate`](docs/sdks/feedback/README.md#create) - Submit feedback
+- [`filesBulkUpload`](docs/sdks/files/README.md#bulkupload) - Bulk upload file
+- [`filesUpload`](docs/sdks/files/README.md#upload) - Upload file
+- [`promptsCreate`](docs/sdks/prompts/README.md#create) - Create a new prompt
+- [`promptsCreateVersion`](docs/sdks/prompts/README.md#createversion) - Create a new prompt version
+- [`promptsDelete`](docs/sdks/prompts/README.md#delete) - Delete a prompt
+- [`promptsDuplicate`](docs/sdks/prompts/README.md#duplicate) - Duplicate a prompt
+- [`promptsGetAll`](docs/sdks/prompts/README.md#getall) - Get all prompts
+- [`promptsGetOne`](docs/sdks/prompts/README.md#getone) - Get one prompt
+- [`promptSnippetsFindOne`](docs/sdks/snippets/README.md#findone) - Get one prompt snippet
+- [`promptsUpdate`](docs/sdks/prompts/README.md#update) - Update a prompt
+- [`promptTemplatesGetAll`](docs/sdks/templates/README.md#getall) - Get all prompt templates
+- [`remoteconfigGetConfig`](docs/sdks/remoteconfig/README.md#getconfig) - Get Configurations
+
+</details>
+<!-- End Standalone functions [standalone-funcs] -->
+
+<!-- Start Server-sent event streaming [eventstream] -->
+## Server-sent event streaming
+
+[Server-sent events][mdn-sse] 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`][mdn-for-await-of] loop. The loop will
+terminate when the server no longer has any events to send and closes the
+underlying connection.
+
+```typescript
+import { Orq } from "@orq-ai/node";
+
+const orq = new Orq({
+  apiKey: process.env["ORQ_API_KEY"] ?? "",
 });
 
-for await (const chunk of stream) {
-  console.log(chunk.choices[0]?.message.content);
+async function run() {
+  const result = await orq.deployments.invoke({
+    key: "<key>",
+  });
+
+  for await (const event of result) {
+    // Handle the event
+    console.log(event);
+  }
 }
+
+run();
+
 ```
 
-#### Adding messages as part of your request
+[mdn-sse]: https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events
+[mdn-for-await-of]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of
+<!-- End Server-sent event streaming [eventstream] -->
 
-If you are using the `invoke` method, you can include `messages` in your request to the model. The `messages` property
-allows you to combine `chat_history` with the prompt configuration in Orq, or to directly send `messages` to the
-model if you are managing the prompt in your code.
+<!-- Start File uploads [file-upload] -->
+## 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`](https://nodejs.org/docs/latest-v20.x/api/fs.html#fsopenasblobpath-options).
+> - **Bun:** The native [`Bun.file`](https://bun.sh/docs/api/file-io#reading-files-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`](https://developer.mozilla.org/en-US/docs/Web/API/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`](https://www.npmjs.com/package/fetch-blob).
+
+```typescript
+import { Orq } from "@orq-ai/node";
+
+const orq = new Orq({
+  apiKey: process.env["ORQ_API_KEY"] ?? "",
+});
+
+async function run() {
+  const result = await orq.files.upload();
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
 
-```ts
-generation = await client.deployments.invoke(
-  key: 'customer_service',
-  context:{
-    language: [],
-    environments: [],
-  },
-  metadata: {
-    'custom-field-name': 'custom-metadata-value',
-  },
-  inputs:{ firstname: 'John', city: 'New York' },
-  messages: [
-    {
-      role: 'user',
-      content:
-        'A customer is asking about the latest software update features. Generate a detailed and informative response highlighting the key new features and improvements in the latest update.',
-    },
-  ]
-);
 ```
+<!-- End File uploads [file-upload] -->
 
-#### Logging metrics to the deployment configuration
+<!-- Start Retries [retries] -->
+## Retries
 
-After invoking, streaming or getting the configuration of a deployment, you can use the `add_metrics` method to add information to the deployment.
+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:
+```typescript
+import { Orq } from "@orq-ai/node";
+
+const orq = new Orq({
+  apiKey: process.env["ORQ_API_KEY"] ?? "",
+});
+
+async function run() {
+  const result = await orq.contacts.create({
+    externalId: "<id>",
+  }, {
+    retries: {
+      strategy: "backoff",
+      backoff: {
+        initialInterval: 1,
+        maxInterval: 50,
+        exponent: 1.1,
+        maxElapsedTime: 100,
+      },
+      retryConnectionErrors: false,
+    },
+  });
+
+  // Handle the result
+  console.log(result);
+}
 
-```ts
-generation.addMetrics({
-  chain_id: 'c4a75b53-62fa-401b-8e97-493f3d299316',
-  conversation_id: 'ee7b0c8c-eeb2-43cf-83e9-a4a49f8f13ea',
-  user_id: 'e3a202a6-461b-447c-abe2-018ba4d04cd0',
-  feedback: { score: 100 },
-  metadata: {
-    custom: 'custom_metadata',
-    chain_id: 'ad1231xsdaABw',
+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:
+```typescript
+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.contacts.create({
+    externalId: "<id>",
+  });
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+
 ```
+<!-- End Retries [retries] -->
+
+<!-- Start Error Handling [errors] -->
+## Error Handling
+
+All SDK methods return a response object or throw an error. By default, an API error will throw a `errors.APIError`.
+
+If a HTTP request fails, an operation my also throw an error from the `models/errors/httpclienterrors.ts` module:
 
-### Get deployment configuration
+| 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                     |
 
-#### `get_config()`
+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 `all` method may throw the following errors:
 
-```ts
-const deploymentPromptConfig = await client.deployments.getConfig({
-  key: 'customer_service',
-  context: { environments: 'production', country: 'NLD' },
-  inputs: { firstname: 'John', city: 'New York' },
-  metadata: { customer_id: 'Qwtqwty90281' },
+| Error Type          | Status Code | Content Type     |
+| ------------------- | ----------- | ---------------- |
+| errors.HonoApiError | 500         | application/json |
+| errors.APIError     | 4XX, 5XX    | \*/\*            |
+
+```typescript
+import { Orq } from "@orq-ai/node";
+import { HonoApiError, SDKValidationError } from "@orq-ai/node/models/errors";
+
+const orq = new Orq({
+  apiKey: process.env["ORQ_API_KEY"] ?? "",
 });
 
-console.log(deploymentPromptConfig);
+async function run() {
+  let result;
+  try {
+    result = await orq.deployments.all();
+
+    // 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 HonoApiError): {
+        // Handle err.data$: HonoApiErrorData
+        console.error(err);
+        return;
+      }
+      default: {
+        throw err;
+      }
+    }
+  }
+}
+
+run();
+
 ```
 
-#### Logging metrics to the deployment configuration
+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.
+<!-- End Error Handling [errors] -->
 
-After invoking, streaming or getting the configuration of a deployment, you can use the `add_metrics` method to add information to the deployment.
+<!-- Start Server Selection [server] -->
+## Server Selection
 
-```ts
-deploymentPromptConfig.addMetrics({
-  chain_id: 'c4a75b53-62fa-401b-8e97-493f3d299316',
-  conversation_id: 'ee7b0c8c-eeb2-43cf-83e9-a4a49f8f13ea',
-  user_id: 'e3a202a6-461b-447c-abe2-018ba4d04cd0',
-  feedback: { score: 100 },
-  metadata: {
-    custom: 'custom_metadata',
-    chain_id: 'ad1231xsdaABw',
-  },
-  usage: {
-    prompt_tokens: 100,
-    completion_tokens: 900,
-    total_tokens: 1000,
-  },
-  performance: {
-    latency: 9000,
-    time_to_first_token: 250,
-  },
+### Override Server URL Per-Client
+
+The default server can also be overridden globally by passing a URL to the `serverURL: string` optional parameter when initializing the SDK client instance. For example:
+```typescript
+import { Orq } from "@orq-ai/node";
+
+const orq = new Orq({
+  serverURL: "https://my.staging.orq.ai",
+  apiKey: process.env["ORQ_API_KEY"] ?? "",
 });
-```
 
-### Logging LLM responses
+async function run() {
+  const result = await orq.contacts.create({
+    externalId: "<id>",
+  });
 
-Whether you use the `get_config` or `invoke`, you can log the model generations to the deployment. Here are some
-examples of how to do it.
+  // Handle the result
+  console.log(result);
+}
 
-#### Logging the completion choices the model generated for the input prompt
+run();
 
-```ts
-generation.addMetrics(
-  choices:[
-    {
-      index: 0,
-      finish_reason: 'assistant',
-      message: {
-        role: 'assistant',
-        content:
-          "Dear customer: Thank you for your interest in our latest software update! We're excited to share with you the new features and improvements we've rolled out. Here's what you can look forward to in this update",
-      },
-    },
-  ]
-);
 ```
+<!-- End Server Selection [server] -->
+
+<!-- Start Custom HTTP Client [http-client] -->
+## Custom HTTP Client
+
+The TypeScript SDK makes API calls using an `HTTPClient` that wraps the native
+[Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/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:
+
+```typescript
+import { Orq } from "@orq-ai/node";
+import { HTTPClient } from "@orq-ai/node/lib/http";
+
+const httpClient = new HTTPClient({
+  // fetcher takes a function that has the same signature as native `fetch`.
+  fetcher: (request) => {
+    return fetch(request);
+  }
+});
 
-#### Logging the completion choices the model generated for the input prompt
+httpClient.addHook("beforeRequest", (request) => {
+  const nextRequest = new Request(request, {
+    signal: request.signal || AbortSignal.timeout(5000)
+  });
 
-You can save the images generated by the model in Orq. If the image format is `base64` we always store it as
-a `png`.
+  nextRequest.headers.set("x-custom-header", "custom value");
 
-```ts
-generation.addMetrics(
-  choices: [
-    {
-      index: 0,
-      finish_reason: 'stop',
-      message: {
-        role: 'assistant',
-        url: '<image_url>',
-      },
-    },
-  ]
-);
+  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 });
 ```
+<!-- End Custom HTTP Client [http-client] -->
 
-#### Logging the output of the tool calls
-
-```ts
-generation.addMetrics(
-  choices: [
-    {
-      index: 0,
-      message: {
-        role: 'assistant',
-        content: None,
-        tool_calls: [
-          {
-            type: 'function',
-            id: 'call_pDBPMMacPXOtoWhTWibW1D94',
-            function: {
-              name: 'get_weather',
-              arguments: '{"location":"San Francisco, CA"}',
-            },
-          },
-        ],
-      },
-      finish_reason: 'tool_calls',
-    },
-  ]
-);
+<!-- Start Debugging [debug] -->
+## 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.
+
+```typescript
+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.
+<!-- End Debugging [debug] -->
+
+<!-- Placeholder for Future Speakeasy SDK Sections -->
+
+# 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](https://www.speakeasy.com/?utm_source=@orq-ai/node&utm_campaign=typescript)