@orq-ai/node 3.1.6 → 3.1.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/jsr.json +1 -1
- package/lib/config.d.ts +3 -3
- package/lib/config.js +3 -3
- package/models/operations/createcontact.js +2 -2
- package/models/operations/fileget.js +2 -2
- package/models/operations/filelist.js +2 -2
- package/models/operations/fileupload.js +2 -2
- package/package.json +1 -1
- package/packages/orq-rc/README.md +8 -61
- package/packages/orq-rc/docs/sdks/deployments/README.md +0 -81
- package/packages/orq-rc/docs/sdks/files/README.md +8 -8
- package/packages/orq-rc/docs/sdks/{remoteconfig → remoteconfigs}/README.md +8 -8
- package/packages/orq-rc/jsr.json +1 -2
- package/packages/orq-rc/package-lock.json +2 -2
- package/packages/orq-rc/package.json +1 -1
- package/packages/orq-rc/src/funcs/contactsCreate.ts +1 -0
- package/packages/orq-rc/src/funcs/deploymentsGetConfig.ts +1 -0
- package/packages/orq-rc/src/funcs/deploymentsInvoke.ts +1 -0
- package/packages/orq-rc/src/funcs/deploymentsList.ts +1 -0
- package/packages/orq-rc/src/funcs/deploymentsMetricsCreate.ts +1 -0
- package/packages/orq-rc/src/funcs/feedbackCreate.ts +1 -0
- package/packages/orq-rc/src/funcs/{filesUpload.ts → filesCreate.ts} +3 -2
- package/packages/orq-rc/src/funcs/filesDelete.ts +1 -0
- package/packages/orq-rc/src/funcs/filesGet.ts +5 -1
- package/packages/orq-rc/src/funcs/filesList.ts +6 -3
- package/packages/orq-rc/src/funcs/promptsCreate.ts +1 -0
- package/packages/orq-rc/src/funcs/promptsDelete.ts +1 -0
- package/packages/orq-rc/src/funcs/promptsGetVersion.ts +1 -0
- package/packages/orq-rc/src/funcs/promptsList.ts +1 -0
- package/packages/orq-rc/src/funcs/promptsListVersions.ts +1 -0
- package/packages/orq-rc/src/funcs/promptsRetrieve.ts +1 -0
- package/packages/orq-rc/src/funcs/promptsUpdate.ts +1 -0
- package/packages/orq-rc/src/funcs/{remoteconfigGetConfig.ts → remoteconfigsRetrieve.ts} +3 -2
- package/packages/orq-rc/src/hooks/types.ts +1 -0
- package/packages/orq-rc/src/lib/config.ts +3 -3
- package/packages/orq-rc/src/lib/matchers.ts +1 -4
- package/packages/orq-rc/src/lib/security.ts +0 -1
- package/packages/orq-rc/src/models/errors/index.ts +0 -1
- package/packages/orq-rc/src/models/operations/createcontact.ts +2 -2
- package/packages/orq-rc/src/models/operations/createprompt.ts +668 -770
- package/packages/orq-rc/src/models/operations/fileget.ts +2 -2
- package/packages/orq-rc/src/models/operations/filelist.ts +31 -16
- package/packages/orq-rc/src/models/operations/fileupload.ts +2 -2
- package/packages/orq-rc/src/models/operations/index.ts +0 -7
- package/packages/orq-rc/src/models/operations/updateprompt.ts +64 -81
- package/packages/orq-rc/src/sdk/deployments.ts +0 -19
- package/packages/orq-rc/src/sdk/files.ts +11 -5
- package/packages/orq-rc/src/sdk/{remoteconfig.ts → remoteconfigs.ts} +5 -5
- package/packages/orq-rc/src/sdk/sdk.ts +4 -10
- package/src/lib/config.ts +3 -3
- package/src/models/operations/createcontact.ts +2 -2
- package/src/models/operations/fileget.ts +2 -2
- package/src/models/operations/filelist.ts +2 -2
- package/src/models/operations/fileupload.ts +2 -2
- package/packages/orq-rc/docs/sdks/promptsnippets/README.md +0 -534
- package/packages/orq-rc/src/funcs/deploymentsStream.ts +0 -150
- package/packages/orq-rc/src/funcs/promptSnippetsCreate.ts +0 -128
- package/packages/orq-rc/src/funcs/promptSnippetsDelete.ts +0 -131
- package/packages/orq-rc/src/funcs/promptSnippetsGet.ts +0 -130
- package/packages/orq-rc/src/funcs/promptSnippetsGetByKey.ts +0 -132
- package/packages/orq-rc/src/funcs/promptSnippetsList.ts +0 -132
- package/packages/orq-rc/src/funcs/promptSnippetsUpdate.ts +0 -139
- package/packages/orq-rc/src/lib/event-streams.ts +0 -264
- package/packages/orq-rc/src/models/errors/updatepromptsnippet.ts +0 -71
- package/packages/orq-rc/src/models/operations/createpromptsnippet.ts +0 -6239
- package/packages/orq-rc/src/models/operations/deletepromptsnippet.ts +0 -69
- package/packages/orq-rc/src/models/operations/deploymentstream.ts +0 -3062
- package/packages/orq-rc/src/models/operations/findonebykeypromptsnippet.ts +0 -4483
- package/packages/orq-rc/src/models/operations/findonepromptsnippet.ts +0 -4343
- package/packages/orq-rc/src/models/operations/getallpromptsnippets.ts +0 -4472
- package/packages/orq-rc/src/models/operations/updatepromptsnippet.ts +0 -6544
- package/packages/orq-rc/src/sdk/promptsnippets.ts +0 -99
package/jsr.json
CHANGED
package/lib/config.d.ts
CHANGED
|
@@ -35,8 +35,8 @@ export declare function serverURLFromOptions(options: SDKOptions): URL | null;
|
|
|
35
35
|
export declare const SDK_METADATA: {
|
|
36
36
|
readonly language: "typescript";
|
|
37
37
|
readonly openapiDocVersion: "2.0";
|
|
38
|
-
readonly sdkVersion: "3.1.
|
|
39
|
-
readonly genVersion: "2.512.
|
|
40
|
-
readonly userAgent: "speakeasy-sdk/typescript 3.1.
|
|
38
|
+
readonly sdkVersion: "3.1.8";
|
|
39
|
+
readonly genVersion: "2.512.4";
|
|
40
|
+
readonly userAgent: "speakeasy-sdk/typescript 3.1.8 2.512.4 2.0 @orq-ai/node";
|
|
41
41
|
};
|
|
42
42
|
//# sourceMappingURL=config.d.ts.map
|
package/lib/config.js
CHANGED
|
@@ -28,8 +28,8 @@ function serverURLFromOptions(options) {
|
|
|
28
28
|
exports.SDK_METADATA = {
|
|
29
29
|
language: "typescript",
|
|
30
30
|
openapiDocVersion: "2.0",
|
|
31
|
-
sdkVersion: "3.1.
|
|
32
|
-
genVersion: "2.512.
|
|
33
|
-
userAgent: "speakeasy-sdk/typescript 3.1.
|
|
31
|
+
sdkVersion: "3.1.8",
|
|
32
|
+
genVersion: "2.512.4",
|
|
33
|
+
userAgent: "speakeasy-sdk/typescript 3.1.8 2.512.4 2.0 @orq-ai/node",
|
|
34
34
|
};
|
|
35
35
|
//# sourceMappingURL=config.js.map
|
|
@@ -102,7 +102,7 @@ exports.CreateContactResponseBody$inboundSchema = z.object({
|
|
|
102
102
|
metadata: z.record(z.any()).optional(),
|
|
103
103
|
created: z.string().datetime({ offset: true }).transform(v => new Date(v))
|
|
104
104
|
.optional(),
|
|
105
|
-
updated: z.string().datetime({ offset: true }).default("2025-02-
|
|
105
|
+
updated: z.string().datetime({ offset: true }).default("2025-02-16T19:05:31.675Z").transform(v => new Date(v)),
|
|
106
106
|
}).transform((v) => {
|
|
107
107
|
return (0, primitives_js_1.remap)(v, {
|
|
108
108
|
"external_id": "externalId",
|
|
@@ -120,7 +120,7 @@ exports.CreateContactResponseBody$outboundSchema = z.object({
|
|
|
120
120
|
tags: z.array(z.string()).optional(),
|
|
121
121
|
metadata: z.record(z.any()).optional(),
|
|
122
122
|
created: z.date().transform(v => v.toISOString()).optional(),
|
|
123
|
-
updated: z.date().default(() => new Date("2025-02-
|
|
123
|
+
updated: z.date().default(() => new Date("2025-02-16T19:05:31.675Z"))
|
|
124
124
|
.transform(v => v.toISOString()),
|
|
125
125
|
}).transform((v) => {
|
|
126
126
|
return (0, primitives_js_1.remap)(v, {
|
|
@@ -107,7 +107,7 @@ exports.FileGetResponseBody$inboundSchema = z.object({
|
|
|
107
107
|
bytes: z.number(),
|
|
108
108
|
file_name: z.string(),
|
|
109
109
|
workspace_id: z.string(),
|
|
110
|
-
created: z.string().datetime({ offset: true }).default("2025-02-
|
|
110
|
+
created: z.string().datetime({ offset: true }).default("2025-02-16T19:05:32.895Z").transform(v => new Date(v)),
|
|
111
111
|
}).transform((v) => {
|
|
112
112
|
return (0, primitives_js_1.remap)(v, {
|
|
113
113
|
"_id": "id",
|
|
@@ -124,7 +124,7 @@ exports.FileGetResponseBody$outboundSchema = z.object({
|
|
|
124
124
|
bytes: z.number(),
|
|
125
125
|
fileName: z.string(),
|
|
126
126
|
workspaceId: z.string(),
|
|
127
|
-
created: z.date().default(() => new Date("2025-02-
|
|
127
|
+
created: z.date().default(() => new Date("2025-02-16T19:05:32.895Z"))
|
|
128
128
|
.transform(v => v.toISOString()),
|
|
129
129
|
}).transform((v) => {
|
|
130
130
|
return (0, primitives_js_1.remap)(v, {
|
|
@@ -133,7 +133,7 @@ exports.FileListData$inboundSchema = z.object({
|
|
|
133
133
|
bytes: z.number(),
|
|
134
134
|
file_name: z.string(),
|
|
135
135
|
workspace_id: z.string(),
|
|
136
|
-
created: z.string().datetime({ offset: true }).default("2025-02-
|
|
136
|
+
created: z.string().datetime({ offset: true }).default("2025-02-16T19:05:32.895Z").transform(v => new Date(v)),
|
|
137
137
|
}).transform((v) => {
|
|
138
138
|
return (0, primitives_js_1.remap)(v, {
|
|
139
139
|
"_id": "id",
|
|
@@ -150,7 +150,7 @@ exports.FileListData$outboundSchema = z.object({
|
|
|
150
150
|
bytes: z.number(),
|
|
151
151
|
fileName: z.string(),
|
|
152
152
|
workspaceId: z.string(),
|
|
153
|
-
created: z.date().default(() => new Date("2025-02-
|
|
153
|
+
created: z.date().default(() => new Date("2025-02-16T19:05:32.895Z"))
|
|
154
154
|
.transform(v => v.toISOString()),
|
|
155
155
|
}).transform((v) => {
|
|
156
156
|
return (0, primitives_js_1.remap)(v, {
|
|
@@ -165,7 +165,7 @@ exports.FileUploadResponseBody$inboundSchema = z.object({
|
|
|
165
165
|
bytes: z.number(),
|
|
166
166
|
file_name: z.string(),
|
|
167
167
|
workspace_id: z.string(),
|
|
168
|
-
created: z.string().datetime({ offset: true }).default("2025-02-
|
|
168
|
+
created: z.string().datetime({ offset: true }).default("2025-02-16T19:05:32.895Z").transform(v => new Date(v)),
|
|
169
169
|
}).transform((v) => {
|
|
170
170
|
return (0, primitives_js_1.remap)(v, {
|
|
171
171
|
"_id": "id",
|
|
@@ -182,7 +182,7 @@ exports.FileUploadResponseBody$outboundSchema = z.object({
|
|
|
182
182
|
bytes: z.number(),
|
|
183
183
|
fileName: z.string(),
|
|
184
184
|
workspaceId: z.string(),
|
|
185
|
-
created: z.date().default(() => new Date("2025-02-
|
|
185
|
+
created: z.date().default(() => new Date("2025-02-16T19:05:32.895Z"))
|
|
186
186
|
.transform(v => v.toISOString()),
|
|
187
187
|
}).transform((v) => {
|
|
188
188
|
return (0, primitives_js_1.remap)(v, {
|
package/package.json
CHANGED
|
@@ -27,7 +27,6 @@ For more information about the API: [orq.ai Documentation](https://docs.orq.ai)
|
|
|
27
27
|
* [Authentication](#authentication)
|
|
28
28
|
* [Available Resources and Operations](#available-resources-and-operations)
|
|
29
29
|
* [Standalone functions](#standalone-functions)
|
|
30
|
-
* [Server-sent event streaming](#server-sent-event-streaming)
|
|
31
30
|
* [File uploads](#file-uploads)
|
|
32
31
|
* [Retries](#retries)
|
|
33
32
|
* [Error Handling](#error-handling)
|
|
@@ -153,7 +152,6 @@ run();
|
|
|
153
152
|
* [list](docs/sdks/deployments/README.md#list) - List all deployments
|
|
154
153
|
* [getConfig](docs/sdks/deployments/README.md#getconfig) - Get config
|
|
155
154
|
* [invoke](docs/sdks/deployments/README.md#invoke) - Invoke
|
|
156
|
-
* [stream](docs/sdks/deployments/README.md#stream) - Stream
|
|
157
155
|
|
|
158
156
|
#### [deployments.metrics](docs/sdks/metrics/README.md)
|
|
159
157
|
|
|
@@ -165,9 +163,9 @@ run();
|
|
|
165
163
|
|
|
166
164
|
### [files](docs/sdks/files/README.md)
|
|
167
165
|
|
|
168
|
-
* [
|
|
166
|
+
* [create](docs/sdks/files/README.md#create) - Create file
|
|
169
167
|
* [list](docs/sdks/files/README.md#list) - List all files
|
|
170
|
-
* [get](docs/sdks/files/README.md#get) -
|
|
168
|
+
* [get](docs/sdks/files/README.md#get) - Retrieve a file
|
|
171
169
|
* [delete](docs/sdks/files/README.md#delete) - Delete file
|
|
172
170
|
|
|
173
171
|
|
|
@@ -181,18 +179,9 @@ run();
|
|
|
181
179
|
* [listVersions](docs/sdks/prompts/README.md#listversions) - List all prompt versions
|
|
182
180
|
* [getVersion](docs/sdks/prompts/README.md#getversion) - Retrieve a prompt version
|
|
183
181
|
|
|
184
|
-
### [
|
|
182
|
+
### [remoteconfigs](docs/sdks/remoteconfigs/README.md)
|
|
185
183
|
|
|
186
|
-
* [
|
|
187
|
-
* [create](docs/sdks/promptsnippets/README.md#create) - Create a prompt snippet
|
|
188
|
-
* [update](docs/sdks/promptsnippets/README.md#update) - Update a prompt snippet
|
|
189
|
-
* [delete](docs/sdks/promptsnippets/README.md#delete) - Delete a prompt snippet
|
|
190
|
-
* [get](docs/sdks/promptsnippets/README.md#get) - Retrieve a prompt snippet
|
|
191
|
-
* [getByKey](docs/sdks/promptsnippets/README.md#getbykey) - Retrieve a prompt snippet by key
|
|
192
|
-
|
|
193
|
-
### [remoteconfig](docs/sdks/remoteconfig/README.md)
|
|
194
|
-
|
|
195
|
-
* [getConfig](docs/sdks/remoteconfig/README.md#getconfig) - Get Configurations
|
|
184
|
+
* [retrieve](docs/sdks/remoteconfigs/README.md#retrieve) - Retrieve a remote config
|
|
196
185
|
|
|
197
186
|
</details>
|
|
198
187
|
<!-- End Available Resources and Operations [operations] -->
|
|
@@ -217,65 +206,23 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
|
|
217
206
|
- [`deploymentsInvoke`](docs/sdks/deployments/README.md#invoke) - Invoke
|
|
218
207
|
- [`deploymentsList`](docs/sdks/deployments/README.md#list) - List all deployments
|
|
219
208
|
- [`deploymentsMetricsCreate`](docs/sdks/metrics/README.md#create) - Add metrics
|
|
220
|
-
- [`deploymentsStream`](docs/sdks/deployments/README.md#stream) - Stream
|
|
221
209
|
- [`feedbackCreate`](docs/sdks/feedback/README.md#create) - Submit feedback
|
|
210
|
+
- [`filesCreate`](docs/sdks/files/README.md#create) - Create file
|
|
222
211
|
- [`filesDelete`](docs/sdks/files/README.md#delete) - Delete file
|
|
223
|
-
- [`filesGet`](docs/sdks/files/README.md#get) -
|
|
212
|
+
- [`filesGet`](docs/sdks/files/README.md#get) - Retrieve a file
|
|
224
213
|
- [`filesList`](docs/sdks/files/README.md#list) - List all files
|
|
225
|
-
- [`filesUpload`](docs/sdks/files/README.md#upload) - Upload file
|
|
226
214
|
- [`promptsCreate`](docs/sdks/prompts/README.md#create) - Create a prompt
|
|
227
215
|
- [`promptsDelete`](docs/sdks/prompts/README.md#delete) - Delete a prompt
|
|
228
216
|
- [`promptsGetVersion`](docs/sdks/prompts/README.md#getversion) - Retrieve a prompt version
|
|
229
217
|
- [`promptsList`](docs/sdks/prompts/README.md#list) - List all prompts
|
|
230
218
|
- [`promptsListVersions`](docs/sdks/prompts/README.md#listversions) - List all prompt versions
|
|
231
|
-
- [`promptSnippetsCreate`](docs/sdks/promptsnippets/README.md#create) - Create a prompt snippet
|
|
232
|
-
- [`promptSnippetsDelete`](docs/sdks/promptsnippets/README.md#delete) - Delete a prompt snippet
|
|
233
|
-
- [`promptSnippetsGet`](docs/sdks/promptsnippets/README.md#get) - Retrieve a prompt snippet
|
|
234
|
-
- [`promptSnippetsGetByKey`](docs/sdks/promptsnippets/README.md#getbykey) - Retrieve a prompt snippet by key
|
|
235
|
-
- [`promptSnippetsList`](docs/sdks/promptsnippets/README.md#list) - List all prompts snippets
|
|
236
|
-
- [`promptSnippetsUpdate`](docs/sdks/promptsnippets/README.md#update) - Update a prompt snippet
|
|
237
219
|
- [`promptsRetrieve`](docs/sdks/prompts/README.md#retrieve) - Retrieve a prompt
|
|
238
220
|
- [`promptsUpdate`](docs/sdks/prompts/README.md#update) - Update a prompt
|
|
239
|
-
- [`
|
|
221
|
+
- [`remoteconfigsRetrieve`](docs/sdks/remoteconfigs/README.md#retrieve) - Retrieve a remote config
|
|
240
222
|
|
|
241
223
|
</details>
|
|
242
224
|
<!-- End Standalone functions [standalone-funcs] -->
|
|
243
225
|
|
|
244
|
-
<!-- Start Server-sent event streaming [eventstream] -->
|
|
245
|
-
## Server-sent event streaming
|
|
246
|
-
|
|
247
|
-
[Server-sent events][mdn-sse] are used to stream content from certain
|
|
248
|
-
operations. These operations will expose the stream as an async iterable that
|
|
249
|
-
can be consumed using a [`for await...of`][mdn-for-await-of] loop. The loop will
|
|
250
|
-
terminate when the server no longer has any events to send and closes the
|
|
251
|
-
underlying connection.
|
|
252
|
-
|
|
253
|
-
```typescript
|
|
254
|
-
import { Orq } from "@orq-ai/node";
|
|
255
|
-
|
|
256
|
-
const orq = new Orq({
|
|
257
|
-
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
258
|
-
});
|
|
259
|
-
|
|
260
|
-
async function run() {
|
|
261
|
-
const result = await orq.deployments.stream({
|
|
262
|
-
key: "<key>",
|
|
263
|
-
});
|
|
264
|
-
|
|
265
|
-
for await (const event of result) {
|
|
266
|
-
// Handle the event
|
|
267
|
-
console.log(event);
|
|
268
|
-
}
|
|
269
|
-
}
|
|
270
|
-
|
|
271
|
-
run();
|
|
272
|
-
|
|
273
|
-
```
|
|
274
|
-
|
|
275
|
-
[mdn-sse]: https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events
|
|
276
|
-
[mdn-for-await-of]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of
|
|
277
|
-
<!-- End Server-sent event streaming [eventstream] -->
|
|
278
|
-
|
|
279
226
|
<!-- Start File uploads [file-upload] -->
|
|
280
227
|
## File uploads
|
|
281
228
|
|
|
@@ -298,7 +245,7 @@ const orq = new Orq({
|
|
|
298
245
|
});
|
|
299
246
|
|
|
300
247
|
async function run() {
|
|
301
|
-
const result = await orq.files.
|
|
248
|
+
const result = await orq.files.create();
|
|
302
249
|
|
|
303
250
|
// Handle the result
|
|
304
251
|
console.log(result);
|
|
@@ -8,7 +8,6 @@
|
|
|
8
8
|
* [list](#list) - List all deployments
|
|
9
9
|
* [getConfig](#getconfig) - Get config
|
|
10
10
|
* [invoke](#invoke) - Invoke
|
|
11
|
-
* [stream](#stream) - Stream
|
|
12
11
|
|
|
13
12
|
## list
|
|
14
13
|
|
|
@@ -231,86 +230,6 @@ run();
|
|
|
231
230
|
|
|
232
231
|
### Errors
|
|
233
232
|
|
|
234
|
-
| Error Type | Status Code | Content Type |
|
|
235
|
-
| --------------- | --------------- | --------------- |
|
|
236
|
-
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
237
|
-
|
|
238
|
-
## stream
|
|
239
|
-
|
|
240
|
-
Stream deployment generation. Only supported for completions and chat completions.
|
|
241
|
-
|
|
242
|
-
### Example Usage
|
|
243
|
-
|
|
244
|
-
```typescript
|
|
245
|
-
import { Orq } from "@orq-ai/node";
|
|
246
|
-
|
|
247
|
-
const orq = new Orq({
|
|
248
|
-
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
249
|
-
});
|
|
250
|
-
|
|
251
|
-
async function run() {
|
|
252
|
-
const result = await orq.deployments.stream({
|
|
253
|
-
key: "<key>",
|
|
254
|
-
});
|
|
255
|
-
|
|
256
|
-
for await (const event of result) {
|
|
257
|
-
// Handle the event
|
|
258
|
-
console.log(event);
|
|
259
|
-
}
|
|
260
|
-
}
|
|
261
|
-
|
|
262
|
-
run();
|
|
263
|
-
```
|
|
264
|
-
|
|
265
|
-
### Standalone function
|
|
266
|
-
|
|
267
|
-
The standalone function version of this method:
|
|
268
|
-
|
|
269
|
-
```typescript
|
|
270
|
-
import { OrqCore } from "@orq-ai/node/core.js";
|
|
271
|
-
import { deploymentsStream } from "@orq-ai/node/funcs/deploymentsStream.js";
|
|
272
|
-
|
|
273
|
-
// Use `OrqCore` for best tree-shaking performance.
|
|
274
|
-
// You can create one instance of it to use across an application.
|
|
275
|
-
const orq = new OrqCore({
|
|
276
|
-
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
277
|
-
});
|
|
278
|
-
|
|
279
|
-
async function run() {
|
|
280
|
-
const res = await deploymentsStream(orq, {
|
|
281
|
-
key: "<key>",
|
|
282
|
-
});
|
|
283
|
-
|
|
284
|
-
if (!res.ok) {
|
|
285
|
-
throw res.error;
|
|
286
|
-
}
|
|
287
|
-
|
|
288
|
-
const { value: result } = res;
|
|
289
|
-
|
|
290
|
-
for await (const event of result) {
|
|
291
|
-
// Handle the event
|
|
292
|
-
console.log(event);
|
|
293
|
-
}
|
|
294
|
-
}
|
|
295
|
-
|
|
296
|
-
run();
|
|
297
|
-
```
|
|
298
|
-
|
|
299
|
-
### Parameters
|
|
300
|
-
|
|
301
|
-
| Parameter | Type | Required | Description |
|
|
302
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
303
|
-
| `request` | [operations.DeploymentStreamRequestBody](../../models/operations/deploymentstreamrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
304
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
305
|
-
| `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. |
|
|
306
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
307
|
-
|
|
308
|
-
### Response
|
|
309
|
-
|
|
310
|
-
**Promise\<[EventStream<operations.DeploymentStreamResponseBody>](../../models/.md)\>**
|
|
311
|
-
|
|
312
|
-
### Errors
|
|
313
|
-
|
|
314
233
|
| Error Type | Status Code | Content Type |
|
|
315
234
|
| --------------- | --------------- | --------------- |
|
|
316
235
|
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
@@ -5,12 +5,12 @@
|
|
|
5
5
|
|
|
6
6
|
### Available Operations
|
|
7
7
|
|
|
8
|
-
* [
|
|
8
|
+
* [create](#create) - Create file
|
|
9
9
|
* [list](#list) - List all files
|
|
10
|
-
* [get](#get) -
|
|
10
|
+
* [get](#get) - Retrieve a file
|
|
11
11
|
* [delete](#delete) - Delete file
|
|
12
12
|
|
|
13
|
-
##
|
|
13
|
+
## create
|
|
14
14
|
|
|
15
15
|
Files are used to upload documents that can be used with features like [Deployments](https://docs.orq.ai/reference/post_v2-deployments-get-config).
|
|
16
16
|
|
|
@@ -24,7 +24,7 @@ const orq = new Orq({
|
|
|
24
24
|
});
|
|
25
25
|
|
|
26
26
|
async function run() {
|
|
27
|
-
const result = await orq.files.
|
|
27
|
+
const result = await orq.files.create();
|
|
28
28
|
|
|
29
29
|
// Handle the result
|
|
30
30
|
console.log(result);
|
|
@@ -39,7 +39,7 @@ The standalone function version of this method:
|
|
|
39
39
|
|
|
40
40
|
```typescript
|
|
41
41
|
import { OrqCore } from "@orq-ai/node/core.js";
|
|
42
|
-
import {
|
|
42
|
+
import { filesCreate } from "@orq-ai/node/funcs/filesCreate.js";
|
|
43
43
|
|
|
44
44
|
// Use `OrqCore` for best tree-shaking performance.
|
|
45
45
|
// You can create one instance of it to use across an application.
|
|
@@ -48,7 +48,7 @@ const orq = new OrqCore({
|
|
|
48
48
|
});
|
|
49
49
|
|
|
50
50
|
async function run() {
|
|
51
|
-
const res = await
|
|
51
|
+
const res = await filesCreate(orq);
|
|
52
52
|
|
|
53
53
|
if (!res.ok) {
|
|
54
54
|
throw res.error;
|
|
@@ -84,7 +84,7 @@ run();
|
|
|
84
84
|
|
|
85
85
|
## list
|
|
86
86
|
|
|
87
|
-
|
|
87
|
+
Returns a list of the files that your account has access to. orq.ai sorts and returns the files by their creation dates, placing the most recently created files at the top.
|
|
88
88
|
|
|
89
89
|
### Example Usage
|
|
90
90
|
|
|
@@ -156,7 +156,7 @@ run();
|
|
|
156
156
|
|
|
157
157
|
## get
|
|
158
158
|
|
|
159
|
-
|
|
159
|
+
Retrieves the details of an existing file object. After you supply a unique file ID, orq.ai returns the corresponding file object
|
|
160
160
|
|
|
161
161
|
### Example Usage
|
|
162
162
|
|
|
@@ -1,15 +1,15 @@
|
|
|
1
|
-
#
|
|
2
|
-
(*
|
|
1
|
+
# Remoteconfigs
|
|
2
|
+
(*remoteconfigs*)
|
|
3
3
|
|
|
4
4
|
## Overview
|
|
5
5
|
|
|
6
6
|
### Available Operations
|
|
7
7
|
|
|
8
|
-
* [
|
|
8
|
+
* [retrieve](#retrieve) - Retrieve a remote config
|
|
9
9
|
|
|
10
|
-
##
|
|
10
|
+
## retrieve
|
|
11
11
|
|
|
12
|
-
|
|
12
|
+
Retrieve a remote config
|
|
13
13
|
|
|
14
14
|
### Example Usage
|
|
15
15
|
|
|
@@ -21,7 +21,7 @@ const orq = new Orq({
|
|
|
21
21
|
});
|
|
22
22
|
|
|
23
23
|
async function run() {
|
|
24
|
-
const result = await orq.
|
|
24
|
+
const result = await orq.remoteconfigs.retrieve();
|
|
25
25
|
|
|
26
26
|
// Handle the result
|
|
27
27
|
console.log(result);
|
|
@@ -36,7 +36,7 @@ The standalone function version of this method:
|
|
|
36
36
|
|
|
37
37
|
```typescript
|
|
38
38
|
import { OrqCore } from "@orq-ai/node/core.js";
|
|
39
|
-
import {
|
|
39
|
+
import { remoteconfigsRetrieve } from "@orq-ai/node/funcs/remoteconfigsRetrieve.js";
|
|
40
40
|
|
|
41
41
|
// Use `OrqCore` for best tree-shaking performance.
|
|
42
42
|
// You can create one instance of it to use across an application.
|
|
@@ -45,7 +45,7 @@ const orq = new OrqCore({
|
|
|
45
45
|
});
|
|
46
46
|
|
|
47
47
|
async function run() {
|
|
48
|
-
const res = await
|
|
48
|
+
const res = await remoteconfigsRetrieve(orq);
|
|
49
49
|
|
|
50
50
|
if (!res.ok) {
|
|
51
51
|
throw res.error;
|
package/packages/orq-rc/jsr.json
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
{
|
|
4
4
|
"name": "@orq-ai/node",
|
|
5
|
-
"version": "3.
|
|
5
|
+
"version": "3.2.0-rc.4",
|
|
6
6
|
"exports": {
|
|
7
7
|
".": "./src/index.ts",
|
|
8
8
|
"./models/errors": "./src/models/errors/index.ts",
|
|
@@ -12,7 +12,6 @@
|
|
|
12
12
|
"./lib/http": "./src/lib/http.ts",
|
|
13
13
|
"./lib/retries": "./src/lib/retries.ts",
|
|
14
14
|
"./lib/sdks": "./src/lib/sdks.ts",
|
|
15
|
-
"./lib/event-streams": "./src/lib/event-streams.ts",
|
|
16
15
|
"./types": "./src/types/index.ts"
|
|
17
16
|
},
|
|
18
17
|
"publish": {
|
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@orq-ai/node",
|
|
3
|
-
"version": "3.
|
|
3
|
+
"version": "3.2.0-rc.4",
|
|
4
4
|
"lockfileVersion": 3,
|
|
5
5
|
"requires": true,
|
|
6
6
|
"packages": {
|
|
7
7
|
"": {
|
|
8
8
|
"name": "@orq-ai/node",
|
|
9
|
-
"version": "3.
|
|
9
|
+
"version": "3.2.0-rc.4",
|
|
10
10
|
"devDependencies": {
|
|
11
11
|
"@eslint/js": "^9.19.0",
|
|
12
12
|
"eslint": "^9.19.0",
|
|
@@ -26,12 +26,12 @@ import { Result } from "../types/fp.js";
|
|
|
26
26
|
import { isReadableStream } from "../types/streams.js";
|
|
27
27
|
|
|
28
28
|
/**
|
|
29
|
-
*
|
|
29
|
+
* Create file
|
|
30
30
|
*
|
|
31
31
|
* @remarks
|
|
32
32
|
* Files are used to upload documents that can be used with features like [Deployments](https://docs.orq.ai/reference/post_v2-deployments-get-config).
|
|
33
33
|
*/
|
|
34
|
-
export async function
|
|
34
|
+
export async function filesCreate(
|
|
35
35
|
client: OrqCore,
|
|
36
36
|
request?: operations.FileUploadRequestBody | undefined,
|
|
37
37
|
options?: RequestOptions,
|
|
@@ -90,6 +90,7 @@ export async function filesUpload(
|
|
|
90
90
|
const requestSecurity = resolveGlobalSecurity(securityInput);
|
|
91
91
|
|
|
92
92
|
const context = {
|
|
93
|
+
baseURL: options?.serverURL ?? "",
|
|
93
94
|
operationID: "FileUpload",
|
|
94
95
|
oAuth2Scopes: [],
|
|
95
96
|
|
|
@@ -23,7 +23,10 @@ import * as operations from "../models/operations/index.js";
|
|
|
23
23
|
import { Result } from "../types/fp.js";
|
|
24
24
|
|
|
25
25
|
/**
|
|
26
|
-
*
|
|
26
|
+
* Retrieve a file
|
|
27
|
+
*
|
|
28
|
+
* @remarks
|
|
29
|
+
* Retrieves the details of an existing file object. After you supply a unique file ID, orq.ai returns the corresponding file object
|
|
27
30
|
*/
|
|
28
31
|
export async function filesGet(
|
|
29
32
|
client: OrqCore,
|
|
@@ -70,6 +73,7 @@ export async function filesGet(
|
|
|
70
73
|
const requestSecurity = resolveGlobalSecurity(securityInput);
|
|
71
74
|
|
|
72
75
|
const context = {
|
|
76
|
+
baseURL: options?.serverURL ?? "",
|
|
73
77
|
operationID: "FileGet",
|
|
74
78
|
oAuth2Scopes: [],
|
|
75
79
|
|
|
@@ -24,6 +24,9 @@ import { Result } from "../types/fp.js";
|
|
|
24
24
|
|
|
25
25
|
/**
|
|
26
26
|
* List all files
|
|
27
|
+
*
|
|
28
|
+
* @remarks
|
|
29
|
+
* Returns a list of the files that your account has access to. orq.ai sorts and returns the files by their creation dates, placing the most recently created files at the top.
|
|
27
30
|
*/
|
|
28
31
|
export async function filesList(
|
|
29
32
|
client: OrqCore,
|
|
@@ -56,10 +59,9 @@ export async function filesList(
|
|
|
56
59
|
const path = pathToFunc("/v2/files")();
|
|
57
60
|
|
|
58
61
|
const query = encodeFormQuery({
|
|
59
|
-
"
|
|
60
|
-
"lastId": payload?.lastId,
|
|
62
|
+
"ending_before": payload?.ending_before,
|
|
61
63
|
"limit": payload?.limit,
|
|
62
|
-
"
|
|
64
|
+
"starting_after": payload?.starting_after,
|
|
63
65
|
});
|
|
64
66
|
|
|
65
67
|
const headers = new Headers(compactMap({
|
|
@@ -71,6 +73,7 @@ export async function filesList(
|
|
|
71
73
|
const requestSecurity = resolveGlobalSecurity(securityInput);
|
|
72
74
|
|
|
73
75
|
const context = {
|
|
76
|
+
baseURL: options?.serverURL ?? "",
|
|
74
77
|
operationID: "FileList",
|
|
75
78
|
oAuth2Scopes: [],
|
|
76
79
|
|