@lokalise/ragnarok-api-contracts 2.0.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 GET_EVALUATION_SCHEMA: z.ZodObject<{
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 GET_EVALUATION_SCHEMA>;
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;
@@ -11,12 +11,57 @@ export declare const getEvaluation: import("@lokalise/api-contracts").GetRouteDe
11
11
  completed: "completed";
12
12
  failed: "failed";
13
13
  }>;
14
- metadata: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
14
+ resultByConfigurationName: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodObject<{
15
+ global: z.ZodObject<{
16
+ referenceTranslationScore: z.ZodOptional<z.ZodNumber>;
17
+ actualTranslationScore: z.ZodOptional<z.ZodNumber>;
18
+ perfectMatch: z.ZodOptional<z.ZodNumber>;
19
+ translationErrorRate: z.ZodOptional<z.ZodNumber>;
20
+ bleu: z.ZodOptional<z.ZodNumber>;
21
+ meteor: z.ZodOptional<z.ZodNumber>;
22
+ }, z.core.$strip>;
23
+ }, z.core.$catchall<z.ZodObject<{
24
+ referenceTranslationScore: z.ZodOptional<z.ZodNumber>;
25
+ actualTranslationScore: z.ZodOptional<z.ZodNumber>;
26
+ perfectMatch: z.ZodOptional<z.ZodNumber>;
27
+ translationErrorRate: z.ZodOptional<z.ZodNumber>;
28
+ bleu: z.ZodOptional<z.ZodNumber>;
29
+ meteor: z.ZodOptional<z.ZodNumber>;
30
+ }, z.core.$strip>>>>>;
31
+ metadata: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
15
32
  }, z.core.$strip>, z.ZodObject<{
16
33
  evaluationId: z.ZodUUID;
17
34
  }, z.core.$strip>, undefined, z.ZodObject<{
18
35
  authorization: z.ZodString;
19
- }, z.core.$strip>, undefined, false, false, undefined>;
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
+ }>;
20
65
  export declare const DATASET_INPUT_SCHEMA: z.ZodObject<{
21
66
  fileUrl: z.ZodURL;
22
67
  }, z.core.$strip>;
@@ -101,5 +146,9 @@ export declare const postScheduleEvaluation: import("@lokalise/api-contracts").P
101
146
  evaluationId: z.ZodUUID;
102
147
  }, z.core.$strip>, undefined, undefined, z.ZodObject<{
103
148
  authorization: z.ZodString;
104
- }, z.core.$strip>, undefined, false, false, undefined>;
149
+ }, z.core.$strip>, undefined, false, false, {
150
+ 202: z.ZodObject<{
151
+ evaluationId: z.ZodUUID;
152
+ }, z.core.$strip>;
153
+ }>;
105
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 GET_EVALUATION_SCHEMA = z.object({
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: (params) => `/v1/evaluations/${params.evaluationId}`,
10
+ pathResolver: ({ evaluationId }) => `/v1/evaluations/${evaluationId}`,
11
11
  description: 'Retrieve evaluation by id',
12
- requestPathParamsSchema: GET_EVALUATION_SCHEMA,
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.url().describe('Presigned URL to the JSONL dataset file'),
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: z.object({
72
- evaluationId: z
73
- .uuid()
74
- .describe('The unique identifier of the scheduled evaluation. Use it to retrieve the evaluation results later.'),
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,qBAAqB,GAAG,CAAC,CAAC,MAAM,CAAC;IACrC,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,MAA2B,EAAE,EAAE,CAAC,mBAAmB,MAAM,CAAC,YAAY,EAAE;IACvF,WAAW,EAAE,2BAA2B;IACxC,uBAAuB,EAAE,qBAAqB;IAC9C,mBAAmB,EAAE,YAAY;IACjC,yBAAyB,EAAE,iBAAiB;CAC7C,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC3C,OAAO,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,yCAAyC,CAAC;CACrE,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,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,CAAC,CAAC,MAAM,CAAC;QAClC,YAAY,EAAE,CAAC;aACZ,IAAI,EAAE;aACN,QAAQ,CACP,qGAAqG,CACtG;KACJ,CAAC;CACH,CAAC,CAAA"}
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/dist/objects.d.ts CHANGED
@@ -1,4 +1,40 @@
1
1
  import { z } from 'zod';
2
+ export declare const CONFIGURATION_RESULT_SCHEMA: z.ZodObject<{
3
+ global: z.ZodObject<{
4
+ referenceTranslationScore: z.ZodOptional<z.ZodNumber>;
5
+ actualTranslationScore: z.ZodOptional<z.ZodNumber>;
6
+ perfectMatch: z.ZodOptional<z.ZodNumber>;
7
+ translationErrorRate: z.ZodOptional<z.ZodNumber>;
8
+ bleu: z.ZodOptional<z.ZodNumber>;
9
+ meteor: z.ZodOptional<z.ZodNumber>;
10
+ }, z.core.$strip>;
11
+ }, z.core.$catchall<z.ZodObject<{
12
+ referenceTranslationScore: z.ZodOptional<z.ZodNumber>;
13
+ actualTranslationScore: z.ZodOptional<z.ZodNumber>;
14
+ perfectMatch: z.ZodOptional<z.ZodNumber>;
15
+ translationErrorRate: z.ZodOptional<z.ZodNumber>;
16
+ bleu: z.ZodOptional<z.ZodNumber>;
17
+ meteor: z.ZodOptional<z.ZodNumber>;
18
+ }, z.core.$strip>>>;
19
+ export type ConfigurationResult = z.infer<typeof CONFIGURATION_RESULT_SCHEMA>;
20
+ export declare const RESULT_BY_CONFIGURATION_NAME_SCHEMA: z.ZodRecord<z.ZodString, z.ZodObject<{
21
+ global: z.ZodObject<{
22
+ referenceTranslationScore: z.ZodOptional<z.ZodNumber>;
23
+ actualTranslationScore: z.ZodOptional<z.ZodNumber>;
24
+ perfectMatch: z.ZodOptional<z.ZodNumber>;
25
+ translationErrorRate: z.ZodOptional<z.ZodNumber>;
26
+ bleu: z.ZodOptional<z.ZodNumber>;
27
+ meteor: z.ZodOptional<z.ZodNumber>;
28
+ }, z.core.$strip>;
29
+ }, z.core.$catchall<z.ZodObject<{
30
+ referenceTranslationScore: z.ZodOptional<z.ZodNumber>;
31
+ actualTranslationScore: z.ZodOptional<z.ZodNumber>;
32
+ perfectMatch: z.ZodOptional<z.ZodNumber>;
33
+ translationErrorRate: z.ZodOptional<z.ZodNumber>;
34
+ bleu: z.ZodOptional<z.ZodNumber>;
35
+ meteor: z.ZodOptional<z.ZodNumber>;
36
+ }, z.core.$strip>>>>;
37
+ export type ResultByConfigurationName = z.infer<typeof RESULT_BY_CONFIGURATION_NAME_SCHEMA>;
2
38
  export declare const EVALUATION_SCHEMA: z.ZodObject<{
3
39
  id: z.ZodUUID;
4
40
  ownerId: z.ZodString;
@@ -7,6 +43,23 @@ export declare const EVALUATION_SCHEMA: z.ZodObject<{
7
43
  completed: "completed";
8
44
  failed: "failed";
9
45
  }>;
10
- metadata: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
46
+ resultByConfigurationName: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodObject<{
47
+ global: z.ZodObject<{
48
+ referenceTranslationScore: z.ZodOptional<z.ZodNumber>;
49
+ actualTranslationScore: z.ZodOptional<z.ZodNumber>;
50
+ perfectMatch: z.ZodOptional<z.ZodNumber>;
51
+ translationErrorRate: z.ZodOptional<z.ZodNumber>;
52
+ bleu: z.ZodOptional<z.ZodNumber>;
53
+ meteor: z.ZodOptional<z.ZodNumber>;
54
+ }, z.core.$strip>;
55
+ }, z.core.$catchall<z.ZodObject<{
56
+ referenceTranslationScore: z.ZodOptional<z.ZodNumber>;
57
+ actualTranslationScore: z.ZodOptional<z.ZodNumber>;
58
+ perfectMatch: z.ZodOptional<z.ZodNumber>;
59
+ translationErrorRate: z.ZodOptional<z.ZodNumber>;
60
+ bleu: z.ZodOptional<z.ZodNumber>;
61
+ meteor: z.ZodOptional<z.ZodNumber>;
62
+ }, z.core.$strip>>>>>;
63
+ metadata: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
11
64
  }, z.core.$strip>;
12
65
  export type Evaluation = z.infer<typeof EVALUATION_SCHEMA>;
package/dist/objects.js CHANGED
@@ -1,8 +1,41 @@
1
1
  import { z } from 'zod';
2
+ const METRICS_SCHEMA = z.object({
3
+ referenceTranslationScore: z
4
+ .number()
5
+ .optional()
6
+ .describe('Average LQA score of reference translations'),
7
+ actualTranslationScore: z
8
+ .number()
9
+ .optional()
10
+ .describe('Average LQA score of actual (generated) translations'),
11
+ perfectMatch: z
12
+ .number()
13
+ .optional()
14
+ .describe('Rate of translations that exactly match the reference (0–1)'),
15
+ translationErrorRate: z
16
+ .number()
17
+ .optional()
18
+ .describe('TER score measuring post-editing effort relative to reference length'),
19
+ bleu: z
20
+ .number()
21
+ .optional()
22
+ .describe('BLEU score measuring n-gram overlap with reference translations'),
23
+ meteor: z.number().optional().describe('METEOR score measuring translation quality'),
24
+ });
25
+ export const CONFIGURATION_RESULT_SCHEMA = z
26
+ .object({
27
+ global: METRICS_SCHEMA.describe('Aggregated metrics across all language pairs for this configuration'),
28
+ })
29
+ .catchall(METRICS_SCHEMA)
30
+ .describe('Metrics keyed by language pair (e.g. "en->pl") plus a "global" aggregate');
31
+ export const RESULT_BY_CONFIGURATION_NAME_SCHEMA = z
32
+ .record(z.string(), CONFIGURATION_RESULT_SCHEMA)
33
+ .describe('Evaluation results grouped by configuration name');
2
34
  export const EVALUATION_SCHEMA = z.object({
3
- id: z.uuid(),
4
- ownerId: z.string(),
5
- status: z.enum(['pending', 'completed', 'failed']),
6
- metadata: z.record(z.string(), z.unknown()).nullable().optional(),
35
+ id: z.uuid().describe('Unique identifier of the evaluation request'),
36
+ ownerId: z.string().describe('Owner identifier (team ID or similar) for this evaluation'),
37
+ status: z.enum(['pending', 'completed', 'failed']).describe('Current status of the evaluation'),
38
+ resultByConfigurationName: RESULT_BY_CONFIGURATION_NAME_SCHEMA.nullable(),
39
+ metadata: z.record(z.string(), z.unknown()).nullable(),
7
40
  });
8
41
  //# sourceMappingURL=objects.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"objects.js","sourceRoot":"","sources":["../src/objects.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,CAAC,MAAM,CAAC;IACxC,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE;IACZ,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;IACnB,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,WAAW,EAAE,QAAQ,CAAC,CAAC;IAClD,QAAQ,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;CAClE,CAAC,CAAA"}
1
+ {"version":3,"file":"objects.js","sourceRoot":"","sources":["../src/objects.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,MAAM,cAAc,GAAG,CAAC,CAAC,MAAM,CAAC;IAC9B,yBAAyB,EAAE,CAAC;SACzB,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CAAC,6CAA6C,CAAC;IAC1D,sBAAsB,EAAE,CAAC;SACtB,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CAAC,sDAAsD,CAAC;IACnE,YAAY,EAAE,CAAC;SACZ,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CAAC,6DAA6D,CAAC;IAC1E,oBAAoB,EAAE,CAAC;SACpB,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CAAC,sEAAsE,CAAC;IACnF,IAAI,EAAE,CAAC;SACJ,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CAAC,iEAAiE,CAAC;IAC9E,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,4CAA4C,CAAC;CACrF,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,2BAA2B,GAAG,CAAC;KACzC,MAAM,CAAC;IACN,MAAM,EAAE,cAAc,CAAC,QAAQ,CAC7B,qEAAqE,CACtE;CACF,CAAC;KACD,QAAQ,CAAC,cAAc,CAAC;KACxB,QAAQ,CAAC,0EAA0E,CAAC,CAAA;AAIvF,MAAM,CAAC,MAAM,mCAAmC,GAAG,CAAC;KACjD,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,2BAA2B,CAAC;KAC/C,QAAQ,CAAC,kDAAkD,CAAC,CAAA;AAI/D,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,CAAC,MAAM,CAAC;IACxC,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,QAAQ,CAAC,6CAA6C,CAAC;IACpE,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,2DAA2D,CAAC;IACzF,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,WAAW,EAAE,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,kCAAkC,CAAC;IAC/F,yBAAyB,EAAE,mCAAmC,CAAC,QAAQ,EAAE;IACzE,QAAQ,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,QAAQ,EAAE;CACvD,CAAC,CAAA"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@lokalise/ragnarok-api-contracts",
3
- "version": "2.0.0",
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.3.15",
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.5.3"
48
+ "@lokalise/api-contracts": "^6.6.0"
49
49
  }
50
50
  }