@orq-ai/node 3.12.0-rc.49 → 3.12.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 +87 -128
- package/bin/mcp-server.js +32716 -42948
- package/bin/mcp-server.js.map +41 -93
- package/docs/sdks/budgets/README.md +2 -4
- package/examples/package-lock.json +6 -5
- package/jsr.json +1 -1
- package/lib/config.d.ts +2 -2
- package/lib/config.js +2 -2
- package/lib/config.js.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 -33
- package/mcp-server/server.js.map +1 -1
- package/models/components/index.d.ts +0 -1
- package/models/components/index.d.ts.map +1 -1
- package/models/components/index.js +0 -1
- package/models/components/index.js.map +1 -1
- package/models/errors/index.d.ts +0 -3
- package/models/errors/index.d.ts.map +1 -1
- package/models/errors/index.js +0 -3
- package/models/errors/index.js.map +1 -1
- package/models/operations/createbudget.js +2 -2
- package/models/operations/createcontact.js +2 -2
- package/models/operations/createdataset.js +2 -2
- package/models/operations/createdatasetitem.js +2 -2
- package/models/operations/createdatasource.js +2 -2
- package/models/operations/createeval.js +16 -16
- package/models/operations/deploymentgetconfig.d.ts +30 -30
- package/models/operations/deploymentgetconfig.d.ts.map +1 -1
- package/models/operations/deploymentgetconfig.js +37 -38
- package/models/operations/deploymentgetconfig.js.map +1 -1
- package/models/operations/fileget.js +2 -2
- package/models/operations/filelist.js +2 -2
- package/models/operations/fileupload.js +2 -2
- package/models/operations/getbudget.js +2 -2
- package/models/operations/getevals.d.ts +30 -30
- package/models/operations/getevals.d.ts.map +1 -1
- package/models/operations/getevals.js +70 -67
- package/models/operations/getevals.js.map +1 -1
- package/models/operations/index.d.ts +0 -16
- package/models/operations/index.d.ts.map +1 -1
- package/models/operations/index.js +0 -16
- package/models/operations/index.js.map +1 -1
- package/models/operations/listbudgets.js +2 -2
- package/models/operations/listcontacts.js +2 -2
- package/models/operations/listdatasetdatapoints.js +2 -2
- package/models/operations/listdatasets.js +2 -2
- package/models/operations/listdatasources.js +2 -2
- package/models/operations/retrievecontact.js +2 -2
- package/models/operations/retrievedatapoint.js +2 -2
- package/models/operations/retrievedataset.js +2 -2
- package/models/operations/retrievedatasource.js +2 -2
- package/models/operations/updatebudget.js +2 -2
- package/models/operations/updatecontact.js +2 -2
- package/models/operations/updatedatapoint.js +2 -2
- package/models/operations/updatedataset.js +2 -2
- package/models/operations/updatedatasource.js +2 -2
- package/models/operations/updateeval.js +16 -16
- package/package.json +4 -4
- package/packages/orq-rc/FUNCTIONS.md +103 -0
- package/packages/orq-rc/README.md +973 -0
- package/packages/orq-rc/RUNTIMES.md +48 -0
- package/packages/orq-rc/docs/sdks/budgets/README.md +401 -0
- package/packages/orq-rc/docs/sdks/chunking/README.md +95 -0
- package/packages/orq-rc/docs/sdks/contacts/README.md +450 -0
- package/{docs/sdks/proxy → packages/orq-rc/docs/sdks/datasets}/README.md +175 -773
- package/packages/orq-rc/docs/sdks/deployments/README.md +314 -0
- package/packages/orq-rc/docs/sdks/evals/README.md +3077 -0
- package/packages/orq-rc/docs/sdks/feedback/README.md +89 -0
- package/{docs/sdks/batches → packages/orq-rc/docs/sdks/files}/README.md +50 -56
- package/packages/orq-rc/docs/sdks/knowledge/README.md +1243 -0
- package/packages/orq-rc/docs/sdks/metrics/README.md +83 -0
- package/packages/orq-rc/docs/sdks/models/README.md +76 -0
- package/packages/orq-rc/docs/sdks/orq/README.md +10 -0
- package/packages/orq-rc/docs/sdks/prompts/README.md +557 -0
- package/packages/orq-rc/docs/sdks/remoteconfigs/README.md +77 -0
- package/packages/orq-rc/examples/README.md +31 -0
- package/packages/orq-rc/examples/contactsCreate.example.ts +42 -0
- package/packages/orq-rc/examples/package-lock.json +627 -0
- package/packages/orq-rc/examples/package.json +18 -0
- package/packages/orq-rc/jsr.json +28 -0
- package/packages/orq-rc/package-lock.json +3071 -0
- package/packages/orq-rc/package.json +43 -0
- package/packages/orq-rc/src/core.ts +13 -0
- package/packages/orq-rc/src/funcs/budgetsCreate.ts +160 -0
- package/packages/orq-rc/src/funcs/budgetsDelete.ts +167 -0
- package/packages/orq-rc/src/funcs/budgetsGet.ts +166 -0
- package/packages/orq-rc/src/funcs/budgetsList.ts +170 -0
- package/packages/orq-rc/src/funcs/budgetsUpdate.ts +167 -0
- package/{src/funcs/proxyEmbeddings.ts → packages/orq-rc/src/funcs/chunkingParse.ts} +12 -13
- package/packages/orq-rc/src/funcs/contactsCreate.ts +165 -0
- 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/{src/funcs/batchesCancel.ts → packages/orq-rc/src/funcs/datasetsClear.ts} +16 -15
- package/{src/funcs/proxyImagesGenerate.ts → packages/orq-rc/src/funcs/datasetsCreate.ts} +17 -15
- package/packages/orq-rc/src/funcs/datasetsCreateDatapoint.ts +168 -0
- package/packages/orq-rc/src/funcs/datasetsDelete.ts +167 -0
- package/packages/orq-rc/src/funcs/datasetsDeleteDatapoint.ts +182 -0
- package/{src/funcs/batchesList.ts → packages/orq-rc/src/funcs/datasetsList.ts} +16 -14
- 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/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 +183 -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/{src/funcs/proxyModerations.ts → packages/orq-rc/src/funcs/evalsCreate.ts} +22 -17
- 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/evalsRagasContextEntitiesRecall.ts +183 -0
- package/packages/orq-rc/src/funcs/evalsRagasContextPrecision.ts +180 -0
- package/packages/orq-rc/src/funcs/evalsRagasContextRecall.ts +177 -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/evalsRagasNoiseSensitivity.ts +180 -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/{src/funcs/batchesCreate.ts → packages/orq-rc/src/funcs/feedbackCreate.ts} +12 -12
- package/{src/funcs/proxyImagesVariation.ts → packages/orq-rc/src/funcs/filesCreate.ts} +41 -33
- 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/{src/funcs/proxyAudioSpeech.ts → packages/orq-rc/src/funcs/knowledgeCreate.ts} +12 -13
- 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/{src/funcs/proxyImagesEdit.ts → packages/orq-rc/src/funcs/knowledgeListChunks.ts} +35 -30
- 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/packages/orq-rc/src/funcs/modelsList.ts +142 -0
- package/{src/funcs/proxyRerank.ts → packages/orq-rc/src/funcs/promptsCreate.ts} +14 -12
- 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/{src/funcs/batchesRetrieve.ts → packages/orq-rc/src/funcs/promptsRetrieve.ts} +13 -13
- 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/{temp/example.ts → packages/orq-rc/src/hooks/index.ts} +2 -1
- 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 +137 -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 +345 -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 +264 -0
- package/packages/orq-rc/src/lib/url.ts +33 -0
- package/packages/orq-rc/src/mcp-server/cli/start/command.ts +112 -0
- package/packages/orq-rc/src/mcp-server/cli/start/impl.ts +136 -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 +261 -0
- package/packages/orq-rc/src/mcp-server/shared.ts +75 -0
- package/packages/orq-rc/src/mcp-server/tools/budgetsCreate.ts +37 -0
- package/{src/mcp-server/tools/proxyAudioSpeech.ts → packages/orq-rc/src/mcp-server/tools/budgetsDelete.ts} +8 -6
- package/packages/orq-rc/src/mcp-server/tools/budgetsGet.ts +37 -0
- package/packages/orq-rc/src/mcp-server/tools/budgetsList.ts +37 -0
- package/packages/orq-rc/src/mcp-server/tools/budgetsUpdate.ts +37 -0
- package/packages/orq-rc/src/mcp-server/tools/chunkingParse.ts +37 -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/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/{src/mcp-server/tools/proxyRerank.ts → packages/orq-rc/src/mcp-server/tools/datasetsListDatapoints.ts} +8 -7
- package/{src/mcp-server/tools/proxyCompletions.ts → packages/orq-rc/src/mcp-server/tools/datasetsRetrieve.ts} +7 -7
- package/packages/orq-rc/src/mcp-server/tools/datasetsRetrieveDatapoint.ts +37 -0
- 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/{src/mcp-server/tools/proxyImagesVariation.ts → packages/orq-rc/src/mcp-server/tools/deploymentsGetConfig.ts} +8 -6
- package/packages/orq-rc/src/mcp-server/tools/deploymentsInvoke.ts +37 -0
- package/{src/mcp-server/tools/proxyEmbeddings.ts → packages/orq-rc/src/mcp-server/tools/deploymentsList.ts} +7 -7
- 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/{src/mcp-server/tools/proxyModerations.ts → packages/orq-rc/src/mcp-server/tools/evalsAll.ts} +6 -6
- 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/evalsRagasContextEntitiesRecall.ts +37 -0
- package/packages/orq-rc/src/mcp-server/tools/evalsRagasContextPrecision.ts +36 -0
- package/packages/orq-rc/src/mcp-server/tools/evalsRagasContextRecall.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/evalsRagasNoiseSensitivity.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/{src/mcp-server/tools/batchesCreate.ts → packages/orq-rc/src/mcp-server/tools/feedbackCreate.ts} +7 -7
- 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/{src/mcp-server/tools/proxyImagesEdit.ts → packages/orq-rc/src/mcp-server/tools/knowledgeCreate.ts} +6 -6
- 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/{src/mcp-server/tools/proxyImagesGenerate.ts → packages/orq-rc/src/mcp-server/tools/knowledgeListChunks.ts} +6 -6
- package/{src/mcp-server/tools/proxyAudioTranscriptions.ts → packages/orq-rc/src/mcp-server/tools/knowledgeListDatasources.ts} +6 -6
- package/packages/orq-rc/src/mcp-server/tools/knowledgeRetrieve.ts +37 -0
- package/{src/mcp-server/tools/proxyAudioTranslations.ts → packages/orq-rc/src/mcp-server/tools/knowledgeRetrieveChunk.ts} +6 -6
- 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/packages/orq-rc/src/mcp-server/tools/modelsList.ts +30 -0
- package/{src/mcp-server/tools/batchesList.ts → packages/orq-rc/src/mcp-server/tools/promptsCreate.ts} +6 -8
- 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/{src/mcp-server/tools/batchesRetrieve.ts → packages/orq-rc/src/mcp-server/tools/promptsRetrieve.ts} +7 -7
- package/{src/mcp-server/tools/batchesCancel.ts → packages/orq-rc/src/mcp-server/tools/promptsUpdate.ts} +6 -8
- 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 +8107 -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 +40 -0
- package/packages/orq-rc/src/models/errors/createeval.ts +80 -0
- package/packages/orq-rc/src/models/errors/deletecontact.ts +91 -0
- package/packages/orq-rc/src/models/errors/deleteeval.ts +80 -0
- package/packages/orq-rc/src/models/errors/evalsageappropriate.ts +156 -0
- package/packages/orq-rc/src/models/errors/evalsbertscore.ts +154 -0
- package/packages/orq-rc/src/models/errors/evalsbleuscore.ts +154 -0
- package/packages/orq-rc/src/models/errors/evalsbotdetection.ts +155 -0
- package/packages/orq-rc/src/models/errors/evalscontains.ts +154 -0
- package/packages/orq-rc/src/models/errors/evalscontainsall.ts +155 -0
- package/packages/orq-rc/src/models/errors/evalscontainsany.ts +155 -0
- package/packages/orq-rc/src/models/errors/evalscontainsemail.ts +156 -0
- package/packages/orq-rc/src/models/errors/evalscontainsnone.ts +155 -0
- package/packages/orq-rc/src/models/errors/evalscontainsurl.ts +155 -0
- package/packages/orq-rc/src/models/errors/evalscontainsvalidlink.ts +157 -0
- package/packages/orq-rc/src/models/errors/evalsendswith.ts +154 -0
- package/packages/orq-rc/src/models/errors/evalsexactmatch.ts +154 -0
- package/packages/orq-rc/src/models/errors/evalsfactcheckingknowledgebase.ts +160 -0
- package/packages/orq-rc/src/models/errors/evalsgrammar.ts +154 -0
- package/packages/orq-rc/src/models/errors/evalslengthbetween.ts +156 -0
- package/packages/orq-rc/src/models/errors/evalslengthgreaterthan.ts +157 -0
- package/packages/orq-rc/src/models/errors/evalslengthlessthan.ts +156 -0
- package/packages/orq-rc/src/models/errors/evalslocalization.ts +155 -0
- package/packages/orq-rc/src/models/errors/evalspii.ts +154 -0
- package/packages/orq-rc/src/models/errors/evalsragascoherence.ts +156 -0
- package/packages/orq-rc/src/models/errors/evalsragasconciseness.ts +157 -0
- package/packages/orq-rc/src/models/errors/evalsragascontextentitiesrecall.ts +163 -0
- package/packages/orq-rc/src/models/errors/evalsragascontextprecision.ts +160 -0
- package/packages/orq-rc/src/models/errors/evalsragascontextrecall.ts +158 -0
- package/packages/orq-rc/src/models/errors/evalsragascorrectness.ts +157 -0
- package/packages/orq-rc/src/models/errors/evalsragasfaithfulness.ts +157 -0
- package/packages/orq-rc/src/models/errors/evalsragasharmfulness.ts +157 -0
- package/packages/orq-rc/src/models/errors/evalsragasmaliciousness.ts +158 -0
- package/packages/orq-rc/src/models/errors/evalsragasnoisesensitivity.ts +160 -0
- package/packages/orq-rc/src/models/errors/evalsragasresponserelevancy.ts +160 -0
- package/packages/orq-rc/src/models/errors/evalsragassummarization.ts +158 -0
- package/packages/orq-rc/src/models/errors/evalssentimentclassification.ts +160 -0
- package/packages/orq-rc/src/models/errors/evalssummarization.ts +156 -0
- package/packages/orq-rc/src/models/errors/evalstoneofvoice.ts +155 -0
- package/packages/orq-rc/src/models/errors/evalstranslation.ts +155 -0
- package/packages/orq-rc/src/models/errors/evalsvalidjson.ts +154 -0
- package/packages/orq-rc/src/models/errors/getevals.ts +80 -0
- package/packages/orq-rc/src/models/errors/getpromptversion.ts +80 -0
- package/packages/orq-rc/src/models/errors/honoapierror.ts +90 -0
- package/packages/orq-rc/src/models/errors/httpclienterrors.ts +62 -0
- package/packages/orq-rc/src/models/errors/index.ts +56 -0
- package/packages/orq-rc/src/models/errors/invokeeval.ts +154 -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 +83 -0
- package/packages/orq-rc/src/models/errors/updateeval.ts +80 -0
- package/packages/orq-rc/src/models/errors/updateprompt.ts +80 -0
- package/packages/orq-rc/src/models/operations/cleardataset.ts +75 -0
- package/packages/orq-rc/src/models/operations/createbudget.ts +736 -0
- package/packages/orq-rc/src/models/operations/createchunk.ts +438 -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/createdatasetitem.ts +6186 -0
- package/packages/orq-rc/src/models/operations/createdatasource.ts +852 -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 +4375 -0
- package/packages/orq-rc/src/models/operations/deletebudget.ts +66 -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 +6507 -0
- package/packages/orq-rc/src/models/operations/deploymentgetconfig.ts +10352 -0
- package/packages/orq-rc/src/models/operations/deploymentinvoke.ts +1259 -0
- package/packages/orq-rc/src/models/operations/deployments.ts +2468 -0
- package/packages/orq-rc/src/models/operations/deploymentstream.ts +10615 -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/evalsragascontextentitiesrecall.ts +164 -0
- package/packages/orq-rc/src/models/operations/evalsragascontextprecision.ts +166 -0
- package/packages/orq-rc/src/models/operations/evalsragascontextrecall.ts +164 -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/evalsragasnoisesensitivity.ts +166 -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 +2438 -0
- package/packages/orq-rc/src/models/operations/getbudget.ts +437 -0
- package/packages/orq-rc/src/models/operations/getevals.ts +7290 -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 +2299 -0
- package/packages/orq-rc/src/models/operations/getpromptversion.ts +2306 -0
- package/packages/orq-rc/src/models/operations/index.ts +103 -0
- package/packages/orq-rc/src/models/operations/invokeeval.ts +2520 -0
- package/packages/orq-rc/src/models/operations/listbudgets.ts +617 -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 +3280 -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 +2439 -0
- package/packages/orq-rc/src/models/operations/parse.ts +1610 -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 +3062 -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 +3816 -0
- package/packages/orq-rc/src/models/operations/updatebudget.ts +624 -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 +6127 -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 +4516 -0
- package/packages/orq-rc/src/sdk/budgets.ts +99 -0
- package/packages/orq-rc/src/sdk/chunking.ts +27 -0
- package/packages/orq-rc/src/sdk/contacts.ts +99 -0
- package/packages/orq-rc/src/sdk/datasets.ts +204 -0
- package/packages/orq-rc/src/sdk/deployments.ts +89 -0
- package/packages/orq-rc/src/sdk/evals.ts +639 -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 +79 -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/sdk.d.ts +0 -6
- package/sdk/sdk.d.ts.map +1 -1
- package/sdk/sdk.js +0 -8
- package/sdk/sdk.js.map +1 -1
- package/src/lib/config.ts +2 -2
- package/src/mcp-server/mcp-server.ts +1 -1
- package/src/mcp-server/server.ts +1 -33
- package/src/models/components/index.ts +0 -1
- package/src/models/errors/index.ts +0 -3
- package/src/models/operations/createbudget.ts +2 -2
- package/src/models/operations/createcontact.ts +2 -2
- package/src/models/operations/createdataset.ts +2 -2
- package/src/models/operations/createdatasetitem.ts +2 -2
- package/src/models/operations/createdatasource.ts +2 -2
- package/src/models/operations/createeval.ts +16 -16
- package/src/models/operations/deploymentgetconfig.ts +51 -66
- 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/getbudget.ts +2 -2
- package/src/models/operations/getevals.ts +92 -107
- package/src/models/operations/index.ts +0 -16
- package/src/models/operations/listbudgets.ts +2 -2
- package/src/models/operations/listcontacts.ts +2 -2
- package/src/models/operations/listdatasetdatapoints.ts +2 -2
- package/src/models/operations/listdatasets.ts +2 -2
- package/src/models/operations/listdatasources.ts +2 -2
- package/src/models/operations/retrievecontact.ts +2 -2
- package/src/models/operations/retrievedatapoint.ts +2 -2
- package/src/models/operations/retrievedataset.ts +2 -2
- package/src/models/operations/retrievedatasource.ts +2 -2
- package/src/models/operations/updatebudget.ts +2 -2
- package/src/models/operations/updatecontact.ts +2 -2
- package/src/models/operations/updatedatapoint.ts +2 -2
- package/src/models/operations/updatedataset.ts +2 -2
- package/src/models/operations/updatedatasource.ts +2 -2
- package/src/models/operations/updateeval.ts +16 -16
- package/src/sdk/sdk.ts +0 -12
- package/funcs/batchesCancel.d.ts +0 -17
- package/funcs/batchesCancel.d.ts.map +0 -1
- package/funcs/batchesCancel.js +0 -119
- package/funcs/batchesCancel.js.map +0 -1
- package/funcs/batchesCreate.d.ts +0 -17
- package/funcs/batchesCreate.d.ts.map +0 -1
- package/funcs/batchesCreate.js +0 -114
- package/funcs/batchesCreate.js.map +0 -1
- package/funcs/batchesList.d.ts +0 -17
- package/funcs/batchesList.d.ts.map +0 -1
- package/funcs/batchesList.js +0 -118
- package/funcs/batchesList.js.map +0 -1
- package/funcs/batchesRetrieve.d.ts +0 -17
- package/funcs/batchesRetrieve.d.ts.map +0 -1
- package/funcs/batchesRetrieve.js +0 -119
- package/funcs/batchesRetrieve.js.map +0 -1
- package/funcs/proxyAudioSpeech.d.ts +0 -14
- package/funcs/proxyAudioSpeech.d.ts.map +0 -1
- package/funcs/proxyAudioSpeech.js +0 -112
- package/funcs/proxyAudioSpeech.js.map +0 -1
- package/funcs/proxyAudioTranscriptions.d.ts +0 -12
- package/funcs/proxyAudioTranscriptions.d.ts.map +0 -1
- package/funcs/proxyAudioTranscriptions.js +0 -162
- package/funcs/proxyAudioTranscriptions.js.map +0 -1
- package/funcs/proxyAudioTranslations.d.ts +0 -12
- package/funcs/proxyAudioTranslations.d.ts.map +0 -1
- package/funcs/proxyAudioTranslations.js +0 -156
- package/funcs/proxyAudioTranslations.js.map +0 -1
- package/funcs/proxyChatCompletions.d.ts +0 -23
- package/funcs/proxyChatCompletions.d.ts.map +0 -1
- package/funcs/proxyChatCompletions.js +0 -121
- package/funcs/proxyChatCompletions.js.map +0 -1
- package/funcs/proxyCompletions.d.ts +0 -23
- package/funcs/proxyCompletions.d.ts.map +0 -1
- package/funcs/proxyCompletions.js +0 -121
- package/funcs/proxyCompletions.js.map +0 -1
- package/funcs/proxyEmbeddings.d.ts +0 -17
- package/funcs/proxyEmbeddings.d.ts.map +0 -1
- package/funcs/proxyEmbeddings.js +0 -114
- package/funcs/proxyEmbeddings.js.map +0 -1
- package/funcs/proxyImagesEdit.d.ts +0 -14
- package/funcs/proxyImagesEdit.d.ts.map +0 -1
- package/funcs/proxyImagesEdit.js +0 -125
- package/funcs/proxyImagesEdit.js.map +0 -1
- package/funcs/proxyImagesGenerate.d.ts +0 -14
- package/funcs/proxyImagesGenerate.d.ts.map +0 -1
- package/funcs/proxyImagesGenerate.js +0 -111
- package/funcs/proxyImagesGenerate.js.map +0 -1
- package/funcs/proxyImagesVariation.d.ts +0 -14
- package/funcs/proxyImagesVariation.d.ts.map +0 -1
- package/funcs/proxyImagesVariation.js +0 -126
- package/funcs/proxyImagesVariation.js.map +0 -1
- package/funcs/proxyModerations.d.ts +0 -12
- package/funcs/proxyModerations.d.ts.map +0 -1
- package/funcs/proxyModerations.js +0 -112
- package/funcs/proxyModerations.js.map +0 -1
- package/funcs/proxyRerank.d.ts +0 -14
- package/funcs/proxyRerank.d.ts.map +0 -1
- package/funcs/proxyRerank.js +0 -111
- package/funcs/proxyRerank.js.map +0 -1
- package/funcs/proxyResponsesCreate.d.ts +0 -23
- package/funcs/proxyResponsesCreate.d.ts.map +0 -1
- package/funcs/proxyResponsesCreate.js +0 -121
- package/funcs/proxyResponsesCreate.js.map +0 -1
- package/mcp-server/tools/batchesCancel.d.ts +0 -8
- package/mcp-server/tools/batchesCancel.d.ts.map +0 -1
- package/mcp-server/tools/batchesCancel.js +0 -64
- package/mcp-server/tools/batchesCancel.js.map +0 -1
- package/mcp-server/tools/batchesCreate.d.ts +0 -8
- package/mcp-server/tools/batchesCreate.d.ts.map +0 -1
- package/mcp-server/tools/batchesCreate.js +0 -64
- package/mcp-server/tools/batchesCreate.js.map +0 -1
- package/mcp-server/tools/batchesList.d.ts +0 -8
- package/mcp-server/tools/batchesList.d.ts.map +0 -1
- package/mcp-server/tools/batchesList.js +0 -64
- package/mcp-server/tools/batchesList.js.map +0 -1
- package/mcp-server/tools/batchesRetrieve.d.ts +0 -8
- package/mcp-server/tools/batchesRetrieve.d.ts.map +0 -1
- package/mcp-server/tools/batchesRetrieve.js +0 -64
- package/mcp-server/tools/batchesRetrieve.js.map +0 -1
- package/mcp-server/tools/proxyAudioSpeech.d.ts +0 -8
- package/mcp-server/tools/proxyAudioSpeech.d.ts.map +0 -1
- package/mcp-server/tools/proxyAudioSpeech.js +0 -61
- package/mcp-server/tools/proxyAudioSpeech.js.map +0 -1
- package/mcp-server/tools/proxyAudioTranscriptions.d.ts +0 -8
- package/mcp-server/tools/proxyAudioTranscriptions.d.ts.map +0 -1
- package/mcp-server/tools/proxyAudioTranscriptions.js +0 -62
- package/mcp-server/tools/proxyAudioTranscriptions.js.map +0 -1
- package/mcp-server/tools/proxyAudioTranslations.d.ts +0 -8
- package/mcp-server/tools/proxyAudioTranslations.d.ts.map +0 -1
- package/mcp-server/tools/proxyAudioTranslations.js +0 -62
- package/mcp-server/tools/proxyAudioTranslations.js.map +0 -1
- package/mcp-server/tools/proxyChatCompletions.d.ts +0 -8
- package/mcp-server/tools/proxyChatCompletions.d.ts.map +0 -1
- package/mcp-server/tools/proxyChatCompletions.js +0 -64
- package/mcp-server/tools/proxyChatCompletions.js.map +0 -1
- package/mcp-server/tools/proxyCompletions.d.ts +0 -8
- package/mcp-server/tools/proxyCompletions.d.ts.map +0 -1
- package/mcp-server/tools/proxyCompletions.js +0 -64
- package/mcp-server/tools/proxyCompletions.js.map +0 -1
- package/mcp-server/tools/proxyEmbeddings.d.ts +0 -8
- package/mcp-server/tools/proxyEmbeddings.d.ts.map +0 -1
- package/mcp-server/tools/proxyEmbeddings.js +0 -64
- package/mcp-server/tools/proxyEmbeddings.js.map +0 -1
- package/mcp-server/tools/proxyImagesEdit.d.ts +0 -8
- package/mcp-server/tools/proxyImagesEdit.d.ts.map +0 -1
- package/mcp-server/tools/proxyImagesEdit.js +0 -62
- package/mcp-server/tools/proxyImagesEdit.js.map +0 -1
- package/mcp-server/tools/proxyImagesGenerate.d.ts +0 -8
- package/mcp-server/tools/proxyImagesGenerate.d.ts.map +0 -1
- package/mcp-server/tools/proxyImagesGenerate.js +0 -62
- package/mcp-server/tools/proxyImagesGenerate.js.map +0 -1
- package/mcp-server/tools/proxyImagesVariation.d.ts +0 -8
- package/mcp-server/tools/proxyImagesVariation.d.ts.map +0 -1
- package/mcp-server/tools/proxyImagesVariation.js +0 -62
- package/mcp-server/tools/proxyImagesVariation.js.map +0 -1
- package/mcp-server/tools/proxyModerations.d.ts +0 -8
- package/mcp-server/tools/proxyModerations.d.ts.map +0 -1
- package/mcp-server/tools/proxyModerations.js +0 -62
- package/mcp-server/tools/proxyModerations.js.map +0 -1
- package/mcp-server/tools/proxyRerank.d.ts +0 -8
- package/mcp-server/tools/proxyRerank.d.ts.map +0 -1
- package/mcp-server/tools/proxyRerank.js +0 -62
- package/mcp-server/tools/proxyRerank.js.map +0 -1
- package/mcp-server/tools/proxyResponsesCreate.d.ts +0 -8
- package/mcp-server/tools/proxyResponsesCreate.d.ts.map +0 -1
- package/mcp-server/tools/proxyResponsesCreate.js +0 -64
- package/mcp-server/tools/proxyResponsesCreate.js.map +0 -1
- package/models/components/publiccontact.d.ts +0 -64
- package/models/components/publiccontact.d.ts.map +0 -1
- package/models/components/publiccontact.js +0 -90
- package/models/components/publiccontact.js.map +0 -1
- package/models/errors/postv2proxyaudiotranscriptions.d.ts +0 -75
- package/models/errors/postv2proxyaudiotranscriptions.d.ts.map +0 -1
- package/models/errors/postv2proxyaudiotranscriptions.js +0 -121
- package/models/errors/postv2proxyaudiotranscriptions.js.map +0 -1
- package/models/errors/postv2proxyaudiotranslations.d.ts +0 -75
- package/models/errors/postv2proxyaudiotranslations.d.ts.map +0 -1
- package/models/errors/postv2proxyaudiotranslations.js +0 -121
- package/models/errors/postv2proxyaudiotranslations.js.map +0 -1
- package/models/errors/postv2proxymoderations.d.ts +0 -75
- package/models/errors/postv2proxymoderations.d.ts.map +0 -1
- package/models/errors/postv2proxymoderations.js +0 -122
- package/models/errors/postv2proxymoderations.js.map +0 -1
- package/models/operations/cancelbatch.d.ts +0 -257
- package/models/operations/cancelbatch.d.ts.map +0 -1
- package/models/operations/cancelbatch.js +0 -252
- package/models/operations/cancelbatch.js.map +0 -1
- package/models/operations/createbatch.d.ts +0 -317
- package/models/operations/createbatch.d.ts.map +0 -1
- package/models/operations/createbatch.js +0 -282
- package/models/operations/createbatch.js.map +0 -1
- package/models/operations/createchatcompletion.d.ts +0 -5564
- package/models/operations/createchatcompletion.d.ts.map +0 -1
- package/models/operations/createchatcompletion.js +0 -5481
- package/models/operations/createchatcompletion.js.map +0 -1
- package/models/operations/createresponse.d.ts +0 -4049
- package/models/operations/createresponse.d.ts.map +0 -1
- package/models/operations/createresponse.js +0 -3623
- package/models/operations/createresponse.js.map +0 -1
- package/models/operations/listbatches.d.ts +0 -310
- package/models/operations/listbatches.d.ts.map +0 -1
- package/models/operations/listbatches.js +0 -303
- package/models/operations/listbatches.js.map +0 -1
- package/models/operations/postv2proxyaudiospeech.d.ts +0 -416
- package/models/operations/postv2proxyaudiospeech.d.ts.map +0 -1
- package/models/operations/postv2proxyaudiospeech.js +0 -407
- package/models/operations/postv2proxyaudiospeech.js.map +0 -1
- package/models/operations/postv2proxyaudiotranscriptions.d.ts +0 -373
- package/models/operations/postv2proxyaudiotranscriptions.d.ts.map +0 -1
- package/models/operations/postv2proxyaudiotranscriptions.js +0 -406
- package/models/operations/postv2proxyaudiotranscriptions.js.map +0 -1
- package/models/operations/postv2proxyaudiotranslations.d.ts +0 -338
- package/models/operations/postv2proxyaudiotranslations.d.ts.map +0 -1
- package/models/operations/postv2proxyaudiotranslations.js +0 -381
- package/models/operations/postv2proxyaudiotranslations.js.map +0 -1
- package/models/operations/postv2proxycompletions.d.ts +0 -2587
- package/models/operations/postv2proxycompletions.d.ts.map +0 -1
- package/models/operations/postv2proxycompletions.js +0 -2647
- package/models/operations/postv2proxycompletions.js.map +0 -1
- package/models/operations/postv2proxyembeddings.d.ts +0 -457
- package/models/operations/postv2proxyembeddings.d.ts.map +0 -1
- package/models/operations/postv2proxyembeddings.js +0 -446
- package/models/operations/postv2proxyembeddings.js.map +0 -1
- package/models/operations/postv2proxyimagesedits.d.ts +0 -289
- package/models/operations/postv2proxyimagesedits.d.ts.map +0 -1
- package/models/operations/postv2proxyimagesedits.js +0 -304
- package/models/operations/postv2proxyimagesedits.js.map +0 -1
- package/models/operations/postv2proxyimagesgenerations.d.ts +0 -601
- package/models/operations/postv2proxyimagesgenerations.d.ts.map +0 -1
- package/models/operations/postv2proxyimagesgenerations.js +0 -569
- package/models/operations/postv2proxyimagesgenerations.js.map +0 -1
- package/models/operations/postv2proxyimagesvariations.d.ts +0 -297
- package/models/operations/postv2proxyimagesvariations.d.ts.map +0 -1
- package/models/operations/postv2proxyimagesvariations.js +0 -306
- package/models/operations/postv2proxyimagesvariations.js.map +0 -1
- package/models/operations/postv2proxymoderations.d.ts +0 -421
- package/models/operations/postv2proxymoderations.d.ts.map +0 -1
- package/models/operations/postv2proxymoderations.js +0 -389
- package/models/operations/postv2proxymoderations.js.map +0 -1
- package/models/operations/postv2proxyrerank.d.ts +0 -447
- package/models/operations/postv2proxyrerank.d.ts.map +0 -1
- package/models/operations/postv2proxyrerank.js +0 -435
- package/models/operations/postv2proxyrerank.js.map +0 -1
- package/models/operations/retrievebatch.d.ts +0 -257
- package/models/operations/retrievebatch.d.ts.map +0 -1
- package/models/operations/retrievebatch.js +0 -252
- package/models/operations/retrievebatch.js.map +0 -1
- package/sdk/batches.d.ts +0 -33
- package/sdk/batches.d.ts.map +0 -1
- package/sdk/batches.js +0 -52
- package/sdk/batches.js.map +0 -1
- package/sdk/proxy.d.ts +0 -68
- package/sdk/proxy.d.ts.map +0 -1
- package/sdk/proxy.js +0 -105
- package/sdk/proxy.js.map +0 -1
- package/src/funcs/proxyAudioTranscriptions.ts +0 -233
- package/src/funcs/proxyAudioTranslations.ts +0 -223
- package/src/funcs/proxyChatCompletions.ts +0 -172
- package/src/funcs/proxyCompletions.ts +0 -168
- package/src/funcs/proxyResponsesCreate.ts +0 -171
- package/src/mcp-server/tools/proxyChatCompletions.ts +0 -37
- package/src/mcp-server/tools/proxyResponsesCreate.ts +0 -37
- package/src/models/components/publiccontact.ts +0 -114
- package/src/models/errors/postv2proxyaudiotranscriptions.ts +0 -163
- package/src/models/errors/postv2proxyaudiotranslations.ts +0 -162
- package/src/models/errors/postv2proxymoderations.ts +0 -151
- package/src/models/operations/cancelbatch.ts +0 -474
- package/src/models/operations/createbatch.ts +0 -531
- package/src/models/operations/createchatcompletion.ts +0 -11697
- package/src/models/operations/createresponse.ts +0 -7071
- package/src/models/operations/listbatches.ts +0 -570
- package/src/models/operations/postv2proxyaudiospeech.ts +0 -708
- package/src/models/operations/postv2proxyaudiotranscriptions.ts +0 -731
- package/src/models/operations/postv2proxyaudiotranslations.ts +0 -741
- package/src/models/operations/postv2proxycompletions.ts +0 -5831
- package/src/models/operations/postv2proxyembeddings.ts +0 -878
- package/src/models/operations/postv2proxyimagesedits.ts +0 -596
- package/src/models/operations/postv2proxyimagesgenerations.ts +0 -1107
- package/src/models/operations/postv2proxyimagesvariations.ts +0 -592
- package/src/models/operations/postv2proxymoderations.ts +0 -802
- package/src/models/operations/postv2proxyrerank.ts +0 -856
- package/src/models/operations/retrievebatch.ts +0 -474
- package/src/sdk/batches.ts +0 -81
- package/src/sdk/proxy.ts +0 -211
|
@@ -1,30 +1,29 @@
|
|
|
1
|
-
#
|
|
2
|
-
(*
|
|
1
|
+
# Datasets
|
|
2
|
+
(*datasets*)
|
|
3
3
|
|
|
4
4
|
## Overview
|
|
5
5
|
|
|
6
6
|
### Available Operations
|
|
7
7
|
|
|
8
|
-
* [
|
|
9
|
-
* [
|
|
10
|
-
* [
|
|
11
|
-
* [
|
|
12
|
-
* [
|
|
13
|
-
* [
|
|
14
|
-
* [
|
|
15
|
-
* [
|
|
16
|
-
* [
|
|
17
|
-
* [
|
|
18
|
-
* [
|
|
19
|
-
* [responsesCreate](#responsescreate) - Create response
|
|
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
|
+
* [listDatapoints](#listdatapoints) - List datapoints
|
|
14
|
+
* [createDatapoint](#createdatapoint) - Create a datapoint
|
|
15
|
+
* [retrieveDatapoint](#retrievedatapoint) - Retrieve a datapoint
|
|
16
|
+
* [updateDatapoint](#updatedatapoint) - Update a datapoint
|
|
17
|
+
* [deleteDatapoint](#deletedatapoint) - Delete a datapoint
|
|
18
|
+
* [clear](#clear) - Delete all datapoints
|
|
20
19
|
|
|
21
|
-
##
|
|
20
|
+
## list
|
|
22
21
|
|
|
23
|
-
|
|
22
|
+
Retrieves a paginated list of datasets for the current workspace. Results can be paginated using cursor-based pagination.
|
|
24
23
|
|
|
25
24
|
### Example Usage
|
|
26
25
|
|
|
27
|
-
<!-- UsageSnippet language="typescript" operationID="
|
|
26
|
+
<!-- UsageSnippet language="typescript" operationID="ListDatasets" method="get" path="/v2/datasets" -->
|
|
28
27
|
```typescript
|
|
29
28
|
import { Orq } from "@orq-ai/node";
|
|
30
29
|
|
|
@@ -33,61 +32,9 @@ const orq = new Orq({
|
|
|
33
32
|
});
|
|
34
33
|
|
|
35
34
|
async function run() {
|
|
36
|
-
const result = await orq.
|
|
37
|
-
messages: [
|
|
38
|
-
{
|
|
39
|
-
role: "assistant",
|
|
40
|
-
},
|
|
41
|
-
],
|
|
42
|
-
model: "Camaro",
|
|
43
|
-
orq: {
|
|
44
|
-
retry: {
|
|
45
|
-
onCodes: [
|
|
46
|
-
429,
|
|
47
|
-
500,
|
|
48
|
-
502,
|
|
49
|
-
],
|
|
50
|
-
},
|
|
51
|
-
fallbacks: [
|
|
52
|
-
{
|
|
53
|
-
model: "openai/gpt-5",
|
|
54
|
-
},
|
|
55
|
-
{
|
|
56
|
-
model: "anthropic/claude-4-opus",
|
|
57
|
-
},
|
|
58
|
-
],
|
|
59
|
-
contact: {
|
|
60
|
-
id: "contact_01ARZ3NDEKTSV4RRFFQ69G5FAV",
|
|
61
|
-
displayName: "Jane Doe",
|
|
62
|
-
email: "jane.doe@example.com",
|
|
63
|
-
},
|
|
64
|
-
thread: {
|
|
65
|
-
id: "thread_01ARZ3NDEKTSV4RRFFQ69G5FAV",
|
|
66
|
-
tags: [
|
|
67
|
-
"customer-support",
|
|
68
|
-
],
|
|
69
|
-
},
|
|
70
|
-
inputs: {
|
|
71
|
-
"customer_name": "John Smith",
|
|
72
|
-
"issue_type": "billing",
|
|
73
|
-
},
|
|
74
|
-
cache: {
|
|
75
|
-
ttl: 3600,
|
|
76
|
-
type: "exact_match",
|
|
77
|
-
},
|
|
78
|
-
knowledgeBases: [
|
|
79
|
-
{
|
|
80
|
-
topK: 5,
|
|
81
|
-
knowledgeId: "knowledge_01ARZ3NDEKTSV4RRFFQ69G5FAV",
|
|
82
|
-
},
|
|
83
|
-
],
|
|
84
|
-
},
|
|
85
|
-
});
|
|
35
|
+
const result = await orq.datasets.list({});
|
|
86
36
|
|
|
87
|
-
|
|
88
|
-
// Handle the event
|
|
89
|
-
console.log(event);
|
|
90
|
-
}
|
|
37
|
+
console.log(result);
|
|
91
38
|
}
|
|
92
39
|
|
|
93
40
|
run();
|
|
@@ -99,7 +46,7 @@ The standalone function version of this method:
|
|
|
99
46
|
|
|
100
47
|
```typescript
|
|
101
48
|
import { OrqCore } from "@orq-ai/node/core.js";
|
|
102
|
-
import {
|
|
49
|
+
import { datasetsList } from "@orq-ai/node/funcs/datasetsList.js";
|
|
103
50
|
|
|
104
51
|
// Use `OrqCore` for best tree-shaking performance.
|
|
105
52
|
// You can create one instance of it to use across an application.
|
|
@@ -108,64 +55,12 @@ const orq = new OrqCore({
|
|
|
108
55
|
});
|
|
109
56
|
|
|
110
57
|
async function run() {
|
|
111
|
-
const res = await
|
|
112
|
-
messages: [
|
|
113
|
-
{
|
|
114
|
-
role: "assistant",
|
|
115
|
-
},
|
|
116
|
-
],
|
|
117
|
-
model: "Camaro",
|
|
118
|
-
orq: {
|
|
119
|
-
retry: {
|
|
120
|
-
onCodes: [
|
|
121
|
-
429,
|
|
122
|
-
500,
|
|
123
|
-
502,
|
|
124
|
-
],
|
|
125
|
-
},
|
|
126
|
-
fallbacks: [
|
|
127
|
-
{
|
|
128
|
-
model: "openai/gpt-5",
|
|
129
|
-
},
|
|
130
|
-
{
|
|
131
|
-
model: "anthropic/claude-4-opus",
|
|
132
|
-
},
|
|
133
|
-
],
|
|
134
|
-
contact: {
|
|
135
|
-
id: "contact_01ARZ3NDEKTSV4RRFFQ69G5FAV",
|
|
136
|
-
displayName: "Jane Doe",
|
|
137
|
-
email: "jane.doe@example.com",
|
|
138
|
-
},
|
|
139
|
-
thread: {
|
|
140
|
-
id: "thread_01ARZ3NDEKTSV4RRFFQ69G5FAV",
|
|
141
|
-
tags: [
|
|
142
|
-
"customer-support",
|
|
143
|
-
],
|
|
144
|
-
},
|
|
145
|
-
inputs: {
|
|
146
|
-
"customer_name": "John Smith",
|
|
147
|
-
"issue_type": "billing",
|
|
148
|
-
},
|
|
149
|
-
cache: {
|
|
150
|
-
ttl: 3600,
|
|
151
|
-
type: "exact_match",
|
|
152
|
-
},
|
|
153
|
-
knowledgeBases: [
|
|
154
|
-
{
|
|
155
|
-
topK: 5,
|
|
156
|
-
knowledgeId: "knowledge_01ARZ3NDEKTSV4RRFFQ69G5FAV",
|
|
157
|
-
},
|
|
158
|
-
],
|
|
159
|
-
},
|
|
160
|
-
});
|
|
58
|
+
const res = await datasetsList(orq, {});
|
|
161
59
|
if (res.ok) {
|
|
162
60
|
const { value: result } = res;
|
|
163
|
-
|
|
164
|
-
// Handle the event
|
|
165
|
-
console.log(event);
|
|
166
|
-
}
|
|
61
|
+
console.log(result);
|
|
167
62
|
} else {
|
|
168
|
-
console.log("
|
|
63
|
+
console.log("datasetsList failed:", res.error);
|
|
169
64
|
}
|
|
170
65
|
}
|
|
171
66
|
|
|
@@ -176,14 +71,14 @@ run();
|
|
|
176
71
|
|
|
177
72
|
| Parameter | Type | Required | Description |
|
|
178
73
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
179
|
-
| `request` | [operations.
|
|
74
|
+
| `request` | [operations.ListDatasetsRequest](../../models/operations/listdatasetsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
180
75
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
181
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. |
|
|
182
77
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
183
78
|
|
|
184
79
|
### Response
|
|
185
80
|
|
|
186
|
-
**Promise\<[operations.
|
|
81
|
+
**Promise\<[operations.ListDatasetsResponseBody](../../models/operations/listdatasetsresponsebody.md)\>**
|
|
187
82
|
|
|
188
83
|
### Errors
|
|
189
84
|
|
|
@@ -191,11 +86,13 @@ run();
|
|
|
191
86
|
| --------------- | --------------- | --------------- |
|
|
192
87
|
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
193
88
|
|
|
194
|
-
##
|
|
89
|
+
## create
|
|
90
|
+
|
|
91
|
+
Creates a new dataset in the specified project.
|
|
195
92
|
|
|
196
93
|
### Example Usage
|
|
197
94
|
|
|
198
|
-
<!-- UsageSnippet language="typescript" operationID="
|
|
95
|
+
<!-- UsageSnippet language="typescript" operationID="CreateDataset" method="post" path="/v2/datasets" -->
|
|
199
96
|
```typescript
|
|
200
97
|
import { Orq } from "@orq-ai/node";
|
|
201
98
|
|
|
@@ -204,8 +101,9 @@ const orq = new Orq({
|
|
|
204
101
|
});
|
|
205
102
|
|
|
206
103
|
async function run() {
|
|
207
|
-
const result = await orq.
|
|
208
|
-
|
|
104
|
+
const result = await orq.datasets.create({
|
|
105
|
+
displayName: "Neva.Raynor10",
|
|
106
|
+
path: "Default",
|
|
209
107
|
});
|
|
210
108
|
|
|
211
109
|
console.log(result);
|
|
@@ -220,7 +118,7 @@ The standalone function version of this method:
|
|
|
220
118
|
|
|
221
119
|
```typescript
|
|
222
120
|
import { OrqCore } from "@orq-ai/node/core.js";
|
|
223
|
-
import {
|
|
121
|
+
import { datasetsCreate } from "@orq-ai/node/funcs/datasetsCreate.js";
|
|
224
122
|
|
|
225
123
|
// Use `OrqCore` for best tree-shaking performance.
|
|
226
124
|
// You can create one instance of it to use across an application.
|
|
@@ -229,14 +127,15 @@ const orq = new OrqCore({
|
|
|
229
127
|
});
|
|
230
128
|
|
|
231
129
|
async function run() {
|
|
232
|
-
const res = await
|
|
233
|
-
|
|
130
|
+
const res = await datasetsCreate(orq, {
|
|
131
|
+
displayName: "Neva.Raynor10",
|
|
132
|
+
path: "Default",
|
|
234
133
|
});
|
|
235
134
|
if (res.ok) {
|
|
236
135
|
const { value: result } = res;
|
|
237
136
|
console.log(result);
|
|
238
137
|
} else {
|
|
239
|
-
console.log("
|
|
138
|
+
console.log("datasetsCreate failed:", res.error);
|
|
240
139
|
}
|
|
241
140
|
}
|
|
242
141
|
|
|
@@ -247,29 +146,28 @@ run();
|
|
|
247
146
|
|
|
248
147
|
| Parameter | Type | Required | Description |
|
|
249
148
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
250
|
-
| `request` | [operations.
|
|
149
|
+
| `request` | [operations.CreateDatasetRequestBody](../../models/operations/createdatasetrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
251
150
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
252
151
|
| `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. |
|
|
253
152
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
254
153
|
|
|
255
154
|
### Response
|
|
256
155
|
|
|
257
|
-
**Promise\<[operations.
|
|
156
|
+
**Promise\<[operations.CreateDatasetResponseBody](../../models/operations/createdatasetresponsebody.md)\>**
|
|
258
157
|
|
|
259
158
|
### Errors
|
|
260
159
|
|
|
261
|
-
| Error Type
|
|
262
|
-
|
|
|
263
|
-
| errors.
|
|
264
|
-
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
160
|
+
| Error Type | Status Code | Content Type |
|
|
161
|
+
| --------------- | --------------- | --------------- |
|
|
162
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
265
163
|
|
|
266
|
-
##
|
|
164
|
+
## retrieve
|
|
267
165
|
|
|
268
|
-
|
|
166
|
+
Retrieves a specific dataset by its unique identifier
|
|
269
167
|
|
|
270
168
|
### Example Usage
|
|
271
169
|
|
|
272
|
-
<!-- UsageSnippet language="typescript" operationID="
|
|
170
|
+
<!-- UsageSnippet language="typescript" operationID="RetrieveDataset" method="get" path="/v2/datasets/{dataset_id}" -->
|
|
273
171
|
```typescript
|
|
274
172
|
import { Orq } from "@orq-ai/node";
|
|
275
173
|
|
|
@@ -278,45 +176,8 @@ const orq = new Orq({
|
|
|
278
176
|
});
|
|
279
177
|
|
|
280
178
|
async function run() {
|
|
281
|
-
const result = await orq.
|
|
282
|
-
|
|
283
|
-
model: "Golf",
|
|
284
|
-
orq: {
|
|
285
|
-
fallbacks: [
|
|
286
|
-
{
|
|
287
|
-
model: "openai/gpt-4o-mini",
|
|
288
|
-
},
|
|
289
|
-
],
|
|
290
|
-
cache: {
|
|
291
|
-
ttl: 3600,
|
|
292
|
-
type: "exact_match",
|
|
293
|
-
},
|
|
294
|
-
retry: {
|
|
295
|
-
onCodes: [
|
|
296
|
-
429,
|
|
297
|
-
500,
|
|
298
|
-
502,
|
|
299
|
-
503,
|
|
300
|
-
504,
|
|
301
|
-
],
|
|
302
|
-
},
|
|
303
|
-
contact: {
|
|
304
|
-
id: "contact_01ARZ3NDEKTSV4RRFFQ69G5FAV",
|
|
305
|
-
displayName: "Jane Doe",
|
|
306
|
-
email: "jane.doe@example.com",
|
|
307
|
-
metadata: [
|
|
308
|
-
{
|
|
309
|
-
"department": "Engineering",
|
|
310
|
-
"role": "Senior Developer",
|
|
311
|
-
},
|
|
312
|
-
],
|
|
313
|
-
logoUrl: "https://example.com/avatars/jane-doe.jpg",
|
|
314
|
-
tags: [
|
|
315
|
-
"hr",
|
|
316
|
-
"engineering",
|
|
317
|
-
],
|
|
318
|
-
},
|
|
319
|
-
},
|
|
179
|
+
const result = await orq.datasets.retrieve({
|
|
180
|
+
datasetId: "<id>",
|
|
320
181
|
});
|
|
321
182
|
|
|
322
183
|
console.log(result);
|
|
@@ -331,7 +192,7 @@ The standalone function version of this method:
|
|
|
331
192
|
|
|
332
193
|
```typescript
|
|
333
194
|
import { OrqCore } from "@orq-ai/node/core.js";
|
|
334
|
-
import {
|
|
195
|
+
import { datasetsRetrieve } from "@orq-ai/node/funcs/datasetsRetrieve.js";
|
|
335
196
|
|
|
336
197
|
// Use `OrqCore` for best tree-shaking performance.
|
|
337
198
|
// You can create one instance of it to use across an application.
|
|
@@ -340,51 +201,14 @@ const orq = new OrqCore({
|
|
|
340
201
|
});
|
|
341
202
|
|
|
342
203
|
async function run() {
|
|
343
|
-
const res = await
|
|
344
|
-
|
|
345
|
-
model: "Golf",
|
|
346
|
-
orq: {
|
|
347
|
-
fallbacks: [
|
|
348
|
-
{
|
|
349
|
-
model: "openai/gpt-4o-mini",
|
|
350
|
-
},
|
|
351
|
-
],
|
|
352
|
-
cache: {
|
|
353
|
-
ttl: 3600,
|
|
354
|
-
type: "exact_match",
|
|
355
|
-
},
|
|
356
|
-
retry: {
|
|
357
|
-
onCodes: [
|
|
358
|
-
429,
|
|
359
|
-
500,
|
|
360
|
-
502,
|
|
361
|
-
503,
|
|
362
|
-
504,
|
|
363
|
-
],
|
|
364
|
-
},
|
|
365
|
-
contact: {
|
|
366
|
-
id: "contact_01ARZ3NDEKTSV4RRFFQ69G5FAV",
|
|
367
|
-
displayName: "Jane Doe",
|
|
368
|
-
email: "jane.doe@example.com",
|
|
369
|
-
metadata: [
|
|
370
|
-
{
|
|
371
|
-
"department": "Engineering",
|
|
372
|
-
"role": "Senior Developer",
|
|
373
|
-
},
|
|
374
|
-
],
|
|
375
|
-
logoUrl: "https://example.com/avatars/jane-doe.jpg",
|
|
376
|
-
tags: [
|
|
377
|
-
"hr",
|
|
378
|
-
"engineering",
|
|
379
|
-
],
|
|
380
|
-
},
|
|
381
|
-
},
|
|
204
|
+
const res = await datasetsRetrieve(orq, {
|
|
205
|
+
datasetId: "<id>",
|
|
382
206
|
});
|
|
383
207
|
if (res.ok) {
|
|
384
208
|
const { value: result } = res;
|
|
385
209
|
console.log(result);
|
|
386
210
|
} else {
|
|
387
|
-
console.log("
|
|
211
|
+
console.log("datasetsRetrieve failed:", res.error);
|
|
388
212
|
}
|
|
389
213
|
}
|
|
390
214
|
|
|
@@ -395,28 +219,29 @@ run();
|
|
|
395
219
|
|
|
396
220
|
| Parameter | Type | Required | Description |
|
|
397
221
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
398
|
-
| `request` | [operations.
|
|
222
|
+
| `request` | [operations.RetrieveDatasetRequest](../../models/operations/retrievedatasetrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
399
223
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
400
224
|
| `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. |
|
|
401
225
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
402
226
|
|
|
403
227
|
### Response
|
|
404
228
|
|
|
405
|
-
**Promise\<[operations.
|
|
229
|
+
**Promise\<[operations.RetrieveDatasetResponseBody](../../models/operations/retrievedatasetresponsebody.md)\>**
|
|
406
230
|
|
|
407
231
|
### Errors
|
|
408
232
|
|
|
409
|
-
| Error Type
|
|
410
|
-
|
|
|
411
|
-
| errors.
|
|
233
|
+
| Error Type | Status Code | Content Type |
|
|
234
|
+
| ------------------- | ------------------- | ------------------- |
|
|
235
|
+
| errors.HonoApiError | 404 | application/json |
|
|
236
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
412
237
|
|
|
413
|
-
##
|
|
238
|
+
## update
|
|
414
239
|
|
|
415
|
-
|
|
240
|
+
Update a dataset
|
|
416
241
|
|
|
417
242
|
### Example Usage
|
|
418
243
|
|
|
419
|
-
<!-- UsageSnippet language="typescript" operationID="
|
|
244
|
+
<!-- UsageSnippet language="typescript" operationID="UpdateDataset" method="patch" path="/v2/datasets/{dataset_id}" -->
|
|
420
245
|
```typescript
|
|
421
246
|
import { Orq } from "@orq-ai/node";
|
|
422
247
|
|
|
@@ -425,45 +250,10 @@ const orq = new Orq({
|
|
|
425
250
|
});
|
|
426
251
|
|
|
427
252
|
async function run() {
|
|
428
|
-
const result = await orq.
|
|
429
|
-
|
|
430
|
-
|
|
431
|
-
|
|
432
|
-
orq: {
|
|
433
|
-
fallbacks: [
|
|
434
|
-
{
|
|
435
|
-
model: "openai/gpt-4o-mini",
|
|
436
|
-
},
|
|
437
|
-
],
|
|
438
|
-
cache: {
|
|
439
|
-
ttl: 3600,
|
|
440
|
-
type: "exact_match",
|
|
441
|
-
},
|
|
442
|
-
retry: {
|
|
443
|
-
onCodes: [
|
|
444
|
-
429,
|
|
445
|
-
500,
|
|
446
|
-
502,
|
|
447
|
-
503,
|
|
448
|
-
504,
|
|
449
|
-
],
|
|
450
|
-
},
|
|
451
|
-
contact: {
|
|
452
|
-
id: "contact_01ARZ3NDEKTSV4RRFFQ69G5FAV",
|
|
453
|
-
displayName: "Jane Doe",
|
|
454
|
-
email: "jane.doe@example.com",
|
|
455
|
-
metadata: [
|
|
456
|
-
{
|
|
457
|
-
"department": "Engineering",
|
|
458
|
-
"role": "Senior Developer",
|
|
459
|
-
},
|
|
460
|
-
],
|
|
461
|
-
logoUrl: "https://example.com/avatars/jane-doe.jpg",
|
|
462
|
-
tags: [
|
|
463
|
-
"hr",
|
|
464
|
-
"engineering",
|
|
465
|
-
],
|
|
466
|
-
},
|
|
253
|
+
const result = await orq.datasets.update({
|
|
254
|
+
datasetId: "<id>",
|
|
255
|
+
requestBody: {
|
|
256
|
+
path: "Default",
|
|
467
257
|
},
|
|
468
258
|
});
|
|
469
259
|
|
|
@@ -479,7 +269,7 @@ The standalone function version of this method:
|
|
|
479
269
|
|
|
480
270
|
```typescript
|
|
481
271
|
import { OrqCore } from "@orq-ai/node/core.js";
|
|
482
|
-
import {
|
|
272
|
+
import { datasetsUpdate } from "@orq-ai/node/funcs/datasetsUpdate.js";
|
|
483
273
|
|
|
484
274
|
// Use `OrqCore` for best tree-shaking performance.
|
|
485
275
|
// You can create one instance of it to use across an application.
|
|
@@ -488,52 +278,17 @@ const orq = new OrqCore({
|
|
|
488
278
|
});
|
|
489
279
|
|
|
490
280
|
async function run() {
|
|
491
|
-
const res = await
|
|
492
|
-
|
|
493
|
-
|
|
494
|
-
|
|
495
|
-
orq: {
|
|
496
|
-
fallbacks: [
|
|
497
|
-
{
|
|
498
|
-
model: "openai/gpt-4o-mini",
|
|
499
|
-
},
|
|
500
|
-
],
|
|
501
|
-
cache: {
|
|
502
|
-
ttl: 3600,
|
|
503
|
-
type: "exact_match",
|
|
504
|
-
},
|
|
505
|
-
retry: {
|
|
506
|
-
onCodes: [
|
|
507
|
-
429,
|
|
508
|
-
500,
|
|
509
|
-
502,
|
|
510
|
-
503,
|
|
511
|
-
504,
|
|
512
|
-
],
|
|
513
|
-
},
|
|
514
|
-
contact: {
|
|
515
|
-
id: "contact_01ARZ3NDEKTSV4RRFFQ69G5FAV",
|
|
516
|
-
displayName: "Jane Doe",
|
|
517
|
-
email: "jane.doe@example.com",
|
|
518
|
-
metadata: [
|
|
519
|
-
{
|
|
520
|
-
"department": "Engineering",
|
|
521
|
-
"role": "Senior Developer",
|
|
522
|
-
},
|
|
523
|
-
],
|
|
524
|
-
logoUrl: "https://example.com/avatars/jane-doe.jpg",
|
|
525
|
-
tags: [
|
|
526
|
-
"hr",
|
|
527
|
-
"engineering",
|
|
528
|
-
],
|
|
529
|
-
},
|
|
281
|
+
const res = await datasetsUpdate(orq, {
|
|
282
|
+
datasetId: "<id>",
|
|
283
|
+
requestBody: {
|
|
284
|
+
path: "Default",
|
|
530
285
|
},
|
|
531
286
|
});
|
|
532
287
|
if (res.ok) {
|
|
533
288
|
const { value: result } = res;
|
|
534
289
|
console.log(result);
|
|
535
290
|
} else {
|
|
536
|
-
console.log("
|
|
291
|
+
console.log("datasetsUpdate failed:", res.error);
|
|
537
292
|
}
|
|
538
293
|
}
|
|
539
294
|
|
|
@@ -544,28 +299,29 @@ run();
|
|
|
544
299
|
|
|
545
300
|
| Parameter | Type | Required | Description |
|
|
546
301
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
547
|
-
| `request` | [operations.
|
|
302
|
+
| `request` | [operations.UpdateDatasetRequest](../../models/operations/updatedatasetrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
548
303
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
549
304
|
| `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. |
|
|
550
305
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
551
306
|
|
|
552
307
|
### Response
|
|
553
308
|
|
|
554
|
-
**Promise\<[operations.
|
|
309
|
+
**Promise\<[operations.UpdateDatasetResponseBody](../../models/operations/updatedatasetresponsebody.md)\>**
|
|
555
310
|
|
|
556
311
|
### Errors
|
|
557
312
|
|
|
558
|
-
| Error Type
|
|
559
|
-
|
|
|
560
|
-
| errors.
|
|
313
|
+
| Error Type | Status Code | Content Type |
|
|
314
|
+
| ------------------- | ------------------- | ------------------- |
|
|
315
|
+
| errors.HonoApiError | 404 | application/json |
|
|
316
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
561
317
|
|
|
562
|
-
##
|
|
318
|
+
## delete
|
|
563
319
|
|
|
564
|
-
|
|
320
|
+
Permanently deletes a dataset and all its datapoints. This action is irreversible.
|
|
565
321
|
|
|
566
322
|
### Example Usage
|
|
567
323
|
|
|
568
|
-
<!-- UsageSnippet language="typescript" operationID="
|
|
324
|
+
<!-- UsageSnippet language="typescript" operationID="DeleteDataset" method="delete" path="/v2/datasets/{dataset_id}" -->
|
|
569
325
|
```typescript
|
|
570
326
|
import { Orq } from "@orq-ai/node";
|
|
571
327
|
|
|
@@ -574,49 +330,8 @@ const orq = new Orq({
|
|
|
574
330
|
});
|
|
575
331
|
|
|
576
332
|
async function run() {
|
|
577
|
-
await orq.
|
|
578
|
-
|
|
579
|
-
model: "openai/tts-1-hd",
|
|
580
|
-
voice: "<value>",
|
|
581
|
-
orq: {
|
|
582
|
-
retry: {
|
|
583
|
-
onCodes: [
|
|
584
|
-
429,
|
|
585
|
-
500,
|
|
586
|
-
502,
|
|
587
|
-
503,
|
|
588
|
-
504,
|
|
589
|
-
],
|
|
590
|
-
},
|
|
591
|
-
fallbacks: [
|
|
592
|
-
{
|
|
593
|
-
model: "openai/gpt-4o-mini",
|
|
594
|
-
},
|
|
595
|
-
],
|
|
596
|
-
contact: {
|
|
597
|
-
id: "contact_01ARZ3NDEKTSV4RRFFQ69G5FAV",
|
|
598
|
-
displayName: "Jane Doe",
|
|
599
|
-
email: "jane.doe@example.com",
|
|
600
|
-
metadata: [
|
|
601
|
-
{
|
|
602
|
-
"department": "Engineering",
|
|
603
|
-
"role": "Senior Developer",
|
|
604
|
-
},
|
|
605
|
-
],
|
|
606
|
-
logoUrl: "https://example.com/avatars/jane-doe.jpg",
|
|
607
|
-
tags: [
|
|
608
|
-
"hr",
|
|
609
|
-
"engineering",
|
|
610
|
-
],
|
|
611
|
-
},
|
|
612
|
-
thread: {
|
|
613
|
-
id: "thread_01ARZ3NDEKTSV4RRFFQ69G5FAV",
|
|
614
|
-
tags: [
|
|
615
|
-
"customer-support",
|
|
616
|
-
"priority-high",
|
|
617
|
-
],
|
|
618
|
-
},
|
|
619
|
-
},
|
|
333
|
+
await orq.datasets.delete({
|
|
334
|
+
datasetId: "<id>",
|
|
620
335
|
});
|
|
621
336
|
|
|
622
337
|
|
|
@@ -631,7 +346,7 @@ The standalone function version of this method:
|
|
|
631
346
|
|
|
632
347
|
```typescript
|
|
633
348
|
import { OrqCore } from "@orq-ai/node/core.js";
|
|
634
|
-
import {
|
|
349
|
+
import { datasetsDelete } from "@orq-ai/node/funcs/datasetsDelete.js";
|
|
635
350
|
|
|
636
351
|
// Use `OrqCore` for best tree-shaking performance.
|
|
637
352
|
// You can create one instance of it to use across an application.
|
|
@@ -640,55 +355,14 @@ const orq = new OrqCore({
|
|
|
640
355
|
});
|
|
641
356
|
|
|
642
357
|
async function run() {
|
|
643
|
-
const res = await
|
|
644
|
-
|
|
645
|
-
model: "openai/tts-1-hd",
|
|
646
|
-
voice: "<value>",
|
|
647
|
-
orq: {
|
|
648
|
-
retry: {
|
|
649
|
-
onCodes: [
|
|
650
|
-
429,
|
|
651
|
-
500,
|
|
652
|
-
502,
|
|
653
|
-
503,
|
|
654
|
-
504,
|
|
655
|
-
],
|
|
656
|
-
},
|
|
657
|
-
fallbacks: [
|
|
658
|
-
{
|
|
659
|
-
model: "openai/gpt-4o-mini",
|
|
660
|
-
},
|
|
661
|
-
],
|
|
662
|
-
contact: {
|
|
663
|
-
id: "contact_01ARZ3NDEKTSV4RRFFQ69G5FAV",
|
|
664
|
-
displayName: "Jane Doe",
|
|
665
|
-
email: "jane.doe@example.com",
|
|
666
|
-
metadata: [
|
|
667
|
-
{
|
|
668
|
-
"department": "Engineering",
|
|
669
|
-
"role": "Senior Developer",
|
|
670
|
-
},
|
|
671
|
-
],
|
|
672
|
-
logoUrl: "https://example.com/avatars/jane-doe.jpg",
|
|
673
|
-
tags: [
|
|
674
|
-
"hr",
|
|
675
|
-
"engineering",
|
|
676
|
-
],
|
|
677
|
-
},
|
|
678
|
-
thread: {
|
|
679
|
-
id: "thread_01ARZ3NDEKTSV4RRFFQ69G5FAV",
|
|
680
|
-
tags: [
|
|
681
|
-
"customer-support",
|
|
682
|
-
"priority-high",
|
|
683
|
-
],
|
|
684
|
-
},
|
|
685
|
-
},
|
|
358
|
+
const res = await datasetsDelete(orq, {
|
|
359
|
+
datasetId: "<id>",
|
|
686
360
|
});
|
|
687
361
|
if (res.ok) {
|
|
688
362
|
const { value: result } = res;
|
|
689
363
|
|
|
690
364
|
} else {
|
|
691
|
-
console.log("
|
|
365
|
+
console.log("datasetsDelete failed:", res.error);
|
|
692
366
|
}
|
|
693
367
|
}
|
|
694
368
|
|
|
@@ -699,7 +373,7 @@ run();
|
|
|
699
373
|
|
|
700
374
|
| Parameter | Type | Required | Description |
|
|
701
375
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
702
|
-
| `request` | [operations.
|
|
376
|
+
| `request` | [operations.DeleteDatasetRequest](../../models/operations/deletedatasetrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
703
377
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
704
378
|
| `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. |
|
|
705
379
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
@@ -714,13 +388,13 @@ run();
|
|
|
714
388
|
| --------------- | --------------- | --------------- |
|
|
715
389
|
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
716
390
|
|
|
717
|
-
##
|
|
391
|
+
## listDatapoints
|
|
718
392
|
|
|
719
|
-
|
|
393
|
+
Retrieves a paginated list of datapoints from a specific dataset.
|
|
720
394
|
|
|
721
395
|
### Example Usage
|
|
722
396
|
|
|
723
|
-
<!-- UsageSnippet language="typescript" operationID="
|
|
397
|
+
<!-- UsageSnippet language="typescript" operationID="ListDatasetDatapoints" method="get" path="/v2/datasets/{dataset_id}/datapoints" -->
|
|
724
398
|
```typescript
|
|
725
399
|
import { Orq } from "@orq-ai/node";
|
|
726
400
|
|
|
@@ -729,217 +403,8 @@ const orq = new Orq({
|
|
|
729
403
|
});
|
|
730
404
|
|
|
731
405
|
async function run() {
|
|
732
|
-
const result = await orq.
|
|
733
|
-
|
|
734
|
-
prompt: "<value>",
|
|
735
|
-
orq: {
|
|
736
|
-
retry: {
|
|
737
|
-
onCodes: [
|
|
738
|
-
429,
|
|
739
|
-
500,
|
|
740
|
-
502,
|
|
741
|
-
],
|
|
742
|
-
},
|
|
743
|
-
fallbacks: [
|
|
744
|
-
{
|
|
745
|
-
model: "openai/gpt-5",
|
|
746
|
-
},
|
|
747
|
-
{
|
|
748
|
-
model: "anthropic/claude-4-opus",
|
|
749
|
-
},
|
|
750
|
-
],
|
|
751
|
-
contact: {
|
|
752
|
-
id: "contact_01ARZ3NDEKTSV4RRFFQ69G5FAV",
|
|
753
|
-
displayName: "Jane Doe",
|
|
754
|
-
email: "jane.doe@example.com",
|
|
755
|
-
},
|
|
756
|
-
thread: {
|
|
757
|
-
id: "thread_01ARZ3NDEKTSV4RRFFQ69G5FAV",
|
|
758
|
-
tags: [
|
|
759
|
-
"customer-support",
|
|
760
|
-
],
|
|
761
|
-
},
|
|
762
|
-
inputs: {
|
|
763
|
-
"customer_name": "John Smith",
|
|
764
|
-
"issue_type": "billing",
|
|
765
|
-
},
|
|
766
|
-
cache: {
|
|
767
|
-
ttl: 3600,
|
|
768
|
-
type: "exact_match",
|
|
769
|
-
},
|
|
770
|
-
knowledgeBases: [
|
|
771
|
-
{
|
|
772
|
-
topK: 5,
|
|
773
|
-
knowledgeId: "knowledge_01ARZ3NDEKTSV4RRFFQ69G5FAV",
|
|
774
|
-
},
|
|
775
|
-
],
|
|
776
|
-
},
|
|
777
|
-
});
|
|
778
|
-
|
|
779
|
-
for await (const event of result) {
|
|
780
|
-
// Handle the event
|
|
781
|
-
console.log(event);
|
|
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 { proxyCompletions } from "@orq-ai/node/funcs/proxyCompletions.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 proxyCompletions(orq, {
|
|
804
|
-
model: "XTS",
|
|
805
|
-
prompt: "<value>",
|
|
806
|
-
orq: {
|
|
807
|
-
retry: {
|
|
808
|
-
onCodes: [
|
|
809
|
-
429,
|
|
810
|
-
500,
|
|
811
|
-
502,
|
|
812
|
-
],
|
|
813
|
-
},
|
|
814
|
-
fallbacks: [
|
|
815
|
-
{
|
|
816
|
-
model: "openai/gpt-5",
|
|
817
|
-
},
|
|
818
|
-
{
|
|
819
|
-
model: "anthropic/claude-4-opus",
|
|
820
|
-
},
|
|
821
|
-
],
|
|
822
|
-
contact: {
|
|
823
|
-
id: "contact_01ARZ3NDEKTSV4RRFFQ69G5FAV",
|
|
824
|
-
displayName: "Jane Doe",
|
|
825
|
-
email: "jane.doe@example.com",
|
|
826
|
-
},
|
|
827
|
-
thread: {
|
|
828
|
-
id: "thread_01ARZ3NDEKTSV4RRFFQ69G5FAV",
|
|
829
|
-
tags: [
|
|
830
|
-
"customer-support",
|
|
831
|
-
],
|
|
832
|
-
},
|
|
833
|
-
inputs: {
|
|
834
|
-
"customer_name": "John Smith",
|
|
835
|
-
"issue_type": "billing",
|
|
836
|
-
},
|
|
837
|
-
cache: {
|
|
838
|
-
ttl: 3600,
|
|
839
|
-
type: "exact_match",
|
|
840
|
-
},
|
|
841
|
-
knowledgeBases: [
|
|
842
|
-
{
|
|
843
|
-
topK: 5,
|
|
844
|
-
knowledgeId: "knowledge_01ARZ3NDEKTSV4RRFFQ69G5FAV",
|
|
845
|
-
},
|
|
846
|
-
],
|
|
847
|
-
},
|
|
848
|
-
});
|
|
849
|
-
if (res.ok) {
|
|
850
|
-
const { value: result } = res;
|
|
851
|
-
for await (const event of result) {
|
|
852
|
-
// Handle the event
|
|
853
|
-
console.log(event);
|
|
854
|
-
}
|
|
855
|
-
} else {
|
|
856
|
-
console.log("proxyCompletions failed:", res.error);
|
|
857
|
-
}
|
|
858
|
-
}
|
|
859
|
-
|
|
860
|
-
run();
|
|
861
|
-
```
|
|
862
|
-
|
|
863
|
-
### Parameters
|
|
864
|
-
|
|
865
|
-
| Parameter | Type | Required | Description |
|
|
866
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
867
|
-
| `request` | [operations.PostV2ProxyCompletionsRequestBody](../../models/operations/postv2proxycompletionsrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
868
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
869
|
-
| `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. |
|
|
870
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
871
|
-
|
|
872
|
-
### Response
|
|
873
|
-
|
|
874
|
-
**Promise\<[operations.PostV2ProxyCompletionsResponse](../../models/operations/postv2proxycompletionsresponse.md)\>**
|
|
875
|
-
|
|
876
|
-
### Errors
|
|
877
|
-
|
|
878
|
-
| Error Type | Status Code | Content Type |
|
|
879
|
-
| --------------- | --------------- | --------------- |
|
|
880
|
-
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
881
|
-
|
|
882
|
-
## imagesGenerate
|
|
883
|
-
|
|
884
|
-
Create an Image
|
|
885
|
-
|
|
886
|
-
### Example Usage
|
|
887
|
-
|
|
888
|
-
<!-- UsageSnippet language="typescript" operationID="post_/v2/proxy/images/generations" method="post" path="/v2/proxy/images/generations" -->
|
|
889
|
-
```typescript
|
|
890
|
-
import { Orq } from "@orq-ai/node";
|
|
891
|
-
|
|
892
|
-
const orq = new Orq({
|
|
893
|
-
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
894
|
-
});
|
|
895
|
-
|
|
896
|
-
async function run() {
|
|
897
|
-
const result = await orq.proxy.imagesGenerate({
|
|
898
|
-
prompt: "<value>",
|
|
899
|
-
model: "F-150",
|
|
900
|
-
orq: {
|
|
901
|
-
retry: {
|
|
902
|
-
onCodes: [
|
|
903
|
-
429,
|
|
904
|
-
500,
|
|
905
|
-
502,
|
|
906
|
-
503,
|
|
907
|
-
504,
|
|
908
|
-
],
|
|
909
|
-
},
|
|
910
|
-
fallbacks: [
|
|
911
|
-
{
|
|
912
|
-
model: "openai/gpt-4o-mini",
|
|
913
|
-
},
|
|
914
|
-
],
|
|
915
|
-
contact: {
|
|
916
|
-
id: "contact_01ARZ3NDEKTSV4RRFFQ69G5FAV",
|
|
917
|
-
displayName: "Jane Doe",
|
|
918
|
-
email: "jane.doe@example.com",
|
|
919
|
-
metadata: [
|
|
920
|
-
{
|
|
921
|
-
"department": "Engineering",
|
|
922
|
-
"role": "Senior Developer",
|
|
923
|
-
},
|
|
924
|
-
],
|
|
925
|
-
logoUrl: "https://example.com/avatars/jane-doe.jpg",
|
|
926
|
-
tags: [
|
|
927
|
-
"hr",
|
|
928
|
-
"engineering",
|
|
929
|
-
],
|
|
930
|
-
},
|
|
931
|
-
thread: {
|
|
932
|
-
id: "thread_01ARZ3NDEKTSV4RRFFQ69G5FAV",
|
|
933
|
-
tags: [
|
|
934
|
-
"customer-support",
|
|
935
|
-
"priority-high",
|
|
936
|
-
],
|
|
937
|
-
},
|
|
938
|
-
cache: {
|
|
939
|
-
ttl: 3600,
|
|
940
|
-
type: "exact_match",
|
|
941
|
-
},
|
|
942
|
-
},
|
|
406
|
+
const result = await orq.datasets.listDatapoints({
|
|
407
|
+
datasetId: "<id>",
|
|
943
408
|
});
|
|
944
409
|
|
|
945
410
|
console.log(result);
|
|
@@ -954,7 +419,7 @@ The standalone function version of this method:
|
|
|
954
419
|
|
|
955
420
|
```typescript
|
|
956
421
|
import { OrqCore } from "@orq-ai/node/core.js";
|
|
957
|
-
import {
|
|
422
|
+
import { datasetsListDatapoints } from "@orq-ai/node/funcs/datasetsListDatapoints.js";
|
|
958
423
|
|
|
959
424
|
// Use `OrqCore` for best tree-shaking performance.
|
|
960
425
|
// You can create one instance of it to use across an application.
|
|
@@ -963,58 +428,14 @@ const orq = new OrqCore({
|
|
|
963
428
|
});
|
|
964
429
|
|
|
965
430
|
async function run() {
|
|
966
|
-
const res = await
|
|
967
|
-
|
|
968
|
-
model: "F-150",
|
|
969
|
-
orq: {
|
|
970
|
-
retry: {
|
|
971
|
-
onCodes: [
|
|
972
|
-
429,
|
|
973
|
-
500,
|
|
974
|
-
502,
|
|
975
|
-
503,
|
|
976
|
-
504,
|
|
977
|
-
],
|
|
978
|
-
},
|
|
979
|
-
fallbacks: [
|
|
980
|
-
{
|
|
981
|
-
model: "openai/gpt-4o-mini",
|
|
982
|
-
},
|
|
983
|
-
],
|
|
984
|
-
contact: {
|
|
985
|
-
id: "contact_01ARZ3NDEKTSV4RRFFQ69G5FAV",
|
|
986
|
-
displayName: "Jane Doe",
|
|
987
|
-
email: "jane.doe@example.com",
|
|
988
|
-
metadata: [
|
|
989
|
-
{
|
|
990
|
-
"department": "Engineering",
|
|
991
|
-
"role": "Senior Developer",
|
|
992
|
-
},
|
|
993
|
-
],
|
|
994
|
-
logoUrl: "https://example.com/avatars/jane-doe.jpg",
|
|
995
|
-
tags: [
|
|
996
|
-
"hr",
|
|
997
|
-
"engineering",
|
|
998
|
-
],
|
|
999
|
-
},
|
|
1000
|
-
thread: {
|
|
1001
|
-
id: "thread_01ARZ3NDEKTSV4RRFFQ69G5FAV",
|
|
1002
|
-
tags: [
|
|
1003
|
-
"customer-support",
|
|
1004
|
-
"priority-high",
|
|
1005
|
-
],
|
|
1006
|
-
},
|
|
1007
|
-
cache: {
|
|
1008
|
-
ttl: 3600,
|
|
1009
|
-
type: "exact_match",
|
|
1010
|
-
},
|
|
1011
|
-
},
|
|
431
|
+
const res = await datasetsListDatapoints(orq, {
|
|
432
|
+
datasetId: "<id>",
|
|
1012
433
|
});
|
|
1013
434
|
if (res.ok) {
|
|
1014
435
|
const { value: result } = res;
|
|
1015
436
|
console.log(result);
|
|
1016
437
|
} else {
|
|
1017
|
-
console.log("
|
|
438
|
+
console.log("datasetsListDatapoints failed:", res.error);
|
|
1018
439
|
}
|
|
1019
440
|
}
|
|
1020
441
|
|
|
@@ -1025,14 +446,14 @@ run();
|
|
|
1025
446
|
|
|
1026
447
|
| Parameter | Type | Required | Description |
|
|
1027
448
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1028
|
-
| `request` | [operations.
|
|
449
|
+
| `request` | [operations.ListDatasetDatapointsRequest](../../models/operations/listdatasetdatapointsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1029
450
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1030
451
|
| `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. |
|
|
1031
452
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1032
453
|
|
|
1033
454
|
### Response
|
|
1034
455
|
|
|
1035
|
-
**Promise\<[operations.
|
|
456
|
+
**Promise\<[operations.ListDatasetDatapointsResponseBody](../../models/operations/listdatasetdatapointsresponsebody.md)\>**
|
|
1036
457
|
|
|
1037
458
|
### Errors
|
|
1038
459
|
|
|
@@ -1040,13 +461,13 @@ run();
|
|
|
1040
461
|
| --------------- | --------------- | --------------- |
|
|
1041
462
|
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
1042
463
|
|
|
1043
|
-
##
|
|
464
|
+
## createDatapoint
|
|
1044
465
|
|
|
1045
|
-
|
|
466
|
+
Creates a new datapoint in the specified dataset.
|
|
1046
467
|
|
|
1047
468
|
### Example Usage
|
|
1048
469
|
|
|
1049
|
-
<!-- UsageSnippet language="typescript" operationID="
|
|
470
|
+
<!-- UsageSnippet language="typescript" operationID="CreateDatasetItem" method="post" path="/v2/datasets/{dataset_id}/datapoints" -->
|
|
1050
471
|
```typescript
|
|
1051
472
|
import { Orq } from "@orq-ai/node";
|
|
1052
473
|
|
|
@@ -1055,10 +476,8 @@ const orq = new Orq({
|
|
|
1055
476
|
});
|
|
1056
477
|
|
|
1057
478
|
async function run() {
|
|
1058
|
-
const result = await orq.
|
|
1059
|
-
|
|
1060
|
-
image: "https://picsum.photos/seed/4IopZRfO/3966/2653",
|
|
1061
|
-
prompt: "<value>",
|
|
479
|
+
const result = await orq.datasets.createDatapoint({
|
|
480
|
+
datasetId: "<id>",
|
|
1062
481
|
});
|
|
1063
482
|
|
|
1064
483
|
console.log(result);
|
|
@@ -1073,7 +492,7 @@ The standalone function version of this method:
|
|
|
1073
492
|
|
|
1074
493
|
```typescript
|
|
1075
494
|
import { OrqCore } from "@orq-ai/node/core.js";
|
|
1076
|
-
import {
|
|
495
|
+
import { datasetsCreateDatapoint } from "@orq-ai/node/funcs/datasetsCreateDatapoint.js";
|
|
1077
496
|
|
|
1078
497
|
// Use `OrqCore` for best tree-shaking performance.
|
|
1079
498
|
// You can create one instance of it to use across an application.
|
|
@@ -1082,16 +501,14 @@ const orq = new OrqCore({
|
|
|
1082
501
|
});
|
|
1083
502
|
|
|
1084
503
|
async function run() {
|
|
1085
|
-
const res = await
|
|
1086
|
-
|
|
1087
|
-
image: "https://picsum.photos/seed/4IopZRfO/3966/2653",
|
|
1088
|
-
prompt: "<value>",
|
|
504
|
+
const res = await datasetsCreateDatapoint(orq, {
|
|
505
|
+
datasetId: "<id>",
|
|
1089
506
|
});
|
|
1090
507
|
if (res.ok) {
|
|
1091
508
|
const { value: result } = res;
|
|
1092
509
|
console.log(result);
|
|
1093
510
|
} else {
|
|
1094
|
-
console.log("
|
|
511
|
+
console.log("datasetsCreateDatapoint failed:", res.error);
|
|
1095
512
|
}
|
|
1096
513
|
}
|
|
1097
514
|
|
|
@@ -1102,14 +519,14 @@ run();
|
|
|
1102
519
|
|
|
1103
520
|
| Parameter | Type | Required | Description |
|
|
1104
521
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1105
|
-
| `request` | [operations.
|
|
522
|
+
| `request` | [operations.CreateDatasetItemRequest](../../models/operations/createdatasetitemrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1106
523
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1107
524
|
| `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. |
|
|
1108
525
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1109
526
|
|
|
1110
527
|
### Response
|
|
1111
528
|
|
|
1112
|
-
**Promise\<[operations.
|
|
529
|
+
**Promise\<[operations.ResponseBody[]](../../models/.md)\>**
|
|
1113
530
|
|
|
1114
531
|
### Errors
|
|
1115
532
|
|
|
@@ -1117,13 +534,13 @@ run();
|
|
|
1117
534
|
| --------------- | --------------- | --------------- |
|
|
1118
535
|
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
1119
536
|
|
|
1120
|
-
##
|
|
537
|
+
## retrieveDatapoint
|
|
1121
538
|
|
|
1122
|
-
|
|
539
|
+
Retrieves a datapoint object
|
|
1123
540
|
|
|
1124
541
|
### Example Usage
|
|
1125
542
|
|
|
1126
|
-
<!-- UsageSnippet language="typescript" operationID="
|
|
543
|
+
<!-- UsageSnippet language="typescript" operationID="RetrieveDatapoint" method="get" path="/v2/datasets/{dataset_id}/datapoints/{datapoint_id}" -->
|
|
1127
544
|
```typescript
|
|
1128
545
|
import { Orq } from "@orq-ai/node";
|
|
1129
546
|
|
|
@@ -1132,9 +549,9 @@ const orq = new Orq({
|
|
|
1132
549
|
});
|
|
1133
550
|
|
|
1134
551
|
async function run() {
|
|
1135
|
-
const result = await orq.
|
|
1136
|
-
|
|
1137
|
-
|
|
552
|
+
const result = await orq.datasets.retrieveDatapoint({
|
|
553
|
+
datasetId: "<id>",
|
|
554
|
+
datapointId: "<id>",
|
|
1138
555
|
});
|
|
1139
556
|
|
|
1140
557
|
console.log(result);
|
|
@@ -1149,7 +566,7 @@ The standalone function version of this method:
|
|
|
1149
566
|
|
|
1150
567
|
```typescript
|
|
1151
568
|
import { OrqCore } from "@orq-ai/node/core.js";
|
|
1152
|
-
import {
|
|
569
|
+
import { datasetsRetrieveDatapoint } from "@orq-ai/node/funcs/datasetsRetrieveDatapoint.js";
|
|
1153
570
|
|
|
1154
571
|
// Use `OrqCore` for best tree-shaking performance.
|
|
1155
572
|
// You can create one instance of it to use across an application.
|
|
@@ -1158,15 +575,15 @@ const orq = new OrqCore({
|
|
|
1158
575
|
});
|
|
1159
576
|
|
|
1160
577
|
async function run() {
|
|
1161
|
-
const res = await
|
|
1162
|
-
|
|
1163
|
-
|
|
578
|
+
const res = await datasetsRetrieveDatapoint(orq, {
|
|
579
|
+
datasetId: "<id>",
|
|
580
|
+
datapointId: "<id>",
|
|
1164
581
|
});
|
|
1165
582
|
if (res.ok) {
|
|
1166
583
|
const { value: result } = res;
|
|
1167
584
|
console.log(result);
|
|
1168
585
|
} else {
|
|
1169
|
-
console.log("
|
|
586
|
+
console.log("datasetsRetrieveDatapoint failed:", res.error);
|
|
1170
587
|
}
|
|
1171
588
|
}
|
|
1172
589
|
|
|
@@ -1177,42 +594,40 @@ run();
|
|
|
1177
594
|
|
|
1178
595
|
| Parameter | Type | Required | Description |
|
|
1179
596
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1180
|
-
| `request` | [operations.
|
|
597
|
+
| `request` | [operations.RetrieveDatapointRequest](../../models/operations/retrievedatapointrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1181
598
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1182
599
|
| `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. |
|
|
1183
600
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1184
601
|
|
|
1185
602
|
### Response
|
|
1186
603
|
|
|
1187
|
-
**Promise\<[operations.
|
|
604
|
+
**Promise\<[operations.RetrieveDatapointResponseBody](../../models/operations/retrievedatapointresponsebody.md)\>**
|
|
1188
605
|
|
|
1189
606
|
### Errors
|
|
1190
607
|
|
|
1191
|
-
| Error Type
|
|
1192
|
-
|
|
|
1193
|
-
| errors.
|
|
608
|
+
| Error Type | Status Code | Content Type |
|
|
609
|
+
| ------------------- | ------------------- | ------------------- |
|
|
610
|
+
| errors.HonoApiError | 404 | application/json |
|
|
611
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
1194
612
|
|
|
1195
|
-
##
|
|
613
|
+
## updateDatapoint
|
|
614
|
+
|
|
615
|
+
Update a datapoint
|
|
1196
616
|
|
|
1197
617
|
### Example Usage
|
|
1198
618
|
|
|
1199
|
-
<!-- UsageSnippet language="typescript" operationID="
|
|
619
|
+
<!-- UsageSnippet language="typescript" operationID="UpdateDatapoint" method="patch" path="/v2/datasets/{dataset_id}/datapoints/{datapoint_id}" -->
|
|
1200
620
|
```typescript
|
|
1201
621
|
import { Orq } from "@orq-ai/node";
|
|
1202
|
-
import { openAsBlob } from "node:fs";
|
|
1203
622
|
|
|
1204
623
|
const orq = new Orq({
|
|
1205
624
|
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
1206
625
|
});
|
|
1207
626
|
|
|
1208
627
|
async function run() {
|
|
1209
|
-
const result = await orq.
|
|
1210
|
-
|
|
1211
|
-
|
|
1212
|
-
"word",
|
|
1213
|
-
"segment",
|
|
1214
|
-
],
|
|
1215
|
-
file: await openAsBlob("example.file"),
|
|
628
|
+
const result = await orq.datasets.updateDatapoint({
|
|
629
|
+
datasetId: "<id>",
|
|
630
|
+
datapointId: "<id>",
|
|
1216
631
|
});
|
|
1217
632
|
|
|
1218
633
|
console.log(result);
|
|
@@ -1227,8 +642,7 @@ The standalone function version of this method:
|
|
|
1227
642
|
|
|
1228
643
|
```typescript
|
|
1229
644
|
import { OrqCore } from "@orq-ai/node/core.js";
|
|
1230
|
-
import {
|
|
1231
|
-
import { openAsBlob } from "node:fs";
|
|
645
|
+
import { datasetsUpdateDatapoint } from "@orq-ai/node/funcs/datasetsUpdateDatapoint.js";
|
|
1232
646
|
|
|
1233
647
|
// Use `OrqCore` for best tree-shaking performance.
|
|
1234
648
|
// You can create one instance of it to use across an application.
|
|
@@ -1237,19 +651,15 @@ const orq = new OrqCore({
|
|
|
1237
651
|
});
|
|
1238
652
|
|
|
1239
653
|
async function run() {
|
|
1240
|
-
const res = await
|
|
1241
|
-
|
|
1242
|
-
|
|
1243
|
-
"word",
|
|
1244
|
-
"segment",
|
|
1245
|
-
],
|
|
1246
|
-
file: await openAsBlob("example.file"),
|
|
654
|
+
const res = await datasetsUpdateDatapoint(orq, {
|
|
655
|
+
datasetId: "<id>",
|
|
656
|
+
datapointId: "<id>",
|
|
1247
657
|
});
|
|
1248
658
|
if (res.ok) {
|
|
1249
659
|
const { value: result } = res;
|
|
1250
660
|
console.log(result);
|
|
1251
661
|
} else {
|
|
1252
|
-
console.log("
|
|
662
|
+
console.log("datasetsUpdateDatapoint failed:", res.error);
|
|
1253
663
|
}
|
|
1254
664
|
}
|
|
1255
665
|
|
|
@@ -1260,42 +670,43 @@ run();
|
|
|
1260
670
|
|
|
1261
671
|
| Parameter | Type | Required | Description |
|
|
1262
672
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1263
|
-
| `request` | [operations.
|
|
673
|
+
| `request` | [operations.UpdateDatapointRequest](../../models/operations/updatedatapointrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1264
674
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1265
675
|
| `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. |
|
|
1266
676
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1267
677
|
|
|
1268
678
|
### Response
|
|
1269
679
|
|
|
1270
|
-
**Promise\<[operations.
|
|
680
|
+
**Promise\<[operations.UpdateDatapointResponseBody](../../models/operations/updatedatapointresponsebody.md)\>**
|
|
1271
681
|
|
|
1272
682
|
### Errors
|
|
1273
683
|
|
|
1274
|
-
| Error Type
|
|
1275
|
-
|
|
|
1276
|
-
| errors.
|
|
1277
|
-
| errors.APIError
|
|
684
|
+
| Error Type | Status Code | Content Type |
|
|
685
|
+
| ------------------- | ------------------- | ------------------- |
|
|
686
|
+
| errors.HonoApiError | 404 | application/json |
|
|
687
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
688
|
+
|
|
689
|
+
## deleteDatapoint
|
|
1278
690
|
|
|
1279
|
-
|
|
691
|
+
Permanently deletes a specific datapoint from a dataset.
|
|
1280
692
|
|
|
1281
693
|
### Example Usage
|
|
1282
694
|
|
|
1283
|
-
<!-- UsageSnippet language="typescript" operationID="
|
|
695
|
+
<!-- UsageSnippet language="typescript" operationID="DeleteDatapoint" method="delete" path="/v2/datasets/{dataset_id}/datapoints/{datapoint_id}" -->
|
|
1284
696
|
```typescript
|
|
1285
697
|
import { Orq } from "@orq-ai/node";
|
|
1286
|
-
import { openAsBlob } from "node:fs";
|
|
1287
698
|
|
|
1288
699
|
const orq = new Orq({
|
|
1289
700
|
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
1290
701
|
});
|
|
1291
702
|
|
|
1292
703
|
async function run() {
|
|
1293
|
-
|
|
1294
|
-
|
|
1295
|
-
|
|
704
|
+
await orq.datasets.deleteDatapoint({
|
|
705
|
+
datasetId: "<id>",
|
|
706
|
+
datapointId: "<id>",
|
|
1296
707
|
});
|
|
1297
708
|
|
|
1298
|
-
|
|
709
|
+
|
|
1299
710
|
}
|
|
1300
711
|
|
|
1301
712
|
run();
|
|
@@ -1307,8 +718,7 @@ The standalone function version of this method:
|
|
|
1307
718
|
|
|
1308
719
|
```typescript
|
|
1309
720
|
import { OrqCore } from "@orq-ai/node/core.js";
|
|
1310
|
-
import {
|
|
1311
|
-
import { openAsBlob } from "node:fs";
|
|
721
|
+
import { datasetsDeleteDatapoint } from "@orq-ai/node/funcs/datasetsDeleteDatapoint.js";
|
|
1312
722
|
|
|
1313
723
|
// Use `OrqCore` for best tree-shaking performance.
|
|
1314
724
|
// You can create one instance of it to use across an application.
|
|
@@ -1317,15 +727,15 @@ const orq = new OrqCore({
|
|
|
1317
727
|
});
|
|
1318
728
|
|
|
1319
729
|
async function run() {
|
|
1320
|
-
const res = await
|
|
1321
|
-
|
|
1322
|
-
|
|
730
|
+
const res = await datasetsDeleteDatapoint(orq, {
|
|
731
|
+
datasetId: "<id>",
|
|
732
|
+
datapointId: "<id>",
|
|
1323
733
|
});
|
|
1324
734
|
if (res.ok) {
|
|
1325
735
|
const { value: result } = res;
|
|
1326
|
-
|
|
736
|
+
|
|
1327
737
|
} else {
|
|
1328
|
-
console.log("
|
|
738
|
+
console.log("datasetsDeleteDatapoint failed:", res.error);
|
|
1329
739
|
}
|
|
1330
740
|
}
|
|
1331
741
|
|
|
@@ -1336,29 +746,29 @@ run();
|
|
|
1336
746
|
|
|
1337
747
|
| Parameter | Type | Required | Description |
|
|
1338
748
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1339
|
-
| `request` | [operations.
|
|
749
|
+
| `request` | [operations.DeleteDatapointRequest](../../models/operations/deletedatapointrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1340
750
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1341
751
|
| `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. |
|
|
1342
752
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1343
753
|
|
|
1344
754
|
### Response
|
|
1345
755
|
|
|
1346
|
-
**Promise\<
|
|
756
|
+
**Promise\<void\>**
|
|
1347
757
|
|
|
1348
758
|
### Errors
|
|
1349
759
|
|
|
1350
|
-
| Error Type
|
|
1351
|
-
|
|
|
1352
|
-
| errors.
|
|
1353
|
-
| errors.APIError
|
|
760
|
+
| Error Type | Status Code | Content Type |
|
|
761
|
+
| ------------------- | ------------------- | ------------------- |
|
|
762
|
+
| errors.HonoApiError | 404 | application/json |
|
|
763
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
1354
764
|
|
|
1355
|
-
##
|
|
765
|
+
## clear
|
|
1356
766
|
|
|
1357
|
-
|
|
767
|
+
Delete all datapoints from a dataset. This action is irreversible.
|
|
1358
768
|
|
|
1359
769
|
### Example Usage
|
|
1360
770
|
|
|
1361
|
-
<!-- UsageSnippet language="typescript" operationID="
|
|
771
|
+
<!-- UsageSnippet language="typescript" operationID="ClearDataset" method="delete" path="/v2/datasets/{dataset_id}/clear" -->
|
|
1362
772
|
```typescript
|
|
1363
773
|
import { Orq } from "@orq-ai/node";
|
|
1364
774
|
|
|
@@ -1367,15 +777,11 @@ const orq = new Orq({
|
|
|
1367
777
|
});
|
|
1368
778
|
|
|
1369
779
|
async function run() {
|
|
1370
|
-
|
|
1371
|
-
|
|
1372
|
-
input: "<value>",
|
|
780
|
+
await orq.datasets.clear({
|
|
781
|
+
datasetId: "<id>",
|
|
1373
782
|
});
|
|
1374
783
|
|
|
1375
|
-
|
|
1376
|
-
// Handle the event
|
|
1377
|
-
console.log(event);
|
|
1378
|
-
}
|
|
784
|
+
|
|
1379
785
|
}
|
|
1380
786
|
|
|
1381
787
|
run();
|
|
@@ -1387,7 +793,7 @@ The standalone function version of this method:
|
|
|
1387
793
|
|
|
1388
794
|
```typescript
|
|
1389
795
|
import { OrqCore } from "@orq-ai/node/core.js";
|
|
1390
|
-
import {
|
|
796
|
+
import { datasetsClear } from "@orq-ai/node/funcs/datasetsClear.js";
|
|
1391
797
|
|
|
1392
798
|
// Use `OrqCore` for best tree-shaking performance.
|
|
1393
799
|
// You can create one instance of it to use across an application.
|
|
@@ -1396,18 +802,14 @@ const orq = new OrqCore({
|
|
|
1396
802
|
});
|
|
1397
803
|
|
|
1398
804
|
async function run() {
|
|
1399
|
-
const res = await
|
|
1400
|
-
|
|
1401
|
-
input: "<value>",
|
|
805
|
+
const res = await datasetsClear(orq, {
|
|
806
|
+
datasetId: "<id>",
|
|
1402
807
|
});
|
|
1403
808
|
if (res.ok) {
|
|
1404
809
|
const { value: result } = res;
|
|
1405
|
-
|
|
1406
|
-
// Handle the event
|
|
1407
|
-
console.log(event);
|
|
1408
|
-
}
|
|
810
|
+
|
|
1409
811
|
} else {
|
|
1410
|
-
console.log("
|
|
812
|
+
console.log("datasetsClear failed:", res.error);
|
|
1411
813
|
}
|
|
1412
814
|
}
|
|
1413
815
|
|
|
@@ -1418,14 +820,14 @@ run();
|
|
|
1418
820
|
|
|
1419
821
|
| Parameter | Type | Required | Description |
|
|
1420
822
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1421
|
-
| `request` | [operations.
|
|
823
|
+
| `request` | [operations.ClearDatasetRequest](../../models/operations/cleardatasetrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1422
824
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1423
825
|
| `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. |
|
|
1424
826
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1425
827
|
|
|
1426
828
|
### Response
|
|
1427
829
|
|
|
1428
|
-
**Promise\<
|
|
830
|
+
**Promise\<void\>**
|
|
1429
831
|
|
|
1430
832
|
### Errors
|
|
1431
833
|
|