@orq-ai/node 4.7.0-rc.58 → 4.7.3

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 (502) hide show
  1. package/jsr.json +1 -1
  2. package/lib/config.d.ts +2 -2
  3. package/lib/config.js +2 -2
  4. package/lib/config.js.map +1 -1
  5. package/models/components/reasoningpart.js +1 -1
  6. package/models/operations/createcontact.js +1 -1
  7. package/models/operations/createdataset.js +1 -1
  8. package/models/operations/createdatasetitem.js +4 -4
  9. package/models/operations/createdatasource.js +1 -1
  10. package/models/operations/createeval.js +16 -16
  11. package/models/operations/createidentity.js +1 -1
  12. package/models/operations/createtool.js +6 -6
  13. package/models/operations/getalltools.js +6 -6
  14. package/models/operations/getevals.js +16 -16
  15. package/models/operations/getv2humanevals.js +6 -6
  16. package/models/operations/getv2humanevalsets.js +2 -2
  17. package/models/operations/getv2humanevalsetsid.js +2 -2
  18. package/models/operations/getv2humanevalsid.js +6 -6
  19. package/models/operations/listdatasetdatapoints.js +4 -4
  20. package/models/operations/listdatasets.js +1 -1
  21. package/models/operations/listdatasources.js +1 -1
  22. package/models/operations/listidentities.js +1 -1
  23. package/models/operations/patchv2humanevalsetsid.js +2 -2
  24. package/models/operations/patchv2humanevalsid.js +12 -12
  25. package/models/operations/postv2feedbackevaluation.js +3 -3
  26. package/models/operations/postv2humanevals.js +12 -12
  27. package/models/operations/postv2humanevalsets.js +2 -2
  28. package/models/operations/retrievedatapoint.js +4 -4
  29. package/models/operations/retrievedataset.js +1 -1
  30. package/models/operations/retrievedatasource.js +1 -1
  31. package/models/operations/retrieveidentity.js +1 -1
  32. package/models/operations/retrievetool.js +6 -6
  33. package/models/operations/runagent.js +1 -1
  34. package/models/operations/streamrunagent.js +1 -1
  35. package/models/operations/updatedatapoint.js +4 -4
  36. package/models/operations/updatedataset.js +1 -1
  37. package/models/operations/updatedatasource.js +1 -1
  38. package/models/operations/updateeval.js +16 -16
  39. package/models/operations/updateidentity.js +1 -1
  40. package/models/operations/updatetool.js +7 -7
  41. package/package.json +3 -4
  42. package/packages/orq-rc/examples/postV2Feedback.example.ts +26 -0
  43. package/packages/orq-rc/src/core.ts +13 -0
  44. package/packages/orq-rc/src/funcs/agentsCreate.ts +161 -0
  45. package/packages/orq-rc/src/funcs/agentsDelete.ts +179 -0
  46. package/packages/orq-rc/src/funcs/agentsInvoke.ts +176 -0
  47. package/packages/orq-rc/src/funcs/agentsList.ts +184 -0
  48. package/packages/orq-rc/src/funcs/agentsPostV2AgentsA2a.ts +178 -0
  49. package/packages/orq-rc/src/funcs/agentsPostV2AgentsKeyCardRefresh.ts +186 -0
  50. package/packages/orq-rc/src/funcs/agentsResponsesCreate.ts +182 -0
  51. package/packages/orq-rc/src/funcs/agentsResponsesGet.ts +181 -0
  52. package/packages/orq-rc/src/funcs/agentsRetrieve.ts +179 -0
  53. package/packages/orq-rc/src/funcs/agentsRun.ts +162 -0
  54. package/packages/orq-rc/src/funcs/agentsStream.ts +203 -0
  55. package/packages/orq-rc/src/funcs/agentsStreamRun.ts +189 -0
  56. package/packages/orq-rc/src/funcs/agentsUpdate.ts +183 -0
  57. package/packages/orq-rc/src/funcs/annotationsCreate.ts +170 -0
  58. package/packages/orq-rc/src/funcs/annotationsDelete.ts +170 -0
  59. package/packages/orq-rc/src/funcs/chunkingParse.ts +160 -0
  60. package/packages/orq-rc/src/funcs/contactsCreate.ts +160 -0
  61. package/packages/orq-rc/src/funcs/datasetsClear.ts +166 -0
  62. package/packages/orq-rc/src/funcs/datasetsCreate.ts +165 -0
  63. package/packages/orq-rc/src/funcs/datasetsCreateDatapoint.ts +170 -0
  64. package/packages/orq-rc/src/funcs/datasetsDelete.ts +166 -0
  65. package/packages/orq-rc/src/funcs/datasetsDeleteDatapoint.ts +181 -0
  66. package/packages/orq-rc/src/funcs/datasetsList.ts +167 -0
  67. package/packages/orq-rc/src/funcs/datasetsListDatapoints.ts +173 -0
  68. package/packages/orq-rc/src/funcs/datasetsRetrieve.ts +174 -0
  69. package/packages/orq-rc/src/funcs/datasetsRetrieveDatapoint.ts +180 -0
  70. package/packages/orq-rc/src/funcs/datasetsUpdate.ts +175 -0
  71. package/packages/orq-rc/src/funcs/datasetsUpdateDatapoint.ts +178 -0
  72. package/packages/orq-rc/src/funcs/deleteV2HumanEvalsId.ts +169 -0
  73. package/packages/orq-rc/src/funcs/deploymentsGetConfig.ts +168 -0
  74. package/packages/orq-rc/src/funcs/deploymentsInvoke.ts +176 -0
  75. package/packages/orq-rc/src/funcs/deploymentsList.ts +176 -0
  76. package/packages/orq-rc/src/funcs/deploymentsMetricsCreate.ts +169 -0
  77. package/packages/orq-rc/src/funcs/deploymentsStream.ts +186 -0
  78. package/packages/orq-rc/src/funcs/evalsAll.ts +173 -0
  79. package/packages/orq-rc/src/funcs/evalsCreate.ts +169 -0
  80. package/packages/orq-rc/src/funcs/evalsDelete.ts +172 -0
  81. package/packages/orq-rc/src/funcs/evalsInvoke.ts +180 -0
  82. package/packages/orq-rc/src/funcs/evalsUpdate.ts +172 -0
  83. package/packages/orq-rc/src/funcs/evaluatorsGetV2EvaluatorsIdVersions.ts +182 -0
  84. package/packages/orq-rc/src/funcs/filesCreate.ts +194 -0
  85. package/packages/orq-rc/src/funcs/filesDelete.ts +163 -0
  86. package/packages/orq-rc/src/funcs/filesGet.ts +165 -0
  87. package/packages/orq-rc/src/funcs/filesGetContent.ts +166 -0
  88. package/packages/orq-rc/src/funcs/filesList.ts +167 -0
  89. package/packages/orq-rc/src/funcs/filesUpdate.ts +166 -0
  90. package/packages/orq-rc/src/funcs/getV2HumanEvals.ts +169 -0
  91. package/packages/orq-rc/src/funcs/getV2HumanEvalsId.ts +168 -0
  92. package/packages/orq-rc/src/funcs/humanReviewSetsDeleteV2HumanEvalSetsId.ts +164 -0
  93. package/packages/orq-rc/src/funcs/humanReviewSetsGetV2HumanEvalSets.ts +168 -0
  94. package/packages/orq-rc/src/funcs/humanReviewSetsGetV2HumanEvalSetsId.ts +163 -0
  95. package/packages/orq-rc/src/funcs/humanReviewSetsPatchV2HumanEvalSetsId.ts +164 -0
  96. package/packages/orq-rc/src/funcs/humanReviewSetsPostV2HumanEvalSets.ts +162 -0
  97. package/packages/orq-rc/src/funcs/identitiesCreate.ts +165 -0
  98. package/packages/orq-rc/src/funcs/identitiesDelete.ts +175 -0
  99. package/packages/orq-rc/src/funcs/identitiesList.ts +170 -0
  100. package/packages/orq-rc/src/funcs/identitiesRetrieve.ts +183 -0
  101. package/packages/orq-rc/src/funcs/identitiesUpdate.ts +175 -0
  102. package/packages/orq-rc/src/funcs/knowledgeCreate.ts +158 -0
  103. package/packages/orq-rc/src/funcs/knowledgeCreateChunks.ts +170 -0
  104. package/packages/orq-rc/src/funcs/knowledgeCreateDatasource.ts +165 -0
  105. package/packages/orq-rc/src/funcs/knowledgeDelete.ts +166 -0
  106. package/packages/orq-rc/src/funcs/knowledgeDeleteChunk.ts +173 -0
  107. package/packages/orq-rc/src/funcs/knowledgeDeleteChunks.ts +169 -0
  108. package/packages/orq-rc/src/funcs/knowledgeDeleteDatasource.ts +172 -0
  109. package/packages/orq-rc/src/funcs/knowledgeGetChunksCount.ts +169 -0
  110. package/packages/orq-rc/src/funcs/knowledgeList.ts +169 -0
  111. package/packages/orq-rc/src/funcs/knowledgeListChunks.ts +177 -0
  112. package/packages/orq-rc/src/funcs/knowledgeListChunksPaginated.ts +170 -0
  113. package/packages/orq-rc/src/funcs/knowledgeListDatasources.ts +173 -0
  114. package/packages/orq-rc/src/funcs/knowledgeRetrieve.ts +165 -0
  115. package/packages/orq-rc/src/funcs/knowledgeRetrieveChunk.ts +172 -0
  116. package/packages/orq-rc/src/funcs/knowledgeRetrieveDatasource.ts +168 -0
  117. package/packages/orq-rc/src/funcs/knowledgeSearch.ts +166 -0
  118. package/packages/orq-rc/src/funcs/knowledgeUpdate.ts +163 -0
  119. package/packages/orq-rc/src/funcs/knowledgeUpdateChunk.ts +173 -0
  120. package/packages/orq-rc/src/funcs/knowledgeUpdateDatasource.ts +169 -0
  121. package/packages/orq-rc/src/funcs/memoryStoresCreate.ts +162 -0
  122. package/packages/orq-rc/src/funcs/memoryStoresCreateDocument.ts +175 -0
  123. package/packages/orq-rc/src/funcs/memoryStoresCreateMemory.ts +169 -0
  124. package/packages/orq-rc/src/funcs/memoryStoresDelete.ts +167 -0
  125. package/packages/orq-rc/src/funcs/memoryStoresDeleteDocument.ts +184 -0
  126. package/packages/orq-rc/src/funcs/memoryStoresDeleteMemory.ts +179 -0
  127. package/packages/orq-rc/src/funcs/memoryStoresList.ts +178 -0
  128. package/packages/orq-rc/src/funcs/memoryStoresListDocuments.ts +183 -0
  129. package/packages/orq-rc/src/funcs/memoryStoresListMemories.ts +176 -0
  130. package/packages/orq-rc/src/funcs/memoryStoresRetrieve.ts +176 -0
  131. package/packages/orq-rc/src/funcs/memoryStoresRetrieveDocument.ts +178 -0
  132. package/packages/orq-rc/src/funcs/memoryStoresRetrieveMemory.ts +173 -0
  133. package/packages/orq-rc/src/funcs/memoryStoresUpdate.ts +167 -0
  134. package/packages/orq-rc/src/funcs/memoryStoresUpdateDocument.ts +179 -0
  135. package/packages/orq-rc/src/funcs/memoryStoresUpdateMemory.ts +174 -0
  136. package/packages/orq-rc/src/funcs/modelsList.ts +165 -0
  137. package/packages/orq-rc/src/funcs/patchV2HumanEvalsId.ts +170 -0
  138. package/packages/orq-rc/src/funcs/postV2Feedback.ts +172 -0
  139. package/packages/orq-rc/src/funcs/postV2FeedbackEvaluation.ts +159 -0
  140. package/packages/orq-rc/src/funcs/postV2FeedbackEvaluationRemove.ts +159 -0
  141. package/packages/orq-rc/src/funcs/postV2FeedbackRemove.ts +167 -0
  142. package/packages/orq-rc/src/funcs/postV2HumanEvals.ts +168 -0
  143. package/packages/orq-rc/src/funcs/promptsCreate.ts +160 -0
  144. package/packages/orq-rc/src/funcs/promptsDelete.ts +172 -0
  145. package/packages/orq-rc/src/funcs/promptsGetVersion.ts +180 -0
  146. package/packages/orq-rc/src/funcs/promptsList.ts +167 -0
  147. package/packages/orq-rc/src/funcs/promptsListVersions.ts +172 -0
  148. package/packages/orq-rc/src/funcs/promptsRetrieve.ts +165 -0
  149. package/packages/orq-rc/src/funcs/promptsUpdate.ts +172 -0
  150. package/packages/orq-rc/src/funcs/remoteconfigsRetrieve.ts +161 -0
  151. package/packages/orq-rc/src/funcs/routerAudioSpeechCreate.ts +161 -0
  152. package/packages/orq-rc/src/funcs/routerAudioTranscriptionsCreate.ts +269 -0
  153. package/packages/orq-rc/src/funcs/routerAudioTranslationsCreate.ts +259 -0
  154. package/packages/orq-rc/src/funcs/routerChatCompletionsCreate.ts +168 -0
  155. package/packages/orq-rc/src/funcs/routerCompletionsCreate.ts +168 -0
  156. package/packages/orq-rc/src/funcs/routerEmbeddingsCreate.ts +161 -0
  157. package/packages/orq-rc/src/funcs/routerImagesEditsCreate.ts +222 -0
  158. package/packages/orq-rc/src/funcs/routerImagesGenerationsCreate.ts +160 -0
  159. package/packages/orq-rc/src/funcs/routerImagesVariationsCreate.ts +218 -0
  160. package/packages/orq-rc/src/funcs/routerModerationsCreate.ts +167 -0
  161. package/packages/orq-rc/src/funcs/routerOcr.ts +158 -0
  162. package/packages/orq-rc/src/funcs/routerRerankCreate.ts +160 -0
  163. package/packages/orq-rc/src/funcs/routerResponsesCreate.ts +167 -0
  164. package/packages/orq-rc/src/funcs/toolsCreate.ts +163 -0
  165. package/packages/orq-rc/src/funcs/toolsDelete.ts +166 -0
  166. package/packages/orq-rc/src/funcs/toolsGetV2ToolsToolIdVersions.ts +182 -0
  167. package/packages/orq-rc/src/funcs/toolsGetV2ToolsToolIdVersionsVersionId.ts +189 -0
  168. package/packages/orq-rc/src/funcs/toolsList.ts +176 -0
  169. package/packages/orq-rc/src/funcs/toolsRetrieve.ts +165 -0
  170. package/packages/orq-rc/src/funcs/toolsUpdate.ts +175 -0
  171. package/packages/orq-rc/src/hooks/global.ts +44 -0
  172. package/packages/orq-rc/src/hooks/hooks.ts +132 -0
  173. package/packages/orq-rc/src/hooks/index.ts +6 -0
  174. package/packages/orq-rc/src/hooks/registration.ts +15 -0
  175. package/packages/orq-rc/src/hooks/types.ts +112 -0
  176. package/packages/orq-rc/src/index.ts +9 -0
  177. package/packages/orq-rc/src/lib/base64.ts +37 -0
  178. package/packages/orq-rc/src/lib/config.ts +74 -0
  179. package/packages/orq-rc/src/lib/dlv.ts +53 -0
  180. package/packages/orq-rc/src/lib/encodings.ts +516 -0
  181. package/packages/orq-rc/src/lib/env.ts +89 -0
  182. package/packages/orq-rc/src/lib/event-streams.ts +165 -0
  183. package/packages/orq-rc/src/lib/files.ts +104 -0
  184. package/packages/orq-rc/src/lib/http.ts +323 -0
  185. package/packages/orq-rc/src/lib/is-plain-object.ts +43 -0
  186. package/packages/orq-rc/src/lib/logger.ts +9 -0
  187. package/packages/orq-rc/src/lib/matchers.ts +346 -0
  188. package/packages/orq-rc/src/lib/primitives.ts +150 -0
  189. package/packages/orq-rc/src/lib/retries.ts +218 -0
  190. package/packages/orq-rc/src/lib/schemas.ts +91 -0
  191. package/packages/orq-rc/src/lib/sdks.ts +409 -0
  192. package/packages/orq-rc/src/lib/security.ts +275 -0
  193. package/packages/orq-rc/src/lib/url.ts +35 -0
  194. package/packages/orq-rc/src/models/components/actionreviewedstreamingevent.ts +99 -0
  195. package/packages/orq-rc/src/models/components/actionreviewrequestedstreamingevent.ts +185 -0
  196. package/packages/orq-rc/src/models/components/agenterroredstreamingevent.ts +73 -0
  197. package/packages/orq-rc/src/models/components/agentexecutionstartedstreamingevent.ts +91 -0
  198. package/packages/orq-rc/src/models/components/agenthandedoffstreamingevent.ts +71 -0
  199. package/packages/orq-rc/src/models/components/agentinactivestreamingevent.ts +507 -0
  200. package/packages/orq-rc/src/models/components/agentmessagecreatedstreamingevent.ts +165 -0
  201. package/packages/orq-rc/src/models/components/agentresponsemessage.ts +103 -0
  202. package/packages/orq-rc/src/models/components/agentstartedstreamingevent.ts +517 -0
  203. package/packages/orq-rc/src/models/components/agentthoughtstreamingevent.ts +807 -0
  204. package/packages/orq-rc/src/models/components/audiocontentpartschema.ts +136 -0
  205. package/packages/orq-rc/src/models/components/createagentresponse.ts +305 -0
  206. package/packages/orq-rc/src/models/components/datapart.ts +38 -0
  207. package/packages/orq-rc/src/models/components/errorpart.ts +58 -0
  208. package/packages/orq-rc/src/models/components/errorstreamingevent.ts +66 -0
  209. package/packages/orq-rc/src/models/components/executionnamedstreamingevent.ts +71 -0
  210. package/packages/orq-rc/src/models/components/executionreviewedstreamingevent.ts +61 -0
  211. package/packages/orq-rc/src/models/components/executionreviewrequiredstreamingevent.ts +67 -0
  212. package/packages/orq-rc/src/models/components/extendedmessage.ts +146 -0
  213. package/packages/orq-rc/src/models/components/filecontentpartschema.ts +87 -0
  214. package/packages/orq-rc/src/models/components/filedocument.ts +48 -0
  215. package/packages/orq-rc/src/models/components/filepart.ts +218 -0
  216. package/packages/orq-rc/src/models/components/getagentresponse.ts +348 -0
  217. package/packages/orq-rc/src/models/components/imagecontentpartschema.ts +268 -0
  218. package/packages/orq-rc/src/models/components/index.ts +61 -0
  219. package/packages/orq-rc/src/models/components/invokedeploymentrequest.ts +3450 -0
  220. package/packages/orq-rc/src/models/components/partdelta.ts +39 -0
  221. package/packages/orq-rc/src/models/components/partdeltaevent.ts +73 -0
  222. package/packages/orq-rc/src/models/components/partdoneevent.ts +70 -0
  223. package/packages/orq-rc/src/models/components/publiccontact.ts +71 -0
  224. package/packages/orq-rc/src/models/components/publicidentity.ts +69 -0
  225. package/packages/orq-rc/src/models/components/reasoningpart.ts +62 -0
  226. package/packages/orq-rc/src/models/components/reasoningpartschema.ts +71 -0
  227. package/packages/orq-rc/src/models/components/redactedreasoningpartschema.ts +66 -0
  228. package/packages/orq-rc/src/models/components/refusalpartschema.ts +64 -0
  229. package/packages/orq-rc/src/models/components/responsedoneevent.ts +324 -0
  230. package/packages/orq-rc/src/models/components/responsefailedevent.ts +72 -0
  231. package/packages/orq-rc/src/models/components/responsestartedevent.ts +97 -0
  232. package/packages/orq-rc/src/models/components/responsestreamingevent.ts +85 -0
  233. package/packages/orq-rc/src/models/components/reviewoutcome.ts +23 -0
  234. package/packages/orq-rc/src/models/components/security.ts +32 -0
  235. package/packages/orq-rc/src/models/components/telemetry.ts +48 -0
  236. package/packages/orq-rc/src/models/components/textcontentpartschema.ts +207 -0
  237. package/packages/orq-rc/src/models/components/textpart.ts +54 -0
  238. package/packages/orq-rc/src/models/components/thinkingconfigadaptiveschema.ts +59 -0
  239. package/packages/orq-rc/src/models/components/thinkingconfigdisabledschema.ts +59 -0
  240. package/packages/orq-rc/src/models/components/thinkingconfigenabledschema.ts +106 -0
  241. package/packages/orq-rc/src/models/components/timeoutstreamingevent.ts +64 -0
  242. package/packages/orq-rc/src/models/components/toolcallpart.ts +51 -0
  243. package/packages/orq-rc/src/models/components/tooldoneevent.ts +77 -0
  244. package/packages/orq-rc/src/models/components/toolexecutionfailedstreamingevent.ts +235 -0
  245. package/packages/orq-rc/src/models/components/toolexecutionfinishedstreamingevent.ts +219 -0
  246. package/packages/orq-rc/src/models/components/toolexecutionstartedstreamingevent.ts +205 -0
  247. package/packages/orq-rc/src/models/components/toolfailedevent.ts +77 -0
  248. package/packages/orq-rc/src/models/components/toolresultpart.ts +71 -0
  249. package/packages/orq-rc/src/models/components/toolreviewdoneevent.ts +78 -0
  250. package/packages/orq-rc/src/models/components/toolreviewrequestedevent.ts +87 -0
  251. package/packages/orq-rc/src/models/components/toolstartedevent.ts +82 -0
  252. package/packages/orq-rc/src/models/errors/apierror.ts +40 -0
  253. package/packages/orq-rc/src/models/errors/createeval.ts +51 -0
  254. package/packages/orq-rc/src/models/errors/createmoderation.ts +84 -0
  255. package/packages/orq-rc/src/models/errors/createtranscription.ts +87 -0
  256. package/packages/orq-rc/src/models/errors/createtranslation.ts +87 -0
  257. package/packages/orq-rc/src/models/errors/deleteagent.ts +51 -0
  258. package/packages/orq-rc/src/models/errors/deleteeval.ts +51 -0
  259. package/packages/orq-rc/src/models/errors/deleteidentity.ts +62 -0
  260. package/packages/orq-rc/src/models/errors/deleteprompt.ts +51 -0
  261. package/packages/orq-rc/src/models/errors/deletev2humanevalsid.ts +51 -0
  262. package/packages/orq-rc/src/models/errors/getevals.ts +51 -0
  263. package/packages/orq-rc/src/models/errors/getpromptversion.ts +51 -0
  264. package/packages/orq-rc/src/models/errors/getv2evaluatorsidversions.ts +51 -0
  265. package/packages/orq-rc/src/models/errors/getv2humanevals.ts +51 -0
  266. package/packages/orq-rc/src/models/errors/getv2humanevalsid.ts +51 -0
  267. package/packages/orq-rc/src/models/errors/getv2toolstoolidversions.ts +51 -0
  268. package/packages/orq-rc/src/models/errors/getv2toolstoolidversionsversionid.ts +52 -0
  269. package/packages/orq-rc/src/models/errors/honoapierror.ts +59 -0
  270. package/packages/orq-rc/src/models/errors/httpclienterrors.ts +62 -0
  271. package/packages/orq-rc/src/models/errors/index.ts +42 -0
  272. package/packages/orq-rc/src/models/errors/invokeeval.ts +141 -0
  273. package/packages/orq-rc/src/models/errors/orqerror.ts +35 -0
  274. package/packages/orq-rc/src/models/errors/patchv2humanevalsid.ts +51 -0
  275. package/packages/orq-rc/src/models/errors/postv2agentsa2a.ts +96 -0
  276. package/packages/orq-rc/src/models/errors/postv2agentskeycardrefresh.ts +97 -0
  277. package/packages/orq-rc/src/models/errors/postv2feedback.ts +96 -0
  278. package/packages/orq-rc/src/models/errors/postv2feedbackremove.ts +51 -0
  279. package/packages/orq-rc/src/models/errors/postv2humanevals.ts +51 -0
  280. package/packages/orq-rc/src/models/errors/responsevalidationerror.ts +50 -0
  281. package/packages/orq-rc/src/models/errors/retrieveagentrequest.ts +51 -0
  282. package/packages/orq-rc/src/models/errors/retrieveidentity.ts +118 -0
  283. package/packages/orq-rc/src/models/errors/sdkvalidationerror.ts +109 -0
  284. package/packages/orq-rc/src/models/errors/streamagent.ts +51 -0
  285. package/packages/orq-rc/src/models/errors/streamrunagent.ts +51 -0
  286. package/packages/orq-rc/src/models/errors/updateagent.ts +51 -0
  287. package/packages/orq-rc/src/models/errors/updateeval.ts +51 -0
  288. package/packages/orq-rc/src/models/errors/updateidentity.ts +54 -0
  289. package/packages/orq-rc/src/models/errors/updateprompt.ts +51 -0
  290. package/packages/orq-rc/src/models/errors/updatetool.ts +62 -0
  291. package/packages/orq-rc/src/models/operations/cleardataset.ts +39 -0
  292. package/packages/orq-rc/src/models/operations/createagentrequest.ts +6459 -0
  293. package/packages/orq-rc/src/models/operations/createagentresponserequest.ts +670 -0
  294. package/packages/orq-rc/src/models/operations/createannotation.ts +166 -0
  295. package/packages/orq-rc/src/models/operations/createchatcompletion.ts +6398 -0
  296. package/packages/orq-rc/src/models/operations/createchunk.ts +222 -0
  297. package/packages/orq-rc/src/models/operations/createcompletion.ts +3473 -0
  298. package/packages/orq-rc/src/models/operations/createcontact.ts +156 -0
  299. package/packages/orq-rc/src/models/operations/createdataset.ts +162 -0
  300. package/packages/orq-rc/src/models/operations/createdatasetitem.ts +2554 -0
  301. package/packages/orq-rc/src/models/operations/createdatasource.ts +437 -0
  302. package/packages/orq-rc/src/models/operations/createembedding.ts +947 -0
  303. package/packages/orq-rc/src/models/operations/createeval.ts +4229 -0
  304. package/packages/orq-rc/src/models/operations/createidentity.ts +162 -0
  305. package/packages/orq-rc/src/models/operations/createimage.ts +1034 -0
  306. package/packages/orq-rc/src/models/operations/createimageedit.ts +1045 -0
  307. package/packages/orq-rc/src/models/operations/createimagevariation.ts +1067 -0
  308. package/packages/orq-rc/src/models/operations/createknowledge.ts +960 -0
  309. package/packages/orq-rc/src/models/operations/creatememory.ts +142 -0
  310. package/packages/orq-rc/src/models/operations/creatememorydocument.ts +152 -0
  311. package/packages/orq-rc/src/models/operations/creatememorystore.ts +199 -0
  312. package/packages/orq-rc/src/models/operations/createmoderation.ts +664 -0
  313. package/packages/orq-rc/src/models/operations/createprompt.ts +5405 -0
  314. package/packages/orq-rc/src/models/operations/creatererank.ts +890 -0
  315. package/packages/orq-rc/src/models/operations/createresponse.ts +3864 -0
  316. package/packages/orq-rc/src/models/operations/createspeech.ts +700 -0
  317. package/packages/orq-rc/src/models/operations/createtool.ts +2509 -0
  318. package/packages/orq-rc/src/models/operations/createtranscription.ts +955 -0
  319. package/packages/orq-rc/src/models/operations/createtranslation.ts +930 -0
  320. package/packages/orq-rc/src/models/operations/deleteagent.ts +39 -0
  321. package/packages/orq-rc/src/models/operations/deleteannotation.ts +82 -0
  322. package/packages/orq-rc/src/models/operations/deletechunk.ts +53 -0
  323. package/packages/orq-rc/src/models/operations/deletechunks.ts +125 -0
  324. package/packages/orq-rc/src/models/operations/deletedatapoint.ts +46 -0
  325. package/packages/orq-rc/src/models/operations/deletedataset.ts +39 -0
  326. package/packages/orq-rc/src/models/operations/deletedatasource.ts +46 -0
  327. package/packages/orq-rc/src/models/operations/deleteeval.ts +31 -0
  328. package/packages/orq-rc/src/models/operations/deleteidentity.ts +34 -0
  329. package/packages/orq-rc/src/models/operations/deleteknowledge.ts +39 -0
  330. package/packages/orq-rc/src/models/operations/deletememory.ts +46 -0
  331. package/packages/orq-rc/src/models/operations/deletememorydocument.ts +55 -0
  332. package/packages/orq-rc/src/models/operations/deletememorystore.ts +39 -0
  333. package/packages/orq-rc/src/models/operations/deleteprompt.ts +34 -0
  334. package/packages/orq-rc/src/models/operations/deletetool.ts +36 -0
  335. package/packages/orq-rc/src/models/operations/deletev2humanevalsetsid.ts +36 -0
  336. package/packages/orq-rc/src/models/operations/deletev2humanevalsid.ts +67 -0
  337. package/packages/orq-rc/src/models/operations/deploymentcreatemetric.ts +2370 -0
  338. package/packages/orq-rc/src/models/operations/deploymentgetconfig.ts +4526 -0
  339. package/packages/orq-rc/src/models/operations/deploymentinvoke.ts +735 -0
  340. package/packages/orq-rc/src/models/operations/deployments.ts +1273 -0
  341. package/packages/orq-rc/src/models/operations/deploymentstream.ts +4659 -0
  342. package/packages/orq-rc/src/models/operations/filecontent.ts +39 -0
  343. package/packages/orq-rc/src/models/operations/filedelete.ts +39 -0
  344. package/packages/orq-rc/src/models/operations/fileget.ts +80 -0
  345. package/packages/orq-rc/src/models/operations/filelist.ts +85 -0
  346. package/packages/orq-rc/src/models/operations/fileupdate.ts +118 -0
  347. package/packages/orq-rc/src/models/operations/fileupload.ts +135 -0
  348. package/packages/orq-rc/src/models/operations/getagentresponse.ts +46 -0
  349. package/packages/orq-rc/src/models/operations/getallmemories.ts +173 -0
  350. package/packages/orq-rc/src/models/operations/getallmemorydocuments.ts +188 -0
  351. package/packages/orq-rc/src/models/operations/getallmemorystores.ts +200 -0
  352. package/packages/orq-rc/src/models/operations/getallprompts.ts +3173 -0
  353. package/packages/orq-rc/src/models/operations/getalltools.ts +1404 -0
  354. package/packages/orq-rc/src/models/operations/getchunkscount.ts +121 -0
  355. package/packages/orq-rc/src/models/operations/getevals.ts +2868 -0
  356. package/packages/orq-rc/src/models/operations/getonechunk.ts +171 -0
  357. package/packages/orq-rc/src/models/operations/getoneknowledge.ts +652 -0
  358. package/packages/orq-rc/src/models/operations/getoneprompt.ts +3098 -0
  359. package/packages/orq-rc/src/models/operations/getpromptversion.ts +3143 -0
  360. package/packages/orq-rc/src/models/operations/getv2evaluatorsidversions.ts +162 -0
  361. package/packages/orq-rc/src/models/operations/getv2humanevals.ts +696 -0
  362. package/packages/orq-rc/src/models/operations/getv2humanevalsets.ts +234 -0
  363. package/packages/orq-rc/src/models/operations/getv2humanevalsetsid.ts +235 -0
  364. package/packages/orq-rc/src/models/operations/getv2humanevalsid.ts +707 -0
  365. package/packages/orq-rc/src/models/operations/getv2toolstoolidversions.ts +163 -0
  366. package/packages/orq-rc/src/models/operations/getv2toolstoolidversionsversionid.ts +110 -0
  367. package/packages/orq-rc/src/models/operations/index.ts +131 -0
  368. package/packages/orq-rc/src/models/operations/invokeagent.ts +801 -0
  369. package/packages/orq-rc/src/models/operations/invokeeval.ts +1254 -0
  370. package/packages/orq-rc/src/models/operations/listagents.ts +2781 -0
  371. package/packages/orq-rc/src/models/operations/listchunks.ts +260 -0
  372. package/packages/orq-rc/src/models/operations/listchunkspaginated.ts +263 -0
  373. package/packages/orq-rc/src/models/operations/listdatasetdatapoints.ts +1498 -0
  374. package/packages/orq-rc/src/models/operations/listdatasets.ts +205 -0
  375. package/packages/orq-rc/src/models/operations/listdatasources.ts +235 -0
  376. package/packages/orq-rc/src/models/operations/listidentities.ts +275 -0
  377. package/packages/orq-rc/src/models/operations/listknowledgebases.ts +642 -0
  378. package/packages/orq-rc/src/models/operations/listmodels.ts +169 -0
  379. package/packages/orq-rc/src/models/operations/listpromptversions.ts +3218 -0
  380. package/packages/orq-rc/src/models/operations/parse.ts +784 -0
  381. package/packages/orq-rc/src/models/operations/patchv2humanevalsetsid.ts +415 -0
  382. package/packages/orq-rc/src/models/operations/patchv2humanevalsid.ts +1362 -0
  383. package/packages/orq-rc/src/models/operations/postv2agentsa2a.ts +255 -0
  384. package/packages/orq-rc/src/models/operations/postv2agentskeycardrefresh.ts +100 -0
  385. package/packages/orq-rc/src/models/operations/postv2feedback.ts +207 -0
  386. package/packages/orq-rc/src/models/operations/postv2feedbackevaluation.ts +321 -0
  387. package/packages/orq-rc/src/models/operations/postv2feedbackevaluationremove.ts +43 -0
  388. package/packages/orq-rc/src/models/operations/postv2feedbackremove.ts +138 -0
  389. package/packages/orq-rc/src/models/operations/postv2humanevals.ts +1193 -0
  390. package/packages/orq-rc/src/models/operations/postv2humanevalsets.ts +365 -0
  391. package/packages/orq-rc/src/models/operations/postv2routerocr.ts +478 -0
  392. package/packages/orq-rc/src/models/operations/remoteconfigsgetconfig.ts +108 -0
  393. package/packages/orq-rc/src/models/operations/retrieveagentrequest.ts +2843 -0
  394. package/packages/orq-rc/src/models/operations/retrievedatapoint.ts +1402 -0
  395. package/packages/orq-rc/src/models/operations/retrievedataset.ts +150 -0
  396. package/packages/orq-rc/src/models/operations/retrievedatasource.ts +152 -0
  397. package/packages/orq-rc/src/models/operations/retrieveidentity.ts +174 -0
  398. package/packages/orq-rc/src/models/operations/retrievememory.ts +112 -0
  399. package/packages/orq-rc/src/models/operations/retrievememorydocument.ts +118 -0
  400. package/packages/orq-rc/src/models/operations/retrievememorystore.ts +144 -0
  401. package/packages/orq-rc/src/models/operations/retrievetool.ts +1385 -0
  402. package/packages/orq-rc/src/models/operations/runagent.ts +4963 -0
  403. package/packages/orq-rc/src/models/operations/searchknowledge.ts +1762 -0
  404. package/packages/orq-rc/src/models/operations/streamagent.ts +692 -0
  405. package/packages/orq-rc/src/models/operations/streamrunagent.ts +5125 -0
  406. package/packages/orq-rc/src/models/operations/updateagent.ts +6889 -0
  407. package/packages/orq-rc/src/models/operations/updatechunk.ts +236 -0
  408. package/packages/orq-rc/src/models/operations/updatedatapoint.ts +2555 -0
  409. package/packages/orq-rc/src/models/operations/updatedataset.ts +206 -0
  410. package/packages/orq-rc/src/models/operations/updatedatasource.ts +186 -0
  411. package/packages/orq-rc/src/models/operations/updateeval.ts +3160 -0
  412. package/packages/orq-rc/src/models/operations/updateidentity.ts +189 -0
  413. package/packages/orq-rc/src/models/operations/updateknowledge.ts +1231 -0
  414. package/packages/orq-rc/src/models/operations/updatememory.ts +142 -0
  415. package/packages/orq-rc/src/models/operations/updatememorydocument.ts +159 -0
  416. package/packages/orq-rc/src/models/operations/updatememorystore.ts +188 -0
  417. package/packages/orq-rc/src/models/operations/updateprompt.ts +5487 -0
  418. package/packages/orq-rc/src/models/operations/updatetool.ts +2816 -0
  419. package/packages/orq-rc/src/sdk/agents.ts +234 -0
  420. package/packages/orq-rc/src/sdk/annotations.ts +39 -0
  421. package/packages/orq-rc/src/sdk/audio.ts +25 -0
  422. package/packages/orq-rc/src/sdk/chat.ts +13 -0
  423. package/packages/orq-rc/src/sdk/chunking.ts +27 -0
  424. package/packages/orq-rc/src/sdk/completions.ts +32 -0
  425. package/packages/orq-rc/src/sdk/contacts.ts +27 -0
  426. package/packages/orq-rc/src/sdk/datasets.ts +204 -0
  427. package/packages/orq-rc/src/sdk/deployments.ts +89 -0
  428. package/packages/orq-rc/src/sdk/edits.ts +27 -0
  429. package/packages/orq-rc/src/sdk/embeddings.ts +27 -0
  430. package/packages/orq-rc/src/sdk/evals.ts +84 -0
  431. package/packages/orq-rc/src/sdk/evaluators.ts +27 -0
  432. package/packages/orq-rc/src/sdk/files.ts +114 -0
  433. package/packages/orq-rc/src/sdk/generations.ts +27 -0
  434. package/packages/orq-rc/src/sdk/humanreviewsets.ts +84 -0
  435. package/packages/orq-rc/src/sdk/identities.ts +99 -0
  436. package/packages/orq-rc/src/sdk/images.ts +25 -0
  437. package/packages/orq-rc/src/sdk/index.ts +5 -0
  438. package/packages/orq-rc/src/sdk/knowledge.ts +309 -0
  439. package/packages/orq-rc/src/sdk/memorystores.ts +286 -0
  440. package/packages/orq-rc/src/sdk/metrics.ts +29 -0
  441. package/packages/orq-rc/src/sdk/models.ts +27 -0
  442. package/packages/orq-rc/src/sdk/moderations.ts +24 -0
  443. package/packages/orq-rc/src/sdk/orqcompletions.ts +32 -0
  444. package/packages/orq-rc/src/sdk/orqresponses.ts +32 -0
  445. package/packages/orq-rc/src/sdk/prompts.ts +126 -0
  446. package/packages/orq-rc/src/sdk/remoteconfigs.ts +24 -0
  447. package/packages/orq-rc/src/sdk/rerank.ts +27 -0
  448. package/packages/orq-rc/src/sdk/responses.ts +53 -0
  449. package/packages/orq-rc/src/sdk/router.ts +72 -0
  450. package/packages/orq-rc/src/sdk/sdk.ts +225 -0
  451. package/packages/orq-rc/src/sdk/speech.ts +27 -0
  452. package/packages/orq-rc/src/sdk/tools.ts +135 -0
  453. package/packages/orq-rc/src/sdk/transcriptions.ts +24 -0
  454. package/packages/orq-rc/src/sdk/translations.ts +24 -0
  455. package/packages/orq-rc/src/sdk/variations.ts +27 -0
  456. package/packages/orq-rc/src/types/async.ts +68 -0
  457. package/packages/orq-rc/src/types/blobs.ts +32 -0
  458. package/packages/orq-rc/src/types/constdatetime.ts +15 -0
  459. package/packages/orq-rc/src/types/enums.ts +45 -0
  460. package/packages/orq-rc/src/types/fp.ts +50 -0
  461. package/packages/orq-rc/src/types/index.ts +11 -0
  462. package/packages/orq-rc/src/types/operations.ts +105 -0
  463. package/packages/orq-rc/src/types/rfcdate.ts +54 -0
  464. package/packages/orq-rc/src/types/streams.ts +21 -0
  465. package/packages/orq-rc/src/types/unrecognized.ts +35 -0
  466. package/src/lib/config.ts +2 -2
  467. package/src/models/components/reasoningpart.ts +1 -1
  468. package/src/models/operations/createcontact.ts +1 -1
  469. package/src/models/operations/createdataset.ts +1 -1
  470. package/src/models/operations/createdatasetitem.ts +4 -4
  471. package/src/models/operations/createdatasource.ts +1 -1
  472. package/src/models/operations/createeval.ts +16 -16
  473. package/src/models/operations/createidentity.ts +1 -1
  474. package/src/models/operations/createtool.ts +6 -6
  475. package/src/models/operations/getalltools.ts +6 -6
  476. package/src/models/operations/getevals.ts +16 -16
  477. package/src/models/operations/getv2humanevals.ts +6 -6
  478. package/src/models/operations/getv2humanevalsets.ts +2 -2
  479. package/src/models/operations/getv2humanevalsetsid.ts +2 -2
  480. package/src/models/operations/getv2humanevalsid.ts +6 -6
  481. package/src/models/operations/listdatasetdatapoints.ts +4 -4
  482. package/src/models/operations/listdatasets.ts +1 -1
  483. package/src/models/operations/listdatasources.ts +1 -1
  484. package/src/models/operations/listidentities.ts +1 -1
  485. package/src/models/operations/patchv2humanevalsetsid.ts +2 -2
  486. package/src/models/operations/patchv2humanevalsid.ts +12 -12
  487. package/src/models/operations/postv2feedbackevaluation.ts +3 -3
  488. package/src/models/operations/postv2humanevals.ts +12 -12
  489. package/src/models/operations/postv2humanevalsets.ts +2 -2
  490. package/src/models/operations/retrievedatapoint.ts +4 -4
  491. package/src/models/operations/retrievedataset.ts +1 -1
  492. package/src/models/operations/retrievedatasource.ts +1 -1
  493. package/src/models/operations/retrieveidentity.ts +1 -1
  494. package/src/models/operations/retrievetool.ts +6 -6
  495. package/src/models/operations/runagent.ts +1 -1
  496. package/src/models/operations/streamrunagent.ts +1 -1
  497. package/src/models/operations/updatedatapoint.ts +4 -4
  498. package/src/models/operations/updatedataset.ts +1 -1
  499. package/src/models/operations/updatedatasource.ts +1 -1
  500. package/src/models/operations/updateeval.ts +16 -16
  501. package/src/models/operations/updateidentity.ts +1 -1
  502. package/src/models/operations/updatetool.ts +7 -7
@@ -0,0 +1,784 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod/v3";
6
+ import { remap as remap$ } from "../../lib/primitives.js";
7
+ import { safeParse } from "../../lib/schemas.js";
8
+ import { ClosedEnum } from "../../types/enums.js";
9
+ import { Result as SafeParseResult } from "../../types/fp.js";
10
+ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
11
+
12
+ /**
13
+ * Return format: chunks (with metadata) or texts (plain strings)
14
+ */
15
+ export const ParseChunkingRequestChunkingRequestRequestBodyReturnType = {
16
+ Chunks: "chunks",
17
+ Texts: "texts",
18
+ } as const;
19
+ /**
20
+ * Return format: chunks (with metadata) or texts (plain strings)
21
+ */
22
+ export type ParseChunkingRequestChunkingRequestRequestBodyReturnType =
23
+ ClosedEnum<typeof ParseChunkingRequestChunkingRequestRequestBodyReturnType>;
24
+
25
+ /**
26
+ * High-performance SIMD-optimized byte-level chunking. Best for large files (>1MB) where speed and memory efficiency are critical. 2x faster and 3x less memory than token-based chunking.
27
+ */
28
+ export type FastChunkerStrategy = {
29
+ /**
30
+ * The text content to be chunked
31
+ */
32
+ text: string;
33
+ /**
34
+ * Whether to include metadata for each chunk
35
+ */
36
+ metadata?: boolean | undefined;
37
+ /**
38
+ * Return format: chunks (with metadata) or texts (plain strings)
39
+ */
40
+ returnType?:
41
+ | ParseChunkingRequestChunkingRequestRequestBodyReturnType
42
+ | undefined;
43
+ strategy: "fast";
44
+ /**
45
+ * Target chunk size in bytes
46
+ */
47
+ targetSize?: number | undefined;
48
+ /**
49
+ * Single-byte delimiter characters. Each character is treated as a separate delimiter (e.g., ".?!" splits on period, question mark, or exclamation). Use escaped sequences for special chars.
50
+ */
51
+ delimiters?: string | undefined;
52
+ /**
53
+ * Multi-byte pattern for splitting (e.g., "▁" for SentencePiece tokenizers). Takes precedence over delimiters if set.
54
+ */
55
+ pattern?: string | undefined;
56
+ /**
57
+ * Attach delimiter to start of next chunk instead of end of current chunk
58
+ */
59
+ prefix?: boolean | undefined;
60
+ /**
61
+ * When true, splits at the START of consecutive delimiter runs, keeping the run with the following chunk (e.g., splits before "\n\n\n" not in the middle)
62
+ */
63
+ consecutive?: boolean | undefined;
64
+ /**
65
+ * Search forward if no delimiter found in backward search window
66
+ */
67
+ forwardFallback?: boolean | undefined;
68
+ };
69
+
70
+ /**
71
+ * Return format: chunks (with metadata) or texts (plain strings)
72
+ */
73
+ export const ParseChunkingRequestChunkingRequestReturnType = {
74
+ Chunks: "chunks",
75
+ Texts: "texts",
76
+ } as const;
77
+ /**
78
+ * Return format: chunks (with metadata) or texts (plain strings)
79
+ */
80
+ export type ParseChunkingRequestChunkingRequestReturnType = ClosedEnum<
81
+ typeof ParseChunkingRequestChunkingRequestReturnType
82
+ >;
83
+
84
+ /**
85
+ * Agentic LLM-powered chunker that uses AI to determine optimal split points. Best for complex documents requiring intelligent segmentation.
86
+ */
87
+ export type AgenticChunkerStrategy = {
88
+ /**
89
+ * The text content to be chunked
90
+ */
91
+ text: string;
92
+ /**
93
+ * Whether to include metadata for each chunk
94
+ */
95
+ metadata?: boolean | undefined;
96
+ /**
97
+ * Return format: chunks (with metadata) or texts (plain strings)
98
+ */
99
+ returnType?: ParseChunkingRequestChunkingRequestReturnType | undefined;
100
+ strategy: "agentic";
101
+ /**
102
+ * Model to use for chunking. (Available models)[https://docs.orq.ai/docs/proxy/supported-models#chat-models]
103
+ */
104
+ model: string;
105
+ /**
106
+ * Maximum tokens per chunk
107
+ */
108
+ chunkSize?: number | undefined;
109
+ /**
110
+ * Size of candidate splits for LLM evaluation
111
+ */
112
+ candidateSize?: number | undefined;
113
+ /**
114
+ * Minimum characters allowed per chunk
115
+ */
116
+ minCharactersPerChunk?: number | undefined;
117
+ /**
118
+ * Custom system prompt for the agentic chunker LLM. Overrides the default prompt that instructs the model how to identify chunk boundaries. Maximum 20,000 tokens.
119
+ */
120
+ systemPrompt?: string | undefined;
121
+ };
122
+
123
+ /**
124
+ * Return format: chunks (with metadata) or texts (plain strings)
125
+ */
126
+ export const ParseChunkingRequestChunkingReturnType = {
127
+ Chunks: "chunks",
128
+ Texts: "texts",
129
+ } as const;
130
+ /**
131
+ * Return format: chunks (with metadata) or texts (plain strings)
132
+ */
133
+ export type ParseChunkingRequestChunkingReturnType = ClosedEnum<
134
+ typeof ParseChunkingRequestChunkingReturnType
135
+ >;
136
+
137
+ export const Threshold2 = {
138
+ Auto: "auto",
139
+ } as const;
140
+ export type Threshold2 = ClosedEnum<typeof Threshold2>;
141
+
142
+ /**
143
+ * Similarity threshold for grouping (0-1) or "auto" for automatic detection
144
+ */
145
+ export type Threshold = number | Threshold2;
146
+
147
+ /**
148
+ * Chunking mode: window-based or sentence-based similarity
149
+ */
150
+ export const ChunkingRequestMode = {
151
+ Window: "window",
152
+ Sentence: "sentence",
153
+ } as const;
154
+ /**
155
+ * Chunking mode: window-based or sentence-based similarity
156
+ */
157
+ export type ChunkingRequestMode = ClosedEnum<typeof ChunkingRequestMode>;
158
+
159
+ /**
160
+ * Groups semantically similar sentences using embeddings. Excellent for maintaining topic coherence and context within chunks.
161
+ */
162
+ export type SemanticChunkerStrategy = {
163
+ /**
164
+ * The text content to be chunked
165
+ */
166
+ text: string;
167
+ /**
168
+ * Whether to include metadata for each chunk
169
+ */
170
+ metadata?: boolean | undefined;
171
+ /**
172
+ * Return format: chunks (with metadata) or texts (plain strings)
173
+ */
174
+ returnType?: ParseChunkingRequestChunkingReturnType | undefined;
175
+ strategy: "semantic";
176
+ /**
177
+ * Maximum tokens per chunk
178
+ */
179
+ chunkSize?: number | undefined;
180
+ /**
181
+ * Similarity threshold for grouping (0-1) or "auto" for automatic detection
182
+ */
183
+ threshold?: number | Threshold2 | undefined;
184
+ /**
185
+ * Embedding model to use for semantic similarity. (Available embedding models)[https://docs.orq.ai/docs/proxy/supported-models#embedding-models]
186
+ */
187
+ embeddingModel: string;
188
+ /**
189
+ * Number of dimensions for the embedding output. Required for text-embedding-3 models. Supported range: 256-3072 for text-embedding-3-large, 256-1536 for text-embedding-3-small.
190
+ */
191
+ dimensions?: number | undefined;
192
+ /**
193
+ * Maximum number of tokens per embedding request. Default is 8191 for text-embedding-3 models.
194
+ */
195
+ maxTokens?: number | undefined;
196
+ /**
197
+ * Chunking mode: window-based or sentence-based similarity
198
+ */
199
+ mode?: ChunkingRequestMode | undefined;
200
+ /**
201
+ * Window size for similarity comparison
202
+ */
203
+ similarityWindow?: number | undefined;
204
+ };
205
+
206
+ /**
207
+ * Return format: chunks (with metadata) or texts (plain strings)
208
+ */
209
+ export const ParseChunkingRequestReturnType = {
210
+ Chunks: "chunks",
211
+ Texts: "texts",
212
+ } as const;
213
+ /**
214
+ * Return format: chunks (with metadata) or texts (plain strings)
215
+ */
216
+ export type ParseChunkingRequestReturnType = ClosedEnum<
217
+ typeof ParseChunkingRequestReturnType
218
+ >;
219
+
220
+ /**
221
+ * Recursively splits text using a hierarchy of separators (paragraphs, sentences, words). Versatile general-purpose chunker that preserves document structure.
222
+ */
223
+ export type RecursiveChunkerStrategy = {
224
+ /**
225
+ * The text content to be chunked
226
+ */
227
+ text: string;
228
+ /**
229
+ * Whether to include metadata for each chunk
230
+ */
231
+ metadata?: boolean | undefined;
232
+ /**
233
+ * Return format: chunks (with metadata) or texts (plain strings)
234
+ */
235
+ returnType?: ParseChunkingRequestReturnType | undefined;
236
+ strategy: "recursive";
237
+ /**
238
+ * Maximum tokens per chunk
239
+ */
240
+ chunkSize?: number | undefined;
241
+ /**
242
+ * Hierarchy of separators to use for splitting
243
+ */
244
+ separators?: Array<string> | undefined;
245
+ /**
246
+ * Minimum characters allowed per chunk
247
+ */
248
+ minCharactersPerChunk?: number | undefined;
249
+ };
250
+
251
+ /**
252
+ * Return format: chunks (with metadata) or texts (plain strings)
253
+ */
254
+ export const ChunkingRequestReturnType = {
255
+ Chunks: "chunks",
256
+ Texts: "texts",
257
+ } as const;
258
+ /**
259
+ * Return format: chunks (with metadata) or texts (plain strings)
260
+ */
261
+ export type ChunkingRequestReturnType = ClosedEnum<
262
+ typeof ChunkingRequestReturnType
263
+ >;
264
+
265
+ /**
266
+ * Splits text at sentence boundaries while respecting token limits. Ideal for maintaining semantic coherence and readability.
267
+ */
268
+ export type SentenceChunkerStrategy = {
269
+ /**
270
+ * The text content to be chunked
271
+ */
272
+ text: string;
273
+ /**
274
+ * Whether to include metadata for each chunk
275
+ */
276
+ metadata?: boolean | undefined;
277
+ /**
278
+ * Return format: chunks (with metadata) or texts (plain strings)
279
+ */
280
+ returnType?: ChunkingRequestReturnType | undefined;
281
+ strategy: "sentence";
282
+ /**
283
+ * Maximum tokens per chunk
284
+ */
285
+ chunkSize?: number | undefined;
286
+ /**
287
+ * Number of overlapping tokens between chunks
288
+ */
289
+ chunkOverlap?: number | undefined;
290
+ /**
291
+ * Minimum number of sentences per chunk
292
+ */
293
+ minSentencesPerChunk?: number | undefined;
294
+ };
295
+
296
+ /**
297
+ * Return format: chunks (with metadata) or texts (plain strings)
298
+ */
299
+ export const ReturnTypeT = {
300
+ Chunks: "chunks",
301
+ Texts: "texts",
302
+ } as const;
303
+ /**
304
+ * Return format: chunks (with metadata) or texts (plain strings)
305
+ */
306
+ export type ReturnTypeT = ClosedEnum<typeof ReturnTypeT>;
307
+
308
+ /**
309
+ * Splits text based on token count. Best for ensuring chunks fit within LLM context windows and maintaining consistent chunk sizes for embedding models.
310
+ */
311
+ export type TokenChunkerStrategy = {
312
+ /**
313
+ * The text content to be chunked
314
+ */
315
+ text: string;
316
+ /**
317
+ * Whether to include metadata for each chunk
318
+ */
319
+ metadata?: boolean | undefined;
320
+ /**
321
+ * Return format: chunks (with metadata) or texts (plain strings)
322
+ */
323
+ returnType?: ReturnTypeT | undefined;
324
+ strategy: "token";
325
+ /**
326
+ * Maximum tokens per chunk
327
+ */
328
+ chunkSize?: number | undefined;
329
+ /**
330
+ * Number of tokens to overlap between chunks
331
+ */
332
+ chunkOverlap?: number | undefined;
333
+ };
334
+
335
+ /**
336
+ * Request payload for text chunking with strategy-specific configuration
337
+ */
338
+ export type ParseChunkingRequest =
339
+ | TokenChunkerStrategy
340
+ | SentenceChunkerStrategy
341
+ | RecursiveChunkerStrategy
342
+ | SemanticChunkerStrategy
343
+ | AgenticChunkerStrategy
344
+ | FastChunkerStrategy;
345
+
346
+ export type ParseMetadata = {
347
+ startIndex: number | null;
348
+ endIndex: number | null;
349
+ tokenCount: number | null;
350
+ };
351
+
352
+ export type Chunks = {
353
+ /**
354
+ * The text content of the chunk
355
+ */
356
+ text: string;
357
+ /**
358
+ * The position index of this chunk in the sequence
359
+ */
360
+ index: number;
361
+ metadata?: ParseMetadata | undefined;
362
+ };
363
+
364
+ /**
365
+ * Text successfully chunked
366
+ */
367
+ export type ParseResponseBody = {
368
+ chunks: Array<Chunks>;
369
+ };
370
+
371
+ /** @internal */
372
+ export const ParseChunkingRequestChunkingRequestRequestBodyReturnType$outboundSchema:
373
+ z.ZodNativeEnum<
374
+ typeof ParseChunkingRequestChunkingRequestRequestBodyReturnType
375
+ > = z.nativeEnum(ParseChunkingRequestChunkingRequestRequestBodyReturnType);
376
+
377
+ /** @internal */
378
+ export type FastChunkerStrategy$Outbound = {
379
+ text: string;
380
+ metadata: boolean;
381
+ return_type: string;
382
+ strategy: "fast";
383
+ target_size: number;
384
+ delimiters: string;
385
+ pattern?: string | undefined;
386
+ prefix: boolean;
387
+ consecutive: boolean;
388
+ forward_fallback: boolean;
389
+ };
390
+
391
+ /** @internal */
392
+ export const FastChunkerStrategy$outboundSchema: z.ZodType<
393
+ FastChunkerStrategy$Outbound,
394
+ z.ZodTypeDef,
395
+ FastChunkerStrategy
396
+ > = z.object({
397
+ text: z.string(),
398
+ metadata: z.boolean().default(true),
399
+ returnType:
400
+ ParseChunkingRequestChunkingRequestRequestBodyReturnType$outboundSchema
401
+ .default("chunks"),
402
+ strategy: z.literal("fast"),
403
+ targetSize: z.number().int().default(4096),
404
+ delimiters: z.string().default("\n.?"),
405
+ pattern: z.string().optional(),
406
+ prefix: z.boolean().default(false),
407
+ consecutive: z.boolean().default(false),
408
+ forwardFallback: z.boolean().default(false),
409
+ }).transform((v) => {
410
+ return remap$(v, {
411
+ returnType: "return_type",
412
+ targetSize: "target_size",
413
+ forwardFallback: "forward_fallback",
414
+ });
415
+ });
416
+
417
+ export function fastChunkerStrategyToJSON(
418
+ fastChunkerStrategy: FastChunkerStrategy,
419
+ ): string {
420
+ return JSON.stringify(
421
+ FastChunkerStrategy$outboundSchema.parse(fastChunkerStrategy),
422
+ );
423
+ }
424
+
425
+ /** @internal */
426
+ export const ParseChunkingRequestChunkingRequestReturnType$outboundSchema:
427
+ z.ZodNativeEnum<typeof ParseChunkingRequestChunkingRequestReturnType> = z
428
+ .nativeEnum(ParseChunkingRequestChunkingRequestReturnType);
429
+
430
+ /** @internal */
431
+ export type AgenticChunkerStrategy$Outbound = {
432
+ text: string;
433
+ metadata: boolean;
434
+ return_type: string;
435
+ strategy: "agentic";
436
+ model: string;
437
+ chunk_size: number;
438
+ candidate_size: number;
439
+ min_characters_per_chunk: number;
440
+ system_prompt?: string | undefined;
441
+ };
442
+
443
+ /** @internal */
444
+ export const AgenticChunkerStrategy$outboundSchema: z.ZodType<
445
+ AgenticChunkerStrategy$Outbound,
446
+ z.ZodTypeDef,
447
+ AgenticChunkerStrategy
448
+ > = z.object({
449
+ text: z.string(),
450
+ metadata: z.boolean().default(true),
451
+ returnType: ParseChunkingRequestChunkingRequestReturnType$outboundSchema
452
+ .default("chunks"),
453
+ strategy: z.literal("agentic"),
454
+ model: z.string(),
455
+ chunkSize: z.number().int().default(1024),
456
+ candidateSize: z.number().int().default(128),
457
+ minCharactersPerChunk: z.number().int().default(24),
458
+ systemPrompt: z.string().optional(),
459
+ }).transform((v) => {
460
+ return remap$(v, {
461
+ returnType: "return_type",
462
+ chunkSize: "chunk_size",
463
+ candidateSize: "candidate_size",
464
+ minCharactersPerChunk: "min_characters_per_chunk",
465
+ systemPrompt: "system_prompt",
466
+ });
467
+ });
468
+
469
+ export function agenticChunkerStrategyToJSON(
470
+ agenticChunkerStrategy: AgenticChunkerStrategy,
471
+ ): string {
472
+ return JSON.stringify(
473
+ AgenticChunkerStrategy$outboundSchema.parse(agenticChunkerStrategy),
474
+ );
475
+ }
476
+
477
+ /** @internal */
478
+ export const ParseChunkingRequestChunkingReturnType$outboundSchema:
479
+ z.ZodNativeEnum<typeof ParseChunkingRequestChunkingReturnType> = z.nativeEnum(
480
+ ParseChunkingRequestChunkingReturnType,
481
+ );
482
+
483
+ /** @internal */
484
+ export const Threshold2$outboundSchema: z.ZodNativeEnum<typeof Threshold2> = z
485
+ .nativeEnum(Threshold2);
486
+
487
+ /** @internal */
488
+ export type Threshold$Outbound = number | string;
489
+
490
+ /** @internal */
491
+ export const Threshold$outboundSchema: z.ZodType<
492
+ Threshold$Outbound,
493
+ z.ZodTypeDef,
494
+ Threshold
495
+ > = z.union([z.number(), Threshold2$outboundSchema]);
496
+
497
+ export function thresholdToJSON(threshold: Threshold): string {
498
+ return JSON.stringify(Threshold$outboundSchema.parse(threshold));
499
+ }
500
+
501
+ /** @internal */
502
+ export const ChunkingRequestMode$outboundSchema: z.ZodNativeEnum<
503
+ typeof ChunkingRequestMode
504
+ > = z.nativeEnum(ChunkingRequestMode);
505
+
506
+ /** @internal */
507
+ export type SemanticChunkerStrategy$Outbound = {
508
+ text: string;
509
+ metadata: boolean;
510
+ return_type: string;
511
+ strategy: "semantic";
512
+ chunk_size: number;
513
+ threshold?: number | string | undefined;
514
+ embedding_model: string;
515
+ dimensions?: number | undefined;
516
+ max_tokens?: number | undefined;
517
+ mode: string;
518
+ similarity_window: number;
519
+ };
520
+
521
+ /** @internal */
522
+ export const SemanticChunkerStrategy$outboundSchema: z.ZodType<
523
+ SemanticChunkerStrategy$Outbound,
524
+ z.ZodTypeDef,
525
+ SemanticChunkerStrategy
526
+ > = z.object({
527
+ text: z.string(),
528
+ metadata: z.boolean().default(true),
529
+ returnType: ParseChunkingRequestChunkingReturnType$outboundSchema.default(
530
+ "chunks",
531
+ ),
532
+ strategy: z.literal("semantic"),
533
+ chunkSize: z.number().int().default(512),
534
+ threshold: z.union([z.number(), Threshold2$outboundSchema]).optional(),
535
+ embeddingModel: z.string(),
536
+ dimensions: z.number().int().optional(),
537
+ maxTokens: z.number().int().optional(),
538
+ mode: ChunkingRequestMode$outboundSchema.default("window"),
539
+ similarityWindow: z.number().int().default(1),
540
+ }).transform((v) => {
541
+ return remap$(v, {
542
+ returnType: "return_type",
543
+ chunkSize: "chunk_size",
544
+ embeddingModel: "embedding_model",
545
+ maxTokens: "max_tokens",
546
+ similarityWindow: "similarity_window",
547
+ });
548
+ });
549
+
550
+ export function semanticChunkerStrategyToJSON(
551
+ semanticChunkerStrategy: SemanticChunkerStrategy,
552
+ ): string {
553
+ return JSON.stringify(
554
+ SemanticChunkerStrategy$outboundSchema.parse(semanticChunkerStrategy),
555
+ );
556
+ }
557
+
558
+ /** @internal */
559
+ export const ParseChunkingRequestReturnType$outboundSchema: z.ZodNativeEnum<
560
+ typeof ParseChunkingRequestReturnType
561
+ > = z.nativeEnum(ParseChunkingRequestReturnType);
562
+
563
+ /** @internal */
564
+ export type RecursiveChunkerStrategy$Outbound = {
565
+ text: string;
566
+ metadata: boolean;
567
+ return_type: string;
568
+ strategy: "recursive";
569
+ chunk_size: number;
570
+ separators?: Array<string> | undefined;
571
+ min_characters_per_chunk: number;
572
+ };
573
+
574
+ /** @internal */
575
+ export const RecursiveChunkerStrategy$outboundSchema: z.ZodType<
576
+ RecursiveChunkerStrategy$Outbound,
577
+ z.ZodTypeDef,
578
+ RecursiveChunkerStrategy
579
+ > = z.object({
580
+ text: z.string(),
581
+ metadata: z.boolean().default(true),
582
+ returnType: ParseChunkingRequestReturnType$outboundSchema.default("chunks"),
583
+ strategy: z.literal("recursive"),
584
+ chunkSize: z.number().int().default(512),
585
+ separators: z.array(z.string()).optional(),
586
+ minCharactersPerChunk: z.number().int().default(24),
587
+ }).transform((v) => {
588
+ return remap$(v, {
589
+ returnType: "return_type",
590
+ chunkSize: "chunk_size",
591
+ minCharactersPerChunk: "min_characters_per_chunk",
592
+ });
593
+ });
594
+
595
+ export function recursiveChunkerStrategyToJSON(
596
+ recursiveChunkerStrategy: RecursiveChunkerStrategy,
597
+ ): string {
598
+ return JSON.stringify(
599
+ RecursiveChunkerStrategy$outboundSchema.parse(recursiveChunkerStrategy),
600
+ );
601
+ }
602
+
603
+ /** @internal */
604
+ export const ChunkingRequestReturnType$outboundSchema: z.ZodNativeEnum<
605
+ typeof ChunkingRequestReturnType
606
+ > = z.nativeEnum(ChunkingRequestReturnType);
607
+
608
+ /** @internal */
609
+ export type SentenceChunkerStrategy$Outbound = {
610
+ text: string;
611
+ metadata: boolean;
612
+ return_type: string;
613
+ strategy: "sentence";
614
+ chunk_size: number;
615
+ chunk_overlap: number;
616
+ min_sentences_per_chunk: number;
617
+ };
618
+
619
+ /** @internal */
620
+ export const SentenceChunkerStrategy$outboundSchema: z.ZodType<
621
+ SentenceChunkerStrategy$Outbound,
622
+ z.ZodTypeDef,
623
+ SentenceChunkerStrategy
624
+ > = z.object({
625
+ text: z.string(),
626
+ metadata: z.boolean().default(true),
627
+ returnType: ChunkingRequestReturnType$outboundSchema.default("chunks"),
628
+ strategy: z.literal("sentence"),
629
+ chunkSize: z.number().int().default(512),
630
+ chunkOverlap: z.number().int().default(0),
631
+ minSentencesPerChunk: z.number().int().default(1),
632
+ }).transform((v) => {
633
+ return remap$(v, {
634
+ returnType: "return_type",
635
+ chunkSize: "chunk_size",
636
+ chunkOverlap: "chunk_overlap",
637
+ minSentencesPerChunk: "min_sentences_per_chunk",
638
+ });
639
+ });
640
+
641
+ export function sentenceChunkerStrategyToJSON(
642
+ sentenceChunkerStrategy: SentenceChunkerStrategy,
643
+ ): string {
644
+ return JSON.stringify(
645
+ SentenceChunkerStrategy$outboundSchema.parse(sentenceChunkerStrategy),
646
+ );
647
+ }
648
+
649
+ /** @internal */
650
+ export const ReturnTypeT$outboundSchema: z.ZodNativeEnum<typeof ReturnTypeT> = z
651
+ .nativeEnum(ReturnTypeT);
652
+
653
+ /** @internal */
654
+ export type TokenChunkerStrategy$Outbound = {
655
+ text: string;
656
+ metadata: boolean;
657
+ return_type: string;
658
+ strategy: "token";
659
+ chunk_size: number;
660
+ chunk_overlap: number;
661
+ };
662
+
663
+ /** @internal */
664
+ export const TokenChunkerStrategy$outboundSchema: z.ZodType<
665
+ TokenChunkerStrategy$Outbound,
666
+ z.ZodTypeDef,
667
+ TokenChunkerStrategy
668
+ > = z.object({
669
+ text: z.string(),
670
+ metadata: z.boolean().default(true),
671
+ returnType: ReturnTypeT$outboundSchema.default("chunks"),
672
+ strategy: z.literal("token"),
673
+ chunkSize: z.number().int().default(512),
674
+ chunkOverlap: z.number().int().default(0),
675
+ }).transform((v) => {
676
+ return remap$(v, {
677
+ returnType: "return_type",
678
+ chunkSize: "chunk_size",
679
+ chunkOverlap: "chunk_overlap",
680
+ });
681
+ });
682
+
683
+ export function tokenChunkerStrategyToJSON(
684
+ tokenChunkerStrategy: TokenChunkerStrategy,
685
+ ): string {
686
+ return JSON.stringify(
687
+ TokenChunkerStrategy$outboundSchema.parse(tokenChunkerStrategy),
688
+ );
689
+ }
690
+
691
+ /** @internal */
692
+ export type ParseChunkingRequest$Outbound =
693
+ | TokenChunkerStrategy$Outbound
694
+ | SentenceChunkerStrategy$Outbound
695
+ | RecursiveChunkerStrategy$Outbound
696
+ | SemanticChunkerStrategy$Outbound
697
+ | AgenticChunkerStrategy$Outbound
698
+ | FastChunkerStrategy$Outbound;
699
+
700
+ /** @internal */
701
+ export const ParseChunkingRequest$outboundSchema: z.ZodType<
702
+ ParseChunkingRequest$Outbound,
703
+ z.ZodTypeDef,
704
+ ParseChunkingRequest
705
+ > = z.union([
706
+ z.lazy(() => TokenChunkerStrategy$outboundSchema),
707
+ z.lazy(() => SentenceChunkerStrategy$outboundSchema),
708
+ z.lazy(() => RecursiveChunkerStrategy$outboundSchema),
709
+ z.lazy(() => SemanticChunkerStrategy$outboundSchema),
710
+ z.lazy(() => AgenticChunkerStrategy$outboundSchema),
711
+ z.lazy(() => FastChunkerStrategy$outboundSchema),
712
+ ]);
713
+
714
+ export function parseChunkingRequestToJSON(
715
+ parseChunkingRequest: ParseChunkingRequest,
716
+ ): string {
717
+ return JSON.stringify(
718
+ ParseChunkingRequest$outboundSchema.parse(parseChunkingRequest),
719
+ );
720
+ }
721
+
722
+ /** @internal */
723
+ export const ParseMetadata$inboundSchema: z.ZodType<
724
+ ParseMetadata,
725
+ z.ZodTypeDef,
726
+ unknown
727
+ > = z.object({
728
+ start_index: z.nullable(z.number()),
729
+ end_index: z.nullable(z.number()),
730
+ token_count: z.nullable(z.number()),
731
+ }).transform((v) => {
732
+ return remap$(v, {
733
+ "start_index": "startIndex",
734
+ "end_index": "endIndex",
735
+ "token_count": "tokenCount",
736
+ });
737
+ });
738
+
739
+ export function parseMetadataFromJSON(
740
+ jsonString: string,
741
+ ): SafeParseResult<ParseMetadata, SDKValidationError> {
742
+ return safeParse(
743
+ jsonString,
744
+ (x) => ParseMetadata$inboundSchema.parse(JSON.parse(x)),
745
+ `Failed to parse 'ParseMetadata' from JSON`,
746
+ );
747
+ }
748
+
749
+ /** @internal */
750
+ export const Chunks$inboundSchema: z.ZodType<Chunks, z.ZodTypeDef, unknown> = z
751
+ .object({
752
+ text: z.string(),
753
+ index: z.number(),
754
+ metadata: z.lazy(() => ParseMetadata$inboundSchema).optional(),
755
+ });
756
+
757
+ export function chunksFromJSON(
758
+ jsonString: string,
759
+ ): SafeParseResult<Chunks, SDKValidationError> {
760
+ return safeParse(
761
+ jsonString,
762
+ (x) => Chunks$inboundSchema.parse(JSON.parse(x)),
763
+ `Failed to parse 'Chunks' from JSON`,
764
+ );
765
+ }
766
+
767
+ /** @internal */
768
+ export const ParseResponseBody$inboundSchema: z.ZodType<
769
+ ParseResponseBody,
770
+ z.ZodTypeDef,
771
+ unknown
772
+ > = z.object({
773
+ chunks: z.array(z.lazy(() => Chunks$inboundSchema)),
774
+ });
775
+
776
+ export function parseResponseBodyFromJSON(
777
+ jsonString: string,
778
+ ): SafeParseResult<ParseResponseBody, SDKValidationError> {
779
+ return safeParse(
780
+ jsonString,
781
+ (x) => ParseResponseBody$inboundSchema.parse(JSON.parse(x)),
782
+ `Failed to parse 'ParseResponseBody' from JSON`,
783
+ );
784
+ }