scorecard-ai 1.0.0-alpha.7 → 1.0.0-alpha.9
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/CHANGELOG.md +54 -0
- package/README.md +25 -37
- package/client.d.mts +5 -4
- package/client.d.mts.map +1 -1
- package/client.d.ts +5 -4
- package/client.d.ts.map +1 -1
- package/client.js +15 -0
- package/client.js.map +1 -1
- package/client.mjs +15 -0
- package/client.mjs.map +1 -1
- package/core/pagination.d.mts +1 -1
- package/core/pagination.d.mts.map +1 -1
- package/core/pagination.d.ts +1 -1
- package/core/pagination.d.ts.map +1 -1
- package/index.d.mts +1 -0
- package/index.d.mts.map +1 -1
- package/index.d.ts +1 -0
- package/index.d.ts.map +1 -1
- package/index.js +3 -1
- package/index.js.map +1 -1
- package/index.mjs +1 -0
- package/index.mjs.map +1 -1
- package/internal/detect-platform.js +3 -3
- package/internal/detect-platform.js.map +1 -1
- package/internal/detect-platform.mjs +3 -3
- package/internal/detect-platform.mjs.map +1 -1
- package/internal/shim-types.d.mts +11 -22
- package/internal/shim-types.d.mts.map +1 -0
- package/internal/shim-types.d.ts +11 -22
- package/internal/shim-types.d.ts.map +1 -0
- package/internal/shim-types.js +4 -0
- package/internal/shim-types.js.map +1 -0
- package/internal/shim-types.mjs +3 -0
- package/internal/shim-types.mjs.map +1 -0
- package/internal/shims.d.mts +2 -2
- package/internal/shims.d.mts.map +1 -1
- package/internal/shims.d.ts +2 -2
- package/internal/shims.d.ts.map +1 -1
- package/internal/uploads.js.map +1 -1
- package/internal/uploads.mjs.map +1 -1
- package/lib/runAndEvaluate.d.mts +49 -9
- package/lib/runAndEvaluate.d.mts.map +1 -1
- package/lib/runAndEvaluate.d.ts +49 -9
- package/lib/runAndEvaluate.d.ts.map +1 -1
- package/lib/runAndEvaluate.js +62 -23
- package/lib/runAndEvaluate.js.map +1 -1
- package/lib/runAndEvaluate.mjs +62 -23
- package/lib/runAndEvaluate.mjs.map +1 -1
- package/package.json +1 -4
- package/resources/index.d.mts +2 -2
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +2 -2
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs.map +1 -1
- package/resources/records.d.mts +11 -9
- package/resources/records.d.mts.map +1 -1
- package/resources/records.d.ts +11 -9
- package/resources/records.d.ts.map +1 -1
- package/resources/records.js +3 -1
- package/resources/records.js.map +1 -1
- package/resources/records.mjs +3 -1
- package/resources/records.mjs.map +1 -1
- package/resources/runs.d.mts +5 -32
- package/resources/runs.d.mts.map +1 -1
- package/resources/runs.d.ts +5 -32
- package/resources/runs.d.ts.map +1 -1
- package/resources/runs.js +1 -14
- package/resources/runs.js.map +1 -1
- package/resources/runs.mjs +1 -14
- package/resources/runs.mjs.map +1 -1
- package/resources/system-configs.d.mts +2 -9
- package/resources/system-configs.d.mts.map +1 -1
- package/resources/system-configs.d.ts +2 -9
- package/resources/system-configs.d.ts.map +1 -1
- package/resources/system-configs.js +2 -4
- package/resources/system-configs.js.map +1 -1
- package/resources/system-configs.mjs +2 -4
- package/resources/system-configs.mjs.map +1 -1
- package/resources/testcases.d.mts +10 -18
- package/resources/testcases.d.mts.map +1 -1
- package/resources/testcases.d.ts +10 -18
- package/resources/testcases.d.ts.map +1 -1
- package/resources/testsets.d.mts +31 -31
- package/resources/testsets.d.mts.map +1 -1
- package/resources/testsets.d.ts +31 -31
- package/resources/testsets.d.ts.map +1 -1
- package/resources/testsets.js +1 -1
- package/resources/testsets.mjs +1 -1
- package/src/client.ts +16 -10
- package/src/core/pagination.ts +1 -1
- package/src/index.ts +2 -0
- package/src/internal/detect-platform.ts +3 -3
- package/src/internal/shim-types.ts +26 -0
- package/src/internal/shims.ts +2 -2
- package/src/internal/uploads.ts +1 -1
- package/src/lib/runAndEvaluate.ts +133 -35
- package/src/resources/index.ts +1 -2
- package/src/resources/records.ts +13 -11
- package/src/resources/runs.ts +5 -57
- package/src/resources/system-configs.ts +2 -16
- package/src/resources/testcases.ts +11 -19
- package/src/resources/testsets.ts +31 -31
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
- package/src/internal/shim-types.d.ts +0 -28
package/lib/runAndEvaluate.mjs
CHANGED
|
@@ -1,36 +1,75 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Returns an async generator over the given Testset or Testcases.
|
|
3
|
+
*/
|
|
4
|
+
async function* testcaseIterator(scorecard, args) {
|
|
5
|
+
if ('testsetId' in args) {
|
|
6
|
+
for await (const testcase of scorecard.testcases.list(args.testsetId)) {
|
|
7
|
+
yield {
|
|
8
|
+
...testcase,
|
|
9
|
+
testcaseId: testcase.id,
|
|
10
|
+
inputs: testcase.inputs,
|
|
11
|
+
};
|
|
12
|
+
}
|
|
13
|
+
}
|
|
14
|
+
else {
|
|
15
|
+
for (const testcase of args.testcases) {
|
|
16
|
+
yield {
|
|
17
|
+
...testcase,
|
|
18
|
+
testcaseId: 'id' in testcase ? testcase.id : null,
|
|
19
|
+
inputs: testcase.inputs,
|
|
20
|
+
};
|
|
21
|
+
}
|
|
22
|
+
}
|
|
23
|
+
}
|
|
1
24
|
/**
|
|
2
25
|
* Runs a system on a Testset and records the results in Scorecard.
|
|
3
26
|
*
|
|
4
27
|
* @param scorecard The Scorecard client
|
|
5
|
-
* @param projectId The ID of the Project to run the system on.
|
|
6
|
-
* @param testsetId The ID of the Testset to run the system on.
|
|
7
|
-
* @param
|
|
8
|
-
* @param
|
|
28
|
+
* @param args.projectId The ID of the Project to run the system on.
|
|
29
|
+
* @param args.testsetId The optional ID of the Testset to run the system on. Either this or `args.testcases` must be provided.
|
|
30
|
+
* @param args.testcases The optional list of Testcases to run the system on. Either this or `args.testsetId` must be provided.
|
|
31
|
+
* @param args.metricIds The IDs of the Metrics to use for evaluation.
|
|
32
|
+
* @param args.systemConfigId The optional ID of the System Configuration to associate with the Run.
|
|
33
|
+
* @param args.system The system to run on the Testset.
|
|
34
|
+
* @param options.runInParallel Whether to call `args.system` in parallel. False (sequential) by default.
|
|
9
35
|
*/
|
|
10
|
-
export async function runAndEvaluate(scorecard,
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
36
|
+
export async function runAndEvaluate(scorecard, args, options = {
|
|
37
|
+
runInParallel: false,
|
|
38
|
+
}) {
|
|
39
|
+
const hasSystemConfig = 'systemConfigId' in args;
|
|
40
|
+
const hasTestset = 'testsetId' in args;
|
|
41
|
+
const runPromise = scorecard.runs.create(args.projectId, {
|
|
42
|
+
testsetId: hasTestset ? args.testsetId : null,
|
|
43
|
+
metricIds: args.metricIds,
|
|
44
|
+
...(hasSystemConfig ?
|
|
45
|
+
{
|
|
46
|
+
systemConfigId: args.systemConfigId,
|
|
47
|
+
}
|
|
48
|
+
: null),
|
|
14
49
|
});
|
|
15
|
-
|
|
50
|
+
const systemConfig = hasSystemConfig ? await scorecard.systemConfigs.get(args.systemConfigId) : null;
|
|
51
|
+
const run = await runPromise;
|
|
16
52
|
const recordPromises = [];
|
|
17
|
-
for await (const
|
|
18
|
-
const
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
53
|
+
for await (const { testcaseId, inputs, expected } of testcaseIterator(scorecard, args)) {
|
|
54
|
+
const modelResponsePromise = hasSystemConfig ? args.system(inputs, systemConfig) : args.system(inputs);
|
|
55
|
+
function createRecord(outputs) {
|
|
56
|
+
return scorecard.records.create(run.id, {
|
|
57
|
+
inputs,
|
|
58
|
+
expected,
|
|
59
|
+
outputs,
|
|
60
|
+
...(testcaseId != null ? { testcaseId } : null),
|
|
61
|
+
});
|
|
62
|
+
}
|
|
63
|
+
if (options.runInParallel) {
|
|
64
|
+
recordPromises.push(modelResponsePromise.then(createRecord));
|
|
65
|
+
}
|
|
66
|
+
else {
|
|
67
|
+
recordPromises.push(createRecord(await modelResponsePromise));
|
|
68
|
+
}
|
|
26
69
|
}
|
|
27
70
|
// Wait until all the Records are created
|
|
28
71
|
await Promise.all(recordPromises);
|
|
29
|
-
|
|
30
|
-
await scorecard.runs.update(run.id, {
|
|
31
|
-
status: 'awaiting_scoring',
|
|
32
|
-
});
|
|
33
|
-
const runUrl = `https://app.getscorecard.ai/projects/${projectId}/runs/grades/${run.id}`;
|
|
72
|
+
const runUrl = `${scorecard.baseAppURL}/projects/${args.projectId}/runs/${run.id}`;
|
|
34
73
|
return { id: run.id, url: runUrl };
|
|
35
74
|
}
|
|
36
75
|
//# sourceMappingURL=runAndEvaluate.mjs.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"runAndEvaluate.mjs","sourceRoot":"","sources":["../src/lib/runAndEvaluate.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"runAndEvaluate.mjs","sourceRoot":"","sources":["../src/lib/runAndEvaluate.ts"],"names":[],"mappings":"AAwDA;;GAEG;AACH,KAAK,SAAS,CAAC,CAAC,gBAAgB,CAC9B,SAAoB,EACpB,IAA0C;IAM1C,IAAI,WAAW,IAAI,IAAI,EAAE,CAAC;QACxB,IAAI,KAAK,EAAE,MAAM,QAAQ,IAAI,SAAS,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;YACtE,MAAM;gBACJ,GAAG,QAAQ;gBACX,UAAU,EAAE,QAAQ,CAAC,EAAE;gBACvB,MAAM,EAAE,QAAQ,CAAC,MAAqB;aACvC,CAAC;QACJ,CAAC;IACH,CAAC;SAAM,CAAC;QACN,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACtC,MAAM;gBACJ,GAAG,QAAQ;gBACX,UAAU,EAAE,IAAI,IAAI,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI;gBACjD,MAAM,EAAE,QAAQ,CAAC,MAAqB;aACvC,CAAC;QACJ,CAAC;IACH,CAAC;AACH,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAIlC,SAAoB,EACpB,IAAmD,EACnD,UAEI;IACF,aAAa,EAAE,KAAK;CACrB;IAED,MAAM,eAAe,GAAG,gBAAgB,IAAI,IAAI,CAAC;IACjD,MAAM,UAAU,GAAG,WAAW,IAAI,IAAI,CAAC;IAEvC,MAAM,UAAU,GAAG,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE;QACvD,SAAS,EAAE,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI;QAC7C,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,GAAG,CAAC,eAAe,CAAC,CAAC;YACnB;gBACE,cAAc,EAAE,IAAI,CAAC,cAAc;aACpC;YACH,CAAC,CAAC,IAAI,CAAC;KACR,CAAC,CAAC;IACH,MAAM,YAAY,GAAG,eAAe,CAAC,CAAC,CAAC,MAAM,SAAS,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IACrG,MAAM,GAAG,GAAG,MAAM,UAAU,CAAC;IAE7B,MAAM,cAAc,GAA4B,EAAE,CAAC;IAEnD,IAAI,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,gBAAgB,CAAC,SAAS,EAAE,IAAI,CAAC,EAAE,CAAC;QACvF,MAAM,oBAAoB,GAAG,eAAe,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,YAAa,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAExG,SAAS,YAAY,CAAC,OAAqB;YACzC,OAAO,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,EAAE;gBACtC,MAAM;gBACN,QAAQ;gBACR,OAAO;gBACP,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;aAChD,CAAC,CAAC;QACL,CAAC;QAED,IAAI,OAAO,CAAC,aAAa,EAAE,CAAC;YAC1B,cAAc,CAAC,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC;QAC/D,CAAC;aAAM,CAAC;YACN,cAAc,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,oBAAoB,CAAC,CAAC,CAAC;QAChE,CAAC;IACH,CAAC;IACD,yCAAyC;IACzC,MAAM,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;IAElC,MAAM,MAAM,GAAG,GAAG,SAAS,CAAC,UAAU,aAAa,IAAI,CAAC,SAAS,SAAS,GAAG,CAAC,EAAE,EAAE,CAAC;IAEnF,OAAO,EAAE,EAAE,EAAE,GAAG,CAAC,EAAE,EAAE,GAAG,EAAE,MAAM,EAAE,CAAC;AACrC,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "scorecard-ai",
|
|
3
|
-
"version": "1.0.0-alpha.
|
|
3
|
+
"version": "1.0.0-alpha.9",
|
|
4
4
|
"description": "The official TypeScript library for the Scorecard API",
|
|
5
5
|
"author": "Scorecard <team@scorecard.io>",
|
|
6
6
|
"types": "./index.d.ts",
|
|
@@ -22,9 +22,6 @@
|
|
|
22
22
|
"fix": "./scripts/format"
|
|
23
23
|
},
|
|
24
24
|
"dependencies": {},
|
|
25
|
-
"resolutions": {
|
|
26
|
-
"synckit": "0.8.8"
|
|
27
|
-
},
|
|
28
25
|
"imports": {
|
|
29
26
|
"scorecard-ai": ".",
|
|
30
27
|
"scorecard-ai/*": "./src/*"
|
package/resources/index.d.mts
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
export * from "./shared.mjs";
|
|
2
2
|
export { Projects, type Project, type ProjectCreateParams, type ProjectListParams, type ProjectsPaginatedResponse, } from "./projects.mjs";
|
|
3
3
|
export { Records, type Record, type RecordCreateParams } from "./records.mjs";
|
|
4
|
-
export { Runs, type Run, type
|
|
4
|
+
export { Runs, type Run, type RunCreateParams } from "./runs.mjs";
|
|
5
5
|
export { Scores, type Score, type ScoreUpsertParams } from "./scores.mjs";
|
|
6
|
-
export { SystemConfigs, type SystemConfig, type SystemConfigCreateParams, type SystemConfigListParams, type
|
|
6
|
+
export { SystemConfigs, type SystemConfig, type SystemConfigCreateParams, type SystemConfigListParams, type SystemConfigsPaginatedResponse, } from "./system-configs.mjs";
|
|
7
7
|
export { Systems, type System, type SystemDeleteResponse, type SystemCreateParams, type SystemUpdateParams, type SystemListParams, type SystemsPaginatedResponse, } from "./systems.mjs";
|
|
8
8
|
export { Testcases, type Testcase, type TestcaseCreateResponse, type TestcaseDeleteResponse, type TestcaseCreateParams, type TestcaseUpdateParams, type TestcaseListParams, type TestcaseDeleteParams, type TestcasesPaginatedResponse, } from "./testcases.mjs";
|
|
9
9
|
export { Testsets, type Testset, type TestsetDeleteResponse, type TestsetCreateParams, type TestsetUpdateParams, type TestsetListParams, type TestsetsPaginatedResponse, } from "./testsets.mjs";
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":";OAGO,EACL,QAAQ,EACR,KAAK,OAAO,EACZ,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,EACtB,KAAK,yBAAyB,GAC/B;OACM,EAAE,OAAO,EAAE,KAAK,MAAM,EAAE,KAAK,kBAAkB,EAAE;OACjD,EAAE,IAAI,EAAE,KAAK,GAAG,EAAE,KAAK,
|
|
1
|
+
{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":";OAGO,EACL,QAAQ,EACR,KAAK,OAAO,EACZ,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,EACtB,KAAK,yBAAyB,GAC/B;OACM,EAAE,OAAO,EAAE,KAAK,MAAM,EAAE,KAAK,kBAAkB,EAAE;OACjD,EAAE,IAAI,EAAE,KAAK,GAAG,EAAE,KAAK,eAAe,EAAE;OACxC,EAAE,MAAM,EAAE,KAAK,KAAK,EAAE,KAAK,iBAAiB,EAAE;OAC9C,EACL,aAAa,EACb,KAAK,YAAY,EACjB,KAAK,wBAAwB,EAC7B,KAAK,sBAAsB,EAC3B,KAAK,8BAA8B,GACpC;OACM,EACL,OAAO,EACP,KAAK,MAAM,EACX,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,EACvB,KAAK,kBAAkB,EACvB,KAAK,gBAAgB,EACrB,KAAK,wBAAwB,GAC9B;OACM,EACL,SAAS,EACT,KAAK,QAAQ,EACb,KAAK,sBAAsB,EAC3B,KAAK,sBAAsB,EAC3B,KAAK,oBAAoB,EACzB,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,EACvB,KAAK,oBAAoB,EACzB,KAAK,0BAA0B,GAChC;OACM,EACL,QAAQ,EACR,KAAK,OAAO,EACZ,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACxB,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,EACtB,KAAK,yBAAyB,GAC/B"}
|
package/resources/index.d.ts
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
export * from "./shared.js";
|
|
2
2
|
export { Projects, type Project, type ProjectCreateParams, type ProjectListParams, type ProjectsPaginatedResponse, } from "./projects.js";
|
|
3
3
|
export { Records, type Record, type RecordCreateParams } from "./records.js";
|
|
4
|
-
export { Runs, type Run, type
|
|
4
|
+
export { Runs, type Run, type RunCreateParams } from "./runs.js";
|
|
5
5
|
export { Scores, type Score, type ScoreUpsertParams } from "./scores.js";
|
|
6
|
-
export { SystemConfigs, type SystemConfig, type SystemConfigCreateParams, type SystemConfigListParams, type
|
|
6
|
+
export { SystemConfigs, type SystemConfig, type SystemConfigCreateParams, type SystemConfigListParams, type SystemConfigsPaginatedResponse, } from "./system-configs.js";
|
|
7
7
|
export { Systems, type System, type SystemDeleteResponse, type SystemCreateParams, type SystemUpdateParams, type SystemListParams, type SystemsPaginatedResponse, } from "./systems.js";
|
|
8
8
|
export { Testcases, type Testcase, type TestcaseCreateResponse, type TestcaseDeleteResponse, type TestcaseCreateParams, type TestcaseUpdateParams, type TestcaseListParams, type TestcaseDeleteParams, type TestcasesPaginatedResponse, } from "./testcases.js";
|
|
9
9
|
export { Testsets, type Testset, type TestsetDeleteResponse, type TestsetCreateParams, type TestsetUpdateParams, type TestsetListParams, type TestsetsPaginatedResponse, } from "./testsets.js";
|
package/resources/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":";OAGO,EACL,QAAQ,EACR,KAAK,OAAO,EACZ,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,EACtB,KAAK,yBAAyB,GAC/B;OACM,EAAE,OAAO,EAAE,KAAK,MAAM,EAAE,KAAK,kBAAkB,EAAE;OACjD,EAAE,IAAI,EAAE,KAAK,GAAG,EAAE,KAAK,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":";OAGO,EACL,QAAQ,EACR,KAAK,OAAO,EACZ,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,EACtB,KAAK,yBAAyB,GAC/B;OACM,EAAE,OAAO,EAAE,KAAK,MAAM,EAAE,KAAK,kBAAkB,EAAE;OACjD,EAAE,IAAI,EAAE,KAAK,GAAG,EAAE,KAAK,eAAe,EAAE;OACxC,EAAE,MAAM,EAAE,KAAK,KAAK,EAAE,KAAK,iBAAiB,EAAE;OAC9C,EACL,aAAa,EACb,KAAK,YAAY,EACjB,KAAK,wBAAwB,EAC7B,KAAK,sBAAsB,EAC3B,KAAK,8BAA8B,GACpC;OACM,EACL,OAAO,EACP,KAAK,MAAM,EACX,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,EACvB,KAAK,kBAAkB,EACvB,KAAK,gBAAgB,EACrB,KAAK,wBAAwB,GAC9B;OACM,EACL,SAAS,EACT,KAAK,QAAQ,EACb,KAAK,sBAAsB,EAC3B,KAAK,sBAAsB,EAC3B,KAAK,oBAAoB,EACzB,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,EACvB,KAAK,oBAAoB,EACzB,KAAK,0BAA0B,GAChC;OACM,EACL,QAAQ,EACR,KAAK,OAAO,EACZ,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACxB,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,EACtB,KAAK,yBAAyB,GAC/B"}
|
package/resources/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,sDAAyB;AACzB,0CAMoB;AALlB,oGAAA,QAAQ,OAAA;AAMV,wCAA0E;AAAjE,kGAAA,OAAO,OAAA;AAChB,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,sDAAyB;AACzB,0CAMoB;AALlB,oGAAA,QAAQ,OAAA;AAMV,wCAA0E;AAAjE,kGAAA,OAAO,OAAA;AAChB,kCAA8D;AAArD,4FAAA,IAAI,OAAA;AACb,sCAAsE;AAA7D,gGAAA,MAAM,OAAA;AACf,sDAM0B;AALxB,+GAAA,aAAa,OAAA;AAMf,wCAQmB;AAPjB,kGAAA,OAAO,OAAA;AAQT,4CAUqB;AATnB,sGAAA,SAAS,OAAA;AAUX,0CAQoB;AAPlB,oGAAA,QAAQ,OAAA"}
|
package/resources/index.mjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;;OAG/E,EACL,QAAQ,GAKT;OACM,EAAE,OAAO,EAAwC;OACjD,EAAE,IAAI,
|
|
1
|
+
{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;;OAG/E,EACL,QAAQ,GAKT;OACM,EAAE,OAAO,EAAwC;OACjD,EAAE,IAAI,EAAkC;OACxC,EAAE,MAAM,EAAsC;OAC9C,EACL,aAAa,GAKd;OACM,EACL,OAAO,GAOR;OACM,EACL,SAAS,GASV;OACM,EACL,QAAQ,GAOT"}
|
package/resources/records.d.mts
CHANGED
|
@@ -9,8 +9,10 @@ export declare class Records extends APIResource {
|
|
|
9
9
|
* @example
|
|
10
10
|
* ```ts
|
|
11
11
|
* const record = await client.records.create('135', {
|
|
12
|
+
* expected: {
|
|
13
|
+
* idealAnswer: 'Paris is the capital of France',
|
|
14
|
+
* },
|
|
12
15
|
* inputs: { question: 'What is the capital of France?' },
|
|
13
|
-
* labels: { idealAnswer: 'Paris is the capital of France' },
|
|
14
16
|
* outputs: { response: 'The capital of France is Paris.' },
|
|
15
17
|
* testcaseId: '248',
|
|
16
18
|
* });
|
|
@@ -26,15 +28,15 @@ export interface Record {
|
|
|
26
28
|
* The ID of the Record.
|
|
27
29
|
*/
|
|
28
30
|
id: string;
|
|
31
|
+
/**
|
|
32
|
+
* The expected outputs for the Testcase.
|
|
33
|
+
*/
|
|
34
|
+
expected: BuiltinRecord<string, unknown>;
|
|
29
35
|
/**
|
|
30
36
|
* The actual inputs sent to the system, which should match the system's input
|
|
31
37
|
* schema.
|
|
32
38
|
*/
|
|
33
39
|
inputs: BuiltinRecord<string, unknown>;
|
|
34
|
-
/**
|
|
35
|
-
* The expected outputs for the Testcase.
|
|
36
|
-
*/
|
|
37
|
-
labels: BuiltinRecord<string, unknown>;
|
|
38
40
|
/**
|
|
39
41
|
* The actual outputs from the system.
|
|
40
42
|
*/
|
|
@@ -49,15 +51,15 @@ export interface Record {
|
|
|
49
51
|
testcaseId?: string;
|
|
50
52
|
}
|
|
51
53
|
export interface RecordCreateParams {
|
|
54
|
+
/**
|
|
55
|
+
* The expected outputs for the Testcase.
|
|
56
|
+
*/
|
|
57
|
+
expected: BuiltinRecord<string, unknown>;
|
|
52
58
|
/**
|
|
53
59
|
* The actual inputs sent to the system, which should match the system's input
|
|
54
60
|
* schema.
|
|
55
61
|
*/
|
|
56
62
|
inputs: BuiltinRecord<string, unknown>;
|
|
57
|
-
/**
|
|
58
|
-
* The expected outputs for the Testcase.
|
|
59
|
-
*/
|
|
60
|
-
labels: BuiltinRecord<string, unknown>;
|
|
61
63
|
/**
|
|
62
64
|
* The actual outputs from the system.
|
|
63
65
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"records.d.mts","sourceRoot":"","sources":["../src/resources/records.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,KAAK,MAAM,IAAI,aAAa,EAAE;OAChC,EAAE,cAAc,EAAE;AAGzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC
|
|
1
|
+
{"version":3,"file":"records.d.mts","sourceRoot":"","sources":["../src/resources/records.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,KAAK,MAAM,IAAI,aAAa,EAAE;OAChC,EAAE,cAAc,EAAE;AAGzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;CAG9F;AAED;;GAEG;AACH,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,QAAQ,EAAE,aAAa,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEzC;;;OAGG;IACH,MAAM,EAAE,aAAa,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEvC;;OAEG;IACH,OAAO,EAAE,aAAa,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAExC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,QAAQ,EAAE,aAAa,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEzC;;;OAGG;IACH,MAAM,EAAE,aAAa,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEvC;;OAEG;IACH,OAAO,EAAE,aAAa,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAExC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EAAE,KAAK,MAAM,IAAI,MAAM,EAAE,KAAK,kBAAkB,IAAI,kBAAkB,EAAE,CAAC;CACjF"}
|
package/resources/records.d.ts
CHANGED
|
@@ -9,8 +9,10 @@ export declare class Records extends APIResource {
|
|
|
9
9
|
* @example
|
|
10
10
|
* ```ts
|
|
11
11
|
* const record = await client.records.create('135', {
|
|
12
|
+
* expected: {
|
|
13
|
+
* idealAnswer: 'Paris is the capital of France',
|
|
14
|
+
* },
|
|
12
15
|
* inputs: { question: 'What is the capital of France?' },
|
|
13
|
-
* labels: { idealAnswer: 'Paris is the capital of France' },
|
|
14
16
|
* outputs: { response: 'The capital of France is Paris.' },
|
|
15
17
|
* testcaseId: '248',
|
|
16
18
|
* });
|
|
@@ -26,15 +28,15 @@ export interface Record {
|
|
|
26
28
|
* The ID of the Record.
|
|
27
29
|
*/
|
|
28
30
|
id: string;
|
|
31
|
+
/**
|
|
32
|
+
* The expected outputs for the Testcase.
|
|
33
|
+
*/
|
|
34
|
+
expected: BuiltinRecord<string, unknown>;
|
|
29
35
|
/**
|
|
30
36
|
* The actual inputs sent to the system, which should match the system's input
|
|
31
37
|
* schema.
|
|
32
38
|
*/
|
|
33
39
|
inputs: BuiltinRecord<string, unknown>;
|
|
34
|
-
/**
|
|
35
|
-
* The expected outputs for the Testcase.
|
|
36
|
-
*/
|
|
37
|
-
labels: BuiltinRecord<string, unknown>;
|
|
38
40
|
/**
|
|
39
41
|
* The actual outputs from the system.
|
|
40
42
|
*/
|
|
@@ -49,15 +51,15 @@ export interface Record {
|
|
|
49
51
|
testcaseId?: string;
|
|
50
52
|
}
|
|
51
53
|
export interface RecordCreateParams {
|
|
54
|
+
/**
|
|
55
|
+
* The expected outputs for the Testcase.
|
|
56
|
+
*/
|
|
57
|
+
expected: BuiltinRecord<string, unknown>;
|
|
52
58
|
/**
|
|
53
59
|
* The actual inputs sent to the system, which should match the system's input
|
|
54
60
|
* schema.
|
|
55
61
|
*/
|
|
56
62
|
inputs: BuiltinRecord<string, unknown>;
|
|
57
|
-
/**
|
|
58
|
-
* The expected outputs for the Testcase.
|
|
59
|
-
*/
|
|
60
|
-
labels: BuiltinRecord<string, unknown>;
|
|
61
63
|
/**
|
|
62
64
|
* The actual outputs from the system.
|
|
63
65
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"records.d.ts","sourceRoot":"","sources":["../src/resources/records.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,KAAK,MAAM,IAAI,aAAa,EAAE;OAChC,EAAE,cAAc,EAAE;AAGzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC
|
|
1
|
+
{"version":3,"file":"records.d.ts","sourceRoot":"","sources":["../src/resources/records.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,KAAK,MAAM,IAAI,aAAa,EAAE;OAChC,EAAE,cAAc,EAAE;AAGzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;CAG9F;AAED;;GAEG;AACH,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,QAAQ,EAAE,aAAa,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEzC;;;OAGG;IACH,MAAM,EAAE,aAAa,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEvC;;OAEG;IACH,OAAO,EAAE,aAAa,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAExC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,QAAQ,EAAE,aAAa,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEzC;;;OAGG;IACH,MAAM,EAAE,aAAa,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEvC;;OAEG;IACH,OAAO,EAAE,aAAa,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAExC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EAAE,KAAK,MAAM,IAAI,MAAM,EAAE,KAAK,kBAAkB,IAAI,kBAAkB,EAAE,CAAC;CACjF"}
|
package/resources/records.js
CHANGED
|
@@ -11,8 +11,10 @@ class Records extends resource_1.APIResource {
|
|
|
11
11
|
* @example
|
|
12
12
|
* ```ts
|
|
13
13
|
* const record = await client.records.create('135', {
|
|
14
|
+
* expected: {
|
|
15
|
+
* idealAnswer: 'Paris is the capital of France',
|
|
16
|
+
* },
|
|
14
17
|
* inputs: { question: 'What is the capital of France?' },
|
|
15
|
-
* labels: { idealAnswer: 'Paris is the capital of France' },
|
|
16
18
|
* outputs: { response: 'The capital of France is Paris.' },
|
|
17
19
|
* testcaseId: '248',
|
|
18
20
|
* });
|
package/resources/records.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"records.js","sourceRoot":"","sources":["../src/resources/records.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C,oDAA8C;AAE9C,MAAa,OAAQ,SAAQ,sBAAW;IACtC
|
|
1
|
+
{"version":3,"file":"records.js","sourceRoot":"","sources":["../src/resources/records.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C,oDAA8C;AAE9C,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,KAAa,EAAE,IAAwB,EAAE,OAAwB;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,SAAS,KAAK,UAAU,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;CACF;AAnBD,0BAmBC"}
|
package/resources/records.mjs
CHANGED
|
@@ -8,8 +8,10 @@ export class Records extends APIResource {
|
|
|
8
8
|
* @example
|
|
9
9
|
* ```ts
|
|
10
10
|
* const record = await client.records.create('135', {
|
|
11
|
+
* expected: {
|
|
12
|
+
* idealAnswer: 'Paris is the capital of France',
|
|
13
|
+
* },
|
|
11
14
|
* inputs: { question: 'What is the capital of France?' },
|
|
12
|
-
* labels: { idealAnswer: 'Paris is the capital of France' },
|
|
13
15
|
* outputs: { response: 'The capital of France is Paris.' },
|
|
14
16
|
* testcaseId: '248',
|
|
15
17
|
* });
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"records.mjs","sourceRoot":"","sources":["../src/resources/records.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAIf,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC
|
|
1
|
+
{"version":3,"file":"records.mjs","sourceRoot":"","sources":["../src/resources/records.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAIf,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,KAAa,EAAE,IAAwB,EAAE,OAAwB;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,SAAS,KAAK,UAAU,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;CACF"}
|
package/resources/runs.d.mts
CHANGED
|
@@ -9,23 +9,12 @@ export declare class Runs extends APIResource {
|
|
|
9
9
|
* ```ts
|
|
10
10
|
* const run = await client.runs.create('314', {
|
|
11
11
|
* metricIds: ['789', '101'],
|
|
12
|
-
* testsetId: '246',
|
|
13
12
|
* systemConfigId: '87654321-4d3b-4ae4-8c7a-4b6e2a19ccf0',
|
|
13
|
+
* testsetId: '246',
|
|
14
14
|
* });
|
|
15
15
|
* ```
|
|
16
16
|
*/
|
|
17
17
|
create(projectID: string, body: RunCreateParams, options?: RequestOptions): APIPromise<Run>;
|
|
18
|
-
/**
|
|
19
|
-
* Update the status of a Run.
|
|
20
|
-
*
|
|
21
|
-
* @example
|
|
22
|
-
* ```ts
|
|
23
|
-
* const run = await client.runs.update('135', {
|
|
24
|
-
* status: 'awaiting_scoring',
|
|
25
|
-
* });
|
|
26
|
-
* ```
|
|
27
|
-
*/
|
|
28
|
-
update(runID: string, body: RunUpdateParams, options?: RequestOptions): APIPromise<RunUpdateResponse>;
|
|
29
18
|
}
|
|
30
19
|
/**
|
|
31
20
|
* A Run in the Scorecard system.
|
|
@@ -46,43 +35,27 @@ export interface Run {
|
|
|
46
35
|
/**
|
|
47
36
|
* The ID of the Testset this Run is testing.
|
|
48
37
|
*/
|
|
49
|
-
testsetId: string;
|
|
38
|
+
testsetId: string | null;
|
|
50
39
|
/**
|
|
51
40
|
* The ID of the system configuration this Run is using.
|
|
52
41
|
*/
|
|
53
42
|
systemConfigId?: string;
|
|
54
43
|
}
|
|
55
|
-
export interface RunUpdateResponse {
|
|
56
|
-
/**
|
|
57
|
-
* The ID of the Run.
|
|
58
|
-
*/
|
|
59
|
-
id: string;
|
|
60
|
-
/**
|
|
61
|
-
* The status of the Run.
|
|
62
|
-
*/
|
|
63
|
-
status: 'pending' | 'awaiting_execution' | 'running_execution' | 'awaiting_scoring' | 'running_scoring' | 'awaiting_human_scoring' | 'completed';
|
|
64
|
-
}
|
|
65
44
|
export interface RunCreateParams {
|
|
66
45
|
/**
|
|
67
46
|
* The IDs of the metrics this Run is using.
|
|
68
47
|
*/
|
|
69
48
|
metricIds: Array<string>;
|
|
70
|
-
/**
|
|
71
|
-
* The ID of the Testset this Run is testing.
|
|
72
|
-
*/
|
|
73
|
-
testsetId: string;
|
|
74
49
|
/**
|
|
75
50
|
* The ID of the system configuration this Run is using.
|
|
76
51
|
*/
|
|
77
52
|
systemConfigId?: string;
|
|
78
|
-
}
|
|
79
|
-
export interface RunUpdateParams {
|
|
80
53
|
/**
|
|
81
|
-
* The
|
|
54
|
+
* The ID of the Testset this Run is testing.
|
|
82
55
|
*/
|
|
83
|
-
|
|
56
|
+
testsetId?: string | null;
|
|
84
57
|
}
|
|
85
58
|
export declare namespace Runs {
|
|
86
|
-
export { type Run as Run, type
|
|
59
|
+
export { type Run as Run, type RunCreateParams as RunCreateParams };
|
|
87
60
|
}
|
|
88
61
|
//# sourceMappingURL=runs.d.mts.map
|
package/resources/runs.d.mts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"runs.d.mts","sourceRoot":"","sources":["../src/resources/runs.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,IAAK,SAAQ,WAAW;IACnC;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,GAAG,CAAC;
|
|
1
|
+
{"version":3,"file":"runs.d.mts","sourceRoot":"","sources":["../src/resources/runs.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,IAAK,SAAQ,WAAW;IACnC;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,GAAG,CAAC;CAG5F;AAED;;GAEG;AACH,MAAM,WAAW,GAAG;IAClB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEzB;;OAEG;IACH,MAAM,EACF,SAAS,GACT,oBAAoB,GACpB,mBAAmB,GACnB,kBAAkB,GAClB,iBAAiB,GACjB,wBAAwB,GACxB,WAAW,CAAC;IAEhB;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEzB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,OAAO,EAAE,KAAK,GAAG,IAAI,GAAG,EAAE,KAAK,eAAe,IAAI,eAAe,EAAE,CAAC;CACrE"}
|
package/resources/runs.d.ts
CHANGED
|
@@ -9,23 +9,12 @@ export declare class Runs extends APIResource {
|
|
|
9
9
|
* ```ts
|
|
10
10
|
* const run = await client.runs.create('314', {
|
|
11
11
|
* metricIds: ['789', '101'],
|
|
12
|
-
* testsetId: '246',
|
|
13
12
|
* systemConfigId: '87654321-4d3b-4ae4-8c7a-4b6e2a19ccf0',
|
|
13
|
+
* testsetId: '246',
|
|
14
14
|
* });
|
|
15
15
|
* ```
|
|
16
16
|
*/
|
|
17
17
|
create(projectID: string, body: RunCreateParams, options?: RequestOptions): APIPromise<Run>;
|
|
18
|
-
/**
|
|
19
|
-
* Update the status of a Run.
|
|
20
|
-
*
|
|
21
|
-
* @example
|
|
22
|
-
* ```ts
|
|
23
|
-
* const run = await client.runs.update('135', {
|
|
24
|
-
* status: 'awaiting_scoring',
|
|
25
|
-
* });
|
|
26
|
-
* ```
|
|
27
|
-
*/
|
|
28
|
-
update(runID: string, body: RunUpdateParams, options?: RequestOptions): APIPromise<RunUpdateResponse>;
|
|
29
18
|
}
|
|
30
19
|
/**
|
|
31
20
|
* A Run in the Scorecard system.
|
|
@@ -46,43 +35,27 @@ export interface Run {
|
|
|
46
35
|
/**
|
|
47
36
|
* The ID of the Testset this Run is testing.
|
|
48
37
|
*/
|
|
49
|
-
testsetId: string;
|
|
38
|
+
testsetId: string | null;
|
|
50
39
|
/**
|
|
51
40
|
* The ID of the system configuration this Run is using.
|
|
52
41
|
*/
|
|
53
42
|
systemConfigId?: string;
|
|
54
43
|
}
|
|
55
|
-
export interface RunUpdateResponse {
|
|
56
|
-
/**
|
|
57
|
-
* The ID of the Run.
|
|
58
|
-
*/
|
|
59
|
-
id: string;
|
|
60
|
-
/**
|
|
61
|
-
* The status of the Run.
|
|
62
|
-
*/
|
|
63
|
-
status: 'pending' | 'awaiting_execution' | 'running_execution' | 'awaiting_scoring' | 'running_scoring' | 'awaiting_human_scoring' | 'completed';
|
|
64
|
-
}
|
|
65
44
|
export interface RunCreateParams {
|
|
66
45
|
/**
|
|
67
46
|
* The IDs of the metrics this Run is using.
|
|
68
47
|
*/
|
|
69
48
|
metricIds: Array<string>;
|
|
70
|
-
/**
|
|
71
|
-
* The ID of the Testset this Run is testing.
|
|
72
|
-
*/
|
|
73
|
-
testsetId: string;
|
|
74
49
|
/**
|
|
75
50
|
* The ID of the system configuration this Run is using.
|
|
76
51
|
*/
|
|
77
52
|
systemConfigId?: string;
|
|
78
|
-
}
|
|
79
|
-
export interface RunUpdateParams {
|
|
80
53
|
/**
|
|
81
|
-
* The
|
|
54
|
+
* The ID of the Testset this Run is testing.
|
|
82
55
|
*/
|
|
83
|
-
|
|
56
|
+
testsetId?: string | null;
|
|
84
57
|
}
|
|
85
58
|
export declare namespace Runs {
|
|
86
|
-
export { type Run as Run, type
|
|
59
|
+
export { type Run as Run, type RunCreateParams as RunCreateParams };
|
|
87
60
|
}
|
|
88
61
|
//# sourceMappingURL=runs.d.ts.map
|
package/resources/runs.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"runs.d.ts","sourceRoot":"","sources":["../src/resources/runs.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,IAAK,SAAQ,WAAW;IACnC;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,GAAG,CAAC;
|
|
1
|
+
{"version":3,"file":"runs.d.ts","sourceRoot":"","sources":["../src/resources/runs.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,IAAK,SAAQ,WAAW;IACnC;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,GAAG,CAAC;CAG5F;AAED;;GAEG;AACH,MAAM,WAAW,GAAG;IAClB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEzB;;OAEG;IACH,MAAM,EACF,SAAS,GACT,oBAAoB,GACpB,mBAAmB,GACnB,kBAAkB,GAClB,iBAAiB,GACjB,wBAAwB,GACxB,WAAW,CAAC;IAEhB;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEzB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,OAAO,EAAE,KAAK,GAAG,IAAI,GAAG,EAAE,KAAK,eAAe,IAAI,eAAe,EAAE,CAAC;CACrE"}
|
package/resources/runs.js
CHANGED
|
@@ -12,27 +12,14 @@ class Runs extends resource_1.APIResource {
|
|
|
12
12
|
* ```ts
|
|
13
13
|
* const run = await client.runs.create('314', {
|
|
14
14
|
* metricIds: ['789', '101'],
|
|
15
|
-
* testsetId: '246',
|
|
16
15
|
* systemConfigId: '87654321-4d3b-4ae4-8c7a-4b6e2a19ccf0',
|
|
16
|
+
* testsetId: '246',
|
|
17
17
|
* });
|
|
18
18
|
* ```
|
|
19
19
|
*/
|
|
20
20
|
create(projectID, body, options) {
|
|
21
21
|
return this._client.post((0, path_1.path) `/projects/${projectID}/runs`, { body, ...options });
|
|
22
22
|
}
|
|
23
|
-
/**
|
|
24
|
-
* Update the status of a Run.
|
|
25
|
-
*
|
|
26
|
-
* @example
|
|
27
|
-
* ```ts
|
|
28
|
-
* const run = await client.runs.update('135', {
|
|
29
|
-
* status: 'awaiting_scoring',
|
|
30
|
-
* });
|
|
31
|
-
* ```
|
|
32
|
-
*/
|
|
33
|
-
update(runID, body, options) {
|
|
34
|
-
return this._client.patch((0, path_1.path) `/runs/${runID}`, { body, ...options });
|
|
35
|
-
}
|
|
36
23
|
}
|
|
37
24
|
exports.Runs = Runs;
|
|
38
25
|
//# sourceMappingURL=runs.js.map
|
package/resources/runs.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"runs.js","sourceRoot":"","sources":["../src/resources/runs.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,oDAA8C;AAE9C,MAAa,IAAK,SAAQ,sBAAW;IACnC;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,SAAiB,EAAE,IAAqB,EAAE,OAAwB;QACvE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,aAAa,SAAS,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpF,CAAC;
|
|
1
|
+
{"version":3,"file":"runs.js","sourceRoot":"","sources":["../src/resources/runs.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,oDAA8C;AAE9C,MAAa,IAAK,SAAQ,sBAAW;IACnC;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,SAAiB,EAAE,IAAqB,EAAE,OAAwB;QACvE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,aAAa,SAAS,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpF,CAAC;CACF;AAhBD,oBAgBC"}
|
package/resources/runs.mjs
CHANGED
|
@@ -9,26 +9,13 @@ export class Runs extends APIResource {
|
|
|
9
9
|
* ```ts
|
|
10
10
|
* const run = await client.runs.create('314', {
|
|
11
11
|
* metricIds: ['789', '101'],
|
|
12
|
-
* testsetId: '246',
|
|
13
12
|
* systemConfigId: '87654321-4d3b-4ae4-8c7a-4b6e2a19ccf0',
|
|
13
|
+
* testsetId: '246',
|
|
14
14
|
* });
|
|
15
15
|
* ```
|
|
16
16
|
*/
|
|
17
17
|
create(projectID, body, options) {
|
|
18
18
|
return this._client.post(path `/projects/${projectID}/runs`, { body, ...options });
|
|
19
19
|
}
|
|
20
|
-
/**
|
|
21
|
-
* Update the status of a Run.
|
|
22
|
-
*
|
|
23
|
-
* @example
|
|
24
|
-
* ```ts
|
|
25
|
-
* const run = await client.runs.update('135', {
|
|
26
|
-
* status: 'awaiting_scoring',
|
|
27
|
-
* });
|
|
28
|
-
* ```
|
|
29
|
-
*/
|
|
30
|
-
update(runID, body, options) {
|
|
31
|
-
return this._client.patch(path `/runs/${runID}`, { body, ...options });
|
|
32
|
-
}
|
|
33
20
|
}
|
|
34
21
|
//# sourceMappingURL=runs.mjs.map
|
package/resources/runs.mjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"runs.mjs","sourceRoot":"","sources":["../src/resources/runs.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,IAAK,SAAQ,WAAW;IACnC;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,SAAiB,EAAE,IAAqB,EAAE,OAAwB;QACvE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,aAAa,SAAS,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpF,CAAC;
|
|
1
|
+
{"version":3,"file":"runs.mjs","sourceRoot":"","sources":["../src/resources/runs.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,IAAK,SAAQ,WAAW;IACnC;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,SAAiB,EAAE,IAAqB,EAAE,OAAwB;QACvE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,aAAa,SAAS,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpF,CAAC;CACF"}
|
|
@@ -60,11 +60,10 @@ export declare class SystemConfigs extends APIResource {
|
|
|
60
60
|
* ```ts
|
|
61
61
|
* const systemConfig = await client.systemConfigs.get(
|
|
62
62
|
* '87654321-4d3b-4ae4-8c7a-4b6e2a19ccf0',
|
|
63
|
-
* { systemId: '12345678-0a8b-4f66-b6f3-2ddcfa097257' },
|
|
64
63
|
* );
|
|
65
64
|
* ```
|
|
66
65
|
*/
|
|
67
|
-
get(systemConfigID: string,
|
|
66
|
+
get(systemConfigID: string, options?: RequestOptions): APIPromise<SystemConfig>;
|
|
68
67
|
}
|
|
69
68
|
export type SystemConfigsPaginatedResponse = PaginatedResponse<SystemConfig>;
|
|
70
69
|
/**
|
|
@@ -143,13 +142,7 @@ export declare namespace SystemConfigCreateParams {
|
|
|
143
142
|
}
|
|
144
143
|
export interface SystemConfigListParams extends PaginatedResponseParams {
|
|
145
144
|
}
|
|
146
|
-
export interface SystemConfigGetParams {
|
|
147
|
-
/**
|
|
148
|
-
* The ID of the system the configuration belongs to.
|
|
149
|
-
*/
|
|
150
|
-
systemId: string;
|
|
151
|
-
}
|
|
152
145
|
export declare namespace SystemConfigs {
|
|
153
|
-
export { type SystemConfig as SystemConfig, type SystemConfigsPaginatedResponse as SystemConfigsPaginatedResponse, type SystemConfigCreateParams as SystemConfigCreateParams, type SystemConfigListParams as SystemConfigListParams,
|
|
146
|
+
export { type SystemConfig as SystemConfig, type SystemConfigsPaginatedResponse as SystemConfigsPaginatedResponse, type SystemConfigCreateParams as SystemConfigCreateParams, type SystemConfigListParams as SystemConfigListParams, };
|
|
154
147
|
}
|
|
155
148
|
//# sourceMappingURL=system-configs.d.mts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"system-configs.d.mts","sourceRoot":"","sources":["../src/resources/system-configs.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,WAAW,EAAE,iBAAiB,EAAE,KAAK,uBAAuB,EAAE;OAChE,EAAE,cAAc,EAAE;AAGzB,qBAAa,aAAc,SAAQ,WAAW;IAC5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,MAAM,CACJ,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,wBAAwB,EAC9B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,YAAY,CAAC;IAI3B;;;;;;;;;;;;;;;OAeG;IACH,IAAI,CACF,QAAQ,EAAE,MAAM,EAChB,KAAK,GAAE,sBAAsB,GAAG,IAAI,GAAG,SAAc,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,8BAA8B,EAAE,YAAY,CAAC;IAO5D
|
|
1
|
+
{"version":3,"file":"system-configs.d.mts","sourceRoot":"","sources":["../src/resources/system-configs.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,WAAW,EAAE,iBAAiB,EAAE,KAAK,uBAAuB,EAAE;OAChE,EAAE,cAAc,EAAE;AAGzB,qBAAa,aAAc,SAAQ,WAAW;IAC5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,MAAM,CACJ,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,wBAAwB,EAC9B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,YAAY,CAAC;IAI3B;;;;;;;;;;;;;;;OAeG;IACH,IAAI,CACF,QAAQ,EAAE,MAAM,EAChB,KAAK,GAAE,sBAAsB,GAAG,IAAI,GAAG,SAAc,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,8BAA8B,EAAE,YAAY,CAAC;IAO5D;;;;;;;;;OASG;IACH,GAAG,CAAC,cAAc,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,YAAY,CAAC;CAGhF;AAED,MAAM,MAAM,8BAA8B,GAAG,iBAAiB,CAAC,YAAY,CAAC,CAAC;AAE7E;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEhC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC;CACxD;AAED,yBAAiB,YAAY,CAAC;IAC5B,UAAiB,eAAe;QAC9B;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;CACF;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEhC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,gBAAgB,CAAC,EAAE,KAAK,CAAC,wBAAwB,CAAC,eAAe,CAAC,CAAC;CACpE;AAED,yBAAiB,wBAAwB,CAAC;IACxC,UAAiB,eAAe;QAC9B;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;CACF;AAED,MAAM,WAAW,sBAAuB,SAAQ,uBAAuB;CAAG;AAE1E,MAAM,CAAC,OAAO,WAAW,aAAa,CAAC;IACrC,OAAO,EACL,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH"}
|