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

package/docs/sdks/prompts/README.md

@@ -5,17 +5,15 @@
 
 ### Available Operations
 
-* [create](#create) - Create a new prompt
-* [createVersion](#createversion) - Create a new prompt version
-* [delete](#delete) - Delete a prompt
-* [getOne](#getone) - Get one prompt
+* [create](#create) - Create a prompt
 * [update](#update) - Update a prompt
-* [duplicate](#duplicate) - Duplicate a prompt
-* [getAll](#getall) - Get all prompts
+* [delete](#delete) - Delete a prompt
+* [get](#get) - Retrieve a prompt
+* [list](#list) - List all prompts
 
 ## create
 
-Create a new prompt
+Create a prompt
 
 ### Example Usage
 
@@ -27,7 +25,41 @@ const orq = new Orq({
 });
 
 async function run() {
-  const result = await orq.prompts.create();
+  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
   console.log(result);
@@ -51,7 +83,41 @@ const orq = new OrqCore({
 });
 
 async function run() {
-  const res = await promptsCreate(orq);
+  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) {
     throw res.error;
@@ -85,9 +151,9 @@ run();
 | --------------- | --------------- | --------------- |
 | errors.APIError | 4XX, 5XX        | \*/\*           |
 
-## createVersion
+## update
 
-Create a new prompt version
+Update a prompt
 
 ### Example Usage
 
@@ -99,7 +165,7 @@ const orq = new Orq({
 });
 
 async function run() {
-  const result = await orq.prompts.createVersion({
+  const result = await orq.prompts.update({
     id: "<id>",
   });
 
@@ -116,7 +182,7 @@ The standalone function version of this method:
 
 ```typescript
 import { OrqCore } from "@orq-ai/node/core.js";
-import { promptsCreateVersion } from "@orq-ai/node/funcs/promptsCreateVersion.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.
@@ -125,7 +191,7 @@ const orq = new OrqCore({
 });
 
 async function run() {
-  const res = await promptsCreateVersion(orq, {
+  const res = await promptsUpdate(orq, {
     id: "<id>",
   });
 
@@ -146,20 +212,21 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.CreatePromptVersionRequest](../../models/operations/createpromptversionrequest.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\<[operations.CreatePromptVersionResponseBody](../../models/operations/createpromptversionresponsebody.md)\>**
+**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                        | \*/\*                           |
 
 ## delete
 
@@ -235,9 +302,9 @@ run();
 | --------------- | --------------- | --------------- |
 | errors.APIError | 4XX, 5XX        | \*/\*           |
 
-## getOne
+## get
 
-Get one prompt
+Retrieve a prompt
 
 ### Example Usage
 
@@ -249,7 +316,7 @@ const orq = new Orq({
 });
 
 async function run() {
-  await orq.prompts.getOne({
+  await orq.prompts.get({
     id: "<id>",
   });
 
@@ -265,7 +332,7 @@ The standalone function version of this method:
 
 ```typescript
 import { OrqCore } from "@orq-ai/node/core.js";
-import { promptsGetOne } from "@orq-ai/node/funcs/promptsGetOne.js";
+import { promptsGet } from "@orq-ai/node/funcs/promptsGet.js";
 
 // Use `OrqCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -274,7 +341,7 @@ const orq = new OrqCore({
 });
 
 async function run() {
-  const res = await promptsGetOne(orq, {
+  const res = await promptsGet(orq, {
     id: "<id>",
   });
 
@@ -309,160 +376,9 @@ run();
 | --------------- | --------------- | --------------- |
 | errors.APIError | 4XX, 5XX        | \*/\*           |
 
-## update
-
-Update a prompt
-
-### 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.prompts.update({
-    id: "<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 { 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.
-const orq = new OrqCore({
-  apiKey: process.env["ORQ_API_KEY"] ?? "",
-});
-
-async function run() {
-  const res = await promptsUpdate(orq, {
-    id: "<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.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\<[operations.UpdatePromptResponseBody](../../models/operations/updatepromptresponsebody.md)\>**
-
-### Errors
-
-| Error Type                      | Status Code                     | Content Type                    |
-| ------------------------------- | ------------------------------- | ------------------------------- |
-| errors.UpdatePromptResponseBody | 404                             | application/json                |
-| errors.APIError                 | 4XX, 5XX                        | \*/\*                           |
-
-## duplicate
-
-Duplicate a prompt
-
-### Example Usage
-
-```typescript
-import { Orq } from "@orq-ai/node";
-
-const orq = new Orq({
-  apiKey: process.env["ORQ_API_KEY"] ?? "",
-});
-
-async function run() {
-  await orq.prompts.duplicate({
-    id: "<id>",
-  });
-
-
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { OrqCore } from "@orq-ai/node/core.js";
-import { promptsDuplicate } from "@orq-ai/node/funcs/promptsDuplicate.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 promptsDuplicate(orq, {
-    id: "<id>",
-  });
-
-  if (!res.ok) {
-    throw res.error;
-  }
-
-  const { value: result } = res;
-
-  
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.DuplicatePromptRequest](../../models/operations/duplicatepromptrequest.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\>**
-
-### Errors
-
-| Error Type      | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.APIError | 4XX, 5XX        | \*/\*           |
-
-## getAll
+## list
 
-Get all prompts
+List all prompts
 
 ### Example Usage
 
@@ -474,7 +390,7 @@ const orq = new Orq({
 });
 
 async function run() {
-  const result = await orq.prompts.getAll();
+  const result = await orq.prompts.list({});
 
   // Handle the result
   console.log(result);
@@ -489,7 +405,7 @@ The standalone function version of this method:
 
 ```typescript
 import { OrqCore } from "@orq-ai/node/core.js";
-import { promptsGetAll } from "@orq-ai/node/funcs/promptsGetAll.js";
+import { promptsList } from "@orq-ai/node/funcs/promptsList.js";
 
 // Use `OrqCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -498,7 +414,7 @@ const orq = new OrqCore({
 });
 
 async function run() {
-  const res = await promptsGetAll(orq);
+  const res = await promptsList(orq, {});
 
   if (!res.ok) {
     throw res.error;
@@ -517,7 +433,7 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.GetAllPromptsRequestBody](../../models/operations/getallpromptsrequestbody.md)                                                                                     | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `request`                                                                                                                                                                      | [operations.GetAllPromptsRequest](../../models/operations/getallpromptsrequest.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.                                                                                                               |