@orq-ai/node 3.3.0-rc.14 → 3.3.0-rc.15

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 (94) hide show
  1. package/README.md +0 -2
  2. package/bin/mcp-server.js +421 -2515
  3. package/bin/mcp-server.js.map +28 -31
  4. package/docs/sdks/knowledge/README.md +2 -86
  5. package/jsr.json +1 -1
  6. package/lib/config.d.ts +2 -2
  7. package/lib/config.js +2 -2
  8. package/mcp-server/mcp-server.js +1 -1
  9. package/mcp-server/server.d.ts.map +1 -1
  10. package/mcp-server/server.js +1 -3
  11. package/mcp-server/server.js.map +1 -1
  12. package/models/operations/bulkcreatedatapoints.js +2 -2
  13. package/models/operations/createchunk.js +2 -2
  14. package/models/operations/createcontact.js +2 -2
  15. package/models/operations/createdataset.js +2 -2
  16. package/models/operations/createdatasetitem.js +2 -2
  17. package/models/operations/createdatasource.js +2 -2
  18. package/models/operations/createknowledge.d.ts +106 -1300
  19. package/models/operations/createknowledge.d.ts.map +1 -1
  20. package/models/operations/createknowledge.js +85 -1183
  21. package/models/operations/createknowledge.js.map +1 -1
  22. package/models/operations/fileget.js +2 -2
  23. package/models/operations/filelist.js +2 -2
  24. package/models/operations/fileupload.js +2 -2
  25. package/models/operations/getoneknowledge.d.ts +59 -676
  26. package/models/operations/getoneknowledge.d.ts.map +1 -1
  27. package/models/operations/getoneknowledge.js +49 -629
  28. package/models/operations/getoneknowledge.js.map +1 -1
  29. package/models/operations/index.d.ts +0 -1
  30. package/models/operations/index.d.ts.map +1 -1
  31. package/models/operations/index.js +0 -1
  32. package/models/operations/index.js.map +1 -1
  33. package/models/operations/listdatasetdatapoints.js +2 -2
  34. package/models/operations/listdatasets.js +2 -2
  35. package/models/operations/listdatasources.js +2 -2
  36. package/models/operations/listknowledgebases.d.ts +59 -676
  37. package/models/operations/listknowledgebases.d.ts.map +1 -1
  38. package/models/operations/listknowledgebases.js +50 -632
  39. package/models/operations/listknowledgebases.js.map +1 -1
  40. package/models/operations/retrievedatapoint.js +2 -2
  41. package/models/operations/retrievedataset.js +2 -2
  42. package/models/operations/retrievedatasource.js +2 -2
  43. package/models/operations/updatedatapoint.js +2 -2
  44. package/models/operations/updatedataset.js +2 -2
  45. package/models/operations/updateknowledge.d.ts +120 -1308
  46. package/models/operations/updateknowledge.d.ts.map +1 -1
  47. package/models/operations/updateknowledge.js +100 -1203
  48. package/models/operations/updateknowledge.js.map +1 -1
  49. package/package.json +1 -1
  50. package/sdk/knowledge.d.ts +0 -4
  51. package/sdk/knowledge.d.ts.map +1 -1
  52. package/sdk/knowledge.js +0 -7
  53. package/sdk/knowledge.js.map +1 -1
  54. package/src/lib/config.ts +2 -2
  55. package/src/mcp-server/mcp-server.ts +1 -1
  56. package/src/mcp-server/server.ts +1 -3
  57. package/src/models/operations/bulkcreatedatapoints.ts +2 -2
  58. package/src/models/operations/createchunk.ts +2 -2
  59. package/src/models/operations/createcontact.ts +2 -2
  60. package/src/models/operations/createdataset.ts +2 -2
  61. package/src/models/operations/createdatasetitem.ts +2 -2
  62. package/src/models/operations/createdatasource.ts +2 -2
  63. package/src/models/operations/createknowledge.ts +324 -2562
  64. package/src/models/operations/fileget.ts +2 -2
  65. package/src/models/operations/filelist.ts +2 -2
  66. package/src/models/operations/fileupload.ts +2 -2
  67. package/src/models/operations/getoneknowledge.ts +101 -1282
  68. package/src/models/operations/index.ts +0 -1
  69. package/src/models/operations/listdatasetdatapoints.ts +2 -2
  70. package/src/models/operations/listdatasets.ts +2 -2
  71. package/src/models/operations/listdatasources.ts +2 -2
  72. package/src/models/operations/listknowledgebases.ts +101 -1309
  73. package/src/models/operations/retrievedatapoint.ts +2 -2
  74. package/src/models/operations/retrievedataset.ts +2 -2
  75. package/src/models/operations/retrievedatasource.ts +2 -2
  76. package/src/models/operations/updatedatapoint.ts +2 -2
  77. package/src/models/operations/updatedataset.ts +2 -2
  78. package/src/models/operations/updateknowledge.ts +383 -2710
  79. package/src/sdk/knowledge.ts +0 -15
  80. package/funcs/knowledgeRetrieveFileUrl.d.ts +0 -14
  81. package/funcs/knowledgeRetrieveFileUrl.d.ts.map +0 -1
  82. package/funcs/knowledgeRetrieveFileUrl.js +0 -124
  83. package/funcs/knowledgeRetrieveFileUrl.js.map +0 -1
  84. package/mcp-server/tools/knowledgeRetrieveFileUrl.d.ts +0 -8
  85. package/mcp-server/tools/knowledgeRetrieveFileUrl.d.ts.map +0 -1
  86. package/mcp-server/tools/knowledgeRetrieveFileUrl.js +0 -62
  87. package/mcp-server/tools/knowledgeRetrieveFileUrl.js.map +0 -1
  88. package/models/operations/getonefileuploadurl.d.ts +0 -68
  89. package/models/operations/getonefileuploadurl.d.ts.map +0 -1
  90. package/models/operations/getonefileuploadurl.js +0 -113
  91. package/models/operations/getonefileuploadurl.js.map +0 -1
  92. package/src/funcs/knowledgeRetrieveFileUrl.ts +0 -176
  93. package/src/mcp-server/tools/knowledgeRetrieveFileUrl.ts +0 -35
  94. package/src/models/operations/getonefileuploadurl.ts +0 -157
@@ -2,410 +2,114 @@ import * as z from "zod";
2
2
  import { ClosedEnum } from "../../types/enums.js";
3
3
  import { Result as SafeParseResult } from "../../types/fp.js";
4
4
  import { SDKValidationError } from "../errors/sdkvalidationerror.js";
5
- export declare const CreateKnowledgeRetrievalSettingsKnowledgeType: {
5
+ /**
6
+ * The retrieval type to use for the knowledge base. If not provided, Hybrid Search will be used as a default query strategy.
7
+ */
8
+ export declare const RetrievalType: {
9
+ readonly VectorSearch: "vector_search";
10
+ readonly KeywordSearch: "keyword_search";
6
11
  readonly HybridSearch: "hybrid_search";
7
12
  };
8
- export type CreateKnowledgeRetrievalSettingsKnowledgeType = ClosedEnum<typeof CreateKnowledgeRetrievalSettingsKnowledgeType>;
9
- export declare const CreateKnowledgeRetrievalSettingsKnowledgeProvider: {
10
- readonly Cohere: "cohere";
11
- readonly Openai: "openai";
12
- readonly Anthropic: "anthropic";
13
- readonly Huggingface: "huggingface";
14
- readonly Replicate: "replicate";
15
- readonly Google: "google";
16
- readonly GoogleAi: "google-ai";
17
- readonly Azure: "azure";
18
- readonly Aws: "aws";
19
- readonly Anyscale: "anyscale";
20
- readonly Perplexity: "perplexity";
21
- readonly Groq: "groq";
22
- readonly Fal: "fal";
23
- readonly Leonardoai: "leonardoai";
24
- readonly Nvidia: "nvidia";
25
- readonly Jina: "jina";
26
- readonly Togetherai: "togetherai";
27
- readonly Elevenlabs: "elevenlabs";
28
- };
29
- export type CreateKnowledgeRetrievalSettingsKnowledgeProvider = ClosedEnum<typeof CreateKnowledgeRetrievalSettingsKnowledgeProvider>;
30
- export declare const CreateKnowledgeRetrievalSettingsKnowledgeModelType: {
31
- readonly Rerank: "rerank";
32
- };
33
- export type CreateKnowledgeRetrievalSettingsKnowledgeModelType = ClosedEnum<typeof CreateKnowledgeRetrievalSettingsKnowledgeModelType>;
34
- export type CreateKnowledgeRetrievalSettingsKnowledgeModelParameters = {
13
+ /**
14
+ * The retrieval type to use for the knowledge base. If not provided, Hybrid Search will be used as a default query strategy.
15
+ */
16
+ export type RetrievalType = ClosedEnum<typeof RetrievalType>;
17
+ /**
18
+ * The rerank configuration for the knowledge base. In case the model is provided it will be used to enhance the search precision.
19
+ */
20
+ export type RerankConfig = {
35
21
  /**
36
22
  * The threshold value used to filter the rerank results, only documents with a relevance score greater than the threshold will be returned
37
23
  */
38
- threshold?: number | undefined;
39
- };
40
- export type CreateKnowledgeRetrievalSettingsRerankConfig = {
41
- enabled?: boolean | undefined;
42
- provider?: CreateKnowledgeRetrievalSettingsKnowledgeProvider | undefined;
43
- /**
44
- * The name of the model to use
45
- */
46
- model?: string | undefined;
24
+ rerankThreshold?: number | undefined;
47
25
  /**
48
- * The ID of the model in the database
26
+ * The rerank model to use for the knowledge base.
49
27
  */
50
- modelDbId?: string | undefined;
51
- modelType?: CreateKnowledgeRetrievalSettingsKnowledgeModelType | undefined;
52
- modelParameters?: CreateKnowledgeRetrievalSettingsKnowledgeModelParameters | undefined;
53
- };
54
- export type RetrievalSettings3 = {
55
- type: CreateKnowledgeRetrievalSettingsKnowledgeType;
56
- /**
57
- * Used to filter chunks that are most similar to the query
58
- */
59
- topK?: number | undefined;
60
- /**
61
- * Used to filter chunks that are most similar to the query. A value of `0` will be consider disabled.
62
- */
63
- threshold?: number | undefined;
64
- rerankConfig?: CreateKnowledgeRetrievalSettingsRerankConfig | null | undefined;
65
- };
66
- export declare const CreateKnowledgeRetrievalSettingsType: {
67
- readonly KeywordSearch: "keyword_search";
68
- };
69
- export type CreateKnowledgeRetrievalSettingsType = ClosedEnum<typeof CreateKnowledgeRetrievalSettingsType>;
70
- export declare const CreateKnowledgeRetrievalSettingsProvider: {
71
- readonly Cohere: "cohere";
72
- readonly Openai: "openai";
73
- readonly Anthropic: "anthropic";
74
- readonly Huggingface: "huggingface";
75
- readonly Replicate: "replicate";
76
- readonly Google: "google";
77
- readonly GoogleAi: "google-ai";
78
- readonly Azure: "azure";
79
- readonly Aws: "aws";
80
- readonly Anyscale: "anyscale";
81
- readonly Perplexity: "perplexity";
82
- readonly Groq: "groq";
83
- readonly Fal: "fal";
84
- readonly Leonardoai: "leonardoai";
85
- readonly Nvidia: "nvidia";
86
- readonly Jina: "jina";
87
- readonly Togetherai: "togetherai";
88
- readonly Elevenlabs: "elevenlabs";
89
- };
90
- export type CreateKnowledgeRetrievalSettingsProvider = ClosedEnum<typeof CreateKnowledgeRetrievalSettingsProvider>;
91
- export declare const CreateKnowledgeRetrievalSettingsModelType: {
92
- readonly Rerank: "rerank";
93
- };
94
- export type CreateKnowledgeRetrievalSettingsModelType = ClosedEnum<typeof CreateKnowledgeRetrievalSettingsModelType>;
95
- export type CreateKnowledgeRetrievalSettingsModelParameters = {
96
- /**
97
- * The threshold value used to filter the rerank results, only documents with a relevance score greater than the threshold will be returned
98
- */
99
- threshold?: number | undefined;
28
+ rerankModel: string;
100
29
  };
101
- export type RetrievalSettingsRerankConfig = {
102
- enabled?: boolean | undefined;
103
- provider?: CreateKnowledgeRetrievalSettingsProvider | undefined;
104
- /**
105
- * The name of the model to use
106
- */
107
- model?: string | undefined;
30
+ /**
31
+ * The retrieval settings for the knowledge base. If not provider, Hybrid Search will be used as a default query strategy.
32
+ */
33
+ export type RetrievalSettings = {
108
34
  /**
109
- * The ID of the model in the database
35
+ * The retrieval type to use for the knowledge base. If not provided, Hybrid Search will be used as a default query strategy.
110
36
  */
111
- modelDbId?: string | undefined;
112
- modelType?: CreateKnowledgeRetrievalSettingsModelType | undefined;
113
- modelParameters?: CreateKnowledgeRetrievalSettingsModelParameters | undefined;
114
- };
115
- export type RetrievalSettings2 = {
116
- type: CreateKnowledgeRetrievalSettingsType;
37
+ retrievalType?: RetrievalType | undefined;
117
38
  /**
118
- * Used to filter chunks that are most similar to the query
39
+ * The number of results to return from the search.
119
40
  */
120
41
  topK?: number | undefined;
121
42
  /**
122
- * Used to filter chunks that are most similar to the query. A value of `0` will be consider disabled.
43
+ * The threshold value used to filter the search results, only documents with a relevance score greater than the threshold will be returned
123
44
  */
124
45
  threshold?: number | undefined;
125
- rerankConfig?: RetrievalSettingsRerankConfig | null | undefined;
126
- };
127
- export declare const RetrievalSettingsType: {
128
- readonly VectorSearch: "vector_search";
129
- };
130
- export type RetrievalSettingsType = ClosedEnum<typeof RetrievalSettingsType>;
131
- export declare const RetrievalSettingsProvider: {
132
- readonly Cohere: "cohere";
133
- readonly Openai: "openai";
134
- readonly Anthropic: "anthropic";
135
- readonly Huggingface: "huggingface";
136
- readonly Replicate: "replicate";
137
- readonly Google: "google";
138
- readonly GoogleAi: "google-ai";
139
- readonly Azure: "azure";
140
- readonly Aws: "aws";
141
- readonly Anyscale: "anyscale";
142
- readonly Perplexity: "perplexity";
143
- readonly Groq: "groq";
144
- readonly Fal: "fal";
145
- readonly Leonardoai: "leonardoai";
146
- readonly Nvidia: "nvidia";
147
- readonly Jina: "jina";
148
- readonly Togetherai: "togetherai";
149
- readonly Elevenlabs: "elevenlabs";
150
- };
151
- export type RetrievalSettingsProvider = ClosedEnum<typeof RetrievalSettingsProvider>;
152
- export declare const RetrievalSettingsModelType: {
153
- readonly Rerank: "rerank";
154
- };
155
- export type RetrievalSettingsModelType = ClosedEnum<typeof RetrievalSettingsModelType>;
156
- export type RetrievalSettingsModelParameters = {
157
46
  /**
158
- * The threshold value used to filter the rerank results, only documents with a relevance score greater than the threshold will be returned
47
+ * The rerank configuration for the knowledge base. In case the model is provided it will be used to enhance the search precision.
159
48
  */
160
- threshold?: number | undefined;
49
+ rerankConfig?: RerankConfig | undefined;
161
50
  };
162
- export type RerankConfig = {
163
- enabled?: boolean | undefined;
164
- provider?: RetrievalSettingsProvider | undefined;
165
- /**
166
- * The name of the model to use
167
- */
168
- model?: string | undefined;
169
- /**
170
- * The ID of the model in the database
171
- */
172
- modelDbId?: string | undefined;
173
- modelType?: RetrievalSettingsModelType | undefined;
174
- modelParameters?: RetrievalSettingsModelParameters | undefined;
175
- };
176
- export type RetrievalSettings1 = {
177
- type: RetrievalSettingsType;
178
- /**
179
- * Used to filter chunks that are most similar to the query
180
- */
181
- topK?: number | undefined;
182
- /**
183
- * Used to filter chunks that are most similar to the query. A value of `0` will be consider disabled.
184
- */
185
- threshold?: number | undefined;
186
- rerankConfig?: RerankConfig | null | undefined;
187
- };
188
- /**
189
- * The retrieval settings for the knowledge base. If not provider, Hybrid Search will be used as a default query strategy.
190
- */
191
- export type RetrievalSettings = RetrievalSettings1 | RetrievalSettings2 | RetrievalSettings3;
192
51
  export type CreateKnowledgeRequestBody = {
193
52
  key: string;
194
53
  description?: string | undefined;
195
54
  /**
196
- * The embeddings model to use for the knowledge base.
55
+ * 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.
197
56
  */
198
- model: string;
57
+ embeddingModel: string;
199
58
  /**
200
59
  * The retrieval settings for the knowledge base. If not provider, Hybrid Search will be used as a default query strategy.
201
60
  */
202
- retrievalSettings?: RetrievalSettings1 | RetrievalSettings2 | RetrievalSettings3 | undefined;
61
+ retrievalSettings?: RetrievalSettings | undefined;
203
62
  /**
204
63
  * 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.
205
64
  */
206
65
  path: string;
207
66
  };
208
- export type CreateKnowledgeMetadata = {
209
- wordCount?: number | undefined;
210
- documentCount?: number | undefined;
211
- sentencesCount?: number | undefined;
212
- };
213
- export declare const CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONType: {
67
+ /**
68
+ * The retrieval type to use for the knowledge base. If not provided, Hybrid Search will be used as a default query strategy.
69
+ */
70
+ export declare const CreateKnowledgeRetrievalType: {
71
+ readonly VectorSearch: "vector_search";
72
+ readonly KeywordSearch: "keyword_search";
214
73
  readonly HybridSearch: "hybrid_search";
215
74
  };
216
- export type CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONType = ClosedEnum<typeof CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONType>;
217
- export declare const CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONProvider: {
218
- readonly Cohere: "cohere";
219
- readonly Openai: "openai";
220
- readonly Anthropic: "anthropic";
221
- readonly Huggingface: "huggingface";
222
- readonly Replicate: "replicate";
223
- readonly Google: "google";
224
- readonly GoogleAi: "google-ai";
225
- readonly Azure: "azure";
226
- readonly Aws: "aws";
227
- readonly Anyscale: "anyscale";
228
- readonly Perplexity: "perplexity";
229
- readonly Groq: "groq";
230
- readonly Fal: "fal";
231
- readonly Leonardoai: "leonardoai";
232
- readonly Nvidia: "nvidia";
233
- readonly Jina: "jina";
234
- readonly Togetherai: "togetherai";
235
- readonly Elevenlabs: "elevenlabs";
236
- };
237
- export type CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONProvider = ClosedEnum<typeof CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONProvider>;
238
- export declare const CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONModelType: {
239
- readonly Rerank: "rerank";
240
- };
241
- export type CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONModelType = ClosedEnum<typeof CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONModelType>;
242
- export type CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONModelParameters = {
75
+ /**
76
+ * The retrieval type to use for the knowledge base. If not provided, Hybrid Search will be used as a default query strategy.
77
+ */
78
+ export type CreateKnowledgeRetrievalType = ClosedEnum<typeof CreateKnowledgeRetrievalType>;
79
+ /**
80
+ * The rerank configuration for the knowledge base. In case the model is provided it will be used to enhance the search precision.
81
+ */
82
+ export type CreateKnowledgeRerankConfig = {
243
83
  /**
244
84
  * The threshold value used to filter the rerank results, only documents with a relevance score greater than the threshold will be returned
245
85
  */
246
- threshold?: number | undefined;
247
- };
248
- export type CreateKnowledgeRetrievalSettingsKnowledgeResponse200RerankConfig = {
249
- enabled?: boolean | undefined;
250
- provider?: CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONProvider | undefined;
251
- /**
252
- * The name of the model to use
253
- */
254
- model?: string | undefined;
86
+ rerankThreshold?: number | undefined;
255
87
  /**
256
- * The ID of the model in the database
88
+ * The rerank model to use for the knowledge base.
257
89
  */
258
- modelDbId?: string | undefined;
259
- modelType?: CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONModelType | undefined;
260
- modelParameters?: CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONModelParameters | undefined;
261
- /**
262
- * The id of the resource
263
- */
264
- integrationId?: string | null | undefined;
265
- };
266
- export type CreateKnowledgeRetrievalSettings3 = {
267
- type: CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONType;
268
- /**
269
- * Used to filter chunks that are most similar to the query
270
- */
271
- topK?: number | undefined;
272
- /**
273
- * Used to filter chunks that are most similar to the query. A value of `0` will be consider disabled.
274
- */
275
- threshold?: number | undefined;
276
- rerankConfig?: CreateKnowledgeRetrievalSettingsKnowledgeResponse200RerankConfig | null | undefined;
90
+ rerankModel: string;
277
91
  };
278
- export declare const CreateKnowledgeRetrievalSettingsKnowledgeResponse200Type: {
279
- readonly KeywordSearch: "keyword_search";
280
- };
281
- export type CreateKnowledgeRetrievalSettingsKnowledgeResponse200Type = ClosedEnum<typeof CreateKnowledgeRetrievalSettingsKnowledgeResponse200Type>;
282
- export declare const CreateKnowledgeRetrievalSettingsKnowledgeResponse200Provider: {
283
- readonly Cohere: "cohere";
284
- readonly Openai: "openai";
285
- readonly Anthropic: "anthropic";
286
- readonly Huggingface: "huggingface";
287
- readonly Replicate: "replicate";
288
- readonly Google: "google";
289
- readonly GoogleAi: "google-ai";
290
- readonly Azure: "azure";
291
- readonly Aws: "aws";
292
- readonly Anyscale: "anyscale";
293
- readonly Perplexity: "perplexity";
294
- readonly Groq: "groq";
295
- readonly Fal: "fal";
296
- readonly Leonardoai: "leonardoai";
297
- readonly Nvidia: "nvidia";
298
- readonly Jina: "jina";
299
- readonly Togetherai: "togetherai";
300
- readonly Elevenlabs: "elevenlabs";
301
- };
302
- export type CreateKnowledgeRetrievalSettingsKnowledgeResponse200Provider = ClosedEnum<typeof CreateKnowledgeRetrievalSettingsKnowledgeResponse200Provider>;
303
- export declare const CreateKnowledgeRetrievalSettingsKnowledgeResponse200ModelType: {
304
- readonly Rerank: "rerank";
305
- };
306
- export type CreateKnowledgeRetrievalSettingsKnowledgeResponse200ModelType = ClosedEnum<typeof CreateKnowledgeRetrievalSettingsKnowledgeResponse200ModelType>;
307
- export type CreateKnowledgeRetrievalSettingsKnowledgeResponse200ModelParameters = {
308
- /**
309
- * The threshold value used to filter the rerank results, only documents with a relevance score greater than the threshold will be returned
310
- */
311
- threshold?: number | undefined;
312
- };
313
- export type CreateKnowledgeRetrievalSettingsKnowledgeResponseRerankConfig = {
314
- enabled?: boolean | undefined;
315
- provider?: CreateKnowledgeRetrievalSettingsKnowledgeResponse200Provider | undefined;
316
- /**
317
- * The name of the model to use
318
- */
319
- model?: string | undefined;
320
- /**
321
- * The ID of the model in the database
322
- */
323
- modelDbId?: string | undefined;
324
- modelType?: CreateKnowledgeRetrievalSettingsKnowledgeResponse200ModelType | undefined;
325
- modelParameters?: CreateKnowledgeRetrievalSettingsKnowledgeResponse200ModelParameters | undefined;
92
+ /**
93
+ * The retrieval settings for the knowledge base. If not provider, Hybrid Search will be used as a default query strategy.
94
+ */
95
+ export type CreateKnowledgeRetrievalSettings = {
326
96
  /**
327
- * The id of the resource
97
+ * The retrieval type to use for the knowledge base. If not provided, Hybrid Search will be used as a default query strategy.
328
98
  */
329
- integrationId?: string | null | undefined;
330
- };
331
- export type CreateKnowledgeRetrievalSettings2 = {
332
- type: CreateKnowledgeRetrievalSettingsKnowledgeResponse200Type;
99
+ retrievalType?: CreateKnowledgeRetrievalType | undefined;
333
100
  /**
334
- * Used to filter chunks that are most similar to the query
101
+ * The number of results to return from the search.
335
102
  */
336
103
  topK?: number | undefined;
337
104
  /**
338
- * Used to filter chunks that are most similar to the query. A value of `0` will be consider disabled.
339
- */
340
- threshold?: number | undefined;
341
- rerankConfig?: CreateKnowledgeRetrievalSettingsKnowledgeResponseRerankConfig | null | undefined;
342
- };
343
- export declare const CreateKnowledgeRetrievalSettingsKnowledgeResponseType: {
344
- readonly VectorSearch: "vector_search";
345
- };
346
- export type CreateKnowledgeRetrievalSettingsKnowledgeResponseType = ClosedEnum<typeof CreateKnowledgeRetrievalSettingsKnowledgeResponseType>;
347
- export declare const CreateKnowledgeRetrievalSettingsKnowledgeResponseProvider: {
348
- readonly Cohere: "cohere";
349
- readonly Openai: "openai";
350
- readonly Anthropic: "anthropic";
351
- readonly Huggingface: "huggingface";
352
- readonly Replicate: "replicate";
353
- readonly Google: "google";
354
- readonly GoogleAi: "google-ai";
355
- readonly Azure: "azure";
356
- readonly Aws: "aws";
357
- readonly Anyscale: "anyscale";
358
- readonly Perplexity: "perplexity";
359
- readonly Groq: "groq";
360
- readonly Fal: "fal";
361
- readonly Leonardoai: "leonardoai";
362
- readonly Nvidia: "nvidia";
363
- readonly Jina: "jina";
364
- readonly Togetherai: "togetherai";
365
- readonly Elevenlabs: "elevenlabs";
366
- };
367
- export type CreateKnowledgeRetrievalSettingsKnowledgeResponseProvider = ClosedEnum<typeof CreateKnowledgeRetrievalSettingsKnowledgeResponseProvider>;
368
- export declare const CreateKnowledgeRetrievalSettingsKnowledgeResponseModelType: {
369
- readonly Rerank: "rerank";
370
- };
371
- export type CreateKnowledgeRetrievalSettingsKnowledgeResponseModelType = ClosedEnum<typeof CreateKnowledgeRetrievalSettingsKnowledgeResponseModelType>;
372
- export type CreateKnowledgeRetrievalSettingsKnowledgeResponseModelParameters = {
373
- /**
374
- * The threshold value used to filter the rerank results, only documents with a relevance score greater than the threshold will be returned
105
+ * The threshold value used to filter the search results, only documents with a relevance score greater than the threshold will be returned
375
106
  */
376
107
  threshold?: number | undefined;
377
- };
378
- export type CreateKnowledgeRetrievalSettingsKnowledgeRerankConfig = {
379
- enabled?: boolean | undefined;
380
- provider?: CreateKnowledgeRetrievalSettingsKnowledgeResponseProvider | undefined;
381
- /**
382
- * The name of the model to use
383
- */
384
- model?: string | undefined;
385
- /**
386
- * The ID of the model in the database
387
- */
388
- modelDbId?: string | undefined;
389
- modelType?: CreateKnowledgeRetrievalSettingsKnowledgeResponseModelType | undefined;
390
- modelParameters?: CreateKnowledgeRetrievalSettingsKnowledgeResponseModelParameters | undefined;
391
- /**
392
- * The id of the resource
393
- */
394
- integrationId?: string | null | undefined;
395
- };
396
- export type CreateKnowledgeRetrievalSettings1 = {
397
- type: CreateKnowledgeRetrievalSettingsKnowledgeResponseType;
398
- /**
399
- * Used to filter chunks that are most similar to the query
400
- */
401
- topK?: number | undefined;
402
108
  /**
403
- * Used to filter chunks that are most similar to the query. A value of `0` will be consider disabled.
109
+ * The rerank configuration for the knowledge base. In case the model is provided it will be used to enhance the search precision.
404
110
  */
405
- threshold?: number | undefined;
406
- rerankConfig?: CreateKnowledgeRetrievalSettingsKnowledgeRerankConfig | null | undefined;
111
+ rerankConfig?: CreateKnowledgeRerankConfig | undefined;
407
112
  };
408
- export type CreateKnowledgeRetrievalSettings = CreateKnowledgeRetrievalSettings1 | CreateKnowledgeRetrievalSettings2 | CreateKnowledgeRetrievalSettings3;
409
113
  /**
410
114
  * Knowledge Base object
411
115
  */
@@ -430,7 +134,6 @@ export type CreateKnowledgeResponseBody = {
430
134
  * The unique key of the knowledge base.
431
135
  */
432
136
  key: string;
433
- metadata: CreateKnowledgeMetadata;
434
137
  /**
435
138
  * The embeddings model used for the knowledge base.
436
139
  */
@@ -439,7 +142,10 @@ export type CreateKnowledgeResponseBody = {
439
142
  * 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.
440
143
  */
441
144
  path?: string | undefined;
442
- retrievalSettings: CreateKnowledgeRetrievalSettings1 | CreateKnowledgeRetrievalSettings2 | CreateKnowledgeRetrievalSettings3;
145
+ /**
146
+ * The retrieval settings for the knowledge base. If not provider, Hybrid Search will be used as a default query strategy.
147
+ */
148
+ retrievalSettings?: CreateKnowledgeRetrievalSettings | undefined;
443
149
  /**
444
150
  * The id of the resource
445
151
  */
@@ -450,449 +156,33 @@ export type CreateKnowledgeResponseBody = {
450
156
  updated: string;
451
157
  };
452
158
  /** @internal */
453
- export declare const CreateKnowledgeRetrievalSettingsKnowledgeType$inboundSchema: z.ZodNativeEnum<typeof CreateKnowledgeRetrievalSettingsKnowledgeType>;
159
+ export declare const RetrievalType$inboundSchema: z.ZodNativeEnum<typeof RetrievalType>;
454
160
  /** @internal */
455
- export declare const CreateKnowledgeRetrievalSettingsKnowledgeType$outboundSchema: z.ZodNativeEnum<typeof CreateKnowledgeRetrievalSettingsKnowledgeType>;
161
+ export declare const RetrievalType$outboundSchema: z.ZodNativeEnum<typeof RetrievalType>;
456
162
  /**
457
163
  * @internal
458
164
  * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
459
165
  */
460
- export declare namespace CreateKnowledgeRetrievalSettingsKnowledgeType$ {
461
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeType$inboundSchema` instead. */
462
- const inboundSchema: z.ZodNativeEnum<{
463
- readonly HybridSearch: "hybrid_search";
464
- }>;
465
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeType$outboundSchema` instead. */
466
- const outboundSchema: z.ZodNativeEnum<{
467
- readonly HybridSearch: "hybrid_search";
468
- }>;
469
- }
470
- /** @internal */
471
- export declare const CreateKnowledgeRetrievalSettingsKnowledgeProvider$inboundSchema: z.ZodNativeEnum<typeof CreateKnowledgeRetrievalSettingsKnowledgeProvider>;
472
- /** @internal */
473
- export declare const CreateKnowledgeRetrievalSettingsKnowledgeProvider$outboundSchema: z.ZodNativeEnum<typeof CreateKnowledgeRetrievalSettingsKnowledgeProvider>;
474
- /**
475
- * @internal
476
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
477
- */
478
- export declare namespace CreateKnowledgeRetrievalSettingsKnowledgeProvider$ {
479
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeProvider$inboundSchema` instead. */
480
- const inboundSchema: z.ZodNativeEnum<{
481
- readonly Cohere: "cohere";
482
- readonly Openai: "openai";
483
- readonly Anthropic: "anthropic";
484
- readonly Huggingface: "huggingface";
485
- readonly Replicate: "replicate";
486
- readonly Google: "google";
487
- readonly GoogleAi: "google-ai";
488
- readonly Azure: "azure";
489
- readonly Aws: "aws";
490
- readonly Anyscale: "anyscale";
491
- readonly Perplexity: "perplexity";
492
- readonly Groq: "groq";
493
- readonly Fal: "fal";
494
- readonly Leonardoai: "leonardoai";
495
- readonly Nvidia: "nvidia";
496
- readonly Jina: "jina";
497
- readonly Togetherai: "togetherai";
498
- readonly Elevenlabs: "elevenlabs";
499
- }>;
500
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeProvider$outboundSchema` instead. */
501
- const outboundSchema: z.ZodNativeEnum<{
502
- readonly Cohere: "cohere";
503
- readonly Openai: "openai";
504
- readonly Anthropic: "anthropic";
505
- readonly Huggingface: "huggingface";
506
- readonly Replicate: "replicate";
507
- readonly Google: "google";
508
- readonly GoogleAi: "google-ai";
509
- readonly Azure: "azure";
510
- readonly Aws: "aws";
511
- readonly Anyscale: "anyscale";
512
- readonly Perplexity: "perplexity";
513
- readonly Groq: "groq";
514
- readonly Fal: "fal";
515
- readonly Leonardoai: "leonardoai";
516
- readonly Nvidia: "nvidia";
517
- readonly Jina: "jina";
518
- readonly Togetherai: "togetherai";
519
- readonly Elevenlabs: "elevenlabs";
520
- }>;
521
- }
522
- /** @internal */
523
- export declare const CreateKnowledgeRetrievalSettingsKnowledgeModelType$inboundSchema: z.ZodNativeEnum<typeof CreateKnowledgeRetrievalSettingsKnowledgeModelType>;
524
- /** @internal */
525
- export declare const CreateKnowledgeRetrievalSettingsKnowledgeModelType$outboundSchema: z.ZodNativeEnum<typeof CreateKnowledgeRetrievalSettingsKnowledgeModelType>;
526
- /**
527
- * @internal
528
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
529
- */
530
- export declare namespace CreateKnowledgeRetrievalSettingsKnowledgeModelType$ {
531
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeModelType$inboundSchema` instead. */
532
- const inboundSchema: z.ZodNativeEnum<{
533
- readonly Rerank: "rerank";
534
- }>;
535
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeModelType$outboundSchema` instead. */
536
- const outboundSchema: z.ZodNativeEnum<{
537
- readonly Rerank: "rerank";
538
- }>;
539
- }
540
- /** @internal */
541
- export declare const CreateKnowledgeRetrievalSettingsKnowledgeModelParameters$inboundSchema: z.ZodType<CreateKnowledgeRetrievalSettingsKnowledgeModelParameters, z.ZodTypeDef, unknown>;
542
- /** @internal */
543
- export type CreateKnowledgeRetrievalSettingsKnowledgeModelParameters$Outbound = {
544
- threshold?: number | undefined;
545
- };
546
- /** @internal */
547
- export declare const CreateKnowledgeRetrievalSettingsKnowledgeModelParameters$outboundSchema: z.ZodType<CreateKnowledgeRetrievalSettingsKnowledgeModelParameters$Outbound, z.ZodTypeDef, CreateKnowledgeRetrievalSettingsKnowledgeModelParameters>;
548
- /**
549
- * @internal
550
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
551
- */
552
- export declare namespace CreateKnowledgeRetrievalSettingsKnowledgeModelParameters$ {
553
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeModelParameters$inboundSchema` instead. */
554
- const inboundSchema: z.ZodType<CreateKnowledgeRetrievalSettingsKnowledgeModelParameters, z.ZodTypeDef, unknown>;
555
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeModelParameters$outboundSchema` instead. */
556
- const outboundSchema: z.ZodType<CreateKnowledgeRetrievalSettingsKnowledgeModelParameters$Outbound, z.ZodTypeDef, CreateKnowledgeRetrievalSettingsKnowledgeModelParameters>;
557
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeModelParameters$Outbound` instead. */
558
- type Outbound = CreateKnowledgeRetrievalSettingsKnowledgeModelParameters$Outbound;
559
- }
560
- export declare function createKnowledgeRetrievalSettingsKnowledgeModelParametersToJSON(createKnowledgeRetrievalSettingsKnowledgeModelParameters: CreateKnowledgeRetrievalSettingsKnowledgeModelParameters): string;
561
- export declare function createKnowledgeRetrievalSettingsKnowledgeModelParametersFromJSON(jsonString: string): SafeParseResult<CreateKnowledgeRetrievalSettingsKnowledgeModelParameters, SDKValidationError>;
562
- /** @internal */
563
- export declare const CreateKnowledgeRetrievalSettingsRerankConfig$inboundSchema: z.ZodType<CreateKnowledgeRetrievalSettingsRerankConfig, z.ZodTypeDef, unknown>;
564
- /** @internal */
565
- export type CreateKnowledgeRetrievalSettingsRerankConfig$Outbound = {
566
- enabled?: boolean | undefined;
567
- provider?: string | undefined;
568
- model?: string | undefined;
569
- model_db_id?: string | undefined;
570
- model_type?: string | undefined;
571
- model_parameters?: CreateKnowledgeRetrievalSettingsKnowledgeModelParameters$Outbound | undefined;
572
- };
573
- /** @internal */
574
- export declare const CreateKnowledgeRetrievalSettingsRerankConfig$outboundSchema: z.ZodType<CreateKnowledgeRetrievalSettingsRerankConfig$Outbound, z.ZodTypeDef, CreateKnowledgeRetrievalSettingsRerankConfig>;
575
- /**
576
- * @internal
577
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
578
- */
579
- export declare namespace CreateKnowledgeRetrievalSettingsRerankConfig$ {
580
- /** @deprecated use `CreateKnowledgeRetrievalSettingsRerankConfig$inboundSchema` instead. */
581
- const inboundSchema: z.ZodType<CreateKnowledgeRetrievalSettingsRerankConfig, z.ZodTypeDef, unknown>;
582
- /** @deprecated use `CreateKnowledgeRetrievalSettingsRerankConfig$outboundSchema` instead. */
583
- const outboundSchema: z.ZodType<CreateKnowledgeRetrievalSettingsRerankConfig$Outbound, z.ZodTypeDef, CreateKnowledgeRetrievalSettingsRerankConfig>;
584
- /** @deprecated use `CreateKnowledgeRetrievalSettingsRerankConfig$Outbound` instead. */
585
- type Outbound = CreateKnowledgeRetrievalSettingsRerankConfig$Outbound;
586
- }
587
- export declare function createKnowledgeRetrievalSettingsRerankConfigToJSON(createKnowledgeRetrievalSettingsRerankConfig: CreateKnowledgeRetrievalSettingsRerankConfig): string;
588
- export declare function createKnowledgeRetrievalSettingsRerankConfigFromJSON(jsonString: string): SafeParseResult<CreateKnowledgeRetrievalSettingsRerankConfig, SDKValidationError>;
589
- /** @internal */
590
- export declare const RetrievalSettings3$inboundSchema: z.ZodType<RetrievalSettings3, z.ZodTypeDef, unknown>;
591
- /** @internal */
592
- export type RetrievalSettings3$Outbound = {
593
- type: string;
594
- top_k: number;
595
- threshold: number;
596
- rerank_config?: CreateKnowledgeRetrievalSettingsRerankConfig$Outbound | null | undefined;
597
- };
598
- /** @internal */
599
- export declare const RetrievalSettings3$outboundSchema: z.ZodType<RetrievalSettings3$Outbound, z.ZodTypeDef, RetrievalSettings3>;
600
- /**
601
- * @internal
602
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
603
- */
604
- export declare namespace RetrievalSettings3$ {
605
- /** @deprecated use `RetrievalSettings3$inboundSchema` instead. */
606
- const inboundSchema: z.ZodType<RetrievalSettings3, z.ZodTypeDef, unknown>;
607
- /** @deprecated use `RetrievalSettings3$outboundSchema` instead. */
608
- const outboundSchema: z.ZodType<RetrievalSettings3$Outbound, z.ZodTypeDef, RetrievalSettings3>;
609
- /** @deprecated use `RetrievalSettings3$Outbound` instead. */
610
- type Outbound = RetrievalSettings3$Outbound;
611
- }
612
- export declare function retrievalSettings3ToJSON(retrievalSettings3: RetrievalSettings3): string;
613
- export declare function retrievalSettings3FromJSON(jsonString: string): SafeParseResult<RetrievalSettings3, SDKValidationError>;
614
- /** @internal */
615
- export declare const CreateKnowledgeRetrievalSettingsType$inboundSchema: z.ZodNativeEnum<typeof CreateKnowledgeRetrievalSettingsType>;
616
- /** @internal */
617
- export declare const CreateKnowledgeRetrievalSettingsType$outboundSchema: z.ZodNativeEnum<typeof CreateKnowledgeRetrievalSettingsType>;
618
- /**
619
- * @internal
620
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
621
- */
622
- export declare namespace CreateKnowledgeRetrievalSettingsType$ {
623
- /** @deprecated use `CreateKnowledgeRetrievalSettingsType$inboundSchema` instead. */
624
- const inboundSchema: z.ZodNativeEnum<{
625
- readonly KeywordSearch: "keyword_search";
626
- }>;
627
- /** @deprecated use `CreateKnowledgeRetrievalSettingsType$outboundSchema` instead. */
628
- const outboundSchema: z.ZodNativeEnum<{
629
- readonly KeywordSearch: "keyword_search";
630
- }>;
631
- }
632
- /** @internal */
633
- export declare const CreateKnowledgeRetrievalSettingsProvider$inboundSchema: z.ZodNativeEnum<typeof CreateKnowledgeRetrievalSettingsProvider>;
634
- /** @internal */
635
- export declare const CreateKnowledgeRetrievalSettingsProvider$outboundSchema: z.ZodNativeEnum<typeof CreateKnowledgeRetrievalSettingsProvider>;
636
- /**
637
- * @internal
638
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
639
- */
640
- export declare namespace CreateKnowledgeRetrievalSettingsProvider$ {
641
- /** @deprecated use `CreateKnowledgeRetrievalSettingsProvider$inboundSchema` instead. */
642
- const inboundSchema: z.ZodNativeEnum<{
643
- readonly Cohere: "cohere";
644
- readonly Openai: "openai";
645
- readonly Anthropic: "anthropic";
646
- readonly Huggingface: "huggingface";
647
- readonly Replicate: "replicate";
648
- readonly Google: "google";
649
- readonly GoogleAi: "google-ai";
650
- readonly Azure: "azure";
651
- readonly Aws: "aws";
652
- readonly Anyscale: "anyscale";
653
- readonly Perplexity: "perplexity";
654
- readonly Groq: "groq";
655
- readonly Fal: "fal";
656
- readonly Leonardoai: "leonardoai";
657
- readonly Nvidia: "nvidia";
658
- readonly Jina: "jina";
659
- readonly Togetherai: "togetherai";
660
- readonly Elevenlabs: "elevenlabs";
661
- }>;
662
- /** @deprecated use `CreateKnowledgeRetrievalSettingsProvider$outboundSchema` instead. */
663
- const outboundSchema: z.ZodNativeEnum<{
664
- readonly Cohere: "cohere";
665
- readonly Openai: "openai";
666
- readonly Anthropic: "anthropic";
667
- readonly Huggingface: "huggingface";
668
- readonly Replicate: "replicate";
669
- readonly Google: "google";
670
- readonly GoogleAi: "google-ai";
671
- readonly Azure: "azure";
672
- readonly Aws: "aws";
673
- readonly Anyscale: "anyscale";
674
- readonly Perplexity: "perplexity";
675
- readonly Groq: "groq";
676
- readonly Fal: "fal";
677
- readonly Leonardoai: "leonardoai";
678
- readonly Nvidia: "nvidia";
679
- readonly Jina: "jina";
680
- readonly Togetherai: "togetherai";
681
- readonly Elevenlabs: "elevenlabs";
682
- }>;
683
- }
684
- /** @internal */
685
- export declare const CreateKnowledgeRetrievalSettingsModelType$inboundSchema: z.ZodNativeEnum<typeof CreateKnowledgeRetrievalSettingsModelType>;
686
- /** @internal */
687
- export declare const CreateKnowledgeRetrievalSettingsModelType$outboundSchema: z.ZodNativeEnum<typeof CreateKnowledgeRetrievalSettingsModelType>;
688
- /**
689
- * @internal
690
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
691
- */
692
- export declare namespace CreateKnowledgeRetrievalSettingsModelType$ {
693
- /** @deprecated use `CreateKnowledgeRetrievalSettingsModelType$inboundSchema` instead. */
694
- const inboundSchema: z.ZodNativeEnum<{
695
- readonly Rerank: "rerank";
696
- }>;
697
- /** @deprecated use `CreateKnowledgeRetrievalSettingsModelType$outboundSchema` instead. */
698
- const outboundSchema: z.ZodNativeEnum<{
699
- readonly Rerank: "rerank";
700
- }>;
701
- }
702
- /** @internal */
703
- export declare const CreateKnowledgeRetrievalSettingsModelParameters$inboundSchema: z.ZodType<CreateKnowledgeRetrievalSettingsModelParameters, z.ZodTypeDef, unknown>;
704
- /** @internal */
705
- export type CreateKnowledgeRetrievalSettingsModelParameters$Outbound = {
706
- threshold?: number | undefined;
707
- };
708
- /** @internal */
709
- export declare const CreateKnowledgeRetrievalSettingsModelParameters$outboundSchema: z.ZodType<CreateKnowledgeRetrievalSettingsModelParameters$Outbound, z.ZodTypeDef, CreateKnowledgeRetrievalSettingsModelParameters>;
710
- /**
711
- * @internal
712
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
713
- */
714
- export declare namespace CreateKnowledgeRetrievalSettingsModelParameters$ {
715
- /** @deprecated use `CreateKnowledgeRetrievalSettingsModelParameters$inboundSchema` instead. */
716
- const inboundSchema: z.ZodType<CreateKnowledgeRetrievalSettingsModelParameters, z.ZodTypeDef, unknown>;
717
- /** @deprecated use `CreateKnowledgeRetrievalSettingsModelParameters$outboundSchema` instead. */
718
- const outboundSchema: z.ZodType<CreateKnowledgeRetrievalSettingsModelParameters$Outbound, z.ZodTypeDef, CreateKnowledgeRetrievalSettingsModelParameters>;
719
- /** @deprecated use `CreateKnowledgeRetrievalSettingsModelParameters$Outbound` instead. */
720
- type Outbound = CreateKnowledgeRetrievalSettingsModelParameters$Outbound;
721
- }
722
- export declare function createKnowledgeRetrievalSettingsModelParametersToJSON(createKnowledgeRetrievalSettingsModelParameters: CreateKnowledgeRetrievalSettingsModelParameters): string;
723
- export declare function createKnowledgeRetrievalSettingsModelParametersFromJSON(jsonString: string): SafeParseResult<CreateKnowledgeRetrievalSettingsModelParameters, SDKValidationError>;
724
- /** @internal */
725
- export declare const RetrievalSettingsRerankConfig$inboundSchema: z.ZodType<RetrievalSettingsRerankConfig, z.ZodTypeDef, unknown>;
726
- /** @internal */
727
- export type RetrievalSettingsRerankConfig$Outbound = {
728
- enabled?: boolean | undefined;
729
- provider?: string | undefined;
730
- model?: string | undefined;
731
- model_db_id?: string | undefined;
732
- model_type?: string | undefined;
733
- model_parameters?: CreateKnowledgeRetrievalSettingsModelParameters$Outbound | undefined;
734
- };
735
- /** @internal */
736
- export declare const RetrievalSettingsRerankConfig$outboundSchema: z.ZodType<RetrievalSettingsRerankConfig$Outbound, z.ZodTypeDef, RetrievalSettingsRerankConfig>;
737
- /**
738
- * @internal
739
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
740
- */
741
- export declare namespace RetrievalSettingsRerankConfig$ {
742
- /** @deprecated use `RetrievalSettingsRerankConfig$inboundSchema` instead. */
743
- const inboundSchema: z.ZodType<RetrievalSettingsRerankConfig, z.ZodTypeDef, unknown>;
744
- /** @deprecated use `RetrievalSettingsRerankConfig$outboundSchema` instead. */
745
- const outboundSchema: z.ZodType<RetrievalSettingsRerankConfig$Outbound, z.ZodTypeDef, RetrievalSettingsRerankConfig>;
746
- /** @deprecated use `RetrievalSettingsRerankConfig$Outbound` instead. */
747
- type Outbound = RetrievalSettingsRerankConfig$Outbound;
748
- }
749
- export declare function retrievalSettingsRerankConfigToJSON(retrievalSettingsRerankConfig: RetrievalSettingsRerankConfig): string;
750
- export declare function retrievalSettingsRerankConfigFromJSON(jsonString: string): SafeParseResult<RetrievalSettingsRerankConfig, SDKValidationError>;
751
- /** @internal */
752
- export declare const RetrievalSettings2$inboundSchema: z.ZodType<RetrievalSettings2, z.ZodTypeDef, unknown>;
753
- /** @internal */
754
- export type RetrievalSettings2$Outbound = {
755
- type: string;
756
- top_k: number;
757
- threshold: number;
758
- rerank_config?: RetrievalSettingsRerankConfig$Outbound | null | undefined;
759
- };
760
- /** @internal */
761
- export declare const RetrievalSettings2$outboundSchema: z.ZodType<RetrievalSettings2$Outbound, z.ZodTypeDef, RetrievalSettings2>;
762
- /**
763
- * @internal
764
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
765
- */
766
- export declare namespace RetrievalSettings2$ {
767
- /** @deprecated use `RetrievalSettings2$inboundSchema` instead. */
768
- const inboundSchema: z.ZodType<RetrievalSettings2, z.ZodTypeDef, unknown>;
769
- /** @deprecated use `RetrievalSettings2$outboundSchema` instead. */
770
- const outboundSchema: z.ZodType<RetrievalSettings2$Outbound, z.ZodTypeDef, RetrievalSettings2>;
771
- /** @deprecated use `RetrievalSettings2$Outbound` instead. */
772
- type Outbound = RetrievalSettings2$Outbound;
773
- }
774
- export declare function retrievalSettings2ToJSON(retrievalSettings2: RetrievalSettings2): string;
775
- export declare function retrievalSettings2FromJSON(jsonString: string): SafeParseResult<RetrievalSettings2, SDKValidationError>;
776
- /** @internal */
777
- export declare const RetrievalSettingsType$inboundSchema: z.ZodNativeEnum<typeof RetrievalSettingsType>;
778
- /** @internal */
779
- export declare const RetrievalSettingsType$outboundSchema: z.ZodNativeEnum<typeof RetrievalSettingsType>;
780
- /**
781
- * @internal
782
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
783
- */
784
- export declare namespace RetrievalSettingsType$ {
785
- /** @deprecated use `RetrievalSettingsType$inboundSchema` instead. */
166
+ export declare namespace RetrievalType$ {
167
+ /** @deprecated use `RetrievalType$inboundSchema` instead. */
786
168
  const inboundSchema: z.ZodNativeEnum<{
787
169
  readonly VectorSearch: "vector_search";
170
+ readonly KeywordSearch: "keyword_search";
171
+ readonly HybridSearch: "hybrid_search";
788
172
  }>;
789
- /** @deprecated use `RetrievalSettingsType$outboundSchema` instead. */
173
+ /** @deprecated use `RetrievalType$outboundSchema` instead. */
790
174
  const outboundSchema: z.ZodNativeEnum<{
791
175
  readonly VectorSearch: "vector_search";
176
+ readonly KeywordSearch: "keyword_search";
177
+ readonly HybridSearch: "hybrid_search";
792
178
  }>;
793
179
  }
794
180
  /** @internal */
795
- export declare const RetrievalSettingsProvider$inboundSchema: z.ZodNativeEnum<typeof RetrievalSettingsProvider>;
796
- /** @internal */
797
- export declare const RetrievalSettingsProvider$outboundSchema: z.ZodNativeEnum<typeof RetrievalSettingsProvider>;
798
- /**
799
- * @internal
800
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
801
- */
802
- export declare namespace RetrievalSettingsProvider$ {
803
- /** @deprecated use `RetrievalSettingsProvider$inboundSchema` instead. */
804
- const inboundSchema: z.ZodNativeEnum<{
805
- readonly Cohere: "cohere";
806
- readonly Openai: "openai";
807
- readonly Anthropic: "anthropic";
808
- readonly Huggingface: "huggingface";
809
- readonly Replicate: "replicate";
810
- readonly Google: "google";
811
- readonly GoogleAi: "google-ai";
812
- readonly Azure: "azure";
813
- readonly Aws: "aws";
814
- readonly Anyscale: "anyscale";
815
- readonly Perplexity: "perplexity";
816
- readonly Groq: "groq";
817
- readonly Fal: "fal";
818
- readonly Leonardoai: "leonardoai";
819
- readonly Nvidia: "nvidia";
820
- readonly Jina: "jina";
821
- readonly Togetherai: "togetherai";
822
- readonly Elevenlabs: "elevenlabs";
823
- }>;
824
- /** @deprecated use `RetrievalSettingsProvider$outboundSchema` instead. */
825
- const outboundSchema: z.ZodNativeEnum<{
826
- readonly Cohere: "cohere";
827
- readonly Openai: "openai";
828
- readonly Anthropic: "anthropic";
829
- readonly Huggingface: "huggingface";
830
- readonly Replicate: "replicate";
831
- readonly Google: "google";
832
- readonly GoogleAi: "google-ai";
833
- readonly Azure: "azure";
834
- readonly Aws: "aws";
835
- readonly Anyscale: "anyscale";
836
- readonly Perplexity: "perplexity";
837
- readonly Groq: "groq";
838
- readonly Fal: "fal";
839
- readonly Leonardoai: "leonardoai";
840
- readonly Nvidia: "nvidia";
841
- readonly Jina: "jina";
842
- readonly Togetherai: "togetherai";
843
- readonly Elevenlabs: "elevenlabs";
844
- }>;
845
- }
846
- /** @internal */
847
- export declare const RetrievalSettingsModelType$inboundSchema: z.ZodNativeEnum<typeof RetrievalSettingsModelType>;
848
- /** @internal */
849
- export declare const RetrievalSettingsModelType$outboundSchema: z.ZodNativeEnum<typeof RetrievalSettingsModelType>;
850
- /**
851
- * @internal
852
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
853
- */
854
- export declare namespace RetrievalSettingsModelType$ {
855
- /** @deprecated use `RetrievalSettingsModelType$inboundSchema` instead. */
856
- const inboundSchema: z.ZodNativeEnum<{
857
- readonly Rerank: "rerank";
858
- }>;
859
- /** @deprecated use `RetrievalSettingsModelType$outboundSchema` instead. */
860
- const outboundSchema: z.ZodNativeEnum<{
861
- readonly Rerank: "rerank";
862
- }>;
863
- }
864
- /** @internal */
865
- export declare const RetrievalSettingsModelParameters$inboundSchema: z.ZodType<RetrievalSettingsModelParameters, z.ZodTypeDef, unknown>;
866
- /** @internal */
867
- export type RetrievalSettingsModelParameters$Outbound = {
868
- threshold?: number | undefined;
869
- };
870
- /** @internal */
871
- export declare const RetrievalSettingsModelParameters$outboundSchema: z.ZodType<RetrievalSettingsModelParameters$Outbound, z.ZodTypeDef, RetrievalSettingsModelParameters>;
872
- /**
873
- * @internal
874
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
875
- */
876
- export declare namespace RetrievalSettingsModelParameters$ {
877
- /** @deprecated use `RetrievalSettingsModelParameters$inboundSchema` instead. */
878
- const inboundSchema: z.ZodType<RetrievalSettingsModelParameters, z.ZodTypeDef, unknown>;
879
- /** @deprecated use `RetrievalSettingsModelParameters$outboundSchema` instead. */
880
- const outboundSchema: z.ZodType<RetrievalSettingsModelParameters$Outbound, z.ZodTypeDef, RetrievalSettingsModelParameters>;
881
- /** @deprecated use `RetrievalSettingsModelParameters$Outbound` instead. */
882
- type Outbound = RetrievalSettingsModelParameters$Outbound;
883
- }
884
- export declare function retrievalSettingsModelParametersToJSON(retrievalSettingsModelParameters: RetrievalSettingsModelParameters): string;
885
- export declare function retrievalSettingsModelParametersFromJSON(jsonString: string): SafeParseResult<RetrievalSettingsModelParameters, SDKValidationError>;
886
- /** @internal */
887
181
  export declare const RerankConfig$inboundSchema: z.ZodType<RerankConfig, z.ZodTypeDef, unknown>;
888
182
  /** @internal */
889
183
  export type RerankConfig$Outbound = {
890
- enabled?: boolean | undefined;
891
- provider?: string | undefined;
892
- model?: string | undefined;
893
- model_db_id?: string | undefined;
894
- model_type?: string | undefined;
895
- model_parameters?: RetrievalSettingsModelParameters$Outbound | undefined;
184
+ rerank_threshold: number;
185
+ rerank_model: string;
896
186
  };
897
187
  /** @internal */
898
188
  export declare const RerankConfig$outboundSchema: z.ZodType<RerankConfig$Outbound, z.ZodTypeDef, RerankConfig>;
@@ -911,35 +201,15 @@ export declare namespace RerankConfig$ {
911
201
  export declare function rerankConfigToJSON(rerankConfig: RerankConfig): string;
912
202
  export declare function rerankConfigFromJSON(jsonString: string): SafeParseResult<RerankConfig, SDKValidationError>;
913
203
  /** @internal */
914
- export declare const RetrievalSettings1$inboundSchema: z.ZodType<RetrievalSettings1, z.ZodTypeDef, unknown>;
204
+ export declare const RetrievalSettings$inboundSchema: z.ZodType<RetrievalSettings, z.ZodTypeDef, unknown>;
915
205
  /** @internal */
916
- export type RetrievalSettings1$Outbound = {
917
- type: string;
206
+ export type RetrievalSettings$Outbound = {
207
+ retrieval_type: string;
918
208
  top_k: number;
919
209
  threshold: number;
920
- rerank_config?: RerankConfig$Outbound | null | undefined;
210
+ rerank_config?: RerankConfig$Outbound | undefined;
921
211
  };
922
212
  /** @internal */
923
- export declare const RetrievalSettings1$outboundSchema: z.ZodType<RetrievalSettings1$Outbound, z.ZodTypeDef, RetrievalSettings1>;
924
- /**
925
- * @internal
926
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
927
- */
928
- export declare namespace RetrievalSettings1$ {
929
- /** @deprecated use `RetrievalSettings1$inboundSchema` instead. */
930
- const inboundSchema: z.ZodType<RetrievalSettings1, z.ZodTypeDef, unknown>;
931
- /** @deprecated use `RetrievalSettings1$outboundSchema` instead. */
932
- const outboundSchema: z.ZodType<RetrievalSettings1$Outbound, z.ZodTypeDef, RetrievalSettings1>;
933
- /** @deprecated use `RetrievalSettings1$Outbound` instead. */
934
- type Outbound = RetrievalSettings1$Outbound;
935
- }
936
- export declare function retrievalSettings1ToJSON(retrievalSettings1: RetrievalSettings1): string;
937
- export declare function retrievalSettings1FromJSON(jsonString: string): SafeParseResult<RetrievalSettings1, SDKValidationError>;
938
- /** @internal */
939
- export declare const RetrievalSettings$inboundSchema: z.ZodType<RetrievalSettings, z.ZodTypeDef, unknown>;
940
- /** @internal */
941
- export type RetrievalSettings$Outbound = RetrievalSettings1$Outbound | RetrievalSettings2$Outbound | RetrievalSettings3$Outbound;
942
- /** @internal */
943
213
  export declare const RetrievalSettings$outboundSchema: z.ZodType<RetrievalSettings$Outbound, z.ZodTypeDef, RetrievalSettings>;
944
214
  /**
945
215
  * @internal
@@ -961,8 +231,8 @@ export declare const CreateKnowledgeRequestBody$inboundSchema: z.ZodType<CreateK
961
231
  export type CreateKnowledgeRequestBody$Outbound = {
962
232
  key: string;
963
233
  description?: string | undefined;
964
- model: string;
965
- retrieval_settings?: RetrievalSettings1$Outbound | RetrievalSettings2$Outbound | RetrievalSettings3$Outbound | undefined;
234
+ embedding_model: string;
235
+ retrieval_settings?: RetrievalSettings$Outbound | undefined;
966
236
  path: string;
967
237
  };
968
238
  /** @internal */
@@ -982,523 +252,60 @@ export declare namespace CreateKnowledgeRequestBody$ {
982
252
  export declare function createKnowledgeRequestBodyToJSON(createKnowledgeRequestBody: CreateKnowledgeRequestBody): string;
983
253
  export declare function createKnowledgeRequestBodyFromJSON(jsonString: string): SafeParseResult<CreateKnowledgeRequestBody, SDKValidationError>;
984
254
  /** @internal */
985
- export declare const CreateKnowledgeMetadata$inboundSchema: z.ZodType<CreateKnowledgeMetadata, z.ZodTypeDef, unknown>;
986
- /** @internal */
987
- export type CreateKnowledgeMetadata$Outbound = {
988
- word_count: number;
989
- document_count: number;
990
- sentences_count: number;
991
- };
255
+ export declare const CreateKnowledgeRetrievalType$inboundSchema: z.ZodNativeEnum<typeof CreateKnowledgeRetrievalType>;
992
256
  /** @internal */
993
- export declare const CreateKnowledgeMetadata$outboundSchema: z.ZodType<CreateKnowledgeMetadata$Outbound, z.ZodTypeDef, CreateKnowledgeMetadata>;
257
+ export declare const CreateKnowledgeRetrievalType$outboundSchema: z.ZodNativeEnum<typeof CreateKnowledgeRetrievalType>;
994
258
  /**
995
259
  * @internal
996
260
  * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
997
261
  */
998
- export declare namespace CreateKnowledgeMetadata$ {
999
- /** @deprecated use `CreateKnowledgeMetadata$inboundSchema` instead. */
1000
- const inboundSchema: z.ZodType<CreateKnowledgeMetadata, z.ZodTypeDef, unknown>;
1001
- /** @deprecated use `CreateKnowledgeMetadata$outboundSchema` instead. */
1002
- const outboundSchema: z.ZodType<CreateKnowledgeMetadata$Outbound, z.ZodTypeDef, CreateKnowledgeMetadata>;
1003
- /** @deprecated use `CreateKnowledgeMetadata$Outbound` instead. */
1004
- type Outbound = CreateKnowledgeMetadata$Outbound;
1005
- }
1006
- export declare function createKnowledgeMetadataToJSON(createKnowledgeMetadata: CreateKnowledgeMetadata): string;
1007
- export declare function createKnowledgeMetadataFromJSON(jsonString: string): SafeParseResult<CreateKnowledgeMetadata, SDKValidationError>;
1008
- /** @internal */
1009
- export declare const CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONType$inboundSchema: z.ZodNativeEnum<typeof CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONType>;
1010
- /** @internal */
1011
- export declare const CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONType$outboundSchema: z.ZodNativeEnum<typeof CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONType>;
1012
- /**
1013
- * @internal
1014
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
1015
- */
1016
- export declare namespace CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONType$ {
1017
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONType$inboundSchema` instead. */
1018
- const inboundSchema: z.ZodNativeEnum<{
1019
- readonly HybridSearch: "hybrid_search";
1020
- }>;
1021
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONType$outboundSchema` instead. */
1022
- const outboundSchema: z.ZodNativeEnum<{
1023
- readonly HybridSearch: "hybrid_search";
1024
- }>;
1025
- }
1026
- /** @internal */
1027
- export declare const CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONProvider$inboundSchema: z.ZodNativeEnum<typeof CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONProvider>;
1028
- /** @internal */
1029
- export declare const CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONProvider$outboundSchema: z.ZodNativeEnum<typeof CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONProvider>;
1030
- /**
1031
- * @internal
1032
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
1033
- */
1034
- export declare namespace CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONProvider$ {
1035
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONProvider$inboundSchema` instead. */
1036
- const inboundSchema: z.ZodNativeEnum<{
1037
- readonly Cohere: "cohere";
1038
- readonly Openai: "openai";
1039
- readonly Anthropic: "anthropic";
1040
- readonly Huggingface: "huggingface";
1041
- readonly Replicate: "replicate";
1042
- readonly Google: "google";
1043
- readonly GoogleAi: "google-ai";
1044
- readonly Azure: "azure";
1045
- readonly Aws: "aws";
1046
- readonly Anyscale: "anyscale";
1047
- readonly Perplexity: "perplexity";
1048
- readonly Groq: "groq";
1049
- readonly Fal: "fal";
1050
- readonly Leonardoai: "leonardoai";
1051
- readonly Nvidia: "nvidia";
1052
- readonly Jina: "jina";
1053
- readonly Togetherai: "togetherai";
1054
- readonly Elevenlabs: "elevenlabs";
1055
- }>;
1056
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONProvider$outboundSchema` instead. */
1057
- const outboundSchema: z.ZodNativeEnum<{
1058
- readonly Cohere: "cohere";
1059
- readonly Openai: "openai";
1060
- readonly Anthropic: "anthropic";
1061
- readonly Huggingface: "huggingface";
1062
- readonly Replicate: "replicate";
1063
- readonly Google: "google";
1064
- readonly GoogleAi: "google-ai";
1065
- readonly Azure: "azure";
1066
- readonly Aws: "aws";
1067
- readonly Anyscale: "anyscale";
1068
- readonly Perplexity: "perplexity";
1069
- readonly Groq: "groq";
1070
- readonly Fal: "fal";
1071
- readonly Leonardoai: "leonardoai";
1072
- readonly Nvidia: "nvidia";
1073
- readonly Jina: "jina";
1074
- readonly Togetherai: "togetherai";
1075
- readonly Elevenlabs: "elevenlabs";
1076
- }>;
1077
- }
1078
- /** @internal */
1079
- export declare const CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONModelType$inboundSchema: z.ZodNativeEnum<typeof CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONModelType>;
1080
- /** @internal */
1081
- export declare const CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONModelType$outboundSchema: z.ZodNativeEnum<typeof CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONModelType>;
1082
- /**
1083
- * @internal
1084
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
1085
- */
1086
- export declare namespace CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONModelType$ {
1087
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONModelType$inboundSchema` instead. */
1088
- const inboundSchema: z.ZodNativeEnum<{
1089
- readonly Rerank: "rerank";
1090
- }>;
1091
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONModelType$outboundSchema` instead. */
1092
- const outboundSchema: z.ZodNativeEnum<{
1093
- readonly Rerank: "rerank";
1094
- }>;
1095
- }
1096
- /** @internal */
1097
- export declare const CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONModelParameters$inboundSchema: z.ZodType<CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONModelParameters, z.ZodTypeDef, unknown>;
1098
- /** @internal */
1099
- export type CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONModelParameters$Outbound = {
1100
- threshold?: number | undefined;
1101
- };
1102
- /** @internal */
1103
- export declare const CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONModelParameters$outboundSchema: z.ZodType<CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONModelParameters$Outbound, z.ZodTypeDef, CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONModelParameters>;
1104
- /**
1105
- * @internal
1106
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
1107
- */
1108
- export declare namespace CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONModelParameters$ {
1109
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONModelParameters$inboundSchema` instead. */
1110
- const inboundSchema: z.ZodType<CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONModelParameters, z.ZodTypeDef, unknown>;
1111
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONModelParameters$outboundSchema` instead. */
1112
- const outboundSchema: z.ZodType<CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONModelParameters$Outbound, z.ZodTypeDef, CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONModelParameters>;
1113
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONModelParameters$Outbound` instead. */
1114
- type Outbound = CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONModelParameters$Outbound;
1115
- }
1116
- export declare function createKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONModelParametersToJSON(createKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONModelParameters: CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONModelParameters): string;
1117
- export declare function createKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONModelParametersFromJSON(jsonString: string): SafeParseResult<CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONModelParameters, SDKValidationError>;
1118
- /** @internal */
1119
- export declare const CreateKnowledgeRetrievalSettingsKnowledgeResponse200RerankConfig$inboundSchema: z.ZodType<CreateKnowledgeRetrievalSettingsKnowledgeResponse200RerankConfig, z.ZodTypeDef, unknown>;
1120
- /** @internal */
1121
- export type CreateKnowledgeRetrievalSettingsKnowledgeResponse200RerankConfig$Outbound = {
1122
- enabled?: boolean | undefined;
1123
- provider?: string | undefined;
1124
- model?: string | undefined;
1125
- model_db_id?: string | undefined;
1126
- model_type?: string | undefined;
1127
- model_parameters?: CreateKnowledgeRetrievalSettingsKnowledgeResponse200ApplicationJSONModelParameters$Outbound | undefined;
1128
- integration_id?: string | null | undefined;
1129
- };
1130
- /** @internal */
1131
- export declare const CreateKnowledgeRetrievalSettingsKnowledgeResponse200RerankConfig$outboundSchema: z.ZodType<CreateKnowledgeRetrievalSettingsKnowledgeResponse200RerankConfig$Outbound, z.ZodTypeDef, CreateKnowledgeRetrievalSettingsKnowledgeResponse200RerankConfig>;
1132
- /**
1133
- * @internal
1134
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
1135
- */
1136
- export declare namespace CreateKnowledgeRetrievalSettingsKnowledgeResponse200RerankConfig$ {
1137
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeResponse200RerankConfig$inboundSchema` instead. */
1138
- const inboundSchema: z.ZodType<CreateKnowledgeRetrievalSettingsKnowledgeResponse200RerankConfig, z.ZodTypeDef, unknown>;
1139
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeResponse200RerankConfig$outboundSchema` instead. */
1140
- const outboundSchema: z.ZodType<CreateKnowledgeRetrievalSettingsKnowledgeResponse200RerankConfig$Outbound, z.ZodTypeDef, CreateKnowledgeRetrievalSettingsKnowledgeResponse200RerankConfig>;
1141
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeResponse200RerankConfig$Outbound` instead. */
1142
- type Outbound = CreateKnowledgeRetrievalSettingsKnowledgeResponse200RerankConfig$Outbound;
1143
- }
1144
- export declare function createKnowledgeRetrievalSettingsKnowledgeResponse200RerankConfigToJSON(createKnowledgeRetrievalSettingsKnowledgeResponse200RerankConfig: CreateKnowledgeRetrievalSettingsKnowledgeResponse200RerankConfig): string;
1145
- export declare function createKnowledgeRetrievalSettingsKnowledgeResponse200RerankConfigFromJSON(jsonString: string): SafeParseResult<CreateKnowledgeRetrievalSettingsKnowledgeResponse200RerankConfig, SDKValidationError>;
1146
- /** @internal */
1147
- export declare const CreateKnowledgeRetrievalSettings3$inboundSchema: z.ZodType<CreateKnowledgeRetrievalSettings3, z.ZodTypeDef, unknown>;
1148
- /** @internal */
1149
- export type CreateKnowledgeRetrievalSettings3$Outbound = {
1150
- type: string;
1151
- top_k: number;
1152
- threshold: number;
1153
- rerank_config?: CreateKnowledgeRetrievalSettingsKnowledgeResponse200RerankConfig$Outbound | null | undefined;
1154
- };
1155
- /** @internal */
1156
- export declare const CreateKnowledgeRetrievalSettings3$outboundSchema: z.ZodType<CreateKnowledgeRetrievalSettings3$Outbound, z.ZodTypeDef, CreateKnowledgeRetrievalSettings3>;
1157
- /**
1158
- * @internal
1159
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
1160
- */
1161
- export declare namespace CreateKnowledgeRetrievalSettings3$ {
1162
- /** @deprecated use `CreateKnowledgeRetrievalSettings3$inboundSchema` instead. */
1163
- const inboundSchema: z.ZodType<CreateKnowledgeRetrievalSettings3, z.ZodTypeDef, unknown>;
1164
- /** @deprecated use `CreateKnowledgeRetrievalSettings3$outboundSchema` instead. */
1165
- const outboundSchema: z.ZodType<CreateKnowledgeRetrievalSettings3$Outbound, z.ZodTypeDef, CreateKnowledgeRetrievalSettings3>;
1166
- /** @deprecated use `CreateKnowledgeRetrievalSettings3$Outbound` instead. */
1167
- type Outbound = CreateKnowledgeRetrievalSettings3$Outbound;
1168
- }
1169
- export declare function createKnowledgeRetrievalSettings3ToJSON(createKnowledgeRetrievalSettings3: CreateKnowledgeRetrievalSettings3): string;
1170
- export declare function createKnowledgeRetrievalSettings3FromJSON(jsonString: string): SafeParseResult<CreateKnowledgeRetrievalSettings3, SDKValidationError>;
1171
- /** @internal */
1172
- export declare const CreateKnowledgeRetrievalSettingsKnowledgeResponse200Type$inboundSchema: z.ZodNativeEnum<typeof CreateKnowledgeRetrievalSettingsKnowledgeResponse200Type>;
1173
- /** @internal */
1174
- export declare const CreateKnowledgeRetrievalSettingsKnowledgeResponse200Type$outboundSchema: z.ZodNativeEnum<typeof CreateKnowledgeRetrievalSettingsKnowledgeResponse200Type>;
1175
- /**
1176
- * @internal
1177
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
1178
- */
1179
- export declare namespace CreateKnowledgeRetrievalSettingsKnowledgeResponse200Type$ {
1180
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeResponse200Type$inboundSchema` instead. */
1181
- const inboundSchema: z.ZodNativeEnum<{
1182
- readonly KeywordSearch: "keyword_search";
1183
- }>;
1184
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeResponse200Type$outboundSchema` instead. */
1185
- const outboundSchema: z.ZodNativeEnum<{
1186
- readonly KeywordSearch: "keyword_search";
1187
- }>;
1188
- }
1189
- /** @internal */
1190
- export declare const CreateKnowledgeRetrievalSettingsKnowledgeResponse200Provider$inboundSchema: z.ZodNativeEnum<typeof CreateKnowledgeRetrievalSettingsKnowledgeResponse200Provider>;
1191
- /** @internal */
1192
- export declare const CreateKnowledgeRetrievalSettingsKnowledgeResponse200Provider$outboundSchema: z.ZodNativeEnum<typeof CreateKnowledgeRetrievalSettingsKnowledgeResponse200Provider>;
1193
- /**
1194
- * @internal
1195
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
1196
- */
1197
- export declare namespace CreateKnowledgeRetrievalSettingsKnowledgeResponse200Provider$ {
1198
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeResponse200Provider$inboundSchema` instead. */
1199
- const inboundSchema: z.ZodNativeEnum<{
1200
- readonly Cohere: "cohere";
1201
- readonly Openai: "openai";
1202
- readonly Anthropic: "anthropic";
1203
- readonly Huggingface: "huggingface";
1204
- readonly Replicate: "replicate";
1205
- readonly Google: "google";
1206
- readonly GoogleAi: "google-ai";
1207
- readonly Azure: "azure";
1208
- readonly Aws: "aws";
1209
- readonly Anyscale: "anyscale";
1210
- readonly Perplexity: "perplexity";
1211
- readonly Groq: "groq";
1212
- readonly Fal: "fal";
1213
- readonly Leonardoai: "leonardoai";
1214
- readonly Nvidia: "nvidia";
1215
- readonly Jina: "jina";
1216
- readonly Togetherai: "togetherai";
1217
- readonly Elevenlabs: "elevenlabs";
1218
- }>;
1219
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeResponse200Provider$outboundSchema` instead. */
1220
- const outboundSchema: z.ZodNativeEnum<{
1221
- readonly Cohere: "cohere";
1222
- readonly Openai: "openai";
1223
- readonly Anthropic: "anthropic";
1224
- readonly Huggingface: "huggingface";
1225
- readonly Replicate: "replicate";
1226
- readonly Google: "google";
1227
- readonly GoogleAi: "google-ai";
1228
- readonly Azure: "azure";
1229
- readonly Aws: "aws";
1230
- readonly Anyscale: "anyscale";
1231
- readonly Perplexity: "perplexity";
1232
- readonly Groq: "groq";
1233
- readonly Fal: "fal";
1234
- readonly Leonardoai: "leonardoai";
1235
- readonly Nvidia: "nvidia";
1236
- readonly Jina: "jina";
1237
- readonly Togetherai: "togetherai";
1238
- readonly Elevenlabs: "elevenlabs";
1239
- }>;
1240
- }
1241
- /** @internal */
1242
- export declare const CreateKnowledgeRetrievalSettingsKnowledgeResponse200ModelType$inboundSchema: z.ZodNativeEnum<typeof CreateKnowledgeRetrievalSettingsKnowledgeResponse200ModelType>;
1243
- /** @internal */
1244
- export declare const CreateKnowledgeRetrievalSettingsKnowledgeResponse200ModelType$outboundSchema: z.ZodNativeEnum<typeof CreateKnowledgeRetrievalSettingsKnowledgeResponse200ModelType>;
1245
- /**
1246
- * @internal
1247
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
1248
- */
1249
- export declare namespace CreateKnowledgeRetrievalSettingsKnowledgeResponse200ModelType$ {
1250
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeResponse200ModelType$inboundSchema` instead. */
1251
- const inboundSchema: z.ZodNativeEnum<{
1252
- readonly Rerank: "rerank";
1253
- }>;
1254
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeResponse200ModelType$outboundSchema` instead. */
1255
- const outboundSchema: z.ZodNativeEnum<{
1256
- readonly Rerank: "rerank";
1257
- }>;
1258
- }
1259
- /** @internal */
1260
- export declare const CreateKnowledgeRetrievalSettingsKnowledgeResponse200ModelParameters$inboundSchema: z.ZodType<CreateKnowledgeRetrievalSettingsKnowledgeResponse200ModelParameters, z.ZodTypeDef, unknown>;
1261
- /** @internal */
1262
- export type CreateKnowledgeRetrievalSettingsKnowledgeResponse200ModelParameters$Outbound = {
1263
- threshold?: number | undefined;
1264
- };
1265
- /** @internal */
1266
- export declare const CreateKnowledgeRetrievalSettingsKnowledgeResponse200ModelParameters$outboundSchema: z.ZodType<CreateKnowledgeRetrievalSettingsKnowledgeResponse200ModelParameters$Outbound, z.ZodTypeDef, CreateKnowledgeRetrievalSettingsKnowledgeResponse200ModelParameters>;
1267
- /**
1268
- * @internal
1269
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
1270
- */
1271
- export declare namespace CreateKnowledgeRetrievalSettingsKnowledgeResponse200ModelParameters$ {
1272
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeResponse200ModelParameters$inboundSchema` instead. */
1273
- const inboundSchema: z.ZodType<CreateKnowledgeRetrievalSettingsKnowledgeResponse200ModelParameters, z.ZodTypeDef, unknown>;
1274
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeResponse200ModelParameters$outboundSchema` instead. */
1275
- const outboundSchema: z.ZodType<CreateKnowledgeRetrievalSettingsKnowledgeResponse200ModelParameters$Outbound, z.ZodTypeDef, CreateKnowledgeRetrievalSettingsKnowledgeResponse200ModelParameters>;
1276
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeResponse200ModelParameters$Outbound` instead. */
1277
- type Outbound = CreateKnowledgeRetrievalSettingsKnowledgeResponse200ModelParameters$Outbound;
1278
- }
1279
- export declare function createKnowledgeRetrievalSettingsKnowledgeResponse200ModelParametersToJSON(createKnowledgeRetrievalSettingsKnowledgeResponse200ModelParameters: CreateKnowledgeRetrievalSettingsKnowledgeResponse200ModelParameters): string;
1280
- export declare function createKnowledgeRetrievalSettingsKnowledgeResponse200ModelParametersFromJSON(jsonString: string): SafeParseResult<CreateKnowledgeRetrievalSettingsKnowledgeResponse200ModelParameters, SDKValidationError>;
1281
- /** @internal */
1282
- export declare const CreateKnowledgeRetrievalSettingsKnowledgeResponseRerankConfig$inboundSchema: z.ZodType<CreateKnowledgeRetrievalSettingsKnowledgeResponseRerankConfig, z.ZodTypeDef, unknown>;
1283
- /** @internal */
1284
- export type CreateKnowledgeRetrievalSettingsKnowledgeResponseRerankConfig$Outbound = {
1285
- enabled?: boolean | undefined;
1286
- provider?: string | undefined;
1287
- model?: string | undefined;
1288
- model_db_id?: string | undefined;
1289
- model_type?: string | undefined;
1290
- model_parameters?: CreateKnowledgeRetrievalSettingsKnowledgeResponse200ModelParameters$Outbound | undefined;
1291
- integration_id?: string | null | undefined;
1292
- };
1293
- /** @internal */
1294
- export declare const CreateKnowledgeRetrievalSettingsKnowledgeResponseRerankConfig$outboundSchema: z.ZodType<CreateKnowledgeRetrievalSettingsKnowledgeResponseRerankConfig$Outbound, z.ZodTypeDef, CreateKnowledgeRetrievalSettingsKnowledgeResponseRerankConfig>;
1295
- /**
1296
- * @internal
1297
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
1298
- */
1299
- export declare namespace CreateKnowledgeRetrievalSettingsKnowledgeResponseRerankConfig$ {
1300
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeResponseRerankConfig$inboundSchema` instead. */
1301
- const inboundSchema: z.ZodType<CreateKnowledgeRetrievalSettingsKnowledgeResponseRerankConfig, z.ZodTypeDef, unknown>;
1302
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeResponseRerankConfig$outboundSchema` instead. */
1303
- const outboundSchema: z.ZodType<CreateKnowledgeRetrievalSettingsKnowledgeResponseRerankConfig$Outbound, z.ZodTypeDef, CreateKnowledgeRetrievalSettingsKnowledgeResponseRerankConfig>;
1304
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeResponseRerankConfig$Outbound` instead. */
1305
- type Outbound = CreateKnowledgeRetrievalSettingsKnowledgeResponseRerankConfig$Outbound;
1306
- }
1307
- export declare function createKnowledgeRetrievalSettingsKnowledgeResponseRerankConfigToJSON(createKnowledgeRetrievalSettingsKnowledgeResponseRerankConfig: CreateKnowledgeRetrievalSettingsKnowledgeResponseRerankConfig): string;
1308
- export declare function createKnowledgeRetrievalSettingsKnowledgeResponseRerankConfigFromJSON(jsonString: string): SafeParseResult<CreateKnowledgeRetrievalSettingsKnowledgeResponseRerankConfig, SDKValidationError>;
1309
- /** @internal */
1310
- export declare const CreateKnowledgeRetrievalSettings2$inboundSchema: z.ZodType<CreateKnowledgeRetrievalSettings2, z.ZodTypeDef, unknown>;
1311
- /** @internal */
1312
- export type CreateKnowledgeRetrievalSettings2$Outbound = {
1313
- type: string;
1314
- top_k: number;
1315
- threshold: number;
1316
- rerank_config?: CreateKnowledgeRetrievalSettingsKnowledgeResponseRerankConfig$Outbound | null | undefined;
1317
- };
1318
- /** @internal */
1319
- export declare const CreateKnowledgeRetrievalSettings2$outboundSchema: z.ZodType<CreateKnowledgeRetrievalSettings2$Outbound, z.ZodTypeDef, CreateKnowledgeRetrievalSettings2>;
1320
- /**
1321
- * @internal
1322
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
1323
- */
1324
- export declare namespace CreateKnowledgeRetrievalSettings2$ {
1325
- /** @deprecated use `CreateKnowledgeRetrievalSettings2$inboundSchema` instead. */
1326
- const inboundSchema: z.ZodType<CreateKnowledgeRetrievalSettings2, z.ZodTypeDef, unknown>;
1327
- /** @deprecated use `CreateKnowledgeRetrievalSettings2$outboundSchema` instead. */
1328
- const outboundSchema: z.ZodType<CreateKnowledgeRetrievalSettings2$Outbound, z.ZodTypeDef, CreateKnowledgeRetrievalSettings2>;
1329
- /** @deprecated use `CreateKnowledgeRetrievalSettings2$Outbound` instead. */
1330
- type Outbound = CreateKnowledgeRetrievalSettings2$Outbound;
1331
- }
1332
- export declare function createKnowledgeRetrievalSettings2ToJSON(createKnowledgeRetrievalSettings2: CreateKnowledgeRetrievalSettings2): string;
1333
- export declare function createKnowledgeRetrievalSettings2FromJSON(jsonString: string): SafeParseResult<CreateKnowledgeRetrievalSettings2, SDKValidationError>;
1334
- /** @internal */
1335
- export declare const CreateKnowledgeRetrievalSettingsKnowledgeResponseType$inboundSchema: z.ZodNativeEnum<typeof CreateKnowledgeRetrievalSettingsKnowledgeResponseType>;
1336
- /** @internal */
1337
- export declare const CreateKnowledgeRetrievalSettingsKnowledgeResponseType$outboundSchema: z.ZodNativeEnum<typeof CreateKnowledgeRetrievalSettingsKnowledgeResponseType>;
1338
- /**
1339
- * @internal
1340
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
1341
- */
1342
- export declare namespace CreateKnowledgeRetrievalSettingsKnowledgeResponseType$ {
1343
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeResponseType$inboundSchema` instead. */
262
+ export declare namespace CreateKnowledgeRetrievalType$ {
263
+ /** @deprecated use `CreateKnowledgeRetrievalType$inboundSchema` instead. */
1344
264
  const inboundSchema: z.ZodNativeEnum<{
1345
265
  readonly VectorSearch: "vector_search";
266
+ readonly KeywordSearch: "keyword_search";
267
+ readonly HybridSearch: "hybrid_search";
1346
268
  }>;
1347
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeResponseType$outboundSchema` instead. */
269
+ /** @deprecated use `CreateKnowledgeRetrievalType$outboundSchema` instead. */
1348
270
  const outboundSchema: z.ZodNativeEnum<{
1349
271
  readonly VectorSearch: "vector_search";
272
+ readonly KeywordSearch: "keyword_search";
273
+ readonly HybridSearch: "hybrid_search";
1350
274
  }>;
1351
275
  }
1352
276
  /** @internal */
1353
- export declare const CreateKnowledgeRetrievalSettingsKnowledgeResponseProvider$inboundSchema: z.ZodNativeEnum<typeof CreateKnowledgeRetrievalSettingsKnowledgeResponseProvider>;
1354
- /** @internal */
1355
- export declare const CreateKnowledgeRetrievalSettingsKnowledgeResponseProvider$outboundSchema: z.ZodNativeEnum<typeof CreateKnowledgeRetrievalSettingsKnowledgeResponseProvider>;
1356
- /**
1357
- * @internal
1358
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
1359
- */
1360
- export declare namespace CreateKnowledgeRetrievalSettingsKnowledgeResponseProvider$ {
1361
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeResponseProvider$inboundSchema` instead. */
1362
- const inboundSchema: z.ZodNativeEnum<{
1363
- readonly Cohere: "cohere";
1364
- readonly Openai: "openai";
1365
- readonly Anthropic: "anthropic";
1366
- readonly Huggingface: "huggingface";
1367
- readonly Replicate: "replicate";
1368
- readonly Google: "google";
1369
- readonly GoogleAi: "google-ai";
1370
- readonly Azure: "azure";
1371
- readonly Aws: "aws";
1372
- readonly Anyscale: "anyscale";
1373
- readonly Perplexity: "perplexity";
1374
- readonly Groq: "groq";
1375
- readonly Fal: "fal";
1376
- readonly Leonardoai: "leonardoai";
1377
- readonly Nvidia: "nvidia";
1378
- readonly Jina: "jina";
1379
- readonly Togetherai: "togetherai";
1380
- readonly Elevenlabs: "elevenlabs";
1381
- }>;
1382
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeResponseProvider$outboundSchema` instead. */
1383
- const outboundSchema: z.ZodNativeEnum<{
1384
- readonly Cohere: "cohere";
1385
- readonly Openai: "openai";
1386
- readonly Anthropic: "anthropic";
1387
- readonly Huggingface: "huggingface";
1388
- readonly Replicate: "replicate";
1389
- readonly Google: "google";
1390
- readonly GoogleAi: "google-ai";
1391
- readonly Azure: "azure";
1392
- readonly Aws: "aws";
1393
- readonly Anyscale: "anyscale";
1394
- readonly Perplexity: "perplexity";
1395
- readonly Groq: "groq";
1396
- readonly Fal: "fal";
1397
- readonly Leonardoai: "leonardoai";
1398
- readonly Nvidia: "nvidia";
1399
- readonly Jina: "jina";
1400
- readonly Togetherai: "togetherai";
1401
- readonly Elevenlabs: "elevenlabs";
1402
- }>;
1403
- }
1404
- /** @internal */
1405
- export declare const CreateKnowledgeRetrievalSettingsKnowledgeResponseModelType$inboundSchema: z.ZodNativeEnum<typeof CreateKnowledgeRetrievalSettingsKnowledgeResponseModelType>;
1406
- /** @internal */
1407
- export declare const CreateKnowledgeRetrievalSettingsKnowledgeResponseModelType$outboundSchema: z.ZodNativeEnum<typeof CreateKnowledgeRetrievalSettingsKnowledgeResponseModelType>;
1408
- /**
1409
- * @internal
1410
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
1411
- */
1412
- export declare namespace CreateKnowledgeRetrievalSettingsKnowledgeResponseModelType$ {
1413
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeResponseModelType$inboundSchema` instead. */
1414
- const inboundSchema: z.ZodNativeEnum<{
1415
- readonly Rerank: "rerank";
1416
- }>;
1417
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeResponseModelType$outboundSchema` instead. */
1418
- const outboundSchema: z.ZodNativeEnum<{
1419
- readonly Rerank: "rerank";
1420
- }>;
1421
- }
1422
- /** @internal */
1423
- export declare const CreateKnowledgeRetrievalSettingsKnowledgeResponseModelParameters$inboundSchema: z.ZodType<CreateKnowledgeRetrievalSettingsKnowledgeResponseModelParameters, z.ZodTypeDef, unknown>;
1424
- /** @internal */
1425
- export type CreateKnowledgeRetrievalSettingsKnowledgeResponseModelParameters$Outbound = {
1426
- threshold?: number | undefined;
1427
- };
1428
- /** @internal */
1429
- export declare const CreateKnowledgeRetrievalSettingsKnowledgeResponseModelParameters$outboundSchema: z.ZodType<CreateKnowledgeRetrievalSettingsKnowledgeResponseModelParameters$Outbound, z.ZodTypeDef, CreateKnowledgeRetrievalSettingsKnowledgeResponseModelParameters>;
1430
- /**
1431
- * @internal
1432
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
1433
- */
1434
- export declare namespace CreateKnowledgeRetrievalSettingsKnowledgeResponseModelParameters$ {
1435
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeResponseModelParameters$inboundSchema` instead. */
1436
- const inboundSchema: z.ZodType<CreateKnowledgeRetrievalSettingsKnowledgeResponseModelParameters, z.ZodTypeDef, unknown>;
1437
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeResponseModelParameters$outboundSchema` instead. */
1438
- const outboundSchema: z.ZodType<CreateKnowledgeRetrievalSettingsKnowledgeResponseModelParameters$Outbound, z.ZodTypeDef, CreateKnowledgeRetrievalSettingsKnowledgeResponseModelParameters>;
1439
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeResponseModelParameters$Outbound` instead. */
1440
- type Outbound = CreateKnowledgeRetrievalSettingsKnowledgeResponseModelParameters$Outbound;
1441
- }
1442
- export declare function createKnowledgeRetrievalSettingsKnowledgeResponseModelParametersToJSON(createKnowledgeRetrievalSettingsKnowledgeResponseModelParameters: CreateKnowledgeRetrievalSettingsKnowledgeResponseModelParameters): string;
1443
- export declare function createKnowledgeRetrievalSettingsKnowledgeResponseModelParametersFromJSON(jsonString: string): SafeParseResult<CreateKnowledgeRetrievalSettingsKnowledgeResponseModelParameters, SDKValidationError>;
1444
- /** @internal */
1445
- export declare const CreateKnowledgeRetrievalSettingsKnowledgeRerankConfig$inboundSchema: z.ZodType<CreateKnowledgeRetrievalSettingsKnowledgeRerankConfig, z.ZodTypeDef, unknown>;
277
+ export declare const CreateKnowledgeRerankConfig$inboundSchema: z.ZodType<CreateKnowledgeRerankConfig, z.ZodTypeDef, unknown>;
1446
278
  /** @internal */
1447
- export type CreateKnowledgeRetrievalSettingsKnowledgeRerankConfig$Outbound = {
1448
- enabled?: boolean | undefined;
1449
- provider?: string | undefined;
1450
- model?: string | undefined;
1451
- model_db_id?: string | undefined;
1452
- model_type?: string | undefined;
1453
- model_parameters?: CreateKnowledgeRetrievalSettingsKnowledgeResponseModelParameters$Outbound | undefined;
1454
- integration_id?: string | null | undefined;
279
+ export type CreateKnowledgeRerankConfig$Outbound = {
280
+ rerank_threshold: number;
281
+ rerank_model: string;
1455
282
  };
1456
283
  /** @internal */
1457
- export declare const CreateKnowledgeRetrievalSettingsKnowledgeRerankConfig$outboundSchema: z.ZodType<CreateKnowledgeRetrievalSettingsKnowledgeRerankConfig$Outbound, z.ZodTypeDef, CreateKnowledgeRetrievalSettingsKnowledgeRerankConfig>;
284
+ export declare const CreateKnowledgeRerankConfig$outboundSchema: z.ZodType<CreateKnowledgeRerankConfig$Outbound, z.ZodTypeDef, CreateKnowledgeRerankConfig>;
1458
285
  /**
1459
286
  * @internal
1460
287
  * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
1461
288
  */
1462
- export declare namespace CreateKnowledgeRetrievalSettingsKnowledgeRerankConfig$ {
1463
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeRerankConfig$inboundSchema` instead. */
1464
- const inboundSchema: z.ZodType<CreateKnowledgeRetrievalSettingsKnowledgeRerankConfig, z.ZodTypeDef, unknown>;
1465
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeRerankConfig$outboundSchema` instead. */
1466
- const outboundSchema: z.ZodType<CreateKnowledgeRetrievalSettingsKnowledgeRerankConfig$Outbound, z.ZodTypeDef, CreateKnowledgeRetrievalSettingsKnowledgeRerankConfig>;
1467
- /** @deprecated use `CreateKnowledgeRetrievalSettingsKnowledgeRerankConfig$Outbound` instead. */
1468
- type Outbound = CreateKnowledgeRetrievalSettingsKnowledgeRerankConfig$Outbound;
289
+ export declare namespace CreateKnowledgeRerankConfig$ {
290
+ /** @deprecated use `CreateKnowledgeRerankConfig$inboundSchema` instead. */
291
+ const inboundSchema: z.ZodType<CreateKnowledgeRerankConfig, z.ZodTypeDef, unknown>;
292
+ /** @deprecated use `CreateKnowledgeRerankConfig$outboundSchema` instead. */
293
+ const outboundSchema: z.ZodType<CreateKnowledgeRerankConfig$Outbound, z.ZodTypeDef, CreateKnowledgeRerankConfig>;
294
+ /** @deprecated use `CreateKnowledgeRerankConfig$Outbound` instead. */
295
+ type Outbound = CreateKnowledgeRerankConfig$Outbound;
1469
296
  }
1470
- export declare function createKnowledgeRetrievalSettingsKnowledgeRerankConfigToJSON(createKnowledgeRetrievalSettingsKnowledgeRerankConfig: CreateKnowledgeRetrievalSettingsKnowledgeRerankConfig): string;
1471
- export declare function createKnowledgeRetrievalSettingsKnowledgeRerankConfigFromJSON(jsonString: string): SafeParseResult<CreateKnowledgeRetrievalSettingsKnowledgeRerankConfig, SDKValidationError>;
297
+ export declare function createKnowledgeRerankConfigToJSON(createKnowledgeRerankConfig: CreateKnowledgeRerankConfig): string;
298
+ export declare function createKnowledgeRerankConfigFromJSON(jsonString: string): SafeParseResult<CreateKnowledgeRerankConfig, SDKValidationError>;
1472
299
  /** @internal */
1473
- export declare const CreateKnowledgeRetrievalSettings1$inboundSchema: z.ZodType<CreateKnowledgeRetrievalSettings1, z.ZodTypeDef, unknown>;
300
+ export declare const CreateKnowledgeRetrievalSettings$inboundSchema: z.ZodType<CreateKnowledgeRetrievalSettings, z.ZodTypeDef, unknown>;
1474
301
  /** @internal */
1475
- export type CreateKnowledgeRetrievalSettings1$Outbound = {
1476
- type: string;
302
+ export type CreateKnowledgeRetrievalSettings$Outbound = {
303
+ retrieval_type: string;
1477
304
  top_k: number;
1478
305
  threshold: number;
1479
- rerank_config?: CreateKnowledgeRetrievalSettingsKnowledgeRerankConfig$Outbound | null | undefined;
306
+ rerank_config?: CreateKnowledgeRerankConfig$Outbound | undefined;
1480
307
  };
1481
308
  /** @internal */
1482
- export declare const CreateKnowledgeRetrievalSettings1$outboundSchema: z.ZodType<CreateKnowledgeRetrievalSettings1$Outbound, z.ZodTypeDef, CreateKnowledgeRetrievalSettings1>;
1483
- /**
1484
- * @internal
1485
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
1486
- */
1487
- export declare namespace CreateKnowledgeRetrievalSettings1$ {
1488
- /** @deprecated use `CreateKnowledgeRetrievalSettings1$inboundSchema` instead. */
1489
- const inboundSchema: z.ZodType<CreateKnowledgeRetrievalSettings1, z.ZodTypeDef, unknown>;
1490
- /** @deprecated use `CreateKnowledgeRetrievalSettings1$outboundSchema` instead. */
1491
- const outboundSchema: z.ZodType<CreateKnowledgeRetrievalSettings1$Outbound, z.ZodTypeDef, CreateKnowledgeRetrievalSettings1>;
1492
- /** @deprecated use `CreateKnowledgeRetrievalSettings1$Outbound` instead. */
1493
- type Outbound = CreateKnowledgeRetrievalSettings1$Outbound;
1494
- }
1495
- export declare function createKnowledgeRetrievalSettings1ToJSON(createKnowledgeRetrievalSettings1: CreateKnowledgeRetrievalSettings1): string;
1496
- export declare function createKnowledgeRetrievalSettings1FromJSON(jsonString: string): SafeParseResult<CreateKnowledgeRetrievalSettings1, SDKValidationError>;
1497
- /** @internal */
1498
- export declare const CreateKnowledgeRetrievalSettings$inboundSchema: z.ZodType<CreateKnowledgeRetrievalSettings, z.ZodTypeDef, unknown>;
1499
- /** @internal */
1500
- export type CreateKnowledgeRetrievalSettings$Outbound = CreateKnowledgeRetrievalSettings1$Outbound | CreateKnowledgeRetrievalSettings2$Outbound | CreateKnowledgeRetrievalSettings3$Outbound;
1501
- /** @internal */
1502
309
  export declare const CreateKnowledgeRetrievalSettings$outboundSchema: z.ZodType<CreateKnowledgeRetrievalSettings$Outbound, z.ZodTypeDef, CreateKnowledgeRetrievalSettings>;
1503
310
  /**
1504
311
  * @internal
@@ -1523,10 +330,9 @@ export type CreateKnowledgeResponseBody$Outbound = {
1523
330
  created: string;
1524
331
  description?: string | undefined;
1525
332
  key: string;
1526
- metadata: CreateKnowledgeMetadata$Outbound;
1527
333
  model: string;
1528
334
  path?: string | undefined;
1529
- retrieval_settings: CreateKnowledgeRetrievalSettings1$Outbound | CreateKnowledgeRetrievalSettings2$Outbound | CreateKnowledgeRetrievalSettings3$Outbound;
335
+ retrieval_settings?: CreateKnowledgeRetrievalSettings$Outbound | undefined;
1530
336
  update_by_id: string;
1531
337
  updated: string;
1532
338
  };