@orq-ai/node 3.2.6 → 3.2.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.
Files changed (71) hide show
  1. package/bin/mcp-server.js +32 -32
  2. package/bin/mcp-server.js.map +17 -17
  3. package/jsr.json +1 -1
  4. package/lib/config.d.ts +3 -3
  5. package/lib/config.js +3 -3
  6. package/mcp-server/mcp-server.js +1 -1
  7. package/mcp-server/server.js +1 -1
  8. package/models/operations/bulkcreatedatapoints.js +2 -2
  9. package/models/operations/createcontact.js +2 -2
  10. package/models/operations/createdataset.js +2 -2
  11. package/models/operations/createdatasetitem.js +2 -2
  12. package/models/operations/fileget.js +2 -2
  13. package/models/operations/filelist.js +2 -2
  14. package/models/operations/fileupload.js +2 -2
  15. package/models/operations/listdatasetdatapoints.js +2 -2
  16. package/models/operations/listdatasets.js +2 -2
  17. package/models/operations/retrievedatapoint.js +2 -2
  18. package/models/operations/retrievedataset.js +2 -2
  19. package/models/operations/updatedatapoint.js +2 -2
  20. package/models/operations/updatedataset.js +2 -2
  21. package/package.json +1 -1
  22. package/packages/orq-rc/README.md +39 -1
  23. package/packages/orq-rc/docs/sdks/deployments/README.md +81 -0
  24. package/packages/orq-rc/docs/sdks/prompts/README.md +110 -110
  25. package/packages/orq-rc/jsr.json +2 -1
  26. package/packages/orq-rc/package-lock.json +2 -2
  27. package/packages/orq-rc/package.json +1 -1
  28. package/packages/orq-rc/src/funcs/deploymentsStream.ts +178 -0
  29. package/packages/orq-rc/src/funcs/promptsList.ts +1 -1
  30. package/packages/orq-rc/src/lib/config.ts +3 -3
  31. package/packages/orq-rc/src/lib/event-streams.ts +264 -0
  32. package/packages/orq-rc/src/lib/matchers.ts +4 -1
  33. package/packages/orq-rc/src/lib/security.ts +11 -3
  34. package/packages/orq-rc/src/mcp-server/mcp-server.ts +1 -1
  35. package/packages/orq-rc/src/mcp-server/server.ts +4 -2
  36. package/packages/orq-rc/src/mcp-server/tools/deploymentsStream.ts +37 -0
  37. package/packages/orq-rc/src/models/operations/bulkcreatedatapoints.ts +2 -2
  38. package/packages/orq-rc/src/models/operations/createcontact.ts +2 -2
  39. package/packages/orq-rc/src/models/operations/createdataset.ts +2 -2
  40. package/packages/orq-rc/src/models/operations/createdatasetitem.ts +2 -2
  41. package/packages/orq-rc/src/models/operations/createprompt.ts +599 -680
  42. package/packages/orq-rc/src/models/operations/deploymentstream.ts +5960 -0
  43. package/packages/orq-rc/src/models/operations/fileget.ts +2 -2
  44. package/packages/orq-rc/src/models/operations/filelist.ts +2 -2
  45. package/packages/orq-rc/src/models/operations/fileupload.ts +2 -2
  46. package/packages/orq-rc/src/models/operations/index.ts +1 -0
  47. package/packages/orq-rc/src/models/operations/listdatasetdatapoints.ts +2 -2
  48. package/packages/orq-rc/src/models/operations/listdatasets.ts +2 -2
  49. package/packages/orq-rc/src/models/operations/retrievedatapoint.ts +2 -2
  50. package/packages/orq-rc/src/models/operations/retrievedataset.ts +2 -2
  51. package/packages/orq-rc/src/models/operations/updatedatapoint.ts +2 -2
  52. package/packages/orq-rc/src/models/operations/updatedataset.ts +2 -2
  53. package/packages/orq-rc/src/models/operations/updateprompt.ts +682 -599
  54. package/packages/orq-rc/src/sdk/deployments.ts +19 -0
  55. package/packages/orq-rc/src/sdk/prompts.ts +14 -14
  56. package/src/lib/config.ts +3 -3
  57. package/src/mcp-server/mcp-server.ts +1 -1
  58. package/src/mcp-server/server.ts +1 -1
  59. package/src/models/operations/bulkcreatedatapoints.ts +2 -2
  60. package/src/models/operations/createcontact.ts +2 -2
  61. package/src/models/operations/createdataset.ts +2 -2
  62. package/src/models/operations/createdatasetitem.ts +2 -2
  63. package/src/models/operations/fileget.ts +2 -2
  64. package/src/models/operations/filelist.ts +2 -2
  65. package/src/models/operations/fileupload.ts +2 -2
  66. package/src/models/operations/listdatasetdatapoints.ts +2 -2
  67. package/src/models/operations/listdatasets.ts +2 -2
  68. package/src/models/operations/retrievedatapoint.ts +2 -2
  69. package/src/models/operations/retrievedataset.ts +2 -2
  70. package/src/models/operations/updatedatapoint.ts +2 -2
  71. package/src/models/operations/updatedataset.ts +2 -2
package/jsr.json CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  {
4
4
  "name": "@orq-ai/node",
5
- "version": "3.2.6",
5
+ "version": "3.2.8",
6
6
  "exports": {
7
7
  ".": "./src/index.ts",
8
8
  "./models/errors": "./src/models/errors/index.ts",
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.2.6";
39
- readonly genVersion: "2.558.2";
40
- readonly userAgent: "speakeasy-sdk/typescript 3.2.6 2.558.2 2.0 @orq-ai/node";
38
+ readonly sdkVersion: "3.2.8";
39
+ readonly genVersion: "2.558.5";
40
+ readonly userAgent: "speakeasy-sdk/typescript 3.2.8 2.558.5 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.2.6",
32
- genVersion: "2.558.2",
33
- userAgent: "speakeasy-sdk/typescript 3.2.6 2.558.2 2.0 @orq-ai/node",
31
+ sdkVersion: "3.2.8",
32
+ genVersion: "2.558.5",
33
+ userAgent: "speakeasy-sdk/typescript 3.2.8 2.558.5 2.0 @orq-ai/node",
34
34
  };
35
35
  //# sourceMappingURL=config.js.map
@@ -22,7 +22,7 @@ const routes = (0, core_1.buildRouteMap)({
22
22
  exports.app = (0, core_1.buildApplication)(routes, {
23
23
  name: "mcp",
24
24
  versionInfo: {
25
- currentVersion: "3.2.6",
25
+ currentVersion: "3.2.8",
26
26
  },
27
27
  });
28
28
  (0, core_1.run)(exports.app, node_process_1.default.argv.slice(2), (0, cli_js_1.buildContext)(node_process_1.default));
@@ -44,7 +44,7 @@ const remoteconfigsRetrieve_js_1 = require("./tools/remoteconfigsRetrieve.js");
44
44
  function createMCPServer(deps) {
45
45
  const server = new mcp_js_1.McpServer({
46
46
  name: "Orq",
47
- version: "3.2.6",
47
+ version: "3.2.8",
48
48
  });
49
49
  const client = new core_js_1.OrqCore({
50
50
  apiKey: deps.apiKey,
@@ -879,7 +879,7 @@ exports.ResponseBody$inboundSchema = z.object({
879
879
  updated_by_id: z.string().optional(),
880
880
  created: z.string().datetime({ offset: true }).transform(v => new Date(v))
881
881
  .optional(),
882
- updated: z.string().datetime({ offset: true }).default("2025-03-20T14:51:11.226Z").transform(v => new Date(v)),
882
+ updated: z.string().datetime({ offset: true }).default("2025-03-21T14:27:17.865Z").transform(v => new Date(v)),
883
883
  }).transform((v) => {
884
884
  return (0, primitives_js_1.remap)(v, {
885
885
  "_id": "id",
@@ -901,7 +901,7 @@ exports.ResponseBody$outboundSchema = z.object({
901
901
  createdById: z.string().optional(),
902
902
  updatedById: z.string().optional(),
903
903
  created: z.date().transform(v => v.toISOString()).optional(),
904
- updated: z.date().default(() => new Date("2025-03-20T14:51:11.226Z"))
904
+ updated: z.date().default(() => new Date("2025-03-21T14:27:17.865Z"))
905
905
  .transform(v => v.toISOString()),
906
906
  }).transform((v) => {
907
907
  return (0, primitives_js_1.remap)(v, {
@@ -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-03-20T14:51:11.226Z").transform(v => new Date(v)),
105
+ updated: z.string().datetime({ offset: true }).default("2025-03-21T14:27:17.865Z").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-03-20T14:51:11.226Z"))
123
+ updated: z.date().default(() => new Date("2025-03-21T14:27:17.865Z"))
124
124
  .transform(v => v.toISOString()),
125
125
  }).transform((v) => {
126
126
  return (0, primitives_js_1.remap)(v, {
@@ -129,7 +129,7 @@ exports.CreateDatasetResponseBody$inboundSchema = z.object({
129
129
  metadata: z.lazy(() => exports.CreateDatasetMetadata$inboundSchema),
130
130
  created: z.string().datetime({ offset: true }).transform(v => new Date(v))
131
131
  .optional(),
132
- updated: z.string().datetime({ offset: true }).default("2025-03-20T14:51:11.226Z").transform(v => new Date(v)),
132
+ updated: z.string().datetime({ offset: true }).default("2025-03-21T14:27:17.865Z").transform(v => new Date(v)),
133
133
  }).transform((v) => {
134
134
  return (0, primitives_js_1.remap)(v, {
135
135
  "_id": "id",
@@ -150,7 +150,7 @@ exports.CreateDatasetResponseBody$outboundSchema = z.object({
150
150
  updatedById: z.string().optional(),
151
151
  metadata: z.lazy(() => exports.CreateDatasetMetadata$outboundSchema),
152
152
  created: z.date().transform(v => v.toISOString()).optional(),
153
- updated: z.date().default(() => new Date("2025-03-20T14:51:11.226Z"))
153
+ updated: z.date().default(() => new Date("2025-03-21T14:27:17.865Z"))
154
154
  .transform(v => v.toISOString()),
155
155
  }).transform((v) => {
156
156
  return (0, primitives_js_1.remap)(v, {
@@ -850,7 +850,7 @@ exports.CreateDatasetItemResponseBody$inboundSchema = z.object({
850
850
  updated_by_id: z.string().optional(),
851
851
  created: z.string().datetime({ offset: true }).transform(v => new Date(v))
852
852
  .optional(),
853
- updated: z.string().datetime({ offset: true }).default("2025-03-20T14:51:11.226Z").transform(v => new Date(v)),
853
+ updated: z.string().datetime({ offset: true }).default("2025-03-21T14:27:17.865Z").transform(v => new Date(v)),
854
854
  }).transform((v) => {
855
855
  return (0, primitives_js_1.remap)(v, {
856
856
  "_id": "id",
@@ -872,7 +872,7 @@ exports.CreateDatasetItemResponseBody$outboundSchema = z.object({
872
872
  createdById: z.string().optional(),
873
873
  updatedById: z.string().optional(),
874
874
  created: z.date().transform(v => v.toISOString()).optional(),
875
- updated: z.date().default(() => new Date("2025-03-20T14:51:11.226Z"))
875
+ updated: z.date().default(() => new Date("2025-03-21T14:27:17.865Z"))
876
876
  .transform(v => v.toISOString()),
877
877
  }).transform((v) => {
878
878
  return (0, primitives_js_1.remap)(v, {
@@ -108,7 +108,7 @@ exports.FileGetResponseBody$inboundSchema = z.object({
108
108
  bytes: z.number(),
109
109
  file_name: z.string(),
110
110
  workspace_id: z.string(),
111
- created: z.string().datetime({ offset: true }).default("2025-03-20T14:51:12.367Z").transform(v => new Date(v)),
111
+ created: z.string().datetime({ offset: true }).default("2025-03-21T14:27:19.052Z").transform(v => new Date(v)),
112
112
  }).transform((v) => {
113
113
  return (0, primitives_js_1.remap)(v, {
114
114
  "_id": "id",
@@ -125,7 +125,7 @@ exports.FileGetResponseBody$outboundSchema = z.object({
125
125
  bytes: z.number(),
126
126
  fileName: z.string(),
127
127
  workspaceId: z.string(),
128
- created: z.date().default(() => new Date("2025-03-20T14:51:12.367Z"))
128
+ created: z.date().default(() => new Date("2025-03-21T14:27:19.052Z"))
129
129
  .transform(v => v.toISOString()),
130
130
  }).transform((v) => {
131
131
  return (0, primitives_js_1.remap)(v, {
@@ -158,7 +158,7 @@ exports.FileListData$inboundSchema = z.object({
158
158
  bytes: z.number(),
159
159
  file_name: z.string(),
160
160
  workspace_id: z.string(),
161
- created: z.string().datetime({ offset: true }).default("2025-03-20T14:51:12.367Z").transform(v => new Date(v)),
161
+ created: z.string().datetime({ offset: true }).default("2025-03-21T14:27:19.052Z").transform(v => new Date(v)),
162
162
  }).transform((v) => {
163
163
  return (0, primitives_js_1.remap)(v, {
164
164
  "_id": "id",
@@ -175,7 +175,7 @@ exports.FileListData$outboundSchema = z.object({
175
175
  bytes: z.number(),
176
176
  fileName: z.string(),
177
177
  workspaceId: z.string(),
178
- created: z.date().default(() => new Date("2025-03-20T14:51:12.367Z"))
178
+ created: z.date().default(() => new Date("2025-03-21T14:27:19.052Z"))
179
179
  .transform(v => v.toISOString()),
180
180
  }).transform((v) => {
181
181
  return (0, primitives_js_1.remap)(v, {
@@ -167,7 +167,7 @@ exports.FileUploadResponseBody$inboundSchema = z.object({
167
167
  bytes: z.number(),
168
168
  file_name: z.string(),
169
169
  workspace_id: z.string(),
170
- created: z.string().datetime({ offset: true }).default("2025-03-20T14:51:12.367Z").transform(v => new Date(v)),
170
+ created: z.string().datetime({ offset: true }).default("2025-03-21T14:27:19.052Z").transform(v => new Date(v)),
171
171
  }).transform((v) => {
172
172
  return (0, primitives_js_1.remap)(v, {
173
173
  "_id": "id",
@@ -184,7 +184,7 @@ exports.FileUploadResponseBody$outboundSchema = z.object({
184
184
  bytes: z.number(),
185
185
  fileName: z.string(),
186
186
  workspaceId: z.string(),
187
- created: z.date().default(() => new Date("2025-03-20T14:51:12.367Z"))
187
+ created: z.date().default(() => new Date("2025-03-21T14:27:19.052Z"))
188
188
  .transform(v => v.toISOString()),
189
189
  }).transform((v) => {
190
190
  return (0, primitives_js_1.remap)(v, {
@@ -501,7 +501,7 @@ exports.ListDatasetDatapointsData$inboundSchema = z.object({
501
501
  updated_by_id: z.string().optional(),
502
502
  created: z.string().datetime({ offset: true }).transform(v => new Date(v))
503
503
  .optional(),
504
- updated: z.string().datetime({ offset: true }).default("2025-03-20T14:51:11.226Z").transform(v => new Date(v)),
504
+ updated: z.string().datetime({ offset: true }).default("2025-03-21T14:27:17.865Z").transform(v => new Date(v)),
505
505
  }).transform((v) => {
506
506
  return (0, primitives_js_1.remap)(v, {
507
507
  "_id": "id",
@@ -524,7 +524,7 @@ exports.ListDatasetDatapointsData$outboundSchema = z.object({
524
524
  createdById: z.string().optional(),
525
525
  updatedById: z.string().optional(),
526
526
  created: z.date().transform(v => v.toISOString()).optional(),
527
- updated: z.date().default(() => new Date("2025-03-20T14:51:11.226Z"))
527
+ updated: z.date().default(() => new Date("2025-03-21T14:27:17.865Z"))
528
528
  .transform(v => v.toISOString()),
529
529
  }).transform((v) => {
530
530
  return (0, primitives_js_1.remap)(v, {
@@ -177,7 +177,7 @@ exports.ListDatasetsData$inboundSchema = z.object({
177
177
  metadata: z.lazy(() => exports.ListDatasetsMetadata$inboundSchema),
178
178
  created: z.string().datetime({ offset: true }).transform(v => new Date(v))
179
179
  .optional(),
180
- updated: z.string().datetime({ offset: true }).default("2025-03-20T14:51:11.226Z").transform(v => new Date(v)),
180
+ updated: z.string().datetime({ offset: true }).default("2025-03-21T14:27:17.865Z").transform(v => new Date(v)),
181
181
  }).transform((v) => {
182
182
  return (0, primitives_js_1.remap)(v, {
183
183
  "_id": "id",
@@ -198,7 +198,7 @@ exports.ListDatasetsData$outboundSchema = z.object({
198
198
  updatedById: z.string().optional(),
199
199
  metadata: z.lazy(() => exports.ListDatasetsMetadata$outboundSchema),
200
200
  created: z.date().transform(v => v.toISOString()).optional(),
201
- updated: z.date().default(() => new Date("2025-03-20T14:51:11.226Z"))
201
+ updated: z.date().default(() => new Date("2025-03-21T14:27:17.865Z"))
202
202
  .transform(v => v.toISOString()),
203
203
  }).transform((v) => {
204
204
  return (0, primitives_js_1.remap)(v, {
@@ -452,7 +452,7 @@ exports.RetrieveDatapointResponseBody$inboundSchema = z.object({
452
452
  updated_by_id: z.string().optional(),
453
453
  created: z.string().datetime({ offset: true }).transform(v => new Date(v))
454
454
  .optional(),
455
- updated: z.string().datetime({ offset: true }).default("2025-03-20T14:51:11.226Z").transform(v => new Date(v)),
455
+ updated: z.string().datetime({ offset: true }).default("2025-03-21T14:27:17.865Z").transform(v => new Date(v)),
456
456
  }).transform((v) => {
457
457
  return (0, primitives_js_1.remap)(v, {
458
458
  "_id": "id",
@@ -475,7 +475,7 @@ exports.RetrieveDatapointResponseBody$outboundSchema = z.object({
475
475
  createdById: z.string().optional(),
476
476
  updatedById: z.string().optional(),
477
477
  created: z.date().transform(v => v.toISOString()).optional(),
478
- updated: z.date().default(() => new Date("2025-03-20T14:51:11.226Z"))
478
+ updated: z.date().default(() => new Date("2025-03-21T14:27:17.865Z"))
479
479
  .transform(v => v.toISOString()),
480
480
  }).transform((v) => {
481
481
  return (0, primitives_js_1.remap)(v, {
@@ -127,7 +127,7 @@ exports.RetrieveDatasetResponseBody$inboundSchema = z.object({
127
127
  metadata: z.lazy(() => exports.RetrieveDatasetMetadata$inboundSchema),
128
128
  created: z.string().datetime({ offset: true }).transform(v => new Date(v))
129
129
  .optional(),
130
- updated: z.string().datetime({ offset: true }).default("2025-03-20T14:51:11.226Z").transform(v => new Date(v)),
130
+ updated: z.string().datetime({ offset: true }).default("2025-03-21T14:27:17.865Z").transform(v => new Date(v)),
131
131
  }).transform((v) => {
132
132
  return (0, primitives_js_1.remap)(v, {
133
133
  "_id": "id",
@@ -148,7 +148,7 @@ exports.RetrieveDatasetResponseBody$outboundSchema = z.object({
148
148
  updatedById: z.string().optional(),
149
149
  metadata: z.lazy(() => exports.RetrieveDatasetMetadata$outboundSchema),
150
150
  created: z.date().transform(v => v.toISOString()).optional(),
151
- updated: z.date().default(() => new Date("2025-03-20T14:51:11.226Z"))
151
+ updated: z.date().default(() => new Date("2025-03-21T14:27:17.865Z"))
152
152
  .transform(v => v.toISOString()),
153
153
  }).transform((v) => {
154
154
  return (0, primitives_js_1.remap)(v, {
@@ -855,7 +855,7 @@ exports.UpdateDatapointResponseBody$inboundSchema = z.object({
855
855
  updated_by_id: z.string().optional(),
856
856
  created: z.string().datetime({ offset: true }).transform(v => new Date(v))
857
857
  .optional(),
858
- updated: z.string().datetime({ offset: true }).default("2025-03-20T14:51:11.226Z").transform(v => new Date(v)),
858
+ updated: z.string().datetime({ offset: true }).default("2025-03-21T14:27:17.865Z").transform(v => new Date(v)),
859
859
  }).transform((v) => {
860
860
  return (0, primitives_js_1.remap)(v, {
861
861
  "_id": "id",
@@ -877,7 +877,7 @@ exports.UpdateDatapointResponseBody$outboundSchema = z.object({
877
877
  createdById: z.string().optional(),
878
878
  updatedById: z.string().optional(),
879
879
  created: z.date().transform(v => v.toISOString()).optional(),
880
- updated: z.date().default(() => new Date("2025-03-20T14:51:11.226Z"))
880
+ updated: z.date().default(() => new Date("2025-03-21T14:27:17.865Z"))
881
881
  .transform(v => v.toISOString()),
882
882
  }).transform((v) => {
883
883
  return (0, primitives_js_1.remap)(v, {
@@ -168,7 +168,7 @@ exports.UpdateDatasetResponseBody$inboundSchema = z.object({
168
168
  version: z.string().optional(),
169
169
  created: z.string().datetime({ offset: true }).transform(v => new Date(v))
170
170
  .optional(),
171
- updated: z.string().datetime({ offset: true }).default("2025-03-20T14:51:11.226Z").transform(v => new Date(v)),
171
+ updated: z.string().datetime({ offset: true }).default("2025-03-21T14:27:17.865Z").transform(v => new Date(v)),
172
172
  }).transform((v) => {
173
173
  return (0, primitives_js_1.remap)(v, {
174
174
  "_id": "id",
@@ -192,7 +192,7 @@ exports.UpdateDatasetResponseBody$outboundSchema = z.object({
192
192
  parentId: z.string().optional(),
193
193
  version: z.string().optional(),
194
194
  created: z.date().transform(v => v.toISOString()).optional(),
195
- updated: z.date().default(() => new Date("2025-03-20T14:51:11.226Z"))
195
+ updated: z.date().default(() => new Date("2025-03-21T14:27:17.865Z"))
196
196
  .transform(v => v.toISOString()),
197
197
  }).transform((v) => {
198
198
  return (0, primitives_js_1.remap)(v, {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@orq-ai/node",
3
- "version": "3.2.6",
3
+ "version": "3.2.8",
4
4
  "author": "Orq",
5
5
  "bin": {
6
6
  "mcp": "bin/mcp-server.js"
@@ -27,6 +27,7 @@ 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)
30
31
  * [File uploads](#file-uploads)
31
32
  * [Retries](#retries)
32
33
  * [Error Handling](#error-handling)
@@ -256,6 +257,7 @@ run();
256
257
  * [list](docs/sdks/deployments/README.md#list) - List all deployments
257
258
  * [getConfig](docs/sdks/deployments/README.md#getconfig) - Get config
258
259
  * [invoke](docs/sdks/deployments/README.md#invoke) - Invoke
260
+ * [stream](docs/sdks/deployments/README.md#stream) - Stream
259
261
 
260
262
  #### [deployments.metrics](docs/sdks/metrics/README.md)
261
263
 
@@ -276,10 +278,10 @@ run();
276
278
  ### [prompts](docs/sdks/prompts/README.md)
277
279
 
278
280
  * [list](docs/sdks/prompts/README.md#list) - List all prompts
281
+ * [create](docs/sdks/prompts/README.md#create) - Create a prompt
279
282
  * [retrieve](docs/sdks/prompts/README.md#retrieve) - Retrieve a prompt
280
283
  * [update](docs/sdks/prompts/README.md#update) - Update a prompt
281
284
  * [delete](docs/sdks/prompts/README.md#delete) - Delete a prompt
282
- * [create](docs/sdks/prompts/README.md#create) - Create a prompt
283
285
  * [listVersions](docs/sdks/prompts/README.md#listversions) - List all prompt versions
284
286
  * [getVersion](docs/sdks/prompts/README.md#getversion) - Retrieve a prompt version
285
287
 
@@ -322,6 +324,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
322
324
  - [`deploymentsInvoke`](docs/sdks/deployments/README.md#invoke) - Invoke
323
325
  - [`deploymentsList`](docs/sdks/deployments/README.md#list) - List all deployments
324
326
  - [`deploymentsMetricsCreate`](docs/sdks/metrics/README.md#create) - Add metrics
327
+ - [`deploymentsStream`](docs/sdks/deployments/README.md#stream) - Stream
325
328
  - [`feedbackCreate`](docs/sdks/feedback/README.md#create) - Submit feedback
326
329
  - [`filesCreate`](docs/sdks/files/README.md#create) - Create file
327
330
  - [`filesDelete`](docs/sdks/files/README.md#delete) - Delete file
@@ -339,6 +342,41 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
339
342
  </details>
340
343
  <!-- End Standalone functions [standalone-funcs] -->
341
344
 
345
+ <!-- Start Server-sent event streaming [eventstream] -->
346
+ ## Server-sent event streaming
347
+
348
+ [Server-sent events][mdn-sse] are used to stream content from certain
349
+ operations. These operations will expose the stream as an async iterable that
350
+ can be consumed using a [`for await...of`][mdn-for-await-of] loop. The loop will
351
+ terminate when the server no longer has any events to send and closes the
352
+ underlying connection.
353
+
354
+ ```typescript
355
+ import { Orq } from "@orq-ai/node";
356
+
357
+ const orq = new Orq({
358
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
359
+ });
360
+
361
+ async function run() {
362
+ const result = await orq.deployments.stream({
363
+ key: "<key>",
364
+ });
365
+
366
+ for await (const event of result) {
367
+ // Handle the event
368
+ console.log(event);
369
+ }
370
+ }
371
+
372
+ run();
373
+
374
+ ```
375
+
376
+ [mdn-sse]: https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events
377
+ [mdn-for-await-of]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of
378
+ <!-- End Server-sent event streaming [eventstream] -->
379
+
342
380
  <!-- Start File uploads [file-upload] -->
343
381
  ## File uploads
344
382
 
@@ -8,6 +8,7 @@
8
8
  * [list](#list) - List all deployments
9
9
  * [getConfig](#getconfig) - Get config
10
10
  * [invoke](#invoke) - Invoke
11
+ * [stream](#stream) - Stream
11
12
 
12
13
  ## list
13
14
 
@@ -230,6 +231,86 @@ run();
230
231
 
231
232
  ### Errors
232
233
 
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
+
233
314
  | Error Type | Status Code | Content Type |
234
315
  | --------------- | --------------- | --------------- |
235
316
  | errors.APIError | 4XX, 5XX | \*/\* |