@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,790 +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
- /**
13
- * The retrieval type to use for the knowledge base. If not provided, Hybrid Search will be used as a default query strategy.
14
- */
15
- export const UpdateKnowledgeRetrievalType = {
16
- VectorSearch: "vector_search",
17
- KeywordSearch: "keyword_search",
18
- HybridSearch: "hybrid_search",
19
- } as const;
20
- /**
21
- * The retrieval type to use for the knowledge base. If not provided, Hybrid Search will be used as a default query strategy.
22
- */
23
- export type UpdateKnowledgeRetrievalType = ClosedEnum<
24
- typeof UpdateKnowledgeRetrievalType
25
- >;
26
-
27
- /**
28
- * The rerank configuration for the knowledge base. In case the model is provided it will be used to enhance the search precision.
29
- */
30
- export type UpdateKnowledgeRerankConfig = {
31
- /**
32
- * The threshold value used to filter the rerank results, only documents with a relevance score greater than the threshold will be returned
33
- */
34
- rerankThreshold?: number | undefined;
35
- /**
36
- * The rerank model to use for the knowledge base.
37
- */
38
- rerankModel: string;
39
- };
40
-
41
- /**
42
- * The retrieval settings for the knowledge base. If not provider, Hybrid Search will be used as a default query strategy.
43
- */
44
- export type UpdateKnowledgeRetrievalSettings = {
45
- /**
46
- * The retrieval type to use for the knowledge base. If not provided, Hybrid Search will be used as a default query strategy.
47
- */
48
- retrievalType?: UpdateKnowledgeRetrievalType | undefined;
49
- /**
50
- * The number of results to return from the search.
51
- */
52
- topK?: number | undefined;
53
- /**
54
- * The threshold value used to filter the search results, only documents with a relevance score greater than the threshold will be returned
55
- */
56
- threshold?: number | undefined;
57
- /**
58
- * The rerank configuration for the knowledge base. In case the model is provided it will be used to enhance the search precision.
59
- */
60
- rerankConfig?: UpdateKnowledgeRerankConfig | undefined;
61
- };
62
-
63
- export type UpdateKnowledgeRequestBody = {
64
- /**
65
- * The description of the knowledge base.
66
- */
67
- description?: string | undefined;
68
- /**
69
- * The embeddings model used for the knowledge base. If the models is provided and is different than the previous set model, all the datasources in the knowledge base will be re-embedded.
70
- */
71
- embeddingModel?: string | undefined;
72
- /**
73
- * 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.
74
- */
75
- path?: string | undefined;
76
- /**
77
- * The retrieval settings for the knowledge base. If not provider, Hybrid Search will be used as a default query strategy.
78
- */
79
- retrievalSettings?: UpdateKnowledgeRetrievalSettings | undefined;
80
- };
81
-
82
- export type UpdateKnowledgeRequest = {
83
- /**
84
- * The unique identifier of the knowledge base
85
- */
86
- knowledgeId: string;
87
- requestBody: UpdateKnowledgeRequestBody;
88
- };
89
-
90
- /**
91
- * The retrieval type to use for the knowledge base. If not provided, Hybrid Search will be used as a default query strategy.
92
- */
93
- export const UpdateKnowledgeKnowledgeRetrievalType = {
94
- VectorSearch: "vector_search",
95
- KeywordSearch: "keyword_search",
96
- HybridSearch: "hybrid_search",
97
- } as const;
98
- /**
99
- * The retrieval type to use for the knowledge base. If not provided, Hybrid Search will be used as a default query strategy.
100
- */
101
- export type UpdateKnowledgeKnowledgeRetrievalType = ClosedEnum<
102
- typeof UpdateKnowledgeKnowledgeRetrievalType
103
- >;
104
-
105
- /**
106
- * The rerank configuration for the knowledge base. In case the model is provided it will be used to enhance the search precision.
107
- */
108
- export type UpdateKnowledgeKnowledgeRerankConfig = {
109
- /**
110
- * The threshold value used to filter the rerank results, only documents with a relevance score greater than the threshold will be returned
111
- */
112
- rerankThreshold?: number | undefined;
113
- /**
114
- * The rerank model to use for the knowledge base.
115
- */
116
- rerankModel: string;
117
- };
118
-
119
- /**
120
- * The retrieval settings for the knowledge base. If not provider, Hybrid Search will be used as a default query strategy.
121
- */
122
- export type UpdateKnowledgeKnowledgeRetrievalSettings = {
123
- /**
124
- * The retrieval type to use for the knowledge base. If not provided, Hybrid Search will be used as a default query strategy.
125
- */
126
- retrievalType?: UpdateKnowledgeKnowledgeRetrievalType | undefined;
127
- /**
128
- * The number of results to return from the search.
129
- */
130
- topK?: number | undefined;
131
- /**
132
- * The threshold value used to filter the search results, only documents with a relevance score greater than the threshold will be returned
133
- */
134
- threshold?: number | undefined;
135
- /**
136
- * The rerank configuration for the knowledge base. In case the model is provided it will be used to enhance the search precision.
137
- */
138
- rerankConfig?: UpdateKnowledgeKnowledgeRerankConfig | undefined;
139
- };
140
-
141
- /**
142
- * Knowledge Base object
143
- */
144
- export type UpdateKnowledgeResponseBody = {
145
- /**
146
- * The unique identifier of the knowledge base.
147
- */
148
- id: string;
149
- /**
150
- * The creation date of the knowledge base.
151
- */
152
- created: string;
153
- /**
154
- * The description of the knowledge base.
155
- */
156
- description?: string | undefined;
157
- /**
158
- * The unique key of the knowledge base.
159
- */
160
- key: string;
161
- /**
162
- * The embeddings model used for the knowledge base.
163
- */
164
- model: string;
165
- /**
166
- * 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.
167
- */
168
- path?: string | undefined;
169
- /**
170
- * The retrieval settings for the knowledge base. If not provider, Hybrid Search will be used as a default query strategy.
171
- */
172
- retrievalSettings?: UpdateKnowledgeKnowledgeRetrievalSettings | undefined;
173
- createdById?: string | null | undefined;
174
- updatedById?: string | null | undefined;
175
- /**
176
- * The last update date of the knowledge base.
177
- */
178
- updated: string;
179
- };
180
-
181
- /** @internal */
182
- export const UpdateKnowledgeRetrievalType$inboundSchema: z.ZodNativeEnum<
183
- typeof UpdateKnowledgeRetrievalType
184
- > = z.nativeEnum(UpdateKnowledgeRetrievalType);
185
-
186
- /** @internal */
187
- export const UpdateKnowledgeRetrievalType$outboundSchema: z.ZodNativeEnum<
188
- typeof UpdateKnowledgeRetrievalType
189
- > = UpdateKnowledgeRetrievalType$inboundSchema;
190
-
191
- /**
192
- * @internal
193
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
194
- */
195
- export namespace UpdateKnowledgeRetrievalType$ {
196
- /** @deprecated use `UpdateKnowledgeRetrievalType$inboundSchema` instead. */
197
- export const inboundSchema = UpdateKnowledgeRetrievalType$inboundSchema;
198
- /** @deprecated use `UpdateKnowledgeRetrievalType$outboundSchema` instead. */
199
- export const outboundSchema = UpdateKnowledgeRetrievalType$outboundSchema;
200
- }
201
-
202
- /** @internal */
203
- export const UpdateKnowledgeRerankConfig$inboundSchema: z.ZodType<
204
- UpdateKnowledgeRerankConfig,
205
- z.ZodTypeDef,
206
- unknown
207
- > = z.object({
208
- rerank_threshold: z.number().default(0.5),
209
- rerank_model: z.string(),
210
- }).transform((v) => {
211
- return remap$(v, {
212
- "rerank_threshold": "rerankThreshold",
213
- "rerank_model": "rerankModel",
214
- });
215
- });
216
-
217
- /** @internal */
218
- export type UpdateKnowledgeRerankConfig$Outbound = {
219
- rerank_threshold: number;
220
- rerank_model: string;
221
- };
222
-
223
- /** @internal */
224
- export const UpdateKnowledgeRerankConfig$outboundSchema: z.ZodType<
225
- UpdateKnowledgeRerankConfig$Outbound,
226
- z.ZodTypeDef,
227
- UpdateKnowledgeRerankConfig
228
- > = z.object({
229
- rerankThreshold: z.number().default(0.5),
230
- rerankModel: z.string(),
231
- }).transform((v) => {
232
- return remap$(v, {
233
- rerankThreshold: "rerank_threshold",
234
- rerankModel: "rerank_model",
235
- });
236
- });
237
-
238
- /**
239
- * @internal
240
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
241
- */
242
- export namespace UpdateKnowledgeRerankConfig$ {
243
- /** @deprecated use `UpdateKnowledgeRerankConfig$inboundSchema` instead. */
244
- export const inboundSchema = UpdateKnowledgeRerankConfig$inboundSchema;
245
- /** @deprecated use `UpdateKnowledgeRerankConfig$outboundSchema` instead. */
246
- export const outboundSchema = UpdateKnowledgeRerankConfig$outboundSchema;
247
- /** @deprecated use `UpdateKnowledgeRerankConfig$Outbound` instead. */
248
- export type Outbound = UpdateKnowledgeRerankConfig$Outbound;
249
- }
250
-
251
- export function updateKnowledgeRerankConfigToJSON(
252
- updateKnowledgeRerankConfig: UpdateKnowledgeRerankConfig,
253
- ): string {
254
- return JSON.stringify(
255
- UpdateKnowledgeRerankConfig$outboundSchema.parse(
256
- updateKnowledgeRerankConfig,
257
- ),
258
- );
259
- }
260
-
261
- export function updateKnowledgeRerankConfigFromJSON(
262
- jsonString: string,
263
- ): SafeParseResult<UpdateKnowledgeRerankConfig, SDKValidationError> {
264
- return safeParse(
265
- jsonString,
266
- (x) => UpdateKnowledgeRerankConfig$inboundSchema.parse(JSON.parse(x)),
267
- `Failed to parse 'UpdateKnowledgeRerankConfig' from JSON`,
268
- );
269
- }
270
-
271
- /** @internal */
272
- export const UpdateKnowledgeRetrievalSettings$inboundSchema: z.ZodType<
273
- UpdateKnowledgeRetrievalSettings,
274
- z.ZodTypeDef,
275
- unknown
276
- > = z.object({
277
- retrieval_type: UpdateKnowledgeRetrievalType$inboundSchema.default(
278
- "hybrid_search",
279
- ),
280
- top_k: z.number().int().default(5),
281
- threshold: z.number().default(0),
282
- rerank_config: z.lazy(() => UpdateKnowledgeRerankConfig$inboundSchema)
283
- .optional(),
284
- }).transform((v) => {
285
- return remap$(v, {
286
- "retrieval_type": "retrievalType",
287
- "top_k": "topK",
288
- "rerank_config": "rerankConfig",
289
- });
290
- });
291
-
292
- /** @internal */
293
- export type UpdateKnowledgeRetrievalSettings$Outbound = {
294
- retrieval_type: string;
295
- top_k: number;
296
- threshold: number;
297
- rerank_config?: UpdateKnowledgeRerankConfig$Outbound | undefined;
298
- };
299
-
300
- /** @internal */
301
- export const UpdateKnowledgeRetrievalSettings$outboundSchema: z.ZodType<
302
- UpdateKnowledgeRetrievalSettings$Outbound,
303
- z.ZodTypeDef,
304
- UpdateKnowledgeRetrievalSettings
305
- > = z.object({
306
- retrievalType: UpdateKnowledgeRetrievalType$outboundSchema.default(
307
- "hybrid_search",
308
- ),
309
- topK: z.number().int().default(5),
310
- threshold: z.number().default(0),
311
- rerankConfig: z.lazy(() => UpdateKnowledgeRerankConfig$outboundSchema)
312
- .optional(),
313
- }).transform((v) => {
314
- return remap$(v, {
315
- retrievalType: "retrieval_type",
316
- topK: "top_k",
317
- rerankConfig: "rerank_config",
318
- });
319
- });
320
-
321
- /**
322
- * @internal
323
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
324
- */
325
- export namespace UpdateKnowledgeRetrievalSettings$ {
326
- /** @deprecated use `UpdateKnowledgeRetrievalSettings$inboundSchema` instead. */
327
- export const inboundSchema = UpdateKnowledgeRetrievalSettings$inboundSchema;
328
- /** @deprecated use `UpdateKnowledgeRetrievalSettings$outboundSchema` instead. */
329
- export const outboundSchema = UpdateKnowledgeRetrievalSettings$outboundSchema;
330
- /** @deprecated use `UpdateKnowledgeRetrievalSettings$Outbound` instead. */
331
- export type Outbound = UpdateKnowledgeRetrievalSettings$Outbound;
332
- }
333
-
334
- export function updateKnowledgeRetrievalSettingsToJSON(
335
- updateKnowledgeRetrievalSettings: UpdateKnowledgeRetrievalSettings,
336
- ): string {
337
- return JSON.stringify(
338
- UpdateKnowledgeRetrievalSettings$outboundSchema.parse(
339
- updateKnowledgeRetrievalSettings,
340
- ),
341
- );
342
- }
343
-
344
- export function updateKnowledgeRetrievalSettingsFromJSON(
345
- jsonString: string,
346
- ): SafeParseResult<UpdateKnowledgeRetrievalSettings, SDKValidationError> {
347
- return safeParse(
348
- jsonString,
349
- (x) => UpdateKnowledgeRetrievalSettings$inboundSchema.parse(JSON.parse(x)),
350
- `Failed to parse 'UpdateKnowledgeRetrievalSettings' from JSON`,
351
- );
352
- }
353
-
354
- /** @internal */
355
- export const UpdateKnowledgeRequestBody$inboundSchema: z.ZodType<
356
- UpdateKnowledgeRequestBody,
357
- z.ZodTypeDef,
358
- unknown
359
- > = z.object({
360
- description: z.string().optional(),
361
- embedding_model: z.string().optional(),
362
- path: z.string().optional(),
363
- retrieval_settings: z.lazy(() =>
364
- UpdateKnowledgeRetrievalSettings$inboundSchema
365
- ).optional(),
366
- }).transform((v) => {
367
- return remap$(v, {
368
- "embedding_model": "embeddingModel",
369
- "retrieval_settings": "retrievalSettings",
370
- });
371
- });
372
-
373
- /** @internal */
374
- export type UpdateKnowledgeRequestBody$Outbound = {
375
- description?: string | undefined;
376
- embedding_model?: string | undefined;
377
- path?: string | undefined;
378
- retrieval_settings?: UpdateKnowledgeRetrievalSettings$Outbound | undefined;
379
- };
380
-
381
- /** @internal */
382
- export const UpdateKnowledgeRequestBody$outboundSchema: z.ZodType<
383
- UpdateKnowledgeRequestBody$Outbound,
384
- z.ZodTypeDef,
385
- UpdateKnowledgeRequestBody
386
- > = z.object({
387
- description: z.string().optional(),
388
- embeddingModel: z.string().optional(),
389
- path: z.string().optional(),
390
- retrievalSettings: z.lazy(() =>
391
- UpdateKnowledgeRetrievalSettings$outboundSchema
392
- ).optional(),
393
- }).transform((v) => {
394
- return remap$(v, {
395
- embeddingModel: "embedding_model",
396
- retrievalSettings: "retrieval_settings",
397
- });
398
- });
399
-
400
- /**
401
- * @internal
402
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
403
- */
404
- export namespace UpdateKnowledgeRequestBody$ {
405
- /** @deprecated use `UpdateKnowledgeRequestBody$inboundSchema` instead. */
406
- export const inboundSchema = UpdateKnowledgeRequestBody$inboundSchema;
407
- /** @deprecated use `UpdateKnowledgeRequestBody$outboundSchema` instead. */
408
- export const outboundSchema = UpdateKnowledgeRequestBody$outboundSchema;
409
- /** @deprecated use `UpdateKnowledgeRequestBody$Outbound` instead. */
410
- export type Outbound = UpdateKnowledgeRequestBody$Outbound;
411
- }
412
-
413
- export function updateKnowledgeRequestBodyToJSON(
414
- updateKnowledgeRequestBody: UpdateKnowledgeRequestBody,
415
- ): string {
416
- return JSON.stringify(
417
- UpdateKnowledgeRequestBody$outboundSchema.parse(updateKnowledgeRequestBody),
418
- );
419
- }
420
-
421
- export function updateKnowledgeRequestBodyFromJSON(
422
- jsonString: string,
423
- ): SafeParseResult<UpdateKnowledgeRequestBody, SDKValidationError> {
424
- return safeParse(
425
- jsonString,
426
- (x) => UpdateKnowledgeRequestBody$inboundSchema.parse(JSON.parse(x)),
427
- `Failed to parse 'UpdateKnowledgeRequestBody' from JSON`,
428
- );
429
- }
430
-
431
- /** @internal */
432
- export const UpdateKnowledgeRequest$inboundSchema: z.ZodType<
433
- UpdateKnowledgeRequest,
434
- z.ZodTypeDef,
435
- unknown
436
- > = z.object({
437
- knowledge_id: z.string(),
438
- RequestBody: z.lazy(() => UpdateKnowledgeRequestBody$inboundSchema),
439
- }).transform((v) => {
440
- return remap$(v, {
441
- "knowledge_id": "knowledgeId",
442
- "RequestBody": "requestBody",
443
- });
444
- });
445
-
446
- /** @internal */
447
- export type UpdateKnowledgeRequest$Outbound = {
448
- knowledge_id: string;
449
- RequestBody: UpdateKnowledgeRequestBody$Outbound;
450
- };
451
-
452
- /** @internal */
453
- export const UpdateKnowledgeRequest$outboundSchema: z.ZodType<
454
- UpdateKnowledgeRequest$Outbound,
455
- z.ZodTypeDef,
456
- UpdateKnowledgeRequest
457
- > = z.object({
458
- knowledgeId: z.string(),
459
- requestBody: z.lazy(() => UpdateKnowledgeRequestBody$outboundSchema),
460
- }).transform((v) => {
461
- return remap$(v, {
462
- knowledgeId: "knowledge_id",
463
- requestBody: "RequestBody",
464
- });
465
- });
466
-
467
- /**
468
- * @internal
469
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
470
- */
471
- export namespace UpdateKnowledgeRequest$ {
472
- /** @deprecated use `UpdateKnowledgeRequest$inboundSchema` instead. */
473
- export const inboundSchema = UpdateKnowledgeRequest$inboundSchema;
474
- /** @deprecated use `UpdateKnowledgeRequest$outboundSchema` instead. */
475
- export const outboundSchema = UpdateKnowledgeRequest$outboundSchema;
476
- /** @deprecated use `UpdateKnowledgeRequest$Outbound` instead. */
477
- export type Outbound = UpdateKnowledgeRequest$Outbound;
478
- }
479
-
480
- export function updateKnowledgeRequestToJSON(
481
- updateKnowledgeRequest: UpdateKnowledgeRequest,
482
- ): string {
483
- return JSON.stringify(
484
- UpdateKnowledgeRequest$outboundSchema.parse(updateKnowledgeRequest),
485
- );
486
- }
487
-
488
- export function updateKnowledgeRequestFromJSON(
489
- jsonString: string,
490
- ): SafeParseResult<UpdateKnowledgeRequest, SDKValidationError> {
491
- return safeParse(
492
- jsonString,
493
- (x) => UpdateKnowledgeRequest$inboundSchema.parse(JSON.parse(x)),
494
- `Failed to parse 'UpdateKnowledgeRequest' from JSON`,
495
- );
496
- }
497
-
498
- /** @internal */
499
- export const UpdateKnowledgeKnowledgeRetrievalType$inboundSchema:
500
- z.ZodNativeEnum<typeof UpdateKnowledgeKnowledgeRetrievalType> = z.nativeEnum(
501
- UpdateKnowledgeKnowledgeRetrievalType,
502
- );
503
-
504
- /** @internal */
505
- export const UpdateKnowledgeKnowledgeRetrievalType$outboundSchema:
506
- z.ZodNativeEnum<typeof UpdateKnowledgeKnowledgeRetrievalType> =
507
- UpdateKnowledgeKnowledgeRetrievalType$inboundSchema;
508
-
509
- /**
510
- * @internal
511
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
512
- */
513
- export namespace UpdateKnowledgeKnowledgeRetrievalType$ {
514
- /** @deprecated use `UpdateKnowledgeKnowledgeRetrievalType$inboundSchema` instead. */
515
- export const inboundSchema =
516
- UpdateKnowledgeKnowledgeRetrievalType$inboundSchema;
517
- /** @deprecated use `UpdateKnowledgeKnowledgeRetrievalType$outboundSchema` instead. */
518
- export const outboundSchema =
519
- UpdateKnowledgeKnowledgeRetrievalType$outboundSchema;
520
- }
521
-
522
- /** @internal */
523
- export const UpdateKnowledgeKnowledgeRerankConfig$inboundSchema: z.ZodType<
524
- UpdateKnowledgeKnowledgeRerankConfig,
525
- z.ZodTypeDef,
526
- unknown
527
- > = z.object({
528
- rerank_threshold: z.number().default(0.5),
529
- rerank_model: z.string(),
530
- }).transform((v) => {
531
- return remap$(v, {
532
- "rerank_threshold": "rerankThreshold",
533
- "rerank_model": "rerankModel",
534
- });
535
- });
536
-
537
- /** @internal */
538
- export type UpdateKnowledgeKnowledgeRerankConfig$Outbound = {
539
- rerank_threshold: number;
540
- rerank_model: string;
541
- };
542
-
543
- /** @internal */
544
- export const UpdateKnowledgeKnowledgeRerankConfig$outboundSchema: z.ZodType<
545
- UpdateKnowledgeKnowledgeRerankConfig$Outbound,
546
- z.ZodTypeDef,
547
- UpdateKnowledgeKnowledgeRerankConfig
548
- > = z.object({
549
- rerankThreshold: z.number().default(0.5),
550
- rerankModel: z.string(),
551
- }).transform((v) => {
552
- return remap$(v, {
553
- rerankThreshold: "rerank_threshold",
554
- rerankModel: "rerank_model",
555
- });
556
- });
557
-
558
- /**
559
- * @internal
560
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
561
- */
562
- export namespace UpdateKnowledgeKnowledgeRerankConfig$ {
563
- /** @deprecated use `UpdateKnowledgeKnowledgeRerankConfig$inboundSchema` instead. */
564
- export const inboundSchema =
565
- UpdateKnowledgeKnowledgeRerankConfig$inboundSchema;
566
- /** @deprecated use `UpdateKnowledgeKnowledgeRerankConfig$outboundSchema` instead. */
567
- export const outboundSchema =
568
- UpdateKnowledgeKnowledgeRerankConfig$outboundSchema;
569
- /** @deprecated use `UpdateKnowledgeKnowledgeRerankConfig$Outbound` instead. */
570
- export type Outbound = UpdateKnowledgeKnowledgeRerankConfig$Outbound;
571
- }
572
-
573
- export function updateKnowledgeKnowledgeRerankConfigToJSON(
574
- updateKnowledgeKnowledgeRerankConfig: UpdateKnowledgeKnowledgeRerankConfig,
575
- ): string {
576
- return JSON.stringify(
577
- UpdateKnowledgeKnowledgeRerankConfig$outboundSchema.parse(
578
- updateKnowledgeKnowledgeRerankConfig,
579
- ),
580
- );
581
- }
582
-
583
- export function updateKnowledgeKnowledgeRerankConfigFromJSON(
584
- jsonString: string,
585
- ): SafeParseResult<UpdateKnowledgeKnowledgeRerankConfig, SDKValidationError> {
586
- return safeParse(
587
- jsonString,
588
- (x) =>
589
- UpdateKnowledgeKnowledgeRerankConfig$inboundSchema.parse(JSON.parse(x)),
590
- `Failed to parse 'UpdateKnowledgeKnowledgeRerankConfig' from JSON`,
591
- );
592
- }
593
-
594
- /** @internal */
595
- export const UpdateKnowledgeKnowledgeRetrievalSettings$inboundSchema: z.ZodType<
596
- UpdateKnowledgeKnowledgeRetrievalSettings,
597
- z.ZodTypeDef,
598
- unknown
599
- > = z.object({
600
- retrieval_type: UpdateKnowledgeKnowledgeRetrievalType$inboundSchema.default(
601
- "hybrid_search",
602
- ),
603
- top_k: z.number().int().default(5),
604
- threshold: z.number().default(0),
605
- rerank_config: z.lazy(() =>
606
- UpdateKnowledgeKnowledgeRerankConfig$inboundSchema
607
- ).optional(),
608
- }).transform((v) => {
609
- return remap$(v, {
610
- "retrieval_type": "retrievalType",
611
- "top_k": "topK",
612
- "rerank_config": "rerankConfig",
613
- });
614
- });
615
-
616
- /** @internal */
617
- export type UpdateKnowledgeKnowledgeRetrievalSettings$Outbound = {
618
- retrieval_type: string;
619
- top_k: number;
620
- threshold: number;
621
- rerank_config?: UpdateKnowledgeKnowledgeRerankConfig$Outbound | undefined;
622
- };
623
-
624
- /** @internal */
625
- export const UpdateKnowledgeKnowledgeRetrievalSettings$outboundSchema:
626
- z.ZodType<
627
- UpdateKnowledgeKnowledgeRetrievalSettings$Outbound,
628
- z.ZodTypeDef,
629
- UpdateKnowledgeKnowledgeRetrievalSettings
630
- > = z.object({
631
- retrievalType: UpdateKnowledgeKnowledgeRetrievalType$outboundSchema.default(
632
- "hybrid_search",
633
- ),
634
- topK: z.number().int().default(5),
635
- threshold: z.number().default(0),
636
- rerankConfig: z.lazy(() =>
637
- UpdateKnowledgeKnowledgeRerankConfig$outboundSchema
638
- ).optional(),
639
- }).transform((v) => {
640
- return remap$(v, {
641
- retrievalType: "retrieval_type",
642
- topK: "top_k",
643
- rerankConfig: "rerank_config",
644
- });
645
- });
646
-
647
- /**
648
- * @internal
649
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
650
- */
651
- export namespace UpdateKnowledgeKnowledgeRetrievalSettings$ {
652
- /** @deprecated use `UpdateKnowledgeKnowledgeRetrievalSettings$inboundSchema` instead. */
653
- export const inboundSchema =
654
- UpdateKnowledgeKnowledgeRetrievalSettings$inboundSchema;
655
- /** @deprecated use `UpdateKnowledgeKnowledgeRetrievalSettings$outboundSchema` instead. */
656
- export const outboundSchema =
657
- UpdateKnowledgeKnowledgeRetrievalSettings$outboundSchema;
658
- /** @deprecated use `UpdateKnowledgeKnowledgeRetrievalSettings$Outbound` instead. */
659
- export type Outbound = UpdateKnowledgeKnowledgeRetrievalSettings$Outbound;
660
- }
661
-
662
- export function updateKnowledgeKnowledgeRetrievalSettingsToJSON(
663
- updateKnowledgeKnowledgeRetrievalSettings:
664
- UpdateKnowledgeKnowledgeRetrievalSettings,
665
- ): string {
666
- return JSON.stringify(
667
- UpdateKnowledgeKnowledgeRetrievalSettings$outboundSchema.parse(
668
- updateKnowledgeKnowledgeRetrievalSettings,
669
- ),
670
- );
671
- }
672
-
673
- export function updateKnowledgeKnowledgeRetrievalSettingsFromJSON(
674
- jsonString: string,
675
- ): SafeParseResult<
676
- UpdateKnowledgeKnowledgeRetrievalSettings,
677
- SDKValidationError
678
- > {
679
- return safeParse(
680
- jsonString,
681
- (x) =>
682
- UpdateKnowledgeKnowledgeRetrievalSettings$inboundSchema.parse(
683
- JSON.parse(x),
684
- ),
685
- `Failed to parse 'UpdateKnowledgeKnowledgeRetrievalSettings' from JSON`,
686
- );
687
- }
688
-
689
- /** @internal */
690
- export const UpdateKnowledgeResponseBody$inboundSchema: z.ZodType<
691
- UpdateKnowledgeResponseBody,
692
- z.ZodTypeDef,
693
- unknown
694
- > = z.object({
695
- _id: z.string(),
696
- created: z.string(),
697
- description: z.string().optional(),
698
- key: z.string(),
699
- model: z.string(),
700
- path: z.string().optional(),
701
- retrieval_settings: z.lazy(() =>
702
- UpdateKnowledgeKnowledgeRetrievalSettings$inboundSchema
703
- ).optional(),
704
- created_by_id: z.nullable(z.string()).optional(),
705
- updated_by_id: z.nullable(z.string()).optional(),
706
- updated: z.string(),
707
- }).transform((v) => {
708
- return remap$(v, {
709
- "_id": "id",
710
- "retrieval_settings": "retrievalSettings",
711
- "created_by_id": "createdById",
712
- "updated_by_id": "updatedById",
713
- });
714
- });
715
-
716
- /** @internal */
717
- export type UpdateKnowledgeResponseBody$Outbound = {
718
- _id: string;
719
- created: string;
720
- description?: string | undefined;
721
- key: string;
722
- model: string;
723
- path?: string | undefined;
724
- retrieval_settings?:
725
- | UpdateKnowledgeKnowledgeRetrievalSettings$Outbound
726
- | undefined;
727
- created_by_id?: string | null | undefined;
728
- updated_by_id?: string | null | undefined;
729
- updated: string;
730
- };
731
-
732
- /** @internal */
733
- export const UpdateKnowledgeResponseBody$outboundSchema: z.ZodType<
734
- UpdateKnowledgeResponseBody$Outbound,
735
- z.ZodTypeDef,
736
- UpdateKnowledgeResponseBody
737
- > = z.object({
738
- id: z.string(),
739
- created: z.string(),
740
- description: z.string().optional(),
741
- key: z.string(),
742
- model: z.string(),
743
- path: z.string().optional(),
744
- retrievalSettings: z.lazy(() =>
745
- UpdateKnowledgeKnowledgeRetrievalSettings$outboundSchema
746
- ).optional(),
747
- createdById: z.nullable(z.string()).optional(),
748
- updatedById: z.nullable(z.string()).optional(),
749
- updated: z.string(),
750
- }).transform((v) => {
751
- return remap$(v, {
752
- id: "_id",
753
- retrievalSettings: "retrieval_settings",
754
- createdById: "created_by_id",
755
- updatedById: "updated_by_id",
756
- });
757
- });
758
-
759
- /**
760
- * @internal
761
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
762
- */
763
- export namespace UpdateKnowledgeResponseBody$ {
764
- /** @deprecated use `UpdateKnowledgeResponseBody$inboundSchema` instead. */
765
- export const inboundSchema = UpdateKnowledgeResponseBody$inboundSchema;
766
- /** @deprecated use `UpdateKnowledgeResponseBody$outboundSchema` instead. */
767
- export const outboundSchema = UpdateKnowledgeResponseBody$outboundSchema;
768
- /** @deprecated use `UpdateKnowledgeResponseBody$Outbound` instead. */
769
- export type Outbound = UpdateKnowledgeResponseBody$Outbound;
770
- }
771
-
772
- export function updateKnowledgeResponseBodyToJSON(
773
- updateKnowledgeResponseBody: UpdateKnowledgeResponseBody,
774
- ): string {
775
- return JSON.stringify(
776
- UpdateKnowledgeResponseBody$outboundSchema.parse(
777
- updateKnowledgeResponseBody,
778
- ),
779
- );
780
- }
781
-
782
- export function updateKnowledgeResponseBodyFromJSON(
783
- jsonString: string,
784
- ): SafeParseResult<UpdateKnowledgeResponseBody, SDKValidationError> {
785
- return safeParse(
786
- jsonString,
787
- (x) => UpdateKnowledgeResponseBody$inboundSchema.parse(JSON.parse(x)),
788
- `Failed to parse 'UpdateKnowledgeResponseBody' from JSON`,
789
- );
790
- }