@orq-ai/node 3.1.0-rc.7 → 3.1.0
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 +31 -38
- package/docs/sdks/deployments/README.md +25 -138
- package/docs/sdks/files/README.md +2 -174
- package/docs/sdks/orq/README.md +1 -1
- package/docs/sdks/prompts/README.md +154 -79
- package/docs/sdks/promptsnippets/README.md +488 -0
- package/funcs/deploymentsInvoke.d.ts +1 -7
- package/funcs/deploymentsInvoke.d.ts.map +1 -1
- package/funcs/deploymentsInvoke.js +10 -11
- package/funcs/deploymentsInvoke.js.map +1 -1
- package/funcs/deploymentsStream.d.ts +16 -0
- package/funcs/deploymentsStream.d.ts.map +1 -0
- package/funcs/{deploymentsGetLogs.js → deploymentsStream.js} +30 -18
- package/funcs/deploymentsStream.js.map +1 -0
- package/funcs/{promptSnippetsFindOne.d.ts → promptSnippetsCreate.d.ts} +3 -3
- package/funcs/promptSnippetsCreate.d.ts.map +1 -0
- package/funcs/{promptsGetAll.js → promptSnippetsCreate.js} +8 -8
- package/funcs/promptSnippetsCreate.js.map +1 -0
- package/funcs/{promptsGetOne.d.ts → promptSnippetsDelete.d.ts} +3 -3
- package/funcs/{promptsCreateVersion.d.ts.map → promptSnippetsDelete.d.ts.map} +1 -1
- package/funcs/{promptsGetOne.js → promptSnippetsDelete.js} +8 -8
- 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} +6 -6
- package/funcs/promptSnippetsGet.js.map +1 -0
- package/funcs/{filesUpdate.d.ts → promptSnippetsGetByKey.d.ts} +3 -3
- package/funcs/promptSnippetsGetByKey.d.ts.map +1 -0
- package/funcs/promptSnippetsGetByKey.js +109 -0
- package/funcs/promptSnippetsGetByKey.js.map +1 -0
- package/funcs/{promptsCreateVersion.d.ts → promptSnippetsList.d.ts} +3 -3
- package/funcs/promptSnippetsList.d.ts.map +1 -0
- package/funcs/{promptTemplatesGetAll.js → promptSnippetsList.js} +13 -13
- package/funcs/promptSnippetsList.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} +14 -10
- package/funcs/promptSnippetsUpdate.js.map +1 -0
- package/funcs/promptsCreate.d.ts +1 -1
- package/funcs/promptsCreate.js +2 -2
- package/funcs/promptsCreate.js.map +1 -1
- package/funcs/promptsDelete.js +1 -1
- package/funcs/promptsDelete.js.map +1 -1
- package/funcs/promptsGetVersion.d.ts +16 -0
- package/funcs/promptsGetVersion.d.ts.map +1 -0
- package/funcs/{filesUpdate.js → promptsGetVersion.js} +22 -12
- package/funcs/promptsGetVersion.js.map +1 -0
- package/funcs/promptsList.d.ts +15 -0
- package/funcs/promptsList.d.ts.map +1 -0
- package/funcs/promptsList.js +112 -0
- package/funcs/promptsList.js.map +1 -0
- package/funcs/promptsListVersions.d.ts +15 -0
- package/funcs/promptsListVersions.d.ts.map +1 -0
- package/funcs/{deploymentsInvalidate.js → promptsListVersions.js} +18 -13
- package/funcs/promptsListVersions.js.map +1 -0
- package/funcs/{deploymentsInvalidate.d.ts → promptsRetrieve.d.ts} +4 -4
- package/funcs/promptsRetrieve.d.ts.map +1 -0
- package/funcs/{promptsDuplicate.js → promptsRetrieve.js} +12 -10
- package/funcs/promptsRetrieve.js.map +1 -0
- package/funcs/promptsUpdate.js +1 -1
- package/funcs/promptsUpdate.js.map +1 -1
- package/hooks/global.d.ts +5 -0
- package/hooks/global.d.ts.map +1 -0
- package/hooks/global.js +41 -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 +1 -1
- package/lib/config.d.ts +11 -3
- package/lib/config.d.ts.map +1 -1
- package/lib/config.js +3 -3
- package/lib/config.js.map +1 -1
- package/lib/env.d.ts +13 -0
- package/lib/env.d.ts.map +1 -1
- package/lib/env.js +17 -0
- package/lib/env.js.map +1 -1
- package/lib/retries.js +0 -1
- package/lib/retries.js.map +1 -1
- package/lib/sdks.js +1 -1
- package/lib/sdks.js.map +1 -1
- package/models/components/deployments.d.ts +0 -5
- package/models/components/deployments.d.ts.map +1 -1
- package/models/components/deployments.js +0 -2
- package/models/components/deployments.js.map +1 -1
- package/models/errors/getpromptversion.d.ts +36 -0
- package/models/errors/getpromptversion.d.ts.map +1 -0
- package/models/errors/getpromptversion.js +79 -0
- package/models/errors/getpromptversion.js.map +1 -0
- package/models/errors/index.d.ts +2 -0
- package/models/errors/index.d.ts.map +1 -1
- package/models/errors/index.js +2 -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/errors/updatepromptsnippet.js +79 -0
- package/models/errors/updatepromptsnippet.js.map +1 -0
- package/models/operations/createcontact.js +2 -2
- package/models/operations/createprompt.d.ts +690 -381
- package/models/operations/createprompt.d.ts.map +1 -1
- package/models/operations/createprompt.js +638 -482
- package/models/operations/createprompt.js.map +1 -1
- package/models/operations/createpromptsnippet.d.ts +3567 -0
- package/models/operations/createpromptsnippet.d.ts.map +1 -0
- package/models/operations/createpromptsnippet.js +3056 -0
- package/models/operations/createpromptsnippet.js.map +1 -0
- package/models/operations/deleteprompt.d.ts +1 -1
- package/models/operations/deletepromptsnippet.d.ts +32 -0
- package/models/operations/deletepromptsnippet.d.ts.map +1 -0
- package/models/operations/{duplicateprompt.js → deletepromptsnippet.js} +17 -17
- package/models/operations/deletepromptsnippet.js.map +1 -0
- package/models/operations/deploymentgetconfig.d.ts +39 -0
- package/models/operations/deploymentgetconfig.d.ts.map +1 -1
- package/models/operations/deploymentgetconfig.js +29 -4
- package/models/operations/deploymentgetconfig.js.map +1 -1
- package/models/operations/deploymentinvoke.d.ts +17 -683
- package/models/operations/deploymentinvoke.d.ts.map +1 -1
- package/models/operations/deploymentinvoke.js +21 -614
- package/models/operations/deploymentinvoke.js.map +1 -1
- package/models/operations/deployments.d.ts +39 -0
- package/models/operations/deployments.d.ts.map +1 -1
- package/models/operations/deployments.js +28 -3
- 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/fileget.js +2 -2
- package/models/operations/filelist.js +2 -2
- package/models/operations/fileupload.js +2 -2
- package/models/operations/findonebykeypromptsnippet.d.ts +2448 -0
- package/models/operations/findonebykeypromptsnippet.d.ts.map +1 -0
- package/models/operations/findonebykeypromptsnippet.js +2133 -0
- package/models/operations/findonebykeypromptsnippet.js.map +1 -0
- package/models/operations/findonepromptsnippet.d.ts +926 -4792
- package/models/operations/findonepromptsnippet.d.ts.map +1 -1
- package/models/operations/findonepromptsnippet.js +971 -4750
- package/models/operations/findonepromptsnippet.js.map +1 -1
- package/models/operations/getallprompts.d.ts +558 -9970
- package/models/operations/getallprompts.d.ts.map +1 -1
- package/models/operations/getallprompts.js +554 -8812
- package/models/operations/getallprompts.js.map +1 -1
- package/models/operations/getallpromptsnippets.d.ts +2512 -0
- package/models/operations/getallpromptsnippets.d.ts.map +1 -0
- package/models/operations/getallpromptsnippets.js +2195 -0
- package/models/operations/getallpromptsnippets.js.map +1 -0
- package/models/operations/getoneprompt.d.ts +1203 -1
- package/models/operations/getoneprompt.d.ts.map +1 -1
- package/models/operations/getoneprompt.js +1011 -1
- package/models/operations/getoneprompt.js.map +1 -1
- package/models/operations/getpromptversion.d.ts +1228 -0
- package/models/operations/getpromptversion.d.ts.map +1 -0
- package/models/operations/getpromptversion.js +1080 -0
- package/models/operations/getpromptversion.js.map +1 -0
- package/models/operations/index.d.ts +8 -7
- package/models/operations/index.d.ts.map +1 -1
- package/models/operations/index.js +8 -7
- package/models/operations/index.js.map +1 -1
- package/models/operations/listpromptversions.d.ts +1286 -0
- package/models/operations/listpromptversions.d.ts.map +1 -0
- package/models/operations/listpromptversions.js +1142 -0
- package/models/operations/listpromptversions.js.map +1 -0
- package/models/operations/updateprompt.d.ts +1101 -6001
- package/models/operations/updateprompt.d.ts.map +1 -1
- package/models/operations/updateprompt.js +1115 -5739
- package/models/operations/updateprompt.js.map +1 -1
- package/models/operations/updatepromptsnippet.d.ts +3595 -0
- package/models/operations/updatepromptsnippet.d.ts.map +1 -0
- package/models/operations/updatepromptsnippet.js +3116 -0
- package/models/operations/updatepromptsnippet.js.map +1 -0
- package/package.json +7 -9
- package/packages/orq-rc/FUNCTIONS.md +106 -0
- package/packages/orq-rc/README.md +559 -0
- package/packages/orq-rc/RUNTIMES.md +48 -0
- package/{docs/sdks/snippets → packages/orq-rc/docs/sdks/contacts}/README.md +12 -12
- package/packages/orq-rc/docs/sdks/deployments/README.md +316 -0
- package/packages/orq-rc/docs/sdks/feedback/README.md +92 -0
- package/packages/orq-rc/docs/sdks/files/README.md +305 -0
- package/packages/orq-rc/docs/sdks/metrics/README.md +86 -0
- package/packages/orq-rc/docs/sdks/orq/README.md +10 -0
- package/packages/orq-rc/docs/sdks/prompts/README.md +608 -0
- package/packages/orq-rc/docs/sdks/promptsnippets/README.md +534 -0
- package/{docs/sdks/templates → packages/orq-rc/docs/sdks/remoteconfig}/README.md +10 -10
- package/packages/orq-rc/jsr.json +28 -0
- package/packages/orq-rc/package-lock.json +1861 -0
- package/packages/orq-rc/package.json +31 -0
- package/packages/orq-rc/src/core.ts +13 -0
- package/packages/orq-rc/src/funcs/contactsCreate.ts +126 -0
- package/{src/funcs/deploymentsGetLogs.ts → packages/orq-rc/src/funcs/deploymentsGetConfig.ts} +20 -19
- package/packages/orq-rc/src/funcs/deploymentsInvoke.ts +142 -0
- package/packages/orq-rc/src/funcs/deploymentsList.ts +141 -0
- package/{src/funcs/promptsCreateVersion.ts → packages/orq-rc/src/funcs/deploymentsMetricsCreate.ts} +14 -11
- package/packages/orq-rc/src/funcs/deploymentsStream.ts +150 -0
- package/packages/orq-rc/src/funcs/feedbackCreate.ts +126 -0
- package/packages/orq-rc/src/funcs/filesDelete.ts +130 -0
- package/{src/funcs/filesUpdate.ts → packages/orq-rc/src/funcs/filesGet.ts} +11 -12
- package/packages/orq-rc/src/funcs/filesList.ts +131 -0
- package/{src/funcs/filesBulkUpload.ts → packages/orq-rc/src/funcs/filesUpload.ts} +32 -12
- package/packages/orq-rc/src/funcs/promptSnippetsCreate.ts +128 -0
- package/{src/funcs/promptsDuplicate.ts → packages/orq-rc/src/funcs/promptSnippetsDelete.ts} +8 -7
- package/{src/funcs/promptSnippetsFindOne.ts → packages/orq-rc/src/funcs/promptSnippetsGet.ts} +4 -4
- package/packages/orq-rc/src/funcs/promptSnippetsGetByKey.ts +132 -0
- package/{src/funcs/promptTemplatesGetAll.ts → packages/orq-rc/src/funcs/promptSnippetsList.ts} +16 -16
- package/packages/orq-rc/src/funcs/promptSnippetsUpdate.ts +139 -0
- package/{src/funcs/promptsGetAll.ts → packages/orq-rc/src/funcs/promptsCreate.ts} +9 -11
- package/{src/funcs/promptsGetOne.ts → packages/orq-rc/src/funcs/promptsDelete.ts} +7 -7
- package/packages/orq-rc/src/funcs/promptsGetVersion.ts +146 -0
- package/packages/orq-rc/src/funcs/promptsList.ts +133 -0
- package/packages/orq-rc/src/funcs/promptsListVersions.ts +139 -0
- package/packages/orq-rc/src/funcs/promptsRetrieve.ts +132 -0
- package/packages/orq-rc/src/funcs/promptsUpdate.ts +138 -0
- package/packages/orq-rc/src/funcs/remoteconfigGetConfig.ts +127 -0
- package/packages/orq-rc/src/hooks/global.ts +44 -0
- package/packages/orq-rc/src/hooks/hooks.ts +132 -0
- package/packages/orq-rc/src/hooks/index.ts +6 -0
- package/packages/orq-rc/src/hooks/registration.ts +15 -0
- package/packages/orq-rc/src/hooks/types.ts +109 -0
- package/packages/orq-rc/src/index.ts +7 -0
- package/packages/orq-rc/src/lib/base64.ts +37 -0
- package/packages/orq-rc/src/lib/config.ts +70 -0
- package/packages/orq-rc/src/lib/dlv.ts +53 -0
- package/packages/orq-rc/src/lib/encodings.ts +483 -0
- package/packages/orq-rc/src/lib/env.ts +73 -0
- package/packages/orq-rc/src/lib/event-streams.ts +264 -0
- package/packages/orq-rc/src/lib/files.ts +40 -0
- package/packages/orq-rc/src/lib/http.ts +323 -0
- package/packages/orq-rc/src/lib/is-plain-object.ts +43 -0
- package/packages/orq-rc/src/lib/logger.ts +9 -0
- package/packages/orq-rc/src/lib/matchers.ts +325 -0
- package/packages/orq-rc/src/lib/primitives.ts +136 -0
- package/packages/orq-rc/src/lib/retries.ts +218 -0
- package/packages/orq-rc/src/lib/schemas.ts +91 -0
- package/packages/orq-rc/src/lib/sdks.ts +400 -0
- package/packages/orq-rc/src/lib/security.ts +254 -0
- package/packages/orq-rc/src/lib/url.ts +33 -0
- package/packages/orq-rc/src/models/components/deployments.ts +1666 -0
- package/packages/orq-rc/src/models/components/index.ts +6 -0
- package/packages/orq-rc/src/models/components/security.ts +71 -0
- package/packages/orq-rc/src/models/errors/apierror.ts +27 -0
- package/packages/orq-rc/src/models/errors/getpromptversion.ts +71 -0
- package/packages/orq-rc/src/models/errors/honoapierror.ts +82 -0
- package/packages/orq-rc/src/models/errors/httpclienterrors.ts +62 -0
- package/packages/orq-rc/src/models/errors/index.ts +11 -0
- package/packages/orq-rc/src/models/errors/sdkvalidationerror.ts +97 -0
- package/packages/orq-rc/src/models/errors/updateprompt.ts +71 -0
- package/packages/orq-rc/src/models/errors/updatepromptsnippet.ts +71 -0
- package/packages/orq-rc/src/models/operations/createcontact.ts +256 -0
- package/packages/orq-rc/src/models/operations/createfeedback.ts +286 -0
- package/packages/orq-rc/src/models/operations/createprompt.ts +3819 -0
- package/packages/orq-rc/src/models/operations/createpromptsnippet.ts +6239 -0
- package/packages/orq-rc/src/models/operations/deleteprompt.ts +69 -0
- package/packages/orq-rc/src/models/operations/deletepromptsnippet.ts +69 -0
- package/packages/orq-rc/src/models/operations/deploymentcreatemetric.ts +1790 -0
- package/packages/orq-rc/src/models/operations/deploymentgetconfig.ts +3527 -0
- package/packages/orq-rc/src/models/operations/deploymentinvoke.ts +1144 -0
- package/packages/orq-rc/src/models/operations/deployments.ts +2148 -0
- package/packages/orq-rc/src/models/operations/deploymentstream.ts +3062 -0
- package/packages/orq-rc/src/models/operations/filedelete.ts +78 -0
- package/packages/orq-rc/src/models/operations/fileget.ts +222 -0
- package/packages/orq-rc/src/models/operations/filelist.ts +321 -0
- package/packages/orq-rc/src/models/operations/fileupload.ts +322 -0
- package/packages/orq-rc/src/models/operations/findonebykeypromptsnippet.ts +4483 -0
- package/packages/orq-rc/src/models/operations/findonepromptsnippet.ts +4343 -0
- package/packages/orq-rc/src/models/operations/getallprompts.ts +2116 -0
- package/packages/orq-rc/src/models/operations/getallpromptsnippets.ts +4472 -0
- package/packages/orq-rc/src/models/operations/getoneprompt.ts +1982 -0
- package/packages/orq-rc/src/models/operations/getpromptversion.ts +2012 -0
- package/packages/orq-rc/src/models/operations/index.ts +29 -0
- package/packages/orq-rc/src/models/operations/listpromptversions.ts +2146 -0
- package/packages/orq-rc/src/models/operations/remoteconfigsgetconfig.ts +190 -0
- package/packages/orq-rc/src/models/operations/updateprompt.ts +3917 -0
- package/packages/orq-rc/src/models/operations/updatepromptsnippet.ts +6544 -0
- package/packages/orq-rc/src/sdk/contacts.ts +27 -0
- package/packages/orq-rc/src/sdk/deployments.ts +89 -0
- package/packages/orq-rc/src/sdk/feedback.ts +27 -0
- package/packages/orq-rc/src/sdk/files.ts +72 -0
- package/packages/orq-rc/src/sdk/index.ts +5 -0
- package/packages/orq-rc/src/sdk/metrics.ts +27 -0
- package/packages/orq-rc/src/sdk/prompts.ts +126 -0
- package/packages/orq-rc/src/sdk/promptsnippets.ts +99 -0
- package/packages/orq-rc/src/sdk/remoteconfig.ts +24 -0
- package/packages/orq-rc/src/sdk/sdk.ts +49 -0
- package/packages/orq-rc/src/types/blobs.ts +31 -0
- package/packages/orq-rc/src/types/constdatetime.ts +15 -0
- package/packages/orq-rc/src/types/enums.ts +16 -0
- package/packages/orq-rc/src/types/fp.ts +50 -0
- package/packages/orq-rc/src/types/index.ts +11 -0
- package/packages/orq-rc/src/types/operations.ts +105 -0
- package/packages/orq-rc/src/types/rfcdate.ts +54 -0
- package/packages/orq-rc/src/types/streams.ts +21 -0
- package/packages/orq-rc/tsconfig.json +41 -0
- package/sdk/deployments.d.ts +5 -15
- package/sdk/deployments.d.ts.map +1 -1
- package/sdk/deployments.js +6 -18
- 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 +26 -14
- package/sdk/prompts.d.ts.map +1 -1
- package/sdk/prompts.js +37 -25
- package/sdk/prompts.js.map +1 -1
- package/sdk/promptsnippets.d.ts +29 -0
- package/sdk/promptsnippets.d.ts.map +1 -0
- package/sdk/promptsnippets.js +54 -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 +3 -3
- package/sdk/sdk.js.map +1 -1
- package/src/funcs/deploymentsInvoke.ts +21 -16
- package/src/funcs/deploymentsStream.ts +150 -0
- package/src/funcs/promptSnippetsCreate.ts +128 -0
- package/src/funcs/{deploymentsInvalidate.ts → promptSnippetsDelete.ts} +9 -13
- package/src/funcs/promptSnippetsGet.ts +130 -0
- package/src/funcs/promptSnippetsGetByKey.ts +132 -0
- package/src/funcs/promptSnippetsList.ts +132 -0
- package/src/funcs/promptSnippetsUpdate.ts +139 -0
- package/src/funcs/promptsCreate.ts +2 -2
- package/src/funcs/promptsDelete.ts +1 -1
- package/src/funcs/promptsGetVersion.ts +146 -0
- package/src/funcs/promptsList.ts +133 -0
- package/src/funcs/promptsListVersions.ts +139 -0
- package/src/funcs/promptsRetrieve.ts +132 -0
- package/src/funcs/promptsUpdate.ts +1 -1
- package/src/hooks/global.ts +44 -0
- package/src/hooks/registration.ts +2 -1
- package/src/lib/config.ts +13 -3
- package/src/lib/env.ts +32 -0
- package/src/lib/retries.ts +0 -1
- package/src/lib/sdks.ts +2 -2
- package/src/models/components/deployments.ts +0 -7
- package/src/models/errors/getpromptversion.ts +71 -0
- package/src/models/errors/index.ts +2 -0
- package/src/models/errors/updatepromptsnippet.ts +71 -0
- package/src/models/operations/createcontact.ts +2 -2
- package/src/models/operations/createprompt.ts +1045 -691
- package/src/models/operations/createpromptsnippet.ts +6239 -0
- package/src/models/operations/deleteprompt.ts +1 -1
- package/src/models/operations/deletepromptsnippet.ts +69 -0
- package/src/models/operations/deploymentgetconfig.ts +44 -0
- package/src/models/operations/deploymentinvoke.ts +180 -1423
- package/src/models/operations/deployments.ts +43 -0
- package/src/models/operations/deploymentstream.ts +3062 -0
- package/src/models/operations/fileget.ts +2 -2
- package/src/models/operations/filelist.ts +2 -2
- package/src/models/operations/fileupload.ts +2 -2
- package/src/models/operations/findonebykeypromptsnippet.ts +4483 -0
- package/src/models/operations/findonepromptsnippet.ts +1811 -11109
- package/src/models/operations/getallprompts.ts +1294 -18123
- package/src/models/operations/getallpromptsnippets.ts +4472 -0
- package/src/models/operations/getoneprompt.ts +1914 -1
- package/src/models/operations/getpromptversion.ts +2012 -0
- package/src/models/operations/index.ts +8 -7
- package/src/models/operations/listpromptversions.ts +2146 -0
- package/src/models/operations/updateprompt.ts +1999 -12503
- package/src/models/operations/updatepromptsnippet.ts +6544 -0
- package/src/sdk/deployments.ts +11 -33
- package/src/sdk/files.ts +0 -33
- package/src/sdk/prompts.ts +51 -39
- package/src/sdk/promptsnippets.ts +99 -0
- package/src/sdk/sdk.ts +4 -4
- package/docs/sdks/prompt/README.md +0 -6
- package/funcs/deploymentsGetLogs.d.ts +0 -15
- package/funcs/deploymentsGetLogs.d.ts.map +0 -1
- package/funcs/deploymentsGetLogs.js.map +0 -1
- package/funcs/deploymentsInvalidate.d.ts.map +0 -1
- package/funcs/deploymentsInvalidate.js.map +0 -1
- package/funcs/filesBulkUpload.d.ts +0 -15
- package/funcs/filesBulkUpload.d.ts.map +0 -1
- package/funcs/filesBulkUpload.js +0 -109
- package/funcs/filesBulkUpload.js.map +0 -1
- package/funcs/filesUpdate.d.ts.map +0 -1
- 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.map +0 -1
- package/funcs/promptsCreateVersion.js.map +0 -1
- package/funcs/promptsDuplicate.d.ts +0 -12
- 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 -2015
- package/models/operations/createpromptversion.d.ts.map +0 -1
- package/models/operations/createpromptversion.js +0 -1856
- package/models/operations/createpromptversion.js.map +0 -1
- package/models/operations/deploymentgetlogs.d.ts +0 -52406
- package/models/operations/deploymentgetlogs.d.ts.map +0 -1
- package/models/operations/deploymentgetlogs.js +0 -53803
- package/models/operations/deploymentgetlogs.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 -6643
- package/models/operations/getallprompttemplates.d.ts.map +0 -1
- package/models/operations/getallprompttemplates.js +0 -6234
- package/models/operations/getallprompttemplates.js.map +0 -1
- package/models/operations/invaliddeployment.d.ts +0 -29
- package/models/operations/invaliddeployment.d.ts.map +0 -1
- package/models/operations/invaliddeployment.js +0 -78
- package/models/operations/invaliddeployment.js.map +0 -1
- package/sdk/prompt.d.ts +0 -10
- package/sdk/prompt.d.ts.map +0 -1
- package/sdk/prompt.js +0 -19
- 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/models/operations/bulkfileupload.ts +0 -315
- package/src/models/operations/createpromptversion.ts +0 -3707
- package/src/models/operations/deploymentgetlogs.ts +0 -119430
- package/src/models/operations/duplicateprompt.ts +0 -69
- package/src/models/operations/fileupdate.ts +0 -298
- package/src/models/operations/getallprompttemplates.ts +0 -13779
- package/src/models/operations/invaliddeployment.ts +0 -75
- package/src/sdk/prompt.ts +0 -19
- package/src/sdk/snippets.ts +0 -24
- package/src/sdk/templates.ts +0 -24
|
@@ -0,0 +1,488 @@
|
|
|
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 | \*/\* |
|
|
@@ -6,17 +6,11 @@ import { ConnectionError, InvalidRequestError, RequestAbortedError, RequestTimeo
|
|
|
6
6
|
import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
|
|
7
7
|
import * as operations from "../models/operations/index.js";
|
|
8
8
|
import { Result } from "../types/fp.js";
|
|
9
|
-
export declare enum InvokeAcceptEnum {
|
|
10
|
-
applicationJson = "application/json",
|
|
11
|
-
textEventStream = "text/event-stream"
|
|
12
|
-
}
|
|
13
9
|
/**
|
|
14
10
|
* Invoke
|
|
15
11
|
*
|
|
16
12
|
* @remarks
|
|
17
13
|
* Invoke a deployment with a given payload
|
|
18
14
|
*/
|
|
19
|
-
export declare function deploymentsInvoke(client: OrqCore, request: components.Deployments, options?: RequestOptions
|
|
20
|
-
acceptHeaderOverride?: InvokeAcceptEnum;
|
|
21
|
-
}): Promise<Result<operations.DeploymentInvokeResponse | undefined, APIError | SDKValidationError | UnexpectedClientError | InvalidRequestError | RequestAbortedError | RequestTimeoutError | ConnectionError>>;
|
|
15
|
+
export declare function deploymentsInvoke(client: OrqCore, request: components.Deployments, options?: RequestOptions): Promise<Result<operations.DeploymentInvokeResponseBody | undefined, APIError | SDKValidationError | UnexpectedClientError | InvalidRequestError | RequestAbortedError | RequestTimeoutError | ConnectionError>>;
|
|
22
16
|
//# sourceMappingURL=deploymentsInvoke.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"deploymentsInvoke.d.ts","sourceRoot":"","sources":["../src/funcs/deploymentsInvoke.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAKrC,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAGhD,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,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
|
|
1
|
+
{"version":3,"file":"deploymentsInvoke.d.ts","sourceRoot":"","sources":["../src/funcs/deploymentsInvoke.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAKrC,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAGhD,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,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;;;;;GAKG;AACH,wBAAsB,iBAAiB,CACrC,MAAM,EAAE,OAAO,EACf,OAAO,EAAE,UAAU,CAAC,WAAW,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CACR,MAAM,CACJ,UAAU,CAAC,4BAA4B,GAAG,SAAS,EACjD,QAAQ,GACR,kBAAkB,GAClB,qBAAqB,GACrB,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,eAAe,CAClB,CACF,CA+FA"}
|
|
@@ -36,7 +36,6 @@ var __importStar = (this && this.__importStar) || (function () {
|
|
|
36
36
|
};
|
|
37
37
|
})();
|
|
38
38
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
39
|
-
exports.InvokeAcceptEnum = void 0;
|
|
40
39
|
exports.deploymentsInvoke = deploymentsInvoke;
|
|
41
40
|
const encodings_js_1 = require("../lib/encodings.js");
|
|
42
41
|
const M = __importStar(require("../lib/matchers.js"));
|
|
@@ -46,11 +45,6 @@ const security_js_1 = require("../lib/security.js");
|
|
|
46
45
|
const url_js_1 = require("../lib/url.js");
|
|
47
46
|
const components = __importStar(require("../models/components/index.js"));
|
|
48
47
|
const operations = __importStar(require("../models/operations/index.js"));
|
|
49
|
-
var InvokeAcceptEnum;
|
|
50
|
-
(function (InvokeAcceptEnum) {
|
|
51
|
-
InvokeAcceptEnum["applicationJson"] = "application/json";
|
|
52
|
-
InvokeAcceptEnum["textEventStream"] = "text/event-stream";
|
|
53
|
-
})(InvokeAcceptEnum || (exports.InvokeAcceptEnum = InvokeAcceptEnum = {}));
|
|
54
48
|
/**
|
|
55
49
|
* Invoke
|
|
56
50
|
*
|
|
@@ -67,8 +61,15 @@ async function deploymentsInvoke(client, request, options) {
|
|
|
67
61
|
const path = (0, url_js_1.pathToFunc)("/v2/deployments/invoke")();
|
|
68
62
|
const headers = new Headers((0, primitives_js_1.compactMap)({
|
|
69
63
|
"Content-Type": "application/json",
|
|
70
|
-
Accept:
|
|
71
|
-
|
|
64
|
+
Accept: "application/json",
|
|
65
|
+
"contactId": (0, encodings_js_1.encodeSimple)("contactId", client._options.contactId, {
|
|
66
|
+
explode: false,
|
|
67
|
+
charEncoding: "none",
|
|
68
|
+
}),
|
|
69
|
+
"environment": (0, encodings_js_1.encodeSimple)("environment", client._options.environment, {
|
|
70
|
+
explode: false,
|
|
71
|
+
charEncoding: "none",
|
|
72
|
+
}),
|
|
72
73
|
}));
|
|
73
74
|
const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey);
|
|
74
75
|
const securityInput = secConfig == null ? {} : { apiKey: secConfig };
|
|
@@ -106,9 +107,7 @@ async function deploymentsInvoke(client, request, options) {
|
|
|
106
107
|
return doResult;
|
|
107
108
|
}
|
|
108
109
|
const response = doResult.value;
|
|
109
|
-
const [result] = await M.match(M.json(200, operations.
|
|
110
|
-
sseSentinel: "[DONE]",
|
|
111
|
-
}), M.nil(204, operations.DeploymentInvokeResponse$inboundSchema.optional()), M.fail("4XX"), M.fail("5XX"))(response);
|
|
110
|
+
const [result] = await M.match(M.json(200, operations.DeploymentInvokeResponseBody$inboundSchema.optional()), M.nil(204, operations.DeploymentInvokeResponseBody$inboundSchema.optional()), M.fail("4XX"), M.fail("5XX"))(response);
|
|
112
111
|
if (!result.ok) {
|
|
113
112
|
return result;
|
|
114
113
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"deploymentsInvoke.js","sourceRoot":"","sources":["../src/funcs/deploymentsInvoke.ts"],"names":[],"mappings":";AAAA;;GAEG
|
|
1
|
+
{"version":3,"file":"deploymentsInvoke.js","sourceRoot":"","sources":["../src/funcs/deploymentsInvoke.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA6BH,8CA8GC;AAxID,sDAA+D;AAC/D,sDAAwC;AACxC,wDAAkD;AAClD,kDAA8C;AAE9C,oDAA4E;AAC5E,0CAA2C;AAC3C,0EAA4D;AAU5D,0EAA4D;AAG5D;;;;;GAKG;AACI,KAAK,UAAU,iBAAiB,CACrC,MAAe,EACf,OAA+B,EAC/B,OAAwB;IAaxB,MAAM,MAAM,GAAG,IAAA,sBAAS,EACtB,OAAO,EACP,CAAC,KAAK,EAAE,EAAE,CAAC,UAAU,CAAC,0BAA0B,CAAC,KAAK,CAAC,KAAK,CAAC,EAC7D,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,IAAA,yBAAU,EAAC,MAAM,EAAE,OAAO,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;IAE5D,MAAM,IAAI,GAAG,IAAA,mBAAU,EAAC,wBAAwB,CAAC,EAAE,CAAC;IAEpD,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,IAAA,0BAAU,EAAC;QACrC,cAAc,EAAE,kBAAkB;QAClC,MAAM,EAAE,kBAAkB;QAC1B,WAAW,EAAE,IAAA,2BAAY,EAAC,WAAW,EAAE,MAAM,CAAC,QAAQ,CAAC,SAAS,EAAE;YAChE,OAAO,EAAE,KAAK;YACd,YAAY,EAAE,MAAM;SACrB,CAAC;QACF,aAAa,EAAE,IAAA,2BAAY,EAAC,aAAa,EAAE,MAAM,CAAC,QAAQ,CAAC,WAAW,EAAE;YACtE,OAAO,EAAE,KAAK;YACd,YAAY,EAAE,MAAM;SACrB,CAAC;KACH,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,kBAAkB;QAC/B,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,CACJ,GAAG,EACH,UAAU,CAAC,0CAA0C,CAAC,QAAQ,EAAE,CACjE,EACD,CAAC,CAAC,GAAG,CACH,GAAG,EACH,UAAU,CAAC,0CAA0C,CAAC,QAAQ,EAAE,CACjE,EACD,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"}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import { OrqCore } from "../core.js";
|
|
2
|
+
import { EventStream } from "../lib/event-streams.js";
|
|
3
|
+
import { RequestOptions } from "../lib/sdks.js";
|
|
4
|
+
import { APIError } from "../models/errors/apierror.js";
|
|
5
|
+
import { ConnectionError, InvalidRequestError, RequestAbortedError, RequestTimeoutError, UnexpectedClientError } from "../models/errors/httpclienterrors.js";
|
|
6
|
+
import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
|
|
7
|
+
import * as operations from "../models/operations/index.js";
|
|
8
|
+
import { Result } from "../types/fp.js";
|
|
9
|
+
/**
|
|
10
|
+
* Stream
|
|
11
|
+
*
|
|
12
|
+
* @remarks
|
|
13
|
+
* Stream deployment generation. Only supported for completions and chat completions.
|
|
14
|
+
*/
|
|
15
|
+
export declare function deploymentsStream(client: OrqCore, request: operations.DeploymentStreamRequestBody, options?: RequestOptions): Promise<Result<EventStream<operations.DeploymentStreamResponseBody>, APIError | SDKValidationError | UnexpectedClientError | InvalidRequestError | RequestAbortedError | RequestTimeoutError | ConnectionError>>;
|
|
16
|
+
//# sourceMappingURL=deploymentsStream.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"deploymentsStream.d.ts","sourceRoot":"","sources":["../src/funcs/deploymentsStream.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAErC,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAItD,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;;;;;GAKG;AACH,wBAAsB,iBAAiB,CACrC,MAAM,EAAE,OAAO,EACf,OAAO,EAAE,UAAU,CAAC,2BAA2B,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CACR,MAAM,CACJ,WAAW,CAAC,UAAU,CAAC,4BAA4B,CAAC,EAClD,QAAQ,GACR,kBAAkB,GAClB,qBAAqB,GACrB,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,eAAe,CAClB,CACF,CAsGA"}
|