scorecard-ai 1.0.0-alpha.6 → 1.0.0-alpha.7
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 +33 -0
- package/README.md +15 -5
- package/client.d.mts +9 -2
- package/client.d.mts.map +1 -1
- package/client.d.ts +9 -2
- package/client.d.ts.map +1 -1
- package/client.js +20 -0
- package/client.js.map +1 -1
- package/client.mjs +20 -0
- package/client.mjs.map +1 -1
- package/internal/headers.js +1 -1
- package/internal/headers.js.map +1 -1
- package/internal/headers.mjs +1 -1
- package/internal/headers.mjs.map +1 -1
- package/internal/to-file.d.mts +0 -1
- package/internal/to-file.d.mts.map +1 -1
- package/internal/to-file.d.ts +0 -1
- package/internal/to-file.d.ts.map +1 -1
- package/internal/to-file.js +3 -2
- package/internal/to-file.js.map +1 -1
- package/internal/to-file.mjs +3 -2
- package/internal/to-file.mjs.map +1 -1
- package/internal/uploads.d.mts +1 -1
- package/internal/uploads.d.mts.map +1 -1
- package/internal/uploads.d.ts +1 -1
- package/internal/uploads.d.ts.map +1 -1
- package/internal/uploads.js +14 -4
- package/internal/uploads.js.map +1 -1
- package/internal/uploads.mjs +12 -3
- package/internal/uploads.mjs.map +1 -1
- package/internal/utils/uuid.d.mts +1 -1
- package/internal/utils/uuid.d.mts.map +1 -1
- package/internal/utils/uuid.d.ts +1 -1
- package/internal/utils/uuid.d.ts.map +1 -1
- package/internal/utils/uuid.js +1 -2
- package/internal/utils/uuid.js.map +1 -1
- package/internal/utils/uuid.mjs +1 -2
- package/internal/utils/uuid.mjs.map +1 -1
- package/package.json +1 -5
- package/resources/index.d.mts +2 -1
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +2 -1
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +3 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +1 -0
- package/resources/index.mjs.map +1 -1
- package/resources/projects.d.mts +39 -4
- package/resources/projects.d.mts.map +1 -1
- package/resources/projects.d.ts +39 -4
- package/resources/projects.d.ts.map +1 -1
- package/resources/projects.js +23 -4
- package/resources/projects.js.map +1 -1
- package/resources/projects.mjs +23 -4
- package/resources/projects.mjs.map +1 -1
- package/resources/records.d.mts +10 -0
- package/resources/records.d.mts.map +1 -1
- package/resources/records.d.ts +10 -0
- package/resources/records.d.ts.map +1 -1
- package/resources/records.js +10 -0
- package/resources/records.js.map +1 -1
- package/resources/records.mjs +10 -0
- package/resources/records.mjs.map +1 -1
- package/resources/runs.d.mts +16 -0
- package/resources/runs.d.mts.map +1 -1
- package/resources/runs.d.ts +16 -0
- package/resources/runs.d.ts.map +1 -1
- package/resources/runs.js +16 -0
- package/resources/runs.js.map +1 -1
- package/resources/runs.mjs +16 -0
- package/resources/runs.mjs.map +1 -1
- package/resources/scores.d.mts +83 -0
- package/resources/scores.d.mts.map +1 -0
- package/resources/scores.d.ts +83 -0
- package/resources/scores.d.ts.map +1 -0
- package/resources/scores.js +35 -0
- package/resources/scores.js.map +1 -0
- package/resources/scores.mjs +31 -0
- package/resources/scores.mjs.map +1 -0
- package/resources/system-configs.d.mts +33 -0
- package/resources/system-configs.d.mts.map +1 -1
- package/resources/system-configs.d.ts +33 -0
- package/resources/system-configs.d.ts.map +1 -1
- package/resources/system-configs.js +33 -0
- package/resources/system-configs.js.map +1 -1
- package/resources/system-configs.mjs +33 -0
- package/resources/system-configs.mjs.map +1 -1
- package/resources/systems.d.mts +73 -0
- package/resources/systems.d.mts.map +1 -1
- package/resources/systems.d.ts +73 -0
- package/resources/systems.d.ts.map +1 -1
- package/resources/systems.js +73 -0
- package/resources/systems.js.map +1 -1
- package/resources/systems.mjs +73 -0
- package/resources/systems.mjs.map +1 -1
- package/resources/testcases.d.mts +62 -0
- package/resources/testcases.d.mts.map +1 -1
- package/resources/testcases.d.ts +62 -0
- package/resources/testcases.d.ts.map +1 -1
- package/resources/testcases.js +62 -0
- package/resources/testcases.js.map +1 -1
- package/resources/testcases.mjs +62 -0
- package/resources/testcases.mjs.map +1 -1
- package/resources/testsets.d.mts +48 -0
- package/resources/testsets.d.mts.map +1 -1
- package/resources/testsets.d.ts +48 -0
- package/resources/testsets.d.ts.map +1 -1
- package/resources/testsets.js +48 -0
- package/resources/testsets.js.map +1 -1
- package/resources/testsets.mjs +48 -0
- package/resources/testsets.mjs.map +1 -1
- package/src/client.ts +29 -4
- package/src/internal/headers.ts +1 -1
- package/src/internal/to-file.ts +4 -2
- package/src/internal/uploads.ts +16 -4
- package/src/internal/utils/uuid.ts +1 -3
- package/src/resources/index.ts +4 -2
- package/src/resources/projects.ts +48 -9
- package/src/resources/records.ts +10 -0
- package/src/resources/runs.ts +16 -0
- package/src/resources/scores.ts +98 -0
- package/src/resources/system-configs.ts +33 -0
- package/src/resources/systems.ts +73 -0
- package/src/resources/testcases.ts +62 -0
- package/src/resources/testsets.ts +48 -0
- 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/internal/shims/crypto.d.mts +0 -13
- package/internal/shims/crypto.d.mts.map +0 -1
- package/internal/shims/crypto.d.ts +0 -13
- package/internal/shims/crypto.d.ts.map +0 -1
- package/internal/shims/crypto.js +0 -13
- package/internal/shims/crypto.js.map +0 -1
- package/internal/shims/crypto.mjs +0 -9
- package/internal/shims/crypto.mjs.map +0 -1
- package/internal/shims/file.d.mts +0 -22
- package/internal/shims/file.d.mts.map +0 -1
- package/internal/shims/file.d.ts +0 -22
- package/internal/shims/file.d.ts.map +0 -1
- package/internal/shims/file.js +0 -16
- package/internal/shims/file.js.map +0 -1
- package/internal/shims/file.mjs +0 -12
- package/internal/shims/file.mjs.map +0 -1
- package/internal/shims/getBuiltinModule.d.mts +0 -11
- package/internal/shims/getBuiltinModule.d.mts.map +0 -1
- package/internal/shims/getBuiltinModule.d.ts +0 -11
- package/internal/shims/getBuiltinModule.d.ts.map +0 -1
- package/internal/shims/getBuiltinModule.js +0 -71
- package/internal/shims/getBuiltinModule.js.map +0 -1
- package/internal/shims/getBuiltinModule.mjs +0 -67
- package/internal/shims/getBuiltinModule.mjs.map +0 -1
- package/internal/shims/nullGetBuiltinModule.d.mts +0 -2
- package/internal/shims/nullGetBuiltinModule.d.mts.map +0 -1
- package/internal/shims/nullGetBuiltinModule.d.ts +0 -2
- package/internal/shims/nullGetBuiltinModule.d.ts.map +0 -1
- package/internal/shims/nullGetBuiltinModule.js +0 -5
- package/internal/shims/nullGetBuiltinModule.js.map +0 -1
- package/internal/shims/nullGetBuiltinModule.mjs +0 -2
- package/internal/shims/nullGetBuiltinModule.mjs.map +0 -1
- package/src/internal/shims/crypto.ts +0 -18
- package/src/internal/shims/file.ts +0 -32
- package/src/internal/shims/getBuiltinModule.ts +0 -66
- package/src/internal/shims/nullGetBuiltinModule.ts +0 -1
|
@@ -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
|
|
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;;;;;;;;;;OAUG;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"}
|
|
@@ -19,6 +19,21 @@ export declare class SystemConfigs extends APIResource {
|
|
|
19
19
|
* - Validation errors indicate fields that don't match the schema but don't
|
|
20
20
|
* prevent creation
|
|
21
21
|
* - Having validation errors may affect how some evaluation metrics are calculated
|
|
22
|
+
*
|
|
23
|
+
* @example
|
|
24
|
+
* ```ts
|
|
25
|
+
* const systemConfig = await client.systemConfigs.create(
|
|
26
|
+
* '12345678-0a8b-4f66-b6f3-2ddcfa097257',
|
|
27
|
+
* {
|
|
28
|
+
* config: {
|
|
29
|
+
* temperature: 0.1,
|
|
30
|
+
* maxTokens: 1024,
|
|
31
|
+
* model: 'gpt-4-turbo',
|
|
32
|
+
* },
|
|
33
|
+
* name: 'Production (Low Temperature)',
|
|
34
|
+
* },
|
|
35
|
+
* );
|
|
36
|
+
* ```
|
|
22
37
|
*/
|
|
23
38
|
create(systemID: string, body: SystemConfigCreateParams, options?: RequestOptions): APIPromise<SystemConfig>;
|
|
24
39
|
/**
|
|
@@ -26,10 +41,28 @@ export declare class SystemConfigs extends APIResource {
|
|
|
26
41
|
*
|
|
27
42
|
* System configurations provide concrete parameter values for a System Under Test,
|
|
28
43
|
* defining exactly how the system should be configured during an evaluation run.
|
|
44
|
+
*
|
|
45
|
+
* @example
|
|
46
|
+
* ```ts
|
|
47
|
+
* // Automatically fetches more pages as needed.
|
|
48
|
+
* for await (const systemConfig of client.systemConfigs.list(
|
|
49
|
+
* '12345678-0a8b-4f66-b6f3-2ddcfa097257',
|
|
50
|
+
* )) {
|
|
51
|
+
* // ...
|
|
52
|
+
* }
|
|
53
|
+
* ```
|
|
29
54
|
*/
|
|
30
55
|
list(systemID: string, query?: SystemConfigListParams | null | undefined, options?: RequestOptions): PagePromise<SystemConfigsPaginatedResponse, SystemConfig>;
|
|
31
56
|
/**
|
|
32
57
|
* Retrieve a specific system configuration by ID.
|
|
58
|
+
*
|
|
59
|
+
* @example
|
|
60
|
+
* ```ts
|
|
61
|
+
* const systemConfig = await client.systemConfigs.get(
|
|
62
|
+
* '87654321-4d3b-4ae4-8c7a-4b6e2a19ccf0',
|
|
63
|
+
* { systemId: '12345678-0a8b-4f66-b6f3-2ddcfa097257' },
|
|
64
|
+
* );
|
|
65
|
+
* ```
|
|
33
66
|
*/
|
|
34
67
|
get(systemConfigID: string, params: SystemConfigGetParams, options?: RequestOptions): APIPromise<SystemConfig>;
|
|
35
68
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"system-configs.d.ts","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
|
|
1
|
+
{"version":3,"file":"system-configs.d.ts","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;;;;;;;;;;OAUG;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"}
|
|
@@ -22,6 +22,21 @@ class SystemConfigs extends resource_1.APIResource {
|
|
|
22
22
|
* - Validation errors indicate fields that don't match the schema but don't
|
|
23
23
|
* prevent creation
|
|
24
24
|
* - Having validation errors may affect how some evaluation metrics are calculated
|
|
25
|
+
*
|
|
26
|
+
* @example
|
|
27
|
+
* ```ts
|
|
28
|
+
* const systemConfig = await client.systemConfigs.create(
|
|
29
|
+
* '12345678-0a8b-4f66-b6f3-2ddcfa097257',
|
|
30
|
+
* {
|
|
31
|
+
* config: {
|
|
32
|
+
* temperature: 0.1,
|
|
33
|
+
* maxTokens: 1024,
|
|
34
|
+
* model: 'gpt-4-turbo',
|
|
35
|
+
* },
|
|
36
|
+
* name: 'Production (Low Temperature)',
|
|
37
|
+
* },
|
|
38
|
+
* );
|
|
39
|
+
* ```
|
|
25
40
|
*/
|
|
26
41
|
create(systemID, body, options) {
|
|
27
42
|
return this._client.post((0, path_1.path) `/systems/${systemID}/configs`, { body, ...options });
|
|
@@ -31,6 +46,16 @@ class SystemConfigs extends resource_1.APIResource {
|
|
|
31
46
|
*
|
|
32
47
|
* System configurations provide concrete parameter values for a System Under Test,
|
|
33
48
|
* defining exactly how the system should be configured during an evaluation run.
|
|
49
|
+
*
|
|
50
|
+
* @example
|
|
51
|
+
* ```ts
|
|
52
|
+
* // Automatically fetches more pages as needed.
|
|
53
|
+
* for await (const systemConfig of client.systemConfigs.list(
|
|
54
|
+
* '12345678-0a8b-4f66-b6f3-2ddcfa097257',
|
|
55
|
+
* )) {
|
|
56
|
+
* // ...
|
|
57
|
+
* }
|
|
58
|
+
* ```
|
|
34
59
|
*/
|
|
35
60
|
list(systemID, query = {}, options) {
|
|
36
61
|
return this._client.getAPIList((0, path_1.path) `/systems/${systemID}/configs`, (pagination_1.PaginatedResponse), {
|
|
@@ -40,6 +65,14 @@ class SystemConfigs extends resource_1.APIResource {
|
|
|
40
65
|
}
|
|
41
66
|
/**
|
|
42
67
|
* Retrieve a specific system configuration by ID.
|
|
68
|
+
*
|
|
69
|
+
* @example
|
|
70
|
+
* ```ts
|
|
71
|
+
* const systemConfig = await client.systemConfigs.get(
|
|
72
|
+
* '87654321-4d3b-4ae4-8c7a-4b6e2a19ccf0',
|
|
73
|
+
* { systemId: '12345678-0a8b-4f66-b6f3-2ddcfa097257' },
|
|
74
|
+
* );
|
|
75
|
+
* ```
|
|
43
76
|
*/
|
|
44
77
|
get(systemConfigID, params, options) {
|
|
45
78
|
const { systemId } = params;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"system-configs.js","sourceRoot":"","sources":["../src/resources/system-configs.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAE/C,sDAAkG;AAElG,oDAA8C;AAE9C,MAAa,aAAc,SAAQ,sBAAW;IAC5C
|
|
1
|
+
{"version":3,"file":"system-configs.js","sourceRoot":"","sources":["../src/resources/system-configs.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAE/C,sDAAkG;AAElG,oDAA8C;AAE9C,MAAa,aAAc,SAAQ,sBAAW;IAC5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,MAAM,CACJ,QAAgB,EAChB,IAA8B,EAC9B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,YAAY,QAAQ,UAAU,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrF,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,IAAI,CACF,QAAgB,EAChB,QAAmD,EAAE,EACrD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAA,WAAI,EAAA,YAAY,QAAQ,UAAU,EAAE,CAAA,8BAA+B,CAAA,EAAE;YAClG,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,GAAG,CACD,cAAsB,EACtB,MAA6B,EAC7B,OAAwB;QAExB,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAC;QAC5B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,YAAY,QAAQ,YAAY,cAAc,EAAE,EAAE,OAAO,CAAC,CAAC;IACzF,CAAC;CACF;AAvFD,sCAuFC"}
|
|
@@ -19,6 +19,21 @@ export class SystemConfigs extends APIResource {
|
|
|
19
19
|
* - Validation errors indicate fields that don't match the schema but don't
|
|
20
20
|
* prevent creation
|
|
21
21
|
* - Having validation errors may affect how some evaluation metrics are calculated
|
|
22
|
+
*
|
|
23
|
+
* @example
|
|
24
|
+
* ```ts
|
|
25
|
+
* const systemConfig = await client.systemConfigs.create(
|
|
26
|
+
* '12345678-0a8b-4f66-b6f3-2ddcfa097257',
|
|
27
|
+
* {
|
|
28
|
+
* config: {
|
|
29
|
+
* temperature: 0.1,
|
|
30
|
+
* maxTokens: 1024,
|
|
31
|
+
* model: 'gpt-4-turbo',
|
|
32
|
+
* },
|
|
33
|
+
* name: 'Production (Low Temperature)',
|
|
34
|
+
* },
|
|
35
|
+
* );
|
|
36
|
+
* ```
|
|
22
37
|
*/
|
|
23
38
|
create(systemID, body, options) {
|
|
24
39
|
return this._client.post(path `/systems/${systemID}/configs`, { body, ...options });
|
|
@@ -28,6 +43,16 @@ export class SystemConfigs extends APIResource {
|
|
|
28
43
|
*
|
|
29
44
|
* System configurations provide concrete parameter values for a System Under Test,
|
|
30
45
|
* defining exactly how the system should be configured during an evaluation run.
|
|
46
|
+
*
|
|
47
|
+
* @example
|
|
48
|
+
* ```ts
|
|
49
|
+
* // Automatically fetches more pages as needed.
|
|
50
|
+
* for await (const systemConfig of client.systemConfigs.list(
|
|
51
|
+
* '12345678-0a8b-4f66-b6f3-2ddcfa097257',
|
|
52
|
+
* )) {
|
|
53
|
+
* // ...
|
|
54
|
+
* }
|
|
55
|
+
* ```
|
|
31
56
|
*/
|
|
32
57
|
list(systemID, query = {}, options) {
|
|
33
58
|
return this._client.getAPIList(path `/systems/${systemID}/configs`, (PaginatedResponse), {
|
|
@@ -37,6 +62,14 @@ export class SystemConfigs extends APIResource {
|
|
|
37
62
|
}
|
|
38
63
|
/**
|
|
39
64
|
* Retrieve a specific system configuration by ID.
|
|
65
|
+
*
|
|
66
|
+
* @example
|
|
67
|
+
* ```ts
|
|
68
|
+
* const systemConfig = await client.systemConfigs.get(
|
|
69
|
+
* '87654321-4d3b-4ae4-8c7a-4b6e2a19ccf0',
|
|
70
|
+
* { systemId: '12345678-0a8b-4f66-b6f3-2ddcfa097257' },
|
|
71
|
+
* );
|
|
72
|
+
* ```
|
|
40
73
|
*/
|
|
41
74
|
get(systemConfigID, params, options) {
|
|
42
75
|
const { systemId } = params;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"system-configs.mjs","sourceRoot":"","sources":["../src/resources/system-configs.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAe,iBAAiB,EAAgC;OAEhE,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,aAAc,SAAQ,WAAW;IAC5C
|
|
1
|
+
{"version":3,"file":"system-configs.mjs","sourceRoot":"","sources":["../src/resources/system-configs.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAe,iBAAiB,EAAgC;OAEhE,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,aAAc,SAAQ,WAAW;IAC5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,MAAM,CACJ,QAAgB,EAChB,IAA8B,EAC9B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,YAAY,QAAQ,UAAU,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrF,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,IAAI,CACF,QAAgB,EAChB,QAAmD,EAAE,EACrD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAA,YAAY,QAAQ,UAAU,EAAE,CAAA,iBAA+B,CAAA,EAAE;YAClG,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,GAAG,CACD,cAAsB,EACtB,MAA6B,EAC7B,OAAwB;QAExB,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAC;QAC5B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,YAAY,QAAQ,YAAY,cAAc,EAAE,EAAE,OAAO,CAAC,CAAC;IACzF,CAAC;CACF"}
|
package/resources/systems.d.mts
CHANGED
|
@@ -19,6 +19,45 @@ export declare class Systems extends APIResource {
|
|
|
19
19
|
*
|
|
20
20
|
* This separation lets you evaluate any system as a black box, focusing on its
|
|
21
21
|
* interface rather than implementation details.
|
|
22
|
+
*
|
|
23
|
+
* @example
|
|
24
|
+
* ```ts
|
|
25
|
+
* const system = await client.systems.create('314', {
|
|
26
|
+
* configSchema: {
|
|
27
|
+
* type: 'object',
|
|
28
|
+
* properties: {
|
|
29
|
+
* temperature: { type: 'number' },
|
|
30
|
+
* maxTokens: { type: 'integer' },
|
|
31
|
+
* model: { type: 'string', enum: ['gpt-4', 'gpt-4-turbo'] },
|
|
32
|
+
* },
|
|
33
|
+
* required: ['model'],
|
|
34
|
+
* },
|
|
35
|
+
* description: 'Production chatbot powered by GPT-4',
|
|
36
|
+
* inputSchema: {
|
|
37
|
+
* type: 'object',
|
|
38
|
+
* properties: {
|
|
39
|
+
* messages: {
|
|
40
|
+
* type: 'array',
|
|
41
|
+
* items: {
|
|
42
|
+
* type: 'object',
|
|
43
|
+
* properties: {
|
|
44
|
+
* role: { type: 'string', enum: ['system', 'user', 'assistant'] },
|
|
45
|
+
* content: { type: 'string' },
|
|
46
|
+
* },
|
|
47
|
+
* required: ['role', 'content'],
|
|
48
|
+
* },
|
|
49
|
+
* },
|
|
50
|
+
* },
|
|
51
|
+
* required: ['messages'],
|
|
52
|
+
* },
|
|
53
|
+
* name: 'GPT-4 Chatbot',
|
|
54
|
+
* outputSchema: {
|
|
55
|
+
* type: 'object',
|
|
56
|
+
* properties: { response: { type: 'string' } },
|
|
57
|
+
* required: ['response'],
|
|
58
|
+
* },
|
|
59
|
+
* });
|
|
60
|
+
* ```
|
|
22
61
|
*/
|
|
23
62
|
create(projectID: string, body: SystemCreateParams, options?: RequestOptions): APIPromise<System>;
|
|
24
63
|
/**
|
|
@@ -34,19 +73,53 @@ export declare class Systems extends APIResource {
|
|
|
34
73
|
* - Schema updates won't invalidate existing evaluations or configurations
|
|
35
74
|
* - For significant redesigns, creating a new system definition provides a cleaner
|
|
36
75
|
* separation
|
|
76
|
+
*
|
|
77
|
+
* @example
|
|
78
|
+
* ```ts
|
|
79
|
+
* const system = await client.systems.update(
|
|
80
|
+
* '12345678-0a8b-4f66-b6f3-2ddcfa097257',
|
|
81
|
+
* {
|
|
82
|
+
* description:
|
|
83
|
+
* 'Updated production chatbot powered by GPT-4 Turbo',
|
|
84
|
+
* name: 'GPT-4 Turbo Chatbot',
|
|
85
|
+
* },
|
|
86
|
+
* );
|
|
87
|
+
* ```
|
|
37
88
|
*/
|
|
38
89
|
update(systemID: string, body?: SystemUpdateParams | null | undefined, options?: RequestOptions): APIPromise<System>;
|
|
39
90
|
/**
|
|
40
91
|
* Retrieve a paginated list of all systems. Systems are ordered by creation date.
|
|
92
|
+
*
|
|
93
|
+
* @example
|
|
94
|
+
* ```ts
|
|
95
|
+
* // Automatically fetches more pages as needed.
|
|
96
|
+
* for await (const system of client.systems.list('314')) {
|
|
97
|
+
* // ...
|
|
98
|
+
* }
|
|
99
|
+
* ```
|
|
41
100
|
*/
|
|
42
101
|
list(projectID: string, query?: SystemListParams | null | undefined, options?: RequestOptions): PagePromise<SystemsPaginatedResponse, System>;
|
|
43
102
|
/**
|
|
44
103
|
* Delete a system definition by ID. This will not delete associated system
|
|
45
104
|
* configurations.
|
|
105
|
+
*
|
|
106
|
+
* @example
|
|
107
|
+
* ```ts
|
|
108
|
+
* const system = await client.systems.delete(
|
|
109
|
+
* '12345678-0a8b-4f66-b6f3-2ddcfa097257',
|
|
110
|
+
* );
|
|
111
|
+
* ```
|
|
46
112
|
*/
|
|
47
113
|
delete(systemID: string, options?: RequestOptions): APIPromise<SystemDeleteResponse>;
|
|
48
114
|
/**
|
|
49
115
|
* Retrieve a specific system by ID.
|
|
116
|
+
*
|
|
117
|
+
* @example
|
|
118
|
+
* ```ts
|
|
119
|
+
* const system = await client.systems.get(
|
|
120
|
+
* '12345678-0a8b-4f66-b6f3-2ddcfa097257',
|
|
121
|
+
* );
|
|
122
|
+
* ```
|
|
50
123
|
*/
|
|
51
124
|
get(systemID: string, options?: RequestOptions): APIPromise<System>;
|
|
52
125
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"systems.d.mts","sourceRoot":"","sources":["../src/resources/systems.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,OAAQ,SAAQ,WAAW;IACtC
|
|
1
|
+
{"version":3,"file":"systems.d.mts","sourceRoot":"","sources":["../src/resources/systems.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,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;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;AAEpE,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;CACH"}
|
package/resources/systems.d.ts
CHANGED
|
@@ -19,6 +19,45 @@ export declare class Systems extends APIResource {
|
|
|
19
19
|
*
|
|
20
20
|
* This separation lets you evaluate any system as a black box, focusing on its
|
|
21
21
|
* interface rather than implementation details.
|
|
22
|
+
*
|
|
23
|
+
* @example
|
|
24
|
+
* ```ts
|
|
25
|
+
* const system = await client.systems.create('314', {
|
|
26
|
+
* configSchema: {
|
|
27
|
+
* type: 'object',
|
|
28
|
+
* properties: {
|
|
29
|
+
* temperature: { type: 'number' },
|
|
30
|
+
* maxTokens: { type: 'integer' },
|
|
31
|
+
* model: { type: 'string', enum: ['gpt-4', 'gpt-4-turbo'] },
|
|
32
|
+
* },
|
|
33
|
+
* required: ['model'],
|
|
34
|
+
* },
|
|
35
|
+
* description: 'Production chatbot powered by GPT-4',
|
|
36
|
+
* inputSchema: {
|
|
37
|
+
* type: 'object',
|
|
38
|
+
* properties: {
|
|
39
|
+
* messages: {
|
|
40
|
+
* type: 'array',
|
|
41
|
+
* items: {
|
|
42
|
+
* type: 'object',
|
|
43
|
+
* properties: {
|
|
44
|
+
* role: { type: 'string', enum: ['system', 'user', 'assistant'] },
|
|
45
|
+
* content: { type: 'string' },
|
|
46
|
+
* },
|
|
47
|
+
* required: ['role', 'content'],
|
|
48
|
+
* },
|
|
49
|
+
* },
|
|
50
|
+
* },
|
|
51
|
+
* required: ['messages'],
|
|
52
|
+
* },
|
|
53
|
+
* name: 'GPT-4 Chatbot',
|
|
54
|
+
* outputSchema: {
|
|
55
|
+
* type: 'object',
|
|
56
|
+
* properties: { response: { type: 'string' } },
|
|
57
|
+
* required: ['response'],
|
|
58
|
+
* },
|
|
59
|
+
* });
|
|
60
|
+
* ```
|
|
22
61
|
*/
|
|
23
62
|
create(projectID: string, body: SystemCreateParams, options?: RequestOptions): APIPromise<System>;
|
|
24
63
|
/**
|
|
@@ -34,19 +73,53 @@ export declare class Systems extends APIResource {
|
|
|
34
73
|
* - Schema updates won't invalidate existing evaluations or configurations
|
|
35
74
|
* - For significant redesigns, creating a new system definition provides a cleaner
|
|
36
75
|
* separation
|
|
76
|
+
*
|
|
77
|
+
* @example
|
|
78
|
+
* ```ts
|
|
79
|
+
* const system = await client.systems.update(
|
|
80
|
+
* '12345678-0a8b-4f66-b6f3-2ddcfa097257',
|
|
81
|
+
* {
|
|
82
|
+
* description:
|
|
83
|
+
* 'Updated production chatbot powered by GPT-4 Turbo',
|
|
84
|
+
* name: 'GPT-4 Turbo Chatbot',
|
|
85
|
+
* },
|
|
86
|
+
* );
|
|
87
|
+
* ```
|
|
37
88
|
*/
|
|
38
89
|
update(systemID: string, body?: SystemUpdateParams | null | undefined, options?: RequestOptions): APIPromise<System>;
|
|
39
90
|
/**
|
|
40
91
|
* Retrieve a paginated list of all systems. Systems are ordered by creation date.
|
|
92
|
+
*
|
|
93
|
+
* @example
|
|
94
|
+
* ```ts
|
|
95
|
+
* // Automatically fetches more pages as needed.
|
|
96
|
+
* for await (const system of client.systems.list('314')) {
|
|
97
|
+
* // ...
|
|
98
|
+
* }
|
|
99
|
+
* ```
|
|
41
100
|
*/
|
|
42
101
|
list(projectID: string, query?: SystemListParams | null | undefined, options?: RequestOptions): PagePromise<SystemsPaginatedResponse, System>;
|
|
43
102
|
/**
|
|
44
103
|
* Delete a system definition by ID. This will not delete associated system
|
|
45
104
|
* configurations.
|
|
105
|
+
*
|
|
106
|
+
* @example
|
|
107
|
+
* ```ts
|
|
108
|
+
* const system = await client.systems.delete(
|
|
109
|
+
* '12345678-0a8b-4f66-b6f3-2ddcfa097257',
|
|
110
|
+
* );
|
|
111
|
+
* ```
|
|
46
112
|
*/
|
|
47
113
|
delete(systemID: string, options?: RequestOptions): APIPromise<SystemDeleteResponse>;
|
|
48
114
|
/**
|
|
49
115
|
* Retrieve a specific system by ID.
|
|
116
|
+
*
|
|
117
|
+
* @example
|
|
118
|
+
* ```ts
|
|
119
|
+
* const system = await client.systems.get(
|
|
120
|
+
* '12345678-0a8b-4f66-b6f3-2ddcfa097257',
|
|
121
|
+
* );
|
|
122
|
+
* ```
|
|
50
123
|
*/
|
|
51
124
|
get(systemID: string, options?: RequestOptions): APIPromise<System>;
|
|
52
125
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"systems.d.ts","sourceRoot":"","sources":["../src/resources/systems.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,OAAQ,SAAQ,WAAW;IACtC
|
|
1
|
+
{"version":3,"file":"systems.d.ts","sourceRoot":"","sources":["../src/resources/systems.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,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;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;AAEpE,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;CACH"}
|
package/resources/systems.js
CHANGED
|
@@ -22,6 +22,45 @@ class Systems extends resource_1.APIResource {
|
|
|
22
22
|
*
|
|
23
23
|
* This separation lets you evaluate any system as a black box, focusing on its
|
|
24
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
|
+
* ```
|
|
25
64
|
*/
|
|
26
65
|
create(projectID, body, options) {
|
|
27
66
|
return this._client.post((0, path_1.path) `/projects/${projectID}/systems`, { body, ...options });
|
|
@@ -39,12 +78,32 @@ class Systems extends resource_1.APIResource {
|
|
|
39
78
|
* - Schema updates won't invalidate existing evaluations or configurations
|
|
40
79
|
* - For significant redesigns, creating a new system definition provides a cleaner
|
|
41
80
|
* separation
|
|
81
|
+
*
|
|
82
|
+
* @example
|
|
83
|
+
* ```ts
|
|
84
|
+
* const system = await client.systems.update(
|
|
85
|
+
* '12345678-0a8b-4f66-b6f3-2ddcfa097257',
|
|
86
|
+
* {
|
|
87
|
+
* description:
|
|
88
|
+
* 'Updated production chatbot powered by GPT-4 Turbo',
|
|
89
|
+
* name: 'GPT-4 Turbo Chatbot',
|
|
90
|
+
* },
|
|
91
|
+
* );
|
|
92
|
+
* ```
|
|
42
93
|
*/
|
|
43
94
|
update(systemID, body = {}, options) {
|
|
44
95
|
return this._client.patch((0, path_1.path) `/systems/${systemID}`, { body, ...options });
|
|
45
96
|
}
|
|
46
97
|
/**
|
|
47
98
|
* Retrieve a paginated list of all systems. Systems are ordered by creation date.
|
|
99
|
+
*
|
|
100
|
+
* @example
|
|
101
|
+
* ```ts
|
|
102
|
+
* // Automatically fetches more pages as needed.
|
|
103
|
+
* for await (const system of client.systems.list('314')) {
|
|
104
|
+
* // ...
|
|
105
|
+
* }
|
|
106
|
+
* ```
|
|
48
107
|
*/
|
|
49
108
|
list(projectID, query = {}, options) {
|
|
50
109
|
return this._client.getAPIList((0, path_1.path) `/projects/${projectID}/systems`, (pagination_1.PaginatedResponse), {
|
|
@@ -55,12 +114,26 @@ class Systems extends resource_1.APIResource {
|
|
|
55
114
|
/**
|
|
56
115
|
* Delete a system definition by ID. This will not delete associated system
|
|
57
116
|
* configurations.
|
|
117
|
+
*
|
|
118
|
+
* @example
|
|
119
|
+
* ```ts
|
|
120
|
+
* const system = await client.systems.delete(
|
|
121
|
+
* '12345678-0a8b-4f66-b6f3-2ddcfa097257',
|
|
122
|
+
* );
|
|
123
|
+
* ```
|
|
58
124
|
*/
|
|
59
125
|
delete(systemID, options) {
|
|
60
126
|
return this._client.delete((0, path_1.path) `/systems/${systemID}`, options);
|
|
61
127
|
}
|
|
62
128
|
/**
|
|
63
129
|
* Retrieve a specific system by ID.
|
|
130
|
+
*
|
|
131
|
+
* @example
|
|
132
|
+
* ```ts
|
|
133
|
+
* const system = await client.systems.get(
|
|
134
|
+
* '12345678-0a8b-4f66-b6f3-2ddcfa097257',
|
|
135
|
+
* );
|
|
136
|
+
* ```
|
|
64
137
|
*/
|
|
65
138
|
get(systemID, options) {
|
|
66
139
|
return this._client.get((0, path_1.path) `/systems/${systemID}`, options);
|
package/resources/systems.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"systems.js","sourceRoot":"","sources":["../src/resources/systems.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAE/C,sDAAkG;AAElG,oDAA8C;AAE9C,MAAa,OAAQ,SAAQ,sBAAW;IACtC
|
|
1
|
+
{"version":3,"file":"systems.js","sourceRoot":"","sources":["../src/resources/systems.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAE/C,sDAAkG;AAElG,oDAA8C;AAE9C,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuDG;IACH,MAAM,CAAC,SAAiB,EAAE,IAAwB,EAAE,OAAwB;QAC1E,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,aAAa,SAAS,UAAU,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,MAAM,CACJ,QAAgB,EAChB,OAA8C,EAAE,EAChD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,YAAY,QAAQ,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9E,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CACF,SAAiB,EACjB,QAA6C,EAAE,EAC/C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAA,WAAI,EAAA,aAAa,SAAS,UAAU,EAAE,CAAA,8BAAyB,CAAA,EAAE;YAC9F,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,QAAgB,EAAE,OAAwB;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,YAAY,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;IAED;;;;;;;;;OASG;IACH,GAAG,CAAC,QAAgB,EAAE,OAAwB;QAC5C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,YAAY,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IAC/D,CAAC;CACF;AAjJD,0BAiJC"}
|
package/resources/systems.mjs
CHANGED
|
@@ -19,6 +19,45 @@ export class Systems extends APIResource {
|
|
|
19
19
|
*
|
|
20
20
|
* This separation lets you evaluate any system as a black box, focusing on its
|
|
21
21
|
* interface rather than implementation details.
|
|
22
|
+
*
|
|
23
|
+
* @example
|
|
24
|
+
* ```ts
|
|
25
|
+
* const system = await client.systems.create('314', {
|
|
26
|
+
* configSchema: {
|
|
27
|
+
* type: 'object',
|
|
28
|
+
* properties: {
|
|
29
|
+
* temperature: { type: 'number' },
|
|
30
|
+
* maxTokens: { type: 'integer' },
|
|
31
|
+
* model: { type: 'string', enum: ['gpt-4', 'gpt-4-turbo'] },
|
|
32
|
+
* },
|
|
33
|
+
* required: ['model'],
|
|
34
|
+
* },
|
|
35
|
+
* description: 'Production chatbot powered by GPT-4',
|
|
36
|
+
* inputSchema: {
|
|
37
|
+
* type: 'object',
|
|
38
|
+
* properties: {
|
|
39
|
+
* messages: {
|
|
40
|
+
* type: 'array',
|
|
41
|
+
* items: {
|
|
42
|
+
* type: 'object',
|
|
43
|
+
* properties: {
|
|
44
|
+
* role: { type: 'string', enum: ['system', 'user', 'assistant'] },
|
|
45
|
+
* content: { type: 'string' },
|
|
46
|
+
* },
|
|
47
|
+
* required: ['role', 'content'],
|
|
48
|
+
* },
|
|
49
|
+
* },
|
|
50
|
+
* },
|
|
51
|
+
* required: ['messages'],
|
|
52
|
+
* },
|
|
53
|
+
* name: 'GPT-4 Chatbot',
|
|
54
|
+
* outputSchema: {
|
|
55
|
+
* type: 'object',
|
|
56
|
+
* properties: { response: { type: 'string' } },
|
|
57
|
+
* required: ['response'],
|
|
58
|
+
* },
|
|
59
|
+
* });
|
|
60
|
+
* ```
|
|
22
61
|
*/
|
|
23
62
|
create(projectID, body, options) {
|
|
24
63
|
return this._client.post(path `/projects/${projectID}/systems`, { body, ...options });
|
|
@@ -36,12 +75,32 @@ export class Systems extends APIResource {
|
|
|
36
75
|
* - Schema updates won't invalidate existing evaluations or configurations
|
|
37
76
|
* - For significant redesigns, creating a new system definition provides a cleaner
|
|
38
77
|
* separation
|
|
78
|
+
*
|
|
79
|
+
* @example
|
|
80
|
+
* ```ts
|
|
81
|
+
* const system = await client.systems.update(
|
|
82
|
+
* '12345678-0a8b-4f66-b6f3-2ddcfa097257',
|
|
83
|
+
* {
|
|
84
|
+
* description:
|
|
85
|
+
* 'Updated production chatbot powered by GPT-4 Turbo',
|
|
86
|
+
* name: 'GPT-4 Turbo Chatbot',
|
|
87
|
+
* },
|
|
88
|
+
* );
|
|
89
|
+
* ```
|
|
39
90
|
*/
|
|
40
91
|
update(systemID, body = {}, options) {
|
|
41
92
|
return this._client.patch(path `/systems/${systemID}`, { body, ...options });
|
|
42
93
|
}
|
|
43
94
|
/**
|
|
44
95
|
* Retrieve a paginated list of all systems. Systems are ordered by creation date.
|
|
96
|
+
*
|
|
97
|
+
* @example
|
|
98
|
+
* ```ts
|
|
99
|
+
* // Automatically fetches more pages as needed.
|
|
100
|
+
* for await (const system of client.systems.list('314')) {
|
|
101
|
+
* // ...
|
|
102
|
+
* }
|
|
103
|
+
* ```
|
|
45
104
|
*/
|
|
46
105
|
list(projectID, query = {}, options) {
|
|
47
106
|
return this._client.getAPIList(path `/projects/${projectID}/systems`, (PaginatedResponse), {
|
|
@@ -52,12 +111,26 @@ export class Systems extends APIResource {
|
|
|
52
111
|
/**
|
|
53
112
|
* Delete a system definition by ID. This will not delete associated system
|
|
54
113
|
* configurations.
|
|
114
|
+
*
|
|
115
|
+
* @example
|
|
116
|
+
* ```ts
|
|
117
|
+
* const system = await client.systems.delete(
|
|
118
|
+
* '12345678-0a8b-4f66-b6f3-2ddcfa097257',
|
|
119
|
+
* );
|
|
120
|
+
* ```
|
|
55
121
|
*/
|
|
56
122
|
delete(systemID, options) {
|
|
57
123
|
return this._client.delete(path `/systems/${systemID}`, options);
|
|
58
124
|
}
|
|
59
125
|
/**
|
|
60
126
|
* Retrieve a specific system by ID.
|
|
127
|
+
*
|
|
128
|
+
* @example
|
|
129
|
+
* ```ts
|
|
130
|
+
* const system = await client.systems.get(
|
|
131
|
+
* '12345678-0a8b-4f66-b6f3-2ddcfa097257',
|
|
132
|
+
* );
|
|
133
|
+
* ```
|
|
61
134
|
*/
|
|
62
135
|
get(systemID, options) {
|
|
63
136
|
return this._client.get(path `/systems/${systemID}`, options);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"systems.mjs","sourceRoot":"","sources":["../src/resources/systems.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAe,iBAAiB,EAAgC;OAEhE,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC
|
|
1
|
+
{"version":3,"file":"systems.mjs","sourceRoot":"","sources":["../src/resources/systems.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAe,iBAAiB,EAAgC;OAEhE,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuDG;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;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,MAAM,CACJ,QAAgB,EAChB,OAA8C,EAAE,EAChD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,YAAY,QAAQ,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9E,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CACF,SAAiB,EACjB,QAA6C,EAAE,EAC/C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAA,aAAa,SAAS,UAAU,EAAE,CAAA,iBAAyB,CAAA,EAAE;YAC9F,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,QAAgB,EAAE,OAAwB;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,YAAY,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;IAED;;;;;;;;;OASG;IACH,GAAG,CAAC,QAAgB,EAAE,OAAwB;QAC5C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,YAAY,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IAC/D,CAAC;CACF"}
|