@orq-ai/node 3.6.10 → 3.6.12
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 +34 -27
- package/bin/mcp-server.js +370 -236
- package/bin/mcp-server.js.map +84 -82
- package/funcs/contactsCreate.d.ts +3 -2
- package/funcs/contactsCreate.d.ts.map +1 -1
- package/funcs/contactsCreate.js +1 -1
- package/funcs/contactsCreate.js.map +1 -1
- package/funcs/datasetsClear.d.ts +3 -2
- package/funcs/datasetsClear.d.ts.map +1 -1
- package/funcs/datasetsClear.js +1 -1
- package/funcs/datasetsClear.js.map +1 -1
- package/funcs/datasetsCreate.d.ts +3 -2
- package/funcs/datasetsCreate.d.ts.map +1 -1
- package/funcs/datasetsCreate.js +1 -1
- package/funcs/datasetsCreate.js.map +1 -1
- package/funcs/datasetsCreateDatapoint.d.ts +3 -2
- package/funcs/datasetsCreateDatapoint.d.ts.map +1 -1
- package/funcs/datasetsCreateDatapoint.js +1 -1
- package/funcs/datasetsCreateDatapoint.js.map +1 -1
- package/funcs/datasetsCreateDatapoints.d.ts +3 -2
- package/funcs/datasetsCreateDatapoints.d.ts.map +1 -1
- package/funcs/datasetsCreateDatapoints.js +1 -1
- package/funcs/datasetsCreateDatapoints.js.map +1 -1
- package/funcs/datasetsCreateExperiment.d.ts +3 -2
- package/funcs/datasetsCreateExperiment.d.ts.map +1 -1
- package/funcs/datasetsCreateExperiment.js +1 -1
- package/funcs/datasetsCreateExperiment.js.map +1 -1
- package/funcs/datasetsDelete.d.ts +3 -2
- package/funcs/datasetsDelete.d.ts.map +1 -1
- package/funcs/datasetsDelete.js +1 -1
- package/funcs/datasetsDelete.js.map +1 -1
- package/funcs/datasetsDeleteDatapoint.d.ts +3 -2
- package/funcs/datasetsDeleteDatapoint.d.ts.map +1 -1
- package/funcs/datasetsDeleteDatapoint.js +1 -1
- package/funcs/datasetsDeleteDatapoint.js.map +1 -1
- package/funcs/datasetsList.d.ts +3 -2
- package/funcs/datasetsList.d.ts.map +1 -1
- package/funcs/datasetsList.js +1 -1
- package/funcs/datasetsList.js.map +1 -1
- package/funcs/datasetsListDatapoints.d.ts +3 -2
- package/funcs/datasetsListDatapoints.d.ts.map +1 -1
- package/funcs/datasetsListDatapoints.js +1 -1
- package/funcs/datasetsListDatapoints.js.map +1 -1
- package/funcs/datasetsRetrieve.d.ts +3 -2
- package/funcs/datasetsRetrieve.d.ts.map +1 -1
- package/funcs/datasetsRetrieve.js +1 -1
- package/funcs/datasetsRetrieve.js.map +1 -1
- package/funcs/datasetsRetrieveDatapoint.d.ts +3 -2
- package/funcs/datasetsRetrieveDatapoint.d.ts.map +1 -1
- package/funcs/datasetsRetrieveDatapoint.js +1 -1
- package/funcs/datasetsRetrieveDatapoint.js.map +1 -1
- package/funcs/datasetsUpdate.d.ts +3 -2
- package/funcs/datasetsUpdate.d.ts.map +1 -1
- package/funcs/datasetsUpdate.js +1 -1
- package/funcs/datasetsUpdate.js.map +1 -1
- package/funcs/datasetsUpdateDatapoint.d.ts +3 -2
- package/funcs/datasetsUpdateDatapoint.d.ts.map +1 -1
- package/funcs/datasetsUpdateDatapoint.js +1 -1
- package/funcs/datasetsUpdateDatapoint.js.map +1 -1
- package/funcs/deploymentsCreateExperiment.d.ts +3 -2
- package/funcs/deploymentsCreateExperiment.d.ts.map +1 -1
- package/funcs/deploymentsCreateExperiment.js +1 -1
- package/funcs/deploymentsCreateExperiment.js.map +1 -1
- package/funcs/deploymentsGetConfig.d.ts +3 -2
- package/funcs/deploymentsGetConfig.d.ts.map +1 -1
- package/funcs/deploymentsGetConfig.js +1 -1
- package/funcs/deploymentsGetConfig.js.map +1 -1
- package/funcs/deploymentsInvoke.d.ts +3 -2
- package/funcs/deploymentsInvoke.d.ts.map +1 -1
- package/funcs/deploymentsInvoke.js +1 -1
- package/funcs/deploymentsInvoke.js.map +1 -1
- package/funcs/deploymentsList.d.ts +3 -2
- package/funcs/deploymentsList.d.ts.map +1 -1
- package/funcs/deploymentsList.js +1 -1
- package/funcs/deploymentsList.js.map +1 -1
- package/funcs/deploymentsMetricsCreate.d.ts +3 -2
- package/funcs/deploymentsMetricsCreate.d.ts.map +1 -1
- package/funcs/deploymentsMetricsCreate.js +1 -1
- package/funcs/deploymentsMetricsCreate.js.map +1 -1
- package/funcs/deploymentsStream.d.ts +3 -2
- package/funcs/deploymentsStream.d.ts.map +1 -1
- package/funcs/deploymentsStream.js +1 -1
- package/funcs/deploymentsStream.js.map +1 -1
- package/funcs/feedbackCreate.d.ts +3 -2
- package/funcs/feedbackCreate.d.ts.map +1 -1
- package/funcs/feedbackCreate.js +1 -1
- package/funcs/feedbackCreate.js.map +1 -1
- package/funcs/filesCreate.d.ts +3 -2
- package/funcs/filesCreate.d.ts.map +1 -1
- package/funcs/filesCreate.js +8 -4
- package/funcs/filesCreate.js.map +1 -1
- package/funcs/filesDelete.d.ts +3 -2
- package/funcs/filesDelete.d.ts.map +1 -1
- package/funcs/filesDelete.js +1 -1
- package/funcs/filesDelete.js.map +1 -1
- package/funcs/filesGet.d.ts +3 -2
- package/funcs/filesGet.d.ts.map +1 -1
- package/funcs/filesGet.js +1 -1
- package/funcs/filesGet.js.map +1 -1
- package/funcs/filesList.d.ts +3 -2
- package/funcs/filesList.d.ts.map +1 -1
- package/funcs/filesList.js +1 -1
- package/funcs/filesList.js.map +1 -1
- package/funcs/knowledgeCreate.d.ts +3 -2
- package/funcs/knowledgeCreate.d.ts.map +1 -1
- package/funcs/knowledgeCreate.js +1 -1
- package/funcs/knowledgeCreate.js.map +1 -1
- package/funcs/knowledgeCreateChunks.d.ts +3 -2
- package/funcs/knowledgeCreateChunks.d.ts.map +1 -1
- package/funcs/knowledgeCreateChunks.js +1 -1
- package/funcs/knowledgeCreateChunks.js.map +1 -1
- package/funcs/knowledgeCreateDatasource.d.ts +3 -2
- package/funcs/knowledgeCreateDatasource.d.ts.map +1 -1
- package/funcs/knowledgeCreateDatasource.js +1 -1
- package/funcs/knowledgeCreateDatasource.js.map +1 -1
- package/funcs/knowledgeDelete.d.ts +3 -2
- package/funcs/knowledgeDelete.d.ts.map +1 -1
- package/funcs/knowledgeDelete.js +1 -1
- package/funcs/knowledgeDelete.js.map +1 -1
- package/funcs/knowledgeDeleteChunk.d.ts +3 -2
- package/funcs/knowledgeDeleteChunk.d.ts.map +1 -1
- package/funcs/knowledgeDeleteChunk.js +1 -1
- package/funcs/knowledgeDeleteChunk.js.map +1 -1
- package/funcs/knowledgeDeleteDatasource.d.ts +3 -2
- package/funcs/knowledgeDeleteDatasource.d.ts.map +1 -1
- package/funcs/knowledgeDeleteDatasource.js +1 -1
- package/funcs/knowledgeDeleteDatasource.js.map +1 -1
- package/funcs/knowledgeList.d.ts +3 -2
- package/funcs/knowledgeList.d.ts.map +1 -1
- package/funcs/knowledgeList.js +1 -1
- package/funcs/knowledgeList.js.map +1 -1
- package/funcs/knowledgeListChunks.d.ts +3 -2
- package/funcs/knowledgeListChunks.d.ts.map +1 -1
- package/funcs/knowledgeListChunks.js +1 -1
- package/funcs/knowledgeListChunks.js.map +1 -1
- package/funcs/knowledgeListDatasources.d.ts +3 -2
- package/funcs/knowledgeListDatasources.d.ts.map +1 -1
- package/funcs/knowledgeListDatasources.js +1 -1
- package/funcs/knowledgeListDatasources.js.map +1 -1
- package/funcs/knowledgeRetrieve.d.ts +3 -2
- package/funcs/knowledgeRetrieve.d.ts.map +1 -1
- package/funcs/knowledgeRetrieve.js +1 -1
- package/funcs/knowledgeRetrieve.js.map +1 -1
- package/funcs/knowledgeRetrieveChunk.d.ts +3 -2
- package/funcs/knowledgeRetrieveChunk.d.ts.map +1 -1
- package/funcs/knowledgeRetrieveChunk.js +1 -1
- package/funcs/knowledgeRetrieveChunk.js.map +1 -1
- package/funcs/knowledgeRetrieveDatasource.d.ts +3 -2
- package/funcs/knowledgeRetrieveDatasource.d.ts.map +1 -1
- package/funcs/knowledgeRetrieveDatasource.js +1 -1
- package/funcs/knowledgeRetrieveDatasource.js.map +1 -1
- package/funcs/knowledgeSearch.d.ts +3 -2
- package/funcs/knowledgeSearch.d.ts.map +1 -1
- package/funcs/knowledgeSearch.js +1 -1
- package/funcs/knowledgeSearch.js.map +1 -1
- package/funcs/knowledgeUpdate.d.ts +3 -2
- package/funcs/knowledgeUpdate.d.ts.map +1 -1
- package/funcs/knowledgeUpdate.js +1 -1
- package/funcs/knowledgeUpdate.js.map +1 -1
- package/funcs/knowledgeUpdateChunk.d.ts +3 -2
- package/funcs/knowledgeUpdateChunk.d.ts.map +1 -1
- package/funcs/knowledgeUpdateChunk.js +1 -1
- package/funcs/knowledgeUpdateChunk.js.map +1 -1
- package/funcs/knowledgeUpdateDatasource.d.ts +3 -2
- package/funcs/knowledgeUpdateDatasource.d.ts.map +1 -1
- package/funcs/knowledgeUpdateDatasource.js +1 -1
- package/funcs/knowledgeUpdateDatasource.js.map +1 -1
- package/funcs/modelsList.d.ts +3 -2
- package/funcs/modelsList.d.ts.map +1 -1
- package/funcs/modelsList.js +1 -1
- package/funcs/modelsList.js.map +1 -1
- package/funcs/promptsCreate.d.ts +3 -2
- package/funcs/promptsCreate.d.ts.map +1 -1
- package/funcs/promptsCreate.js +1 -1
- package/funcs/promptsCreate.js.map +1 -1
- package/funcs/promptsDelete.d.ts +3 -2
- package/funcs/promptsDelete.d.ts.map +1 -1
- package/funcs/promptsDelete.js +1 -1
- package/funcs/promptsDelete.js.map +1 -1
- package/funcs/promptsGetVersion.d.ts +3 -2
- package/funcs/promptsGetVersion.d.ts.map +1 -1
- package/funcs/promptsGetVersion.js +1 -1
- package/funcs/promptsGetVersion.js.map +1 -1
- package/funcs/promptsList.d.ts +3 -2
- package/funcs/promptsList.d.ts.map +1 -1
- package/funcs/promptsList.js +1 -1
- package/funcs/promptsList.js.map +1 -1
- package/funcs/promptsListVersions.d.ts +3 -2
- package/funcs/promptsListVersions.d.ts.map +1 -1
- package/funcs/promptsListVersions.js +1 -1
- package/funcs/promptsListVersions.js.map +1 -1
- package/funcs/promptsRetrieve.d.ts +3 -2
- package/funcs/promptsRetrieve.d.ts.map +1 -1
- package/funcs/promptsRetrieve.js +1 -1
- package/funcs/promptsRetrieve.js.map +1 -1
- package/funcs/promptsUpdate.d.ts +3 -2
- package/funcs/promptsUpdate.d.ts.map +1 -1
- package/funcs/promptsUpdate.js +1 -1
- package/funcs/promptsUpdate.js.map +1 -1
- package/funcs/remoteconfigsRetrieve.d.ts +3 -2
- package/funcs/remoteconfigsRetrieve.d.ts.map +1 -1
- package/funcs/remoteconfigsRetrieve.js +1 -1
- package/funcs/remoteconfigsRetrieve.js.map +1 -1
- package/jsr.json +1 -1
- package/lib/config.d.ts +3 -3
- package/lib/config.js +3 -3
- package/lib/files.d.ts +5 -0
- package/lib/files.d.ts.map +1 -1
- package/lib/files.js +41 -0
- package/lib/files.js.map +1 -1
- package/lib/matchers.d.ts +3 -10
- package/lib/matchers.d.ts.map +1 -1
- package/lib/matchers.js +33 -31
- package/lib/matchers.js.map +1 -1
- package/mcp-server/mcp-server.js +1 -1
- package/mcp-server/server.js +1 -1
- package/models/errors/apierror.d.ts +8 -18
- package/models/errors/apierror.d.ts.map +1 -1
- package/models/errors/apierror.js +17 -10
- package/models/errors/apierror.js.map +1 -1
- package/models/errors/getpromptversion.d.ts +7 -2
- package/models/errors/getpromptversion.d.ts.map +1 -1
- package/models/errors/getpromptversion.js +12 -4
- package/models/errors/getpromptversion.js.map +1 -1
- package/models/errors/honoapierror.d.ts +7 -2
- package/models/errors/honoapierror.d.ts.map +1 -1
- package/models/errors/honoapierror.js +12 -4
- package/models/errors/honoapierror.js.map +1 -1
- package/models/errors/index.d.ts +1 -0
- package/models/errors/index.d.ts.map +1 -1
- package/models/errors/index.js +1 -0
- package/models/errors/index.js.map +1 -1
- package/models/errors/orqerror.d.ts +19 -0
- package/models/errors/orqerror.d.ts.map +1 -0
- package/models/errors/orqerror.js +20 -0
- package/models/errors/orqerror.js.map +1 -0
- package/models/errors/responsevalidationerror.d.ts +26 -0
- package/models/errors/responsevalidationerror.d.ts.map +1 -0
- package/models/errors/responsevalidationerror.js +66 -0
- package/models/errors/responsevalidationerror.js.map +1 -0
- package/models/errors/sdkvalidationerror.d.ts +1 -0
- package/models/errors/sdkvalidationerror.d.ts.map +1 -1
- package/models/errors/sdkvalidationerror.js +14 -0
- package/models/errors/sdkvalidationerror.js.map +1 -1
- package/models/errors/updateprompt.d.ts +7 -2
- package/models/errors/updateprompt.d.ts.map +1 -1
- package/models/errors/updateprompt.js +12 -4
- package/models/errors/updateprompt.js.map +1 -1
- package/models/operations/bulkcreatedatapoints.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/fileget.js +2 -2
- package/models/operations/filelist.js +2 -2
- package/models/operations/fileupload.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/retrievedatapoint.js +2 -2
- package/models/operations/retrievedataset.js +2 -2
- package/models/operations/retrievedatasource.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/package.json +1 -1
- package/packages/orq-rc/FUNCTIONS.md +3 -5
- package/packages/orq-rc/README.md +131 -118
- package/packages/orq-rc/docs/sdks/contacts/README.md +30 -2
- package/packages/orq-rc/docs/sdks/evals/README.md +315 -14
- package/packages/orq-rc/docs/sdks/knowledge/README.md +1 -1
- package/packages/orq-rc/docs/sdks/orq/README.md +138 -0
- package/packages/orq-rc/jsr.json +1 -1
- package/packages/orq-rc/package-lock.json +2 -2
- package/packages/orq-rc/package.json +1 -1
- package/packages/orq-rc/src/funcs/contactsCreate.ts +21 -17
- package/packages/orq-rc/src/funcs/contactsDelete.ts +21 -17
- package/packages/orq-rc/src/funcs/contactsList.ts +21 -17
- package/packages/orq-rc/src/funcs/contactsRetrieve.ts +21 -17
- package/packages/orq-rc/src/funcs/contactsUpdate.ts +21 -17
- package/packages/orq-rc/src/funcs/datasetsClear.ts +21 -17
- package/packages/orq-rc/src/funcs/datasetsCreate.ts +21 -17
- package/packages/orq-rc/src/funcs/datasetsCreateDatapoint.ts +21 -17
- package/packages/orq-rc/src/funcs/datasetsCreateExperiment.ts +21 -17
- package/packages/orq-rc/src/funcs/datasetsDelete.ts +21 -17
- package/packages/orq-rc/src/funcs/datasetsDeleteDatapoint.ts +21 -17
- package/packages/orq-rc/src/funcs/datasetsList.ts +21 -17
- package/packages/orq-rc/src/funcs/datasetsListDatapoints.ts +21 -17
- package/packages/orq-rc/src/funcs/datasetsRetrieve.ts +21 -17
- package/packages/orq-rc/src/funcs/datasetsRetrieveDatapoint.ts +21 -17
- package/packages/orq-rc/src/funcs/datasetsUpdate.ts +21 -17
- package/packages/orq-rc/src/funcs/datasetsUpdateDatapoint.ts +21 -17
- package/packages/orq-rc/src/funcs/deploymentsCreateExperiment.ts +21 -17
- package/packages/orq-rc/src/funcs/deploymentsGetConfig.ts +21 -17
- package/packages/orq-rc/src/funcs/deploymentsInvoke.ts +21 -17
- package/packages/orq-rc/src/funcs/deploymentsList.ts +21 -17
- package/packages/orq-rc/src/funcs/deploymentsMetricsCreate.ts +21 -17
- package/packages/orq-rc/src/funcs/deploymentsStream.ts +21 -17
- package/packages/orq-rc/src/funcs/evalsAgeAppropriate.ts +21 -17
- package/packages/orq-rc/src/funcs/evalsAll.ts +173 -0
- package/packages/orq-rc/src/funcs/{evalsRunBertScore.ts → evalsBertScore.ts} +40 -34
- package/packages/orq-rc/src/funcs/evalsBleuScore.ts +21 -17
- package/packages/orq-rc/src/funcs/evalsBotDetection.ts +21 -17
- package/packages/orq-rc/src/funcs/evalsContains.ts +21 -17
- package/packages/orq-rc/src/funcs/evalsContainsAll.ts +21 -17
- package/packages/orq-rc/src/funcs/evalsContainsAny.ts +21 -17
- package/packages/orq-rc/src/funcs/evalsContainsEmail.ts +21 -17
- package/packages/orq-rc/src/funcs/evalsContainsNone.ts +21 -17
- package/packages/orq-rc/src/funcs/evalsContainsUrl.ts +21 -17
- package/packages/orq-rc/src/funcs/evalsContainsValidLink.ts +21 -17
- package/packages/orq-rc/src/funcs/evalsCreate.ts +21 -17
- package/packages/orq-rc/src/funcs/evalsDelete.ts +173 -0
- package/packages/orq-rc/src/funcs/evalsEndsWith.ts +21 -17
- package/packages/orq-rc/src/funcs/evalsExactMatch.ts +21 -17
- package/packages/orq-rc/src/funcs/evalsFactCheckingKnowledgeBase.ts +21 -17
- package/packages/orq-rc/src/funcs/evalsGrammar.ts +21 -17
- package/packages/orq-rc/src/funcs/evalsInvoke.ts +177 -0
- package/packages/orq-rc/src/funcs/evalsLengthBetween.ts +21 -17
- package/packages/orq-rc/src/funcs/evalsLengthGreaterThan.ts +21 -17
- package/packages/orq-rc/src/funcs/evalsLengthLessThan.ts +21 -17
- package/packages/orq-rc/src/funcs/evalsLocalization.ts +21 -17
- package/packages/orq-rc/src/funcs/evalsPii.ts +21 -17
- package/packages/orq-rc/src/funcs/evalsRagasCoherence.ts +21 -17
- package/packages/orq-rc/src/funcs/evalsRagasConciseness.ts +21 -17
- package/packages/orq-rc/src/funcs/evalsRagasContextPrecision.ts +21 -17
- package/packages/orq-rc/src/funcs/evalsRagasCorrectness.ts +21 -17
- package/packages/orq-rc/src/funcs/evalsRagasFaithfulness.ts +21 -17
- package/packages/orq-rc/src/funcs/evalsRagasHarmfulness.ts +21 -17
- package/packages/orq-rc/src/funcs/evalsRagasMaliciousness.ts +21 -17
- package/packages/orq-rc/src/funcs/evalsRagasResponseRelevancy.ts +21 -17
- package/packages/orq-rc/src/funcs/evalsRagasSummarization.ts +21 -17
- package/packages/orq-rc/src/funcs/evalsSentimentClassification.ts +21 -17
- package/packages/orq-rc/src/funcs/evalsSummarization.ts +21 -17
- package/packages/orq-rc/src/funcs/evalsToneOfVoice.ts +21 -17
- package/packages/orq-rc/src/funcs/evalsTranslation.ts +21 -17
- package/packages/orq-rc/src/funcs/evalsUpdate.ts +173 -0
- package/packages/orq-rc/src/funcs/evalsValidJson.ts +21 -17
- package/packages/orq-rc/src/funcs/feedbackCreate.ts +21 -17
- package/packages/orq-rc/src/funcs/filesCreate.ts +32 -21
- package/packages/orq-rc/src/funcs/filesDelete.ts +21 -17
- package/packages/orq-rc/src/funcs/filesGet.ts +21 -17
- package/packages/orq-rc/src/funcs/filesList.ts +21 -17
- package/packages/orq-rc/src/funcs/getV2ModelsLitellmModels.ts +143 -0
- package/packages/orq-rc/src/funcs/knowledgeCreate.ts +21 -17
- package/packages/orq-rc/src/funcs/knowledgeCreateChunks.ts +25 -21
- package/packages/orq-rc/src/funcs/knowledgeCreateDatasource.ts +21 -17
- package/packages/orq-rc/src/funcs/knowledgeDelete.ts +21 -17
- package/packages/orq-rc/src/funcs/knowledgeDeleteChunk.ts +21 -17
- package/packages/orq-rc/src/funcs/knowledgeDeleteDatasource.ts +21 -17
- package/packages/orq-rc/src/funcs/knowledgeList.ts +21 -17
- package/packages/orq-rc/src/funcs/knowledgeListChunks.ts +21 -17
- package/packages/orq-rc/src/funcs/knowledgeListDatasources.ts +21 -17
- package/packages/orq-rc/src/funcs/knowledgeRetrieve.ts +21 -17
- package/packages/orq-rc/src/funcs/knowledgeRetrieveChunk.ts +21 -17
- package/packages/orq-rc/src/funcs/knowledgeRetrieveDatasource.ts +21 -17
- package/packages/orq-rc/src/funcs/knowledgeSearch.ts +21 -17
- package/packages/orq-rc/src/funcs/knowledgeUpdate.ts +21 -17
- package/packages/orq-rc/src/funcs/knowledgeUpdateChunk.ts +21 -17
- package/packages/orq-rc/src/funcs/knowledgeUpdateDatasource.ts +21 -17
- package/packages/orq-rc/src/funcs/modelsList.ts +21 -17
- package/packages/orq-rc/src/funcs/postV2ModelsLitellmImport.ts +167 -0
- package/packages/orq-rc/src/funcs/promptsCreate.ts +21 -17
- package/packages/orq-rc/src/funcs/promptsDelete.ts +21 -17
- package/packages/orq-rc/src/funcs/promptsGetVersion.ts +21 -17
- package/packages/orq-rc/src/funcs/promptsList.ts +21 -17
- package/packages/orq-rc/src/funcs/promptsListVersions.ts +21 -17
- package/packages/orq-rc/src/funcs/promptsRetrieve.ts +21 -17
- package/packages/orq-rc/src/funcs/promptsUpdate.ts +21 -17
- package/packages/orq-rc/src/funcs/remoteconfigsRetrieve.ts +21 -17
- package/packages/orq-rc/src/lib/config.ts +3 -3
- package/packages/orq-rc/src/lib/files.ts +42 -0
- package/packages/orq-rc/src/lib/matchers.ts +44 -41
- package/packages/orq-rc/src/mcp-server/mcp-server.ts +1 -1
- package/packages/orq-rc/src/mcp-server/server.ts +15 -3
- package/packages/orq-rc/src/mcp-server/tools/evalsAll.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/{evalsRunBertScore.ts → evalsBertScore.ts} +5 -5
- package/packages/orq-rc/src/mcp-server/tools/evalsDelete.ts +33 -0
- package/packages/orq-rc/src/mcp-server/tools/evalsInvoke.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/evalsUpdate.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/getV2ModelsLitellmModels.ts +30 -0
- package/packages/orq-rc/src/mcp-server/tools/postV2ModelsLitellmImport.ts +38 -0
- package/packages/orq-rc/src/models/errors/apierror.ts +23 -31
- package/packages/orq-rc/src/models/errors/createeval.ts +15 -4
- package/packages/orq-rc/src/models/errors/deletecontact.ts +15 -5
- package/packages/orq-rc/src/models/errors/deleteeval.ts +82 -0
- package/packages/orq-rc/src/models/errors/evalsageappropriate.ts +29 -8
- package/packages/orq-rc/src/models/errors/evalsbertscore.ts +158 -0
- package/packages/orq-rc/src/models/errors/evalsbleuscore.ts +29 -8
- package/packages/orq-rc/src/models/errors/evalsbotdetection.ts +29 -8
- package/packages/orq-rc/src/models/errors/evalscontains.ts +29 -8
- package/packages/orq-rc/src/models/errors/evalscontainsall.ts +29 -8
- package/packages/orq-rc/src/models/errors/evalscontainsany.ts +29 -8
- package/packages/orq-rc/src/models/errors/evalscontainsemail.ts +29 -8
- package/packages/orq-rc/src/models/errors/evalscontainsnone.ts +29 -8
- package/packages/orq-rc/src/models/errors/evalscontainsurl.ts +29 -8
- package/packages/orq-rc/src/models/errors/evalscontainsvalidlink.ts +29 -8
- package/packages/orq-rc/src/models/errors/evalsendswith.ts +29 -8
- package/packages/orq-rc/src/models/errors/evalsexactmatch.ts +29 -8
- package/packages/orq-rc/src/models/errors/evalsfactcheckingknowledgebase.ts +29 -8
- package/packages/orq-rc/src/models/errors/evalsgrammar.ts +29 -8
- package/packages/orq-rc/src/models/errors/evalslengthbetween.ts +29 -8
- package/packages/orq-rc/src/models/errors/evalslengthgreaterthan.ts +29 -8
- package/packages/orq-rc/src/models/errors/evalslengthlessthan.ts +29 -8
- package/packages/orq-rc/src/models/errors/evalslocalization.ts +29 -8
- package/packages/orq-rc/src/models/errors/evalspii.ts +29 -8
- package/packages/orq-rc/src/models/errors/evalsragascoherence.ts +29 -8
- package/packages/orq-rc/src/models/errors/evalsragasconciseness.ts +29 -8
- package/packages/orq-rc/src/models/errors/evalsragascontextprecision.ts +29 -8
- package/packages/orq-rc/src/models/errors/evalsragascorrectness.ts +29 -8
- package/packages/orq-rc/src/models/errors/evalsragasfaithfulness.ts +29 -8
- package/packages/orq-rc/src/models/errors/evalsragasharmfulness.ts +29 -8
- package/packages/orq-rc/src/models/errors/evalsragasmaliciousness.ts +29 -8
- package/packages/orq-rc/src/models/errors/evalsragasresponserelevancy.ts +29 -8
- package/packages/orq-rc/src/models/errors/evalsragassummarization.ts +29 -8
- package/packages/orq-rc/src/models/errors/evalssentimentclassification.ts +29 -8
- package/packages/orq-rc/src/models/errors/evalssummarization.ts +29 -8
- package/packages/orq-rc/src/models/errors/evalstoneofvoice.ts +29 -8
- package/packages/orq-rc/src/models/errors/evalstranslation.ts +29 -8
- package/packages/orq-rc/src/models/errors/evalsvalidjson.ts +29 -8
- package/packages/orq-rc/src/models/errors/getevals.ts +82 -0
- package/packages/orq-rc/src/models/errors/getpromptversion.ts +15 -4
- package/packages/orq-rc/src/models/errors/honoapierror.ts +15 -5
- package/packages/orq-rc/src/models/errors/index.ts +6 -1
- package/packages/orq-rc/src/models/errors/invokeeval.ts +158 -0
- package/packages/orq-rc/src/models/errors/orqerror.ts +35 -0
- package/packages/orq-rc/src/models/errors/responsevalidationerror.ts +50 -0
- package/packages/orq-rc/src/models/errors/retrievecontact.ts +15 -5
- package/packages/orq-rc/src/models/errors/sdkvalidationerror.ts +12 -0
- package/packages/orq-rc/src/models/errors/updatecontact.ts +15 -4
- package/packages/orq-rc/src/models/errors/updateeval.ts +82 -0
- package/packages/orq-rc/src/models/errors/updateprompt.ts +15 -4
- package/packages/orq-rc/src/models/operations/createchunk.ts +54 -44
- package/packages/orq-rc/src/models/operations/createcontact.ts +2 -2
- package/packages/orq-rc/src/models/operations/createdataset.ts +2 -2
- package/packages/orq-rc/src/models/operations/createdatasetitem.ts +2 -2
- package/packages/orq-rc/src/models/operations/createdatasource.ts +2 -2
- package/packages/orq-rc/src/models/operations/createeval.ts +16 -16
- package/packages/orq-rc/src/models/operations/createprompt.ts +2 -0
- package/packages/orq-rc/src/models/operations/deleteeval.ts +66 -0
- package/packages/orq-rc/src/models/operations/deploymentgetconfig.ts +30 -24
- package/packages/orq-rc/src/models/operations/deploymentinvoke.ts +1 -0
- package/packages/orq-rc/src/models/operations/deployments.ts +1 -0
- package/packages/orq-rc/src/models/operations/evalsbertscore.ts +197 -0
- package/packages/orq-rc/src/models/operations/fileget.ts +2 -2
- package/packages/orq-rc/src/models/operations/filelist.ts +2 -2
- package/packages/orq-rc/src/models/operations/fileupload.ts +2 -2
- package/packages/orq-rc/src/models/operations/getallprompts.ts +1 -0
- package/packages/orq-rc/src/models/operations/getevals.ts +6187 -0
- package/packages/orq-rc/src/models/operations/getoneprompt.ts +1 -0
- package/packages/orq-rc/src/models/operations/getpromptversion.ts +1 -0
- package/packages/orq-rc/src/models/operations/getv2modelslitellmmodels.ts +530 -0
- package/packages/orq-rc/src/models/operations/index.ts +7 -1
- package/packages/orq-rc/src/models/operations/invokeeval.ts +2492 -0
- package/packages/orq-rc/src/models/operations/listcontacts.ts +2 -2
- package/packages/orq-rc/src/models/operations/listdatasetdatapoints.ts +2 -2
- package/packages/orq-rc/src/models/operations/listdatasets.ts +2 -2
- package/packages/orq-rc/src/models/operations/listdatasources.ts +2 -2
- package/packages/orq-rc/src/models/operations/listpromptversions.ts +1 -0
- package/packages/orq-rc/src/models/operations/postv2modelslitellmimport.ts +2408 -0
- package/packages/orq-rc/src/models/operations/retrievecontact.ts +2 -2
- package/packages/orq-rc/src/models/operations/retrievedatapoint.ts +2 -2
- package/packages/orq-rc/src/models/operations/retrievedataset.ts +2 -2
- package/packages/orq-rc/src/models/operations/retrievedatasource.ts +2 -2
- package/packages/orq-rc/src/models/operations/updatecontact.ts +2 -2
- package/packages/orq-rc/src/models/operations/updatedatapoint.ts +2 -2
- package/packages/orq-rc/src/models/operations/updatedataset.ts +2 -2
- package/packages/orq-rc/src/models/operations/updatedatasource.ts +2 -2
- package/packages/orq-rc/src/models/operations/updateeval.ts +4131 -0
- package/packages/orq-rc/src/models/operations/updateprompt.ts +2 -0
- package/packages/orq-rc/src/sdk/evals.ts +65 -5
- package/packages/orq-rc/src/sdk/knowledge.ts +1 -1
- package/packages/orq-rc/src/sdk/sdk.ts +37 -1
- package/src/funcs/contactsCreate.ts +21 -17
- package/src/funcs/datasetsClear.ts +21 -17
- package/src/funcs/datasetsCreate.ts +21 -17
- package/src/funcs/datasetsCreateDatapoint.ts +21 -17
- package/src/funcs/datasetsCreateDatapoints.ts +21 -17
- package/src/funcs/datasetsCreateExperiment.ts +21 -17
- package/src/funcs/datasetsDelete.ts +21 -17
- package/src/funcs/datasetsDeleteDatapoint.ts +21 -17
- package/src/funcs/datasetsList.ts +21 -17
- package/src/funcs/datasetsListDatapoints.ts +21 -17
- package/src/funcs/datasetsRetrieve.ts +21 -17
- package/src/funcs/datasetsRetrieveDatapoint.ts +21 -17
- package/src/funcs/datasetsUpdate.ts +21 -17
- package/src/funcs/datasetsUpdateDatapoint.ts +21 -17
- package/src/funcs/deploymentsCreateExperiment.ts +21 -17
- package/src/funcs/deploymentsGetConfig.ts +21 -17
- package/src/funcs/deploymentsInvoke.ts +21 -17
- package/src/funcs/deploymentsList.ts +21 -17
- package/src/funcs/deploymentsMetricsCreate.ts +21 -17
- package/src/funcs/deploymentsStream.ts +21 -17
- package/src/funcs/feedbackCreate.ts +21 -17
- package/src/funcs/filesCreate.ts +32 -21
- package/src/funcs/filesDelete.ts +21 -17
- package/src/funcs/filesGet.ts +21 -17
- package/src/funcs/filesList.ts +21 -17
- package/src/funcs/knowledgeCreate.ts +21 -17
- package/src/funcs/knowledgeCreateChunks.ts +21 -17
- package/src/funcs/knowledgeCreateDatasource.ts +21 -17
- package/src/funcs/knowledgeDelete.ts +21 -17
- package/src/funcs/knowledgeDeleteChunk.ts +21 -17
- package/src/funcs/knowledgeDeleteDatasource.ts +21 -17
- package/src/funcs/knowledgeList.ts +21 -17
- package/src/funcs/knowledgeListChunks.ts +21 -17
- package/src/funcs/knowledgeListDatasources.ts +21 -17
- package/src/funcs/knowledgeRetrieve.ts +21 -17
- package/src/funcs/knowledgeRetrieveChunk.ts +21 -17
- package/src/funcs/knowledgeRetrieveDatasource.ts +21 -17
- package/src/funcs/knowledgeSearch.ts +21 -17
- package/src/funcs/knowledgeUpdate.ts +21 -17
- package/src/funcs/knowledgeUpdateChunk.ts +21 -17
- package/src/funcs/knowledgeUpdateDatasource.ts +21 -17
- package/src/funcs/modelsList.ts +21 -17
- package/src/funcs/promptsCreate.ts +21 -17
- package/src/funcs/promptsDelete.ts +21 -17
- package/src/funcs/promptsGetVersion.ts +21 -17
- package/src/funcs/promptsList.ts +21 -17
- package/src/funcs/promptsListVersions.ts +21 -17
- package/src/funcs/promptsRetrieve.ts +21 -17
- package/src/funcs/promptsUpdate.ts +21 -17
- package/src/funcs/remoteconfigsRetrieve.ts +21 -17
- package/src/lib/config.ts +3 -3
- package/src/lib/files.ts +42 -0
- package/src/lib/matchers.ts +44 -41
- package/src/mcp-server/mcp-server.ts +1 -1
- package/src/mcp-server/server.ts +1 -1
- package/src/models/errors/apierror.ts +23 -31
- package/src/models/errors/getpromptversion.ts +15 -4
- package/src/models/errors/honoapierror.ts +15 -5
- package/src/models/errors/index.ts +1 -0
- package/src/models/errors/orqerror.ts +35 -0
- package/src/models/errors/responsevalidationerror.ts +50 -0
- package/src/models/errors/sdkvalidationerror.ts +12 -0
- package/src/models/errors/updateprompt.ts +15 -4
- package/src/models/operations/bulkcreatedatapoints.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/fileget.ts +2 -2
- package/src/models/operations/filelist.ts +2 -2
- package/src/models/operations/fileupload.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/retrievedatapoint.ts +2 -2
- package/src/models/operations/retrievedataset.ts +2 -2
- package/src/models/operations/retrievedatasource.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/packages/orq-rc/src/models/errors/runbertscore.ts +0 -137
- package/packages/orq-rc/src/models/operations/runbertscore.ts +0 -197
|
@@ -5,8 +5,11 @@
|
|
|
5
5
|
|
|
6
6
|
### Available Operations
|
|
7
7
|
|
|
8
|
+
* [all](#all) - Get all Evaluators
|
|
8
9
|
* [create](#create) - Create an Evaluator
|
|
9
|
-
* [
|
|
10
|
+
* [update](#update) - Update an Evaluator
|
|
11
|
+
* [delete](#delete) - Delete an Evaluator
|
|
12
|
+
* [bertScore](#bertscore) - Run BertScore Evaluator
|
|
10
13
|
* [bleuScore](#bleuscore) - Run BLEU Score Evaluator
|
|
11
14
|
* [containsAll](#containsall) - Run Contains All Evaluator
|
|
12
15
|
* [containsAny](#containsany) - Run Contains Any Evaluator
|
|
@@ -40,6 +43,76 @@
|
|
|
40
43
|
* [ragasMaliciousness](#ragasmaliciousness) - Run Maliciousness Evaluator
|
|
41
44
|
* [ragasResponseRelevancy](#ragasresponserelevancy) - Run Response Relevancy Evaluator
|
|
42
45
|
* [ragasSummarization](#ragassummarization) - Run Summarization Evaluator
|
|
46
|
+
* [invoke](#invoke) - Invoke a Custom Evaluator
|
|
47
|
+
|
|
48
|
+
## all
|
|
49
|
+
|
|
50
|
+
Get all Evaluators
|
|
51
|
+
|
|
52
|
+
### Example Usage
|
|
53
|
+
|
|
54
|
+
```typescript
|
|
55
|
+
import { Orq } from "@orq-ai/node";
|
|
56
|
+
|
|
57
|
+
const orq = new Orq({
|
|
58
|
+
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
59
|
+
});
|
|
60
|
+
|
|
61
|
+
async function run() {
|
|
62
|
+
const result = await orq.evals.all({});
|
|
63
|
+
|
|
64
|
+
console.log(result);
|
|
65
|
+
}
|
|
66
|
+
|
|
67
|
+
run();
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
### Standalone function
|
|
71
|
+
|
|
72
|
+
The standalone function version of this method:
|
|
73
|
+
|
|
74
|
+
```typescript
|
|
75
|
+
import { OrqCore } from "@orq-ai/node/core.js";
|
|
76
|
+
import { evalsAll } from "@orq-ai/node/funcs/evalsAll.js";
|
|
77
|
+
|
|
78
|
+
// Use `OrqCore` for best tree-shaking performance.
|
|
79
|
+
// You can create one instance of it to use across an application.
|
|
80
|
+
const orq = new OrqCore({
|
|
81
|
+
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
82
|
+
});
|
|
83
|
+
|
|
84
|
+
async function run() {
|
|
85
|
+
const res = await evalsAll(orq, {});
|
|
86
|
+
if (res.ok) {
|
|
87
|
+
const { value: result } = res;
|
|
88
|
+
console.log(result);
|
|
89
|
+
} else {
|
|
90
|
+
console.log("evalsAll failed:", res.error);
|
|
91
|
+
}
|
|
92
|
+
}
|
|
93
|
+
|
|
94
|
+
run();
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
### Parameters
|
|
98
|
+
|
|
99
|
+
| Parameter | Type | Required | Description |
|
|
100
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
101
|
+
| `request` | [operations.GetEvalsRequest](../../models/operations/getevalsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
102
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
103
|
+
| `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. |
|
|
104
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
105
|
+
|
|
106
|
+
### Response
|
|
107
|
+
|
|
108
|
+
**Promise\<[operations.GetEvalsResponseBody](../../models/operations/getevalsresponsebody.md)\>**
|
|
109
|
+
|
|
110
|
+
### Errors
|
|
111
|
+
|
|
112
|
+
| Error Type | Status Code | Content Type |
|
|
113
|
+
| --------------------------- | --------------------------- | --------------------------- |
|
|
114
|
+
| errors.GetEvalsResponseBody | 404 | application/json |
|
|
115
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
43
116
|
|
|
44
117
|
## create
|
|
45
118
|
|
|
@@ -140,7 +213,161 @@ run();
|
|
|
140
213
|
| errors.CreateEvalResponseBody | 404 | application/json |
|
|
141
214
|
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
142
215
|
|
|
143
|
-
##
|
|
216
|
+
## update
|
|
217
|
+
|
|
218
|
+
Update an Evaluator
|
|
219
|
+
|
|
220
|
+
### Example Usage
|
|
221
|
+
|
|
222
|
+
```typescript
|
|
223
|
+
import { Orq } from "@orq-ai/node";
|
|
224
|
+
|
|
225
|
+
const orq = new Orq({
|
|
226
|
+
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
227
|
+
});
|
|
228
|
+
|
|
229
|
+
async function run() {
|
|
230
|
+
const result = await orq.evals.update({
|
|
231
|
+
id: "<id>",
|
|
232
|
+
requestBody: {
|
|
233
|
+
type: "llm_eval",
|
|
234
|
+
path: "Default",
|
|
235
|
+
},
|
|
236
|
+
});
|
|
237
|
+
|
|
238
|
+
console.log(result);
|
|
239
|
+
}
|
|
240
|
+
|
|
241
|
+
run();
|
|
242
|
+
```
|
|
243
|
+
|
|
244
|
+
### Standalone function
|
|
245
|
+
|
|
246
|
+
The standalone function version of this method:
|
|
247
|
+
|
|
248
|
+
```typescript
|
|
249
|
+
import { OrqCore } from "@orq-ai/node/core.js";
|
|
250
|
+
import { evalsUpdate } from "@orq-ai/node/funcs/evalsUpdate.js";
|
|
251
|
+
|
|
252
|
+
// Use `OrqCore` for best tree-shaking performance.
|
|
253
|
+
// You can create one instance of it to use across an application.
|
|
254
|
+
const orq = new OrqCore({
|
|
255
|
+
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
256
|
+
});
|
|
257
|
+
|
|
258
|
+
async function run() {
|
|
259
|
+
const res = await evalsUpdate(orq, {
|
|
260
|
+
id: "<id>",
|
|
261
|
+
requestBody: {
|
|
262
|
+
type: "llm_eval",
|
|
263
|
+
path: "Default",
|
|
264
|
+
},
|
|
265
|
+
});
|
|
266
|
+
if (res.ok) {
|
|
267
|
+
const { value: result } = res;
|
|
268
|
+
console.log(result);
|
|
269
|
+
} else {
|
|
270
|
+
console.log("evalsUpdate failed:", res.error);
|
|
271
|
+
}
|
|
272
|
+
}
|
|
273
|
+
|
|
274
|
+
run();
|
|
275
|
+
```
|
|
276
|
+
|
|
277
|
+
### Parameters
|
|
278
|
+
|
|
279
|
+
| Parameter | Type | Required | Description |
|
|
280
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
281
|
+
| `request` | [operations.UpdateEvalRequest](../../models/operations/updateevalrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
282
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
283
|
+
| `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. |
|
|
284
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
285
|
+
|
|
286
|
+
### Response
|
|
287
|
+
|
|
288
|
+
**Promise\<[operations.UpdateEvalResponseBody](../../models/operations/updateevalresponsebody.md)\>**
|
|
289
|
+
|
|
290
|
+
### Errors
|
|
291
|
+
|
|
292
|
+
| Error Type | Status Code | Content Type |
|
|
293
|
+
| ----------------------------- | ----------------------------- | ----------------------------- |
|
|
294
|
+
| errors.UpdateEvalResponseBody | 404 | application/json |
|
|
295
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
296
|
+
|
|
297
|
+
## delete
|
|
298
|
+
|
|
299
|
+
Delete an Evaluator
|
|
300
|
+
|
|
301
|
+
### Example Usage
|
|
302
|
+
|
|
303
|
+
```typescript
|
|
304
|
+
import { Orq } from "@orq-ai/node";
|
|
305
|
+
|
|
306
|
+
const orq = new Orq({
|
|
307
|
+
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
308
|
+
});
|
|
309
|
+
|
|
310
|
+
async function run() {
|
|
311
|
+
await orq.evals.delete({
|
|
312
|
+
id: "<id>",
|
|
313
|
+
});
|
|
314
|
+
|
|
315
|
+
|
|
316
|
+
}
|
|
317
|
+
|
|
318
|
+
run();
|
|
319
|
+
```
|
|
320
|
+
|
|
321
|
+
### Standalone function
|
|
322
|
+
|
|
323
|
+
The standalone function version of this method:
|
|
324
|
+
|
|
325
|
+
```typescript
|
|
326
|
+
import { OrqCore } from "@orq-ai/node/core.js";
|
|
327
|
+
import { evalsDelete } from "@orq-ai/node/funcs/evalsDelete.js";
|
|
328
|
+
|
|
329
|
+
// Use `OrqCore` for best tree-shaking performance.
|
|
330
|
+
// You can create one instance of it to use across an application.
|
|
331
|
+
const orq = new OrqCore({
|
|
332
|
+
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
333
|
+
});
|
|
334
|
+
|
|
335
|
+
async function run() {
|
|
336
|
+
const res = await evalsDelete(orq, {
|
|
337
|
+
id: "<id>",
|
|
338
|
+
});
|
|
339
|
+
if (res.ok) {
|
|
340
|
+
const { value: result } = res;
|
|
341
|
+
|
|
342
|
+
} else {
|
|
343
|
+
console.log("evalsDelete failed:", res.error);
|
|
344
|
+
}
|
|
345
|
+
}
|
|
346
|
+
|
|
347
|
+
run();
|
|
348
|
+
```
|
|
349
|
+
|
|
350
|
+
### Parameters
|
|
351
|
+
|
|
352
|
+
| Parameter | Type | Required | Description |
|
|
353
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
354
|
+
| `request` | [operations.DeleteEvalRequest](../../models/operations/deleteevalrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
355
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
356
|
+
| `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. |
|
|
357
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
358
|
+
|
|
359
|
+
### Response
|
|
360
|
+
|
|
361
|
+
**Promise\<void\>**
|
|
362
|
+
|
|
363
|
+
### Errors
|
|
364
|
+
|
|
365
|
+
| Error Type | Status Code | Content Type |
|
|
366
|
+
| ----------------------------- | ----------------------------- | ----------------------------- |
|
|
367
|
+
| errors.DeleteEvalResponseBody | 404 | application/json |
|
|
368
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
369
|
+
|
|
370
|
+
## bertScore
|
|
144
371
|
|
|
145
372
|
Run BertScore Evaluator
|
|
146
373
|
|
|
@@ -154,7 +381,7 @@ const orq = new Orq({
|
|
|
154
381
|
});
|
|
155
382
|
|
|
156
383
|
async function run() {
|
|
157
|
-
const result = await orq.evals.
|
|
384
|
+
const result = await orq.evals.bertScore();
|
|
158
385
|
|
|
159
386
|
console.log(result);
|
|
160
387
|
}
|
|
@@ -168,7 +395,7 @@ The standalone function version of this method:
|
|
|
168
395
|
|
|
169
396
|
```typescript
|
|
170
397
|
import { OrqCore } from "@orq-ai/node/core.js";
|
|
171
|
-
import {
|
|
398
|
+
import { evalsBertScore } from "@orq-ai/node/funcs/evalsBertScore.js";
|
|
172
399
|
|
|
173
400
|
// Use `OrqCore` for best tree-shaking performance.
|
|
174
401
|
// You can create one instance of it to use across an application.
|
|
@@ -177,12 +404,12 @@ const orq = new OrqCore({
|
|
|
177
404
|
});
|
|
178
405
|
|
|
179
406
|
async function run() {
|
|
180
|
-
const res = await
|
|
407
|
+
const res = await evalsBertScore(orq);
|
|
181
408
|
if (res.ok) {
|
|
182
409
|
const { value: result } = res;
|
|
183
410
|
console.log(result);
|
|
184
411
|
} else {
|
|
185
|
-
console.log("
|
|
412
|
+
console.log("evalsBertScore failed:", res.error);
|
|
186
413
|
}
|
|
187
414
|
}
|
|
188
415
|
|
|
@@ -193,22 +420,22 @@ run();
|
|
|
193
420
|
|
|
194
421
|
| Parameter | Type | Required | Description |
|
|
195
422
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
196
|
-
| `request` | [operations.
|
|
423
|
+
| `request` | [operations.EvalsBertScoreRequestBody](../../models/operations/evalsbertscorerequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
197
424
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
198
425
|
| `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. |
|
|
199
426
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
200
427
|
|
|
201
428
|
### Response
|
|
202
429
|
|
|
203
|
-
**Promise\<[operations.
|
|
430
|
+
**Promise\<[operations.EvalsBertScoreResponseBody](../../models/operations/evalsbertscoreresponsebody.md)\>**
|
|
204
431
|
|
|
205
432
|
### Errors
|
|
206
433
|
|
|
207
|
-
| Error Type
|
|
208
|
-
|
|
|
209
|
-
| errors.
|
|
210
|
-
| errors.
|
|
211
|
-
| errors.APIError
|
|
434
|
+
| Error Type | Status Code | Content Type |
|
|
435
|
+
| -------------------------------------- | -------------------------------------- | -------------------------------------- |
|
|
436
|
+
| errors.EvalsBertScoreResponseBody | 404 | application/json |
|
|
437
|
+
| errors.EvalsBertScoreEvalsResponseBody | 500 | application/json |
|
|
438
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
212
439
|
|
|
213
440
|
## bleuScore
|
|
214
441
|
|
|
@@ -2518,4 +2745,78 @@ run();
|
|
|
2518
2745
|
| ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- |
|
|
2519
2746
|
| errors.EvalsRagasSummarizationResponseBody | 404 | application/json |
|
|
2520
2747
|
| errors.EvalsRagasSummarizationEvalsResponseBody | 500 | application/json |
|
|
2521
|
-
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
2748
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
2749
|
+
|
|
2750
|
+
## invoke
|
|
2751
|
+
|
|
2752
|
+
Invoke a Custom Evaluator
|
|
2753
|
+
|
|
2754
|
+
### Example Usage
|
|
2755
|
+
|
|
2756
|
+
```typescript
|
|
2757
|
+
import { Orq } from "@orq-ai/node";
|
|
2758
|
+
|
|
2759
|
+
const orq = new Orq({
|
|
2760
|
+
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
2761
|
+
});
|
|
2762
|
+
|
|
2763
|
+
async function run() {
|
|
2764
|
+
const result = await orq.evals.invoke({
|
|
2765
|
+
id: "<id>",
|
|
2766
|
+
});
|
|
2767
|
+
|
|
2768
|
+
console.log(result);
|
|
2769
|
+
}
|
|
2770
|
+
|
|
2771
|
+
run();
|
|
2772
|
+
```
|
|
2773
|
+
|
|
2774
|
+
### Standalone function
|
|
2775
|
+
|
|
2776
|
+
The standalone function version of this method:
|
|
2777
|
+
|
|
2778
|
+
```typescript
|
|
2779
|
+
import { OrqCore } from "@orq-ai/node/core.js";
|
|
2780
|
+
import { evalsInvoke } from "@orq-ai/node/funcs/evalsInvoke.js";
|
|
2781
|
+
|
|
2782
|
+
// Use `OrqCore` for best tree-shaking performance.
|
|
2783
|
+
// You can create one instance of it to use across an application.
|
|
2784
|
+
const orq = new OrqCore({
|
|
2785
|
+
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
2786
|
+
});
|
|
2787
|
+
|
|
2788
|
+
async function run() {
|
|
2789
|
+
const res = await evalsInvoke(orq, {
|
|
2790
|
+
id: "<id>",
|
|
2791
|
+
});
|
|
2792
|
+
if (res.ok) {
|
|
2793
|
+
const { value: result } = res;
|
|
2794
|
+
console.log(result);
|
|
2795
|
+
} else {
|
|
2796
|
+
console.log("evalsInvoke failed:", res.error);
|
|
2797
|
+
}
|
|
2798
|
+
}
|
|
2799
|
+
|
|
2800
|
+
run();
|
|
2801
|
+
```
|
|
2802
|
+
|
|
2803
|
+
### Parameters
|
|
2804
|
+
|
|
2805
|
+
| Parameter | Type | Required | Description |
|
|
2806
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
2807
|
+
| `request` | [operations.InvokeEvalRequest](../../models/operations/invokeevalrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
2808
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
2809
|
+
| `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. |
|
|
2810
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
2811
|
+
|
|
2812
|
+
### Response
|
|
2813
|
+
|
|
2814
|
+
**Promise\<[operations.InvokeEvalResponseBody](../../models/operations/invokeevalresponsebody.md)\>**
|
|
2815
|
+
|
|
2816
|
+
### Errors
|
|
2817
|
+
|
|
2818
|
+
| Error Type | Status Code | Content Type |
|
|
2819
|
+
| ---------------------------------- | ---------------------------------- | ---------------------------------- |
|
|
2820
|
+
| errors.InvokeEvalResponseBody | 404 | application/json |
|
|
2821
|
+
| errors.InvokeEvalEvalsResponseBody | 500 | application/json |
|
|
2822
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
@@ -8,3 +8,141 @@ orq.ai Documentation
|
|
|
8
8
|
<https://docs.orq.ai>
|
|
9
9
|
|
|
10
10
|
### Available Operations
|
|
11
|
+
|
|
12
|
+
* [getV2ModelsLitellmModels](#getv2modelslitellmmodels) - Get available models from LiteLLM
|
|
13
|
+
* [postV2ModelsLitellmImport](#postv2modelslitellmimport) - Import models from LiteLLM
|
|
14
|
+
|
|
15
|
+
## getV2ModelsLitellmModels
|
|
16
|
+
|
|
17
|
+
Fetches all available models from the configured LiteLLM instance
|
|
18
|
+
|
|
19
|
+
### Example Usage
|
|
20
|
+
|
|
21
|
+
```typescript
|
|
22
|
+
import { Orq } from "@orq-ai/node";
|
|
23
|
+
|
|
24
|
+
const orq = new Orq({
|
|
25
|
+
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
26
|
+
});
|
|
27
|
+
|
|
28
|
+
async function run() {
|
|
29
|
+
const result = await orq.getV2ModelsLitellmModels();
|
|
30
|
+
|
|
31
|
+
console.log(result);
|
|
32
|
+
}
|
|
33
|
+
|
|
34
|
+
run();
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
### Standalone function
|
|
38
|
+
|
|
39
|
+
The standalone function version of this method:
|
|
40
|
+
|
|
41
|
+
```typescript
|
|
42
|
+
import { OrqCore } from "@orq-ai/node/core.js";
|
|
43
|
+
import { getV2ModelsLitellmModels } from "@orq-ai/node/funcs/getV2ModelsLitellmModels.js";
|
|
44
|
+
|
|
45
|
+
// Use `OrqCore` for best tree-shaking performance.
|
|
46
|
+
// You can create one instance of it to use across an application.
|
|
47
|
+
const orq = new OrqCore({
|
|
48
|
+
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
49
|
+
});
|
|
50
|
+
|
|
51
|
+
async function run() {
|
|
52
|
+
const res = await getV2ModelsLitellmModels(orq);
|
|
53
|
+
if (res.ok) {
|
|
54
|
+
const { value: result } = res;
|
|
55
|
+
console.log(result);
|
|
56
|
+
} else {
|
|
57
|
+
console.log("getV2ModelsLitellmModels failed:", res.error);
|
|
58
|
+
}
|
|
59
|
+
}
|
|
60
|
+
|
|
61
|
+
run();
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
### Parameters
|
|
65
|
+
|
|
66
|
+
| Parameter | Type | Required | Description |
|
|
67
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
68
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
69
|
+
| `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. |
|
|
70
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
71
|
+
|
|
72
|
+
### Response
|
|
73
|
+
|
|
74
|
+
**Promise\<[operations.ResponseBody[]](../../models/.md)\>**
|
|
75
|
+
|
|
76
|
+
### Errors
|
|
77
|
+
|
|
78
|
+
| Error Type | Status Code | Content Type |
|
|
79
|
+
| --------------- | --------------- | --------------- |
|
|
80
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
81
|
+
|
|
82
|
+
## postV2ModelsLitellmImport
|
|
83
|
+
|
|
84
|
+
Imports selected models from LiteLLM instance into the model garden
|
|
85
|
+
|
|
86
|
+
### Example Usage
|
|
87
|
+
|
|
88
|
+
```typescript
|
|
89
|
+
import { Orq } from "@orq-ai/node";
|
|
90
|
+
|
|
91
|
+
const orq = new Orq({
|
|
92
|
+
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
93
|
+
});
|
|
94
|
+
|
|
95
|
+
async function run() {
|
|
96
|
+
const result = await orq.postV2ModelsLitellmImport();
|
|
97
|
+
|
|
98
|
+
console.log(result);
|
|
99
|
+
}
|
|
100
|
+
|
|
101
|
+
run();
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
### Standalone function
|
|
105
|
+
|
|
106
|
+
The standalone function version of this method:
|
|
107
|
+
|
|
108
|
+
```typescript
|
|
109
|
+
import { OrqCore } from "@orq-ai/node/core.js";
|
|
110
|
+
import { postV2ModelsLitellmImport } from "@orq-ai/node/funcs/postV2ModelsLitellmImport.js";
|
|
111
|
+
|
|
112
|
+
// Use `OrqCore` for best tree-shaking performance.
|
|
113
|
+
// You can create one instance of it to use across an application.
|
|
114
|
+
const orq = new OrqCore({
|
|
115
|
+
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
116
|
+
});
|
|
117
|
+
|
|
118
|
+
async function run() {
|
|
119
|
+
const res = await postV2ModelsLitellmImport(orq);
|
|
120
|
+
if (res.ok) {
|
|
121
|
+
const { value: result } = res;
|
|
122
|
+
console.log(result);
|
|
123
|
+
} else {
|
|
124
|
+
console.log("postV2ModelsLitellmImport failed:", res.error);
|
|
125
|
+
}
|
|
126
|
+
}
|
|
127
|
+
|
|
128
|
+
run();
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
### Parameters
|
|
132
|
+
|
|
133
|
+
| Parameter | Type | Required | Description |
|
|
134
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
135
|
+
| `request` | [operations.RequestBody[]](../../models/.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
136
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
137
|
+
| `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. |
|
|
138
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
139
|
+
|
|
140
|
+
### Response
|
|
141
|
+
|
|
142
|
+
**Promise\<[operations.PostV2ModelsLitellmImportResponseBody[]](../../models/.md)\>**
|
|
143
|
+
|
|
144
|
+
### Errors
|
|
145
|
+
|
|
146
|
+
| Error Type | Status Code | Content Type |
|
|
147
|
+
| --------------- | --------------- | --------------- |
|
|
148
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
package/packages/orq-rc/jsr.json
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@orq-ai/node",
|
|
3
|
-
"version": "3.8.0-rc.
|
|
3
|
+
"version": "3.8.0-rc.17",
|
|
4
4
|
"lockfileVersion": 3,
|
|
5
5
|
"requires": true,
|
|
6
6
|
"packages": {
|
|
7
7
|
"": {
|
|
8
8
|
"name": "@orq-ai/node",
|
|
9
|
-
"version": "3.8.0-rc.
|
|
9
|
+
"version": "3.8.0-rc.17",
|
|
10
10
|
"bin": {
|
|
11
11
|
"mcp": "bin/mcp-server.js"
|
|
12
12
|
},
|