@orq-ai/node 3.1.3 → 3.1.4

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 (149) hide show
  1. package/README.md +8 -23
  2. package/docs/sdks/files/README.md +8 -8
  3. package/docs/sdks/{remoteconfig → remoteconfigs}/README.md +8 -8
  4. package/funcs/{filesUpload.d.ts → filesCreate.d.ts} +3 -3
  5. package/funcs/{filesUpload.d.ts.map → filesCreate.d.ts.map} +1 -1
  6. package/funcs/{filesUpload.js → filesCreate.js} +4 -4
  7. package/funcs/{filesUpload.js.map → filesCreate.js.map} +1 -1
  8. package/funcs/filesGet.d.ts +4 -1
  9. package/funcs/filesGet.d.ts.map +1 -1
  10. package/funcs/filesGet.js +4 -1
  11. package/funcs/filesGet.js.map +1 -1
  12. package/funcs/filesList.d.ts +3 -0
  13. package/funcs/filesList.d.ts.map +1 -1
  14. package/funcs/filesList.js +5 -3
  15. package/funcs/filesList.js.map +1 -1
  16. package/funcs/{remoteconfigGetConfig.d.ts → remoteconfigsRetrieve.d.ts} +3 -3
  17. package/funcs/{remoteconfigGetConfig.d.ts.map → remoteconfigsRetrieve.d.ts.map} +1 -1
  18. package/funcs/{remoteconfigGetConfig.js → remoteconfigsRetrieve.js} +4 -4
  19. package/funcs/{remoteconfigGetConfig.js.map → remoteconfigsRetrieve.js.map} +1 -1
  20. package/jsr.json +1 -1
  21. package/lib/config.d.ts +2 -2
  22. package/lib/config.js +2 -2
  23. package/models/errors/index.d.ts +0 -1
  24. package/models/errors/index.d.ts.map +1 -1
  25. package/models/errors/index.js +0 -1
  26. package/models/errors/index.js.map +1 -1
  27. package/models/operations/createcontact.js +2 -2
  28. package/models/operations/createprompt.d.ts +348 -348
  29. package/models/operations/createprompt.d.ts.map +1 -1
  30. package/models/operations/createprompt.js +486 -483
  31. package/models/operations/createprompt.js.map +1 -1
  32. package/models/operations/fileget.js +2 -2
  33. package/models/operations/filelist.d.ts +13 -6
  34. package/models/operations/filelist.d.ts.map +1 -1
  35. package/models/operations/filelist.js +18 -10
  36. package/models/operations/filelist.js.map +1 -1
  37. package/models/operations/fileupload.js +2 -2
  38. package/models/operations/index.d.ts +0 -6
  39. package/models/operations/index.d.ts.map +1 -1
  40. package/models/operations/index.js +0 -6
  41. package/models/operations/index.js.map +1 -1
  42. package/models/operations/updateprompt.d.ts +30 -30
  43. package/models/operations/updateprompt.d.ts.map +1 -1
  44. package/models/operations/updateprompt.js +38 -38
  45. package/models/operations/updateprompt.js.map +1 -1
  46. package/package.json +1 -1
  47. package/sdk/files.d.ts +9 -3
  48. package/sdk/files.d.ts.map +1 -1
  49. package/sdk/files.js +11 -5
  50. package/sdk/files.js.map +1 -1
  51. package/sdk/remoteconfigs.d.ts +9 -0
  52. package/sdk/remoteconfigs.d.ts.map +1 -0
  53. package/sdk/remoteconfigs.js +19 -0
  54. package/sdk/remoteconfigs.js.map +1 -0
  55. package/sdk/sdk.d.ts +3 -6
  56. package/sdk/sdk.d.ts.map +1 -1
  57. package/sdk/sdk.js +3 -7
  58. package/sdk/sdk.js.map +1 -1
  59. package/src/funcs/{filesUpload.ts → filesCreate.ts} +2 -2
  60. package/src/funcs/filesGet.ts +4 -1
  61. package/src/funcs/filesList.ts +5 -3
  62. package/src/funcs/{remoteconfigGetConfig.ts → remoteconfigsRetrieve.ts} +2 -2
  63. package/src/lib/config.ts +2 -2
  64. package/src/models/errors/index.ts +0 -1
  65. package/src/models/operations/createcontact.ts +2 -2
  66. package/src/models/operations/createprompt.ts +668 -770
  67. package/src/models/operations/fileget.ts +2 -2
  68. package/src/models/operations/filelist.ts +31 -16
  69. package/src/models/operations/fileupload.ts +2 -2
  70. package/src/models/operations/index.ts +0 -6
  71. package/src/models/operations/updateprompt.ts +64 -81
  72. package/src/sdk/files.ts +11 -5
  73. package/src/sdk/{remoteconfig.ts → remoteconfigs.ts} +5 -5
  74. package/src/sdk/sdk.ts +4 -10
  75. package/docs/sdks/promptsnippets/README.md +0 -488
  76. package/funcs/promptSnippetsCreate.d.ts +0 -12
  77. package/funcs/promptSnippetsCreate.d.ts.map +0 -1
  78. package/funcs/promptSnippetsCreate.js +0 -106
  79. package/funcs/promptSnippetsCreate.js.map +0 -1
  80. package/funcs/promptSnippetsDelete.d.ts +0 -12
  81. package/funcs/promptSnippetsDelete.d.ts.map +0 -1
  82. package/funcs/promptSnippetsDelete.js +0 -110
  83. package/funcs/promptSnippetsDelete.js.map +0 -1
  84. package/funcs/promptSnippetsGet.d.ts +0 -12
  85. package/funcs/promptSnippetsGet.d.ts.map +0 -1
  86. package/funcs/promptSnippetsGet.js +0 -109
  87. package/funcs/promptSnippetsGet.js.map +0 -1
  88. package/funcs/promptSnippetsGetByKey.d.ts +0 -12
  89. package/funcs/promptSnippetsGetByKey.d.ts.map +0 -1
  90. package/funcs/promptSnippetsGetByKey.js +0 -109
  91. package/funcs/promptSnippetsGetByKey.js.map +0 -1
  92. package/funcs/promptSnippetsList.d.ts +0 -12
  93. package/funcs/promptSnippetsList.d.ts.map +0 -1
  94. package/funcs/promptSnippetsList.js +0 -109
  95. package/funcs/promptSnippetsList.js.map +0 -1
  96. package/funcs/promptSnippetsUpdate.d.ts +0 -13
  97. package/funcs/promptSnippetsUpdate.d.ts.map +0 -1
  98. package/funcs/promptSnippetsUpdate.js +0 -114
  99. package/funcs/promptSnippetsUpdate.js.map +0 -1
  100. package/models/errors/updatepromptsnippet.d.ts +0 -36
  101. package/models/errors/updatepromptsnippet.d.ts.map +0 -1
  102. package/models/errors/updatepromptsnippet.js +0 -79
  103. package/models/errors/updatepromptsnippet.js.map +0 -1
  104. package/models/operations/createpromptsnippet.d.ts +0 -3567
  105. package/models/operations/createpromptsnippet.d.ts.map +0 -1
  106. package/models/operations/createpromptsnippet.js +0 -3056
  107. package/models/operations/createpromptsnippet.js.map +0 -1
  108. package/models/operations/deletepromptsnippet.d.ts +0 -32
  109. package/models/operations/deletepromptsnippet.d.ts.map +0 -1
  110. package/models/operations/deletepromptsnippet.js +0 -69
  111. package/models/operations/deletepromptsnippet.js.map +0 -1
  112. package/models/operations/findonebykeypromptsnippet.d.ts +0 -2448
  113. package/models/operations/findonebykeypromptsnippet.d.ts.map +0 -1
  114. package/models/operations/findonebykeypromptsnippet.js +0 -2133
  115. package/models/operations/findonebykeypromptsnippet.js.map +0 -1
  116. package/models/operations/findonepromptsnippet.d.ts +0 -2448
  117. package/models/operations/findonepromptsnippet.d.ts.map +0 -1
  118. package/models/operations/findonepromptsnippet.js +0 -2124
  119. package/models/operations/findonepromptsnippet.js.map +0 -1
  120. package/models/operations/getallpromptsnippets.d.ts +0 -2512
  121. package/models/operations/getallpromptsnippets.d.ts.map +0 -1
  122. package/models/operations/getallpromptsnippets.js +0 -2195
  123. package/models/operations/getallpromptsnippets.js.map +0 -1
  124. package/models/operations/updatepromptsnippet.d.ts +0 -3595
  125. package/models/operations/updatepromptsnippet.d.ts.map +0 -1
  126. package/models/operations/updatepromptsnippet.js +0 -3116
  127. package/models/operations/updatepromptsnippet.js.map +0 -1
  128. package/sdk/promptsnippets.d.ts +0 -29
  129. package/sdk/promptsnippets.d.ts.map +0 -1
  130. package/sdk/promptsnippets.js +0 -54
  131. package/sdk/promptsnippets.js.map +0 -1
  132. package/sdk/remoteconfig.d.ts +0 -9
  133. package/sdk/remoteconfig.d.ts.map +0 -1
  134. package/sdk/remoteconfig.js +0 -19
  135. package/sdk/remoteconfig.js.map +0 -1
  136. package/src/funcs/promptSnippetsCreate.ts +0 -128
  137. package/src/funcs/promptSnippetsDelete.ts +0 -131
  138. package/src/funcs/promptSnippetsGet.ts +0 -130
  139. package/src/funcs/promptSnippetsGetByKey.ts +0 -132
  140. package/src/funcs/promptSnippetsList.ts +0 -132
  141. package/src/funcs/promptSnippetsUpdate.ts +0 -139
  142. package/src/models/errors/updatepromptsnippet.ts +0 -71
  143. package/src/models/operations/createpromptsnippet.ts +0 -6239
  144. package/src/models/operations/deletepromptsnippet.ts +0 -69
  145. package/src/models/operations/findonebykeypromptsnippet.ts +0 -4483
  146. package/src/models/operations/findonepromptsnippet.ts +0 -4343
  147. package/src/models/operations/getallpromptsnippets.ts +0 -4472
  148. package/src/models/operations/updatepromptsnippet.ts +0 -6544
  149. package/src/sdk/promptsnippets.ts +0 -99
@@ -1,488 +0,0 @@
1
- # PromptSnippets
2
- (*promptSnippets*)
3
-
4
- ## Overview
5
-
6
- ### Available Operations
7
-
8
- * [list](#list) - List all prompts snippets
9
- * [create](#create) - Create a prompt snippet
10
- * [update](#update) - Update a prompt snippet
11
- * [delete](#delete) - Delete a prompt snippet
12
- * [get](#get) - Retrieve a prompt snippet
13
- * [getByKey](#getbykey) - Retrieve a prompt snippet by key
14
-
15
- ## list
16
-
17
- List all prompts snippets
18
-
19
- ### Example Usage
20
-
21
- ```typescript
22
- import { Orq } from "@orq-ai/node";
23
-
24
- const orq = new Orq({
25
- apiKey: process.env["ORQ_API_KEY"] ?? "",
26
- });
27
-
28
- async function run() {
29
- const result = await orq.promptSnippets.list({});
30
-
31
- // Handle the result
32
- console.log(result);
33
- }
34
-
35
- run();
36
- ```
37
-
38
- ### Standalone function
39
-
40
- The standalone function version of this method:
41
-
42
- ```typescript
43
- import { OrqCore } from "@orq-ai/node/core.js";
44
- import { promptSnippetsList } from "@orq-ai/node/funcs/promptSnippetsList.js";
45
-
46
- // Use `OrqCore` for best tree-shaking performance.
47
- // You can create one instance of it to use across an application.
48
- const orq = new OrqCore({
49
- apiKey: process.env["ORQ_API_KEY"] ?? "",
50
- });
51
-
52
- async function run() {
53
- const res = await promptSnippetsList(orq, {});
54
-
55
- if (!res.ok) {
56
- throw res.error;
57
- }
58
-
59
- const { value: result } = res;
60
-
61
- // Handle the result
62
- console.log(result);
63
- }
64
-
65
- run();
66
- ```
67
-
68
- ### Parameters
69
-
70
- | Parameter | Type | Required | Description |
71
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
72
- | `request` | [operations.GetAllPromptSnippetsRequest](../../models/operations/getallpromptsnippetsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
73
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
74
- | `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. |
75
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
76
-
77
- ### Response
78
-
79
- **Promise\<[operations.GetAllPromptSnippetsResponseBody](../../models/operations/getallpromptsnippetsresponsebody.md)\>**
80
-
81
- ### Errors
82
-
83
- | Error Type | Status Code | Content Type |
84
- | --------------- | --------------- | --------------- |
85
- | errors.APIError | 4XX, 5XX | \*/\* |
86
-
87
- ## create
88
-
89
- Create a prompt snippet
90
-
91
- ### Example Usage
92
-
93
- ```typescript
94
- import { Orq } from "@orq-ai/node";
95
-
96
- const orq = new Orq({
97
- apiKey: process.env["ORQ_API_KEY"] ?? "",
98
- });
99
-
100
- async function run() {
101
- const result = await orq.promptSnippets.create({
102
- key: "<key>",
103
- promptConfig: {
104
- messages: [
105
- {
106
- role: "prompt",
107
- content: "<value>",
108
- },
109
- ],
110
- },
111
- path: "Customer Service/Billing/Refund",
112
- });
113
-
114
- // Handle the result
115
- console.log(result);
116
- }
117
-
118
- run();
119
- ```
120
-
121
- ### Standalone function
122
-
123
- The standalone function version of this method:
124
-
125
- ```typescript
126
- import { OrqCore } from "@orq-ai/node/core.js";
127
- import { promptSnippetsCreate } from "@orq-ai/node/funcs/promptSnippetsCreate.js";
128
-
129
- // Use `OrqCore` for best tree-shaking performance.
130
- // You can create one instance of it to use across an application.
131
- const orq = new OrqCore({
132
- apiKey: process.env["ORQ_API_KEY"] ?? "",
133
- });
134
-
135
- async function run() {
136
- const res = await promptSnippetsCreate(orq, {
137
- key: "<key>",
138
- promptConfig: {
139
- messages: [
140
- {
141
- role: "prompt",
142
- content: "<value>",
143
- },
144
- ],
145
- },
146
- path: "Customer Service/Billing/Refund",
147
- });
148
-
149
- if (!res.ok) {
150
- throw res.error;
151
- }
152
-
153
- const { value: result } = res;
154
-
155
- // Handle the result
156
- console.log(result);
157
- }
158
-
159
- run();
160
- ```
161
-
162
- ### Parameters
163
-
164
- | Parameter | Type | Required | Description |
165
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
166
- | `request` | [operations.CreatePromptSnippetRequestBody](../../models/operations/createpromptsnippetrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
167
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
168
- | `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. |
169
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
170
-
171
- ### Response
172
-
173
- **Promise\<[operations.CreatePromptSnippetResponseBody](../../models/operations/createpromptsnippetresponsebody.md)\>**
174
-
175
- ### Errors
176
-
177
- | Error Type | Status Code | Content Type |
178
- | --------------- | --------------- | --------------- |
179
- | errors.APIError | 4XX, 5XX | \*/\* |
180
-
181
- ## update
182
-
183
- Update a prompt snippet
184
-
185
- ### Example Usage
186
-
187
- ```typescript
188
- import { Orq } from "@orq-ai/node";
189
-
190
- const orq = new Orq({
191
- apiKey: process.env["ORQ_API_KEY"] ?? "",
192
- });
193
-
194
- async function run() {
195
- const result = await orq.promptSnippets.update({
196
- id: "<id>",
197
- requestBody: {
198
- path: "Customer Service/Billing/Refund",
199
- },
200
- });
201
-
202
- // Handle the result
203
- console.log(result);
204
- }
205
-
206
- run();
207
- ```
208
-
209
- ### Standalone function
210
-
211
- The standalone function version of this method:
212
-
213
- ```typescript
214
- import { OrqCore } from "@orq-ai/node/core.js";
215
- import { promptSnippetsUpdate } from "@orq-ai/node/funcs/promptSnippetsUpdate.js";
216
-
217
- // Use `OrqCore` for best tree-shaking performance.
218
- // You can create one instance of it to use across an application.
219
- const orq = new OrqCore({
220
- apiKey: process.env["ORQ_API_KEY"] ?? "",
221
- });
222
-
223
- async function run() {
224
- const res = await promptSnippetsUpdate(orq, {
225
- id: "<id>",
226
- requestBody: {
227
- path: "Customer Service/Billing/Refund",
228
- },
229
- });
230
-
231
- if (!res.ok) {
232
- throw res.error;
233
- }
234
-
235
- const { value: result } = res;
236
-
237
- // Handle the result
238
- console.log(result);
239
- }
240
-
241
- run();
242
- ```
243
-
244
- ### Parameters
245
-
246
- | Parameter | Type | Required | Description |
247
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
248
- | `request` | [operations.UpdatePromptSnippetRequest](../../models/operations/updatepromptsnippetrequest.md) | :heavy_check_mark: | The request object to use for the request. |
249
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
250
- | `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. |
251
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
252
-
253
- ### Response
254
-
255
- **Promise\<[operations.UpdatePromptSnippetResponseBody](../../models/operations/updatepromptsnippetresponsebody.md)\>**
256
-
257
- ### Errors
258
-
259
- | Error Type | Status Code | Content Type |
260
- | -------------------------------------- | -------------------------------------- | -------------------------------------- |
261
- | errors.UpdatePromptSnippetResponseBody | 404 | application/json |
262
- | errors.APIError | 4XX, 5XX | \*/\* |
263
-
264
- ## delete
265
-
266
- Delete a prompt snippet
267
-
268
- ### Example Usage
269
-
270
- ```typescript
271
- import { Orq } from "@orq-ai/node";
272
-
273
- const orq = new Orq({
274
- apiKey: process.env["ORQ_API_KEY"] ?? "",
275
- });
276
-
277
- async function run() {
278
- await orq.promptSnippets.delete({
279
- id: "<id>",
280
- });
281
-
282
-
283
- }
284
-
285
- run();
286
- ```
287
-
288
- ### Standalone function
289
-
290
- The standalone function version of this method:
291
-
292
- ```typescript
293
- import { OrqCore } from "@orq-ai/node/core.js";
294
- import { promptSnippetsDelete } from "@orq-ai/node/funcs/promptSnippetsDelete.js";
295
-
296
- // Use `OrqCore` for best tree-shaking performance.
297
- // You can create one instance of it to use across an application.
298
- const orq = new OrqCore({
299
- apiKey: process.env["ORQ_API_KEY"] ?? "",
300
- });
301
-
302
- async function run() {
303
- const res = await promptSnippetsDelete(orq, {
304
- id: "<id>",
305
- });
306
-
307
- if (!res.ok) {
308
- throw res.error;
309
- }
310
-
311
- const { value: result } = res;
312
-
313
-
314
- }
315
-
316
- run();
317
- ```
318
-
319
- ### Parameters
320
-
321
- | Parameter | Type | Required | Description |
322
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
323
- | `request` | [operations.DeletePromptSnippetRequest](../../models/operations/deletepromptsnippetrequest.md) | :heavy_check_mark: | The request object to use for the request. |
324
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
325
- | `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. |
326
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
327
-
328
- ### Response
329
-
330
- **Promise\<void\>**
331
-
332
- ### Errors
333
-
334
- | Error Type | Status Code | Content Type |
335
- | --------------- | --------------- | --------------- |
336
- | errors.APIError | 4XX, 5XX | \*/\* |
337
-
338
- ## get
339
-
340
- Retrieve a prompt snippet
341
-
342
- ### Example Usage
343
-
344
- ```typescript
345
- import { Orq } from "@orq-ai/node";
346
-
347
- const orq = new Orq({
348
- apiKey: process.env["ORQ_API_KEY"] ?? "",
349
- });
350
-
351
- async function run() {
352
- const result = await orq.promptSnippets.get({
353
- id: "<id>",
354
- });
355
-
356
- // Handle the result
357
- console.log(result);
358
- }
359
-
360
- run();
361
- ```
362
-
363
- ### Standalone function
364
-
365
- The standalone function version of this method:
366
-
367
- ```typescript
368
- import { OrqCore } from "@orq-ai/node/core.js";
369
- import { promptSnippetsGet } from "@orq-ai/node/funcs/promptSnippetsGet.js";
370
-
371
- // Use `OrqCore` for best tree-shaking performance.
372
- // You can create one instance of it to use across an application.
373
- const orq = new OrqCore({
374
- apiKey: process.env["ORQ_API_KEY"] ?? "",
375
- });
376
-
377
- async function run() {
378
- const res = await promptSnippetsGet(orq, {
379
- id: "<id>",
380
- });
381
-
382
- if (!res.ok) {
383
- throw res.error;
384
- }
385
-
386
- const { value: result } = res;
387
-
388
- // Handle the result
389
- console.log(result);
390
- }
391
-
392
- run();
393
- ```
394
-
395
- ### Parameters
396
-
397
- | Parameter | Type | Required | Description |
398
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
399
- | `request` | [operations.FindOnePromptSnippetRequest](../../models/operations/findonepromptsnippetrequest.md) | :heavy_check_mark: | The request object to use for the request. |
400
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
401
- | `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. |
402
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
403
-
404
- ### Response
405
-
406
- **Promise\<[operations.FindOnePromptSnippetResponseBody](../../models/operations/findonepromptsnippetresponsebody.md)\>**
407
-
408
- ### Errors
409
-
410
- | Error Type | Status Code | Content Type |
411
- | --------------- | --------------- | --------------- |
412
- | errors.APIError | 4XX, 5XX | \*/\* |
413
-
414
- ## getByKey
415
-
416
- Retrieve a prompt snippet by key
417
-
418
- ### Example Usage
419
-
420
- ```typescript
421
- import { Orq } from "@orq-ai/node";
422
-
423
- const orq = new Orq({
424
- apiKey: process.env["ORQ_API_KEY"] ?? "",
425
- });
426
-
427
- async function run() {
428
- const result = await orq.promptSnippets.getByKey({
429
- key: "<key>",
430
- });
431
-
432
- // Handle the result
433
- console.log(result);
434
- }
435
-
436
- run();
437
- ```
438
-
439
- ### Standalone function
440
-
441
- The standalone function version of this method:
442
-
443
- ```typescript
444
- import { OrqCore } from "@orq-ai/node/core.js";
445
- import { promptSnippetsGetByKey } from "@orq-ai/node/funcs/promptSnippetsGetByKey.js";
446
-
447
- // Use `OrqCore` for best tree-shaking performance.
448
- // You can create one instance of it to use across an application.
449
- const orq = new OrqCore({
450
- apiKey: process.env["ORQ_API_KEY"] ?? "",
451
- });
452
-
453
- async function run() {
454
- const res = await promptSnippetsGetByKey(orq, {
455
- key: "<key>",
456
- });
457
-
458
- if (!res.ok) {
459
- throw res.error;
460
- }
461
-
462
- const { value: result } = res;
463
-
464
- // Handle the result
465
- console.log(result);
466
- }
467
-
468
- run();
469
- ```
470
-
471
- ### Parameters
472
-
473
- | Parameter | Type | Required | Description |
474
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
475
- | `request` | [operations.FindOneByKeyPromptSnippetRequest](../../models/operations/findonebykeypromptsnippetrequest.md) | :heavy_check_mark: | The request object to use for the request. |
476
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
477
- | `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. |
478
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
479
-
480
- ### Response
481
-
482
- **Promise\<[operations.FindOneByKeyPromptSnippetResponseBody](../../models/operations/findonebykeypromptsnippetresponsebody.md)\>**
483
-
484
- ### Errors
485
-
486
- | Error Type | Status Code | Content Type |
487
- | --------------- | --------------- | --------------- |
488
- | errors.APIError | 4XX, 5XX | \*/\* |
@@ -1,12 +0,0 @@
1
- import { OrqCore } from "../core.js";
2
- import { RequestOptions } from "../lib/sdks.js";
3
- import { APIError } from "../models/errors/apierror.js";
4
- import { ConnectionError, InvalidRequestError, RequestAbortedError, RequestTimeoutError, UnexpectedClientError } from "../models/errors/httpclienterrors.js";
5
- import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
6
- import * as operations from "../models/operations/index.js";
7
- import { Result } from "../types/fp.js";
8
- /**
9
- * Create a prompt snippet
10
- */
11
- export declare function promptSnippetsCreate(client: OrqCore, request?: operations.CreatePromptSnippetRequestBody | undefined, options?: RequestOptions): Promise<Result<operations.CreatePromptSnippetResponseBody, APIError | SDKValidationError | UnexpectedClientError | InvalidRequestError | RequestAbortedError | RequestTimeoutError | ConnectionError>>;
12
- //# sourceMappingURL=promptSnippetsCreate.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"promptSnippetsCreate.d.ts","sourceRoot":"","sources":["../src/funcs/promptSnippetsCreate.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAKrC,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAGhD,OAAO,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AACxD,OAAO,EACL,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACtB,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EAAE,kBAAkB,EAAE,MAAM,wCAAwC,CAAC;AAC5E,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAExC;;GAEG;AACH,wBAAsB,oBAAoB,CACxC,MAAM,EAAE,OAAO,EACf,OAAO,CAAC,EAAE,UAAU,CAAC,8BAA8B,GAAG,SAAS,EAC/D,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CACR,MAAM,CACJ,UAAU,CAAC,+BAA+B,EACxC,QAAQ,GACR,kBAAkB,GAClB,qBAAqB,GACrB,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,eAAe,CAClB,CACF,CAqFA"}
@@ -1,106 +0,0 @@
1
- "use strict";
2
- /*
3
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
4
- */
5
- var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
6
- if (k2 === undefined) k2 = k;
7
- var desc = Object.getOwnPropertyDescriptor(m, k);
8
- if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
9
- desc = { enumerable: true, get: function() { return m[k]; } };
10
- }
11
- Object.defineProperty(o, k2, desc);
12
- }) : (function(o, m, k, k2) {
13
- if (k2 === undefined) k2 = k;
14
- o[k2] = m[k];
15
- }));
16
- var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
17
- Object.defineProperty(o, "default", { enumerable: true, value: v });
18
- }) : function(o, v) {
19
- o["default"] = v;
20
- });
21
- var __importStar = (this && this.__importStar) || (function () {
22
- var ownKeys = function(o) {
23
- ownKeys = Object.getOwnPropertyNames || function (o) {
24
- var ar = [];
25
- for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
26
- return ar;
27
- };
28
- return ownKeys(o);
29
- };
30
- return function (mod) {
31
- if (mod && mod.__esModule) return mod;
32
- var result = {};
33
- if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
34
- __setModuleDefault(result, mod);
35
- return result;
36
- };
37
- })();
38
- Object.defineProperty(exports, "__esModule", { value: true });
39
- exports.promptSnippetsCreate = promptSnippetsCreate;
40
- const encodings_js_1 = require("../lib/encodings.js");
41
- const M = __importStar(require("../lib/matchers.js"));
42
- const primitives_js_1 = require("../lib/primitives.js");
43
- const schemas_js_1 = require("../lib/schemas.js");
44
- const security_js_1 = require("../lib/security.js");
45
- const url_js_1 = require("../lib/url.js");
46
- const operations = __importStar(require("../models/operations/index.js"));
47
- /**
48
- * Create a prompt snippet
49
- */
50
- async function promptSnippetsCreate(client, request, options) {
51
- const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.CreatePromptSnippetRequestBody$outboundSchema.optional().parse(value), "Input validation failed");
52
- if (!parsed.ok) {
53
- return parsed;
54
- }
55
- const payload = parsed.value;
56
- const body = payload === undefined
57
- ? null
58
- : (0, encodings_js_1.encodeJSON)("body", payload, { explode: true });
59
- const path = (0, url_js_1.pathToFunc)("/v2/resources/prompts/snippets")();
60
- const headers = new Headers((0, primitives_js_1.compactMap)({
61
- "Content-Type": "application/json",
62
- Accept: "application/json",
63
- }));
64
- const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey);
65
- const securityInput = secConfig == null ? {} : { apiKey: secConfig };
66
- const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput);
67
- const context = {
68
- operationID: "CreatePromptSnippet",
69
- oAuth2Scopes: [],
70
- resolvedSecurity: requestSecurity,
71
- securitySource: client._options.apiKey,
72
- retryConfig: options?.retries
73
- || client._options.retryConfig
74
- || { strategy: "none" },
75
- retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
76
- };
77
- const requestRes = client._createRequest(context, {
78
- security: requestSecurity,
79
- method: "POST",
80
- baseURL: options?.serverURL,
81
- path: path,
82
- headers: headers,
83
- body: body,
84
- timeoutMs: options?.timeoutMs || client._options.timeoutMs || 600000,
85
- }, options);
86
- if (!requestRes.ok) {
87
- return requestRes;
88
- }
89
- const req = requestRes.value;
90
- const doResult = await client._do(req, {
91
- context,
92
- errorCodes: ["4XX", "5XX"],
93
- retryConfig: context.retryConfig,
94
- retryCodes: context.retryCodes,
95
- });
96
- if (!doResult.ok) {
97
- return doResult;
98
- }
99
- const response = doResult.value;
100
- const [result] = await M.match(M.json(200, operations.CreatePromptSnippetResponseBody$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response);
101
- if (!result.ok) {
102
- return result;
103
- }
104
- return result;
105
- }
106
- //# sourceMappingURL=promptSnippetsCreate.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"promptSnippetsCreate.js","sourceRoot":"","sources":["../src/funcs/promptSnippetsCreate.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAyBH,oDAoGC;AA1HD,sDAAiD;AACjD,sDAAwC;AACxC,wDAAkD;AAClD,kDAA8C;AAE9C,oDAA4E;AAC5E,0CAA2C;AAU3C,0EAA4D;AAG5D;;GAEG;AACI,KAAK,UAAU,oBAAoB,CACxC,MAAe,EACf,OAA+D,EAC/D,OAAwB;IAaxB,MAAM,MAAM,GAAG,IAAA,sBAAS,EACtB,OAAO,EACP,CAAC,KAAK,EAAE,EAAE,CACR,UAAU,CAAC,6CAA6C,CAAC,QAAQ,EAAE,CAAC,KAAK,CACvE,KAAK,CACN,EACH,yBAAyB,CAC1B,CAAC;IACF,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;QACf,OAAO,MAAM,CAAC;IAChB,CAAC;IACD,MAAM,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC;IAC7B,MAAM,IAAI,GAAG,OAAO,KAAK,SAAS;QAChC,CAAC,CAAC,IAAI;QACN,CAAC,CAAC,IAAA,yBAAU,EAAC,MAAM,EAAE,OAAO,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;IAEnD,MAAM,IAAI,GAAG,IAAA,mBAAU,EAAC,gCAAgC,CAAC,EAAE,CAAC;IAE5D,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,IAAA,0BAAU,EAAC;QACrC,cAAc,EAAE,kBAAkB;QAClC,MAAM,EAAE,kBAAkB;KAC3B,CAAC,CAAC,CAAC;IAEJ,MAAM,SAAS,GAAG,MAAM,IAAA,6BAAe,EAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IAChE,MAAM,aAAa,GAAG,SAAS,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC;IACrE,MAAM,eAAe,GAAG,IAAA,mCAAqB,EAAC,aAAa,CAAC,CAAC;IAE7D,MAAM,OAAO,GAAG;QACd,WAAW,EAAE,qBAAqB;QAClC,YAAY,EAAE,EAAE;QAEhB,gBAAgB,EAAE,eAAe;QAEjC,cAAc,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM;QACtC,WAAW,EAAE,OAAO,EAAE,OAAO;eACxB,MAAM,CAAC,QAAQ,CAAC,WAAW;eAC3B,EAAE,QAAQ,EAAE,MAAM,EAAE;QACzB,UAAU,EAAE,OAAO,EAAE,UAAU,IAAI,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC;KACvE,CAAC;IAEF,MAAM,UAAU,GAAG,MAAM,CAAC,cAAc,CAAC,OAAO,EAAE;QAChD,QAAQ,EAAE,eAAe;QACzB,MAAM,EAAE,MAAM;QACd,OAAO,EAAE,OAAO,EAAE,SAAS;QAC3B,IAAI,EAAE,IAAI;QACV,OAAO,EAAE,OAAO;QAChB,IAAI,EAAE,IAAI;QACV,SAAS,EAAE,OAAO,EAAE,SAAS,IAAI,MAAM,CAAC,QAAQ,CAAC,SAAS,IAAI,MAAM;KACrE,EAAE,OAAO,CAAC,CAAC;IACZ,IAAI,CAAC,UAAU,CAAC,EAAE,EAAE,CAAC;QACnB,OAAO,UAAU,CAAC;IACpB,CAAC;IACD,MAAM,GAAG,GAAG,UAAU,CAAC,KAAK,CAAC;IAE7B,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE;QACrC,OAAO;QACP,UAAU,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC;QAC1B,WAAW,EAAE,OAAO,CAAC,WAAW;QAChC,UAAU,EAAE,OAAO,CAAC,UAAU;KAC/B,CAAC,CAAC;IACH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;QACjB,OAAO,QAAQ,CAAC;IAClB,CAAC;IACD,MAAM,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC;IAEhC,MAAM,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,KAAK,CAU5B,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,UAAU,CAAC,6CAA6C,CAAC,EACrE,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,EACb,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CACd,CAAC,QAAQ,CAAC,CAAC;IACZ,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;QACf,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC"}
@@ -1,12 +0,0 @@
1
- import { OrqCore } from "../core.js";
2
- import { RequestOptions } from "../lib/sdks.js";
3
- import { APIError } from "../models/errors/apierror.js";
4
- import { ConnectionError, InvalidRequestError, RequestAbortedError, RequestTimeoutError, UnexpectedClientError } from "../models/errors/httpclienterrors.js";
5
- import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
6
- import * as operations from "../models/operations/index.js";
7
- import { Result } from "../types/fp.js";
8
- /**
9
- * Delete a prompt snippet
10
- */
11
- export declare function promptSnippetsDelete(client: OrqCore, request: operations.DeletePromptSnippetRequest, options?: RequestOptions): Promise<Result<void, APIError | SDKValidationError | UnexpectedClientError | InvalidRequestError | RequestAbortedError | RequestTimeoutError | ConnectionError>>;
12
- //# sourceMappingURL=promptSnippetsDelete.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"promptSnippetsDelete.d.ts","sourceRoot":"","sources":["../src/funcs/promptSnippetsDelete.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAKrC,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAGhD,OAAO,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AACxD,OAAO,EACL,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACtB,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EAAE,kBAAkB,EAAE,MAAM,wCAAwC,CAAC;AAC5E,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAExC;;GAEG;AACH,wBAAsB,oBAAoB,CACxC,MAAM,EAAE,OAAO,EACf,OAAO,EAAE,UAAU,CAAC,0BAA0B,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CACR,MAAM,CACJ,IAAI,EACF,QAAQ,GACR,kBAAkB,GAClB,qBAAqB,GACrB,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,eAAe,CAClB,CACF,CAuFA"}