@orq-ai/node 3.9.3 → 3.9.4

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 (92) hide show
  1. package/bin/mcp-server.js +103 -103
  2. package/bin/mcp-server.js.map +26 -26
  3. package/jsr.json +1 -1
  4. package/lib/config.d.ts +2 -2
  5. package/lib/config.js +2 -2
  6. package/mcp-server/mcp-server.js +1 -1
  7. package/mcp-server/server.js +1 -1
  8. package/models/operations/createcontact.js +2 -2
  9. package/models/operations/createdataset.js +2 -2
  10. package/models/operations/createdatasetitem.js +2 -2
  11. package/models/operations/createdatasource.js +2 -2
  12. package/models/operations/createeval.js +16 -16
  13. package/models/operations/fileget.js +2 -2
  14. package/models/operations/filelist.js +2 -2
  15. package/models/operations/fileupload.js +2 -2
  16. package/models/operations/getevals.js +28 -28
  17. package/models/operations/listcontacts.js +2 -2
  18. package/models/operations/listdatasetdatapoints.js +2 -2
  19. package/models/operations/listdatasets.js +2 -2
  20. package/models/operations/listdatasources.js +2 -2
  21. package/models/operations/retrievecontact.js +2 -2
  22. package/models/operations/retrievedatapoint.js +2 -2
  23. package/models/operations/retrievedataset.js +2 -2
  24. package/models/operations/retrievedatasource.js +2 -2
  25. package/models/operations/updatecontact.js +2 -2
  26. package/models/operations/updatedatapoint.js +2 -2
  27. package/models/operations/updatedataset.js +2 -2
  28. package/models/operations/updatedatasource.js +2 -2
  29. package/models/operations/updateeval.js +16 -16
  30. package/package.json +1 -1
  31. package/packages/orq-rc/README.md +5 -2
  32. package/packages/orq-rc/docs/sdks/knowledge/README.md +0 -87
  33. package/packages/orq-rc/docs/sdks/knowledgebases/README.md +94 -0
  34. package/packages/orq-rc/jsr.json +1 -1
  35. package/packages/orq-rc/package-lock.json +56 -67
  36. package/packages/orq-rc/package.json +3 -3
  37. package/packages/orq-rc/src/funcs/{knowledgeChunkText.ts → knowledgeBasesChunkText.ts} +2 -2
  38. package/packages/orq-rc/src/lib/config.ts +3 -3
  39. package/packages/orq-rc/src/mcp-server/mcp-server.ts +1 -1
  40. package/packages/orq-rc/src/mcp-server/server.ts +3 -3
  41. package/packages/orq-rc/src/mcp-server/tools/{knowledgeChunkText.ts → knowledgeBasesChunkText.ts} +5 -5
  42. package/packages/orq-rc/src/models/operations/chunktext.ts +63 -57
  43. package/packages/orq-rc/src/models/operations/createcontact.ts +2 -2
  44. package/packages/orq-rc/src/models/operations/createdataset.ts +2 -2
  45. package/packages/orq-rc/src/models/operations/createdatasetitem.ts +2 -2
  46. package/packages/orq-rc/src/models/operations/createdatasource.ts +2 -2
  47. package/packages/orq-rc/src/models/operations/createeval.ts +16 -16
  48. package/packages/orq-rc/src/models/operations/fileget.ts +2 -2
  49. package/packages/orq-rc/src/models/operations/filelist.ts +2 -2
  50. package/packages/orq-rc/src/models/operations/fileupload.ts +2 -2
  51. package/packages/orq-rc/src/models/operations/getevals.ts +28 -28
  52. package/packages/orq-rc/src/models/operations/listcontacts.ts +2 -2
  53. package/packages/orq-rc/src/models/operations/listdatasetdatapoints.ts +2 -2
  54. package/packages/orq-rc/src/models/operations/listdatasets.ts +2 -2
  55. package/packages/orq-rc/src/models/operations/listdatasources.ts +2 -2
  56. package/packages/orq-rc/src/models/operations/retrievecontact.ts +2 -2
  57. package/packages/orq-rc/src/models/operations/retrievedatapoint.ts +2 -2
  58. package/packages/orq-rc/src/models/operations/retrievedataset.ts +2 -2
  59. package/packages/orq-rc/src/models/operations/retrievedatasource.ts +2 -2
  60. package/packages/orq-rc/src/models/operations/updatecontact.ts +2 -2
  61. package/packages/orq-rc/src/models/operations/updatedatapoint.ts +2 -2
  62. package/packages/orq-rc/src/models/operations/updatedataset.ts +2 -2
  63. package/packages/orq-rc/src/models/operations/updatedatasource.ts +2 -2
  64. package/packages/orq-rc/src/models/operations/updateeval.ts +16 -16
  65. package/packages/orq-rc/src/sdk/knowledge.ts +0 -18
  66. package/packages/orq-rc/src/sdk/knowledgebases.ts +27 -0
  67. package/packages/orq-rc/src/sdk/sdk.ts +6 -0
  68. package/src/lib/config.ts +2 -2
  69. package/src/mcp-server/mcp-server.ts +1 -1
  70. package/src/mcp-server/server.ts +1 -1
  71. package/src/models/operations/createcontact.ts +2 -2
  72. package/src/models/operations/createdataset.ts +2 -2
  73. package/src/models/operations/createdatasetitem.ts +2 -2
  74. package/src/models/operations/createdatasource.ts +2 -2
  75. package/src/models/operations/createeval.ts +16 -16
  76. package/src/models/operations/fileget.ts +2 -2
  77. package/src/models/operations/filelist.ts +2 -2
  78. package/src/models/operations/fileupload.ts +2 -2
  79. package/src/models/operations/getevals.ts +28 -28
  80. package/src/models/operations/listcontacts.ts +2 -2
  81. package/src/models/operations/listdatasetdatapoints.ts +2 -2
  82. package/src/models/operations/listdatasets.ts +2 -2
  83. package/src/models/operations/listdatasources.ts +2 -2
  84. package/src/models/operations/retrievecontact.ts +2 -2
  85. package/src/models/operations/retrievedatapoint.ts +2 -2
  86. package/src/models/operations/retrievedataset.ts +2 -2
  87. package/src/models/operations/retrievedatasource.ts +2 -2
  88. package/src/models/operations/updatecontact.ts +2 -2
  89. package/src/models/operations/updatedatapoint.ts +2 -2
  90. package/src/models/operations/updatedataset.ts +2 -2
  91. package/src/models/operations/updatedatasource.ts +2 -2
  92. package/src/models/operations/updateeval.ts +16 -16
@@ -174,7 +174,7 @@ exports.UpdateDatasetResponseBody$inboundSchema = z.object({
174
174
  version: z.string().optional(),
175
175
  created: z.string().datetime({ offset: true }).transform(v => new Date(v))
176
176
  .optional(),
177
- updated: z.string().datetime({ offset: true }).default("2025-07-03T19:32:36.817Z").transform(v => new Date(v)),
177
+ updated: z.string().datetime({ offset: true }).default("2025-07-07T14:14:48.166Z").transform(v => new Date(v)),
178
178
  }).transform((v) => {
179
179
  return (0, primitives_js_1.remap)(v, {
180
180
  "_id": "id",
@@ -198,7 +198,7 @@ exports.UpdateDatasetResponseBody$outboundSchema = z.object({
198
198
  parentId: z.string().optional(),
199
199
  version: z.string().optional(),
200
200
  created: z.date().transform(v => v.toISOString()).optional(),
201
- updated: z.date().default(() => new Date("2025-07-03T19:32:36.817Z"))
201
+ updated: z.date().default(() => new Date("2025-07-07T14:14:48.166Z"))
202
202
  .transform(v => v.toISOString()),
203
203
  }).transform((v) => {
204
204
  return (0, primitives_js_1.remap)(v, {
@@ -144,7 +144,7 @@ var UpdateDatasourceStatus$;
144
144
  })(UpdateDatasourceStatus$ || (exports.UpdateDatasourceStatus$ = UpdateDatasourceStatus$ = {}));
145
145
  /** @internal */
146
146
  exports.UpdateDatasourceResponseBody$inboundSchema = z.object({
147
- _id: z.string().default("01JZ8WDVTTH42HGMZ8WKS2CNX6"),
147
+ _id: z.string().default("01JZJKTSMAJZTNRCH7H4TRCKG4"),
148
148
  display_name: z.string(),
149
149
  description: z.string().optional(),
150
150
  status: exports.UpdateDatasourceStatus$inboundSchema,
@@ -168,7 +168,7 @@ exports.UpdateDatasourceResponseBody$inboundSchema = z.object({
168
168
  });
169
169
  /** @internal */
170
170
  exports.UpdateDatasourceResponseBody$outboundSchema = z.object({
171
- id: z.string().default("01JZ8WDVTTH42HGMZ8WKS2CNX6"),
171
+ id: z.string().default("01JZJKTSMAJZTNRCH7H4TRCKG4"),
172
172
  displayName: z.string(),
173
173
  description: z.string().optional(),
174
174
  status: exports.UpdateDatasourceStatus$outboundSchema,
@@ -1302,8 +1302,8 @@ var UpdateEvalResponseBodyEvalsResponse200Type$;
1302
1302
  exports.UpdateEvalResponseBodyPython$inboundSchema = z.object({
1303
1303
  _id: z.string(),
1304
1304
  description: z.string(),
1305
- created: z.string().default("2025-07-03T19:32:39.016Z"),
1306
- updated: z.string().default("2025-07-03T19:32:39.016Z"),
1305
+ created: z.string().default("2025-07-07T14:14:50.239Z"),
1306
+ updated: z.string().default("2025-07-07T14:14:50.239Z"),
1307
1307
  guardrail_config: z.union([
1308
1308
  z.lazy(() => exports.UpdateEvalGuardrailConfigEvalsResponse200ApplicationJSONResponseBodyNumber$inboundSchema),
1309
1309
  z.lazy(() => exports.UpdateEvalGuardrailConfigEvalsResponse200ApplicationJSONResponseBodyBoolean$inboundSchema),
@@ -1321,8 +1321,8 @@ exports.UpdateEvalResponseBodyPython$inboundSchema = z.object({
1321
1321
  exports.UpdateEvalResponseBodyPython$outboundSchema = z.object({
1322
1322
  id: z.string(),
1323
1323
  description: z.string(),
1324
- created: z.string().default("2025-07-03T19:32:39.016Z"),
1325
- updated: z.string().default("2025-07-03T19:32:39.016Z"),
1324
+ created: z.string().default("2025-07-07T14:14:50.239Z"),
1325
+ updated: z.string().default("2025-07-07T14:14:50.239Z"),
1326
1326
  guardrailConfig: z.union([
1327
1327
  z.lazy(() => exports.UpdateEvalGuardrailConfigEvalsResponse200ApplicationJSONResponseBodyNumber$outboundSchema),
1328
1328
  z.lazy(() => exports.UpdateEvalGuardrailConfigEvalsResponse200ApplicationJSONResponseBodyBoolean$outboundSchema),
@@ -1524,8 +1524,8 @@ var UpdateEvalResponseBodyMethod$;
1524
1524
  exports.UpdateEvalResponseBodyHTTP$inboundSchema = z.object({
1525
1525
  _id: z.string(),
1526
1526
  description: z.string(),
1527
- created: z.string().default("2025-07-03T19:32:39.016Z"),
1528
- updated: z.string().default("2025-07-03T19:32:39.016Z"),
1527
+ created: z.string().default("2025-07-07T14:14:50.239Z"),
1528
+ updated: z.string().default("2025-07-07T14:14:50.239Z"),
1529
1529
  guardrail_config: z.union([
1530
1530
  z.lazy(() => exports.UpdateEvalGuardrailConfigEvalsResponse200ApplicationJSONNumber$inboundSchema),
1531
1531
  z.lazy(() => exports.UpdateEvalGuardrailConfigEvalsResponse200ApplicationJSONBoolean$inboundSchema),
@@ -1546,8 +1546,8 @@ exports.UpdateEvalResponseBodyHTTP$inboundSchema = z.object({
1546
1546
  exports.UpdateEvalResponseBodyHTTP$outboundSchema = z.object({
1547
1547
  id: z.string(),
1548
1548
  description: z.string(),
1549
- created: z.string().default("2025-07-03T19:32:39.016Z"),
1550
- updated: z.string().default("2025-07-03T19:32:39.016Z"),
1549
+ created: z.string().default("2025-07-07T14:14:50.239Z"),
1550
+ updated: z.string().default("2025-07-07T14:14:50.239Z"),
1551
1551
  guardrailConfig: z.union([
1552
1552
  z.lazy(() => exports.UpdateEvalGuardrailConfigEvalsResponse200ApplicationJSONNumber$outboundSchema),
1553
1553
  z.lazy(() => exports.UpdateEvalGuardrailConfigEvalsResponse200ApplicationJSONBoolean$outboundSchema),
@@ -1733,8 +1733,8 @@ var UpdateEvalResponseBodyEvalsType$;
1733
1733
  exports.UpdateEvalResponseBodyJSON$inboundSchema = z.object({
1734
1734
  _id: z.string(),
1735
1735
  description: z.string(),
1736
- created: z.string().default("2025-07-03T19:32:39.016Z"),
1737
- updated: z.string().default("2025-07-03T19:32:39.016Z"),
1736
+ created: z.string().default("2025-07-07T14:14:50.239Z"),
1737
+ updated: z.string().default("2025-07-07T14:14:50.239Z"),
1738
1738
  guardrail_config: z.union([
1739
1739
  z.lazy(() => exports.UpdateEvalGuardrailConfigEvalsResponse200Number$inboundSchema),
1740
1740
  z.lazy(() => exports.UpdateEvalGuardrailConfigEvalsResponse200Boolean$inboundSchema),
@@ -1752,8 +1752,8 @@ exports.UpdateEvalResponseBodyJSON$inboundSchema = z.object({
1752
1752
  exports.UpdateEvalResponseBodyJSON$outboundSchema = z.object({
1753
1753
  id: z.string(),
1754
1754
  description: z.string(),
1755
- created: z.string().default("2025-07-03T19:32:39.016Z"),
1756
- updated: z.string().default("2025-07-03T19:32:39.016Z"),
1755
+ created: z.string().default("2025-07-07T14:14:50.239Z"),
1756
+ updated: z.string().default("2025-07-07T14:14:50.239Z"),
1757
1757
  guardrailConfig: z.union([
1758
1758
  z.lazy(() => exports.UpdateEvalGuardrailConfigEvalsResponse200Number$outboundSchema),
1759
1759
  z.lazy(() => exports.UpdateEvalGuardrailConfigEvalsResponse200Boolean$outboundSchema),
@@ -1938,8 +1938,8 @@ var UpdateEvalResponseBodyType$;
1938
1938
  exports.UpdateEvalResponseBodyLLM$inboundSchema = z.object({
1939
1939
  _id: z.string(),
1940
1940
  description: z.string(),
1941
- created: z.string().default("2025-07-03T19:32:39.016Z"),
1942
- updated: z.string().default("2025-07-03T19:32:39.016Z"),
1941
+ created: z.string().default("2025-07-07T14:14:50.239Z"),
1942
+ updated: z.string().default("2025-07-07T14:14:50.239Z"),
1943
1943
  guardrail_config: z.union([
1944
1944
  z.lazy(() => exports.UpdateEvalGuardrailConfigEvalsResponseNumber$inboundSchema),
1945
1945
  z.lazy(() => exports.UpdateEvalGuardrailConfigEvalsResponseBoolean$inboundSchema),
@@ -1958,8 +1958,8 @@ exports.UpdateEvalResponseBodyLLM$inboundSchema = z.object({
1958
1958
  exports.UpdateEvalResponseBodyLLM$outboundSchema = z.object({
1959
1959
  id: z.string(),
1960
1960
  description: z.string(),
1961
- created: z.string().default("2025-07-03T19:32:39.016Z"),
1962
- updated: z.string().default("2025-07-03T19:32:39.016Z"),
1961
+ created: z.string().default("2025-07-07T14:14:50.239Z"),
1962
+ updated: z.string().default("2025-07-07T14:14:50.239Z"),
1963
1963
  guardrailConfig: z.union([
1964
1964
  z.lazy(() => exports.UpdateEvalGuardrailConfigEvalsResponseNumber$outboundSchema),
1965
1965
  z.lazy(() => exports.UpdateEvalGuardrailConfigEvalsResponseBoolean$outboundSchema),
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@orq-ai/node",
3
- "version": "3.9.3",
3
+ "version": "3.9.4",
4
4
  "author": "Orq",
5
5
  "bin": {
6
6
  "mcp": "bin/mcp-server.js"
@@ -365,7 +365,10 @@ run();
365
365
  * [updateChunk](docs/sdks/knowledge/README.md#updatechunk) - Update a chunk
366
366
  * [deleteChunk](docs/sdks/knowledge/README.md#deletechunk) - Delete a chunk
367
367
  * [retrieveChunk](docs/sdks/knowledge/README.md#retrievechunk) - Retrieve a chunk
368
- * [chunkText](docs/sdks/knowledge/README.md#chunktext) - Chunk text content using various strategies
368
+
369
+ ### [knowledgeBases](docs/sdks/knowledgebases/README.md)
370
+
371
+ * [chunkText](docs/sdks/knowledgebases/README.md#chunktext) - Chunk text
369
372
 
370
373
  ### [models](docs/sdks/models/README.md)
371
374
 
@@ -472,7 +475,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
472
475
  - [`filesDelete`](docs/sdks/files/README.md#delete) - Delete file
473
476
  - [`filesGet`](docs/sdks/files/README.md#get) - Retrieve a file
474
477
  - [`filesList`](docs/sdks/files/README.md#list) - List all files
475
- - [`knowledgeChunkText`](docs/sdks/knowledge/README.md#chunktext) - Chunk text content using various strategies
478
+ - [`knowledgeBasesChunkText`](docs/sdks/knowledgebases/README.md#chunktext) - Chunk text
476
479
  - [`knowledgeCreateChunks`](docs/sdks/knowledge/README.md#createchunks) - Create chunks for a datasource
477
480
  - [`knowledgeCreateDatasource`](docs/sdks/knowledge/README.md#createdatasource) - Create a new datasource
478
481
  - [`knowledgeDelete`](docs/sdks/knowledge/README.md#delete) - Deletes a knowledge
@@ -20,7 +20,6 @@
20
20
  * [updateChunk](#updatechunk) - Update a chunk
21
21
  * [deleteChunk](#deletechunk) - Delete a chunk
22
22
  * [retrieveChunk](#retrievechunk) - Retrieve a chunk
23
- * [chunkText](#chunktext) - Chunk text content using various strategies
24
23
 
25
24
  ## list
26
25
 
@@ -1146,92 +1145,6 @@ run();
1146
1145
 
1147
1146
  ### Errors
1148
1147
 
1149
- | Error Type | Status Code | Content Type |
1150
- | --------------- | --------------- | --------------- |
1151
- | errors.APIError | 4XX, 5XX | \*/\* |
1152
-
1153
- ## chunkText
1154
-
1155
- Split large text documents into smaller, manageable chunks using different chunking strategies optimized for RAG (Retrieval-Augmented Generation) workflows. This endpoint supports multiple chunking algorithms including token-based, sentence-based, recursive, semantic, and specialized strategies.
1156
-
1157
- ### Example Usage
1158
-
1159
- ```typescript
1160
- import { Orq } from "@orq-ai/node";
1161
-
1162
- const orq = new Orq({
1163
- apiKey: process.env["ORQ_API_KEY"] ?? "",
1164
- });
1165
-
1166
- async function run() {
1167
- const result = await orq.knowledge.chunkText({
1168
- text: "The quick brown fox jumps over the lazy dog. This is a sample text that will be chunked into smaller pieces. Each chunk will maintain context while respecting the maximum chunk size.",
1169
- metadata: true,
1170
- strategy: "semantic",
1171
- chunkSize: 256,
1172
- threshold: 0.8,
1173
- embeddingModel: "openai/text-embedding-3-small",
1174
- mode: "window",
1175
- similarityWindow: 1,
1176
- });
1177
-
1178
- console.log(result);
1179
- }
1180
-
1181
- run();
1182
- ```
1183
-
1184
- ### Standalone function
1185
-
1186
- The standalone function version of this method:
1187
-
1188
- ```typescript
1189
- import { OrqCore } from "@orq-ai/node/core.js";
1190
- import { knowledgeChunkText } from "@orq-ai/node/funcs/knowledgeChunkText.js";
1191
-
1192
- // Use `OrqCore` for best tree-shaking performance.
1193
- // You can create one instance of it to use across an application.
1194
- const orq = new OrqCore({
1195
- apiKey: process.env["ORQ_API_KEY"] ?? "",
1196
- });
1197
-
1198
- async function run() {
1199
- const res = await knowledgeChunkText(orq, {
1200
- text: "The quick brown fox jumps over the lazy dog. This is a sample text that will be chunked into smaller pieces. Each chunk will maintain context while respecting the maximum chunk size.",
1201
- metadata: true,
1202
- strategy: "semantic",
1203
- chunkSize: 256,
1204
- threshold: 0.8,
1205
- embeddingModel: "openai/text-embedding-3-small",
1206
- mode: "window",
1207
- similarityWindow: 1,
1208
- });
1209
- if (res.ok) {
1210
- const { value: result } = res;
1211
- console.log(result);
1212
- } else {
1213
- console.log("knowledgeChunkText failed:", res.error);
1214
- }
1215
- }
1216
-
1217
- run();
1218
- ```
1219
-
1220
- ### Parameters
1221
-
1222
- | Parameter | Type | Required | Description |
1223
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1224
- | `request` | [operations.ChunkTextChunkingRequest](../../models/operations/chunktextchunkingrequest.md) | :heavy_check_mark: | The request object to use for the request. |
1225
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1226
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
1227
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1228
-
1229
- ### Response
1230
-
1231
- **Promise\<[operations.ChunkTextResponseBody](../../models/operations/chunktextresponsebody.md)\>**
1232
-
1233
- ### Errors
1234
-
1235
1148
  | Error Type | Status Code | Content Type |
1236
1149
  | --------------- | --------------- | --------------- |
1237
1150
  | errors.APIError | 4XX, 5XX | \*/\* |
@@ -0,0 +1,94 @@
1
+ # KnowledgeBases
2
+ (*knowledgeBases*)
3
+
4
+ ## Overview
5
+
6
+ ### Available Operations
7
+
8
+ * [chunkText](#chunktext) - Chunk text
9
+
10
+ ## chunkText
11
+
12
+ Split large text documents into smaller, manageable chunks using different chunking strategies optimized for RAG (Retrieval-Augmented Generation) workflows. This endpoint supports multiple chunking algorithms including token-based, sentence-based, recursive, semantic, and specialized strategies.
13
+
14
+ ### Example Usage
15
+
16
+ ```typescript
17
+ import { Orq } from "@orq-ai/node";
18
+
19
+ const orq = new Orq({
20
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
21
+ });
22
+
23
+ async function run() {
24
+ const result = await orq.knowledgeBases.chunkText({
25
+ text: "The quick brown fox jumps over the lazy dog. This is a sample text that will be chunked into smaller pieces. Each chunk will maintain context while respecting the maximum chunk size.",
26
+ metadata: true,
27
+ strategy: "semantic",
28
+ chunkSize: 256,
29
+ threshold: 0.8,
30
+ embeddingModel: "openai/text-embedding-3-small",
31
+ mode: "window",
32
+ similarityWindow: 1,
33
+ });
34
+
35
+ console.log(result);
36
+ }
37
+
38
+ run();
39
+ ```
40
+
41
+ ### Standalone function
42
+
43
+ The standalone function version of this method:
44
+
45
+ ```typescript
46
+ import { OrqCore } from "@orq-ai/node/core.js";
47
+ import { knowledgeBasesChunkText } from "@orq-ai/node/funcs/knowledgeBasesChunkText.js";
48
+
49
+ // Use `OrqCore` for best tree-shaking performance.
50
+ // You can create one instance of it to use across an application.
51
+ const orq = new OrqCore({
52
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
53
+ });
54
+
55
+ async function run() {
56
+ const res = await knowledgeBasesChunkText(orq, {
57
+ text: "The quick brown fox jumps over the lazy dog. This is a sample text that will be chunked into smaller pieces. Each chunk will maintain context while respecting the maximum chunk size.",
58
+ metadata: true,
59
+ strategy: "semantic",
60
+ chunkSize: 256,
61
+ threshold: 0.8,
62
+ embeddingModel: "openai/text-embedding-3-small",
63
+ mode: "window",
64
+ similarityWindow: 1,
65
+ });
66
+ if (res.ok) {
67
+ const { value: result } = res;
68
+ console.log(result);
69
+ } else {
70
+ console.log("knowledgeBasesChunkText failed:", res.error);
71
+ }
72
+ }
73
+
74
+ run();
75
+ ```
76
+
77
+ ### Parameters
78
+
79
+ | Parameter | Type | Required | Description |
80
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
81
+ | `request` | [operations.ChunkTextChunkingRequest](../../models/operations/chunktextchunkingrequest.md) | :heavy_check_mark: | The request object to use for the request. |
82
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
83
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
84
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
85
+
86
+ ### Response
87
+
88
+ **Promise\<[operations.ChunkTextResponseBody](../../models/operations/chunktextresponsebody.md)\>**
89
+
90
+ ### Errors
91
+
92
+ | Error Type | Status Code | Content Type |
93
+ | --------------- | --------------- | --------------- |
94
+ | errors.APIError | 4XX, 5XX | \*/\* |
@@ -2,7 +2,7 @@
2
2
 
3
3
  {
4
4
  "name": "@orq-ai/node",
5
- "version": "3.9.0-rc.13",
5
+ "version": "3.10.0-rc.0",
6
6
  "exports": {
7
7
  ".": "./src/index.ts",
8
8
  "./models/errors": "./src/models/errors/index.ts",
@@ -1,12 +1,12 @@
1
1
  {
2
2
  "name": "@orq-ai/node",
3
- "version": "3.9.0-rc.13",
3
+ "version": "3.10.0-rc.0",
4
4
  "lockfileVersion": 3,
5
5
  "requires": true,
6
6
  "packages": {
7
7
  "": {
8
8
  "name": "@orq-ai/node",
9
- "version": "3.9.0-rc.13",
9
+ "version": "3.10.0-rc.0",
10
10
  "bin": {
11
11
  "mcp": "bin/mcp-server.js"
12
12
  },
@@ -15,8 +15,8 @@
15
15
  "@modelcontextprotocol/sdk": ">=1.5.0 <1.10.0",
16
16
  "@stricli/core": "^1.1.1",
17
17
  "@types/express": "^4.17.21",
18
- "bun": "^1.2.2",
19
- "bun-types": "^1.2.2",
18
+ "bun": "1.2.17",
19
+ "bun-types": "1.2.17",
20
20
  "eslint": "^9.19.0",
21
21
  "express": "^4.21.2",
22
22
  "globals": "^15.14.0",
@@ -332,9 +332,9 @@
332
332
  }
333
333
  },
334
334
  "node_modules/@oven/bun-darwin-aarch64": {
335
- "version": "1.2.3",
336
- "resolved": "https://registry.npmjs.org/@oven/bun-darwin-aarch64/-/bun-darwin-aarch64-1.2.3.tgz",
337
- "integrity": "sha512-wEUBqSD7KDUx6xcOlNs/lDcbzJYH9CEPVZzAaJ+F3Zp8hORQYJ07byidQ0YgNMc1QhJq4xLaClMDLga6u2abIQ==",
335
+ "version": "1.2.17",
336
+ "resolved": "https://registry.npmjs.org/@oven/bun-darwin-aarch64/-/bun-darwin-aarch64-1.2.17.tgz",
337
+ "integrity": "sha512-66Xjz3NZXUUWKZJPvWKuwEkaqMZpir1Gm4SbhbB2iiRSSTW8jqwdkSb9RhgTCDt5OnSPd3+Cq0WsP/T5ExJbhA==",
338
338
  "cpu": [
339
339
  "arm64"
340
340
  ],
@@ -346,9 +346,9 @@
346
346
  ]
347
347
  },
348
348
  "node_modules/@oven/bun-darwin-x64": {
349
- "version": "1.2.3",
350
- "resolved": "https://registry.npmjs.org/@oven/bun-darwin-x64/-/bun-darwin-x64-1.2.3.tgz",
351
- "integrity": "sha512-kBeKYLNAwQrcJ1HPcuDGo3PGEfDvzHbL5N5kiaui1+eluyCS2yJZvuy2ddg9b0vqQkgzNu7D1keiRLpdR2Wneg==",
349
+ "version": "1.2.17",
350
+ "resolved": "https://registry.npmjs.org/@oven/bun-darwin-x64/-/bun-darwin-x64-1.2.17.tgz",
351
+ "integrity": "sha512-OMJMHpcpBlWcVnWfSQ6x+8fF7HpkQLqBfoIvzxgUjIZZvj2d8K46XX4N/h62RglDEinRC9VDGxt24vwvlk5tTw==",
352
352
  "cpu": [
353
353
  "x64"
354
354
  ],
@@ -360,9 +360,9 @@
360
360
  ]
361
361
  },
362
362
  "node_modules/@oven/bun-darwin-x64-baseline": {
363
- "version": "1.2.3",
364
- "resolved": "https://registry.npmjs.org/@oven/bun-darwin-x64-baseline/-/bun-darwin-x64-baseline-1.2.3.tgz",
365
- "integrity": "sha512-oYqGnocQ7eY5wfthGivpXd0lzLYklXU4rEKXU4+oLaiFeFnY3lyszv85UHjywuB5bl7xybmSIE8tN8ie36WY1w==",
363
+ "version": "1.2.17",
364
+ "resolved": "https://registry.npmjs.org/@oven/bun-darwin-x64-baseline/-/bun-darwin-x64-baseline-1.2.17.tgz",
365
+ "integrity": "sha512-VSIctl90tV8yg1LRMvPg/8LgUzl55Q7Jcxe+u6PfuvLQIJOTIPbNn7HtRpJg7MGc3+qyztB5KDd70xC7qI2yEg==",
366
366
  "cpu": [
367
367
  "x64"
368
368
  ],
@@ -374,9 +374,9 @@
374
374
  ]
375
375
  },
376
376
  "node_modules/@oven/bun-linux-aarch64": {
377
- "version": "1.2.3",
378
- "resolved": "https://registry.npmjs.org/@oven/bun-linux-aarch64/-/bun-linux-aarch64-1.2.3.tgz",
379
- "integrity": "sha512-hbi7ykhLAtoBZl7mox5Qg6xVy9FcnPNibo/h6A1oElXBl4pRaVGNFDsuDmb80f9sFf4yZL0vwYyb47hL89MiGw==",
377
+ "version": "1.2.17",
378
+ "resolved": "https://registry.npmjs.org/@oven/bun-linux-aarch64/-/bun-linux-aarch64-1.2.17.tgz",
379
+ "integrity": "sha512-KPoMqaibCXcSv+VZ3uMqKUNZqMxE6Hho1be6+laolYGOIJxJTMnZPfmKfIlQmnnW3vLlm3g2Rm8pPPC7doSHWg==",
380
380
  "cpu": [
381
381
  "arm64"
382
382
  ],
@@ -388,9 +388,9 @@
388
388
  ]
389
389
  },
390
390
  "node_modules/@oven/bun-linux-aarch64-musl": {
391
- "version": "1.2.3",
392
- "resolved": "https://registry.npmjs.org/@oven/bun-linux-aarch64-musl/-/bun-linux-aarch64-musl-1.2.3.tgz",
393
- "integrity": "sha512-nSB6FU29OW+8zUP5jRrQEAXl9m6Jd8vp5Swplh3prc0L0niYdtan39wouCxDVFNJafC0DaeKQme4UMQJ65s9qw==",
391
+ "version": "1.2.17",
392
+ "resolved": "https://registry.npmjs.org/@oven/bun-linux-aarch64-musl/-/bun-linux-aarch64-musl-1.2.17.tgz",
393
+ "integrity": "sha512-PH+hUV+I6DGD1VRHdAIAKEAOed+GSdvn6S1b3qqX27/VuHBU781V+hzt+6DBlcWBHYLw8PIg9sfIdNp485gQmw==",
394
394
  "cpu": [
395
395
  "aarch64"
396
396
  ],
@@ -402,9 +402,9 @@
402
402
  ]
403
403
  },
404
404
  "node_modules/@oven/bun-linux-x64": {
405
- "version": "1.2.3",
406
- "resolved": "https://registry.npmjs.org/@oven/bun-linux-x64/-/bun-linux-x64-1.2.3.tgz",
407
- "integrity": "sha512-oxubd+zJW8+1H02bwzne8lj2EtvgoRU6w245hWMtwjo15IET/YGc01ndFRd42FX02bwo926N+7Jm7NFzS8GOHQ==",
405
+ "version": "1.2.17",
406
+ "resolved": "https://registry.npmjs.org/@oven/bun-linux-x64/-/bun-linux-x64-1.2.17.tgz",
407
+ "integrity": "sha512-BfySnrTxp7D9hVUi9JEpviJl8ndsuESiRiQKTzgmdTLrMjUxP4SwrwMtYt6R9X20n9rREG6a47C0IyQMhbwG/g==",
408
408
  "cpu": [
409
409
  "x64"
410
410
  ],
@@ -416,9 +416,9 @@
416
416
  ]
417
417
  },
418
418
  "node_modules/@oven/bun-linux-x64-baseline": {
419
- "version": "1.2.3",
420
- "resolved": "https://registry.npmjs.org/@oven/bun-linux-x64-baseline/-/bun-linux-x64-baseline-1.2.3.tgz",
421
- "integrity": "sha512-PrkC18s81ImpHMdqgFXvyq9Oxed8mzlYb709DsuuoV9NL3nrzQzfqq8JStz/g3dYMc4obrljG/EKXGfMaJMJVA==",
419
+ "version": "1.2.17",
420
+ "resolved": "https://registry.npmjs.org/@oven/bun-linux-x64-baseline/-/bun-linux-x64-baseline-1.2.17.tgz",
421
+ "integrity": "sha512-IrnFMUwYWxoKICQgK8ZlJ6rI/HU2gITFNEW0MIOPIcuT0s3j0/33631M9EzYDoL4NuLQPks6569JDvSHEVqdeA==",
422
422
  "cpu": [
423
423
  "x64"
424
424
  ],
@@ -430,9 +430,9 @@
430
430
  ]
431
431
  },
432
432
  "node_modules/@oven/bun-linux-x64-musl": {
433
- "version": "1.2.3",
434
- "resolved": "https://registry.npmjs.org/@oven/bun-linux-x64-musl/-/bun-linux-x64-musl-1.2.3.tgz",
435
- "integrity": "sha512-481HyvBKKXrKH2VZsSBVsqsqxcnncqpsKz7qgTqnSEToCSyNqc3bGrI6pN6haI9nLawJpIh+oNXCg4JISUi6bg==",
433
+ "version": "1.2.17",
434
+ "resolved": "https://registry.npmjs.org/@oven/bun-linux-x64-musl/-/bun-linux-x64-musl-1.2.17.tgz",
435
+ "integrity": "sha512-fW9qn/WqO131/qSIkIPW8zN+thQnYUWa/k98EWubLG87htKSPh1v023E5ikKb7WlUv4Yb6UlE/z4NmMYKffmAg==",
436
436
  "cpu": [
437
437
  "x64"
438
438
  ],
@@ -444,9 +444,9 @@
444
444
  ]
445
445
  },
446
446
  "node_modules/@oven/bun-linux-x64-musl-baseline": {
447
- "version": "1.2.3",
448
- "resolved": "https://registry.npmjs.org/@oven/bun-linux-x64-musl-baseline/-/bun-linux-x64-musl-baseline-1.2.3.tgz",
449
- "integrity": "sha512-1VsFwYMOryIsnTGPG70N1HAXoa8Fa7s+XAtP2Y010tao0omgpM0S6Go0Uc7VJ8g+yHKyIw79leRMwUs35ysQZA==",
447
+ "version": "1.2.17",
448
+ "resolved": "https://registry.npmjs.org/@oven/bun-linux-x64-musl-baseline/-/bun-linux-x64-musl-baseline-1.2.17.tgz",
449
+ "integrity": "sha512-YE5wQ/YA79BykMLhuwgdoF8Yjj5dRipD8dwmXs8n7gzR+/L9tL7Q69NQgskW2KkAalmWPoGAv3TV0IwbU+1dFw==",
450
450
  "cpu": [
451
451
  "x64"
452
452
  ],
@@ -458,9 +458,9 @@
458
458
  ]
459
459
  },
460
460
  "node_modules/@oven/bun-windows-x64": {
461
- "version": "1.2.3",
462
- "resolved": "https://registry.npmjs.org/@oven/bun-windows-x64/-/bun-windows-x64-1.2.3.tgz",
463
- "integrity": "sha512-z3G7jft1hbiiX47rY666i3HFJZBqCLgddr7e0ccoE/kUk4U5IB08mqJZYW0vaaL8zy0wuEF2h5VkK0S/iryLWw==",
461
+ "version": "1.2.17",
462
+ "resolved": "https://registry.npmjs.org/@oven/bun-windows-x64/-/bun-windows-x64-1.2.17.tgz",
463
+ "integrity": "sha512-GJUg1oA59DWH6eyV8uccpgfTEVxjmgfTWQCOl2ySMXR3IfRoFwS4aQfpjcVzNmEZrv8eYt+yMuw1K7aNcWTTIg==",
464
464
  "cpu": [
465
465
  "x64"
466
466
  ],
@@ -472,9 +472,9 @@
472
472
  ]
473
473
  },
474
474
  "node_modules/@oven/bun-windows-x64-baseline": {
475
- "version": "1.2.3",
476
- "resolved": "https://registry.npmjs.org/@oven/bun-windows-x64-baseline/-/bun-windows-x64-baseline-1.2.3.tgz",
477
- "integrity": "sha512-pvtDgWRclz/bxLEWUAppj854MklfTu01DfHAvKzV1UAHbBOlurC8+StpE7EhITAHC/jBK9U39eVYnZNvumVU9w==",
475
+ "version": "1.2.17",
476
+ "resolved": "https://registry.npmjs.org/@oven/bun-windows-x64-baseline/-/bun-windows-x64-baseline-1.2.17.tgz",
477
+ "integrity": "sha512-aVkq4l1yZ9VKfBOtZ2HEj0OCU5kUe3Fx6LbAG6oY6OglWVYj051i3RGaE2OdR4L4F2jDyxzfGYRTM/qs8nU5qA==",
478
478
  "cpu": [
479
479
  "x64"
480
480
  ],
@@ -614,16 +614,6 @@
614
614
  "@types/send": "*"
615
615
  }
616
616
  },
617
- "node_modules/@types/ws": {
618
- "version": "8.5.14",
619
- "resolved": "https://registry.npmjs.org/@types/ws/-/ws-8.5.14.tgz",
620
- "integrity": "sha512-bd/YFLW+URhBzMXurx7lWByOu+xzU9+kb3RboOteXYDfW+tr+JZa99OyNmPINEGB/ahzKrEuc8rcv4gnpJmxTw==",
621
- "dev": true,
622
- "license": "MIT",
623
- "dependencies": {
624
- "@types/node": "*"
625
- }
626
- },
627
617
  "node_modules/@typescript-eslint/type-utils": {
628
618
  "version": "8.22.0",
629
619
  "resolved": "https://registry.npmjs.org/@typescript-eslint/type-utils/-/type-utils-8.22.0.tgz",
@@ -1033,9 +1023,9 @@
1033
1023
  }
1034
1024
  },
1035
1025
  "node_modules/bun": {
1036
- "version": "1.2.3",
1037
- "resolved": "https://registry.npmjs.org/bun/-/bun-1.2.3.tgz",
1038
- "integrity": "sha512-i8F+I3wxmt9omnLh3lOg0APQtqxZaMU0x6xuC+9YH4Eg/7fu8SM4YbdwyvV8Z6sy3OMtGFB0SYOjU2STuId4FQ==",
1026
+ "version": "1.2.17",
1027
+ "resolved": "https://registry.npmjs.org/bun/-/bun-1.2.17.tgz",
1028
+ "integrity": "sha512-lrUZTWS24eVy6v+Eph8VTwqFPcG7/XQ0rLBQEMNoQs2Vd7ctVdMGAzJKKGZRUQH+rgkD8rBeHGIVoWxX4vJLCA==",
1039
1029
  "cpu": [
1040
1030
  "arm64",
1041
1031
  "x64",
@@ -1051,31 +1041,30 @@
1051
1041
  ],
1052
1042
  "bin": {
1053
1043
  "bun": "bin/bun.exe",
1054
- "bunx": "bin/bun.exe"
1044
+ "bunx": "bin/bunx.exe"
1055
1045
  },
1056
1046
  "optionalDependencies": {
1057
- "@oven/bun-darwin-aarch64": "1.2.3",
1058
- "@oven/bun-darwin-x64": "1.2.3",
1059
- "@oven/bun-darwin-x64-baseline": "1.2.3",
1060
- "@oven/bun-linux-aarch64": "1.2.3",
1061
- "@oven/bun-linux-aarch64-musl": "1.2.3",
1062
- "@oven/bun-linux-x64": "1.2.3",
1063
- "@oven/bun-linux-x64-baseline": "1.2.3",
1064
- "@oven/bun-linux-x64-musl": "1.2.3",
1065
- "@oven/bun-linux-x64-musl-baseline": "1.2.3",
1066
- "@oven/bun-windows-x64": "1.2.3",
1067
- "@oven/bun-windows-x64-baseline": "1.2.3"
1047
+ "@oven/bun-darwin-aarch64": "1.2.17",
1048
+ "@oven/bun-darwin-x64": "1.2.17",
1049
+ "@oven/bun-darwin-x64-baseline": "1.2.17",
1050
+ "@oven/bun-linux-aarch64": "1.2.17",
1051
+ "@oven/bun-linux-aarch64-musl": "1.2.17",
1052
+ "@oven/bun-linux-x64": "1.2.17",
1053
+ "@oven/bun-linux-x64-baseline": "1.2.17",
1054
+ "@oven/bun-linux-x64-musl": "1.2.17",
1055
+ "@oven/bun-linux-x64-musl-baseline": "1.2.17",
1056
+ "@oven/bun-windows-x64": "1.2.17",
1057
+ "@oven/bun-windows-x64-baseline": "1.2.17"
1068
1058
  }
1069
1059
  },
1070
1060
  "node_modules/bun-types": {
1071
- "version": "1.2.3",
1072
- "resolved": "https://registry.npmjs.org/bun-types/-/bun-types-1.2.3.tgz",
1073
- "integrity": "sha512-P7AeyTseLKAvgaZqQrvp3RqFM3yN9PlcLuSTe7SoJOfZkER73mLdT2vEQi8U64S1YvM/ldcNiQjn0Sn7H9lGgg==",
1061
+ "version": "1.2.17",
1062
+ "resolved": "https://registry.npmjs.org/bun-types/-/bun-types-1.2.17.tgz",
1063
+ "integrity": "sha512-ElC7ItwT3SCQwYZDYoAH+q6KT4Fxjl8DtZ6qDulUFBmXA8YB4xo+l54J9ZJN+k2pphfn9vk7kfubeSd5QfTVJQ==",
1074
1064
  "dev": true,
1075
1065
  "license": "MIT",
1076
1066
  "dependencies": {
1077
- "@types/node": "*",
1078
- "@types/ws": "~8.5.10"
1067
+ "@types/node": "*"
1079
1068
  }
1080
1069
  },
1081
1070
  "node_modules/bytes": {
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@orq-ai/node",
3
- "version": "3.9.0-rc.13",
3
+ "version": "3.10.0-rc.0",
4
4
  "author": "Orq",
5
5
  "bin": {
6
6
  "mcp": "bin/mcp-server.js"
@@ -30,8 +30,8 @@
30
30
  "@modelcontextprotocol/sdk": ">=1.5.0 <1.10.0",
31
31
  "@stricli/core": "^1.1.1",
32
32
  "@types/express": "^4.17.21",
33
- "bun": "^1.2.2",
34
- "bun-types": "^1.2.2",
33
+ "bun": "1.2.17",
34
+ "bun-types": "1.2.17",
35
35
  "eslint": "^9.19.0",
36
36
  "express": "^4.21.2",
37
37
  "globals": "^15.14.0",