@orq-ai/node 3.8.0-rc.8 → 3.8.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/FUNCTIONS.md +19 -3
- package/README.md +165 -91
- package/bin/mcp-server.js +930 -2272
- package/bin/mcp-server.js.map +67 -73
- package/docs/sdks/contacts/README.md +30 -2
- package/docs/sdks/knowledge/README.md +1 -1
- package/docs/sdks/orq/README.md +0 -138
- package/funcs/filesCreate.d.ts.map +1 -1
- package/funcs/filesCreate.js +7 -3
- package/funcs/filesCreate.js.map +1 -1
- package/funcs/knowledgeCreateChunks.d.ts +1 -1
- package/funcs/knowledgeCreateChunks.d.ts.map +1 -1
- package/funcs/knowledgeCreateChunks.js +1 -1
- package/funcs/knowledgeCreateChunks.js.map +1 -1
- package/jsr.json +1 -1
- package/lib/config.d.ts +3 -3
- package/lib/config.js +3 -3
- package/lib/config.js.map +1 -1
- package/lib/files.d.ts +5 -0
- package/lib/files.d.ts.map +1 -1
- package/lib/files.js +41 -0
- package/lib/files.js.map +1 -1
- package/lib/security.d.ts +2 -2
- package/lib/security.d.ts.map +1 -1
- package/mcp-server/mcp-server.js +1 -1
- package/mcp-server/mcp-server.js.map +1 -1
- package/mcp-server/server.d.ts.map +1 -1
- package/mcp-server/server.js +1 -5
- package/mcp-server/server.js.map +1 -1
- package/models/components/deployments.d.ts +12 -12
- package/models/components/deployments.d.ts.map +1 -1
- package/models/components/deployments.js +12 -12
- package/models/components/deployments.js.map +1 -1
- package/models/operations/createchunk.d.ts +28 -28
- package/models/operations/createchunk.d.ts.map +1 -1
- package/models/operations/createchunk.js +33 -35
- package/models/operations/createchunk.js.map +1 -1
- package/models/operations/createcontact.js +2 -2
- package/models/operations/createdataset.js +2 -2
- package/models/operations/createdatasetitem.d.ts +12 -12
- package/models/operations/createdatasetitem.d.ts.map +1 -1
- package/models/operations/createdatasetitem.js +14 -14
- package/models/operations/createdatasetitem.js.map +1 -1
- package/models/operations/createdatasource.js +2 -2
- package/models/operations/createeval.d.ts +36 -36
- package/models/operations/createeval.d.ts.map +1 -1
- package/models/operations/createeval.js +56 -56
- package/models/operations/createeval.js.map +1 -1
- package/models/operations/createfeedback.d.ts +8 -8
- package/models/operations/createfeedback.d.ts.map +1 -1
- package/models/operations/createfeedback.js +8 -8
- package/models/operations/createfeedback.js.map +1 -1
- package/models/operations/createprompt.d.ts +18 -18
- package/models/operations/createprompt.d.ts.map +1 -1
- package/models/operations/createprompt.js +18 -18
- package/models/operations/createprompt.js.map +1 -1
- package/models/operations/deploymentcreatemetric.d.ts +12 -12
- package/models/operations/deploymentcreatemetric.d.ts.map +1 -1
- package/models/operations/deploymentcreatemetric.js +12 -12
- package/models/operations/deploymentcreatemetric.js.map +1 -1
- package/models/operations/deploymentgetconfig.d.ts +33 -33
- package/models/operations/deploymentgetconfig.d.ts.map +1 -1
- package/models/operations/deploymentgetconfig.js +36 -36
- package/models/operations/deploymentgetconfig.js.map +1 -1
- package/models/operations/deploymentinvoke.d.ts +4 -4
- package/models/operations/deploymentinvoke.js +8 -8
- package/models/operations/deployments.d.ts +6 -6
- package/models/operations/deployments.d.ts.map +1 -1
- package/models/operations/deployments.js +6 -6
- package/models/operations/deployments.js.map +1 -1
- package/models/operations/deploymentstream.d.ts +16 -16
- package/models/operations/deploymentstream.d.ts.map +1 -1
- package/models/operations/deploymentstream.js +16 -16
- package/models/operations/deploymentstream.js.map +1 -1
- package/models/operations/evalsageappropriate.d.ts +2 -2
- package/models/operations/evalsageappropriate.js +2 -2
- package/models/operations/evalsfactcheckingknowledgebase.d.ts +2 -2
- package/models/operations/evalsfactcheckingknowledgebase.js +2 -2
- package/models/operations/evalsgrammar.d.ts +2 -2
- package/models/operations/evalsgrammar.js +2 -2
- package/models/operations/evalslocalization.d.ts +2 -2
- package/models/operations/evalslocalization.js +2 -2
- package/models/operations/evalspii.d.ts +2 -2
- package/models/operations/evalspii.js +2 -2
- package/models/operations/evalsragascoherence.d.ts +2 -2
- package/models/operations/evalsragascoherence.js +2 -2
- package/models/operations/evalsragasconciseness.d.ts +2 -2
- package/models/operations/evalsragasconciseness.js +2 -2
- package/models/operations/evalsragascontextprecision.d.ts +2 -2
- package/models/operations/evalsragascontextprecision.js +2 -2
- package/models/operations/evalsragascorrectness.d.ts +2 -2
- package/models/operations/evalsragascorrectness.js +2 -2
- package/models/operations/evalsragasfaithfulness.d.ts +2 -2
- package/models/operations/evalsragasfaithfulness.js +2 -2
- package/models/operations/evalsragasharmfulness.d.ts +2 -2
- package/models/operations/evalsragasharmfulness.js +2 -2
- package/models/operations/evalsragasmaliciousness.d.ts +2 -2
- package/models/operations/evalsragasmaliciousness.js +2 -2
- package/models/operations/evalsragasresponserelevancy.d.ts +2 -2
- package/models/operations/evalsragasresponserelevancy.js +2 -2
- package/models/operations/evalssentimentclassification.d.ts +2 -2
- package/models/operations/evalssentimentclassification.js +2 -2
- package/models/operations/evalssummarization.d.ts +2 -2
- package/models/operations/evalssummarization.js +2 -2
- package/models/operations/evalstoneofvoice.d.ts +2 -2
- package/models/operations/evalstoneofvoice.js +2 -2
- package/models/operations/evalstranslation.d.ts +2 -2
- package/models/operations/evalstranslation.js +2 -2
- package/models/operations/fileget.js +2 -2
- package/models/operations/filelist.js +2 -2
- package/models/operations/fileupload.js +2 -2
- package/models/operations/getallprompts.d.ts +10 -10
- package/models/operations/getallprompts.d.ts.map +1 -1
- package/models/operations/getallprompts.js +10 -10
- package/models/operations/getallprompts.js.map +1 -1
- package/models/operations/getevals.d.ts +88 -88
- package/models/operations/getevals.d.ts.map +1 -1
- package/models/operations/getevals.js +187 -182
- package/models/operations/getevals.js.map +1 -1
- package/models/operations/getoneprompt.d.ts +10 -10
- package/models/operations/getoneprompt.d.ts.map +1 -1
- package/models/operations/getoneprompt.js +10 -10
- package/models/operations/getoneprompt.js.map +1 -1
- package/models/operations/getpromptversion.d.ts +10 -10
- package/models/operations/getpromptversion.d.ts.map +1 -1
- package/models/operations/getpromptversion.js +10 -10
- package/models/operations/getpromptversion.js.map +1 -1
- package/models/operations/index.d.ts +0 -2
- package/models/operations/index.d.ts.map +1 -1
- package/models/operations/index.js +0 -2
- package/models/operations/index.js.map +1 -1
- package/models/operations/invokeeval.d.ts +108 -108
- package/models/operations/invokeeval.d.ts.map +1 -1
- package/models/operations/invokeeval.js +141 -144
- package/models/operations/invokeeval.js.map +1 -1
- package/models/operations/listcontacts.js +2 -2
- package/models/operations/listdatasetdatapoints.d.ts +6 -6
- package/models/operations/listdatasetdatapoints.d.ts.map +1 -1
- package/models/operations/listdatasetdatapoints.js +8 -8
- package/models/operations/listdatasetdatapoints.js.map +1 -1
- package/models/operations/listdatasets.js +2 -2
- package/models/operations/listdatasources.js +2 -2
- package/models/operations/listpromptversions.d.ts +10 -10
- package/models/operations/listpromptversions.d.ts.map +1 -1
- package/models/operations/listpromptversions.js +10 -10
- package/models/operations/listpromptversions.js.map +1 -1
- package/models/operations/retrievecontact.js +2 -2
- package/models/operations/retrievedatapoint.d.ts +6 -6
- package/models/operations/retrievedatapoint.d.ts.map +1 -1
- package/models/operations/retrievedatapoint.js +8 -8
- package/models/operations/retrievedatapoint.js.map +1 -1
- package/models/operations/retrievedataset.js +2 -2
- package/models/operations/retrievedatasource.js +2 -2
- package/models/operations/updatecontact.js +2 -2
- package/models/operations/updatedatapoint.d.ts +12 -12
- package/models/operations/updatedatapoint.d.ts.map +1 -1
- package/models/operations/updatedatapoint.js +14 -14
- package/models/operations/updatedatapoint.js.map +1 -1
- package/models/operations/updatedataset.js +2 -2
- package/models/operations/updatedatasource.js +2 -2
- package/models/operations/updateeval.d.ts +38 -38
- package/models/operations/updateeval.d.ts.map +1 -1
- package/models/operations/updateeval.js +60 -60
- package/models/operations/updateeval.js.map +1 -1
- package/models/operations/updateprompt.d.ts +27 -86
- package/models/operations/updateprompt.d.ts.map +1 -1
- package/models/operations/updateprompt.js +39 -64
- package/models/operations/updateprompt.js.map +1 -1
- package/package.json +2 -3
- package/packages/orq-rc/FUNCTIONS.md +103 -0
- package/packages/orq-rc/README.md +947 -0
- package/packages/orq-rc/RUNTIMES.md +48 -0
- package/packages/orq-rc/docs/sdks/contacts/README.md +445 -0
- package/packages/orq-rc/docs/sdks/datasets/README.md +908 -0
- package/packages/orq-rc/docs/sdks/deployments/README.md +395 -0
- package/packages/orq-rc/docs/sdks/evals/README.md +2822 -0
- package/packages/orq-rc/docs/sdks/feedback/README.md +88 -0
- package/packages/orq-rc/docs/sdks/files/README.md +297 -0
- package/packages/orq-rc/docs/sdks/knowledge/README.md +1227 -0
- package/packages/orq-rc/docs/sdks/metrics/README.md +82 -0
- package/packages/orq-rc/docs/sdks/models/README.md +75 -0
- package/packages/orq-rc/docs/sdks/orq/README.md +10 -0
- package/packages/orq-rc/docs/sdks/prompts/README.md +550 -0
- package/packages/orq-rc/docs/sdks/remoteconfigs/README.md +76 -0
- package/packages/orq-rc/jsr.json +28 -0
- package/packages/orq-rc/package-lock.json +3217 -0
- package/packages/orq-rc/package.json +45 -0
- package/packages/orq-rc/src/core.ts +13 -0
- package/{src/funcs/postV2ModelsLitellmImport.ts → packages/orq-rc/src/funcs/contactsCreate.ts} +14 -16
- package/packages/orq-rc/src/funcs/contactsDelete.ts +176 -0
- package/packages/orq-rc/src/funcs/contactsList.ts +169 -0
- package/packages/orq-rc/src/funcs/contactsRetrieve.ts +175 -0
- package/packages/orq-rc/src/funcs/contactsUpdate.ts +176 -0
- package/packages/orq-rc/src/funcs/datasetsClear.ts +167 -0
- package/packages/orq-rc/src/funcs/datasetsCreate.ts +165 -0
- package/packages/orq-rc/src/funcs/datasetsCreateDatapoint.ts +167 -0
- package/packages/orq-rc/src/funcs/datasetsCreateExperiment.ts +168 -0
- package/packages/orq-rc/src/funcs/datasetsDelete.ts +167 -0
- package/packages/orq-rc/src/funcs/datasetsDeleteDatapoint.ts +182 -0
- package/packages/orq-rc/src/funcs/datasetsList.ts +167 -0
- package/packages/orq-rc/src/funcs/datasetsListDatapoints.ts +174 -0
- package/packages/orq-rc/src/funcs/datasetsRetrieve.ts +175 -0
- package/packages/orq-rc/src/funcs/datasetsRetrieveDatapoint.ts +181 -0
- package/packages/orq-rc/src/funcs/datasetsUpdate.ts +176 -0
- package/packages/orq-rc/src/funcs/datasetsUpdateDatapoint.ts +179 -0
- package/packages/orq-rc/src/funcs/deploymentsCreateExperiment.ts +173 -0
- package/packages/orq-rc/src/funcs/deploymentsGetConfig.ts +168 -0
- package/packages/orq-rc/src/funcs/deploymentsInvoke.ts +176 -0
- package/packages/orq-rc/src/funcs/deploymentsList.ts +176 -0
- package/packages/orq-rc/src/funcs/deploymentsMetricsCreate.ts +168 -0
- package/packages/orq-rc/src/funcs/deploymentsStream.ts +184 -0
- package/packages/orq-rc/src/funcs/evalsAgeAppropriate.ts +175 -0
- package/packages/orq-rc/src/funcs/evalsAll.ts +173 -0
- package/packages/orq-rc/src/funcs/evalsBertScore.ts +175 -0
- package/packages/orq-rc/src/funcs/evalsBleuScore.ts +175 -0
- package/packages/orq-rc/src/funcs/evalsBotDetection.ts +175 -0
- package/packages/orq-rc/src/funcs/evalsContains.ts +175 -0
- package/packages/orq-rc/src/funcs/evalsContainsAll.ts +175 -0
- package/packages/orq-rc/src/funcs/evalsContainsAny.ts +175 -0
- package/packages/orq-rc/src/funcs/evalsContainsEmail.ts +175 -0
- package/packages/orq-rc/src/funcs/evalsContainsNone.ts +175 -0
- package/packages/orq-rc/src/funcs/evalsContainsUrl.ts +175 -0
- package/packages/orq-rc/src/funcs/evalsContainsValidLink.ts +177 -0
- package/packages/orq-rc/src/funcs/evalsCreate.ts +169 -0
- package/packages/orq-rc/src/funcs/evalsDelete.ts +173 -0
- package/packages/orq-rc/src/funcs/evalsEndsWith.ts +175 -0
- package/packages/orq-rc/src/funcs/evalsExactMatch.ts +175 -0
- package/packages/orq-rc/src/funcs/evalsFactCheckingKnowledgeBase.ts +183 -0
- package/packages/orq-rc/src/funcs/evalsGrammar.ts +173 -0
- package/packages/orq-rc/src/funcs/evalsInvoke.ts +177 -0
- package/packages/orq-rc/src/funcs/evalsLengthBetween.ts +175 -0
- package/packages/orq-rc/src/funcs/evalsLengthGreaterThan.ts +177 -0
- package/packages/orq-rc/src/funcs/evalsLengthLessThan.ts +175 -0
- package/packages/orq-rc/src/funcs/evalsLocalization.ts +175 -0
- package/packages/orq-rc/src/funcs/evalsPii.ts +173 -0
- package/packages/orq-rc/src/funcs/evalsRagasCoherence.ts +175 -0
- package/packages/orq-rc/src/funcs/evalsRagasConciseness.ts +174 -0
- package/packages/orq-rc/src/funcs/evalsRagasContextPrecision.ts +180 -0
- package/packages/orq-rc/src/funcs/evalsRagasCorrectness.ts +174 -0
- package/packages/orq-rc/src/funcs/evalsRagasFaithfulness.ts +177 -0
- package/packages/orq-rc/src/funcs/evalsRagasHarmfulness.ts +174 -0
- package/packages/orq-rc/src/funcs/evalsRagasMaliciousness.ts +177 -0
- package/packages/orq-rc/src/funcs/evalsRagasResponseRelevancy.ts +183 -0
- package/packages/orq-rc/src/funcs/evalsRagasSummarization.ts +177 -0
- package/packages/orq-rc/src/funcs/evalsSentimentClassification.ts +183 -0
- package/packages/orq-rc/src/funcs/evalsSummarization.ts +175 -0
- package/packages/orq-rc/src/funcs/evalsToneOfVoice.ts +175 -0
- package/packages/orq-rc/src/funcs/evalsTranslation.ts +175 -0
- package/packages/orq-rc/src/funcs/evalsUpdate.ts +173 -0
- package/packages/orq-rc/src/funcs/evalsValidJson.ts +175 -0
- package/packages/orq-rc/src/funcs/feedbackCreate.ts +160 -0
- package/packages/orq-rc/src/funcs/filesCreate.ts +187 -0
- package/packages/orq-rc/src/funcs/filesDelete.ts +164 -0
- package/packages/orq-rc/src/funcs/filesGet.ts +166 -0
- package/packages/orq-rc/src/funcs/filesList.ts +167 -0
- package/packages/orq-rc/src/funcs/knowledgeCreate.ts +158 -0
- package/packages/orq-rc/src/funcs/knowledgeCreateChunks.ts +171 -0
- package/packages/orq-rc/src/funcs/knowledgeCreateDatasource.ts +166 -0
- package/packages/orq-rc/src/funcs/knowledgeDelete.ts +167 -0
- package/packages/orq-rc/src/funcs/knowledgeDeleteChunk.ts +174 -0
- package/packages/orq-rc/src/funcs/knowledgeDeleteDatasource.ts +173 -0
- package/packages/orq-rc/src/funcs/knowledgeList.ts +169 -0
- package/packages/orq-rc/src/funcs/knowledgeListChunks.ts +178 -0
- package/packages/orq-rc/src/funcs/knowledgeListDatasources.ts +174 -0
- package/packages/orq-rc/src/funcs/knowledgeRetrieve.ts +166 -0
- package/packages/orq-rc/src/funcs/knowledgeRetrieveChunk.ts +173 -0
- package/packages/orq-rc/src/funcs/knowledgeRetrieveDatasource.ts +169 -0
- package/packages/orq-rc/src/funcs/knowledgeSearch.ts +167 -0
- package/packages/orq-rc/src/funcs/knowledgeUpdate.ts +164 -0
- package/packages/orq-rc/src/funcs/knowledgeUpdateChunk.ts +174 -0
- package/packages/orq-rc/src/funcs/knowledgeUpdateDatasource.ts +170 -0
- package/{src/funcs/getV2ModelsLitellmModels.ts → packages/orq-rc/src/funcs/modelsList.ts} +9 -10
- package/packages/orq-rc/src/funcs/promptsCreate.ts +160 -0
- package/packages/orq-rc/src/funcs/promptsDelete.ts +164 -0
- package/packages/orq-rc/src/funcs/promptsGetVersion.ts +181 -0
- package/packages/orq-rc/src/funcs/promptsList.ts +167 -0
- package/packages/orq-rc/src/funcs/promptsListVersions.ts +173 -0
- package/packages/orq-rc/src/funcs/promptsRetrieve.ts +166 -0
- package/packages/orq-rc/src/funcs/promptsUpdate.ts +173 -0
- package/packages/orq-rc/src/funcs/remoteconfigsRetrieve.ts +161 -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 +112 -0
- package/packages/orq-rc/src/index.ts +9 -0
- package/packages/orq-rc/src/lib/base64.ts +37 -0
- package/packages/orq-rc/src/lib/config.ts +74 -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 +82 -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 +348 -0
- package/packages/orq-rc/src/lib/primitives.ts +150 -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 +407 -0
- package/packages/orq-rc/src/lib/security.ts +261 -0
- package/packages/orq-rc/src/lib/url.ts +33 -0
- package/packages/orq-rc/src/mcp-server/cli/start/command.ts +125 -0
- package/packages/orq-rc/src/mcp-server/cli/start/impl.ts +140 -0
- package/packages/orq-rc/src/mcp-server/cli.ts +13 -0
- package/packages/orq-rc/src/mcp-server/console-logger.ts +71 -0
- package/packages/orq-rc/src/mcp-server/extensions.ts +17 -0
- package/packages/orq-rc/src/mcp-server/mcp-server.ts +26 -0
- package/packages/orq-rc/src/mcp-server/prompts.ts +117 -0
- package/packages/orq-rc/src/mcp-server/resources.ts +172 -0
- package/packages/orq-rc/src/mcp-server/scopes.ts +7 -0
- package/packages/orq-rc/src/mcp-server/server.ts +247 -0
- package/packages/orq-rc/src/mcp-server/shared.ts +75 -0
- package/packages/orq-rc/src/mcp-server/tools/contactsCreate.ts +37 -0
- package/packages/orq-rc/src/mcp-server/tools/contactsDelete.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/contactsList.ts +37 -0
- package/packages/orq-rc/src/mcp-server/tools/contactsRetrieve.ts +37 -0
- package/packages/orq-rc/src/mcp-server/tools/contactsUpdate.ts +37 -0
- package/packages/orq-rc/src/mcp-server/tools/datasetsClear.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/datasetsCreate.ts +37 -0
- package/packages/orq-rc/src/mcp-server/tools/datasetsCreateDatapoint.ts +37 -0
- package/packages/orq-rc/src/mcp-server/tools/datasetsCreateExperiment.ts +37 -0
- package/packages/orq-rc/src/mcp-server/tools/datasetsDelete.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/datasetsDeleteDatapoint.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/datasetsList.ts +37 -0
- package/packages/orq-rc/src/mcp-server/tools/datasetsListDatapoints.ts +37 -0
- package/packages/orq-rc/src/mcp-server/tools/datasetsRetrieve.ts +37 -0
- package/{src/mcp-server/tools/postV2ModelsLitellmImport.ts → packages/orq-rc/src/mcp-server/tools/datasetsRetrieveDatapoint.ts} +7 -8
- package/packages/orq-rc/src/mcp-server/tools/datasetsUpdate.ts +37 -0
- package/packages/orq-rc/src/mcp-server/tools/datasetsUpdateDatapoint.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/deploymentsCreateExperiment.ts +37 -0
- package/packages/orq-rc/src/mcp-server/tools/deploymentsGetConfig.ts +37 -0
- package/packages/orq-rc/src/mcp-server/tools/deploymentsInvoke.ts +37 -0
- package/packages/orq-rc/src/mcp-server/tools/deploymentsList.ts +37 -0
- package/packages/orq-rc/src/mcp-server/tools/deploymentsMetricsCreate.ts +37 -0
- package/packages/orq-rc/src/mcp-server/tools/deploymentsStream.ts +37 -0
- package/packages/orq-rc/src/mcp-server/tools/evalsAgeAppropriate.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/evalsAll.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/evalsBertScore.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/evalsBleuScore.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/evalsBotDetection.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/evalsContains.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/evalsContainsAll.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/evalsContainsAny.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/evalsContainsEmail.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/evalsContainsNone.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/evalsContainsUrl.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/evalsContainsValidLink.ts +36 -0
- package/packages/orq-rc/src/mcp-server/tools/evalsCreate.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/evalsDelete.ts +33 -0
- package/packages/orq-rc/src/mcp-server/tools/evalsEndsWith.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/evalsExactMatch.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/evalsFactCheckingKnowledgeBase.ts +37 -0
- package/packages/orq-rc/src/mcp-server/tools/evalsGrammar.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/evalsInvoke.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/evalsLengthBetween.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/evalsLengthGreaterThan.ts +36 -0
- package/packages/orq-rc/src/mcp-server/tools/evalsLengthLessThan.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/evalsLocalization.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/evalsPii.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/evalsRagasCoherence.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/evalsRagasConciseness.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/evalsRagasContextPrecision.ts +36 -0
- package/packages/orq-rc/src/mcp-server/tools/evalsRagasCorrectness.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/evalsRagasFaithfulness.ts +36 -0
- package/packages/orq-rc/src/mcp-server/tools/evalsRagasHarmfulness.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/evalsRagasMaliciousness.ts +36 -0
- package/packages/orq-rc/src/mcp-server/tools/evalsRagasResponseRelevancy.ts +36 -0
- package/packages/orq-rc/src/mcp-server/tools/evalsRagasSummarization.ts +36 -0
- package/packages/orq-rc/src/mcp-server/tools/evalsSentimentClassification.ts +36 -0
- package/packages/orq-rc/src/mcp-server/tools/evalsSummarization.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/evalsToneOfVoice.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/evalsTranslation.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/evalsUpdate.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/evalsValidJson.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/feedbackCreate.ts +37 -0
- package/packages/orq-rc/src/mcp-server/tools/filesCreate.ts +37 -0
- package/packages/orq-rc/src/mcp-server/tools/filesDelete.ts +33 -0
- package/packages/orq-rc/src/mcp-server/tools/filesGet.ts +37 -0
- package/packages/orq-rc/src/mcp-server/tools/filesList.ts +37 -0
- package/packages/orq-rc/src/mcp-server/tools/knowledgeCreate.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/knowledgeCreateChunks.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/knowledgeCreateDatasource.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/knowledgeDelete.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/knowledgeDeleteChunk.ts +33 -0
- package/packages/orq-rc/src/mcp-server/tools/knowledgeDeleteDatasource.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/knowledgeList.ts +37 -0
- package/packages/orq-rc/src/mcp-server/tools/knowledgeListChunks.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/knowledgeListDatasources.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/knowledgeRetrieve.ts +37 -0
- package/packages/orq-rc/src/mcp-server/tools/knowledgeRetrieveChunk.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/knowledgeRetrieveDatasource.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/knowledgeSearch.ts +37 -0
- package/packages/orq-rc/src/mcp-server/tools/knowledgeUpdate.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/knowledgeUpdateChunk.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/knowledgeUpdateDatasource.ts +35 -0
- package/{src/mcp-server/tools/getV2ModelsLitellmModels.ts → packages/orq-rc/src/mcp-server/tools/modelsList.ts} +6 -6
- package/packages/orq-rc/src/mcp-server/tools/promptsCreate.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/promptsDelete.ts +33 -0
- package/packages/orq-rc/src/mcp-server/tools/promptsGetVersion.ts +37 -0
- package/packages/orq-rc/src/mcp-server/tools/promptsList.ts +37 -0
- package/packages/orq-rc/src/mcp-server/tools/promptsListVersions.ts +37 -0
- package/packages/orq-rc/src/mcp-server/tools/promptsRetrieve.ts +37 -0
- package/packages/orq-rc/src/mcp-server/tools/promptsUpdate.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/remoteconfigsRetrieve.ts +36 -0
- package/packages/orq-rc/src/mcp-server/tools.ts +129 -0
- package/packages/orq-rc/src/models/components/deployments.ts +7289 -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 +34 -0
- package/packages/orq-rc/src/models/errors/createeval.ts +82 -0
- package/packages/orq-rc/src/models/errors/deletecontact.ts +91 -0
- package/packages/orq-rc/src/models/errors/deleteeval.ts +82 -0
- package/packages/orq-rc/src/models/errors/evalsageappropriate.ts +160 -0
- package/packages/orq-rc/src/models/errors/evalsbertscore.ts +158 -0
- package/packages/orq-rc/src/models/errors/evalsbleuscore.ts +158 -0
- package/packages/orq-rc/src/models/errors/evalsbotdetection.ts +159 -0
- package/packages/orq-rc/src/models/errors/evalscontains.ts +158 -0
- package/packages/orq-rc/src/models/errors/evalscontainsall.ts +159 -0
- package/packages/orq-rc/src/models/errors/evalscontainsany.ts +159 -0
- package/packages/orq-rc/src/models/errors/evalscontainsemail.ts +160 -0
- package/packages/orq-rc/src/models/errors/evalscontainsnone.ts +159 -0
- package/packages/orq-rc/src/models/errors/evalscontainsurl.ts +159 -0
- package/packages/orq-rc/src/models/errors/evalscontainsvalidlink.ts +161 -0
- package/packages/orq-rc/src/models/errors/evalsendswith.ts +158 -0
- package/packages/orq-rc/src/models/errors/evalsexactmatch.ts +158 -0
- package/packages/orq-rc/src/models/errors/evalsfactcheckingknowledgebase.ts +164 -0
- package/packages/orq-rc/src/models/errors/evalsgrammar.ts +158 -0
- package/packages/orq-rc/src/models/errors/evalslengthbetween.ts +160 -0
- package/packages/orq-rc/src/models/errors/evalslengthgreaterthan.ts +161 -0
- package/packages/orq-rc/src/models/errors/evalslengthlessthan.ts +160 -0
- package/packages/orq-rc/src/models/errors/evalslocalization.ts +159 -0
- package/packages/orq-rc/src/models/errors/evalspii.ts +158 -0
- package/packages/orq-rc/src/models/errors/evalsragascoherence.ts +160 -0
- package/packages/orq-rc/src/models/errors/evalsragasconciseness.ts +161 -0
- package/packages/orq-rc/src/models/errors/evalsragascontextprecision.ts +164 -0
- package/packages/orq-rc/src/models/errors/evalsragascorrectness.ts +161 -0
- package/packages/orq-rc/src/models/errors/evalsragasfaithfulness.ts +161 -0
- package/packages/orq-rc/src/models/errors/evalsragasharmfulness.ts +161 -0
- package/packages/orq-rc/src/models/errors/evalsragasmaliciousness.ts +162 -0
- package/packages/orq-rc/src/models/errors/evalsragasresponserelevancy.ts +164 -0
- package/packages/orq-rc/src/models/errors/evalsragassummarization.ts +162 -0
- package/packages/orq-rc/src/models/errors/evalssentimentclassification.ts +164 -0
- package/packages/orq-rc/src/models/errors/evalssummarization.ts +160 -0
- package/packages/orq-rc/src/models/errors/evalstoneofvoice.ts +159 -0
- package/packages/orq-rc/src/models/errors/evalstranslation.ts +159 -0
- package/packages/orq-rc/src/models/errors/evalsvalidjson.ts +158 -0
- package/packages/orq-rc/src/models/errors/getevals.ts +82 -0
- package/packages/orq-rc/src/models/errors/getpromptversion.ts +82 -0
- package/packages/orq-rc/src/models/errors/honoapierror.ts +92 -0
- package/packages/orq-rc/src/models/errors/httpclienterrors.ts +62 -0
- package/packages/orq-rc/src/models/errors/index.ts +53 -0
- package/packages/orq-rc/src/models/errors/invokeeval.ts +158 -0
- package/packages/orq-rc/src/models/errors/orqerror.ts +35 -0
- package/packages/orq-rc/src/models/errors/responsevalidationerror.ts +50 -0
- package/packages/orq-rc/src/models/errors/retrievecontact.ts +91 -0
- package/packages/orq-rc/src/models/errors/sdkvalidationerror.ts +109 -0
- package/packages/orq-rc/src/models/errors/updatecontact.ts +85 -0
- package/packages/orq-rc/src/models/errors/updateeval.ts +82 -0
- package/packages/orq-rc/src/models/errors/updateprompt.ts +82 -0
- package/packages/orq-rc/src/models/operations/cleardataset.ts +75 -0
- package/packages/orq-rc/src/models/operations/createchunk.ts +428 -0
- package/packages/orq-rc/src/models/operations/createcontact.ts +267 -0
- package/packages/orq-rc/src/models/operations/createdataset.ts +296 -0
- package/packages/orq-rc/src/models/operations/createdatasetexperiment.ts +307 -0
- package/packages/orq-rc/src/models/operations/createdatasetitem.ts +5222 -0
- package/packages/orq-rc/src/models/operations/createdatasource.ts +852 -0
- package/packages/orq-rc/src/models/operations/createdeploymentexperiment.ts +321 -0
- package/packages/orq-rc/src/models/operations/createeval.ts +3830 -0
- package/packages/orq-rc/src/models/operations/createfeedback.ts +286 -0
- package/packages/orq-rc/src/models/operations/createknowledge.ts +846 -0
- package/packages/orq-rc/src/models/operations/createprompt.ts +4081 -0
- package/packages/orq-rc/src/models/operations/deletechunk.ts +96 -0
- package/packages/orq-rc/src/models/operations/deletecontact.ts +69 -0
- package/packages/orq-rc/src/models/operations/deletedatapoint.ts +81 -0
- package/packages/orq-rc/src/models/operations/deletedataset.ts +75 -0
- package/packages/orq-rc/src/models/operations/deletedatasource.ts +87 -0
- package/packages/orq-rc/src/models/operations/deleteeval.ts +66 -0
- package/packages/orq-rc/src/models/operations/deleteknowledge.ts +78 -0
- package/packages/orq-rc/src/models/operations/deleteprompt.ts +69 -0
- package/packages/orq-rc/src/models/operations/deploymentcreatemetric.ts +5439 -0
- package/packages/orq-rc/src/models/operations/deploymentgetconfig.ts +9378 -0
- package/packages/orq-rc/src/models/operations/deploymentinvoke.ts +1256 -0
- package/packages/orq-rc/src/models/operations/deployments.ts +2327 -0
- package/packages/orq-rc/src/models/operations/deploymentstream.ts +9499 -0
- package/packages/orq-rc/src/models/operations/evalsageappropriate.ts +253 -0
- package/packages/orq-rc/src/models/operations/evalsbertscore.ts +197 -0
- package/packages/orq-rc/src/models/operations/evalsbleuscore.ts +131 -0
- package/packages/orq-rc/src/models/operations/evalsbotdetection.ts +249 -0
- package/packages/orq-rc/src/models/operations/evalscontains.ts +250 -0
- package/packages/orq-rc/src/models/operations/evalscontainsall.ts +248 -0
- package/packages/orq-rc/src/models/operations/evalscontainsany.ts +254 -0
- package/packages/orq-rc/src/models/operations/evalscontainsemail.ts +181 -0
- package/packages/orq-rc/src/models/operations/evalscontainsnone.ts +254 -0
- package/packages/orq-rc/src/models/operations/evalscontainsurl.ts +181 -0
- package/packages/orq-rc/src/models/operations/evalscontainsvalidlink.ts +186 -0
- package/packages/orq-rc/src/models/operations/evalsendswith.ts +250 -0
- package/packages/orq-rc/src/models/operations/evalsexactmatch.ts +183 -0
- package/packages/orq-rc/src/models/operations/evalsfactcheckingknowledgebase.ts +299 -0
- package/packages/orq-rc/src/models/operations/evalsgrammar.ts +243 -0
- package/packages/orq-rc/src/models/operations/evalslengthbetween.ts +268 -0
- package/packages/orq-rc/src/models/operations/evalslengthgreaterthan.ts +266 -0
- package/packages/orq-rc/src/models/operations/evalslengthlessthan.ts +259 -0
- package/packages/orq-rc/src/models/operations/evalslocalization.ts +253 -0
- package/packages/orq-rc/src/models/operations/evalspii.ts +243 -0
- package/packages/orq-rc/src/models/operations/evalsragascoherence.ts +152 -0
- package/packages/orq-rc/src/models/operations/evalsragasconciseness.ts +153 -0
- package/packages/orq-rc/src/models/operations/evalsragascontextprecision.ts +166 -0
- package/packages/orq-rc/src/models/operations/evalsragascorrectness.ts +153 -0
- package/packages/orq-rc/src/models/operations/evalsragasfaithfulness.ts +155 -0
- package/packages/orq-rc/src/models/operations/evalsragasharmfulness.ts +146 -0
- package/packages/orq-rc/src/models/operations/evalsragasmaliciousness.ts +157 -0
- package/packages/orq-rc/src/models/operations/evalsragasresponserelevancy.ts +165 -0
- package/packages/orq-rc/src/models/operations/evalsragassummarization.ts +150 -0
- package/packages/orq-rc/src/models/operations/evalssentimentclassification.ts +285 -0
- package/packages/orq-rc/src/models/operations/evalssummarization.ts +253 -0
- package/packages/orq-rc/src/models/operations/evalstoneofvoice.ts +251 -0
- package/packages/orq-rc/src/models/operations/evalstranslation.ts +251 -0
- package/packages/orq-rc/src/models/operations/evalsvalidjson.ts +177 -0
- package/packages/orq-rc/src/models/operations/filedelete.ts +78 -0
- package/packages/orq-rc/src/models/operations/fileget.ts +223 -0
- package/packages/orq-rc/src/models/operations/filelist.ts +337 -0
- package/packages/orq-rc/src/models/operations/fileupload.ts +327 -0
- package/packages/orq-rc/src/models/operations/getallprompts.ts +2295 -0
- package/packages/orq-rc/src/models/operations/getevals.ts +6162 -0
- package/packages/orq-rc/src/models/operations/getonechunk.ts +315 -0
- package/packages/orq-rc/src/models/operations/getoneknowledge.ts +537 -0
- package/packages/orq-rc/src/models/operations/getoneprompt.ts +2156 -0
- package/packages/orq-rc/src/models/operations/getpromptversion.ts +2161 -0
- package/packages/orq-rc/src/models/operations/index.ts +96 -0
- package/packages/orq-rc/src/models/operations/invokeeval.ts +2520 -0
- package/packages/orq-rc/src/models/operations/listchunks.ts +494 -0
- package/packages/orq-rc/src/models/operations/listcontacts.ts +490 -0
- package/packages/orq-rc/src/models/operations/listdatasetdatapoints.ts +2784 -0
- package/packages/orq-rc/src/models/operations/listdatasets.ts +406 -0
- package/packages/orq-rc/src/models/operations/listdatasources.ts +447 -0
- package/packages/orq-rc/src/models/operations/listknowledgebases.ts +663 -0
- package/packages/orq-rc/src/models/operations/listmodels.ts +273 -0
- package/packages/orq-rc/src/models/operations/listpromptversions.ts +2293 -0
- package/packages/orq-rc/src/models/operations/remoteconfigsgetconfig.ts +190 -0
- package/packages/orq-rc/src/models/operations/retrievecontact.ts +210 -0
- package/packages/orq-rc/src/models/operations/retrievedatapoint.ts +2586 -0
- package/packages/orq-rc/src/models/operations/retrievedataset.ts +288 -0
- package/packages/orq-rc/src/models/operations/retrievedatasource.ts +273 -0
- package/packages/orq-rc/src/models/operations/searchknowledge.ts +3367 -0
- package/packages/orq-rc/src/models/operations/updatechunk.ts +448 -0
- package/packages/orq-rc/src/models/operations/updatecontact.ts +325 -0
- package/packages/orq-rc/src/models/operations/updatedatapoint.ts +5155 -0
- package/packages/orq-rc/src/models/operations/updatedataset.ts +393 -0
- package/packages/orq-rc/src/models/operations/updatedatasource.ts +345 -0
- package/packages/orq-rc/src/models/operations/updateeval.ts +4131 -0
- package/packages/orq-rc/src/models/operations/updateknowledge.ts +980 -0
- package/packages/orq-rc/src/models/operations/updateprompt.ts +4218 -0
- package/packages/orq-rc/src/sdk/contacts.ts +99 -0
- package/packages/orq-rc/src/sdk/datasets.ts +222 -0
- package/packages/orq-rc/src/sdk/deployments.ts +107 -0
- package/packages/orq-rc/src/sdk/evals.ts +594 -0
- package/packages/orq-rc/src/sdk/feedback.ts +27 -0
- package/packages/orq-rc/src/sdk/files.ts +78 -0
- package/packages/orq-rc/src/sdk/index.ts +5 -0
- package/packages/orq-rc/src/sdk/knowledge.ts +264 -0
- package/packages/orq-rc/src/sdk/metrics.ts +27 -0
- package/packages/orq-rc/src/sdk/models.ts +25 -0
- package/packages/orq-rc/src/sdk/prompts.ts +126 -0
- package/packages/orq-rc/src/sdk/remoteconfigs.ts +24 -0
- package/packages/orq-rc/src/sdk/sdk.ts +67 -0
- package/packages/orq-rc/src/types/async.ts +68 -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/knowledge.d.ts +1 -1
- package/sdk/knowledge.d.ts.map +1 -1
- package/sdk/sdk.d.ts +1 -16
- package/sdk/sdk.d.ts.map +1 -1
- package/sdk/sdk.js +0 -21
- package/sdk/sdk.js.map +1 -1
- package/src/funcs/filesCreate.ts +11 -4
- package/src/funcs/knowledgeCreateChunks.ts +4 -4
- package/src/lib/config.ts +3 -3
- package/src/lib/files.ts +42 -0
- package/src/lib/security.ts +2 -2
- package/src/mcp-server/mcp-server.ts +1 -1
- package/src/mcp-server/server.ts +1 -5
- package/src/models/components/deployments.ts +24 -24
- package/src/models/operations/createchunk.ts +44 -54
- package/src/models/operations/createcontact.ts +2 -2
- package/src/models/operations/createdataset.ts +2 -2
- package/src/models/operations/createdatasetitem.ts +26 -26
- package/src/models/operations/createdatasource.ts +2 -2
- package/src/models/operations/createeval.ts +121 -121
- package/src/models/operations/createfeedback.ts +16 -16
- package/src/models/operations/createprompt.ts +39 -39
- package/src/models/operations/deploymentcreatemetric.ts +30 -26
- package/src/models/operations/deploymentgetconfig.ts +62 -68
- package/src/models/operations/deploymentinvoke.ts +13 -13
- package/src/models/operations/deployments.ts +14 -14
- package/src/models/operations/deploymentstream.ts +34 -34
- package/src/models/operations/evalsageappropriate.ts +4 -4
- package/src/models/operations/evalsfactcheckingknowledgebase.ts +4 -4
- package/src/models/operations/evalsgrammar.ts +4 -4
- package/src/models/operations/evalslocalization.ts +4 -4
- package/src/models/operations/evalspii.ts +4 -4
- package/src/models/operations/evalsragascoherence.ts +4 -4
- package/src/models/operations/evalsragasconciseness.ts +4 -4
- package/src/models/operations/evalsragascontextprecision.ts +4 -4
- package/src/models/operations/evalsragascorrectness.ts +4 -4
- package/src/models/operations/evalsragasfaithfulness.ts +4 -4
- package/src/models/operations/evalsragasharmfulness.ts +4 -4
- package/src/models/operations/evalsragasmaliciousness.ts +4 -4
- package/src/models/operations/evalsragasresponserelevancy.ts +4 -4
- package/src/models/operations/evalssentimentclassification.ts +4 -4
- package/src/models/operations/evalssummarization.ts +4 -4
- package/src/models/operations/evalstoneofvoice.ts +4 -4
- package/src/models/operations/evalstranslation.ts +4 -4
- 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/getallprompts.ts +22 -22
- package/src/models/operations/getevals.ts +339 -364
- package/src/models/operations/getoneprompt.ts +22 -22
- package/src/models/operations/getpromptversion.ts +22 -22
- package/src/models/operations/index.ts +0 -2
- package/src/models/operations/invokeeval.ts +251 -223
- package/src/models/operations/listcontacts.ts +2 -2
- package/src/models/operations/listdatasetdatapoints.ts +20 -16
- package/src/models/operations/listdatasets.ts +2 -2
- package/src/models/operations/listdatasources.ts +2 -2
- package/src/models/operations/listpromptversions.ts +22 -22
- package/src/models/operations/retrievecontact.ts +2 -2
- package/src/models/operations/retrievedatapoint.ts +14 -14
- package/src/models/operations/retrievedataset.ts +2 -2
- package/src/models/operations/retrievedatasource.ts +2 -2
- package/src/models/operations/updatecontact.ts +2 -2
- package/src/models/operations/updatedatapoint.ts +29 -27
- package/src/models/operations/updatedataset.ts +2 -2
- package/src/models/operations/updatedatasource.ts +2 -2
- package/src/models/operations/updateeval.ts +139 -139
- package/src/models/operations/updateprompt.ts +61 -106
- package/src/sdk/knowledge.ts +1 -1
- package/src/sdk/sdk.ts +1 -37
- package/src/types/constdatetime.ts +1 -1
- package/types/constdatetime.js +1 -1
- package/funcs/getV2ModelsLitellmModels.d.ts +0 -17
- package/funcs/getV2ModelsLitellmModels.d.ts.map +0 -1
- package/funcs/getV2ModelsLitellmModels.js +0 -105
- package/funcs/getV2ModelsLitellmModels.js.map +0 -1
- package/funcs/postV2ModelsLitellmImport.d.ts +0 -17
- package/funcs/postV2ModelsLitellmImport.d.ts.map +0 -1
- package/funcs/postV2ModelsLitellmImport.js +0 -117
- package/funcs/postV2ModelsLitellmImport.js.map +0 -1
- package/mcp-server/tools/getV2ModelsLitellmModels.d.ts +0 -3
- package/mcp-server/tools/getV2ModelsLitellmModels.d.ts.map +0 -1
- package/mcp-server/tools/getV2ModelsLitellmModels.js +0 -26
- package/mcp-server/tools/getV2ModelsLitellmModels.js.map +0 -1
- package/mcp-server/tools/postV2ModelsLitellmImport.d.ts +0 -9
- package/mcp-server/tools/postV2ModelsLitellmImport.d.ts.map +0 -1
- package/mcp-server/tools/postV2ModelsLitellmImport.js +0 -65
- package/mcp-server/tools/postV2ModelsLitellmImport.js.map +0 -1
- package/models/operations/getv2modelslitellmmodels.d.ts +0 -185
- package/models/operations/getv2modelslitellmmodels.d.ts.map +0 -1
- package/models/operations/getv2modelslitellmmodels.js +0 -349
- package/models/operations/getv2modelslitellmmodels.js.map +0 -1
- package/models/operations/postv2modelslitellmimport.d.ts +0 -1333
- package/models/operations/postv2modelslitellmimport.d.ts.map +0 -1
- package/models/operations/postv2modelslitellmimport.js +0 -1400
- package/models/operations/postv2modelslitellmimport.js.map +0 -1
- package/src/models/operations/getv2modelslitellmmodels.ts +0 -530
- package/src/models/operations/postv2modelslitellmimport.ts +0 -2408
|
@@ -0,0 +1,908 @@
|
|
|
1
|
+
# Datasets
|
|
2
|
+
(*datasets*)
|
|
3
|
+
|
|
4
|
+
## Overview
|
|
5
|
+
|
|
6
|
+
### Available Operations
|
|
7
|
+
|
|
8
|
+
* [list](#list) - List datasets
|
|
9
|
+
* [create](#create) - Create a dataset
|
|
10
|
+
* [retrieve](#retrieve) - Retrieve a dataset
|
|
11
|
+
* [update](#update) - Update a dataset
|
|
12
|
+
* [delete](#delete) - Delete a dataset
|
|
13
|
+
* [createExperiment](#createexperiment) - Create an experiment from a dataset
|
|
14
|
+
* [listDatapoints](#listdatapoints) - List datapoints
|
|
15
|
+
* [createDatapoint](#createdatapoint) - Create a datapoint
|
|
16
|
+
* [retrieveDatapoint](#retrievedatapoint) - Retrieve a datapoint
|
|
17
|
+
* [updateDatapoint](#updatedatapoint) - Update a datapoint
|
|
18
|
+
* [deleteDatapoint](#deletedatapoint) - Delete a datapoint
|
|
19
|
+
* [clear](#clear) - Delete all datapoints
|
|
20
|
+
|
|
21
|
+
## list
|
|
22
|
+
|
|
23
|
+
Retrieves a paginated list of datasets for the current workspace. Results can be paginated using cursor-based pagination.
|
|
24
|
+
|
|
25
|
+
### Example Usage
|
|
26
|
+
|
|
27
|
+
```typescript
|
|
28
|
+
import { Orq } from "@orq-ai/node";
|
|
29
|
+
|
|
30
|
+
const orq = new Orq({
|
|
31
|
+
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
32
|
+
});
|
|
33
|
+
|
|
34
|
+
async function run() {
|
|
35
|
+
const result = await orq.datasets.list({});
|
|
36
|
+
|
|
37
|
+
console.log(result);
|
|
38
|
+
}
|
|
39
|
+
|
|
40
|
+
run();
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
### Standalone function
|
|
44
|
+
|
|
45
|
+
The standalone function version of this method:
|
|
46
|
+
|
|
47
|
+
```typescript
|
|
48
|
+
import { OrqCore } from "@orq-ai/node/core.js";
|
|
49
|
+
import { datasetsList } from "@orq-ai/node/funcs/datasetsList.js";
|
|
50
|
+
|
|
51
|
+
// Use `OrqCore` for best tree-shaking performance.
|
|
52
|
+
// You can create one instance of it to use across an application.
|
|
53
|
+
const orq = new OrqCore({
|
|
54
|
+
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
55
|
+
});
|
|
56
|
+
|
|
57
|
+
async function run() {
|
|
58
|
+
const res = await datasetsList(orq, {});
|
|
59
|
+
if (res.ok) {
|
|
60
|
+
const { value: result } = res;
|
|
61
|
+
console.log(result);
|
|
62
|
+
} else {
|
|
63
|
+
console.log("datasetsList failed:", res.error);
|
|
64
|
+
}
|
|
65
|
+
}
|
|
66
|
+
|
|
67
|
+
run();
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
### Parameters
|
|
71
|
+
|
|
72
|
+
| Parameter | Type | Required | Description |
|
|
73
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
74
|
+
| `request` | [operations.ListDatasetsRequest](../../models/operations/listdatasetsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
75
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
76
|
+
| `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. |
|
|
77
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
78
|
+
|
|
79
|
+
### Response
|
|
80
|
+
|
|
81
|
+
**Promise\<[operations.ListDatasetsResponseBody](../../models/operations/listdatasetsresponsebody.md)\>**
|
|
82
|
+
|
|
83
|
+
### Errors
|
|
84
|
+
|
|
85
|
+
| Error Type | Status Code | Content Type |
|
|
86
|
+
| --------------- | --------------- | --------------- |
|
|
87
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
88
|
+
|
|
89
|
+
## create
|
|
90
|
+
|
|
91
|
+
Creates a new dataset in the specified project.
|
|
92
|
+
|
|
93
|
+
### Example Usage
|
|
94
|
+
|
|
95
|
+
```typescript
|
|
96
|
+
import { Orq } from "@orq-ai/node";
|
|
97
|
+
|
|
98
|
+
const orq = new Orq({
|
|
99
|
+
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
100
|
+
});
|
|
101
|
+
|
|
102
|
+
async function run() {
|
|
103
|
+
const result = await orq.datasets.create({
|
|
104
|
+
displayName: "Neva.Raynor10",
|
|
105
|
+
path: "Default",
|
|
106
|
+
});
|
|
107
|
+
|
|
108
|
+
console.log(result);
|
|
109
|
+
}
|
|
110
|
+
|
|
111
|
+
run();
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
### Standalone function
|
|
115
|
+
|
|
116
|
+
The standalone function version of this method:
|
|
117
|
+
|
|
118
|
+
```typescript
|
|
119
|
+
import { OrqCore } from "@orq-ai/node/core.js";
|
|
120
|
+
import { datasetsCreate } from "@orq-ai/node/funcs/datasetsCreate.js";
|
|
121
|
+
|
|
122
|
+
// Use `OrqCore` for best tree-shaking performance.
|
|
123
|
+
// You can create one instance of it to use across an application.
|
|
124
|
+
const orq = new OrqCore({
|
|
125
|
+
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
126
|
+
});
|
|
127
|
+
|
|
128
|
+
async function run() {
|
|
129
|
+
const res = await datasetsCreate(orq, {
|
|
130
|
+
displayName: "Neva.Raynor10",
|
|
131
|
+
path: "Default",
|
|
132
|
+
});
|
|
133
|
+
if (res.ok) {
|
|
134
|
+
const { value: result } = res;
|
|
135
|
+
console.log(result);
|
|
136
|
+
} else {
|
|
137
|
+
console.log("datasetsCreate failed:", res.error);
|
|
138
|
+
}
|
|
139
|
+
}
|
|
140
|
+
|
|
141
|
+
run();
|
|
142
|
+
```
|
|
143
|
+
|
|
144
|
+
### Parameters
|
|
145
|
+
|
|
146
|
+
| Parameter | Type | Required | Description |
|
|
147
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
148
|
+
| `request` | [operations.CreateDatasetRequestBody](../../models/operations/createdatasetrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
149
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
150
|
+
| `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. |
|
|
151
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
152
|
+
|
|
153
|
+
### Response
|
|
154
|
+
|
|
155
|
+
**Promise\<[operations.CreateDatasetResponseBody](../../models/operations/createdatasetresponsebody.md)\>**
|
|
156
|
+
|
|
157
|
+
### Errors
|
|
158
|
+
|
|
159
|
+
| Error Type | Status Code | Content Type |
|
|
160
|
+
| --------------- | --------------- | --------------- |
|
|
161
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
162
|
+
|
|
163
|
+
## retrieve
|
|
164
|
+
|
|
165
|
+
Retrieves a specific dataset by its unique identifier
|
|
166
|
+
|
|
167
|
+
### Example Usage
|
|
168
|
+
|
|
169
|
+
```typescript
|
|
170
|
+
import { Orq } from "@orq-ai/node";
|
|
171
|
+
|
|
172
|
+
const orq = new Orq({
|
|
173
|
+
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
174
|
+
});
|
|
175
|
+
|
|
176
|
+
async function run() {
|
|
177
|
+
const result = await orq.datasets.retrieve({
|
|
178
|
+
datasetId: "<id>",
|
|
179
|
+
});
|
|
180
|
+
|
|
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 { datasetsRetrieve } from "@orq-ai/node/funcs/datasetsRetrieve.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 datasetsRetrieve(orq, {
|
|
203
|
+
datasetId: "<id>",
|
|
204
|
+
});
|
|
205
|
+
if (res.ok) {
|
|
206
|
+
const { value: result } = res;
|
|
207
|
+
console.log(result);
|
|
208
|
+
} else {
|
|
209
|
+
console.log("datasetsRetrieve failed:", res.error);
|
|
210
|
+
}
|
|
211
|
+
}
|
|
212
|
+
|
|
213
|
+
run();
|
|
214
|
+
```
|
|
215
|
+
|
|
216
|
+
### Parameters
|
|
217
|
+
|
|
218
|
+
| Parameter | Type | Required | Description |
|
|
219
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
220
|
+
| `request` | [operations.RetrieveDatasetRequest](../../models/operations/retrievedatasetrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
221
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
222
|
+
| `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. |
|
|
223
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
224
|
+
|
|
225
|
+
### Response
|
|
226
|
+
|
|
227
|
+
**Promise\<[operations.RetrieveDatasetResponseBody](../../models/operations/retrievedatasetresponsebody.md)\>**
|
|
228
|
+
|
|
229
|
+
### Errors
|
|
230
|
+
|
|
231
|
+
| Error Type | Status Code | Content Type |
|
|
232
|
+
| ------------------- | ------------------- | ------------------- |
|
|
233
|
+
| errors.HonoApiError | 404 | application/json |
|
|
234
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
235
|
+
|
|
236
|
+
## update
|
|
237
|
+
|
|
238
|
+
Update a dataset
|
|
239
|
+
|
|
240
|
+
### Example Usage
|
|
241
|
+
|
|
242
|
+
```typescript
|
|
243
|
+
import { Orq } from "@orq-ai/node";
|
|
244
|
+
|
|
245
|
+
const orq = new Orq({
|
|
246
|
+
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
247
|
+
});
|
|
248
|
+
|
|
249
|
+
async function run() {
|
|
250
|
+
const result = await orq.datasets.update({
|
|
251
|
+
datasetId: "<id>",
|
|
252
|
+
requestBody: {
|
|
253
|
+
path: "Default",
|
|
254
|
+
},
|
|
255
|
+
});
|
|
256
|
+
|
|
257
|
+
console.log(result);
|
|
258
|
+
}
|
|
259
|
+
|
|
260
|
+
run();
|
|
261
|
+
```
|
|
262
|
+
|
|
263
|
+
### Standalone function
|
|
264
|
+
|
|
265
|
+
The standalone function version of this method:
|
|
266
|
+
|
|
267
|
+
```typescript
|
|
268
|
+
import { OrqCore } from "@orq-ai/node/core.js";
|
|
269
|
+
import { datasetsUpdate } from "@orq-ai/node/funcs/datasetsUpdate.js";
|
|
270
|
+
|
|
271
|
+
// Use `OrqCore` for best tree-shaking performance.
|
|
272
|
+
// You can create one instance of it to use across an application.
|
|
273
|
+
const orq = new OrqCore({
|
|
274
|
+
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
275
|
+
});
|
|
276
|
+
|
|
277
|
+
async function run() {
|
|
278
|
+
const res = await datasetsUpdate(orq, {
|
|
279
|
+
datasetId: "<id>",
|
|
280
|
+
requestBody: {
|
|
281
|
+
path: "Default",
|
|
282
|
+
},
|
|
283
|
+
});
|
|
284
|
+
if (res.ok) {
|
|
285
|
+
const { value: result } = res;
|
|
286
|
+
console.log(result);
|
|
287
|
+
} else {
|
|
288
|
+
console.log("datasetsUpdate failed:", res.error);
|
|
289
|
+
}
|
|
290
|
+
}
|
|
291
|
+
|
|
292
|
+
run();
|
|
293
|
+
```
|
|
294
|
+
|
|
295
|
+
### Parameters
|
|
296
|
+
|
|
297
|
+
| Parameter | Type | Required | Description |
|
|
298
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
299
|
+
| `request` | [operations.UpdateDatasetRequest](../../models/operations/updatedatasetrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
300
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
301
|
+
| `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. |
|
|
302
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
303
|
+
|
|
304
|
+
### Response
|
|
305
|
+
|
|
306
|
+
**Promise\<[operations.UpdateDatasetResponseBody](../../models/operations/updatedatasetresponsebody.md)\>**
|
|
307
|
+
|
|
308
|
+
### Errors
|
|
309
|
+
|
|
310
|
+
| Error Type | Status Code | Content Type |
|
|
311
|
+
| ------------------- | ------------------- | ------------------- |
|
|
312
|
+
| errors.HonoApiError | 404 | application/json |
|
|
313
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
314
|
+
|
|
315
|
+
## delete
|
|
316
|
+
|
|
317
|
+
Permanently deletes a dataset and all its datapoints. This action is irreversible.
|
|
318
|
+
|
|
319
|
+
### Example Usage
|
|
320
|
+
|
|
321
|
+
```typescript
|
|
322
|
+
import { Orq } from "@orq-ai/node";
|
|
323
|
+
|
|
324
|
+
const orq = new Orq({
|
|
325
|
+
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
326
|
+
});
|
|
327
|
+
|
|
328
|
+
async function run() {
|
|
329
|
+
await orq.datasets.delete({
|
|
330
|
+
datasetId: "<id>",
|
|
331
|
+
});
|
|
332
|
+
|
|
333
|
+
|
|
334
|
+
}
|
|
335
|
+
|
|
336
|
+
run();
|
|
337
|
+
```
|
|
338
|
+
|
|
339
|
+
### Standalone function
|
|
340
|
+
|
|
341
|
+
The standalone function version of this method:
|
|
342
|
+
|
|
343
|
+
```typescript
|
|
344
|
+
import { OrqCore } from "@orq-ai/node/core.js";
|
|
345
|
+
import { datasetsDelete } from "@orq-ai/node/funcs/datasetsDelete.js";
|
|
346
|
+
|
|
347
|
+
// Use `OrqCore` for best tree-shaking performance.
|
|
348
|
+
// You can create one instance of it to use across an application.
|
|
349
|
+
const orq = new OrqCore({
|
|
350
|
+
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
351
|
+
});
|
|
352
|
+
|
|
353
|
+
async function run() {
|
|
354
|
+
const res = await datasetsDelete(orq, {
|
|
355
|
+
datasetId: "<id>",
|
|
356
|
+
});
|
|
357
|
+
if (res.ok) {
|
|
358
|
+
const { value: result } = res;
|
|
359
|
+
|
|
360
|
+
} else {
|
|
361
|
+
console.log("datasetsDelete failed:", res.error);
|
|
362
|
+
}
|
|
363
|
+
}
|
|
364
|
+
|
|
365
|
+
run();
|
|
366
|
+
```
|
|
367
|
+
|
|
368
|
+
### Parameters
|
|
369
|
+
|
|
370
|
+
| Parameter | Type | Required | Description |
|
|
371
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
372
|
+
| `request` | [operations.DeleteDatasetRequest](../../models/operations/deletedatasetrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
373
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
374
|
+
| `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. |
|
|
375
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
376
|
+
|
|
377
|
+
### Response
|
|
378
|
+
|
|
379
|
+
**Promise\<void\>**
|
|
380
|
+
|
|
381
|
+
### Errors
|
|
382
|
+
|
|
383
|
+
| Error Type | Status Code | Content Type |
|
|
384
|
+
| --------------- | --------------- | --------------- |
|
|
385
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
386
|
+
|
|
387
|
+
## createExperiment
|
|
388
|
+
|
|
389
|
+
Create an experiment from a dataset
|
|
390
|
+
|
|
391
|
+
### Example Usage
|
|
392
|
+
|
|
393
|
+
```typescript
|
|
394
|
+
import { Orq } from "@orq-ai/node";
|
|
395
|
+
|
|
396
|
+
const orq = new Orq({
|
|
397
|
+
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
398
|
+
});
|
|
399
|
+
|
|
400
|
+
async function run() {
|
|
401
|
+
const result = await orq.datasets.createExperiment({
|
|
402
|
+
datasetId: "<id>",
|
|
403
|
+
requestBody: {
|
|
404
|
+
experimentKey: "<value>",
|
|
405
|
+
path: "Default/Experiments",
|
|
406
|
+
type: "dataset_experiment",
|
|
407
|
+
},
|
|
408
|
+
});
|
|
409
|
+
|
|
410
|
+
console.log(result);
|
|
411
|
+
}
|
|
412
|
+
|
|
413
|
+
run();
|
|
414
|
+
```
|
|
415
|
+
|
|
416
|
+
### Standalone function
|
|
417
|
+
|
|
418
|
+
The standalone function version of this method:
|
|
419
|
+
|
|
420
|
+
```typescript
|
|
421
|
+
import { OrqCore } from "@orq-ai/node/core.js";
|
|
422
|
+
import { datasetsCreateExperiment } from "@orq-ai/node/funcs/datasetsCreateExperiment.js";
|
|
423
|
+
|
|
424
|
+
// Use `OrqCore` for best tree-shaking performance.
|
|
425
|
+
// You can create one instance of it to use across an application.
|
|
426
|
+
const orq = new OrqCore({
|
|
427
|
+
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
428
|
+
});
|
|
429
|
+
|
|
430
|
+
async function run() {
|
|
431
|
+
const res = await datasetsCreateExperiment(orq, {
|
|
432
|
+
datasetId: "<id>",
|
|
433
|
+
requestBody: {
|
|
434
|
+
experimentKey: "<value>",
|
|
435
|
+
path: "Default/Experiments",
|
|
436
|
+
type: "dataset_experiment",
|
|
437
|
+
},
|
|
438
|
+
});
|
|
439
|
+
if (res.ok) {
|
|
440
|
+
const { value: result } = res;
|
|
441
|
+
console.log(result);
|
|
442
|
+
} else {
|
|
443
|
+
console.log("datasetsCreateExperiment failed:", res.error);
|
|
444
|
+
}
|
|
445
|
+
}
|
|
446
|
+
|
|
447
|
+
run();
|
|
448
|
+
```
|
|
449
|
+
|
|
450
|
+
### Parameters
|
|
451
|
+
|
|
452
|
+
| Parameter | Type | Required | Description |
|
|
453
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
454
|
+
| `request` | [operations.CreateDatasetExperimentRequest](../../models/operations/createdatasetexperimentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
455
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
456
|
+
| `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. |
|
|
457
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
458
|
+
|
|
459
|
+
### Response
|
|
460
|
+
|
|
461
|
+
**Promise\<[operations.CreateDatasetExperimentResponseBody](../../models/operations/createdatasetexperimentresponsebody.md)\>**
|
|
462
|
+
|
|
463
|
+
### Errors
|
|
464
|
+
|
|
465
|
+
| Error Type | Status Code | Content Type |
|
|
466
|
+
| --------------- | --------------- | --------------- |
|
|
467
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
468
|
+
|
|
469
|
+
## listDatapoints
|
|
470
|
+
|
|
471
|
+
Retrieves a paginated list of datapoints from a specific dataset.
|
|
472
|
+
|
|
473
|
+
### Example Usage
|
|
474
|
+
|
|
475
|
+
```typescript
|
|
476
|
+
import { Orq } from "@orq-ai/node";
|
|
477
|
+
|
|
478
|
+
const orq = new Orq({
|
|
479
|
+
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
480
|
+
});
|
|
481
|
+
|
|
482
|
+
async function run() {
|
|
483
|
+
const result = await orq.datasets.listDatapoints({
|
|
484
|
+
datasetId: "<id>",
|
|
485
|
+
});
|
|
486
|
+
|
|
487
|
+
console.log(result);
|
|
488
|
+
}
|
|
489
|
+
|
|
490
|
+
run();
|
|
491
|
+
```
|
|
492
|
+
|
|
493
|
+
### Standalone function
|
|
494
|
+
|
|
495
|
+
The standalone function version of this method:
|
|
496
|
+
|
|
497
|
+
```typescript
|
|
498
|
+
import { OrqCore } from "@orq-ai/node/core.js";
|
|
499
|
+
import { datasetsListDatapoints } from "@orq-ai/node/funcs/datasetsListDatapoints.js";
|
|
500
|
+
|
|
501
|
+
// Use `OrqCore` for best tree-shaking performance.
|
|
502
|
+
// You can create one instance of it to use across an application.
|
|
503
|
+
const orq = new OrqCore({
|
|
504
|
+
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
505
|
+
});
|
|
506
|
+
|
|
507
|
+
async function run() {
|
|
508
|
+
const res = await datasetsListDatapoints(orq, {
|
|
509
|
+
datasetId: "<id>",
|
|
510
|
+
});
|
|
511
|
+
if (res.ok) {
|
|
512
|
+
const { value: result } = res;
|
|
513
|
+
console.log(result);
|
|
514
|
+
} else {
|
|
515
|
+
console.log("datasetsListDatapoints failed:", res.error);
|
|
516
|
+
}
|
|
517
|
+
}
|
|
518
|
+
|
|
519
|
+
run();
|
|
520
|
+
```
|
|
521
|
+
|
|
522
|
+
### Parameters
|
|
523
|
+
|
|
524
|
+
| Parameter | Type | Required | Description |
|
|
525
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
526
|
+
| `request` | [operations.ListDatasetDatapointsRequest](../../models/operations/listdatasetdatapointsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
527
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
528
|
+
| `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. |
|
|
529
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
530
|
+
|
|
531
|
+
### Response
|
|
532
|
+
|
|
533
|
+
**Promise\<[operations.ListDatasetDatapointsResponseBody](../../models/operations/listdatasetdatapointsresponsebody.md)\>**
|
|
534
|
+
|
|
535
|
+
### Errors
|
|
536
|
+
|
|
537
|
+
| Error Type | Status Code | Content Type |
|
|
538
|
+
| --------------- | --------------- | --------------- |
|
|
539
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
540
|
+
|
|
541
|
+
## createDatapoint
|
|
542
|
+
|
|
543
|
+
Creates a new datapoint in the specified dataset.
|
|
544
|
+
|
|
545
|
+
### Example Usage
|
|
546
|
+
|
|
547
|
+
```typescript
|
|
548
|
+
import { Orq } from "@orq-ai/node";
|
|
549
|
+
|
|
550
|
+
const orq = new Orq({
|
|
551
|
+
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
552
|
+
});
|
|
553
|
+
|
|
554
|
+
async function run() {
|
|
555
|
+
const result = await orq.datasets.createDatapoint({
|
|
556
|
+
datasetId: "<id>",
|
|
557
|
+
});
|
|
558
|
+
|
|
559
|
+
console.log(result);
|
|
560
|
+
}
|
|
561
|
+
|
|
562
|
+
run();
|
|
563
|
+
```
|
|
564
|
+
|
|
565
|
+
### Standalone function
|
|
566
|
+
|
|
567
|
+
The standalone function version of this method:
|
|
568
|
+
|
|
569
|
+
```typescript
|
|
570
|
+
import { OrqCore } from "@orq-ai/node/core.js";
|
|
571
|
+
import { datasetsCreateDatapoint } from "@orq-ai/node/funcs/datasetsCreateDatapoint.js";
|
|
572
|
+
|
|
573
|
+
// Use `OrqCore` for best tree-shaking performance.
|
|
574
|
+
// You can create one instance of it to use across an application.
|
|
575
|
+
const orq = new OrqCore({
|
|
576
|
+
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
577
|
+
});
|
|
578
|
+
|
|
579
|
+
async function run() {
|
|
580
|
+
const res = await datasetsCreateDatapoint(orq, {
|
|
581
|
+
datasetId: "<id>",
|
|
582
|
+
});
|
|
583
|
+
if (res.ok) {
|
|
584
|
+
const { value: result } = res;
|
|
585
|
+
console.log(result);
|
|
586
|
+
} else {
|
|
587
|
+
console.log("datasetsCreateDatapoint failed:", res.error);
|
|
588
|
+
}
|
|
589
|
+
}
|
|
590
|
+
|
|
591
|
+
run();
|
|
592
|
+
```
|
|
593
|
+
|
|
594
|
+
### Parameters
|
|
595
|
+
|
|
596
|
+
| Parameter | Type | Required | Description |
|
|
597
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
598
|
+
| `request` | [operations.CreateDatasetItemRequest](../../models/operations/createdatasetitemrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
599
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
600
|
+
| `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. |
|
|
601
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
602
|
+
|
|
603
|
+
### Response
|
|
604
|
+
|
|
605
|
+
**Promise\<[operations.CreateDatasetItemResponseBody](../../models/operations/createdatasetitemresponsebody.md)\>**
|
|
606
|
+
|
|
607
|
+
### Errors
|
|
608
|
+
|
|
609
|
+
| Error Type | Status Code | Content Type |
|
|
610
|
+
| --------------- | --------------- | --------------- |
|
|
611
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
612
|
+
|
|
613
|
+
## retrieveDatapoint
|
|
614
|
+
|
|
615
|
+
Retrieves a datapoint object
|
|
616
|
+
|
|
617
|
+
### Example Usage
|
|
618
|
+
|
|
619
|
+
```typescript
|
|
620
|
+
import { Orq } from "@orq-ai/node";
|
|
621
|
+
|
|
622
|
+
const orq = new Orq({
|
|
623
|
+
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
624
|
+
});
|
|
625
|
+
|
|
626
|
+
async function run() {
|
|
627
|
+
const result = await orq.datasets.retrieveDatapoint({
|
|
628
|
+
datasetId: "<id>",
|
|
629
|
+
datapointId: "<id>",
|
|
630
|
+
});
|
|
631
|
+
|
|
632
|
+
console.log(result);
|
|
633
|
+
}
|
|
634
|
+
|
|
635
|
+
run();
|
|
636
|
+
```
|
|
637
|
+
|
|
638
|
+
### Standalone function
|
|
639
|
+
|
|
640
|
+
The standalone function version of this method:
|
|
641
|
+
|
|
642
|
+
```typescript
|
|
643
|
+
import { OrqCore } from "@orq-ai/node/core.js";
|
|
644
|
+
import { datasetsRetrieveDatapoint } from "@orq-ai/node/funcs/datasetsRetrieveDatapoint.js";
|
|
645
|
+
|
|
646
|
+
// Use `OrqCore` for best tree-shaking performance.
|
|
647
|
+
// You can create one instance of it to use across an application.
|
|
648
|
+
const orq = new OrqCore({
|
|
649
|
+
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
650
|
+
});
|
|
651
|
+
|
|
652
|
+
async function run() {
|
|
653
|
+
const res = await datasetsRetrieveDatapoint(orq, {
|
|
654
|
+
datasetId: "<id>",
|
|
655
|
+
datapointId: "<id>",
|
|
656
|
+
});
|
|
657
|
+
if (res.ok) {
|
|
658
|
+
const { value: result } = res;
|
|
659
|
+
console.log(result);
|
|
660
|
+
} else {
|
|
661
|
+
console.log("datasetsRetrieveDatapoint failed:", res.error);
|
|
662
|
+
}
|
|
663
|
+
}
|
|
664
|
+
|
|
665
|
+
run();
|
|
666
|
+
```
|
|
667
|
+
|
|
668
|
+
### Parameters
|
|
669
|
+
|
|
670
|
+
| Parameter | Type | Required | Description |
|
|
671
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
672
|
+
| `request` | [operations.RetrieveDatapointRequest](../../models/operations/retrievedatapointrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
673
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
674
|
+
| `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. |
|
|
675
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
676
|
+
|
|
677
|
+
### Response
|
|
678
|
+
|
|
679
|
+
**Promise\<[operations.RetrieveDatapointResponseBody](../../models/operations/retrievedatapointresponsebody.md)\>**
|
|
680
|
+
|
|
681
|
+
### Errors
|
|
682
|
+
|
|
683
|
+
| Error Type | Status Code | Content Type |
|
|
684
|
+
| ------------------- | ------------------- | ------------------- |
|
|
685
|
+
| errors.HonoApiError | 404 | application/json |
|
|
686
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
687
|
+
|
|
688
|
+
## updateDatapoint
|
|
689
|
+
|
|
690
|
+
Update a datapoint
|
|
691
|
+
|
|
692
|
+
### Example Usage
|
|
693
|
+
|
|
694
|
+
```typescript
|
|
695
|
+
import { Orq } from "@orq-ai/node";
|
|
696
|
+
|
|
697
|
+
const orq = new Orq({
|
|
698
|
+
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
699
|
+
});
|
|
700
|
+
|
|
701
|
+
async function run() {
|
|
702
|
+
const result = await orq.datasets.updateDatapoint({
|
|
703
|
+
datasetId: "<id>",
|
|
704
|
+
datapointId: "<id>",
|
|
705
|
+
});
|
|
706
|
+
|
|
707
|
+
console.log(result);
|
|
708
|
+
}
|
|
709
|
+
|
|
710
|
+
run();
|
|
711
|
+
```
|
|
712
|
+
|
|
713
|
+
### Standalone function
|
|
714
|
+
|
|
715
|
+
The standalone function version of this method:
|
|
716
|
+
|
|
717
|
+
```typescript
|
|
718
|
+
import { OrqCore } from "@orq-ai/node/core.js";
|
|
719
|
+
import { datasetsUpdateDatapoint } from "@orq-ai/node/funcs/datasetsUpdateDatapoint.js";
|
|
720
|
+
|
|
721
|
+
// Use `OrqCore` for best tree-shaking performance.
|
|
722
|
+
// You can create one instance of it to use across an application.
|
|
723
|
+
const orq = new OrqCore({
|
|
724
|
+
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
725
|
+
});
|
|
726
|
+
|
|
727
|
+
async function run() {
|
|
728
|
+
const res = await datasetsUpdateDatapoint(orq, {
|
|
729
|
+
datasetId: "<id>",
|
|
730
|
+
datapointId: "<id>",
|
|
731
|
+
});
|
|
732
|
+
if (res.ok) {
|
|
733
|
+
const { value: result } = res;
|
|
734
|
+
console.log(result);
|
|
735
|
+
} else {
|
|
736
|
+
console.log("datasetsUpdateDatapoint failed:", res.error);
|
|
737
|
+
}
|
|
738
|
+
}
|
|
739
|
+
|
|
740
|
+
run();
|
|
741
|
+
```
|
|
742
|
+
|
|
743
|
+
### Parameters
|
|
744
|
+
|
|
745
|
+
| Parameter | Type | Required | Description |
|
|
746
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
747
|
+
| `request` | [operations.UpdateDatapointRequest](../../models/operations/updatedatapointrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
748
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
749
|
+
| `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. |
|
|
750
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
751
|
+
|
|
752
|
+
### Response
|
|
753
|
+
|
|
754
|
+
**Promise\<[operations.UpdateDatapointResponseBody](../../models/operations/updatedatapointresponsebody.md)\>**
|
|
755
|
+
|
|
756
|
+
### Errors
|
|
757
|
+
|
|
758
|
+
| Error Type | Status Code | Content Type |
|
|
759
|
+
| ------------------- | ------------------- | ------------------- |
|
|
760
|
+
| errors.HonoApiError | 404 | application/json |
|
|
761
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
762
|
+
|
|
763
|
+
## deleteDatapoint
|
|
764
|
+
|
|
765
|
+
Permanently deletes a specific datapoint from a dataset.
|
|
766
|
+
|
|
767
|
+
### Example Usage
|
|
768
|
+
|
|
769
|
+
```typescript
|
|
770
|
+
import { Orq } from "@orq-ai/node";
|
|
771
|
+
|
|
772
|
+
const orq = new Orq({
|
|
773
|
+
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
774
|
+
});
|
|
775
|
+
|
|
776
|
+
async function run() {
|
|
777
|
+
await orq.datasets.deleteDatapoint({
|
|
778
|
+
datasetId: "<id>",
|
|
779
|
+
datapointId: "<id>",
|
|
780
|
+
});
|
|
781
|
+
|
|
782
|
+
|
|
783
|
+
}
|
|
784
|
+
|
|
785
|
+
run();
|
|
786
|
+
```
|
|
787
|
+
|
|
788
|
+
### Standalone function
|
|
789
|
+
|
|
790
|
+
The standalone function version of this method:
|
|
791
|
+
|
|
792
|
+
```typescript
|
|
793
|
+
import { OrqCore } from "@orq-ai/node/core.js";
|
|
794
|
+
import { datasetsDeleteDatapoint } from "@orq-ai/node/funcs/datasetsDeleteDatapoint.js";
|
|
795
|
+
|
|
796
|
+
// Use `OrqCore` for best tree-shaking performance.
|
|
797
|
+
// You can create one instance of it to use across an application.
|
|
798
|
+
const orq = new OrqCore({
|
|
799
|
+
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
800
|
+
});
|
|
801
|
+
|
|
802
|
+
async function run() {
|
|
803
|
+
const res = await datasetsDeleteDatapoint(orq, {
|
|
804
|
+
datasetId: "<id>",
|
|
805
|
+
datapointId: "<id>",
|
|
806
|
+
});
|
|
807
|
+
if (res.ok) {
|
|
808
|
+
const { value: result } = res;
|
|
809
|
+
|
|
810
|
+
} else {
|
|
811
|
+
console.log("datasetsDeleteDatapoint failed:", res.error);
|
|
812
|
+
}
|
|
813
|
+
}
|
|
814
|
+
|
|
815
|
+
run();
|
|
816
|
+
```
|
|
817
|
+
|
|
818
|
+
### Parameters
|
|
819
|
+
|
|
820
|
+
| Parameter | Type | Required | Description |
|
|
821
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
822
|
+
| `request` | [operations.DeleteDatapointRequest](../../models/operations/deletedatapointrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
823
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
824
|
+
| `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. |
|
|
825
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
826
|
+
|
|
827
|
+
### Response
|
|
828
|
+
|
|
829
|
+
**Promise\<void\>**
|
|
830
|
+
|
|
831
|
+
### Errors
|
|
832
|
+
|
|
833
|
+
| Error Type | Status Code | Content Type |
|
|
834
|
+
| ------------------- | ------------------- | ------------------- |
|
|
835
|
+
| errors.HonoApiError | 404 | application/json |
|
|
836
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
837
|
+
|
|
838
|
+
## clear
|
|
839
|
+
|
|
840
|
+
Delete all datapoints from a dataset. This action is irreversible.
|
|
841
|
+
|
|
842
|
+
### Example Usage
|
|
843
|
+
|
|
844
|
+
```typescript
|
|
845
|
+
import { Orq } from "@orq-ai/node";
|
|
846
|
+
|
|
847
|
+
const orq = new Orq({
|
|
848
|
+
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
849
|
+
});
|
|
850
|
+
|
|
851
|
+
async function run() {
|
|
852
|
+
await orq.datasets.clear({
|
|
853
|
+
datasetId: "<id>",
|
|
854
|
+
});
|
|
855
|
+
|
|
856
|
+
|
|
857
|
+
}
|
|
858
|
+
|
|
859
|
+
run();
|
|
860
|
+
```
|
|
861
|
+
|
|
862
|
+
### Standalone function
|
|
863
|
+
|
|
864
|
+
The standalone function version of this method:
|
|
865
|
+
|
|
866
|
+
```typescript
|
|
867
|
+
import { OrqCore } from "@orq-ai/node/core.js";
|
|
868
|
+
import { datasetsClear } from "@orq-ai/node/funcs/datasetsClear.js";
|
|
869
|
+
|
|
870
|
+
// Use `OrqCore` for best tree-shaking performance.
|
|
871
|
+
// You can create one instance of it to use across an application.
|
|
872
|
+
const orq = new OrqCore({
|
|
873
|
+
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
874
|
+
});
|
|
875
|
+
|
|
876
|
+
async function run() {
|
|
877
|
+
const res = await datasetsClear(orq, {
|
|
878
|
+
datasetId: "<id>",
|
|
879
|
+
});
|
|
880
|
+
if (res.ok) {
|
|
881
|
+
const { value: result } = res;
|
|
882
|
+
|
|
883
|
+
} else {
|
|
884
|
+
console.log("datasetsClear failed:", res.error);
|
|
885
|
+
}
|
|
886
|
+
}
|
|
887
|
+
|
|
888
|
+
run();
|
|
889
|
+
```
|
|
890
|
+
|
|
891
|
+
### Parameters
|
|
892
|
+
|
|
893
|
+
| Parameter | Type | Required | Description |
|
|
894
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
895
|
+
| `request` | [operations.ClearDatasetRequest](../../models/operations/cleardatasetrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
896
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
897
|
+
| `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. |
|
|
898
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
899
|
+
|
|
900
|
+
### Response
|
|
901
|
+
|
|
902
|
+
**Promise\<void\>**
|
|
903
|
+
|
|
904
|
+
### Errors
|
|
905
|
+
|
|
906
|
+
| Error Type | Status Code | Content Type |
|
|
907
|
+
| --------------- | --------------- | --------------- |
|
|
908
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|