@orq-ai/node 3.0.0-rc.19 → 3.1.0-rc.26
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/README.md +29 -40
- package/RUNTIMES.md +27 -1
- package/docs/sdks/deployments/README.md +86 -9
- package/docs/sdks/files/README.md +2 -170
- package/docs/sdks/orq/README.md +1 -1
- package/docs/sdks/prompts/README.md +97 -181
- package/docs/sdks/promptsnippets/README.md +463 -0
- package/funcs/contactsCreate.d.ts.map +1 -1
- package/funcs/contactsCreate.js +12 -7
- package/funcs/contactsCreate.js.map +1 -1
- package/funcs/deploymentsGetConfig.d.ts.map +1 -1
- package/funcs/deploymentsGetConfig.js +12 -7
- package/funcs/deploymentsGetConfig.js.map +1 -1
- package/funcs/deploymentsInvoke.d.ts +1 -7
- package/funcs/deploymentsInvoke.d.ts.map +1 -1
- package/funcs/deploymentsInvoke.js +17 -17
- package/funcs/deploymentsInvoke.js.map +1 -1
- package/funcs/{deploymentsAll.d.ts → deploymentsList.d.ts} +2 -2
- package/funcs/deploymentsList.d.ts.map +1 -0
- package/funcs/{deploymentsAll.js → deploymentsList.js} +18 -12
- package/funcs/deploymentsList.js.map +1 -0
- package/funcs/deploymentsMetricsCreate.d.ts.map +1 -1
- package/funcs/deploymentsMetricsCreate.js +12 -7
- package/funcs/deploymentsMetricsCreate.js.map +1 -1
- package/funcs/deploymentsStream.d.ts +16 -0
- package/funcs/deploymentsStream.d.ts.map +1 -0
- package/funcs/deploymentsStream.js +125 -0
- package/funcs/deploymentsStream.js.map +1 -0
- package/funcs/feedbackCreate.d.ts.map +1 -1
- package/funcs/feedbackCreate.js +12 -7
- package/funcs/feedbackCreate.js.map +1 -1
- package/funcs/filesDelete.d.ts.map +1 -1
- package/funcs/filesDelete.js +12 -7
- package/funcs/filesDelete.js.map +1 -1
- package/funcs/filesGet.d.ts.map +1 -1
- package/funcs/filesGet.js +12 -7
- package/funcs/filesGet.js.map +1 -1
- package/funcs/filesList.d.ts.map +1 -1
- package/funcs/filesList.js +16 -11
- package/funcs/filesList.js.map +1 -1
- package/funcs/filesUpload.d.ts.map +1 -1
- package/funcs/filesUpload.js +22 -16
- package/funcs/filesUpload.js.map +1 -1
- package/funcs/{promptsCreateVersion.d.ts → promptSnippetsCreate.d.ts} +3 -3
- package/funcs/promptSnippetsCreate.d.ts.map +1 -0
- package/funcs/{promptsGetAll.js → promptSnippetsCreate.js} +19 -14
- package/funcs/promptSnippetsCreate.js.map +1 -0
- package/funcs/{filesUpdate.d.ts → promptSnippetsDelete.d.ts} +3 -3
- package/funcs/{promptsCreateVersion.d.ts.map → promptSnippetsDelete.d.ts.map} +1 -1
- package/funcs/{promptsDuplicate.js → promptSnippetsDelete.js} +20 -15
- package/funcs/promptSnippetsDelete.js.map +1 -0
- package/funcs/{promptsGetAll.d.ts → promptSnippetsGet.d.ts} +3 -3
- package/funcs/promptSnippetsGet.d.ts.map +1 -0
- package/funcs/{promptSnippetsFindOne.js → promptSnippetsGet.js} +18 -13
- package/funcs/promptSnippetsGet.js.map +1 -0
- package/funcs/{promptSnippetsFindOne.d.ts → promptSnippetsGetByKey.d.ts} +3 -3
- package/funcs/promptSnippetsGetByKey.d.ts.map +1 -0
- package/funcs/promptSnippetsGetByKey.js +113 -0
- package/funcs/promptSnippetsGetByKey.js.map +1 -0
- package/funcs/promptSnippetsUpdate.d.ts +13 -0
- package/funcs/promptSnippetsUpdate.d.ts.map +1 -0
- package/funcs/{promptsCreateVersion.js → promptSnippetsUpdate.js} +25 -16
- package/funcs/promptSnippetsUpdate.js.map +1 -0
- package/funcs/promptsCreate.d.ts +1 -1
- package/funcs/promptsCreate.d.ts.map +1 -1
- package/funcs/promptsCreate.js +14 -9
- package/funcs/promptsCreate.js.map +1 -1
- package/funcs/promptsDelete.d.ts.map +1 -1
- package/funcs/promptsDelete.js +13 -8
- package/funcs/promptsDelete.js.map +1 -1
- package/funcs/{promptsGetOne.d.ts → promptsGet.d.ts} +3 -3
- package/funcs/promptsGet.d.ts.map +1 -0
- package/funcs/{promptsGetOne.js → promptsGet.js} +17 -12
- package/funcs/promptsGet.js.map +1 -0
- package/funcs/{promptsDuplicate.d.ts → promptsList.d.ts} +3 -3
- package/funcs/promptsList.d.ts.map +1 -0
- package/funcs/promptsList.js +113 -0
- package/funcs/promptsList.js.map +1 -0
- package/funcs/promptsUpdate.d.ts.map +1 -1
- package/funcs/promptsUpdate.js +13 -8
- package/funcs/promptsUpdate.js.map +1 -1
- package/funcs/remoteconfigGetConfig.d.ts.map +1 -1
- package/funcs/remoteconfigGetConfig.js +12 -7
- package/funcs/remoteconfigGetConfig.js.map +1 -1
- package/hooks/global.d.ts +5 -0
- package/hooks/global.d.ts.map +1 -0
- package/hooks/global.js +35 -0
- package/hooks/global.js.map +1 -0
- package/hooks/registration.d.ts.map +1 -1
- package/hooks/registration.js +2 -1
- package/hooks/registration.js.map +1 -1
- package/jsr.json +28 -0
- package/lib/config.d.ts +12 -4
- package/lib/config.d.ts.map +1 -1
- package/lib/config.js +5 -6
- package/lib/config.js.map +1 -1
- package/lib/encodings.d.ts +10 -9
- package/lib/encodings.d.ts.map +1 -1
- package/lib/encodings.js +91 -66
- package/lib/encodings.js.map +1 -1
- package/lib/env.d.ts +13 -0
- package/lib/env.d.ts.map +1 -1
- package/lib/env.js +18 -2
- package/lib/env.js.map +1 -1
- package/lib/event-streams.js +2 -3
- package/lib/event-streams.js.map +1 -1
- package/lib/http.js +1 -2
- package/lib/http.js.map +1 -1
- package/lib/matchers.js +5 -6
- package/lib/matchers.js.map +1 -1
- package/lib/primitives.d.ts +1 -0
- package/lib/primitives.d.ts.map +1 -1
- package/lib/primitives.js +11 -1
- package/lib/primitives.js.map +1 -1
- package/lib/retries.js +3 -5
- package/lib/retries.js.map +1 -1
- package/lib/schemas.d.ts +1 -1
- package/lib/schemas.d.ts.map +1 -1
- package/lib/schemas.js +4 -1
- package/lib/schemas.js.map +1 -1
- package/lib/sdks.d.ts.map +1 -1
- package/lib/sdks.js +20 -18
- package/lib/sdks.js.map +1 -1
- package/lib/security.js +2 -3
- package/lib/security.js.map +1 -1
- package/lib/url.js +1 -1
- package/lib/url.js.map +1 -1
- package/models/errors/httpclienterrors.js +2 -2
- package/models/errors/httpclienterrors.js.map +1 -1
- package/models/errors/index.d.ts +1 -0
- package/models/errors/index.d.ts.map +1 -1
- package/models/errors/index.js +1 -0
- package/models/errors/index.js.map +1 -1
- package/models/errors/updatepromptsnippet.d.ts +36 -0
- package/models/errors/updatepromptsnippet.d.ts.map +1 -0
- package/models/{operations/duplicateprompt.js → errors/updatepromptsnippet.js} +33 -23
- package/models/errors/updatepromptsnippet.js.map +1 -0
- package/models/operations/createcontact.d.ts +25 -0
- package/models/operations/createcontact.d.ts.map +1 -1
- package/models/operations/createcontact.js +30 -3
- package/models/operations/createcontact.js.map +1 -1
- package/models/operations/createfeedback.d.ts +25 -0
- package/models/operations/createfeedback.d.ts.map +1 -1
- package/models/operations/createfeedback.js +28 -1
- package/models/operations/createfeedback.js.map +1 -1
- package/models/operations/createprompt.d.ts +2199 -748
- package/models/operations/createprompt.d.ts.map +1 -1
- package/models/operations/createprompt.js +1628 -486
- package/models/operations/createprompt.js.map +1 -1
- package/models/operations/createpromptsnippet.d.ts +3490 -0
- package/models/operations/createpromptsnippet.d.ts.map +1 -0
- package/models/operations/createpromptsnippet.js +3018 -0
- package/models/operations/createpromptsnippet.js.map +1 -0
- package/models/operations/deleteprompt.d.ts +25 -0
- package/models/operations/deleteprompt.d.ts.map +1 -1
- package/models/operations/deleteprompt.js +28 -1
- package/models/operations/deleteprompt.js.map +1 -1
- package/models/operations/deletepromptsnippet.d.ts +57 -0
- package/models/operations/deletepromptsnippet.d.ts.map +1 -0
- package/models/operations/deletepromptsnippet.js +96 -0
- package/models/operations/deletepromptsnippet.js.map +1 -0
- package/models/operations/deploymentcreatemetric.d.ts +25 -0
- package/models/operations/deploymentcreatemetric.d.ts.map +1 -1
- package/models/operations/deploymentcreatemetric.js +29 -2
- package/models/operations/deploymentcreatemetric.js.map +1 -1
- package/models/operations/deploymentgetconfig.d.ts +25 -0
- package/models/operations/deploymentgetconfig.d.ts.map +1 -1
- package/models/operations/deploymentgetconfig.js +31 -4
- package/models/operations/deploymentgetconfig.js.map +1 -1
- package/models/operations/deploymentinvoke.d.ts +23 -683
- package/models/operations/deploymentinvoke.d.ts.map +1 -1
- package/models/operations/deploymentinvoke.js +23 -614
- package/models/operations/deploymentinvoke.js.map +1 -1
- package/models/operations/deployments.d.ts +40 -8
- package/models/operations/deployments.d.ts.map +1 -1
- package/models/operations/deployments.js +46 -13
- package/models/operations/deployments.js.map +1 -1
- package/models/operations/deploymentstream.d.ts +1622 -0
- package/models/operations/deploymentstream.d.ts.map +1 -0
- package/models/operations/deploymentstream.js +1571 -0
- package/models/operations/deploymentstream.js.map +1 -0
- package/models/operations/filedelete.d.ts +25 -0
- package/models/operations/filedelete.d.ts.map +1 -1
- package/models/operations/filedelete.js +28 -1
- package/models/operations/filedelete.js.map +1 -1
- package/models/operations/fileget.d.ts +25 -0
- package/models/operations/fileget.d.ts.map +1 -1
- package/models/operations/fileget.js +30 -3
- package/models/operations/fileget.js.map +1 -1
- package/models/operations/filelist.d.ts +26 -5
- package/models/operations/filelist.d.ts.map +1 -1
- package/models/operations/filelist.js +32 -13
- package/models/operations/filelist.js.map +1 -1
- package/models/operations/fileupload.d.ts +25 -0
- package/models/operations/fileupload.d.ts.map +1 -1
- package/models/operations/fileupload.js +30 -3
- package/models/operations/fileupload.js.map +1 -1
- package/models/operations/findonebykeypromptsnippet.d.ts +2405 -0
- package/models/operations/findonebykeypromptsnippet.d.ts.map +1 -0
- package/models/operations/findonebykeypromptsnippet.js +2113 -0
- package/models/operations/findonebykeypromptsnippet.js.map +1 -0
- package/models/operations/findonepromptsnippet.d.ts +891 -4764
- package/models/operations/findonepromptsnippet.d.ts.map +1 -1
- package/models/operations/findonepromptsnippet.js +966 -4752
- package/models/operations/findonepromptsnippet.js.map +1 -1
- package/models/operations/getallprompts.d.ts +907 -9115
- package/models/operations/getallprompts.d.ts.map +1 -1
- package/models/operations/getallprompts.js +923 -8166
- package/models/operations/getallprompts.js.map +1 -1
- package/models/operations/getoneprompt.d.ts +25 -0
- package/models/operations/getoneprompt.d.ts.map +1 -1
- package/models/operations/getoneprompt.js +28 -1
- package/models/operations/getoneprompt.js.map +1 -1
- package/models/operations/index.d.ts +5 -5
- package/models/operations/index.d.ts.map +1 -1
- package/models/operations/index.js +5 -5
- package/models/operations/index.js.map +1 -1
- package/models/operations/remoteconfigsgetconfig.d.ts +25 -0
- package/models/operations/remoteconfigsgetconfig.d.ts.map +1 -1
- package/models/operations/remoteconfigsgetconfig.js +28 -1
- package/models/operations/remoteconfigsgetconfig.js.map +1 -1
- package/models/operations/updateprompt.d.ts +1363 -5103
- package/models/operations/updateprompt.d.ts.map +1 -1
- package/models/operations/updateprompt.js +1020 -4666
- package/models/operations/updateprompt.js.map +1 -1
- package/models/operations/updatepromptsnippet.d.ts +3518 -0
- package/models/operations/updatepromptsnippet.d.ts.map +1 -0
- package/models/operations/updatepromptsnippet.js +3076 -0
- package/models/operations/updatepromptsnippet.js.map +1 -0
- package/package.json +6 -7
- package/sdk/deployments.d.ts +10 -6
- package/sdk/deployments.d.ts.map +1 -1
- package/sdk/deployments.js +15 -8
- package/sdk/deployments.js.map +1 -1
- package/sdk/files.d.ts +0 -11
- package/sdk/files.d.ts.map +1 -1
- package/sdk/files.js +0 -17
- package/sdk/files.js.map +1 -1
- package/sdk/prompts.d.ts +7 -15
- package/sdk/prompts.d.ts.map +1 -1
- package/sdk/prompts.js +12 -26
- package/sdk/prompts.js.map +1 -1
- package/sdk/promptsnippets.d.ts +25 -0
- package/sdk/promptsnippets.d.ts.map +1 -0
- package/sdk/promptsnippets.js +47 -0
- package/sdk/promptsnippets.js.map +1 -0
- package/sdk/sdk.d.ts +3 -3
- package/sdk/sdk.d.ts.map +1 -1
- package/sdk/sdk.js +9 -16
- package/sdk/sdk.js.map +1 -1
- package/src/funcs/contactsCreate.ts +10 -4
- package/src/funcs/deploymentsGetConfig.ts +10 -4
- package/src/funcs/deploymentsInvoke.ts +26 -19
- package/src/funcs/{deploymentsAll.ts → deploymentsList.ts} +13 -6
- package/src/funcs/deploymentsMetricsCreate.ts +9 -3
- package/src/funcs/deploymentsStream.ts +150 -0
- package/src/funcs/feedbackCreate.ts +10 -4
- package/src/funcs/filesDelete.ts +9 -3
- package/src/funcs/filesGet.ts +9 -3
- package/src/funcs/filesList.ts +10 -4
- package/src/funcs/filesUpload.ts +15 -7
- package/src/funcs/{promptsCreateVersion.ts → promptSnippetsCreate.ts} +23 -20
- package/src/funcs/{promptsDuplicate.ts → promptSnippetsDelete.ts} +17 -10
- package/src/funcs/{promptSnippetsFindOne.ts → promptSnippetsGet.ts} +13 -7
- package/src/funcs/promptSnippetsGetByKey.ts +136 -0
- package/src/funcs/{filesUpdate.ts → promptSnippetsUpdate.ts} +29 -14
- package/src/funcs/promptsCreate.ts +12 -6
- package/src/funcs/promptsDelete.ts +10 -4
- package/src/funcs/{promptsGetOne.ts → promptsGet.ts} +12 -6
- package/src/funcs/{promptsGetAll.ts → promptsList.ts} +24 -16
- package/src/funcs/promptsUpdate.ts +10 -4
- package/src/funcs/remoteconfigGetConfig.ts +10 -4
- package/src/hooks/global.ts +38 -0
- package/src/hooks/registration.ts +2 -1
- package/src/lib/config.ts +14 -4
- package/src/lib/encodings.ts +95 -61
- package/src/lib/env.ts +32 -0
- package/src/lib/primitives.ts +14 -0
- package/src/lib/retries.ts +0 -1
- package/src/lib/schemas.ts +5 -0
- package/src/lib/sdks.ts +6 -3
- package/src/lib/security.ts +1 -1
- package/src/models/errors/index.ts +1 -0
- package/src/models/errors/updatepromptsnippet.ts +71 -0
- package/src/models/operations/createcontact.ts +60 -2
- package/src/models/operations/createfeedback.ts +58 -0
- package/src/models/operations/createprompt.ts +3795 -1345
- package/src/models/operations/createpromptsnippet.ts +6189 -0
- package/src/models/operations/deleteprompt.ts +58 -0
- package/src/models/operations/deletepromptsnippet.ts +127 -0
- package/src/models/operations/deploymentcreatemetric.ts +60 -0
- package/src/models/operations/deploymentgetconfig.ts +58 -0
- package/src/models/operations/deploymentinvoke.ts +182 -1423
- package/src/models/operations/deployments.ts +83 -18
- package/src/models/operations/deploymentstream.ts +3062 -0
- package/src/models/operations/filedelete.ts +58 -0
- package/src/models/operations/fileget.ts +56 -2
- package/src/models/operations/filelist.ts +61 -17
- package/src/models/operations/fileupload.ts +60 -2
- package/src/models/operations/findonebykeypromptsnippet.ts +4461 -0
- package/src/models/operations/findonepromptsnippet.ts +1779 -11084
- package/src/models/operations/getallprompts.ts +1595 -16105
- package/src/models/operations/getoneprompt.ts +58 -0
- package/src/models/operations/index.ts +5 -5
- package/src/models/operations/remoteconfigsgetconfig.ts +60 -0
- package/src/models/operations/updateprompt.ts +2571 -10999
- package/src/models/operations/updatepromptsnippet.ts +6483 -0
- package/src/sdk/deployments.ts +25 -11
- package/src/sdk/files.ts +0 -33
- package/src/sdk/prompts.ts +15 -45
- package/src/sdk/promptsnippets.ts +84 -0
- package/src/sdk/sdk.ts +4 -4
- package/tsconfig.json +41 -0
- package/docs/sdks/prompt/README.md +0 -6
- package/docs/sdks/snippets/README.md +0 -84
- package/docs/sdks/templates/README.md +0 -80
- package/funcs/deploymentsAll.d.ts.map +0 -1
- package/funcs/deploymentsAll.js.map +0 -1
- package/funcs/filesBulkUpload.d.ts +0 -15
- package/funcs/filesBulkUpload.d.ts.map +0 -1
- package/funcs/filesBulkUpload.js +0 -107
- package/funcs/filesBulkUpload.js.map +0 -1
- package/funcs/filesUpdate.d.ts.map +0 -1
- package/funcs/filesUpdate.js +0 -109
- package/funcs/filesUpdate.js.map +0 -1
- package/funcs/promptSnippetsFindOne.d.ts.map +0 -1
- package/funcs/promptSnippetsFindOne.js.map +0 -1
- package/funcs/promptTemplatesGetAll.d.ts +0 -12
- package/funcs/promptTemplatesGetAll.d.ts.map +0 -1
- package/funcs/promptTemplatesGetAll.js +0 -108
- package/funcs/promptTemplatesGetAll.js.map +0 -1
- package/funcs/promptsCreateVersion.js.map +0 -1
- package/funcs/promptsDuplicate.d.ts.map +0 -1
- package/funcs/promptsDuplicate.js.map +0 -1
- package/funcs/promptsGetAll.d.ts.map +0 -1
- package/funcs/promptsGetAll.js.map +0 -1
- package/funcs/promptsGetOne.d.ts.map +0 -1
- package/funcs/promptsGetOne.js.map +0 -1
- package/models/operations/bulkfileupload.d.ts +0 -173
- package/models/operations/bulkfileupload.d.ts.map +0 -1
- package/models/operations/bulkfileupload.js +0 -210
- package/models/operations/bulkfileupload.js.map +0 -1
- package/models/operations/createpromptversion.d.ts +0 -2003
- package/models/operations/createpromptversion.d.ts.map +0 -1
- package/models/operations/createpromptversion.js +0 -1852
- package/models/operations/createpromptversion.js.map +0 -1
- package/models/operations/duplicateprompt.d.ts +0 -32
- package/models/operations/duplicateprompt.d.ts.map +0 -1
- package/models/operations/duplicateprompt.js.map +0 -1
- package/models/operations/fileupdate.d.ts +0 -143
- package/models/operations/fileupdate.d.ts.map +0 -1
- package/models/operations/fileupdate.js +0 -193
- package/models/operations/fileupdate.js.map +0 -1
- package/models/operations/getallprompttemplates.d.ts +0 -6607
- package/models/operations/getallprompttemplates.d.ts.map +0 -1
- package/models/operations/getallprompttemplates.js +0 -6225
- package/models/operations/getallprompttemplates.js.map +0 -1
- package/sdk/prompt.d.ts +0 -10
- package/sdk/prompt.d.ts.map +0 -1
- package/sdk/prompt.js +0 -21
- package/sdk/prompt.js.map +0 -1
- package/sdk/snippets.d.ts +0 -9
- package/sdk/snippets.d.ts.map +0 -1
- package/sdk/snippets.js +0 -19
- package/sdk/snippets.js.map +0 -1
- package/sdk/templates.d.ts +0 -9
- package/sdk/templates.d.ts.map +0 -1
- package/sdk/templates.js +0 -19
- package/sdk/templates.js.map +0 -1
- package/src/funcs/filesBulkUpload.ts +0 -126
- package/src/funcs/promptTemplatesGetAll.ts +0 -130
- package/src/models/operations/bulkfileupload.ts +0 -315
- package/src/models/operations/createpromptversion.ts +0 -3703
- package/src/models/operations/duplicateprompt.ts +0 -69
- package/src/models/operations/fileupdate.ts +0 -298
- package/src/models/operations/getallprompttemplates.ts +0 -13690
- package/src/sdk/prompt.ts +0 -19
- package/src/sdk/snippets.ts +0 -24
- package/src/sdk/templates.ts +0 -24
package/README.md
CHANGED
|
@@ -9,15 +9,10 @@ Developer-friendly & type-safe Typescript SDK specifically catered to leverage *
|
|
|
9
9
|
</a>
|
|
10
10
|
</div>
|
|
11
11
|
|
|
12
|
-
|
|
13
|
-
<br /><br />
|
|
14
|
-
> [!IMPORTANT]
|
|
15
|
-
> This SDK is not yet ready for production use. To complete setup please follow the steps outlined in your [workspace](https://app.speakeasy.com/org/orq/orq). Delete this section before > publishing to a package manager.
|
|
16
|
-
|
|
17
12
|
<!-- Start Summary [summary] -->
|
|
18
13
|
## Summary
|
|
19
14
|
|
|
20
|
-
[Dev] orq.ai API:
|
|
15
|
+
[Dev] orq.ai API: orq.ai API documentation
|
|
21
16
|
|
|
22
17
|
For more information about the API: [orq.ai Documentation](https://docs.orq.ai)
|
|
23
18
|
<!-- End Summary [summary] -->
|
|
@@ -155,9 +150,10 @@ run();
|
|
|
155
150
|
|
|
156
151
|
### [deployments](docs/sdks/deployments/README.md)
|
|
157
152
|
|
|
158
|
-
* [
|
|
153
|
+
* [list](docs/sdks/deployments/README.md#list) - List all deployments
|
|
159
154
|
* [getConfig](docs/sdks/deployments/README.md#getconfig) - Get config
|
|
160
155
|
* [invoke](docs/sdks/deployments/README.md#invoke) - Invoke
|
|
156
|
+
* [stream](docs/sdks/deployments/README.md#stream) - Stream
|
|
161
157
|
|
|
162
158
|
#### [deployments.metrics](docs/sdks/metrics/README.md)
|
|
163
159
|
|
|
@@ -172,31 +168,24 @@ run();
|
|
|
172
168
|
* [upload](docs/sdks/files/README.md#upload) - Upload file
|
|
173
169
|
* [list](docs/sdks/files/README.md#list) - List all files
|
|
174
170
|
* [get](docs/sdks/files/README.md#get) - Get file by ID
|
|
175
|
-
* [update](docs/sdks/files/README.md#update) - Update file name
|
|
176
171
|
* [delete](docs/sdks/files/README.md#delete) - Delete file
|
|
177
|
-
* [bulkUpload](docs/sdks/files/README.md#bulkupload) - Bulk upload file
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
### [prompt](docs/sdks/prompt/README.md)
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
#### [prompt.snippets](docs/sdks/snippets/README.md)
|
|
184
172
|
|
|
185
|
-
* [findOne](docs/sdks/snippets/README.md#findone) - Get one prompt snippet
|
|
186
|
-
|
|
187
|
-
#### [prompt.templates](docs/sdks/templates/README.md)
|
|
188
|
-
|
|
189
|
-
* [getAll](docs/sdks/templates/README.md#getall) - Get all prompt templates
|
|
190
173
|
|
|
191
174
|
### [prompts](docs/sdks/prompts/README.md)
|
|
192
175
|
|
|
193
|
-
* [create](docs/sdks/prompts/README.md#create) - Create a
|
|
194
|
-
* [createVersion](docs/sdks/prompts/README.md#createversion) - Create a new prompt version
|
|
195
|
-
* [delete](docs/sdks/prompts/README.md#delete) - Delete a prompt
|
|
196
|
-
* [getOne](docs/sdks/prompts/README.md#getone) - Get one prompt
|
|
176
|
+
* [create](docs/sdks/prompts/README.md#create) - Create a prompt
|
|
197
177
|
* [update](docs/sdks/prompts/README.md#update) - Update a prompt
|
|
198
|
-
* [
|
|
199
|
-
* [
|
|
178
|
+
* [delete](docs/sdks/prompts/README.md#delete) - Delete a prompt
|
|
179
|
+
* [get](docs/sdks/prompts/README.md#get) - Retrieve a prompt
|
|
180
|
+
* [list](docs/sdks/prompts/README.md#list) - List all prompts
|
|
181
|
+
|
|
182
|
+
### [promptSnippets](docs/sdks/promptsnippets/README.md)
|
|
183
|
+
|
|
184
|
+
* [create](docs/sdks/promptsnippets/README.md#create) - Create a prompt snippet
|
|
185
|
+
* [update](docs/sdks/promptsnippets/README.md#update) - Update a prompt snippet
|
|
186
|
+
* [delete](docs/sdks/promptsnippets/README.md#delete) - Delete a prompt snippet
|
|
187
|
+
* [get](docs/sdks/promptsnippets/README.md#get) - Retrieve a prompt snippet
|
|
188
|
+
* [getByKey](docs/sdks/promptsnippets/README.md#getbykey) - Retrieve a prompt snippet by key
|
|
200
189
|
|
|
201
190
|
### [remoteconfig](docs/sdks/remoteconfig/README.md)
|
|
202
191
|
|
|
@@ -221,26 +210,26 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
|
|
221
210
|
<summary>Available standalone functions</summary>
|
|
222
211
|
|
|
223
212
|
- [`contactsCreate`](docs/sdks/contacts/README.md#create) - Update user information
|
|
224
|
-
- [`deploymentsAll`](docs/sdks/deployments/README.md#all) - List all deployments
|
|
225
213
|
- [`deploymentsGetConfig`](docs/sdks/deployments/README.md#getconfig) - Get config
|
|
226
214
|
- [`deploymentsInvoke`](docs/sdks/deployments/README.md#invoke) - Invoke
|
|
215
|
+
- [`deploymentsList`](docs/sdks/deployments/README.md#list) - List all deployments
|
|
227
216
|
- [`deploymentsMetricsCreate`](docs/sdks/metrics/README.md#create) - Add metrics
|
|
217
|
+
- [`deploymentsStream`](docs/sdks/deployments/README.md#stream) - Stream
|
|
228
218
|
- [`feedbackCreate`](docs/sdks/feedback/README.md#create) - Submit feedback
|
|
229
|
-
- [`filesBulkUpload`](docs/sdks/files/README.md#bulkupload) - Bulk upload file
|
|
230
219
|
- [`filesDelete`](docs/sdks/files/README.md#delete) - Delete file
|
|
231
220
|
- [`filesGet`](docs/sdks/files/README.md#get) - Get file by ID
|
|
232
221
|
- [`filesList`](docs/sdks/files/README.md#list) - List all files
|
|
233
|
-
- [`filesUpdate`](docs/sdks/files/README.md#update) - Update file name
|
|
234
222
|
- [`filesUpload`](docs/sdks/files/README.md#upload) - Upload file
|
|
235
|
-
- [`promptsCreate`](docs/sdks/prompts/README.md#create) - Create a
|
|
236
|
-
- [`promptsCreateVersion`](docs/sdks/prompts/README.md#createversion) - Create a new prompt version
|
|
223
|
+
- [`promptsCreate`](docs/sdks/prompts/README.md#create) - Create a prompt
|
|
237
224
|
- [`promptsDelete`](docs/sdks/prompts/README.md#delete) - Delete a prompt
|
|
238
|
-
- [`
|
|
239
|
-
- [`
|
|
240
|
-
- [`
|
|
241
|
-
- [`
|
|
225
|
+
- [`promptsGet`](docs/sdks/prompts/README.md#get) - Retrieve a prompt
|
|
226
|
+
- [`promptsList`](docs/sdks/prompts/README.md#list) - List all prompts
|
|
227
|
+
- [`promptSnippetsCreate`](docs/sdks/promptsnippets/README.md#create) - Create a prompt snippet
|
|
228
|
+
- [`promptSnippetsDelete`](docs/sdks/promptsnippets/README.md#delete) - Delete a prompt snippet
|
|
229
|
+
- [`promptSnippetsGet`](docs/sdks/promptsnippets/README.md#get) - Retrieve a prompt snippet
|
|
230
|
+
- [`promptSnippetsGetByKey`](docs/sdks/promptsnippets/README.md#getbykey) - Retrieve a prompt snippet by key
|
|
231
|
+
- [`promptSnippetsUpdate`](docs/sdks/promptsnippets/README.md#update) - Update a prompt snippet
|
|
242
232
|
- [`promptsUpdate`](docs/sdks/prompts/README.md#update) - Update a prompt
|
|
243
|
-
- [`promptTemplatesGetAll`](docs/sdks/templates/README.md#getall) - Get all prompt templates
|
|
244
233
|
- [`remoteconfigGetConfig`](docs/sdks/remoteconfig/README.md#getconfig) - Get Configurations
|
|
245
234
|
|
|
246
235
|
</details>
|
|
@@ -263,7 +252,7 @@ const orq = new Orq({
|
|
|
263
252
|
});
|
|
264
253
|
|
|
265
254
|
async function run() {
|
|
266
|
-
const result = await orq.deployments.
|
|
255
|
+
const result = await orq.deployments.stream({
|
|
267
256
|
key: "<key>",
|
|
268
257
|
});
|
|
269
258
|
|
|
@@ -386,7 +375,7 @@ run();
|
|
|
386
375
|
<!-- Start Error Handling [errors] -->
|
|
387
376
|
## Error Handling
|
|
388
377
|
|
|
389
|
-
Some methods specify known errors which can be thrown. All the known errors are enumerated in the `models/errors/errors.ts` module. The known errors for a method are documented under the *Errors* tables in SDK docs. For example, the `
|
|
378
|
+
Some methods specify known errors which can be thrown. All the known errors are enumerated in the `models/errors/errors.ts` module. The known errors for a method are documented under the *Errors* tables in SDK docs. For example, the `list` method may throw the following errors:
|
|
390
379
|
|
|
391
380
|
| Error Type | Status Code | Content Type |
|
|
392
381
|
| ------------------- | ----------- | ---------------- |
|
|
@@ -406,7 +395,7 @@ const orq = new Orq({
|
|
|
406
395
|
async function run() {
|
|
407
396
|
let result;
|
|
408
397
|
try {
|
|
409
|
-
result = await orq.deployments.
|
|
398
|
+
result = await orq.deployments.list({});
|
|
410
399
|
|
|
411
400
|
// Handle the result
|
|
412
401
|
console.log(result);
|
|
@@ -460,7 +449,7 @@ The default server can also be overridden globally by passing a URL to the `serv
|
|
|
460
449
|
import { Orq } from "@orq-ai/node";
|
|
461
450
|
|
|
462
451
|
const orq = new Orq({
|
|
463
|
-
serverURL: "https://my.
|
|
452
|
+
serverURL: "https://my.orq.ai",
|
|
464
453
|
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
465
454
|
});
|
|
466
455
|
|
package/RUNTIMES.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Supported JavaScript runtimes
|
|
2
2
|
|
|
3
|
-
This SDK is intended to be used in JavaScript runtimes that support the following features:
|
|
3
|
+
This SDK is intended to be used in JavaScript runtimes that support ECMAScript 2020 or newer. The SDK uses the following features:
|
|
4
4
|
|
|
5
5
|
* [Web Fetch API][web-fetch]
|
|
6
6
|
* [Web Streams API][web-streams] and in particular `ReadableStream`
|
|
@@ -20,3 +20,29 @@ Runtime environments that are explicitly supported are:
|
|
|
20
20
|
- Note that Deno does not currently have native support for streaming file uploads backed by the filesystem ([issue link][deno-file-streaming])
|
|
21
21
|
|
|
22
22
|
[deno-file-streaming]: https://github.com/denoland/deno/issues/11018
|
|
23
|
+
|
|
24
|
+
## Recommended TypeScript compiler options
|
|
25
|
+
|
|
26
|
+
The following `tsconfig.json` options are recommended for projects using this
|
|
27
|
+
SDK in order to get static type support for features like async iterables,
|
|
28
|
+
streams and `fetch`-related APIs ([`for await...of`][for-await-of],
|
|
29
|
+
[`AbortSignal`][abort-signal], [`Request`][request], [`Response`][response] and
|
|
30
|
+
so on):
|
|
31
|
+
|
|
32
|
+
[for-await-of]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of
|
|
33
|
+
[abort-signal]: https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal
|
|
34
|
+
[request]: https://developer.mozilla.org/en-US/docs/Web/API/Request
|
|
35
|
+
[response]: https://developer.mozilla.org/en-US/docs/Web/API/Response
|
|
36
|
+
|
|
37
|
+
```jsonc
|
|
38
|
+
{
|
|
39
|
+
"compilerOptions": {
|
|
40
|
+
"target": "es2020", // or higher
|
|
41
|
+
"lib": ["es2020", "dom", "dom.iterable"],
|
|
42
|
+
}
|
|
43
|
+
}
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
While `target` can be set to older ECMAScript versions, it may result in extra,
|
|
47
|
+
unnecessary compatibility code being generated if you are not targeting old
|
|
48
|
+
runtimes.
|
|
@@ -5,11 +5,12 @@
|
|
|
5
5
|
|
|
6
6
|
### Available Operations
|
|
7
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
|
|
|
14
15
|
Returns a list of your deployments. The deployments are returned sorted by creation date, with the most recent deployments appearing first.
|
|
15
16
|
|
|
@@ -23,7 +24,7 @@ const orq = new Orq({
|
|
|
23
24
|
});
|
|
24
25
|
|
|
25
26
|
async function run() {
|
|
26
|
-
const result = await orq.deployments.
|
|
27
|
+
const result = await orq.deployments.list({});
|
|
27
28
|
|
|
28
29
|
// Handle the result
|
|
29
30
|
console.log(result);
|
|
@@ -38,7 +39,7 @@ The standalone function version of this method:
|
|
|
38
39
|
|
|
39
40
|
```typescript
|
|
40
41
|
import { OrqCore } from "@orq-ai/node/core.js";
|
|
41
|
-
import {
|
|
42
|
+
import { deploymentsList } from "@orq-ai/node/funcs/deploymentsList.js";
|
|
42
43
|
|
|
43
44
|
// Use `OrqCore` for best tree-shaking performance.
|
|
44
45
|
// You can create one instance of it to use across an application.
|
|
@@ -47,7 +48,7 @@ const orq = new OrqCore({
|
|
|
47
48
|
});
|
|
48
49
|
|
|
49
50
|
async function run() {
|
|
50
|
-
const res = await
|
|
51
|
+
const res = await deploymentsList(orq, {});
|
|
51
52
|
|
|
52
53
|
if (!res.ok) {
|
|
53
54
|
throw res.error;
|
|
@@ -176,6 +177,82 @@ async function run() {
|
|
|
176
177
|
key: "<key>",
|
|
177
178
|
});
|
|
178
179
|
|
|
180
|
+
// Handle the result
|
|
181
|
+
console.log(result);
|
|
182
|
+
}
|
|
183
|
+
|
|
184
|
+
run();
|
|
185
|
+
```
|
|
186
|
+
|
|
187
|
+
### Standalone function
|
|
188
|
+
|
|
189
|
+
The standalone function version of this method:
|
|
190
|
+
|
|
191
|
+
```typescript
|
|
192
|
+
import { OrqCore } from "@orq-ai/node/core.js";
|
|
193
|
+
import { deploymentsInvoke } from "@orq-ai/node/funcs/deploymentsInvoke.js";
|
|
194
|
+
|
|
195
|
+
// Use `OrqCore` for best tree-shaking performance.
|
|
196
|
+
// You can create one instance of it to use across an application.
|
|
197
|
+
const orq = new OrqCore({
|
|
198
|
+
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
199
|
+
});
|
|
200
|
+
|
|
201
|
+
async function run() {
|
|
202
|
+
const res = await deploymentsInvoke(orq, {
|
|
203
|
+
key: "<key>",
|
|
204
|
+
});
|
|
205
|
+
|
|
206
|
+
if (!res.ok) {
|
|
207
|
+
throw res.error;
|
|
208
|
+
}
|
|
209
|
+
|
|
210
|
+
const { value: result } = res;
|
|
211
|
+
|
|
212
|
+
// Handle the result
|
|
213
|
+
console.log(result);
|
|
214
|
+
}
|
|
215
|
+
|
|
216
|
+
run();
|
|
217
|
+
```
|
|
218
|
+
|
|
219
|
+
### Parameters
|
|
220
|
+
|
|
221
|
+
| Parameter | Type | Required | Description |
|
|
222
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
223
|
+
| `request` | [components.Deployments](../../models/components/deployments.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
224
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
225
|
+
| `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. |
|
|
226
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
227
|
+
|
|
228
|
+
### Response
|
|
229
|
+
|
|
230
|
+
**Promise\<[operations.DeploymentInvokeResponseBody](../../models/operations/deploymentinvokeresponsebody.md)\>**
|
|
231
|
+
|
|
232
|
+
### Errors
|
|
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
|
+
|
|
179
256
|
for await (const event of result) {
|
|
180
257
|
// Handle the event
|
|
181
258
|
console.log(event);
|
|
@@ -191,7 +268,7 @@ The standalone function version of this method:
|
|
|
191
268
|
|
|
192
269
|
```typescript
|
|
193
270
|
import { OrqCore } from "@orq-ai/node/core.js";
|
|
194
|
-
import {
|
|
271
|
+
import { deploymentsStream } from "@orq-ai/node/funcs/deploymentsStream.js";
|
|
195
272
|
|
|
196
273
|
// Use `OrqCore` for best tree-shaking performance.
|
|
197
274
|
// You can create one instance of it to use across an application.
|
|
@@ -200,7 +277,7 @@ const orq = new OrqCore({
|
|
|
200
277
|
});
|
|
201
278
|
|
|
202
279
|
async function run() {
|
|
203
|
-
const res = await
|
|
280
|
+
const res = await deploymentsStream(orq, {
|
|
204
281
|
key: "<key>",
|
|
205
282
|
});
|
|
206
283
|
|
|
@@ -223,14 +300,14 @@ run();
|
|
|
223
300
|
|
|
224
301
|
| Parameter | Type | Required | Description |
|
|
225
302
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
226
|
-
| `request` | [
|
|
303
|
+
| `request` | [operations.DeploymentStreamRequestBody](../../models/operations/deploymentstreamrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
227
304
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
228
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. |
|
|
229
306
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
230
307
|
|
|
231
308
|
### Response
|
|
232
309
|
|
|
233
|
-
**Promise\<[operations.
|
|
310
|
+
**Promise\<[EventStream<operations.DeploymentStreamResponseBody>](../../models/.md)\>**
|
|
234
311
|
|
|
235
312
|
### Errors
|
|
236
313
|
|
|
@@ -8,9 +8,7 @@
|
|
|
8
8
|
* [upload](#upload) - Upload file
|
|
9
9
|
* [list](#list) - List all files
|
|
10
10
|
* [get](#get) - Get file by ID
|
|
11
|
-
* [update](#update) - Update file name
|
|
12
11
|
* [delete](#delete) - Delete file
|
|
13
|
-
* [bulkUpload](#bulkupload) - Bulk upload file
|
|
14
12
|
|
|
15
13
|
## upload
|
|
16
14
|
|
|
@@ -98,7 +96,7 @@ const orq = new Orq({
|
|
|
98
96
|
});
|
|
99
97
|
|
|
100
98
|
async function run() {
|
|
101
|
-
const result = await orq.files.list();
|
|
99
|
+
const result = await orq.files.list({});
|
|
102
100
|
|
|
103
101
|
// Handle the result
|
|
104
102
|
console.log(result);
|
|
@@ -122,7 +120,7 @@ const orq = new OrqCore({
|
|
|
122
120
|
});
|
|
123
121
|
|
|
124
122
|
async function run() {
|
|
125
|
-
const res = await filesList(orq);
|
|
123
|
+
const res = await filesList(orq, {});
|
|
126
124
|
|
|
127
125
|
if (!res.ok) {
|
|
128
126
|
throw res.error;
|
|
@@ -232,82 +230,6 @@ run();
|
|
|
232
230
|
| --------------- | --------------- | --------------- |
|
|
233
231
|
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
234
232
|
|
|
235
|
-
## update
|
|
236
|
-
|
|
237
|
-
Update file name
|
|
238
|
-
|
|
239
|
-
### Example Usage
|
|
240
|
-
|
|
241
|
-
```typescript
|
|
242
|
-
import { Orq } from "@orq-ai/node";
|
|
243
|
-
|
|
244
|
-
const orq = new Orq({
|
|
245
|
-
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
246
|
-
});
|
|
247
|
-
|
|
248
|
-
async function run() {
|
|
249
|
-
const result = await orq.files.update({
|
|
250
|
-
fileId: "<id>",
|
|
251
|
-
});
|
|
252
|
-
|
|
253
|
-
// Handle the result
|
|
254
|
-
console.log(result);
|
|
255
|
-
}
|
|
256
|
-
|
|
257
|
-
run();
|
|
258
|
-
```
|
|
259
|
-
|
|
260
|
-
### Standalone function
|
|
261
|
-
|
|
262
|
-
The standalone function version of this method:
|
|
263
|
-
|
|
264
|
-
```typescript
|
|
265
|
-
import { OrqCore } from "@orq-ai/node/core.js";
|
|
266
|
-
import { filesUpdate } from "@orq-ai/node/funcs/filesUpdate.js";
|
|
267
|
-
|
|
268
|
-
// Use `OrqCore` for best tree-shaking performance.
|
|
269
|
-
// You can create one instance of it to use across an application.
|
|
270
|
-
const orq = new OrqCore({
|
|
271
|
-
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
272
|
-
});
|
|
273
|
-
|
|
274
|
-
async function run() {
|
|
275
|
-
const res = await filesUpdate(orq, {
|
|
276
|
-
fileId: "<id>",
|
|
277
|
-
});
|
|
278
|
-
|
|
279
|
-
if (!res.ok) {
|
|
280
|
-
throw res.error;
|
|
281
|
-
}
|
|
282
|
-
|
|
283
|
-
const { value: result } = res;
|
|
284
|
-
|
|
285
|
-
// Handle the result
|
|
286
|
-
console.log(result);
|
|
287
|
-
}
|
|
288
|
-
|
|
289
|
-
run();
|
|
290
|
-
```
|
|
291
|
-
|
|
292
|
-
### Parameters
|
|
293
|
-
|
|
294
|
-
| Parameter | Type | Required | Description |
|
|
295
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
296
|
-
| `request` | [operations.FileUpdateRequest](../../models/operations/fileupdaterequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
297
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
298
|
-
| `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. |
|
|
299
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
300
|
-
|
|
301
|
-
### Response
|
|
302
|
-
|
|
303
|
-
**Promise\<[operations.FileUpdateResponseBody](../../models/operations/fileupdateresponsebody.md)\>**
|
|
304
|
-
|
|
305
|
-
### Errors
|
|
306
|
-
|
|
307
|
-
| Error Type | Status Code | Content Type |
|
|
308
|
-
| --------------- | --------------- | --------------- |
|
|
309
|
-
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
310
|
-
|
|
311
233
|
## delete
|
|
312
234
|
|
|
313
235
|
Delete file
|
|
@@ -378,96 +300,6 @@ run();
|
|
|
378
300
|
|
|
379
301
|
### Errors
|
|
380
302
|
|
|
381
|
-
| Error Type | Status Code | Content Type |
|
|
382
|
-
| --------------- | --------------- | --------------- |
|
|
383
|
-
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
384
|
-
|
|
385
|
-
## bulkUpload
|
|
386
|
-
|
|
387
|
-
Files are used to upload documents that can be used with features like [Deployments](https://docs.orq.ai/reference/post_v2-deployments-get-config).
|
|
388
|
-
|
|
389
|
-
### Example Usage
|
|
390
|
-
|
|
391
|
-
```typescript
|
|
392
|
-
import { Orq } from "@orq-ai/node";
|
|
393
|
-
import { openAsBlob } from "node:fs";
|
|
394
|
-
|
|
395
|
-
const orq = new Orq({
|
|
396
|
-
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
397
|
-
});
|
|
398
|
-
|
|
399
|
-
async function run() {
|
|
400
|
-
const result = await orq.files.bulkUpload({
|
|
401
|
-
files: [
|
|
402
|
-
{
|
|
403
|
-
fileName: "example.file",
|
|
404
|
-
content: await openAsBlob("example.file"),
|
|
405
|
-
},
|
|
406
|
-
],
|
|
407
|
-
purpose: "retrieval",
|
|
408
|
-
});
|
|
409
|
-
|
|
410
|
-
// Handle the result
|
|
411
|
-
console.log(result);
|
|
412
|
-
}
|
|
413
|
-
|
|
414
|
-
run();
|
|
415
|
-
```
|
|
416
|
-
|
|
417
|
-
### Standalone function
|
|
418
|
-
|
|
419
|
-
The standalone function version of this method:
|
|
420
|
-
|
|
421
|
-
```typescript
|
|
422
|
-
import { OrqCore } from "@orq-ai/node/core.js";
|
|
423
|
-
import { filesBulkUpload } from "@orq-ai/node/funcs/filesBulkUpload.js";
|
|
424
|
-
import { openAsBlob } from "node:fs";
|
|
425
|
-
|
|
426
|
-
// Use `OrqCore` for best tree-shaking performance.
|
|
427
|
-
// You can create one instance of it to use across an application.
|
|
428
|
-
const orq = new OrqCore({
|
|
429
|
-
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
430
|
-
});
|
|
431
|
-
|
|
432
|
-
async function run() {
|
|
433
|
-
const res = await filesBulkUpload(orq, {
|
|
434
|
-
files: [
|
|
435
|
-
{
|
|
436
|
-
fileName: "example.file",
|
|
437
|
-
content: await openAsBlob("example.file"),
|
|
438
|
-
},
|
|
439
|
-
],
|
|
440
|
-
purpose: "retrieval",
|
|
441
|
-
});
|
|
442
|
-
|
|
443
|
-
if (!res.ok) {
|
|
444
|
-
throw res.error;
|
|
445
|
-
}
|
|
446
|
-
|
|
447
|
-
const { value: result } = res;
|
|
448
|
-
|
|
449
|
-
// Handle the result
|
|
450
|
-
console.log(result);
|
|
451
|
-
}
|
|
452
|
-
|
|
453
|
-
run();
|
|
454
|
-
```
|
|
455
|
-
|
|
456
|
-
### Parameters
|
|
457
|
-
|
|
458
|
-
| Parameter | Type | Required | Description |
|
|
459
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
460
|
-
| `request` | [operations.BulkFileUploadRequestBody](../../models/operations/bulkfileuploadrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
461
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
462
|
-
| `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. |
|
|
463
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
464
|
-
|
|
465
|
-
### Response
|
|
466
|
-
|
|
467
|
-
**Promise\<[operations.ResponseBody[]](../../models/.md)\>**
|
|
468
|
-
|
|
469
|
-
### Errors
|
|
470
|
-
|
|
471
303
|
| Error Type | Status Code | Content Type |
|
|
472
304
|
| --------------- | --------------- | --------------- |
|
|
473
305
|
| errors.APIError | 4XX, 5XX | \*/\* |
|