@orq-ai/node 3.2.11 → 3.2.13

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 (123) hide show
  1. package/bin/mcp-server.js +32 -32
  2. package/bin/mcp-server.js.map +17 -17
  3. package/jsr.json +1 -1
  4. package/lib/config.d.ts +3 -3
  5. package/lib/config.js +3 -3
  6. package/mcp-server/mcp-server.js +1 -1
  7. package/mcp-server/server.js +1 -1
  8. package/models/operations/bulkcreatedatapoints.js +2 -2
  9. package/models/operations/createcontact.js +2 -2
  10. package/models/operations/createdataset.js +2 -2
  11. package/models/operations/createdatasetitem.js +2 -2
  12. package/models/operations/fileget.js +2 -2
  13. package/models/operations/filelist.js +2 -2
  14. package/models/operations/fileupload.js +2 -2
  15. package/models/operations/listdatasetdatapoints.js +2 -2
  16. package/models/operations/listdatasets.js +2 -2
  17. package/models/operations/retrievedatapoint.js +2 -2
  18. package/models/operations/retrievedataset.js +2 -2
  19. package/models/operations/updatedatapoint.js +2 -2
  20. package/models/operations/updatedataset.js +2 -2
  21. package/package.json +1 -1
  22. package/packages/orq-rc/README.md +4 -2
  23. package/packages/orq-rc/docs/sdks/datasets/README.md +6 -0
  24. package/packages/orq-rc/docs/sdks/knowledge/README.md +140 -58
  25. package/packages/orq-rc/docs/sdks/prompts/README.md +6 -0
  26. package/packages/orq-rc/jsr.json +1 -1
  27. package/packages/orq-rc/package-lock.json +2 -2
  28. package/packages/orq-rc/package.json +1 -1
  29. package/packages/orq-rc/src/funcs/contactsCreate.ts +1 -1
  30. package/packages/orq-rc/src/funcs/datasetsClear.ts +1 -1
  31. package/packages/orq-rc/src/funcs/datasetsCreate.ts +1 -1
  32. package/packages/orq-rc/src/funcs/datasetsCreateDatapoint.ts +1 -1
  33. package/packages/orq-rc/src/funcs/datasetsCreateDatapoints.ts +1 -1
  34. package/packages/orq-rc/src/funcs/datasetsDelete.ts +1 -1
  35. package/packages/orq-rc/src/funcs/datasetsDeleteDatapoint.ts +1 -1
  36. package/packages/orq-rc/src/funcs/datasetsList.ts +1 -1
  37. package/packages/orq-rc/src/funcs/datasetsListDatapoints.ts +1 -1
  38. package/packages/orq-rc/src/funcs/datasetsRetrieve.ts +1 -1
  39. package/packages/orq-rc/src/funcs/datasetsRetrieveDatapoint.ts +1 -1
  40. package/packages/orq-rc/src/funcs/datasetsUpdate.ts +1 -1
  41. package/packages/orq-rc/src/funcs/datasetsUpdateDatapoint.ts +1 -1
  42. package/packages/orq-rc/src/funcs/deploymentsGetConfig.ts +1 -1
  43. package/packages/orq-rc/src/funcs/deploymentsInvoke.ts +1 -1
  44. package/packages/orq-rc/src/funcs/deploymentsList.ts +1 -1
  45. package/packages/orq-rc/src/funcs/deploymentsMetricsCreate.ts +1 -1
  46. package/packages/orq-rc/src/funcs/deploymentsStream.ts +1 -1
  47. package/packages/orq-rc/src/funcs/feedbackCreate.ts +1 -1
  48. package/packages/orq-rc/src/funcs/filesCreate.ts +1 -1
  49. package/packages/orq-rc/src/funcs/filesDelete.ts +1 -1
  50. package/packages/orq-rc/src/funcs/filesGet.ts +1 -1
  51. package/packages/orq-rc/src/funcs/filesList.ts +1 -1
  52. package/packages/orq-rc/src/funcs/knowledgeCreate.ts +1 -1
  53. package/packages/orq-rc/src/funcs/knowledgeCreateChunks.ts +1 -1
  54. package/packages/orq-rc/src/funcs/knowledgeCreateDatasource.ts +1 -1
  55. package/packages/orq-rc/src/funcs/knowledgeDelete.ts +1 -1
  56. package/packages/orq-rc/src/funcs/knowledgeDeleteChunk.ts +1 -1
  57. package/packages/orq-rc/src/funcs/knowledgeDeleteDatasource.ts +1 -1
  58. package/packages/orq-rc/src/funcs/knowledgeList.ts +1 -1
  59. package/packages/orq-rc/src/funcs/knowledgeListChunks.ts +1 -1
  60. package/packages/orq-rc/src/funcs/knowledgeListDatasources.ts +1 -1
  61. package/packages/orq-rc/src/funcs/knowledgeRetrieve.ts +1 -1
  62. package/packages/orq-rc/src/funcs/{knowledgeRetrieveFileUrl.ts → knowledgeRetrieveChunk.ts} +25 -34
  63. package/packages/orq-rc/src/funcs/knowledgeRetrieveDatasource.ts +1 -1
  64. package/packages/orq-rc/src/funcs/knowledgeSearch.ts +1 -1
  65. package/packages/orq-rc/src/funcs/knowledgeUpdate.ts +1 -1
  66. package/packages/orq-rc/src/funcs/knowledgeUpdateChunk.ts +1 -1
  67. package/packages/orq-rc/src/funcs/knowledgeUpdateDatasource.ts +164 -0
  68. package/packages/orq-rc/src/funcs/promptsCreate.ts +1 -1
  69. package/packages/orq-rc/src/funcs/promptsDelete.ts +1 -1
  70. package/packages/orq-rc/src/funcs/promptsGetVersion.ts +1 -1
  71. package/packages/orq-rc/src/funcs/promptsList.ts +1 -1
  72. package/packages/orq-rc/src/funcs/promptsListVersions.ts +1 -1
  73. package/packages/orq-rc/src/funcs/promptsRetrieve.ts +1 -1
  74. package/packages/orq-rc/src/funcs/promptsUpdate.ts +1 -1
  75. package/packages/orq-rc/src/funcs/remoteconfigsRetrieve.ts +1 -1
  76. package/packages/orq-rc/src/lib/config.ts +3 -3
  77. package/packages/orq-rc/src/mcp-server/mcp-server.ts +1 -1
  78. package/packages/orq-rc/src/mcp-server/server.ts +5 -3
  79. package/packages/orq-rc/src/mcp-server/tools/{knowledgeRetrieveFileUrl.ts → knowledgeRetrieveChunk.ts} +6 -6
  80. package/packages/orq-rc/src/mcp-server/tools/knowledgeUpdateDatasource.ts +35 -0
  81. package/packages/orq-rc/src/models/operations/bulkcreatedatapoints.ts +2 -2
  82. package/packages/orq-rc/src/models/operations/createchunk.ts +2 -2
  83. package/packages/orq-rc/src/models/operations/createcontact.ts +2 -2
  84. package/packages/orq-rc/src/models/operations/createdataset.ts +2 -2
  85. package/packages/orq-rc/src/models/operations/createdatasetitem.ts +2 -2
  86. package/packages/orq-rc/src/models/operations/createdatasource.ts +2 -2
  87. package/packages/orq-rc/src/models/operations/createknowledge.ts +324 -2562
  88. package/packages/orq-rc/src/models/operations/fileget.ts +2 -2
  89. package/packages/orq-rc/src/models/operations/filelist.ts +2 -2
  90. package/packages/orq-rc/src/models/operations/fileupload.ts +2 -2
  91. package/packages/orq-rc/src/models/operations/getonechunk.ts +265 -0
  92. package/packages/orq-rc/src/models/operations/getoneknowledge.ts +101 -1282
  93. package/packages/orq-rc/src/models/operations/index.ts +2 -1
  94. package/packages/orq-rc/src/models/operations/listdatasetdatapoints.ts +2 -2
  95. package/packages/orq-rc/src/models/operations/listdatasets.ts +2 -2
  96. package/packages/orq-rc/src/models/operations/listdatasources.ts +2 -2
  97. package/packages/orq-rc/src/models/operations/listknowledgebases.ts +101 -1309
  98. package/packages/orq-rc/src/models/operations/retrievedatapoint.ts +2 -2
  99. package/packages/orq-rc/src/models/operations/retrievedataset.ts +2 -2
  100. package/packages/orq-rc/src/models/operations/retrievedatasource.ts +2 -2
  101. package/packages/orq-rc/src/models/operations/updatedatapoint.ts +2 -2
  102. package/packages/orq-rc/src/models/operations/updatedataset.ts +25 -6
  103. package/packages/orq-rc/src/models/operations/updatedatasource.ts +345 -0
  104. package/packages/orq-rc/src/models/operations/updateknowledge.ts +383 -2710
  105. package/packages/orq-rc/src/models/operations/updateprompt.ts +7 -0
  106. package/packages/orq-rc/src/sdk/knowledge.ts +30 -15
  107. package/src/lib/config.ts +3 -3
  108. package/src/mcp-server/mcp-server.ts +1 -1
  109. package/src/mcp-server/server.ts +1 -1
  110. package/src/models/operations/bulkcreatedatapoints.ts +2 -2
  111. package/src/models/operations/createcontact.ts +2 -2
  112. package/src/models/operations/createdataset.ts +2 -2
  113. package/src/models/operations/createdatasetitem.ts +2 -2
  114. package/src/models/operations/fileget.ts +2 -2
  115. package/src/models/operations/filelist.ts +2 -2
  116. package/src/models/operations/fileupload.ts +2 -2
  117. package/src/models/operations/listdatasetdatapoints.ts +2 -2
  118. package/src/models/operations/listdatasets.ts +2 -2
  119. package/src/models/operations/retrievedatapoint.ts +2 -2
  120. package/src/models/operations/retrievedataset.ts +2 -2
  121. package/src/models/operations/updatedatapoint.ts +2 -2
  122. package/src/models/operations/updatedataset.ts +2 -2
  123. package/packages/orq-rc/src/models/operations/getonefileuploadurl.ts +0 -157
@@ -9,2362 +9,292 @@ import { ClosedEnum } from "../../types/enums.js";
9
9
  import { Result as SafeParseResult } from "../../types/fp.js";
10
10
  import { SDKValidationError } from "../errors/sdkvalidationerror.js";
11
11
 
12
- export const CreateKnowledgeRetrievalSettingsKnowledgeType = {
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 RetrievalType = {
16
+ VectorSearch: "vector_search",
17
+ KeywordSearch: "keyword_search",
13
18
  HybridSearch: "hybrid_search",
14
19
  } as const;
15
- export type CreateKnowledgeRetrievalSettingsKnowledgeType = ClosedEnum<
16
- typeof CreateKnowledgeRetrievalSettingsKnowledgeType
17
- >;
18
-
19
- export const CreateKnowledgeRetrievalSettingsKnowledgeProvider = {
20
- Cohere: "cohere",
21
- Openai: "openai",
22
- Anthropic: "anthropic",
23
- Huggingface: "huggingface",
24
- Replicate: "replicate",
25
- Google: "google",
26
- GoogleAi: "google-ai",
27
- Azure: "azure",
28
- Aws: "aws",
29
- Anyscale: "anyscale",
30
- Perplexity: "perplexity",
31
- Groq: "groq",
32
- Fal: "fal",
33
- Leonardoai: "leonardoai",
34
- Nvidia: "nvidia",
35
- Jina: "jina",
36
- Togetherai: "togetherai",
37
- Elevenlabs: "elevenlabs",
38
- } as const;
39
- export type CreateKnowledgeRetrievalSettingsKnowledgeProvider = ClosedEnum<
40
- typeof CreateKnowledgeRetrievalSettingsKnowledgeProvider
41
- >;
42
-
43
- export const CreateKnowledgeRetrievalSettingsKnowledgeModelType = {
44
- Rerank: "rerank",
45
- } as const;
46
- export type CreateKnowledgeRetrievalSettingsKnowledgeModelType = ClosedEnum<
47
- typeof CreateKnowledgeRetrievalSettingsKnowledgeModelType
48
- >;
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 RetrievalType = ClosedEnum<typeof RetrievalType>;
49
24
 
50
- export type CreateKnowledgeRetrievalSettingsKnowledgeModelParameters = {
25
+ /**
26
+ * The rerank configuration for the knowledge base. In case the model is provided it will be used to enhance the search precision.
27
+ */
28
+ export type RerankConfig = {
51
29
  /**
52
30
  * The threshold value used to filter the rerank results, only documents with a relevance score greater than the threshold will be returned
53
31
  */
54
- threshold?: number | undefined;
55
- };
56
-
57
- export type CreateKnowledgeRetrievalSettingsRerankConfig = {
58
- enabled?: boolean | undefined;
59
- provider?: CreateKnowledgeRetrievalSettingsKnowledgeProvider | undefined;
60
- /**
61
- * The name of the model to use
62
- */
63
- model?: string | undefined;
64
- /**
65
- * The ID of the model in the database
66
- */
67
- modelDbId?: string | undefined;
68
- modelType?: CreateKnowledgeRetrievalSettingsKnowledgeModelType | undefined;
69
- modelParameters?:
70
- | CreateKnowledgeRetrievalSettingsKnowledgeModelParameters
71
- | undefined;
72
- };
73
-
74
- export type RetrievalSettings3 = {
75
- type: CreateKnowledgeRetrievalSettingsKnowledgeType;
76
- /**
77
- * Used to filter chunks that are most similar to the query
78
- */
79
- topK?: number | undefined;
80
- /**
81
- * Used to filter chunks that are most similar to the query. A value of `0` will be consider disabled.
82
- */
83
- threshold?: number | undefined;
84
- rerankConfig?:
85
- | CreateKnowledgeRetrievalSettingsRerankConfig
86
- | null
87
- | undefined;
88
- };
89
-
90
- export const CreateKnowledgeRetrievalSettingsType = {
91
- KeywordSearch: "keyword_search",
92
- } as const;
93
- export type CreateKnowledgeRetrievalSettingsType = ClosedEnum<
94
- typeof CreateKnowledgeRetrievalSettingsType
95
- >;
96
-
97
- export const CreateKnowledgeRetrievalSettingsProvider = {
98
- Cohere: "cohere",
99
- Openai: "openai",
100
- Anthropic: "anthropic",
101
- Huggingface: "huggingface",
102
- Replicate: "replicate",
103
- Google: "google",
104
- GoogleAi: "google-ai",
105
- Azure: "azure",
106
- Aws: "aws",
107
- Anyscale: "anyscale",
108
- Perplexity: "perplexity",
109
- Groq: "groq",
110
- Fal: "fal",
111
- Leonardoai: "leonardoai",
112
- Nvidia: "nvidia",
113
- Jina: "jina",
114
- Togetherai: "togetherai",
115
- Elevenlabs: "elevenlabs",
116
- } as const;
117
- export type CreateKnowledgeRetrievalSettingsProvider = ClosedEnum<
118
- typeof CreateKnowledgeRetrievalSettingsProvider
119
- >;
120
-
121
- export const CreateKnowledgeRetrievalSettingsModelType = {
122
- Rerank: "rerank",
123
- } as const;
124
- export type CreateKnowledgeRetrievalSettingsModelType = ClosedEnum<
125
- typeof CreateKnowledgeRetrievalSettingsModelType
126
- >;
127
-
128
- export type CreateKnowledgeRetrievalSettingsModelParameters = {
32
+ rerankThreshold?: number | undefined;
129
33
  /**
130
- * The threshold value used to filter the rerank results, only documents with a relevance score greater than the threshold will be returned
34
+ * The rerank model to use for the knowledge base.
131
35
  */
132
- threshold?: number | undefined;
36
+ rerankModel: string;
133
37
  };
134
38
 
135
- export type RetrievalSettingsRerankConfig = {
136
- enabled?: boolean | undefined;
137
- provider?: CreateKnowledgeRetrievalSettingsProvider | undefined;
138
- /**
139
- * The name of the model to use
140
- */
141
- model?: string | undefined;
39
+ /**
40
+ * The retrieval settings for the knowledge base. If not provider, Hybrid Search will be used as a default query strategy.
41
+ */
42
+ export type RetrievalSettings = {
142
43
  /**
143
- * The ID of the model in the database
44
+ * The retrieval type to use for the knowledge base. If not provided, Hybrid Search will be used as a default query strategy.
144
45
  */
145
- modelDbId?: string | undefined;
146
- modelType?: CreateKnowledgeRetrievalSettingsModelType | undefined;
147
- modelParameters?: CreateKnowledgeRetrievalSettingsModelParameters | undefined;
148
- };
149
-
150
- export type RetrievalSettings2 = {
151
- type: CreateKnowledgeRetrievalSettingsType;
46
+ retrievalType?: RetrievalType | undefined;
152
47
  /**
153
- * Used to filter chunks that are most similar to the query
48
+ * The number of results to return from the search.
154
49
  */
155
50
  topK?: number | undefined;
156
51
  /**
157
- * Used to filter chunks that are most similar to the query. A value of `0` will be consider disabled.
158
- */
159
- threshold?: number | undefined;
160
- rerankConfig?: RetrievalSettingsRerankConfig | null | undefined;
161
- };
162
-
163
- export const RetrievalSettingsType = {
164
- VectorSearch: "vector_search",
165
- } as const;
166
- export type RetrievalSettingsType = ClosedEnum<typeof RetrievalSettingsType>;
167
-
168
- export const RetrievalSettingsProvider = {
169
- Cohere: "cohere",
170
- Openai: "openai",
171
- Anthropic: "anthropic",
172
- Huggingface: "huggingface",
173
- Replicate: "replicate",
174
- Google: "google",
175
- GoogleAi: "google-ai",
176
- Azure: "azure",
177
- Aws: "aws",
178
- Anyscale: "anyscale",
179
- Perplexity: "perplexity",
180
- Groq: "groq",
181
- Fal: "fal",
182
- Leonardoai: "leonardoai",
183
- Nvidia: "nvidia",
184
- Jina: "jina",
185
- Togetherai: "togetherai",
186
- Elevenlabs: "elevenlabs",
187
- } as const;
188
- export type RetrievalSettingsProvider = ClosedEnum<
189
- typeof RetrievalSettingsProvider
190
- >;
191
-
192
- export const RetrievalSettingsModelType = {
193
- Rerank: "rerank",
194
- } as const;
195
- export type RetrievalSettingsModelType = ClosedEnum<
196
- typeof RetrievalSettingsModelType
197
- >;
198
-
199
- export type RetrievalSettingsModelParameters = {
200
- /**
201
- * The threshold value used to filter the rerank results, only documents with a relevance score greater than the threshold will be returned
52
+ * The threshold value used to filter the search results, only documents with a relevance score greater than the threshold will be returned
202
53
  */
203
54
  threshold?: number | undefined;
204
- };
205
-
206
- export type RerankConfig = {
207
- enabled?: boolean | undefined;
208
- provider?: RetrievalSettingsProvider | undefined;
209
- /**
210
- * The name of the model to use
211
- */
212
- model?: string | undefined;
213
55
  /**
214
- * The ID of the model in the database
56
+ * The rerank configuration for the knowledge base. In case the model is provided it will be used to enhance the search precision.
215
57
  */
216
- modelDbId?: string | undefined;
217
- modelType?: RetrievalSettingsModelType | undefined;
218
- modelParameters?: RetrievalSettingsModelParameters | undefined;
219
- };
220
-
221
- export type RetrievalSettings1 = {
222
- type: RetrievalSettingsType;
223
- /**
224
- * Used to filter chunks that are most similar to the query
225
- */
226
- topK?: number | undefined;
227
- /**
228
- * Used to filter chunks that are most similar to the query. A value of `0` will be consider disabled.
229
- */
230
- threshold?: number | undefined;
231
- rerankConfig?: RerankConfig | null | undefined;
58
+ rerankConfig?: RerankConfig | undefined;
232
59
  };
233
60
 
234
- /**
235
- * The retrieval settings for the knowledge base. If not provider, Hybrid Search will be used as a default query strategy.
236
- */
237
- export type RetrievalSettings =
238
- | RetrievalSettings1
239
- | RetrievalSettings2
240
- | RetrievalSettings3;
241
-
242
61
  export type CreateKnowledgeRequestBody = {
243
62
  key: string;
244
63
  description?: string | undefined;
245
64
  /**
246
- * The embeddings model to use for the knowledge base.
65
+ * The embeddings model to use for the knowledge base. This model will be used to embed the chunks when they are added to the knowledge base.
247
66
  */
248
- model: string;
67
+ embeddingModel: string;
249
68
  /**
250
69
  * The retrieval settings for the knowledge base. If not provider, Hybrid Search will be used as a default query strategy.
251
70
  */
252
- retrievalSettings?:
253
- | RetrievalSettings1
254
- | RetrievalSettings2
255
- | RetrievalSettings3
256
- | undefined;
71
+ retrievalSettings?: RetrievalSettings | undefined;
257
72
  /**
258
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.
259
74
  */
260
75
  path: string;
261
76
  };
262
77
 
263
- export type CreateKnowledgeMetadata = {
264
- wordCount?: number | undefined;
265
- documentCount?: number | undefined;
266
- sentencesCount?: number | undefined;
267
- };
268
-
269
- export const CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONType =
270
- {
271
- HybridSearch: "hybrid_search",
272
- } as const;
273
- export type CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONType =
274
- ClosedEnum<
275
- typeof CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONType
276
- >;
277
-
278
- export const CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONProvider =
279
- {
280
- Cohere: "cohere",
281
- Openai: "openai",
282
- Anthropic: "anthropic",
283
- Huggingface: "huggingface",
284
- Replicate: "replicate",
285
- Google: "google",
286
- GoogleAi: "google-ai",
287
- Azure: "azure",
288
- Aws: "aws",
289
- Anyscale: "anyscale",
290
- Perplexity: "perplexity",
291
- Groq: "groq",
292
- Fal: "fal",
293
- Leonardoai: "leonardoai",
294
- Nvidia: "nvidia",
295
- Jina: "jina",
296
- Togetherai: "togetherai",
297
- Elevenlabs: "elevenlabs",
298
- } as const;
299
- export type CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONProvider =
300
- ClosedEnum<
301
- typeof CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONProvider
302
- >;
303
-
304
- export const CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONModelType =
305
- {
306
- Rerank: "rerank",
307
- } as const;
308
- export type CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONModelType =
309
- ClosedEnum<
310
- typeof CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONModelType
311
- >;
312
-
313
- export type CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONModelParameters =
314
- {
315
- /**
316
- * The threshold value used to filter the rerank results, only documents with a relevance score greater than the threshold will be returned
317
- */
318
- threshold?: number | undefined;
319
- };
320
-
321
- export type CreateKnowledgeRetrievalSettingsKnowledgeResponse200RerankConfig = {
322
- enabled?: boolean | undefined;
323
- provider?:
324
- | CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONProvider
325
- | undefined;
326
- /**
327
- * The name of the model to use
328
- */
329
- model?: string | undefined;
330
- /**
331
- * The ID of the model in the database
332
- */
333
- modelDbId?: string | undefined;
334
- modelType?:
335
- | CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONModelType
336
- | undefined;
337
- modelParameters?:
338
- | CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONModelParameters
339
- | undefined;
340
- /**
341
- * The id of the resource
342
- */
343
- integrationId?: string | null | undefined;
344
- };
345
-
346
- export type CreateKnowledgeRetrievalSettings3 = {
347
- type: CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONType;
348
- /**
349
- * Used to filter chunks that are most similar to the query
350
- */
351
- topK?: number | undefined;
352
- /**
353
- * Used to filter chunks that are most similar to the query. A value of `0` will be consider disabled.
354
- */
355
- threshold?: number | undefined;
356
- rerankConfig?:
357
- | CreateKnowledgeRetrievalSettingsKnowledgeResponse200RerankConfig
358
- | null
359
- | undefined;
360
- };
361
-
362
- export const CreateKnowledgeRetrievalSettingsKnowledgeResponse200Type = {
363
- KeywordSearch: "keyword_search",
364
- } as const;
365
- export type CreateKnowledgeRetrievalSettingsKnowledgeResponse200Type =
366
- ClosedEnum<typeof CreateKnowledgeRetrievalSettingsKnowledgeResponse200Type>;
367
-
368
- export const CreateKnowledgeRetrievalSettingsKnowledgeResponse200Provider = {
369
- Cohere: "cohere",
370
- Openai: "openai",
371
- Anthropic: "anthropic",
372
- Huggingface: "huggingface",
373
- Replicate: "replicate",
374
- Google: "google",
375
- GoogleAi: "google-ai",
376
- Azure: "azure",
377
- Aws: "aws",
378
- Anyscale: "anyscale",
379
- Perplexity: "perplexity",
380
- Groq: "groq",
381
- Fal: "fal",
382
- Leonardoai: "leonardoai",
383
- Nvidia: "nvidia",
384
- Jina: "jina",
385
- Togetherai: "togetherai",
386
- Elevenlabs: "elevenlabs",
387
- } as const;
388
- export type CreateKnowledgeRetrievalSettingsKnowledgeResponse200Provider =
389
- ClosedEnum<
390
- typeof CreateKnowledgeRetrievalSettingsKnowledgeResponse200Provider
391
- >;
392
-
393
- export const CreateKnowledgeRetrievalSettingsKnowledgeResponse200ModelType = {
394
- Rerank: "rerank",
395
- } as const;
396
- export type CreateKnowledgeRetrievalSettingsKnowledgeResponse200ModelType =
397
- ClosedEnum<
398
- typeof CreateKnowledgeRetrievalSettingsKnowledgeResponse200ModelType
399
- >;
400
-
401
- export type CreateKnowledgeRetrievalSettingsKnowledgeResponse200ModelParameters =
402
- {
403
- /**
404
- * The threshold value used to filter the rerank results, only documents with a relevance score greater than the threshold will be returned
405
- */
406
- threshold?: number | undefined;
407
- };
408
-
409
- export type CreateKnowledgeRetrievalSettingsKnowledgeResponseRerankConfig = {
410
- enabled?: boolean | undefined;
411
- provider?:
412
- | CreateKnowledgeRetrievalSettingsKnowledgeResponse200Provider
413
- | undefined;
414
- /**
415
- * The name of the model to use
416
- */
417
- model?: string | undefined;
418
- /**
419
- * The ID of the model in the database
420
- */
421
- modelDbId?: string | undefined;
422
- modelType?:
423
- | CreateKnowledgeRetrievalSettingsKnowledgeResponse200ModelType
424
- | undefined;
425
- modelParameters?:
426
- | CreateKnowledgeRetrievalSettingsKnowledgeResponse200ModelParameters
427
- | undefined;
428
- /**
429
- * The id of the resource
430
- */
431
- integrationId?: string | null | undefined;
432
- };
433
-
434
- export type CreateKnowledgeRetrievalSettings2 = {
435
- type: CreateKnowledgeRetrievalSettingsKnowledgeResponse200Type;
436
- /**
437
- * Used to filter chunks that are most similar to the query
438
- */
439
- topK?: number | undefined;
440
- /**
441
- * Used to filter chunks that are most similar to the query. A value of `0` will be consider disabled.
442
- */
443
- threshold?: number | undefined;
444
- rerankConfig?:
445
- | CreateKnowledgeRetrievalSettingsKnowledgeResponseRerankConfig
446
- | null
447
- | undefined;
448
- };
449
-
450
- export const CreateKnowledgeRetrievalSettingsKnowledgeResponseType = {
78
+ /**
79
+ * The retrieval type to use for the knowledge base. If not provided, Hybrid Search will be used as a default query strategy.
80
+ */
81
+ export const CreateKnowledgeRetrievalType = {
451
82
  VectorSearch: "vector_search",
83
+ KeywordSearch: "keyword_search",
84
+ HybridSearch: "hybrid_search",
452
85
  } as const;
453
- export type CreateKnowledgeRetrievalSettingsKnowledgeResponseType = ClosedEnum<
454
- typeof CreateKnowledgeRetrievalSettingsKnowledgeResponseType
86
+ /**
87
+ * The retrieval type to use for the knowledge base. If not provided, Hybrid Search will be used as a default query strategy.
88
+ */
89
+ export type CreateKnowledgeRetrievalType = ClosedEnum<
90
+ typeof CreateKnowledgeRetrievalType
455
91
  >;
456
92
 
457
- export const CreateKnowledgeRetrievalSettingsKnowledgeResponseProvider = {
458
- Cohere: "cohere",
459
- Openai: "openai",
460
- Anthropic: "anthropic",
461
- Huggingface: "huggingface",
462
- Replicate: "replicate",
463
- Google: "google",
464
- GoogleAi: "google-ai",
465
- Azure: "azure",
466
- Aws: "aws",
467
- Anyscale: "anyscale",
468
- Perplexity: "perplexity",
469
- Groq: "groq",
470
- Fal: "fal",
471
- Leonardoai: "leonardoai",
472
- Nvidia: "nvidia",
473
- Jina: "jina",
474
- Togetherai: "togetherai",
475
- Elevenlabs: "elevenlabs",
476
- } as const;
477
- export type CreateKnowledgeRetrievalSettingsKnowledgeResponseProvider =
478
- ClosedEnum<typeof CreateKnowledgeRetrievalSettingsKnowledgeResponseProvider>;
479
-
480
- export const CreateKnowledgeRetrievalSettingsKnowledgeResponseModelType = {
481
- Rerank: "rerank",
482
- } as const;
483
- export type CreateKnowledgeRetrievalSettingsKnowledgeResponseModelType =
484
- ClosedEnum<typeof CreateKnowledgeRetrievalSettingsKnowledgeResponseModelType>;
485
-
486
- export type CreateKnowledgeRetrievalSettingsKnowledgeResponseModelParameters = {
93
+ /**
94
+ * The rerank configuration for the knowledge base. In case the model is provided it will be used to enhance the search precision.
95
+ */
96
+ export type CreateKnowledgeRerankConfig = {
487
97
  /**
488
98
  * The threshold value used to filter the rerank results, only documents with a relevance score greater than the threshold will be returned
489
99
  */
490
- threshold?: number | undefined;
491
- };
492
-
493
- export type CreateKnowledgeRetrievalSettingsKnowledgeRerankConfig = {
494
- enabled?: boolean | undefined;
495
- provider?:
496
- | CreateKnowledgeRetrievalSettingsKnowledgeResponseProvider
497
- | undefined;
498
- /**
499
- * The name of the model to use
500
- */
501
- model?: string | undefined;
502
- /**
503
- * The ID of the model in the database
504
- */
505
- modelDbId?: string | undefined;
506
- modelType?:
507
- | CreateKnowledgeRetrievalSettingsKnowledgeResponseModelType
508
- | undefined;
509
- modelParameters?:
510
- | CreateKnowledgeRetrievalSettingsKnowledgeResponseModelParameters
511
- | undefined;
512
- /**
513
- * The id of the resource
514
- */
515
- integrationId?: string | null | undefined;
516
- };
517
-
518
- export type CreateKnowledgeRetrievalSettings1 = {
519
- type: CreateKnowledgeRetrievalSettingsKnowledgeResponseType;
520
- /**
521
- * Used to filter chunks that are most similar to the query
522
- */
523
- topK?: number | undefined;
100
+ rerankThreshold?: number | undefined;
524
101
  /**
525
- * Used to filter chunks that are most similar to the query. A value of `0` will be consider disabled.
102
+ * The rerank model to use for the knowledge base.
526
103
  */
527
- threshold?: number | undefined;
528
- rerankConfig?:
529
- | CreateKnowledgeRetrievalSettingsKnowledgeRerankConfig
530
- | null
531
- | undefined;
104
+ rerankModel: string;
532
105
  };
533
106
 
534
- export type CreateKnowledgeRetrievalSettings =
535
- | CreateKnowledgeRetrievalSettings1
536
- | CreateKnowledgeRetrievalSettings2
537
- | CreateKnowledgeRetrievalSettings3;
538
-
539
107
  /**
540
- * Knowledge Base object
108
+ * The retrieval settings for the knowledge base. If not provider, Hybrid Search will be used as a default query strategy.
541
109
  */
542
- export type CreateKnowledgeResponseBody = {
543
- /**
544
- * The unique identifier of the knowledge base.
545
- */
546
- id: string;
547
- /**
548
- * The id of the resource
549
- */
550
- createdById: string;
551
- /**
552
- * The creation date of the knowledge base.
553
- */
554
- created: string;
555
- /**
556
- * The description of the knowledge base.
557
- */
558
- description?: string | undefined;
559
- /**
560
- * The unique key of the knowledge base.
561
- */
562
- key: string;
563
- metadata: CreateKnowledgeMetadata;
564
- /**
565
- * The embeddings model used for the knowledge base.
566
- */
567
- model: string;
568
- /**
569
- * 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.
570
- */
571
- path?: string | undefined;
572
- retrievalSettings:
573
- | CreateKnowledgeRetrievalSettings1
574
- | CreateKnowledgeRetrievalSettings2
575
- | CreateKnowledgeRetrievalSettings3;
576
- /**
577
- * The id of the resource
578
- */
579
- updateById: string;
110
+ export type CreateKnowledgeRetrievalSettings = {
580
111
  /**
581
- * The last update date of the knowledge base.
112
+ * The retrieval type to use for the knowledge base. If not provided, Hybrid Search will be used as a default query strategy.
582
113
  */
583
- updated: string;
584
- };
585
-
586
- /** @internal */
587
- export const CreateKnowledgeRetrievalSettingsKnowledgeType$inboundSchema:
588
- z.ZodNativeEnum<typeof CreateKnowledgeRetrievalSettingsKnowledgeType> = z
589
- .nativeEnum(CreateKnowledgeRetrievalSettingsKnowledgeType);
590
-
591
- /** @internal */
592
- export const CreateKnowledgeRetrievalSettingsKnowledgeType$outboundSchema:
593
- z.ZodNativeEnum<typeof CreateKnowledgeRetrievalSettingsKnowledgeType> =
594
- CreateKnowledgeRetrievalSettingsKnowledgeType$inboundSchema;
595
-
596
- /**
597
- * @internal
598
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
599
- */
600
- export namespace CreateKnowledgeRetrievalSettingsKnowledgeType$ {
601
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeType$inboundSchema` instead. */
602
- export const inboundSchema =
603
- CreateKnowledgeRetrievalSettingsKnowledgeType$inboundSchema;
604
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeType$outboundSchema` instead. */
605
- export const outboundSchema =
606
- CreateKnowledgeRetrievalSettingsKnowledgeType$outboundSchema;
607
- }
608
-
609
- /** @internal */
610
- export const CreateKnowledgeRetrievalSettingsKnowledgeProvider$inboundSchema:
611
- z.ZodNativeEnum<typeof CreateKnowledgeRetrievalSettingsKnowledgeProvider> = z
612
- .nativeEnum(CreateKnowledgeRetrievalSettingsKnowledgeProvider);
613
-
614
- /** @internal */
615
- export const CreateKnowledgeRetrievalSettingsKnowledgeProvider$outboundSchema:
616
- z.ZodNativeEnum<typeof CreateKnowledgeRetrievalSettingsKnowledgeProvider> =
617
- CreateKnowledgeRetrievalSettingsKnowledgeProvider$inboundSchema;
618
-
619
- /**
620
- * @internal
621
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
622
- */
623
- export namespace CreateKnowledgeRetrievalSettingsKnowledgeProvider$ {
624
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeProvider$inboundSchema` instead. */
625
- export const inboundSchema =
626
- CreateKnowledgeRetrievalSettingsKnowledgeProvider$inboundSchema;
627
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeProvider$outboundSchema` instead. */
628
- export const outboundSchema =
629
- CreateKnowledgeRetrievalSettingsKnowledgeProvider$outboundSchema;
630
- }
631
-
632
- /** @internal */
633
- export const CreateKnowledgeRetrievalSettingsKnowledgeModelType$inboundSchema:
634
- z.ZodNativeEnum<typeof CreateKnowledgeRetrievalSettingsKnowledgeModelType> = z
635
- .nativeEnum(CreateKnowledgeRetrievalSettingsKnowledgeModelType);
636
-
637
- /** @internal */
638
- export const CreateKnowledgeRetrievalSettingsKnowledgeModelType$outboundSchema:
639
- z.ZodNativeEnum<typeof CreateKnowledgeRetrievalSettingsKnowledgeModelType> =
640
- CreateKnowledgeRetrievalSettingsKnowledgeModelType$inboundSchema;
641
-
642
- /**
643
- * @internal
644
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
645
- */
646
- export namespace CreateKnowledgeRetrievalSettingsKnowledgeModelType$ {
647
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeModelType$inboundSchema` instead. */
648
- export const inboundSchema =
649
- CreateKnowledgeRetrievalSettingsKnowledgeModelType$inboundSchema;
650
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeModelType$outboundSchema` instead. */
651
- export const outboundSchema =
652
- CreateKnowledgeRetrievalSettingsKnowledgeModelType$outboundSchema;
653
- }
654
-
655
- /** @internal */
656
- export const CreateKnowledgeRetrievalSettingsKnowledgeModelParameters$inboundSchema:
657
- z.ZodType<
658
- CreateKnowledgeRetrievalSettingsKnowledgeModelParameters,
659
- z.ZodTypeDef,
660
- unknown
661
- > = z.object({
662
- threshold: z.number().optional(),
663
- });
664
-
665
- /** @internal */
666
- export type CreateKnowledgeRetrievalSettingsKnowledgeModelParameters$Outbound =
667
- {
668
- threshold?: number | undefined;
669
- };
670
-
671
- /** @internal */
672
- export const CreateKnowledgeRetrievalSettingsKnowledgeModelParameters$outboundSchema:
673
- z.ZodType<
674
- CreateKnowledgeRetrievalSettingsKnowledgeModelParameters$Outbound,
675
- z.ZodTypeDef,
676
- CreateKnowledgeRetrievalSettingsKnowledgeModelParameters
677
- > = z.object({
678
- threshold: z.number().optional(),
679
- });
680
-
681
- /**
682
- * @internal
683
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
684
- */
685
- export namespace CreateKnowledgeRetrievalSettingsKnowledgeModelParameters$ {
686
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeModelParameters$inboundSchema` instead. */
687
- export const inboundSchema =
688
- CreateKnowledgeRetrievalSettingsKnowledgeModelParameters$inboundSchema;
689
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeModelParameters$outboundSchema` instead. */
690
- export const outboundSchema =
691
- CreateKnowledgeRetrievalSettingsKnowledgeModelParameters$outboundSchema;
692
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeModelParameters$Outbound` instead. */
693
- export type Outbound =
694
- CreateKnowledgeRetrievalSettingsKnowledgeModelParameters$Outbound;
695
- }
696
-
697
- export function createKnowledgeRetrievalSettingsKnowledgeModelParametersToJSON(
698
- createKnowledgeRetrievalSettingsKnowledgeModelParameters:
699
- CreateKnowledgeRetrievalSettingsKnowledgeModelParameters,
700
- ): string {
701
- return JSON.stringify(
702
- CreateKnowledgeRetrievalSettingsKnowledgeModelParameters$outboundSchema
703
- .parse(createKnowledgeRetrievalSettingsKnowledgeModelParameters),
704
- );
705
- }
706
-
707
- export function createKnowledgeRetrievalSettingsKnowledgeModelParametersFromJSON(
708
- jsonString: string,
709
- ): SafeParseResult<
710
- CreateKnowledgeRetrievalSettingsKnowledgeModelParameters,
711
- SDKValidationError
712
- > {
713
- return safeParse(
714
- jsonString,
715
- (x) =>
716
- CreateKnowledgeRetrievalSettingsKnowledgeModelParameters$inboundSchema
717
- .parse(JSON.parse(x)),
718
- `Failed to parse 'CreateKnowledgeRetrievalSettingsKnowledgeModelParameters' from JSON`,
719
- );
720
- }
721
-
722
- /** @internal */
723
- export const CreateKnowledgeRetrievalSettingsRerankConfig$inboundSchema:
724
- z.ZodType<
725
- CreateKnowledgeRetrievalSettingsRerankConfig,
726
- z.ZodTypeDef,
727
- unknown
728
- > = z.object({
729
- enabled: z.boolean().optional(),
730
- provider: CreateKnowledgeRetrievalSettingsKnowledgeProvider$inboundSchema
731
- .optional(),
732
- model: z.string().optional(),
733
- model_db_id: z.string().optional(),
734
- model_type: CreateKnowledgeRetrievalSettingsKnowledgeModelType$inboundSchema
735
- .optional(),
736
- model_parameters: z.lazy(() =>
737
- CreateKnowledgeRetrievalSettingsKnowledgeModelParameters$inboundSchema
738
- ).optional(),
739
- }).transform((v) => {
740
- return remap$(v, {
741
- "model_db_id": "modelDbId",
742
- "model_type": "modelType",
743
- "model_parameters": "modelParameters",
744
- });
745
- });
746
-
747
- /** @internal */
748
- export type CreateKnowledgeRetrievalSettingsRerankConfig$Outbound = {
749
- enabled?: boolean | undefined;
750
- provider?: string | undefined;
751
- model?: string | undefined;
752
- model_db_id?: string | undefined;
753
- model_type?: string | undefined;
754
- model_parameters?:
755
- | CreateKnowledgeRetrievalSettingsKnowledgeModelParameters$Outbound
756
- | undefined;
757
- };
758
-
759
- /** @internal */
760
- export const CreateKnowledgeRetrievalSettingsRerankConfig$outboundSchema:
761
- z.ZodType<
762
- CreateKnowledgeRetrievalSettingsRerankConfig$Outbound,
763
- z.ZodTypeDef,
764
- CreateKnowledgeRetrievalSettingsRerankConfig
765
- > = z.object({
766
- enabled: z.boolean().optional(),
767
- provider: CreateKnowledgeRetrievalSettingsKnowledgeProvider$outboundSchema
768
- .optional(),
769
- model: z.string().optional(),
770
- modelDbId: z.string().optional(),
771
- modelType: CreateKnowledgeRetrievalSettingsKnowledgeModelType$outboundSchema
772
- .optional(),
773
- modelParameters: z.lazy(() =>
774
- CreateKnowledgeRetrievalSettingsKnowledgeModelParameters$outboundSchema
775
- ).optional(),
776
- }).transform((v) => {
777
- return remap$(v, {
778
- modelDbId: "model_db_id",
779
- modelType: "model_type",
780
- modelParameters: "model_parameters",
781
- });
782
- });
783
-
784
- /**
785
- * @internal
786
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
787
- */
788
- export namespace CreateKnowledgeRetrievalSettingsRerankConfig$ {
789
- /** @deprecated use `CreateKnowledgeRetrievalSettingsRerankConfig$inboundSchema` instead. */
790
- export const inboundSchema =
791
- CreateKnowledgeRetrievalSettingsRerankConfig$inboundSchema;
792
- /** @deprecated use `CreateKnowledgeRetrievalSettingsRerankConfig$outboundSchema` instead. */
793
- export const outboundSchema =
794
- CreateKnowledgeRetrievalSettingsRerankConfig$outboundSchema;
795
- /** @deprecated use `CreateKnowledgeRetrievalSettingsRerankConfig$Outbound` instead. */
796
- export type Outbound = CreateKnowledgeRetrievalSettingsRerankConfig$Outbound;
797
- }
798
-
799
- export function createKnowledgeRetrievalSettingsRerankConfigToJSON(
800
- createKnowledgeRetrievalSettingsRerankConfig:
801
- CreateKnowledgeRetrievalSettingsRerankConfig,
802
- ): string {
803
- return JSON.stringify(
804
- CreateKnowledgeRetrievalSettingsRerankConfig$outboundSchema.parse(
805
- createKnowledgeRetrievalSettingsRerankConfig,
806
- ),
807
- );
808
- }
809
-
810
- export function createKnowledgeRetrievalSettingsRerankConfigFromJSON(
811
- jsonString: string,
812
- ): SafeParseResult<
813
- CreateKnowledgeRetrievalSettingsRerankConfig,
814
- SDKValidationError
815
- > {
816
- return safeParse(
817
- jsonString,
818
- (x) =>
819
- CreateKnowledgeRetrievalSettingsRerankConfig$inboundSchema.parse(
820
- JSON.parse(x),
821
- ),
822
- `Failed to parse 'CreateKnowledgeRetrievalSettingsRerankConfig' from JSON`,
823
- );
824
- }
825
-
826
- /** @internal */
827
- export const RetrievalSettings3$inboundSchema: z.ZodType<
828
- RetrievalSettings3,
829
- z.ZodTypeDef,
830
- unknown
831
- > = z.object({
832
- type: CreateKnowledgeRetrievalSettingsKnowledgeType$inboundSchema,
833
- top_k: z.number().int().default(5),
834
- threshold: z.number().default(0),
835
- rerank_config: z.nullable(
836
- z.lazy(() => CreateKnowledgeRetrievalSettingsRerankConfig$inboundSchema),
837
- ).optional(),
838
- }).transform((v) => {
839
- return remap$(v, {
840
- "top_k": "topK",
841
- "rerank_config": "rerankConfig",
842
- });
843
- });
844
-
845
- /** @internal */
846
- export type RetrievalSettings3$Outbound = {
847
- type: string;
848
- top_k: number;
849
- threshold: number;
850
- rerank_config?:
851
- | CreateKnowledgeRetrievalSettingsRerankConfig$Outbound
852
- | null
853
- | undefined;
854
- };
855
-
856
- /** @internal */
857
- export const RetrievalSettings3$outboundSchema: z.ZodType<
858
- RetrievalSettings3$Outbound,
859
- z.ZodTypeDef,
860
- RetrievalSettings3
861
- > = z.object({
862
- type: CreateKnowledgeRetrievalSettingsKnowledgeType$outboundSchema,
863
- topK: z.number().int().default(5),
864
- threshold: z.number().default(0),
865
- rerankConfig: z.nullable(
866
- z.lazy(() => CreateKnowledgeRetrievalSettingsRerankConfig$outboundSchema),
867
- ).optional(),
868
- }).transform((v) => {
869
- return remap$(v, {
870
- topK: "top_k",
871
- rerankConfig: "rerank_config",
872
- });
873
- });
874
-
875
- /**
876
- * @internal
877
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
878
- */
879
- export namespace RetrievalSettings3$ {
880
- /** @deprecated use `RetrievalSettings3$inboundSchema` instead. */
881
- export const inboundSchema = RetrievalSettings3$inboundSchema;
882
- /** @deprecated use `RetrievalSettings3$outboundSchema` instead. */
883
- export const outboundSchema = RetrievalSettings3$outboundSchema;
884
- /** @deprecated use `RetrievalSettings3$Outbound` instead. */
885
- export type Outbound = RetrievalSettings3$Outbound;
886
- }
887
-
888
- export function retrievalSettings3ToJSON(
889
- retrievalSettings3: RetrievalSettings3,
890
- ): string {
891
- return JSON.stringify(
892
- RetrievalSettings3$outboundSchema.parse(retrievalSettings3),
893
- );
894
- }
895
-
896
- export function retrievalSettings3FromJSON(
897
- jsonString: string,
898
- ): SafeParseResult<RetrievalSettings3, SDKValidationError> {
899
- return safeParse(
900
- jsonString,
901
- (x) => RetrievalSettings3$inboundSchema.parse(JSON.parse(x)),
902
- `Failed to parse 'RetrievalSettings3' from JSON`,
903
- );
904
- }
905
-
906
- /** @internal */
907
- export const CreateKnowledgeRetrievalSettingsType$inboundSchema:
908
- z.ZodNativeEnum<typeof CreateKnowledgeRetrievalSettingsType> = z.nativeEnum(
909
- CreateKnowledgeRetrievalSettingsType,
910
- );
911
-
912
- /** @internal */
913
- export const CreateKnowledgeRetrievalSettingsType$outboundSchema:
914
- z.ZodNativeEnum<typeof CreateKnowledgeRetrievalSettingsType> =
915
- CreateKnowledgeRetrievalSettingsType$inboundSchema;
916
-
917
- /**
918
- * @internal
919
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
920
- */
921
- export namespace CreateKnowledgeRetrievalSettingsType$ {
922
- /** @deprecated use `CreateKnowledgeRetrievalSettingsType$inboundSchema` instead. */
923
- export const inboundSchema =
924
- CreateKnowledgeRetrievalSettingsType$inboundSchema;
925
- /** @deprecated use `CreateKnowledgeRetrievalSettingsType$outboundSchema` instead. */
926
- export const outboundSchema =
927
- CreateKnowledgeRetrievalSettingsType$outboundSchema;
928
- }
929
-
930
- /** @internal */
931
- export const CreateKnowledgeRetrievalSettingsProvider$inboundSchema:
932
- z.ZodNativeEnum<typeof CreateKnowledgeRetrievalSettingsProvider> = z
933
- .nativeEnum(CreateKnowledgeRetrievalSettingsProvider);
934
-
935
- /** @internal */
936
- export const CreateKnowledgeRetrievalSettingsProvider$outboundSchema:
937
- z.ZodNativeEnum<typeof CreateKnowledgeRetrievalSettingsProvider> =
938
- CreateKnowledgeRetrievalSettingsProvider$inboundSchema;
939
-
940
- /**
941
- * @internal
942
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
943
- */
944
- export namespace CreateKnowledgeRetrievalSettingsProvider$ {
945
- /** @deprecated use `CreateKnowledgeRetrievalSettingsProvider$inboundSchema` instead. */
946
- export const inboundSchema =
947
- CreateKnowledgeRetrievalSettingsProvider$inboundSchema;
948
- /** @deprecated use `CreateKnowledgeRetrievalSettingsProvider$outboundSchema` instead. */
949
- export const outboundSchema =
950
- CreateKnowledgeRetrievalSettingsProvider$outboundSchema;
951
- }
952
-
953
- /** @internal */
954
- export const CreateKnowledgeRetrievalSettingsModelType$inboundSchema:
955
- z.ZodNativeEnum<typeof CreateKnowledgeRetrievalSettingsModelType> = z
956
- .nativeEnum(CreateKnowledgeRetrievalSettingsModelType);
957
-
958
- /** @internal */
959
- export const CreateKnowledgeRetrievalSettingsModelType$outboundSchema:
960
- z.ZodNativeEnum<typeof CreateKnowledgeRetrievalSettingsModelType> =
961
- CreateKnowledgeRetrievalSettingsModelType$inboundSchema;
962
-
963
- /**
964
- * @internal
965
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
966
- */
967
- export namespace CreateKnowledgeRetrievalSettingsModelType$ {
968
- /** @deprecated use `CreateKnowledgeRetrievalSettingsModelType$inboundSchema` instead. */
969
- export const inboundSchema =
970
- CreateKnowledgeRetrievalSettingsModelType$inboundSchema;
971
- /** @deprecated use `CreateKnowledgeRetrievalSettingsModelType$outboundSchema` instead. */
972
- export const outboundSchema =
973
- CreateKnowledgeRetrievalSettingsModelType$outboundSchema;
974
- }
975
-
976
- /** @internal */
977
- export const CreateKnowledgeRetrievalSettingsModelParameters$inboundSchema:
978
- z.ZodType<
979
- CreateKnowledgeRetrievalSettingsModelParameters,
980
- z.ZodTypeDef,
981
- unknown
982
- > = z.object({
983
- threshold: z.number().optional(),
984
- });
985
-
986
- /** @internal */
987
- export type CreateKnowledgeRetrievalSettingsModelParameters$Outbound = {
988
- threshold?: number | undefined;
989
- };
990
-
991
- /** @internal */
992
- export const CreateKnowledgeRetrievalSettingsModelParameters$outboundSchema:
993
- z.ZodType<
994
- CreateKnowledgeRetrievalSettingsModelParameters$Outbound,
995
- z.ZodTypeDef,
996
- CreateKnowledgeRetrievalSettingsModelParameters
997
- > = z.object({
998
- threshold: z.number().optional(),
999
- });
1000
-
1001
- /**
1002
- * @internal
1003
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
1004
- */
1005
- export namespace CreateKnowledgeRetrievalSettingsModelParameters$ {
1006
- /** @deprecated use `CreateKnowledgeRetrievalSettingsModelParameters$inboundSchema` instead. */
1007
- export const inboundSchema =
1008
- CreateKnowledgeRetrievalSettingsModelParameters$inboundSchema;
1009
- /** @deprecated use `CreateKnowledgeRetrievalSettingsModelParameters$outboundSchema` instead. */
1010
- export const outboundSchema =
1011
- CreateKnowledgeRetrievalSettingsModelParameters$outboundSchema;
1012
- /** @deprecated use `CreateKnowledgeRetrievalSettingsModelParameters$Outbound` instead. */
1013
- export type Outbound =
1014
- CreateKnowledgeRetrievalSettingsModelParameters$Outbound;
1015
- }
1016
-
1017
- export function createKnowledgeRetrievalSettingsModelParametersToJSON(
1018
- createKnowledgeRetrievalSettingsModelParameters:
1019
- CreateKnowledgeRetrievalSettingsModelParameters,
1020
- ): string {
1021
- return JSON.stringify(
1022
- CreateKnowledgeRetrievalSettingsModelParameters$outboundSchema.parse(
1023
- createKnowledgeRetrievalSettingsModelParameters,
1024
- ),
1025
- );
1026
- }
1027
-
1028
- export function createKnowledgeRetrievalSettingsModelParametersFromJSON(
1029
- jsonString: string,
1030
- ): SafeParseResult<
1031
- CreateKnowledgeRetrievalSettingsModelParameters,
1032
- SDKValidationError
1033
- > {
1034
- return safeParse(
1035
- jsonString,
1036
- (x) =>
1037
- CreateKnowledgeRetrievalSettingsModelParameters$inboundSchema.parse(
1038
- JSON.parse(x),
1039
- ),
1040
- `Failed to parse 'CreateKnowledgeRetrievalSettingsModelParameters' from JSON`,
1041
- );
1042
- }
1043
-
1044
- /** @internal */
1045
- export const RetrievalSettingsRerankConfig$inboundSchema: z.ZodType<
1046
- RetrievalSettingsRerankConfig,
1047
- z.ZodTypeDef,
1048
- unknown
1049
- > = z.object({
1050
- enabled: z.boolean().optional(),
1051
- provider: CreateKnowledgeRetrievalSettingsProvider$inboundSchema.optional(),
1052
- model: z.string().optional(),
1053
- model_db_id: z.string().optional(),
1054
- model_type: CreateKnowledgeRetrievalSettingsModelType$inboundSchema
1055
- .optional(),
1056
- model_parameters: z.lazy(() =>
1057
- CreateKnowledgeRetrievalSettingsModelParameters$inboundSchema
1058
- ).optional(),
1059
- }).transform((v) => {
1060
- return remap$(v, {
1061
- "model_db_id": "modelDbId",
1062
- "model_type": "modelType",
1063
- "model_parameters": "modelParameters",
1064
- });
1065
- });
1066
-
1067
- /** @internal */
1068
- export type RetrievalSettingsRerankConfig$Outbound = {
1069
- enabled?: boolean | undefined;
1070
- provider?: string | undefined;
1071
- model?: string | undefined;
1072
- model_db_id?: string | undefined;
1073
- model_type?: string | undefined;
1074
- model_parameters?:
1075
- | CreateKnowledgeRetrievalSettingsModelParameters$Outbound
1076
- | undefined;
1077
- };
1078
-
1079
- /** @internal */
1080
- export const RetrievalSettingsRerankConfig$outboundSchema: z.ZodType<
1081
- RetrievalSettingsRerankConfig$Outbound,
1082
- z.ZodTypeDef,
1083
- RetrievalSettingsRerankConfig
1084
- > = z.object({
1085
- enabled: z.boolean().optional(),
1086
- provider: CreateKnowledgeRetrievalSettingsProvider$outboundSchema.optional(),
1087
- model: z.string().optional(),
1088
- modelDbId: z.string().optional(),
1089
- modelType: CreateKnowledgeRetrievalSettingsModelType$outboundSchema
1090
- .optional(),
1091
- modelParameters: z.lazy(() =>
1092
- CreateKnowledgeRetrievalSettingsModelParameters$outboundSchema
1093
- ).optional(),
1094
- }).transform((v) => {
1095
- return remap$(v, {
1096
- modelDbId: "model_db_id",
1097
- modelType: "model_type",
1098
- modelParameters: "model_parameters",
1099
- });
1100
- });
1101
-
1102
- /**
1103
- * @internal
1104
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
1105
- */
1106
- export namespace RetrievalSettingsRerankConfig$ {
1107
- /** @deprecated use `RetrievalSettingsRerankConfig$inboundSchema` instead. */
1108
- export const inboundSchema = RetrievalSettingsRerankConfig$inboundSchema;
1109
- /** @deprecated use `RetrievalSettingsRerankConfig$outboundSchema` instead. */
1110
- export const outboundSchema = RetrievalSettingsRerankConfig$outboundSchema;
1111
- /** @deprecated use `RetrievalSettingsRerankConfig$Outbound` instead. */
1112
- export type Outbound = RetrievalSettingsRerankConfig$Outbound;
1113
- }
1114
-
1115
- export function retrievalSettingsRerankConfigToJSON(
1116
- retrievalSettingsRerankConfig: RetrievalSettingsRerankConfig,
1117
- ): string {
1118
- return JSON.stringify(
1119
- RetrievalSettingsRerankConfig$outboundSchema.parse(
1120
- retrievalSettingsRerankConfig,
1121
- ),
1122
- );
1123
- }
1124
-
1125
- export function retrievalSettingsRerankConfigFromJSON(
1126
- jsonString: string,
1127
- ): SafeParseResult<RetrievalSettingsRerankConfig, SDKValidationError> {
1128
- return safeParse(
1129
- jsonString,
1130
- (x) => RetrievalSettingsRerankConfig$inboundSchema.parse(JSON.parse(x)),
1131
- `Failed to parse 'RetrievalSettingsRerankConfig' from JSON`,
1132
- );
1133
- }
1134
-
1135
- /** @internal */
1136
- export const RetrievalSettings2$inboundSchema: z.ZodType<
1137
- RetrievalSettings2,
1138
- z.ZodTypeDef,
1139
- unknown
1140
- > = z.object({
1141
- type: CreateKnowledgeRetrievalSettingsType$inboundSchema,
1142
- top_k: z.number().int().default(5),
1143
- threshold: z.number().default(0),
1144
- rerank_config: z.nullable(
1145
- z.lazy(() => RetrievalSettingsRerankConfig$inboundSchema),
1146
- ).optional(),
1147
- }).transform((v) => {
1148
- return remap$(v, {
1149
- "top_k": "topK",
1150
- "rerank_config": "rerankConfig",
1151
- });
1152
- });
1153
-
1154
- /** @internal */
1155
- export type RetrievalSettings2$Outbound = {
1156
- type: string;
1157
- top_k: number;
1158
- threshold: number;
1159
- rerank_config?: RetrievalSettingsRerankConfig$Outbound | null | undefined;
1160
- };
1161
-
1162
- /** @internal */
1163
- export const RetrievalSettings2$outboundSchema: z.ZodType<
1164
- RetrievalSettings2$Outbound,
1165
- z.ZodTypeDef,
1166
- RetrievalSettings2
1167
- > = z.object({
1168
- type: CreateKnowledgeRetrievalSettingsType$outboundSchema,
1169
- topK: z.number().int().default(5),
1170
- threshold: z.number().default(0),
1171
- rerankConfig: z.nullable(
1172
- z.lazy(() => RetrievalSettingsRerankConfig$outboundSchema),
1173
- ).optional(),
1174
- }).transform((v) => {
1175
- return remap$(v, {
1176
- topK: "top_k",
1177
- rerankConfig: "rerank_config",
1178
- });
1179
- });
1180
-
1181
- /**
1182
- * @internal
1183
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
1184
- */
1185
- export namespace RetrievalSettings2$ {
1186
- /** @deprecated use `RetrievalSettings2$inboundSchema` instead. */
1187
- export const inboundSchema = RetrievalSettings2$inboundSchema;
1188
- /** @deprecated use `RetrievalSettings2$outboundSchema` instead. */
1189
- export const outboundSchema = RetrievalSettings2$outboundSchema;
1190
- /** @deprecated use `RetrievalSettings2$Outbound` instead. */
1191
- export type Outbound = RetrievalSettings2$Outbound;
1192
- }
1193
-
1194
- export function retrievalSettings2ToJSON(
1195
- retrievalSettings2: RetrievalSettings2,
1196
- ): string {
1197
- return JSON.stringify(
1198
- RetrievalSettings2$outboundSchema.parse(retrievalSettings2),
1199
- );
1200
- }
1201
-
1202
- export function retrievalSettings2FromJSON(
1203
- jsonString: string,
1204
- ): SafeParseResult<RetrievalSettings2, SDKValidationError> {
1205
- return safeParse(
1206
- jsonString,
1207
- (x) => RetrievalSettings2$inboundSchema.parse(JSON.parse(x)),
1208
- `Failed to parse 'RetrievalSettings2' from JSON`,
1209
- );
1210
- }
1211
-
1212
- /** @internal */
1213
- export const RetrievalSettingsType$inboundSchema: z.ZodNativeEnum<
1214
- typeof RetrievalSettingsType
1215
- > = z.nativeEnum(RetrievalSettingsType);
1216
-
1217
- /** @internal */
1218
- export const RetrievalSettingsType$outboundSchema: z.ZodNativeEnum<
1219
- typeof RetrievalSettingsType
1220
- > = RetrievalSettingsType$inboundSchema;
1221
-
1222
- /**
1223
- * @internal
1224
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
1225
- */
1226
- export namespace RetrievalSettingsType$ {
1227
- /** @deprecated use `RetrievalSettingsType$inboundSchema` instead. */
1228
- export const inboundSchema = RetrievalSettingsType$inboundSchema;
1229
- /** @deprecated use `RetrievalSettingsType$outboundSchema` instead. */
1230
- export const outboundSchema = RetrievalSettingsType$outboundSchema;
1231
- }
1232
-
1233
- /** @internal */
1234
- export const RetrievalSettingsProvider$inboundSchema: z.ZodNativeEnum<
1235
- typeof RetrievalSettingsProvider
1236
- > = z.nativeEnum(RetrievalSettingsProvider);
1237
-
1238
- /** @internal */
1239
- export const RetrievalSettingsProvider$outboundSchema: z.ZodNativeEnum<
1240
- typeof RetrievalSettingsProvider
1241
- > = RetrievalSettingsProvider$inboundSchema;
1242
-
1243
- /**
1244
- * @internal
1245
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
1246
- */
1247
- export namespace RetrievalSettingsProvider$ {
1248
- /** @deprecated use `RetrievalSettingsProvider$inboundSchema` instead. */
1249
- export const inboundSchema = RetrievalSettingsProvider$inboundSchema;
1250
- /** @deprecated use `RetrievalSettingsProvider$outboundSchema` instead. */
1251
- export const outboundSchema = RetrievalSettingsProvider$outboundSchema;
1252
- }
1253
-
1254
- /** @internal */
1255
- export const RetrievalSettingsModelType$inboundSchema: z.ZodNativeEnum<
1256
- typeof RetrievalSettingsModelType
1257
- > = z.nativeEnum(RetrievalSettingsModelType);
1258
-
1259
- /** @internal */
1260
- export const RetrievalSettingsModelType$outboundSchema: z.ZodNativeEnum<
1261
- typeof RetrievalSettingsModelType
1262
- > = RetrievalSettingsModelType$inboundSchema;
1263
-
1264
- /**
1265
- * @internal
1266
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
1267
- */
1268
- export namespace RetrievalSettingsModelType$ {
1269
- /** @deprecated use `RetrievalSettingsModelType$inboundSchema` instead. */
1270
- export const inboundSchema = RetrievalSettingsModelType$inboundSchema;
1271
- /** @deprecated use `RetrievalSettingsModelType$outboundSchema` instead. */
1272
- export const outboundSchema = RetrievalSettingsModelType$outboundSchema;
1273
- }
1274
-
1275
- /** @internal */
1276
- export const RetrievalSettingsModelParameters$inboundSchema: z.ZodType<
1277
- RetrievalSettingsModelParameters,
1278
- z.ZodTypeDef,
1279
- unknown
1280
- > = z.object({
1281
- threshold: z.number().optional(),
1282
- });
1283
-
1284
- /** @internal */
1285
- export type RetrievalSettingsModelParameters$Outbound = {
1286
- threshold?: number | undefined;
1287
- };
1288
-
1289
- /** @internal */
1290
- export const RetrievalSettingsModelParameters$outboundSchema: z.ZodType<
1291
- RetrievalSettingsModelParameters$Outbound,
1292
- z.ZodTypeDef,
1293
- RetrievalSettingsModelParameters
1294
- > = z.object({
1295
- threshold: z.number().optional(),
1296
- });
1297
-
1298
- /**
1299
- * @internal
1300
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
1301
- */
1302
- export namespace RetrievalSettingsModelParameters$ {
1303
- /** @deprecated use `RetrievalSettingsModelParameters$inboundSchema` instead. */
1304
- export const inboundSchema = RetrievalSettingsModelParameters$inboundSchema;
1305
- /** @deprecated use `RetrievalSettingsModelParameters$outboundSchema` instead. */
1306
- export const outboundSchema = RetrievalSettingsModelParameters$outboundSchema;
1307
- /** @deprecated use `RetrievalSettingsModelParameters$Outbound` instead. */
1308
- export type Outbound = RetrievalSettingsModelParameters$Outbound;
1309
- }
1310
-
1311
- export function retrievalSettingsModelParametersToJSON(
1312
- retrievalSettingsModelParameters: RetrievalSettingsModelParameters,
1313
- ): string {
1314
- return JSON.stringify(
1315
- RetrievalSettingsModelParameters$outboundSchema.parse(
1316
- retrievalSettingsModelParameters,
1317
- ),
1318
- );
1319
- }
1320
-
1321
- export function retrievalSettingsModelParametersFromJSON(
1322
- jsonString: string,
1323
- ): SafeParseResult<RetrievalSettingsModelParameters, SDKValidationError> {
1324
- return safeParse(
1325
- jsonString,
1326
- (x) => RetrievalSettingsModelParameters$inboundSchema.parse(JSON.parse(x)),
1327
- `Failed to parse 'RetrievalSettingsModelParameters' from JSON`,
1328
- );
1329
- }
1330
-
1331
- /** @internal */
1332
- export const RerankConfig$inboundSchema: z.ZodType<
1333
- RerankConfig,
1334
- z.ZodTypeDef,
1335
- unknown
1336
- > = z.object({
1337
- enabled: z.boolean().optional(),
1338
- provider: RetrievalSettingsProvider$inboundSchema.optional(),
1339
- model: z.string().optional(),
1340
- model_db_id: z.string().optional(),
1341
- model_type: RetrievalSettingsModelType$inboundSchema.optional(),
1342
- model_parameters: z.lazy(() => RetrievalSettingsModelParameters$inboundSchema)
1343
- .optional(),
1344
- }).transform((v) => {
1345
- return remap$(v, {
1346
- "model_db_id": "modelDbId",
1347
- "model_type": "modelType",
1348
- "model_parameters": "modelParameters",
1349
- });
1350
- });
1351
-
1352
- /** @internal */
1353
- export type RerankConfig$Outbound = {
1354
- enabled?: boolean | undefined;
1355
- provider?: string | undefined;
1356
- model?: string | undefined;
1357
- model_db_id?: string | undefined;
1358
- model_type?: string | undefined;
1359
- model_parameters?: RetrievalSettingsModelParameters$Outbound | undefined;
1360
- };
1361
-
1362
- /** @internal */
1363
- export const RerankConfig$outboundSchema: z.ZodType<
1364
- RerankConfig$Outbound,
1365
- z.ZodTypeDef,
1366
- RerankConfig
1367
- > = z.object({
1368
- enabled: z.boolean().optional(),
1369
- provider: RetrievalSettingsProvider$outboundSchema.optional(),
1370
- model: z.string().optional(),
1371
- modelDbId: z.string().optional(),
1372
- modelType: RetrievalSettingsModelType$outboundSchema.optional(),
1373
- modelParameters: z.lazy(() => RetrievalSettingsModelParameters$outboundSchema)
1374
- .optional(),
1375
- }).transform((v) => {
1376
- return remap$(v, {
1377
- modelDbId: "model_db_id",
1378
- modelType: "model_type",
1379
- modelParameters: "model_parameters",
1380
- });
1381
- });
1382
-
1383
- /**
1384
- * @internal
1385
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
1386
- */
1387
- export namespace RerankConfig$ {
1388
- /** @deprecated use `RerankConfig$inboundSchema` instead. */
1389
- export const inboundSchema = RerankConfig$inboundSchema;
1390
- /** @deprecated use `RerankConfig$outboundSchema` instead. */
1391
- export const outboundSchema = RerankConfig$outboundSchema;
1392
- /** @deprecated use `RerankConfig$Outbound` instead. */
1393
- export type Outbound = RerankConfig$Outbound;
1394
- }
1395
-
1396
- export function rerankConfigToJSON(rerankConfig: RerankConfig): string {
1397
- return JSON.stringify(RerankConfig$outboundSchema.parse(rerankConfig));
1398
- }
1399
-
1400
- export function rerankConfigFromJSON(
1401
- jsonString: string,
1402
- ): SafeParseResult<RerankConfig, SDKValidationError> {
1403
- return safeParse(
1404
- jsonString,
1405
- (x) => RerankConfig$inboundSchema.parse(JSON.parse(x)),
1406
- `Failed to parse 'RerankConfig' from JSON`,
1407
- );
1408
- }
1409
-
1410
- /** @internal */
1411
- export const RetrievalSettings1$inboundSchema: z.ZodType<
1412
- RetrievalSettings1,
1413
- z.ZodTypeDef,
1414
- unknown
1415
- > = z.object({
1416
- type: RetrievalSettingsType$inboundSchema,
1417
- top_k: z.number().int().default(5),
1418
- threshold: z.number().default(0),
1419
- rerank_config: z.nullable(z.lazy(() => RerankConfig$inboundSchema))
1420
- .optional(),
1421
- }).transform((v) => {
1422
- return remap$(v, {
1423
- "top_k": "topK",
1424
- "rerank_config": "rerankConfig",
1425
- });
1426
- });
1427
-
1428
- /** @internal */
1429
- export type RetrievalSettings1$Outbound = {
1430
- type: string;
1431
- top_k: number;
1432
- threshold: number;
1433
- rerank_config?: RerankConfig$Outbound | null | undefined;
1434
- };
1435
-
1436
- /** @internal */
1437
- export const RetrievalSettings1$outboundSchema: z.ZodType<
1438
- RetrievalSettings1$Outbound,
1439
- z.ZodTypeDef,
1440
- RetrievalSettings1
1441
- > = z.object({
1442
- type: RetrievalSettingsType$outboundSchema,
1443
- topK: z.number().int().default(5),
1444
- threshold: z.number().default(0),
1445
- rerankConfig: z.nullable(z.lazy(() => RerankConfig$outboundSchema))
1446
- .optional(),
1447
- }).transform((v) => {
1448
- return remap$(v, {
1449
- topK: "top_k",
1450
- rerankConfig: "rerank_config",
1451
- });
1452
- });
1453
-
1454
- /**
1455
- * @internal
1456
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
1457
- */
1458
- export namespace RetrievalSettings1$ {
1459
- /** @deprecated use `RetrievalSettings1$inboundSchema` instead. */
1460
- export const inboundSchema = RetrievalSettings1$inboundSchema;
1461
- /** @deprecated use `RetrievalSettings1$outboundSchema` instead. */
1462
- export const outboundSchema = RetrievalSettings1$outboundSchema;
1463
- /** @deprecated use `RetrievalSettings1$Outbound` instead. */
1464
- export type Outbound = RetrievalSettings1$Outbound;
1465
- }
1466
-
1467
- export function retrievalSettings1ToJSON(
1468
- retrievalSettings1: RetrievalSettings1,
1469
- ): string {
1470
- return JSON.stringify(
1471
- RetrievalSettings1$outboundSchema.parse(retrievalSettings1),
1472
- );
1473
- }
1474
-
1475
- export function retrievalSettings1FromJSON(
1476
- jsonString: string,
1477
- ): SafeParseResult<RetrievalSettings1, SDKValidationError> {
1478
- return safeParse(
1479
- jsonString,
1480
- (x) => RetrievalSettings1$inboundSchema.parse(JSON.parse(x)),
1481
- `Failed to parse 'RetrievalSettings1' from JSON`,
1482
- );
1483
- }
1484
-
1485
- /** @internal */
1486
- export const RetrievalSettings$inboundSchema: z.ZodType<
1487
- RetrievalSettings,
1488
- z.ZodTypeDef,
1489
- unknown
1490
- > = z.union([
1491
- z.lazy(() => RetrievalSettings1$inboundSchema),
1492
- z.lazy(() => RetrievalSettings2$inboundSchema),
1493
- z.lazy(() => RetrievalSettings3$inboundSchema),
1494
- ]);
1495
-
1496
- /** @internal */
1497
- export type RetrievalSettings$Outbound =
1498
- | RetrievalSettings1$Outbound
1499
- | RetrievalSettings2$Outbound
1500
- | RetrievalSettings3$Outbound;
1501
-
1502
- /** @internal */
1503
- export const RetrievalSettings$outboundSchema: z.ZodType<
1504
- RetrievalSettings$Outbound,
1505
- z.ZodTypeDef,
1506
- RetrievalSettings
1507
- > = z.union([
1508
- z.lazy(() => RetrievalSettings1$outboundSchema),
1509
- z.lazy(() => RetrievalSettings2$outboundSchema),
1510
- z.lazy(() => RetrievalSettings3$outboundSchema),
1511
- ]);
1512
-
1513
- /**
1514
- * @internal
1515
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
1516
- */
1517
- export namespace RetrievalSettings$ {
1518
- /** @deprecated use `RetrievalSettings$inboundSchema` instead. */
1519
- export const inboundSchema = RetrievalSettings$inboundSchema;
1520
- /** @deprecated use `RetrievalSettings$outboundSchema` instead. */
1521
- export const outboundSchema = RetrievalSettings$outboundSchema;
1522
- /** @deprecated use `RetrievalSettings$Outbound` instead. */
1523
- export type Outbound = RetrievalSettings$Outbound;
1524
- }
1525
-
1526
- export function retrievalSettingsToJSON(
1527
- retrievalSettings: RetrievalSettings,
1528
- ): string {
1529
- return JSON.stringify(
1530
- RetrievalSettings$outboundSchema.parse(retrievalSettings),
1531
- );
1532
- }
1533
-
1534
- export function retrievalSettingsFromJSON(
1535
- jsonString: string,
1536
- ): SafeParseResult<RetrievalSettings, SDKValidationError> {
1537
- return safeParse(
1538
- jsonString,
1539
- (x) => RetrievalSettings$inboundSchema.parse(JSON.parse(x)),
1540
- `Failed to parse 'RetrievalSettings' from JSON`,
1541
- );
1542
- }
1543
-
1544
- /** @internal */
1545
- export const CreateKnowledgeRequestBody$inboundSchema: z.ZodType<
1546
- CreateKnowledgeRequestBody,
1547
- z.ZodTypeDef,
1548
- unknown
1549
- > = z.object({
1550
- key: z.string(),
1551
- description: z.string().optional(),
1552
- model: z.string(),
1553
- retrieval_settings: z.union([
1554
- z.lazy(() => RetrievalSettings1$inboundSchema),
1555
- z.lazy(() => RetrievalSettings2$inboundSchema),
1556
- z.lazy(() => RetrievalSettings3$inboundSchema),
1557
- ]).optional(),
1558
- path: z.string(),
1559
- }).transform((v) => {
1560
- return remap$(v, {
1561
- "retrieval_settings": "retrievalSettings",
1562
- });
1563
- });
1564
-
1565
- /** @internal */
1566
- export type CreateKnowledgeRequestBody$Outbound = {
1567
- key: string;
1568
- description?: string | undefined;
1569
- model: string;
1570
- retrieval_settings?:
1571
- | RetrievalSettings1$Outbound
1572
- | RetrievalSettings2$Outbound
1573
- | RetrievalSettings3$Outbound
1574
- | undefined;
1575
- path: string;
1576
- };
1577
-
1578
- /** @internal */
1579
- export const CreateKnowledgeRequestBody$outboundSchema: z.ZodType<
1580
- CreateKnowledgeRequestBody$Outbound,
1581
- z.ZodTypeDef,
1582
- CreateKnowledgeRequestBody
1583
- > = z.object({
1584
- key: z.string(),
1585
- description: z.string().optional(),
1586
- model: z.string(),
1587
- retrievalSettings: z.union([
1588
- z.lazy(() => RetrievalSettings1$outboundSchema),
1589
- z.lazy(() => RetrievalSettings2$outboundSchema),
1590
- z.lazy(() => RetrievalSettings3$outboundSchema),
1591
- ]).optional(),
1592
- path: z.string(),
1593
- }).transform((v) => {
1594
- return remap$(v, {
1595
- retrievalSettings: "retrieval_settings",
1596
- });
1597
- });
1598
-
1599
- /**
1600
- * @internal
1601
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
1602
- */
1603
- export namespace CreateKnowledgeRequestBody$ {
1604
- /** @deprecated use `CreateKnowledgeRequestBody$inboundSchema` instead. */
1605
- export const inboundSchema = CreateKnowledgeRequestBody$inboundSchema;
1606
- /** @deprecated use `CreateKnowledgeRequestBody$outboundSchema` instead. */
1607
- export const outboundSchema = CreateKnowledgeRequestBody$outboundSchema;
1608
- /** @deprecated use `CreateKnowledgeRequestBody$Outbound` instead. */
1609
- export type Outbound = CreateKnowledgeRequestBody$Outbound;
1610
- }
1611
-
1612
- export function createKnowledgeRequestBodyToJSON(
1613
- createKnowledgeRequestBody: CreateKnowledgeRequestBody,
1614
- ): string {
1615
- return JSON.stringify(
1616
- CreateKnowledgeRequestBody$outboundSchema.parse(createKnowledgeRequestBody),
1617
- );
1618
- }
1619
-
1620
- export function createKnowledgeRequestBodyFromJSON(
1621
- jsonString: string,
1622
- ): SafeParseResult<CreateKnowledgeRequestBody, SDKValidationError> {
1623
- return safeParse(
1624
- jsonString,
1625
- (x) => CreateKnowledgeRequestBody$inboundSchema.parse(JSON.parse(x)),
1626
- `Failed to parse 'CreateKnowledgeRequestBody' from JSON`,
1627
- );
1628
- }
1629
-
1630
- /** @internal */
1631
- export const CreateKnowledgeMetadata$inboundSchema: z.ZodType<
1632
- CreateKnowledgeMetadata,
1633
- z.ZodTypeDef,
1634
- unknown
1635
- > = z.object({
1636
- word_count: z.number().int().default(0),
1637
- document_count: z.number().int().default(0),
1638
- sentences_count: z.number().int().default(0),
1639
- }).transform((v) => {
1640
- return remap$(v, {
1641
- "word_count": "wordCount",
1642
- "document_count": "documentCount",
1643
- "sentences_count": "sentencesCount",
1644
- });
1645
- });
1646
-
1647
- /** @internal */
1648
- export type CreateKnowledgeMetadata$Outbound = {
1649
- word_count: number;
1650
- document_count: number;
1651
- sentences_count: number;
1652
- };
1653
-
1654
- /** @internal */
1655
- export const CreateKnowledgeMetadata$outboundSchema: z.ZodType<
1656
- CreateKnowledgeMetadata$Outbound,
1657
- z.ZodTypeDef,
1658
- CreateKnowledgeMetadata
1659
- > = z.object({
1660
- wordCount: z.number().int().default(0),
1661
- documentCount: z.number().int().default(0),
1662
- sentencesCount: z.number().int().default(0),
1663
- }).transform((v) => {
1664
- return remap$(v, {
1665
- wordCount: "word_count",
1666
- documentCount: "document_count",
1667
- sentencesCount: "sentences_count",
1668
- });
1669
- });
1670
-
1671
- /**
1672
- * @internal
1673
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
1674
- */
1675
- export namespace CreateKnowledgeMetadata$ {
1676
- /** @deprecated use `CreateKnowledgeMetadata$inboundSchema` instead. */
1677
- export const inboundSchema = CreateKnowledgeMetadata$inboundSchema;
1678
- /** @deprecated use `CreateKnowledgeMetadata$outboundSchema` instead. */
1679
- export const outboundSchema = CreateKnowledgeMetadata$outboundSchema;
1680
- /** @deprecated use `CreateKnowledgeMetadata$Outbound` instead. */
1681
- export type Outbound = CreateKnowledgeMetadata$Outbound;
1682
- }
1683
-
1684
- export function createKnowledgeMetadataToJSON(
1685
- createKnowledgeMetadata: CreateKnowledgeMetadata,
1686
- ): string {
1687
- return JSON.stringify(
1688
- CreateKnowledgeMetadata$outboundSchema.parse(createKnowledgeMetadata),
1689
- );
1690
- }
1691
-
1692
- export function createKnowledgeMetadataFromJSON(
1693
- jsonString: string,
1694
- ): SafeParseResult<CreateKnowledgeMetadata, SDKValidationError> {
1695
- return safeParse(
1696
- jsonString,
1697
- (x) => CreateKnowledgeMetadata$inboundSchema.parse(JSON.parse(x)),
1698
- `Failed to parse 'CreateKnowledgeMetadata' from JSON`,
1699
- );
1700
- }
1701
-
1702
- /** @internal */
1703
- export const CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONType$inboundSchema:
1704
- z.ZodNativeEnum<
1705
- typeof CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONType
1706
- > = z.nativeEnum(
1707
- CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONType,
1708
- );
1709
-
1710
- /** @internal */
1711
- export const CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONType$outboundSchema:
1712
- z.ZodNativeEnum<
1713
- typeof CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONType
1714
- > =
1715
- CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONType$inboundSchema;
1716
-
1717
- /**
1718
- * @internal
1719
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
1720
- */
1721
- export namespace CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONType$ {
1722
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONType$inboundSchema` instead. */
1723
- export const inboundSchema =
1724
- CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONType$inboundSchema;
1725
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONType$outboundSchema` instead. */
1726
- export const outboundSchema =
1727
- CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONType$outboundSchema;
1728
- }
1729
-
1730
- /** @internal */
1731
- export const CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONProvider$inboundSchema:
1732
- z.ZodNativeEnum<
1733
- typeof CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONProvider
1734
- > = z.nativeEnum(
1735
- CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONProvider,
1736
- );
1737
-
1738
- /** @internal */
1739
- export const CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONProvider$outboundSchema:
1740
- z.ZodNativeEnum<
1741
- typeof CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONProvider
1742
- > =
1743
- CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONProvider$inboundSchema;
1744
-
1745
- /**
1746
- * @internal
1747
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
1748
- */
1749
- export namespace CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONProvider$ {
1750
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONProvider$inboundSchema` instead. */
1751
- export const inboundSchema =
1752
- CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONProvider$inboundSchema;
1753
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONProvider$outboundSchema` instead. */
1754
- export const outboundSchema =
1755
- CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONProvider$outboundSchema;
1756
- }
1757
-
1758
- /** @internal */
1759
- export const CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONModelType$inboundSchema:
1760
- z.ZodNativeEnum<
1761
- typeof CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONModelType
1762
- > = z.nativeEnum(
1763
- CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONModelType,
1764
- );
1765
-
1766
- /** @internal */
1767
- export const CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONModelType$outboundSchema:
1768
- z.ZodNativeEnum<
1769
- typeof CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONModelType
1770
- > =
1771
- CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONModelType$inboundSchema;
1772
-
1773
- /**
1774
- * @internal
1775
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
1776
- */
1777
- export namespace CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONModelType$ {
1778
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONModelType$inboundSchema` instead. */
1779
- export const inboundSchema =
1780
- CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONModelType$inboundSchema;
1781
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONModelType$outboundSchema` instead. */
1782
- export const outboundSchema =
1783
- CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONModelType$outboundSchema;
1784
- }
1785
-
1786
- /** @internal */
1787
- export const CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONModelParameters$inboundSchema:
1788
- z.ZodType<
1789
- CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONModelParameters,
1790
- z.ZodTypeDef,
1791
- unknown
1792
- > = z.object({
1793
- threshold: z.number().optional(),
1794
- });
1795
-
1796
- /** @internal */
1797
- export type CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONModelParameters$Outbound =
1798
- {
1799
- threshold?: number | undefined;
1800
- };
1801
-
1802
- /** @internal */
1803
- export const CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONModelParameters$outboundSchema:
1804
- z.ZodType<
1805
- CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONModelParameters$Outbound,
1806
- z.ZodTypeDef,
1807
- CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONModelParameters
1808
- > = z.object({
1809
- threshold: z.number().optional(),
1810
- });
1811
-
1812
- /**
1813
- * @internal
1814
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
1815
- */
1816
- export namespace CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONModelParameters$ {
1817
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONModelParameters$inboundSchema` instead. */
1818
- export const inboundSchema =
1819
- CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONModelParameters$inboundSchema;
1820
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONModelParameters$outboundSchema` instead. */
1821
- export const outboundSchema =
1822
- CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONModelParameters$outboundSchema;
1823
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONModelParameters$Outbound` instead. */
1824
- export type Outbound =
1825
- CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONModelParameters$Outbound;
1826
- }
1827
-
1828
- export function createKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONModelParametersToJSON(
1829
- createKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONModelParameters:
1830
- CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONModelParameters,
1831
- ): string {
1832
- return JSON.stringify(
1833
- CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONModelParameters$outboundSchema
1834
- .parse(
1835
- createKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONModelParameters,
1836
- ),
1837
- );
1838
- }
1839
-
1840
- export function createKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONModelParametersFromJSON(
1841
- jsonString: string,
1842
- ): SafeParseResult<
1843
- CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONModelParameters,
1844
- SDKValidationError
1845
- > {
1846
- return safeParse(
1847
- jsonString,
1848
- (x) =>
1849
- CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONModelParameters$inboundSchema
1850
- .parse(JSON.parse(x)),
1851
- `Failed to parse 'CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONModelParameters' from JSON`,
1852
- );
1853
- }
1854
-
1855
- /** @internal */
1856
- export const CreateKnowledgeRetrievalSettingsKnowledgeResponse200RerankConfig$inboundSchema:
1857
- z.ZodType<
1858
- CreateKnowledgeRetrievalSettingsKnowledgeResponse200RerankConfig,
1859
- z.ZodTypeDef,
1860
- unknown
1861
- > = z.object({
1862
- enabled: z.boolean().optional(),
1863
- provider:
1864
- CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONProvider$inboundSchema
1865
- .optional(),
1866
- model: z.string().optional(),
1867
- model_db_id: z.string().optional(),
1868
- model_type:
1869
- CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONModelType$inboundSchema
1870
- .optional(),
1871
- model_parameters: z.lazy(() =>
1872
- CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONModelParameters$inboundSchema
1873
- ).optional(),
1874
- integration_id: z.nullable(z.string()).optional(),
1875
- }).transform((v) => {
1876
- return remap$(v, {
1877
- "model_db_id": "modelDbId",
1878
- "model_type": "modelType",
1879
- "model_parameters": "modelParameters",
1880
- "integration_id": "integrationId",
1881
- });
1882
- });
1883
-
1884
- /** @internal */
1885
- export type CreateKnowledgeRetrievalSettingsKnowledgeResponse200RerankConfig$Outbound =
1886
- {
1887
- enabled?: boolean | undefined;
1888
- provider?: string | undefined;
1889
- model?: string | undefined;
1890
- model_db_id?: string | undefined;
1891
- model_type?: string | undefined;
1892
- model_parameters?:
1893
- | CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONModelParameters$Outbound
1894
- | undefined;
1895
- integration_id?: string | null | undefined;
1896
- };
1897
-
1898
- /** @internal */
1899
- export const CreateKnowledgeRetrievalSettingsKnowledgeResponse200RerankConfig$outboundSchema:
1900
- z.ZodType<
1901
- CreateKnowledgeRetrievalSettingsKnowledgeResponse200RerankConfig$Outbound,
1902
- z.ZodTypeDef,
1903
- CreateKnowledgeRetrievalSettingsKnowledgeResponse200RerankConfig
1904
- > = z.object({
1905
- enabled: z.boolean().optional(),
1906
- provider:
1907
- CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONProvider$outboundSchema
1908
- .optional(),
1909
- model: z.string().optional(),
1910
- modelDbId: z.string().optional(),
1911
- modelType:
1912
- CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONModelType$outboundSchema
1913
- .optional(),
1914
- modelParameters: z.lazy(() =>
1915
- CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONModelParameters$outboundSchema
1916
- ).optional(),
1917
- integrationId: z.nullable(z.string()).optional(),
1918
- }).transform((v) => {
1919
- return remap$(v, {
1920
- modelDbId: "model_db_id",
1921
- modelType: "model_type",
1922
- modelParameters: "model_parameters",
1923
- integrationId: "integration_id",
1924
- });
1925
- });
1926
-
1927
- /**
1928
- * @internal
1929
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
1930
- */
1931
- export namespace CreateKnowledgeRetrievalSettingsKnowledgeResponse200RerankConfig$ {
1932
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeResponse200RerankConfig$inboundSchema` instead. */
1933
- export const inboundSchema =
1934
- CreateKnowledgeRetrievalSettingsKnowledgeResponse200RerankConfig$inboundSchema;
1935
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeResponse200RerankConfig$outboundSchema` instead. */
1936
- export const outboundSchema =
1937
- CreateKnowledgeRetrievalSettingsKnowledgeResponse200RerankConfig$outboundSchema;
1938
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeResponse200RerankConfig$Outbound` instead. */
1939
- export type Outbound =
1940
- CreateKnowledgeRetrievalSettingsKnowledgeResponse200RerankConfig$Outbound;
1941
- }
1942
-
1943
- export function createKnowledgeRetrievalSettingsKnowledgeResponse200RerankConfigToJSON(
1944
- createKnowledgeRetrievalSettingsKnowledgeResponse200RerankConfig:
1945
- CreateKnowledgeRetrievalSettingsKnowledgeResponse200RerankConfig,
1946
- ): string {
1947
- return JSON.stringify(
1948
- CreateKnowledgeRetrievalSettingsKnowledgeResponse200RerankConfig$outboundSchema
1949
- .parse(createKnowledgeRetrievalSettingsKnowledgeResponse200RerankConfig),
1950
- );
1951
- }
1952
-
1953
- export function createKnowledgeRetrievalSettingsKnowledgeResponse200RerankConfigFromJSON(
1954
- jsonString: string,
1955
- ): SafeParseResult<
1956
- CreateKnowledgeRetrievalSettingsKnowledgeResponse200RerankConfig,
1957
- SDKValidationError
1958
- > {
1959
- return safeParse(
1960
- jsonString,
1961
- (x) =>
1962
- CreateKnowledgeRetrievalSettingsKnowledgeResponse200RerankConfig$inboundSchema
1963
- .parse(JSON.parse(x)),
1964
- `Failed to parse 'CreateKnowledgeRetrievalSettingsKnowledgeResponse200RerankConfig' from JSON`,
1965
- );
1966
- }
1967
-
1968
- /** @internal */
1969
- export const CreateKnowledgeRetrievalSettings3$inboundSchema: z.ZodType<
1970
- CreateKnowledgeRetrievalSettings3,
1971
- z.ZodTypeDef,
1972
- unknown
1973
- > = z.object({
1974
- type:
1975
- CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONType$inboundSchema,
1976
- top_k: z.number().int().default(5),
1977
- threshold: z.number().default(0),
1978
- rerank_config: z.nullable(
1979
- z.lazy(() =>
1980
- CreateKnowledgeRetrievalSettingsKnowledgeResponse200RerankConfig$inboundSchema
1981
- ),
1982
- ).optional(),
1983
- }).transform((v) => {
1984
- return remap$(v, {
1985
- "top_k": "topK",
1986
- "rerank_config": "rerankConfig",
1987
- });
1988
- });
1989
-
1990
- /** @internal */
1991
- export type CreateKnowledgeRetrievalSettings3$Outbound = {
1992
- type: string;
1993
- top_k: number;
1994
- threshold: number;
1995
- rerank_config?:
1996
- | CreateKnowledgeRetrievalSettingsKnowledgeResponse200RerankConfig$Outbound
1997
- | null
1998
- | undefined;
1999
- };
2000
-
2001
- /** @internal */
2002
- export const CreateKnowledgeRetrievalSettings3$outboundSchema: z.ZodType<
2003
- CreateKnowledgeRetrievalSettings3$Outbound,
2004
- z.ZodTypeDef,
2005
- CreateKnowledgeRetrievalSettings3
2006
- > = z.object({
2007
- type:
2008
- CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONType$outboundSchema,
2009
- topK: z.number().int().default(5),
2010
- threshold: z.number().default(0),
2011
- rerankConfig: z.nullable(
2012
- z.lazy(() =>
2013
- CreateKnowledgeRetrievalSettingsKnowledgeResponse200RerankConfig$outboundSchema
2014
- ),
2015
- ).optional(),
2016
- }).transform((v) => {
2017
- return remap$(v, {
2018
- topK: "top_k",
2019
- rerankConfig: "rerank_config",
2020
- });
2021
- });
2022
-
2023
- /**
2024
- * @internal
2025
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
2026
- */
2027
- export namespace CreateKnowledgeRetrievalSettings3$ {
2028
- /** @deprecated use `CreateKnowledgeRetrievalSettings3$inboundSchema` instead. */
2029
- export const inboundSchema = CreateKnowledgeRetrievalSettings3$inboundSchema;
2030
- /** @deprecated use `CreateKnowledgeRetrievalSettings3$outboundSchema` instead. */
2031
- export const outboundSchema =
2032
- CreateKnowledgeRetrievalSettings3$outboundSchema;
2033
- /** @deprecated use `CreateKnowledgeRetrievalSettings3$Outbound` instead. */
2034
- export type Outbound = CreateKnowledgeRetrievalSettings3$Outbound;
2035
- }
2036
-
2037
- export function createKnowledgeRetrievalSettings3ToJSON(
2038
- createKnowledgeRetrievalSettings3: CreateKnowledgeRetrievalSettings3,
2039
- ): string {
2040
- return JSON.stringify(
2041
- CreateKnowledgeRetrievalSettings3$outboundSchema.parse(
2042
- createKnowledgeRetrievalSettings3,
2043
- ),
2044
- );
2045
- }
2046
-
2047
- export function createKnowledgeRetrievalSettings3FromJSON(
2048
- jsonString: string,
2049
- ): SafeParseResult<CreateKnowledgeRetrievalSettings3, SDKValidationError> {
2050
- return safeParse(
2051
- jsonString,
2052
- (x) => CreateKnowledgeRetrievalSettings3$inboundSchema.parse(JSON.parse(x)),
2053
- `Failed to parse 'CreateKnowledgeRetrievalSettings3' from JSON`,
2054
- );
2055
- }
2056
-
2057
- /** @internal */
2058
- export const CreateKnowledgeRetrievalSettingsKnowledgeResponse200Type$inboundSchema:
2059
- z.ZodNativeEnum<
2060
- typeof CreateKnowledgeRetrievalSettingsKnowledgeResponse200Type
2061
- > = z.nativeEnum(CreateKnowledgeRetrievalSettingsKnowledgeResponse200Type);
2062
-
2063
- /** @internal */
2064
- export const CreateKnowledgeRetrievalSettingsKnowledgeResponse200Type$outboundSchema:
2065
- z.ZodNativeEnum<
2066
- typeof CreateKnowledgeRetrievalSettingsKnowledgeResponse200Type
2067
- > = CreateKnowledgeRetrievalSettingsKnowledgeResponse200Type$inboundSchema;
2068
-
2069
- /**
2070
- * @internal
2071
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
2072
- */
2073
- export namespace CreateKnowledgeRetrievalSettingsKnowledgeResponse200Type$ {
2074
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeResponse200Type$inboundSchema` instead. */
2075
- export const inboundSchema =
2076
- CreateKnowledgeRetrievalSettingsKnowledgeResponse200Type$inboundSchema;
2077
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeResponse200Type$outboundSchema` instead. */
2078
- export const outboundSchema =
2079
- CreateKnowledgeRetrievalSettingsKnowledgeResponse200Type$outboundSchema;
2080
- }
2081
-
2082
- /** @internal */
2083
- export const CreateKnowledgeRetrievalSettingsKnowledgeResponse200Provider$inboundSchema:
2084
- z.ZodNativeEnum<
2085
- typeof CreateKnowledgeRetrievalSettingsKnowledgeResponse200Provider
2086
- > = z.nativeEnum(
2087
- CreateKnowledgeRetrievalSettingsKnowledgeResponse200Provider,
2088
- );
2089
-
2090
- /** @internal */
2091
- export const CreateKnowledgeRetrievalSettingsKnowledgeResponse200Provider$outboundSchema:
2092
- z.ZodNativeEnum<
2093
- typeof CreateKnowledgeRetrievalSettingsKnowledgeResponse200Provider
2094
- > =
2095
- CreateKnowledgeRetrievalSettingsKnowledgeResponse200Provider$inboundSchema;
2096
-
2097
- /**
2098
- * @internal
2099
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
2100
- */
2101
- export namespace CreateKnowledgeRetrievalSettingsKnowledgeResponse200Provider$ {
2102
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeResponse200Provider$inboundSchema` instead. */
2103
- export const inboundSchema =
2104
- CreateKnowledgeRetrievalSettingsKnowledgeResponse200Provider$inboundSchema;
2105
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeResponse200Provider$outboundSchema` instead. */
2106
- export const outboundSchema =
2107
- CreateKnowledgeRetrievalSettingsKnowledgeResponse200Provider$outboundSchema;
2108
- }
2109
-
2110
- /** @internal */
2111
- export const CreateKnowledgeRetrievalSettingsKnowledgeResponse200ModelType$inboundSchema:
2112
- z.ZodNativeEnum<
2113
- typeof CreateKnowledgeRetrievalSettingsKnowledgeResponse200ModelType
2114
- > = z.nativeEnum(
2115
- CreateKnowledgeRetrievalSettingsKnowledgeResponse200ModelType,
2116
- );
2117
-
2118
- /** @internal */
2119
- export const CreateKnowledgeRetrievalSettingsKnowledgeResponse200ModelType$outboundSchema:
2120
- z.ZodNativeEnum<
2121
- typeof CreateKnowledgeRetrievalSettingsKnowledgeResponse200ModelType
2122
- > =
2123
- CreateKnowledgeRetrievalSettingsKnowledgeResponse200ModelType$inboundSchema;
114
+ retrievalType?: CreateKnowledgeRetrievalType | undefined;
115
+ /**
116
+ * The number of results to return from the search.
117
+ */
118
+ topK?: number | undefined;
119
+ /**
120
+ * The threshold value used to filter the search results, only documents with a relevance score greater than the threshold will be returned
121
+ */
122
+ threshold?: number | undefined;
123
+ /**
124
+ * The rerank configuration for the knowledge base. In case the model is provided it will be used to enhance the search precision.
125
+ */
126
+ rerankConfig?: CreateKnowledgeRerankConfig | undefined;
127
+ };
2124
128
 
2125
129
  /**
2126
- * @internal
2127
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
130
+ * Knowledge Base object
2128
131
  */
2129
- export namespace CreateKnowledgeRetrievalSettingsKnowledgeResponse200ModelType$ {
2130
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeResponse200ModelType$inboundSchema` instead. */
2131
- export const inboundSchema =
2132
- CreateKnowledgeRetrievalSettingsKnowledgeResponse200ModelType$inboundSchema;
2133
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeResponse200ModelType$outboundSchema` instead. */
2134
- export const outboundSchema =
2135
- CreateKnowledgeRetrievalSettingsKnowledgeResponse200ModelType$outboundSchema;
2136
- }
2137
-
2138
- /** @internal */
2139
- export const CreateKnowledgeRetrievalSettingsKnowledgeResponse200ModelParameters$inboundSchema:
2140
- z.ZodType<
2141
- CreateKnowledgeRetrievalSettingsKnowledgeResponse200ModelParameters,
2142
- z.ZodTypeDef,
2143
- unknown
2144
- > = z.object({
2145
- threshold: z.number().optional(),
2146
- });
132
+ export type CreateKnowledgeResponseBody = {
133
+ /**
134
+ * The unique identifier of the knowledge base.
135
+ */
136
+ id: string;
137
+ /**
138
+ * The id of the resource
139
+ */
140
+ createdById: string;
141
+ /**
142
+ * The creation date of the knowledge base.
143
+ */
144
+ created: string;
145
+ /**
146
+ * The description of the knowledge base.
147
+ */
148
+ description?: string | undefined;
149
+ /**
150
+ * The unique key of the knowledge base.
151
+ */
152
+ key: string;
153
+ /**
154
+ * The embeddings model used for the knowledge base.
155
+ */
156
+ model: string;
157
+ /**
158
+ * 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.
159
+ */
160
+ path?: string | undefined;
161
+ /**
162
+ * The retrieval settings for the knowledge base. If not provider, Hybrid Search will be used as a default query strategy.
163
+ */
164
+ retrievalSettings?: CreateKnowledgeRetrievalSettings | undefined;
165
+ /**
166
+ * The id of the resource
167
+ */
168
+ updateById: string;
169
+ /**
170
+ * The last update date of the knowledge base.
171
+ */
172
+ updated: string;
173
+ };
2147
174
 
2148
175
  /** @internal */
2149
- export type CreateKnowledgeRetrievalSettingsKnowledgeResponse200ModelParameters$Outbound =
2150
- {
2151
- threshold?: number | undefined;
2152
- };
176
+ export const RetrievalType$inboundSchema: z.ZodNativeEnum<
177
+ typeof RetrievalType
178
+ > = z.nativeEnum(RetrievalType);
2153
179
 
2154
180
  /** @internal */
2155
- export const CreateKnowledgeRetrievalSettingsKnowledgeResponse200ModelParameters$outboundSchema:
2156
- z.ZodType<
2157
- CreateKnowledgeRetrievalSettingsKnowledgeResponse200ModelParameters$Outbound,
2158
- z.ZodTypeDef,
2159
- CreateKnowledgeRetrievalSettingsKnowledgeResponse200ModelParameters
2160
- > = z.object({
2161
- threshold: z.number().optional(),
2162
- });
181
+ export const RetrievalType$outboundSchema: z.ZodNativeEnum<
182
+ typeof RetrievalType
183
+ > = RetrievalType$inboundSchema;
2163
184
 
2164
185
  /**
2165
186
  * @internal
2166
187
  * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
2167
188
  */
2168
- export namespace CreateKnowledgeRetrievalSettingsKnowledgeResponse200ModelParameters$ {
2169
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeResponse200ModelParameters$inboundSchema` instead. */
2170
- export const inboundSchema =
2171
- CreateKnowledgeRetrievalSettingsKnowledgeResponse200ModelParameters$inboundSchema;
2172
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeResponse200ModelParameters$outboundSchema` instead. */
2173
- export const outboundSchema =
2174
- CreateKnowledgeRetrievalSettingsKnowledgeResponse200ModelParameters$outboundSchema;
2175
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeResponse200ModelParameters$Outbound` instead. */
2176
- export type Outbound =
2177
- CreateKnowledgeRetrievalSettingsKnowledgeResponse200ModelParameters$Outbound;
2178
- }
2179
-
2180
- export function createKnowledgeRetrievalSettingsKnowledgeResponse200ModelParametersToJSON(
2181
- createKnowledgeRetrievalSettingsKnowledgeResponse200ModelParameters:
2182
- CreateKnowledgeRetrievalSettingsKnowledgeResponse200ModelParameters,
2183
- ): string {
2184
- return JSON.stringify(
2185
- CreateKnowledgeRetrievalSettingsKnowledgeResponse200ModelParameters$outboundSchema
2186
- .parse(
2187
- createKnowledgeRetrievalSettingsKnowledgeResponse200ModelParameters,
2188
- ),
2189
- );
2190
- }
2191
-
2192
- export function createKnowledgeRetrievalSettingsKnowledgeResponse200ModelParametersFromJSON(
2193
- jsonString: string,
2194
- ): SafeParseResult<
2195
- CreateKnowledgeRetrievalSettingsKnowledgeResponse200ModelParameters,
2196
- SDKValidationError
2197
- > {
2198
- return safeParse(
2199
- jsonString,
2200
- (x) =>
2201
- CreateKnowledgeRetrievalSettingsKnowledgeResponse200ModelParameters$inboundSchema
2202
- .parse(JSON.parse(x)),
2203
- `Failed to parse 'CreateKnowledgeRetrievalSettingsKnowledgeResponse200ModelParameters' from JSON`,
2204
- );
189
+ export namespace RetrievalType$ {
190
+ /** @deprecated use `RetrievalType$inboundSchema` instead. */
191
+ export const inboundSchema = RetrievalType$inboundSchema;
192
+ /** @deprecated use `RetrievalType$outboundSchema` instead. */
193
+ export const outboundSchema = RetrievalType$outboundSchema;
2205
194
  }
2206
195
 
2207
196
  /** @internal */
2208
- export const CreateKnowledgeRetrievalSettingsKnowledgeResponseRerankConfig$inboundSchema:
2209
- z.ZodType<
2210
- CreateKnowledgeRetrievalSettingsKnowledgeResponseRerankConfig,
2211
- z.ZodTypeDef,
2212
- unknown
2213
- > = z.object({
2214
- enabled: z.boolean().optional(),
2215
- provider:
2216
- CreateKnowledgeRetrievalSettingsKnowledgeResponse200Provider$inboundSchema
2217
- .optional(),
2218
- model: z.string().optional(),
2219
- model_db_id: z.string().optional(),
2220
- model_type:
2221
- CreateKnowledgeRetrievalSettingsKnowledgeResponse200ModelType$inboundSchema
2222
- .optional(),
2223
- model_parameters: z.lazy(() =>
2224
- CreateKnowledgeRetrievalSettingsKnowledgeResponse200ModelParameters$inboundSchema
2225
- ).optional(),
2226
- integration_id: z.nullable(z.string()).optional(),
2227
- }).transform((v) => {
2228
- return remap$(v, {
2229
- "model_db_id": "modelDbId",
2230
- "model_type": "modelType",
2231
- "model_parameters": "modelParameters",
2232
- "integration_id": "integrationId",
2233
- });
197
+ export const RerankConfig$inboundSchema: z.ZodType<
198
+ RerankConfig,
199
+ z.ZodTypeDef,
200
+ unknown
201
+ > = z.object({
202
+ rerank_threshold: z.number().default(0.5),
203
+ rerank_model: z.string(),
204
+ }).transform((v) => {
205
+ return remap$(v, {
206
+ "rerank_threshold": "rerankThreshold",
207
+ "rerank_model": "rerankModel",
2234
208
  });
209
+ });
2235
210
 
2236
211
  /** @internal */
2237
- export type CreateKnowledgeRetrievalSettingsKnowledgeResponseRerankConfig$Outbound =
2238
- {
2239
- enabled?: boolean | undefined;
2240
- provider?: string | undefined;
2241
- model?: string | undefined;
2242
- model_db_id?: string | undefined;
2243
- model_type?: string | undefined;
2244
- model_parameters?:
2245
- | CreateKnowledgeRetrievalSettingsKnowledgeResponse200ModelParameters$Outbound
2246
- | undefined;
2247
- integration_id?: string | null | undefined;
2248
- };
212
+ export type RerankConfig$Outbound = {
213
+ rerank_threshold: number;
214
+ rerank_model: string;
215
+ };
2249
216
 
2250
217
  /** @internal */
2251
- export const CreateKnowledgeRetrievalSettingsKnowledgeResponseRerankConfig$outboundSchema:
2252
- z.ZodType<
2253
- CreateKnowledgeRetrievalSettingsKnowledgeResponseRerankConfig$Outbound,
2254
- z.ZodTypeDef,
2255
- CreateKnowledgeRetrievalSettingsKnowledgeResponseRerankConfig
2256
- > = z.object({
2257
- enabled: z.boolean().optional(),
2258
- provider:
2259
- CreateKnowledgeRetrievalSettingsKnowledgeResponse200Provider$outboundSchema
2260
- .optional(),
2261
- model: z.string().optional(),
2262
- modelDbId: z.string().optional(),
2263
- modelType:
2264
- CreateKnowledgeRetrievalSettingsKnowledgeResponse200ModelType$outboundSchema
2265
- .optional(),
2266
- modelParameters: z.lazy(() =>
2267
- CreateKnowledgeRetrievalSettingsKnowledgeResponse200ModelParameters$outboundSchema
2268
- ).optional(),
2269
- integrationId: z.nullable(z.string()).optional(),
2270
- }).transform((v) => {
2271
- return remap$(v, {
2272
- modelDbId: "model_db_id",
2273
- modelType: "model_type",
2274
- modelParameters: "model_parameters",
2275
- integrationId: "integration_id",
2276
- });
218
+ export const RerankConfig$outboundSchema: z.ZodType<
219
+ RerankConfig$Outbound,
220
+ z.ZodTypeDef,
221
+ RerankConfig
222
+ > = z.object({
223
+ rerankThreshold: z.number().default(0.5),
224
+ rerankModel: z.string(),
225
+ }).transform((v) => {
226
+ return remap$(v, {
227
+ rerankThreshold: "rerank_threshold",
228
+ rerankModel: "rerank_model",
2277
229
  });
230
+ });
2278
231
 
2279
232
  /**
2280
233
  * @internal
2281
234
  * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
2282
235
  */
2283
- export namespace CreateKnowledgeRetrievalSettingsKnowledgeResponseRerankConfig$ {
2284
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeResponseRerankConfig$inboundSchema` instead. */
2285
- export const inboundSchema =
2286
- CreateKnowledgeRetrievalSettingsKnowledgeResponseRerankConfig$inboundSchema;
2287
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeResponseRerankConfig$outboundSchema` instead. */
2288
- export const outboundSchema =
2289
- CreateKnowledgeRetrievalSettingsKnowledgeResponseRerankConfig$outboundSchema;
2290
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeResponseRerankConfig$Outbound` instead. */
2291
- export type Outbound =
2292
- CreateKnowledgeRetrievalSettingsKnowledgeResponseRerankConfig$Outbound;
236
+ export namespace RerankConfig$ {
237
+ /** @deprecated use `RerankConfig$inboundSchema` instead. */
238
+ export const inboundSchema = RerankConfig$inboundSchema;
239
+ /** @deprecated use `RerankConfig$outboundSchema` instead. */
240
+ export const outboundSchema = RerankConfig$outboundSchema;
241
+ /** @deprecated use `RerankConfig$Outbound` instead. */
242
+ export type Outbound = RerankConfig$Outbound;
2293
243
  }
2294
244
 
2295
- export function createKnowledgeRetrievalSettingsKnowledgeResponseRerankConfigToJSON(
2296
- createKnowledgeRetrievalSettingsKnowledgeResponseRerankConfig:
2297
- CreateKnowledgeRetrievalSettingsKnowledgeResponseRerankConfig,
2298
- ): string {
2299
- return JSON.stringify(
2300
- CreateKnowledgeRetrievalSettingsKnowledgeResponseRerankConfig$outboundSchema
2301
- .parse(createKnowledgeRetrievalSettingsKnowledgeResponseRerankConfig),
2302
- );
245
+ export function rerankConfigToJSON(rerankConfig: RerankConfig): string {
246
+ return JSON.stringify(RerankConfig$outboundSchema.parse(rerankConfig));
2303
247
  }
2304
248
 
2305
- export function createKnowledgeRetrievalSettingsKnowledgeResponseRerankConfigFromJSON(
249
+ export function rerankConfigFromJSON(
2306
250
  jsonString: string,
2307
- ): SafeParseResult<
2308
- CreateKnowledgeRetrievalSettingsKnowledgeResponseRerankConfig,
2309
- SDKValidationError
2310
- > {
251
+ ): SafeParseResult<RerankConfig, SDKValidationError> {
2311
252
  return safeParse(
2312
253
  jsonString,
2313
- (x) =>
2314
- CreateKnowledgeRetrievalSettingsKnowledgeResponseRerankConfig$inboundSchema
2315
- .parse(JSON.parse(x)),
2316
- `Failed to parse 'CreateKnowledgeRetrievalSettingsKnowledgeResponseRerankConfig' from JSON`,
254
+ (x) => RerankConfig$inboundSchema.parse(JSON.parse(x)),
255
+ `Failed to parse 'RerankConfig' from JSON`,
2317
256
  );
2318
257
  }
2319
258
 
2320
259
  /** @internal */
2321
- export const CreateKnowledgeRetrievalSettings2$inboundSchema: z.ZodType<
2322
- CreateKnowledgeRetrievalSettings2,
260
+ export const RetrievalSettings$inboundSchema: z.ZodType<
261
+ RetrievalSettings,
2323
262
  z.ZodTypeDef,
2324
263
  unknown
2325
264
  > = z.object({
2326
- type: CreateKnowledgeRetrievalSettingsKnowledgeResponse200Type$inboundSchema,
265
+ retrieval_type: RetrievalType$inboundSchema.default("hybrid_search"),
2327
266
  top_k: z.number().int().default(5),
2328
267
  threshold: z.number().default(0),
2329
- rerank_config: z.nullable(
2330
- z.lazy(() =>
2331
- CreateKnowledgeRetrievalSettingsKnowledgeResponseRerankConfig$inboundSchema
2332
- ),
2333
- ).optional(),
268
+ rerank_config: z.lazy(() => RerankConfig$inboundSchema).optional(),
2334
269
  }).transform((v) => {
2335
270
  return remap$(v, {
271
+ "retrieval_type": "retrievalType",
2336
272
  "top_k": "topK",
2337
273
  "rerank_config": "rerankConfig",
2338
274
  });
2339
275
  });
2340
276
 
2341
277
  /** @internal */
2342
- export type CreateKnowledgeRetrievalSettings2$Outbound = {
2343
- type: string;
278
+ export type RetrievalSettings$Outbound = {
279
+ retrieval_type: string;
2344
280
  top_k: number;
2345
281
  threshold: number;
2346
- rerank_config?:
2347
- | CreateKnowledgeRetrievalSettingsKnowledgeResponseRerankConfig$Outbound
2348
- | null
2349
- | undefined;
282
+ rerank_config?: RerankConfig$Outbound | undefined;
2350
283
  };
2351
284
 
2352
285
  /** @internal */
2353
- export const CreateKnowledgeRetrievalSettings2$outboundSchema: z.ZodType<
2354
- CreateKnowledgeRetrievalSettings2$Outbound,
286
+ export const RetrievalSettings$outboundSchema: z.ZodType<
287
+ RetrievalSettings$Outbound,
2355
288
  z.ZodTypeDef,
2356
- CreateKnowledgeRetrievalSettings2
289
+ RetrievalSettings
2357
290
  > = z.object({
2358
- type: CreateKnowledgeRetrievalSettingsKnowledgeResponse200Type$outboundSchema,
291
+ retrievalType: RetrievalType$outboundSchema.default("hybrid_search"),
2359
292
  topK: z.number().int().default(5),
2360
293
  threshold: z.number().default(0),
2361
- rerankConfig: z.nullable(
2362
- z.lazy(() =>
2363
- CreateKnowledgeRetrievalSettingsKnowledgeResponseRerankConfig$outboundSchema
2364
- ),
2365
- ).optional(),
294
+ rerankConfig: z.lazy(() => RerankConfig$outboundSchema).optional(),
2366
295
  }).transform((v) => {
2367
296
  return remap$(v, {
297
+ retrievalType: "retrieval_type",
2368
298
  topK: "top_k",
2369
299
  rerankConfig: "rerank_config",
2370
300
  });
@@ -2374,342 +304,163 @@ export const CreateKnowledgeRetrievalSettings2$outboundSchema: z.ZodType<
2374
304
  * @internal
2375
305
  * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
2376
306
  */
2377
- export namespace CreateKnowledgeRetrievalSettings2$ {
2378
- /** @deprecated use `CreateKnowledgeRetrievalSettings2$inboundSchema` instead. */
2379
- export const inboundSchema = CreateKnowledgeRetrievalSettings2$inboundSchema;
2380
- /** @deprecated use `CreateKnowledgeRetrievalSettings2$outboundSchema` instead. */
2381
- export const outboundSchema =
2382
- CreateKnowledgeRetrievalSettings2$outboundSchema;
2383
- /** @deprecated use `CreateKnowledgeRetrievalSettings2$Outbound` instead. */
2384
- export type Outbound = CreateKnowledgeRetrievalSettings2$Outbound;
307
+ export namespace RetrievalSettings$ {
308
+ /** @deprecated use `RetrievalSettings$inboundSchema` instead. */
309
+ export const inboundSchema = RetrievalSettings$inboundSchema;
310
+ /** @deprecated use `RetrievalSettings$outboundSchema` instead. */
311
+ export const outboundSchema = RetrievalSettings$outboundSchema;
312
+ /** @deprecated use `RetrievalSettings$Outbound` instead. */
313
+ export type Outbound = RetrievalSettings$Outbound;
2385
314
  }
2386
315
 
2387
- export function createKnowledgeRetrievalSettings2ToJSON(
2388
- createKnowledgeRetrievalSettings2: CreateKnowledgeRetrievalSettings2,
316
+ export function retrievalSettingsToJSON(
317
+ retrievalSettings: RetrievalSettings,
2389
318
  ): string {
2390
319
  return JSON.stringify(
2391
- CreateKnowledgeRetrievalSettings2$outboundSchema.parse(
2392
- createKnowledgeRetrievalSettings2,
2393
- ),
320
+ RetrievalSettings$outboundSchema.parse(retrievalSettings),
2394
321
  );
2395
322
  }
2396
323
 
2397
- export function createKnowledgeRetrievalSettings2FromJSON(
324
+ export function retrievalSettingsFromJSON(
2398
325
  jsonString: string,
2399
- ): SafeParseResult<CreateKnowledgeRetrievalSettings2, SDKValidationError> {
326
+ ): SafeParseResult<RetrievalSettings, SDKValidationError> {
2400
327
  return safeParse(
2401
328
  jsonString,
2402
- (x) => CreateKnowledgeRetrievalSettings2$inboundSchema.parse(JSON.parse(x)),
2403
- `Failed to parse 'CreateKnowledgeRetrievalSettings2' from JSON`,
329
+ (x) => RetrievalSettings$inboundSchema.parse(JSON.parse(x)),
330
+ `Failed to parse 'RetrievalSettings' from JSON`,
2404
331
  );
2405
332
  }
2406
333
 
2407
334
  /** @internal */
2408
- export const CreateKnowledgeRetrievalSettingsKnowledgeResponseType$inboundSchema:
2409
- z.ZodNativeEnum<
2410
- typeof CreateKnowledgeRetrievalSettingsKnowledgeResponseType
2411
- > = z.nativeEnum(CreateKnowledgeRetrievalSettingsKnowledgeResponseType);
2412
-
2413
- /** @internal */
2414
- export const CreateKnowledgeRetrievalSettingsKnowledgeResponseType$outboundSchema:
2415
- z.ZodNativeEnum<
2416
- typeof CreateKnowledgeRetrievalSettingsKnowledgeResponseType
2417
- > = CreateKnowledgeRetrievalSettingsKnowledgeResponseType$inboundSchema;
2418
-
2419
- /**
2420
- * @internal
2421
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
2422
- */
2423
- export namespace CreateKnowledgeRetrievalSettingsKnowledgeResponseType$ {
2424
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeResponseType$inboundSchema` instead. */
2425
- export const inboundSchema =
2426
- CreateKnowledgeRetrievalSettingsKnowledgeResponseType$inboundSchema;
2427
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeResponseType$outboundSchema` instead. */
2428
- export const outboundSchema =
2429
- CreateKnowledgeRetrievalSettingsKnowledgeResponseType$outboundSchema;
2430
- }
2431
-
2432
- /** @internal */
2433
- export const CreateKnowledgeRetrievalSettingsKnowledgeResponseProvider$inboundSchema:
2434
- z.ZodNativeEnum<
2435
- typeof CreateKnowledgeRetrievalSettingsKnowledgeResponseProvider
2436
- > = z.nativeEnum(CreateKnowledgeRetrievalSettingsKnowledgeResponseProvider);
2437
-
2438
- /** @internal */
2439
- export const CreateKnowledgeRetrievalSettingsKnowledgeResponseProvider$outboundSchema:
2440
- z.ZodNativeEnum<
2441
- typeof CreateKnowledgeRetrievalSettingsKnowledgeResponseProvider
2442
- > = CreateKnowledgeRetrievalSettingsKnowledgeResponseProvider$inboundSchema;
2443
-
2444
- /**
2445
- * @internal
2446
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
2447
- */
2448
- export namespace CreateKnowledgeRetrievalSettingsKnowledgeResponseProvider$ {
2449
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeResponseProvider$inboundSchema` instead. */
2450
- export const inboundSchema =
2451
- CreateKnowledgeRetrievalSettingsKnowledgeResponseProvider$inboundSchema;
2452
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeResponseProvider$outboundSchema` instead. */
2453
- export const outboundSchema =
2454
- CreateKnowledgeRetrievalSettingsKnowledgeResponseProvider$outboundSchema;
2455
- }
2456
-
2457
- /** @internal */
2458
- export const CreateKnowledgeRetrievalSettingsKnowledgeResponseModelType$inboundSchema:
2459
- z.ZodNativeEnum<
2460
- typeof CreateKnowledgeRetrievalSettingsKnowledgeResponseModelType
2461
- > = z.nativeEnum(CreateKnowledgeRetrievalSettingsKnowledgeResponseModelType);
2462
-
2463
- /** @internal */
2464
- export const CreateKnowledgeRetrievalSettingsKnowledgeResponseModelType$outboundSchema:
2465
- z.ZodNativeEnum<
2466
- typeof CreateKnowledgeRetrievalSettingsKnowledgeResponseModelType
2467
- > = CreateKnowledgeRetrievalSettingsKnowledgeResponseModelType$inboundSchema;
2468
-
2469
- /**
2470
- * @internal
2471
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
2472
- */
2473
- export namespace CreateKnowledgeRetrievalSettingsKnowledgeResponseModelType$ {
2474
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeResponseModelType$inboundSchema` instead. */
2475
- export const inboundSchema =
2476
- CreateKnowledgeRetrievalSettingsKnowledgeResponseModelType$inboundSchema;
2477
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeResponseModelType$outboundSchema` instead. */
2478
- export const outboundSchema =
2479
- CreateKnowledgeRetrievalSettingsKnowledgeResponseModelType$outboundSchema;
2480
- }
2481
-
2482
- /** @internal */
2483
- export const CreateKnowledgeRetrievalSettingsKnowledgeResponseModelParameters$inboundSchema:
2484
- z.ZodType<
2485
- CreateKnowledgeRetrievalSettingsKnowledgeResponseModelParameters,
2486
- z.ZodTypeDef,
2487
- unknown
2488
- > = z.object({
2489
- threshold: z.number().optional(),
335
+ export const CreateKnowledgeRequestBody$inboundSchema: z.ZodType<
336
+ CreateKnowledgeRequestBody,
337
+ z.ZodTypeDef,
338
+ unknown
339
+ > = z.object({
340
+ key: z.string(),
341
+ description: z.string().optional(),
342
+ embedding_model: z.string(),
343
+ retrieval_settings: z.lazy(() => RetrievalSettings$inboundSchema).optional(),
344
+ path: z.string(),
345
+ }).transform((v) => {
346
+ return remap$(v, {
347
+ "embedding_model": "embeddingModel",
348
+ "retrieval_settings": "retrievalSettings",
2490
349
  });
350
+ });
2491
351
 
2492
352
  /** @internal */
2493
- export type CreateKnowledgeRetrievalSettingsKnowledgeResponseModelParameters$Outbound =
2494
- {
2495
- threshold?: number | undefined;
2496
- };
353
+ export type CreateKnowledgeRequestBody$Outbound = {
354
+ key: string;
355
+ description?: string | undefined;
356
+ embedding_model: string;
357
+ retrieval_settings?: RetrievalSettings$Outbound | undefined;
358
+ path: string;
359
+ };
2497
360
 
2498
361
  /** @internal */
2499
- export const CreateKnowledgeRetrievalSettingsKnowledgeResponseModelParameters$outboundSchema:
2500
- z.ZodType<
2501
- CreateKnowledgeRetrievalSettingsKnowledgeResponseModelParameters$Outbound,
2502
- z.ZodTypeDef,
2503
- CreateKnowledgeRetrievalSettingsKnowledgeResponseModelParameters
2504
- > = z.object({
2505
- threshold: z.number().optional(),
362
+ export const CreateKnowledgeRequestBody$outboundSchema: z.ZodType<
363
+ CreateKnowledgeRequestBody$Outbound,
364
+ z.ZodTypeDef,
365
+ CreateKnowledgeRequestBody
366
+ > = z.object({
367
+ key: z.string(),
368
+ description: z.string().optional(),
369
+ embeddingModel: z.string(),
370
+ retrievalSettings: z.lazy(() => RetrievalSettings$outboundSchema).optional(),
371
+ path: z.string(),
372
+ }).transform((v) => {
373
+ return remap$(v, {
374
+ embeddingModel: "embedding_model",
375
+ retrievalSettings: "retrieval_settings",
2506
376
  });
377
+ });
2507
378
 
2508
379
  /**
2509
380
  * @internal
2510
381
  * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
2511
382
  */
2512
- export namespace CreateKnowledgeRetrievalSettingsKnowledgeResponseModelParameters$ {
2513
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeResponseModelParameters$inboundSchema` instead. */
2514
- export const inboundSchema =
2515
- CreateKnowledgeRetrievalSettingsKnowledgeResponseModelParameters$inboundSchema;
2516
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeResponseModelParameters$outboundSchema` instead. */
2517
- export const outboundSchema =
2518
- CreateKnowledgeRetrievalSettingsKnowledgeResponseModelParameters$outboundSchema;
2519
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeResponseModelParameters$Outbound` instead. */
2520
- export type Outbound =
2521
- CreateKnowledgeRetrievalSettingsKnowledgeResponseModelParameters$Outbound;
383
+ export namespace CreateKnowledgeRequestBody$ {
384
+ /** @deprecated use `CreateKnowledgeRequestBody$inboundSchema` instead. */
385
+ export const inboundSchema = CreateKnowledgeRequestBody$inboundSchema;
386
+ /** @deprecated use `CreateKnowledgeRequestBody$outboundSchema` instead. */
387
+ export const outboundSchema = CreateKnowledgeRequestBody$outboundSchema;
388
+ /** @deprecated use `CreateKnowledgeRequestBody$Outbound` instead. */
389
+ export type Outbound = CreateKnowledgeRequestBody$Outbound;
2522
390
  }
2523
391
 
2524
- export function createKnowledgeRetrievalSettingsKnowledgeResponseModelParametersToJSON(
2525
- createKnowledgeRetrievalSettingsKnowledgeResponseModelParameters:
2526
- CreateKnowledgeRetrievalSettingsKnowledgeResponseModelParameters,
392
+ export function createKnowledgeRequestBodyToJSON(
393
+ createKnowledgeRequestBody: CreateKnowledgeRequestBody,
2527
394
  ): string {
2528
395
  return JSON.stringify(
2529
- CreateKnowledgeRetrievalSettingsKnowledgeResponseModelParameters$outboundSchema
2530
- .parse(createKnowledgeRetrievalSettingsKnowledgeResponseModelParameters),
396
+ CreateKnowledgeRequestBody$outboundSchema.parse(createKnowledgeRequestBody),
2531
397
  );
2532
398
  }
2533
399
 
2534
- export function createKnowledgeRetrievalSettingsKnowledgeResponseModelParametersFromJSON(
400
+ export function createKnowledgeRequestBodyFromJSON(
2535
401
  jsonString: string,
2536
- ): SafeParseResult<
2537
- CreateKnowledgeRetrievalSettingsKnowledgeResponseModelParameters,
2538
- SDKValidationError
2539
- > {
402
+ ): SafeParseResult<CreateKnowledgeRequestBody, SDKValidationError> {
2540
403
  return safeParse(
2541
404
  jsonString,
2542
- (x) =>
2543
- CreateKnowledgeRetrievalSettingsKnowledgeResponseModelParameters$inboundSchema
2544
- .parse(JSON.parse(x)),
2545
- `Failed to parse 'CreateKnowledgeRetrievalSettingsKnowledgeResponseModelParameters' from JSON`,
405
+ (x) => CreateKnowledgeRequestBody$inboundSchema.parse(JSON.parse(x)),
406
+ `Failed to parse 'CreateKnowledgeRequestBody' from JSON`,
2546
407
  );
2547
408
  }
2548
409
 
2549
410
  /** @internal */
2550
- export const CreateKnowledgeRetrievalSettingsKnowledgeRerankConfig$inboundSchema:
2551
- z.ZodType<
2552
- CreateKnowledgeRetrievalSettingsKnowledgeRerankConfig,
2553
- z.ZodTypeDef,
2554
- unknown
2555
- > = z.object({
2556
- enabled: z.boolean().optional(),
2557
- provider:
2558
- CreateKnowledgeRetrievalSettingsKnowledgeResponseProvider$inboundSchema
2559
- .optional(),
2560
- model: z.string().optional(),
2561
- model_db_id: z.string().optional(),
2562
- model_type:
2563
- CreateKnowledgeRetrievalSettingsKnowledgeResponseModelType$inboundSchema
2564
- .optional(),
2565
- model_parameters: z.lazy(() =>
2566
- CreateKnowledgeRetrievalSettingsKnowledgeResponseModelParameters$inboundSchema
2567
- ).optional(),
2568
- integration_id: z.nullable(z.string()).optional(),
2569
- }).transform((v) => {
2570
- return remap$(v, {
2571
- "model_db_id": "modelDbId",
2572
- "model_type": "modelType",
2573
- "model_parameters": "modelParameters",
2574
- "integration_id": "integrationId",
2575
- });
2576
- });
2577
-
2578
- /** @internal */
2579
- export type CreateKnowledgeRetrievalSettingsKnowledgeRerankConfig$Outbound = {
2580
- enabled?: boolean | undefined;
2581
- provider?: string | undefined;
2582
- model?: string | undefined;
2583
- model_db_id?: string | undefined;
2584
- model_type?: string | undefined;
2585
- model_parameters?:
2586
- | CreateKnowledgeRetrievalSettingsKnowledgeResponseModelParameters$Outbound
2587
- | undefined;
2588
- integration_id?: string | null | undefined;
2589
- };
411
+ export const CreateKnowledgeRetrievalType$inboundSchema: z.ZodNativeEnum<
412
+ typeof CreateKnowledgeRetrievalType
413
+ > = z.nativeEnum(CreateKnowledgeRetrievalType);
2590
414
 
2591
415
  /** @internal */
2592
- export const CreateKnowledgeRetrievalSettingsKnowledgeRerankConfig$outboundSchema:
2593
- z.ZodType<
2594
- CreateKnowledgeRetrievalSettingsKnowledgeRerankConfig$Outbound,
2595
- z.ZodTypeDef,
2596
- CreateKnowledgeRetrievalSettingsKnowledgeRerankConfig
2597
- > = z.object({
2598
- enabled: z.boolean().optional(),
2599
- provider:
2600
- CreateKnowledgeRetrievalSettingsKnowledgeResponseProvider$outboundSchema
2601
- .optional(),
2602
- model: z.string().optional(),
2603
- modelDbId: z.string().optional(),
2604
- modelType:
2605
- CreateKnowledgeRetrievalSettingsKnowledgeResponseModelType$outboundSchema
2606
- .optional(),
2607
- modelParameters: z.lazy(() =>
2608
- CreateKnowledgeRetrievalSettingsKnowledgeResponseModelParameters$outboundSchema
2609
- ).optional(),
2610
- integrationId: z.nullable(z.string()).optional(),
2611
- }).transform((v) => {
2612
- return remap$(v, {
2613
- modelDbId: "model_db_id",
2614
- modelType: "model_type",
2615
- modelParameters: "model_parameters",
2616
- integrationId: "integration_id",
2617
- });
2618
- });
416
+ export const CreateKnowledgeRetrievalType$outboundSchema: z.ZodNativeEnum<
417
+ typeof CreateKnowledgeRetrievalType
418
+ > = CreateKnowledgeRetrievalType$inboundSchema;
2619
419
 
2620
420
  /**
2621
421
  * @internal
2622
422
  * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
2623
423
  */
2624
- export namespace CreateKnowledgeRetrievalSettingsKnowledgeRerankConfig$ {
2625
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeRerankConfig$inboundSchema` instead. */
2626
- export const inboundSchema =
2627
- CreateKnowledgeRetrievalSettingsKnowledgeRerankConfig$inboundSchema;
2628
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeRerankConfig$outboundSchema` instead. */
2629
- export const outboundSchema =
2630
- CreateKnowledgeRetrievalSettingsKnowledgeRerankConfig$outboundSchema;
2631
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeRerankConfig$Outbound` instead. */
2632
- export type Outbound =
2633
- CreateKnowledgeRetrievalSettingsKnowledgeRerankConfig$Outbound;
2634
- }
2635
-
2636
- export function createKnowledgeRetrievalSettingsKnowledgeRerankConfigToJSON(
2637
- createKnowledgeRetrievalSettingsKnowledgeRerankConfig:
2638
- CreateKnowledgeRetrievalSettingsKnowledgeRerankConfig,
2639
- ): string {
2640
- return JSON.stringify(
2641
- CreateKnowledgeRetrievalSettingsKnowledgeRerankConfig$outboundSchema.parse(
2642
- createKnowledgeRetrievalSettingsKnowledgeRerankConfig,
2643
- ),
2644
- );
2645
- }
2646
-
2647
- export function createKnowledgeRetrievalSettingsKnowledgeRerankConfigFromJSON(
2648
- jsonString: string,
2649
- ): SafeParseResult<
2650
- CreateKnowledgeRetrievalSettingsKnowledgeRerankConfig,
2651
- SDKValidationError
2652
- > {
2653
- return safeParse(
2654
- jsonString,
2655
- (x) =>
2656
- CreateKnowledgeRetrievalSettingsKnowledgeRerankConfig$inboundSchema.parse(
2657
- JSON.parse(x),
2658
- ),
2659
- `Failed to parse 'CreateKnowledgeRetrievalSettingsKnowledgeRerankConfig' from JSON`,
2660
- );
424
+ export namespace CreateKnowledgeRetrievalType$ {
425
+ /** @deprecated use `CreateKnowledgeRetrievalType$inboundSchema` instead. */
426
+ export const inboundSchema = CreateKnowledgeRetrievalType$inboundSchema;
427
+ /** @deprecated use `CreateKnowledgeRetrievalType$outboundSchema` instead. */
428
+ export const outboundSchema = CreateKnowledgeRetrievalType$outboundSchema;
2661
429
  }
2662
430
 
2663
431
  /** @internal */
2664
- export const CreateKnowledgeRetrievalSettings1$inboundSchema: z.ZodType<
2665
- CreateKnowledgeRetrievalSettings1,
432
+ export const CreateKnowledgeRerankConfig$inboundSchema: z.ZodType<
433
+ CreateKnowledgeRerankConfig,
2666
434
  z.ZodTypeDef,
2667
435
  unknown
2668
436
  > = z.object({
2669
- type: CreateKnowledgeRetrievalSettingsKnowledgeResponseType$inboundSchema,
2670
- top_k: z.number().int().default(5),
2671
- threshold: z.number().default(0),
2672
- rerank_config: z.nullable(
2673
- z.lazy(() =>
2674
- CreateKnowledgeRetrievalSettingsKnowledgeRerankConfig$inboundSchema
2675
- ),
2676
- ).optional(),
437
+ rerank_threshold: z.number().default(0.5),
438
+ rerank_model: z.string(),
2677
439
  }).transform((v) => {
2678
440
  return remap$(v, {
2679
- "top_k": "topK",
2680
- "rerank_config": "rerankConfig",
441
+ "rerank_threshold": "rerankThreshold",
442
+ "rerank_model": "rerankModel",
2681
443
  });
2682
444
  });
2683
445
 
2684
446
  /** @internal */
2685
- export type CreateKnowledgeRetrievalSettings1$Outbound = {
2686
- type: string;
2687
- top_k: number;
2688
- threshold: number;
2689
- rerank_config?:
2690
- | CreateKnowledgeRetrievalSettingsKnowledgeRerankConfig$Outbound
2691
- | null
2692
- | undefined;
447
+ export type CreateKnowledgeRerankConfig$Outbound = {
448
+ rerank_threshold: number;
449
+ rerank_model: string;
2693
450
  };
2694
451
 
2695
452
  /** @internal */
2696
- export const CreateKnowledgeRetrievalSettings1$outboundSchema: z.ZodType<
2697
- CreateKnowledgeRetrievalSettings1$Outbound,
453
+ export const CreateKnowledgeRerankConfig$outboundSchema: z.ZodType<
454
+ CreateKnowledgeRerankConfig$Outbound,
2698
455
  z.ZodTypeDef,
2699
- CreateKnowledgeRetrievalSettings1
456
+ CreateKnowledgeRerankConfig
2700
457
  > = z.object({
2701
- type: CreateKnowledgeRetrievalSettingsKnowledgeResponseType$outboundSchema,
2702
- topK: z.number().int().default(5),
2703
- threshold: z.number().default(0),
2704
- rerankConfig: z.nullable(
2705
- z.lazy(() =>
2706
- CreateKnowledgeRetrievalSettingsKnowledgeRerankConfig$outboundSchema
2707
- ),
2708
- ).optional(),
458
+ rerankThreshold: z.number().default(0.5),
459
+ rerankModel: z.string(),
2709
460
  }).transform((v) => {
2710
461
  return remap$(v, {
2711
- topK: "top_k",
2712
- rerankConfig: "rerank_config",
462
+ rerankThreshold: "rerank_threshold",
463
+ rerankModel: "rerank_model",
2713
464
  });
2714
465
  });
2715
466
 
@@ -2717,33 +468,32 @@ export const CreateKnowledgeRetrievalSettings1$outboundSchema: z.ZodType<
2717
468
  * @internal
2718
469
  * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
2719
470
  */
2720
- export namespace CreateKnowledgeRetrievalSettings1$ {
2721
- /** @deprecated use `CreateKnowledgeRetrievalSettings1$inboundSchema` instead. */
2722
- export const inboundSchema = CreateKnowledgeRetrievalSettings1$inboundSchema;
2723
- /** @deprecated use `CreateKnowledgeRetrievalSettings1$outboundSchema` instead. */
2724
- export const outboundSchema =
2725
- CreateKnowledgeRetrievalSettings1$outboundSchema;
2726
- /** @deprecated use `CreateKnowledgeRetrievalSettings1$Outbound` instead. */
2727
- export type Outbound = CreateKnowledgeRetrievalSettings1$Outbound;
471
+ export namespace CreateKnowledgeRerankConfig$ {
472
+ /** @deprecated use `CreateKnowledgeRerankConfig$inboundSchema` instead. */
473
+ export const inboundSchema = CreateKnowledgeRerankConfig$inboundSchema;
474
+ /** @deprecated use `CreateKnowledgeRerankConfig$outboundSchema` instead. */
475
+ export const outboundSchema = CreateKnowledgeRerankConfig$outboundSchema;
476
+ /** @deprecated use `CreateKnowledgeRerankConfig$Outbound` instead. */
477
+ export type Outbound = CreateKnowledgeRerankConfig$Outbound;
2728
478
  }
2729
479
 
2730
- export function createKnowledgeRetrievalSettings1ToJSON(
2731
- createKnowledgeRetrievalSettings1: CreateKnowledgeRetrievalSettings1,
480
+ export function createKnowledgeRerankConfigToJSON(
481
+ createKnowledgeRerankConfig: CreateKnowledgeRerankConfig,
2732
482
  ): string {
2733
483
  return JSON.stringify(
2734
- CreateKnowledgeRetrievalSettings1$outboundSchema.parse(
2735
- createKnowledgeRetrievalSettings1,
484
+ CreateKnowledgeRerankConfig$outboundSchema.parse(
485
+ createKnowledgeRerankConfig,
2736
486
  ),
2737
487
  );
2738
488
  }
2739
489
 
2740
- export function createKnowledgeRetrievalSettings1FromJSON(
490
+ export function createKnowledgeRerankConfigFromJSON(
2741
491
  jsonString: string,
2742
- ): SafeParseResult<CreateKnowledgeRetrievalSettings1, SDKValidationError> {
492
+ ): SafeParseResult<CreateKnowledgeRerankConfig, SDKValidationError> {
2743
493
  return safeParse(
2744
494
  jsonString,
2745
- (x) => CreateKnowledgeRetrievalSettings1$inboundSchema.parse(JSON.parse(x)),
2746
- `Failed to parse 'CreateKnowledgeRetrievalSettings1' from JSON`,
495
+ (x) => CreateKnowledgeRerankConfig$inboundSchema.parse(JSON.parse(x)),
496
+ `Failed to parse 'CreateKnowledgeRerankConfig' from JSON`,
2747
497
  );
2748
498
  }
2749
499
 
@@ -2752,28 +502,50 @@ export const CreateKnowledgeRetrievalSettings$inboundSchema: z.ZodType<
2752
502
  CreateKnowledgeRetrievalSettings,
2753
503
  z.ZodTypeDef,
2754
504
  unknown
2755
- > = z.union([
2756
- z.lazy(() => CreateKnowledgeRetrievalSettings1$inboundSchema),
2757
- z.lazy(() => CreateKnowledgeRetrievalSettings2$inboundSchema),
2758
- z.lazy(() => CreateKnowledgeRetrievalSettings3$inboundSchema),
2759
- ]);
505
+ > = z.object({
506
+ retrieval_type: CreateKnowledgeRetrievalType$inboundSchema.default(
507
+ "hybrid_search",
508
+ ),
509
+ top_k: z.number().int().default(5),
510
+ threshold: z.number().default(0),
511
+ rerank_config: z.lazy(() => CreateKnowledgeRerankConfig$inboundSchema)
512
+ .optional(),
513
+ }).transform((v) => {
514
+ return remap$(v, {
515
+ "retrieval_type": "retrievalType",
516
+ "top_k": "topK",
517
+ "rerank_config": "rerankConfig",
518
+ });
519
+ });
2760
520
 
2761
521
  /** @internal */
2762
- export type CreateKnowledgeRetrievalSettings$Outbound =
2763
- | CreateKnowledgeRetrievalSettings1$Outbound
2764
- | CreateKnowledgeRetrievalSettings2$Outbound
2765
- | CreateKnowledgeRetrievalSettings3$Outbound;
522
+ export type CreateKnowledgeRetrievalSettings$Outbound = {
523
+ retrieval_type: string;
524
+ top_k: number;
525
+ threshold: number;
526
+ rerank_config?: CreateKnowledgeRerankConfig$Outbound | undefined;
527
+ };
2766
528
 
2767
529
  /** @internal */
2768
530
  export const CreateKnowledgeRetrievalSettings$outboundSchema: z.ZodType<
2769
531
  CreateKnowledgeRetrievalSettings$Outbound,
2770
532
  z.ZodTypeDef,
2771
533
  CreateKnowledgeRetrievalSettings
2772
- > = z.union([
2773
- z.lazy(() => CreateKnowledgeRetrievalSettings1$outboundSchema),
2774
- z.lazy(() => CreateKnowledgeRetrievalSettings2$outboundSchema),
2775
- z.lazy(() => CreateKnowledgeRetrievalSettings3$outboundSchema),
2776
- ]);
534
+ > = z.object({
535
+ retrievalType: CreateKnowledgeRetrievalType$outboundSchema.default(
536
+ "hybrid_search",
537
+ ),
538
+ topK: z.number().int().default(5),
539
+ threshold: z.number().default(0),
540
+ rerankConfig: z.lazy(() => CreateKnowledgeRerankConfig$outboundSchema)
541
+ .optional(),
542
+ }).transform((v) => {
543
+ return remap$(v, {
544
+ retrievalType: "retrieval_type",
545
+ topK: "top_k",
546
+ rerankConfig: "rerank_config",
547
+ });
548
+ });
2777
549
 
2778
550
  /**
2779
551
  * @internal
@@ -2819,14 +591,11 @@ export const CreateKnowledgeResponseBody$inboundSchema: z.ZodType<
2819
591
  created: z.string(),
2820
592
  description: z.string().optional(),
2821
593
  key: z.string(),
2822
- metadata: z.lazy(() => CreateKnowledgeMetadata$inboundSchema),
2823
594
  model: z.string(),
2824
595
  path: z.string().optional(),
2825
- retrieval_settings: z.union([
2826
- z.lazy(() => CreateKnowledgeRetrievalSettings1$inboundSchema),
2827
- z.lazy(() => CreateKnowledgeRetrievalSettings2$inboundSchema),
2828
- z.lazy(() => CreateKnowledgeRetrievalSettings3$inboundSchema),
2829
- ]),
596
+ retrieval_settings: z.lazy(() =>
597
+ CreateKnowledgeRetrievalSettings$inboundSchema
598
+ ).optional(),
2830
599
  update_by_id: z.string(),
2831
600
  updated: z.string(),
2832
601
  }).transform((v) => {
@@ -2845,13 +614,9 @@ export type CreateKnowledgeResponseBody$Outbound = {
2845
614
  created: string;
2846
615
  description?: string | undefined;
2847
616
  key: string;
2848
- metadata: CreateKnowledgeMetadata$Outbound;
2849
617
  model: string;
2850
618
  path?: string | undefined;
2851
- retrieval_settings:
2852
- | CreateKnowledgeRetrievalSettings1$Outbound
2853
- | CreateKnowledgeRetrievalSettings2$Outbound
2854
- | CreateKnowledgeRetrievalSettings3$Outbound;
619
+ retrieval_settings?: CreateKnowledgeRetrievalSettings$Outbound | undefined;
2855
620
  update_by_id: string;
2856
621
  updated: string;
2857
622
  };
@@ -2867,14 +632,11 @@ export const CreateKnowledgeResponseBody$outboundSchema: z.ZodType<
2867
632
  created: z.string(),
2868
633
  description: z.string().optional(),
2869
634
  key: z.string(),
2870
- metadata: z.lazy(() => CreateKnowledgeMetadata$outboundSchema),
2871
635
  model: z.string(),
2872
636
  path: z.string().optional(),
2873
- retrievalSettings: z.union([
2874
- z.lazy(() => CreateKnowledgeRetrievalSettings1$outboundSchema),
2875
- z.lazy(() => CreateKnowledgeRetrievalSettings2$outboundSchema),
2876
- z.lazy(() => CreateKnowledgeRetrievalSettings3$outboundSchema),
2877
- ]),
637
+ retrievalSettings: z.lazy(() =>
638
+ CreateKnowledgeRetrievalSettings$outboundSchema
639
+ ).optional(),
2878
640
  updateById: z.string(),
2879
641
  updated: z.string(),
2880
642
  }).transform((v) => {