@orq-ai/node 3.9.2 → 3.10.0-rc.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (508) hide show
  1. package/README.md +5 -2
  2. package/bin/mcp-server.js +145 -148
  3. package/bin/mcp-server.js.map +33 -33
  4. package/docs/sdks/knowledge/README.md +0 -87
  5. package/{packages/orq-rc/docs/sdks/feedback → docs/sdks/knowledgebases}/README.md +27 -21
  6. package/funcs/{knowledgeChunkText.d.ts → knowledgeBasesChunkText.d.ts} +3 -3
  7. package/funcs/knowledgeBasesChunkText.d.ts.map +1 -0
  8. package/funcs/{knowledgeChunkText.js → knowledgeBasesChunkText.js} +4 -4
  9. package/funcs/knowledgeBasesChunkText.js.map +1 -0
  10. package/jsr.json +1 -1
  11. package/lib/config.d.ts +2 -2
  12. package/lib/config.js +2 -2
  13. package/lib/config.js.map +1 -1
  14. package/mcp-server/mcp-server.js +1 -1
  15. package/mcp-server/mcp-server.js.map +1 -1
  16. package/mcp-server/server.js +3 -3
  17. package/mcp-server/server.js.map +1 -1
  18. package/mcp-server/tools/{knowledgeChunkText.d.ts → knowledgeBasesChunkText.d.ts} +2 -2
  19. package/mcp-server/tools/knowledgeBasesChunkText.d.ts.map +1 -0
  20. package/mcp-server/tools/{knowledgeChunkText.js → knowledgeBasesChunkText.js} +7 -7
  21. package/mcp-server/tools/knowledgeBasesChunkText.js.map +1 -0
  22. package/models/operations/chunktext.d.ts +24 -24
  23. package/models/operations/chunktext.d.ts.map +1 -1
  24. package/models/operations/chunktext.js +38 -39
  25. package/models/operations/chunktext.js.map +1 -1
  26. package/models/operations/createcontact.js +2 -2
  27. package/models/operations/createdataset.js +2 -2
  28. package/models/operations/createdatasetitem.js +2 -2
  29. package/models/operations/createdatasource.js +2 -2
  30. package/models/operations/createeval.js +16 -16
  31. package/models/operations/fileget.js +2 -2
  32. package/models/operations/filelist.js +2 -2
  33. package/models/operations/fileupload.js +2 -2
  34. package/models/operations/getevals.js +28 -28
  35. package/models/operations/listcontacts.js +2 -2
  36. package/models/operations/listdatasetdatapoints.js +2 -2
  37. package/models/operations/listdatasets.js +2 -2
  38. package/models/operations/listdatasources.js +2 -2
  39. package/models/operations/retrievecontact.js +2 -2
  40. package/models/operations/retrievedatapoint.js +2 -2
  41. package/models/operations/retrievedataset.js +2 -2
  42. package/models/operations/retrievedatasource.js +2 -2
  43. package/models/operations/updatecontact.js +2 -2
  44. package/models/operations/updatedatapoint.js +2 -2
  45. package/models/operations/updatedataset.js +2 -2
  46. package/models/operations/updatedatasource.js +2 -2
  47. package/models/operations/updateeval.js +16 -16
  48. package/package.json +3 -2
  49. package/sdk/knowledge.d.ts +0 -7
  50. package/sdk/knowledge.d.ts.map +1 -1
  51. package/sdk/knowledge.js +0 -10
  52. package/sdk/knowledge.js.map +1 -1
  53. package/sdk/knowledgebases.d.ts +12 -0
  54. package/sdk/knowledgebases.d.ts.map +1 -0
  55. package/sdk/knowledgebases.js +22 -0
  56. package/sdk/knowledgebases.js.map +1 -0
  57. package/sdk/sdk.d.ts +3 -0
  58. package/sdk/sdk.d.ts.map +1 -1
  59. package/sdk/sdk.js +4 -0
  60. package/sdk/sdk.js.map +1 -1
  61. package/{packages/orq-rc/src/funcs/knowledgeChunkText.ts → src/funcs/knowledgeBasesChunkText.ts} +2 -2
  62. package/src/lib/config.ts +2 -2
  63. package/src/mcp-server/mcp-server.ts +1 -1
  64. package/src/mcp-server/server.ts +3 -3
  65. package/{packages/orq-rc/src/mcp-server/tools/knowledgeChunkText.ts → src/mcp-server/tools/knowledgeBasesChunkText.ts} +5 -5
  66. package/src/models/operations/chunktext.ts +63 -57
  67. package/src/models/operations/createcontact.ts +2 -2
  68. package/src/models/operations/createdataset.ts +2 -2
  69. package/src/models/operations/createdatasetitem.ts +2 -2
  70. package/src/models/operations/createdatasource.ts +2 -2
  71. package/src/models/operations/createeval.ts +16 -16
  72. package/src/models/operations/fileget.ts +2 -2
  73. package/src/models/operations/filelist.ts +2 -2
  74. package/src/models/operations/fileupload.ts +2 -2
  75. package/src/models/operations/getevals.ts +28 -28
  76. package/src/models/operations/listcontacts.ts +2 -2
  77. package/src/models/operations/listdatasetdatapoints.ts +2 -2
  78. package/src/models/operations/listdatasets.ts +2 -2
  79. package/src/models/operations/listdatasources.ts +2 -2
  80. package/src/models/operations/retrievecontact.ts +2 -2
  81. package/src/models/operations/retrievedatapoint.ts +2 -2
  82. package/src/models/operations/retrievedataset.ts +2 -2
  83. package/src/models/operations/retrievedatasource.ts +2 -2
  84. package/src/models/operations/updatecontact.ts +2 -2
  85. package/src/models/operations/updatedatapoint.ts +2 -2
  86. package/src/models/operations/updatedataset.ts +2 -2
  87. package/src/models/operations/updatedatasource.ts +2 -2
  88. package/src/models/operations/updateeval.ts +16 -16
  89. package/src/sdk/knowledge.ts +0 -18
  90. package/src/sdk/knowledgebases.ts +27 -0
  91. package/src/sdk/sdk.ts +6 -0
  92. package/funcs/knowledgeChunkText.d.ts.map +0 -1
  93. package/funcs/knowledgeChunkText.js.map +0 -1
  94. package/mcp-server/tools/knowledgeChunkText.d.ts.map +0 -1
  95. package/mcp-server/tools/knowledgeChunkText.js.map +0 -1
  96. package/packages/orq-rc/FUNCTIONS.md +0 -103
  97. package/packages/orq-rc/README.md +0 -955
  98. package/packages/orq-rc/RUNTIMES.md +0 -48
  99. package/packages/orq-rc/docs/sdks/contacts/README.md +0 -445
  100. package/packages/orq-rc/docs/sdks/datasets/README.md +0 -825
  101. package/packages/orq-rc/docs/sdks/deployments/README.md +0 -310
  102. package/packages/orq-rc/docs/sdks/evals/README.md +0 -3035
  103. package/packages/orq-rc/docs/sdks/files/README.md +0 -297
  104. package/packages/orq-rc/docs/sdks/knowledge/README.md +0 -1237
  105. package/packages/orq-rc/docs/sdks/metrics/README.md +0 -82
  106. package/packages/orq-rc/docs/sdks/models/README.md +0 -75
  107. package/packages/orq-rc/docs/sdks/orq/README.md +0 -10
  108. package/packages/orq-rc/docs/sdks/prompts/README.md +0 -550
  109. package/packages/orq-rc/docs/sdks/remoteconfigs/README.md +0 -76
  110. package/packages/orq-rc/jsr.json +0 -28
  111. package/packages/orq-rc/package-lock.json +0 -3217
  112. package/packages/orq-rc/package.json +0 -45
  113. package/packages/orq-rc/src/core.ts +0 -13
  114. package/packages/orq-rc/src/funcs/contactsCreate.ts +0 -165
  115. package/packages/orq-rc/src/funcs/contactsDelete.ts +0 -176
  116. package/packages/orq-rc/src/funcs/contactsList.ts +0 -169
  117. package/packages/orq-rc/src/funcs/contactsRetrieve.ts +0 -175
  118. package/packages/orq-rc/src/funcs/contactsUpdate.ts +0 -176
  119. package/packages/orq-rc/src/funcs/datasetsClear.ts +0 -167
  120. package/packages/orq-rc/src/funcs/datasetsCreate.ts +0 -165
  121. package/packages/orq-rc/src/funcs/datasetsCreateDatapoint.ts +0 -167
  122. package/packages/orq-rc/src/funcs/datasetsDelete.ts +0 -167
  123. package/packages/orq-rc/src/funcs/datasetsDeleteDatapoint.ts +0 -182
  124. package/packages/orq-rc/src/funcs/datasetsList.ts +0 -167
  125. package/packages/orq-rc/src/funcs/datasetsListDatapoints.ts +0 -174
  126. package/packages/orq-rc/src/funcs/datasetsRetrieve.ts +0 -175
  127. package/packages/orq-rc/src/funcs/datasetsRetrieveDatapoint.ts +0 -181
  128. package/packages/orq-rc/src/funcs/datasetsUpdate.ts +0 -176
  129. package/packages/orq-rc/src/funcs/datasetsUpdateDatapoint.ts +0 -179
  130. package/packages/orq-rc/src/funcs/deploymentsGetConfig.ts +0 -168
  131. package/packages/orq-rc/src/funcs/deploymentsInvoke.ts +0 -176
  132. package/packages/orq-rc/src/funcs/deploymentsList.ts +0 -176
  133. package/packages/orq-rc/src/funcs/deploymentsMetricsCreate.ts +0 -168
  134. package/packages/orq-rc/src/funcs/deploymentsStream.ts +0 -184
  135. package/packages/orq-rc/src/funcs/evalsAgeAppropriate.ts +0 -175
  136. package/packages/orq-rc/src/funcs/evalsAll.ts +0 -173
  137. package/packages/orq-rc/src/funcs/evalsBertScore.ts +0 -175
  138. package/packages/orq-rc/src/funcs/evalsBleuScore.ts +0 -175
  139. package/packages/orq-rc/src/funcs/evalsBotDetection.ts +0 -175
  140. package/packages/orq-rc/src/funcs/evalsContains.ts +0 -175
  141. package/packages/orq-rc/src/funcs/evalsContainsAll.ts +0 -175
  142. package/packages/orq-rc/src/funcs/evalsContainsAny.ts +0 -175
  143. package/packages/orq-rc/src/funcs/evalsContainsEmail.ts +0 -175
  144. package/packages/orq-rc/src/funcs/evalsContainsNone.ts +0 -175
  145. package/packages/orq-rc/src/funcs/evalsContainsUrl.ts +0 -175
  146. package/packages/orq-rc/src/funcs/evalsContainsValidLink.ts +0 -177
  147. package/packages/orq-rc/src/funcs/evalsCreate.ts +0 -169
  148. package/packages/orq-rc/src/funcs/evalsDelete.ts +0 -173
  149. package/packages/orq-rc/src/funcs/evalsEndsWith.ts +0 -175
  150. package/packages/orq-rc/src/funcs/evalsExactMatch.ts +0 -175
  151. package/packages/orq-rc/src/funcs/evalsFactCheckingKnowledgeBase.ts +0 -183
  152. package/packages/orq-rc/src/funcs/evalsGrammar.ts +0 -173
  153. package/packages/orq-rc/src/funcs/evalsInvoke.ts +0 -177
  154. package/packages/orq-rc/src/funcs/evalsLengthBetween.ts +0 -175
  155. package/packages/orq-rc/src/funcs/evalsLengthGreaterThan.ts +0 -177
  156. package/packages/orq-rc/src/funcs/evalsLengthLessThan.ts +0 -175
  157. package/packages/orq-rc/src/funcs/evalsLocalization.ts +0 -175
  158. package/packages/orq-rc/src/funcs/evalsPii.ts +0 -173
  159. package/packages/orq-rc/src/funcs/evalsRagasCoherence.ts +0 -175
  160. package/packages/orq-rc/src/funcs/evalsRagasConciseness.ts +0 -174
  161. package/packages/orq-rc/src/funcs/evalsRagasContextEntitiesRecall.ts +0 -183
  162. package/packages/orq-rc/src/funcs/evalsRagasContextPrecision.ts +0 -180
  163. package/packages/orq-rc/src/funcs/evalsRagasContextRecall.ts +0 -177
  164. package/packages/orq-rc/src/funcs/evalsRagasCorrectness.ts +0 -174
  165. package/packages/orq-rc/src/funcs/evalsRagasFaithfulness.ts +0 -177
  166. package/packages/orq-rc/src/funcs/evalsRagasHarmfulness.ts +0 -174
  167. package/packages/orq-rc/src/funcs/evalsRagasMaliciousness.ts +0 -177
  168. package/packages/orq-rc/src/funcs/evalsRagasNoiseSensitivity.ts +0 -180
  169. package/packages/orq-rc/src/funcs/evalsRagasResponseRelevancy.ts +0 -183
  170. package/packages/orq-rc/src/funcs/evalsRagasSummarization.ts +0 -177
  171. package/packages/orq-rc/src/funcs/evalsSentimentClassification.ts +0 -183
  172. package/packages/orq-rc/src/funcs/evalsSummarization.ts +0 -175
  173. package/packages/orq-rc/src/funcs/evalsToneOfVoice.ts +0 -175
  174. package/packages/orq-rc/src/funcs/evalsTranslation.ts +0 -175
  175. package/packages/orq-rc/src/funcs/evalsUpdate.ts +0 -173
  176. package/packages/orq-rc/src/funcs/evalsValidJson.ts +0 -175
  177. package/packages/orq-rc/src/funcs/feedbackCreate.ts +0 -160
  178. package/packages/orq-rc/src/funcs/filesCreate.ts +0 -187
  179. package/packages/orq-rc/src/funcs/filesDelete.ts +0 -164
  180. package/packages/orq-rc/src/funcs/filesGet.ts +0 -166
  181. package/packages/orq-rc/src/funcs/filesList.ts +0 -167
  182. package/packages/orq-rc/src/funcs/knowledgeCreateChunks.ts +0 -171
  183. package/packages/orq-rc/src/funcs/knowledgeCreateDatasource.ts +0 -166
  184. package/packages/orq-rc/src/funcs/knowledgeDelete.ts +0 -167
  185. package/packages/orq-rc/src/funcs/knowledgeDeleteChunk.ts +0 -174
  186. package/packages/orq-rc/src/funcs/knowledgeDeleteDatasource.ts +0 -173
  187. package/packages/orq-rc/src/funcs/knowledgeList.ts +0 -169
  188. package/packages/orq-rc/src/funcs/knowledgeListChunks.ts +0 -178
  189. package/packages/orq-rc/src/funcs/knowledgeListDatasources.ts +0 -174
  190. package/packages/orq-rc/src/funcs/knowledgeRetrieve.ts +0 -166
  191. package/packages/orq-rc/src/funcs/knowledgeRetrieveChunk.ts +0 -173
  192. package/packages/orq-rc/src/funcs/knowledgeRetrieveDatasource.ts +0 -169
  193. package/packages/orq-rc/src/funcs/knowledgeSearch.ts +0 -167
  194. package/packages/orq-rc/src/funcs/knowledgeUpdate.ts +0 -164
  195. package/packages/orq-rc/src/funcs/knowledgeUpdateChunk.ts +0 -174
  196. package/packages/orq-rc/src/funcs/knowledgeUpdateDatasource.ts +0 -170
  197. package/packages/orq-rc/src/funcs/modelsList.ts +0 -142
  198. package/packages/orq-rc/src/funcs/promptsCreate.ts +0 -160
  199. package/packages/orq-rc/src/funcs/promptsDelete.ts +0 -164
  200. package/packages/orq-rc/src/funcs/promptsGetVersion.ts +0 -181
  201. package/packages/orq-rc/src/funcs/promptsList.ts +0 -167
  202. package/packages/orq-rc/src/funcs/promptsListVersions.ts +0 -173
  203. package/packages/orq-rc/src/funcs/promptsRetrieve.ts +0 -166
  204. package/packages/orq-rc/src/funcs/promptsUpdate.ts +0 -173
  205. package/packages/orq-rc/src/funcs/remoteconfigsRetrieve.ts +0 -161
  206. package/packages/orq-rc/src/hooks/global.ts +0 -44
  207. package/packages/orq-rc/src/hooks/hooks.ts +0 -132
  208. package/packages/orq-rc/src/hooks/index.ts +0 -6
  209. package/packages/orq-rc/src/hooks/registration.ts +0 -15
  210. package/packages/orq-rc/src/hooks/types.ts +0 -112
  211. package/packages/orq-rc/src/index.ts +0 -9
  212. package/packages/orq-rc/src/lib/base64.ts +0 -37
  213. package/packages/orq-rc/src/lib/config.ts +0 -74
  214. package/packages/orq-rc/src/lib/dlv.ts +0 -53
  215. package/packages/orq-rc/src/lib/encodings.ts +0 -483
  216. package/packages/orq-rc/src/lib/env.ts +0 -73
  217. package/packages/orq-rc/src/lib/event-streams.ts +0 -264
  218. package/packages/orq-rc/src/lib/files.ts +0 -82
  219. package/packages/orq-rc/src/lib/http.ts +0 -323
  220. package/packages/orq-rc/src/lib/is-plain-object.ts +0 -43
  221. package/packages/orq-rc/src/lib/logger.ts +0 -9
  222. package/packages/orq-rc/src/lib/matchers.ts +0 -348
  223. package/packages/orq-rc/src/lib/primitives.ts +0 -150
  224. package/packages/orq-rc/src/lib/retries.ts +0 -218
  225. package/packages/orq-rc/src/lib/schemas.ts +0 -91
  226. package/packages/orq-rc/src/lib/sdks.ts +0 -407
  227. package/packages/orq-rc/src/lib/security.ts +0 -261
  228. package/packages/orq-rc/src/lib/url.ts +0 -33
  229. package/packages/orq-rc/src/mcp-server/cli/start/command.ts +0 -112
  230. package/packages/orq-rc/src/mcp-server/cli/start/impl.ts +0 -136
  231. package/packages/orq-rc/src/mcp-server/cli.ts +0 -13
  232. package/packages/orq-rc/src/mcp-server/console-logger.ts +0 -71
  233. package/packages/orq-rc/src/mcp-server/extensions.ts +0 -17
  234. package/packages/orq-rc/src/mcp-server/mcp-server.ts +0 -26
  235. package/packages/orq-rc/src/mcp-server/prompts.ts +0 -117
  236. package/packages/orq-rc/src/mcp-server/resources.ts +0 -172
  237. package/packages/orq-rc/src/mcp-server/scopes.ts +0 -7
  238. package/packages/orq-rc/src/mcp-server/server.ts +0 -249
  239. package/packages/orq-rc/src/mcp-server/shared.ts +0 -75
  240. package/packages/orq-rc/src/mcp-server/tools/contactsCreate.ts +0 -37
  241. package/packages/orq-rc/src/mcp-server/tools/contactsDelete.ts +0 -35
  242. package/packages/orq-rc/src/mcp-server/tools/contactsList.ts +0 -37
  243. package/packages/orq-rc/src/mcp-server/tools/contactsRetrieve.ts +0 -37
  244. package/packages/orq-rc/src/mcp-server/tools/contactsUpdate.ts +0 -37
  245. package/packages/orq-rc/src/mcp-server/tools/datasetsClear.ts +0 -35
  246. package/packages/orq-rc/src/mcp-server/tools/datasetsCreate.ts +0 -37
  247. package/packages/orq-rc/src/mcp-server/tools/datasetsCreateDatapoint.ts +0 -37
  248. package/packages/orq-rc/src/mcp-server/tools/datasetsDelete.ts +0 -35
  249. package/packages/orq-rc/src/mcp-server/tools/datasetsDeleteDatapoint.ts +0 -35
  250. package/packages/orq-rc/src/mcp-server/tools/datasetsList.ts +0 -37
  251. package/packages/orq-rc/src/mcp-server/tools/datasetsListDatapoints.ts +0 -37
  252. package/packages/orq-rc/src/mcp-server/tools/datasetsRetrieve.ts +0 -37
  253. package/packages/orq-rc/src/mcp-server/tools/datasetsRetrieveDatapoint.ts +0 -37
  254. package/packages/orq-rc/src/mcp-server/tools/datasetsUpdate.ts +0 -37
  255. package/packages/orq-rc/src/mcp-server/tools/datasetsUpdateDatapoint.ts +0 -35
  256. package/packages/orq-rc/src/mcp-server/tools/deploymentsGetConfig.ts +0 -37
  257. package/packages/orq-rc/src/mcp-server/tools/deploymentsInvoke.ts +0 -37
  258. package/packages/orq-rc/src/mcp-server/tools/deploymentsList.ts +0 -37
  259. package/packages/orq-rc/src/mcp-server/tools/deploymentsMetricsCreate.ts +0 -37
  260. package/packages/orq-rc/src/mcp-server/tools/deploymentsStream.ts +0 -37
  261. package/packages/orq-rc/src/mcp-server/tools/evalsAgeAppropriate.ts +0 -35
  262. package/packages/orq-rc/src/mcp-server/tools/evalsAll.ts +0 -35
  263. package/packages/orq-rc/src/mcp-server/tools/evalsBertScore.ts +0 -35
  264. package/packages/orq-rc/src/mcp-server/tools/evalsBleuScore.ts +0 -35
  265. package/packages/orq-rc/src/mcp-server/tools/evalsBotDetection.ts +0 -35
  266. package/packages/orq-rc/src/mcp-server/tools/evalsContains.ts +0 -35
  267. package/packages/orq-rc/src/mcp-server/tools/evalsContainsAll.ts +0 -35
  268. package/packages/orq-rc/src/mcp-server/tools/evalsContainsAny.ts +0 -35
  269. package/packages/orq-rc/src/mcp-server/tools/evalsContainsEmail.ts +0 -35
  270. package/packages/orq-rc/src/mcp-server/tools/evalsContainsNone.ts +0 -35
  271. package/packages/orq-rc/src/mcp-server/tools/evalsContainsUrl.ts +0 -35
  272. package/packages/orq-rc/src/mcp-server/tools/evalsContainsValidLink.ts +0 -36
  273. package/packages/orq-rc/src/mcp-server/tools/evalsCreate.ts +0 -35
  274. package/packages/orq-rc/src/mcp-server/tools/evalsDelete.ts +0 -33
  275. package/packages/orq-rc/src/mcp-server/tools/evalsEndsWith.ts +0 -35
  276. package/packages/orq-rc/src/mcp-server/tools/evalsExactMatch.ts +0 -35
  277. package/packages/orq-rc/src/mcp-server/tools/evalsFactCheckingKnowledgeBase.ts +0 -37
  278. package/packages/orq-rc/src/mcp-server/tools/evalsGrammar.ts +0 -35
  279. package/packages/orq-rc/src/mcp-server/tools/evalsInvoke.ts +0 -35
  280. package/packages/orq-rc/src/mcp-server/tools/evalsLengthBetween.ts +0 -35
  281. package/packages/orq-rc/src/mcp-server/tools/evalsLengthGreaterThan.ts +0 -36
  282. package/packages/orq-rc/src/mcp-server/tools/evalsLengthLessThan.ts +0 -35
  283. package/packages/orq-rc/src/mcp-server/tools/evalsLocalization.ts +0 -35
  284. package/packages/orq-rc/src/mcp-server/tools/evalsPii.ts +0 -35
  285. package/packages/orq-rc/src/mcp-server/tools/evalsRagasCoherence.ts +0 -35
  286. package/packages/orq-rc/src/mcp-server/tools/evalsRagasConciseness.ts +0 -35
  287. package/packages/orq-rc/src/mcp-server/tools/evalsRagasContextEntitiesRecall.ts +0 -37
  288. package/packages/orq-rc/src/mcp-server/tools/evalsRagasContextPrecision.ts +0 -36
  289. package/packages/orq-rc/src/mcp-server/tools/evalsRagasContextRecall.ts +0 -36
  290. package/packages/orq-rc/src/mcp-server/tools/evalsRagasCorrectness.ts +0 -35
  291. package/packages/orq-rc/src/mcp-server/tools/evalsRagasFaithfulness.ts +0 -36
  292. package/packages/orq-rc/src/mcp-server/tools/evalsRagasHarmfulness.ts +0 -35
  293. package/packages/orq-rc/src/mcp-server/tools/evalsRagasMaliciousness.ts +0 -36
  294. package/packages/orq-rc/src/mcp-server/tools/evalsRagasNoiseSensitivity.ts +0 -36
  295. package/packages/orq-rc/src/mcp-server/tools/evalsRagasResponseRelevancy.ts +0 -36
  296. package/packages/orq-rc/src/mcp-server/tools/evalsRagasSummarization.ts +0 -36
  297. package/packages/orq-rc/src/mcp-server/tools/evalsSentimentClassification.ts +0 -36
  298. package/packages/orq-rc/src/mcp-server/tools/evalsSummarization.ts +0 -35
  299. package/packages/orq-rc/src/mcp-server/tools/evalsToneOfVoice.ts +0 -35
  300. package/packages/orq-rc/src/mcp-server/tools/evalsTranslation.ts +0 -35
  301. package/packages/orq-rc/src/mcp-server/tools/evalsUpdate.ts +0 -35
  302. package/packages/orq-rc/src/mcp-server/tools/evalsValidJson.ts +0 -35
  303. package/packages/orq-rc/src/mcp-server/tools/feedbackCreate.ts +0 -37
  304. package/packages/orq-rc/src/mcp-server/tools/filesCreate.ts +0 -37
  305. package/packages/orq-rc/src/mcp-server/tools/filesDelete.ts +0 -33
  306. package/packages/orq-rc/src/mcp-server/tools/filesGet.ts +0 -37
  307. package/packages/orq-rc/src/mcp-server/tools/filesList.ts +0 -37
  308. package/packages/orq-rc/src/mcp-server/tools/knowledgeCreateChunks.ts +0 -35
  309. package/packages/orq-rc/src/mcp-server/tools/knowledgeCreateDatasource.ts +0 -35
  310. package/packages/orq-rc/src/mcp-server/tools/knowledgeDelete.ts +0 -35
  311. package/packages/orq-rc/src/mcp-server/tools/knowledgeDeleteChunk.ts +0 -33
  312. package/packages/orq-rc/src/mcp-server/tools/knowledgeDeleteDatasource.ts +0 -35
  313. package/packages/orq-rc/src/mcp-server/tools/knowledgeList.ts +0 -37
  314. package/packages/orq-rc/src/mcp-server/tools/knowledgeListChunks.ts +0 -35
  315. package/packages/orq-rc/src/mcp-server/tools/knowledgeListDatasources.ts +0 -35
  316. package/packages/orq-rc/src/mcp-server/tools/knowledgeRetrieve.ts +0 -37
  317. package/packages/orq-rc/src/mcp-server/tools/knowledgeRetrieveChunk.ts +0 -35
  318. package/packages/orq-rc/src/mcp-server/tools/knowledgeRetrieveDatasource.ts +0 -35
  319. package/packages/orq-rc/src/mcp-server/tools/knowledgeSearch.ts +0 -37
  320. package/packages/orq-rc/src/mcp-server/tools/knowledgeUpdate.ts +0 -35
  321. package/packages/orq-rc/src/mcp-server/tools/knowledgeUpdateChunk.ts +0 -35
  322. package/packages/orq-rc/src/mcp-server/tools/knowledgeUpdateDatasource.ts +0 -35
  323. package/packages/orq-rc/src/mcp-server/tools/modelsList.ts +0 -30
  324. package/packages/orq-rc/src/mcp-server/tools/promptsCreate.ts +0 -35
  325. package/packages/orq-rc/src/mcp-server/tools/promptsDelete.ts +0 -33
  326. package/packages/orq-rc/src/mcp-server/tools/promptsGetVersion.ts +0 -37
  327. package/packages/orq-rc/src/mcp-server/tools/promptsList.ts +0 -37
  328. package/packages/orq-rc/src/mcp-server/tools/promptsListVersions.ts +0 -37
  329. package/packages/orq-rc/src/mcp-server/tools/promptsRetrieve.ts +0 -37
  330. package/packages/orq-rc/src/mcp-server/tools/promptsUpdate.ts +0 -35
  331. package/packages/orq-rc/src/mcp-server/tools/remoteconfigsRetrieve.ts +0 -36
  332. package/packages/orq-rc/src/mcp-server/tools.ts +0 -129
  333. package/packages/orq-rc/src/models/components/deployments.ts +0 -7289
  334. package/packages/orq-rc/src/models/components/index.ts +0 -6
  335. package/packages/orq-rc/src/models/components/security.ts +0 -71
  336. package/packages/orq-rc/src/models/errors/apierror.ts +0 -40
  337. package/packages/orq-rc/src/models/errors/createeval.ts +0 -80
  338. package/packages/orq-rc/src/models/errors/deletecontact.ts +0 -91
  339. package/packages/orq-rc/src/models/errors/deleteeval.ts +0 -80
  340. package/packages/orq-rc/src/models/errors/evalsageappropriate.ts +0 -156
  341. package/packages/orq-rc/src/models/errors/evalsbertscore.ts +0 -154
  342. package/packages/orq-rc/src/models/errors/evalsbleuscore.ts +0 -154
  343. package/packages/orq-rc/src/models/errors/evalsbotdetection.ts +0 -155
  344. package/packages/orq-rc/src/models/errors/evalscontains.ts +0 -154
  345. package/packages/orq-rc/src/models/errors/evalscontainsall.ts +0 -155
  346. package/packages/orq-rc/src/models/errors/evalscontainsany.ts +0 -155
  347. package/packages/orq-rc/src/models/errors/evalscontainsemail.ts +0 -156
  348. package/packages/orq-rc/src/models/errors/evalscontainsnone.ts +0 -155
  349. package/packages/orq-rc/src/models/errors/evalscontainsurl.ts +0 -155
  350. package/packages/orq-rc/src/models/errors/evalscontainsvalidlink.ts +0 -157
  351. package/packages/orq-rc/src/models/errors/evalsendswith.ts +0 -154
  352. package/packages/orq-rc/src/models/errors/evalsexactmatch.ts +0 -154
  353. package/packages/orq-rc/src/models/errors/evalsfactcheckingknowledgebase.ts +0 -160
  354. package/packages/orq-rc/src/models/errors/evalsgrammar.ts +0 -154
  355. package/packages/orq-rc/src/models/errors/evalslengthbetween.ts +0 -156
  356. package/packages/orq-rc/src/models/errors/evalslengthgreaterthan.ts +0 -157
  357. package/packages/orq-rc/src/models/errors/evalslengthlessthan.ts +0 -156
  358. package/packages/orq-rc/src/models/errors/evalslocalization.ts +0 -155
  359. package/packages/orq-rc/src/models/errors/evalspii.ts +0 -154
  360. package/packages/orq-rc/src/models/errors/evalsragascoherence.ts +0 -156
  361. package/packages/orq-rc/src/models/errors/evalsragasconciseness.ts +0 -157
  362. package/packages/orq-rc/src/models/errors/evalsragascontextentitiesrecall.ts +0 -163
  363. package/packages/orq-rc/src/models/errors/evalsragascontextprecision.ts +0 -160
  364. package/packages/orq-rc/src/models/errors/evalsragascontextrecall.ts +0 -158
  365. package/packages/orq-rc/src/models/errors/evalsragascorrectness.ts +0 -157
  366. package/packages/orq-rc/src/models/errors/evalsragasfaithfulness.ts +0 -157
  367. package/packages/orq-rc/src/models/errors/evalsragasharmfulness.ts +0 -157
  368. package/packages/orq-rc/src/models/errors/evalsragasmaliciousness.ts +0 -158
  369. package/packages/orq-rc/src/models/errors/evalsragasnoisesensitivity.ts +0 -160
  370. package/packages/orq-rc/src/models/errors/evalsragasresponserelevancy.ts +0 -160
  371. package/packages/orq-rc/src/models/errors/evalsragassummarization.ts +0 -158
  372. package/packages/orq-rc/src/models/errors/evalssentimentclassification.ts +0 -160
  373. package/packages/orq-rc/src/models/errors/evalssummarization.ts +0 -156
  374. package/packages/orq-rc/src/models/errors/evalstoneofvoice.ts +0 -155
  375. package/packages/orq-rc/src/models/errors/evalstranslation.ts +0 -155
  376. package/packages/orq-rc/src/models/errors/evalsvalidjson.ts +0 -154
  377. package/packages/orq-rc/src/models/errors/getevals.ts +0 -80
  378. package/packages/orq-rc/src/models/errors/getpromptversion.ts +0 -80
  379. package/packages/orq-rc/src/models/errors/honoapierror.ts +0 -90
  380. package/packages/orq-rc/src/models/errors/httpclienterrors.ts +0 -62
  381. package/packages/orq-rc/src/models/errors/index.ts +0 -56
  382. package/packages/orq-rc/src/models/errors/invokeeval.ts +0 -154
  383. package/packages/orq-rc/src/models/errors/orqerror.ts +0 -35
  384. package/packages/orq-rc/src/models/errors/responsevalidationerror.ts +0 -50
  385. package/packages/orq-rc/src/models/errors/retrievecontact.ts +0 -91
  386. package/packages/orq-rc/src/models/errors/sdkvalidationerror.ts +0 -109
  387. package/packages/orq-rc/src/models/errors/updatecontact.ts +0 -83
  388. package/packages/orq-rc/src/models/errors/updateeval.ts +0 -80
  389. package/packages/orq-rc/src/models/errors/updateprompt.ts +0 -80
  390. package/packages/orq-rc/src/models/operations/chunktext.ts +0 -1623
  391. package/packages/orq-rc/src/models/operations/cleardataset.ts +0 -75
  392. package/packages/orq-rc/src/models/operations/createchunk.ts +0 -428
  393. package/packages/orq-rc/src/models/operations/createcontact.ts +0 -267
  394. package/packages/orq-rc/src/models/operations/createdataset.ts +0 -296
  395. package/packages/orq-rc/src/models/operations/createdatasetitem.ts +0 -5222
  396. package/packages/orq-rc/src/models/operations/createdatasource.ts +0 -852
  397. package/packages/orq-rc/src/models/operations/createeval.ts +0 -3830
  398. package/packages/orq-rc/src/models/operations/createfeedback.ts +0 -286
  399. package/packages/orq-rc/src/models/operations/createprompt.ts +0 -4083
  400. package/packages/orq-rc/src/models/operations/deletechunk.ts +0 -96
  401. package/packages/orq-rc/src/models/operations/deletecontact.ts +0 -69
  402. package/packages/orq-rc/src/models/operations/deletedatapoint.ts +0 -81
  403. package/packages/orq-rc/src/models/operations/deletedataset.ts +0 -75
  404. package/packages/orq-rc/src/models/operations/deletedatasource.ts +0 -87
  405. package/packages/orq-rc/src/models/operations/deleteeval.ts +0 -66
  406. package/packages/orq-rc/src/models/operations/deleteknowledge.ts +0 -78
  407. package/packages/orq-rc/src/models/operations/deleteprompt.ts +0 -69
  408. package/packages/orq-rc/src/models/operations/deploymentcreatemetric.ts +0 -5439
  409. package/packages/orq-rc/src/models/operations/deploymentgetconfig.ts +0 -9379
  410. package/packages/orq-rc/src/models/operations/deploymentinvoke.ts +0 -1256
  411. package/packages/orq-rc/src/models/operations/deployments.ts +0 -2328
  412. package/packages/orq-rc/src/models/operations/deploymentstream.ts +0 -9499
  413. package/packages/orq-rc/src/models/operations/evalsageappropriate.ts +0 -253
  414. package/packages/orq-rc/src/models/operations/evalsbertscore.ts +0 -197
  415. package/packages/orq-rc/src/models/operations/evalsbleuscore.ts +0 -131
  416. package/packages/orq-rc/src/models/operations/evalsbotdetection.ts +0 -249
  417. package/packages/orq-rc/src/models/operations/evalscontains.ts +0 -250
  418. package/packages/orq-rc/src/models/operations/evalscontainsall.ts +0 -248
  419. package/packages/orq-rc/src/models/operations/evalscontainsany.ts +0 -254
  420. package/packages/orq-rc/src/models/operations/evalscontainsemail.ts +0 -181
  421. package/packages/orq-rc/src/models/operations/evalscontainsnone.ts +0 -254
  422. package/packages/orq-rc/src/models/operations/evalscontainsurl.ts +0 -181
  423. package/packages/orq-rc/src/models/operations/evalscontainsvalidlink.ts +0 -186
  424. package/packages/orq-rc/src/models/operations/evalsendswith.ts +0 -250
  425. package/packages/orq-rc/src/models/operations/evalsexactmatch.ts +0 -183
  426. package/packages/orq-rc/src/models/operations/evalsfactcheckingknowledgebase.ts +0 -299
  427. package/packages/orq-rc/src/models/operations/evalsgrammar.ts +0 -243
  428. package/packages/orq-rc/src/models/operations/evalslengthbetween.ts +0 -268
  429. package/packages/orq-rc/src/models/operations/evalslengthgreaterthan.ts +0 -266
  430. package/packages/orq-rc/src/models/operations/evalslengthlessthan.ts +0 -259
  431. package/packages/orq-rc/src/models/operations/evalslocalization.ts +0 -253
  432. package/packages/orq-rc/src/models/operations/evalspii.ts +0 -243
  433. package/packages/orq-rc/src/models/operations/evalsragascoherence.ts +0 -152
  434. package/packages/orq-rc/src/models/operations/evalsragasconciseness.ts +0 -153
  435. package/packages/orq-rc/src/models/operations/evalsragascontextentitiesrecall.ts +0 -164
  436. package/packages/orq-rc/src/models/operations/evalsragascontextprecision.ts +0 -166
  437. package/packages/orq-rc/src/models/operations/evalsragascontextrecall.ts +0 -164
  438. package/packages/orq-rc/src/models/operations/evalsragascorrectness.ts +0 -153
  439. package/packages/orq-rc/src/models/operations/evalsragasfaithfulness.ts +0 -155
  440. package/packages/orq-rc/src/models/operations/evalsragasharmfulness.ts +0 -146
  441. package/packages/orq-rc/src/models/operations/evalsragasmaliciousness.ts +0 -157
  442. package/packages/orq-rc/src/models/operations/evalsragasnoisesensitivity.ts +0 -166
  443. package/packages/orq-rc/src/models/operations/evalsragasresponserelevancy.ts +0 -165
  444. package/packages/orq-rc/src/models/operations/evalsragassummarization.ts +0 -150
  445. package/packages/orq-rc/src/models/operations/evalssentimentclassification.ts +0 -285
  446. package/packages/orq-rc/src/models/operations/evalssummarization.ts +0 -253
  447. package/packages/orq-rc/src/models/operations/evalstoneofvoice.ts +0 -251
  448. package/packages/orq-rc/src/models/operations/evalstranslation.ts +0 -251
  449. package/packages/orq-rc/src/models/operations/evalsvalidjson.ts +0 -177
  450. package/packages/orq-rc/src/models/operations/filedelete.ts +0 -78
  451. package/packages/orq-rc/src/models/operations/fileget.ts +0 -223
  452. package/packages/orq-rc/src/models/operations/filelist.ts +0 -337
  453. package/packages/orq-rc/src/models/operations/fileupload.ts +0 -327
  454. package/packages/orq-rc/src/models/operations/getallprompts.ts +0 -2296
  455. package/packages/orq-rc/src/models/operations/getevals.ts +0 -6163
  456. package/packages/orq-rc/src/models/operations/getonechunk.ts +0 -315
  457. package/packages/orq-rc/src/models/operations/getoneknowledge.ts +0 -537
  458. package/packages/orq-rc/src/models/operations/getoneprompt.ts +0 -2157
  459. package/packages/orq-rc/src/models/operations/getpromptversion.ts +0 -2162
  460. package/packages/orq-rc/src/models/operations/index.ts +0 -97
  461. package/packages/orq-rc/src/models/operations/invokeeval.ts +0 -2520
  462. package/packages/orq-rc/src/models/operations/listchunks.ts +0 -494
  463. package/packages/orq-rc/src/models/operations/listcontacts.ts +0 -490
  464. package/packages/orq-rc/src/models/operations/listdatasetdatapoints.ts +0 -2784
  465. package/packages/orq-rc/src/models/operations/listdatasets.ts +0 -406
  466. package/packages/orq-rc/src/models/operations/listdatasources.ts +0 -447
  467. package/packages/orq-rc/src/models/operations/listknowledgebases.ts +0 -663
  468. package/packages/orq-rc/src/models/operations/listmodels.ts +0 -273
  469. package/packages/orq-rc/src/models/operations/listpromptversions.ts +0 -2294
  470. package/packages/orq-rc/src/models/operations/remoteconfigsgetconfig.ts +0 -190
  471. package/packages/orq-rc/src/models/operations/retrievecontact.ts +0 -210
  472. package/packages/orq-rc/src/models/operations/retrievedatapoint.ts +0 -2586
  473. package/packages/orq-rc/src/models/operations/retrievedataset.ts +0 -288
  474. package/packages/orq-rc/src/models/operations/retrievedatasource.ts +0 -273
  475. package/packages/orq-rc/src/models/operations/searchknowledge.ts +0 -3367
  476. package/packages/orq-rc/src/models/operations/updatechunk.ts +0 -448
  477. package/packages/orq-rc/src/models/operations/updatecontact.ts +0 -325
  478. package/packages/orq-rc/src/models/operations/updatedatapoint.ts +0 -5155
  479. package/packages/orq-rc/src/models/operations/updatedataset.ts +0 -393
  480. package/packages/orq-rc/src/models/operations/updatedatasource.ts +0 -345
  481. package/packages/orq-rc/src/models/operations/updateeval.ts +0 -4131
  482. package/packages/orq-rc/src/models/operations/updateknowledge.ts +0 -920
  483. package/packages/orq-rc/src/models/operations/updateprompt.ts +0 -4220
  484. package/packages/orq-rc/src/sdk/contacts.ts +0 -99
  485. package/packages/orq-rc/src/sdk/datasets.ts +0 -204
  486. package/packages/orq-rc/src/sdk/deployments.ts +0 -89
  487. package/packages/orq-rc/src/sdk/evals.ts +0 -639
  488. package/packages/orq-rc/src/sdk/feedback.ts +0 -27
  489. package/packages/orq-rc/src/sdk/files.ts +0 -78
  490. package/packages/orq-rc/src/sdk/index.ts +0 -5
  491. package/packages/orq-rc/src/sdk/knowledge.ts +0 -267
  492. package/packages/orq-rc/src/sdk/metrics.ts +0 -27
  493. package/packages/orq-rc/src/sdk/models.ts +0 -25
  494. package/packages/orq-rc/src/sdk/prompts.ts +0 -126
  495. package/packages/orq-rc/src/sdk/remoteconfigs.ts +0 -24
  496. package/packages/orq-rc/src/sdk/sdk.ts +0 -67
  497. package/packages/orq-rc/src/types/async.ts +0 -68
  498. package/packages/orq-rc/src/types/blobs.ts +0 -31
  499. package/packages/orq-rc/src/types/constdatetime.ts +0 -15
  500. package/packages/orq-rc/src/types/enums.ts +0 -16
  501. package/packages/orq-rc/src/types/fp.ts +0 -50
  502. package/packages/orq-rc/src/types/index.ts +0 -11
  503. package/packages/orq-rc/src/types/operations.ts +0 -105
  504. package/packages/orq-rc/src/types/rfcdate.ts +0 -54
  505. package/packages/orq-rc/src/types/streams.ts +0 -21
  506. package/packages/orq-rc/tsconfig.json +0 -41
  507. package/src/funcs/knowledgeChunkText.ts +0 -160
  508. package/src/mcp-server/tools/knowledgeChunkText.ts +0 -37
@@ -1,1237 +0,0 @@
1
- # Knowledge
2
- (*knowledge*)
3
-
4
- ## Overview
5
-
6
- ### Available Operations
7
-
8
- * [list](#list) - List all knowledge bases
9
- * [retrieve](#retrieve) - Retrieves a knowledge base
10
- * [update](#update) - Updates a knowledge
11
- * [delete](#delete) - Deletes a knowledge
12
- * [search](#search) - Search knowledge base
13
- * [listDatasources](#listdatasources) - List all datasources
14
- * [createDatasource](#createdatasource) - Create a new datasource
15
- * [retrieveDatasource](#retrievedatasource) - Retrieve a datasource
16
- * [deleteDatasource](#deletedatasource) - Deletes a datasource
17
- * [updateDatasource](#updatedatasource) - Update a datasource
18
- * [createChunks](#createchunks) - Create chunks for a datasource
19
- * [listChunks](#listchunks) - List all chunks for a datasource
20
- * [updateChunk](#updatechunk) - Update a chunk
21
- * [deleteChunk](#deletechunk) - Delete a chunk
22
- * [retrieveChunk](#retrievechunk) - Retrieve a chunk
23
- * [chunkText](#chunktext) - Chunk text content using various strategies
24
-
25
- ## list
26
-
27
- Returns a list of your knowledge bases. The knowledge bases are returned sorted by creation date, with the most recent knowledge bases appearing first
28
-
29
- ### Example Usage
30
-
31
- ```typescript
32
- import { Orq } from "@orq-ai/node";
33
-
34
- const orq = new Orq({
35
- apiKey: process.env["ORQ_API_KEY"] ?? "",
36
- });
37
-
38
- async function run() {
39
- const result = await orq.knowledge.list({});
40
-
41
- console.log(result);
42
- }
43
-
44
- run();
45
- ```
46
-
47
- ### Standalone function
48
-
49
- The standalone function version of this method:
50
-
51
- ```typescript
52
- import { OrqCore } from "@orq-ai/node/core.js";
53
- import { knowledgeList } from "@orq-ai/node/funcs/knowledgeList.js";
54
-
55
- // Use `OrqCore` for best tree-shaking performance.
56
- // You can create one instance of it to use across an application.
57
- const orq = new OrqCore({
58
- apiKey: process.env["ORQ_API_KEY"] ?? "",
59
- });
60
-
61
- async function run() {
62
- const res = await knowledgeList(orq, {});
63
- if (res.ok) {
64
- const { value: result } = res;
65
- console.log(result);
66
- } else {
67
- console.log("knowledgeList failed:", res.error);
68
- }
69
- }
70
-
71
- run();
72
- ```
73
-
74
- ### Parameters
75
-
76
- | Parameter | Type | Required | Description |
77
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
78
- | `request` | [operations.ListKnowledgeBasesRequest](../../models/operations/listknowledgebasesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
79
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
80
- | `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. |
81
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
82
-
83
- ### Response
84
-
85
- **Promise\<[operations.ListKnowledgeBasesResponseBody](../../models/operations/listknowledgebasesresponsebody.md)\>**
86
-
87
- ### Errors
88
-
89
- | Error Type | Status Code | Content Type |
90
- | --------------- | --------------- | --------------- |
91
- | errors.APIError | 4XX, 5XX | \*/\* |
92
-
93
- ## retrieve
94
-
95
- Retrieve a knowledge base with the settings.
96
-
97
- ### Example Usage
98
-
99
- ```typescript
100
- import { Orq } from "@orq-ai/node";
101
-
102
- const orq = new Orq({
103
- apiKey: process.env["ORQ_API_KEY"] ?? "",
104
- });
105
-
106
- async function run() {
107
- const result = await orq.knowledge.retrieve({
108
- knowledgeId: "<id>",
109
- });
110
-
111
- console.log(result);
112
- }
113
-
114
- run();
115
- ```
116
-
117
- ### Standalone function
118
-
119
- The standalone function version of this method:
120
-
121
- ```typescript
122
- import { OrqCore } from "@orq-ai/node/core.js";
123
- import { knowledgeRetrieve } from "@orq-ai/node/funcs/knowledgeRetrieve.js";
124
-
125
- // Use `OrqCore` for best tree-shaking performance.
126
- // You can create one instance of it to use across an application.
127
- const orq = new OrqCore({
128
- apiKey: process.env["ORQ_API_KEY"] ?? "",
129
- });
130
-
131
- async function run() {
132
- const res = await knowledgeRetrieve(orq, {
133
- knowledgeId: "<id>",
134
- });
135
- if (res.ok) {
136
- const { value: result } = res;
137
- console.log(result);
138
- } else {
139
- console.log("knowledgeRetrieve failed:", res.error);
140
- }
141
- }
142
-
143
- run();
144
- ```
145
-
146
- ### Parameters
147
-
148
- | Parameter | Type | Required | Description |
149
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
150
- | `request` | [operations.GetOneKnowledgeRequest](../../models/operations/getoneknowledgerequest.md) | :heavy_check_mark: | The request object to use for the request. |
151
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
152
- | `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. |
153
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
154
-
155
- ### Response
156
-
157
- **Promise\<[operations.GetOneKnowledgeResponseBody](../../models/operations/getoneknowledgeresponsebody.md)\>**
158
-
159
- ### Errors
160
-
161
- | Error Type | Status Code | Content Type |
162
- | --------------- | --------------- | --------------- |
163
- | errors.APIError | 4XX, 5XX | \*/\* |
164
-
165
- ## update
166
-
167
- Updates a knowledge
168
-
169
- ### Example Usage
170
-
171
- ```typescript
172
- import { Orq } from "@orq-ai/node";
173
-
174
- const orq = new Orq({
175
- apiKey: process.env["ORQ_API_KEY"] ?? "",
176
- });
177
-
178
- async function run() {
179
- const result = await orq.knowledge.update({
180
- knowledgeId: "<id>",
181
- requestBody: {
182
- path: "Default",
183
- },
184
- });
185
-
186
- console.log(result);
187
- }
188
-
189
- run();
190
- ```
191
-
192
- ### Standalone function
193
-
194
- The standalone function version of this method:
195
-
196
- ```typescript
197
- import { OrqCore } from "@orq-ai/node/core.js";
198
- import { knowledgeUpdate } from "@orq-ai/node/funcs/knowledgeUpdate.js";
199
-
200
- // Use `OrqCore` for best tree-shaking performance.
201
- // You can create one instance of it to use across an application.
202
- const orq = new OrqCore({
203
- apiKey: process.env["ORQ_API_KEY"] ?? "",
204
- });
205
-
206
- async function run() {
207
- const res = await knowledgeUpdate(orq, {
208
- knowledgeId: "<id>",
209
- requestBody: {
210
- path: "Default",
211
- },
212
- });
213
- if (res.ok) {
214
- const { value: result } = res;
215
- console.log(result);
216
- } else {
217
- console.log("knowledgeUpdate failed:", res.error);
218
- }
219
- }
220
-
221
- run();
222
- ```
223
-
224
- ### Parameters
225
-
226
- | Parameter | Type | Required | Description |
227
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
228
- | `request` | [operations.UpdateKnowledgeRequest](../../models/operations/updateknowledgerequest.md) | :heavy_check_mark: | The request object to use for the request. |
229
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
230
- | `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. |
231
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
232
-
233
- ### Response
234
-
235
- **Promise\<[operations.UpdateKnowledgeResponseBody](../../models/operations/updateknowledgeresponsebody.md)\>**
236
-
237
- ### Errors
238
-
239
- | Error Type | Status Code | Content Type |
240
- | --------------- | --------------- | --------------- |
241
- | errors.APIError | 4XX, 5XX | \*/\* |
242
-
243
- ## delete
244
-
245
- Deletes a knowledge base. Deleting a knowledge base will delete all the datasources and chunks associated with it.
246
-
247
- ### Example Usage
248
-
249
- ```typescript
250
- import { Orq } from "@orq-ai/node";
251
-
252
- const orq = new Orq({
253
- apiKey: process.env["ORQ_API_KEY"] ?? "",
254
- });
255
-
256
- async function run() {
257
- await orq.knowledge.delete({
258
- knowledgeId: "<id>",
259
- });
260
-
261
-
262
- }
263
-
264
- run();
265
- ```
266
-
267
- ### Standalone function
268
-
269
- The standalone function version of this method:
270
-
271
- ```typescript
272
- import { OrqCore } from "@orq-ai/node/core.js";
273
- import { knowledgeDelete } from "@orq-ai/node/funcs/knowledgeDelete.js";
274
-
275
- // Use `OrqCore` for best tree-shaking performance.
276
- // You can create one instance of it to use across an application.
277
- const orq = new OrqCore({
278
- apiKey: process.env["ORQ_API_KEY"] ?? "",
279
- });
280
-
281
- async function run() {
282
- const res = await knowledgeDelete(orq, {
283
- knowledgeId: "<id>",
284
- });
285
- if (res.ok) {
286
- const { value: result } = res;
287
-
288
- } else {
289
- console.log("knowledgeDelete failed:", res.error);
290
- }
291
- }
292
-
293
- run();
294
- ```
295
-
296
- ### Parameters
297
-
298
- | Parameter | Type | Required | Description |
299
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
300
- | `request` | [operations.DeleteKnowledgeRequest](../../models/operations/deleteknowledgerequest.md) | :heavy_check_mark: | The request object to use for the request. |
301
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
302
- | `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. |
303
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
304
-
305
- ### Response
306
-
307
- **Promise\<void\>**
308
-
309
- ### Errors
310
-
311
- | Error Type | Status Code | Content Type |
312
- | --------------- | --------------- | --------------- |
313
- | errors.APIError | 4XX, 5XX | \*/\* |
314
-
315
- ## search
316
-
317
- Search a Knowledge Base and return the most similar chunks, along with their search and rerank scores.
318
-
319
- ### Example Usage
320
-
321
- ```typescript
322
- import { Orq } from "@orq-ai/node";
323
-
324
- const orq = new Orq({
325
- apiKey: process.env["ORQ_API_KEY"] ?? "",
326
- });
327
-
328
- async function run() {
329
- const result = await orq.knowledge.search({
330
- knowledgeId: "<id>",
331
- });
332
-
333
- console.log(result);
334
- }
335
-
336
- run();
337
- ```
338
-
339
- ### Standalone function
340
-
341
- The standalone function version of this method:
342
-
343
- ```typescript
344
- import { OrqCore } from "@orq-ai/node/core.js";
345
- import { knowledgeSearch } from "@orq-ai/node/funcs/knowledgeSearch.js";
346
-
347
- // Use `OrqCore` for best tree-shaking performance.
348
- // You can create one instance of it to use across an application.
349
- const orq = new OrqCore({
350
- apiKey: process.env["ORQ_API_KEY"] ?? "",
351
- });
352
-
353
- async function run() {
354
- const res = await knowledgeSearch(orq, {
355
- knowledgeId: "<id>",
356
- });
357
- if (res.ok) {
358
- const { value: result } = res;
359
- console.log(result);
360
- } else {
361
- console.log("knowledgeSearch failed:", res.error);
362
- }
363
- }
364
-
365
- run();
366
- ```
367
-
368
- ### Parameters
369
-
370
- | Parameter | Type | Required | Description |
371
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
372
- | `request` | [operations.SearchKnowledgeRequest](../../models/operations/searchknowledgerequest.md) | :heavy_check_mark: | The request object to use for the request. |
373
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
374
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
375
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
376
-
377
- ### Response
378
-
379
- **Promise\<[operations.SearchKnowledgeResponseBody](../../models/operations/searchknowledgeresponsebody.md)\>**
380
-
381
- ### Errors
382
-
383
- | Error Type | Status Code | Content Type |
384
- | --------------- | --------------- | --------------- |
385
- | errors.APIError | 4XX, 5XX | \*/\* |
386
-
387
- ## listDatasources
388
-
389
- List all datasources
390
-
391
- ### Example Usage
392
-
393
- ```typescript
394
- import { Orq } from "@orq-ai/node";
395
-
396
- const orq = new Orq({
397
- apiKey: process.env["ORQ_API_KEY"] ?? "",
398
- });
399
-
400
- async function run() {
401
- const result = await orq.knowledge.listDatasources({
402
- knowledgeId: "<id>",
403
- status: [
404
- "completed",
405
- "failed",
406
- ],
407
- });
408
-
409
- console.log(result);
410
- }
411
-
412
- run();
413
- ```
414
-
415
- ### Standalone function
416
-
417
- The standalone function version of this method:
418
-
419
- ```typescript
420
- import { OrqCore } from "@orq-ai/node/core.js";
421
- import { knowledgeListDatasources } from "@orq-ai/node/funcs/knowledgeListDatasources.js";
422
-
423
- // Use `OrqCore` for best tree-shaking performance.
424
- // You can create one instance of it to use across an application.
425
- const orq = new OrqCore({
426
- apiKey: process.env["ORQ_API_KEY"] ?? "",
427
- });
428
-
429
- async function run() {
430
- const res = await knowledgeListDatasources(orq, {
431
- knowledgeId: "<id>",
432
- status: [
433
- "completed",
434
- "failed",
435
- ],
436
- });
437
- if (res.ok) {
438
- const { value: result } = res;
439
- console.log(result);
440
- } else {
441
- console.log("knowledgeListDatasources failed:", res.error);
442
- }
443
- }
444
-
445
- run();
446
- ```
447
-
448
- ### Parameters
449
-
450
- | Parameter | Type | Required | Description |
451
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
452
- | `request` | [operations.ListDatasourcesRequest](../../models/operations/listdatasourcesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
453
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
454
- | `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. |
455
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
456
-
457
- ### Response
458
-
459
- **Promise\<[operations.ListDatasourcesResponseBody](../../models/operations/listdatasourcesresponsebody.md)\>**
460
-
461
- ### Errors
462
-
463
- | Error Type | Status Code | Content Type |
464
- | --------------- | --------------- | --------------- |
465
- | errors.APIError | 4XX, 5XX | \*/\* |
466
-
467
- ## createDatasource
468
-
469
- Create a new datasource
470
-
471
- ### Example Usage
472
-
473
- ```typescript
474
- import { Orq } from "@orq-ai/node";
475
-
476
- const orq = new Orq({
477
- apiKey: process.env["ORQ_API_KEY"] ?? "",
478
- });
479
-
480
- async function run() {
481
- const result = await orq.knowledge.createDatasource({
482
- knowledgeId: "<id>",
483
- requestBody: {},
484
- });
485
-
486
- console.log(result);
487
- }
488
-
489
- run();
490
- ```
491
-
492
- ### Standalone function
493
-
494
- The standalone function version of this method:
495
-
496
- ```typescript
497
- import { OrqCore } from "@orq-ai/node/core.js";
498
- import { knowledgeCreateDatasource } from "@orq-ai/node/funcs/knowledgeCreateDatasource.js";
499
-
500
- // Use `OrqCore` for best tree-shaking performance.
501
- // You can create one instance of it to use across an application.
502
- const orq = new OrqCore({
503
- apiKey: process.env["ORQ_API_KEY"] ?? "",
504
- });
505
-
506
- async function run() {
507
- const res = await knowledgeCreateDatasource(orq, {
508
- knowledgeId: "<id>",
509
- requestBody: {},
510
- });
511
- if (res.ok) {
512
- const { value: result } = res;
513
- console.log(result);
514
- } else {
515
- console.log("knowledgeCreateDatasource failed:", res.error);
516
- }
517
- }
518
-
519
- run();
520
- ```
521
-
522
- ### Parameters
523
-
524
- | Parameter | Type | Required | Description |
525
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
526
- | `request` | [operations.CreateDatasourceRequest](../../models/operations/createdatasourcerequest.md) | :heavy_check_mark: | The request object to use for the request. |
527
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
528
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
529
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
530
-
531
- ### Response
532
-
533
- **Promise\<[operations.CreateDatasourceResponseBody](../../models/operations/createdatasourceresponsebody.md)\>**
534
-
535
- ### Errors
536
-
537
- | Error Type | Status Code | Content Type |
538
- | --------------- | --------------- | --------------- |
539
- | errors.APIError | 4XX, 5XX | \*/\* |
540
-
541
- ## retrieveDatasource
542
-
543
- Retrieve a datasource
544
-
545
- ### Example Usage
546
-
547
- ```typescript
548
- import { Orq } from "@orq-ai/node";
549
-
550
- const orq = new Orq({
551
- apiKey: process.env["ORQ_API_KEY"] ?? "",
552
- });
553
-
554
- async function run() {
555
- const result = await orq.knowledge.retrieveDatasource({
556
- knowledgeId: "<id>",
557
- datasourceId: "<id>",
558
- });
559
-
560
- console.log(result);
561
- }
562
-
563
- run();
564
- ```
565
-
566
- ### Standalone function
567
-
568
- The standalone function version of this method:
569
-
570
- ```typescript
571
- import { OrqCore } from "@orq-ai/node/core.js";
572
- import { knowledgeRetrieveDatasource } from "@orq-ai/node/funcs/knowledgeRetrieveDatasource.js";
573
-
574
- // Use `OrqCore` for best tree-shaking performance.
575
- // You can create one instance of it to use across an application.
576
- const orq = new OrqCore({
577
- apiKey: process.env["ORQ_API_KEY"] ?? "",
578
- });
579
-
580
- async function run() {
581
- const res = await knowledgeRetrieveDatasource(orq, {
582
- knowledgeId: "<id>",
583
- datasourceId: "<id>",
584
- });
585
- if (res.ok) {
586
- const { value: result } = res;
587
- console.log(result);
588
- } else {
589
- console.log("knowledgeRetrieveDatasource failed:", res.error);
590
- }
591
- }
592
-
593
- run();
594
- ```
595
-
596
- ### Parameters
597
-
598
- | Parameter | Type | Required | Description |
599
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
600
- | `request` | [operations.RetrieveDatasourceRequest](../../models/operations/retrievedatasourcerequest.md) | :heavy_check_mark: | The request object to use for the request. |
601
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
602
- | `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. |
603
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
604
-
605
- ### Response
606
-
607
- **Promise\<[operations.RetrieveDatasourceResponseBody](../../models/operations/retrievedatasourceresponsebody.md)\>**
608
-
609
- ### Errors
610
-
611
- | Error Type | Status Code | Content Type |
612
- | --------------- | --------------- | --------------- |
613
- | errors.APIError | 4XX, 5XX | \*/\* |
614
-
615
- ## deleteDatasource
616
-
617
- Deletes a datasource from a knowledge base. Deleting a datasource will remove it from the knowledge base and all associated chunks. This action is irreversible and cannot be undone.
618
-
619
- ### Example Usage
620
-
621
- ```typescript
622
- import { Orq } from "@orq-ai/node";
623
-
624
- const orq = new Orq({
625
- apiKey: process.env["ORQ_API_KEY"] ?? "",
626
- });
627
-
628
- async function run() {
629
- await orq.knowledge.deleteDatasource({
630
- knowledgeId: "<id>",
631
- datasourceId: "<id>",
632
- });
633
-
634
-
635
- }
636
-
637
- run();
638
- ```
639
-
640
- ### Standalone function
641
-
642
- The standalone function version of this method:
643
-
644
- ```typescript
645
- import { OrqCore } from "@orq-ai/node/core.js";
646
- import { knowledgeDeleteDatasource } from "@orq-ai/node/funcs/knowledgeDeleteDatasource.js";
647
-
648
- // Use `OrqCore` for best tree-shaking performance.
649
- // You can create one instance of it to use across an application.
650
- const orq = new OrqCore({
651
- apiKey: process.env["ORQ_API_KEY"] ?? "",
652
- });
653
-
654
- async function run() {
655
- const res = await knowledgeDeleteDatasource(orq, {
656
- knowledgeId: "<id>",
657
- datasourceId: "<id>",
658
- });
659
- if (res.ok) {
660
- const { value: result } = res;
661
-
662
- } else {
663
- console.log("knowledgeDeleteDatasource failed:", res.error);
664
- }
665
- }
666
-
667
- run();
668
- ```
669
-
670
- ### Parameters
671
-
672
- | Parameter | Type | Required | Description |
673
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
674
- | `request` | [operations.DeleteDatasourceRequest](../../models/operations/deletedatasourcerequest.md) | :heavy_check_mark: | The request object to use for the request. |
675
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
676
- | `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. |
677
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
678
-
679
- ### Response
680
-
681
- **Promise\<void\>**
682
-
683
- ### Errors
684
-
685
- | Error Type | Status Code | Content Type |
686
- | --------------- | --------------- | --------------- |
687
- | errors.APIError | 4XX, 5XX | \*/\* |
688
-
689
- ## updateDatasource
690
-
691
- Update a datasource
692
-
693
- ### Example Usage
694
-
695
- ```typescript
696
- import { Orq } from "@orq-ai/node";
697
-
698
- const orq = new Orq({
699
- apiKey: process.env["ORQ_API_KEY"] ?? "",
700
- });
701
-
702
- async function run() {
703
- const result = await orq.knowledge.updateDatasource({
704
- knowledgeId: "<id>",
705
- datasourceId: "<id>",
706
- requestBody: {
707
- displayName: "Tony_Roberts",
708
- },
709
- });
710
-
711
- console.log(result);
712
- }
713
-
714
- run();
715
- ```
716
-
717
- ### Standalone function
718
-
719
- The standalone function version of this method:
720
-
721
- ```typescript
722
- import { OrqCore } from "@orq-ai/node/core.js";
723
- import { knowledgeUpdateDatasource } from "@orq-ai/node/funcs/knowledgeUpdateDatasource.js";
724
-
725
- // Use `OrqCore` for best tree-shaking performance.
726
- // You can create one instance of it to use across an application.
727
- const orq = new OrqCore({
728
- apiKey: process.env["ORQ_API_KEY"] ?? "",
729
- });
730
-
731
- async function run() {
732
- const res = await knowledgeUpdateDatasource(orq, {
733
- knowledgeId: "<id>",
734
- datasourceId: "<id>",
735
- requestBody: {
736
- displayName: "Tony_Roberts",
737
- },
738
- });
739
- if (res.ok) {
740
- const { value: result } = res;
741
- console.log(result);
742
- } else {
743
- console.log("knowledgeUpdateDatasource failed:", res.error);
744
- }
745
- }
746
-
747
- run();
748
- ```
749
-
750
- ### Parameters
751
-
752
- | Parameter | Type | Required | Description |
753
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
754
- | `request` | [operations.UpdateDatasourceRequest](../../models/operations/updatedatasourcerequest.md) | :heavy_check_mark: | The request object to use for the request. |
755
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
756
- | `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. |
757
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
758
-
759
- ### Response
760
-
761
- **Promise\<[operations.UpdateDatasourceResponseBody](../../models/operations/updatedatasourceresponsebody.md)\>**
762
-
763
- ### Errors
764
-
765
- | Error Type | Status Code | Content Type |
766
- | --------------- | --------------- | --------------- |
767
- | errors.APIError | 4XX, 5XX | \*/\* |
768
-
769
- ## createChunks
770
-
771
- Create chunks for a datasource
772
-
773
- ### Example Usage
774
-
775
- ```typescript
776
- import { Orq } from "@orq-ai/node";
777
-
778
- const orq = new Orq({
779
- apiKey: process.env["ORQ_API_KEY"] ?? "",
780
- });
781
-
782
- async function run() {
783
- const result = await orq.knowledge.createChunks({
784
- knowledgeId: "<id>",
785
- datasourceId: "<id>",
786
- });
787
-
788
- console.log(result);
789
- }
790
-
791
- run();
792
- ```
793
-
794
- ### Standalone function
795
-
796
- The standalone function version of this method:
797
-
798
- ```typescript
799
- import { OrqCore } from "@orq-ai/node/core.js";
800
- import { knowledgeCreateChunks } from "@orq-ai/node/funcs/knowledgeCreateChunks.js";
801
-
802
- // Use `OrqCore` for best tree-shaking performance.
803
- // You can create one instance of it to use across an application.
804
- const orq = new OrqCore({
805
- apiKey: process.env["ORQ_API_KEY"] ?? "",
806
- });
807
-
808
- async function run() {
809
- const res = await knowledgeCreateChunks(orq, {
810
- knowledgeId: "<id>",
811
- datasourceId: "<id>",
812
- });
813
- if (res.ok) {
814
- const { value: result } = res;
815
- console.log(result);
816
- } else {
817
- console.log("knowledgeCreateChunks failed:", res.error);
818
- }
819
- }
820
-
821
- run();
822
- ```
823
-
824
- ### Parameters
825
-
826
- | Parameter | Type | Required | Description |
827
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
828
- | `request` | [operations.CreateChunkRequest](../../models/operations/createchunkrequest.md) | :heavy_check_mark: | The request object to use for the request. |
829
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
830
- | `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. |
831
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
832
-
833
- ### Response
834
-
835
- **Promise\<[operations.ResponseBody[]](../../models/.md)\>**
836
-
837
- ### Errors
838
-
839
- | Error Type | Status Code | Content Type |
840
- | --------------- | --------------- | --------------- |
841
- | errors.APIError | 4XX, 5XX | \*/\* |
842
-
843
- ## listChunks
844
-
845
- List all chunks for a datasource
846
-
847
- ### Example Usage
848
-
849
- ```typescript
850
- import { Orq } from "@orq-ai/node";
851
-
852
- const orq = new Orq({
853
- apiKey: process.env["ORQ_API_KEY"] ?? "",
854
- });
855
-
856
- async function run() {
857
- const result = await orq.knowledge.listChunks({
858
- knowledgeId: "<id>",
859
- datasourceId: "<id>",
860
- status: [
861
- "completed",
862
- "failed",
863
- ],
864
- });
865
-
866
- console.log(result);
867
- }
868
-
869
- run();
870
- ```
871
-
872
- ### Standalone function
873
-
874
- The standalone function version of this method:
875
-
876
- ```typescript
877
- import { OrqCore } from "@orq-ai/node/core.js";
878
- import { knowledgeListChunks } from "@orq-ai/node/funcs/knowledgeListChunks.js";
879
-
880
- // Use `OrqCore` for best tree-shaking performance.
881
- // You can create one instance of it to use across an application.
882
- const orq = new OrqCore({
883
- apiKey: process.env["ORQ_API_KEY"] ?? "",
884
- });
885
-
886
- async function run() {
887
- const res = await knowledgeListChunks(orq, {
888
- knowledgeId: "<id>",
889
- datasourceId: "<id>",
890
- status: [
891
- "completed",
892
- "failed",
893
- ],
894
- });
895
- if (res.ok) {
896
- const { value: result } = res;
897
- console.log(result);
898
- } else {
899
- console.log("knowledgeListChunks failed:", res.error);
900
- }
901
- }
902
-
903
- run();
904
- ```
905
-
906
- ### Parameters
907
-
908
- | Parameter | Type | Required | Description |
909
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
910
- | `request` | [operations.ListChunksRequest](../../models/operations/listchunksrequest.md) | :heavy_check_mark: | The request object to use for the request. |
911
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
912
- | `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. |
913
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
914
-
915
- ### Response
916
-
917
- **Promise\<[operations.ListChunksResponseBody](../../models/operations/listchunksresponsebody.md)\>**
918
-
919
- ### Errors
920
-
921
- | Error Type | Status Code | Content Type |
922
- | --------------- | --------------- | --------------- |
923
- | errors.APIError | 4XX, 5XX | \*/\* |
924
-
925
- ## updateChunk
926
-
927
- Update a chunk
928
-
929
- ### Example Usage
930
-
931
- ```typescript
932
- import { Orq } from "@orq-ai/node";
933
-
934
- const orq = new Orq({
935
- apiKey: process.env["ORQ_API_KEY"] ?? "",
936
- });
937
-
938
- async function run() {
939
- const result = await orq.knowledge.updateChunk({
940
- chunkId: "<id>",
941
- datasourceId: "<id>",
942
- knowledgeId: "<id>",
943
- });
944
-
945
- console.log(result);
946
- }
947
-
948
- run();
949
- ```
950
-
951
- ### Standalone function
952
-
953
- The standalone function version of this method:
954
-
955
- ```typescript
956
- import { OrqCore } from "@orq-ai/node/core.js";
957
- import { knowledgeUpdateChunk } from "@orq-ai/node/funcs/knowledgeUpdateChunk.js";
958
-
959
- // Use `OrqCore` for best tree-shaking performance.
960
- // You can create one instance of it to use across an application.
961
- const orq = new OrqCore({
962
- apiKey: process.env["ORQ_API_KEY"] ?? "",
963
- });
964
-
965
- async function run() {
966
- const res = await knowledgeUpdateChunk(orq, {
967
- chunkId: "<id>",
968
- datasourceId: "<id>",
969
- knowledgeId: "<id>",
970
- });
971
- if (res.ok) {
972
- const { value: result } = res;
973
- console.log(result);
974
- } else {
975
- console.log("knowledgeUpdateChunk failed:", res.error);
976
- }
977
- }
978
-
979
- run();
980
- ```
981
-
982
- ### Parameters
983
-
984
- | Parameter | Type | Required | Description |
985
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
986
- | `request` | [operations.UpdateChunkRequest](../../models/operations/updatechunkrequest.md) | :heavy_check_mark: | The request object to use for the request. |
987
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
988
- | `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. |
989
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
990
-
991
- ### Response
992
-
993
- **Promise\<[operations.UpdateChunkResponseBody](../../models/operations/updatechunkresponsebody.md)\>**
994
-
995
- ### Errors
996
-
997
- | Error Type | Status Code | Content Type |
998
- | --------------- | --------------- | --------------- |
999
- | errors.APIError | 4XX, 5XX | \*/\* |
1000
-
1001
- ## deleteChunk
1002
-
1003
- Delete a chunk
1004
-
1005
- ### Example Usage
1006
-
1007
- ```typescript
1008
- import { Orq } from "@orq-ai/node";
1009
-
1010
- const orq = new Orq({
1011
- apiKey: process.env["ORQ_API_KEY"] ?? "",
1012
- });
1013
-
1014
- async function run() {
1015
- await orq.knowledge.deleteChunk({
1016
- chunkId: "<id>",
1017
- datasourceId: "<id>",
1018
- knowledgeId: "<id>",
1019
- });
1020
-
1021
-
1022
- }
1023
-
1024
- run();
1025
- ```
1026
-
1027
- ### Standalone function
1028
-
1029
- The standalone function version of this method:
1030
-
1031
- ```typescript
1032
- import { OrqCore } from "@orq-ai/node/core.js";
1033
- import { knowledgeDeleteChunk } from "@orq-ai/node/funcs/knowledgeDeleteChunk.js";
1034
-
1035
- // Use `OrqCore` for best tree-shaking performance.
1036
- // You can create one instance of it to use across an application.
1037
- const orq = new OrqCore({
1038
- apiKey: process.env["ORQ_API_KEY"] ?? "",
1039
- });
1040
-
1041
- async function run() {
1042
- const res = await knowledgeDeleteChunk(orq, {
1043
- chunkId: "<id>",
1044
- datasourceId: "<id>",
1045
- knowledgeId: "<id>",
1046
- });
1047
- if (res.ok) {
1048
- const { value: result } = res;
1049
-
1050
- } else {
1051
- console.log("knowledgeDeleteChunk failed:", res.error);
1052
- }
1053
- }
1054
-
1055
- run();
1056
- ```
1057
-
1058
- ### Parameters
1059
-
1060
- | Parameter | Type | Required | Description |
1061
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1062
- | `request` | [operations.DeleteChunkRequest](../../models/operations/deletechunkrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1063
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1064
- | `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. |
1065
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1066
-
1067
- ### Response
1068
-
1069
- **Promise\<void\>**
1070
-
1071
- ### Errors
1072
-
1073
- | Error Type | Status Code | Content Type |
1074
- | --------------- | --------------- | --------------- |
1075
- | errors.APIError | 4XX, 5XX | \*/\* |
1076
-
1077
- ## retrieveChunk
1078
-
1079
- Retrieve a chunk
1080
-
1081
- ### Example Usage
1082
-
1083
- ```typescript
1084
- import { Orq } from "@orq-ai/node";
1085
-
1086
- const orq = new Orq({
1087
- apiKey: process.env["ORQ_API_KEY"] ?? "",
1088
- });
1089
-
1090
- async function run() {
1091
- const result = await orq.knowledge.retrieveChunk({
1092
- chunkId: "<id>",
1093
- datasourceId: "<id>",
1094
- knowledgeId: "<id>",
1095
- });
1096
-
1097
- console.log(result);
1098
- }
1099
-
1100
- run();
1101
- ```
1102
-
1103
- ### Standalone function
1104
-
1105
- The standalone function version of this method:
1106
-
1107
- ```typescript
1108
- import { OrqCore } from "@orq-ai/node/core.js";
1109
- import { knowledgeRetrieveChunk } from "@orq-ai/node/funcs/knowledgeRetrieveChunk.js";
1110
-
1111
- // Use `OrqCore` for best tree-shaking performance.
1112
- // You can create one instance of it to use across an application.
1113
- const orq = new OrqCore({
1114
- apiKey: process.env["ORQ_API_KEY"] ?? "",
1115
- });
1116
-
1117
- async function run() {
1118
- const res = await knowledgeRetrieveChunk(orq, {
1119
- chunkId: "<id>",
1120
- datasourceId: "<id>",
1121
- knowledgeId: "<id>",
1122
- });
1123
- if (res.ok) {
1124
- const { value: result } = res;
1125
- console.log(result);
1126
- } else {
1127
- console.log("knowledgeRetrieveChunk failed:", res.error);
1128
- }
1129
- }
1130
-
1131
- run();
1132
- ```
1133
-
1134
- ### Parameters
1135
-
1136
- | Parameter | Type | Required | Description |
1137
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1138
- | `request` | [operations.GetOneChunkRequest](../../models/operations/getonechunkrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1139
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1140
- | `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. |
1141
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1142
-
1143
- ### Response
1144
-
1145
- **Promise\<[operations.GetOneChunkResponseBody](../../models/operations/getonechunkresponsebody.md)\>**
1146
-
1147
- ### Errors
1148
-
1149
- | Error Type | Status Code | Content Type |
1150
- | --------------- | --------------- | --------------- |
1151
- | errors.APIError | 4XX, 5XX | \*/\* |
1152
-
1153
- ## chunkText
1154
-
1155
- 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.
1156
-
1157
- ### Example Usage
1158
-
1159
- ```typescript
1160
- import { Orq } from "@orq-ai/node";
1161
-
1162
- const orq = new Orq({
1163
- apiKey: process.env["ORQ_API_KEY"] ?? "",
1164
- });
1165
-
1166
- async function run() {
1167
- const result = await orq.knowledge.chunkText({
1168
- 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.",
1169
- metadata: true,
1170
- strategy: "semantic",
1171
- chunkSize: 256,
1172
- threshold: 0.8,
1173
- embeddingModel: "openai/text-embedding-3-small",
1174
- mode: "window",
1175
- similarityWindow: 1,
1176
- });
1177
-
1178
- console.log(result);
1179
- }
1180
-
1181
- run();
1182
- ```
1183
-
1184
- ### Standalone function
1185
-
1186
- The standalone function version of this method:
1187
-
1188
- ```typescript
1189
- import { OrqCore } from "@orq-ai/node/core.js";
1190
- import { knowledgeChunkText } from "@orq-ai/node/funcs/knowledgeChunkText.js";
1191
-
1192
- // Use `OrqCore` for best tree-shaking performance.
1193
- // You can create one instance of it to use across an application.
1194
- const orq = new OrqCore({
1195
- apiKey: process.env["ORQ_API_KEY"] ?? "",
1196
- });
1197
-
1198
- async function run() {
1199
- const res = await knowledgeChunkText(orq, {
1200
- 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.",
1201
- metadata: true,
1202
- strategy: "semantic",
1203
- chunkSize: 256,
1204
- threshold: 0.8,
1205
- embeddingModel: "openai/text-embedding-3-small",
1206
- mode: "window",
1207
- similarityWindow: 1,
1208
- });
1209
- if (res.ok) {
1210
- const { value: result } = res;
1211
- console.log(result);
1212
- } else {
1213
- console.log("knowledgeChunkText failed:", res.error);
1214
- }
1215
- }
1216
-
1217
- run();
1218
- ```
1219
-
1220
- ### Parameters
1221
-
1222
- | Parameter | Type | Required | Description |
1223
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1224
- | `request` | [operations.ChunkTextChunkingRequest](../../models/operations/chunktextchunkingrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1225
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1226
- | `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. |
1227
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1228
-
1229
- ### Response
1230
-
1231
- **Promise\<[operations.ChunkTextResponseBody](../../models/operations/chunktextresponsebody.md)\>**
1232
-
1233
- ### Errors
1234
-
1235
- | Error Type | Status Code | Content Type |
1236
- | --------------- | --------------- | --------------- |
1237
- | errors.APIError | 4XX, 5XX | \*/\* |