@orq-ai/node 3.2.4 → 3.2.6

package/docs/sdks/deployments/README.md

@@ -8,6 +8,7 @@
 * [list](#list) - List all deployments
 * [getConfig](#getconfig) - Get config
 * [invoke](#invoke) - Invoke
+* [stream](#stream) - Stream
 
 ## list
 
@@ -230,6 +231,86 @@ run();
 
 ### 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);
+  }
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { OrqCore } from "@orq-ai/node/core.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.
+const orq = new OrqCore({
+  apiKey: process.env["ORQ_API_KEY"] ?? "",
+});
+
+async function run() {
+  const res = await deploymentsStream(orq, {
+    key: "<key>",
+  });
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  for await (const event of result) {
+    // Handle the event
+    console.log(event);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `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\<[EventStream<operations.DeploymentStreamResponseBody>](../../models/.md)\>**
+
+### Errors
+
 | Error Type      | Status Code     | Content Type    |
 | --------------- | --------------- | --------------- |
 | errors.APIError | 4XX, 5XX        | \*/\*           |

package/docs/sdks/prompts/README.md

@@ -6,10 +6,10 @@
 ### Available Operations
 
 * [list](#list) - List all prompts
+* [create](#create) - Create a prompt
 * [retrieve](#retrieve) - Retrieve a prompt
 * [update](#update) - Update a prompt
 * [delete](#delete) - Delete a prompt
-* [create](#create) - Create a prompt
 * [listVersions](#listversions) - List all prompt versions
 * [getVersion](#getversion) - Retrieve a prompt version
 
@@ -85,9 +85,9 @@ run();
 | --------------- | --------------- | --------------- |
 | errors.APIError | 4XX, 5XX        | \*/\*           |
 
-## retrieve
+## create
 
-Retrieves a prompt object
+Create a prompt
 
 ### Example Usage
 
@@ -99,8 +99,40 @@ const orq = new Orq({
 });
 
 async function run() {
-  const result = await orq.prompts.retrieve({
-    id: "<id>",
+  const result = await orq.prompts.create({
+    displayName: "Jed6",
+    promptConfig: {
+      messages: [
+        {
+          role: "system",
+          content: "<value>",
+        },
+        {
+          role: "system",
+          content: [
+            {
+              type: "image_url",
+              imageUrl: {
+                url: "https://well-worn-formation.biz",
+              },
+            },
+            {
+              type: "text",
+              text: "<value>",
+            },
+            {
+              type: "text",
+              text: "<value>",
+            },
+          ],
+        },
+        {
+          role: "assistant",
+          content: "<value>",
+        },
+      ],
+    },
+    path: "Customer Service/Billing/Refund",
   });
 
   // Handle the result
@@ -116,7 +148,7 @@ The standalone function version of this method:
 
 ```typescript
 import { OrqCore } from "@orq-ai/node/core.js";
-import { promptsRetrieve } from "@orq-ai/node/funcs/promptsRetrieve.js";
+import { promptsCreate } from "@orq-ai/node/funcs/promptsCreate.js";
 
 // Use `OrqCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -125,8 +157,40 @@ const orq = new OrqCore({
 });
 
 async function run() {
-  const res = await promptsRetrieve(orq, {
-    id: "<id>",
+  const res = await promptsCreate(orq, {
+    displayName: "Jed6",
+    promptConfig: {
+      messages: [
+        {
+          role: "system",
+          content: "<value>",
+        },
+        {
+          role: "system",
+          content: [
+            {
+              type: "image_url",
+              imageUrl: {
+                url: "https://well-worn-formation.biz",
+              },
+            },
+            {
+              type: "text",
+              text: "<value>",
+            },
+            {
+              type: "text",
+              text: "<value>",
+            },
+          ],
+        },
+        {
+          role: "assistant",
+          content: "<value>",
+        },
+      ],
+    },
+    path: "Customer Service/Billing/Refund",
   });
 
   if (!res.ok) {
@@ -146,14 +210,14 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.GetOnePromptRequest](../../models/operations/getonepromptrequest.md)                                                                                               | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `request`                                                                                                                                                                      | [operations.CreatePromptRequestBody](../../models/operations/createpromptrequestbody.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.GetOnePromptResponseBody](../../models/operations/getonepromptresponsebody.md)\>**
+**Promise\<[operations.CreatePromptResponseBody](../../models/operations/createpromptresponsebody.md)\>**
 
 ### Errors
 
@@ -161,9 +225,9 @@ run();
 | --------------- | --------------- | --------------- |
 | errors.APIError | 4XX, 5XX        | \*/\*           |
 
-## update
+## retrieve
 
-Update a prompt
+Retrieves a prompt object
 
 ### Example Usage
 
@@ -175,7 +239,7 @@ const orq = new Orq({
 });
 
 async function run() {
-  const result = await orq.prompts.update({
+  const result = await orq.prompts.retrieve({
     id: "<id>",
   });
 
@@ -192,7 +256,7 @@ The standalone function version of this method:
 
 ```typescript
 import { OrqCore } from "@orq-ai/node/core.js";
-import { promptsUpdate } from "@orq-ai/node/funcs/promptsUpdate.js";
+import { promptsRetrieve } from "@orq-ai/node/funcs/promptsRetrieve.js";
 
 // Use `OrqCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -201,7 +265,7 @@ const orq = new OrqCore({
 });
 
 async function run() {
-  const res = await promptsUpdate(orq, {
+  const res = await promptsRetrieve(orq, {
     id: "<id>",
   });
 
@@ -222,25 +286,24 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.UpdatePromptRequest](../../models/operations/updatepromptrequest.md)                                                                                               | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `request`                                                                                                                                                                      | [operations.GetOnePromptRequest](../../models/operations/getonepromptrequest.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.UpdatePromptResponseBody](../../models/operations/updatepromptresponsebody.md)\>**
+**Promise\<[operations.GetOnePromptResponseBody](../../models/operations/getonepromptresponsebody.md)\>**
 
 ### Errors
 
-| Error Type                      | Status Code                     | Content Type                    |
-| ------------------------------- | ------------------------------- | ------------------------------- |
-| errors.UpdatePromptResponseBody | 404                             | application/json                |
-| errors.APIError                 | 4XX, 5XX                        | \*/\*                           |
+| Error Type      | Status Code     | Content Type    |
+| --------------- | --------------- | --------------- |
+| errors.APIError | 4XX, 5XX        | \*/\*           |
 
-## delete
+## update
 
-Delete a prompt
+Update a prompt
 
 ### Example Usage
 
@@ -252,11 +315,12 @@ const orq = new Orq({
 });
 
 async function run() {
-  await orq.prompts.delete({
+  const result = await orq.prompts.update({
     id: "<id>",
   });
 
-
+  // Handle the result
+  console.log(result);
 }
 
 run();
@@ -268,7 +332,7 @@ The standalone function version of this method:
 
 ```typescript
 import { OrqCore } from "@orq-ai/node/core.js";
-import { promptsDelete } from "@orq-ai/node/funcs/promptsDelete.js";
+import { promptsUpdate } from "@orq-ai/node/funcs/promptsUpdate.js";
 
 // Use `OrqCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -277,7 +341,7 @@ const orq = new OrqCore({
 });
 
 async function run() {
-  const res = await promptsDelete(orq, {
+  const res = await promptsUpdate(orq, {
     id: "<id>",
   });
 
@@ -287,7 +351,8 @@ async function run() {
 
   const { value: result } = res;
 
-  
+  // Handle the result
+  console.log(result);
 }
 
 run();
@@ -297,24 +362,25 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.DeletePromptRequest](../../models/operations/deletepromptrequest.md)                                                                                               | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `request`                                                                                                                                                                      | [operations.UpdatePromptRequest](../../models/operations/updatepromptrequest.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\<void\>**
+**Promise\<[operations.UpdatePromptResponseBody](../../models/operations/updatepromptresponsebody.md)\>**
 
 ### Errors
 
-| Error Type      | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.APIError | 4XX, 5XX        | \*/\*           |
+| Error Type                      | Status Code                     | Content Type                    |
+| ------------------------------- | ------------------------------- | ------------------------------- |
+| errors.UpdatePromptResponseBody | 404                             | application/json                |
+| errors.APIError                 | 4XX, 5XX                        | \*/\*                           |
 
-## create
+## delete
 
-Create a prompt
+Delete a prompt
 
 ### Example Usage
 
@@ -326,44 +392,11 @@ const orq = new Orq({
 });
 
 async function run() {
-  const result = await orq.prompts.create({
-    displayName: "Jed6",
-    promptConfig: {
-      messages: [
-        {
-          role: "system",
-          content: "<value>",
-        },
-        {
-          role: "system",
-          content: [
-            {
-              type: "image_url",
-              imageUrl: {
-                url: "https://well-worn-formation.biz",
-              },
-            },
-            {
-              type: "text",
-              text: "<value>",
-            },
-            {
-              type: "text",
-              text: "<value>",
-            },
-          ],
-        },
-        {
-          role: "assistant",
-          content: "<value>",
-        },
-      ],
-    },
-    path: "Customer Service/Billing/Refund",
+  await orq.prompts.delete({
+    id: "<id>",
   });
 
-  // Handle the result
-  console.log(result);
+
 }
 
 run();
@@ -375,7 +408,7 @@ The standalone function version of this method:
 
 ```typescript
 import { OrqCore } from "@orq-ai/node/core.js";
-import { promptsCreate } from "@orq-ai/node/funcs/promptsCreate.js";
+import { promptsDelete } from "@orq-ai/node/funcs/promptsDelete.js";
 
 // Use `OrqCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -384,40 +417,8 @@ const orq = new OrqCore({
 });
 
 async function run() {
-  const res = await promptsCreate(orq, {
-    displayName: "Jed6",
-    promptConfig: {
-      messages: [
-        {
-          role: "system",
-          content: "<value>",
-        },
-        {
-          role: "system",
-          content: [
-            {
-              type: "image_url",
-              imageUrl: {
-                url: "https://well-worn-formation.biz",
-              },
-            },
-            {
-              type: "text",
-              text: "<value>",
-            },
-            {
-              type: "text",
-              text: "<value>",
-            },
-          ],
-        },
-        {
-          role: "assistant",
-          content: "<value>",
-        },
-      ],
-    },
-    path: "Customer Service/Billing/Refund",
+  const res = await promptsDelete(orq, {
+    id: "<id>",
   });
 
   if (!res.ok) {
@@ -426,8 +427,7 @@ async function run() {
 
   const { value: result } = res;
 
-  // Handle the result
-  console.log(result);
+  
 }
 
 run();
@@ -437,14 +437,14 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.CreatePromptRequestBody](../../models/operations/createpromptrequestbody.md)                                                                                       | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `request`                                                                                                                                                                      | [operations.DeletePromptRequest](../../models/operations/deletepromptrequest.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.CreatePromptResponseBody](../../models/operations/createpromptresponsebody.md)\>**
+**Promise\<void\>**
 
 ### Errors
 

package/funcs/deploymentsStream.d.ts

@@ -0,0 +1,17 @@
+import { OrqCore } from "../core.js";
+import { EventStream } from "../lib/event-streams.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { APIError } from "../models/errors/apierror.js";
+import { ConnectionError, InvalidRequestError, RequestAbortedError, RequestTimeoutError, UnexpectedClientError } from "../models/errors/httpclienterrors.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as operations from "../models/operations/index.js";
+import { APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+/**
+ * Stream
+ *
+ * @remarks
+ * Stream deployment generation. Only supported for completions and chat completions.
+ */
+export declare function deploymentsStream(client: OrqCore, request: operations.DeploymentStreamRequestBody, options?: RequestOptions): APIPromise<Result<EventStream<operations.DeploymentStreamResponseBody>, APIError | SDKValidationError | UnexpectedClientError | InvalidRequestError | RequestAbortedError | RequestTimeoutError | ConnectionError>>;
+//# sourceMappingURL=deploymentsStream.d.ts.map

package/funcs/deploymentsStream.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"deploymentsStream.d.ts","sourceRoot":"","sources":["../src/funcs/deploymentsStream.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAErC,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAItD,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAGhD,OAAO,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AACxD,OAAO,EACL,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACtB,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EAAE,kBAAkB,EAAE,MAAM,wCAAwC,CAAC;AAC5E,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,EAAW,UAAU,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAExC;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAC/B,MAAM,EAAE,OAAO,EACf,OAAO,EAAE,UAAU,CAAC,2BAA2B,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CACX,MAAM,CACJ,WAAW,CAAC,UAAU,CAAC,4BAA4B,CAAC,EAClD,QAAQ,GACR,kBAAkB,GAClB,qBAAqB,GACrB,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,eAAe,CAClB,CACF,CAMA"}