@orq-ai/node 3.4.0-rc.37 → 3.5.11

package/{docs/sdks/tools → packages/orq-rc/docs/sdks/deployments}/README.md

@@ -1,19 +1,19 @@
-# Tools
-(*tools*)
+# Deployments
+(*deployments*)
 
 ## Overview
 
 ### Available Operations
 
-* [list](#list) - List tools
-* [create](#create) - Create tool
-* [update](#update) - Update tool
-* [delete](#delete) - Delete tool
-* [retrieve](#retrieve) - Retrieve tool
+* [list](#list) - List all deployments
+* [getConfig](#getconfig) - Get config
+* [invoke](#invoke) - Invoke
+* [stream](#stream) - Stream
+* [createExperiment](#createexperiment) - Create an experiment from a deployment
 
 ## list
 
-Retrieves a paginated list of tools in the workspace. Use cursor-based pagination parameters to navigate through the results.
+Returns a list of your deployments. The deployments are returned sorted by creation date, with the most recent deployments appearing first.
 
 ### Example Usage
 
@@ -25,7 +25,7 @@ const orq = new Orq({
 });
 
 async function run() {
-  const result = await orq.tools.list({});
+  const result = await orq.deployments.list({});
 
   // Handle the result
   console.log(result);
@@ -40,7 +40,7 @@ The standalone function version of this method:
 
 ```typescript
 import { OrqCore } from "@orq-ai/node/core.js";
-import { toolsList } from "@orq-ai/node/funcs/toolsList.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.
@@ -49,7 +49,7 @@ const orq = new OrqCore({
 });
 
 async function run() {
-  const res = await toolsList(orq, {});
+  const res = await deploymentsList(orq, {});
 
   if (!res.ok) {
     throw res.error;
@@ -68,25 +68,25 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.GetAllToolsRequest](../../models/operations/getalltoolsrequest.md)                                                                                                 | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `request`                                                                                                                                                                      | [operations.DeploymentsRequest](../../models/operations/deploymentsrequest.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.GetAllToolsResponseBody](../../models/operations/getalltoolsresponsebody.md)\>**
+**Promise\<[operations.DeploymentsResponseBody](../../models/operations/deploymentsresponsebody.md)\>**
 
 ### Errors
 
 | Error Type          | Status Code         | Content Type        |
 | ------------------- | ------------------- | ------------------- |
-| errors.HonoApiError | 401                 | application/json    |
+| errors.HonoApiError | 500                 | application/json    |
 | errors.APIError     | 4XX, 5XX            | \*/\*               |
 
-## create
+## getConfig
 
-Creates a new tool in the workspace.
+Retrieve the deployment configuration
 
 ### Example Usage
 
@@ -98,21 +98,8 @@ const orq = new Orq({
 });
 
 async function run() {
-  const result = await orq.tools.create({
-    path: "Customer Service/Billing/Refund",
+  const result = await orq.deployments.getConfig({
     key: "<key>",
-    description: "delightfully fumigate convection though zowie up bulky electronics",
-    status: "pending",
-    versionHash: "<value>",
-    type: "json_schema",
-    jsonSchema: {
-      name: "<value>",
-      schema: {
-        "key": "<value>",
-        "key1": "<value>",
-      },
-      strict: false,
-    },
   });
 
   // Handle the result
@@ -128,7 +115,7 @@ The standalone function version of this method:
 
 ```typescript
 import { OrqCore } from "@orq-ai/node/core.js";
-import { toolsCreate } from "@orq-ai/node/funcs/toolsCreate.js";
+import { deploymentsGetConfig } from "@orq-ai/node/funcs/deploymentsGetConfig.js";
 
 // Use `OrqCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -137,21 +124,8 @@ const orq = new OrqCore({
 });
 
 async function run() {
-  const res = await toolsCreate(orq, {
-    path: "Customer Service/Billing/Refund",
+  const res = await deploymentsGetConfig(orq, {
     key: "<key>",
-    description: "delightfully fumigate convection though zowie up bulky electronics",
-    status: "pending",
-    versionHash: "<value>",
-    type: "json_schema",
-    jsonSchema: {
-      name: "<value>",
-      schema: {
-        "key": "<value>",
-        "key1": "<value>",
-      },
-      strict: false,
-    },
   });
 
   if (!res.ok) {
@@ -171,14 +145,14 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.CreateToolRequestBody](../../models/operations/createtoolrequestbody.md)                                                                                           | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `request`                                                                                                                                                                      | [operations.DeploymentGetConfigRequestBody](../../models/operations/deploymentgetconfigrequestbody.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.CreateToolResponseBody](../../models/operations/createtoolresponsebody.md)\>**
+**Promise\<[operations.DeploymentGetConfigResponseBody](../../models/operations/deploymentgetconfigresponsebody.md)\>**
 
 ### Errors
 
@@ -186,9 +160,9 @@ run();
 | --------------- | --------------- | --------------- |
 | errors.APIError | 4XX, 5XX        | \*/\*           |
 
-## update
+## invoke
 
-Updates a tool in the workspace.
+Invoke a deployment with a given payload
 
 ### Example Usage
 
@@ -200,14 +174,8 @@ const orq = new Orq({
 });
 
 async function run() {
-  const result = await orq.tools.update({
-    toolKey: "<value>",
-    requestBody: {
-      path: "Customer Service/Billing/Refund",
-      status: "pending",
-      versionHash: "<value>",
-      type: "orq_http",
-    },
+  const result = await orq.deployments.invoke({
+    key: "<key>",
   });
 
   // Handle the result
@@ -223,7 +191,7 @@ The standalone function version of this method:
 
 ```typescript
 import { OrqCore } from "@orq-ai/node/core.js";
-import { toolsUpdate } from "@orq-ai/node/funcs/toolsUpdate.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.
@@ -232,14 +200,8 @@ const orq = new OrqCore({
 });
 
 async function run() {
-  const res = await toolsUpdate(orq, {
-    toolKey: "<value>",
-    requestBody: {
-      path: "Customer Service/Billing/Refund",
-      status: "pending",
-      versionHash: "<value>",
-      type: "orq_http",
-    },
+  const res = await deploymentsInvoke(orq, {
+    key: "<key>",
   });
 
   if (!res.ok) {
@@ -259,14 +221,14 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.UpdateToolRequest](../../models/operations/updatetoolrequest.md)                                                                                                   | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `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.UpdateToolResponseBody](../../models/operations/updatetoolresponsebody.md)\>**
+**Promise\<[operations.DeploymentInvokeResponseBody](../../models/operations/deploymentinvokeresponsebody.md)\>**
 
 ### Errors
 
@@ -274,9 +236,9 @@ run();
 | --------------- | --------------- | --------------- |
 | errors.APIError | 4XX, 5XX        | \*/\*           |
 
-## delete
+## stream
 
-Deletes a tool by key.
+Stream deployment generation. Only supported for completions and chat completions.
 
 ### Example Usage
 
@@ -288,11 +250,14 @@ const orq = new Orq({
 });
 
 async function run() {
-  await orq.tools.delete({
-    toolKey: "<value>",
+  const result = await orq.deployments.stream({
+    key: "<key>",
   });
 
-
+  for await (const event of result) {
+    // Handle the event
+    console.log(event);
+  }
 }
 
 run();
@@ -304,7 +269,7 @@ The standalone function version of this method:
 
 ```typescript
 import { OrqCore } from "@orq-ai/node/core.js";
-import { toolsDelete } from "@orq-ai/node/funcs/toolsDelete.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.
@@ -313,8 +278,8 @@ const orq = new OrqCore({
 });
 
 async function run() {
-  const res = await toolsDelete(orq, {
-    toolKey: "<value>",
+  const res = await deploymentsStream(orq, {
+    key: "<key>",
   });
 
   if (!res.ok) {
@@ -323,7 +288,10 @@ async function run() {
 
   const { value: result } = res;
 
-  
+  for await (const event of result) {
+    // Handle the event
+    console.log(event);
+  }
 }
 
 run();
@@ -333,14 +301,14 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.DeleteToolRequest](../../models/operations/deletetoolrequest.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\<void\>**
+**Promise\<[EventStream<operations.DeploymentStreamResponseBody>](../../models/.md)\>**
 
 ### Errors
 
@@ -348,9 +316,9 @@ run();
 | --------------- | --------------- | --------------- |
 | errors.APIError | 4XX, 5XX        | \*/\*           |
 
-## retrieve
+## createExperiment
 
-Retrieves a tool by key.
+Create an experiment from a deployment
 
 ### Example Usage
 
@@ -362,8 +330,14 @@ const orq = new Orq({
 });
 
 async function run() {
-  const result = await orq.tools.retrieve({
-    toolKey: "<value>",
+  const result = await orq.deployments.createExperiment({
+    deploymentKey: "<value>",
+    requestBody: {
+      experimentKey: "<value>",
+      path: "Default/Experiments",
+      datasetId: "<id>",
+      type: "deployment_experiment",
+    },
   });
 
   // Handle the result
@@ -379,7 +353,7 @@ The standalone function version of this method:
 
 ```typescript
 import { OrqCore } from "@orq-ai/node/core.js";
-import { toolsRetrieve } from "@orq-ai/node/funcs/toolsRetrieve.js";
+import { deploymentsCreateExperiment } from "@orq-ai/node/funcs/deploymentsCreateExperiment.js";
 
 // Use `OrqCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -388,8 +362,14 @@ const orq = new OrqCore({
 });
 
 async function run() {
-  const res = await toolsRetrieve(orq, {
-    toolKey: "<value>",
+  const res = await deploymentsCreateExperiment(orq, {
+    deploymentKey: "<value>",
+    requestBody: {
+      experimentKey: "<value>",
+      path: "Default/Experiments",
+      datasetId: "<id>",
+      type: "deployment_experiment",
+    },
   });
 
   if (!res.ok) {
@@ -409,14 +389,14 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.RetrieveToolRequest](../../models/operations/retrievetoolrequest.md)                                                                                               | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `request`                                                                                                                                                                      | [operations.CreateDeploymentExperimentRequest](../../models/operations/createdeploymentexperimentrequest.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.RetrieveToolResponseBody](../../models/operations/retrievetoolresponsebody.md)\>**
+**Promise\<[operations.CreateDeploymentExperimentResponseBody](../../models/operations/createdeploymentexperimentresponsebody.md)\>**
 
 ### Errors
 

package/packages/orq-rc/docs/sdks/feedback/README.md

@@ -0,0 +1,92 @@
+# Feedback
+(*feedback*)
+
+## Overview
+
+### Available Operations
+
+* [create](#create) - Submit feedback
+
+## create
+
+Submit feedback for the LLM transaction via the API
+
+### 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.feedback.create({
+    field: "rating",
+    value: [
+      "good",
+    ],
+    traceId: "67HTZ65Z9W91HSF51CW68KK1QH",
+  });
+
+  // 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 { feedbackCreate } from "@orq-ai/node/funcs/feedbackCreate.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 feedbackCreate(orq, {
+    field: "rating",
+    value: [
+      "good",
+    ],
+    traceId: "67HTZ65Z9W91HSF51CW68KK1QH",
+  });
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.CreateFeedbackRequestBody](../../models/operations/createfeedbackrequestbody.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.CreateFeedbackResponseBody](../../models/operations/createfeedbackresponsebody.md)\>**
+
+### Errors
+
+| Error Type      | Status Code     | Content Type    |
+| --------------- | --------------- | --------------- |
+| errors.APIError | 4XX, 5XX        | \*/\*           |