scorecard-ai 1.0.0-alpha.0 → 1.0.0-alpha.1
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 +37 -0
- package/README.md +2 -2
- package/client.d.mts +13 -1
- package/client.d.mts.map +1 -1
- package/client.d.ts +13 -1
- package/client.d.ts.map +1 -1
- package/client.js +15 -3
- package/client.js.map +1 -1
- package/client.mjs +15 -3
- package/client.mjs.map +1 -1
- package/internal/utils/base64.d.mts.map +1 -1
- package/internal/utils/base64.d.ts.map +1 -1
- package/internal/utils/base64.js +8 -4
- package/internal/utils/base64.js.map +1 -1
- package/internal/utils/base64.mjs +8 -4
- package/internal/utils/base64.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/execution-records.d.mts +62 -0
- package/resources/execution-records.d.mts.map +1 -0
- package/resources/execution-records.d.ts +62 -0
- package/resources/execution-records.d.ts.map +1 -0
- package/resources/execution-records.js +16 -0
- package/resources/execution-records.js.map +1 -0
- package/resources/execution-records.mjs +12 -0
- package/resources/execution-records.mjs.map +1 -0
- package/resources/index.d.mts +4 -0
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +4 -0
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +9 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +4 -0
- package/resources/index.mjs.map +1 -1
- package/resources/runs.d.mts +48 -0
- package/resources/runs.d.mts.map +1 -0
- package/resources/runs.d.ts +48 -0
- package/resources/runs.d.ts.map +1 -0
- package/resources/runs.js +16 -0
- package/resources/runs.js.map +1 -0
- package/resources/runs.mjs +12 -0
- package/resources/runs.mjs.map +1 -0
- package/resources/system-configs.d.mts +122 -0
- package/resources/system-configs.d.mts.map +1 -0
- package/resources/system-configs.d.ts +122 -0
- package/resources/system-configs.d.ts.map +1 -0
- package/resources/system-configs.js +50 -0
- package/resources/system-configs.js.map +1 -0
- package/resources/system-configs.mjs +46 -0
- package/resources/system-configs.mjs.map +1 -0
- package/resources/systems.d.mts +152 -0
- package/resources/systems.d.mts.map +1 -0
- package/resources/systems.d.ts +152 -0
- package/resources/systems.d.ts.map +1 -0
- package/resources/systems.js +70 -0
- package/resources/systems.js.map +1 -0
- package/resources/systems.mjs +66 -0
- package/resources/systems.mjs.map +1 -0
- package/resources/testcases.d.mts +11 -27
- package/resources/testcases.d.mts.map +1 -1
- package/resources/testcases.d.ts +11 -27
- package/resources/testcases.d.ts.map +1 -1
- package/resources/testcases.js +3 -3
- package/resources/testcases.js.map +1 -1
- package/resources/testcases.mjs +3 -3
- package/resources/testcases.mjs.map +1 -1
- package/resources/testsets.d.mts +12 -9
- package/resources/testsets.d.mts.map +1 -1
- package/resources/testsets.d.ts +12 -9
- package/resources/testsets.d.ts.map +1 -1
- package/src/client.ts +61 -3
- package/src/internal/utils/base64.ts +8 -6
- package/src/resources/execution-records.ts +85 -0
- package/src/resources/index.ts +23 -0
- package/src/resources/runs.ts +61 -0
- package/src/resources/system-configs.ts +170 -0
- package/src/resources/systems.ts +206 -0
- package/src/resources/testcases.ts +13 -36
- package/src/resources/testsets.ts +13 -10
- 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
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
import { APIResource } from "../core/resource.mjs";
|
|
2
|
+
import { APIPromise } from "../core/api-promise.mjs";
|
|
3
|
+
import { RequestOptions } from "../internal/request-options.mjs";
|
|
4
|
+
export declare class ExecutionRecords extends APIResource {
|
|
5
|
+
/**
|
|
6
|
+
* Create a new execution record.
|
|
7
|
+
*/
|
|
8
|
+
create(runID: string, body: ExecutionRecordCreateParams, options?: RequestOptions): APIPromise<ExecutionRecord>;
|
|
9
|
+
}
|
|
10
|
+
/**
|
|
11
|
+
* An execution record in the Scorecard system.
|
|
12
|
+
*/
|
|
13
|
+
export interface ExecutionRecord {
|
|
14
|
+
/**
|
|
15
|
+
* The ID of the execution record
|
|
16
|
+
*/
|
|
17
|
+
id: string;
|
|
18
|
+
/**
|
|
19
|
+
* The actual inputs sent to the system, which should match the system's input
|
|
20
|
+
* schema
|
|
21
|
+
*/
|
|
22
|
+
inputs: Record<string, unknown>;
|
|
23
|
+
/**
|
|
24
|
+
* The expected outputs for the testcase
|
|
25
|
+
*/
|
|
26
|
+
labels: Record<string, unknown>;
|
|
27
|
+
/**
|
|
28
|
+
* The actual outputs from the system
|
|
29
|
+
*/
|
|
30
|
+
outputs: Record<string, unknown>;
|
|
31
|
+
/**
|
|
32
|
+
* The ID of the run containing this execution record
|
|
33
|
+
*/
|
|
34
|
+
runId: string;
|
|
35
|
+
/**
|
|
36
|
+
* The ID of the testcase
|
|
37
|
+
*/
|
|
38
|
+
testcaseId?: string;
|
|
39
|
+
}
|
|
40
|
+
export interface ExecutionRecordCreateParams {
|
|
41
|
+
/**
|
|
42
|
+
* The actual inputs sent to the system, which should match the system's input
|
|
43
|
+
* schema
|
|
44
|
+
*/
|
|
45
|
+
inputs: Record<string, unknown>;
|
|
46
|
+
/**
|
|
47
|
+
* The expected outputs for the testcase
|
|
48
|
+
*/
|
|
49
|
+
labels: Record<string, unknown>;
|
|
50
|
+
/**
|
|
51
|
+
* The actual outputs from the system
|
|
52
|
+
*/
|
|
53
|
+
outputs: Record<string, unknown>;
|
|
54
|
+
/**
|
|
55
|
+
* The ID of the testcase
|
|
56
|
+
*/
|
|
57
|
+
testcaseId?: string;
|
|
58
|
+
}
|
|
59
|
+
export declare namespace ExecutionRecords {
|
|
60
|
+
export { type ExecutionRecord as ExecutionRecord, type ExecutionRecordCreateParams as ExecutionRecordCreateParams, };
|
|
61
|
+
}
|
|
62
|
+
//# sourceMappingURL=execution-records.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"execution-records.d.mts","sourceRoot":"","sources":["../src/resources/execution-records.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,gBAAiB,SAAQ,WAAW;IAC/C;;OAEG;IACH,MAAM,CACJ,KAAK,EAAE,MAAM,EACb,IAAI,EAAE,2BAA2B,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,eAAe,CAAC;CAG/B;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEhC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEhC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEjC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,2BAA2B;IAC1C;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEhC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEhC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEjC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,CAAC,OAAO,WAAW,gBAAgB,CAAC;IACxC,OAAO,EACL,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,2BAA2B,IAAI,2BAA2B,GAChE,CAAC;CACH"}
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
import { APIResource } from "../core/resource.js";
|
|
2
|
+
import { APIPromise } from "../core/api-promise.js";
|
|
3
|
+
import { RequestOptions } from "../internal/request-options.js";
|
|
4
|
+
export declare class ExecutionRecords extends APIResource {
|
|
5
|
+
/**
|
|
6
|
+
* Create a new execution record.
|
|
7
|
+
*/
|
|
8
|
+
create(runID: string, body: ExecutionRecordCreateParams, options?: RequestOptions): APIPromise<ExecutionRecord>;
|
|
9
|
+
}
|
|
10
|
+
/**
|
|
11
|
+
* An execution record in the Scorecard system.
|
|
12
|
+
*/
|
|
13
|
+
export interface ExecutionRecord {
|
|
14
|
+
/**
|
|
15
|
+
* The ID of the execution record
|
|
16
|
+
*/
|
|
17
|
+
id: string;
|
|
18
|
+
/**
|
|
19
|
+
* The actual inputs sent to the system, which should match the system's input
|
|
20
|
+
* schema
|
|
21
|
+
*/
|
|
22
|
+
inputs: Record<string, unknown>;
|
|
23
|
+
/**
|
|
24
|
+
* The expected outputs for the testcase
|
|
25
|
+
*/
|
|
26
|
+
labels: Record<string, unknown>;
|
|
27
|
+
/**
|
|
28
|
+
* The actual outputs from the system
|
|
29
|
+
*/
|
|
30
|
+
outputs: Record<string, unknown>;
|
|
31
|
+
/**
|
|
32
|
+
* The ID of the run containing this execution record
|
|
33
|
+
*/
|
|
34
|
+
runId: string;
|
|
35
|
+
/**
|
|
36
|
+
* The ID of the testcase
|
|
37
|
+
*/
|
|
38
|
+
testcaseId?: string;
|
|
39
|
+
}
|
|
40
|
+
export interface ExecutionRecordCreateParams {
|
|
41
|
+
/**
|
|
42
|
+
* The actual inputs sent to the system, which should match the system's input
|
|
43
|
+
* schema
|
|
44
|
+
*/
|
|
45
|
+
inputs: Record<string, unknown>;
|
|
46
|
+
/**
|
|
47
|
+
* The expected outputs for the testcase
|
|
48
|
+
*/
|
|
49
|
+
labels: Record<string, unknown>;
|
|
50
|
+
/**
|
|
51
|
+
* The actual outputs from the system
|
|
52
|
+
*/
|
|
53
|
+
outputs: Record<string, unknown>;
|
|
54
|
+
/**
|
|
55
|
+
* The ID of the testcase
|
|
56
|
+
*/
|
|
57
|
+
testcaseId?: string;
|
|
58
|
+
}
|
|
59
|
+
export declare namespace ExecutionRecords {
|
|
60
|
+
export { type ExecutionRecord as ExecutionRecord, type ExecutionRecordCreateParams as ExecutionRecordCreateParams, };
|
|
61
|
+
}
|
|
62
|
+
//# sourceMappingURL=execution-records.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"execution-records.d.ts","sourceRoot":"","sources":["../src/resources/execution-records.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,gBAAiB,SAAQ,WAAW;IAC/C;;OAEG;IACH,MAAM,CACJ,KAAK,EAAE,MAAM,EACb,IAAI,EAAE,2BAA2B,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,eAAe,CAAC;CAG/B;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEhC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEhC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEjC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,2BAA2B;IAC1C;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEhC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEhC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEjC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,CAAC,OAAO,WAAW,gBAAgB,CAAC;IACxC,OAAO,EACL,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,2BAA2B,IAAI,2BAA2B,GAChE,CAAC;CACH"}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.ExecutionRecords = void 0;
|
|
5
|
+
const resource_1 = require("../core/resource.js");
|
|
6
|
+
const path_1 = require("../internal/utils/path.js");
|
|
7
|
+
class ExecutionRecords extends resource_1.APIResource {
|
|
8
|
+
/**
|
|
9
|
+
* Create a new execution record.
|
|
10
|
+
*/
|
|
11
|
+
create(runID, body, options) {
|
|
12
|
+
return this._client.post((0, path_1.path) `/runs/${runID}/executionrecords`, { body, ...options });
|
|
13
|
+
}
|
|
14
|
+
}
|
|
15
|
+
exports.ExecutionRecords = ExecutionRecords;
|
|
16
|
+
//# sourceMappingURL=execution-records.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"execution-records.js","sourceRoot":"","sources":["../src/resources/execution-records.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,oDAA8C;AAE9C,MAAa,gBAAiB,SAAQ,sBAAW;IAC/C;;OAEG;IACH,MAAM,CACJ,KAAa,EACb,IAAiC,EACjC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,SAAS,KAAK,mBAAmB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxF,CAAC;CACF;AAXD,4CAWC"}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
+
import { APIResource } from "../core/resource.mjs";
|
|
3
|
+
import { path } from "../internal/utils/path.mjs";
|
|
4
|
+
export class ExecutionRecords extends APIResource {
|
|
5
|
+
/**
|
|
6
|
+
* Create a new execution record.
|
|
7
|
+
*/
|
|
8
|
+
create(runID, body, options) {
|
|
9
|
+
return this._client.post(path `/runs/${runID}/executionrecords`, { body, ...options });
|
|
10
|
+
}
|
|
11
|
+
}
|
|
12
|
+
//# sourceMappingURL=execution-records.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"execution-records.mjs","sourceRoot":"","sources":["../src/resources/execution-records.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,gBAAiB,SAAQ,WAAW;IAC/C;;OAEG;IACH,MAAM,CACJ,KAAa,EACb,IAAiC,EACjC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,SAAS,KAAK,mBAAmB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxF,CAAC;CACF"}
|
package/resources/index.d.mts
CHANGED
|
@@ -1,5 +1,9 @@
|
|
|
1
1
|
export * from "./shared.mjs";
|
|
2
|
+
export { ExecutionRecords, type ExecutionRecord, type ExecutionRecordCreateParams, } from "./execution-records.mjs";
|
|
2
3
|
export { Projects, type ProjectListResponse, type ProjectListParams, type ProjectListResponsesPaginatedResponse, } from "./projects.mjs";
|
|
4
|
+
export { Runs, type Run, type RunCreateParams } from "./runs.mjs";
|
|
5
|
+
export { SystemConfigs, type SystemConfig, type SystemConfigCreateParams, type SystemConfigListParams, type SystemConfigGetParams, type SystemConfigsPaginatedResponse, } from "./system-configs.mjs";
|
|
6
|
+
export { Systems, type System, type SystemDeleteResponse, type SystemCreateParams, type SystemUpdateParams, type SystemListParams, type SystemsPaginatedResponse, } from "./systems.mjs";
|
|
3
7
|
export { Testcases, type Testcase, type TestcaseCreateResponse, type TestcaseDeleteResponse, type TestcaseCreateParams, type TestcaseUpdateParams, type TestcaseListParams, type TestcaseDeleteParams, type TestcasesPaginatedResponse, } from "./testcases.mjs";
|
|
4
8
|
export { Testsets, type Testset, type TestsetDeleteResponse, type TestsetCreateParams, type TestsetUpdateParams, type TestsetListParams, type TestsetsPaginatedResponse, } from "./testsets.mjs";
|
|
5
9
|
//# sourceMappingURL=index.d.mts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":";OAGO,EACL,QAAQ,EACR,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,EACtB,KAAK,qCAAqC,GAC3C;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"}
|
|
1
|
+
{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":";OAGO,EACL,gBAAgB,EAChB,KAAK,eAAe,EACpB,KAAK,2BAA2B,GACjC;OACM,EACL,QAAQ,EACR,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,EACtB,KAAK,qCAAqC,GAC3C;OACM,EAAE,IAAI,EAAE,KAAK,GAAG,EAAE,KAAK,eAAe,EAAE;OACxC,EACL,aAAa,EACb,KAAK,YAAY,EACjB,KAAK,wBAAwB,EAC7B,KAAK,sBAAsB,EAC3B,KAAK,qBAAqB,EAC1B,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,5 +1,9 @@
|
|
|
1
1
|
export * from "./shared.js";
|
|
2
|
+
export { ExecutionRecords, type ExecutionRecord, type ExecutionRecordCreateParams, } from "./execution-records.js";
|
|
2
3
|
export { Projects, type ProjectListResponse, type ProjectListParams, type ProjectListResponsesPaginatedResponse, } from "./projects.js";
|
|
4
|
+
export { Runs, type Run, type RunCreateParams } from "./runs.js";
|
|
5
|
+
export { SystemConfigs, type SystemConfig, type SystemConfigCreateParams, type SystemConfigListParams, type SystemConfigGetParams, type SystemConfigsPaginatedResponse, } from "./system-configs.js";
|
|
6
|
+
export { Systems, type System, type SystemDeleteResponse, type SystemCreateParams, type SystemUpdateParams, type SystemListParams, type SystemsPaginatedResponse, } from "./systems.js";
|
|
3
7
|
export { Testcases, type Testcase, type TestcaseCreateResponse, type TestcaseDeleteResponse, type TestcaseCreateParams, type TestcaseUpdateParams, type TestcaseListParams, type TestcaseDeleteParams, type TestcasesPaginatedResponse, } from "./testcases.js";
|
|
4
8
|
export { Testsets, type Testset, type TestsetDeleteResponse, type TestsetCreateParams, type TestsetUpdateParams, type TestsetListParams, type TestsetsPaginatedResponse, } from "./testsets.js";
|
|
5
9
|
//# sourceMappingURL=index.d.ts.map
|
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,mBAAmB,EACxB,KAAK,iBAAiB,EACtB,KAAK,qCAAqC,GAC3C;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"}
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":";OAGO,EACL,gBAAgB,EAChB,KAAK,eAAe,EACpB,KAAK,2BAA2B,GACjC;OACM,EACL,QAAQ,EACR,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,EACtB,KAAK,qCAAqC,GAC3C;OACM,EAAE,IAAI,EAAE,KAAK,GAAG,EAAE,KAAK,eAAe,EAAE;OACxC,EACL,aAAa,EACb,KAAK,YAAY,EACjB,KAAK,wBAAwB,EAC7B,KAAK,sBAAsB,EAC3B,KAAK,qBAAqB,EAC1B,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
CHANGED
|
@@ -15,10 +15,18 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
|
15
15
|
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
16
16
|
};
|
|
17
17
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
18
|
-
exports.Testsets = exports.Testcases = exports.Projects = void 0;
|
|
18
|
+
exports.Testsets = exports.Testcases = exports.Systems = exports.SystemConfigs = exports.Runs = exports.Projects = exports.ExecutionRecords = void 0;
|
|
19
19
|
__exportStar(require("./shared.js"), exports);
|
|
20
|
+
var execution_records_1 = require("./execution-records.js");
|
|
21
|
+
Object.defineProperty(exports, "ExecutionRecords", { enumerable: true, get: function () { return execution_records_1.ExecutionRecords; } });
|
|
20
22
|
var projects_1 = require("./projects.js");
|
|
21
23
|
Object.defineProperty(exports, "Projects", { enumerable: true, get: function () { return projects_1.Projects; } });
|
|
24
|
+
var runs_1 = require("./runs.js");
|
|
25
|
+
Object.defineProperty(exports, "Runs", { enumerable: true, get: function () { return runs_1.Runs; } });
|
|
26
|
+
var system_configs_1 = require("./system-configs.js");
|
|
27
|
+
Object.defineProperty(exports, "SystemConfigs", { enumerable: true, get: function () { return system_configs_1.SystemConfigs; } });
|
|
28
|
+
var systems_1 = require("./systems.js");
|
|
29
|
+
Object.defineProperty(exports, "Systems", { enumerable: true, get: function () { return systems_1.Systems; } });
|
|
22
30
|
var testcases_1 = require("./testcases.js");
|
|
23
31
|
Object.defineProperty(exports, "Testcases", { enumerable: true, get: function () { return testcases_1.Testcases; } });
|
|
24
32
|
var testsets_1 = require("./testsets.js");
|
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,8CAAyB;AACzB,0CAKoB;AAJlB,oGAAA,QAAQ,OAAA;AAKV,4CAUqB;AATnB,sGAAA,SAAS,OAAA;AAUX,0CAQoB;AAPlB,oGAAA,QAAQ,OAAA"}
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;;;;;;;;;;;;;;AAEtF,8CAAyB;AACzB,4DAI6B;AAH3B,qHAAA,gBAAgB,OAAA;AAIlB,0CAKoB;AAJlB,oGAAA,QAAQ,OAAA;AAKV,kCAA8D;AAArD,4FAAA,IAAI,OAAA;AACb,sDAO0B;AANxB,+GAAA,aAAa,OAAA;AAOf,wCAQmB;AAPjB,kGAAA,OAAO,OAAA;AAQT,4CAUqB;AATnB,sGAAA,SAAS,OAAA;AAUX,0CAQoB;AAPlB,oGAAA,QAAQ,OAAA"}
|
package/resources/index.mjs
CHANGED
|
@@ -1,6 +1,10 @@
|
|
|
1
1
|
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
2
|
export * from "./shared.mjs";
|
|
3
|
+
export { ExecutionRecords, } from "./execution-records.mjs";
|
|
3
4
|
export { Projects, } from "./projects.mjs";
|
|
5
|
+
export { Runs } from "./runs.mjs";
|
|
6
|
+
export { SystemConfigs, } from "./system-configs.mjs";
|
|
7
|
+
export { Systems, } from "./systems.mjs";
|
|
4
8
|
export { Testcases, } from "./testcases.mjs";
|
|
5
9
|
export { Testsets, } from "./testsets.mjs";
|
|
6
10
|
//# sourceMappingURL=index.mjs.map
|
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,GAIT;OACM,EACL,SAAS,GASV;OACM,EACL,QAAQ,GAOT"}
|
|
1
|
+
{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;;OAG/E,EACL,gBAAgB,GAGjB;OACM,EACL,QAAQ,GAIT;OACM,EAAE,IAAI,EAAkC;OACxC,EACL,aAAa,GAMd;OACM,EACL,OAAO,GAOR;OACM,EACL,SAAS,GASV;OACM,EACL,QAAQ,GAOT"}
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
import { APIResource } from "../core/resource.mjs";
|
|
2
|
+
import { APIPromise } from "../core/api-promise.mjs";
|
|
3
|
+
import { RequestOptions } from "../internal/request-options.mjs";
|
|
4
|
+
export declare class Runs extends APIResource {
|
|
5
|
+
/**
|
|
6
|
+
* Create a new run.
|
|
7
|
+
*/
|
|
8
|
+
create(projectID: string, body: RunCreateParams, options?: RequestOptions): APIPromise<Run>;
|
|
9
|
+
}
|
|
10
|
+
/**
|
|
11
|
+
* A Run in the Scorecard system.
|
|
12
|
+
*/
|
|
13
|
+
export interface Run {
|
|
14
|
+
/**
|
|
15
|
+
* The ID of the Run
|
|
16
|
+
*/
|
|
17
|
+
id: string;
|
|
18
|
+
/**
|
|
19
|
+
* The IDs of the metrics this Run is using
|
|
20
|
+
*/
|
|
21
|
+
metricIds: Array<string>;
|
|
22
|
+
/**
|
|
23
|
+
* The ID of the Testset this Run is testing
|
|
24
|
+
*/
|
|
25
|
+
testsetId: string;
|
|
26
|
+
/**
|
|
27
|
+
* The ID of the system configuration this Run is using
|
|
28
|
+
*/
|
|
29
|
+
systemConfigId?: string;
|
|
30
|
+
}
|
|
31
|
+
export interface RunCreateParams {
|
|
32
|
+
/**
|
|
33
|
+
* The IDs of the metrics this Run is using
|
|
34
|
+
*/
|
|
35
|
+
metricIds: Array<string>;
|
|
36
|
+
/**
|
|
37
|
+
* The ID of the Testset this Run is testing
|
|
38
|
+
*/
|
|
39
|
+
testsetId: string;
|
|
40
|
+
/**
|
|
41
|
+
* The ID of the system configuration this Run is using
|
|
42
|
+
*/
|
|
43
|
+
systemConfigId?: string;
|
|
44
|
+
}
|
|
45
|
+
export declare namespace Runs {
|
|
46
|
+
export { type Run as Run, type RunCreateParams as RunCreateParams };
|
|
47
|
+
}
|
|
48
|
+
//# sourceMappingURL=runs.d.mts.map
|
|
@@ -0,0 +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;;OAEG;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,SAAS,EAAE,MAAM,CAAC;IAElB;;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,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,OAAO,EAAE,KAAK,GAAG,IAAI,GAAG,EAAE,KAAK,eAAe,IAAI,eAAe,EAAE,CAAC;CACrE"}
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
import { APIResource } from "../core/resource.js";
|
|
2
|
+
import { APIPromise } from "../core/api-promise.js";
|
|
3
|
+
import { RequestOptions } from "../internal/request-options.js";
|
|
4
|
+
export declare class Runs extends APIResource {
|
|
5
|
+
/**
|
|
6
|
+
* Create a new run.
|
|
7
|
+
*/
|
|
8
|
+
create(projectID: string, body: RunCreateParams, options?: RequestOptions): APIPromise<Run>;
|
|
9
|
+
}
|
|
10
|
+
/**
|
|
11
|
+
* A Run in the Scorecard system.
|
|
12
|
+
*/
|
|
13
|
+
export interface Run {
|
|
14
|
+
/**
|
|
15
|
+
* The ID of the Run
|
|
16
|
+
*/
|
|
17
|
+
id: string;
|
|
18
|
+
/**
|
|
19
|
+
* The IDs of the metrics this Run is using
|
|
20
|
+
*/
|
|
21
|
+
metricIds: Array<string>;
|
|
22
|
+
/**
|
|
23
|
+
* The ID of the Testset this Run is testing
|
|
24
|
+
*/
|
|
25
|
+
testsetId: string;
|
|
26
|
+
/**
|
|
27
|
+
* The ID of the system configuration this Run is using
|
|
28
|
+
*/
|
|
29
|
+
systemConfigId?: string;
|
|
30
|
+
}
|
|
31
|
+
export interface RunCreateParams {
|
|
32
|
+
/**
|
|
33
|
+
* The IDs of the metrics this Run is using
|
|
34
|
+
*/
|
|
35
|
+
metricIds: Array<string>;
|
|
36
|
+
/**
|
|
37
|
+
* The ID of the Testset this Run is testing
|
|
38
|
+
*/
|
|
39
|
+
testsetId: string;
|
|
40
|
+
/**
|
|
41
|
+
* The ID of the system configuration this Run is using
|
|
42
|
+
*/
|
|
43
|
+
systemConfigId?: string;
|
|
44
|
+
}
|
|
45
|
+
export declare namespace Runs {
|
|
46
|
+
export { type Run as Run, type RunCreateParams as RunCreateParams };
|
|
47
|
+
}
|
|
48
|
+
//# sourceMappingURL=runs.d.ts.map
|
|
@@ -0,0 +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;;OAEG;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,SAAS,EAAE,MAAM,CAAC;IAElB;;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,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,OAAO,EAAE,KAAK,GAAG,IAAI,GAAG,EAAE,KAAK,eAAe,IAAI,eAAe,EAAE,CAAC;CACrE"}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.Runs = void 0;
|
|
5
|
+
const resource_1 = require("../core/resource.js");
|
|
6
|
+
const path_1 = require("../internal/utils/path.js");
|
|
7
|
+
class Runs extends resource_1.APIResource {
|
|
8
|
+
/**
|
|
9
|
+
* Create a new run.
|
|
10
|
+
*/
|
|
11
|
+
create(projectID, body, options) {
|
|
12
|
+
return this._client.post((0, path_1.path) `/projects/${projectID}/runs`, { body, ...options });
|
|
13
|
+
}
|
|
14
|
+
}
|
|
15
|
+
exports.Runs = Runs;
|
|
16
|
+
//# sourceMappingURL=runs.js.map
|
|
@@ -0,0 +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;;OAEG;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;AAPD,oBAOC"}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
+
import { APIResource } from "../core/resource.mjs";
|
|
3
|
+
import { path } from "../internal/utils/path.mjs";
|
|
4
|
+
export class Runs extends APIResource {
|
|
5
|
+
/**
|
|
6
|
+
* Create a new run.
|
|
7
|
+
*/
|
|
8
|
+
create(projectID, body, options) {
|
|
9
|
+
return this._client.post(path `/projects/${projectID}/runs`, { body, ...options });
|
|
10
|
+
}
|
|
11
|
+
}
|
|
12
|
+
//# sourceMappingURL=runs.mjs.map
|
|
@@ -0,0 +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;;OAEG;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"}
|
|
@@ -0,0 +1,122 @@
|
|
|
1
|
+
import { APIResource } from "../core/resource.mjs";
|
|
2
|
+
import { APIPromise } from "../core/api-promise.mjs";
|
|
3
|
+
import { PagePromise, PaginatedResponse, type PaginatedResponseParams } from "../core/pagination.mjs";
|
|
4
|
+
import { RequestOptions } from "../internal/request-options.mjs";
|
|
5
|
+
export declare class SystemConfigs extends APIResource {
|
|
6
|
+
/**
|
|
7
|
+
* Create a new configuration for a system.
|
|
8
|
+
*
|
|
9
|
+
* Each configuration contains specific parameter values that match the system's
|
|
10
|
+
* configSchema - things like model parameters, thresholds, or processing options.
|
|
11
|
+
* Once created, configurations cannot be modified, ensuring stable reference
|
|
12
|
+
* points for evaluations.
|
|
13
|
+
*
|
|
14
|
+
* When creating a configuration:
|
|
15
|
+
*
|
|
16
|
+
* - The 'config' object is validated against the parent system's configSchema
|
|
17
|
+
* - Configurations with validation errors are still stored, with errors included
|
|
18
|
+
* in the response
|
|
19
|
+
* - Validation errors indicate fields that don't match the schema but don't
|
|
20
|
+
* prevent creation
|
|
21
|
+
* - Having validation errors may affect how some evaluation metrics are calculated
|
|
22
|
+
*/
|
|
23
|
+
create(systemID: string, body: SystemConfigCreateParams, options?: RequestOptions): APIPromise<SystemConfig>;
|
|
24
|
+
/**
|
|
25
|
+
* Retrieve a paginated list of configurations for a specific system.
|
|
26
|
+
*
|
|
27
|
+
* System configurations provide concrete parameter values for a System Under Test,
|
|
28
|
+
* defining exactly how the system should be configured during an evaluation run.
|
|
29
|
+
*/
|
|
30
|
+
list(systemID: string, query?: SystemConfigListParams | null | undefined, options?: RequestOptions): PagePromise<SystemConfigsPaginatedResponse, SystemConfig>;
|
|
31
|
+
/**
|
|
32
|
+
* Retrieve a specific system configuration by ID.
|
|
33
|
+
*/
|
|
34
|
+
get(systemConfigID: string, params: SystemConfigGetParams, options?: RequestOptions): APIPromise<SystemConfig>;
|
|
35
|
+
}
|
|
36
|
+
export type SystemConfigsPaginatedResponse = PaginatedResponse<SystemConfig>;
|
|
37
|
+
/**
|
|
38
|
+
* A SystemConfig defines the specific settings for a System Under Test.
|
|
39
|
+
*
|
|
40
|
+
* Configurations contain parameter values that determine system behavior during
|
|
41
|
+
* evaluation. They are immutable snapshots - once created, they never change.
|
|
42
|
+
*
|
|
43
|
+
* When running evaluations, you reference a specific configId to establish which
|
|
44
|
+
* configuration to test.
|
|
45
|
+
*
|
|
46
|
+
* Configurations will be validated against the system's configSchema, with
|
|
47
|
+
* non-conforming values generating warnings.
|
|
48
|
+
*/
|
|
49
|
+
export interface SystemConfig {
|
|
50
|
+
/**
|
|
51
|
+
* The ID of the system configuration
|
|
52
|
+
*/
|
|
53
|
+
id: string;
|
|
54
|
+
/**
|
|
55
|
+
* The configuration of the system
|
|
56
|
+
*/
|
|
57
|
+
config: Record<string, unknown>;
|
|
58
|
+
/**
|
|
59
|
+
* The name of the system configuration
|
|
60
|
+
*/
|
|
61
|
+
name: string;
|
|
62
|
+
/**
|
|
63
|
+
* The ID of the system the configuration belongs to
|
|
64
|
+
*/
|
|
65
|
+
systemId: string;
|
|
66
|
+
/**
|
|
67
|
+
* Validation errors found in the configuration. If present, the configuration
|
|
68
|
+
* doesn't fully conform to its system's configSchema.
|
|
69
|
+
*/
|
|
70
|
+
validationErrors?: Array<SystemConfig.ValidationError>;
|
|
71
|
+
}
|
|
72
|
+
export declare namespace SystemConfig {
|
|
73
|
+
interface ValidationError {
|
|
74
|
+
/**
|
|
75
|
+
* Human-readable error description
|
|
76
|
+
*/
|
|
77
|
+
message: string;
|
|
78
|
+
/**
|
|
79
|
+
* JSON Pointer to the field with the validation error
|
|
80
|
+
*/
|
|
81
|
+
path: string;
|
|
82
|
+
}
|
|
83
|
+
}
|
|
84
|
+
export interface SystemConfigCreateParams {
|
|
85
|
+
/**
|
|
86
|
+
* The configuration of the system
|
|
87
|
+
*/
|
|
88
|
+
config: Record<string, unknown>;
|
|
89
|
+
/**
|
|
90
|
+
* The name of the system configuration
|
|
91
|
+
*/
|
|
92
|
+
name: string;
|
|
93
|
+
/**
|
|
94
|
+
* Validation errors found in the configuration. If present, the configuration
|
|
95
|
+
* doesn't fully conform to its system's configSchema.
|
|
96
|
+
*/
|
|
97
|
+
validationErrors?: Array<SystemConfigCreateParams.ValidationError>;
|
|
98
|
+
}
|
|
99
|
+
export declare namespace SystemConfigCreateParams {
|
|
100
|
+
interface ValidationError {
|
|
101
|
+
/**
|
|
102
|
+
* Human-readable error description
|
|
103
|
+
*/
|
|
104
|
+
message: string;
|
|
105
|
+
/**
|
|
106
|
+
* JSON Pointer to the field with the validation error
|
|
107
|
+
*/
|
|
108
|
+
path: string;
|
|
109
|
+
}
|
|
110
|
+
}
|
|
111
|
+
export interface SystemConfigListParams extends PaginatedResponseParams {
|
|
112
|
+
}
|
|
113
|
+
export interface SystemConfigGetParams {
|
|
114
|
+
/**
|
|
115
|
+
* The ID of the system the configuration belongs to
|
|
116
|
+
*/
|
|
117
|
+
systemId: string;
|
|
118
|
+
}
|
|
119
|
+
export declare namespace SystemConfigs {
|
|
120
|
+
export { type SystemConfig as SystemConfig, type SystemConfigsPaginatedResponse as SystemConfigsPaginatedResponse, type SystemConfigCreateParams as SystemConfigCreateParams, type SystemConfigListParams as SystemConfigListParams, type SystemConfigGetParams as SystemConfigGetParams, };
|
|
121
|
+
}
|
|
122
|
+
//# sourceMappingURL=system-configs.d.mts.map
|
|
@@ -0,0 +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;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CACJ,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,wBAAwB,EAC9B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,YAAY,CAAC;IAI3B;;;;;OAKG;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;;OAEG;IACH,GAAG,CACD,cAAc,EAAE,MAAM,EACtB,MAAM,EAAE,qBAAqB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,YAAY,CAAC;CAI5B;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,WAAW,qBAAqB;IACpC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,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,EACrD,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;CACH"}
|
|
@@ -0,0 +1,122 @@
|
|
|
1
|
+
import { APIResource } from "../core/resource.js";
|
|
2
|
+
import { APIPromise } from "../core/api-promise.js";
|
|
3
|
+
import { PagePromise, PaginatedResponse, type PaginatedResponseParams } from "../core/pagination.js";
|
|
4
|
+
import { RequestOptions } from "../internal/request-options.js";
|
|
5
|
+
export declare class SystemConfigs extends APIResource {
|
|
6
|
+
/**
|
|
7
|
+
* Create a new configuration for a system.
|
|
8
|
+
*
|
|
9
|
+
* Each configuration contains specific parameter values that match the system's
|
|
10
|
+
* configSchema - things like model parameters, thresholds, or processing options.
|
|
11
|
+
* Once created, configurations cannot be modified, ensuring stable reference
|
|
12
|
+
* points for evaluations.
|
|
13
|
+
*
|
|
14
|
+
* When creating a configuration:
|
|
15
|
+
*
|
|
16
|
+
* - The 'config' object is validated against the parent system's configSchema
|
|
17
|
+
* - Configurations with validation errors are still stored, with errors included
|
|
18
|
+
* in the response
|
|
19
|
+
* - Validation errors indicate fields that don't match the schema but don't
|
|
20
|
+
* prevent creation
|
|
21
|
+
* - Having validation errors may affect how some evaluation metrics are calculated
|
|
22
|
+
*/
|
|
23
|
+
create(systemID: string, body: SystemConfigCreateParams, options?: RequestOptions): APIPromise<SystemConfig>;
|
|
24
|
+
/**
|
|
25
|
+
* Retrieve a paginated list of configurations for a specific system.
|
|
26
|
+
*
|
|
27
|
+
* System configurations provide concrete parameter values for a System Under Test,
|
|
28
|
+
* defining exactly how the system should be configured during an evaluation run.
|
|
29
|
+
*/
|
|
30
|
+
list(systemID: string, query?: SystemConfigListParams | null | undefined, options?: RequestOptions): PagePromise<SystemConfigsPaginatedResponse, SystemConfig>;
|
|
31
|
+
/**
|
|
32
|
+
* Retrieve a specific system configuration by ID.
|
|
33
|
+
*/
|
|
34
|
+
get(systemConfigID: string, params: SystemConfigGetParams, options?: RequestOptions): APIPromise<SystemConfig>;
|
|
35
|
+
}
|
|
36
|
+
export type SystemConfigsPaginatedResponse = PaginatedResponse<SystemConfig>;
|
|
37
|
+
/**
|
|
38
|
+
* A SystemConfig defines the specific settings for a System Under Test.
|
|
39
|
+
*
|
|
40
|
+
* Configurations contain parameter values that determine system behavior during
|
|
41
|
+
* evaluation. They are immutable snapshots - once created, they never change.
|
|
42
|
+
*
|
|
43
|
+
* When running evaluations, you reference a specific configId to establish which
|
|
44
|
+
* configuration to test.
|
|
45
|
+
*
|
|
46
|
+
* Configurations will be validated against the system's configSchema, with
|
|
47
|
+
* non-conforming values generating warnings.
|
|
48
|
+
*/
|
|
49
|
+
export interface SystemConfig {
|
|
50
|
+
/**
|
|
51
|
+
* The ID of the system configuration
|
|
52
|
+
*/
|
|
53
|
+
id: string;
|
|
54
|
+
/**
|
|
55
|
+
* The configuration of the system
|
|
56
|
+
*/
|
|
57
|
+
config: Record<string, unknown>;
|
|
58
|
+
/**
|
|
59
|
+
* The name of the system configuration
|
|
60
|
+
*/
|
|
61
|
+
name: string;
|
|
62
|
+
/**
|
|
63
|
+
* The ID of the system the configuration belongs to
|
|
64
|
+
*/
|
|
65
|
+
systemId: string;
|
|
66
|
+
/**
|
|
67
|
+
* Validation errors found in the configuration. If present, the configuration
|
|
68
|
+
* doesn't fully conform to its system's configSchema.
|
|
69
|
+
*/
|
|
70
|
+
validationErrors?: Array<SystemConfig.ValidationError>;
|
|
71
|
+
}
|
|
72
|
+
export declare namespace SystemConfig {
|
|
73
|
+
interface ValidationError {
|
|
74
|
+
/**
|
|
75
|
+
* Human-readable error description
|
|
76
|
+
*/
|
|
77
|
+
message: string;
|
|
78
|
+
/**
|
|
79
|
+
* JSON Pointer to the field with the validation error
|
|
80
|
+
*/
|
|
81
|
+
path: string;
|
|
82
|
+
}
|
|
83
|
+
}
|
|
84
|
+
export interface SystemConfigCreateParams {
|
|
85
|
+
/**
|
|
86
|
+
* The configuration of the system
|
|
87
|
+
*/
|
|
88
|
+
config: Record<string, unknown>;
|
|
89
|
+
/**
|
|
90
|
+
* The name of the system configuration
|
|
91
|
+
*/
|
|
92
|
+
name: string;
|
|
93
|
+
/**
|
|
94
|
+
* Validation errors found in the configuration. If present, the configuration
|
|
95
|
+
* doesn't fully conform to its system's configSchema.
|
|
96
|
+
*/
|
|
97
|
+
validationErrors?: Array<SystemConfigCreateParams.ValidationError>;
|
|
98
|
+
}
|
|
99
|
+
export declare namespace SystemConfigCreateParams {
|
|
100
|
+
interface ValidationError {
|
|
101
|
+
/**
|
|
102
|
+
* Human-readable error description
|
|
103
|
+
*/
|
|
104
|
+
message: string;
|
|
105
|
+
/**
|
|
106
|
+
* JSON Pointer to the field with the validation error
|
|
107
|
+
*/
|
|
108
|
+
path: string;
|
|
109
|
+
}
|
|
110
|
+
}
|
|
111
|
+
export interface SystemConfigListParams extends PaginatedResponseParams {
|
|
112
|
+
}
|
|
113
|
+
export interface SystemConfigGetParams {
|
|
114
|
+
/**
|
|
115
|
+
* The ID of the system the configuration belongs to
|
|
116
|
+
*/
|
|
117
|
+
systemId: string;
|
|
118
|
+
}
|
|
119
|
+
export declare namespace SystemConfigs {
|
|
120
|
+
export { type SystemConfig as SystemConfig, type SystemConfigsPaginatedResponse as SystemConfigsPaginatedResponse, type SystemConfigCreateParams as SystemConfigCreateParams, type SystemConfigListParams as SystemConfigListParams, type SystemConfigGetParams as SystemConfigGetParams, };
|
|
121
|
+
}
|
|
122
|
+
//# sourceMappingURL=system-configs.d.ts.map
|