@lokalise/ragnarok-api-contracts 2.1.0 → 2.1.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.
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import { z } from 'zod';
|
|
2
|
-
declare const
|
|
2
|
+
declare const GET_EVALUATION_PARAMS_SCHEMA: z.ZodObject<{
|
|
3
3
|
evaluationId: z.ZodUUID;
|
|
4
4
|
}, z.core.$strip>;
|
|
5
|
-
export type GetEvaluationParams = z.infer<typeof
|
|
5
|
+
export type GetEvaluationParams = z.infer<typeof GET_EVALUATION_PARAMS_SCHEMA>;
|
|
6
6
|
export declare const getEvaluation: import("@lokalise/api-contracts").GetRouteDefinition<z.ZodObject<{
|
|
7
7
|
id: z.ZodUUID;
|
|
8
8
|
ownerId: z.ZodString;
|
|
@@ -33,7 +33,35 @@ export declare const getEvaluation: import("@lokalise/api-contracts").GetRouteDe
|
|
|
33
33
|
evaluationId: z.ZodUUID;
|
|
34
34
|
}, z.core.$strip>, undefined, z.ZodObject<{
|
|
35
35
|
authorization: z.ZodString;
|
|
36
|
-
}, z.core.$strip>, undefined, false, false,
|
|
36
|
+
}, z.core.$strip>, undefined, false, false, {
|
|
37
|
+
200: z.ZodObject<{
|
|
38
|
+
id: z.ZodUUID;
|
|
39
|
+
ownerId: z.ZodString;
|
|
40
|
+
status: z.ZodEnum<{
|
|
41
|
+
pending: "pending";
|
|
42
|
+
completed: "completed";
|
|
43
|
+
failed: "failed";
|
|
44
|
+
}>;
|
|
45
|
+
resultByConfigurationName: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodObject<{
|
|
46
|
+
global: z.ZodObject<{
|
|
47
|
+
referenceTranslationScore: z.ZodOptional<z.ZodNumber>;
|
|
48
|
+
actualTranslationScore: z.ZodOptional<z.ZodNumber>;
|
|
49
|
+
perfectMatch: z.ZodOptional<z.ZodNumber>;
|
|
50
|
+
translationErrorRate: z.ZodOptional<z.ZodNumber>;
|
|
51
|
+
bleu: z.ZodOptional<z.ZodNumber>;
|
|
52
|
+
meteor: z.ZodOptional<z.ZodNumber>;
|
|
53
|
+
}, z.core.$strip>;
|
|
54
|
+
}, z.core.$catchall<z.ZodObject<{
|
|
55
|
+
referenceTranslationScore: z.ZodOptional<z.ZodNumber>;
|
|
56
|
+
actualTranslationScore: z.ZodOptional<z.ZodNumber>;
|
|
57
|
+
perfectMatch: z.ZodOptional<z.ZodNumber>;
|
|
58
|
+
translationErrorRate: z.ZodOptional<z.ZodNumber>;
|
|
59
|
+
bleu: z.ZodOptional<z.ZodNumber>;
|
|
60
|
+
meteor: z.ZodOptional<z.ZodNumber>;
|
|
61
|
+
}, z.core.$strip>>>>>;
|
|
62
|
+
metadata: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
|
|
63
|
+
}, z.core.$strip>;
|
|
64
|
+
}>;
|
|
37
65
|
export declare const DATASET_INPUT_SCHEMA: z.ZodObject<{
|
|
38
66
|
fileUrl: z.ZodURL;
|
|
39
67
|
}, z.core.$strip>;
|
|
@@ -118,5 +146,9 @@ export declare const postScheduleEvaluation: import("@lokalise/api-contracts").P
|
|
|
118
146
|
evaluationId: z.ZodUUID;
|
|
119
147
|
}, z.core.$strip>, undefined, undefined, z.ZodObject<{
|
|
120
148
|
authorization: z.ZodString;
|
|
121
|
-
}, z.core.$strip>, undefined, false, false,
|
|
149
|
+
}, z.core.$strip>, undefined, false, false, {
|
|
150
|
+
202: z.ZodObject<{
|
|
151
|
+
evaluationId: z.ZodUUID;
|
|
152
|
+
}, z.core.$strip>;
|
|
153
|
+
}>;
|
|
122
154
|
export {};
|
|
@@ -2,19 +2,24 @@ import { buildRestContract } from '@lokalise/api-contracts';
|
|
|
2
2
|
import { z } from 'zod';
|
|
3
3
|
import { AUTH_HEADERS, INTEGRATION_INPUT_SCHEMA, METADATA_SCHEMA, WEBHOOK_SCHEMA, } from "./common.js";
|
|
4
4
|
import { EVALUATION_SCHEMA } from "./objects.js";
|
|
5
|
-
const
|
|
5
|
+
const GET_EVALUATION_PARAMS_SCHEMA = z.object({
|
|
6
6
|
evaluationId: z.uuid().describe('The unique identifier of the evaluation to retrieve.'),
|
|
7
7
|
});
|
|
8
8
|
export const getEvaluation = buildRestContract({
|
|
9
9
|
method: 'get',
|
|
10
|
-
pathResolver: (
|
|
10
|
+
pathResolver: ({ evaluationId }) => `/v1/evaluations/${evaluationId}`,
|
|
11
11
|
description: 'Retrieve evaluation by id',
|
|
12
|
-
requestPathParamsSchema:
|
|
12
|
+
requestPathParamsSchema: GET_EVALUATION_PARAMS_SCHEMA,
|
|
13
13
|
requestHeaderSchema: AUTH_HEADERS,
|
|
14
14
|
successResponseBodySchema: EVALUATION_SCHEMA,
|
|
15
|
+
responseSchemasByStatusCode: {
|
|
16
|
+
200: EVALUATION_SCHEMA,
|
|
17
|
+
},
|
|
15
18
|
});
|
|
16
19
|
export const DATASET_INPUT_SCHEMA = z.object({
|
|
17
|
-
fileUrl: z
|
|
20
|
+
fileUrl: z
|
|
21
|
+
.url()
|
|
22
|
+
.describe('Presigned URL to the JSONL dataset file. Dataset format specification: https://github.com/lokalise/ragnarok/blob/main/apps/ragnarok/docs/evaluation-dataset-file.md'),
|
|
18
23
|
});
|
|
19
24
|
export const RUN_CONFIGURATION_INPUT_SCHEMA = z.object({
|
|
20
25
|
name: z
|
|
@@ -62,16 +67,20 @@ const SCHEDULE_EVALUATION_BODY_SCHEMA = z
|
|
|
62
67
|
const names = data.runConfigurations.map((c) => c.name);
|
|
63
68
|
return new Set(names).size === names.length;
|
|
64
69
|
}, { message: 'Run configuration names must be unique within the request' });
|
|
70
|
+
const SCHEDULE_EVALUATION_RESPONSE_SCHEMA = z.object({
|
|
71
|
+
evaluationId: z
|
|
72
|
+
.uuid()
|
|
73
|
+
.describe('The unique identifier of the scheduled evaluation. Use it to retrieve the evaluation results later.'),
|
|
74
|
+
});
|
|
65
75
|
export const postScheduleEvaluation = buildRestContract({
|
|
66
76
|
method: 'post',
|
|
67
77
|
pathResolver: () => '/v1/evaluations',
|
|
68
78
|
description: 'Schedule evaluation',
|
|
69
79
|
requestHeaderSchema: AUTH_HEADERS,
|
|
70
80
|
requestBodySchema: SCHEDULE_EVALUATION_BODY_SCHEMA,
|
|
71
|
-
successResponseBodySchema:
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
}),
|
|
81
|
+
successResponseBodySchema: SCHEDULE_EVALUATION_RESPONSE_SCHEMA,
|
|
82
|
+
responseSchemasByStatusCode: {
|
|
83
|
+
202: SCHEDULE_EVALUATION_RESPONSE_SCHEMA,
|
|
84
|
+
},
|
|
76
85
|
});
|
|
77
86
|
//# sourceMappingURL=evaluation-contracts.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"evaluation-contracts.js","sourceRoot":"","sources":["../src/evaluation-contracts.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAA;AAC3D,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AACvB,OAAO,EACL,YAAY,EACZ,wBAAwB,EACxB,eAAe,EACf,cAAc,GACf,MAAM,aAAa,CAAA;AACpB,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AAEhD,MAAM,
|
|
1
|
+
{"version":3,"file":"evaluation-contracts.js","sourceRoot":"","sources":["../src/evaluation-contracts.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAA;AAC3D,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AACvB,OAAO,EACL,YAAY,EACZ,wBAAwB,EACxB,eAAe,EACf,cAAc,GACf,MAAM,aAAa,CAAA;AACpB,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AAEhD,MAAM,4BAA4B,GAAG,CAAC,CAAC,MAAM,CAAC;IAC5C,YAAY,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,QAAQ,CAAC,sDAAsD,CAAC;CACxF,CAAC,CAAA;AAIF,MAAM,CAAC,MAAM,aAAa,GAAG,iBAAiB,CAAC;IAC7C,MAAM,EAAE,KAAK;IACb,YAAY,EAAE,CAAC,EAAE,YAAY,EAAE,EAAE,EAAE,CAAC,mBAAmB,YAAY,EAAE;IACrE,WAAW,EAAE,2BAA2B;IACxC,uBAAuB,EAAE,4BAA4B;IACrD,mBAAmB,EAAE,YAAY;IACjC,yBAAyB,EAAE,iBAAiB;IAC5C,2BAA2B,EAAE;QAC3B,GAAG,EAAE,iBAAiB;KACvB;CACF,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC3C,OAAO,EAAE,CAAC;SACP,GAAG,EAAE;SACL,QAAQ,CACP,qKAAqK,CACtK;CACJ,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,8BAA8B,GAAG,CAAC,CAAC,MAAM,CAAC;IACrD,IAAI,EAAE,CAAC;SACJ,MAAM,EAAE;SACR,GAAG,CAAC,CAAC,CAAC;SACN,QAAQ,CAAC,gEAAgE,CAAC;IAC7E,WAAW,EAAE,wBAAwB,CAAC,QAAQ,EAAE,CAAC,QAAQ,CACvD,oDAAoD,CACrD;IACD,WAAW,EAAE,CAAC;SACX,OAAO,EAAE;SACT,QAAQ,EAAE;SACV,OAAO,CAAC,IAAI,CAAC;SACb,QAAQ,CAAC,sEAAsE,CAAC;IACnF,aAAa,EAAE,CAAC;SACb,OAAO,EAAE;SACT,QAAQ,EAAE;SACV,OAAO,CAAC,IAAI,CAAC;SACb,QAAQ,CAAC,4DAA4D,CAAC;IACzE,WAAW,EAAE,CAAC;SACX,OAAO,EAAE;SACT,QAAQ,EAAE;SACV,OAAO,CAAC,IAAI,CAAC;SACb,QAAQ,CAAC,gEAAgE,CAAC;IAC7E,eAAe,EAAE,CAAC;SACf,OAAO,EAAE;SACT,QAAQ,EAAE;SACV,OAAO,CAAC,IAAI,CAAC;SACb,QAAQ,CACP,0FAA0F,CAC3F;CACJ,CAAC,CAAA;AAIF,MAAM,+BAA+B,GAAG,CAAC;KACtC,MAAM,CAAC;IACN,OAAO,EAAE,CAAC;SACP,MAAM,EAAE;SACR,GAAG,CAAC,CAAC,CAAC;SACN,QAAQ,CAAC,2DAA2D,CAAC;IACxE,QAAQ,EAAE,CAAC,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,0BAA0B,CAAC;IACnF,OAAO,EAAE,cAAc,CAAC,QAAQ,CAAC,qCAAqC,CAAC;IACvE,iBAAiB,EAAE,CAAC;SACjB,KAAK,CAAC,8BAA8B,CAAC;SACrC,GAAG,CAAC,CAAC,EAAE,4CAA4C,CAAC;SACpD,GAAG,CAAC,EAAE,EAAE,uCAAuC,CAAC;SAChD,QAAQ,CACP,oFAAoF,CACrF;IACH,QAAQ,EAAE,eAAe,CAAC,QAAQ,EAAE;CACrC,CAAC;KACD,MAAM,CACL,CAAC,IAAI,EAAE,EAAE;IACP,MAAM,KAAK,GAAG,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAA;IACvD,OAAO,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC,IAAI,KAAK,KAAK,CAAC,MAAM,CAAA;AAC7C,CAAC,EACD,EAAE,OAAO,EAAE,2DAA2D,EAAE,CACzE,CAAA;AAIH,MAAM,mCAAmC,GAAG,CAAC,CAAC,MAAM,CAAC;IACnD,YAAY,EAAE,CAAC;SACZ,IAAI,EAAE;SACN,QAAQ,CACP,qGAAqG,CACtG;CACJ,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,sBAAsB,GAAG,iBAAiB,CAAC;IACtD,MAAM,EAAE,MAAM;IACd,YAAY,EAAE,GAAG,EAAE,CAAC,iBAAiB;IACrC,WAAW,EAAE,qBAAqB;IAClC,mBAAmB,EAAE,YAAY;IACjC,iBAAiB,EAAE,+BAA+B;IAClD,yBAAyB,EAAE,mCAAmC;IAC9D,2BAA2B,EAAE;QAC3B,GAAG,EAAE,mCAAmC;KACzC;CACF,CAAC,CAAA"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@lokalise/ragnarok-api-contracts",
|
|
3
|
-
"version": "2.1.
|
|
3
|
+
"version": "2.1.1",
|
|
4
4
|
"author": {
|
|
5
5
|
"name": "Lokalise",
|
|
6
6
|
"url": "https://lokalise.com"
|
|
@@ -35,7 +35,7 @@
|
|
|
35
35
|
"postversion": "biome check --write package.json"
|
|
36
36
|
},
|
|
37
37
|
"devDependencies": {
|
|
38
|
-
"@biomejs/biome": "^2.
|
|
38
|
+
"@biomejs/biome": "^2.4.6",
|
|
39
39
|
"@lokalise/biome-config": "^3.1.0",
|
|
40
40
|
"@lokalise/tsconfig": "^3.0.0",
|
|
41
41
|
"rimraf": "^6.1.3",
|
|
@@ -45,6 +45,6 @@
|
|
|
45
45
|
"zod": "^4.0.0"
|
|
46
46
|
},
|
|
47
47
|
"dependencies": {
|
|
48
|
-
"@lokalise/api-contracts": "^6.
|
|
48
|
+
"@lokalise/api-contracts": "^6.6.0"
|
|
49
49
|
}
|
|
50
50
|
}
|