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

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
@@ -20,207 +20,52 @@ export declare const ListKnowledgeBasesObject: {
20
20
  readonly List: "list";
21
21
  };
22
22
  export type ListKnowledgeBasesObject = ClosedEnum<typeof ListKnowledgeBasesObject>;
23
- export type ListKnowledgeBasesMetadata = {
24
- wordCount?: number | undefined;
25
- documentCount?: number | undefined;
26
- sentencesCount?: number | undefined;
27
- };
28
- export declare const ListKnowledgeBasesRetrievalSettingsKnowledgeType: {
23
+ /**
24
+ * The retrieval type to use for the knowledge base. If not provided, Hybrid Search will be used as a default query strategy.
25
+ */
26
+ export declare const ListKnowledgeBasesRetrievalType: {
27
+ readonly VectorSearch: "vector_search";
28
+ readonly KeywordSearch: "keyword_search";
29
29
  readonly HybridSearch: "hybrid_search";
30
30
  };
31
- export type ListKnowledgeBasesRetrievalSettingsKnowledgeType = ClosedEnum<typeof ListKnowledgeBasesRetrievalSettingsKnowledgeType>;
32
- export declare const ListKnowledgeBasesRetrievalSettingsKnowledgeProvider: {
33
- readonly Cohere: "cohere";
34
- readonly Openai: "openai";
35
- readonly Anthropic: "anthropic";
36
- readonly Huggingface: "huggingface";
37
- readonly Replicate: "replicate";
38
- readonly Google: "google";
39
- readonly GoogleAi: "google-ai";
40
- readonly Azure: "azure";
41
- readonly Aws: "aws";
42
- readonly Anyscale: "anyscale";
43
- readonly Perplexity: "perplexity";
44
- readonly Groq: "groq";
45
- readonly Fal: "fal";
46
- readonly Leonardoai: "leonardoai";
47
- readonly Nvidia: "nvidia";
48
- readonly Jina: "jina";
49
- readonly Togetherai: "togetherai";
50
- readonly Elevenlabs: "elevenlabs";
51
- };
52
- export type ListKnowledgeBasesRetrievalSettingsKnowledgeProvider = ClosedEnum<typeof ListKnowledgeBasesRetrievalSettingsKnowledgeProvider>;
53
- export declare const ListKnowledgeBasesRetrievalSettingsKnowledgeModelType: {
54
- readonly Rerank: "rerank";
55
- };
56
- export type ListKnowledgeBasesRetrievalSettingsKnowledgeModelType = ClosedEnum<typeof ListKnowledgeBasesRetrievalSettingsKnowledgeModelType>;
57
- export type ListKnowledgeBasesRetrievalSettingsKnowledgeModelParameters = {
31
+ /**
32
+ * The retrieval type to use for the knowledge base. If not provided, Hybrid Search will be used as a default query strategy.
33
+ */
34
+ export type ListKnowledgeBasesRetrievalType = ClosedEnum<typeof ListKnowledgeBasesRetrievalType>;
35
+ /**
36
+ * The rerank configuration for the knowledge base. In case the model is provided it will be used to enhance the search precision.
37
+ */
38
+ export type ListKnowledgeBasesRerankConfig = {
58
39
  /**
59
40
  * The threshold value used to filter the rerank results, only documents with a relevance score greater than the threshold will be returned
60
41
  */
61
- threshold?: number | undefined;
62
- };
63
- export type ListKnowledgeBasesRetrievalSettingsRerankConfig = {
64
- enabled?: boolean | undefined;
65
- provider?: ListKnowledgeBasesRetrievalSettingsKnowledgeProvider | undefined;
66
- /**
67
- * The name of the model to use
68
- */
69
- model?: string | undefined;
70
- /**
71
- * The ID of the model in the database
72
- */
73
- modelDbId?: string | undefined;
74
- modelType?: ListKnowledgeBasesRetrievalSettingsKnowledgeModelType | undefined;
75
- modelParameters?: ListKnowledgeBasesRetrievalSettingsKnowledgeModelParameters | undefined;
76
- /**
77
- * The id of the resource
78
- */
79
- integrationId?: string | null | undefined;
80
- };
81
- export type ListKnowledgeBasesRetrievalSettings3 = {
82
- type: ListKnowledgeBasesRetrievalSettingsKnowledgeType;
83
- /**
84
- * Used to filter chunks that are most similar to the query
85
- */
86
- topK?: number | undefined;
42
+ rerankThreshold?: number | undefined;
87
43
  /**
88
- * Used to filter chunks that are most similar to the query. A value of `0` will be consider disabled.
44
+ * The rerank model to use for the knowledge base.
89
45
  */
90
- threshold?: number | undefined;
91
- rerankConfig?: ListKnowledgeBasesRetrievalSettingsRerankConfig | null | undefined;
92
- };
93
- export declare const ListKnowledgeBasesRetrievalSettingsType: {
94
- readonly KeywordSearch: "keyword_search";
95
- };
96
- export type ListKnowledgeBasesRetrievalSettingsType = ClosedEnum<typeof ListKnowledgeBasesRetrievalSettingsType>;
97
- export declare const ListKnowledgeBasesRetrievalSettingsProvider: {
98
- readonly Cohere: "cohere";
99
- readonly Openai: "openai";
100
- readonly Anthropic: "anthropic";
101
- readonly Huggingface: "huggingface";
102
- readonly Replicate: "replicate";
103
- readonly Google: "google";
104
- readonly GoogleAi: "google-ai";
105
- readonly Azure: "azure";
106
- readonly Aws: "aws";
107
- readonly Anyscale: "anyscale";
108
- readonly Perplexity: "perplexity";
109
- readonly Groq: "groq";
110
- readonly Fal: "fal";
111
- readonly Leonardoai: "leonardoai";
112
- readonly Nvidia: "nvidia";
113
- readonly Jina: "jina";
114
- readonly Togetherai: "togetherai";
115
- readonly Elevenlabs: "elevenlabs";
46
+ rerankModel: string;
116
47
  };
117
- export type ListKnowledgeBasesRetrievalSettingsProvider = ClosedEnum<typeof ListKnowledgeBasesRetrievalSettingsProvider>;
118
- export declare const ListKnowledgeBasesRetrievalSettingsModelType: {
119
- readonly Rerank: "rerank";
120
- };
121
- export type ListKnowledgeBasesRetrievalSettingsModelType = ClosedEnum<typeof ListKnowledgeBasesRetrievalSettingsModelType>;
122
- export type ListKnowledgeBasesRetrievalSettingsModelParameters = {
123
- /**
124
- * The threshold value used to filter the rerank results, only documents with a relevance score greater than the threshold will be returned
125
- */
126
- threshold?: number | undefined;
127
- };
128
- export type ListKnowledgeBasesRetrievalSettingsKnowledgeResponseRerankConfig = {
129
- enabled?: boolean | undefined;
130
- provider?: ListKnowledgeBasesRetrievalSettingsProvider | undefined;
131
- /**
132
- * The name of the model to use
133
- */
134
- model?: string | undefined;
135
- /**
136
- * The ID of the model in the database
137
- */
138
- modelDbId?: string | undefined;
139
- modelType?: ListKnowledgeBasesRetrievalSettingsModelType | undefined;
140
- modelParameters?: ListKnowledgeBasesRetrievalSettingsModelParameters | undefined;
48
+ /**
49
+ * The retrieval settings for the knowledge base. If not provider, Hybrid Search will be used as a default query strategy.
50
+ */
51
+ export type ListKnowledgeBasesRetrievalSettings = {
141
52
  /**
142
- * The id of the resource
53
+ * The retrieval type to use for the knowledge base. If not provided, Hybrid Search will be used as a default query strategy.
143
54
  */
144
- integrationId?: string | null | undefined;
145
- };
146
- export type ListKnowledgeBasesRetrievalSettings2 = {
147
- type: ListKnowledgeBasesRetrievalSettingsType;
55
+ retrievalType?: ListKnowledgeBasesRetrievalType | undefined;
148
56
  /**
149
- * Used to filter chunks that are most similar to the query
57
+ * The number of results to return from the search.
150
58
  */
151
59
  topK?: number | undefined;
152
60
  /**
153
- * Used to filter chunks that are most similar to the query. A value of `0` will be consider disabled.
61
+ * The threshold value used to filter the search results, only documents with a relevance score greater than the threshold will be returned
154
62
  */
155
63
  threshold?: number | undefined;
156
- rerankConfig?: ListKnowledgeBasesRetrievalSettingsKnowledgeResponseRerankConfig | null | undefined;
157
- };
158
- export declare const ListKnowledgeBasesRetrievalSettingsKnowledgeResponseType: {
159
- readonly VectorSearch: "vector_search";
160
- };
161
- export type ListKnowledgeBasesRetrievalSettingsKnowledgeResponseType = ClosedEnum<typeof ListKnowledgeBasesRetrievalSettingsKnowledgeResponseType>;
162
- export declare const ListKnowledgeBasesRetrievalSettingsKnowledgeResponseProvider: {
163
- readonly Cohere: "cohere";
164
- readonly Openai: "openai";
165
- readonly Anthropic: "anthropic";
166
- readonly Huggingface: "huggingface";
167
- readonly Replicate: "replicate";
168
- readonly Google: "google";
169
- readonly GoogleAi: "google-ai";
170
- readonly Azure: "azure";
171
- readonly Aws: "aws";
172
- readonly Anyscale: "anyscale";
173
- readonly Perplexity: "perplexity";
174
- readonly Groq: "groq";
175
- readonly Fal: "fal";
176
- readonly Leonardoai: "leonardoai";
177
- readonly Nvidia: "nvidia";
178
- readonly Jina: "jina";
179
- readonly Togetherai: "togetherai";
180
- readonly Elevenlabs: "elevenlabs";
181
- };
182
- export type ListKnowledgeBasesRetrievalSettingsKnowledgeResponseProvider = ClosedEnum<typeof ListKnowledgeBasesRetrievalSettingsKnowledgeResponseProvider>;
183
- export declare const ListKnowledgeBasesRetrievalSettingsKnowledgeResponseModelType: {
184
- readonly Rerank: "rerank";
185
- };
186
- export type ListKnowledgeBasesRetrievalSettingsKnowledgeResponseModelType = ClosedEnum<typeof ListKnowledgeBasesRetrievalSettingsKnowledgeResponseModelType>;
187
- export type ListKnowledgeBasesRetrievalSettingsKnowledgeResponseModelParameters = {
188
- /**
189
- * The threshold value used to filter the rerank results, only documents with a relevance score greater than the threshold will be returned
190
- */
191
- threshold?: number | undefined;
192
- };
193
- export type ListKnowledgeBasesRetrievalSettingsKnowledgeRerankConfig = {
194
- enabled?: boolean | undefined;
195
- provider?: ListKnowledgeBasesRetrievalSettingsKnowledgeResponseProvider | undefined;
196
- /**
197
- * The name of the model to use
198
- */
199
- model?: string | undefined;
200
- /**
201
- * The ID of the model in the database
202
- */
203
- modelDbId?: string | undefined;
204
- modelType?: ListKnowledgeBasesRetrievalSettingsKnowledgeResponseModelType | undefined;
205
- modelParameters?: ListKnowledgeBasesRetrievalSettingsKnowledgeResponseModelParameters | undefined;
206
- /**
207
- * The id of the resource
208
- */
209
- integrationId?: string | null | undefined;
210
- };
211
- export type ListKnowledgeBasesRetrievalSettings1 = {
212
- type: ListKnowledgeBasesRetrievalSettingsKnowledgeResponseType;
213
- /**
214
- * Used to filter chunks that are most similar to the query
215
- */
216
- topK?: number | undefined;
217
64
  /**
218
- * Used to filter chunks that are most similar to the query. A value of `0` will be consider disabled.
65
+ * The rerank configuration for the knowledge base. In case the model is provided it will be used to enhance the search precision.
219
66
  */
220
- threshold?: number | undefined;
221
- rerankConfig?: ListKnowledgeBasesRetrievalSettingsKnowledgeRerankConfig | null | undefined;
67
+ rerankConfig?: ListKnowledgeBasesRerankConfig | undefined;
222
68
  };
223
- export type ListKnowledgeBasesRetrievalSettings = ListKnowledgeBasesRetrievalSettings1 | ListKnowledgeBasesRetrievalSettings2 | ListKnowledgeBasesRetrievalSettings3;
224
69
  /**
225
70
  * Knowledge Base object
226
71
  */
@@ -245,7 +90,6 @@ export type ListKnowledgeBasesData = {
245
90
  * The unique key of the knowledge base.
246
91
  */
247
92
  key: string;
248
- metadata: ListKnowledgeBasesMetadata;
249
93
  /**
250
94
  * The embeddings model used for the knowledge base.
251
95
  */
@@ -254,7 +98,10 @@ export type ListKnowledgeBasesData = {
254
98
  * 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.
255
99
  */
256
100
  path?: string | undefined;
257
- retrievalSettings: ListKnowledgeBasesRetrievalSettings1 | ListKnowledgeBasesRetrievalSettings2 | ListKnowledgeBasesRetrievalSettings3;
101
+ /**
102
+ * The retrieval settings for the knowledge base. If not provider, Hybrid Search will be used as a default query strategy.
103
+ */
104
+ retrievalSettings?: ListKnowledgeBasesRetrievalSettings | undefined;
258
105
  /**
259
106
  * The id of the resource
260
107
  */
@@ -315,523 +162,60 @@ export declare namespace ListKnowledgeBasesObject$ {
315
162
  }>;
316
163
  }
317
164
  /** @internal */
318
- export declare const ListKnowledgeBasesMetadata$inboundSchema: z.ZodType<ListKnowledgeBasesMetadata, z.ZodTypeDef, unknown>;
319
- /** @internal */
320
- export type ListKnowledgeBasesMetadata$Outbound = {
321
- word_count: number;
322
- document_count: number;
323
- sentences_count: number;
324
- };
325
- /** @internal */
326
- export declare const ListKnowledgeBasesMetadata$outboundSchema: z.ZodType<ListKnowledgeBasesMetadata$Outbound, z.ZodTypeDef, ListKnowledgeBasesMetadata>;
327
- /**
328
- * @internal
329
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
330
- */
331
- export declare namespace ListKnowledgeBasesMetadata$ {
332
- /** @deprecated use `ListKnowledgeBasesMetadata$inboundSchema` instead. */
333
- const inboundSchema: z.ZodType<ListKnowledgeBasesMetadata, z.ZodTypeDef, unknown>;
334
- /** @deprecated use `ListKnowledgeBasesMetadata$outboundSchema` instead. */
335
- const outboundSchema: z.ZodType<ListKnowledgeBasesMetadata$Outbound, z.ZodTypeDef, ListKnowledgeBasesMetadata>;
336
- /** @deprecated use `ListKnowledgeBasesMetadata$Outbound` instead. */
337
- type Outbound = ListKnowledgeBasesMetadata$Outbound;
338
- }
339
- export declare function listKnowledgeBasesMetadataToJSON(listKnowledgeBasesMetadata: ListKnowledgeBasesMetadata): string;
340
- export declare function listKnowledgeBasesMetadataFromJSON(jsonString: string): SafeParseResult<ListKnowledgeBasesMetadata, SDKValidationError>;
341
- /** @internal */
342
- export declare const ListKnowledgeBasesRetrievalSettingsKnowledgeType$inboundSchema: z.ZodNativeEnum<typeof ListKnowledgeBasesRetrievalSettingsKnowledgeType>;
343
- /** @internal */
344
- export declare const ListKnowledgeBasesRetrievalSettingsKnowledgeType$outboundSchema: z.ZodNativeEnum<typeof ListKnowledgeBasesRetrievalSettingsKnowledgeType>;
345
- /**
346
- * @internal
347
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
348
- */
349
- export declare namespace ListKnowledgeBasesRetrievalSettingsKnowledgeType$ {
350
- /** @deprecated use `ListKnowledgeBasesRetrievalSettingsKnowledgeType$inboundSchema` instead. */
351
- const inboundSchema: z.ZodNativeEnum<{
352
- readonly HybridSearch: "hybrid_search";
353
- }>;
354
- /** @deprecated use `ListKnowledgeBasesRetrievalSettingsKnowledgeType$outboundSchema` instead. */
355
- const outboundSchema: z.ZodNativeEnum<{
356
- readonly HybridSearch: "hybrid_search";
357
- }>;
358
- }
359
- /** @internal */
360
- export declare const ListKnowledgeBasesRetrievalSettingsKnowledgeProvider$inboundSchema: z.ZodNativeEnum<typeof ListKnowledgeBasesRetrievalSettingsKnowledgeProvider>;
165
+ export declare const ListKnowledgeBasesRetrievalType$inboundSchema: z.ZodNativeEnum<typeof ListKnowledgeBasesRetrievalType>;
361
166
  /** @internal */
362
- export declare const ListKnowledgeBasesRetrievalSettingsKnowledgeProvider$outboundSchema: z.ZodNativeEnum<typeof ListKnowledgeBasesRetrievalSettingsKnowledgeProvider>;
167
+ export declare const ListKnowledgeBasesRetrievalType$outboundSchema: z.ZodNativeEnum<typeof ListKnowledgeBasesRetrievalType>;
363
168
  /**
364
169
  * @internal
365
170
  * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
366
171
  */
367
- export declare namespace ListKnowledgeBasesRetrievalSettingsKnowledgeProvider$ {
368
- /** @deprecated use `ListKnowledgeBasesRetrievalSettingsKnowledgeProvider$inboundSchema` instead. */
369
- const inboundSchema: z.ZodNativeEnum<{
370
- readonly Cohere: "cohere";
371
- readonly Openai: "openai";
372
- readonly Anthropic: "anthropic";
373
- readonly Huggingface: "huggingface";
374
- readonly Replicate: "replicate";
375
- readonly Google: "google";
376
- readonly GoogleAi: "google-ai";
377
- readonly Azure: "azure";
378
- readonly Aws: "aws";
379
- readonly Anyscale: "anyscale";
380
- readonly Perplexity: "perplexity";
381
- readonly Groq: "groq";
382
- readonly Fal: "fal";
383
- readonly Leonardoai: "leonardoai";
384
- readonly Nvidia: "nvidia";
385
- readonly Jina: "jina";
386
- readonly Togetherai: "togetherai";
387
- readonly Elevenlabs: "elevenlabs";
388
- }>;
389
- /** @deprecated use `ListKnowledgeBasesRetrievalSettingsKnowledgeProvider$outboundSchema` instead. */
390
- const outboundSchema: z.ZodNativeEnum<{
391
- readonly Cohere: "cohere";
392
- readonly Openai: "openai";
393
- readonly Anthropic: "anthropic";
394
- readonly Huggingface: "huggingface";
395
- readonly Replicate: "replicate";
396
- readonly Google: "google";
397
- readonly GoogleAi: "google-ai";
398
- readonly Azure: "azure";
399
- readonly Aws: "aws";
400
- readonly Anyscale: "anyscale";
401
- readonly Perplexity: "perplexity";
402
- readonly Groq: "groq";
403
- readonly Fal: "fal";
404
- readonly Leonardoai: "leonardoai";
405
- readonly Nvidia: "nvidia";
406
- readonly Jina: "jina";
407
- readonly Togetherai: "togetherai";
408
- readonly Elevenlabs: "elevenlabs";
409
- }>;
410
- }
411
- /** @internal */
412
- export declare const ListKnowledgeBasesRetrievalSettingsKnowledgeModelType$inboundSchema: z.ZodNativeEnum<typeof ListKnowledgeBasesRetrievalSettingsKnowledgeModelType>;
413
- /** @internal */
414
- export declare const ListKnowledgeBasesRetrievalSettingsKnowledgeModelType$outboundSchema: z.ZodNativeEnum<typeof ListKnowledgeBasesRetrievalSettingsKnowledgeModelType>;
415
- /**
416
- * @internal
417
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
418
- */
419
- export declare namespace ListKnowledgeBasesRetrievalSettingsKnowledgeModelType$ {
420
- /** @deprecated use `ListKnowledgeBasesRetrievalSettingsKnowledgeModelType$inboundSchema` instead. */
421
- const inboundSchema: z.ZodNativeEnum<{
422
- readonly Rerank: "rerank";
423
- }>;
424
- /** @deprecated use `ListKnowledgeBasesRetrievalSettingsKnowledgeModelType$outboundSchema` instead. */
425
- const outboundSchema: z.ZodNativeEnum<{
426
- readonly Rerank: "rerank";
427
- }>;
428
- }
429
- /** @internal */
430
- export declare const ListKnowledgeBasesRetrievalSettingsKnowledgeModelParameters$inboundSchema: z.ZodType<ListKnowledgeBasesRetrievalSettingsKnowledgeModelParameters, z.ZodTypeDef, unknown>;
431
- /** @internal */
432
- export type ListKnowledgeBasesRetrievalSettingsKnowledgeModelParameters$Outbound = {
433
- threshold?: number | undefined;
434
- };
435
- /** @internal */
436
- export declare const ListKnowledgeBasesRetrievalSettingsKnowledgeModelParameters$outboundSchema: z.ZodType<ListKnowledgeBasesRetrievalSettingsKnowledgeModelParameters$Outbound, z.ZodTypeDef, ListKnowledgeBasesRetrievalSettingsKnowledgeModelParameters>;
437
- /**
438
- * @internal
439
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
440
- */
441
- export declare namespace ListKnowledgeBasesRetrievalSettingsKnowledgeModelParameters$ {
442
- /** @deprecated use `ListKnowledgeBasesRetrievalSettingsKnowledgeModelParameters$inboundSchema` instead. */
443
- const inboundSchema: z.ZodType<ListKnowledgeBasesRetrievalSettingsKnowledgeModelParameters, z.ZodTypeDef, unknown>;
444
- /** @deprecated use `ListKnowledgeBasesRetrievalSettingsKnowledgeModelParameters$outboundSchema` instead. */
445
- const outboundSchema: z.ZodType<ListKnowledgeBasesRetrievalSettingsKnowledgeModelParameters$Outbound, z.ZodTypeDef, ListKnowledgeBasesRetrievalSettingsKnowledgeModelParameters>;
446
- /** @deprecated use `ListKnowledgeBasesRetrievalSettingsKnowledgeModelParameters$Outbound` instead. */
447
- type Outbound = ListKnowledgeBasesRetrievalSettingsKnowledgeModelParameters$Outbound;
448
- }
449
- export declare function listKnowledgeBasesRetrievalSettingsKnowledgeModelParametersToJSON(listKnowledgeBasesRetrievalSettingsKnowledgeModelParameters: ListKnowledgeBasesRetrievalSettingsKnowledgeModelParameters): string;
450
- export declare function listKnowledgeBasesRetrievalSettingsKnowledgeModelParametersFromJSON(jsonString: string): SafeParseResult<ListKnowledgeBasesRetrievalSettingsKnowledgeModelParameters, SDKValidationError>;
451
- /** @internal */
452
- export declare const ListKnowledgeBasesRetrievalSettingsRerankConfig$inboundSchema: z.ZodType<ListKnowledgeBasesRetrievalSettingsRerankConfig, z.ZodTypeDef, unknown>;
453
- /** @internal */
454
- export type ListKnowledgeBasesRetrievalSettingsRerankConfig$Outbound = {
455
- enabled?: boolean | undefined;
456
- provider?: string | undefined;
457
- model?: string | undefined;
458
- model_db_id?: string | undefined;
459
- model_type?: string | undefined;
460
- model_parameters?: ListKnowledgeBasesRetrievalSettingsKnowledgeModelParameters$Outbound | undefined;
461
- integration_id?: string | null | undefined;
462
- };
463
- /** @internal */
464
- export declare const ListKnowledgeBasesRetrievalSettingsRerankConfig$outboundSchema: z.ZodType<ListKnowledgeBasesRetrievalSettingsRerankConfig$Outbound, z.ZodTypeDef, ListKnowledgeBasesRetrievalSettingsRerankConfig>;
465
- /**
466
- * @internal
467
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
468
- */
469
- export declare namespace ListKnowledgeBasesRetrievalSettingsRerankConfig$ {
470
- /** @deprecated use `ListKnowledgeBasesRetrievalSettingsRerankConfig$inboundSchema` instead. */
471
- const inboundSchema: z.ZodType<ListKnowledgeBasesRetrievalSettingsRerankConfig, z.ZodTypeDef, unknown>;
472
- /** @deprecated use `ListKnowledgeBasesRetrievalSettingsRerankConfig$outboundSchema` instead. */
473
- const outboundSchema: z.ZodType<ListKnowledgeBasesRetrievalSettingsRerankConfig$Outbound, z.ZodTypeDef, ListKnowledgeBasesRetrievalSettingsRerankConfig>;
474
- /** @deprecated use `ListKnowledgeBasesRetrievalSettingsRerankConfig$Outbound` instead. */
475
- type Outbound = ListKnowledgeBasesRetrievalSettingsRerankConfig$Outbound;
476
- }
477
- export declare function listKnowledgeBasesRetrievalSettingsRerankConfigToJSON(listKnowledgeBasesRetrievalSettingsRerankConfig: ListKnowledgeBasesRetrievalSettingsRerankConfig): string;
478
- export declare function listKnowledgeBasesRetrievalSettingsRerankConfigFromJSON(jsonString: string): SafeParseResult<ListKnowledgeBasesRetrievalSettingsRerankConfig, SDKValidationError>;
479
- /** @internal */
480
- export declare const ListKnowledgeBasesRetrievalSettings3$inboundSchema: z.ZodType<ListKnowledgeBasesRetrievalSettings3, z.ZodTypeDef, unknown>;
481
- /** @internal */
482
- export type ListKnowledgeBasesRetrievalSettings3$Outbound = {
483
- type: string;
484
- top_k: number;
485
- threshold: number;
486
- rerank_config?: ListKnowledgeBasesRetrievalSettingsRerankConfig$Outbound | null | undefined;
487
- };
488
- /** @internal */
489
- export declare const ListKnowledgeBasesRetrievalSettings3$outboundSchema: z.ZodType<ListKnowledgeBasesRetrievalSettings3$Outbound, z.ZodTypeDef, ListKnowledgeBasesRetrievalSettings3>;
490
- /**
491
- * @internal
492
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
493
- */
494
- export declare namespace ListKnowledgeBasesRetrievalSettings3$ {
495
- /** @deprecated use `ListKnowledgeBasesRetrievalSettings3$inboundSchema` instead. */
496
- const inboundSchema: z.ZodType<ListKnowledgeBasesRetrievalSettings3, z.ZodTypeDef, unknown>;
497
- /** @deprecated use `ListKnowledgeBasesRetrievalSettings3$outboundSchema` instead. */
498
- const outboundSchema: z.ZodType<ListKnowledgeBasesRetrievalSettings3$Outbound, z.ZodTypeDef, ListKnowledgeBasesRetrievalSettings3>;
499
- /** @deprecated use `ListKnowledgeBasesRetrievalSettings3$Outbound` instead. */
500
- type Outbound = ListKnowledgeBasesRetrievalSettings3$Outbound;
501
- }
502
- export declare function listKnowledgeBasesRetrievalSettings3ToJSON(listKnowledgeBasesRetrievalSettings3: ListKnowledgeBasesRetrievalSettings3): string;
503
- export declare function listKnowledgeBasesRetrievalSettings3FromJSON(jsonString: string): SafeParseResult<ListKnowledgeBasesRetrievalSettings3, SDKValidationError>;
504
- /** @internal */
505
- export declare const ListKnowledgeBasesRetrievalSettingsType$inboundSchema: z.ZodNativeEnum<typeof ListKnowledgeBasesRetrievalSettingsType>;
506
- /** @internal */
507
- export declare const ListKnowledgeBasesRetrievalSettingsType$outboundSchema: z.ZodNativeEnum<typeof ListKnowledgeBasesRetrievalSettingsType>;
508
- /**
509
- * @internal
510
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
511
- */
512
- export declare namespace ListKnowledgeBasesRetrievalSettingsType$ {
513
- /** @deprecated use `ListKnowledgeBasesRetrievalSettingsType$inboundSchema` instead. */
514
- const inboundSchema: z.ZodNativeEnum<{
515
- readonly KeywordSearch: "keyword_search";
516
- }>;
517
- /** @deprecated use `ListKnowledgeBasesRetrievalSettingsType$outboundSchema` instead. */
518
- const outboundSchema: z.ZodNativeEnum<{
519
- readonly KeywordSearch: "keyword_search";
520
- }>;
521
- }
522
- /** @internal */
523
- export declare const ListKnowledgeBasesRetrievalSettingsProvider$inboundSchema: z.ZodNativeEnum<typeof ListKnowledgeBasesRetrievalSettingsProvider>;
524
- /** @internal */
525
- export declare const ListKnowledgeBasesRetrievalSettingsProvider$outboundSchema: z.ZodNativeEnum<typeof ListKnowledgeBasesRetrievalSettingsProvider>;
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 ListKnowledgeBasesRetrievalSettingsProvider$ {
531
- /** @deprecated use `ListKnowledgeBasesRetrievalSettingsProvider$inboundSchema` instead. */
532
- const inboundSchema: z.ZodNativeEnum<{
533
- readonly Cohere: "cohere";
534
- readonly Openai: "openai";
535
- readonly Anthropic: "anthropic";
536
- readonly Huggingface: "huggingface";
537
- readonly Replicate: "replicate";
538
- readonly Google: "google";
539
- readonly GoogleAi: "google-ai";
540
- readonly Azure: "azure";
541
- readonly Aws: "aws";
542
- readonly Anyscale: "anyscale";
543
- readonly Perplexity: "perplexity";
544
- readonly Groq: "groq";
545
- readonly Fal: "fal";
546
- readonly Leonardoai: "leonardoai";
547
- readonly Nvidia: "nvidia";
548
- readonly Jina: "jina";
549
- readonly Togetherai: "togetherai";
550
- readonly Elevenlabs: "elevenlabs";
551
- }>;
552
- /** @deprecated use `ListKnowledgeBasesRetrievalSettingsProvider$outboundSchema` instead. */
553
- const outboundSchema: z.ZodNativeEnum<{
554
- readonly Cohere: "cohere";
555
- readonly Openai: "openai";
556
- readonly Anthropic: "anthropic";
557
- readonly Huggingface: "huggingface";
558
- readonly Replicate: "replicate";
559
- readonly Google: "google";
560
- readonly GoogleAi: "google-ai";
561
- readonly Azure: "azure";
562
- readonly Aws: "aws";
563
- readonly Anyscale: "anyscale";
564
- readonly Perplexity: "perplexity";
565
- readonly Groq: "groq";
566
- readonly Fal: "fal";
567
- readonly Leonardoai: "leonardoai";
568
- readonly Nvidia: "nvidia";
569
- readonly Jina: "jina";
570
- readonly Togetherai: "togetherai";
571
- readonly Elevenlabs: "elevenlabs";
572
- }>;
573
- }
574
- /** @internal */
575
- export declare const ListKnowledgeBasesRetrievalSettingsModelType$inboundSchema: z.ZodNativeEnum<typeof ListKnowledgeBasesRetrievalSettingsModelType>;
576
- /** @internal */
577
- export declare const ListKnowledgeBasesRetrievalSettingsModelType$outboundSchema: z.ZodNativeEnum<typeof ListKnowledgeBasesRetrievalSettingsModelType>;
578
- /**
579
- * @internal
580
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
581
- */
582
- export declare namespace ListKnowledgeBasesRetrievalSettingsModelType$ {
583
- /** @deprecated use `ListKnowledgeBasesRetrievalSettingsModelType$inboundSchema` instead. */
584
- const inboundSchema: z.ZodNativeEnum<{
585
- readonly Rerank: "rerank";
586
- }>;
587
- /** @deprecated use `ListKnowledgeBasesRetrievalSettingsModelType$outboundSchema` instead. */
588
- const outboundSchema: z.ZodNativeEnum<{
589
- readonly Rerank: "rerank";
590
- }>;
591
- }
592
- /** @internal */
593
- export declare const ListKnowledgeBasesRetrievalSettingsModelParameters$inboundSchema: z.ZodType<ListKnowledgeBasesRetrievalSettingsModelParameters, z.ZodTypeDef, unknown>;
594
- /** @internal */
595
- export type ListKnowledgeBasesRetrievalSettingsModelParameters$Outbound = {
596
- threshold?: number | undefined;
597
- };
598
- /** @internal */
599
- export declare const ListKnowledgeBasesRetrievalSettingsModelParameters$outboundSchema: z.ZodType<ListKnowledgeBasesRetrievalSettingsModelParameters$Outbound, z.ZodTypeDef, ListKnowledgeBasesRetrievalSettingsModelParameters>;
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 ListKnowledgeBasesRetrievalSettingsModelParameters$ {
605
- /** @deprecated use `ListKnowledgeBasesRetrievalSettingsModelParameters$inboundSchema` instead. */
606
- const inboundSchema: z.ZodType<ListKnowledgeBasesRetrievalSettingsModelParameters, z.ZodTypeDef, unknown>;
607
- /** @deprecated use `ListKnowledgeBasesRetrievalSettingsModelParameters$outboundSchema` instead. */
608
- const outboundSchema: z.ZodType<ListKnowledgeBasesRetrievalSettingsModelParameters$Outbound, z.ZodTypeDef, ListKnowledgeBasesRetrievalSettingsModelParameters>;
609
- /** @deprecated use `ListKnowledgeBasesRetrievalSettingsModelParameters$Outbound` instead. */
610
- type Outbound = ListKnowledgeBasesRetrievalSettingsModelParameters$Outbound;
611
- }
612
- export declare function listKnowledgeBasesRetrievalSettingsModelParametersToJSON(listKnowledgeBasesRetrievalSettingsModelParameters: ListKnowledgeBasesRetrievalSettingsModelParameters): string;
613
- export declare function listKnowledgeBasesRetrievalSettingsModelParametersFromJSON(jsonString: string): SafeParseResult<ListKnowledgeBasesRetrievalSettingsModelParameters, SDKValidationError>;
614
- /** @internal */
615
- export declare const ListKnowledgeBasesRetrievalSettingsKnowledgeResponseRerankConfig$inboundSchema: z.ZodType<ListKnowledgeBasesRetrievalSettingsKnowledgeResponseRerankConfig, z.ZodTypeDef, unknown>;
616
- /** @internal */
617
- export type ListKnowledgeBasesRetrievalSettingsKnowledgeResponseRerankConfig$Outbound = {
618
- enabled?: boolean | undefined;
619
- provider?: string | undefined;
620
- model?: string | undefined;
621
- model_db_id?: string | undefined;
622
- model_type?: string | undefined;
623
- model_parameters?: ListKnowledgeBasesRetrievalSettingsModelParameters$Outbound | undefined;
624
- integration_id?: string | null | undefined;
625
- };
626
- /** @internal */
627
- export declare const ListKnowledgeBasesRetrievalSettingsKnowledgeResponseRerankConfig$outboundSchema: z.ZodType<ListKnowledgeBasesRetrievalSettingsKnowledgeResponseRerankConfig$Outbound, z.ZodTypeDef, ListKnowledgeBasesRetrievalSettingsKnowledgeResponseRerankConfig>;
628
- /**
629
- * @internal
630
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
631
- */
632
- export declare namespace ListKnowledgeBasesRetrievalSettingsKnowledgeResponseRerankConfig$ {
633
- /** @deprecated use `ListKnowledgeBasesRetrievalSettingsKnowledgeResponseRerankConfig$inboundSchema` instead. */
634
- const inboundSchema: z.ZodType<ListKnowledgeBasesRetrievalSettingsKnowledgeResponseRerankConfig, z.ZodTypeDef, unknown>;
635
- /** @deprecated use `ListKnowledgeBasesRetrievalSettingsKnowledgeResponseRerankConfig$outboundSchema` instead. */
636
- const outboundSchema: z.ZodType<ListKnowledgeBasesRetrievalSettingsKnowledgeResponseRerankConfig$Outbound, z.ZodTypeDef, ListKnowledgeBasesRetrievalSettingsKnowledgeResponseRerankConfig>;
637
- /** @deprecated use `ListKnowledgeBasesRetrievalSettingsKnowledgeResponseRerankConfig$Outbound` instead. */
638
- type Outbound = ListKnowledgeBasesRetrievalSettingsKnowledgeResponseRerankConfig$Outbound;
639
- }
640
- export declare function listKnowledgeBasesRetrievalSettingsKnowledgeResponseRerankConfigToJSON(listKnowledgeBasesRetrievalSettingsKnowledgeResponseRerankConfig: ListKnowledgeBasesRetrievalSettingsKnowledgeResponseRerankConfig): string;
641
- export declare function listKnowledgeBasesRetrievalSettingsKnowledgeResponseRerankConfigFromJSON(jsonString: string): SafeParseResult<ListKnowledgeBasesRetrievalSettingsKnowledgeResponseRerankConfig, SDKValidationError>;
642
- /** @internal */
643
- export declare const ListKnowledgeBasesRetrievalSettings2$inboundSchema: z.ZodType<ListKnowledgeBasesRetrievalSettings2, z.ZodTypeDef, unknown>;
644
- /** @internal */
645
- export type ListKnowledgeBasesRetrievalSettings2$Outbound = {
646
- type: string;
647
- top_k: number;
648
- threshold: number;
649
- rerank_config?: ListKnowledgeBasesRetrievalSettingsKnowledgeResponseRerankConfig$Outbound | null | undefined;
650
- };
651
- /** @internal */
652
- export declare const ListKnowledgeBasesRetrievalSettings2$outboundSchema: z.ZodType<ListKnowledgeBasesRetrievalSettings2$Outbound, z.ZodTypeDef, ListKnowledgeBasesRetrievalSettings2>;
653
- /**
654
- * @internal
655
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
656
- */
657
- export declare namespace ListKnowledgeBasesRetrievalSettings2$ {
658
- /** @deprecated use `ListKnowledgeBasesRetrievalSettings2$inboundSchema` instead. */
659
- const inboundSchema: z.ZodType<ListKnowledgeBasesRetrievalSettings2, z.ZodTypeDef, unknown>;
660
- /** @deprecated use `ListKnowledgeBasesRetrievalSettings2$outboundSchema` instead. */
661
- const outboundSchema: z.ZodType<ListKnowledgeBasesRetrievalSettings2$Outbound, z.ZodTypeDef, ListKnowledgeBasesRetrievalSettings2>;
662
- /** @deprecated use `ListKnowledgeBasesRetrievalSettings2$Outbound` instead. */
663
- type Outbound = ListKnowledgeBasesRetrievalSettings2$Outbound;
664
- }
665
- export declare function listKnowledgeBasesRetrievalSettings2ToJSON(listKnowledgeBasesRetrievalSettings2: ListKnowledgeBasesRetrievalSettings2): string;
666
- export declare function listKnowledgeBasesRetrievalSettings2FromJSON(jsonString: string): SafeParseResult<ListKnowledgeBasesRetrievalSettings2, SDKValidationError>;
667
- /** @internal */
668
- export declare const ListKnowledgeBasesRetrievalSettingsKnowledgeResponseType$inboundSchema: z.ZodNativeEnum<typeof ListKnowledgeBasesRetrievalSettingsKnowledgeResponseType>;
669
- /** @internal */
670
- export declare const ListKnowledgeBasesRetrievalSettingsKnowledgeResponseType$outboundSchema: z.ZodNativeEnum<typeof ListKnowledgeBasesRetrievalSettingsKnowledgeResponseType>;
671
- /**
672
- * @internal
673
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
674
- */
675
- export declare namespace ListKnowledgeBasesRetrievalSettingsKnowledgeResponseType$ {
676
- /** @deprecated use `ListKnowledgeBasesRetrievalSettingsKnowledgeResponseType$inboundSchema` instead. */
172
+ export declare namespace ListKnowledgeBasesRetrievalType$ {
173
+ /** @deprecated use `ListKnowledgeBasesRetrievalType$inboundSchema` instead. */
677
174
  const inboundSchema: z.ZodNativeEnum<{
678
175
  readonly VectorSearch: "vector_search";
176
+ readonly KeywordSearch: "keyword_search";
177
+ readonly HybridSearch: "hybrid_search";
679
178
  }>;
680
- /** @deprecated use `ListKnowledgeBasesRetrievalSettingsKnowledgeResponseType$outboundSchema` instead. */
179
+ /** @deprecated use `ListKnowledgeBasesRetrievalType$outboundSchema` instead. */
681
180
  const outboundSchema: z.ZodNativeEnum<{
682
181
  readonly VectorSearch: "vector_search";
182
+ readonly KeywordSearch: "keyword_search";
183
+ readonly HybridSearch: "hybrid_search";
683
184
  }>;
684
185
  }
685
186
  /** @internal */
686
- export declare const ListKnowledgeBasesRetrievalSettingsKnowledgeResponseProvider$inboundSchema: z.ZodNativeEnum<typeof ListKnowledgeBasesRetrievalSettingsKnowledgeResponseProvider>;
687
- /** @internal */
688
- export declare const ListKnowledgeBasesRetrievalSettingsKnowledgeResponseProvider$outboundSchema: z.ZodNativeEnum<typeof ListKnowledgeBasesRetrievalSettingsKnowledgeResponseProvider>;
689
- /**
690
- * @internal
691
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
692
- */
693
- export declare namespace ListKnowledgeBasesRetrievalSettingsKnowledgeResponseProvider$ {
694
- /** @deprecated use `ListKnowledgeBasesRetrievalSettingsKnowledgeResponseProvider$inboundSchema` instead. */
695
- const inboundSchema: z.ZodNativeEnum<{
696
- readonly Cohere: "cohere";
697
- readonly Openai: "openai";
698
- readonly Anthropic: "anthropic";
699
- readonly Huggingface: "huggingface";
700
- readonly Replicate: "replicate";
701
- readonly Google: "google";
702
- readonly GoogleAi: "google-ai";
703
- readonly Azure: "azure";
704
- readonly Aws: "aws";
705
- readonly Anyscale: "anyscale";
706
- readonly Perplexity: "perplexity";
707
- readonly Groq: "groq";
708
- readonly Fal: "fal";
709
- readonly Leonardoai: "leonardoai";
710
- readonly Nvidia: "nvidia";
711
- readonly Jina: "jina";
712
- readonly Togetherai: "togetherai";
713
- readonly Elevenlabs: "elevenlabs";
714
- }>;
715
- /** @deprecated use `ListKnowledgeBasesRetrievalSettingsKnowledgeResponseProvider$outboundSchema` instead. */
716
- const outboundSchema: z.ZodNativeEnum<{
717
- readonly Cohere: "cohere";
718
- readonly Openai: "openai";
719
- readonly Anthropic: "anthropic";
720
- readonly Huggingface: "huggingface";
721
- readonly Replicate: "replicate";
722
- readonly Google: "google";
723
- readonly GoogleAi: "google-ai";
724
- readonly Azure: "azure";
725
- readonly Aws: "aws";
726
- readonly Anyscale: "anyscale";
727
- readonly Perplexity: "perplexity";
728
- readonly Groq: "groq";
729
- readonly Fal: "fal";
730
- readonly Leonardoai: "leonardoai";
731
- readonly Nvidia: "nvidia";
732
- readonly Jina: "jina";
733
- readonly Togetherai: "togetherai";
734
- readonly Elevenlabs: "elevenlabs";
735
- }>;
736
- }
737
- /** @internal */
738
- export declare const ListKnowledgeBasesRetrievalSettingsKnowledgeResponseModelType$inboundSchema: z.ZodNativeEnum<typeof ListKnowledgeBasesRetrievalSettingsKnowledgeResponseModelType>;
739
- /** @internal */
740
- export declare const ListKnowledgeBasesRetrievalSettingsKnowledgeResponseModelType$outboundSchema: z.ZodNativeEnum<typeof ListKnowledgeBasesRetrievalSettingsKnowledgeResponseModelType>;
741
- /**
742
- * @internal
743
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
744
- */
745
- export declare namespace ListKnowledgeBasesRetrievalSettingsKnowledgeResponseModelType$ {
746
- /** @deprecated use `ListKnowledgeBasesRetrievalSettingsKnowledgeResponseModelType$inboundSchema` instead. */
747
- const inboundSchema: z.ZodNativeEnum<{
748
- readonly Rerank: "rerank";
749
- }>;
750
- /** @deprecated use `ListKnowledgeBasesRetrievalSettingsKnowledgeResponseModelType$outboundSchema` instead. */
751
- const outboundSchema: z.ZodNativeEnum<{
752
- readonly Rerank: "rerank";
753
- }>;
754
- }
755
- /** @internal */
756
- export declare const ListKnowledgeBasesRetrievalSettingsKnowledgeResponseModelParameters$inboundSchema: z.ZodType<ListKnowledgeBasesRetrievalSettingsKnowledgeResponseModelParameters, z.ZodTypeDef, unknown>;
187
+ export declare const ListKnowledgeBasesRerankConfig$inboundSchema: z.ZodType<ListKnowledgeBasesRerankConfig, z.ZodTypeDef, unknown>;
757
188
  /** @internal */
758
- export type ListKnowledgeBasesRetrievalSettingsKnowledgeResponseModelParameters$Outbound = {
759
- threshold?: number | undefined;
189
+ export type ListKnowledgeBasesRerankConfig$Outbound = {
190
+ rerank_threshold: number;
191
+ rerank_model: string;
760
192
  };
761
193
  /** @internal */
762
- export declare const ListKnowledgeBasesRetrievalSettingsKnowledgeResponseModelParameters$outboundSchema: z.ZodType<ListKnowledgeBasesRetrievalSettingsKnowledgeResponseModelParameters$Outbound, z.ZodTypeDef, ListKnowledgeBasesRetrievalSettingsKnowledgeResponseModelParameters>;
194
+ export declare const ListKnowledgeBasesRerankConfig$outboundSchema: z.ZodType<ListKnowledgeBasesRerankConfig$Outbound, z.ZodTypeDef, ListKnowledgeBasesRerankConfig>;
763
195
  /**
764
196
  * @internal
765
197
  * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
766
198
  */
767
- export declare namespace ListKnowledgeBasesRetrievalSettingsKnowledgeResponseModelParameters$ {
768
- /** @deprecated use `ListKnowledgeBasesRetrievalSettingsKnowledgeResponseModelParameters$inboundSchema` instead. */
769
- const inboundSchema: z.ZodType<ListKnowledgeBasesRetrievalSettingsKnowledgeResponseModelParameters, z.ZodTypeDef, unknown>;
770
- /** @deprecated use `ListKnowledgeBasesRetrievalSettingsKnowledgeResponseModelParameters$outboundSchema` instead. */
771
- const outboundSchema: z.ZodType<ListKnowledgeBasesRetrievalSettingsKnowledgeResponseModelParameters$Outbound, z.ZodTypeDef, ListKnowledgeBasesRetrievalSettingsKnowledgeResponseModelParameters>;
772
- /** @deprecated use `ListKnowledgeBasesRetrievalSettingsKnowledgeResponseModelParameters$Outbound` instead. */
773
- type Outbound = ListKnowledgeBasesRetrievalSettingsKnowledgeResponseModelParameters$Outbound;
199
+ export declare namespace ListKnowledgeBasesRerankConfig$ {
200
+ /** @deprecated use `ListKnowledgeBasesRerankConfig$inboundSchema` instead. */
201
+ const inboundSchema: z.ZodType<ListKnowledgeBasesRerankConfig, z.ZodTypeDef, unknown>;
202
+ /** @deprecated use `ListKnowledgeBasesRerankConfig$outboundSchema` instead. */
203
+ const outboundSchema: z.ZodType<ListKnowledgeBasesRerankConfig$Outbound, z.ZodTypeDef, ListKnowledgeBasesRerankConfig>;
204
+ /** @deprecated use `ListKnowledgeBasesRerankConfig$Outbound` instead. */
205
+ type Outbound = ListKnowledgeBasesRerankConfig$Outbound;
774
206
  }
775
- export declare function listKnowledgeBasesRetrievalSettingsKnowledgeResponseModelParametersToJSON(listKnowledgeBasesRetrievalSettingsKnowledgeResponseModelParameters: ListKnowledgeBasesRetrievalSettingsKnowledgeResponseModelParameters): string;
776
- export declare function listKnowledgeBasesRetrievalSettingsKnowledgeResponseModelParametersFromJSON(jsonString: string): SafeParseResult<ListKnowledgeBasesRetrievalSettingsKnowledgeResponseModelParameters, SDKValidationError>;
207
+ export declare function listKnowledgeBasesRerankConfigToJSON(listKnowledgeBasesRerankConfig: ListKnowledgeBasesRerankConfig): string;
208
+ export declare function listKnowledgeBasesRerankConfigFromJSON(jsonString: string): SafeParseResult<ListKnowledgeBasesRerankConfig, SDKValidationError>;
777
209
  /** @internal */
778
- export declare const ListKnowledgeBasesRetrievalSettingsKnowledgeRerankConfig$inboundSchema: z.ZodType<ListKnowledgeBasesRetrievalSettingsKnowledgeRerankConfig, z.ZodTypeDef, unknown>;
779
- /** @internal */
780
- export type ListKnowledgeBasesRetrievalSettingsKnowledgeRerankConfig$Outbound = {
781
- enabled?: boolean | undefined;
782
- provider?: string | undefined;
783
- model?: string | undefined;
784
- model_db_id?: string | undefined;
785
- model_type?: string | undefined;
786
- model_parameters?: ListKnowledgeBasesRetrievalSettingsKnowledgeResponseModelParameters$Outbound | undefined;
787
- integration_id?: string | null | undefined;
788
- };
789
- /** @internal */
790
- export declare const ListKnowledgeBasesRetrievalSettingsKnowledgeRerankConfig$outboundSchema: z.ZodType<ListKnowledgeBasesRetrievalSettingsKnowledgeRerankConfig$Outbound, z.ZodTypeDef, ListKnowledgeBasesRetrievalSettingsKnowledgeRerankConfig>;
791
- /**
792
- * @internal
793
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
794
- */
795
- export declare namespace ListKnowledgeBasesRetrievalSettingsKnowledgeRerankConfig$ {
796
- /** @deprecated use `ListKnowledgeBasesRetrievalSettingsKnowledgeRerankConfig$inboundSchema` instead. */
797
- const inboundSchema: z.ZodType<ListKnowledgeBasesRetrievalSettingsKnowledgeRerankConfig, z.ZodTypeDef, unknown>;
798
- /** @deprecated use `ListKnowledgeBasesRetrievalSettingsKnowledgeRerankConfig$outboundSchema` instead. */
799
- const outboundSchema: z.ZodType<ListKnowledgeBasesRetrievalSettingsKnowledgeRerankConfig$Outbound, z.ZodTypeDef, ListKnowledgeBasesRetrievalSettingsKnowledgeRerankConfig>;
800
- /** @deprecated use `ListKnowledgeBasesRetrievalSettingsKnowledgeRerankConfig$Outbound` instead. */
801
- type Outbound = ListKnowledgeBasesRetrievalSettingsKnowledgeRerankConfig$Outbound;
802
- }
803
- export declare function listKnowledgeBasesRetrievalSettingsKnowledgeRerankConfigToJSON(listKnowledgeBasesRetrievalSettingsKnowledgeRerankConfig: ListKnowledgeBasesRetrievalSettingsKnowledgeRerankConfig): string;
804
- export declare function listKnowledgeBasesRetrievalSettingsKnowledgeRerankConfigFromJSON(jsonString: string): SafeParseResult<ListKnowledgeBasesRetrievalSettingsKnowledgeRerankConfig, SDKValidationError>;
805
- /** @internal */
806
- export declare const ListKnowledgeBasesRetrievalSettings1$inboundSchema: z.ZodType<ListKnowledgeBasesRetrievalSettings1, z.ZodTypeDef, unknown>;
210
+ export declare const ListKnowledgeBasesRetrievalSettings$inboundSchema: z.ZodType<ListKnowledgeBasesRetrievalSettings, z.ZodTypeDef, unknown>;
807
211
  /** @internal */
808
- export type ListKnowledgeBasesRetrievalSettings1$Outbound = {
809
- type: string;
212
+ export type ListKnowledgeBasesRetrievalSettings$Outbound = {
213
+ retrieval_type: string;
810
214
  top_k: number;
811
215
  threshold: number;
812
- rerank_config?: ListKnowledgeBasesRetrievalSettingsKnowledgeRerankConfig$Outbound | null | undefined;
216
+ rerank_config?: ListKnowledgeBasesRerankConfig$Outbound | undefined;
813
217
  };
814
218
  /** @internal */
815
- export declare const ListKnowledgeBasesRetrievalSettings1$outboundSchema: z.ZodType<ListKnowledgeBasesRetrievalSettings1$Outbound, z.ZodTypeDef, ListKnowledgeBasesRetrievalSettings1>;
816
- /**
817
- * @internal
818
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
819
- */
820
- export declare namespace ListKnowledgeBasesRetrievalSettings1$ {
821
- /** @deprecated use `ListKnowledgeBasesRetrievalSettings1$inboundSchema` instead. */
822
- const inboundSchema: z.ZodType<ListKnowledgeBasesRetrievalSettings1, z.ZodTypeDef, unknown>;
823
- /** @deprecated use `ListKnowledgeBasesRetrievalSettings1$outboundSchema` instead. */
824
- const outboundSchema: z.ZodType<ListKnowledgeBasesRetrievalSettings1$Outbound, z.ZodTypeDef, ListKnowledgeBasesRetrievalSettings1>;
825
- /** @deprecated use `ListKnowledgeBasesRetrievalSettings1$Outbound` instead. */
826
- type Outbound = ListKnowledgeBasesRetrievalSettings1$Outbound;
827
- }
828
- export declare function listKnowledgeBasesRetrievalSettings1ToJSON(listKnowledgeBasesRetrievalSettings1: ListKnowledgeBasesRetrievalSettings1): string;
829
- export declare function listKnowledgeBasesRetrievalSettings1FromJSON(jsonString: string): SafeParseResult<ListKnowledgeBasesRetrievalSettings1, SDKValidationError>;
830
- /** @internal */
831
- export declare const ListKnowledgeBasesRetrievalSettings$inboundSchema: z.ZodType<ListKnowledgeBasesRetrievalSettings, z.ZodTypeDef, unknown>;
832
- /** @internal */
833
- export type ListKnowledgeBasesRetrievalSettings$Outbound = ListKnowledgeBasesRetrievalSettings1$Outbound | ListKnowledgeBasesRetrievalSettings2$Outbound | ListKnowledgeBasesRetrievalSettings3$Outbound;
834
- /** @internal */
835
219
  export declare const ListKnowledgeBasesRetrievalSettings$outboundSchema: z.ZodType<ListKnowledgeBasesRetrievalSettings$Outbound, z.ZodTypeDef, ListKnowledgeBasesRetrievalSettings>;
836
220
  /**
837
221
  * @internal
@@ -856,10 +240,9 @@ export type ListKnowledgeBasesData$Outbound = {
856
240
  created: string;
857
241
  description?: string | undefined;
858
242
  key: string;
859
- metadata: ListKnowledgeBasesMetadata$Outbound;
860
243
  model: string;
861
244
  path?: string | undefined;
862
- retrieval_settings: ListKnowledgeBasesRetrievalSettings1$Outbound | ListKnowledgeBasesRetrievalSettings2$Outbound | ListKnowledgeBasesRetrievalSettings3$Outbound;
245
+ retrieval_settings?: ListKnowledgeBasesRetrievalSettings$Outbound | undefined;
863
246
  update_by_id: string;
864
247
  updated: string;
865
248
  };