@orq-ai/node 3.2.8 → 3.2.10

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