@orq-ai/node 3.10.0-rc.9 → 3.10.2
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 +93 -91
- package/bin/mcp-server.js +1696 -1367
- package/bin/mcp-server.js.map +52 -49
- package/docs/sdks/{knowledgebases → chunking}/README.md +11 -10
- package/docs/sdks/contacts/README.md +5 -0
- package/docs/sdks/datasets/README.md +11 -0
- package/docs/sdks/deployments/README.md +4 -0
- package/docs/sdks/evals/README.md +42 -0
- package/docs/sdks/feedback/README.md +1 -0
- package/docs/sdks/files/README.md +4 -0
- package/docs/sdks/knowledge/README.md +93 -0
- package/docs/sdks/metrics/README.md +1 -0
- package/docs/sdks/models/README.md +1 -0
- package/docs/sdks/prompts/README.md +7 -0
- package/docs/sdks/remoteconfigs/README.md +1 -0
- package/examples/README.md +5 -0
- package/examples/contactsCreate.example.ts +2 -0
- package/examples/package-lock.json +10 -8
- package/funcs/{knowledgeBasesChunkText.d.ts → chunkingParse.d.ts} +3 -3
- package/funcs/chunkingParse.d.ts.map +1 -0
- package/funcs/{knowledgeBasesChunkText.js → chunkingParse.js} +8 -8
- package/funcs/chunkingParse.js.map +1 -0
- package/funcs/knowledgeCreate.d.ts +14 -0
- package/funcs/knowledgeCreate.d.ts.map +1 -0
- package/funcs/knowledgeCreate.js +111 -0
- package/funcs/knowledgeCreate.js.map +1 -0
- package/jsr.json +1 -1
- package/lib/config.d.ts +3 -3
- package/lib/config.js +3 -3
- package/lib/config.js.map +1 -1
- package/lib/encodings.d.ts.map +1 -1
- package/lib/event-streams.d.ts +1 -1
- package/lib/event-streams.d.ts.map +1 -1
- package/lib/event-streams.js +22 -29
- package/lib/event-streams.js.map +1 -1
- package/mcp-server/mcp-server.js +1 -1
- package/mcp-server/mcp-server.js.map +1 -1
- package/mcp-server/server.d.ts.map +1 -1
- package/mcp-server/server.js +5 -3
- package/mcp-server/server.js.map +1 -1
- package/mcp-server/tools/chunkingParse.d.ts +8 -0
- package/mcp-server/tools/chunkingParse.d.ts.map +1 -0
- package/mcp-server/tools/{knowledgeBasesChunkText.js → chunkingParse.js} +8 -8
- package/mcp-server/tools/chunkingParse.js.map +1 -0
- package/mcp-server/tools/knowledgeCreate.d.ts +8 -0
- package/mcp-server/tools/knowledgeCreate.d.ts.map +1 -0
- package/mcp-server/tools/knowledgeCreate.js +62 -0
- package/mcp-server/tools/knowledgeCreate.js.map +1 -0
- package/models/components/deployments.d.ts +4 -25
- package/models/components/deployments.d.ts.map +1 -1
- package/models/components/deployments.js +10 -35
- package/models/components/deployments.js.map +1 -1
- package/models/operations/createcontact.js +2 -2
- package/models/operations/createdataset.js +2 -2
- package/models/operations/createdatasetitem.d.ts +2 -2
- package/models/operations/createdatasetitem.js +2 -2
- package/models/operations/createdatasource.js +2 -2
- package/models/operations/createeval.js +16 -16
- package/models/operations/createknowledge.d.ts +426 -0
- package/models/operations/createknowledge.d.ts.map +1 -0
- package/models/operations/createknowledge.js +431 -0
- package/models/operations/createknowledge.js.map +1 -0
- package/models/operations/createprompt.d.ts +14 -2
- package/models/operations/createprompt.d.ts.map +1 -1
- package/models/operations/createprompt.js +4 -0
- package/models/operations/createprompt.js.map +1 -1
- package/models/operations/deploymentcreatemetric.d.ts +2 -2
- package/models/operations/deploymentgetconfig.d.ts +5 -26
- package/models/operations/deploymentgetconfig.d.ts.map +1 -1
- package/models/operations/deploymentgetconfig.js +13 -37
- package/models/operations/deploymentgetconfig.js.map +1 -1
- package/models/operations/deploymentinvoke.d.ts +6 -0
- package/models/operations/deploymentinvoke.d.ts.map +1 -1
- package/models/operations/deploymentinvoke.js +2 -0
- package/models/operations/deploymentinvoke.js.map +1 -1
- package/models/operations/deployments.d.ts +7 -1
- package/models/operations/deployments.d.ts.map +1 -1
- package/models/operations/deployments.js +2 -0
- package/models/operations/deployments.js.map +1 -1
- package/models/operations/deploymentstream.d.ts +4 -25
- package/models/operations/deploymentstream.d.ts.map +1 -1
- package/models/operations/deploymentstream.js +12 -35
- package/models/operations/deploymentstream.js.map +1 -1
- package/models/operations/fileget.js +2 -2
- package/models/operations/filelist.js +2 -2
- package/models/operations/fileupload.js +2 -2
- package/models/operations/getallprompts.d.ts +7 -1
- package/models/operations/getallprompts.d.ts.map +1 -1
- package/models/operations/getallprompts.js +2 -0
- package/models/operations/getallprompts.js.map +1 -1
- package/models/operations/getevals.js +28 -28
- package/models/operations/getoneprompt.d.ts +7 -1
- package/models/operations/getoneprompt.d.ts.map +1 -1
- package/models/operations/getoneprompt.js +2 -0
- package/models/operations/getoneprompt.js.map +1 -1
- package/models/operations/getpromptversion.d.ts +7 -1
- package/models/operations/getpromptversion.d.ts.map +1 -1
- package/models/operations/getpromptversion.js +2 -0
- package/models/operations/getpromptversion.js.map +1 -1
- package/models/operations/index.d.ts +2 -1
- package/models/operations/index.d.ts.map +1 -1
- package/models/operations/index.js +2 -1
- package/models/operations/index.js.map +1 -1
- package/models/operations/invokeeval.d.ts +1 -1
- package/models/operations/listcontacts.js +2 -2
- package/models/operations/listdatasetdatapoints.d.ts +1 -1
- package/models/operations/listdatasetdatapoints.js +2 -2
- package/models/operations/listdatasets.js +2 -2
- package/models/operations/listdatasources.js +2 -2
- package/models/operations/listpromptversions.d.ts +7 -1
- package/models/operations/listpromptversions.d.ts.map +1 -1
- package/models/operations/listpromptversions.js +2 -0
- package/models/operations/listpromptversions.js.map +1 -1
- package/models/operations/{chunktext.d.ts → parse.d.ts} +83 -83
- package/models/operations/parse.d.ts.map +1 -0
- package/models/operations/{chunktext.js → parse.js} +113 -117
- package/models/operations/parse.js.map +1 -0
- package/models/operations/retrievecontact.js +2 -2
- package/models/operations/retrievedatapoint.d.ts +1 -1
- package/models/operations/retrievedatapoint.js +2 -2
- package/models/operations/retrievedataset.js +2 -2
- package/models/operations/retrievedatasource.js +2 -2
- package/models/operations/updatecontact.js +2 -2
- package/models/operations/updatedatapoint.d.ts +2 -2
- package/models/operations/updatedatapoint.js +2 -2
- package/models/operations/updatedataset.js +2 -2
- package/models/operations/updatedatasource.js +2 -2
- package/models/operations/updateeval.js +16 -16
- package/models/operations/updateknowledge.d.ts +106 -106
- package/models/operations/updateknowledge.d.ts.map +1 -1
- package/models/operations/updateknowledge.js +125 -129
- package/models/operations/updateknowledge.js.map +1 -1
- package/models/operations/updateprompt.d.ts +14 -2
- package/models/operations/updateprompt.d.ts.map +1 -1
- package/models/operations/updateprompt.js +4 -0
- package/models/operations/updateprompt.js.map +1 -1
- package/package.json +6 -8
- package/packages/orq-rc/FUNCTIONS.md +103 -0
- package/packages/orq-rc/README.md +960 -0
- package/packages/orq-rc/RUNTIMES.md +48 -0
- package/packages/orq-rc/docs/sdks/chunking/README.md +95 -0
- package/packages/orq-rc/docs/sdks/contacts/README.md +450 -0
- package/packages/orq-rc/docs/sdks/datasets/README.md +836 -0
- package/packages/orq-rc/docs/sdks/deployments/README.md +314 -0
- package/packages/orq-rc/docs/sdks/evals/README.md +3077 -0
- package/packages/orq-rc/docs/sdks/feedback/README.md +89 -0
- package/packages/orq-rc/docs/sdks/files/README.md +301 -0
- package/packages/orq-rc/docs/sdks/knowledge/README.md +1243 -0
- package/packages/orq-rc/docs/sdks/metrics/README.md +83 -0
- package/packages/orq-rc/docs/sdks/models/README.md +76 -0
- package/packages/orq-rc/docs/sdks/orq/README.md +10 -0
- package/packages/orq-rc/docs/sdks/prompts/README.md +557 -0
- package/packages/orq-rc/docs/sdks/remoteconfigs/README.md +77 -0
- package/packages/orq-rc/examples/README.md +31 -0
- package/packages/orq-rc/examples/contactsCreate.example.ts +42 -0
- package/packages/orq-rc/examples/package-lock.json +627 -0
- package/packages/orq-rc/examples/package.json +18 -0
- package/packages/orq-rc/jsr.json +28 -0
- package/packages/orq-rc/package-lock.json +3018 -0
- package/packages/orq-rc/package.json +43 -0
- package/packages/orq-rc/src/core.ts +13 -0
- package/{src/funcs/knowledgeBasesChunkText.ts → packages/orq-rc/src/funcs/chunkingParse.ts} +11 -11
- package/packages/orq-rc/src/funcs/contactsCreate.ts +165 -0
- package/packages/orq-rc/src/funcs/contactsDelete.ts +176 -0
- package/packages/orq-rc/src/funcs/contactsList.ts +169 -0
- package/packages/orq-rc/src/funcs/contactsRetrieve.ts +175 -0
- package/packages/orq-rc/src/funcs/contactsUpdate.ts +176 -0
- package/packages/orq-rc/src/funcs/datasetsClear.ts +167 -0
- package/packages/orq-rc/src/funcs/datasetsCreate.ts +165 -0
- package/packages/orq-rc/src/funcs/datasetsCreateDatapoint.ts +167 -0
- package/packages/orq-rc/src/funcs/datasetsDelete.ts +167 -0
- package/packages/orq-rc/src/funcs/datasetsDeleteDatapoint.ts +182 -0
- package/packages/orq-rc/src/funcs/datasetsList.ts +167 -0
- package/packages/orq-rc/src/funcs/datasetsListDatapoints.ts +174 -0
- package/packages/orq-rc/src/funcs/datasetsRetrieve.ts +175 -0
- package/packages/orq-rc/src/funcs/datasetsRetrieveDatapoint.ts +181 -0
- package/packages/orq-rc/src/funcs/datasetsUpdate.ts +176 -0
- package/packages/orq-rc/src/funcs/datasetsUpdateDatapoint.ts +179 -0
- package/packages/orq-rc/src/funcs/deploymentsGetConfig.ts +168 -0
- package/packages/orq-rc/src/funcs/deploymentsInvoke.ts +176 -0
- package/packages/orq-rc/src/funcs/deploymentsList.ts +176 -0
- package/packages/orq-rc/src/funcs/deploymentsMetricsCreate.ts +168 -0
- package/packages/orq-rc/src/funcs/deploymentsStream.ts +183 -0
- package/packages/orq-rc/src/funcs/evalsAgeAppropriate.ts +175 -0
- package/packages/orq-rc/src/funcs/evalsAll.ts +173 -0
- package/packages/orq-rc/src/funcs/evalsBertScore.ts +175 -0
- package/packages/orq-rc/src/funcs/evalsBleuScore.ts +175 -0
- package/packages/orq-rc/src/funcs/evalsBotDetection.ts +175 -0
- package/packages/orq-rc/src/funcs/evalsContains.ts +175 -0
- package/packages/orq-rc/src/funcs/evalsContainsAll.ts +175 -0
- package/packages/orq-rc/src/funcs/evalsContainsAny.ts +175 -0
- package/packages/orq-rc/src/funcs/evalsContainsEmail.ts +175 -0
- package/packages/orq-rc/src/funcs/evalsContainsNone.ts +175 -0
- package/packages/orq-rc/src/funcs/evalsContainsUrl.ts +175 -0
- package/packages/orq-rc/src/funcs/evalsContainsValidLink.ts +177 -0
- package/packages/orq-rc/src/funcs/evalsCreate.ts +169 -0
- package/packages/orq-rc/src/funcs/evalsDelete.ts +173 -0
- package/packages/orq-rc/src/funcs/evalsEndsWith.ts +175 -0
- package/packages/orq-rc/src/funcs/evalsExactMatch.ts +175 -0
- package/packages/orq-rc/src/funcs/evalsFactCheckingKnowledgeBase.ts +183 -0
- package/packages/orq-rc/src/funcs/evalsGrammar.ts +173 -0
- package/packages/orq-rc/src/funcs/evalsInvoke.ts +177 -0
- package/packages/orq-rc/src/funcs/evalsLengthBetween.ts +175 -0
- package/packages/orq-rc/src/funcs/evalsLengthGreaterThan.ts +177 -0
- package/packages/orq-rc/src/funcs/evalsLengthLessThan.ts +175 -0
- package/packages/orq-rc/src/funcs/evalsLocalization.ts +175 -0
- package/packages/orq-rc/src/funcs/evalsPii.ts +173 -0
- package/packages/orq-rc/src/funcs/evalsRagasCoherence.ts +175 -0
- package/packages/orq-rc/src/funcs/evalsRagasConciseness.ts +174 -0
- package/packages/orq-rc/src/funcs/evalsRagasContextEntitiesRecall.ts +183 -0
- package/packages/orq-rc/src/funcs/evalsRagasContextPrecision.ts +180 -0
- package/packages/orq-rc/src/funcs/evalsRagasContextRecall.ts +177 -0
- package/packages/orq-rc/src/funcs/evalsRagasCorrectness.ts +174 -0
- package/packages/orq-rc/src/funcs/evalsRagasFaithfulness.ts +177 -0
- package/packages/orq-rc/src/funcs/evalsRagasHarmfulness.ts +174 -0
- package/packages/orq-rc/src/funcs/evalsRagasMaliciousness.ts +177 -0
- package/packages/orq-rc/src/funcs/evalsRagasNoiseSensitivity.ts +180 -0
- package/packages/orq-rc/src/funcs/evalsRagasResponseRelevancy.ts +183 -0
- package/packages/orq-rc/src/funcs/evalsRagasSummarization.ts +177 -0
- package/packages/orq-rc/src/funcs/evalsSentimentClassification.ts +183 -0
- package/packages/orq-rc/src/funcs/evalsSummarization.ts +175 -0
- package/packages/orq-rc/src/funcs/evalsToneOfVoice.ts +175 -0
- package/packages/orq-rc/src/funcs/evalsTranslation.ts +175 -0
- package/packages/orq-rc/src/funcs/evalsUpdate.ts +173 -0
- package/packages/orq-rc/src/funcs/evalsValidJson.ts +175 -0
- package/packages/orq-rc/src/funcs/feedbackCreate.ts +160 -0
- package/packages/orq-rc/src/funcs/filesCreate.ts +187 -0
- package/packages/orq-rc/src/funcs/filesDelete.ts +164 -0
- package/packages/orq-rc/src/funcs/filesGet.ts +166 -0
- package/packages/orq-rc/src/funcs/filesList.ts +167 -0
- package/packages/orq-rc/src/funcs/knowledgeCreate.ts +158 -0
- package/packages/orq-rc/src/funcs/knowledgeCreateChunks.ts +171 -0
- package/packages/orq-rc/src/funcs/knowledgeCreateDatasource.ts +166 -0
- package/packages/orq-rc/src/funcs/knowledgeDelete.ts +167 -0
- package/packages/orq-rc/src/funcs/knowledgeDeleteChunk.ts +174 -0
- package/packages/orq-rc/src/funcs/knowledgeDeleteDatasource.ts +173 -0
- package/packages/orq-rc/src/funcs/knowledgeList.ts +169 -0
- package/packages/orq-rc/src/funcs/knowledgeListChunks.ts +178 -0
- package/packages/orq-rc/src/funcs/knowledgeListDatasources.ts +174 -0
- package/packages/orq-rc/src/funcs/knowledgeRetrieve.ts +166 -0
- package/packages/orq-rc/src/funcs/knowledgeRetrieveChunk.ts +173 -0
- package/packages/orq-rc/src/funcs/knowledgeRetrieveDatasource.ts +169 -0
- package/packages/orq-rc/src/funcs/knowledgeSearch.ts +167 -0
- package/packages/orq-rc/src/funcs/knowledgeUpdate.ts +164 -0
- package/packages/orq-rc/src/funcs/knowledgeUpdateChunk.ts +174 -0
- package/packages/orq-rc/src/funcs/knowledgeUpdateDatasource.ts +170 -0
- package/packages/orq-rc/src/funcs/modelsList.ts +142 -0
- package/packages/orq-rc/src/funcs/promptsCreate.ts +160 -0
- package/packages/orq-rc/src/funcs/promptsDelete.ts +164 -0
- package/packages/orq-rc/src/funcs/promptsGetVersion.ts +181 -0
- package/packages/orq-rc/src/funcs/promptsList.ts +167 -0
- package/packages/orq-rc/src/funcs/promptsListVersions.ts +173 -0
- package/packages/orq-rc/src/funcs/promptsRetrieve.ts +166 -0
- package/packages/orq-rc/src/funcs/promptsUpdate.ts +173 -0
- package/packages/orq-rc/src/funcs/remoteconfigsRetrieve.ts +161 -0
- package/packages/orq-rc/src/hooks/global.ts +44 -0
- package/packages/orq-rc/src/hooks/hooks.ts +132 -0
- package/packages/orq-rc/src/hooks/index.ts +6 -0
- package/packages/orq-rc/src/hooks/registration.ts +15 -0
- package/packages/orq-rc/src/hooks/types.ts +112 -0
- package/packages/orq-rc/src/index.ts +9 -0
- package/packages/orq-rc/src/lib/base64.ts +37 -0
- package/packages/orq-rc/src/lib/config.ts +74 -0
- package/packages/orq-rc/src/lib/dlv.ts +53 -0
- package/packages/orq-rc/src/lib/encodings.ts +483 -0
- package/packages/orq-rc/src/lib/env.ts +73 -0
- package/packages/orq-rc/src/lib/event-streams.ts +137 -0
- package/packages/orq-rc/src/lib/files.ts +82 -0
- package/packages/orq-rc/src/lib/http.ts +323 -0
- package/packages/orq-rc/src/lib/is-plain-object.ts +43 -0
- package/packages/orq-rc/src/lib/logger.ts +9 -0
- package/packages/orq-rc/src/lib/matchers.ts +345 -0
- package/packages/orq-rc/src/lib/primitives.ts +150 -0
- package/packages/orq-rc/src/lib/retries.ts +218 -0
- package/packages/orq-rc/src/lib/schemas.ts +91 -0
- package/packages/orq-rc/src/lib/sdks.ts +407 -0
- package/packages/orq-rc/src/lib/security.ts +261 -0
- package/packages/orq-rc/src/lib/url.ts +33 -0
- package/packages/orq-rc/src/mcp-server/cli/start/command.ts +112 -0
- package/packages/orq-rc/src/mcp-server/cli/start/impl.ts +136 -0
- package/packages/orq-rc/src/mcp-server/cli.ts +13 -0
- package/packages/orq-rc/src/mcp-server/console-logger.ts +71 -0
- package/packages/orq-rc/src/mcp-server/extensions.ts +17 -0
- package/packages/orq-rc/src/mcp-server/mcp-server.ts +26 -0
- package/packages/orq-rc/src/mcp-server/prompts.ts +117 -0
- package/packages/orq-rc/src/mcp-server/resources.ts +172 -0
- package/packages/orq-rc/src/mcp-server/scopes.ts +7 -0
- package/packages/orq-rc/src/mcp-server/server.ts +251 -0
- package/packages/orq-rc/src/mcp-server/shared.ts +75 -0
- package/{src/mcp-server/tools/knowledgeBasesChunkText.ts → packages/orq-rc/src/mcp-server/tools/chunkingParse.ts} +6 -6
- package/packages/orq-rc/src/mcp-server/tools/contactsCreate.ts +37 -0
- package/packages/orq-rc/src/mcp-server/tools/contactsDelete.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/contactsList.ts +37 -0
- package/packages/orq-rc/src/mcp-server/tools/contactsRetrieve.ts +37 -0
- package/packages/orq-rc/src/mcp-server/tools/contactsUpdate.ts +37 -0
- package/packages/orq-rc/src/mcp-server/tools/datasetsClear.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/datasetsCreate.ts +37 -0
- package/packages/orq-rc/src/mcp-server/tools/datasetsCreateDatapoint.ts +37 -0
- package/packages/orq-rc/src/mcp-server/tools/datasetsDelete.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/datasetsDeleteDatapoint.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/datasetsList.ts +37 -0
- package/packages/orq-rc/src/mcp-server/tools/datasetsListDatapoints.ts +37 -0
- package/packages/orq-rc/src/mcp-server/tools/datasetsRetrieve.ts +37 -0
- package/packages/orq-rc/src/mcp-server/tools/datasetsRetrieveDatapoint.ts +37 -0
- package/packages/orq-rc/src/mcp-server/tools/datasetsUpdate.ts +37 -0
- package/packages/orq-rc/src/mcp-server/tools/datasetsUpdateDatapoint.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/deploymentsGetConfig.ts +37 -0
- package/packages/orq-rc/src/mcp-server/tools/deploymentsInvoke.ts +37 -0
- package/packages/orq-rc/src/mcp-server/tools/deploymentsList.ts +37 -0
- package/packages/orq-rc/src/mcp-server/tools/deploymentsMetricsCreate.ts +37 -0
- package/packages/orq-rc/src/mcp-server/tools/deploymentsStream.ts +37 -0
- package/packages/orq-rc/src/mcp-server/tools/evalsAgeAppropriate.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/evalsAll.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/evalsBertScore.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/evalsBleuScore.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/evalsBotDetection.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/evalsContains.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/evalsContainsAll.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/evalsContainsAny.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/evalsContainsEmail.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/evalsContainsNone.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/evalsContainsUrl.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/evalsContainsValidLink.ts +36 -0
- package/packages/orq-rc/src/mcp-server/tools/evalsCreate.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/evalsDelete.ts +33 -0
- package/packages/orq-rc/src/mcp-server/tools/evalsEndsWith.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/evalsExactMatch.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/evalsFactCheckingKnowledgeBase.ts +37 -0
- package/packages/orq-rc/src/mcp-server/tools/evalsGrammar.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/evalsInvoke.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/evalsLengthBetween.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/evalsLengthGreaterThan.ts +36 -0
- package/packages/orq-rc/src/mcp-server/tools/evalsLengthLessThan.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/evalsLocalization.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/evalsPii.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/evalsRagasCoherence.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/evalsRagasConciseness.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/evalsRagasContextEntitiesRecall.ts +37 -0
- package/packages/orq-rc/src/mcp-server/tools/evalsRagasContextPrecision.ts +36 -0
- package/packages/orq-rc/src/mcp-server/tools/evalsRagasContextRecall.ts +36 -0
- package/packages/orq-rc/src/mcp-server/tools/evalsRagasCorrectness.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/evalsRagasFaithfulness.ts +36 -0
- package/packages/orq-rc/src/mcp-server/tools/evalsRagasHarmfulness.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/evalsRagasMaliciousness.ts +36 -0
- package/packages/orq-rc/src/mcp-server/tools/evalsRagasNoiseSensitivity.ts +36 -0
- package/packages/orq-rc/src/mcp-server/tools/evalsRagasResponseRelevancy.ts +36 -0
- package/packages/orq-rc/src/mcp-server/tools/evalsRagasSummarization.ts +36 -0
- package/packages/orq-rc/src/mcp-server/tools/evalsSentimentClassification.ts +36 -0
- package/packages/orq-rc/src/mcp-server/tools/evalsSummarization.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/evalsToneOfVoice.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/evalsTranslation.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/evalsUpdate.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/evalsValidJson.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/feedbackCreate.ts +37 -0
- package/packages/orq-rc/src/mcp-server/tools/filesCreate.ts +37 -0
- package/packages/orq-rc/src/mcp-server/tools/filesDelete.ts +33 -0
- package/packages/orq-rc/src/mcp-server/tools/filesGet.ts +37 -0
- package/packages/orq-rc/src/mcp-server/tools/filesList.ts +37 -0
- package/packages/orq-rc/src/mcp-server/tools/knowledgeCreate.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/knowledgeCreateChunks.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/knowledgeCreateDatasource.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/knowledgeDelete.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/knowledgeDeleteChunk.ts +33 -0
- package/packages/orq-rc/src/mcp-server/tools/knowledgeDeleteDatasource.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/knowledgeList.ts +37 -0
- package/packages/orq-rc/src/mcp-server/tools/knowledgeListChunks.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/knowledgeListDatasources.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/knowledgeRetrieve.ts +37 -0
- package/packages/orq-rc/src/mcp-server/tools/knowledgeRetrieveChunk.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/knowledgeRetrieveDatasource.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/knowledgeSearch.ts +37 -0
- package/packages/orq-rc/src/mcp-server/tools/knowledgeUpdate.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/knowledgeUpdateChunk.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/knowledgeUpdateDatasource.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/modelsList.ts +30 -0
- package/packages/orq-rc/src/mcp-server/tools/promptsCreate.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/promptsDelete.ts +33 -0
- package/packages/orq-rc/src/mcp-server/tools/promptsGetVersion.ts +37 -0
- package/packages/orq-rc/src/mcp-server/tools/promptsList.ts +37 -0
- package/packages/orq-rc/src/mcp-server/tools/promptsListVersions.ts +37 -0
- package/packages/orq-rc/src/mcp-server/tools/promptsRetrieve.ts +37 -0
- package/packages/orq-rc/src/mcp-server/tools/promptsUpdate.ts +35 -0
- package/packages/orq-rc/src/mcp-server/tools/remoteconfigsRetrieve.ts +36 -0
- package/packages/orq-rc/src/mcp-server/tools.ts +129 -0
- package/packages/orq-rc/src/models/components/deployments.ts +7246 -0
- package/packages/orq-rc/src/models/components/index.ts +6 -0
- package/packages/orq-rc/src/models/components/security.ts +71 -0
- package/packages/orq-rc/src/models/errors/apierror.ts +40 -0
- package/packages/orq-rc/src/models/errors/createeval.ts +80 -0
- package/packages/orq-rc/src/models/errors/deletecontact.ts +91 -0
- package/packages/orq-rc/src/models/errors/deleteeval.ts +80 -0
- package/packages/orq-rc/src/models/errors/evalsageappropriate.ts +156 -0
- package/packages/orq-rc/src/models/errors/evalsbertscore.ts +154 -0
- package/packages/orq-rc/src/models/errors/evalsbleuscore.ts +154 -0
- package/packages/orq-rc/src/models/errors/evalsbotdetection.ts +155 -0
- package/packages/orq-rc/src/models/errors/evalscontains.ts +154 -0
- package/packages/orq-rc/src/models/errors/evalscontainsall.ts +155 -0
- package/packages/orq-rc/src/models/errors/evalscontainsany.ts +155 -0
- package/packages/orq-rc/src/models/errors/evalscontainsemail.ts +156 -0
- package/packages/orq-rc/src/models/errors/evalscontainsnone.ts +155 -0
- package/packages/orq-rc/src/models/errors/evalscontainsurl.ts +155 -0
- package/packages/orq-rc/src/models/errors/evalscontainsvalidlink.ts +157 -0
- package/packages/orq-rc/src/models/errors/evalsendswith.ts +154 -0
- package/packages/orq-rc/src/models/errors/evalsexactmatch.ts +154 -0
- package/packages/orq-rc/src/models/errors/evalsfactcheckingknowledgebase.ts +160 -0
- package/packages/orq-rc/src/models/errors/evalsgrammar.ts +154 -0
- package/packages/orq-rc/src/models/errors/evalslengthbetween.ts +156 -0
- package/packages/orq-rc/src/models/errors/evalslengthgreaterthan.ts +157 -0
- package/packages/orq-rc/src/models/errors/evalslengthlessthan.ts +156 -0
- package/packages/orq-rc/src/models/errors/evalslocalization.ts +155 -0
- package/packages/orq-rc/src/models/errors/evalspii.ts +154 -0
- package/packages/orq-rc/src/models/errors/evalsragascoherence.ts +156 -0
- package/packages/orq-rc/src/models/errors/evalsragasconciseness.ts +157 -0
- package/packages/orq-rc/src/models/errors/evalsragascontextentitiesrecall.ts +163 -0
- package/packages/orq-rc/src/models/errors/evalsragascontextprecision.ts +160 -0
- package/packages/orq-rc/src/models/errors/evalsragascontextrecall.ts +158 -0
- package/packages/orq-rc/src/models/errors/evalsragascorrectness.ts +157 -0
- package/packages/orq-rc/src/models/errors/evalsragasfaithfulness.ts +157 -0
- package/packages/orq-rc/src/models/errors/evalsragasharmfulness.ts +157 -0
- package/packages/orq-rc/src/models/errors/evalsragasmaliciousness.ts +158 -0
- package/packages/orq-rc/src/models/errors/evalsragasnoisesensitivity.ts +160 -0
- package/packages/orq-rc/src/models/errors/evalsragasresponserelevancy.ts +160 -0
- package/packages/orq-rc/src/models/errors/evalsragassummarization.ts +158 -0
- package/packages/orq-rc/src/models/errors/evalssentimentclassification.ts +160 -0
- package/packages/orq-rc/src/models/errors/evalssummarization.ts +156 -0
- package/packages/orq-rc/src/models/errors/evalstoneofvoice.ts +155 -0
- package/packages/orq-rc/src/models/errors/evalstranslation.ts +155 -0
- package/packages/orq-rc/src/models/errors/evalsvalidjson.ts +154 -0
- package/packages/orq-rc/src/models/errors/getevals.ts +80 -0
- package/packages/orq-rc/src/models/errors/getpromptversion.ts +80 -0
- package/packages/orq-rc/src/models/errors/honoapierror.ts +90 -0
- package/packages/orq-rc/src/models/errors/httpclienterrors.ts +62 -0
- package/packages/orq-rc/src/models/errors/index.ts +56 -0
- package/packages/orq-rc/src/models/errors/invokeeval.ts +154 -0
- package/packages/orq-rc/src/models/errors/orqerror.ts +35 -0
- package/packages/orq-rc/src/models/errors/responsevalidationerror.ts +50 -0
- package/packages/orq-rc/src/models/errors/retrievecontact.ts +91 -0
- package/packages/orq-rc/src/models/errors/sdkvalidationerror.ts +109 -0
- package/packages/orq-rc/src/models/errors/updatecontact.ts +83 -0
- package/packages/orq-rc/src/models/errors/updateeval.ts +80 -0
- package/packages/orq-rc/src/models/errors/updateprompt.ts +80 -0
- package/packages/orq-rc/src/models/operations/cleardataset.ts +75 -0
- package/packages/orq-rc/src/models/operations/createchunk.ts +428 -0
- package/packages/orq-rc/src/models/operations/createcontact.ts +267 -0
- package/packages/orq-rc/src/models/operations/createdataset.ts +296 -0
- package/packages/orq-rc/src/models/operations/createdatasetitem.ts +5222 -0
- package/packages/orq-rc/src/models/operations/createdatasource.ts +852 -0
- package/packages/orq-rc/src/models/operations/createeval.ts +3830 -0
- package/packages/orq-rc/src/models/operations/createfeedback.ts +286 -0
- package/packages/orq-rc/src/models/operations/createknowledge.ts +846 -0
- package/packages/orq-rc/src/models/operations/createprompt.ts +4087 -0
- package/packages/orq-rc/src/models/operations/deletechunk.ts +96 -0
- package/packages/orq-rc/src/models/operations/deletecontact.ts +69 -0
- package/packages/orq-rc/src/models/operations/deletedatapoint.ts +81 -0
- package/packages/orq-rc/src/models/operations/deletedataset.ts +75 -0
- package/packages/orq-rc/src/models/operations/deletedatasource.ts +87 -0
- package/packages/orq-rc/src/models/operations/deleteeval.ts +66 -0
- package/packages/orq-rc/src/models/operations/deleteknowledge.ts +78 -0
- package/packages/orq-rc/src/models/operations/deleteprompt.ts +69 -0
- package/packages/orq-rc/src/models/operations/deploymentcreatemetric.ts +5439 -0
- package/packages/orq-rc/src/models/operations/deploymentgetconfig.ts +9336 -0
- package/packages/orq-rc/src/models/operations/deploymentinvoke.ts +1258 -0
- package/packages/orq-rc/src/models/operations/deployments.ts +2330 -0
- package/packages/orq-rc/src/models/operations/deploymentstream.ts +9449 -0
- package/packages/orq-rc/src/models/operations/evalsageappropriate.ts +253 -0
- package/packages/orq-rc/src/models/operations/evalsbertscore.ts +197 -0
- package/packages/orq-rc/src/models/operations/evalsbleuscore.ts +131 -0
- package/packages/orq-rc/src/models/operations/evalsbotdetection.ts +249 -0
- package/packages/orq-rc/src/models/operations/evalscontains.ts +250 -0
- package/packages/orq-rc/src/models/operations/evalscontainsall.ts +248 -0
- package/packages/orq-rc/src/models/operations/evalscontainsany.ts +254 -0
- package/packages/orq-rc/src/models/operations/evalscontainsemail.ts +181 -0
- package/packages/orq-rc/src/models/operations/evalscontainsnone.ts +254 -0
- package/packages/orq-rc/src/models/operations/evalscontainsurl.ts +181 -0
- package/packages/orq-rc/src/models/operations/evalscontainsvalidlink.ts +186 -0
- package/packages/orq-rc/src/models/operations/evalsendswith.ts +250 -0
- package/packages/orq-rc/src/models/operations/evalsexactmatch.ts +183 -0
- package/packages/orq-rc/src/models/operations/evalsfactcheckingknowledgebase.ts +299 -0
- package/packages/orq-rc/src/models/operations/evalsgrammar.ts +243 -0
- package/packages/orq-rc/src/models/operations/evalslengthbetween.ts +268 -0
- package/packages/orq-rc/src/models/operations/evalslengthgreaterthan.ts +266 -0
- package/packages/orq-rc/src/models/operations/evalslengthlessthan.ts +259 -0
- package/packages/orq-rc/src/models/operations/evalslocalization.ts +253 -0
- package/packages/orq-rc/src/models/operations/evalspii.ts +243 -0
- package/packages/orq-rc/src/models/operations/evalsragascoherence.ts +152 -0
- package/packages/orq-rc/src/models/operations/evalsragasconciseness.ts +153 -0
- package/packages/orq-rc/src/models/operations/evalsragascontextentitiesrecall.ts +164 -0
- package/packages/orq-rc/src/models/operations/evalsragascontextprecision.ts +166 -0
- package/packages/orq-rc/src/models/operations/evalsragascontextrecall.ts +164 -0
- package/packages/orq-rc/src/models/operations/evalsragascorrectness.ts +153 -0
- package/packages/orq-rc/src/models/operations/evalsragasfaithfulness.ts +155 -0
- package/packages/orq-rc/src/models/operations/evalsragasharmfulness.ts +146 -0
- package/packages/orq-rc/src/models/operations/evalsragasmaliciousness.ts +157 -0
- package/packages/orq-rc/src/models/operations/evalsragasnoisesensitivity.ts +166 -0
- package/packages/orq-rc/src/models/operations/evalsragasresponserelevancy.ts +165 -0
- package/packages/orq-rc/src/models/operations/evalsragassummarization.ts +150 -0
- package/packages/orq-rc/src/models/operations/evalssentimentclassification.ts +285 -0
- package/packages/orq-rc/src/models/operations/evalssummarization.ts +253 -0
- package/packages/orq-rc/src/models/operations/evalstoneofvoice.ts +251 -0
- package/packages/orq-rc/src/models/operations/evalstranslation.ts +251 -0
- package/packages/orq-rc/src/models/operations/evalsvalidjson.ts +177 -0
- package/packages/orq-rc/src/models/operations/filedelete.ts +78 -0
- package/packages/orq-rc/src/models/operations/fileget.ts +223 -0
- package/packages/orq-rc/src/models/operations/filelist.ts +337 -0
- package/packages/orq-rc/src/models/operations/fileupload.ts +327 -0
- package/packages/orq-rc/src/models/operations/getallprompts.ts +2298 -0
- package/packages/orq-rc/src/models/operations/getevals.ts +7290 -0
- package/packages/orq-rc/src/models/operations/getonechunk.ts +315 -0
- package/packages/orq-rc/src/models/operations/getoneknowledge.ts +537 -0
- package/packages/orq-rc/src/models/operations/getoneprompt.ts +2159 -0
- package/packages/orq-rc/src/models/operations/getpromptversion.ts +2164 -0
- package/packages/orq-rc/src/models/operations/index.ts +98 -0
- package/packages/orq-rc/src/models/operations/invokeeval.ts +2520 -0
- package/packages/orq-rc/src/models/operations/listchunks.ts +494 -0
- package/packages/orq-rc/src/models/operations/listcontacts.ts +490 -0
- package/packages/orq-rc/src/models/operations/listdatasetdatapoints.ts +2784 -0
- package/packages/orq-rc/src/models/operations/listdatasets.ts +406 -0
- package/packages/orq-rc/src/models/operations/listdatasources.ts +447 -0
- package/packages/orq-rc/src/models/operations/listknowledgebases.ts +663 -0
- package/packages/orq-rc/src/models/operations/listmodels.ts +273 -0
- package/packages/orq-rc/src/models/operations/listpromptversions.ts +2296 -0
- package/{src/models/operations/chunktext.ts → packages/orq-rc/src/models/operations/parse.ts} +164 -183
- package/packages/orq-rc/src/models/operations/remoteconfigsgetconfig.ts +190 -0
- package/packages/orq-rc/src/models/operations/retrievecontact.ts +210 -0
- package/packages/orq-rc/src/models/operations/retrievedatapoint.ts +2586 -0
- package/packages/orq-rc/src/models/operations/retrievedataset.ts +288 -0
- package/packages/orq-rc/src/models/operations/retrievedatasource.ts +273 -0
- package/packages/orq-rc/src/models/operations/searchknowledge.ts +3367 -0
- package/packages/orq-rc/src/models/operations/updatechunk.ts +448 -0
- package/packages/orq-rc/src/models/operations/updatecontact.ts +325 -0
- package/packages/orq-rc/src/models/operations/updatedatapoint.ts +5155 -0
- package/packages/orq-rc/src/models/operations/updatedataset.ts +393 -0
- package/packages/orq-rc/src/models/operations/updatedatasource.ts +345 -0
- package/packages/orq-rc/src/models/operations/updateeval.ts +4131 -0
- package/packages/orq-rc/src/models/operations/updateknowledge.ts +980 -0
- package/packages/orq-rc/src/models/operations/updateprompt.ts +4224 -0
- package/{src/sdk/knowledgebases.ts → packages/orq-rc/src/sdk/chunking.ts} +7 -7
- package/packages/orq-rc/src/sdk/contacts.ts +99 -0
- package/packages/orq-rc/src/sdk/datasets.ts +204 -0
- package/packages/orq-rc/src/sdk/deployments.ts +89 -0
- package/packages/orq-rc/src/sdk/evals.ts +639 -0
- package/packages/orq-rc/src/sdk/feedback.ts +27 -0
- package/packages/orq-rc/src/sdk/files.ts +78 -0
- package/packages/orq-rc/src/sdk/index.ts +5 -0
- package/packages/orq-rc/src/sdk/knowledge.ts +264 -0
- package/packages/orq-rc/src/sdk/metrics.ts +27 -0
- package/packages/orq-rc/src/sdk/models.ts +25 -0
- package/packages/orq-rc/src/sdk/prompts.ts +126 -0
- package/packages/orq-rc/src/sdk/remoteconfigs.ts +24 -0
- package/packages/orq-rc/src/sdk/sdk.ts +73 -0
- package/packages/orq-rc/src/types/async.ts +68 -0
- package/packages/orq-rc/src/types/blobs.ts +31 -0
- package/packages/orq-rc/src/types/constdatetime.ts +15 -0
- package/packages/orq-rc/src/types/enums.ts +16 -0
- package/packages/orq-rc/src/types/fp.ts +50 -0
- package/packages/orq-rc/src/types/index.ts +11 -0
- package/packages/orq-rc/src/types/operations.ts +105 -0
- package/packages/orq-rc/src/types/rfcdate.ts +54 -0
- package/packages/orq-rc/src/types/streams.ts +21 -0
- package/packages/orq-rc/tsconfig.json +41 -0
- package/sdk/{knowledgebases.d.ts → chunking.d.ts} +4 -4
- package/sdk/chunking.d.ts.map +1 -0
- package/sdk/{knowledgebases.js → chunking.js} +8 -8
- package/sdk/chunking.js.map +1 -0
- package/sdk/knowledge.d.ts +4 -0
- package/sdk/knowledge.d.ts.map +1 -1
- package/sdk/knowledge.js +7 -0
- package/sdk/knowledge.js.map +1 -1
- package/sdk/sdk.d.ts +3 -3
- package/sdk/sdk.d.ts.map +1 -1
- package/sdk/sdk.js +3 -3
- package/sdk/sdk.js.map +1 -1
- package/src/funcs/chunkingParse.ts +160 -0
- package/src/funcs/knowledgeCreate.ts +158 -0
- package/src/lib/config.ts +3 -3
- package/src/lib/event-streams.ts +21 -31
- package/src/mcp-server/mcp-server.ts +1 -1
- package/src/mcp-server/server.ts +5 -3
- package/src/mcp-server/tools/chunkingParse.ts +37 -0
- package/src/mcp-server/tools/knowledgeCreate.ts +35 -0
- package/src/models/components/deployments.ts +6 -49
- package/src/models/operations/createcontact.ts +2 -2
- package/src/models/operations/createdataset.ts +2 -2
- package/src/models/operations/createdatasetitem.ts +4 -4
- package/src/models/operations/createdatasource.ts +2 -2
- package/src/models/operations/createeval.ts +16 -16
- package/src/models/operations/createknowledge.ts +846 -0
- package/src/models/operations/createprompt.ts +6 -2
- package/src/models/operations/deploymentcreatemetric.ts +2 -2
- package/src/models/operations/deploymentgetconfig.ts +7 -50
- package/src/models/operations/deploymentinvoke.ts +2 -0
- package/src/models/operations/deployments.ts +3 -1
- package/src/models/operations/deploymentstream.ts +6 -56
- package/src/models/operations/fileget.ts +2 -2
- package/src/models/operations/filelist.ts +2 -2
- package/src/models/operations/fileupload.ts +2 -2
- package/src/models/operations/getallprompts.ts +3 -1
- package/src/models/operations/getevals.ts +28 -28
- package/src/models/operations/getoneprompt.ts +3 -1
- package/src/models/operations/getpromptversion.ts +3 -1
- package/src/models/operations/index.ts +2 -1
- package/src/models/operations/invokeeval.ts +1 -1
- package/src/models/operations/listcontacts.ts +2 -2
- package/src/models/operations/listdatasetdatapoints.ts +3 -3
- package/src/models/operations/listdatasets.ts +2 -2
- package/src/models/operations/listdatasources.ts +2 -2
- package/src/models/operations/listpromptversions.ts +3 -1
- package/src/models/operations/parse.ts +1610 -0
- package/src/models/operations/retrievecontact.ts +2 -2
- package/src/models/operations/retrievedatapoint.ts +3 -3
- package/src/models/operations/retrievedataset.ts +2 -2
- package/src/models/operations/retrievedatasource.ts +2 -2
- package/src/models/operations/updatecontact.ts +2 -2
- package/src/models/operations/updatedatapoint.ts +4 -4
- package/src/models/operations/updatedataset.ts +2 -2
- package/src/models/operations/updatedatasource.ts +2 -2
- package/src/models/operations/updateeval.ts +16 -16
- package/src/models/operations/updateknowledge.ts +266 -206
- package/src/models/operations/updateprompt.ts +6 -2
- package/src/sdk/chunking.ts +27 -0
- package/src/sdk/knowledge.ts +15 -0
- package/src/sdk/sdk.ts +4 -4
- package/funcs/knowledgeBasesChunkText.d.ts.map +0 -1
- package/funcs/knowledgeBasesChunkText.js.map +0 -1
- package/mcp-server/tools/knowledgeBasesChunkText.d.ts +0 -8
- package/mcp-server/tools/knowledgeBasesChunkText.d.ts.map +0 -1
- package/mcp-server/tools/knowledgeBasesChunkText.js.map +0 -1
- package/models/operations/chunktext.d.ts.map +0 -1
- package/models/operations/chunktext.js.map +0 -1
- package/sdk/knowledgebases.d.ts.map +0 -1
- package/sdk/knowledgebases.js.map +0 -1
|
@@ -1,18 +1,19 @@
|
|
|
1
|
-
#
|
|
2
|
-
(*
|
|
1
|
+
# Chunking
|
|
2
|
+
(*chunking*)
|
|
3
3
|
|
|
4
4
|
## Overview
|
|
5
5
|
|
|
6
6
|
### Available Operations
|
|
7
7
|
|
|
8
|
-
* [
|
|
8
|
+
* [parse](#parse) - Parse text
|
|
9
9
|
|
|
10
|
-
##
|
|
10
|
+
## parse
|
|
11
11
|
|
|
12
12
|
Split large text documents into smaller, manageable chunks using different chunking strategies optimized for RAG (Retrieval-Augmented Generation) workflows. This endpoint supports multiple chunking algorithms including token-based, sentence-based, recursive, semantic, and specialized strategies.
|
|
13
13
|
|
|
14
14
|
### Example Usage
|
|
15
15
|
|
|
16
|
+
<!-- UsageSnippet language="typescript" operationID="parse" method="post" path="/v2/chunking" -->
|
|
16
17
|
```typescript
|
|
17
18
|
import { Orq } from "@orq-ai/node";
|
|
18
19
|
|
|
@@ -21,7 +22,7 @@ const orq = new Orq({
|
|
|
21
22
|
});
|
|
22
23
|
|
|
23
24
|
async function run() {
|
|
24
|
-
const result = await orq.
|
|
25
|
+
const result = await orq.chunking.parse({
|
|
25
26
|
text: "The quick brown fox jumps over the lazy dog. This is a sample text that will be chunked into smaller pieces. Each chunk will maintain context while respecting the maximum chunk size.",
|
|
26
27
|
metadata: true,
|
|
27
28
|
strategy: "semantic",
|
|
@@ -44,7 +45,7 @@ The standalone function version of this method:
|
|
|
44
45
|
|
|
45
46
|
```typescript
|
|
46
47
|
import { OrqCore } from "@orq-ai/node/core.js";
|
|
47
|
-
import {
|
|
48
|
+
import { chunkingParse } from "@orq-ai/node/funcs/chunkingParse.js";
|
|
48
49
|
|
|
49
50
|
// Use `OrqCore` for best tree-shaking performance.
|
|
50
51
|
// You can create one instance of it to use across an application.
|
|
@@ -53,7 +54,7 @@ const orq = new OrqCore({
|
|
|
53
54
|
});
|
|
54
55
|
|
|
55
56
|
async function run() {
|
|
56
|
-
const res = await
|
|
57
|
+
const res = await chunkingParse(orq, {
|
|
57
58
|
text: "The quick brown fox jumps over the lazy dog. This is a sample text that will be chunked into smaller pieces. Each chunk will maintain context while respecting the maximum chunk size.",
|
|
58
59
|
metadata: true,
|
|
59
60
|
strategy: "semantic",
|
|
@@ -67,7 +68,7 @@ async function run() {
|
|
|
67
68
|
const { value: result } = res;
|
|
68
69
|
console.log(result);
|
|
69
70
|
} else {
|
|
70
|
-
console.log("
|
|
71
|
+
console.log("chunkingParse failed:", res.error);
|
|
71
72
|
}
|
|
72
73
|
}
|
|
73
74
|
|
|
@@ -78,14 +79,14 @@ run();
|
|
|
78
79
|
|
|
79
80
|
| Parameter | Type | Required | Description |
|
|
80
81
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
81
|
-
| `request` | [operations.
|
|
82
|
+
| `request` | [operations.ParseChunkingRequest](../../models/operations/parsechunkingrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
82
83
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
83
84
|
| `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. |
|
|
84
85
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
85
86
|
|
|
86
87
|
### Response
|
|
87
88
|
|
|
88
|
-
**Promise\<[operations.
|
|
89
|
+
**Promise\<[operations.ParseResponseBody](../../models/operations/parseresponsebody.md)\>**
|
|
89
90
|
|
|
90
91
|
### Errors
|
|
91
92
|
|
|
@@ -17,6 +17,7 @@ Creates a new contact or updates an existing one based on external_id. Use this
|
|
|
17
17
|
|
|
18
18
|
### Example Usage
|
|
19
19
|
|
|
20
|
+
<!-- UsageSnippet language="typescript" operationID="CreateContact" method="post" path="/v2/contacts" -->
|
|
20
21
|
```typescript
|
|
21
22
|
import { Orq } from "@orq-ai/node";
|
|
22
23
|
|
|
@@ -117,6 +118,7 @@ Retrieves a paginated list of contacts in your workspace. Use pagination paramet
|
|
|
117
118
|
|
|
118
119
|
### Example Usage
|
|
119
120
|
|
|
121
|
+
<!-- UsageSnippet language="typescript" operationID="ListContacts" method="get" path="/v2/contacts" -->
|
|
120
122
|
```typescript
|
|
121
123
|
import { Orq } from "@orq-ai/node";
|
|
122
124
|
|
|
@@ -199,6 +201,7 @@ Retrieves detailed information about a specific contact using their contact ID o
|
|
|
199
201
|
|
|
200
202
|
### Example Usage
|
|
201
203
|
|
|
204
|
+
<!-- UsageSnippet language="typescript" operationID="RetrieveContact" method="get" path="/v2/contacts/{id}" -->
|
|
202
205
|
```typescript
|
|
203
206
|
import { Orq } from "@orq-ai/node";
|
|
204
207
|
|
|
@@ -272,6 +275,7 @@ Updates specific fields of an existing contact. Only the fields provided in the
|
|
|
272
275
|
|
|
273
276
|
### Example Usage
|
|
274
277
|
|
|
278
|
+
<!-- UsageSnippet language="typescript" operationID="UpdateContact" method="patch" path="/v2/contacts/{id}" -->
|
|
275
279
|
```typescript
|
|
276
280
|
import { Orq } from "@orq-ai/node";
|
|
277
281
|
|
|
@@ -377,6 +381,7 @@ Permanently deletes a contact from your workspace. This action cannot be undone.
|
|
|
377
381
|
|
|
378
382
|
### Example Usage
|
|
379
383
|
|
|
384
|
+
<!-- UsageSnippet language="typescript" operationID="DeleteContact" method="delete" path="/v2/contacts/{id}" -->
|
|
380
385
|
```typescript
|
|
381
386
|
import { Orq } from "@orq-ai/node";
|
|
382
387
|
|
|
@@ -23,6 +23,7 @@ Retrieves a paginated list of datasets for the current workspace. Results can be
|
|
|
23
23
|
|
|
24
24
|
### Example Usage
|
|
25
25
|
|
|
26
|
+
<!-- UsageSnippet language="typescript" operationID="ListDatasets" method="get" path="/v2/datasets" -->
|
|
26
27
|
```typescript
|
|
27
28
|
import { Orq } from "@orq-ai/node";
|
|
28
29
|
|
|
@@ -91,6 +92,7 @@ Creates a new dataset in the specified project.
|
|
|
91
92
|
|
|
92
93
|
### Example Usage
|
|
93
94
|
|
|
95
|
+
<!-- UsageSnippet language="typescript" operationID="CreateDataset" method="post" path="/v2/datasets" -->
|
|
94
96
|
```typescript
|
|
95
97
|
import { Orq } from "@orq-ai/node";
|
|
96
98
|
|
|
@@ -165,6 +167,7 @@ Retrieves a specific dataset by its unique identifier
|
|
|
165
167
|
|
|
166
168
|
### Example Usage
|
|
167
169
|
|
|
170
|
+
<!-- UsageSnippet language="typescript" operationID="RetrieveDataset" method="get" path="/v2/datasets/{dataset_id}" -->
|
|
168
171
|
```typescript
|
|
169
172
|
import { Orq } from "@orq-ai/node";
|
|
170
173
|
|
|
@@ -238,6 +241,7 @@ Update a dataset
|
|
|
238
241
|
|
|
239
242
|
### Example Usage
|
|
240
243
|
|
|
244
|
+
<!-- UsageSnippet language="typescript" operationID="UpdateDataset" method="patch" path="/v2/datasets/{dataset_id}" -->
|
|
241
245
|
```typescript
|
|
242
246
|
import { Orq } from "@orq-ai/node";
|
|
243
247
|
|
|
@@ -317,6 +321,7 @@ Permanently deletes a dataset and all its datapoints. This action is irreversibl
|
|
|
317
321
|
|
|
318
322
|
### Example Usage
|
|
319
323
|
|
|
324
|
+
<!-- UsageSnippet language="typescript" operationID="DeleteDataset" method="delete" path="/v2/datasets/{dataset_id}" -->
|
|
320
325
|
```typescript
|
|
321
326
|
import { Orq } from "@orq-ai/node";
|
|
322
327
|
|
|
@@ -389,6 +394,7 @@ Retrieves a paginated list of datapoints from a specific dataset.
|
|
|
389
394
|
|
|
390
395
|
### Example Usage
|
|
391
396
|
|
|
397
|
+
<!-- UsageSnippet language="typescript" operationID="ListDatasetDatapoints" method="get" path="/v2/datasets/{dataset_id}/datapoints" -->
|
|
392
398
|
```typescript
|
|
393
399
|
import { Orq } from "@orq-ai/node";
|
|
394
400
|
|
|
@@ -461,6 +467,7 @@ Creates a new datapoint in the specified dataset.
|
|
|
461
467
|
|
|
462
468
|
### Example Usage
|
|
463
469
|
|
|
470
|
+
<!-- UsageSnippet language="typescript" operationID="CreateDatasetItem" method="post" path="/v2/datasets/{dataset_id}/datapoints" -->
|
|
464
471
|
```typescript
|
|
465
472
|
import { Orq } from "@orq-ai/node";
|
|
466
473
|
|
|
@@ -533,6 +540,7 @@ Retrieves a datapoint object
|
|
|
533
540
|
|
|
534
541
|
### Example Usage
|
|
535
542
|
|
|
543
|
+
<!-- UsageSnippet language="typescript" operationID="RetrieveDatapoint" method="get" path="/v2/datasets/{dataset_id}/datapoints/{datapoint_id}" -->
|
|
536
544
|
```typescript
|
|
537
545
|
import { Orq } from "@orq-ai/node";
|
|
538
546
|
|
|
@@ -608,6 +616,7 @@ Update a datapoint
|
|
|
608
616
|
|
|
609
617
|
### Example Usage
|
|
610
618
|
|
|
619
|
+
<!-- UsageSnippet language="typescript" operationID="UpdateDatapoint" method="patch" path="/v2/datasets/{dataset_id}/datapoints/{datapoint_id}" -->
|
|
611
620
|
```typescript
|
|
612
621
|
import { Orq } from "@orq-ai/node";
|
|
613
622
|
|
|
@@ -683,6 +692,7 @@ Permanently deletes a specific datapoint from a dataset.
|
|
|
683
692
|
|
|
684
693
|
### Example Usage
|
|
685
694
|
|
|
695
|
+
<!-- UsageSnippet language="typescript" operationID="DeleteDatapoint" method="delete" path="/v2/datasets/{dataset_id}/datapoints/{datapoint_id}" -->
|
|
686
696
|
```typescript
|
|
687
697
|
import { Orq } from "@orq-ai/node";
|
|
688
698
|
|
|
@@ -758,6 +768,7 @@ Delete all datapoints from a dataset. This action is irreversible.
|
|
|
758
768
|
|
|
759
769
|
### Example Usage
|
|
760
770
|
|
|
771
|
+
<!-- UsageSnippet language="typescript" operationID="ClearDataset" method="delete" path="/v2/datasets/{dataset_id}/clear" -->
|
|
761
772
|
```typescript
|
|
762
773
|
import { Orq } from "@orq-ai/node";
|
|
763
774
|
|
|
@@ -16,6 +16,7 @@ Returns a list of your deployments. The deployments are returned sorted by creat
|
|
|
16
16
|
|
|
17
17
|
### Example Usage
|
|
18
18
|
|
|
19
|
+
<!-- UsageSnippet language="typescript" operationID="Deployments" method="get" path="/v2/deployments" -->
|
|
19
20
|
```typescript
|
|
20
21
|
import { Orq } from "@orq-ai/node";
|
|
21
22
|
|
|
@@ -85,6 +86,7 @@ Retrieve the deployment configuration
|
|
|
85
86
|
|
|
86
87
|
### Example Usage
|
|
87
88
|
|
|
89
|
+
<!-- UsageSnippet language="typescript" operationID="DeploymentGetConfig" method="post" path="/v2/deployments/get_config" -->
|
|
88
90
|
```typescript
|
|
89
91
|
import { Orq } from "@orq-ai/node";
|
|
90
92
|
|
|
@@ -157,6 +159,7 @@ Invoke a deployment with a given payload
|
|
|
157
159
|
|
|
158
160
|
### Example Usage
|
|
159
161
|
|
|
162
|
+
<!-- UsageSnippet language="typescript" operationID="DeploymentInvoke" method="post" path="/v2/deployments/invoke" -->
|
|
160
163
|
```typescript
|
|
161
164
|
import { Orq } from "@orq-ai/node";
|
|
162
165
|
|
|
@@ -233,6 +236,7 @@ Stream deployment generation. Only supported for completions and chat completion
|
|
|
233
236
|
|
|
234
237
|
### Example Usage
|
|
235
238
|
|
|
239
|
+
<!-- UsageSnippet language="typescript" operationID="DeploymentStream" method="post" path="/v2/deployments/stream" -->
|
|
236
240
|
```typescript
|
|
237
241
|
import { Orq } from "@orq-ai/node";
|
|
238
242
|
|
|
@@ -54,6 +54,7 @@ Get all Evaluators
|
|
|
54
54
|
|
|
55
55
|
### Example Usage
|
|
56
56
|
|
|
57
|
+
<!-- UsageSnippet language="typescript" operationID="GetEvals" method="get" path="/v2/evaluators" -->
|
|
57
58
|
```typescript
|
|
58
59
|
import { Orq } from "@orq-ai/node";
|
|
59
60
|
|
|
@@ -123,6 +124,7 @@ Create an Evaluator
|
|
|
123
124
|
|
|
124
125
|
### Example Usage
|
|
125
126
|
|
|
127
|
+
<!-- UsageSnippet language="typescript" operationID="CreateEval" method="post" path="/v2/evaluators" -->
|
|
126
128
|
```typescript
|
|
127
129
|
import { Orq } from "@orq-ai/node";
|
|
128
130
|
|
|
@@ -222,6 +224,7 @@ Update an Evaluator
|
|
|
222
224
|
|
|
223
225
|
### Example Usage
|
|
224
226
|
|
|
227
|
+
<!-- UsageSnippet language="typescript" operationID="UpdateEval" method="patch" path="/v2/evaluators/{id}" -->
|
|
225
228
|
```typescript
|
|
226
229
|
import { Orq } from "@orq-ai/node";
|
|
227
230
|
|
|
@@ -303,6 +306,7 @@ Delete an Evaluator
|
|
|
303
306
|
|
|
304
307
|
### Example Usage
|
|
305
308
|
|
|
309
|
+
<!-- UsageSnippet language="typescript" operationID="DeleteEval" method="delete" path="/v2/evaluators/{id}" -->
|
|
306
310
|
```typescript
|
|
307
311
|
import { Orq } from "@orq-ai/node";
|
|
308
312
|
|
|
@@ -376,6 +380,7 @@ Run BertScore Evaluator
|
|
|
376
380
|
|
|
377
381
|
### Example Usage
|
|
378
382
|
|
|
383
|
+
<!-- UsageSnippet language="typescript" operationID="EvalsBertScore" method="post" path="/v2/evaluators/bert_score" -->
|
|
379
384
|
```typescript
|
|
380
385
|
import { Orq } from "@orq-ai/node";
|
|
381
386
|
|
|
@@ -446,6 +451,7 @@ Run BLEU Score Evaluator
|
|
|
446
451
|
|
|
447
452
|
### Example Usage
|
|
448
453
|
|
|
454
|
+
<!-- UsageSnippet language="typescript" operationID="EvalsBleuScore" method="post" path="/v2/evaluators/bleu_score" -->
|
|
449
455
|
```typescript
|
|
450
456
|
import { Orq } from "@orq-ai/node";
|
|
451
457
|
|
|
@@ -516,6 +522,7 @@ Run Contains All Evaluator
|
|
|
516
522
|
|
|
517
523
|
### Example Usage
|
|
518
524
|
|
|
525
|
+
<!-- UsageSnippet language="typescript" operationID="EvalsContainsAll" method="post" path="/v2/evaluators/contains_all" -->
|
|
519
526
|
```typescript
|
|
520
527
|
import { Orq } from "@orq-ai/node";
|
|
521
528
|
|
|
@@ -586,6 +593,7 @@ Run Contains Any Evaluator
|
|
|
586
593
|
|
|
587
594
|
### Example Usage
|
|
588
595
|
|
|
596
|
+
<!-- UsageSnippet language="typescript" operationID="EvalsContainsAny" method="post" path="/v2/evaluators/contains_any" -->
|
|
589
597
|
```typescript
|
|
590
598
|
import { Orq } from "@orq-ai/node";
|
|
591
599
|
|
|
@@ -656,6 +664,7 @@ Run Contains Email Evaluator
|
|
|
656
664
|
|
|
657
665
|
### Example Usage
|
|
658
666
|
|
|
667
|
+
<!-- UsageSnippet language="typescript" operationID="EvalsContainsEmail" method="post" path="/v2/evaluators/contains_email" -->
|
|
659
668
|
```typescript
|
|
660
669
|
import { Orq } from "@orq-ai/node";
|
|
661
670
|
|
|
@@ -726,6 +735,7 @@ Run Contains None Evaluator
|
|
|
726
735
|
|
|
727
736
|
### Example Usage
|
|
728
737
|
|
|
738
|
+
<!-- UsageSnippet language="typescript" operationID="EvalsContainsNone" method="post" path="/v2/evaluators/contains_none" -->
|
|
729
739
|
```typescript
|
|
730
740
|
import { Orq } from "@orq-ai/node";
|
|
731
741
|
|
|
@@ -796,6 +806,7 @@ Run Contains URL Evaluator
|
|
|
796
806
|
|
|
797
807
|
### Example Usage
|
|
798
808
|
|
|
809
|
+
<!-- UsageSnippet language="typescript" operationID="EvalsContainsUrl" method="post" path="/v2/evaluators/contains_url" -->
|
|
799
810
|
```typescript
|
|
800
811
|
import { Orq } from "@orq-ai/node";
|
|
801
812
|
|
|
@@ -866,6 +877,7 @@ Run Contains Valid Link Evaluator
|
|
|
866
877
|
|
|
867
878
|
### Example Usage
|
|
868
879
|
|
|
880
|
+
<!-- UsageSnippet language="typescript" operationID="EvalsContainsValidLink" method="post" path="/v2/evaluators/contains_valid_link" -->
|
|
869
881
|
```typescript
|
|
870
882
|
import { Orq } from "@orq-ai/node";
|
|
871
883
|
|
|
@@ -936,6 +948,7 @@ Run Contains Evaluator
|
|
|
936
948
|
|
|
937
949
|
### Example Usage
|
|
938
950
|
|
|
951
|
+
<!-- UsageSnippet language="typescript" operationID="EvalsContains" method="post" path="/v2/evaluators/contains" -->
|
|
939
952
|
```typescript
|
|
940
953
|
import { Orq } from "@orq-ai/node";
|
|
941
954
|
|
|
@@ -1006,6 +1019,7 @@ Run Ends With Evaluator
|
|
|
1006
1019
|
|
|
1007
1020
|
### Example Usage
|
|
1008
1021
|
|
|
1022
|
+
<!-- UsageSnippet language="typescript" operationID="EvalsEndsWith" method="post" path="/v2/evaluators/ends_with" -->
|
|
1009
1023
|
```typescript
|
|
1010
1024
|
import { Orq } from "@orq-ai/node";
|
|
1011
1025
|
|
|
@@ -1076,6 +1090,7 @@ Run Exact Match Evaluator
|
|
|
1076
1090
|
|
|
1077
1091
|
### Example Usage
|
|
1078
1092
|
|
|
1093
|
+
<!-- UsageSnippet language="typescript" operationID="EvalsExactMatch" method="post" path="/v2/evaluators/exact_match" -->
|
|
1079
1094
|
```typescript
|
|
1080
1095
|
import { Orq } from "@orq-ai/node";
|
|
1081
1096
|
|
|
@@ -1146,6 +1161,7 @@ Run Length Between Evaluator
|
|
|
1146
1161
|
|
|
1147
1162
|
### Example Usage
|
|
1148
1163
|
|
|
1164
|
+
<!-- UsageSnippet language="typescript" operationID="EvalsLengthBetween" method="post" path="/v2/evaluators/length_between" -->
|
|
1149
1165
|
```typescript
|
|
1150
1166
|
import { Orq } from "@orq-ai/node";
|
|
1151
1167
|
|
|
@@ -1216,6 +1232,7 @@ Run Length Greater Than Evaluator
|
|
|
1216
1232
|
|
|
1217
1233
|
### Example Usage
|
|
1218
1234
|
|
|
1235
|
+
<!-- UsageSnippet language="typescript" operationID="EvalsLengthGreaterThan" method="post" path="/v2/evaluators/length_greater_than" -->
|
|
1219
1236
|
```typescript
|
|
1220
1237
|
import { Orq } from "@orq-ai/node";
|
|
1221
1238
|
|
|
@@ -1286,6 +1303,7 @@ Run Length Less Than Evaluator
|
|
|
1286
1303
|
|
|
1287
1304
|
### Example Usage
|
|
1288
1305
|
|
|
1306
|
+
<!-- UsageSnippet language="typescript" operationID="EvalsLengthLessThan" method="post" path="/v2/evaluators/length_less_than" -->
|
|
1289
1307
|
```typescript
|
|
1290
1308
|
import { Orq } from "@orq-ai/node";
|
|
1291
1309
|
|
|
@@ -1356,6 +1374,7 @@ Run JSON Validation Evaluator
|
|
|
1356
1374
|
|
|
1357
1375
|
### Example Usage
|
|
1358
1376
|
|
|
1377
|
+
<!-- UsageSnippet language="typescript" operationID="EvalsValidJson" method="post" path="/v2/evaluators/valid_json" -->
|
|
1359
1378
|
```typescript
|
|
1360
1379
|
import { Orq } from "@orq-ai/node";
|
|
1361
1380
|
|
|
@@ -1426,6 +1445,7 @@ Run Age Appropriate Evaluator
|
|
|
1426
1445
|
|
|
1427
1446
|
### Example Usage
|
|
1428
1447
|
|
|
1448
|
+
<!-- UsageSnippet language="typescript" operationID="EvalsAgeAppropriate" method="post" path="/v2/evaluators/age_appropriate" -->
|
|
1429
1449
|
```typescript
|
|
1430
1450
|
import { Orq } from "@orq-ai/node";
|
|
1431
1451
|
|
|
@@ -1496,6 +1516,7 @@ Run Bot Detection Evaluator
|
|
|
1496
1516
|
|
|
1497
1517
|
### Example Usage
|
|
1498
1518
|
|
|
1519
|
+
<!-- UsageSnippet language="typescript" operationID="EvalsBotDetection" method="post" path="/v2/evaluators/bot_detection" -->
|
|
1499
1520
|
```typescript
|
|
1500
1521
|
import { Orq } from "@orq-ai/node";
|
|
1501
1522
|
|
|
@@ -1566,6 +1587,7 @@ Run Fact Checking Knowledge Base Evaluator
|
|
|
1566
1587
|
|
|
1567
1588
|
### Example Usage
|
|
1568
1589
|
|
|
1590
|
+
<!-- UsageSnippet language="typescript" operationID="EvalsFactCheckingKnowledgeBase" method="post" path="/v2/evaluators/fact_checking_knowledge_base" -->
|
|
1569
1591
|
```typescript
|
|
1570
1592
|
import { Orq } from "@orq-ai/node";
|
|
1571
1593
|
|
|
@@ -1636,6 +1658,7 @@ Run Grammar Evaluator
|
|
|
1636
1658
|
|
|
1637
1659
|
### Example Usage
|
|
1638
1660
|
|
|
1661
|
+
<!-- UsageSnippet language="typescript" operationID="EvalsGrammar" method="post" path="/v2/evaluators/grammar" -->
|
|
1639
1662
|
```typescript
|
|
1640
1663
|
import { Orq } from "@orq-ai/node";
|
|
1641
1664
|
|
|
@@ -1706,6 +1729,7 @@ Run Localization Evaluator
|
|
|
1706
1729
|
|
|
1707
1730
|
### Example Usage
|
|
1708
1731
|
|
|
1732
|
+
<!-- UsageSnippet language="typescript" operationID="EvalsLocalization" method="post" path="/v2/evaluators/localization" -->
|
|
1709
1733
|
```typescript
|
|
1710
1734
|
import { Orq } from "@orq-ai/node";
|
|
1711
1735
|
|
|
@@ -1776,6 +1800,7 @@ Run PII Evaluator
|
|
|
1776
1800
|
|
|
1777
1801
|
### Example Usage
|
|
1778
1802
|
|
|
1803
|
+
<!-- UsageSnippet language="typescript" operationID="EvalsPii" method="post" path="/v2/evaluators/pii" -->
|
|
1779
1804
|
```typescript
|
|
1780
1805
|
import { Orq } from "@orq-ai/node";
|
|
1781
1806
|
|
|
@@ -1846,6 +1871,7 @@ Run Sentiment Classification Evaluator
|
|
|
1846
1871
|
|
|
1847
1872
|
### Example Usage
|
|
1848
1873
|
|
|
1874
|
+
<!-- UsageSnippet language="typescript" operationID="EvalsSentimentClassification" method="post" path="/v2/evaluators/sentiment_classification" -->
|
|
1849
1875
|
```typescript
|
|
1850
1876
|
import { Orq } from "@orq-ai/node";
|
|
1851
1877
|
|
|
@@ -1916,6 +1942,7 @@ Run Summarization Evaluator
|
|
|
1916
1942
|
|
|
1917
1943
|
### Example Usage
|
|
1918
1944
|
|
|
1945
|
+
<!-- UsageSnippet language="typescript" operationID="EvalsSummarization" method="post" path="/v2/evaluators/summarization" -->
|
|
1919
1946
|
```typescript
|
|
1920
1947
|
import { Orq } from "@orq-ai/node";
|
|
1921
1948
|
|
|
@@ -1986,6 +2013,7 @@ Run Tone of Voice Evaluator
|
|
|
1986
2013
|
|
|
1987
2014
|
### Example Usage
|
|
1988
2015
|
|
|
2016
|
+
<!-- UsageSnippet language="typescript" operationID="EvalsToneOfVoice" method="post" path="/v2/evaluators/tone_of_voice" -->
|
|
1989
2017
|
```typescript
|
|
1990
2018
|
import { Orq } from "@orq-ai/node";
|
|
1991
2019
|
|
|
@@ -2056,6 +2084,7 @@ Run Translation Evaluator
|
|
|
2056
2084
|
|
|
2057
2085
|
### Example Usage
|
|
2058
2086
|
|
|
2087
|
+
<!-- UsageSnippet language="typescript" operationID="EvalsTranslation" method="post" path="/v2/evaluators/translation" -->
|
|
2059
2088
|
```typescript
|
|
2060
2089
|
import { Orq } from "@orq-ai/node";
|
|
2061
2090
|
|
|
@@ -2126,6 +2155,7 @@ Run Coherence Evaluator
|
|
|
2126
2155
|
|
|
2127
2156
|
### Example Usage
|
|
2128
2157
|
|
|
2158
|
+
<!-- UsageSnippet language="typescript" operationID="EvalsRagasCoherence" method="post" path="/v2/evaluators/ragas_coherence" -->
|
|
2129
2159
|
```typescript
|
|
2130
2160
|
import { Orq } from "@orq-ai/node";
|
|
2131
2161
|
|
|
@@ -2196,6 +2226,7 @@ Run Conciseness Evaluator
|
|
|
2196
2226
|
|
|
2197
2227
|
### Example Usage
|
|
2198
2228
|
|
|
2229
|
+
<!-- UsageSnippet language="typescript" operationID="EvalsRagasConciseness" method="post" path="/v2/evaluators/ragas_conciseness" -->
|
|
2199
2230
|
```typescript
|
|
2200
2231
|
import { Orq } from "@orq-ai/node";
|
|
2201
2232
|
|
|
@@ -2266,6 +2297,7 @@ Run Context Precision Evaluator
|
|
|
2266
2297
|
|
|
2267
2298
|
### Example Usage
|
|
2268
2299
|
|
|
2300
|
+
<!-- UsageSnippet language="typescript" operationID="EvalsRagasContextPrecision" method="post" path="/v2/evaluators/ragas_context_precision" -->
|
|
2269
2301
|
```typescript
|
|
2270
2302
|
import { Orq } from "@orq-ai/node";
|
|
2271
2303
|
|
|
@@ -2336,6 +2368,7 @@ Run Context Recall Evaluator
|
|
|
2336
2368
|
|
|
2337
2369
|
### Example Usage
|
|
2338
2370
|
|
|
2371
|
+
<!-- UsageSnippet language="typescript" operationID="EvalsRagasContextRecall" method="post" path="/v2/evaluators/ragas_context_recall" -->
|
|
2339
2372
|
```typescript
|
|
2340
2373
|
import { Orq } from "@orq-ai/node";
|
|
2341
2374
|
|
|
@@ -2406,6 +2439,7 @@ Run Context Entities Recall Evaluator
|
|
|
2406
2439
|
|
|
2407
2440
|
### Example Usage
|
|
2408
2441
|
|
|
2442
|
+
<!-- UsageSnippet language="typescript" operationID="EvalsRagasContextEntitiesRecall" method="post" path="/v2/evaluators/ragas_context_entities_recall" -->
|
|
2409
2443
|
```typescript
|
|
2410
2444
|
import { Orq } from "@orq-ai/node";
|
|
2411
2445
|
|
|
@@ -2476,6 +2510,7 @@ Run Correctness Evaluator
|
|
|
2476
2510
|
|
|
2477
2511
|
### Example Usage
|
|
2478
2512
|
|
|
2513
|
+
<!-- UsageSnippet language="typescript" operationID="EvalsRagasCorrectness" method="post" path="/v2/evaluators/ragas_correctness" -->
|
|
2479
2514
|
```typescript
|
|
2480
2515
|
import { Orq } from "@orq-ai/node";
|
|
2481
2516
|
|
|
@@ -2546,6 +2581,7 @@ Run Faithfulness Evaluator
|
|
|
2546
2581
|
|
|
2547
2582
|
### Example Usage
|
|
2548
2583
|
|
|
2584
|
+
<!-- UsageSnippet language="typescript" operationID="EvalsRagasFaithfulness" method="post" path="/v2/evaluators/ragas_faithfulness" -->
|
|
2549
2585
|
```typescript
|
|
2550
2586
|
import { Orq } from "@orq-ai/node";
|
|
2551
2587
|
|
|
@@ -2616,6 +2652,7 @@ Run Harmfulness Evaluator
|
|
|
2616
2652
|
|
|
2617
2653
|
### Example Usage
|
|
2618
2654
|
|
|
2655
|
+
<!-- UsageSnippet language="typescript" operationID="EvalsRagasHarmfulness" method="post" path="/v2/evaluators/ragas_harmfulness" -->
|
|
2619
2656
|
```typescript
|
|
2620
2657
|
import { Orq } from "@orq-ai/node";
|
|
2621
2658
|
|
|
@@ -2686,6 +2723,7 @@ Run Maliciousness Evaluator
|
|
|
2686
2723
|
|
|
2687
2724
|
### Example Usage
|
|
2688
2725
|
|
|
2726
|
+
<!-- UsageSnippet language="typescript" operationID="EvalsRagasMaliciousness" method="post" path="/v2/evaluators/ragas_maliciousness" -->
|
|
2689
2727
|
```typescript
|
|
2690
2728
|
import { Orq } from "@orq-ai/node";
|
|
2691
2729
|
|
|
@@ -2756,6 +2794,7 @@ Run Noise Sensitivity Evaluator
|
|
|
2756
2794
|
|
|
2757
2795
|
### Example Usage
|
|
2758
2796
|
|
|
2797
|
+
<!-- UsageSnippet language="typescript" operationID="EvalsRagasNoiseSensitivity" method="post" path="/v2/evaluators/ragas_noise_sensitivity" -->
|
|
2759
2798
|
```typescript
|
|
2760
2799
|
import { Orq } from "@orq-ai/node";
|
|
2761
2800
|
|
|
@@ -2826,6 +2865,7 @@ Run Response Relevancy Evaluator
|
|
|
2826
2865
|
|
|
2827
2866
|
### Example Usage
|
|
2828
2867
|
|
|
2868
|
+
<!-- UsageSnippet language="typescript" operationID="EvalsRagasResponseRelevancy" method="post" path="/v2/evaluators/ragas_response_relevancy" -->
|
|
2829
2869
|
```typescript
|
|
2830
2870
|
import { Orq } from "@orq-ai/node";
|
|
2831
2871
|
|
|
@@ -2896,6 +2936,7 @@ Run Summarization Evaluator
|
|
|
2896
2936
|
|
|
2897
2937
|
### Example Usage
|
|
2898
2938
|
|
|
2939
|
+
<!-- UsageSnippet language="typescript" operationID="EvalsRagasSummarization" method="post" path="/v2/evaluators/ragas_summarization" -->
|
|
2899
2940
|
```typescript
|
|
2900
2941
|
import { Orq } from "@orq-ai/node";
|
|
2901
2942
|
|
|
@@ -2966,6 +3007,7 @@ Invoke a Custom Evaluator
|
|
|
2966
3007
|
|
|
2967
3008
|
### Example Usage
|
|
2968
3009
|
|
|
3010
|
+
<!-- UsageSnippet language="typescript" operationID="InvokeEval" method="post" path="/v2/evaluators/{id}/invoke" -->
|
|
2969
3011
|
```typescript
|
|
2970
3012
|
import { Orq } from "@orq-ai/node";
|
|
2971
3013
|
|
|
@@ -16,6 +16,7 @@ Files are used to upload documents that can be used with features like [Deployme
|
|
|
16
16
|
|
|
17
17
|
### Example Usage
|
|
18
18
|
|
|
19
|
+
<!-- UsageSnippet language="typescript" operationID="FileUpload" method="post" path="/v2/files" -->
|
|
19
20
|
```typescript
|
|
20
21
|
import { Orq } from "@orq-ai/node";
|
|
21
22
|
import { openAsBlob } from "node:fs";
|
|
@@ -90,6 +91,7 @@ Returns a list of the files that your account has access to. orq.ai sorts and re
|
|
|
90
91
|
|
|
91
92
|
### Example Usage
|
|
92
93
|
|
|
94
|
+
<!-- UsageSnippet language="typescript" operationID="FileList" method="get" path="/v2/files" -->
|
|
93
95
|
```typescript
|
|
94
96
|
import { Orq } from "@orq-ai/node";
|
|
95
97
|
|
|
@@ -158,6 +160,7 @@ Retrieves the details of an existing file object. After you supply a unique file
|
|
|
158
160
|
|
|
159
161
|
### Example Usage
|
|
160
162
|
|
|
163
|
+
<!-- UsageSnippet language="typescript" operationID="FileGet" method="get" path="/v2/files/{file_id}" -->
|
|
161
164
|
```typescript
|
|
162
165
|
import { Orq } from "@orq-ai/node";
|
|
163
166
|
|
|
@@ -230,6 +233,7 @@ Delete file
|
|
|
230
233
|
|
|
231
234
|
### Example Usage
|
|
232
235
|
|
|
236
|
+
<!-- UsageSnippet language="typescript" operationID="FileDelete" method="delete" path="/v2/files/{file_id}" -->
|
|
233
237
|
```typescript
|
|
234
238
|
import { Orq } from "@orq-ai/node";
|
|
235
239
|
|