@orq-ai/node 3.0.1 → 3.1.0-rc.26

package/README.md

@@ -9,15 +9,10 @@ Developer-friendly & type-safe Typescript SDK specifically catered to leverage *
     </a>
 </div>
 
-
-<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.
-
 <!-- Start Summary [summary] -->
 ## Summary
 
-[Dev] orq.ai API: The Orquesta API
+[Dev] orq.ai API: orq.ai API documentation
 
 For more information about the API: [orq.ai Documentation](https://docs.orq.ai)
 <!-- End Summary [summary] -->
@@ -155,9 +150,10 @@ run();
 
 ### [deployments](docs/sdks/deployments/README.md)
 
-* [all](docs/sdks/deployments/README.md#all) - List all deployments
+* [list](docs/sdks/deployments/README.md#list) - List all deployments
 * [getConfig](docs/sdks/deployments/README.md#getconfig) - Get config
 * [invoke](docs/sdks/deployments/README.md#invoke) - Invoke
+* [stream](docs/sdks/deployments/README.md#stream) - Stream
 
 #### [deployments.metrics](docs/sdks/metrics/README.md)
 
@@ -172,31 +168,24 @@ run();
 * [upload](docs/sdks/files/README.md#upload) - Upload file
 * [list](docs/sdks/files/README.md#list) - List all files
 * [get](docs/sdks/files/README.md#get) - Get file by ID
-* [update](docs/sdks/files/README.md#update) - Update file name
 * [delete](docs/sdks/files/README.md#delete) - Delete 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
+* [create](docs/sdks/prompts/README.md#create) - Create a 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
+* [delete](docs/sdks/prompts/README.md#delete) - Delete a prompt
+* [get](docs/sdks/prompts/README.md#get) - Retrieve a prompt
+* [list](docs/sdks/prompts/README.md#list) - List all prompts
+
+### [promptSnippets](docs/sdks/promptsnippets/README.md)
+
+* [create](docs/sdks/promptsnippets/README.md#create) - Create a prompt snippet
+* [update](docs/sdks/promptsnippets/README.md#update) - Update a prompt snippet
+* [delete](docs/sdks/promptsnippets/README.md#delete) - Delete a prompt snippet
+* [get](docs/sdks/promptsnippets/README.md#get) - Retrieve a prompt snippet
+* [getByKey](docs/sdks/promptsnippets/README.md#getbykey) - Retrieve a prompt snippet by key
 
 ### [remoteconfig](docs/sdks/remoteconfig/README.md)
 
@@ -221,26 +210,26 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 <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
 - [`deploymentsInvoke`](docs/sdks/deployments/README.md#invoke) - Invoke
+- [`deploymentsList`](docs/sdks/deployments/README.md#list) - List all deployments
 - [`deploymentsMetricsCreate`](docs/sdks/metrics/README.md#create) - Add metrics
+- [`deploymentsStream`](docs/sdks/deployments/README.md#stream) - Stream
 - [`feedbackCreate`](docs/sdks/feedback/README.md#create) - Submit feedback
-- [`filesBulkUpload`](docs/sdks/files/README.md#bulkupload) - Bulk upload file
 - [`filesDelete`](docs/sdks/files/README.md#delete) - Delete file
 - [`filesGet`](docs/sdks/files/README.md#get) - Get file by ID
 - [`filesList`](docs/sdks/files/README.md#list) - List all files
-- [`filesUpdate`](docs/sdks/files/README.md#update) - Update file name
 - [`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
+- [`promptsCreate`](docs/sdks/prompts/README.md#create) - Create a prompt
 - [`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
+- [`promptsGet`](docs/sdks/prompts/README.md#get) - Retrieve a prompt
+- [`promptsList`](docs/sdks/prompts/README.md#list) - List all prompts
+- [`promptSnippetsCreate`](docs/sdks/promptsnippets/README.md#create) - Create a prompt snippet
+- [`promptSnippetsDelete`](docs/sdks/promptsnippets/README.md#delete) - Delete a prompt snippet
+- [`promptSnippetsGet`](docs/sdks/promptsnippets/README.md#get) - Retrieve a prompt snippet
+- [`promptSnippetsGetByKey`](docs/sdks/promptsnippets/README.md#getbykey) - Retrieve a prompt snippet by key
+- [`promptSnippetsUpdate`](docs/sdks/promptsnippets/README.md#update) - Update a 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>
@@ -263,7 +252,7 @@ const orq = new Orq({
 });
 
 async function run() {
-  const result = await orq.deployments.invoke({
+  const result = await orq.deployments.stream({
     key: "<key>",
   });
 
@@ -386,7 +375,7 @@ run();
 <!-- Start Error Handling [errors] -->
 ## Error Handling
 
-Some methods specify known errors which can be thrown. All the known errors are enumerated in the `models/errors/errors.ts` module. The known errors for a method are documented under the *Errors* tables in SDK docs. For example, the `all` method may throw the following errors:
+Some methods specify known errors which can be thrown. All the known errors are enumerated in the `models/errors/errors.ts` module. The known errors for a method are documented under the *Errors* tables in SDK docs. For example, the `list` method may throw the following errors:
 
 | Error Type          | Status Code | Content Type     |
 | ------------------- | ----------- | ---------------- |
@@ -406,7 +395,7 @@ const orq = new Orq({
 async function run() {
   let result;
   try {
-    result = await orq.deployments.all();
+    result = await orq.deployments.list({});
 
     // Handle the result
     console.log(result);

package/docs/sdks/deployments/README.md

@@ -5,11 +5,12 @@
 
 ### Available Operations
 
-* [all](#all) - List all deployments
+* [list](#list) - List all deployments
 * [getConfig](#getconfig) - Get config
 * [invoke](#invoke) - Invoke
+* [stream](#stream) - Stream
 
-## all
+## list
 
 Returns a list of your deployments. The deployments are returned sorted by creation date, with the most recent deployments appearing first.
 
@@ -23,7 +24,7 @@ const orq = new Orq({
 });
 
 async function run() {
-  const result = await orq.deployments.all();
+  const result = await orq.deployments.list({});
 
   // Handle the result
   console.log(result);
@@ -38,7 +39,7 @@ The standalone function version of this method:
 
 ```typescript
 import { OrqCore } from "@orq-ai/node/core.js";
-import { deploymentsAll } from "@orq-ai/node/funcs/deploymentsAll.js";
+import { deploymentsList } from "@orq-ai/node/funcs/deploymentsList.js";
 
 // Use `OrqCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -47,7 +48,7 @@ const orq = new OrqCore({
 });
 
 async function run() {
-  const res = await deploymentsAll(orq);
+  const res = await deploymentsList(orq, {});
 
   if (!res.ok) {
     throw res.error;
@@ -176,6 +177,82 @@ async function run() {
     key: "<key>",
   });
 
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { OrqCore } from "@orq-ai/node/core.js";
+import { deploymentsInvoke } from "@orq-ai/node/funcs/deploymentsInvoke.js";
+
+// Use `OrqCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const orq = new OrqCore({
+  apiKey: process.env["ORQ_API_KEY"] ?? "",
+});
+
+async function run() {
+  const res = await deploymentsInvoke(orq, {
+    key: "<key>",
+  });
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [components.Deployments](../../models/components/deployments.md)                                                                                                               | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[operations.DeploymentInvokeResponseBody](../../models/operations/deploymentinvokeresponsebody.md)\>**
+
+### Errors
+
+| Error Type      | Status Code     | Content Type    |
+| --------------- | --------------- | --------------- |
+| errors.APIError | 4XX, 5XX        | \*/\*           |
+
+## stream
+
+Stream deployment generation. Only supported for completions and chat completions.
+
+### Example Usage
+
+```typescript
+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>",
+  });
+
   for await (const event of result) {
     // Handle the event
     console.log(event);
@@ -191,7 +268,7 @@ The standalone function version of this method:
 
 ```typescript
 import { OrqCore } from "@orq-ai/node/core.js";
-import { deploymentsInvoke } from "@orq-ai/node/funcs/deploymentsInvoke.js";
+import { deploymentsStream } from "@orq-ai/node/funcs/deploymentsStream.js";
 
 // Use `OrqCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -200,7 +277,7 @@ const orq = new OrqCore({
 });
 
 async function run() {
-  const res = await deploymentsInvoke(orq, {
+  const res = await deploymentsStream(orq, {
     key: "<key>",
   });
 
@@ -223,14 +300,14 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [components.Deployments](../../models/components/deployments.md)                                                                                                               | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `request`                                                                                                                                                                      | [operations.DeploymentStreamRequestBody](../../models/operations/deploymentstreamrequestbody.md)                                                                               | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
 | `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
 | `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
 | `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
 
 ### Response
 
-**Promise\<[operations.DeploymentInvokeResponse](../../models/operations/deploymentinvokeresponse.md)\>**
+**Promise\<[EventStream<operations.DeploymentStreamResponseBody>](../../models/.md)\>**
 
 ### Errors
 

package/docs/sdks/files/README.md

@@ -8,9 +8,7 @@
 * [upload](#upload) - Upload file
 * [list](#list) - List all files
 * [get](#get) - Get file by ID
-* [update](#update) - Update file name
 * [delete](#delete) - Delete file
-* [bulkUpload](#bulkupload) - Bulk upload file
 
 ## upload
 
@@ -98,7 +96,7 @@ const orq = new Orq({
 });
 
 async function run() {
-  const result = await orq.files.list();
+  const result = await orq.files.list({});
 
   // Handle the result
   console.log(result);
@@ -122,7 +120,7 @@ const orq = new OrqCore({
 });
 
 async function run() {
-  const res = await filesList(orq);
+  const res = await filesList(orq, {});
 
   if (!res.ok) {
     throw res.error;
@@ -232,82 +230,6 @@ run();
 | --------------- | --------------- | --------------- |
 | errors.APIError | 4XX, 5XX        | \*/\*           |
 
-## update
-
-Update file name
-
-### Example Usage
-
-```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.update({
-    fileId: "<id>",
-  });
-
-  // Handle the result
-  console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { OrqCore } from "@orq-ai/node/core.js";
-import { filesUpdate } from "@orq-ai/node/funcs/filesUpdate.js";
-
-// Use `OrqCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const orq = new OrqCore({
-  apiKey: process.env["ORQ_API_KEY"] ?? "",
-});
-
-async function run() {
-  const res = await filesUpdate(orq, {
-    fileId: "<id>",
-  });
-
-  if (!res.ok) {
-    throw res.error;
-  }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.FileUpdateRequest](../../models/operations/fileupdaterequest.md)                                                                                                   | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
-| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
-| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
-
-### Response
-
-**Promise\<[operations.FileUpdateResponseBody](../../models/operations/fileupdateresponsebody.md)\>**
-
-### Errors
-
-| Error Type      | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.APIError | 4XX, 5XX        | \*/\*           |
-
 ## delete
 
 Delete file
@@ -378,96 +300,6 @@ run();
 
 ### Errors
 
-| Error Type      | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.APIError | 4XX, 5XX        | \*/\*           |
-
-## bulkUpload
-
-Files are used to upload documents that can be used with features like [Deployments](https://docs.orq.ai/reference/post_v2-deployments-get-config).
-
-### Example Usage
-
-```typescript
-import { Orq } from "@orq-ai/node";
-import { openAsBlob } from "node:fs";
-
-const orq = new Orq({
-  apiKey: process.env["ORQ_API_KEY"] ?? "",
-});
-
-async function run() {
-  const result = await orq.files.bulkUpload({
-    files: [
-      {
-        fileName: "example.file",
-        content: await openAsBlob("example.file"),
-      },
-    ],
-    purpose: "retrieval",
-  });
-
-  // Handle the result
-  console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { OrqCore } from "@orq-ai/node/core.js";
-import { filesBulkUpload } from "@orq-ai/node/funcs/filesBulkUpload.js";
-import { openAsBlob } from "node:fs";
-
-// Use `OrqCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const orq = new OrqCore({
-  apiKey: process.env["ORQ_API_KEY"] ?? "",
-});
-
-async function run() {
-  const res = await filesBulkUpload(orq, {
-    files: [
-      {
-        fileName: "example.file",
-        content: await openAsBlob("example.file"),
-      },
-    ],
-    purpose: "retrieval",
-  });
-
-  if (!res.ok) {
-    throw res.error;
-  }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.BulkFileUploadRequestBody](../../models/operations/bulkfileuploadrequestbody.md)                                                                                   | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
-| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
-| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
-
-### Response
-
-**Promise\<[operations.ResponseBody[]](../../models/.md)\>**
-
-### Errors
-
 | Error Type      | Status Code     | Content Type    |
 | --------------- | --------------- | --------------- |
 | errors.APIError | 4XX, 5XX        | \*/\*           |

package/docs/sdks/orq/README.md

@@ -2,7 +2,7 @@
 
 ## Overview
 
-[Dev] orq.ai API: The Orquesta API
+[Dev] orq.ai API: orq.ai API documentation
 
 orq.ai Documentation
 <https://docs.orq.ai>