scorecard-ai 1.0.0-alpha.9 → 1.1.0
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 +48 -19
- package/client.d.mts +4 -4
- package/client.d.mts.map +1 -1
- package/client.d.ts +4 -4
- package/client.d.ts.map +1 -1
- package/client.js +7 -5
- package/client.js.map +1 -1
- package/client.mjs +7 -5
- package/client.mjs.map +1 -1
- package/internal/tslib.js +6 -6
- package/lib/runAndEvaluate.d.mts +20 -8
- package/lib/runAndEvaluate.d.mts.map +1 -1
- package/lib/runAndEvaluate.d.ts +20 -8
- package/lib/runAndEvaluate.d.ts.map +1 -1
- package/lib/runAndEvaluate.js +31 -21
- package/lib/runAndEvaluate.js.map +1 -1
- package/lib/runAndEvaluate.mjs +31 -21
- package/lib/runAndEvaluate.mjs.map +1 -1
- package/package.json +1 -1
- 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 +4 -4
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +2 -2
- package/resources/index.mjs.map +1 -1
- package/resources/metrics.d.mts +611 -0
- package/resources/metrics.d.mts.map +1 -0
- package/resources/metrics.d.ts +611 -0
- package/resources/metrics.d.ts.map +1 -0
- package/resources/metrics.js +52 -0
- package/resources/metrics.js.map +1 -0
- package/resources/metrics.mjs +48 -0
- package/resources/metrics.mjs.map +1 -0
- package/resources/runs.d.mts +5 -5
- package/resources/runs.d.mts.map +1 -1
- package/resources/runs.d.ts +5 -5
- package/resources/runs.d.ts.map +1 -1
- package/resources/runs.js +1 -1
- package/resources/runs.mjs +1 -1
- package/resources/systems/index.d.mts +3 -0
- package/resources/systems/index.d.mts.map +1 -0
- package/resources/systems/index.d.ts +3 -0
- package/resources/systems/index.d.ts.map +1 -0
- package/resources/systems/index.js +9 -0
- package/resources/systems/index.js.map +1 -0
- package/resources/systems/index.mjs +4 -0
- package/resources/systems/index.mjs.map +1 -0
- package/resources/systems/systems.d.mts +229 -0
- package/resources/systems/systems.d.mts.map +1 -0
- package/resources/systems/systems.d.ts +229 -0
- package/resources/systems/systems.d.ts.map +1 -0
- package/resources/systems/systems.js +151 -0
- package/resources/systems/systems.js.map +1 -0
- package/resources/systems/systems.mjs +146 -0
- package/resources/systems/systems.mjs.map +1 -0
- package/resources/systems/versions.d.mts +132 -0
- package/resources/systems/versions.d.mts.map +1 -0
- package/resources/systems/versions.d.ts +132 -0
- package/resources/systems/versions.d.ts.map +1 -0
- package/resources/{system-configs.js → systems/versions.js} +26 -25
- package/resources/systems/versions.js.map +1 -0
- package/resources/{system-configs.mjs → systems/versions.mjs} +24 -23
- package/resources/systems/versions.mjs.map +1 -0
- package/resources/systems.d.mts +1 -224
- package/resources/systems.d.mts.map +1 -1
- package/resources/systems.d.ts +1 -224
- package/resources/systems.d.ts.map +1 -1
- package/resources/systems.js +2 -139
- package/resources/systems.js.map +1 -1
- package/resources/systems.mjs +1 -137
- package/resources/systems.mjs.map +1 -1
- package/resources/testsets.d.mts +1 -1
- package/resources/testsets.d.ts +1 -1
- package/resources/testsets.js +1 -1
- package/resources/testsets.mjs +1 -1
- package/src/client.ts +22 -27
- package/src/lib/runAndEvaluate.ts +52 -27
- package/src/resources/index.ts +2 -8
- package/src/resources/metrics.ts +768 -0
- package/src/resources/runs.ts +5 -5
- package/src/resources/systems/index.ts +18 -0
- package/src/resources/systems/systems.ts +299 -0
- package/src/resources/systems/versions.ts +166 -0
- package/src/resources/systems.ts +1 -277
- package/src/resources/testsets.ts +1 -1
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.mts.map +1 -1
- package/version.d.ts +1 -1
- package/version.d.ts.map +1 -1
- package/version.js +1 -1
- package/version.js.map +1 -1
- package/version.mjs +1 -1
- package/version.mjs.map +1 -1
- package/resources/system-configs.d.mts +0 -148
- package/resources/system-configs.d.mts.map +0 -1
- package/resources/system-configs.d.ts +0 -148
- package/resources/system-configs.d.ts.map +0 -1
- package/resources/system-configs.js.map +0 -1
- package/resources/system-configs.mjs.map +0 -1
- package/src/resources/system-configs.ts +0 -189
|
@@ -0,0 +1,48 @@
|
|
|
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 Metrics extends APIResource {
|
|
5
|
+
/**
|
|
6
|
+
* Create a new Metric for evaluating system outputs. The structure of a metric
|
|
7
|
+
* depends on the evalType and outputType of the metric.
|
|
8
|
+
*
|
|
9
|
+
* @example
|
|
10
|
+
* ```ts
|
|
11
|
+
* const metric = await client.metrics.create('314', {
|
|
12
|
+
* evalType: 'ai',
|
|
13
|
+
* name: 'Response Accuracy',
|
|
14
|
+
* outputType: 'boolean',
|
|
15
|
+
* promptTemplate:
|
|
16
|
+
* 'Please evaluate if the following response is factually accurate: {{outputs.response}}',
|
|
17
|
+
* description:
|
|
18
|
+
* 'Evaluates if the response is factually accurate',
|
|
19
|
+
* evalModelName: 'gpt-4o',
|
|
20
|
+
* guidelines:
|
|
21
|
+
* 'Check if the response contains factually correct information',
|
|
22
|
+
* temperature: 0.1,
|
|
23
|
+
* });
|
|
24
|
+
* ```
|
|
25
|
+
*/
|
|
26
|
+
create(projectID, body, options) {
|
|
27
|
+
return this._client.post(path `/projects/${projectID}/metrics`, { body, ...options });
|
|
28
|
+
}
|
|
29
|
+
/**
|
|
30
|
+
* Update an existing Metric. You must specify the evalType and outputType of the
|
|
31
|
+
* metric. The structure of a metric depends on the evalType and outputType of the
|
|
32
|
+
* metric.
|
|
33
|
+
*
|
|
34
|
+
* @example
|
|
35
|
+
* ```ts
|
|
36
|
+
* const metric = await client.metrics.update('321', {
|
|
37
|
+
* evalType: 'ai',
|
|
38
|
+
* outputType: 'boolean',
|
|
39
|
+
* promptTemplate:
|
|
40
|
+
* 'Using the following guidelines, evaluate the response: {{ guidelines }}\n\nResponse: {{ outputs.response }}\n\nIdeal answer: {{ expected.idealResponse }}',
|
|
41
|
+
* });
|
|
42
|
+
* ```
|
|
43
|
+
*/
|
|
44
|
+
update(metricID, body, options) {
|
|
45
|
+
return this._client.patch(path `/metrics/${metricID}`, { body, ...options });
|
|
46
|
+
}
|
|
47
|
+
}
|
|
48
|
+
//# sourceMappingURL=metrics.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"metrics.mjs","sourceRoot":"","sources":["../src/resources/metrics.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,MAAM,CAAC,SAAiB,EAAE,IAAwB,EAAE,OAAwB;QAC1E,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,aAAa,SAAS,UAAU,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvF,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,QAAgB,EAAE,IAAwB,EAAE,OAAwB;QACzE,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,YAAY,QAAQ,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9E,CAAC;CACF"}
|
package/resources/runs.d.mts
CHANGED
|
@@ -9,7 +9,7 @@ export declare class Runs extends APIResource {
|
|
|
9
9
|
* ```ts
|
|
10
10
|
* const run = await client.runs.create('314', {
|
|
11
11
|
* metricIds: ['789', '101'],
|
|
12
|
-
*
|
|
12
|
+
* systemVersionId: '87654321-4d3b-4ae4-8c7a-4b6e2a19ccf0',
|
|
13
13
|
* testsetId: '246',
|
|
14
14
|
* });
|
|
15
15
|
* ```
|
|
@@ -37,9 +37,9 @@ export interface Run {
|
|
|
37
37
|
*/
|
|
38
38
|
testsetId: string | null;
|
|
39
39
|
/**
|
|
40
|
-
* The ID of the system
|
|
40
|
+
* The ID of the system version this Run is using.
|
|
41
41
|
*/
|
|
42
|
-
|
|
42
|
+
systemVersionId?: string;
|
|
43
43
|
}
|
|
44
44
|
export interface RunCreateParams {
|
|
45
45
|
/**
|
|
@@ -47,9 +47,9 @@ export interface RunCreateParams {
|
|
|
47
47
|
*/
|
|
48
48
|
metricIds: Array<string>;
|
|
49
49
|
/**
|
|
50
|
-
* The ID of the system
|
|
50
|
+
* The ID of the system version this Run is using.
|
|
51
51
|
*/
|
|
52
|
-
|
|
52
|
+
systemVersionId?: string;
|
|
53
53
|
/**
|
|
54
54
|
* The ID of the Testset this Run is testing.
|
|
55
55
|
*/
|
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;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,
|
|
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,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEzB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;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,7 +9,7 @@ export declare class Runs extends APIResource {
|
|
|
9
9
|
* ```ts
|
|
10
10
|
* const run = await client.runs.create('314', {
|
|
11
11
|
* metricIds: ['789', '101'],
|
|
12
|
-
*
|
|
12
|
+
* systemVersionId: '87654321-4d3b-4ae4-8c7a-4b6e2a19ccf0',
|
|
13
13
|
* testsetId: '246',
|
|
14
14
|
* });
|
|
15
15
|
* ```
|
|
@@ -37,9 +37,9 @@ export interface Run {
|
|
|
37
37
|
*/
|
|
38
38
|
testsetId: string | null;
|
|
39
39
|
/**
|
|
40
|
-
* The ID of the system
|
|
40
|
+
* The ID of the system version this Run is using.
|
|
41
41
|
*/
|
|
42
|
-
|
|
42
|
+
systemVersionId?: string;
|
|
43
43
|
}
|
|
44
44
|
export interface RunCreateParams {
|
|
45
45
|
/**
|
|
@@ -47,9 +47,9 @@ export interface RunCreateParams {
|
|
|
47
47
|
*/
|
|
48
48
|
metricIds: Array<string>;
|
|
49
49
|
/**
|
|
50
|
-
* The ID of the system
|
|
50
|
+
* The ID of the system version this Run is using.
|
|
51
51
|
*/
|
|
52
|
-
|
|
52
|
+
systemVersionId?: string;
|
|
53
53
|
/**
|
|
54
54
|
* The ID of the Testset this Run is testing.
|
|
55
55
|
*/
|
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;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,
|
|
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,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEzB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;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,7 +12,7 @@ class Runs extends resource_1.APIResource {
|
|
|
12
12
|
* ```ts
|
|
13
13
|
* const run = await client.runs.create('314', {
|
|
14
14
|
* metricIds: ['789', '101'],
|
|
15
|
-
*
|
|
15
|
+
* systemVersionId: '87654321-4d3b-4ae4-8c7a-4b6e2a19ccf0',
|
|
16
16
|
* testsetId: '246',
|
|
17
17
|
* });
|
|
18
18
|
* ```
|
package/resources/runs.mjs
CHANGED
|
@@ -9,7 +9,7 @@ export class Runs extends APIResource {
|
|
|
9
9
|
* ```ts
|
|
10
10
|
* const run = await client.runs.create('314', {
|
|
11
11
|
* metricIds: ['789', '101'],
|
|
12
|
-
*
|
|
12
|
+
* systemVersionId: '87654321-4d3b-4ae4-8c7a-4b6e2a19ccf0',
|
|
13
13
|
* testsetId: '246',
|
|
14
14
|
* });
|
|
15
15
|
* ```
|
|
@@ -0,0 +1,3 @@
|
|
|
1
|
+
export { Systems, type System, type SystemDeleteResponse, type SystemCreateParams, type SystemUpdateParams, type SystemListParams, type SystemsPaginatedResponse, } from "./systems.mjs";
|
|
2
|
+
export { Versions, type SystemVersion, type VersionCreateParams, type VersionListParams, type SystemVersionsPaginatedResponse, } from "./versions.mjs";
|
|
3
|
+
//# sourceMappingURL=index.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../src/resources/systems/index.ts"],"names":[],"mappings":"OAEO,EACL,OAAO,EACP,KAAK,MAAM,EACX,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,EACvB,KAAK,kBAAkB,EACvB,KAAK,gBAAgB,EACrB,KAAK,wBAAwB,GAC9B;OACM,EACL,QAAQ,EACR,KAAK,aAAa,EAClB,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,EACtB,KAAK,+BAA+B,GACrC"}
|
|
@@ -0,0 +1,3 @@
|
|
|
1
|
+
export { Systems, type System, type SystemDeleteResponse, type SystemCreateParams, type SystemUpdateParams, type SystemListParams, type SystemsPaginatedResponse, } from "./systems.js";
|
|
2
|
+
export { Versions, type SystemVersion, type VersionCreateParams, type VersionListParams, type SystemVersionsPaginatedResponse, } from "./versions.js";
|
|
3
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/resources/systems/index.ts"],"names":[],"mappings":"OAEO,EACL,OAAO,EACP,KAAK,MAAM,EACX,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,EACvB,KAAK,kBAAkB,EACvB,KAAK,gBAAgB,EACrB,KAAK,wBAAwB,GAC9B;OACM,EACL,QAAQ,EACR,KAAK,aAAa,EAClB,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,EACtB,KAAK,+BAA+B,GACrC"}
|
|
@@ -0,0 +1,9 @@
|
|
|
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.Versions = exports.Systems = void 0;
|
|
5
|
+
var systems_1 = require("./systems.js");
|
|
6
|
+
Object.defineProperty(exports, "Systems", { enumerable: true, get: function () { return systems_1.Systems; } });
|
|
7
|
+
var versions_1 = require("./versions.js");
|
|
8
|
+
Object.defineProperty(exports, "Versions", { enumerable: true, get: function () { return versions_1.Versions; } });
|
|
9
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/resources/systems/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wCAQmB;AAPjB,kGAAA,OAAO,OAAA;AAQT,0CAMoB;AALlB,oGAAA,QAAQ,OAAA"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/resources/systems/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EACL,OAAO,GAOR;OACM,EACL,QAAQ,GAKT"}
|
|
@@ -0,0 +1,229 @@
|
|
|
1
|
+
import { APIResource } from "../../core/resource.mjs";
|
|
2
|
+
import * as VersionsAPI from "./versions.mjs";
|
|
3
|
+
import { SystemVersion, SystemVersionsPaginatedResponse, VersionCreateParams, VersionListParams, Versions } from "./versions.mjs";
|
|
4
|
+
import { APIPromise } from "../../core/api-promise.mjs";
|
|
5
|
+
import { PagePromise, PaginatedResponse, type PaginatedResponseParams } from "../../core/pagination.mjs";
|
|
6
|
+
import { RequestOptions } from "../../internal/request-options.mjs";
|
|
7
|
+
export declare class Systems extends APIResource {
|
|
8
|
+
versions: VersionsAPI.Versions;
|
|
9
|
+
/**
|
|
10
|
+
* Create a new system definition that specifies the interface contracts for a
|
|
11
|
+
* component you want to evaluate.
|
|
12
|
+
*
|
|
13
|
+
* A system acts as a template that defines three key contracts through JSON
|
|
14
|
+
* Schemas:
|
|
15
|
+
*
|
|
16
|
+
* 1. Input Schema: What data your system accepts (e.g., user queries, context
|
|
17
|
+
* documents)
|
|
18
|
+
* 2. Output Schema: What data your system produces (e.g., responses, confidence
|
|
19
|
+
* scores)
|
|
20
|
+
* 3. Config Schema: What parameters can be adjusted (e.g., model selection,
|
|
21
|
+
* temperature)
|
|
22
|
+
*
|
|
23
|
+
* This separation lets you evaluate any system as a black box, focusing on its
|
|
24
|
+
* interface rather than implementation details.
|
|
25
|
+
*
|
|
26
|
+
* @example
|
|
27
|
+
* ```ts
|
|
28
|
+
* const system = await client.systems.create('314', {
|
|
29
|
+
* configSchema: {
|
|
30
|
+
* type: 'object',
|
|
31
|
+
* properties: {
|
|
32
|
+
* temperature: { type: 'number' },
|
|
33
|
+
* maxTokens: { type: 'integer' },
|
|
34
|
+
* model: { type: 'string', enum: ['gpt-4', 'gpt-4-turbo'] },
|
|
35
|
+
* },
|
|
36
|
+
* required: ['model'],
|
|
37
|
+
* },
|
|
38
|
+
* description: 'Production chatbot powered by GPT-4',
|
|
39
|
+
* inputSchema: {
|
|
40
|
+
* type: 'object',
|
|
41
|
+
* properties: {
|
|
42
|
+
* messages: {
|
|
43
|
+
* type: 'array',
|
|
44
|
+
* items: {
|
|
45
|
+
* type: 'object',
|
|
46
|
+
* properties: {
|
|
47
|
+
* role: { type: 'string', enum: ['system', 'user', 'assistant'] },
|
|
48
|
+
* content: { type: 'string' },
|
|
49
|
+
* },
|
|
50
|
+
* required: ['role', 'content'],
|
|
51
|
+
* },
|
|
52
|
+
* },
|
|
53
|
+
* },
|
|
54
|
+
* required: ['messages'],
|
|
55
|
+
* },
|
|
56
|
+
* name: 'GPT-4 Chatbot',
|
|
57
|
+
* outputSchema: {
|
|
58
|
+
* type: 'object',
|
|
59
|
+
* properties: { response: { type: 'string' } },
|
|
60
|
+
* required: ['response'],
|
|
61
|
+
* },
|
|
62
|
+
* });
|
|
63
|
+
* ```
|
|
64
|
+
*/
|
|
65
|
+
create(projectID: string, body: SystemCreateParams, options?: RequestOptions): APIPromise<System>;
|
|
66
|
+
/**
|
|
67
|
+
* Update an existing system definition. Only the fields provided in the request
|
|
68
|
+
* body will be updated. If a field is provided, the new content will replace the
|
|
69
|
+
* existing content. If a field is not provided, the existing content will remain
|
|
70
|
+
* unchanged.
|
|
71
|
+
*
|
|
72
|
+
* When updating schemas:
|
|
73
|
+
*
|
|
74
|
+
* - The system will accept your changes regardless of compatibility with existing
|
|
75
|
+
* configurations
|
|
76
|
+
* - Schema updates won't invalidate existing evaluations or configurations
|
|
77
|
+
* - For significant redesigns, creating a new system definition provides a cleaner
|
|
78
|
+
* separation
|
|
79
|
+
*
|
|
80
|
+
* @example
|
|
81
|
+
* ```ts
|
|
82
|
+
* const system = await client.systems.update(
|
|
83
|
+
* '12345678-0a8b-4f66-b6f3-2ddcfa097257',
|
|
84
|
+
* {
|
|
85
|
+
* description:
|
|
86
|
+
* 'Updated production chatbot powered by GPT-4 Turbo',
|
|
87
|
+
* name: 'GPT-4 Turbo Chatbot',
|
|
88
|
+
* },
|
|
89
|
+
* );
|
|
90
|
+
* ```
|
|
91
|
+
*/
|
|
92
|
+
update(systemID: string, body?: SystemUpdateParams | null | undefined, options?: RequestOptions): APIPromise<System>;
|
|
93
|
+
/**
|
|
94
|
+
* Retrieve a paginated list of all systems. Systems are ordered by creation date.
|
|
95
|
+
*
|
|
96
|
+
* @example
|
|
97
|
+
* ```ts
|
|
98
|
+
* // Automatically fetches more pages as needed.
|
|
99
|
+
* for await (const system of client.systems.list('314')) {
|
|
100
|
+
* // ...
|
|
101
|
+
* }
|
|
102
|
+
* ```
|
|
103
|
+
*/
|
|
104
|
+
list(projectID: string, query?: SystemListParams | null | undefined, options?: RequestOptions): PagePromise<SystemsPaginatedResponse, System>;
|
|
105
|
+
/**
|
|
106
|
+
* Delete a system definition by ID. This will not delete associated system
|
|
107
|
+
* versions.
|
|
108
|
+
*
|
|
109
|
+
* @example
|
|
110
|
+
* ```ts
|
|
111
|
+
* const system = await client.systems.delete(
|
|
112
|
+
* '12345678-0a8b-4f66-b6f3-2ddcfa097257',
|
|
113
|
+
* );
|
|
114
|
+
* ```
|
|
115
|
+
*/
|
|
116
|
+
delete(systemID: string, options?: RequestOptions): APIPromise<SystemDeleteResponse>;
|
|
117
|
+
/**
|
|
118
|
+
* Retrieve a specific system by ID.
|
|
119
|
+
*
|
|
120
|
+
* @example
|
|
121
|
+
* ```ts
|
|
122
|
+
* const system = await client.systems.get(
|
|
123
|
+
* '12345678-0a8b-4f66-b6f3-2ddcfa097257',
|
|
124
|
+
* );
|
|
125
|
+
* ```
|
|
126
|
+
*/
|
|
127
|
+
get(systemID: string, options?: RequestOptions): APIPromise<System>;
|
|
128
|
+
}
|
|
129
|
+
export type SystemsPaginatedResponse = PaginatedResponse<System>;
|
|
130
|
+
/**
|
|
131
|
+
* A System Under Test (SUT) defines the interface to a component or service you
|
|
132
|
+
* want to evaluate.
|
|
133
|
+
*
|
|
134
|
+
* It specifies three contracts through schemas:
|
|
135
|
+
*
|
|
136
|
+
* - inputSchema: The structure of data the system accepts.
|
|
137
|
+
* - outputSchema: The structure of data the system produces.
|
|
138
|
+
* - configSchema: The parameters that modify system behavior.
|
|
139
|
+
*
|
|
140
|
+
* This abstraction lets you evaluate any system as a black box, focusing on its
|
|
141
|
+
* interface rather than implementation details. It's particularly useful for
|
|
142
|
+
* systems with variable outputs or complex internal state.
|
|
143
|
+
*
|
|
144
|
+
* Systems are templates - to run evaluations, pair them with a SystemVersion that
|
|
145
|
+
* provides specific parameter values.
|
|
146
|
+
*/
|
|
147
|
+
export interface System {
|
|
148
|
+
/**
|
|
149
|
+
* The ID of the system.
|
|
150
|
+
*/
|
|
151
|
+
id: string;
|
|
152
|
+
/**
|
|
153
|
+
* The schema of the system's configuration.
|
|
154
|
+
*/
|
|
155
|
+
configSchema: Record<string, unknown>;
|
|
156
|
+
/**
|
|
157
|
+
* The description of the system.
|
|
158
|
+
*/
|
|
159
|
+
description: string;
|
|
160
|
+
/**
|
|
161
|
+
* The schema of the system's inputs.
|
|
162
|
+
*/
|
|
163
|
+
inputSchema: Record<string, unknown>;
|
|
164
|
+
/**
|
|
165
|
+
* The name of the system.
|
|
166
|
+
*/
|
|
167
|
+
name: string;
|
|
168
|
+
/**
|
|
169
|
+
* The schema of the system's outputs.
|
|
170
|
+
*/
|
|
171
|
+
outputSchema: Record<string, unknown>;
|
|
172
|
+
}
|
|
173
|
+
export interface SystemDeleteResponse {
|
|
174
|
+
/**
|
|
175
|
+
* Whether the deletion was successful.
|
|
176
|
+
*/
|
|
177
|
+
success: boolean;
|
|
178
|
+
}
|
|
179
|
+
export interface SystemCreateParams {
|
|
180
|
+
/**
|
|
181
|
+
* The schema of the system's configuration.
|
|
182
|
+
*/
|
|
183
|
+
configSchema: Record<string, unknown>;
|
|
184
|
+
/**
|
|
185
|
+
* The description of the system.
|
|
186
|
+
*/
|
|
187
|
+
description: string;
|
|
188
|
+
/**
|
|
189
|
+
* The schema of the system's inputs.
|
|
190
|
+
*/
|
|
191
|
+
inputSchema: Record<string, unknown>;
|
|
192
|
+
/**
|
|
193
|
+
* The name of the system.
|
|
194
|
+
*/
|
|
195
|
+
name: string;
|
|
196
|
+
/**
|
|
197
|
+
* The schema of the system's outputs.
|
|
198
|
+
*/
|
|
199
|
+
outputSchema: Record<string, unknown>;
|
|
200
|
+
}
|
|
201
|
+
export interface SystemUpdateParams {
|
|
202
|
+
/**
|
|
203
|
+
* The schema of the system's configuration.
|
|
204
|
+
*/
|
|
205
|
+
configSchema?: Record<string, unknown>;
|
|
206
|
+
/**
|
|
207
|
+
* The description of the system.
|
|
208
|
+
*/
|
|
209
|
+
description?: string;
|
|
210
|
+
/**
|
|
211
|
+
* The schema of the system's inputs.
|
|
212
|
+
*/
|
|
213
|
+
inputSchema?: Record<string, unknown>;
|
|
214
|
+
/**
|
|
215
|
+
* The name of the system.
|
|
216
|
+
*/
|
|
217
|
+
name?: string;
|
|
218
|
+
/**
|
|
219
|
+
* The schema of the system's outputs.
|
|
220
|
+
*/
|
|
221
|
+
outputSchema?: Record<string, unknown>;
|
|
222
|
+
}
|
|
223
|
+
export interface SystemListParams extends PaginatedResponseParams {
|
|
224
|
+
}
|
|
225
|
+
export declare namespace Systems {
|
|
226
|
+
export { type System as System, type SystemDeleteResponse as SystemDeleteResponse, type SystemsPaginatedResponse as SystemsPaginatedResponse, type SystemCreateParams as SystemCreateParams, type SystemUpdateParams as SystemUpdateParams, type SystemListParams as SystemListParams, };
|
|
227
|
+
export { Versions as Versions, type SystemVersion as SystemVersion, type SystemVersionsPaginatedResponse as SystemVersionsPaginatedResponse, type VersionCreateParams as VersionCreateParams, type VersionListParams as VersionListParams, };
|
|
228
|
+
}
|
|
229
|
+
//# sourceMappingURL=systems.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"systems.d.mts","sourceRoot":"","sources":["../../src/resources/systems/systems.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,WAAW;OAChB,EACL,aAAa,EACb,+BAA+B,EAC/B,mBAAmB,EACnB,iBAAiB,EACjB,QAAQ,EACT;OACM,EAAE,UAAU,EAAE;OACd,EAAE,WAAW,EAAE,iBAAiB,EAAE,KAAK,uBAAuB,EAAE;OAChE,EAAE,cAAc,EAAE;AAGzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAA0C;IAExE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuDG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;IAIjG;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,MAAM,CACJ,QAAQ,EAAE,MAAM,EAChB,IAAI,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,MAAM,CAAC;IAIrB;;;;;;;;;;OAUG;IACH,IAAI,CACF,SAAS,EAAE,MAAM,EACjB,KAAK,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,wBAAwB,EAAE,MAAM,CAAC;IAOhD;;;;;;;;;;OAUG;IACH,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,oBAAoB,CAAC;IAIpF;;;;;;;;;OASG;IACH,GAAG,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;CAGpE;AAED,MAAM,MAAM,wBAAwB,GAAG,iBAAiB,CAAC,MAAM,CAAC,CAAC;AAEjE;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEtC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAErC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACvC;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEtC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAErC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACvC;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEvC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEtC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACxC;AAED,MAAM,WAAW,gBAAiB,SAAQ,uBAAuB;CAAG;AAIpE,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,MAAM,IAAI,MAAM,EACrB,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;IAEF,OAAO,EACL,QAAQ,IAAI,QAAQ,EACpB,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}
|
|
@@ -0,0 +1,229 @@
|
|
|
1
|
+
import { APIResource } from "../../core/resource.js";
|
|
2
|
+
import * as VersionsAPI from "./versions.js";
|
|
3
|
+
import { SystemVersion, SystemVersionsPaginatedResponse, VersionCreateParams, VersionListParams, Versions } from "./versions.js";
|
|
4
|
+
import { APIPromise } from "../../core/api-promise.js";
|
|
5
|
+
import { PagePromise, PaginatedResponse, type PaginatedResponseParams } from "../../core/pagination.js";
|
|
6
|
+
import { RequestOptions } from "../../internal/request-options.js";
|
|
7
|
+
export declare class Systems extends APIResource {
|
|
8
|
+
versions: VersionsAPI.Versions;
|
|
9
|
+
/**
|
|
10
|
+
* Create a new system definition that specifies the interface contracts for a
|
|
11
|
+
* component you want to evaluate.
|
|
12
|
+
*
|
|
13
|
+
* A system acts as a template that defines three key contracts through JSON
|
|
14
|
+
* Schemas:
|
|
15
|
+
*
|
|
16
|
+
* 1. Input Schema: What data your system accepts (e.g., user queries, context
|
|
17
|
+
* documents)
|
|
18
|
+
* 2. Output Schema: What data your system produces (e.g., responses, confidence
|
|
19
|
+
* scores)
|
|
20
|
+
* 3. Config Schema: What parameters can be adjusted (e.g., model selection,
|
|
21
|
+
* temperature)
|
|
22
|
+
*
|
|
23
|
+
* This separation lets you evaluate any system as a black box, focusing on its
|
|
24
|
+
* interface rather than implementation details.
|
|
25
|
+
*
|
|
26
|
+
* @example
|
|
27
|
+
* ```ts
|
|
28
|
+
* const system = await client.systems.create('314', {
|
|
29
|
+
* configSchema: {
|
|
30
|
+
* type: 'object',
|
|
31
|
+
* properties: {
|
|
32
|
+
* temperature: { type: 'number' },
|
|
33
|
+
* maxTokens: { type: 'integer' },
|
|
34
|
+
* model: { type: 'string', enum: ['gpt-4', 'gpt-4-turbo'] },
|
|
35
|
+
* },
|
|
36
|
+
* required: ['model'],
|
|
37
|
+
* },
|
|
38
|
+
* description: 'Production chatbot powered by GPT-4',
|
|
39
|
+
* inputSchema: {
|
|
40
|
+
* type: 'object',
|
|
41
|
+
* properties: {
|
|
42
|
+
* messages: {
|
|
43
|
+
* type: 'array',
|
|
44
|
+
* items: {
|
|
45
|
+
* type: 'object',
|
|
46
|
+
* properties: {
|
|
47
|
+
* role: { type: 'string', enum: ['system', 'user', 'assistant'] },
|
|
48
|
+
* content: { type: 'string' },
|
|
49
|
+
* },
|
|
50
|
+
* required: ['role', 'content'],
|
|
51
|
+
* },
|
|
52
|
+
* },
|
|
53
|
+
* },
|
|
54
|
+
* required: ['messages'],
|
|
55
|
+
* },
|
|
56
|
+
* name: 'GPT-4 Chatbot',
|
|
57
|
+
* outputSchema: {
|
|
58
|
+
* type: 'object',
|
|
59
|
+
* properties: { response: { type: 'string' } },
|
|
60
|
+
* required: ['response'],
|
|
61
|
+
* },
|
|
62
|
+
* });
|
|
63
|
+
* ```
|
|
64
|
+
*/
|
|
65
|
+
create(projectID: string, body: SystemCreateParams, options?: RequestOptions): APIPromise<System>;
|
|
66
|
+
/**
|
|
67
|
+
* Update an existing system definition. Only the fields provided in the request
|
|
68
|
+
* body will be updated. If a field is provided, the new content will replace the
|
|
69
|
+
* existing content. If a field is not provided, the existing content will remain
|
|
70
|
+
* unchanged.
|
|
71
|
+
*
|
|
72
|
+
* When updating schemas:
|
|
73
|
+
*
|
|
74
|
+
* - The system will accept your changes regardless of compatibility with existing
|
|
75
|
+
* configurations
|
|
76
|
+
* - Schema updates won't invalidate existing evaluations or configurations
|
|
77
|
+
* - For significant redesigns, creating a new system definition provides a cleaner
|
|
78
|
+
* separation
|
|
79
|
+
*
|
|
80
|
+
* @example
|
|
81
|
+
* ```ts
|
|
82
|
+
* const system = await client.systems.update(
|
|
83
|
+
* '12345678-0a8b-4f66-b6f3-2ddcfa097257',
|
|
84
|
+
* {
|
|
85
|
+
* description:
|
|
86
|
+
* 'Updated production chatbot powered by GPT-4 Turbo',
|
|
87
|
+
* name: 'GPT-4 Turbo Chatbot',
|
|
88
|
+
* },
|
|
89
|
+
* );
|
|
90
|
+
* ```
|
|
91
|
+
*/
|
|
92
|
+
update(systemID: string, body?: SystemUpdateParams | null | undefined, options?: RequestOptions): APIPromise<System>;
|
|
93
|
+
/**
|
|
94
|
+
* Retrieve a paginated list of all systems. Systems are ordered by creation date.
|
|
95
|
+
*
|
|
96
|
+
* @example
|
|
97
|
+
* ```ts
|
|
98
|
+
* // Automatically fetches more pages as needed.
|
|
99
|
+
* for await (const system of client.systems.list('314')) {
|
|
100
|
+
* // ...
|
|
101
|
+
* }
|
|
102
|
+
* ```
|
|
103
|
+
*/
|
|
104
|
+
list(projectID: string, query?: SystemListParams | null | undefined, options?: RequestOptions): PagePromise<SystemsPaginatedResponse, System>;
|
|
105
|
+
/**
|
|
106
|
+
* Delete a system definition by ID. This will not delete associated system
|
|
107
|
+
* versions.
|
|
108
|
+
*
|
|
109
|
+
* @example
|
|
110
|
+
* ```ts
|
|
111
|
+
* const system = await client.systems.delete(
|
|
112
|
+
* '12345678-0a8b-4f66-b6f3-2ddcfa097257',
|
|
113
|
+
* );
|
|
114
|
+
* ```
|
|
115
|
+
*/
|
|
116
|
+
delete(systemID: string, options?: RequestOptions): APIPromise<SystemDeleteResponse>;
|
|
117
|
+
/**
|
|
118
|
+
* Retrieve a specific system by ID.
|
|
119
|
+
*
|
|
120
|
+
* @example
|
|
121
|
+
* ```ts
|
|
122
|
+
* const system = await client.systems.get(
|
|
123
|
+
* '12345678-0a8b-4f66-b6f3-2ddcfa097257',
|
|
124
|
+
* );
|
|
125
|
+
* ```
|
|
126
|
+
*/
|
|
127
|
+
get(systemID: string, options?: RequestOptions): APIPromise<System>;
|
|
128
|
+
}
|
|
129
|
+
export type SystemsPaginatedResponse = PaginatedResponse<System>;
|
|
130
|
+
/**
|
|
131
|
+
* A System Under Test (SUT) defines the interface to a component or service you
|
|
132
|
+
* want to evaluate.
|
|
133
|
+
*
|
|
134
|
+
* It specifies three contracts through schemas:
|
|
135
|
+
*
|
|
136
|
+
* - inputSchema: The structure of data the system accepts.
|
|
137
|
+
* - outputSchema: The structure of data the system produces.
|
|
138
|
+
* - configSchema: The parameters that modify system behavior.
|
|
139
|
+
*
|
|
140
|
+
* This abstraction lets you evaluate any system as a black box, focusing on its
|
|
141
|
+
* interface rather than implementation details. It's particularly useful for
|
|
142
|
+
* systems with variable outputs or complex internal state.
|
|
143
|
+
*
|
|
144
|
+
* Systems are templates - to run evaluations, pair them with a SystemVersion that
|
|
145
|
+
* provides specific parameter values.
|
|
146
|
+
*/
|
|
147
|
+
export interface System {
|
|
148
|
+
/**
|
|
149
|
+
* The ID of the system.
|
|
150
|
+
*/
|
|
151
|
+
id: string;
|
|
152
|
+
/**
|
|
153
|
+
* The schema of the system's configuration.
|
|
154
|
+
*/
|
|
155
|
+
configSchema: Record<string, unknown>;
|
|
156
|
+
/**
|
|
157
|
+
* The description of the system.
|
|
158
|
+
*/
|
|
159
|
+
description: string;
|
|
160
|
+
/**
|
|
161
|
+
* The schema of the system's inputs.
|
|
162
|
+
*/
|
|
163
|
+
inputSchema: Record<string, unknown>;
|
|
164
|
+
/**
|
|
165
|
+
* The name of the system.
|
|
166
|
+
*/
|
|
167
|
+
name: string;
|
|
168
|
+
/**
|
|
169
|
+
* The schema of the system's outputs.
|
|
170
|
+
*/
|
|
171
|
+
outputSchema: Record<string, unknown>;
|
|
172
|
+
}
|
|
173
|
+
export interface SystemDeleteResponse {
|
|
174
|
+
/**
|
|
175
|
+
* Whether the deletion was successful.
|
|
176
|
+
*/
|
|
177
|
+
success: boolean;
|
|
178
|
+
}
|
|
179
|
+
export interface SystemCreateParams {
|
|
180
|
+
/**
|
|
181
|
+
* The schema of the system's configuration.
|
|
182
|
+
*/
|
|
183
|
+
configSchema: Record<string, unknown>;
|
|
184
|
+
/**
|
|
185
|
+
* The description of the system.
|
|
186
|
+
*/
|
|
187
|
+
description: string;
|
|
188
|
+
/**
|
|
189
|
+
* The schema of the system's inputs.
|
|
190
|
+
*/
|
|
191
|
+
inputSchema: Record<string, unknown>;
|
|
192
|
+
/**
|
|
193
|
+
* The name of the system.
|
|
194
|
+
*/
|
|
195
|
+
name: string;
|
|
196
|
+
/**
|
|
197
|
+
* The schema of the system's outputs.
|
|
198
|
+
*/
|
|
199
|
+
outputSchema: Record<string, unknown>;
|
|
200
|
+
}
|
|
201
|
+
export interface SystemUpdateParams {
|
|
202
|
+
/**
|
|
203
|
+
* The schema of the system's configuration.
|
|
204
|
+
*/
|
|
205
|
+
configSchema?: Record<string, unknown>;
|
|
206
|
+
/**
|
|
207
|
+
* The description of the system.
|
|
208
|
+
*/
|
|
209
|
+
description?: string;
|
|
210
|
+
/**
|
|
211
|
+
* The schema of the system's inputs.
|
|
212
|
+
*/
|
|
213
|
+
inputSchema?: Record<string, unknown>;
|
|
214
|
+
/**
|
|
215
|
+
* The name of the system.
|
|
216
|
+
*/
|
|
217
|
+
name?: string;
|
|
218
|
+
/**
|
|
219
|
+
* The schema of the system's outputs.
|
|
220
|
+
*/
|
|
221
|
+
outputSchema?: Record<string, unknown>;
|
|
222
|
+
}
|
|
223
|
+
export interface SystemListParams extends PaginatedResponseParams {
|
|
224
|
+
}
|
|
225
|
+
export declare namespace Systems {
|
|
226
|
+
export { type System as System, type SystemDeleteResponse as SystemDeleteResponse, type SystemsPaginatedResponse as SystemsPaginatedResponse, type SystemCreateParams as SystemCreateParams, type SystemUpdateParams as SystemUpdateParams, type SystemListParams as SystemListParams, };
|
|
227
|
+
export { Versions as Versions, type SystemVersion as SystemVersion, type SystemVersionsPaginatedResponse as SystemVersionsPaginatedResponse, type VersionCreateParams as VersionCreateParams, type VersionListParams as VersionListParams, };
|
|
228
|
+
}
|
|
229
|
+
//# sourceMappingURL=systems.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"systems.d.ts","sourceRoot":"","sources":["../../src/resources/systems/systems.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,WAAW;OAChB,EACL,aAAa,EACb,+BAA+B,EAC/B,mBAAmB,EACnB,iBAAiB,EACjB,QAAQ,EACT;OACM,EAAE,UAAU,EAAE;OACd,EAAE,WAAW,EAAE,iBAAiB,EAAE,KAAK,uBAAuB,EAAE;OAChE,EAAE,cAAc,EAAE;AAGzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAA0C;IAExE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuDG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;IAIjG;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,MAAM,CACJ,QAAQ,EAAE,MAAM,EAChB,IAAI,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,MAAM,CAAC;IAIrB;;;;;;;;;;OAUG;IACH,IAAI,CACF,SAAS,EAAE,MAAM,EACjB,KAAK,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,wBAAwB,EAAE,MAAM,CAAC;IAOhD;;;;;;;;;;OAUG;IACH,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,oBAAoB,CAAC;IAIpF;;;;;;;;;OASG;IACH,GAAG,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;CAGpE;AAED,MAAM,MAAM,wBAAwB,GAAG,iBAAiB,CAAC,MAAM,CAAC,CAAC;AAEjE;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEtC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAErC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACvC;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEtC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAErC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACvC;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEvC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEtC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACxC;AAED,MAAM,WAAW,gBAAiB,SAAQ,uBAAuB;CAAG;AAIpE,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,MAAM,IAAI,MAAM,EACrB,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;IAEF,OAAO,EACL,QAAQ,IAAI,QAAQ,EACpB,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}
|