@orq-ai/node 3.3.2 → 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 (239) hide show
  1. package/bin/mcp-server.js +6 -9
  2. package/bin/mcp-server.js.map +7 -7
  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/package.json +3 -2
  12. package/src/lib/config.ts +2 -2
  13. package/src/mcp-server/mcp-server.ts +1 -1
  14. package/src/mcp-server/server.ts +1 -1
  15. package/packages/orq-rc/FUNCTIONS.md +0 -106
  16. package/packages/orq-rc/README.md +0 -698
  17. package/packages/orq-rc/RUNTIMES.md +0 -48
  18. package/packages/orq-rc/docs/sdks/contacts/README.md +0 -84
  19. package/packages/orq-rc/docs/sdks/datasets/README.md +0 -940
  20. package/packages/orq-rc/docs/sdks/deployments/README.md +0 -316
  21. package/packages/orq-rc/docs/sdks/feedback/README.md +0 -92
  22. package/packages/orq-rc/docs/sdks/files/README.md +0 -311
  23. package/packages/orq-rc/docs/sdks/knowledge/README.md +0 -1279
  24. package/packages/orq-rc/docs/sdks/metrics/README.md +0 -86
  25. package/packages/orq-rc/docs/sdks/orq/README.md +0 -10
  26. package/packages/orq-rc/docs/sdks/prompts/README.md +0 -614
  27. package/packages/orq-rc/docs/sdks/remoteconfigs/README.md +0 -80
  28. package/packages/orq-rc/jsr.json +0 -28
  29. package/packages/orq-rc/package-lock.json +0 -3217
  30. package/packages/orq-rc/package.json +0 -45
  31. package/packages/orq-rc/src/core.ts +0 -13
  32. package/packages/orq-rc/src/funcs/contactsCreate.ts +0 -154
  33. package/packages/orq-rc/src/funcs/datasetsClear.ts +0 -161
  34. package/packages/orq-rc/src/funcs/datasetsCreate.ts +0 -159
  35. package/packages/orq-rc/src/funcs/datasetsCreateDatapoint.ts +0 -161
  36. package/packages/orq-rc/src/funcs/datasetsCreateDatapoints.ts +0 -165
  37. package/packages/orq-rc/src/funcs/datasetsDelete.ts +0 -161
  38. package/packages/orq-rc/src/funcs/datasetsDeleteDatapoint.ts +0 -176
  39. package/packages/orq-rc/src/funcs/datasetsList.ts +0 -161
  40. package/packages/orq-rc/src/funcs/datasetsListDatapoints.ts +0 -168
  41. package/packages/orq-rc/src/funcs/datasetsRetrieve.ts +0 -169
  42. package/packages/orq-rc/src/funcs/datasetsRetrieveDatapoint.ts +0 -175
  43. package/packages/orq-rc/src/funcs/datasetsUpdate.ts +0 -170
  44. package/packages/orq-rc/src/funcs/datasetsUpdateDatapoint.ts +0 -173
  45. package/packages/orq-rc/src/funcs/deploymentsGetConfig.ts +0 -162
  46. package/packages/orq-rc/src/funcs/deploymentsInvoke.ts +0 -170
  47. package/packages/orq-rc/src/funcs/deploymentsList.ts +0 -170
  48. package/packages/orq-rc/src/funcs/deploymentsMetricsCreate.ts +0 -162
  49. package/packages/orq-rc/src/funcs/deploymentsStream.ts +0 -178
  50. package/packages/orq-rc/src/funcs/feedbackCreate.ts +0 -154
  51. package/packages/orq-rc/src/funcs/filesCreate.ts +0 -174
  52. package/packages/orq-rc/src/funcs/filesDelete.ts +0 -158
  53. package/packages/orq-rc/src/funcs/filesGet.ts +0 -160
  54. package/packages/orq-rc/src/funcs/filesList.ts +0 -161
  55. package/packages/orq-rc/src/funcs/knowledgeCreate.ts +0 -152
  56. package/packages/orq-rc/src/funcs/knowledgeCreateChunks.ts +0 -165
  57. package/packages/orq-rc/src/funcs/knowledgeCreateDatasource.ts +0 -160
  58. package/packages/orq-rc/src/funcs/knowledgeDelete.ts +0 -161
  59. package/packages/orq-rc/src/funcs/knowledgeDeleteChunk.ts +0 -168
  60. package/packages/orq-rc/src/funcs/knowledgeDeleteDatasource.ts +0 -167
  61. package/packages/orq-rc/src/funcs/knowledgeList.ts +0 -163
  62. package/packages/orq-rc/src/funcs/knowledgeListChunks.ts +0 -172
  63. package/packages/orq-rc/src/funcs/knowledgeListDatasources.ts +0 -168
  64. package/packages/orq-rc/src/funcs/knowledgeRetrieve.ts +0 -160
  65. package/packages/orq-rc/src/funcs/knowledgeRetrieveChunk.ts +0 -167
  66. package/packages/orq-rc/src/funcs/knowledgeRetrieveDatasource.ts +0 -163
  67. package/packages/orq-rc/src/funcs/knowledgeSearch.ts +0 -158
  68. package/packages/orq-rc/src/funcs/knowledgeUpdate.ts +0 -158
  69. package/packages/orq-rc/src/funcs/knowledgeUpdateChunk.ts +0 -168
  70. package/packages/orq-rc/src/funcs/knowledgeUpdateDatasource.ts +0 -164
  71. package/packages/orq-rc/src/funcs/promptsCreate.ts +0 -154
  72. package/packages/orq-rc/src/funcs/promptsDelete.ts +0 -158
  73. package/packages/orq-rc/src/funcs/promptsGetVersion.ts +0 -175
  74. package/packages/orq-rc/src/funcs/promptsList.ts +0 -161
  75. package/packages/orq-rc/src/funcs/promptsListVersions.ts +0 -167
  76. package/packages/orq-rc/src/funcs/promptsRetrieve.ts +0 -160
  77. package/packages/orq-rc/src/funcs/promptsUpdate.ts +0 -167
  78. package/packages/orq-rc/src/funcs/remoteconfigsRetrieve.ts +0 -155
  79. package/packages/orq-rc/src/hooks/global.ts +0 -44
  80. package/packages/orq-rc/src/hooks/hooks.ts +0 -132
  81. package/packages/orq-rc/src/hooks/index.ts +0 -6
  82. package/packages/orq-rc/src/hooks/registration.ts +0 -15
  83. package/packages/orq-rc/src/hooks/types.ts +0 -110
  84. package/packages/orq-rc/src/index.ts +0 -7
  85. package/packages/orq-rc/src/lib/base64.ts +0 -37
  86. package/packages/orq-rc/src/lib/config.ts +0 -70
  87. package/packages/orq-rc/src/lib/dlv.ts +0 -53
  88. package/packages/orq-rc/src/lib/encodings.ts +0 -483
  89. package/packages/orq-rc/src/lib/env.ts +0 -73
  90. package/packages/orq-rc/src/lib/event-streams.ts +0 -264
  91. package/packages/orq-rc/src/lib/files.ts +0 -40
  92. package/packages/orq-rc/src/lib/http.ts +0 -323
  93. package/packages/orq-rc/src/lib/is-plain-object.ts +0 -43
  94. package/packages/orq-rc/src/lib/logger.ts +0 -9
  95. package/packages/orq-rc/src/lib/matchers.ts +0 -325
  96. package/packages/orq-rc/src/lib/primitives.ts +0 -150
  97. package/packages/orq-rc/src/lib/retries.ts +0 -218
  98. package/packages/orq-rc/src/lib/schemas.ts +0 -91
  99. package/packages/orq-rc/src/lib/sdks.ts +0 -395
  100. package/packages/orq-rc/src/lib/security.ts +0 -261
  101. package/packages/orq-rc/src/lib/url.ts +0 -33
  102. package/packages/orq-rc/src/mcp-server/cli/start/command.ts +0 -125
  103. package/packages/orq-rc/src/mcp-server/cli/start/impl.ts +0 -140
  104. package/packages/orq-rc/src/mcp-server/cli.ts +0 -13
  105. package/packages/orq-rc/src/mcp-server/console-logger.ts +0 -71
  106. package/packages/orq-rc/src/mcp-server/extensions.ts +0 -17
  107. package/packages/orq-rc/src/mcp-server/mcp-server.ts +0 -26
  108. package/packages/orq-rc/src/mcp-server/prompts.ts +0 -110
  109. package/packages/orq-rc/src/mcp-server/resources.ts +0 -158
  110. package/packages/orq-rc/src/mcp-server/scopes.ts +0 -7
  111. package/packages/orq-rc/src/mcp-server/server.ts +0 -157
  112. package/packages/orq-rc/src/mcp-server/shared.ts +0 -75
  113. package/packages/orq-rc/src/mcp-server/tools/contactsCreate.ts +0 -37
  114. package/packages/orq-rc/src/mcp-server/tools/datasetsClear.ts +0 -35
  115. package/packages/orq-rc/src/mcp-server/tools/datasetsCreate.ts +0 -37
  116. package/packages/orq-rc/src/mcp-server/tools/datasetsCreateDatapoint.ts +0 -37
  117. package/packages/orq-rc/src/mcp-server/tools/datasetsCreateDatapoints.ts +0 -37
  118. package/packages/orq-rc/src/mcp-server/tools/datasetsDelete.ts +0 -35
  119. package/packages/orq-rc/src/mcp-server/tools/datasetsDeleteDatapoint.ts +0 -35
  120. package/packages/orq-rc/src/mcp-server/tools/datasetsList.ts +0 -37
  121. package/packages/orq-rc/src/mcp-server/tools/datasetsListDatapoints.ts +0 -37
  122. package/packages/orq-rc/src/mcp-server/tools/datasetsRetrieve.ts +0 -37
  123. package/packages/orq-rc/src/mcp-server/tools/datasetsRetrieveDatapoint.ts +0 -37
  124. package/packages/orq-rc/src/mcp-server/tools/datasetsUpdate.ts +0 -37
  125. package/packages/orq-rc/src/mcp-server/tools/datasetsUpdateDatapoint.ts +0 -35
  126. package/packages/orq-rc/src/mcp-server/tools/deploymentsGetConfig.ts +0 -37
  127. package/packages/orq-rc/src/mcp-server/tools/deploymentsInvoke.ts +0 -37
  128. package/packages/orq-rc/src/mcp-server/tools/deploymentsList.ts +0 -37
  129. package/packages/orq-rc/src/mcp-server/tools/deploymentsMetricsCreate.ts +0 -37
  130. package/packages/orq-rc/src/mcp-server/tools/deploymentsStream.ts +0 -37
  131. package/packages/orq-rc/src/mcp-server/tools/feedbackCreate.ts +0 -37
  132. package/packages/orq-rc/src/mcp-server/tools/filesCreate.ts +0 -37
  133. package/packages/orq-rc/src/mcp-server/tools/filesDelete.ts +0 -33
  134. package/packages/orq-rc/src/mcp-server/tools/filesGet.ts +0 -37
  135. package/packages/orq-rc/src/mcp-server/tools/filesList.ts +0 -37
  136. package/packages/orq-rc/src/mcp-server/tools/knowledgeCreate.ts +0 -35
  137. package/packages/orq-rc/src/mcp-server/tools/knowledgeCreateChunks.ts +0 -35
  138. package/packages/orq-rc/src/mcp-server/tools/knowledgeCreateDatasource.ts +0 -35
  139. package/packages/orq-rc/src/mcp-server/tools/knowledgeDelete.ts +0 -35
  140. package/packages/orq-rc/src/mcp-server/tools/knowledgeDeleteChunk.ts +0 -33
  141. package/packages/orq-rc/src/mcp-server/tools/knowledgeDeleteDatasource.ts +0 -35
  142. package/packages/orq-rc/src/mcp-server/tools/knowledgeList.ts +0 -37
  143. package/packages/orq-rc/src/mcp-server/tools/knowledgeListChunks.ts +0 -35
  144. package/packages/orq-rc/src/mcp-server/tools/knowledgeListDatasources.ts +0 -35
  145. package/packages/orq-rc/src/mcp-server/tools/knowledgeRetrieve.ts +0 -37
  146. package/packages/orq-rc/src/mcp-server/tools/knowledgeRetrieveChunk.ts +0 -35
  147. package/packages/orq-rc/src/mcp-server/tools/knowledgeRetrieveDatasource.ts +0 -35
  148. package/packages/orq-rc/src/mcp-server/tools/knowledgeSearch.ts +0 -35
  149. package/packages/orq-rc/src/mcp-server/tools/knowledgeUpdate.ts +0 -35
  150. package/packages/orq-rc/src/mcp-server/tools/knowledgeUpdateChunk.ts +0 -35
  151. package/packages/orq-rc/src/mcp-server/tools/knowledgeUpdateDatasource.ts +0 -35
  152. package/packages/orq-rc/src/mcp-server/tools/promptsCreate.ts +0 -35
  153. package/packages/orq-rc/src/mcp-server/tools/promptsDelete.ts +0 -33
  154. package/packages/orq-rc/src/mcp-server/tools/promptsGetVersion.ts +0 -37
  155. package/packages/orq-rc/src/mcp-server/tools/promptsList.ts +0 -37
  156. package/packages/orq-rc/src/mcp-server/tools/promptsListVersions.ts +0 -37
  157. package/packages/orq-rc/src/mcp-server/tools/promptsRetrieve.ts +0 -37
  158. package/packages/orq-rc/src/mcp-server/tools/promptsUpdate.ts +0 -35
  159. package/packages/orq-rc/src/mcp-server/tools/remoteconfigsRetrieve.ts +0 -36
  160. package/packages/orq-rc/src/mcp-server/tools.ts +0 -126
  161. package/packages/orq-rc/src/models/components/deployments.ts +0 -4164
  162. package/packages/orq-rc/src/models/components/index.ts +0 -6
  163. package/packages/orq-rc/src/models/components/security.ts +0 -71
  164. package/packages/orq-rc/src/models/errors/apierror.ts +0 -27
  165. package/packages/orq-rc/src/models/errors/getpromptversion.ts +0 -71
  166. package/packages/orq-rc/src/models/errors/honoapierror.ts +0 -82
  167. package/packages/orq-rc/src/models/errors/httpclienterrors.ts +0 -62
  168. package/packages/orq-rc/src/models/errors/index.ts +0 -10
  169. package/packages/orq-rc/src/models/errors/sdkvalidationerror.ts +0 -97
  170. package/packages/orq-rc/src/models/errors/updateprompt.ts +0 -71
  171. package/packages/orq-rc/src/models/operations/bulkcreatedatapoints.ts +0 -1816
  172. package/packages/orq-rc/src/models/operations/cleardataset.ts +0 -75
  173. package/packages/orq-rc/src/models/operations/createchunk.ts +0 -680
  174. package/packages/orq-rc/src/models/operations/createcontact.ts +0 -256
  175. package/packages/orq-rc/src/models/operations/createdataset.ts +0 -296
  176. package/packages/orq-rc/src/models/operations/createdatasetitem.ts +0 -1740
  177. package/packages/orq-rc/src/models/operations/createdatasource.ts +0 -852
  178. package/packages/orq-rc/src/models/operations/createfeedback.ts +0 -286
  179. package/packages/orq-rc/src/models/operations/createknowledge.ts +0 -676
  180. package/packages/orq-rc/src/models/operations/createprompt.ts +0 -3743
  181. package/packages/orq-rc/src/models/operations/deletechunk.ts +0 -96
  182. package/packages/orq-rc/src/models/operations/deletedatapoint.ts +0 -81
  183. package/packages/orq-rc/src/models/operations/deletedataset.ts +0 -75
  184. package/packages/orq-rc/src/models/operations/deletedatasource.ts +0 -87
  185. package/packages/orq-rc/src/models/operations/deleteknowledge.ts +0 -78
  186. package/packages/orq-rc/src/models/operations/deleteprompt.ts +0 -69
  187. package/packages/orq-rc/src/models/operations/deploymentcreatemetric.ts +0 -4936
  188. package/packages/orq-rc/src/models/operations/deploymentgetconfig.ts +0 -6090
  189. package/packages/orq-rc/src/models/operations/deploymentinvoke.ts +0 -1199
  190. package/packages/orq-rc/src/models/operations/deployments.ts +0 -2155
  191. package/packages/orq-rc/src/models/operations/deploymentstream.ts +0 -5960
  192. package/packages/orq-rc/src/models/operations/filedelete.ts +0 -78
  193. package/packages/orq-rc/src/models/operations/fileget.ts +0 -223
  194. package/packages/orq-rc/src/models/operations/filelist.ts +0 -337
  195. package/packages/orq-rc/src/models/operations/fileupload.ts +0 -324
  196. package/packages/orq-rc/src/models/operations/getallprompts.ts +0 -2127
  197. package/packages/orq-rc/src/models/operations/getonechunk.ts +0 -265
  198. package/packages/orq-rc/src/models/operations/getoneknowledge.ts +0 -444
  199. package/packages/orq-rc/src/models/operations/getoneprompt.ts +0 -1993
  200. package/packages/orq-rc/src/models/operations/getpromptversion.ts +0 -1991
  201. package/packages/orq-rc/src/models/operations/index.ts +0 -51
  202. package/packages/orq-rc/src/models/operations/listchunks.ts +0 -444
  203. package/packages/orq-rc/src/models/operations/listdatasetdatapoints.ts +0 -1071
  204. package/packages/orq-rc/src/models/operations/listdatasets.ts +0 -406
  205. package/packages/orq-rc/src/models/operations/listdatasources.ts +0 -447
  206. package/packages/orq-rc/src/models/operations/listknowledgebases.ts +0 -568
  207. package/packages/orq-rc/src/models/operations/listpromptversions.ts +0 -2125
  208. package/packages/orq-rc/src/models/operations/remoteconfigsgetconfig.ts +0 -190
  209. package/packages/orq-rc/src/models/operations/retrievedatapoint.ts +0 -924
  210. package/packages/orq-rc/src/models/operations/retrievedataset.ts +0 -288
  211. package/packages/orq-rc/src/models/operations/retrievedatasource.ts +0 -273
  212. package/packages/orq-rc/src/models/operations/searchknowledge.ts +0 -1673
  213. package/packages/orq-rc/src/models/operations/updatechunk.ts +0 -418
  214. package/packages/orq-rc/src/models/operations/updatedatapoint.ts +0 -1729
  215. package/packages/orq-rc/src/models/operations/updatedataset.ts +0 -393
  216. package/packages/orq-rc/src/models/operations/updatedatasource.ts +0 -345
  217. package/packages/orq-rc/src/models/operations/updateknowledge.ts +0 -790
  218. package/packages/orq-rc/src/models/operations/updateprompt.ts +0 -3929
  219. package/packages/orq-rc/src/sdk/contacts.ts +0 -27
  220. package/packages/orq-rc/src/sdk/datasets.ts +0 -222
  221. package/packages/orq-rc/src/sdk/deployments.ts +0 -89
  222. package/packages/orq-rc/src/sdk/feedback.ts +0 -27
  223. package/packages/orq-rc/src/sdk/files.ts +0 -78
  224. package/packages/orq-rc/src/sdk/index.ts +0 -5
  225. package/packages/orq-rc/src/sdk/knowledge.ts +0 -261
  226. package/packages/orq-rc/src/sdk/metrics.ts +0 -27
  227. package/packages/orq-rc/src/sdk/prompts.ts +0 -126
  228. package/packages/orq-rc/src/sdk/remoteconfigs.ts +0 -24
  229. package/packages/orq-rc/src/sdk/sdk.ts +0 -55
  230. package/packages/orq-rc/src/types/async.ts +0 -68
  231. package/packages/orq-rc/src/types/blobs.ts +0 -31
  232. package/packages/orq-rc/src/types/constdatetime.ts +0 -15
  233. package/packages/orq-rc/src/types/enums.ts +0 -16
  234. package/packages/orq-rc/src/types/fp.ts +0 -50
  235. package/packages/orq-rc/src/types/index.ts +0 -11
  236. package/packages/orq-rc/src/types/operations.ts +0 -105
  237. package/packages/orq-rc/src/types/rfcdate.ts +0 -54
  238. package/packages/orq-rc/src/types/streams.ts +0 -21
  239. package/packages/orq-rc/tsconfig.json +0 -41
@@ -1,265 +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 type GetOneChunkRequest = {
13
- /**
14
- * The unique identifier of the chunk
15
- */
16
- chunkId: string;
17
- /**
18
- * The unique identifier of the data source
19
- */
20
- datasourceId: string;
21
- /**
22
- * The unique identifier of the knowledge base
23
- */
24
- knowledgeId: string;
25
- };
26
-
27
- /**
28
- * The status of the chunk
29
- */
30
- export const GetOneChunkStatus = {
31
- Pending: "pending",
32
- Processing: "processing",
33
- Completed: "completed",
34
- Failed: "failed",
35
- Queued: "queued",
36
- } as const;
37
- /**
38
- * The status of the chunk
39
- */
40
- export type GetOneChunkStatus = ClosedEnum<typeof GetOneChunkStatus>;
41
-
42
- /**
43
- * Chunk successfully retrieved
44
- */
45
- export type GetOneChunkResponseBody = {
46
- /**
47
- * The unique identifier of the chunk
48
- */
49
- id: string;
50
- /**
51
- * The text content of the chunk
52
- */
53
- text: string;
54
- /**
55
- * Metadata of the chunk. Can include `page_number` or any other key-value pairs. Only values of type string are supported.
56
- */
57
- metadata?: { [k: string]: string } | undefined;
58
- /**
59
- * Whether the chunk is enabled
60
- */
61
- enabled: boolean;
62
- /**
63
- * The status of the chunk
64
- */
65
- status: GetOneChunkStatus;
66
- /**
67
- * The date and time the chunk was created
68
- */
69
- created: string;
70
- /**
71
- * The date and time the chunk was updated
72
- */
73
- updated: string;
74
- /**
75
- * The unique identifier of the user who created the chunk
76
- */
77
- createdById?: string | undefined;
78
- /**
79
- * The unique identifier of the user who updated the chunk
80
- */
81
- updateById?: string | undefined;
82
- };
83
-
84
- /** @internal */
85
- export const GetOneChunkRequest$inboundSchema: z.ZodType<
86
- GetOneChunkRequest,
87
- z.ZodTypeDef,
88
- unknown
89
- > = z.object({
90
- chunk_id: z.string(),
91
- datasource_id: z.string(),
92
- knowledge_id: z.string(),
93
- }).transform((v) => {
94
- return remap$(v, {
95
- "chunk_id": "chunkId",
96
- "datasource_id": "datasourceId",
97
- "knowledge_id": "knowledgeId",
98
- });
99
- });
100
-
101
- /** @internal */
102
- export type GetOneChunkRequest$Outbound = {
103
- chunk_id: string;
104
- datasource_id: string;
105
- knowledge_id: string;
106
- };
107
-
108
- /** @internal */
109
- export const GetOneChunkRequest$outboundSchema: z.ZodType<
110
- GetOneChunkRequest$Outbound,
111
- z.ZodTypeDef,
112
- GetOneChunkRequest
113
- > = z.object({
114
- chunkId: z.string(),
115
- datasourceId: z.string(),
116
- knowledgeId: z.string(),
117
- }).transform((v) => {
118
- return remap$(v, {
119
- chunkId: "chunk_id",
120
- datasourceId: "datasource_id",
121
- knowledgeId: "knowledge_id",
122
- });
123
- });
124
-
125
- /**
126
- * @internal
127
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
128
- */
129
- export namespace GetOneChunkRequest$ {
130
- /** @deprecated use `GetOneChunkRequest$inboundSchema` instead. */
131
- export const inboundSchema = GetOneChunkRequest$inboundSchema;
132
- /** @deprecated use `GetOneChunkRequest$outboundSchema` instead. */
133
- export const outboundSchema = GetOneChunkRequest$outboundSchema;
134
- /** @deprecated use `GetOneChunkRequest$Outbound` instead. */
135
- export type Outbound = GetOneChunkRequest$Outbound;
136
- }
137
-
138
- export function getOneChunkRequestToJSON(
139
- getOneChunkRequest: GetOneChunkRequest,
140
- ): string {
141
- return JSON.stringify(
142
- GetOneChunkRequest$outboundSchema.parse(getOneChunkRequest),
143
- );
144
- }
145
-
146
- export function getOneChunkRequestFromJSON(
147
- jsonString: string,
148
- ): SafeParseResult<GetOneChunkRequest, SDKValidationError> {
149
- return safeParse(
150
- jsonString,
151
- (x) => GetOneChunkRequest$inboundSchema.parse(JSON.parse(x)),
152
- `Failed to parse 'GetOneChunkRequest' from JSON`,
153
- );
154
- }
155
-
156
- /** @internal */
157
- export const GetOneChunkStatus$inboundSchema: z.ZodNativeEnum<
158
- typeof GetOneChunkStatus
159
- > = z.nativeEnum(GetOneChunkStatus);
160
-
161
- /** @internal */
162
- export const GetOneChunkStatus$outboundSchema: z.ZodNativeEnum<
163
- typeof GetOneChunkStatus
164
- > = GetOneChunkStatus$inboundSchema;
165
-
166
- /**
167
- * @internal
168
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
169
- */
170
- export namespace GetOneChunkStatus$ {
171
- /** @deprecated use `GetOneChunkStatus$inboundSchema` instead. */
172
- export const inboundSchema = GetOneChunkStatus$inboundSchema;
173
- /** @deprecated use `GetOneChunkStatus$outboundSchema` instead. */
174
- export const outboundSchema = GetOneChunkStatus$outboundSchema;
175
- }
176
-
177
- /** @internal */
178
- export const GetOneChunkResponseBody$inboundSchema: z.ZodType<
179
- GetOneChunkResponseBody,
180
- z.ZodTypeDef,
181
- unknown
182
- > = z.object({
183
- _id: z.string(),
184
- text: z.string(),
185
- metadata: z.record(z.string()).optional(),
186
- enabled: z.boolean(),
187
- status: GetOneChunkStatus$inboundSchema,
188
- created: z.string(),
189
- updated: z.string(),
190
- created_by_id: z.string().optional(),
191
- update_by_id: z.string().optional(),
192
- }).transform((v) => {
193
- return remap$(v, {
194
- "_id": "id",
195
- "created_by_id": "createdById",
196
- "update_by_id": "updateById",
197
- });
198
- });
199
-
200
- /** @internal */
201
- export type GetOneChunkResponseBody$Outbound = {
202
- _id: string;
203
- text: string;
204
- metadata?: { [k: string]: string } | undefined;
205
- enabled: boolean;
206
- status: string;
207
- created: string;
208
- updated: string;
209
- created_by_id?: string | undefined;
210
- update_by_id?: string | undefined;
211
- };
212
-
213
- /** @internal */
214
- export const GetOneChunkResponseBody$outboundSchema: z.ZodType<
215
- GetOneChunkResponseBody$Outbound,
216
- z.ZodTypeDef,
217
- GetOneChunkResponseBody
218
- > = z.object({
219
- id: z.string(),
220
- text: z.string(),
221
- metadata: z.record(z.string()).optional(),
222
- enabled: z.boolean(),
223
- status: GetOneChunkStatus$outboundSchema,
224
- created: z.string(),
225
- updated: z.string(),
226
- createdById: z.string().optional(),
227
- updateById: z.string().optional(),
228
- }).transform((v) => {
229
- return remap$(v, {
230
- id: "_id",
231
- createdById: "created_by_id",
232
- updateById: "update_by_id",
233
- });
234
- });
235
-
236
- /**
237
- * @internal
238
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
239
- */
240
- export namespace GetOneChunkResponseBody$ {
241
- /** @deprecated use `GetOneChunkResponseBody$inboundSchema` instead. */
242
- export const inboundSchema = GetOneChunkResponseBody$inboundSchema;
243
- /** @deprecated use `GetOneChunkResponseBody$outboundSchema` instead. */
244
- export const outboundSchema = GetOneChunkResponseBody$outboundSchema;
245
- /** @deprecated use `GetOneChunkResponseBody$Outbound` instead. */
246
- export type Outbound = GetOneChunkResponseBody$Outbound;
247
- }
248
-
249
- export function getOneChunkResponseBodyToJSON(
250
- getOneChunkResponseBody: GetOneChunkResponseBody,
251
- ): string {
252
- return JSON.stringify(
253
- GetOneChunkResponseBody$outboundSchema.parse(getOneChunkResponseBody),
254
- );
255
- }
256
-
257
- export function getOneChunkResponseBodyFromJSON(
258
- jsonString: string,
259
- ): SafeParseResult<GetOneChunkResponseBody, SDKValidationError> {
260
- return safeParse(
261
- jsonString,
262
- (x) => GetOneChunkResponseBody$inboundSchema.parse(JSON.parse(x)),
263
- `Failed to parse 'GetOneChunkResponseBody' from JSON`,
264
- );
265
- }
@@ -1,444 +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 type GetOneKnowledgeRequest = {
13
- /**
14
- * Unique identifier of the knowledge base
15
- */
16
- knowledgeId: string;
17
- };
18
-
19
- /**
20
- * The retrieval type to use for the knowledge base. If not provided, Hybrid Search will be used as a default query strategy.
21
- */
22
- export const GetOneKnowledgeRetrievalType = {
23
- VectorSearch: "vector_search",
24
- KeywordSearch: "keyword_search",
25
- HybridSearch: "hybrid_search",
26
- } as const;
27
- /**
28
- * The retrieval type to use for the knowledge base. If not provided, Hybrid Search will be used as a default query strategy.
29
- */
30
- export type GetOneKnowledgeRetrievalType = ClosedEnum<
31
- typeof GetOneKnowledgeRetrievalType
32
- >;
33
-
34
- /**
35
- * The rerank configuration for the knowledge base. In case the model is provided it will be used to enhance the search precision.
36
- */
37
- export type GetOneKnowledgeRerankConfig = {
38
- /**
39
- * The threshold value used to filter the rerank results, only documents with a relevance score greater than the threshold will be returned
40
- */
41
- rerankThreshold?: number | undefined;
42
- /**
43
- * The rerank model to use for the knowledge base.
44
- */
45
- rerankModel: string;
46
- };
47
-
48
- /**
49
- * The retrieval settings for the knowledge base. If not provider, Hybrid Search will be used as a default query strategy.
50
- */
51
- export type GetOneKnowledgeRetrievalSettings = {
52
- /**
53
- * The retrieval type to use for the knowledge base. If not provided, Hybrid Search will be used as a default query strategy.
54
- */
55
- retrievalType?: GetOneKnowledgeRetrievalType | undefined;
56
- /**
57
- * The number of results to return from the search.
58
- */
59
- topK?: number | undefined;
60
- /**
61
- * The threshold value used to filter the search results, only documents with a relevance score greater than the threshold will be returned
62
- */
63
- threshold?: number | undefined;
64
- /**
65
- * The rerank configuration for the knowledge base. In case the model is provided it will be used to enhance the search precision.
66
- */
67
- rerankConfig?: GetOneKnowledgeRerankConfig | undefined;
68
- };
69
-
70
- /**
71
- * Knowledge Base object
72
- */
73
- export type GetOneKnowledgeResponseBody = {
74
- /**
75
- * The unique identifier of the knowledge base.
76
- */
77
- id: string;
78
- /**
79
- * The creation date of the knowledge base.
80
- */
81
- created: string;
82
- /**
83
- * The description of the knowledge base.
84
- */
85
- description?: string | undefined;
86
- /**
87
- * The unique key of the knowledge base.
88
- */
89
- key: string;
90
- /**
91
- * The embeddings model used for the knowledge base.
92
- */
93
- model: string;
94
- /**
95
- * The path where the entity is stored in the project structure. The first element of the path always represents the project name. Any subsequent path element after the project will be created as a folder in the project if it does not exists.
96
- */
97
- path?: string | undefined;
98
- /**
99
- * The retrieval settings for the knowledge base. If not provider, Hybrid Search will be used as a default query strategy.
100
- */
101
- retrievalSettings?: GetOneKnowledgeRetrievalSettings | undefined;
102
- createdById?: string | null | undefined;
103
- updatedById?: string | null | undefined;
104
- /**
105
- * The last update date of the knowledge base.
106
- */
107
- updated: string;
108
- };
109
-
110
- /** @internal */
111
- export const GetOneKnowledgeRequest$inboundSchema: z.ZodType<
112
- GetOneKnowledgeRequest,
113
- z.ZodTypeDef,
114
- unknown
115
- > = z.object({
116
- knowledge_id: z.string(),
117
- }).transform((v) => {
118
- return remap$(v, {
119
- "knowledge_id": "knowledgeId",
120
- });
121
- });
122
-
123
- /** @internal */
124
- export type GetOneKnowledgeRequest$Outbound = {
125
- knowledge_id: string;
126
- };
127
-
128
- /** @internal */
129
- export const GetOneKnowledgeRequest$outboundSchema: z.ZodType<
130
- GetOneKnowledgeRequest$Outbound,
131
- z.ZodTypeDef,
132
- GetOneKnowledgeRequest
133
- > = z.object({
134
- knowledgeId: z.string(),
135
- }).transform((v) => {
136
- return remap$(v, {
137
- knowledgeId: "knowledge_id",
138
- });
139
- });
140
-
141
- /**
142
- * @internal
143
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
144
- */
145
- export namespace GetOneKnowledgeRequest$ {
146
- /** @deprecated use `GetOneKnowledgeRequest$inboundSchema` instead. */
147
- export const inboundSchema = GetOneKnowledgeRequest$inboundSchema;
148
- /** @deprecated use `GetOneKnowledgeRequest$outboundSchema` instead. */
149
- export const outboundSchema = GetOneKnowledgeRequest$outboundSchema;
150
- /** @deprecated use `GetOneKnowledgeRequest$Outbound` instead. */
151
- export type Outbound = GetOneKnowledgeRequest$Outbound;
152
- }
153
-
154
- export function getOneKnowledgeRequestToJSON(
155
- getOneKnowledgeRequest: GetOneKnowledgeRequest,
156
- ): string {
157
- return JSON.stringify(
158
- GetOneKnowledgeRequest$outboundSchema.parse(getOneKnowledgeRequest),
159
- );
160
- }
161
-
162
- export function getOneKnowledgeRequestFromJSON(
163
- jsonString: string,
164
- ): SafeParseResult<GetOneKnowledgeRequest, SDKValidationError> {
165
- return safeParse(
166
- jsonString,
167
- (x) => GetOneKnowledgeRequest$inboundSchema.parse(JSON.parse(x)),
168
- `Failed to parse 'GetOneKnowledgeRequest' from JSON`,
169
- );
170
- }
171
-
172
- /** @internal */
173
- export const GetOneKnowledgeRetrievalType$inboundSchema: z.ZodNativeEnum<
174
- typeof GetOneKnowledgeRetrievalType
175
- > = z.nativeEnum(GetOneKnowledgeRetrievalType);
176
-
177
- /** @internal */
178
- export const GetOneKnowledgeRetrievalType$outboundSchema: z.ZodNativeEnum<
179
- typeof GetOneKnowledgeRetrievalType
180
- > = GetOneKnowledgeRetrievalType$inboundSchema;
181
-
182
- /**
183
- * @internal
184
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
185
- */
186
- export namespace GetOneKnowledgeRetrievalType$ {
187
- /** @deprecated use `GetOneKnowledgeRetrievalType$inboundSchema` instead. */
188
- export const inboundSchema = GetOneKnowledgeRetrievalType$inboundSchema;
189
- /** @deprecated use `GetOneKnowledgeRetrievalType$outboundSchema` instead. */
190
- export const outboundSchema = GetOneKnowledgeRetrievalType$outboundSchema;
191
- }
192
-
193
- /** @internal */
194
- export const GetOneKnowledgeRerankConfig$inboundSchema: z.ZodType<
195
- GetOneKnowledgeRerankConfig,
196
- z.ZodTypeDef,
197
- unknown
198
- > = z.object({
199
- rerank_threshold: z.number().default(0.5),
200
- rerank_model: z.string(),
201
- }).transform((v) => {
202
- return remap$(v, {
203
- "rerank_threshold": "rerankThreshold",
204
- "rerank_model": "rerankModel",
205
- });
206
- });
207
-
208
- /** @internal */
209
- export type GetOneKnowledgeRerankConfig$Outbound = {
210
- rerank_threshold: number;
211
- rerank_model: string;
212
- };
213
-
214
- /** @internal */
215
- export const GetOneKnowledgeRerankConfig$outboundSchema: z.ZodType<
216
- GetOneKnowledgeRerankConfig$Outbound,
217
- z.ZodTypeDef,
218
- GetOneKnowledgeRerankConfig
219
- > = z.object({
220
- rerankThreshold: z.number().default(0.5),
221
- rerankModel: z.string(),
222
- }).transform((v) => {
223
- return remap$(v, {
224
- rerankThreshold: "rerank_threshold",
225
- rerankModel: "rerank_model",
226
- });
227
- });
228
-
229
- /**
230
- * @internal
231
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
232
- */
233
- export namespace GetOneKnowledgeRerankConfig$ {
234
- /** @deprecated use `GetOneKnowledgeRerankConfig$inboundSchema` instead. */
235
- export const inboundSchema = GetOneKnowledgeRerankConfig$inboundSchema;
236
- /** @deprecated use `GetOneKnowledgeRerankConfig$outboundSchema` instead. */
237
- export const outboundSchema = GetOneKnowledgeRerankConfig$outboundSchema;
238
- /** @deprecated use `GetOneKnowledgeRerankConfig$Outbound` instead. */
239
- export type Outbound = GetOneKnowledgeRerankConfig$Outbound;
240
- }
241
-
242
- export function getOneKnowledgeRerankConfigToJSON(
243
- getOneKnowledgeRerankConfig: GetOneKnowledgeRerankConfig,
244
- ): string {
245
- return JSON.stringify(
246
- GetOneKnowledgeRerankConfig$outboundSchema.parse(
247
- getOneKnowledgeRerankConfig,
248
- ),
249
- );
250
- }
251
-
252
- export function getOneKnowledgeRerankConfigFromJSON(
253
- jsonString: string,
254
- ): SafeParseResult<GetOneKnowledgeRerankConfig, SDKValidationError> {
255
- return safeParse(
256
- jsonString,
257
- (x) => GetOneKnowledgeRerankConfig$inboundSchema.parse(JSON.parse(x)),
258
- `Failed to parse 'GetOneKnowledgeRerankConfig' from JSON`,
259
- );
260
- }
261
-
262
- /** @internal */
263
- export const GetOneKnowledgeRetrievalSettings$inboundSchema: z.ZodType<
264
- GetOneKnowledgeRetrievalSettings,
265
- z.ZodTypeDef,
266
- unknown
267
- > = z.object({
268
- retrieval_type: GetOneKnowledgeRetrievalType$inboundSchema.default(
269
- "hybrid_search",
270
- ),
271
- top_k: z.number().int().default(5),
272
- threshold: z.number().default(0),
273
- rerank_config: z.lazy(() => GetOneKnowledgeRerankConfig$inboundSchema)
274
- .optional(),
275
- }).transform((v) => {
276
- return remap$(v, {
277
- "retrieval_type": "retrievalType",
278
- "top_k": "topK",
279
- "rerank_config": "rerankConfig",
280
- });
281
- });
282
-
283
- /** @internal */
284
- export type GetOneKnowledgeRetrievalSettings$Outbound = {
285
- retrieval_type: string;
286
- top_k: number;
287
- threshold: number;
288
- rerank_config?: GetOneKnowledgeRerankConfig$Outbound | undefined;
289
- };
290
-
291
- /** @internal */
292
- export const GetOneKnowledgeRetrievalSettings$outboundSchema: z.ZodType<
293
- GetOneKnowledgeRetrievalSettings$Outbound,
294
- z.ZodTypeDef,
295
- GetOneKnowledgeRetrievalSettings
296
- > = z.object({
297
- retrievalType: GetOneKnowledgeRetrievalType$outboundSchema.default(
298
- "hybrid_search",
299
- ),
300
- topK: z.number().int().default(5),
301
- threshold: z.number().default(0),
302
- rerankConfig: z.lazy(() => GetOneKnowledgeRerankConfig$outboundSchema)
303
- .optional(),
304
- }).transform((v) => {
305
- return remap$(v, {
306
- retrievalType: "retrieval_type",
307
- topK: "top_k",
308
- rerankConfig: "rerank_config",
309
- });
310
- });
311
-
312
- /**
313
- * @internal
314
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
315
- */
316
- export namespace GetOneKnowledgeRetrievalSettings$ {
317
- /** @deprecated use `GetOneKnowledgeRetrievalSettings$inboundSchema` instead. */
318
- export const inboundSchema = GetOneKnowledgeRetrievalSettings$inboundSchema;
319
- /** @deprecated use `GetOneKnowledgeRetrievalSettings$outboundSchema` instead. */
320
- export const outboundSchema = GetOneKnowledgeRetrievalSettings$outboundSchema;
321
- /** @deprecated use `GetOneKnowledgeRetrievalSettings$Outbound` instead. */
322
- export type Outbound = GetOneKnowledgeRetrievalSettings$Outbound;
323
- }
324
-
325
- export function getOneKnowledgeRetrievalSettingsToJSON(
326
- getOneKnowledgeRetrievalSettings: GetOneKnowledgeRetrievalSettings,
327
- ): string {
328
- return JSON.stringify(
329
- GetOneKnowledgeRetrievalSettings$outboundSchema.parse(
330
- getOneKnowledgeRetrievalSettings,
331
- ),
332
- );
333
- }
334
-
335
- export function getOneKnowledgeRetrievalSettingsFromJSON(
336
- jsonString: string,
337
- ): SafeParseResult<GetOneKnowledgeRetrievalSettings, SDKValidationError> {
338
- return safeParse(
339
- jsonString,
340
- (x) => GetOneKnowledgeRetrievalSettings$inboundSchema.parse(JSON.parse(x)),
341
- `Failed to parse 'GetOneKnowledgeRetrievalSettings' from JSON`,
342
- );
343
- }
344
-
345
- /** @internal */
346
- export const GetOneKnowledgeResponseBody$inboundSchema: z.ZodType<
347
- GetOneKnowledgeResponseBody,
348
- z.ZodTypeDef,
349
- unknown
350
- > = z.object({
351
- _id: z.string(),
352
- created: z.string(),
353
- description: z.string().optional(),
354
- key: z.string(),
355
- model: z.string(),
356
- path: z.string().optional(),
357
- retrieval_settings: z.lazy(() =>
358
- GetOneKnowledgeRetrievalSettings$inboundSchema
359
- ).optional(),
360
- created_by_id: z.nullable(z.string()).optional(),
361
- updated_by_id: z.nullable(z.string()).optional(),
362
- updated: z.string(),
363
- }).transform((v) => {
364
- return remap$(v, {
365
- "_id": "id",
366
- "retrieval_settings": "retrievalSettings",
367
- "created_by_id": "createdById",
368
- "updated_by_id": "updatedById",
369
- });
370
- });
371
-
372
- /** @internal */
373
- export type GetOneKnowledgeResponseBody$Outbound = {
374
- _id: string;
375
- created: string;
376
- description?: string | undefined;
377
- key: string;
378
- model: string;
379
- path?: string | undefined;
380
- retrieval_settings?: GetOneKnowledgeRetrievalSettings$Outbound | undefined;
381
- created_by_id?: string | null | undefined;
382
- updated_by_id?: string | null | undefined;
383
- updated: string;
384
- };
385
-
386
- /** @internal */
387
- export const GetOneKnowledgeResponseBody$outboundSchema: z.ZodType<
388
- GetOneKnowledgeResponseBody$Outbound,
389
- z.ZodTypeDef,
390
- GetOneKnowledgeResponseBody
391
- > = z.object({
392
- id: z.string(),
393
- created: z.string(),
394
- description: z.string().optional(),
395
- key: z.string(),
396
- model: z.string(),
397
- path: z.string().optional(),
398
- retrievalSettings: z.lazy(() =>
399
- GetOneKnowledgeRetrievalSettings$outboundSchema
400
- ).optional(),
401
- createdById: z.nullable(z.string()).optional(),
402
- updatedById: z.nullable(z.string()).optional(),
403
- updated: z.string(),
404
- }).transform((v) => {
405
- return remap$(v, {
406
- id: "_id",
407
- retrievalSettings: "retrieval_settings",
408
- createdById: "created_by_id",
409
- updatedById: "updated_by_id",
410
- });
411
- });
412
-
413
- /**
414
- * @internal
415
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
416
- */
417
- export namespace GetOneKnowledgeResponseBody$ {
418
- /** @deprecated use `GetOneKnowledgeResponseBody$inboundSchema` instead. */
419
- export const inboundSchema = GetOneKnowledgeResponseBody$inboundSchema;
420
- /** @deprecated use `GetOneKnowledgeResponseBody$outboundSchema` instead. */
421
- export const outboundSchema = GetOneKnowledgeResponseBody$outboundSchema;
422
- /** @deprecated use `GetOneKnowledgeResponseBody$Outbound` instead. */
423
- export type Outbound = GetOneKnowledgeResponseBody$Outbound;
424
- }
425
-
426
- export function getOneKnowledgeResponseBodyToJSON(
427
- getOneKnowledgeResponseBody: GetOneKnowledgeResponseBody,
428
- ): string {
429
- return JSON.stringify(
430
- GetOneKnowledgeResponseBody$outboundSchema.parse(
431
- getOneKnowledgeResponseBody,
432
- ),
433
- );
434
- }
435
-
436
- export function getOneKnowledgeResponseBodyFromJSON(
437
- jsonString: string,
438
- ): SafeParseResult<GetOneKnowledgeResponseBody, SDKValidationError> {
439
- return safeParse(
440
- jsonString,
441
- (x) => GetOneKnowledgeResponseBody$inboundSchema.parse(JSON.parse(x)),
442
- `Failed to parse 'GetOneKnowledgeResponseBody' from JSON`,
443
- );
444
- }