ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.455.5

orq-ai · Dec 16, 2024 · 16ec634 · 16ec634
1 parent 76ec799
commit 16ec634
Show file tree

Hide file tree

Showing 968 changed files with 525 additions and 86,241 deletions.
diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock
diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock
@@ -1,12 +1,12 @@
-speakeasyVersion: 1.454.0
+speakeasyVersion: 1.455.5
 sources:
     orq-ai-node:
         sourceNamespace: orq-ai-node
-        sourceRevisionDigest: sha256:124147b62647f80d9c595af677e0b904130b58ab9049de79d04902cedc96beb8
-        sourceBlobDigest: sha256:897b0e8e98e67b47490aae717bf3256d6d4574cdd4014a81401d844337126fb4
+        sourceRevisionDigest: sha256:f3f7aec2d9bb037d358ff9a7fdd7e20f85c81a7b3947249e0095f213eeacf790
+        sourceBlobDigest: sha256:118ed318598374163d31c335847a23ebaa71f446aca4fb3ea1f09e2382b13b9c
         tags:
             - latest
-            - speakeasy-sdk-regen-1734004973
+            - speakeasy-sdk-regen-1734366867
             - "2.0"
     orq-ai-prerelease-node:
         sourceNamespace: orq-ai-prerelease-node
@@ -20,10 +20,10 @@ targets:
     orq-ai-node:
         source: orq-ai-node
         sourceNamespace: orq-ai-node
-        sourceRevisionDigest: sha256:124147b62647f80d9c595af677e0b904130b58ab9049de79d04902cedc96beb8
-        sourceBlobDigest: sha256:897b0e8e98e67b47490aae717bf3256d6d4574cdd4014a81401d844337126fb4
+        sourceRevisionDigest: sha256:f3f7aec2d9bb037d358ff9a7fdd7e20f85c81a7b3947249e0095f213eeacf790
+        sourceBlobDigest: sha256:118ed318598374163d31c335847a23ebaa71f446aca4fb3ea1f09e2382b13b9c
         codeSamplesNamespace: orq-ai-node-typescript-code-samples
-        codeSamplesRevisionDigest: sha256:b51cbcd4dfaeeb44689270679695acb6dd6a6578e9c77edcbf4e7e65cb5504d2
+        codeSamplesRevisionDigest: sha256:7a02e5c8288067b6df5431c02f1ddc80c07c788a445fe09007bbd202716b666f
     orq-ai-prerelease-node:
         source: orq-ai-prerelease-node
         sourceNamespace: orq-ai-prerelease-node

diff --git a/README.md b/README.md
@@ -174,27 +174,6 @@ run();
 * [bulkUpload](docs/sdks/files/README.md#bulkupload) - Bulk upload file
 
 
-### [prompt](docs/sdks/prompt/README.md)
-
-
-#### [prompt.snippets](docs/sdks/snippets/README.md)
-
-* [findOne](docs/sdks/snippets/README.md#findone) - Get one prompt snippet
-
-#### [prompt.templates](docs/sdks/templates/README.md)
-
-* [getAll](docs/sdks/templates/README.md#getall) - Get all prompt templates
-
-### [prompts](docs/sdks/prompts/README.md)
-
-* [create](docs/sdks/prompts/README.md#create) - Create a new prompt
-* [createVersion](docs/sdks/prompts/README.md#createversion) - Create a new prompt version
-* [delete](docs/sdks/prompts/README.md#delete) - Delete a prompt
-* [getOne](docs/sdks/prompts/README.md#getone) - Get one prompt
-* [update](docs/sdks/prompts/README.md#update) - Update a prompt
-* [duplicate](docs/sdks/prompts/README.md#duplicate) - Duplicate a prompt
-* [getAll](docs/sdks/prompts/README.md#getall) - Get all prompts
-
 ### [remoteconfig](docs/sdks/remoteconfig/README.md)
 
 * [getConfig](docs/sdks/remoteconfig/README.md#getconfig) - Get Configurations
@@ -226,15 +205,6 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 - [`feedbackCreate`](docs/sdks/feedback/README.md#create) - Submit feedback
 - [`filesBulkUpload`](docs/sdks/files/README.md#bulkupload) - Bulk upload file
 - [`filesUpload`](docs/sdks/files/README.md#upload) - Upload file
-- [`promptsCreate`](docs/sdks/prompts/README.md#create) - Create a new prompt
-- [`promptsCreateVersion`](docs/sdks/prompts/README.md#createversion) - Create a new prompt version
-- [`promptsDelete`](docs/sdks/prompts/README.md#delete) - Delete a prompt
-- [`promptsDuplicate`](docs/sdks/prompts/README.md#duplicate) - Duplicate a prompt
-- [`promptsGetAll`](docs/sdks/prompts/README.md#getall) - Get all prompts
-- [`promptsGetOne`](docs/sdks/prompts/README.md#getone) - Get one prompt
-- [`promptSnippetsFindOne`](docs/sdks/snippets/README.md#findone) - Get one prompt snippet
-- [`promptsUpdate`](docs/sdks/prompts/README.md#update) - Update a prompt
-- [`promptTemplatesGetAll`](docs/sdks/templates/README.md#getall) - Get all prompt templates
 - [`remoteconfigGetConfig`](docs/sdks/remoteconfig/README.md#getconfig) - Get Configurations
 
 </details>
@@ -380,25 +350,15 @@ run();
 <!-- Start Error Handling [errors] -->
 ## Error Handling
 
-All SDK methods return a response object or throw an error. By default, an API error will throw a `errors.APIError`.
-
-If a HTTP request fails, an operation my also throw an error from the `models/errors/httpclienterrors.ts` module:
-
-| HTTP Client Error                                    | Description                                          |
-| ---------------------------------------------------- | ---------------------------------------------------- |
-| RequestAbortedError                                  | HTTP request was aborted by the client               |
-| RequestTimeoutError                                  | HTTP request timed out due to an AbortSignal signal  |
-| ConnectionError                                      | HTTP client was unable to make a request to a server |
-| InvalidRequestError                                  | Any input used to create a request is invalid        |
-| UnexpectedClientError                                | Unrecognised or unexpected error                     |
-
-In addition, when custom error responses are specified for an operation, the SDK may throw their associated Error type. You can refer to respective *Errors* tables in SDK docs for more details on possible error types for each operation. For example, the `all` method may throw the following errors:
+Some methods specify known errors which can be thrown. All the known errors are enumerated in the `models/errors/errors.ts` module. The known errors for a method are documented under the *Errors* tables in SDK docs. For example, the `all` method may throw the following errors:
 
 | Error Type          | Status Code | Content Type     |
 | ------------------- | ----------- | ---------------- |
 | errors.HonoApiError | 500         | application/json |
 | errors.APIError     | 4XX, 5XX    | \*/\*            |
 
+If the method throws an error and it is not captured by the known errors, it will default to throwing a `APIError`.
+
 ```typescript
 import { Orq } from "@orq-ai/node";
 import { HonoApiError, SDKValidationError } from "@orq-ai/node/models/errors";
@@ -416,8 +376,9 @@ async function run() {
     console.log(result);
   } catch (err) {
     switch (true) {
+      // The server response does not match the expected SDK schema
       case (err instanceof SDKValidationError): {
-        // Validation errors can be pretty-printed
+        // Pretty-print will provide a human-readable multi-line error message
         console.error(err.pretty());
         // Raw value may also be inspected
         console.error(err.rawValue);
@@ -429,6 +390,7 @@ async function run() {
         return;
       }
       default: {
+        // Other errors such as network errors, see HTTPClientErrors for more details
         throw err;
       }
     }
@@ -439,7 +401,17 @@ run();
 
 ```
 
-Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The `SDKValidationError` that is thrown as a result will capture the raw value that failed validation in an attribute called `rawValue`. Additionally, a `pretty()` method is available on this error that can be used to log a nicely formatted string since validation errors can list many issues and the plain error string may be difficult read when debugging.
+Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The `SDKValidationError` that is thrown as a result will capture the raw value that failed validation in an attribute called `rawValue`. Additionally, a `pretty()` method is available on this error that can be used to log a nicely formatted multi-line string since validation errors can list many issues and the plain error string may be difficult read when debugging.
+
+In some rare cases, the SDK can fail to get a response from the server or even make the request due to unexpected circumstances such as network conditions. These types of errors are captured in the `models/errors/httpclienterrors.ts` module:
+
+| HTTP Client Error                                    | Description                                          |
+| ---------------------------------------------------- | ---------------------------------------------------- |
+| RequestAbortedError                                  | HTTP request was aborted by the client               |
+| RequestTimeoutError                                  | HTTP request timed out due to an AbortSignal signal  |
+| ConnectionError                                      | HTTP client was unable to make a request to a server |
+| InvalidRequestError                                  | Any input used to create a request is invalid        |
+| UnexpectedClientError                                | Unrecognised or unexpected error                     |
 <!-- End Error Handling [errors] -->
 
 <!-- Start Server Selection [server] -->

diff --git a/RELEASES.md b/RELEASES.md
@@ -18,4 +18,14 @@ Based on:
 ### Generated
 - [typescript v1.31.1] .
 ### Releases
-- [NPM v1.31.1] https://www.npmjs.com/package/@orq-ai/node/v/1.31.1 - .
+- [NPM v1.31.1] https://www.npmjs.com/package/@orq-ai/node/v/1.31.1 - .
+
+## 2024-12-16 16:34:23
+### Changes
+Based on:
+- OpenAPI Doc  
+- Speakeasy CLI 1.455.5 (2.479.3) https://github.com/speakeasy-api/speakeasy
+### Generated
+- [typescript v1.31.11] .
+### Releases
+- [NPM v1.31.11] https://www.npmjs.com/package/@orq-ai/node/v/1.31.11 - .
diff --git a/docs/models/components/content.md b/docs/models/components/content.md
@@ -18,7 +18,7 @@ const value: components.Two[] = [
   {
     type: "image_url",
     imageUrl: {
-      url: "https://ashamed-distinction.net",
+      url: "https://insistent-markup.biz",
     },
   },
 ];

diff --git a/docs/models/components/content2.md b/docs/models/components/content2.md
@@ -18,7 +18,7 @@ const value: components.Two1 = {
 const value: components.Deployments22 = {
   type: "image_url",
   imageUrl: {
-    url: "https://worldly-apricot.com/",
+    url: "https://frequent-wriggler.biz",
   },
 };
 ```

diff --git a/docs/models/components/deployments22.md b/docs/models/components/deployments22.md
@@ -10,7 +10,7 @@ import { Deployments22 } from "@orq-ai/node/models/components";
 let value: Deployments22 = {
   type: "image_url",
   imageUrl: {
-    url: "https://crooked-in-joke.biz/",
+    url: "https://subdued-widow.org/",
   },
 };
 ```

diff --git a/docs/models/components/deploymentscontent.md b/docs/models/components/deploymentscontent.md
@@ -16,10 +16,8 @@ const value: string = "<value>";
 ```typescript
 const value: components.Content2[] = [
   {
-    type: "image_url",
-    imageUrl: {
-      url: "https://artistic-impostor.org/",
-    },
+    type: "text",
+    text: "<value>",
   },
 ];
 ```

diff --git a/docs/models/components/deploymentsrole.md b/docs/models/components/deploymentsrole.md
@@ -7,7 +7,7 @@ The role of the prompt message
 ```typescript
 import { DeploymentsRole } from "@orq-ai/node/models/components";
 
-let value: DeploymentsRole = "correction";
+let value: DeploymentsRole = "user";
 ```
 
 ## Values

diff --git a/docs/models/components/imageurl.md b/docs/models/components/imageurl.md
@@ -6,7 +6,7 @@
 import { ImageUrl } from "@orq-ai/node/models/components";
 
 let value: ImageUrl = {
-  url: "https://authorized-transom.info",
+  url: "https://incomparable-coil.name",
 };
 ```
 

diff --git a/docs/models/components/inputs.md b/docs/models/components/inputs.md
@@ -12,7 +12,7 @@ const value: string = "<value>";
 ### `number`
 
 ```typescript
-const value: number = 442.61;
+const value: number = 6184.80;
 ```
 
 ### `boolean`

diff --git a/docs/models/components/messages.md b/docs/models/components/messages.md
@@ -6,15 +6,8 @@
 import { Messages } from "@orq-ai/node/models/components";
 
 let value: Messages = {
-  role: "user",
-  content: [
-    {
-      type: "image_url",
-      imageUrl: {
-        url: "https://jam-packed-traditionalism.com/",
-      },
-    },
-  ],
+  role: "expected_output",
+  content: "<value>",
 };
 ```
 

diff --git a/docs/models/components/prefixmessages.md b/docs/models/components/prefixmessages.md
@@ -6,7 +6,7 @@
 import { PrefixMessages } from "@orq-ai/node/models/components";
 
 let value: PrefixMessages = {
-  role: "user",
+  role: "prompt",
   content: "<value>",
 };
 ```

diff --git a/docs/models/components/role.md b/docs/models/components/role.md
@@ -7,7 +7,7 @@ The role of the prompt message
 ```typescript
 import { Role } from "@orq-ai/node/models/components";
 
-let value: Role = "correction";
+let value: Role = "expected_output";
 ```
 
 ## Values

diff --git a/docs/models/components/two.md b/docs/models/components/two.md
@@ -18,7 +18,7 @@ const value: components.One = {
 const value: components.Two2 = {
   type: "image_url",
   imageUrl: {
-    url: "https://better-bonnet.name",
+    url: "https://excellent-petticoat.biz/",
   },
 };
 ```

diff --git a/docs/models/components/two2.md b/docs/models/components/two2.md
@@ -10,7 +10,7 @@ import { Two2 } from "@orq-ai/node/models/components";
 let value: Two2 = {
   type: "image_url",
   imageUrl: {
-    url: "https://key-soup.biz/",
+    url: "https://wrong-baseboard.net/",
   },
 };
 ```

diff --git a/docs/models/components/twoimageurl.md b/docs/models/components/twoimageurl.md
@@ -6,7 +6,7 @@
 import { TwoImageUrl } from "@orq-ai/node/models/components";
 
 let value: TwoImageUrl = {
-  url: "https://silky-order.org",
+  url: "https://vain-archaeology.biz",
 };
 ```
 

diff --git a/docs/models/components/userid.md b/docs/models/components/userid.md
@@ -14,6 +14,6 @@ const value: string = "<value>";
 ### `number`
 
 ```typescript
-const value: number = 618.93;
+const value: number = 6897.68;
 ```
 
diff --git a/docs/models/errors/updatepromptresponsebody.md b/docs/models/errors/updatepromptresponsebody.md
diff --git a/docs/models/operations/createprompt21.md b/docs/models/operations/createprompt21.md
diff --git a/docs/models/operations/createprompt22.md b/docs/models/operations/createprompt22.md
diff --git a/docs/models/operations/createprompt2imageurl.md b/docs/models/operations/createprompt2imageurl.md