@orq-ai/node 3.9.0-rc.0 → 3.9.0-rc.10
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/README.md +93 -85
- package/bin/mcp-server.js +1328 -1113
- package/bin/mcp-server.js.map +50 -44
- package/docs/sdks/datasets/README.md +0 -83
- package/docs/sdks/deployments/README.md +0 -85
- package/docs/sdks/evals/README.md +213 -0
- package/funcs/evalsRagasContextEntitiesRecall.d.ts +15 -0
- package/funcs/evalsRagasContextEntitiesRecall.d.ts.map +1 -0
- package/funcs/evalsRagasContextEntitiesRecall.js +118 -0
- package/funcs/evalsRagasContextEntitiesRecall.js.map +1 -0
- package/funcs/evalsRagasContextRecall.d.ts +15 -0
- package/funcs/evalsRagasContextRecall.d.ts.map +1 -0
- package/funcs/{deploymentsCreateExperiment.js → evalsRagasContextRecall.js} +17 -19
- package/funcs/evalsRagasContextRecall.js.map +1 -0
- package/funcs/evalsRagasNoiseSensitivity.d.ts +15 -0
- package/funcs/evalsRagasNoiseSensitivity.d.ts.map +1 -0
- package/funcs/{datasetsCreateExperiment.js → evalsRagasNoiseSensitivity.js} +17 -19
- package/funcs/evalsRagasNoiseSensitivity.js.map +1 -0
- package/jsr.json +1 -1
- package/lib/config.d.ts +3 -3
- package/lib/config.js +3 -3
- package/lib/config.js.map +1 -1
- package/mcp-server/mcp-server.js +1 -1
- package/mcp-server/mcp-server.js.map +1 -1
- package/mcp-server/server.d.ts.map +1 -1
- package/mcp-server/server.js +7 -5
- package/mcp-server/server.js.map +1 -1
- package/mcp-server/tools/evalsRagasContextEntitiesRecall.d.ts +8 -0
- package/mcp-server/tools/evalsRagasContextEntitiesRecall.d.ts.map +1 -0
- package/mcp-server/tools/evalsRagasContextEntitiesRecall.js +63 -0
- package/mcp-server/tools/evalsRagasContextEntitiesRecall.js.map +1 -0
- package/mcp-server/tools/evalsRagasContextRecall.d.ts +8 -0
- package/mcp-server/tools/evalsRagasContextRecall.d.ts.map +1 -0
- package/mcp-server/tools/{datasetsCreateExperiment.js → evalsRagasContextRecall.js} +9 -10
- package/mcp-server/tools/evalsRagasContextRecall.js.map +1 -0
- package/mcp-server/tools/evalsRagasNoiseSensitivity.d.ts +8 -0
- package/mcp-server/tools/evalsRagasNoiseSensitivity.d.ts.map +1 -0
- package/mcp-server/tools/{deploymentsCreateExperiment.js → evalsRagasNoiseSensitivity.js} +9 -10
- package/mcp-server/tools/evalsRagasNoiseSensitivity.js.map +1 -0
- package/models/errors/evalsragascontextentitiesrecall.d.ts +79 -0
- package/models/errors/evalsragascontextentitiesrecall.d.ts.map +1 -0
- package/models/errors/evalsragascontextentitiesrecall.js +132 -0
- package/models/errors/evalsragascontextentitiesrecall.js.map +1 -0
- package/models/errors/evalsragascontextrecall.d.ts +79 -0
- package/models/errors/evalsragascontextrecall.d.ts.map +1 -0
- package/models/errors/evalsragascontextrecall.js +132 -0
- package/models/errors/evalsragascontextrecall.js.map +1 -0
- package/models/errors/evalsragasnoisesensitivity.d.ts +79 -0
- package/models/errors/evalsragasnoisesensitivity.d.ts.map +1 -0
- package/models/errors/evalsragasnoisesensitivity.js +132 -0
- package/models/errors/evalsragasnoisesensitivity.js.map +1 -0
- package/models/errors/index.d.ts +3 -0
- package/models/errors/index.d.ts.map +1 -1
- package/models/errors/index.js +3 -0
- package/models/errors/index.js.map +1 -1
- package/models/operations/createcontact.js +2 -2
- package/models/operations/createdataset.js +2 -2
- package/models/operations/createdatasetitem.js +2 -2
- package/models/operations/createdatasource.js +2 -2
- package/models/operations/createeval.js +16 -16
- package/models/operations/createprompt.d.ts +6 -0
- package/models/operations/createprompt.d.ts.map +1 -1
- package/models/operations/createprompt.js +2 -0
- package/models/operations/createprompt.js.map +1 -1
- package/models/operations/deploymentgetconfig.d.ts +3 -0
- package/models/operations/deploymentgetconfig.d.ts.map +1 -1
- package/models/operations/deploymentgetconfig.js +1 -0
- package/models/operations/deploymentgetconfig.js.map +1 -1
- package/models/operations/deployments.d.ts +3 -0
- package/models/operations/deployments.d.ts.map +1 -1
- package/models/operations/deployments.js +1 -0
- package/models/operations/deployments.js.map +1 -1
- package/models/operations/evalsragascontextentitiesrecall.d.ts +67 -0
- package/models/operations/evalsragascontextentitiesrecall.d.ts.map +1 -0
- package/models/operations/evalsragascontextentitiesrecall.js +100 -0
- package/models/operations/evalsragascontextentitiesrecall.js.map +1 -0
- package/models/operations/evalsragascontextrecall.d.ts +77 -0
- package/models/operations/evalsragascontextrecall.d.ts.map +1 -0
- package/models/operations/evalsragascontextrecall.js +104 -0
- package/models/operations/evalsragascontextrecall.js.map +1 -0
- package/models/operations/evalsragasnoisesensitivity.d.ts +77 -0
- package/models/operations/evalsragasnoisesensitivity.d.ts.map +1 -0
- package/models/operations/evalsragasnoisesensitivity.js +104 -0
- package/models/operations/evalsragasnoisesensitivity.js.map +1 -0
- package/models/operations/fileget.js +2 -2
- package/models/operations/filelist.js +2 -2
- package/models/operations/fileupload.js +2 -2
- package/models/operations/getallprompts.d.ts +3 -0
- package/models/operations/getallprompts.d.ts.map +1 -1
- package/models/operations/getallprompts.js +1 -0
- package/models/operations/getallprompts.js.map +1 -1
- package/models/operations/getevals.d.ts +3 -0
- package/models/operations/getevals.d.ts.map +1 -1
- package/models/operations/getevals.js +29 -28
- package/models/operations/getevals.js.map +1 -1
- package/models/operations/getoneprompt.d.ts +3 -0
- package/models/operations/getoneprompt.d.ts.map +1 -1
- package/models/operations/getoneprompt.js +1 -0
- package/models/operations/getoneprompt.js.map +1 -1
- package/models/operations/getpromptversion.d.ts +3 -0
- package/models/operations/getpromptversion.d.ts.map +1 -1
- package/models/operations/getpromptversion.js +1 -0
- package/models/operations/getpromptversion.js.map +1 -1
- package/models/operations/index.d.ts +3 -2
- package/models/operations/index.d.ts.map +1 -1
- package/models/operations/index.js +3 -2
- package/models/operations/index.js.map +1 -1
- package/models/operations/listcontacts.js +2 -2
- package/models/operations/listdatasetdatapoints.js +2 -2
- package/models/operations/listdatasets.js +2 -2
- package/models/operations/listdatasources.js +2 -2
- package/models/operations/listpromptversions.d.ts +3 -0
- package/models/operations/listpromptversions.d.ts.map +1 -1
- package/models/operations/listpromptversions.js +1 -0
- package/models/operations/listpromptversions.js.map +1 -1
- package/models/operations/retrievecontact.js +2 -2
- package/models/operations/retrievedatapoint.js +2 -2
- package/models/operations/retrievedataset.js +2 -2
- package/models/operations/retrievedatasource.js +2 -2
- package/models/operations/updatecontact.js +2 -2
- package/models/operations/updatedatapoint.js +2 -2
- package/models/operations/updatedataset.js +2 -2
- package/models/operations/updatedatasource.js +2 -2
- package/models/operations/updateeval.js +16 -16
- package/models/operations/updateprompt.d.ts +6 -0
- package/models/operations/updateprompt.d.ts.map +1 -1
- package/models/operations/updateprompt.js +2 -0
- package/models/operations/updateprompt.js.map +1 -1
- package/package.json +1 -1
- package/sdk/datasets.d.ts +0 -7
- package/sdk/datasets.d.ts.map +1 -1
- package/sdk/datasets.js +0 -10
- package/sdk/datasets.js.map +1 -1
- package/sdk/deployments.d.ts +0 -7
- package/sdk/deployments.d.ts.map +1 -1
- package/sdk/deployments.js +0 -10
- package/sdk/deployments.js.map +1 -1
- package/sdk/evals.d.ts +12 -0
- package/sdk/evals.d.ts.map +1 -1
- package/sdk/evals.js +21 -0
- package/sdk/evals.js.map +1 -1
- package/src/funcs/evalsRagasContextEntitiesRecall.ts +183 -0
- package/src/funcs/{datasetsCreateExperiment.ts → evalsRagasContextRecall.ts} +34 -25
- package/src/funcs/{deploymentsCreateExperiment.ts → evalsRagasNoiseSensitivity.ts} +34 -27
- package/src/lib/config.ts +3 -3
- package/src/mcp-server/mcp-server.ts +1 -1
- package/src/mcp-server/server.ts +7 -5
- package/src/mcp-server/tools/evalsRagasContextEntitiesRecall.ts +37 -0
- package/src/mcp-server/tools/{datasetsCreateExperiment.ts → evalsRagasContextRecall.ts} +7 -8
- package/src/mcp-server/tools/{deploymentsCreateExperiment.ts → evalsRagasNoiseSensitivity.ts} +7 -8
- package/src/models/errors/evalsragascontextentitiesrecall.ts +167 -0
- package/src/models/errors/evalsragascontextrecall.ts +162 -0
- package/src/models/errors/evalsragasnoisesensitivity.ts +164 -0
- package/src/models/errors/index.ts +3 -0
- package/src/models/operations/createcontact.ts +2 -2
- package/src/models/operations/createdataset.ts +2 -2
- package/src/models/operations/createdatasetitem.ts +2 -2
- package/src/models/operations/createdatasource.ts +2 -2
- package/src/models/operations/createeval.ts +16 -16
- package/src/models/operations/createprompt.ts +2 -0
- package/src/models/operations/deploymentgetconfig.ts +1 -0
- package/src/models/operations/deployments.ts +1 -0
- package/src/models/operations/evalsragascontextentitiesrecall.ts +164 -0
- package/src/models/operations/evalsragascontextrecall.ts +164 -0
- package/src/models/operations/evalsragasnoisesensitivity.ts +166 -0
- package/src/models/operations/fileget.ts +2 -2
- package/src/models/operations/filelist.ts +2 -2
- package/src/models/operations/fileupload.ts +2 -2
- package/src/models/operations/getallprompts.ts +1 -0
- package/src/models/operations/getevals.ts +29 -28
- package/src/models/operations/getoneprompt.ts +1 -0
- package/src/models/operations/getpromptversion.ts +1 -0
- package/src/models/operations/index.ts +3 -2
- package/src/models/operations/listcontacts.ts +2 -2
- package/src/models/operations/listdatasetdatapoints.ts +2 -2
- package/src/models/operations/listdatasets.ts +2 -2
- package/src/models/operations/listdatasources.ts +2 -2
- package/src/models/operations/listpromptversions.ts +1 -0
- package/src/models/operations/retrievecontact.ts +2 -2
- package/src/models/operations/retrievedatapoint.ts +2 -2
- package/src/models/operations/retrievedataset.ts +2 -2
- package/src/models/operations/retrievedatasource.ts +2 -2
- package/src/models/operations/updatecontact.ts +2 -2
- package/src/models/operations/updatedatapoint.ts +2 -2
- package/src/models/operations/updatedataset.ts +2 -2
- package/src/models/operations/updatedatasource.ts +2 -2
- package/src/models/operations/updateeval.ts +16 -16
- package/src/models/operations/updateprompt.ts +2 -0
- package/src/sdk/datasets.ts +0 -18
- package/src/sdk/deployments.ts +0 -18
- package/src/sdk/evals.ts +45 -0
- package/funcs/datasetsCreateExperiment.d.ts +0 -17
- package/funcs/datasetsCreateExperiment.d.ts.map +0 -1
- package/funcs/datasetsCreateExperiment.js.map +0 -1
- package/funcs/deploymentsCreateExperiment.d.ts +0 -17
- package/funcs/deploymentsCreateExperiment.d.ts.map +0 -1
- package/funcs/deploymentsCreateExperiment.js.map +0 -1
- package/mcp-server/tools/datasetsCreateExperiment.d.ts +0 -8
- package/mcp-server/tools/datasetsCreateExperiment.d.ts.map +0 -1
- package/mcp-server/tools/datasetsCreateExperiment.js.map +0 -1
- package/mcp-server/tools/deploymentsCreateExperiment.d.ts +0 -8
- package/mcp-server/tools/deploymentsCreateExperiment.d.ts.map +0 -1
- package/mcp-server/tools/deploymentsCreateExperiment.js.map +0 -1
- package/models/operations/createdatasetexperiment.d.ts +0 -140
- package/models/operations/createdatasetexperiment.d.ts.map +0 -1
- package/models/operations/createdatasetexperiment.js +0 -188
- package/models/operations/createdatasetexperiment.js.map +0 -1
- package/models/operations/createdeploymentexperiment.d.ts +0 -152
- package/models/operations/createdeploymentexperiment.d.ts.map +0 -1
- package/models/operations/createdeploymentexperiment.js +0 -189
- package/models/operations/createdeploymentexperiment.js.map +0 -1
- package/src/models/operations/createdatasetexperiment.ts +0 -307
- package/src/models/operations/createdeploymentexperiment.ts +0 -321
|
@@ -1492,6 +1492,7 @@ export type DeploymentGetConfigEncodingFormat = ClosedEnum<
|
|
|
1492
1492
|
* Constrains effort on reasoning for reasoning models. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.
|
|
1493
1493
|
*/
|
|
1494
1494
|
export const DeploymentGetConfigReasoningEffort = {
|
|
1495
|
+
Disable: "disable",
|
|
1495
1496
|
Low: "low",
|
|
1496
1497
|
Medium: "medium",
|
|
1497
1498
|
High: "high",
|
|
@@ -199,6 +199,7 @@ export type DeploymentsEncodingFormat = ClosedEnum<
|
|
|
199
199
|
* Constrains effort on reasoning for reasoning models. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.
|
|
200
200
|
*/
|
|
201
201
|
export const DeploymentsReasoningEffort = {
|
|
202
|
+
Disable: "disable",
|
|
202
203
|
Low: "low",
|
|
203
204
|
Medium: "medium",
|
|
204
205
|
High: "high",
|
|
@@ -0,0 +1,164 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
|
3
|
+
*/
|
|
4
|
+
|
|
5
|
+
import * as z from "zod";
|
|
6
|
+
import { safeParse } from "../../lib/schemas.js";
|
|
7
|
+
import { Result as SafeParseResult } from "../../types/fp.js";
|
|
8
|
+
import { SDKValidationError } from "../errors/sdkvalidationerror.js";
|
|
9
|
+
|
|
10
|
+
export type EvalsRagasContextEntitiesRecallRequestBody = {
|
|
11
|
+
/**
|
|
12
|
+
* The ground truth answer to evaluate entity recall against
|
|
13
|
+
*/
|
|
14
|
+
reference: string;
|
|
15
|
+
/**
|
|
16
|
+
* Knowledge base retrievals containing entities to evaluate
|
|
17
|
+
*/
|
|
18
|
+
retrievals?: Array<string> | undefined;
|
|
19
|
+
model: string;
|
|
20
|
+
};
|
|
21
|
+
|
|
22
|
+
/**
|
|
23
|
+
* Returns the context entities recall evaluation result
|
|
24
|
+
*/
|
|
25
|
+
export type EvalsRagasContextEntitiesRecallResponseBody = {
|
|
26
|
+
value: number | null;
|
|
27
|
+
};
|
|
28
|
+
|
|
29
|
+
/** @internal */
|
|
30
|
+
export const EvalsRagasContextEntitiesRecallRequestBody$inboundSchema:
|
|
31
|
+
z.ZodType<EvalsRagasContextEntitiesRecallRequestBody, z.ZodTypeDef, unknown> =
|
|
32
|
+
z.object({
|
|
33
|
+
reference: z.string(),
|
|
34
|
+
retrievals: z.array(z.string()).optional(),
|
|
35
|
+
model: z.string(),
|
|
36
|
+
});
|
|
37
|
+
|
|
38
|
+
/** @internal */
|
|
39
|
+
export type EvalsRagasContextEntitiesRecallRequestBody$Outbound = {
|
|
40
|
+
reference: string;
|
|
41
|
+
retrievals?: Array<string> | undefined;
|
|
42
|
+
model: string;
|
|
43
|
+
};
|
|
44
|
+
|
|
45
|
+
/** @internal */
|
|
46
|
+
export const EvalsRagasContextEntitiesRecallRequestBody$outboundSchema:
|
|
47
|
+
z.ZodType<
|
|
48
|
+
EvalsRagasContextEntitiesRecallRequestBody$Outbound,
|
|
49
|
+
z.ZodTypeDef,
|
|
50
|
+
EvalsRagasContextEntitiesRecallRequestBody
|
|
51
|
+
> = z.object({
|
|
52
|
+
reference: z.string(),
|
|
53
|
+
retrievals: z.array(z.string()).optional(),
|
|
54
|
+
model: z.string(),
|
|
55
|
+
});
|
|
56
|
+
|
|
57
|
+
/**
|
|
58
|
+
* @internal
|
|
59
|
+
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
|
|
60
|
+
*/
|
|
61
|
+
export namespace EvalsRagasContextEntitiesRecallRequestBody$ {
|
|
62
|
+
/** @deprecated use `EvalsRagasContextEntitiesRecallRequestBody$inboundSchema` instead. */
|
|
63
|
+
export const inboundSchema =
|
|
64
|
+
EvalsRagasContextEntitiesRecallRequestBody$inboundSchema;
|
|
65
|
+
/** @deprecated use `EvalsRagasContextEntitiesRecallRequestBody$outboundSchema` instead. */
|
|
66
|
+
export const outboundSchema =
|
|
67
|
+
EvalsRagasContextEntitiesRecallRequestBody$outboundSchema;
|
|
68
|
+
/** @deprecated use `EvalsRagasContextEntitiesRecallRequestBody$Outbound` instead. */
|
|
69
|
+
export type Outbound = EvalsRagasContextEntitiesRecallRequestBody$Outbound;
|
|
70
|
+
}
|
|
71
|
+
|
|
72
|
+
export function evalsRagasContextEntitiesRecallRequestBodyToJSON(
|
|
73
|
+
evalsRagasContextEntitiesRecallRequestBody:
|
|
74
|
+
EvalsRagasContextEntitiesRecallRequestBody,
|
|
75
|
+
): string {
|
|
76
|
+
return JSON.stringify(
|
|
77
|
+
EvalsRagasContextEntitiesRecallRequestBody$outboundSchema.parse(
|
|
78
|
+
evalsRagasContextEntitiesRecallRequestBody,
|
|
79
|
+
),
|
|
80
|
+
);
|
|
81
|
+
}
|
|
82
|
+
|
|
83
|
+
export function evalsRagasContextEntitiesRecallRequestBodyFromJSON(
|
|
84
|
+
jsonString: string,
|
|
85
|
+
): SafeParseResult<
|
|
86
|
+
EvalsRagasContextEntitiesRecallRequestBody,
|
|
87
|
+
SDKValidationError
|
|
88
|
+
> {
|
|
89
|
+
return safeParse(
|
|
90
|
+
jsonString,
|
|
91
|
+
(x) =>
|
|
92
|
+
EvalsRagasContextEntitiesRecallRequestBody$inboundSchema.parse(
|
|
93
|
+
JSON.parse(x),
|
|
94
|
+
),
|
|
95
|
+
`Failed to parse 'EvalsRagasContextEntitiesRecallRequestBody' from JSON`,
|
|
96
|
+
);
|
|
97
|
+
}
|
|
98
|
+
|
|
99
|
+
/** @internal */
|
|
100
|
+
export const EvalsRagasContextEntitiesRecallResponseBody$inboundSchema:
|
|
101
|
+
z.ZodType<
|
|
102
|
+
EvalsRagasContextEntitiesRecallResponseBody,
|
|
103
|
+
z.ZodTypeDef,
|
|
104
|
+
unknown
|
|
105
|
+
> = z.object({
|
|
106
|
+
value: z.nullable(z.number()),
|
|
107
|
+
});
|
|
108
|
+
|
|
109
|
+
/** @internal */
|
|
110
|
+
export type EvalsRagasContextEntitiesRecallResponseBody$Outbound = {
|
|
111
|
+
value: number | null;
|
|
112
|
+
};
|
|
113
|
+
|
|
114
|
+
/** @internal */
|
|
115
|
+
export const EvalsRagasContextEntitiesRecallResponseBody$outboundSchema:
|
|
116
|
+
z.ZodType<
|
|
117
|
+
EvalsRagasContextEntitiesRecallResponseBody$Outbound,
|
|
118
|
+
z.ZodTypeDef,
|
|
119
|
+
EvalsRagasContextEntitiesRecallResponseBody
|
|
120
|
+
> = z.object({
|
|
121
|
+
value: z.nullable(z.number()),
|
|
122
|
+
});
|
|
123
|
+
|
|
124
|
+
/**
|
|
125
|
+
* @internal
|
|
126
|
+
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
|
|
127
|
+
*/
|
|
128
|
+
export namespace EvalsRagasContextEntitiesRecallResponseBody$ {
|
|
129
|
+
/** @deprecated use `EvalsRagasContextEntitiesRecallResponseBody$inboundSchema` instead. */
|
|
130
|
+
export const inboundSchema =
|
|
131
|
+
EvalsRagasContextEntitiesRecallResponseBody$inboundSchema;
|
|
132
|
+
/** @deprecated use `EvalsRagasContextEntitiesRecallResponseBody$outboundSchema` instead. */
|
|
133
|
+
export const outboundSchema =
|
|
134
|
+
EvalsRagasContextEntitiesRecallResponseBody$outboundSchema;
|
|
135
|
+
/** @deprecated use `EvalsRagasContextEntitiesRecallResponseBody$Outbound` instead. */
|
|
136
|
+
export type Outbound = EvalsRagasContextEntitiesRecallResponseBody$Outbound;
|
|
137
|
+
}
|
|
138
|
+
|
|
139
|
+
export function evalsRagasContextEntitiesRecallResponseBodyToJSON(
|
|
140
|
+
evalsRagasContextEntitiesRecallResponseBody:
|
|
141
|
+
EvalsRagasContextEntitiesRecallResponseBody,
|
|
142
|
+
): string {
|
|
143
|
+
return JSON.stringify(
|
|
144
|
+
EvalsRagasContextEntitiesRecallResponseBody$outboundSchema.parse(
|
|
145
|
+
evalsRagasContextEntitiesRecallResponseBody,
|
|
146
|
+
),
|
|
147
|
+
);
|
|
148
|
+
}
|
|
149
|
+
|
|
150
|
+
export function evalsRagasContextEntitiesRecallResponseBodyFromJSON(
|
|
151
|
+
jsonString: string,
|
|
152
|
+
): SafeParseResult<
|
|
153
|
+
EvalsRagasContextEntitiesRecallResponseBody,
|
|
154
|
+
SDKValidationError
|
|
155
|
+
> {
|
|
156
|
+
return safeParse(
|
|
157
|
+
jsonString,
|
|
158
|
+
(x) =>
|
|
159
|
+
EvalsRagasContextEntitiesRecallResponseBody$inboundSchema.parse(
|
|
160
|
+
JSON.parse(x),
|
|
161
|
+
),
|
|
162
|
+
`Failed to parse 'EvalsRagasContextEntitiesRecallResponseBody' from JSON`,
|
|
163
|
+
);
|
|
164
|
+
}
|
|
@@ -0,0 +1,164 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
|
3
|
+
*/
|
|
4
|
+
|
|
5
|
+
import * as z from "zod";
|
|
6
|
+
import { safeParse } from "../../lib/schemas.js";
|
|
7
|
+
import { Result as SafeParseResult } from "../../types/fp.js";
|
|
8
|
+
import { SDKValidationError } from "../errors/sdkvalidationerror.js";
|
|
9
|
+
|
|
10
|
+
export type EvalsRagasContextRecallRequestBody = {
|
|
11
|
+
/**
|
|
12
|
+
* Latest user message
|
|
13
|
+
*/
|
|
14
|
+
query?: string | undefined;
|
|
15
|
+
/**
|
|
16
|
+
* The generated response from the model
|
|
17
|
+
*/
|
|
18
|
+
output?: string | undefined;
|
|
19
|
+
model: string;
|
|
20
|
+
/**
|
|
21
|
+
* The ground truth answer to evaluate context recall against
|
|
22
|
+
*/
|
|
23
|
+
reference: string;
|
|
24
|
+
/**
|
|
25
|
+
* Knowledge base retrievals
|
|
26
|
+
*/
|
|
27
|
+
retrievals?: Array<string> | undefined;
|
|
28
|
+
};
|
|
29
|
+
|
|
30
|
+
/**
|
|
31
|
+
* Returns the context recall evaluation result
|
|
32
|
+
*/
|
|
33
|
+
export type EvalsRagasContextRecallResponseBody = {
|
|
34
|
+
value: number | null;
|
|
35
|
+
};
|
|
36
|
+
|
|
37
|
+
/** @internal */
|
|
38
|
+
export const EvalsRagasContextRecallRequestBody$inboundSchema: z.ZodType<
|
|
39
|
+
EvalsRagasContextRecallRequestBody,
|
|
40
|
+
z.ZodTypeDef,
|
|
41
|
+
unknown
|
|
42
|
+
> = z.object({
|
|
43
|
+
query: z.string().optional(),
|
|
44
|
+
output: z.string().optional(),
|
|
45
|
+
model: z.string(),
|
|
46
|
+
reference: z.string(),
|
|
47
|
+
retrievals: z.array(z.string()).optional(),
|
|
48
|
+
});
|
|
49
|
+
|
|
50
|
+
/** @internal */
|
|
51
|
+
export type EvalsRagasContextRecallRequestBody$Outbound = {
|
|
52
|
+
query?: string | undefined;
|
|
53
|
+
output?: string | undefined;
|
|
54
|
+
model: string;
|
|
55
|
+
reference: string;
|
|
56
|
+
retrievals?: Array<string> | undefined;
|
|
57
|
+
};
|
|
58
|
+
|
|
59
|
+
/** @internal */
|
|
60
|
+
export const EvalsRagasContextRecallRequestBody$outboundSchema: z.ZodType<
|
|
61
|
+
EvalsRagasContextRecallRequestBody$Outbound,
|
|
62
|
+
z.ZodTypeDef,
|
|
63
|
+
EvalsRagasContextRecallRequestBody
|
|
64
|
+
> = z.object({
|
|
65
|
+
query: z.string().optional(),
|
|
66
|
+
output: z.string().optional(),
|
|
67
|
+
model: z.string(),
|
|
68
|
+
reference: z.string(),
|
|
69
|
+
retrievals: z.array(z.string()).optional(),
|
|
70
|
+
});
|
|
71
|
+
|
|
72
|
+
/**
|
|
73
|
+
* @internal
|
|
74
|
+
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
|
|
75
|
+
*/
|
|
76
|
+
export namespace EvalsRagasContextRecallRequestBody$ {
|
|
77
|
+
/** @deprecated use `EvalsRagasContextRecallRequestBody$inboundSchema` instead. */
|
|
78
|
+
export const inboundSchema = EvalsRagasContextRecallRequestBody$inboundSchema;
|
|
79
|
+
/** @deprecated use `EvalsRagasContextRecallRequestBody$outboundSchema` instead. */
|
|
80
|
+
export const outboundSchema =
|
|
81
|
+
EvalsRagasContextRecallRequestBody$outboundSchema;
|
|
82
|
+
/** @deprecated use `EvalsRagasContextRecallRequestBody$Outbound` instead. */
|
|
83
|
+
export type Outbound = EvalsRagasContextRecallRequestBody$Outbound;
|
|
84
|
+
}
|
|
85
|
+
|
|
86
|
+
export function evalsRagasContextRecallRequestBodyToJSON(
|
|
87
|
+
evalsRagasContextRecallRequestBody: EvalsRagasContextRecallRequestBody,
|
|
88
|
+
): string {
|
|
89
|
+
return JSON.stringify(
|
|
90
|
+
EvalsRagasContextRecallRequestBody$outboundSchema.parse(
|
|
91
|
+
evalsRagasContextRecallRequestBody,
|
|
92
|
+
),
|
|
93
|
+
);
|
|
94
|
+
}
|
|
95
|
+
|
|
96
|
+
export function evalsRagasContextRecallRequestBodyFromJSON(
|
|
97
|
+
jsonString: string,
|
|
98
|
+
): SafeParseResult<EvalsRagasContextRecallRequestBody, SDKValidationError> {
|
|
99
|
+
return safeParse(
|
|
100
|
+
jsonString,
|
|
101
|
+
(x) =>
|
|
102
|
+
EvalsRagasContextRecallRequestBody$inboundSchema.parse(JSON.parse(x)),
|
|
103
|
+
`Failed to parse 'EvalsRagasContextRecallRequestBody' from JSON`,
|
|
104
|
+
);
|
|
105
|
+
}
|
|
106
|
+
|
|
107
|
+
/** @internal */
|
|
108
|
+
export const EvalsRagasContextRecallResponseBody$inboundSchema: z.ZodType<
|
|
109
|
+
EvalsRagasContextRecallResponseBody,
|
|
110
|
+
z.ZodTypeDef,
|
|
111
|
+
unknown
|
|
112
|
+
> = z.object({
|
|
113
|
+
value: z.nullable(z.number()),
|
|
114
|
+
});
|
|
115
|
+
|
|
116
|
+
/** @internal */
|
|
117
|
+
export type EvalsRagasContextRecallResponseBody$Outbound = {
|
|
118
|
+
value: number | null;
|
|
119
|
+
};
|
|
120
|
+
|
|
121
|
+
/** @internal */
|
|
122
|
+
export const EvalsRagasContextRecallResponseBody$outboundSchema: z.ZodType<
|
|
123
|
+
EvalsRagasContextRecallResponseBody$Outbound,
|
|
124
|
+
z.ZodTypeDef,
|
|
125
|
+
EvalsRagasContextRecallResponseBody
|
|
126
|
+
> = z.object({
|
|
127
|
+
value: z.nullable(z.number()),
|
|
128
|
+
});
|
|
129
|
+
|
|
130
|
+
/**
|
|
131
|
+
* @internal
|
|
132
|
+
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
|
|
133
|
+
*/
|
|
134
|
+
export namespace EvalsRagasContextRecallResponseBody$ {
|
|
135
|
+
/** @deprecated use `EvalsRagasContextRecallResponseBody$inboundSchema` instead. */
|
|
136
|
+
export const inboundSchema =
|
|
137
|
+
EvalsRagasContextRecallResponseBody$inboundSchema;
|
|
138
|
+
/** @deprecated use `EvalsRagasContextRecallResponseBody$outboundSchema` instead. */
|
|
139
|
+
export const outboundSchema =
|
|
140
|
+
EvalsRagasContextRecallResponseBody$outboundSchema;
|
|
141
|
+
/** @deprecated use `EvalsRagasContextRecallResponseBody$Outbound` instead. */
|
|
142
|
+
export type Outbound = EvalsRagasContextRecallResponseBody$Outbound;
|
|
143
|
+
}
|
|
144
|
+
|
|
145
|
+
export function evalsRagasContextRecallResponseBodyToJSON(
|
|
146
|
+
evalsRagasContextRecallResponseBody: EvalsRagasContextRecallResponseBody,
|
|
147
|
+
): string {
|
|
148
|
+
return JSON.stringify(
|
|
149
|
+
EvalsRagasContextRecallResponseBody$outboundSchema.parse(
|
|
150
|
+
evalsRagasContextRecallResponseBody,
|
|
151
|
+
),
|
|
152
|
+
);
|
|
153
|
+
}
|
|
154
|
+
|
|
155
|
+
export function evalsRagasContextRecallResponseBodyFromJSON(
|
|
156
|
+
jsonString: string,
|
|
157
|
+
): SafeParseResult<EvalsRagasContextRecallResponseBody, SDKValidationError> {
|
|
158
|
+
return safeParse(
|
|
159
|
+
jsonString,
|
|
160
|
+
(x) =>
|
|
161
|
+
EvalsRagasContextRecallResponseBody$inboundSchema.parse(JSON.parse(x)),
|
|
162
|
+
`Failed to parse 'EvalsRagasContextRecallResponseBody' from JSON`,
|
|
163
|
+
);
|
|
164
|
+
}
|
|
@@ -0,0 +1,166 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
|
3
|
+
*/
|
|
4
|
+
|
|
5
|
+
import * as z from "zod";
|
|
6
|
+
import { safeParse } from "../../lib/schemas.js";
|
|
7
|
+
import { Result as SafeParseResult } from "../../types/fp.js";
|
|
8
|
+
import { SDKValidationError } from "../errors/sdkvalidationerror.js";
|
|
9
|
+
|
|
10
|
+
export type EvalsRagasNoiseSensitivityRequestBody = {
|
|
11
|
+
/**
|
|
12
|
+
* Latest user message
|
|
13
|
+
*/
|
|
14
|
+
query: string;
|
|
15
|
+
/**
|
|
16
|
+
* The generated response from the model
|
|
17
|
+
*/
|
|
18
|
+
output: string;
|
|
19
|
+
model: string;
|
|
20
|
+
/**
|
|
21
|
+
* The ground truth answer to evaluate noise sensitivity against
|
|
22
|
+
*/
|
|
23
|
+
reference: string;
|
|
24
|
+
/**
|
|
25
|
+
* Knowledge base retrievals that may contain irrelevant information
|
|
26
|
+
*/
|
|
27
|
+
retrievals?: Array<string> | undefined;
|
|
28
|
+
};
|
|
29
|
+
|
|
30
|
+
/**
|
|
31
|
+
* Returns the noise sensitivity evaluation result
|
|
32
|
+
*/
|
|
33
|
+
export type EvalsRagasNoiseSensitivityResponseBody = {
|
|
34
|
+
value: number | null;
|
|
35
|
+
};
|
|
36
|
+
|
|
37
|
+
/** @internal */
|
|
38
|
+
export const EvalsRagasNoiseSensitivityRequestBody$inboundSchema: z.ZodType<
|
|
39
|
+
EvalsRagasNoiseSensitivityRequestBody,
|
|
40
|
+
z.ZodTypeDef,
|
|
41
|
+
unknown
|
|
42
|
+
> = z.object({
|
|
43
|
+
query: z.string(),
|
|
44
|
+
output: z.string(),
|
|
45
|
+
model: z.string(),
|
|
46
|
+
reference: z.string(),
|
|
47
|
+
retrievals: z.array(z.string()).optional(),
|
|
48
|
+
});
|
|
49
|
+
|
|
50
|
+
/** @internal */
|
|
51
|
+
export type EvalsRagasNoiseSensitivityRequestBody$Outbound = {
|
|
52
|
+
query: string;
|
|
53
|
+
output: string;
|
|
54
|
+
model: string;
|
|
55
|
+
reference: string;
|
|
56
|
+
retrievals?: Array<string> | undefined;
|
|
57
|
+
};
|
|
58
|
+
|
|
59
|
+
/** @internal */
|
|
60
|
+
export const EvalsRagasNoiseSensitivityRequestBody$outboundSchema: z.ZodType<
|
|
61
|
+
EvalsRagasNoiseSensitivityRequestBody$Outbound,
|
|
62
|
+
z.ZodTypeDef,
|
|
63
|
+
EvalsRagasNoiseSensitivityRequestBody
|
|
64
|
+
> = z.object({
|
|
65
|
+
query: z.string(),
|
|
66
|
+
output: z.string(),
|
|
67
|
+
model: z.string(),
|
|
68
|
+
reference: z.string(),
|
|
69
|
+
retrievals: z.array(z.string()).optional(),
|
|
70
|
+
});
|
|
71
|
+
|
|
72
|
+
/**
|
|
73
|
+
* @internal
|
|
74
|
+
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
|
|
75
|
+
*/
|
|
76
|
+
export namespace EvalsRagasNoiseSensitivityRequestBody$ {
|
|
77
|
+
/** @deprecated use `EvalsRagasNoiseSensitivityRequestBody$inboundSchema` instead. */
|
|
78
|
+
export const inboundSchema =
|
|
79
|
+
EvalsRagasNoiseSensitivityRequestBody$inboundSchema;
|
|
80
|
+
/** @deprecated use `EvalsRagasNoiseSensitivityRequestBody$outboundSchema` instead. */
|
|
81
|
+
export const outboundSchema =
|
|
82
|
+
EvalsRagasNoiseSensitivityRequestBody$outboundSchema;
|
|
83
|
+
/** @deprecated use `EvalsRagasNoiseSensitivityRequestBody$Outbound` instead. */
|
|
84
|
+
export type Outbound = EvalsRagasNoiseSensitivityRequestBody$Outbound;
|
|
85
|
+
}
|
|
86
|
+
|
|
87
|
+
export function evalsRagasNoiseSensitivityRequestBodyToJSON(
|
|
88
|
+
evalsRagasNoiseSensitivityRequestBody: EvalsRagasNoiseSensitivityRequestBody,
|
|
89
|
+
): string {
|
|
90
|
+
return JSON.stringify(
|
|
91
|
+
EvalsRagasNoiseSensitivityRequestBody$outboundSchema.parse(
|
|
92
|
+
evalsRagasNoiseSensitivityRequestBody,
|
|
93
|
+
),
|
|
94
|
+
);
|
|
95
|
+
}
|
|
96
|
+
|
|
97
|
+
export function evalsRagasNoiseSensitivityRequestBodyFromJSON(
|
|
98
|
+
jsonString: string,
|
|
99
|
+
): SafeParseResult<EvalsRagasNoiseSensitivityRequestBody, SDKValidationError> {
|
|
100
|
+
return safeParse(
|
|
101
|
+
jsonString,
|
|
102
|
+
(x) =>
|
|
103
|
+
EvalsRagasNoiseSensitivityRequestBody$inboundSchema.parse(JSON.parse(x)),
|
|
104
|
+
`Failed to parse 'EvalsRagasNoiseSensitivityRequestBody' from JSON`,
|
|
105
|
+
);
|
|
106
|
+
}
|
|
107
|
+
|
|
108
|
+
/** @internal */
|
|
109
|
+
export const EvalsRagasNoiseSensitivityResponseBody$inboundSchema: z.ZodType<
|
|
110
|
+
EvalsRagasNoiseSensitivityResponseBody,
|
|
111
|
+
z.ZodTypeDef,
|
|
112
|
+
unknown
|
|
113
|
+
> = z.object({
|
|
114
|
+
value: z.nullable(z.number()),
|
|
115
|
+
});
|
|
116
|
+
|
|
117
|
+
/** @internal */
|
|
118
|
+
export type EvalsRagasNoiseSensitivityResponseBody$Outbound = {
|
|
119
|
+
value: number | null;
|
|
120
|
+
};
|
|
121
|
+
|
|
122
|
+
/** @internal */
|
|
123
|
+
export const EvalsRagasNoiseSensitivityResponseBody$outboundSchema: z.ZodType<
|
|
124
|
+
EvalsRagasNoiseSensitivityResponseBody$Outbound,
|
|
125
|
+
z.ZodTypeDef,
|
|
126
|
+
EvalsRagasNoiseSensitivityResponseBody
|
|
127
|
+
> = z.object({
|
|
128
|
+
value: z.nullable(z.number()),
|
|
129
|
+
});
|
|
130
|
+
|
|
131
|
+
/**
|
|
132
|
+
* @internal
|
|
133
|
+
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
|
|
134
|
+
*/
|
|
135
|
+
export namespace EvalsRagasNoiseSensitivityResponseBody$ {
|
|
136
|
+
/** @deprecated use `EvalsRagasNoiseSensitivityResponseBody$inboundSchema` instead. */
|
|
137
|
+
export const inboundSchema =
|
|
138
|
+
EvalsRagasNoiseSensitivityResponseBody$inboundSchema;
|
|
139
|
+
/** @deprecated use `EvalsRagasNoiseSensitivityResponseBody$outboundSchema` instead. */
|
|
140
|
+
export const outboundSchema =
|
|
141
|
+
EvalsRagasNoiseSensitivityResponseBody$outboundSchema;
|
|
142
|
+
/** @deprecated use `EvalsRagasNoiseSensitivityResponseBody$Outbound` instead. */
|
|
143
|
+
export type Outbound = EvalsRagasNoiseSensitivityResponseBody$Outbound;
|
|
144
|
+
}
|
|
145
|
+
|
|
146
|
+
export function evalsRagasNoiseSensitivityResponseBodyToJSON(
|
|
147
|
+
evalsRagasNoiseSensitivityResponseBody:
|
|
148
|
+
EvalsRagasNoiseSensitivityResponseBody,
|
|
149
|
+
): string {
|
|
150
|
+
return JSON.stringify(
|
|
151
|
+
EvalsRagasNoiseSensitivityResponseBody$outboundSchema.parse(
|
|
152
|
+
evalsRagasNoiseSensitivityResponseBody,
|
|
153
|
+
),
|
|
154
|
+
);
|
|
155
|
+
}
|
|
156
|
+
|
|
157
|
+
export function evalsRagasNoiseSensitivityResponseBodyFromJSON(
|
|
158
|
+
jsonString: string,
|
|
159
|
+
): SafeParseResult<EvalsRagasNoiseSensitivityResponseBody, SDKValidationError> {
|
|
160
|
+
return safeParse(
|
|
161
|
+
jsonString,
|
|
162
|
+
(x) =>
|
|
163
|
+
EvalsRagasNoiseSensitivityResponseBody$inboundSchema.parse(JSON.parse(x)),
|
|
164
|
+
`Failed to parse 'EvalsRagasNoiseSensitivityResponseBody' from JSON`,
|
|
165
|
+
);
|
|
166
|
+
}
|
|
@@ -146,7 +146,7 @@ export const FileGetResponseBody$inboundSchema: z.ZodType<
|
|
|
146
146
|
file_name: z.string(),
|
|
147
147
|
workspace_id: z.string(),
|
|
148
148
|
created: z.string().datetime({ offset: true }).default(
|
|
149
|
-
"2025-06-
|
|
149
|
+
"2025-06-30T13:00:29.711Z",
|
|
150
150
|
).transform(v => new Date(v)),
|
|
151
151
|
}).transform((v) => {
|
|
152
152
|
return remap$(v, {
|
|
@@ -180,7 +180,7 @@ export const FileGetResponseBody$outboundSchema: z.ZodType<
|
|
|
180
180
|
bytes: z.number(),
|
|
181
181
|
fileName: z.string(),
|
|
182
182
|
workspaceId: z.string(),
|
|
183
|
-
created: z.date().default(() => new Date("2025-06-
|
|
183
|
+
created: z.date().default(() => new Date("2025-06-30T13:00:29.711Z"))
|
|
184
184
|
.transform(v => v.toISOString()),
|
|
185
185
|
}).transform((v) => {
|
|
186
186
|
return remap$(v, {
|
|
@@ -196,7 +196,7 @@ export const FileListData$inboundSchema: z.ZodType<
|
|
|
196
196
|
file_name: z.string(),
|
|
197
197
|
workspace_id: z.string(),
|
|
198
198
|
created: z.string().datetime({ offset: true }).default(
|
|
199
|
-
"2025-06-
|
|
199
|
+
"2025-06-30T13:00:29.711Z",
|
|
200
200
|
).transform(v => new Date(v)),
|
|
201
201
|
}).transform((v) => {
|
|
202
202
|
return remap$(v, {
|
|
@@ -230,7 +230,7 @@ export const FileListData$outboundSchema: z.ZodType<
|
|
|
230
230
|
bytes: z.number(),
|
|
231
231
|
fileName: z.string(),
|
|
232
232
|
workspaceId: z.string(),
|
|
233
|
-
created: z.date().default(() => new Date("2025-06-
|
|
233
|
+
created: z.date().default(() => new Date("2025-06-30T13:00:29.711Z"))
|
|
234
234
|
.transform(v => v.toISOString()),
|
|
235
235
|
}).transform((v) => {
|
|
236
236
|
return remap$(v, {
|
|
@@ -250,7 +250,7 @@ export const FileUploadResponseBody$inboundSchema: z.ZodType<
|
|
|
250
250
|
file_name: z.string(),
|
|
251
251
|
workspace_id: z.string(),
|
|
252
252
|
created: z.string().datetime({ offset: true }).default(
|
|
253
|
-
"2025-06-
|
|
253
|
+
"2025-06-30T13:00:29.711Z",
|
|
254
254
|
).transform(v => new Date(v)),
|
|
255
255
|
}).transform((v) => {
|
|
256
256
|
return remap$(v, {
|
|
@@ -284,7 +284,7 @@ export const FileUploadResponseBody$outboundSchema: z.ZodType<
|
|
|
284
284
|
bytes: z.number(),
|
|
285
285
|
fileName: z.string(),
|
|
286
286
|
workspaceId: z.string(),
|
|
287
|
-
created: z.date().default(() => new Date("2025-06-
|
|
287
|
+
created: z.date().default(() => new Date("2025-06-30T13:00:29.711Z"))
|
|
288
288
|
.transform(v => v.toISOString()),
|
|
289
289
|
}).transform((v) => {
|
|
290
290
|
return remap$(v, {
|
|
@@ -143,6 +143,7 @@ export type GetAllPromptsEncodingFormat = ClosedEnum<
|
|
|
143
143
|
* Constrains effort on reasoning for reasoning models. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.
|
|
144
144
|
*/
|
|
145
145
|
export const GetAllPromptsReasoningEffort = {
|
|
146
|
+
Disable: "disable",
|
|
146
147
|
Low: "low",
|
|
147
148
|
Medium: "medium",
|
|
148
149
|
High: "high",
|