@orq-ai/node 3.6.11 → 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 +121 -121
- package/packages/orq-rc/docs/sdks/contacts/README.md +30 -2
- 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 +21 -17
- package/packages/orq-rc/src/funcs/evalsBertScore.ts +21 -17
- 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 +21 -17
- 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 +21 -17
- 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 +21 -17
- 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 +5 -1
- 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 +15 -4
- package/packages/orq-rc/src/models/errors/evalsageappropriate.ts +29 -8
- package/packages/orq-rc/src/models/errors/evalsbertscore.ts +29 -8
- 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 +15 -4
- 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 +1 -0
- package/packages/orq-rc/src/models/errors/invokeeval.ts +29 -8
- 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 +15 -4
- 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/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/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 +28 -28
- 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 +2 -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 +16 -16
- package/packages/orq-rc/src/models/operations/updateprompt.ts +2 -0
- 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
|
@@ -181,9 +181,7 @@ const orq = new Orq({
|
|
|
181
181
|
});
|
|
182
182
|
|
|
183
183
|
async function run() {
|
|
184
|
-
const result = await orq.
|
|
185
|
-
externalId: "<id>",
|
|
186
|
-
});
|
|
184
|
+
const result = await orq.getV2ModelsLitellmModels();
|
|
187
185
|
|
|
188
186
|
console.log(result);
|
|
189
187
|
}
|
|
@@ -213,9 +211,7 @@ const orq = new Orq({
|
|
|
213
211
|
});
|
|
214
212
|
|
|
215
213
|
async function run() {
|
|
216
|
-
const result = await orq.
|
|
217
|
-
externalId: "<id>",
|
|
218
|
-
});
|
|
214
|
+
const result = await orq.getV2ModelsLitellmModels();
|
|
219
215
|
|
|
220
216
|
console.log(result);
|
|
221
217
|
}
|
|
@@ -342,6 +338,10 @@ run();
|
|
|
342
338
|
|
|
343
339
|
* [list](docs/sdks/models/README.md#list) - List models
|
|
344
340
|
|
|
341
|
+
### [Orq SDK](docs/sdks/orq/README.md)
|
|
342
|
+
|
|
343
|
+
* [getV2ModelsLitellmModels](docs/sdks/orq/README.md#getv2modelslitellmmodels) - Get available models from LiteLLM
|
|
344
|
+
* [postV2ModelsLitellmImport](docs/sdks/orq/README.md#postv2modelslitellmimport) - Import models from LiteLLM
|
|
345
345
|
|
|
346
346
|
### [prompts](docs/sdks/prompts/README.md)
|
|
347
347
|
|
|
@@ -442,6 +442,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
|
|
442
442
|
- [`filesDelete`](docs/sdks/files/README.md#delete) - Delete file
|
|
443
443
|
- [`filesGet`](docs/sdks/files/README.md#get) - Retrieve a file
|
|
444
444
|
- [`filesList`](docs/sdks/files/README.md#list) - List all files
|
|
445
|
+
- [`getV2ModelsLitellmModels`](docs/sdks/orq/README.md#getv2modelslitellmmodels) - Get available models from LiteLLM
|
|
445
446
|
- [`knowledgeCreate`](docs/sdks/knowledge/README.md#create) - Create a knowledge
|
|
446
447
|
- [`knowledgeCreateChunks`](docs/sdks/knowledge/README.md#createchunks) - Create chunks for a datasource
|
|
447
448
|
- [`knowledgeCreateDatasource`](docs/sdks/knowledge/README.md#createdatasource) - Create a new datasource
|
|
@@ -459,6 +460,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
|
|
459
460
|
- [`knowledgeUpdateChunk`](docs/sdks/knowledge/README.md#updatechunk) - Update a chunk
|
|
460
461
|
- [`knowledgeUpdateDatasource`](docs/sdks/knowledge/README.md#updatedatasource) - Update a datasource
|
|
461
462
|
- [`modelsList`](docs/sdks/models/README.md#list) - List models
|
|
463
|
+
- [`postV2ModelsLitellmImport`](docs/sdks/orq/README.md#postv2modelslitellmimport) - Import models from LiteLLM
|
|
462
464
|
- [`promptsCreate`](docs/sdks/prompts/README.md#create) - Create a prompt
|
|
463
465
|
- [`promptsDelete`](docs/sdks/prompts/README.md#delete) - Delete a prompt
|
|
464
466
|
- [`promptsGetVersion`](docs/sdks/prompts/README.md#getversion) - Retrieve a prompt version
|
|
@@ -557,9 +559,7 @@ const orq = new Orq({
|
|
|
557
559
|
});
|
|
558
560
|
|
|
559
561
|
async function run() {
|
|
560
|
-
const result = await orq.
|
|
561
|
-
externalId: "<id>",
|
|
562
|
-
}, {
|
|
562
|
+
const result = await orq.getV2ModelsLitellmModels({
|
|
563
563
|
retries: {
|
|
564
564
|
strategy: "backoff",
|
|
565
565
|
backoff: {
|
|
@@ -598,9 +598,7 @@ const orq = new Orq({
|
|
|
598
598
|
});
|
|
599
599
|
|
|
600
600
|
async function run() {
|
|
601
|
-
const result = await orq.
|
|
602
|
-
externalId: "<id>",
|
|
603
|
-
});
|
|
601
|
+
const result = await orq.getV2ModelsLitellmModels();
|
|
604
602
|
|
|
605
603
|
console.log(result);
|
|
606
604
|
}
|
|
@@ -613,16 +611,15 @@ run();
|
|
|
613
611
|
<!-- Start Error Handling [errors] -->
|
|
614
612
|
## Error Handling
|
|
615
613
|
|
|
616
|
-
|
|
614
|
+
[`OrqError`](./src/models/errors/orqerror.ts) is the base class for all HTTP error responses. It has the following properties:
|
|
617
615
|
|
|
618
616
|
| Property | Type | Description |
|
|
619
617
|
| ------------------- | ---------- | --------------------------------------------------------------------------------------- |
|
|
620
|
-
| `error.name` | `string` | Error class name eg `APIError` |
|
|
621
618
|
| `error.message` | `string` | Error message |
|
|
622
|
-
| `error.statusCode` | `number` | HTTP status code eg `404`
|
|
623
|
-
| `error.
|
|
619
|
+
| `error.statusCode` | `number` | HTTP response status code eg `404` |
|
|
620
|
+
| `error.headers` | `Headers` | HTTP response headers |
|
|
624
621
|
| `error.body` | `string` | HTTP body. Can be empty string if no body is returned. |
|
|
625
|
-
| `error.rawResponse` | `Response` | Raw HTTP response
|
|
622
|
+
| `error.rawResponse` | `Response` | Raw HTTP response |
|
|
626
623
|
| `error.data$` | | Optional. Some errors may contain structured data. [See Error Classes](#error-classes). |
|
|
627
624
|
|
|
628
625
|
### Example
|
|
@@ -642,18 +639,17 @@ async function run() {
|
|
|
642
639
|
|
|
643
640
|
console.log(result);
|
|
644
641
|
} catch (error) {
|
|
645
|
-
//
|
|
646
|
-
if (error instanceof errors.
|
|
647
|
-
console.log(error.message);
|
|
648
|
-
console.log(error.data$.error); // string
|
|
649
|
-
}
|
|
650
|
-
|
|
651
|
-
// Fallback error class, if no other more specific error class is matched
|
|
652
|
-
if (error instanceof errors.APIError) {
|
|
642
|
+
// The base class for HTTP error responses
|
|
643
|
+
if (error instanceof errors.OrqError) {
|
|
653
644
|
console.log(error.message);
|
|
654
645
|
console.log(error.statusCode);
|
|
655
646
|
console.log(error.body);
|
|
656
|
-
console.log(error.
|
|
647
|
+
console.log(error.headers);
|
|
648
|
+
|
|
649
|
+
// Depending on the method different errors may be thrown
|
|
650
|
+
if (error instanceof errors.RetrieveContactResponseBody) {
|
|
651
|
+
console.log(error.data$.error); // string
|
|
652
|
+
}
|
|
657
653
|
}
|
|
658
654
|
}
|
|
659
655
|
}
|
|
@@ -663,99 +659,105 @@ run();
|
|
|
663
659
|
```
|
|
664
660
|
|
|
665
661
|
### Error Classes
|
|
666
|
-
|
|
667
|
-
* `
|
|
668
|
-
|
|
669
|
-
|
|
670
|
-
|
|
671
|
-
|
|
672
|
-
|
|
673
|
-
|
|
674
|
-
|
|
675
|
-
|
|
676
|
-
|
|
677
|
-
* [`
|
|
678
|
-
* [`
|
|
679
|
-
|
|
680
|
-
|
|
681
|
-
|
|
682
|
-
* [`
|
|
683
|
-
* [`
|
|
684
|
-
* [`
|
|
685
|
-
* [`
|
|
686
|
-
* [`
|
|
687
|
-
* [`
|
|
688
|
-
* [`
|
|
689
|
-
* [`
|
|
690
|
-
* [`
|
|
691
|
-
* [`
|
|
692
|
-
* [`
|
|
693
|
-
* [`
|
|
694
|
-
* [`
|
|
695
|
-
* [`
|
|
696
|
-
* [`
|
|
697
|
-
* [`
|
|
698
|
-
* [`
|
|
699
|
-
* [`
|
|
700
|
-
* [`
|
|
701
|
-
* [`
|
|
702
|
-
* [`
|
|
703
|
-
* [`
|
|
704
|
-
* [`
|
|
705
|
-
* [`
|
|
706
|
-
* [`
|
|
707
|
-
* [`
|
|
708
|
-
* [`
|
|
709
|
-
* [`
|
|
710
|
-
* [`
|
|
711
|
-
* [`
|
|
712
|
-
* [`
|
|
713
|
-
* [`
|
|
714
|
-
* [`
|
|
715
|
-
* [`
|
|
716
|
-
* [`
|
|
717
|
-
* [`
|
|
718
|
-
* [`
|
|
719
|
-
* [`
|
|
720
|
-
* [`
|
|
721
|
-
* [`
|
|
722
|
-
* [`
|
|
723
|
-
* [`
|
|
724
|
-
* [`
|
|
725
|
-
* [`
|
|
726
|
-
* [`
|
|
727
|
-
* [`
|
|
728
|
-
* [`
|
|
729
|
-
* [`
|
|
730
|
-
* [`
|
|
731
|
-
* [`
|
|
732
|
-
* [`
|
|
733
|
-
* [`
|
|
734
|
-
* [`
|
|
735
|
-
* [`
|
|
736
|
-
* [`
|
|
737
|
-
* [`
|
|
738
|
-
* [`
|
|
739
|
-
* [`
|
|
740
|
-
* [`
|
|
741
|
-
* [`
|
|
742
|
-
* [`
|
|
743
|
-
* [`
|
|
744
|
-
* [`
|
|
745
|
-
* [`
|
|
746
|
-
* [`
|
|
747
|
-
* [`
|
|
748
|
-
* [`
|
|
749
|
-
* [`
|
|
750
|
-
* [`
|
|
751
|
-
* [`
|
|
752
|
-
* [`
|
|
753
|
-
* [`
|
|
754
|
-
* [`
|
|
755
|
-
* [`
|
|
756
|
-
* [`
|
|
757
|
-
|
|
662
|
+
**Primary error:**
|
|
663
|
+
* [`OrqError`](./src/models/errors/orqerror.ts): The base class for HTTP error responses.
|
|
664
|
+
|
|
665
|
+
<details><summary>Less common errors (86)</summary>
|
|
666
|
+
|
|
667
|
+
<br />
|
|
668
|
+
|
|
669
|
+
**Network errors:**
|
|
670
|
+
* [`ConnectionError`](./src/models/errors/httpclienterrors.ts): HTTP client was unable to make a request to a server.
|
|
671
|
+
* [`RequestTimeoutError`](./src/models/errors/httpclienterrors.ts): HTTP request timed out due to an AbortSignal signal.
|
|
672
|
+
* [`RequestAbortedError`](./src/models/errors/httpclienterrors.ts): HTTP request was aborted by the client.
|
|
673
|
+
* [`InvalidRequestError`](./src/models/errors/httpclienterrors.ts): Any input used to create a request is invalid.
|
|
674
|
+
* [`UnexpectedClientError`](./src/models/errors/httpclienterrors.ts): Unrecognised or unexpected error.
|
|
675
|
+
|
|
676
|
+
|
|
677
|
+
**Inherit from [`OrqError`](./src/models/errors/orqerror.ts)**:
|
|
678
|
+
* [`HonoApiError`](docs/models/errors/honoapierror.md): Applicable to 6 of 94 methods.*
|
|
679
|
+
* [`RetrieveContactResponseBody`](docs/models/errors/retrievecontactresponsebody.md): Contact not found. Status code `404`. Applicable to 1 of 94 methods.*
|
|
680
|
+
* [`UpdateContactResponseBody`](docs/models/errors/updatecontactresponsebody.md): Contact not found. Status code `404`. Applicable to 1 of 94 methods.*
|
|
681
|
+
* [`DeleteContactResponseBody`](docs/models/errors/deletecontactresponsebody.md): Contact not found. Status code `404`. Applicable to 1 of 94 methods.*
|
|
682
|
+
* [`UpdatePromptResponseBody`](docs/models/errors/updatepromptresponsebody.md): Prompt not found. Status code `404`. Applicable to 1 of 94 methods.*
|
|
683
|
+
* [`GetPromptVersionResponseBody`](docs/models/errors/getpromptversionresponsebody.md): Not Found - The prompt or prompt version does not exist. Status code `404`. Applicable to 1 of 94 methods.*
|
|
684
|
+
* [`GetEvalsResponseBody`](docs/models/errors/getevalsresponsebody.md): Workspace ID is not found on the request. Status code `404`. Applicable to 1 of 94 methods.*
|
|
685
|
+
* [`CreateEvalResponseBody`](docs/models/errors/createevalresponsebody.md): Workspace ID is not found on the request. Status code `404`. Applicable to 1 of 94 methods.*
|
|
686
|
+
* [`UpdateEvalResponseBody`](docs/models/errors/updateevalresponsebody.md): Workspace ID is not found on the request. Status code `404`. Applicable to 1 of 94 methods.*
|
|
687
|
+
* [`DeleteEvalResponseBody`](docs/models/errors/deleteevalresponsebody.md): Workspace ID is not found on the request. Status code `404`. Applicable to 1 of 94 methods.*
|
|
688
|
+
* [`EvalsBertScoreResponseBody`](docs/models/errors/evalsbertscoreresponsebody.md): Evaluator not found. Status code `404`. Applicable to 1 of 94 methods.*
|
|
689
|
+
* [`EvalsBleuScoreResponseBody`](docs/models/errors/evalsbleuscoreresponsebody.md): Evaluator not found. Status code `404`. Applicable to 1 of 94 methods.*
|
|
690
|
+
* [`EvalsContainsAllResponseBody`](docs/models/errors/evalscontainsallresponsebody.md): Evaluator not found. Status code `404`. Applicable to 1 of 94 methods.*
|
|
691
|
+
* [`EvalsContainsAnyResponseBody`](docs/models/errors/evalscontainsanyresponsebody.md): Evaluator not found. Status code `404`. Applicable to 1 of 94 methods.*
|
|
692
|
+
* [`EvalsContainsEmailResponseBody`](docs/models/errors/evalscontainsemailresponsebody.md): Evaluator not found. Status code `404`. Applicable to 1 of 94 methods.*
|
|
693
|
+
* [`EvalsContainsNoneResponseBody`](docs/models/errors/evalscontainsnoneresponsebody.md): Evaluator not found. Status code `404`. Applicable to 1 of 94 methods.*
|
|
694
|
+
* [`EvalsContainsUrlResponseBody`](docs/models/errors/evalscontainsurlresponsebody.md): Evaluator not found. Status code `404`. Applicable to 1 of 94 methods.*
|
|
695
|
+
* [`EvalsContainsValidLinkResponseBody`](docs/models/errors/evalscontainsvalidlinkresponsebody.md): Evaluator not found. Status code `404`. Applicable to 1 of 94 methods.*
|
|
696
|
+
* [`EvalsContainsResponseBody`](docs/models/errors/evalscontainsresponsebody.md): Evaluator not found. Status code `404`. Applicable to 1 of 94 methods.*
|
|
697
|
+
* [`EvalsEndsWithResponseBody`](docs/models/errors/evalsendswithresponsebody.md): Evaluator not found. Status code `404`. Applicable to 1 of 94 methods.*
|
|
698
|
+
* [`EvalsExactMatchResponseBody`](docs/models/errors/evalsexactmatchresponsebody.md): Evaluator not found. Status code `404`. Applicable to 1 of 94 methods.*
|
|
699
|
+
* [`EvalsLengthBetweenResponseBody`](docs/models/errors/evalslengthbetweenresponsebody.md): Evaluator not found. Status code `404`. Applicable to 1 of 94 methods.*
|
|
700
|
+
* [`EvalsLengthGreaterThanResponseBody`](docs/models/errors/evalslengthgreaterthanresponsebody.md): Evaluator not found. Status code `404`. Applicable to 1 of 94 methods.*
|
|
701
|
+
* [`EvalsLengthLessThanResponseBody`](docs/models/errors/evalslengthlessthanresponsebody.md): Evaluator not found. Status code `404`. Applicable to 1 of 94 methods.*
|
|
702
|
+
* [`EvalsValidJsonResponseBody`](docs/models/errors/evalsvalidjsonresponsebody.md): Evaluator not found. Status code `404`. Applicable to 1 of 94 methods.*
|
|
703
|
+
* [`EvalsAgeAppropriateResponseBody`](docs/models/errors/evalsageappropriateresponsebody.md): Evaluator not found. Status code `404`. Applicable to 1 of 94 methods.*
|
|
704
|
+
* [`EvalsBotDetectionResponseBody`](docs/models/errors/evalsbotdetectionresponsebody.md): Evaluator not found. Status code `404`. Applicable to 1 of 94 methods.*
|
|
705
|
+
* [`EvalsFactCheckingKnowledgeBaseResponseBody`](docs/models/errors/evalsfactcheckingknowledgebaseresponsebody.md): Evaluator not found. Status code `404`. Applicable to 1 of 94 methods.*
|
|
706
|
+
* [`EvalsGrammarResponseBody`](docs/models/errors/evalsgrammarresponsebody.md): Evaluator not found. Status code `404`. Applicable to 1 of 94 methods.*
|
|
707
|
+
* [`EvalsLocalizationResponseBody`](docs/models/errors/evalslocalizationresponsebody.md): Evaluator not found. Status code `404`. Applicable to 1 of 94 methods.*
|
|
708
|
+
* [`EvalsPiiResponseBody`](docs/models/errors/evalspiiresponsebody.md): Evaluator not found. Status code `404`. Applicable to 1 of 94 methods.*
|
|
709
|
+
* [`EvalsSentimentClassificationResponseBody`](docs/models/errors/evalssentimentclassificationresponsebody.md): Evaluator not found. Status code `404`. Applicable to 1 of 94 methods.*
|
|
710
|
+
* [`EvalsSummarizationResponseBody`](docs/models/errors/evalssummarizationresponsebody.md): Evaluator not found. Status code `404`. Applicable to 1 of 94 methods.*
|
|
711
|
+
* [`EvalsToneOfVoiceResponseBody`](docs/models/errors/evalstoneofvoiceresponsebody.md): Evaluator not found. Status code `404`. Applicable to 1 of 94 methods.*
|
|
712
|
+
* [`EvalsTranslationResponseBody`](docs/models/errors/evalstranslationresponsebody.md): Evaluator not found. Status code `404`. Applicable to 1 of 94 methods.*
|
|
713
|
+
* [`EvalsRagasCoherenceResponseBody`](docs/models/errors/evalsragascoherenceresponsebody.md): Evaluator not found. Status code `404`. Applicable to 1 of 94 methods.*
|
|
714
|
+
* [`EvalsRagasConcisenessResponseBody`](docs/models/errors/evalsragasconcisenessresponsebody.md): Evaluator not found. Status code `404`. Applicable to 1 of 94 methods.*
|
|
715
|
+
* [`EvalsRagasContextPrecisionResponseBody`](docs/models/errors/evalsragascontextprecisionresponsebody.md): Evaluator not found. Status code `404`. Applicable to 1 of 94 methods.*
|
|
716
|
+
* [`EvalsRagasCorrectnessResponseBody`](docs/models/errors/evalsragascorrectnessresponsebody.md): Evaluator not found. Status code `404`. Applicable to 1 of 94 methods.*
|
|
717
|
+
* [`EvalsRagasFaithfulnessResponseBody`](docs/models/errors/evalsragasfaithfulnessresponsebody.md): Evaluator not found. Status code `404`. Applicable to 1 of 94 methods.*
|
|
718
|
+
* [`EvalsRagasHarmfulnessResponseBody`](docs/models/errors/evalsragasharmfulnessresponsebody.md): Evaluator not found. Status code `404`. Applicable to 1 of 94 methods.*
|
|
719
|
+
* [`EvalsRagasMaliciousnessResponseBody`](docs/models/errors/evalsragasmaliciousnessresponsebody.md): Evaluator not found. Status code `404`. Applicable to 1 of 94 methods.*
|
|
720
|
+
* [`EvalsRagasResponseRelevancyResponseBody`](docs/models/errors/evalsragasresponserelevancyresponsebody.md): Evaluator not found. Status code `404`. Applicable to 1 of 94 methods.*
|
|
721
|
+
* [`EvalsRagasSummarizationResponseBody`](docs/models/errors/evalsragassummarizationresponsebody.md): Evaluator not found. Status code `404`. Applicable to 1 of 94 methods.*
|
|
722
|
+
* [`InvokeEvalResponseBody`](docs/models/errors/invokeevalresponsebody.md): Workspace ID is not found on the request. Status code `404`. Applicable to 1 of 94 methods.*
|
|
723
|
+
* [`EvalsBertScoreEvalsResponseBody`](docs/models/errors/evalsbertscoreevalsresponsebody.md): Internal server error. Status code `500`. Applicable to 1 of 94 methods.*
|
|
724
|
+
* [`EvalsBleuScoreEvalsResponseBody`](docs/models/errors/evalsbleuscoreevalsresponsebody.md): Internal server error. Status code `500`. Applicable to 1 of 94 methods.*
|
|
725
|
+
* [`EvalsContainsAllEvalsResponseBody`](docs/models/errors/evalscontainsallevalsresponsebody.md): Internal server error. Status code `500`. Applicable to 1 of 94 methods.*
|
|
726
|
+
* [`EvalsContainsAnyEvalsResponseBody`](docs/models/errors/evalscontainsanyevalsresponsebody.md): Internal server error. Status code `500`. Applicable to 1 of 94 methods.*
|
|
727
|
+
* [`EvalsContainsEmailEvalsResponseBody`](docs/models/errors/evalscontainsemailevalsresponsebody.md): Internal server error. Status code `500`. Applicable to 1 of 94 methods.*
|
|
728
|
+
* [`EvalsContainsNoneEvalsResponseBody`](docs/models/errors/evalscontainsnoneevalsresponsebody.md): Internal server error. Status code `500`. Applicable to 1 of 94 methods.*
|
|
729
|
+
* [`EvalsContainsUrlEvalsResponseBody`](docs/models/errors/evalscontainsurlevalsresponsebody.md): Internal server error. Status code `500`. Applicable to 1 of 94 methods.*
|
|
730
|
+
* [`EvalsContainsValidLinkEvalsResponseBody`](docs/models/errors/evalscontainsvalidlinkevalsresponsebody.md): Internal server error. Status code `500`. Applicable to 1 of 94 methods.*
|
|
731
|
+
* [`EvalsContainsEvalsResponseBody`](docs/models/errors/evalscontainsevalsresponsebody.md): Internal server error. Status code `500`. Applicable to 1 of 94 methods.*
|
|
732
|
+
* [`EvalsEndsWithEvalsResponseBody`](docs/models/errors/evalsendswithevalsresponsebody.md): Internal server error. Status code `500`. Applicable to 1 of 94 methods.*
|
|
733
|
+
* [`EvalsExactMatchEvalsResponseBody`](docs/models/errors/evalsexactmatchevalsresponsebody.md): Internal server error. Status code `500`. Applicable to 1 of 94 methods.*
|
|
734
|
+
* [`EvalsLengthBetweenEvalsResponseBody`](docs/models/errors/evalslengthbetweenevalsresponsebody.md): Internal server error. Status code `500`. Applicable to 1 of 94 methods.*
|
|
735
|
+
* [`EvalsLengthGreaterThanEvalsResponseBody`](docs/models/errors/evalslengthgreaterthanevalsresponsebody.md): Internal server error. Status code `500`. Applicable to 1 of 94 methods.*
|
|
736
|
+
* [`EvalsLengthLessThanEvalsResponseBody`](docs/models/errors/evalslengthlessthanevalsresponsebody.md): Internal server error. Status code `500`. Applicable to 1 of 94 methods.*
|
|
737
|
+
* [`EvalsValidJsonEvalsResponseBody`](docs/models/errors/evalsvalidjsonevalsresponsebody.md): Internal server error. Status code `500`. Applicable to 1 of 94 methods.*
|
|
738
|
+
* [`EvalsAgeAppropriateEvalsResponseBody`](docs/models/errors/evalsageappropriateevalsresponsebody.md): Internal server error. Status code `500`. Applicable to 1 of 94 methods.*
|
|
739
|
+
* [`EvalsBotDetectionEvalsResponseBody`](docs/models/errors/evalsbotdetectionevalsresponsebody.md): Internal server error. Status code `500`. Applicable to 1 of 94 methods.*
|
|
740
|
+
* [`EvalsFactCheckingKnowledgeBaseEvalsResponseBody`](docs/models/errors/evalsfactcheckingknowledgebaseevalsresponsebody.md): Internal server error. Status code `500`. Applicable to 1 of 94 methods.*
|
|
741
|
+
* [`EvalsGrammarEvalsResponseBody`](docs/models/errors/evalsgrammarevalsresponsebody.md): Internal server error. Status code `500`. Applicable to 1 of 94 methods.*
|
|
742
|
+
* [`EvalsLocalizationEvalsResponseBody`](docs/models/errors/evalslocalizationevalsresponsebody.md): Internal server error. Status code `500`. Applicable to 1 of 94 methods.*
|
|
743
|
+
* [`EvalsPiiEvalsResponseBody`](docs/models/errors/evalspiievalsresponsebody.md): Internal server error. Status code `500`. Applicable to 1 of 94 methods.*
|
|
744
|
+
* [`EvalsSentimentClassificationEvalsResponseBody`](docs/models/errors/evalssentimentclassificationevalsresponsebody.md): Internal server error. Status code `500`. Applicable to 1 of 94 methods.*
|
|
745
|
+
* [`EvalsSummarizationEvalsResponseBody`](docs/models/errors/evalssummarizationevalsresponsebody.md): Internal server error. Status code `500`. Applicable to 1 of 94 methods.*
|
|
746
|
+
* [`EvalsToneOfVoiceEvalsResponseBody`](docs/models/errors/evalstoneofvoiceevalsresponsebody.md): Internal server error. Status code `500`. Applicable to 1 of 94 methods.*
|
|
747
|
+
* [`EvalsTranslationEvalsResponseBody`](docs/models/errors/evalstranslationevalsresponsebody.md): Internal server error. Status code `500`. Applicable to 1 of 94 methods.*
|
|
748
|
+
* [`EvalsRagasCoherenceEvalsResponseBody`](docs/models/errors/evalsragascoherenceevalsresponsebody.md): Internal server error. Status code `500`. Applicable to 1 of 94 methods.*
|
|
749
|
+
* [`EvalsRagasConcisenessEvalsResponseBody`](docs/models/errors/evalsragasconcisenessevalsresponsebody.md): Internal server error. Status code `500`. Applicable to 1 of 94 methods.*
|
|
750
|
+
* [`EvalsRagasContextPrecisionEvalsResponseBody`](docs/models/errors/evalsragascontextprecisionevalsresponsebody.md): Internal server error. Status code `500`. Applicable to 1 of 94 methods.*
|
|
751
|
+
* [`EvalsRagasCorrectnessEvalsResponseBody`](docs/models/errors/evalsragascorrectnessevalsresponsebody.md): Internal server error. Status code `500`. Applicable to 1 of 94 methods.*
|
|
752
|
+
* [`EvalsRagasFaithfulnessEvalsResponseBody`](docs/models/errors/evalsragasfaithfulnessevalsresponsebody.md): Internal server error. Status code `500`. Applicable to 1 of 94 methods.*
|
|
753
|
+
* [`EvalsRagasHarmfulnessEvalsResponseBody`](docs/models/errors/evalsragasharmfulnessevalsresponsebody.md): Internal server error. Status code `500`. Applicable to 1 of 94 methods.*
|
|
754
|
+
* [`EvalsRagasMaliciousnessEvalsResponseBody`](docs/models/errors/evalsragasmaliciousnessevalsresponsebody.md): Internal server error. Status code `500`. Applicable to 1 of 94 methods.*
|
|
755
|
+
* [`EvalsRagasResponseRelevancyEvalsResponseBody`](docs/models/errors/evalsragasresponserelevancyevalsresponsebody.md): Internal server error. Status code `500`. Applicable to 1 of 94 methods.*
|
|
756
|
+
* [`EvalsRagasSummarizationEvalsResponseBody`](docs/models/errors/evalsragassummarizationevalsresponsebody.md): Internal server error. Status code `500`. Applicable to 1 of 94 methods.*
|
|
757
|
+
* [`InvokeEvalEvalsResponseBody`](docs/models/errors/invokeevalevalsresponsebody.md): Error running the evaluator. Status code `500`. Applicable to 1 of 94 methods.*
|
|
758
|
+
* [`ResponseValidationError`](./src/models/errors/responsevalidationerror.ts): Type mismatch between the data returned from the server and the structure expected by the SDK. See `error.rawValue` for the raw value and `error.pretty()` for a nicely formatted multi-line string.
|
|
758
759
|
|
|
760
|
+
</details>
|
|
759
761
|
|
|
760
762
|
\* Check [the method documentation](#available-resources-and-operations) to see if the error is applicable.
|
|
761
763
|
<!-- End Error Handling [errors] -->
|
|
@@ -775,9 +777,7 @@ const orq = new Orq({
|
|
|
775
777
|
});
|
|
776
778
|
|
|
777
779
|
async function run() {
|
|
778
|
-
const result = await orq.
|
|
779
|
-
externalId: "<id>",
|
|
780
|
-
});
|
|
780
|
+
const result = await orq.getV2ModelsLitellmModels();
|
|
781
781
|
|
|
782
782
|
console.log(result);
|
|
783
783
|
}
|
|
@@ -26,7 +26,21 @@ const orq = new Orq({
|
|
|
26
26
|
|
|
27
27
|
async function run() {
|
|
28
28
|
const result = await orq.contacts.create({
|
|
29
|
-
externalId: "
|
|
29
|
+
externalId: "user_12345",
|
|
30
|
+
displayName: "Jane Smith",
|
|
31
|
+
email: "jane.smith@example.com",
|
|
32
|
+
avatarUrl: "https://example.com/avatars/jane-smith.jpg",
|
|
33
|
+
tags: [
|
|
34
|
+
"premium",
|
|
35
|
+
"beta-user",
|
|
36
|
+
"enterprise",
|
|
37
|
+
],
|
|
38
|
+
metadata: {
|
|
39
|
+
"department": "Engineering",
|
|
40
|
+
"role": "Senior Developer",
|
|
41
|
+
"subscription_tier": "premium",
|
|
42
|
+
"last_login": "2024-01-15T10:30:00Z",
|
|
43
|
+
},
|
|
30
44
|
});
|
|
31
45
|
|
|
32
46
|
console.log(result);
|
|
@@ -51,7 +65,21 @@ const orq = new OrqCore({
|
|
|
51
65
|
|
|
52
66
|
async function run() {
|
|
53
67
|
const res = await contactsCreate(orq, {
|
|
54
|
-
externalId: "
|
|
68
|
+
externalId: "user_12345",
|
|
69
|
+
displayName: "Jane Smith",
|
|
70
|
+
email: "jane.smith@example.com",
|
|
71
|
+
avatarUrl: "https://example.com/avatars/jane-smith.jpg",
|
|
72
|
+
tags: [
|
|
73
|
+
"premium",
|
|
74
|
+
"beta-user",
|
|
75
|
+
"enterprise",
|
|
76
|
+
],
|
|
77
|
+
metadata: {
|
|
78
|
+
"department": "Engineering",
|
|
79
|
+
"role": "Senior Developer",
|
|
80
|
+
"subscription_tier": "premium",
|
|
81
|
+
"last_login": "2024-01-15T10:30:00Z",
|
|
82
|
+
},
|
|
55
83
|
});
|
|
56
84
|
if (res.ok) {
|
|
57
85
|
const { value: result } = res;
|
|
@@ -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
|
},
|