@orq-ai/node 3.8.3 → 3.8.5

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 (107) hide show
  1. package/bin/mcp-server.js +104 -104
  2. package/bin/mcp-server.js.map +26 -26
  3. package/jsr.json +1 -1
  4. package/lib/config.d.ts +3 -3
  5. package/lib/config.js +3 -3
  6. package/mcp-server/mcp-server.js +1 -1
  7. package/mcp-server/server.js +1 -1
  8. package/models/operations/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 +95 -83
  32. package/packages/orq-rc/docs/sdks/evals/README.md +213 -0
  33. package/packages/orq-rc/docs/sdks/knowledge/README.md +87 -77
  34. package/packages/orq-rc/jsr.json +1 -1
  35. package/packages/orq-rc/package-lock.json +2 -2
  36. package/packages/orq-rc/package.json +1 -1
  37. package/packages/orq-rc/src/funcs/evalsRagasContextEntitiesRecall.ts +183 -0
  38. package/packages/orq-rc/src/funcs/evalsRagasContextRecall.ts +177 -0
  39. package/packages/orq-rc/src/funcs/evalsRagasNoiseSensitivity.ts +180 -0
  40. package/packages/orq-rc/src/funcs/{knowledgeCreate.ts → knowledgeChunkText.ts} +13 -11
  41. package/packages/orq-rc/src/lib/config.ts +3 -3
  42. package/packages/orq-rc/src/mcp-server/mcp-server.ts +1 -1
  43. package/packages/orq-rc/src/mcp-server/server.ts +9 -3
  44. package/packages/orq-rc/src/mcp-server/tools/evalsRagasContextEntitiesRecall.ts +37 -0
  45. package/packages/orq-rc/src/mcp-server/tools/{knowledgeCreate.ts → evalsRagasContextRecall.ts} +7 -6
  46. package/packages/orq-rc/src/mcp-server/tools/evalsRagasNoiseSensitivity.ts +36 -0
  47. package/packages/orq-rc/src/mcp-server/tools/knowledgeChunkText.ts +37 -0
  48. package/packages/orq-rc/src/models/errors/evalsragascontextentitiesrecall.ts +167 -0
  49. package/packages/orq-rc/src/models/errors/evalsragascontextrecall.ts +162 -0
  50. package/packages/orq-rc/src/models/errors/evalsragasnoisesensitivity.ts +164 -0
  51. package/packages/orq-rc/src/models/errors/index.ts +3 -0
  52. package/packages/orq-rc/src/models/operations/chunktext.ts +1623 -0
  53. package/packages/orq-rc/src/models/operations/createcontact.ts +2 -2
  54. package/packages/orq-rc/src/models/operations/createdataset.ts +2 -2
  55. package/packages/orq-rc/src/models/operations/createdatasetitem.ts +2 -2
  56. package/packages/orq-rc/src/models/operations/createdatasource.ts +2 -2
  57. package/packages/orq-rc/src/models/operations/createeval.ts +16 -16
  58. package/packages/orq-rc/src/models/operations/evalsragascontextentitiesrecall.ts +164 -0
  59. package/packages/orq-rc/src/models/operations/evalsragascontextrecall.ts +164 -0
  60. package/packages/orq-rc/src/models/operations/evalsragasnoisesensitivity.ts +166 -0
  61. package/packages/orq-rc/src/models/operations/fileget.ts +2 -2
  62. package/packages/orq-rc/src/models/operations/filelist.ts +2 -2
  63. package/packages/orq-rc/src/models/operations/fileupload.ts +2 -2
  64. package/packages/orq-rc/src/models/operations/getevals.ts +29 -28
  65. package/packages/orq-rc/src/models/operations/index.ts +4 -1
  66. package/packages/orq-rc/src/models/operations/listcontacts.ts +2 -2
  67. package/packages/orq-rc/src/models/operations/listdatasetdatapoints.ts +2 -2
  68. package/packages/orq-rc/src/models/operations/listdatasets.ts +2 -2
  69. package/packages/orq-rc/src/models/operations/listdatasources.ts +2 -2
  70. package/packages/orq-rc/src/models/operations/retrievecontact.ts +2 -2
  71. package/packages/orq-rc/src/models/operations/retrievedatapoint.ts +2 -2
  72. package/packages/orq-rc/src/models/operations/retrievedataset.ts +2 -2
  73. package/packages/orq-rc/src/models/operations/retrievedatasource.ts +2 -2
  74. package/packages/orq-rc/src/models/operations/updatecontact.ts +2 -2
  75. package/packages/orq-rc/src/models/operations/updatedatapoint.ts +2 -2
  76. package/packages/orq-rc/src/models/operations/updatedataset.ts +2 -2
  77. package/packages/orq-rc/src/models/operations/updatedatasource.ts +2 -2
  78. package/packages/orq-rc/src/models/operations/updateeval.ts +16 -16
  79. package/packages/orq-rc/src/models/operations/updateknowledge.ts +206 -266
  80. package/packages/orq-rc/src/sdk/evals.ts +45 -0
  81. package/packages/orq-rc/src/sdk/knowledge.ts +18 -15
  82. package/src/lib/config.ts +3 -3
  83. package/src/mcp-server/mcp-server.ts +1 -1
  84. package/src/mcp-server/server.ts +1 -1
  85. package/src/models/operations/createcontact.ts +2 -2
  86. package/src/models/operations/createdataset.ts +2 -2
  87. package/src/models/operations/createdatasetitem.ts +2 -2
  88. package/src/models/operations/createdatasource.ts +2 -2
  89. package/src/models/operations/createeval.ts +16 -16
  90. package/src/models/operations/fileget.ts +2 -2
  91. package/src/models/operations/filelist.ts +2 -2
  92. package/src/models/operations/fileupload.ts +2 -2
  93. package/src/models/operations/getevals.ts +28 -28
  94. package/src/models/operations/listcontacts.ts +2 -2
  95. package/src/models/operations/listdatasetdatapoints.ts +2 -2
  96. package/src/models/operations/listdatasets.ts +2 -2
  97. package/src/models/operations/listdatasources.ts +2 -2
  98. package/src/models/operations/retrievecontact.ts +2 -2
  99. package/src/models/operations/retrievedatapoint.ts +2 -2
  100. package/src/models/operations/retrievedataset.ts +2 -2
  101. package/src/models/operations/retrievedatasource.ts +2 -2
  102. package/src/models/operations/updatecontact.ts +2 -2
  103. package/src/models/operations/updatedatapoint.ts +2 -2
  104. package/src/models/operations/updatedataset.ts +2 -2
  105. package/src/models/operations/updatedatasource.ts +2 -2
  106. package/src/models/operations/updateeval.ts +16 -16
  107. package/packages/orq-rc/src/models/operations/createknowledge.ts +0 -846
@@ -37,10 +37,13 @@
37
37
  * [ragasCoherence](#ragascoherence) - Run Coherence Evaluator
38
38
  * [ragasConciseness](#ragasconciseness) - Run Conciseness Evaluator
39
39
  * [ragasContextPrecision](#ragascontextprecision) - Run Context Precision Evaluator
40
+ * [ragasContextRecall](#ragascontextrecall) - Run Context Recall Evaluator
41
+ * [ragasContextEntitiesRecall](#ragascontextentitiesrecall) - Run Context Entities Recall Evaluator
40
42
  * [ragasCorrectness](#ragascorrectness) - Run Correctness Evaluator
41
43
  * [ragasFaithfulness](#ragasfaithfulness) - Run Faithfulness Evaluator
42
44
  * [ragasHarmfulness](#ragasharmfulness) - Run Harmfulness Evaluator
43
45
  * [ragasMaliciousness](#ragasmaliciousness) - Run Maliciousness Evaluator
46
+ * [ragasNoiseSensitivity](#ragasnoisesensitivity) - Run Noise Sensitivity Evaluator
44
47
  * [ragasResponseRelevancy](#ragasresponserelevancy) - Run Response Relevancy Evaluator
45
48
  * [ragasSummarization](#ragassummarization) - Run Summarization Evaluator
46
49
  * [invoke](#invoke) - Invoke a Custom Evaluator
@@ -2327,6 +2330,146 @@ run();
2327
2330
  | errors.EvalsRagasContextPrecisionEvalsResponseBody | 500 | application/json |
2328
2331
  | errors.APIError | 4XX, 5XX | \*/\* |
2329
2332
 
2333
+ ## ragasContextRecall
2334
+
2335
+ Run Context Recall Evaluator
2336
+
2337
+ ### Example Usage
2338
+
2339
+ ```typescript
2340
+ import { Orq } from "@orq-ai/node";
2341
+
2342
+ const orq = new Orq({
2343
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
2344
+ });
2345
+
2346
+ async function run() {
2347
+ const result = await orq.evals.ragasContextRecall();
2348
+
2349
+ console.log(result);
2350
+ }
2351
+
2352
+ run();
2353
+ ```
2354
+
2355
+ ### Standalone function
2356
+
2357
+ The standalone function version of this method:
2358
+
2359
+ ```typescript
2360
+ import { OrqCore } from "@orq-ai/node/core.js";
2361
+ import { evalsRagasContextRecall } from "@orq-ai/node/funcs/evalsRagasContextRecall.js";
2362
+
2363
+ // Use `OrqCore` for best tree-shaking performance.
2364
+ // You can create one instance of it to use across an application.
2365
+ const orq = new OrqCore({
2366
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
2367
+ });
2368
+
2369
+ async function run() {
2370
+ const res = await evalsRagasContextRecall(orq);
2371
+ if (res.ok) {
2372
+ const { value: result } = res;
2373
+ console.log(result);
2374
+ } else {
2375
+ console.log("evalsRagasContextRecall failed:", res.error);
2376
+ }
2377
+ }
2378
+
2379
+ run();
2380
+ ```
2381
+
2382
+ ### Parameters
2383
+
2384
+ | Parameter | Type | Required | Description |
2385
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
2386
+ | `request` | [operations.EvalsRagasContextRecallRequestBody](../../models/operations/evalsragascontextrecallrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
2387
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
2388
+ | `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. |
2389
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
2390
+
2391
+ ### Response
2392
+
2393
+ **Promise\<[operations.EvalsRagasContextRecallResponseBody](../../models/operations/evalsragascontextrecallresponsebody.md)\>**
2394
+
2395
+ ### Errors
2396
+
2397
+ | Error Type | Status Code | Content Type |
2398
+ | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- |
2399
+ | errors.EvalsRagasContextRecallResponseBody | 404 | application/json |
2400
+ | errors.EvalsRagasContextRecallEvalsResponseBody | 500 | application/json |
2401
+ | errors.APIError | 4XX, 5XX | \*/\* |
2402
+
2403
+ ## ragasContextEntitiesRecall
2404
+
2405
+ Run Context Entities Recall Evaluator
2406
+
2407
+ ### Example Usage
2408
+
2409
+ ```typescript
2410
+ import { Orq } from "@orq-ai/node";
2411
+
2412
+ const orq = new Orq({
2413
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
2414
+ });
2415
+
2416
+ async function run() {
2417
+ const result = await orq.evals.ragasContextEntitiesRecall();
2418
+
2419
+ console.log(result);
2420
+ }
2421
+
2422
+ run();
2423
+ ```
2424
+
2425
+ ### Standalone function
2426
+
2427
+ The standalone function version of this method:
2428
+
2429
+ ```typescript
2430
+ import { OrqCore } from "@orq-ai/node/core.js";
2431
+ import { evalsRagasContextEntitiesRecall } from "@orq-ai/node/funcs/evalsRagasContextEntitiesRecall.js";
2432
+
2433
+ // Use `OrqCore` for best tree-shaking performance.
2434
+ // You can create one instance of it to use across an application.
2435
+ const orq = new OrqCore({
2436
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
2437
+ });
2438
+
2439
+ async function run() {
2440
+ const res = await evalsRagasContextEntitiesRecall(orq);
2441
+ if (res.ok) {
2442
+ const { value: result } = res;
2443
+ console.log(result);
2444
+ } else {
2445
+ console.log("evalsRagasContextEntitiesRecall failed:", res.error);
2446
+ }
2447
+ }
2448
+
2449
+ run();
2450
+ ```
2451
+
2452
+ ### Parameters
2453
+
2454
+ | Parameter | Type | Required | Description |
2455
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
2456
+ | `request` | [operations.EvalsRagasContextEntitiesRecallRequestBody](../../models/operations/evalsragascontextentitiesrecallrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
2457
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
2458
+ | `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. |
2459
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
2460
+
2461
+ ### Response
2462
+
2463
+ **Promise\<[operations.EvalsRagasContextEntitiesRecallResponseBody](../../models/operations/evalsragascontextentitiesrecallresponsebody.md)\>**
2464
+
2465
+ ### Errors
2466
+
2467
+ | Error Type | Status Code | Content Type |
2468
+ | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
2469
+ | errors.EvalsRagasContextEntitiesRecallResponseBody | 404 | application/json |
2470
+ | errors.EvalsRagasContextEntitiesRecallEvalsResponseBody | 500 | application/json |
2471
+ | errors.APIError | 4XX, 5XX | \*/\* |
2472
+
2330
2473
  ## ragasCorrectness
2331
2474
 
2332
2475
  Run Correctness Evaluator
@@ -2607,6 +2750,76 @@ run();
2607
2750
  | errors.EvalsRagasMaliciousnessEvalsResponseBody | 500 | application/json |
2608
2751
  | errors.APIError | 4XX, 5XX | \*/\* |
2609
2752
 
2753
+ ## ragasNoiseSensitivity
2754
+
2755
+ Run Noise Sensitivity Evaluator
2756
+
2757
+ ### Example Usage
2758
+
2759
+ ```typescript
2760
+ import { Orq } from "@orq-ai/node";
2761
+
2762
+ const orq = new Orq({
2763
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
2764
+ });
2765
+
2766
+ async function run() {
2767
+ const result = await orq.evals.ragasNoiseSensitivity();
2768
+
2769
+ console.log(result);
2770
+ }
2771
+
2772
+ run();
2773
+ ```
2774
+
2775
+ ### Standalone function
2776
+
2777
+ The standalone function version of this method:
2778
+
2779
+ ```typescript
2780
+ import { OrqCore } from "@orq-ai/node/core.js";
2781
+ import { evalsRagasNoiseSensitivity } from "@orq-ai/node/funcs/evalsRagasNoiseSensitivity.js";
2782
+
2783
+ // Use `OrqCore` for best tree-shaking performance.
2784
+ // You can create one instance of it to use across an application.
2785
+ const orq = new OrqCore({
2786
+ apiKey: process.env["ORQ_API_KEY"] ?? "",
2787
+ });
2788
+
2789
+ async function run() {
2790
+ const res = await evalsRagasNoiseSensitivity(orq);
2791
+ if (res.ok) {
2792
+ const { value: result } = res;
2793
+ console.log(result);
2794
+ } else {
2795
+ console.log("evalsRagasNoiseSensitivity failed:", res.error);
2796
+ }
2797
+ }
2798
+
2799
+ run();
2800
+ ```
2801
+
2802
+ ### Parameters
2803
+
2804
+ | Parameter | Type | Required | Description |
2805
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
2806
+ | `request` | [operations.EvalsRagasNoiseSensitivityRequestBody](../../models/operations/evalsragasnoisesensitivityrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
2807
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
2808
+ | `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. |
2809
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
2810
+
2811
+ ### Response
2812
+
2813
+ **Promise\<[operations.EvalsRagasNoiseSensitivityResponseBody](../../models/operations/evalsragasnoisesensitivityresponsebody.md)\>**
2814
+
2815
+ ### Errors
2816
+
2817
+ | Error Type | Status Code | Content Type |
2818
+ | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- |
2819
+ | errors.EvalsRagasNoiseSensitivityResponseBody | 404 | application/json |
2820
+ | errors.EvalsRagasNoiseSensitivityEvalsResponseBody | 500 | application/json |
2821
+ | errors.APIError | 4XX, 5XX | \*/\* |
2822
+
2610
2823
  ## ragasResponseRelevancy
2611
2824
 
2612
2825
  Run Response Relevancy Evaluator
@@ -6,7 +6,6 @@
6
6
  ### Available Operations
7
7
 
8
8
  * [list](#list) - List all knowledge bases
9
- * [create](#create) - Create a knowledge
10
9
  * [retrieve](#retrieve) - Retrieves a knowledge base
11
10
  * [update](#update) - Updates a knowledge
12
11
  * [delete](#delete) - Deletes a knowledge
@@ -21,6 +20,7 @@
21
20
  * [updateChunk](#updatechunk) - Update a chunk
22
21
  * [deleteChunk](#deletechunk) - Delete a chunk
23
22
  * [retrieveChunk](#retrievechunk) - Retrieve a chunk
23
+ * [chunkText](#chunktext) - Chunk text content using various strategies
24
24
 
25
25
  ## list
26
26
 
@@ -90,82 +90,6 @@ run();
90
90
  | --------------- | --------------- | --------------- |
91
91
  | errors.APIError | 4XX, 5XX | \*/\* |
92
92
 
93
- ## create
94
-
95
- Create a knowledge
96
-
97
- ### Example Usage
98
-
99
- ```typescript
100
- import { Orq } from "@orq-ai/node";
101
-
102
- const orq = new Orq({
103
- apiKey: process.env["ORQ_API_KEY"] ?? "",
104
- });
105
-
106
- async function run() {
107
- const result = await orq.knowledge.create({
108
- key: "<key>",
109
- embeddingModel: "<value>",
110
- path: "Default",
111
- });
112
-
113
- console.log(result);
114
- }
115
-
116
- run();
117
- ```
118
-
119
- ### Standalone function
120
-
121
- The standalone function version of this method:
122
-
123
- ```typescript
124
- import { OrqCore } from "@orq-ai/node/core.js";
125
- import { knowledgeCreate } from "@orq-ai/node/funcs/knowledgeCreate.js";
126
-
127
- // Use `OrqCore` for best tree-shaking performance.
128
- // You can create one instance of it to use across an application.
129
- const orq = new OrqCore({
130
- apiKey: process.env["ORQ_API_KEY"] ?? "",
131
- });
132
-
133
- async function run() {
134
- const res = await knowledgeCreate(orq, {
135
- key: "<key>",
136
- embeddingModel: "<value>",
137
- path: "Default",
138
- });
139
- if (res.ok) {
140
- const { value: result } = res;
141
- console.log(result);
142
- } else {
143
- console.log("knowledgeCreate failed:", res.error);
144
- }
145
- }
146
-
147
- run();
148
- ```
149
-
150
- ### Parameters
151
-
152
- | Parameter | Type | Required | Description |
153
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
154
- | `request` | [operations.CreateKnowledgeRequestBody](../../models/operations/createknowledgerequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
155
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
156
- | `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. |
157
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
158
-
159
- ### Response
160
-
161
- **Promise\<[operations.CreateKnowledgeResponseBody](../../models/operations/createknowledgeresponsebody.md)\>**
162
-
163
- ### Errors
164
-
165
- | Error Type | Status Code | Content Type |
166
- | --------------- | --------------- | --------------- |
167
- | errors.APIError | 4XX, 5XX | \*/\* |
168
-
169
93
  ## retrieve
170
94
 
171
95
  Retrieve a knowledge base with the settings.
@@ -1222,6 +1146,92 @@ run();
1222
1146
 
1223
1147
  ### Errors
1224
1148
 
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
+
1225
1235
  | Error Type | Status Code | Content Type |
1226
1236
  | --------------- | --------------- | --------------- |
1227
1237
  | errors.APIError | 4XX, 5XX | \*/\* |
@@ -2,7 +2,7 @@
2
2
 
3
3
  {
4
4
  "name": "@orq-ai/node",
5
- "version": "3.8.0-rc.36",
5
+ "version": "3.9.0-rc.1",
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.8.0-rc.36",
3
+ "version": "3.9.0-rc.1",
4
4
  "lockfileVersion": 3,
5
5
  "requires": true,
6
6
  "packages": {
7
7
  "": {
8
8
  "name": "@orq-ai/node",
9
- "version": "3.8.0-rc.36",
9
+ "version": "3.9.0-rc.1",
10
10
  "bin": {
11
11
  "mcp": "bin/mcp-server.js"
12
12
  },
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@orq-ai/node",
3
- "version": "3.8.0-rc.36",
3
+ "version": "3.9.0-rc.1",
4
4
  "author": "Orq",
5
5
  "bin": {
6
6
  "mcp": "bin/mcp-server.js"
@@ -0,0 +1,183 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import { OrqCore } from "../core.js";
6
+ import { encodeJSON } from "../lib/encodings.js";
7
+ import * as M from "../lib/matchers.js";
8
+ import { compactMap } from "../lib/primitives.js";
9
+ import { safeParse } from "../lib/schemas.js";
10
+ import { RequestOptions } from "../lib/sdks.js";
11
+ import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
12
+ import { pathToFunc } from "../lib/url.js";
13
+ import {
14
+ ConnectionError,
15
+ InvalidRequestError,
16
+ RequestAbortedError,
17
+ RequestTimeoutError,
18
+ UnexpectedClientError,
19
+ } from "../models/errors/httpclienterrors.js";
20
+ import * as errors from "../models/errors/index.js";
21
+ import { OrqError } from "../models/errors/orqerror.js";
22
+ import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
23
+ import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
24
+ import * as operations from "../models/operations/index.js";
25
+ import { APICall, APIPromise } from "../types/async.js";
26
+ import { Result } from "../types/fp.js";
27
+
28
+ /**
29
+ * Run Context Entities Recall Evaluator
30
+ */
31
+ export function evalsRagasContextEntitiesRecall(
32
+ client: OrqCore,
33
+ request?: operations.EvalsRagasContextEntitiesRecallRequestBody | undefined,
34
+ options?: RequestOptions,
35
+ ): APIPromise<
36
+ Result<
37
+ operations.EvalsRagasContextEntitiesRecallResponseBody,
38
+ | errors.EvalsRagasContextEntitiesRecallResponseBody
39
+ | errors.EvalsRagasContextEntitiesRecallEvalsResponseBody
40
+ | OrqError
41
+ | ResponseValidationError
42
+ | ConnectionError
43
+ | RequestAbortedError
44
+ | RequestTimeoutError
45
+ | InvalidRequestError
46
+ | UnexpectedClientError
47
+ | SDKValidationError
48
+ >
49
+ > {
50
+ return new APIPromise($do(
51
+ client,
52
+ request,
53
+ options,
54
+ ));
55
+ }
56
+
57
+ async function $do(
58
+ client: OrqCore,
59
+ request?: operations.EvalsRagasContextEntitiesRecallRequestBody | undefined,
60
+ options?: RequestOptions,
61
+ ): Promise<
62
+ [
63
+ Result<
64
+ operations.EvalsRagasContextEntitiesRecallResponseBody,
65
+ | errors.EvalsRagasContextEntitiesRecallResponseBody
66
+ | errors.EvalsRagasContextEntitiesRecallEvalsResponseBody
67
+ | OrqError
68
+ | ResponseValidationError
69
+ | ConnectionError
70
+ | RequestAbortedError
71
+ | RequestTimeoutError
72
+ | InvalidRequestError
73
+ | UnexpectedClientError
74
+ | SDKValidationError
75
+ >,
76
+ APICall,
77
+ ]
78
+ > {
79
+ const parsed = safeParse(
80
+ request,
81
+ (value) =>
82
+ operations.EvalsRagasContextEntitiesRecallRequestBody$outboundSchema
83
+ .optional().parse(value),
84
+ "Input validation failed",
85
+ );
86
+ if (!parsed.ok) {
87
+ return [parsed, { status: "invalid" }];
88
+ }
89
+ const payload = parsed.value;
90
+ const body = payload === undefined
91
+ ? null
92
+ : encodeJSON("body", payload, { explode: true });
93
+
94
+ const path = pathToFunc("/v2/evaluators/ragas_context_entities_recall")();
95
+
96
+ const headers = new Headers(compactMap({
97
+ "Content-Type": "application/json",
98
+ Accept: "application/json",
99
+ }));
100
+
101
+ const secConfig = await extractSecurity(client._options.apiKey);
102
+ const securityInput = secConfig == null ? {} : { apiKey: secConfig };
103
+ const requestSecurity = resolveGlobalSecurity(securityInput);
104
+
105
+ const context = {
106
+ options: client._options,
107
+ baseURL: options?.serverURL ?? client._baseURL ?? "",
108
+ operationID: "EvalsRagasContextEntitiesRecall",
109
+ oAuth2Scopes: [],
110
+
111
+ resolvedSecurity: requestSecurity,
112
+
113
+ securitySource: client._options.apiKey,
114
+ retryConfig: options?.retries
115
+ || client._options.retryConfig
116
+ || { strategy: "none" },
117
+ retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
118
+ };
119
+
120
+ const requestRes = client._createRequest(context, {
121
+ security: requestSecurity,
122
+ method: "POST",
123
+ baseURL: options?.serverURL,
124
+ path: path,
125
+ headers: headers,
126
+ body: body,
127
+ userAgent: client._options.userAgent,
128
+ timeoutMs: options?.timeoutMs || client._options.timeoutMs || 600000,
129
+ }, options);
130
+ if (!requestRes.ok) {
131
+ return [requestRes, { status: "invalid" }];
132
+ }
133
+ const req = requestRes.value;
134
+
135
+ const doResult = await client._do(req, {
136
+ context,
137
+ errorCodes: ["404", "4XX", "500", "5XX"],
138
+ retryConfig: context.retryConfig,
139
+ retryCodes: context.retryCodes,
140
+ });
141
+ if (!doResult.ok) {
142
+ return [doResult, { status: "request-error", request: req }];
143
+ }
144
+ const response = doResult.value;
145
+
146
+ const responseFields = {
147
+ HttpMeta: { Response: response, Request: req },
148
+ };
149
+
150
+ const [result] = await M.match<
151
+ operations.EvalsRagasContextEntitiesRecallResponseBody,
152
+ | errors.EvalsRagasContextEntitiesRecallResponseBody
153
+ | errors.EvalsRagasContextEntitiesRecallEvalsResponseBody
154
+ | OrqError
155
+ | ResponseValidationError
156
+ | ConnectionError
157
+ | RequestAbortedError
158
+ | RequestTimeoutError
159
+ | InvalidRequestError
160
+ | UnexpectedClientError
161
+ | SDKValidationError
162
+ >(
163
+ M.json(
164
+ 200,
165
+ operations.EvalsRagasContextEntitiesRecallResponseBody$inboundSchema,
166
+ ),
167
+ M.jsonErr(
168
+ 404,
169
+ errors.EvalsRagasContextEntitiesRecallResponseBody$inboundSchema,
170
+ ),
171
+ M.jsonErr(
172
+ 500,
173
+ errors.EvalsRagasContextEntitiesRecallEvalsResponseBody$inboundSchema,
174
+ ),
175
+ M.fail("4XX"),
176
+ M.fail("5XX"),
177
+ )(response, req, { extraFields: responseFields });
178
+ if (!result.ok) {
179
+ return [result, { status: "complete", request: req, response }];
180
+ }
181
+
182
+ return [result, { status: "complete", request: req, response }];
183
+ }