@orq-ai/node 3.3.1 → 3.4.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 (273) hide show
  1. package/bin/mcp-server.js +40 -43
  2. package/bin/mcp-server.js.map +24 -24
  3. package/jsr.json +1 -1
  4. package/lib/config.d.ts +2 -2
  5. package/lib/config.js +2 -2
  6. package/lib/config.js.map +1 -1
  7. package/mcp-server/mcp-server.js +1 -1
  8. package/mcp-server/mcp-server.js.map +1 -1
  9. package/mcp-server/server.js +1 -1
  10. package/mcp-server/server.js.map +1 -1
  11. package/models/operations/bulkcreatedatapoints.js +2 -2
  12. package/models/operations/createcontact.js +2 -2
  13. package/models/operations/createdataset.js +2 -2
  14. package/models/operations/createdatasetitem.js +2 -2
  15. package/models/operations/createdatasource.js +2 -2
  16. package/models/operations/fileget.js +2 -2
  17. package/models/operations/filelist.js +2 -2
  18. package/models/operations/fileupload.js +2 -2
  19. package/models/operations/listdatasetdatapoints.js +2 -2
  20. package/models/operations/listdatasets.js +2 -2
  21. package/models/operations/listdatasources.js +2 -2
  22. package/models/operations/retrievedatapoint.js +2 -2
  23. package/models/operations/retrievedataset.js +2 -2
  24. package/models/operations/retrievedatasource.js +2 -2
  25. package/models/operations/updatedatapoint.js +2 -2
  26. package/models/operations/updatedataset.js +2 -2
  27. package/models/operations/updatedatasource.js +2 -2
  28. package/package.json +3 -2
  29. package/src/lib/config.ts +2 -2
  30. package/src/mcp-server/mcp-server.ts +1 -1
  31. package/src/mcp-server/server.ts +1 -1
  32. package/src/models/operations/bulkcreatedatapoints.ts +2 -2
  33. package/src/models/operations/createcontact.ts +2 -2
  34. package/src/models/operations/createdataset.ts +2 -2
  35. package/src/models/operations/createdatasetitem.ts +2 -2
  36. package/src/models/operations/createdatasource.ts +2 -2
  37. package/src/models/operations/fileget.ts +2 -2
  38. package/src/models/operations/filelist.ts +2 -2
  39. package/src/models/operations/fileupload.ts +2 -2
  40. package/src/models/operations/listdatasetdatapoints.ts +2 -2
  41. package/src/models/operations/listdatasets.ts +2 -2
  42. package/src/models/operations/listdatasources.ts +2 -2
  43. package/src/models/operations/retrievedatapoint.ts +2 -2
  44. package/src/models/operations/retrievedataset.ts +2 -2
  45. package/src/models/operations/retrievedatasource.ts +2 -2
  46. package/src/models/operations/updatedatapoint.ts +2 -2
  47. package/src/models/operations/updatedataset.ts +2 -2
  48. package/src/models/operations/updatedatasource.ts +2 -2
  49. package/packages/orq-rc/FUNCTIONS.md +0 -106
  50. package/packages/orq-rc/README.md +0 -698
  51. package/packages/orq-rc/RUNTIMES.md +0 -48
  52. package/packages/orq-rc/docs/sdks/contacts/README.md +0 -84
  53. package/packages/orq-rc/docs/sdks/datasets/README.md +0 -940
  54. package/packages/orq-rc/docs/sdks/deployments/README.md +0 -316
  55. package/packages/orq-rc/docs/sdks/feedback/README.md +0 -92
  56. package/packages/orq-rc/docs/sdks/files/README.md +0 -311
  57. package/packages/orq-rc/docs/sdks/knowledge/README.md +0 -1279
  58. package/packages/orq-rc/docs/sdks/metrics/README.md +0 -86
  59. package/packages/orq-rc/docs/sdks/orq/README.md +0 -10
  60. package/packages/orq-rc/docs/sdks/prompts/README.md +0 -614
  61. package/packages/orq-rc/docs/sdks/remoteconfigs/README.md +0 -80
  62. package/packages/orq-rc/jsr.json +0 -28
  63. package/packages/orq-rc/package-lock.json +0 -3217
  64. package/packages/orq-rc/package.json +0 -45
  65. package/packages/orq-rc/src/core.ts +0 -13
  66. package/packages/orq-rc/src/funcs/contactsCreate.ts +0 -154
  67. package/packages/orq-rc/src/funcs/datasetsClear.ts +0 -161
  68. package/packages/orq-rc/src/funcs/datasetsCreate.ts +0 -159
  69. package/packages/orq-rc/src/funcs/datasetsCreateDatapoint.ts +0 -161
  70. package/packages/orq-rc/src/funcs/datasetsCreateDatapoints.ts +0 -165
  71. package/packages/orq-rc/src/funcs/datasetsDelete.ts +0 -161
  72. package/packages/orq-rc/src/funcs/datasetsDeleteDatapoint.ts +0 -176
  73. package/packages/orq-rc/src/funcs/datasetsList.ts +0 -161
  74. package/packages/orq-rc/src/funcs/datasetsListDatapoints.ts +0 -168
  75. package/packages/orq-rc/src/funcs/datasetsRetrieve.ts +0 -169
  76. package/packages/orq-rc/src/funcs/datasetsRetrieveDatapoint.ts +0 -175
  77. package/packages/orq-rc/src/funcs/datasetsUpdate.ts +0 -170
  78. package/packages/orq-rc/src/funcs/datasetsUpdateDatapoint.ts +0 -173
  79. package/packages/orq-rc/src/funcs/deploymentsGetConfig.ts +0 -162
  80. package/packages/orq-rc/src/funcs/deploymentsInvoke.ts +0 -170
  81. package/packages/orq-rc/src/funcs/deploymentsList.ts +0 -170
  82. package/packages/orq-rc/src/funcs/deploymentsMetricsCreate.ts +0 -162
  83. package/packages/orq-rc/src/funcs/deploymentsStream.ts +0 -178
  84. package/packages/orq-rc/src/funcs/feedbackCreate.ts +0 -154
  85. package/packages/orq-rc/src/funcs/filesCreate.ts +0 -174
  86. package/packages/orq-rc/src/funcs/filesDelete.ts +0 -158
  87. package/packages/orq-rc/src/funcs/filesGet.ts +0 -160
  88. package/packages/orq-rc/src/funcs/filesList.ts +0 -161
  89. package/packages/orq-rc/src/funcs/knowledgeCreate.ts +0 -152
  90. package/packages/orq-rc/src/funcs/knowledgeCreateChunks.ts +0 -165
  91. package/packages/orq-rc/src/funcs/knowledgeCreateDatasource.ts +0 -160
  92. package/packages/orq-rc/src/funcs/knowledgeDelete.ts +0 -161
  93. package/packages/orq-rc/src/funcs/knowledgeDeleteChunk.ts +0 -168
  94. package/packages/orq-rc/src/funcs/knowledgeDeleteDatasource.ts +0 -167
  95. package/packages/orq-rc/src/funcs/knowledgeList.ts +0 -163
  96. package/packages/orq-rc/src/funcs/knowledgeListChunks.ts +0 -172
  97. package/packages/orq-rc/src/funcs/knowledgeListDatasources.ts +0 -168
  98. package/packages/orq-rc/src/funcs/knowledgeRetrieve.ts +0 -160
  99. package/packages/orq-rc/src/funcs/knowledgeRetrieveChunk.ts +0 -167
  100. package/packages/orq-rc/src/funcs/knowledgeRetrieveDatasource.ts +0 -163
  101. package/packages/orq-rc/src/funcs/knowledgeSearch.ts +0 -158
  102. package/packages/orq-rc/src/funcs/knowledgeUpdate.ts +0 -158
  103. package/packages/orq-rc/src/funcs/knowledgeUpdateChunk.ts +0 -168
  104. package/packages/orq-rc/src/funcs/knowledgeUpdateDatasource.ts +0 -164
  105. package/packages/orq-rc/src/funcs/promptsCreate.ts +0 -154
  106. package/packages/orq-rc/src/funcs/promptsDelete.ts +0 -158
  107. package/packages/orq-rc/src/funcs/promptsGetVersion.ts +0 -175
  108. package/packages/orq-rc/src/funcs/promptsList.ts +0 -161
  109. package/packages/orq-rc/src/funcs/promptsListVersions.ts +0 -167
  110. package/packages/orq-rc/src/funcs/promptsRetrieve.ts +0 -160
  111. package/packages/orq-rc/src/funcs/promptsUpdate.ts +0 -167
  112. package/packages/orq-rc/src/funcs/remoteconfigsRetrieve.ts +0 -155
  113. package/packages/orq-rc/src/hooks/global.ts +0 -44
  114. package/packages/orq-rc/src/hooks/hooks.ts +0 -132
  115. package/packages/orq-rc/src/hooks/index.ts +0 -6
  116. package/packages/orq-rc/src/hooks/registration.ts +0 -15
  117. package/packages/orq-rc/src/hooks/types.ts +0 -110
  118. package/packages/orq-rc/src/index.ts +0 -7
  119. package/packages/orq-rc/src/lib/base64.ts +0 -37
  120. package/packages/orq-rc/src/lib/config.ts +0 -70
  121. package/packages/orq-rc/src/lib/dlv.ts +0 -53
  122. package/packages/orq-rc/src/lib/encodings.ts +0 -483
  123. package/packages/orq-rc/src/lib/env.ts +0 -73
  124. package/packages/orq-rc/src/lib/event-streams.ts +0 -264
  125. package/packages/orq-rc/src/lib/files.ts +0 -40
  126. package/packages/orq-rc/src/lib/http.ts +0 -323
  127. package/packages/orq-rc/src/lib/is-plain-object.ts +0 -43
  128. package/packages/orq-rc/src/lib/logger.ts +0 -9
  129. package/packages/orq-rc/src/lib/matchers.ts +0 -325
  130. package/packages/orq-rc/src/lib/primitives.ts +0 -150
  131. package/packages/orq-rc/src/lib/retries.ts +0 -218
  132. package/packages/orq-rc/src/lib/schemas.ts +0 -91
  133. package/packages/orq-rc/src/lib/sdks.ts +0 -395
  134. package/packages/orq-rc/src/lib/security.ts +0 -261
  135. package/packages/orq-rc/src/lib/url.ts +0 -33
  136. package/packages/orq-rc/src/mcp-server/cli/start/command.ts +0 -125
  137. package/packages/orq-rc/src/mcp-server/cli/start/impl.ts +0 -140
  138. package/packages/orq-rc/src/mcp-server/cli.ts +0 -13
  139. package/packages/orq-rc/src/mcp-server/console-logger.ts +0 -71
  140. package/packages/orq-rc/src/mcp-server/extensions.ts +0 -17
  141. package/packages/orq-rc/src/mcp-server/mcp-server.ts +0 -26
  142. package/packages/orq-rc/src/mcp-server/prompts.ts +0 -110
  143. package/packages/orq-rc/src/mcp-server/resources.ts +0 -158
  144. package/packages/orq-rc/src/mcp-server/scopes.ts +0 -7
  145. package/packages/orq-rc/src/mcp-server/server.ts +0 -157
  146. package/packages/orq-rc/src/mcp-server/shared.ts +0 -75
  147. package/packages/orq-rc/src/mcp-server/tools/contactsCreate.ts +0 -37
  148. package/packages/orq-rc/src/mcp-server/tools/datasetsClear.ts +0 -35
  149. package/packages/orq-rc/src/mcp-server/tools/datasetsCreate.ts +0 -37
  150. package/packages/orq-rc/src/mcp-server/tools/datasetsCreateDatapoint.ts +0 -37
  151. package/packages/orq-rc/src/mcp-server/tools/datasetsCreateDatapoints.ts +0 -37
  152. package/packages/orq-rc/src/mcp-server/tools/datasetsDelete.ts +0 -35
  153. package/packages/orq-rc/src/mcp-server/tools/datasetsDeleteDatapoint.ts +0 -35
  154. package/packages/orq-rc/src/mcp-server/tools/datasetsList.ts +0 -37
  155. package/packages/orq-rc/src/mcp-server/tools/datasetsListDatapoints.ts +0 -37
  156. package/packages/orq-rc/src/mcp-server/tools/datasetsRetrieve.ts +0 -37
  157. package/packages/orq-rc/src/mcp-server/tools/datasetsRetrieveDatapoint.ts +0 -37
  158. package/packages/orq-rc/src/mcp-server/tools/datasetsUpdate.ts +0 -37
  159. package/packages/orq-rc/src/mcp-server/tools/datasetsUpdateDatapoint.ts +0 -35
  160. package/packages/orq-rc/src/mcp-server/tools/deploymentsGetConfig.ts +0 -37
  161. package/packages/orq-rc/src/mcp-server/tools/deploymentsInvoke.ts +0 -37
  162. package/packages/orq-rc/src/mcp-server/tools/deploymentsList.ts +0 -37
  163. package/packages/orq-rc/src/mcp-server/tools/deploymentsMetricsCreate.ts +0 -37
  164. package/packages/orq-rc/src/mcp-server/tools/deploymentsStream.ts +0 -37
  165. package/packages/orq-rc/src/mcp-server/tools/feedbackCreate.ts +0 -37
  166. package/packages/orq-rc/src/mcp-server/tools/filesCreate.ts +0 -37
  167. package/packages/orq-rc/src/mcp-server/tools/filesDelete.ts +0 -33
  168. package/packages/orq-rc/src/mcp-server/tools/filesGet.ts +0 -37
  169. package/packages/orq-rc/src/mcp-server/tools/filesList.ts +0 -37
  170. package/packages/orq-rc/src/mcp-server/tools/knowledgeCreate.ts +0 -35
  171. package/packages/orq-rc/src/mcp-server/tools/knowledgeCreateChunks.ts +0 -35
  172. package/packages/orq-rc/src/mcp-server/tools/knowledgeCreateDatasource.ts +0 -35
  173. package/packages/orq-rc/src/mcp-server/tools/knowledgeDelete.ts +0 -35
  174. package/packages/orq-rc/src/mcp-server/tools/knowledgeDeleteChunk.ts +0 -33
  175. package/packages/orq-rc/src/mcp-server/tools/knowledgeDeleteDatasource.ts +0 -35
  176. package/packages/orq-rc/src/mcp-server/tools/knowledgeList.ts +0 -37
  177. package/packages/orq-rc/src/mcp-server/tools/knowledgeListChunks.ts +0 -35
  178. package/packages/orq-rc/src/mcp-server/tools/knowledgeListDatasources.ts +0 -35
  179. package/packages/orq-rc/src/mcp-server/tools/knowledgeRetrieve.ts +0 -37
  180. package/packages/orq-rc/src/mcp-server/tools/knowledgeRetrieveChunk.ts +0 -35
  181. package/packages/orq-rc/src/mcp-server/tools/knowledgeRetrieveDatasource.ts +0 -35
  182. package/packages/orq-rc/src/mcp-server/tools/knowledgeSearch.ts +0 -35
  183. package/packages/orq-rc/src/mcp-server/tools/knowledgeUpdate.ts +0 -35
  184. package/packages/orq-rc/src/mcp-server/tools/knowledgeUpdateChunk.ts +0 -35
  185. package/packages/orq-rc/src/mcp-server/tools/knowledgeUpdateDatasource.ts +0 -35
  186. package/packages/orq-rc/src/mcp-server/tools/promptsCreate.ts +0 -35
  187. package/packages/orq-rc/src/mcp-server/tools/promptsDelete.ts +0 -33
  188. package/packages/orq-rc/src/mcp-server/tools/promptsGetVersion.ts +0 -37
  189. package/packages/orq-rc/src/mcp-server/tools/promptsList.ts +0 -37
  190. package/packages/orq-rc/src/mcp-server/tools/promptsListVersions.ts +0 -37
  191. package/packages/orq-rc/src/mcp-server/tools/promptsRetrieve.ts +0 -37
  192. package/packages/orq-rc/src/mcp-server/tools/promptsUpdate.ts +0 -35
  193. package/packages/orq-rc/src/mcp-server/tools/remoteconfigsRetrieve.ts +0 -36
  194. package/packages/orq-rc/src/mcp-server/tools.ts +0 -126
  195. package/packages/orq-rc/src/models/components/deployments.ts +0 -4164
  196. package/packages/orq-rc/src/models/components/index.ts +0 -6
  197. package/packages/orq-rc/src/models/components/security.ts +0 -71
  198. package/packages/orq-rc/src/models/errors/apierror.ts +0 -27
  199. package/packages/orq-rc/src/models/errors/getpromptversion.ts +0 -71
  200. package/packages/orq-rc/src/models/errors/honoapierror.ts +0 -82
  201. package/packages/orq-rc/src/models/errors/httpclienterrors.ts +0 -62
  202. package/packages/orq-rc/src/models/errors/index.ts +0 -10
  203. package/packages/orq-rc/src/models/errors/sdkvalidationerror.ts +0 -97
  204. package/packages/orq-rc/src/models/errors/updateprompt.ts +0 -71
  205. package/packages/orq-rc/src/models/operations/bulkcreatedatapoints.ts +0 -1816
  206. package/packages/orq-rc/src/models/operations/cleardataset.ts +0 -75
  207. package/packages/orq-rc/src/models/operations/createchunk.ts +0 -680
  208. package/packages/orq-rc/src/models/operations/createcontact.ts +0 -256
  209. package/packages/orq-rc/src/models/operations/createdataset.ts +0 -296
  210. package/packages/orq-rc/src/models/operations/createdatasetitem.ts +0 -1740
  211. package/packages/orq-rc/src/models/operations/createdatasource.ts +0 -852
  212. package/packages/orq-rc/src/models/operations/createfeedback.ts +0 -286
  213. package/packages/orq-rc/src/models/operations/createknowledge.ts +0 -676
  214. package/packages/orq-rc/src/models/operations/createprompt.ts +0 -3743
  215. package/packages/orq-rc/src/models/operations/deletechunk.ts +0 -96
  216. package/packages/orq-rc/src/models/operations/deletedatapoint.ts +0 -81
  217. package/packages/orq-rc/src/models/operations/deletedataset.ts +0 -75
  218. package/packages/orq-rc/src/models/operations/deletedatasource.ts +0 -87
  219. package/packages/orq-rc/src/models/operations/deleteknowledge.ts +0 -78
  220. package/packages/orq-rc/src/models/operations/deleteprompt.ts +0 -69
  221. package/packages/orq-rc/src/models/operations/deploymentcreatemetric.ts +0 -4936
  222. package/packages/orq-rc/src/models/operations/deploymentgetconfig.ts +0 -6090
  223. package/packages/orq-rc/src/models/operations/deploymentinvoke.ts +0 -1199
  224. package/packages/orq-rc/src/models/operations/deployments.ts +0 -2155
  225. package/packages/orq-rc/src/models/operations/deploymentstream.ts +0 -5960
  226. package/packages/orq-rc/src/models/operations/filedelete.ts +0 -78
  227. package/packages/orq-rc/src/models/operations/fileget.ts +0 -223
  228. package/packages/orq-rc/src/models/operations/filelist.ts +0 -337
  229. package/packages/orq-rc/src/models/operations/fileupload.ts +0 -324
  230. package/packages/orq-rc/src/models/operations/getallprompts.ts +0 -2127
  231. package/packages/orq-rc/src/models/operations/getonechunk.ts +0 -265
  232. package/packages/orq-rc/src/models/operations/getoneknowledge.ts +0 -444
  233. package/packages/orq-rc/src/models/operations/getoneprompt.ts +0 -1993
  234. package/packages/orq-rc/src/models/operations/getpromptversion.ts +0 -1991
  235. package/packages/orq-rc/src/models/operations/index.ts +0 -51
  236. package/packages/orq-rc/src/models/operations/listchunks.ts +0 -444
  237. package/packages/orq-rc/src/models/operations/listdatasetdatapoints.ts +0 -1071
  238. package/packages/orq-rc/src/models/operations/listdatasets.ts +0 -406
  239. package/packages/orq-rc/src/models/operations/listdatasources.ts +0 -447
  240. package/packages/orq-rc/src/models/operations/listknowledgebases.ts +0 -568
  241. package/packages/orq-rc/src/models/operations/listpromptversions.ts +0 -2125
  242. package/packages/orq-rc/src/models/operations/remoteconfigsgetconfig.ts +0 -190
  243. package/packages/orq-rc/src/models/operations/retrievedatapoint.ts +0 -924
  244. package/packages/orq-rc/src/models/operations/retrievedataset.ts +0 -288
  245. package/packages/orq-rc/src/models/operations/retrievedatasource.ts +0 -273
  246. package/packages/orq-rc/src/models/operations/searchknowledge.ts +0 -1673
  247. package/packages/orq-rc/src/models/operations/updatechunk.ts +0 -418
  248. package/packages/orq-rc/src/models/operations/updatedatapoint.ts +0 -1729
  249. package/packages/orq-rc/src/models/operations/updatedataset.ts +0 -393
  250. package/packages/orq-rc/src/models/operations/updatedatasource.ts +0 -345
  251. package/packages/orq-rc/src/models/operations/updateknowledge.ts +0 -790
  252. package/packages/orq-rc/src/models/operations/updateprompt.ts +0 -3929
  253. package/packages/orq-rc/src/sdk/contacts.ts +0 -27
  254. package/packages/orq-rc/src/sdk/datasets.ts +0 -222
  255. package/packages/orq-rc/src/sdk/deployments.ts +0 -89
  256. package/packages/orq-rc/src/sdk/feedback.ts +0 -27
  257. package/packages/orq-rc/src/sdk/files.ts +0 -78
  258. package/packages/orq-rc/src/sdk/index.ts +0 -5
  259. package/packages/orq-rc/src/sdk/knowledge.ts +0 -261
  260. package/packages/orq-rc/src/sdk/metrics.ts +0 -27
  261. package/packages/orq-rc/src/sdk/prompts.ts +0 -126
  262. package/packages/orq-rc/src/sdk/remoteconfigs.ts +0 -24
  263. package/packages/orq-rc/src/sdk/sdk.ts +0 -55
  264. package/packages/orq-rc/src/types/async.ts +0 -68
  265. package/packages/orq-rc/src/types/blobs.ts +0 -31
  266. package/packages/orq-rc/src/types/constdatetime.ts +0 -15
  267. package/packages/orq-rc/src/types/enums.ts +0 -16
  268. package/packages/orq-rc/src/types/fp.ts +0 -50
  269. package/packages/orq-rc/src/types/index.ts +0 -11
  270. package/packages/orq-rc/src/types/operations.ts +0 -105
  271. package/packages/orq-rc/src/types/rfcdate.ts +0 -54
  272. package/packages/orq-rc/src/types/streams.ts +0 -21
  273. package/packages/orq-rc/tsconfig.json +0 -41
@@ -1,1673 +0,0 @@
1
- /*
2
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
- */
4
-
5
- import * as z from "zod";
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
- export const SearchKnowledgeRetrievalConfigKnowledgeType = {
13
- HybridSearch: "hybrid_search",
14
- } as const;
15
- export type SearchKnowledgeRetrievalConfigKnowledgeType = ClosedEnum<
16
- typeof SearchKnowledgeRetrievalConfigKnowledgeType
17
- >;
18
-
19
- export const SearchKnowledgeRetrievalConfigKnowledgeProvider = {
20
- Cohere: "cohere",
21
- Openai: "openai",
22
- Anthropic: "anthropic",
23
- Huggingface: "huggingface",
24
- Replicate: "replicate",
25
- Google: "google",
26
- GoogleAi: "google-ai",
27
- Azure: "azure",
28
- Aws: "aws",
29
- Anyscale: "anyscale",
30
- Perplexity: "perplexity",
31
- Groq: "groq",
32
- Fal: "fal",
33
- Leonardoai: "leonardoai",
34
- Nvidia: "nvidia",
35
- Jina: "jina",
36
- Togetherai: "togetherai",
37
- Elevenlabs: "elevenlabs",
38
- } as const;
39
- export type SearchKnowledgeRetrievalConfigKnowledgeProvider = ClosedEnum<
40
- typeof SearchKnowledgeRetrievalConfigKnowledgeProvider
41
- >;
42
-
43
- export const SearchKnowledgeRetrievalConfigKnowledgeModelType = {
44
- Rerank: "rerank",
45
- } as const;
46
- export type SearchKnowledgeRetrievalConfigKnowledgeModelType = ClosedEnum<
47
- typeof SearchKnowledgeRetrievalConfigKnowledgeModelType
48
- >;
49
-
50
- export type SearchKnowledgeRetrievalConfigKnowledgeModelParameters = {
51
- /**
52
- * The threshold value used to filter the rerank results, only documents with a relevance score greater than the threshold will be returned
53
- */
54
- threshold?: number | undefined;
55
- };
56
-
57
- export type SearchKnowledgeRetrievalConfigRerankConfigInput = {
58
- enabled?: boolean | undefined;
59
- provider?: SearchKnowledgeRetrievalConfigKnowledgeProvider | undefined;
60
- /**
61
- * The name of the model to use
62
- */
63
- model?: string | undefined;
64
- /**
65
- * The ID of the model in the database
66
- */
67
- modelDbId?: string | undefined;
68
- modelType?: SearchKnowledgeRetrievalConfigKnowledgeModelType | undefined;
69
- modelParameters?:
70
- | SearchKnowledgeRetrievalConfigKnowledgeModelParameters
71
- | undefined;
72
- };
73
-
74
- export type RetrievalConfig3 = {
75
- type: SearchKnowledgeRetrievalConfigKnowledgeType;
76
- /**
77
- * Used to filter chunks that are most similar to the query
78
- */
79
- topK?: number | undefined;
80
- /**
81
- * Used to filter chunks that are most similar to the query. A value of `0` will be consider disabled.
82
- */
83
- threshold?: number | undefined;
84
- rerankConfig?:
85
- | SearchKnowledgeRetrievalConfigRerankConfigInput
86
- | null
87
- | undefined;
88
- };
89
-
90
- export const SearchKnowledgeRetrievalConfigType = {
91
- KeywordSearch: "keyword_search",
92
- } as const;
93
- export type SearchKnowledgeRetrievalConfigType = ClosedEnum<
94
- typeof SearchKnowledgeRetrievalConfigType
95
- >;
96
-
97
- export const SearchKnowledgeRetrievalConfigProvider = {
98
- Cohere: "cohere",
99
- Openai: "openai",
100
- Anthropic: "anthropic",
101
- Huggingface: "huggingface",
102
- Replicate: "replicate",
103
- Google: "google",
104
- GoogleAi: "google-ai",
105
- Azure: "azure",
106
- Aws: "aws",
107
- Anyscale: "anyscale",
108
- Perplexity: "perplexity",
109
- Groq: "groq",
110
- Fal: "fal",
111
- Leonardoai: "leonardoai",
112
- Nvidia: "nvidia",
113
- Jina: "jina",
114
- Togetherai: "togetherai",
115
- Elevenlabs: "elevenlabs",
116
- } as const;
117
- export type SearchKnowledgeRetrievalConfigProvider = ClosedEnum<
118
- typeof SearchKnowledgeRetrievalConfigProvider
119
- >;
120
-
121
- export const SearchKnowledgeRetrievalConfigModelType = {
122
- Rerank: "rerank",
123
- } as const;
124
- export type SearchKnowledgeRetrievalConfigModelType = ClosedEnum<
125
- typeof SearchKnowledgeRetrievalConfigModelType
126
- >;
127
-
128
- export type SearchKnowledgeRetrievalConfigModelParameters = {
129
- /**
130
- * The threshold value used to filter the rerank results, only documents with a relevance score greater than the threshold will be returned
131
- */
132
- threshold?: number | undefined;
133
- };
134
-
135
- export type SearchKnowledgeRetrievalConfigRerankConfig = {
136
- enabled?: boolean | undefined;
137
- provider?: SearchKnowledgeRetrievalConfigProvider | undefined;
138
- /**
139
- * The name of the model to use
140
- */
141
- model?: string | undefined;
142
- /**
143
- * The ID of the model in the database
144
- */
145
- modelDbId?: string | undefined;
146
- modelType?: SearchKnowledgeRetrievalConfigModelType | undefined;
147
- modelParameters?: SearchKnowledgeRetrievalConfigModelParameters | undefined;
148
- };
149
-
150
- export type RetrievalConfig2 = {
151
- type: SearchKnowledgeRetrievalConfigType;
152
- /**
153
- * Used to filter chunks that are most similar to the query
154
- */
155
- topK?: number | undefined;
156
- /**
157
- * Used to filter chunks that are most similar to the query. A value of `0` will be consider disabled.
158
- */
159
- threshold?: number | undefined;
160
- rerankConfig?: SearchKnowledgeRetrievalConfigRerankConfig | null | undefined;
161
- };
162
-
163
- export const RetrievalConfigType = {
164
- VectorSearch: "vector_search",
165
- } as const;
166
- export type RetrievalConfigType = ClosedEnum<typeof RetrievalConfigType>;
167
-
168
- export const RetrievalConfigProvider = {
169
- Cohere: "cohere",
170
- Openai: "openai",
171
- Anthropic: "anthropic",
172
- Huggingface: "huggingface",
173
- Replicate: "replicate",
174
- Google: "google",
175
- GoogleAi: "google-ai",
176
- Azure: "azure",
177
- Aws: "aws",
178
- Anyscale: "anyscale",
179
- Perplexity: "perplexity",
180
- Groq: "groq",
181
- Fal: "fal",
182
- Leonardoai: "leonardoai",
183
- Nvidia: "nvidia",
184
- Jina: "jina",
185
- Togetherai: "togetherai",
186
- Elevenlabs: "elevenlabs",
187
- } as const;
188
- export type RetrievalConfigProvider = ClosedEnum<
189
- typeof RetrievalConfigProvider
190
- >;
191
-
192
- export const RetrievalConfigModelType = {
193
- Rerank: "rerank",
194
- } as const;
195
- export type RetrievalConfigModelType = ClosedEnum<
196
- typeof RetrievalConfigModelType
197
- >;
198
-
199
- export type RetrievalConfigModelParameters = {
200
- /**
201
- * The threshold value used to filter the rerank results, only documents with a relevance score greater than the threshold will be returned
202
- */
203
- threshold?: number | undefined;
204
- };
205
-
206
- export type RetrievalConfigRerankConfig = {
207
- enabled?: boolean | undefined;
208
- provider?: RetrievalConfigProvider | undefined;
209
- /**
210
- * The name of the model to use
211
- */
212
- model?: string | undefined;
213
- /**
214
- * The ID of the model in the database
215
- */
216
- modelDbId?: string | undefined;
217
- modelType?: RetrievalConfigModelType | undefined;
218
- modelParameters?: RetrievalConfigModelParameters | undefined;
219
- };
220
-
221
- export type RetrievalConfig1 = {
222
- type: RetrievalConfigType;
223
- /**
224
- * Used to filter chunks that are most similar to the query
225
- */
226
- topK?: number | undefined;
227
- /**
228
- * Used to filter chunks that are most similar to the query. A value of `0` will be consider disabled.
229
- */
230
- threshold?: number | undefined;
231
- rerankConfig?: RetrievalConfigRerankConfig | null | undefined;
232
- };
233
-
234
- /**
235
- * Allow to modify the retrieval config for the search. If not provided, the knowledge base configuration set in the database will be used.
236
- */
237
- export type RetrievalConfig =
238
- | RetrievalConfig1
239
- | RetrievalConfig2
240
- | RetrievalConfig3;
241
-
242
- export type SearchKnowledgeRequestBody = {
243
- query: string;
244
- /**
245
- * Allow to modify the retrieval config for the search. If not provided, the knowledge base configuration set in the database will be used.
246
- */
247
- retrievalConfig?:
248
- | RetrievalConfig1
249
- | RetrievalConfig2
250
- | RetrievalConfig3
251
- | undefined;
252
- };
253
-
254
- export type SearchKnowledgeRequest = {
255
- knowledgeId: string;
256
- requestBody: SearchKnowledgeRequestBody;
257
- };
258
-
259
- export type SearchKnowledgeMetadata = {
260
- /**
261
- * Unique identifier for the data source
262
- */
263
- datasourceId: string;
264
- /**
265
- * Unique identifier for the chunk
266
- */
267
- chunkId: string;
268
- /**
269
- * Name of the uploaded file during the datasource creation.
270
- */
271
- fileName: string;
272
- /**
273
- * Reference to the page number the chunk was extracted from. The property will only be available for `application/pdf` type of files. For other file types, the property will be `null`.
274
- */
275
- pageNumber?: number | null | undefined;
276
- /**
277
- * Type of the uploaded file when the datasource was created.
278
- */
279
- fileType: string;
280
- };
281
-
282
- export type SearchKnowledgeDocuments = {
283
- /**
284
- * Unique identifier for the retrieval
285
- */
286
- id: string;
287
- /**
288
- * Text content of the document
289
- */
290
- text: string;
291
- metadata: SearchKnowledgeMetadata;
292
- /**
293
- * The score of the document
294
- */
295
- score: number;
296
- /**
297
- * The rerank score of the document
298
- */
299
- rerankScore?: number | undefined;
300
- };
301
-
302
- /**
303
- * Knowledge successfully retrieved
304
- */
305
- export type SearchKnowledgeResponseBody = {
306
- /**
307
- * Unique id of the knowledge base
308
- */
309
- knowledgeId: string;
310
- /**
311
- * The documents returned
312
- */
313
- documents: Array<SearchKnowledgeDocuments>;
314
- /**
315
- * The key of the knowledge base
316
- */
317
- knowledgeKey: string;
318
- /**
319
- * The query used to search the knowledge base
320
- */
321
- query: string;
322
- };
323
-
324
- /** @internal */
325
- export const SearchKnowledgeRetrievalConfigKnowledgeType$inboundSchema:
326
- z.ZodNativeEnum<typeof SearchKnowledgeRetrievalConfigKnowledgeType> = z
327
- .nativeEnum(SearchKnowledgeRetrievalConfigKnowledgeType);
328
-
329
- /** @internal */
330
- export const SearchKnowledgeRetrievalConfigKnowledgeType$outboundSchema:
331
- z.ZodNativeEnum<typeof SearchKnowledgeRetrievalConfigKnowledgeType> =
332
- SearchKnowledgeRetrievalConfigKnowledgeType$inboundSchema;
333
-
334
- /**
335
- * @internal
336
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
337
- */
338
- export namespace SearchKnowledgeRetrievalConfigKnowledgeType$ {
339
- /** @deprecated use `SearchKnowledgeRetrievalConfigKnowledgeType$inboundSchema` instead. */
340
- export const inboundSchema =
341
- SearchKnowledgeRetrievalConfigKnowledgeType$inboundSchema;
342
- /** @deprecated use `SearchKnowledgeRetrievalConfigKnowledgeType$outboundSchema` instead. */
343
- export const outboundSchema =
344
- SearchKnowledgeRetrievalConfigKnowledgeType$outboundSchema;
345
- }
346
-
347
- /** @internal */
348
- export const SearchKnowledgeRetrievalConfigKnowledgeProvider$inboundSchema:
349
- z.ZodNativeEnum<typeof SearchKnowledgeRetrievalConfigKnowledgeProvider> = z
350
- .nativeEnum(SearchKnowledgeRetrievalConfigKnowledgeProvider);
351
-
352
- /** @internal */
353
- export const SearchKnowledgeRetrievalConfigKnowledgeProvider$outboundSchema:
354
- z.ZodNativeEnum<typeof SearchKnowledgeRetrievalConfigKnowledgeProvider> =
355
- SearchKnowledgeRetrievalConfigKnowledgeProvider$inboundSchema;
356
-
357
- /**
358
- * @internal
359
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
360
- */
361
- export namespace SearchKnowledgeRetrievalConfigKnowledgeProvider$ {
362
- /** @deprecated use `SearchKnowledgeRetrievalConfigKnowledgeProvider$inboundSchema` instead. */
363
- export const inboundSchema =
364
- SearchKnowledgeRetrievalConfigKnowledgeProvider$inboundSchema;
365
- /** @deprecated use `SearchKnowledgeRetrievalConfigKnowledgeProvider$outboundSchema` instead. */
366
- export const outboundSchema =
367
- SearchKnowledgeRetrievalConfigKnowledgeProvider$outboundSchema;
368
- }
369
-
370
- /** @internal */
371
- export const SearchKnowledgeRetrievalConfigKnowledgeModelType$inboundSchema:
372
- z.ZodNativeEnum<typeof SearchKnowledgeRetrievalConfigKnowledgeModelType> = z
373
- .nativeEnum(SearchKnowledgeRetrievalConfigKnowledgeModelType);
374
-
375
- /** @internal */
376
- export const SearchKnowledgeRetrievalConfigKnowledgeModelType$outboundSchema:
377
- z.ZodNativeEnum<typeof SearchKnowledgeRetrievalConfigKnowledgeModelType> =
378
- SearchKnowledgeRetrievalConfigKnowledgeModelType$inboundSchema;
379
-
380
- /**
381
- * @internal
382
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
383
- */
384
- export namespace SearchKnowledgeRetrievalConfigKnowledgeModelType$ {
385
- /** @deprecated use `SearchKnowledgeRetrievalConfigKnowledgeModelType$inboundSchema` instead. */
386
- export const inboundSchema =
387
- SearchKnowledgeRetrievalConfigKnowledgeModelType$inboundSchema;
388
- /** @deprecated use `SearchKnowledgeRetrievalConfigKnowledgeModelType$outboundSchema` instead. */
389
- export const outboundSchema =
390
- SearchKnowledgeRetrievalConfigKnowledgeModelType$outboundSchema;
391
- }
392
-
393
- /** @internal */
394
- export const SearchKnowledgeRetrievalConfigKnowledgeModelParameters$inboundSchema:
395
- z.ZodType<
396
- SearchKnowledgeRetrievalConfigKnowledgeModelParameters,
397
- z.ZodTypeDef,
398
- unknown
399
- > = z.object({
400
- threshold: z.number().optional(),
401
- });
402
-
403
- /** @internal */
404
- export type SearchKnowledgeRetrievalConfigKnowledgeModelParameters$Outbound = {
405
- threshold?: number | undefined;
406
- };
407
-
408
- /** @internal */
409
- export const SearchKnowledgeRetrievalConfigKnowledgeModelParameters$outboundSchema:
410
- z.ZodType<
411
- SearchKnowledgeRetrievalConfigKnowledgeModelParameters$Outbound,
412
- z.ZodTypeDef,
413
- SearchKnowledgeRetrievalConfigKnowledgeModelParameters
414
- > = z.object({
415
- threshold: z.number().optional(),
416
- });
417
-
418
- /**
419
- * @internal
420
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
421
- */
422
- export namespace SearchKnowledgeRetrievalConfigKnowledgeModelParameters$ {
423
- /** @deprecated use `SearchKnowledgeRetrievalConfigKnowledgeModelParameters$inboundSchema` instead. */
424
- export const inboundSchema =
425
- SearchKnowledgeRetrievalConfigKnowledgeModelParameters$inboundSchema;
426
- /** @deprecated use `SearchKnowledgeRetrievalConfigKnowledgeModelParameters$outboundSchema` instead. */
427
- export const outboundSchema =
428
- SearchKnowledgeRetrievalConfigKnowledgeModelParameters$outboundSchema;
429
- /** @deprecated use `SearchKnowledgeRetrievalConfigKnowledgeModelParameters$Outbound` instead. */
430
- export type Outbound =
431
- SearchKnowledgeRetrievalConfigKnowledgeModelParameters$Outbound;
432
- }
433
-
434
- export function searchKnowledgeRetrievalConfigKnowledgeModelParametersToJSON(
435
- searchKnowledgeRetrievalConfigKnowledgeModelParameters:
436
- SearchKnowledgeRetrievalConfigKnowledgeModelParameters,
437
- ): string {
438
- return JSON.stringify(
439
- SearchKnowledgeRetrievalConfigKnowledgeModelParameters$outboundSchema.parse(
440
- searchKnowledgeRetrievalConfigKnowledgeModelParameters,
441
- ),
442
- );
443
- }
444
-
445
- export function searchKnowledgeRetrievalConfigKnowledgeModelParametersFromJSON(
446
- jsonString: string,
447
- ): SafeParseResult<
448
- SearchKnowledgeRetrievalConfigKnowledgeModelParameters,
449
- SDKValidationError
450
- > {
451
- return safeParse(
452
- jsonString,
453
- (x) =>
454
- SearchKnowledgeRetrievalConfigKnowledgeModelParameters$inboundSchema
455
- .parse(JSON.parse(x)),
456
- `Failed to parse 'SearchKnowledgeRetrievalConfigKnowledgeModelParameters' from JSON`,
457
- );
458
- }
459
-
460
- /** @internal */
461
- export const SearchKnowledgeRetrievalConfigRerankConfigInput$inboundSchema:
462
- z.ZodType<
463
- SearchKnowledgeRetrievalConfigRerankConfigInput,
464
- z.ZodTypeDef,
465
- unknown
466
- > = z.object({
467
- enabled: z.boolean().optional(),
468
- provider: SearchKnowledgeRetrievalConfigKnowledgeProvider$inboundSchema
469
- .optional(),
470
- model: z.string().optional(),
471
- model_db_id: z.string().optional(),
472
- model_type: SearchKnowledgeRetrievalConfigKnowledgeModelType$inboundSchema
473
- .optional(),
474
- model_parameters: z.lazy(() =>
475
- SearchKnowledgeRetrievalConfigKnowledgeModelParameters$inboundSchema
476
- ).optional(),
477
- }).transform((v) => {
478
- return remap$(v, {
479
- "model_db_id": "modelDbId",
480
- "model_type": "modelType",
481
- "model_parameters": "modelParameters",
482
- });
483
- });
484
-
485
- /** @internal */
486
- export type SearchKnowledgeRetrievalConfigRerankConfigInput$Outbound = {
487
- enabled?: boolean | undefined;
488
- provider?: string | undefined;
489
- model?: string | undefined;
490
- model_db_id?: string | undefined;
491
- model_type?: string | undefined;
492
- model_parameters?:
493
- | SearchKnowledgeRetrievalConfigKnowledgeModelParameters$Outbound
494
- | undefined;
495
- };
496
-
497
- /** @internal */
498
- export const SearchKnowledgeRetrievalConfigRerankConfigInput$outboundSchema:
499
- z.ZodType<
500
- SearchKnowledgeRetrievalConfigRerankConfigInput$Outbound,
501
- z.ZodTypeDef,
502
- SearchKnowledgeRetrievalConfigRerankConfigInput
503
- > = z.object({
504
- enabled: z.boolean().optional(),
505
- provider: SearchKnowledgeRetrievalConfigKnowledgeProvider$outboundSchema
506
- .optional(),
507
- model: z.string().optional(),
508
- modelDbId: z.string().optional(),
509
- modelType: SearchKnowledgeRetrievalConfigKnowledgeModelType$outboundSchema
510
- .optional(),
511
- modelParameters: z.lazy(() =>
512
- SearchKnowledgeRetrievalConfigKnowledgeModelParameters$outboundSchema
513
- ).optional(),
514
- }).transform((v) => {
515
- return remap$(v, {
516
- modelDbId: "model_db_id",
517
- modelType: "model_type",
518
- modelParameters: "model_parameters",
519
- });
520
- });
521
-
522
- /**
523
- * @internal
524
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
525
- */
526
- export namespace SearchKnowledgeRetrievalConfigRerankConfigInput$ {
527
- /** @deprecated use `SearchKnowledgeRetrievalConfigRerankConfigInput$inboundSchema` instead. */
528
- export const inboundSchema =
529
- SearchKnowledgeRetrievalConfigRerankConfigInput$inboundSchema;
530
- /** @deprecated use `SearchKnowledgeRetrievalConfigRerankConfigInput$outboundSchema` instead. */
531
- export const outboundSchema =
532
- SearchKnowledgeRetrievalConfigRerankConfigInput$outboundSchema;
533
- /** @deprecated use `SearchKnowledgeRetrievalConfigRerankConfigInput$Outbound` instead. */
534
- export type Outbound =
535
- SearchKnowledgeRetrievalConfigRerankConfigInput$Outbound;
536
- }
537
-
538
- export function searchKnowledgeRetrievalConfigRerankConfigInputToJSON(
539
- searchKnowledgeRetrievalConfigRerankConfigInput:
540
- SearchKnowledgeRetrievalConfigRerankConfigInput,
541
- ): string {
542
- return JSON.stringify(
543
- SearchKnowledgeRetrievalConfigRerankConfigInput$outboundSchema.parse(
544
- searchKnowledgeRetrievalConfigRerankConfigInput,
545
- ),
546
- );
547
- }
548
-
549
- export function searchKnowledgeRetrievalConfigRerankConfigInputFromJSON(
550
- jsonString: string,
551
- ): SafeParseResult<
552
- SearchKnowledgeRetrievalConfigRerankConfigInput,
553
- SDKValidationError
554
- > {
555
- return safeParse(
556
- jsonString,
557
- (x) =>
558
- SearchKnowledgeRetrievalConfigRerankConfigInput$inboundSchema.parse(
559
- JSON.parse(x),
560
- ),
561
- `Failed to parse 'SearchKnowledgeRetrievalConfigRerankConfigInput' from JSON`,
562
- );
563
- }
564
-
565
- /** @internal */
566
- export const RetrievalConfig3$inboundSchema: z.ZodType<
567
- RetrievalConfig3,
568
- z.ZodTypeDef,
569
- unknown
570
- > = z.object({
571
- type: SearchKnowledgeRetrievalConfigKnowledgeType$inboundSchema,
572
- top_k: z.number().int().default(5),
573
- threshold: z.number().default(0),
574
- rerank_config: z.nullable(
575
- z.lazy(() => SearchKnowledgeRetrievalConfigRerankConfigInput$inboundSchema),
576
- ).optional(),
577
- }).transform((v) => {
578
- return remap$(v, {
579
- "top_k": "topK",
580
- "rerank_config": "rerankConfig",
581
- });
582
- });
583
-
584
- /** @internal */
585
- export type RetrievalConfig3$Outbound = {
586
- type: string;
587
- top_k: number;
588
- threshold: number;
589
- rerank_config?:
590
- | SearchKnowledgeRetrievalConfigRerankConfigInput$Outbound
591
- | null
592
- | undefined;
593
- };
594
-
595
- /** @internal */
596
- export const RetrievalConfig3$outboundSchema: z.ZodType<
597
- RetrievalConfig3$Outbound,
598
- z.ZodTypeDef,
599
- RetrievalConfig3
600
- > = z.object({
601
- type: SearchKnowledgeRetrievalConfigKnowledgeType$outboundSchema,
602
- topK: z.number().int().default(5),
603
- threshold: z.number().default(0),
604
- rerankConfig: z.nullable(
605
- z.lazy(() =>
606
- SearchKnowledgeRetrievalConfigRerankConfigInput$outboundSchema
607
- ),
608
- ).optional(),
609
- }).transform((v) => {
610
- return remap$(v, {
611
- topK: "top_k",
612
- rerankConfig: "rerank_config",
613
- });
614
- });
615
-
616
- /**
617
- * @internal
618
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
619
- */
620
- export namespace RetrievalConfig3$ {
621
- /** @deprecated use `RetrievalConfig3$inboundSchema` instead. */
622
- export const inboundSchema = RetrievalConfig3$inboundSchema;
623
- /** @deprecated use `RetrievalConfig3$outboundSchema` instead. */
624
- export const outboundSchema = RetrievalConfig3$outboundSchema;
625
- /** @deprecated use `RetrievalConfig3$Outbound` instead. */
626
- export type Outbound = RetrievalConfig3$Outbound;
627
- }
628
-
629
- export function retrievalConfig3ToJSON(
630
- retrievalConfig3: RetrievalConfig3,
631
- ): string {
632
- return JSON.stringify(
633
- RetrievalConfig3$outboundSchema.parse(retrievalConfig3),
634
- );
635
- }
636
-
637
- export function retrievalConfig3FromJSON(
638
- jsonString: string,
639
- ): SafeParseResult<RetrievalConfig3, SDKValidationError> {
640
- return safeParse(
641
- jsonString,
642
- (x) => RetrievalConfig3$inboundSchema.parse(JSON.parse(x)),
643
- `Failed to parse 'RetrievalConfig3' from JSON`,
644
- );
645
- }
646
-
647
- /** @internal */
648
- export const SearchKnowledgeRetrievalConfigType$inboundSchema: z.ZodNativeEnum<
649
- typeof SearchKnowledgeRetrievalConfigType
650
- > = z.nativeEnum(SearchKnowledgeRetrievalConfigType);
651
-
652
- /** @internal */
653
- export const SearchKnowledgeRetrievalConfigType$outboundSchema: z.ZodNativeEnum<
654
- typeof SearchKnowledgeRetrievalConfigType
655
- > = SearchKnowledgeRetrievalConfigType$inboundSchema;
656
-
657
- /**
658
- * @internal
659
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
660
- */
661
- export namespace SearchKnowledgeRetrievalConfigType$ {
662
- /** @deprecated use `SearchKnowledgeRetrievalConfigType$inboundSchema` instead. */
663
- export const inboundSchema = SearchKnowledgeRetrievalConfigType$inboundSchema;
664
- /** @deprecated use `SearchKnowledgeRetrievalConfigType$outboundSchema` instead. */
665
- export const outboundSchema =
666
- SearchKnowledgeRetrievalConfigType$outboundSchema;
667
- }
668
-
669
- /** @internal */
670
- export const SearchKnowledgeRetrievalConfigProvider$inboundSchema:
671
- z.ZodNativeEnum<typeof SearchKnowledgeRetrievalConfigProvider> = z.nativeEnum(
672
- SearchKnowledgeRetrievalConfigProvider,
673
- );
674
-
675
- /** @internal */
676
- export const SearchKnowledgeRetrievalConfigProvider$outboundSchema:
677
- z.ZodNativeEnum<typeof SearchKnowledgeRetrievalConfigProvider> =
678
- SearchKnowledgeRetrievalConfigProvider$inboundSchema;
679
-
680
- /**
681
- * @internal
682
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
683
- */
684
- export namespace SearchKnowledgeRetrievalConfigProvider$ {
685
- /** @deprecated use `SearchKnowledgeRetrievalConfigProvider$inboundSchema` instead. */
686
- export const inboundSchema =
687
- SearchKnowledgeRetrievalConfigProvider$inboundSchema;
688
- /** @deprecated use `SearchKnowledgeRetrievalConfigProvider$outboundSchema` instead. */
689
- export const outboundSchema =
690
- SearchKnowledgeRetrievalConfigProvider$outboundSchema;
691
- }
692
-
693
- /** @internal */
694
- export const SearchKnowledgeRetrievalConfigModelType$inboundSchema:
695
- z.ZodNativeEnum<typeof SearchKnowledgeRetrievalConfigModelType> = z
696
- .nativeEnum(SearchKnowledgeRetrievalConfigModelType);
697
-
698
- /** @internal */
699
- export const SearchKnowledgeRetrievalConfigModelType$outboundSchema:
700
- z.ZodNativeEnum<typeof SearchKnowledgeRetrievalConfigModelType> =
701
- SearchKnowledgeRetrievalConfigModelType$inboundSchema;
702
-
703
- /**
704
- * @internal
705
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
706
- */
707
- export namespace SearchKnowledgeRetrievalConfigModelType$ {
708
- /** @deprecated use `SearchKnowledgeRetrievalConfigModelType$inboundSchema` instead. */
709
- export const inboundSchema =
710
- SearchKnowledgeRetrievalConfigModelType$inboundSchema;
711
- /** @deprecated use `SearchKnowledgeRetrievalConfigModelType$outboundSchema` instead. */
712
- export const outboundSchema =
713
- SearchKnowledgeRetrievalConfigModelType$outboundSchema;
714
- }
715
-
716
- /** @internal */
717
- export const SearchKnowledgeRetrievalConfigModelParameters$inboundSchema:
718
- z.ZodType<
719
- SearchKnowledgeRetrievalConfigModelParameters,
720
- z.ZodTypeDef,
721
- unknown
722
- > = z.object({
723
- threshold: z.number().optional(),
724
- });
725
-
726
- /** @internal */
727
- export type SearchKnowledgeRetrievalConfigModelParameters$Outbound = {
728
- threshold?: number | undefined;
729
- };
730
-
731
- /** @internal */
732
- export const SearchKnowledgeRetrievalConfigModelParameters$outboundSchema:
733
- z.ZodType<
734
- SearchKnowledgeRetrievalConfigModelParameters$Outbound,
735
- z.ZodTypeDef,
736
- SearchKnowledgeRetrievalConfigModelParameters
737
- > = z.object({
738
- threshold: z.number().optional(),
739
- });
740
-
741
- /**
742
- * @internal
743
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
744
- */
745
- export namespace SearchKnowledgeRetrievalConfigModelParameters$ {
746
- /** @deprecated use `SearchKnowledgeRetrievalConfigModelParameters$inboundSchema` instead. */
747
- export const inboundSchema =
748
- SearchKnowledgeRetrievalConfigModelParameters$inboundSchema;
749
- /** @deprecated use `SearchKnowledgeRetrievalConfigModelParameters$outboundSchema` instead. */
750
- export const outboundSchema =
751
- SearchKnowledgeRetrievalConfigModelParameters$outboundSchema;
752
- /** @deprecated use `SearchKnowledgeRetrievalConfigModelParameters$Outbound` instead. */
753
- export type Outbound = SearchKnowledgeRetrievalConfigModelParameters$Outbound;
754
- }
755
-
756
- export function searchKnowledgeRetrievalConfigModelParametersToJSON(
757
- searchKnowledgeRetrievalConfigModelParameters:
758
- SearchKnowledgeRetrievalConfigModelParameters,
759
- ): string {
760
- return JSON.stringify(
761
- SearchKnowledgeRetrievalConfigModelParameters$outboundSchema.parse(
762
- searchKnowledgeRetrievalConfigModelParameters,
763
- ),
764
- );
765
- }
766
-
767
- export function searchKnowledgeRetrievalConfigModelParametersFromJSON(
768
- jsonString: string,
769
- ): SafeParseResult<
770
- SearchKnowledgeRetrievalConfigModelParameters,
771
- SDKValidationError
772
- > {
773
- return safeParse(
774
- jsonString,
775
- (x) =>
776
- SearchKnowledgeRetrievalConfigModelParameters$inboundSchema.parse(
777
- JSON.parse(x),
778
- ),
779
- `Failed to parse 'SearchKnowledgeRetrievalConfigModelParameters' from JSON`,
780
- );
781
- }
782
-
783
- /** @internal */
784
- export const SearchKnowledgeRetrievalConfigRerankConfig$inboundSchema:
785
- z.ZodType<SearchKnowledgeRetrievalConfigRerankConfig, z.ZodTypeDef, unknown> =
786
- z.object({
787
- enabled: z.boolean().optional(),
788
- provider: SearchKnowledgeRetrievalConfigProvider$inboundSchema.optional(),
789
- model: z.string().optional(),
790
- model_db_id: z.string().optional(),
791
- model_type: SearchKnowledgeRetrievalConfigModelType$inboundSchema
792
- .optional(),
793
- model_parameters: z.lazy(() =>
794
- SearchKnowledgeRetrievalConfigModelParameters$inboundSchema
795
- ).optional(),
796
- }).transform((v) => {
797
- return remap$(v, {
798
- "model_db_id": "modelDbId",
799
- "model_type": "modelType",
800
- "model_parameters": "modelParameters",
801
- });
802
- });
803
-
804
- /** @internal */
805
- export type SearchKnowledgeRetrievalConfigRerankConfig$Outbound = {
806
- enabled?: boolean | undefined;
807
- provider?: string | undefined;
808
- model?: string | undefined;
809
- model_db_id?: string | undefined;
810
- model_type?: string | undefined;
811
- model_parameters?:
812
- | SearchKnowledgeRetrievalConfigModelParameters$Outbound
813
- | undefined;
814
- };
815
-
816
- /** @internal */
817
- export const SearchKnowledgeRetrievalConfigRerankConfig$outboundSchema:
818
- z.ZodType<
819
- SearchKnowledgeRetrievalConfigRerankConfig$Outbound,
820
- z.ZodTypeDef,
821
- SearchKnowledgeRetrievalConfigRerankConfig
822
- > = z.object({
823
- enabled: z.boolean().optional(),
824
- provider: SearchKnowledgeRetrievalConfigProvider$outboundSchema.optional(),
825
- model: z.string().optional(),
826
- modelDbId: z.string().optional(),
827
- modelType: SearchKnowledgeRetrievalConfigModelType$outboundSchema
828
- .optional(),
829
- modelParameters: z.lazy(() =>
830
- SearchKnowledgeRetrievalConfigModelParameters$outboundSchema
831
- ).optional(),
832
- }).transform((v) => {
833
- return remap$(v, {
834
- modelDbId: "model_db_id",
835
- modelType: "model_type",
836
- modelParameters: "model_parameters",
837
- });
838
- });
839
-
840
- /**
841
- * @internal
842
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
843
- */
844
- export namespace SearchKnowledgeRetrievalConfigRerankConfig$ {
845
- /** @deprecated use `SearchKnowledgeRetrievalConfigRerankConfig$inboundSchema` instead. */
846
- export const inboundSchema =
847
- SearchKnowledgeRetrievalConfigRerankConfig$inboundSchema;
848
- /** @deprecated use `SearchKnowledgeRetrievalConfigRerankConfig$outboundSchema` instead. */
849
- export const outboundSchema =
850
- SearchKnowledgeRetrievalConfigRerankConfig$outboundSchema;
851
- /** @deprecated use `SearchKnowledgeRetrievalConfigRerankConfig$Outbound` instead. */
852
- export type Outbound = SearchKnowledgeRetrievalConfigRerankConfig$Outbound;
853
- }
854
-
855
- export function searchKnowledgeRetrievalConfigRerankConfigToJSON(
856
- searchKnowledgeRetrievalConfigRerankConfig:
857
- SearchKnowledgeRetrievalConfigRerankConfig,
858
- ): string {
859
- return JSON.stringify(
860
- SearchKnowledgeRetrievalConfigRerankConfig$outboundSchema.parse(
861
- searchKnowledgeRetrievalConfigRerankConfig,
862
- ),
863
- );
864
- }
865
-
866
- export function searchKnowledgeRetrievalConfigRerankConfigFromJSON(
867
- jsonString: string,
868
- ): SafeParseResult<
869
- SearchKnowledgeRetrievalConfigRerankConfig,
870
- SDKValidationError
871
- > {
872
- return safeParse(
873
- jsonString,
874
- (x) =>
875
- SearchKnowledgeRetrievalConfigRerankConfig$inboundSchema.parse(
876
- JSON.parse(x),
877
- ),
878
- `Failed to parse 'SearchKnowledgeRetrievalConfigRerankConfig' from JSON`,
879
- );
880
- }
881
-
882
- /** @internal */
883
- export const RetrievalConfig2$inboundSchema: z.ZodType<
884
- RetrievalConfig2,
885
- z.ZodTypeDef,
886
- unknown
887
- > = z.object({
888
- type: SearchKnowledgeRetrievalConfigType$inboundSchema,
889
- top_k: z.number().int().default(5),
890
- threshold: z.number().default(0),
891
- rerank_config: z.nullable(
892
- z.lazy(() => SearchKnowledgeRetrievalConfigRerankConfig$inboundSchema),
893
- ).optional(),
894
- }).transform((v) => {
895
- return remap$(v, {
896
- "top_k": "topK",
897
- "rerank_config": "rerankConfig",
898
- });
899
- });
900
-
901
- /** @internal */
902
- export type RetrievalConfig2$Outbound = {
903
- type: string;
904
- top_k: number;
905
- threshold: number;
906
- rerank_config?:
907
- | SearchKnowledgeRetrievalConfigRerankConfig$Outbound
908
- | null
909
- | undefined;
910
- };
911
-
912
- /** @internal */
913
- export const RetrievalConfig2$outboundSchema: z.ZodType<
914
- RetrievalConfig2$Outbound,
915
- z.ZodTypeDef,
916
- RetrievalConfig2
917
- > = z.object({
918
- type: SearchKnowledgeRetrievalConfigType$outboundSchema,
919
- topK: z.number().int().default(5),
920
- threshold: z.number().default(0),
921
- rerankConfig: z.nullable(
922
- z.lazy(() => SearchKnowledgeRetrievalConfigRerankConfig$outboundSchema),
923
- ).optional(),
924
- }).transform((v) => {
925
- return remap$(v, {
926
- topK: "top_k",
927
- rerankConfig: "rerank_config",
928
- });
929
- });
930
-
931
- /**
932
- * @internal
933
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
934
- */
935
- export namespace RetrievalConfig2$ {
936
- /** @deprecated use `RetrievalConfig2$inboundSchema` instead. */
937
- export const inboundSchema = RetrievalConfig2$inboundSchema;
938
- /** @deprecated use `RetrievalConfig2$outboundSchema` instead. */
939
- export const outboundSchema = RetrievalConfig2$outboundSchema;
940
- /** @deprecated use `RetrievalConfig2$Outbound` instead. */
941
- export type Outbound = RetrievalConfig2$Outbound;
942
- }
943
-
944
- export function retrievalConfig2ToJSON(
945
- retrievalConfig2: RetrievalConfig2,
946
- ): string {
947
- return JSON.stringify(
948
- RetrievalConfig2$outboundSchema.parse(retrievalConfig2),
949
- );
950
- }
951
-
952
- export function retrievalConfig2FromJSON(
953
- jsonString: string,
954
- ): SafeParseResult<RetrievalConfig2, SDKValidationError> {
955
- return safeParse(
956
- jsonString,
957
- (x) => RetrievalConfig2$inboundSchema.parse(JSON.parse(x)),
958
- `Failed to parse 'RetrievalConfig2' from JSON`,
959
- );
960
- }
961
-
962
- /** @internal */
963
- export const RetrievalConfigType$inboundSchema: z.ZodNativeEnum<
964
- typeof RetrievalConfigType
965
- > = z.nativeEnum(RetrievalConfigType);
966
-
967
- /** @internal */
968
- export const RetrievalConfigType$outboundSchema: z.ZodNativeEnum<
969
- typeof RetrievalConfigType
970
- > = RetrievalConfigType$inboundSchema;
971
-
972
- /**
973
- * @internal
974
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
975
- */
976
- export namespace RetrievalConfigType$ {
977
- /** @deprecated use `RetrievalConfigType$inboundSchema` instead. */
978
- export const inboundSchema = RetrievalConfigType$inboundSchema;
979
- /** @deprecated use `RetrievalConfigType$outboundSchema` instead. */
980
- export const outboundSchema = RetrievalConfigType$outboundSchema;
981
- }
982
-
983
- /** @internal */
984
- export const RetrievalConfigProvider$inboundSchema: z.ZodNativeEnum<
985
- typeof RetrievalConfigProvider
986
- > = z.nativeEnum(RetrievalConfigProvider);
987
-
988
- /** @internal */
989
- export const RetrievalConfigProvider$outboundSchema: z.ZodNativeEnum<
990
- typeof RetrievalConfigProvider
991
- > = RetrievalConfigProvider$inboundSchema;
992
-
993
- /**
994
- * @internal
995
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
996
- */
997
- export namespace RetrievalConfigProvider$ {
998
- /** @deprecated use `RetrievalConfigProvider$inboundSchema` instead. */
999
- export const inboundSchema = RetrievalConfigProvider$inboundSchema;
1000
- /** @deprecated use `RetrievalConfigProvider$outboundSchema` instead. */
1001
- export const outboundSchema = RetrievalConfigProvider$outboundSchema;
1002
- }
1003
-
1004
- /** @internal */
1005
- export const RetrievalConfigModelType$inboundSchema: z.ZodNativeEnum<
1006
- typeof RetrievalConfigModelType
1007
- > = z.nativeEnum(RetrievalConfigModelType);
1008
-
1009
- /** @internal */
1010
- export const RetrievalConfigModelType$outboundSchema: z.ZodNativeEnum<
1011
- typeof RetrievalConfigModelType
1012
- > = RetrievalConfigModelType$inboundSchema;
1013
-
1014
- /**
1015
- * @internal
1016
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
1017
- */
1018
- export namespace RetrievalConfigModelType$ {
1019
- /** @deprecated use `RetrievalConfigModelType$inboundSchema` instead. */
1020
- export const inboundSchema = RetrievalConfigModelType$inboundSchema;
1021
- /** @deprecated use `RetrievalConfigModelType$outboundSchema` instead. */
1022
- export const outboundSchema = RetrievalConfigModelType$outboundSchema;
1023
- }
1024
-
1025
- /** @internal */
1026
- export const RetrievalConfigModelParameters$inboundSchema: z.ZodType<
1027
- RetrievalConfigModelParameters,
1028
- z.ZodTypeDef,
1029
- unknown
1030
- > = z.object({
1031
- threshold: z.number().optional(),
1032
- });
1033
-
1034
- /** @internal */
1035
- export type RetrievalConfigModelParameters$Outbound = {
1036
- threshold?: number | undefined;
1037
- };
1038
-
1039
- /** @internal */
1040
- export const RetrievalConfigModelParameters$outboundSchema: z.ZodType<
1041
- RetrievalConfigModelParameters$Outbound,
1042
- z.ZodTypeDef,
1043
- RetrievalConfigModelParameters
1044
- > = z.object({
1045
- threshold: z.number().optional(),
1046
- });
1047
-
1048
- /**
1049
- * @internal
1050
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
1051
- */
1052
- export namespace RetrievalConfigModelParameters$ {
1053
- /** @deprecated use `RetrievalConfigModelParameters$inboundSchema` instead. */
1054
- export const inboundSchema = RetrievalConfigModelParameters$inboundSchema;
1055
- /** @deprecated use `RetrievalConfigModelParameters$outboundSchema` instead. */
1056
- export const outboundSchema = RetrievalConfigModelParameters$outboundSchema;
1057
- /** @deprecated use `RetrievalConfigModelParameters$Outbound` instead. */
1058
- export type Outbound = RetrievalConfigModelParameters$Outbound;
1059
- }
1060
-
1061
- export function retrievalConfigModelParametersToJSON(
1062
- retrievalConfigModelParameters: RetrievalConfigModelParameters,
1063
- ): string {
1064
- return JSON.stringify(
1065
- RetrievalConfigModelParameters$outboundSchema.parse(
1066
- retrievalConfigModelParameters,
1067
- ),
1068
- );
1069
- }
1070
-
1071
- export function retrievalConfigModelParametersFromJSON(
1072
- jsonString: string,
1073
- ): SafeParseResult<RetrievalConfigModelParameters, SDKValidationError> {
1074
- return safeParse(
1075
- jsonString,
1076
- (x) => RetrievalConfigModelParameters$inboundSchema.parse(JSON.parse(x)),
1077
- `Failed to parse 'RetrievalConfigModelParameters' from JSON`,
1078
- );
1079
- }
1080
-
1081
- /** @internal */
1082
- export const RetrievalConfigRerankConfig$inboundSchema: z.ZodType<
1083
- RetrievalConfigRerankConfig,
1084
- z.ZodTypeDef,
1085
- unknown
1086
- > = z.object({
1087
- enabled: z.boolean().optional(),
1088
- provider: RetrievalConfigProvider$inboundSchema.optional(),
1089
- model: z.string().optional(),
1090
- model_db_id: z.string().optional(),
1091
- model_type: RetrievalConfigModelType$inboundSchema.optional(),
1092
- model_parameters: z.lazy(() => RetrievalConfigModelParameters$inboundSchema)
1093
- .optional(),
1094
- }).transform((v) => {
1095
- return remap$(v, {
1096
- "model_db_id": "modelDbId",
1097
- "model_type": "modelType",
1098
- "model_parameters": "modelParameters",
1099
- });
1100
- });
1101
-
1102
- /** @internal */
1103
- export type RetrievalConfigRerankConfig$Outbound = {
1104
- enabled?: boolean | undefined;
1105
- provider?: string | undefined;
1106
- model?: string | undefined;
1107
- model_db_id?: string | undefined;
1108
- model_type?: string | undefined;
1109
- model_parameters?: RetrievalConfigModelParameters$Outbound | undefined;
1110
- };
1111
-
1112
- /** @internal */
1113
- export const RetrievalConfigRerankConfig$outboundSchema: z.ZodType<
1114
- RetrievalConfigRerankConfig$Outbound,
1115
- z.ZodTypeDef,
1116
- RetrievalConfigRerankConfig
1117
- > = z.object({
1118
- enabled: z.boolean().optional(),
1119
- provider: RetrievalConfigProvider$outboundSchema.optional(),
1120
- model: z.string().optional(),
1121
- modelDbId: z.string().optional(),
1122
- modelType: RetrievalConfigModelType$outboundSchema.optional(),
1123
- modelParameters: z.lazy(() => RetrievalConfigModelParameters$outboundSchema)
1124
- .optional(),
1125
- }).transform((v) => {
1126
- return remap$(v, {
1127
- modelDbId: "model_db_id",
1128
- modelType: "model_type",
1129
- modelParameters: "model_parameters",
1130
- });
1131
- });
1132
-
1133
- /**
1134
- * @internal
1135
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
1136
- */
1137
- export namespace RetrievalConfigRerankConfig$ {
1138
- /** @deprecated use `RetrievalConfigRerankConfig$inboundSchema` instead. */
1139
- export const inboundSchema = RetrievalConfigRerankConfig$inboundSchema;
1140
- /** @deprecated use `RetrievalConfigRerankConfig$outboundSchema` instead. */
1141
- export const outboundSchema = RetrievalConfigRerankConfig$outboundSchema;
1142
- /** @deprecated use `RetrievalConfigRerankConfig$Outbound` instead. */
1143
- export type Outbound = RetrievalConfigRerankConfig$Outbound;
1144
- }
1145
-
1146
- export function retrievalConfigRerankConfigToJSON(
1147
- retrievalConfigRerankConfig: RetrievalConfigRerankConfig,
1148
- ): string {
1149
- return JSON.stringify(
1150
- RetrievalConfigRerankConfig$outboundSchema.parse(
1151
- retrievalConfigRerankConfig,
1152
- ),
1153
- );
1154
- }
1155
-
1156
- export function retrievalConfigRerankConfigFromJSON(
1157
- jsonString: string,
1158
- ): SafeParseResult<RetrievalConfigRerankConfig, SDKValidationError> {
1159
- return safeParse(
1160
- jsonString,
1161
- (x) => RetrievalConfigRerankConfig$inboundSchema.parse(JSON.parse(x)),
1162
- `Failed to parse 'RetrievalConfigRerankConfig' from JSON`,
1163
- );
1164
- }
1165
-
1166
- /** @internal */
1167
- export const RetrievalConfig1$inboundSchema: z.ZodType<
1168
- RetrievalConfig1,
1169
- z.ZodTypeDef,
1170
- unknown
1171
- > = z.object({
1172
- type: RetrievalConfigType$inboundSchema,
1173
- top_k: z.number().int().default(5),
1174
- threshold: z.number().default(0),
1175
- rerank_config: z.nullable(
1176
- z.lazy(() => RetrievalConfigRerankConfig$inboundSchema),
1177
- ).optional(),
1178
- }).transform((v) => {
1179
- return remap$(v, {
1180
- "top_k": "topK",
1181
- "rerank_config": "rerankConfig",
1182
- });
1183
- });
1184
-
1185
- /** @internal */
1186
- export type RetrievalConfig1$Outbound = {
1187
- type: string;
1188
- top_k: number;
1189
- threshold: number;
1190
- rerank_config?: RetrievalConfigRerankConfig$Outbound | null | undefined;
1191
- };
1192
-
1193
- /** @internal */
1194
- export const RetrievalConfig1$outboundSchema: z.ZodType<
1195
- RetrievalConfig1$Outbound,
1196
- z.ZodTypeDef,
1197
- RetrievalConfig1
1198
- > = z.object({
1199
- type: RetrievalConfigType$outboundSchema,
1200
- topK: z.number().int().default(5),
1201
- threshold: z.number().default(0),
1202
- rerankConfig: z.nullable(
1203
- z.lazy(() => RetrievalConfigRerankConfig$outboundSchema),
1204
- ).optional(),
1205
- }).transform((v) => {
1206
- return remap$(v, {
1207
- topK: "top_k",
1208
- rerankConfig: "rerank_config",
1209
- });
1210
- });
1211
-
1212
- /**
1213
- * @internal
1214
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
1215
- */
1216
- export namespace RetrievalConfig1$ {
1217
- /** @deprecated use `RetrievalConfig1$inboundSchema` instead. */
1218
- export const inboundSchema = RetrievalConfig1$inboundSchema;
1219
- /** @deprecated use `RetrievalConfig1$outboundSchema` instead. */
1220
- export const outboundSchema = RetrievalConfig1$outboundSchema;
1221
- /** @deprecated use `RetrievalConfig1$Outbound` instead. */
1222
- export type Outbound = RetrievalConfig1$Outbound;
1223
- }
1224
-
1225
- export function retrievalConfig1ToJSON(
1226
- retrievalConfig1: RetrievalConfig1,
1227
- ): string {
1228
- return JSON.stringify(
1229
- RetrievalConfig1$outboundSchema.parse(retrievalConfig1),
1230
- );
1231
- }
1232
-
1233
- export function retrievalConfig1FromJSON(
1234
- jsonString: string,
1235
- ): SafeParseResult<RetrievalConfig1, SDKValidationError> {
1236
- return safeParse(
1237
- jsonString,
1238
- (x) => RetrievalConfig1$inboundSchema.parse(JSON.parse(x)),
1239
- `Failed to parse 'RetrievalConfig1' from JSON`,
1240
- );
1241
- }
1242
-
1243
- /** @internal */
1244
- export const RetrievalConfig$inboundSchema: z.ZodType<
1245
- RetrievalConfig,
1246
- z.ZodTypeDef,
1247
- unknown
1248
- > = z.union([
1249
- z.lazy(() => RetrievalConfig1$inboundSchema),
1250
- z.lazy(() => RetrievalConfig2$inboundSchema),
1251
- z.lazy(() => RetrievalConfig3$inboundSchema),
1252
- ]);
1253
-
1254
- /** @internal */
1255
- export type RetrievalConfig$Outbound =
1256
- | RetrievalConfig1$Outbound
1257
- | RetrievalConfig2$Outbound
1258
- | RetrievalConfig3$Outbound;
1259
-
1260
- /** @internal */
1261
- export const RetrievalConfig$outboundSchema: z.ZodType<
1262
- RetrievalConfig$Outbound,
1263
- z.ZodTypeDef,
1264
- RetrievalConfig
1265
- > = z.union([
1266
- z.lazy(() => RetrievalConfig1$outboundSchema),
1267
- z.lazy(() => RetrievalConfig2$outboundSchema),
1268
- z.lazy(() => RetrievalConfig3$outboundSchema),
1269
- ]);
1270
-
1271
- /**
1272
- * @internal
1273
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
1274
- */
1275
- export namespace RetrievalConfig$ {
1276
- /** @deprecated use `RetrievalConfig$inboundSchema` instead. */
1277
- export const inboundSchema = RetrievalConfig$inboundSchema;
1278
- /** @deprecated use `RetrievalConfig$outboundSchema` instead. */
1279
- export const outboundSchema = RetrievalConfig$outboundSchema;
1280
- /** @deprecated use `RetrievalConfig$Outbound` instead. */
1281
- export type Outbound = RetrievalConfig$Outbound;
1282
- }
1283
-
1284
- export function retrievalConfigToJSON(
1285
- retrievalConfig: RetrievalConfig,
1286
- ): string {
1287
- return JSON.stringify(RetrievalConfig$outboundSchema.parse(retrievalConfig));
1288
- }
1289
-
1290
- export function retrievalConfigFromJSON(
1291
- jsonString: string,
1292
- ): SafeParseResult<RetrievalConfig, SDKValidationError> {
1293
- return safeParse(
1294
- jsonString,
1295
- (x) => RetrievalConfig$inboundSchema.parse(JSON.parse(x)),
1296
- `Failed to parse 'RetrievalConfig' from JSON`,
1297
- );
1298
- }
1299
-
1300
- /** @internal */
1301
- export const SearchKnowledgeRequestBody$inboundSchema: z.ZodType<
1302
- SearchKnowledgeRequestBody,
1303
- z.ZodTypeDef,
1304
- unknown
1305
- > = z.object({
1306
- query: z.string(),
1307
- retrieval_config: z.union([
1308
- z.lazy(() => RetrievalConfig1$inboundSchema),
1309
- z.lazy(() => RetrievalConfig2$inboundSchema),
1310
- z.lazy(() => RetrievalConfig3$inboundSchema),
1311
- ]).optional(),
1312
- }).transform((v) => {
1313
- return remap$(v, {
1314
- "retrieval_config": "retrievalConfig",
1315
- });
1316
- });
1317
-
1318
- /** @internal */
1319
- export type SearchKnowledgeRequestBody$Outbound = {
1320
- query: string;
1321
- retrieval_config?:
1322
- | RetrievalConfig1$Outbound
1323
- | RetrievalConfig2$Outbound
1324
- | RetrievalConfig3$Outbound
1325
- | undefined;
1326
- };
1327
-
1328
- /** @internal */
1329
- export const SearchKnowledgeRequestBody$outboundSchema: z.ZodType<
1330
- SearchKnowledgeRequestBody$Outbound,
1331
- z.ZodTypeDef,
1332
- SearchKnowledgeRequestBody
1333
- > = z.object({
1334
- query: z.string(),
1335
- retrievalConfig: z.union([
1336
- z.lazy(() => RetrievalConfig1$outboundSchema),
1337
- z.lazy(() => RetrievalConfig2$outboundSchema),
1338
- z.lazy(() => RetrievalConfig3$outboundSchema),
1339
- ]).optional(),
1340
- }).transform((v) => {
1341
- return remap$(v, {
1342
- retrievalConfig: "retrieval_config",
1343
- });
1344
- });
1345
-
1346
- /**
1347
- * @internal
1348
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
1349
- */
1350
- export namespace SearchKnowledgeRequestBody$ {
1351
- /** @deprecated use `SearchKnowledgeRequestBody$inboundSchema` instead. */
1352
- export const inboundSchema = SearchKnowledgeRequestBody$inboundSchema;
1353
- /** @deprecated use `SearchKnowledgeRequestBody$outboundSchema` instead. */
1354
- export const outboundSchema = SearchKnowledgeRequestBody$outboundSchema;
1355
- /** @deprecated use `SearchKnowledgeRequestBody$Outbound` instead. */
1356
- export type Outbound = SearchKnowledgeRequestBody$Outbound;
1357
- }
1358
-
1359
- export function searchKnowledgeRequestBodyToJSON(
1360
- searchKnowledgeRequestBody: SearchKnowledgeRequestBody,
1361
- ): string {
1362
- return JSON.stringify(
1363
- SearchKnowledgeRequestBody$outboundSchema.parse(searchKnowledgeRequestBody),
1364
- );
1365
- }
1366
-
1367
- export function searchKnowledgeRequestBodyFromJSON(
1368
- jsonString: string,
1369
- ): SafeParseResult<SearchKnowledgeRequestBody, SDKValidationError> {
1370
- return safeParse(
1371
- jsonString,
1372
- (x) => SearchKnowledgeRequestBody$inboundSchema.parse(JSON.parse(x)),
1373
- `Failed to parse 'SearchKnowledgeRequestBody' from JSON`,
1374
- );
1375
- }
1376
-
1377
- /** @internal */
1378
- export const SearchKnowledgeRequest$inboundSchema: z.ZodType<
1379
- SearchKnowledgeRequest,
1380
- z.ZodTypeDef,
1381
- unknown
1382
- > = z.object({
1383
- knowledge_id: z.string(),
1384
- RequestBody: z.lazy(() => SearchKnowledgeRequestBody$inboundSchema),
1385
- }).transform((v) => {
1386
- return remap$(v, {
1387
- "knowledge_id": "knowledgeId",
1388
- "RequestBody": "requestBody",
1389
- });
1390
- });
1391
-
1392
- /** @internal */
1393
- export type SearchKnowledgeRequest$Outbound = {
1394
- knowledge_id: string;
1395
- RequestBody: SearchKnowledgeRequestBody$Outbound;
1396
- };
1397
-
1398
- /** @internal */
1399
- export const SearchKnowledgeRequest$outboundSchema: z.ZodType<
1400
- SearchKnowledgeRequest$Outbound,
1401
- z.ZodTypeDef,
1402
- SearchKnowledgeRequest
1403
- > = z.object({
1404
- knowledgeId: z.string(),
1405
- requestBody: z.lazy(() => SearchKnowledgeRequestBody$outboundSchema),
1406
- }).transform((v) => {
1407
- return remap$(v, {
1408
- knowledgeId: "knowledge_id",
1409
- requestBody: "RequestBody",
1410
- });
1411
- });
1412
-
1413
- /**
1414
- * @internal
1415
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
1416
- */
1417
- export namespace SearchKnowledgeRequest$ {
1418
- /** @deprecated use `SearchKnowledgeRequest$inboundSchema` instead. */
1419
- export const inboundSchema = SearchKnowledgeRequest$inboundSchema;
1420
- /** @deprecated use `SearchKnowledgeRequest$outboundSchema` instead. */
1421
- export const outboundSchema = SearchKnowledgeRequest$outboundSchema;
1422
- /** @deprecated use `SearchKnowledgeRequest$Outbound` instead. */
1423
- export type Outbound = SearchKnowledgeRequest$Outbound;
1424
- }
1425
-
1426
- export function searchKnowledgeRequestToJSON(
1427
- searchKnowledgeRequest: SearchKnowledgeRequest,
1428
- ): string {
1429
- return JSON.stringify(
1430
- SearchKnowledgeRequest$outboundSchema.parse(searchKnowledgeRequest),
1431
- );
1432
- }
1433
-
1434
- export function searchKnowledgeRequestFromJSON(
1435
- jsonString: string,
1436
- ): SafeParseResult<SearchKnowledgeRequest, SDKValidationError> {
1437
- return safeParse(
1438
- jsonString,
1439
- (x) => SearchKnowledgeRequest$inboundSchema.parse(JSON.parse(x)),
1440
- `Failed to parse 'SearchKnowledgeRequest' from JSON`,
1441
- );
1442
- }
1443
-
1444
- /** @internal */
1445
- export const SearchKnowledgeMetadata$inboundSchema: z.ZodType<
1446
- SearchKnowledgeMetadata,
1447
- z.ZodTypeDef,
1448
- unknown
1449
- > = z.object({
1450
- datasource_id: z.string(),
1451
- chunk_id: z.string(),
1452
- file_name: z.string(),
1453
- page_number: z.nullable(z.number()).optional(),
1454
- file_type: z.string(),
1455
- }).transform((v) => {
1456
- return remap$(v, {
1457
- "datasource_id": "datasourceId",
1458
- "chunk_id": "chunkId",
1459
- "file_name": "fileName",
1460
- "page_number": "pageNumber",
1461
- "file_type": "fileType",
1462
- });
1463
- });
1464
-
1465
- /** @internal */
1466
- export type SearchKnowledgeMetadata$Outbound = {
1467
- datasource_id: string;
1468
- chunk_id: string;
1469
- file_name: string;
1470
- page_number?: number | null | undefined;
1471
- file_type: string;
1472
- };
1473
-
1474
- /** @internal */
1475
- export const SearchKnowledgeMetadata$outboundSchema: z.ZodType<
1476
- SearchKnowledgeMetadata$Outbound,
1477
- z.ZodTypeDef,
1478
- SearchKnowledgeMetadata
1479
- > = z.object({
1480
- datasourceId: z.string(),
1481
- chunkId: z.string(),
1482
- fileName: z.string(),
1483
- pageNumber: z.nullable(z.number()).optional(),
1484
- fileType: z.string(),
1485
- }).transform((v) => {
1486
- return remap$(v, {
1487
- datasourceId: "datasource_id",
1488
- chunkId: "chunk_id",
1489
- fileName: "file_name",
1490
- pageNumber: "page_number",
1491
- fileType: "file_type",
1492
- });
1493
- });
1494
-
1495
- /**
1496
- * @internal
1497
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
1498
- */
1499
- export namespace SearchKnowledgeMetadata$ {
1500
- /** @deprecated use `SearchKnowledgeMetadata$inboundSchema` instead. */
1501
- export const inboundSchema = SearchKnowledgeMetadata$inboundSchema;
1502
- /** @deprecated use `SearchKnowledgeMetadata$outboundSchema` instead. */
1503
- export const outboundSchema = SearchKnowledgeMetadata$outboundSchema;
1504
- /** @deprecated use `SearchKnowledgeMetadata$Outbound` instead. */
1505
- export type Outbound = SearchKnowledgeMetadata$Outbound;
1506
- }
1507
-
1508
- export function searchKnowledgeMetadataToJSON(
1509
- searchKnowledgeMetadata: SearchKnowledgeMetadata,
1510
- ): string {
1511
- return JSON.stringify(
1512
- SearchKnowledgeMetadata$outboundSchema.parse(searchKnowledgeMetadata),
1513
- );
1514
- }
1515
-
1516
- export function searchKnowledgeMetadataFromJSON(
1517
- jsonString: string,
1518
- ): SafeParseResult<SearchKnowledgeMetadata, SDKValidationError> {
1519
- return safeParse(
1520
- jsonString,
1521
- (x) => SearchKnowledgeMetadata$inboundSchema.parse(JSON.parse(x)),
1522
- `Failed to parse 'SearchKnowledgeMetadata' from JSON`,
1523
- );
1524
- }
1525
-
1526
- /** @internal */
1527
- export const SearchKnowledgeDocuments$inboundSchema: z.ZodType<
1528
- SearchKnowledgeDocuments,
1529
- z.ZodTypeDef,
1530
- unknown
1531
- > = z.object({
1532
- id: z.string(),
1533
- text: z.string(),
1534
- metadata: z.lazy(() => SearchKnowledgeMetadata$inboundSchema),
1535
- score: z.number(),
1536
- rerank_score: z.number().optional(),
1537
- }).transform((v) => {
1538
- return remap$(v, {
1539
- "rerank_score": "rerankScore",
1540
- });
1541
- });
1542
-
1543
- /** @internal */
1544
- export type SearchKnowledgeDocuments$Outbound = {
1545
- id: string;
1546
- text: string;
1547
- metadata: SearchKnowledgeMetadata$Outbound;
1548
- score: number;
1549
- rerank_score?: number | undefined;
1550
- };
1551
-
1552
- /** @internal */
1553
- export const SearchKnowledgeDocuments$outboundSchema: z.ZodType<
1554
- SearchKnowledgeDocuments$Outbound,
1555
- z.ZodTypeDef,
1556
- SearchKnowledgeDocuments
1557
- > = z.object({
1558
- id: z.string(),
1559
- text: z.string(),
1560
- metadata: z.lazy(() => SearchKnowledgeMetadata$outboundSchema),
1561
- score: z.number(),
1562
- rerankScore: z.number().optional(),
1563
- }).transform((v) => {
1564
- return remap$(v, {
1565
- rerankScore: "rerank_score",
1566
- });
1567
- });
1568
-
1569
- /**
1570
- * @internal
1571
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
1572
- */
1573
- export namespace SearchKnowledgeDocuments$ {
1574
- /** @deprecated use `SearchKnowledgeDocuments$inboundSchema` instead. */
1575
- export const inboundSchema = SearchKnowledgeDocuments$inboundSchema;
1576
- /** @deprecated use `SearchKnowledgeDocuments$outboundSchema` instead. */
1577
- export const outboundSchema = SearchKnowledgeDocuments$outboundSchema;
1578
- /** @deprecated use `SearchKnowledgeDocuments$Outbound` instead. */
1579
- export type Outbound = SearchKnowledgeDocuments$Outbound;
1580
- }
1581
-
1582
- export function searchKnowledgeDocumentsToJSON(
1583
- searchKnowledgeDocuments: SearchKnowledgeDocuments,
1584
- ): string {
1585
- return JSON.stringify(
1586
- SearchKnowledgeDocuments$outboundSchema.parse(searchKnowledgeDocuments),
1587
- );
1588
- }
1589
-
1590
- export function searchKnowledgeDocumentsFromJSON(
1591
- jsonString: string,
1592
- ): SafeParseResult<SearchKnowledgeDocuments, SDKValidationError> {
1593
- return safeParse(
1594
- jsonString,
1595
- (x) => SearchKnowledgeDocuments$inboundSchema.parse(JSON.parse(x)),
1596
- `Failed to parse 'SearchKnowledgeDocuments' from JSON`,
1597
- );
1598
- }
1599
-
1600
- /** @internal */
1601
- export const SearchKnowledgeResponseBody$inboundSchema: z.ZodType<
1602
- SearchKnowledgeResponseBody,
1603
- z.ZodTypeDef,
1604
- unknown
1605
- > = z.object({
1606
- knowledge_id: z.string(),
1607
- documents: z.array(z.lazy(() => SearchKnowledgeDocuments$inboundSchema)),
1608
- knowledge_key: z.string(),
1609
- query: z.string(),
1610
- }).transform((v) => {
1611
- return remap$(v, {
1612
- "knowledge_id": "knowledgeId",
1613
- "knowledge_key": "knowledgeKey",
1614
- });
1615
- });
1616
-
1617
- /** @internal */
1618
- export type SearchKnowledgeResponseBody$Outbound = {
1619
- knowledge_id: string;
1620
- documents: Array<SearchKnowledgeDocuments$Outbound>;
1621
- knowledge_key: string;
1622
- query: string;
1623
- };
1624
-
1625
- /** @internal */
1626
- export const SearchKnowledgeResponseBody$outboundSchema: z.ZodType<
1627
- SearchKnowledgeResponseBody$Outbound,
1628
- z.ZodTypeDef,
1629
- SearchKnowledgeResponseBody
1630
- > = z.object({
1631
- knowledgeId: z.string(),
1632
- documents: z.array(z.lazy(() => SearchKnowledgeDocuments$outboundSchema)),
1633
- knowledgeKey: z.string(),
1634
- query: z.string(),
1635
- }).transform((v) => {
1636
- return remap$(v, {
1637
- knowledgeId: "knowledge_id",
1638
- knowledgeKey: "knowledge_key",
1639
- });
1640
- });
1641
-
1642
- /**
1643
- * @internal
1644
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
1645
- */
1646
- export namespace SearchKnowledgeResponseBody$ {
1647
- /** @deprecated use `SearchKnowledgeResponseBody$inboundSchema` instead. */
1648
- export const inboundSchema = SearchKnowledgeResponseBody$inboundSchema;
1649
- /** @deprecated use `SearchKnowledgeResponseBody$outboundSchema` instead. */
1650
- export const outboundSchema = SearchKnowledgeResponseBody$outboundSchema;
1651
- /** @deprecated use `SearchKnowledgeResponseBody$Outbound` instead. */
1652
- export type Outbound = SearchKnowledgeResponseBody$Outbound;
1653
- }
1654
-
1655
- export function searchKnowledgeResponseBodyToJSON(
1656
- searchKnowledgeResponseBody: SearchKnowledgeResponseBody,
1657
- ): string {
1658
- return JSON.stringify(
1659
- SearchKnowledgeResponseBody$outboundSchema.parse(
1660
- searchKnowledgeResponseBody,
1661
- ),
1662
- );
1663
- }
1664
-
1665
- export function searchKnowledgeResponseBodyFromJSON(
1666
- jsonString: string,
1667
- ): SafeParseResult<SearchKnowledgeResponseBody, SDKValidationError> {
1668
- return safeParse(
1669
- jsonString,
1670
- (x) => SearchKnowledgeResponseBody$inboundSchema.parse(JSON.parse(x)),
1671
- `Failed to parse 'SearchKnowledgeResponseBody' from JSON`,
1672
- );
1673
- }