@orq-ai/node 3.9.0-rc.0 → 3.9.0-rc.10
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.
- package/README.md +93 -85
- package/bin/mcp-server.js +1328 -1113
- package/bin/mcp-server.js.map +50 -44
- package/docs/sdks/datasets/README.md +0 -83
- package/docs/sdks/deployments/README.md +0 -85
- package/docs/sdks/evals/README.md +213 -0
- package/funcs/evalsRagasContextEntitiesRecall.d.ts +15 -0
- package/funcs/evalsRagasContextEntitiesRecall.d.ts.map +1 -0
- package/funcs/evalsRagasContextEntitiesRecall.js +118 -0
- package/funcs/evalsRagasContextEntitiesRecall.js.map +1 -0
- package/funcs/evalsRagasContextRecall.d.ts +15 -0
- package/funcs/evalsRagasContextRecall.d.ts.map +1 -0
- package/funcs/{deploymentsCreateExperiment.js → evalsRagasContextRecall.js} +17 -19
- package/funcs/evalsRagasContextRecall.js.map +1 -0
- package/funcs/evalsRagasNoiseSensitivity.d.ts +15 -0
- package/funcs/evalsRagasNoiseSensitivity.d.ts.map +1 -0
- package/funcs/{datasetsCreateExperiment.js → evalsRagasNoiseSensitivity.js} +17 -19
- package/funcs/evalsRagasNoiseSensitivity.js.map +1 -0
- package/jsr.json +1 -1
- package/lib/config.d.ts +3 -3
- package/lib/config.js +3 -3
- package/lib/config.js.map +1 -1
- package/mcp-server/mcp-server.js +1 -1
- package/mcp-server/mcp-server.js.map +1 -1
- package/mcp-server/server.d.ts.map +1 -1
- package/mcp-server/server.js +7 -5
- package/mcp-server/server.js.map +1 -1
- package/mcp-server/tools/evalsRagasContextEntitiesRecall.d.ts +8 -0
- package/mcp-server/tools/evalsRagasContextEntitiesRecall.d.ts.map +1 -0
- package/mcp-server/tools/evalsRagasContextEntitiesRecall.js +63 -0
- package/mcp-server/tools/evalsRagasContextEntitiesRecall.js.map +1 -0
- package/mcp-server/tools/evalsRagasContextRecall.d.ts +8 -0
- package/mcp-server/tools/evalsRagasContextRecall.d.ts.map +1 -0
- package/mcp-server/tools/{datasetsCreateExperiment.js → evalsRagasContextRecall.js} +9 -10
- package/mcp-server/tools/evalsRagasContextRecall.js.map +1 -0
- package/mcp-server/tools/evalsRagasNoiseSensitivity.d.ts +8 -0
- package/mcp-server/tools/evalsRagasNoiseSensitivity.d.ts.map +1 -0
- package/mcp-server/tools/{deploymentsCreateExperiment.js → evalsRagasNoiseSensitivity.js} +9 -10
- package/mcp-server/tools/evalsRagasNoiseSensitivity.js.map +1 -0
- package/models/errors/evalsragascontextentitiesrecall.d.ts +79 -0
- package/models/errors/evalsragascontextentitiesrecall.d.ts.map +1 -0
- package/models/errors/evalsragascontextentitiesrecall.js +132 -0
- package/models/errors/evalsragascontextentitiesrecall.js.map +1 -0
- package/models/errors/evalsragascontextrecall.d.ts +79 -0
- package/models/errors/evalsragascontextrecall.d.ts.map +1 -0
- package/models/errors/evalsragascontextrecall.js +132 -0
- package/models/errors/evalsragascontextrecall.js.map +1 -0
- package/models/errors/evalsragasnoisesensitivity.d.ts +79 -0
- package/models/errors/evalsragasnoisesensitivity.d.ts.map +1 -0
- package/models/errors/evalsragasnoisesensitivity.js +132 -0
- package/models/errors/evalsragasnoisesensitivity.js.map +1 -0
- package/models/errors/index.d.ts +3 -0
- package/models/errors/index.d.ts.map +1 -1
- package/models/errors/index.js +3 -0
- package/models/errors/index.js.map +1 -1
- package/models/operations/createcontact.js +2 -2
- package/models/operations/createdataset.js +2 -2
- package/models/operations/createdatasetitem.js +2 -2
- package/models/operations/createdatasource.js +2 -2
- package/models/operations/createeval.js +16 -16
- package/models/operations/createprompt.d.ts +6 -0
- package/models/operations/createprompt.d.ts.map +1 -1
- package/models/operations/createprompt.js +2 -0
- package/models/operations/createprompt.js.map +1 -1
- package/models/operations/deploymentgetconfig.d.ts +3 -0
- package/models/operations/deploymentgetconfig.d.ts.map +1 -1
- package/models/operations/deploymentgetconfig.js +1 -0
- package/models/operations/deploymentgetconfig.js.map +1 -1
- package/models/operations/deployments.d.ts +3 -0
- package/models/operations/deployments.d.ts.map +1 -1
- package/models/operations/deployments.js +1 -0
- package/models/operations/deployments.js.map +1 -1
- package/models/operations/evalsragascontextentitiesrecall.d.ts +67 -0
- package/models/operations/evalsragascontextentitiesrecall.d.ts.map +1 -0
- package/models/operations/evalsragascontextentitiesrecall.js +100 -0
- package/models/operations/evalsragascontextentitiesrecall.js.map +1 -0
- package/models/operations/evalsragascontextrecall.d.ts +77 -0
- package/models/operations/evalsragascontextrecall.d.ts.map +1 -0
- package/models/operations/evalsragascontextrecall.js +104 -0
- package/models/operations/evalsragascontextrecall.js.map +1 -0
- package/models/operations/evalsragasnoisesensitivity.d.ts +77 -0
- package/models/operations/evalsragasnoisesensitivity.d.ts.map +1 -0
- package/models/operations/evalsragasnoisesensitivity.js +104 -0
- package/models/operations/evalsragasnoisesensitivity.js.map +1 -0
- package/models/operations/fileget.js +2 -2
- package/models/operations/filelist.js +2 -2
- package/models/operations/fileupload.js +2 -2
- package/models/operations/getallprompts.d.ts +3 -0
- package/models/operations/getallprompts.d.ts.map +1 -1
- package/models/operations/getallprompts.js +1 -0
- package/models/operations/getallprompts.js.map +1 -1
- package/models/operations/getevals.d.ts +3 -0
- package/models/operations/getevals.d.ts.map +1 -1
- package/models/operations/getevals.js +29 -28
- package/models/operations/getevals.js.map +1 -1
- package/models/operations/getoneprompt.d.ts +3 -0
- package/models/operations/getoneprompt.d.ts.map +1 -1
- package/models/operations/getoneprompt.js +1 -0
- package/models/operations/getoneprompt.js.map +1 -1
- package/models/operations/getpromptversion.d.ts +3 -0
- package/models/operations/getpromptversion.d.ts.map +1 -1
- package/models/operations/getpromptversion.js +1 -0
- package/models/operations/getpromptversion.js.map +1 -1
- package/models/operations/index.d.ts +3 -2
- package/models/operations/index.d.ts.map +1 -1
- package/models/operations/index.js +3 -2
- package/models/operations/index.js.map +1 -1
- package/models/operations/listcontacts.js +2 -2
- package/models/operations/listdatasetdatapoints.js +2 -2
- package/models/operations/listdatasets.js +2 -2
- package/models/operations/listdatasources.js +2 -2
- package/models/operations/listpromptversions.d.ts +3 -0
- package/models/operations/listpromptversions.d.ts.map +1 -1
- package/models/operations/listpromptversions.js +1 -0
- package/models/operations/listpromptversions.js.map +1 -1
- package/models/operations/retrievecontact.js +2 -2
- package/models/operations/retrievedatapoint.js +2 -2
- package/models/operations/retrievedataset.js +2 -2
- package/models/operations/retrievedatasource.js +2 -2
- package/models/operations/updatecontact.js +2 -2
- package/models/operations/updatedatapoint.js +2 -2
- package/models/operations/updatedataset.js +2 -2
- package/models/operations/updatedatasource.js +2 -2
- package/models/operations/updateeval.js +16 -16
- package/models/operations/updateprompt.d.ts +6 -0
- package/models/operations/updateprompt.d.ts.map +1 -1
- package/models/operations/updateprompt.js +2 -0
- package/models/operations/updateprompt.js.map +1 -1
- package/package.json +1 -1
- package/sdk/datasets.d.ts +0 -7
- package/sdk/datasets.d.ts.map +1 -1
- package/sdk/datasets.js +0 -10
- package/sdk/datasets.js.map +1 -1
- package/sdk/deployments.d.ts +0 -7
- package/sdk/deployments.d.ts.map +1 -1
- package/sdk/deployments.js +0 -10
- package/sdk/deployments.js.map +1 -1
- package/sdk/evals.d.ts +12 -0
- package/sdk/evals.d.ts.map +1 -1
- package/sdk/evals.js +21 -0
- package/sdk/evals.js.map +1 -1
- package/src/funcs/evalsRagasContextEntitiesRecall.ts +183 -0
- package/src/funcs/{datasetsCreateExperiment.ts → evalsRagasContextRecall.ts} +34 -25
- package/src/funcs/{deploymentsCreateExperiment.ts → evalsRagasNoiseSensitivity.ts} +34 -27
- package/src/lib/config.ts +3 -3
- package/src/mcp-server/mcp-server.ts +1 -1
- package/src/mcp-server/server.ts +7 -5
- package/src/mcp-server/tools/evalsRagasContextEntitiesRecall.ts +37 -0
- package/src/mcp-server/tools/{datasetsCreateExperiment.ts → evalsRagasContextRecall.ts} +7 -8
- package/src/mcp-server/tools/{deploymentsCreateExperiment.ts → evalsRagasNoiseSensitivity.ts} +7 -8
- package/src/models/errors/evalsragascontextentitiesrecall.ts +167 -0
- package/src/models/errors/evalsragascontextrecall.ts +162 -0
- package/src/models/errors/evalsragasnoisesensitivity.ts +164 -0
- package/src/models/errors/index.ts +3 -0
- package/src/models/operations/createcontact.ts +2 -2
- package/src/models/operations/createdataset.ts +2 -2
- package/src/models/operations/createdatasetitem.ts +2 -2
- package/src/models/operations/createdatasource.ts +2 -2
- package/src/models/operations/createeval.ts +16 -16
- package/src/models/operations/createprompt.ts +2 -0
- package/src/models/operations/deploymentgetconfig.ts +1 -0
- package/src/models/operations/deployments.ts +1 -0
- package/src/models/operations/evalsragascontextentitiesrecall.ts +164 -0
- package/src/models/operations/evalsragascontextrecall.ts +164 -0
- package/src/models/operations/evalsragasnoisesensitivity.ts +166 -0
- package/src/models/operations/fileget.ts +2 -2
- package/src/models/operations/filelist.ts +2 -2
- package/src/models/operations/fileupload.ts +2 -2
- package/src/models/operations/getallprompts.ts +1 -0
- package/src/models/operations/getevals.ts +29 -28
- package/src/models/operations/getoneprompt.ts +1 -0
- package/src/models/operations/getpromptversion.ts +1 -0
- package/src/models/operations/index.ts +3 -2
- package/src/models/operations/listcontacts.ts +2 -2
- package/src/models/operations/listdatasetdatapoints.ts +2 -2
- package/src/models/operations/listdatasets.ts +2 -2
- package/src/models/operations/listdatasources.ts +2 -2
- package/src/models/operations/listpromptversions.ts +1 -0
- package/src/models/operations/retrievecontact.ts +2 -2
- package/src/models/operations/retrievedatapoint.ts +2 -2
- package/src/models/operations/retrievedataset.ts +2 -2
- package/src/models/operations/retrievedatasource.ts +2 -2
- package/src/models/operations/updatecontact.ts +2 -2
- package/src/models/operations/updatedatapoint.ts +2 -2
- package/src/models/operations/updatedataset.ts +2 -2
- package/src/models/operations/updatedatasource.ts +2 -2
- package/src/models/operations/updateeval.ts +16 -16
- package/src/models/operations/updateprompt.ts +2 -0
- package/src/sdk/datasets.ts +0 -18
- package/src/sdk/deployments.ts +0 -18
- package/src/sdk/evals.ts +45 -0
- package/funcs/datasetsCreateExperiment.d.ts +0 -17
- package/funcs/datasetsCreateExperiment.d.ts.map +0 -1
- package/funcs/datasetsCreateExperiment.js.map +0 -1
- package/funcs/deploymentsCreateExperiment.d.ts +0 -17
- package/funcs/deploymentsCreateExperiment.d.ts.map +0 -1
- package/funcs/deploymentsCreateExperiment.js.map +0 -1
- package/mcp-server/tools/datasetsCreateExperiment.d.ts +0 -8
- package/mcp-server/tools/datasetsCreateExperiment.d.ts.map +0 -1
- package/mcp-server/tools/datasetsCreateExperiment.js.map +0 -1
- package/mcp-server/tools/deploymentsCreateExperiment.d.ts +0 -8
- package/mcp-server/tools/deploymentsCreateExperiment.d.ts.map +0 -1
- package/mcp-server/tools/deploymentsCreateExperiment.js.map +0 -1
- package/models/operations/createdatasetexperiment.d.ts +0 -140
- package/models/operations/createdatasetexperiment.d.ts.map +0 -1
- package/models/operations/createdatasetexperiment.js +0 -188
- package/models/operations/createdatasetexperiment.js.map +0 -1
- package/models/operations/createdeploymentexperiment.d.ts +0 -152
- package/models/operations/createdeploymentexperiment.d.ts.map +0 -1
- package/models/operations/createdeploymentexperiment.js +0 -189
- package/models/operations/createdeploymentexperiment.js.map +0 -1
- package/src/models/operations/createdatasetexperiment.ts +0 -307
- package/src/models/operations/createdeploymentexperiment.ts +0 -321
|
@@ -10,7 +10,6 @@
|
|
|
10
10
|
* [retrieve](#retrieve) - Retrieve a dataset
|
|
11
11
|
* [update](#update) - Update a dataset
|
|
12
12
|
* [delete](#delete) - Delete a dataset
|
|
13
|
-
* [createExperiment](#createexperiment) - Create an experiment from a dataset
|
|
14
13
|
* [listDatapoints](#listdatapoints) - List datapoints
|
|
15
14
|
* [createDatapoint](#createdatapoint) - Create a datapoint
|
|
16
15
|
* [retrieveDatapoint](#retrievedatapoint) - Retrieve a datapoint
|
|
@@ -384,88 +383,6 @@ run();
|
|
|
384
383
|
| --------------- | --------------- | --------------- |
|
|
385
384
|
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
386
385
|
|
|
387
|
-
## createExperiment
|
|
388
|
-
|
|
389
|
-
Create an experiment from a dataset
|
|
390
|
-
|
|
391
|
-
### Example Usage
|
|
392
|
-
|
|
393
|
-
```typescript
|
|
394
|
-
import { Orq } from "@orq-ai/node";
|
|
395
|
-
|
|
396
|
-
const orq = new Orq({
|
|
397
|
-
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
398
|
-
});
|
|
399
|
-
|
|
400
|
-
async function run() {
|
|
401
|
-
const result = await orq.datasets.createExperiment({
|
|
402
|
-
datasetId: "<id>",
|
|
403
|
-
requestBody: {
|
|
404
|
-
experimentKey: "<value>",
|
|
405
|
-
path: "Default/Experiments",
|
|
406
|
-
type: "dataset_experiment",
|
|
407
|
-
},
|
|
408
|
-
});
|
|
409
|
-
|
|
410
|
-
console.log(result);
|
|
411
|
-
}
|
|
412
|
-
|
|
413
|
-
run();
|
|
414
|
-
```
|
|
415
|
-
|
|
416
|
-
### Standalone function
|
|
417
|
-
|
|
418
|
-
The standalone function version of this method:
|
|
419
|
-
|
|
420
|
-
```typescript
|
|
421
|
-
import { OrqCore } from "@orq-ai/node/core.js";
|
|
422
|
-
import { datasetsCreateExperiment } from "@orq-ai/node/funcs/datasetsCreateExperiment.js";
|
|
423
|
-
|
|
424
|
-
// Use `OrqCore` for best tree-shaking performance.
|
|
425
|
-
// You can create one instance of it to use across an application.
|
|
426
|
-
const orq = new OrqCore({
|
|
427
|
-
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
428
|
-
});
|
|
429
|
-
|
|
430
|
-
async function run() {
|
|
431
|
-
const res = await datasetsCreateExperiment(orq, {
|
|
432
|
-
datasetId: "<id>",
|
|
433
|
-
requestBody: {
|
|
434
|
-
experimentKey: "<value>",
|
|
435
|
-
path: "Default/Experiments",
|
|
436
|
-
type: "dataset_experiment",
|
|
437
|
-
},
|
|
438
|
-
});
|
|
439
|
-
if (res.ok) {
|
|
440
|
-
const { value: result } = res;
|
|
441
|
-
console.log(result);
|
|
442
|
-
} else {
|
|
443
|
-
console.log("datasetsCreateExperiment failed:", res.error);
|
|
444
|
-
}
|
|
445
|
-
}
|
|
446
|
-
|
|
447
|
-
run();
|
|
448
|
-
```
|
|
449
|
-
|
|
450
|
-
### Parameters
|
|
451
|
-
|
|
452
|
-
| Parameter | Type | Required | Description |
|
|
453
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
454
|
-
| `request` | [operations.CreateDatasetExperimentRequest](../../models/operations/createdatasetexperimentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
455
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
456
|
-
| `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. |
|
|
457
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
458
|
-
|
|
459
|
-
### Response
|
|
460
|
-
|
|
461
|
-
**Promise\<[operations.CreateDatasetExperimentResponseBody](../../models/operations/createdatasetexperimentresponsebody.md)\>**
|
|
462
|
-
|
|
463
|
-
### Errors
|
|
464
|
-
|
|
465
|
-
| Error Type | Status Code | Content Type |
|
|
466
|
-
| --------------- | --------------- | --------------- |
|
|
467
|
-
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
468
|
-
|
|
469
386
|
## listDatapoints
|
|
470
387
|
|
|
471
388
|
Retrieves a paginated list of datapoints from a specific dataset.
|
|
@@ -9,7 +9,6 @@
|
|
|
9
9
|
* [getConfig](#getconfig) - Get config
|
|
10
10
|
* [invoke](#invoke) - Invoke
|
|
11
11
|
* [stream](#stream) - Stream
|
|
12
|
-
* [createExperiment](#createexperiment) - Create an experiment from a deployment
|
|
13
12
|
|
|
14
13
|
## list
|
|
15
14
|
|
|
@@ -306,90 +305,6 @@ run();
|
|
|
306
305
|
|
|
307
306
|
### Errors
|
|
308
307
|
|
|
309
|
-
| Error Type | Status Code | Content Type |
|
|
310
|
-
| --------------- | --------------- | --------------- |
|
|
311
|
-
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
312
|
-
|
|
313
|
-
## createExperiment
|
|
314
|
-
|
|
315
|
-
Create an experiment from a deployment
|
|
316
|
-
|
|
317
|
-
### Example Usage
|
|
318
|
-
|
|
319
|
-
```typescript
|
|
320
|
-
import { Orq } from "@orq-ai/node";
|
|
321
|
-
|
|
322
|
-
const orq = new Orq({
|
|
323
|
-
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
324
|
-
});
|
|
325
|
-
|
|
326
|
-
async function run() {
|
|
327
|
-
const result = await orq.deployments.createExperiment({
|
|
328
|
-
deploymentKey: "<value>",
|
|
329
|
-
requestBody: {
|
|
330
|
-
experimentKey: "<value>",
|
|
331
|
-
path: "Default/Experiments",
|
|
332
|
-
datasetId: "<id>",
|
|
333
|
-
type: "deployment_experiment",
|
|
334
|
-
},
|
|
335
|
-
});
|
|
336
|
-
|
|
337
|
-
console.log(result);
|
|
338
|
-
}
|
|
339
|
-
|
|
340
|
-
run();
|
|
341
|
-
```
|
|
342
|
-
|
|
343
|
-
### Standalone function
|
|
344
|
-
|
|
345
|
-
The standalone function version of this method:
|
|
346
|
-
|
|
347
|
-
```typescript
|
|
348
|
-
import { OrqCore } from "@orq-ai/node/core.js";
|
|
349
|
-
import { deploymentsCreateExperiment } from "@orq-ai/node/funcs/deploymentsCreateExperiment.js";
|
|
350
|
-
|
|
351
|
-
// Use `OrqCore` for best tree-shaking performance.
|
|
352
|
-
// You can create one instance of it to use across an application.
|
|
353
|
-
const orq = new OrqCore({
|
|
354
|
-
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
355
|
-
});
|
|
356
|
-
|
|
357
|
-
async function run() {
|
|
358
|
-
const res = await deploymentsCreateExperiment(orq, {
|
|
359
|
-
deploymentKey: "<value>",
|
|
360
|
-
requestBody: {
|
|
361
|
-
experimentKey: "<value>",
|
|
362
|
-
path: "Default/Experiments",
|
|
363
|
-
datasetId: "<id>",
|
|
364
|
-
type: "deployment_experiment",
|
|
365
|
-
},
|
|
366
|
-
});
|
|
367
|
-
if (res.ok) {
|
|
368
|
-
const { value: result } = res;
|
|
369
|
-
console.log(result);
|
|
370
|
-
} else {
|
|
371
|
-
console.log("deploymentsCreateExperiment failed:", res.error);
|
|
372
|
-
}
|
|
373
|
-
}
|
|
374
|
-
|
|
375
|
-
run();
|
|
376
|
-
```
|
|
377
|
-
|
|
378
|
-
### Parameters
|
|
379
|
-
|
|
380
|
-
| Parameter | Type | Required | Description |
|
|
381
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
382
|
-
| `request` | [operations.CreateDeploymentExperimentRequest](../../models/operations/createdeploymentexperimentrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
383
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
384
|
-
| `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. |
|
|
385
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
386
|
-
|
|
387
|
-
### Response
|
|
388
|
-
|
|
389
|
-
**Promise\<[operations.CreateDeploymentExperimentResponseBody](../../models/operations/createdeploymentexperimentresponsebody.md)\>**
|
|
390
|
-
|
|
391
|
-
### Errors
|
|
392
|
-
|
|
393
308
|
| Error Type | Status Code | Content Type |
|
|
394
309
|
| --------------- | --------------- | --------------- |
|
|
395
310
|
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
@@ -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
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import { OrqCore } from "../core.js";
|
|
2
|
+
import { RequestOptions } from "../lib/sdks.js";
|
|
3
|
+
import { ConnectionError, InvalidRequestError, RequestAbortedError, RequestTimeoutError, UnexpectedClientError } from "../models/errors/httpclienterrors.js";
|
|
4
|
+
import * as errors from "../models/errors/index.js";
|
|
5
|
+
import { OrqError } from "../models/errors/orqerror.js";
|
|
6
|
+
import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
|
|
7
|
+
import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
|
|
8
|
+
import * as operations from "../models/operations/index.js";
|
|
9
|
+
import { APIPromise } from "../types/async.js";
|
|
10
|
+
import { Result } from "../types/fp.js";
|
|
11
|
+
/**
|
|
12
|
+
* Run Context Entities Recall Evaluator
|
|
13
|
+
*/
|
|
14
|
+
export declare function evalsRagasContextEntitiesRecall(client: OrqCore, request?: operations.EvalsRagasContextEntitiesRecallRequestBody | undefined, options?: RequestOptions): APIPromise<Result<operations.EvalsRagasContextEntitiesRecallResponseBody, errors.EvalsRagasContextEntitiesRecallResponseBody | errors.EvalsRagasContextEntitiesRecallEvalsResponseBody | OrqError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
|
|
15
|
+
//# sourceMappingURL=evalsRagasContextEntitiesRecall.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"evalsRagasContextEntitiesRecall.d.ts","sourceRoot":"","sources":["../src/funcs/evalsRagasContextEntitiesRecall.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAKrC,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAGhD,OAAO,EACL,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACtB,MAAM,sCAAsC,CAAC;AAC9C,OAAO,KAAK,MAAM,MAAM,2BAA2B,CAAC;AACpD,OAAO,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AACxD,OAAO,EAAE,uBAAuB,EAAE,MAAM,6CAA6C,CAAC;AACtF,OAAO,EAAE,kBAAkB,EAAE,MAAM,wCAAwC,CAAC;AAC5E,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,EAAW,UAAU,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAExC;;GAEG;AACH,wBAAgB,+BAA+B,CAC7C,MAAM,EAAE,OAAO,EACf,OAAO,CAAC,EAAE,UAAU,CAAC,0CAA0C,GAAG,SAAS,EAC3E,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CACX,MAAM,CACJ,UAAU,CAAC,2CAA2C,EACpD,MAAM,CAAC,2CAA2C,GAClD,MAAM,CAAC,gDAAgD,GACvD,QAAQ,GACR,uBAAuB,GACvB,eAAe,GACf,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,qBAAqB,GACrB,kBAAkB,CACrB,CACF,CAMA"}
|
|
@@ -0,0 +1,118 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/*
|
|
3
|
+
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
|
4
|
+
*/
|
|
5
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
6
|
+
if (k2 === undefined) k2 = k;
|
|
7
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
8
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
9
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
10
|
+
}
|
|
11
|
+
Object.defineProperty(o, k2, desc);
|
|
12
|
+
}) : (function(o, m, k, k2) {
|
|
13
|
+
if (k2 === undefined) k2 = k;
|
|
14
|
+
o[k2] = m[k];
|
|
15
|
+
}));
|
|
16
|
+
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
|
17
|
+
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
|
18
|
+
}) : function(o, v) {
|
|
19
|
+
o["default"] = v;
|
|
20
|
+
});
|
|
21
|
+
var __importStar = (this && this.__importStar) || (function () {
|
|
22
|
+
var ownKeys = function(o) {
|
|
23
|
+
ownKeys = Object.getOwnPropertyNames || function (o) {
|
|
24
|
+
var ar = [];
|
|
25
|
+
for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
|
|
26
|
+
return ar;
|
|
27
|
+
};
|
|
28
|
+
return ownKeys(o);
|
|
29
|
+
};
|
|
30
|
+
return function (mod) {
|
|
31
|
+
if (mod && mod.__esModule) return mod;
|
|
32
|
+
var result = {};
|
|
33
|
+
if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
|
|
34
|
+
__setModuleDefault(result, mod);
|
|
35
|
+
return result;
|
|
36
|
+
};
|
|
37
|
+
})();
|
|
38
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
39
|
+
exports.evalsRagasContextEntitiesRecall = evalsRagasContextEntitiesRecall;
|
|
40
|
+
const encodings_js_1 = require("../lib/encodings.js");
|
|
41
|
+
const M = __importStar(require("../lib/matchers.js"));
|
|
42
|
+
const primitives_js_1 = require("../lib/primitives.js");
|
|
43
|
+
const schemas_js_1 = require("../lib/schemas.js");
|
|
44
|
+
const security_js_1 = require("../lib/security.js");
|
|
45
|
+
const url_js_1 = require("../lib/url.js");
|
|
46
|
+
const errors = __importStar(require("../models/errors/index.js"));
|
|
47
|
+
const operations = __importStar(require("../models/operations/index.js"));
|
|
48
|
+
const async_js_1 = require("../types/async.js");
|
|
49
|
+
/**
|
|
50
|
+
* Run Context Entities Recall Evaluator
|
|
51
|
+
*/
|
|
52
|
+
function evalsRagasContextEntitiesRecall(client, request, options) {
|
|
53
|
+
return new async_js_1.APIPromise($do(client, request, options));
|
|
54
|
+
}
|
|
55
|
+
async function $do(client, request, options) {
|
|
56
|
+
const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.EvalsRagasContextEntitiesRecallRequestBody$outboundSchema
|
|
57
|
+
.optional().parse(value), "Input validation failed");
|
|
58
|
+
if (!parsed.ok) {
|
|
59
|
+
return [parsed, { status: "invalid" }];
|
|
60
|
+
}
|
|
61
|
+
const payload = parsed.value;
|
|
62
|
+
const body = payload === undefined
|
|
63
|
+
? null
|
|
64
|
+
: (0, encodings_js_1.encodeJSON)("body", payload, { explode: true });
|
|
65
|
+
const path = (0, url_js_1.pathToFunc)("/v2/evaluators/ragas_context_entities_recall")();
|
|
66
|
+
const headers = new Headers((0, primitives_js_1.compactMap)({
|
|
67
|
+
"Content-Type": "application/json",
|
|
68
|
+
Accept: "application/json",
|
|
69
|
+
}));
|
|
70
|
+
const secConfig = await (0, security_js_1.extractSecurity)(client._options.apiKey);
|
|
71
|
+
const securityInput = secConfig == null ? {} : { apiKey: secConfig };
|
|
72
|
+
const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput);
|
|
73
|
+
const context = {
|
|
74
|
+
options: client._options,
|
|
75
|
+
baseURL: options?.serverURL ?? client._baseURL ?? "",
|
|
76
|
+
operationID: "EvalsRagasContextEntitiesRecall",
|
|
77
|
+
oAuth2Scopes: [],
|
|
78
|
+
resolvedSecurity: requestSecurity,
|
|
79
|
+
securitySource: client._options.apiKey,
|
|
80
|
+
retryConfig: options?.retries
|
|
81
|
+
|| client._options.retryConfig
|
|
82
|
+
|| { strategy: "none" },
|
|
83
|
+
retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
|
|
84
|
+
};
|
|
85
|
+
const requestRes = client._createRequest(context, {
|
|
86
|
+
security: requestSecurity,
|
|
87
|
+
method: "POST",
|
|
88
|
+
baseURL: options?.serverURL,
|
|
89
|
+
path: path,
|
|
90
|
+
headers: headers,
|
|
91
|
+
body: body,
|
|
92
|
+
userAgent: client._options.userAgent,
|
|
93
|
+
timeoutMs: options?.timeoutMs || client._options.timeoutMs || 600000,
|
|
94
|
+
}, options);
|
|
95
|
+
if (!requestRes.ok) {
|
|
96
|
+
return [requestRes, { status: "invalid" }];
|
|
97
|
+
}
|
|
98
|
+
const req = requestRes.value;
|
|
99
|
+
const doResult = await client._do(req, {
|
|
100
|
+
context,
|
|
101
|
+
errorCodes: ["404", "4XX", "500", "5XX"],
|
|
102
|
+
retryConfig: context.retryConfig,
|
|
103
|
+
retryCodes: context.retryCodes,
|
|
104
|
+
});
|
|
105
|
+
if (!doResult.ok) {
|
|
106
|
+
return [doResult, { status: "request-error", request: req }];
|
|
107
|
+
}
|
|
108
|
+
const response = doResult.value;
|
|
109
|
+
const responseFields = {
|
|
110
|
+
HttpMeta: { Response: response, Request: req },
|
|
111
|
+
};
|
|
112
|
+
const [result] = await M.match(M.json(200, operations.EvalsRagasContextEntitiesRecallResponseBody$inboundSchema), M.jsonErr(404, errors.EvalsRagasContextEntitiesRecallResponseBody$inboundSchema), M.jsonErr(500, errors.EvalsRagasContextEntitiesRecallEvalsResponseBody$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields });
|
|
113
|
+
if (!result.ok) {
|
|
114
|
+
return [result, { status: "complete", request: req, response }];
|
|
115
|
+
}
|
|
116
|
+
return [result, { status: "complete", request: req, response }];
|
|
117
|
+
}
|
|
118
|
+
//# sourceMappingURL=evalsRagasContextEntitiesRecall.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"evalsRagasContextEntitiesRecall.js","sourceRoot":"","sources":["../src/funcs/evalsRagasContextEntitiesRecall.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4BH,0EAwBC;AAjDD,sDAAiD;AACjD,sDAAwC;AACxC,wDAAkD;AAClD,kDAA8C;AAE9C,oDAA4E;AAC5E,0CAA2C;AAQ3C,kEAAoD;AAIpD,0EAA4D;AAC5D,gDAAwD;AAGxD;;GAEG;AACH,SAAgB,+BAA+B,CAC7C,MAAe,EACf,OAA2E,EAC3E,OAAwB;IAgBxB,OAAO,IAAI,qBAAU,CAAC,GAAG,CACvB,MAAM,EACN,OAAO,EACP,OAAO,CACR,CAAC,CAAC;AACL,CAAC;AAED,KAAK,UAAU,GAAG,CAChB,MAAe,EACf,OAA2E,EAC3E,OAAwB;IAmBxB,MAAM,MAAM,GAAG,IAAA,sBAAS,EACtB,OAAO,EACP,CAAC,KAAK,EAAE,EAAE,CACR,UAAU,CAAC,yDAAyD;SACjE,QAAQ,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,EAC5B,yBAAyB,CAC1B,CAAC;IACF,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;QACf,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;IACzC,CAAC;IACD,MAAM,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC;IAC7B,MAAM,IAAI,GAAG,OAAO,KAAK,SAAS;QAChC,CAAC,CAAC,IAAI;QACN,CAAC,CAAC,IAAA,yBAAU,EAAC,MAAM,EAAE,OAAO,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;IAEnD,MAAM,IAAI,GAAG,IAAA,mBAAU,EAAC,8CAA8C,CAAC,EAAE,CAAC;IAE1E,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,IAAA,0BAAU,EAAC;QACrC,cAAc,EAAE,kBAAkB;QAClC,MAAM,EAAE,kBAAkB;KAC3B,CAAC,CAAC,CAAC;IAEJ,MAAM,SAAS,GAAG,MAAM,IAAA,6BAAe,EAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IAChE,MAAM,aAAa,GAAG,SAAS,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC;IACrE,MAAM,eAAe,GAAG,IAAA,mCAAqB,EAAC,aAAa,CAAC,CAAC;IAE7D,MAAM,OAAO,GAAG;QACd,OAAO,EAAE,MAAM,CAAC,QAAQ;QACxB,OAAO,EAAE,OAAO,EAAE,SAAS,IAAI,MAAM,CAAC,QAAQ,IAAI,EAAE;QACpD,WAAW,EAAE,iCAAiC;QAC9C,YAAY,EAAE,EAAE;QAEhB,gBAAgB,EAAE,eAAe;QAEjC,cAAc,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM;QACtC,WAAW,EAAE,OAAO,EAAE,OAAO;eACxB,MAAM,CAAC,QAAQ,CAAC,WAAW;eAC3B,EAAE,QAAQ,EAAE,MAAM,EAAE;QACzB,UAAU,EAAE,OAAO,EAAE,UAAU,IAAI,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC;KACvE,CAAC;IAEF,MAAM,UAAU,GAAG,MAAM,CAAC,cAAc,CAAC,OAAO,EAAE;QAChD,QAAQ,EAAE,eAAe;QACzB,MAAM,EAAE,MAAM;QACd,OAAO,EAAE,OAAO,EAAE,SAAS;QAC3B,IAAI,EAAE,IAAI;QACV,OAAO,EAAE,OAAO;QAChB,IAAI,EAAE,IAAI;QACV,SAAS,EAAE,MAAM,CAAC,QAAQ,CAAC,SAAS;QACpC,SAAS,EAAE,OAAO,EAAE,SAAS,IAAI,MAAM,CAAC,QAAQ,CAAC,SAAS,IAAI,MAAM;KACrE,EAAE,OAAO,CAAC,CAAC;IACZ,IAAI,CAAC,UAAU,CAAC,EAAE,EAAE,CAAC;QACnB,OAAO,CAAC,UAAU,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;IAC7C,CAAC;IACD,MAAM,GAAG,GAAG,UAAU,CAAC,KAAK,CAAC;IAE7B,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE;QACrC,OAAO;QACP,UAAU,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC;QACxC,WAAW,EAAE,OAAO,CAAC,WAAW;QAChC,UAAU,EAAE,OAAO,CAAC,UAAU;KAC/B,CAAC,CAAC;IACH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;QACjB,OAAO,CAAC,QAAQ,EAAE,EAAE,MAAM,EAAE,eAAe,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,CAAC;IAC/D,CAAC;IACD,MAAM,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC;IAEhC,MAAM,cAAc,GAAG;QACrB,QAAQ,EAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,EAAE;KAC/C,CAAC;IAEF,MAAM,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,KAAK,CAa5B,CAAC,CAAC,IAAI,CACJ,GAAG,EACH,UAAU,CAAC,yDAAyD,CACrE,EACD,CAAC,CAAC,OAAO,CACP,GAAG,EACH,MAAM,CAAC,yDAAyD,CACjE,EACD,CAAC,CAAC,OAAO,CACP,GAAG,EACH,MAAM,CAAC,8DAA8D,CACtE,EACD,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,EACb,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CACd,CAAC,QAAQ,EAAE,GAAG,EAAE,EAAE,WAAW,EAAE,cAAc,EAAE,CAAC,CAAC;IAClD,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;QACf,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,CAAC,CAAC;IAClE,CAAC;IAED,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,CAAC,CAAC;AAClE,CAAC"}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import { OrqCore } from "../core.js";
|
|
2
|
+
import { RequestOptions } from "../lib/sdks.js";
|
|
3
|
+
import { ConnectionError, InvalidRequestError, RequestAbortedError, RequestTimeoutError, UnexpectedClientError } from "../models/errors/httpclienterrors.js";
|
|
4
|
+
import * as errors from "../models/errors/index.js";
|
|
5
|
+
import { OrqError } from "../models/errors/orqerror.js";
|
|
6
|
+
import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
|
|
7
|
+
import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
|
|
8
|
+
import * as operations from "../models/operations/index.js";
|
|
9
|
+
import { APIPromise } from "../types/async.js";
|
|
10
|
+
import { Result } from "../types/fp.js";
|
|
11
|
+
/**
|
|
12
|
+
* Run Context Recall Evaluator
|
|
13
|
+
*/
|
|
14
|
+
export declare function evalsRagasContextRecall(client: OrqCore, request?: operations.EvalsRagasContextRecallRequestBody | undefined, options?: RequestOptions): APIPromise<Result<operations.EvalsRagasContextRecallResponseBody, errors.EvalsRagasContextRecallResponseBody | errors.EvalsRagasContextRecallEvalsResponseBody | OrqError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
|
|
15
|
+
//# sourceMappingURL=evalsRagasContextRecall.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"evalsRagasContextRecall.d.ts","sourceRoot":"","sources":["../src/funcs/evalsRagasContextRecall.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAKrC,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAGhD,OAAO,EACL,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACtB,MAAM,sCAAsC,CAAC;AAC9C,OAAO,KAAK,MAAM,MAAM,2BAA2B,CAAC;AACpD,OAAO,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AACxD,OAAO,EAAE,uBAAuB,EAAE,MAAM,6CAA6C,CAAC;AACtF,OAAO,EAAE,kBAAkB,EAAE,MAAM,wCAAwC,CAAC;AAC5E,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,EAAW,UAAU,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAExC;;GAEG;AACH,wBAAgB,uBAAuB,CACrC,MAAM,EAAE,OAAO,EACf,OAAO,CAAC,EAAE,UAAU,CAAC,kCAAkC,GAAG,SAAS,EACnE,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CACX,MAAM,CACJ,UAAU,CAAC,mCAAmC,EAC5C,MAAM,CAAC,mCAAmC,GAC1C,MAAM,CAAC,wCAAwC,GAC/C,QAAQ,GACR,uBAAuB,GACvB,eAAe,GACf,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,qBAAqB,GACrB,kBAAkB,CACrB,CACF,CAMA"}
|