@orq-ai/node 4.15.0-rc.41 → 4.15.0-rc.43
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/funcs/budgetsList.d.ts +1 -1
- package/funcs/budgetsList.js +1 -1
- package/jsr.json +1 -1
- package/lib/config.d.ts +2 -2
- package/lib/config.js +2 -2
- package/models/components/aggregatelogsrequest.d.ts +3 -3
- package/models/components/evaluationcontext.d.ts +1 -1
- package/models/components/evaluationresult.d.ts +5 -9
- package/models/components/evaluationresult.d.ts.map +1 -1
- package/models/components/evaluationresult.js.map +1 -1
- package/models/components/invokeevaluatorrequest.d.ts +3 -3
- package/models/components/memorystoreembeddingconfig.d.ts +1 -1
- package/models/components/reasoningpart.js +1 -1
- package/models/components/searchknowledgematch.d.ts +1 -4
- package/models/components/searchknowledgematch.d.ts.map +1 -1
- package/models/components/searchknowledgematch.js.map +1 -1
- package/models/components/searchknowledgerequest.d.ts +4 -4
- package/models/components/searchretrievalconfig.d.ts +1 -1
- package/models/components/skill.d.ts +2 -3
- package/models/components/skill.d.ts.map +1 -1
- package/models/components/skill.js.map +1 -1
- package/models/components/spansummary.d.ts +12 -0
- package/models/components/spansummary.d.ts.map +1 -1
- package/models/components/spansummary.js +9 -0
- package/models/components/spansummary.js.map +1 -1
- package/models/components/toolexecutionfailedstreamingevent.d.ts +1 -0
- package/models/components/toolexecutionfailedstreamingevent.d.ts.map +1 -1
- package/models/components/toolexecutionfailedstreamingevent.js +1 -0
- package/models/components/toolexecutionfailedstreamingevent.js.map +1 -1
- package/models/components/toolexecutionfinishedstreamingevent.d.ts +1 -0
- package/models/components/toolexecutionfinishedstreamingevent.d.ts.map +1 -1
- package/models/components/toolexecutionfinishedstreamingevent.js +1 -0
- package/models/components/toolexecutionfinishedstreamingevent.js.map +1 -1
- package/models/components/toolexecutionstartedstreamingevent.d.ts +1 -0
- package/models/components/toolexecutionstartedstreamingevent.d.ts.map +1 -1
- package/models/components/toolexecutionstartedstreamingevent.js +1 -0
- package/models/components/toolexecutionstartedstreamingevent.js.map +1 -1
- package/models/operations/budgetlist.d.ts +2 -3
- package/models/operations/budgetlist.d.ts.map +1 -1
- package/models/operations/budgetlist.js.map +1 -1
- package/models/operations/createchatcompletion.d.ts +5 -5
- package/models/operations/createcompletion.d.ts +4 -4
- package/models/operations/createdataset.js +1 -1
- package/models/operations/createdatasetitem.js +5 -5
- package/models/operations/createimageedit.d.ts +1 -1
- package/models/operations/createprompt.d.ts +1 -1
- package/models/operations/createtool.js +4 -4
- package/models/operations/getalltools.js +4 -4
- package/models/operations/getv2humanevalsets.js +2 -2
- package/models/operations/getv2humanevalsetsid.js +2 -2
- package/models/operations/listdatasetdatapoints.js +5 -5
- package/models/operations/listdatasets.js +1 -1
- package/models/operations/parse.d.ts +3 -3
- package/models/operations/patchv2humanevalsetsid.js +2 -2
- package/models/operations/postv2feedback.d.ts +2 -0
- package/models/operations/postv2feedback.d.ts.map +1 -1
- package/models/operations/postv2feedback.js +2 -0
- package/models/operations/postv2feedback.js.map +1 -1
- package/models/operations/postv2feedbackevaluation.js +4 -4
- package/models/operations/postv2feedbackremove.d.ts +2 -0
- package/models/operations/postv2feedbackremove.d.ts.map +1 -1
- package/models/operations/postv2feedbackremove.js +2 -0
- package/models/operations/postv2feedbackremove.js.map +1 -1
- package/models/operations/postv2humanevalsets.js +2 -2
- package/models/operations/retrievedatapoint.js +5 -5
- package/models/operations/retrievedataset.js +1 -1
- package/models/operations/retrievetool.js +4 -4
- package/models/operations/runagent.js +1 -1
- package/models/operations/streamrunagent.js +1 -1
- package/models/operations/updatedatapoint.js +5 -5
- package/models/operations/updatedataset.js +1 -1
- package/models/operations/updateprompt.d.ts +1 -1
- package/models/operations/updatetool.js +4 -4
- package/package.json +6 -6
- package/sdk/budgets.d.ts +1 -1
- package/sdk/budgets.js +1 -1
- package/src/funcs/budgetsList.ts +1 -1
- package/src/lib/config.ts +2 -2
- package/src/models/components/aggregatelogsrequest.ts +3 -3
- package/src/models/components/evaluationcontext.ts +1 -1
- package/src/models/components/evaluationresult.ts +5 -9
- package/src/models/components/invokeevaluatorrequest.ts +3 -3
- package/src/models/components/memorystoreembeddingconfig.ts +1 -1
- package/src/models/components/reasoningpart.ts +1 -1
- package/src/models/components/searchknowledgematch.ts +1 -4
- package/src/models/components/searchknowledgerequest.ts +4 -4
- package/src/models/components/searchretrievalconfig.ts +1 -1
- package/src/models/components/skill.ts +2 -3
- package/src/models/components/spansummary.ts +21 -0
- package/src/models/components/toolexecutionfailedstreamingevent.ts +1 -0
- package/src/models/components/toolexecutionfinishedstreamingevent.ts +1 -0
- package/src/models/components/toolexecutionstartedstreamingevent.ts +1 -0
- package/src/models/operations/budgetlist.ts +2 -3
- package/src/models/operations/createchatcompletion.ts +5 -5
- package/src/models/operations/createcompletion.ts +4 -4
- package/src/models/operations/createdataset.ts +1 -1
- package/src/models/operations/createdatasetitem.ts +5 -5
- package/src/models/operations/createimageedit.ts +1 -1
- package/src/models/operations/createprompt.ts +1 -1
- package/src/models/operations/createtool.ts +4 -4
- package/src/models/operations/getalltools.ts +4 -4
- package/src/models/operations/getv2humanevalsets.ts +2 -2
- package/src/models/operations/getv2humanevalsetsid.ts +2 -2
- package/src/models/operations/listdatasetdatapoints.ts +5 -5
- package/src/models/operations/listdatasets.ts +1 -1
- package/src/models/operations/parse.ts +3 -3
- package/src/models/operations/patchv2humanevalsetsid.ts +2 -2
- package/src/models/operations/postv2feedback.ts +2 -0
- package/src/models/operations/postv2feedbackevaluation.ts +4 -4
- package/src/models/operations/postv2feedbackremove.ts +2 -0
- package/src/models/operations/postv2humanevalsets.ts +2 -2
- package/src/models/operations/retrievedatapoint.ts +5 -5
- package/src/models/operations/retrievedataset.ts +1 -1
- package/src/models/operations/retrievetool.ts +4 -4
- package/src/models/operations/runagent.ts +1 -1
- package/src/models/operations/streamrunagent.ts +1 -1
- package/src/models/operations/updatedatapoint.ts +5 -5
- package/src/models/operations/updatedataset.ts +1 -1
- package/src/models/operations/updateprompt.ts +1 -1
- package/src/models/operations/updatetool.ts +4 -4
- package/src/sdk/budgets.ts +1 -1
|
@@ -866,7 +866,7 @@ exports.UpdateDatapointEvaluations4$inboundSchema = z.object({
|
|
|
866
866
|
parent_annotation_id: z.string().optional(),
|
|
867
867
|
explanation: z.string().optional(),
|
|
868
868
|
reviewed_by_id: z.string(),
|
|
869
|
-
reviewed_at: z.string().datetime({ offset: true }).default("2026-09-
|
|
869
|
+
reviewed_at: z.string().datetime({ offset: true }).default("2026-09-14T08:33:11.996Z").transform(v => new Date(v)),
|
|
870
870
|
type: z.literal("string_array"),
|
|
871
871
|
values: z.array(z.string()),
|
|
872
872
|
}).transform((v) => {
|
|
@@ -917,7 +917,7 @@ exports.UpdateDatapointEvaluations3$inboundSchema = z.object({
|
|
|
917
917
|
parent_annotation_id: z.string().optional(),
|
|
918
918
|
explanation: z.string().optional(),
|
|
919
919
|
reviewed_by_id: z.string(),
|
|
920
|
-
reviewed_at: z.string().datetime({ offset: true }).default("2026-09-
|
|
920
|
+
reviewed_at: z.string().datetime({ offset: true }).default("2026-09-14T08:33:11.995Z").transform(v => new Date(v)),
|
|
921
921
|
type: z.literal("boolean"),
|
|
922
922
|
value: z.boolean(),
|
|
923
923
|
}).transform((v) => {
|
|
@@ -968,7 +968,7 @@ exports.UpdateDatapointEvaluations2$inboundSchema = z.object({
|
|
|
968
968
|
parent_annotation_id: z.string().optional(),
|
|
969
969
|
explanation: z.string().optional(),
|
|
970
970
|
reviewed_by_id: z.string(),
|
|
971
|
-
reviewed_at: z.string().datetime({ offset: true }).default("2026-09-
|
|
971
|
+
reviewed_at: z.string().datetime({ offset: true }).default("2026-09-14T08:33:11.995Z").transform(v => new Date(v)),
|
|
972
972
|
type: z.literal("number"),
|
|
973
973
|
value: z.number(),
|
|
974
974
|
}).transform((v) => {
|
|
@@ -1018,7 +1018,7 @@ exports.UpdateDatapointEvaluations1$inboundSchema = z.object({
|
|
|
1018
1018
|
parent_annotation_id: z.string().optional(),
|
|
1019
1019
|
explanation: z.string().optional(),
|
|
1020
1020
|
reviewed_by_id: z.string(),
|
|
1021
|
-
reviewed_at: z.string().datetime({ offset: true }).default("2026-09-
|
|
1021
|
+
reviewed_at: z.string().datetime({ offset: true }).default("2026-09-14T08:33:11.994Z").transform(v => new Date(v)),
|
|
1022
1022
|
type: z.literal("string"),
|
|
1023
1023
|
value: z.string(),
|
|
1024
1024
|
}).transform((v) => {
|
|
@@ -1069,7 +1069,7 @@ exports.UpdateDatapointResponseBody$inboundSchema = z.object({
|
|
|
1069
1069
|
updated_by_id: z.nullable(z.string()).optional(),
|
|
1070
1070
|
created: z.string().datetime({ offset: true }).transform(v => new Date(v))
|
|
1071
1071
|
.optional(),
|
|
1072
|
-
updated: z.string().datetime({ offset: true }).default("2026-09-
|
|
1072
|
+
updated: z.string().datetime({ offset: true }).default("2026-09-14T08:33:02.935Z").transform(v => new Date(v)),
|
|
1073
1073
|
}).transform((v) => {
|
|
1074
1074
|
return (0, primitives_js_1.remap)(v, {
|
|
1075
1075
|
"_id": "id",
|
|
@@ -95,7 +95,7 @@ exports.UpdateDatasetResponseBody$inboundSchema = z.object({
|
|
|
95
95
|
updated_by_id: z.nullable(z.string()).optional(),
|
|
96
96
|
created: z.string().datetime({ offset: true }).transform(v => new Date(v))
|
|
97
97
|
.optional(),
|
|
98
|
-
updated: z.string().datetime({ offset: true }).default("2026-09-
|
|
98
|
+
updated: z.string().datetime({ offset: true }).default("2026-09-14T08:33:02.935Z").transform(v => new Date(v)),
|
|
99
99
|
}).transform((v) => {
|
|
100
100
|
return (0, primitives_js_1.remap)(v, {
|
|
101
101
|
"_id": "id",
|
|
@@ -608,7 +608,7 @@ export type UpdatePromptPromptInput = {
|
|
|
608
608
|
*/
|
|
609
609
|
messages?: Array<UpdatePromptMessagesSystemMessage | UpdatePromptMessagesUserMessage | UpdatePromptMessagesAssistantMessage | UpdatePromptMessagesToolMessage> | undefined;
|
|
610
610
|
/**
|
|
611
|
-
* Model ID used to generate the response, like `openai/gpt-4o` or `anthropic/claude-3-5-sonnet-20241022`. For private models, use format: `{workspaceKey}@{provider}/{model}`. The full list of models can be found at https://docs.orq.ai/docs/ai-gateway
|
|
611
|
+
* Model ID used to generate the response, like `openai/gpt-4o` or `anthropic/claude-3-5-sonnet-20241022`. For private models, use format: `{workspaceKey}@{provider}/{model}`. The full list of models can be found at https://docs.orq.ai/docs/ai-gateway/supported-models. Only chat models are supported.
|
|
612
612
|
*/
|
|
613
613
|
model?: string | null | undefined;
|
|
614
614
|
/**
|
|
@@ -536,7 +536,7 @@ function updateToolResponseBodyCodeToolFromJSON(jsonString) {
|
|
|
536
536
|
}
|
|
537
537
|
/** @internal */
|
|
538
538
|
exports.UpdateToolResponseBodyCodeExecutionTool$inboundSchema = z.object({
|
|
539
|
-
_id: z.string().default("
|
|
539
|
+
_id: z.string().default("tool_01M2FGS08EGT6VCF9VRTMHFTH3"),
|
|
540
540
|
path: z.string(),
|
|
541
541
|
key: z.string(),
|
|
542
542
|
display_name: z.string().optional(),
|
|
@@ -625,7 +625,7 @@ function updateToolResponseBodyHttpFromJSON(jsonString) {
|
|
|
625
625
|
}
|
|
626
626
|
/** @internal */
|
|
627
627
|
exports.UpdateToolResponseBodyHTTPTool$inboundSchema = z.object({
|
|
628
|
-
_id: z.string().default("
|
|
628
|
+
_id: z.string().default("tool_01M2FGS08D9J9FF2N5745CTS6A"),
|
|
629
629
|
path: z.string(),
|
|
630
630
|
key: z.string(),
|
|
631
631
|
display_name: z.string().optional(),
|
|
@@ -675,7 +675,7 @@ function updateToolResponseBodyJsonSchemaFromJSON(jsonString) {
|
|
|
675
675
|
}
|
|
676
676
|
/** @internal */
|
|
677
677
|
exports.UpdateToolResponseBodyJSONSchemaTool$inboundSchema = z.object({
|
|
678
|
-
_id: z.string().default("
|
|
678
|
+
_id: z.string().default("tool_01M2FGS08C482CB04TTT4FTNNM"),
|
|
679
679
|
path: z.string(),
|
|
680
680
|
key: z.string(),
|
|
681
681
|
display_name: z.string().optional(),
|
|
@@ -729,7 +729,7 @@ function updateToolResponseBodyFunctionFromJSON(jsonString) {
|
|
|
729
729
|
}
|
|
730
730
|
/** @internal */
|
|
731
731
|
exports.UpdateToolResponseBodyFunctionTool$inboundSchema = z.object({
|
|
732
|
-
_id: z.string().default("
|
|
732
|
+
_id: z.string().default("tool_01M2FGS08C2VRHF525WT0Y9GFJ"),
|
|
733
733
|
path: z.string(),
|
|
734
734
|
key: z.string(),
|
|
735
735
|
display_name: z.string().optional(),
|
package/package.json
CHANGED
|
@@ -1,18 +1,18 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@orq-ai/node",
|
|
3
|
-
"version": "4.15.0-rc.
|
|
3
|
+
"version": "4.15.0-rc.43",
|
|
4
4
|
"author": "Orq",
|
|
5
5
|
"exports": {
|
|
6
|
-
".": {
|
|
7
|
-
"import": "./index.js",
|
|
8
|
-
"require": "./index.js",
|
|
9
|
-
"types": "./index.d.ts"
|
|
10
|
-
},
|
|
11
6
|
"./*": "./*",
|
|
12
7
|
"./langchain": {
|
|
13
8
|
"import": "./langchain/index.mjs",
|
|
14
9
|
"require": "./langchain/index.js",
|
|
15
10
|
"types": "./langchain/index.d.mts"
|
|
11
|
+
},
|
|
12
|
+
".": {
|
|
13
|
+
"import": "./index.js",
|
|
14
|
+
"require": "./index.js",
|
|
15
|
+
"types": "./index.d.ts"
|
|
16
16
|
}
|
|
17
17
|
},
|
|
18
18
|
"main": "./index.js",
|
package/sdk/budgets.d.ts
CHANGED
|
@@ -6,7 +6,7 @@ export declare class Budgets extends ClientSDK {
|
|
|
6
6
|
* List budgets
|
|
7
7
|
*
|
|
8
8
|
* @remarks
|
|
9
|
-
* Returns budgets visible to the current workspace, ordered by
|
|
9
|
+
* Returns budgets visible to the current workspace, ordered by most recently updated with the newest first. Supports filtering by scope kind, scope target id, period, and active state, plus an optional free-text query that matches scope target names and ids. Requires a Management Key with the Budgets permission; project-scoped API keys cannot manage budgets.
|
|
10
10
|
*/
|
|
11
11
|
list(request?: operations.BudgetListRequest | undefined, options?: RequestOptions): Promise<components.ListBudgetsResponse>;
|
|
12
12
|
/**
|
package/sdk/budgets.js
CHANGED
|
@@ -17,7 +17,7 @@ class Budgets extends sdks_js_1.ClientSDK {
|
|
|
17
17
|
* List budgets
|
|
18
18
|
*
|
|
19
19
|
* @remarks
|
|
20
|
-
* Returns budgets visible to the current workspace, ordered by
|
|
20
|
+
* Returns budgets visible to the current workspace, ordered by most recently updated with the newest first. Supports filtering by scope kind, scope target id, period, and active state, plus an optional free-text query that matches scope target names and ids. Requires a Management Key with the Budgets permission; project-scoped API keys cannot manage budgets.
|
|
21
21
|
*/
|
|
22
22
|
async list(request, options) {
|
|
23
23
|
return (0, fp_js_1.unwrapAsync)((0, budgetsList_js_1.budgetsList)(this, request, options));
|
package/src/funcs/budgetsList.ts
CHANGED
|
@@ -30,7 +30,7 @@ import { Result } from "../types/fp.js";
|
|
|
30
30
|
* List budgets
|
|
31
31
|
*
|
|
32
32
|
* @remarks
|
|
33
|
-
* Returns budgets visible to the current workspace, ordered by
|
|
33
|
+
* Returns budgets visible to the current workspace, ordered by most recently updated with the newest first. Supports filtering by scope kind, scope target id, period, and active state, plus an optional free-text query that matches scope target names and ids. Requires a Management Key with the Budgets permission; project-scoped API keys cannot manage budgets.
|
|
34
34
|
*/
|
|
35
35
|
export function budgetsList(
|
|
36
36
|
client: OrqCore,
|
package/src/lib/config.ts
CHANGED
|
@@ -58,7 +58,7 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
|
|
|
58
58
|
export const SDK_METADATA = {
|
|
59
59
|
language: "typescript",
|
|
60
60
|
openapiDocVersion: "2.0",
|
|
61
|
-
sdkVersion: "4.15.0-rc.
|
|
61
|
+
sdkVersion: "4.15.0-rc.43",
|
|
62
62
|
genVersion: "2.935.1",
|
|
63
|
-
userAgent: "speakeasy-sdk/typescript 4.15.0-rc.
|
|
63
|
+
userAgent: "speakeasy-sdk/typescript 4.15.0-rc.43 2.935.1 2.0 @orq-ai/node",
|
|
64
64
|
} as const;
|
|
@@ -13,11 +13,11 @@ export type AggregateLogsRequest = {
|
|
|
13
13
|
from?: Date | undefined;
|
|
14
14
|
to?: Date | undefined;
|
|
15
15
|
/**
|
|
16
|
-
* Time bucket grain: "auto" | "minute" | "hour" | "day"
|
|
16
|
+
* Time bucket grain: "auto" | "minute" | "hour" | "day". "auto" picks the
|
|
17
17
|
*
|
|
18
18
|
* @remarks
|
|
19
|
-
*
|
|
20
|
-
*
|
|
19
|
+
* grain from the requested time range. Empty returns rows without time
|
|
20
|
+
* buckets.
|
|
21
21
|
*/
|
|
22
22
|
grain?: string | undefined;
|
|
23
23
|
filters?: Array<TraceFilter> | undefined;
|
|
@@ -21,7 +21,7 @@ export type Messages = {};
|
|
|
21
21
|
*
|
|
22
22
|
* @remarks
|
|
23
23
|
* `input.user_query` is ignored; `output.response` is appended only when the
|
|
24
|
-
* conversation carries no assistant turn.
|
|
24
|
+
* conversation carries no assistant turn.
|
|
25
25
|
*/
|
|
26
26
|
export type EvaluationContext = {
|
|
27
27
|
messages?: Array<Messages> | undefined;
|
|
@@ -9,14 +9,11 @@ import { Result as SafeParseResult } from "../../types/fp.js";
|
|
|
9
9
|
import { SDKValidationError } from "../errors/sdkvalidationerror.js";
|
|
10
10
|
|
|
11
11
|
/**
|
|
12
|
-
* The verdict.
|
|
13
|
-
*
|
|
14
|
-
* @remarks
|
|
15
|
-
* TypeScript route returned, so existing consumers read the same JSON.
|
|
12
|
+
* The verdict. Its shape is fixed so existing consumers read the same JSON.
|
|
16
13
|
*/
|
|
17
14
|
export type EvaluationResult = {
|
|
18
15
|
/**
|
|
19
|
-
* Discriminator
|
|
16
|
+
* Discriminator for the verdict shape: "string", "number", "boolean",
|
|
20
17
|
*
|
|
21
18
|
* @remarks
|
|
22
19
|
* "string_array", "rouge_n", "bert_score", "llm_evaluator", "http_eval".
|
|
@@ -34,8 +31,7 @@ export type EvaluationResult = {
|
|
|
34
31
|
* Trace reference of the evaluator's own span. Optional so an absent
|
|
35
32
|
*
|
|
36
33
|
* @remarks
|
|
37
|
-
* reference is omitted rather than emitted as an empty string
|
|
38
|
-
* legacy body.
|
|
34
|
+
* reference is omitted rather than emitted as an empty string.
|
|
39
35
|
*/
|
|
40
36
|
traceId?: string | undefined;
|
|
41
37
|
spanId?: string | undefined;
|
|
@@ -52,8 +48,8 @@ export type EvaluationResult = {
|
|
|
52
48
|
* The guardrail's decision when the evaluator has one, the grader's own
|
|
53
49
|
*
|
|
54
50
|
* @remarks
|
|
55
|
-
* judgement otherwise. Always present
|
|
56
|
-
*
|
|
51
|
+
* judgement otherwise. Always present, so read `guardrail_config` to detect
|
|
52
|
+
* a guardrail, not this.
|
|
57
53
|
*/
|
|
58
54
|
passed?: boolean | undefined;
|
|
59
55
|
explanation?: string | undefined;
|
|
@@ -15,8 +15,8 @@ export type InvokeEvaluatorRequestMessages = {};
|
|
|
15
15
|
* Accepts two shapes. `context` names its fields after the template variables
|
|
16
16
|
*
|
|
17
17
|
* @remarks
|
|
18
|
-
* they feed and is the one to use; the flat fields below are
|
|
19
|
-
*
|
|
18
|
+
* they feed and is the one to use; the flat fields below are folded into
|
|
19
|
+
* `context` when it is absent. Setting `context` wins.
|
|
20
20
|
*/
|
|
21
21
|
export type InvokeEvaluatorRequest = {
|
|
22
22
|
/**
|
|
@@ -24,7 +24,7 @@ export type InvokeEvaluatorRequest = {
|
|
|
24
24
|
*
|
|
25
25
|
* @remarks
|
|
26
26
|
* `input.user_query` is ignored; `output.response` is appended only when the
|
|
27
|
-
* conversation carries no assistant turn.
|
|
27
|
+
* conversation carries no assistant turn.
|
|
28
28
|
*/
|
|
29
29
|
context?: EvaluationContext | undefined;
|
|
30
30
|
/**
|
|
@@ -9,7 +9,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
|
|
|
9
9
|
|
|
10
10
|
export type MemoryStoreEmbeddingConfig = {
|
|
11
11
|
/**
|
|
12
|
-
* The embeddings model to use for the knowledge base in the format "provider/model" for public models or "workspaceKey@provider/model" for private workspace models. This model will be used to embed the chunks when they are added to the knowledge base. Refer to the
|
|
12
|
+
* The embeddings model to use for the knowledge base in the format "provider/model" for public models or "workspaceKey@provider/model" for private workspace models. This model will be used to embed the chunks when they are added to the knowledge base. Refer to the [Supported models](/docs/ai-gateway/supported-models) to browse available models.
|
|
13
13
|
*/
|
|
14
14
|
model: string;
|
|
15
15
|
};
|
|
@@ -40,7 +40,7 @@ export const ReasoningPart$inboundSchema: z.ZodType<
|
|
|
40
40
|
z.ZodTypeDef,
|
|
41
41
|
unknown
|
|
42
42
|
> = z.object({
|
|
43
|
-
_id: z.string().default("
|
|
43
|
+
_id: z.string().default("reasoning_01m2fgs03g8dzadfsswc8z0e21"),
|
|
44
44
|
metadata: z.record(z.any()).optional(),
|
|
45
45
|
kind: z.literal("reasoning"),
|
|
46
46
|
reasoning: z.string(),
|
|
@@ -20,10 +20,7 @@ export type SearchKnowledgeMatch = {
|
|
|
20
20
|
id: string;
|
|
21
21
|
text: string;
|
|
22
22
|
/**
|
|
23
|
-
*
|
|
24
|
-
*
|
|
25
|
-
* @remarks
|
|
26
|
-
* repeated fields are omitted by proto JSON, preserving optional vectors.
|
|
23
|
+
* Embedding vector of the chunk, returned only when requested.
|
|
27
24
|
*/
|
|
28
25
|
vector?: Array<number> | undefined;
|
|
29
26
|
/**
|
|
@@ -311,7 +311,7 @@ export type Two = {
|
|
|
311
311
|
*/
|
|
312
312
|
model?: string | undefined;
|
|
313
313
|
/**
|
|
314
|
-
*
|
|
314
|
+
* Identifier of the stored model configuration to use.
|
|
315
315
|
*/
|
|
316
316
|
modelDbId: string;
|
|
317
317
|
/**
|
|
@@ -330,7 +330,7 @@ export type AgenticRagConfig1 = {
|
|
|
330
330
|
*/
|
|
331
331
|
model: string;
|
|
332
332
|
/**
|
|
333
|
-
*
|
|
333
|
+
* Identifier of the stored model configuration to use.
|
|
334
334
|
*/
|
|
335
335
|
modelDbId?: string | undefined;
|
|
336
336
|
/**
|
|
@@ -349,10 +349,10 @@ export type AgenticRagConfig1 = {
|
|
|
349
349
|
export type SearchKnowledgeRequestAgenticRagConfig = Two | AgenticRagConfig1;
|
|
350
350
|
|
|
351
351
|
/**
|
|
352
|
-
*
|
|
352
|
+
* Search request. Sets the knowledge base and query, plus optional retrieval
|
|
353
353
|
*
|
|
354
354
|
* @remarks
|
|
355
|
-
*
|
|
355
|
+
* settings.
|
|
356
356
|
*/
|
|
357
357
|
export type SearchKnowledgeRequest = {
|
|
358
358
|
/**
|
|
@@ -31,7 +31,7 @@ export type SearchRetrievalConfigRerankConfig = {
|
|
|
31
31
|
};
|
|
32
32
|
|
|
33
33
|
/**
|
|
34
|
-
* SearchRetrievalConfig
|
|
34
|
+
* SearchRetrievalConfig is the retrieval strategy configuration. Type remains
|
|
35
35
|
*
|
|
36
36
|
* @remarks
|
|
37
37
|
* optional because external knowledge bases use the same base configuration
|
|
@@ -58,11 +58,10 @@ export type Skill = {
|
|
|
58
58
|
*/
|
|
59
59
|
instructions: string;
|
|
60
60
|
/**
|
|
61
|
-
* Latest semver
|
|
61
|
+
* Latest semver for the skill. It advances when the skill's definition
|
|
62
62
|
*
|
|
63
63
|
* @remarks
|
|
64
|
-
*
|
|
65
|
-
* workspaces.activities.
|
|
64
|
+
* changes and is returned on every read.
|
|
66
65
|
*/
|
|
67
66
|
version: string;
|
|
68
67
|
};
|
|
@@ -27,6 +27,18 @@ export type SpanSummary = {
|
|
|
27
27
|
usage?: TraceUsage | undefined;
|
|
28
28
|
cost?: TraceCost | undefined;
|
|
29
29
|
hasDetail?: boolean | undefined;
|
|
30
|
+
level?: number | undefined;
|
|
31
|
+
hasChildren?: boolean | undefined;
|
|
32
|
+
/**
|
|
33
|
+
* Row badge inputs, so the tree does not need a detail fetch per span:
|
|
34
|
+
*
|
|
35
|
+
* @remarks
|
|
36
|
+
* trace_framework is set on the trace root, leading_span_type where the
|
|
37
|
+
* ingest marked one, guardrail_enabled on evaluator spans run as guardrails.
|
|
38
|
+
*/
|
|
39
|
+
traceFramework?: string | undefined;
|
|
40
|
+
leadingSpanType?: string | undefined;
|
|
41
|
+
guardrailEnabled?: boolean | undefined;
|
|
30
42
|
};
|
|
31
43
|
|
|
32
44
|
/** @internal */
|
|
@@ -53,6 +65,11 @@ export const SpanSummary$inboundSchema: z.ZodType<
|
|
|
53
65
|
usage: TraceUsage$inboundSchema.optional(),
|
|
54
66
|
cost: TraceCost$inboundSchema.optional(),
|
|
55
67
|
has_detail: z.boolean().optional(),
|
|
68
|
+
level: z.number().int().optional(),
|
|
69
|
+
has_children: z.boolean().optional(),
|
|
70
|
+
trace_framework: z.string().optional(),
|
|
71
|
+
leading_span_type: z.string().optional(),
|
|
72
|
+
guardrail_enabled: z.boolean().optional(),
|
|
56
73
|
}).transform((v) => {
|
|
57
74
|
return remap$(v, {
|
|
58
75
|
"trace_id": "traceId",
|
|
@@ -62,6 +79,10 @@ export const SpanSummary$inboundSchema: z.ZodType<
|
|
|
62
79
|
"ended_at": "endedAt",
|
|
63
80
|
"duration_ms": "durationMs",
|
|
64
81
|
"has_detail": "hasDetail",
|
|
82
|
+
"has_children": "hasChildren",
|
|
83
|
+
"trace_framework": "traceFramework",
|
|
84
|
+
"leading_span_type": "leadingSpanType",
|
|
85
|
+
"guardrail_enabled": "guardrailEnabled",
|
|
65
86
|
});
|
|
66
87
|
});
|
|
67
88
|
|
|
@@ -48,11 +48,10 @@ export type BudgetListRequest = {
|
|
|
48
48
|
*/
|
|
49
49
|
period?: Array<components.BudgetPeriod> | undefined;
|
|
50
50
|
/**
|
|
51
|
-
* Optional free-text query
|
|
51
|
+
* Optional free-text query matched against a budget's scope target
|
|
52
52
|
*
|
|
53
53
|
* @remarks
|
|
54
|
-
*
|
|
55
|
-
* the per-workspace `{workspace_id}_budgets` collection.
|
|
54
|
+
* name and id.
|
|
56
55
|
*/
|
|
57
56
|
query?: string | undefined;
|
|
58
57
|
/**
|
|
@@ -1229,7 +1229,7 @@ export type FilterBy1 =
|
|
|
1229
1229
|
| CreateChatCompletion1Nin;
|
|
1230
1230
|
|
|
1231
1231
|
/**
|
|
1232
|
-
* The metadata filter to apply to the search. Check the [Searching a Knowledge Base](https://docs.orq.ai/docs/knowledge
|
|
1232
|
+
* The metadata filter to apply to the search. Check the [Searching a Knowledge Base](https://docs.orq.ai/docs/ai-studio/ai-engineering/knowledge-bases#search-a-knowledge-base) for more information.
|
|
1233
1233
|
*/
|
|
1234
1234
|
export type FilterBy = FilterByAnd | FilterByOr | {
|
|
1235
1235
|
[k: string]:
|
|
@@ -1266,7 +1266,7 @@ export type SearchOptions = {
|
|
|
1266
1266
|
*/
|
|
1267
1267
|
export type RerankConfig = {
|
|
1268
1268
|
/**
|
|
1269
|
-
* The name of the rerank model to use. Refer to the [model list](https://docs.orq.ai/docs/
|
|
1269
|
+
* The name of the rerank model to use. Refer to the [model list](https://docs.orq.ai/docs/ai-gateway/supported-models#rerank-models).
|
|
1270
1270
|
*/
|
|
1271
1271
|
model: string;
|
|
1272
1272
|
/**
|
|
@@ -1284,7 +1284,7 @@ export type RerankConfig = {
|
|
|
1284
1284
|
*/
|
|
1285
1285
|
export type AgenticRagConfig = {
|
|
1286
1286
|
/**
|
|
1287
|
-
* The name of the model for the Agent to use. Refer to the [model list](https://docs.orq.ai/docs/
|
|
1287
|
+
* The name of the model for the Agent to use. Refer to the [model list](https://docs.orq.ai/docs/ai-gateway/supported-models#chat-models).
|
|
1288
1288
|
*/
|
|
1289
1289
|
model: string;
|
|
1290
1290
|
};
|
|
@@ -1303,7 +1303,7 @@ export type CreateChatCompletionKnowledgeBases = {
|
|
|
1303
1303
|
*/
|
|
1304
1304
|
searchType?: SearchType | null | undefined;
|
|
1305
1305
|
/**
|
|
1306
|
-
* The metadata filter to apply to the search. Check the [Searching a Knowledge Base](https://docs.orq.ai/docs/knowledge
|
|
1306
|
+
* The metadata filter to apply to the search. Check the [Searching a Knowledge Base](https://docs.orq.ai/docs/ai-studio/ai-engineering/knowledge-bases#search-a-knowledge-base) for more information.
|
|
1307
1307
|
*/
|
|
1308
1308
|
filterBy?: FilterByAnd | FilterByOr | {
|
|
1309
1309
|
[k: string]:
|
|
@@ -1449,7 +1449,7 @@ export type CreateChatCompletionRequestBody = {
|
|
|
1449
1449
|
| CreateChatCompletionMessagesToolMessage
|
|
1450
1450
|
>;
|
|
1451
1451
|
/**
|
|
1452
|
-
* Model ID used to generate the response, like `openai/gpt-4o` or `anthropic/claude-haiku-4-5-20251001`. The AI Gateway offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the
|
|
1452
|
+
* Model ID used to generate the response, like `openai/gpt-4o` or `anthropic/claude-haiku-4-5-20251001`. The AI Gateway offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the [Supported models](/docs/ai-gateway/supported-models) to browse available models.
|
|
1453
1453
|
*/
|
|
1454
1454
|
model: string;
|
|
1455
1455
|
/**
|
|
@@ -470,7 +470,7 @@ export type CreateCompletionFilterBy1 =
|
|
|
470
470
|
| CreateCompletion1Nin;
|
|
471
471
|
|
|
472
472
|
/**
|
|
473
|
-
* The metadata filter to apply to the search. Check the [Searching a Knowledge Base](https://docs.orq.ai/docs/knowledge
|
|
473
|
+
* The metadata filter to apply to the search. Check the [Searching a Knowledge Base](https://docs.orq.ai/docs/ai-studio/ai-engineering/knowledge-bases#search-a-knowledge-base) for more information.
|
|
474
474
|
*/
|
|
475
475
|
export type CreateCompletionFilterBy =
|
|
476
476
|
| CreateCompletionFilterByAnd
|
|
@@ -510,7 +510,7 @@ export type CreateCompletionSearchOptions = {
|
|
|
510
510
|
*/
|
|
511
511
|
export type CreateCompletionRerankConfig = {
|
|
512
512
|
/**
|
|
513
|
-
* The name of the rerank model to use. Refer to the [model list](https://docs.orq.ai/docs/
|
|
513
|
+
* The name of the rerank model to use. Refer to the [model list](https://docs.orq.ai/docs/ai-gateway/supported-models#rerank-models).
|
|
514
514
|
*/
|
|
515
515
|
model: string;
|
|
516
516
|
/**
|
|
@@ -528,7 +528,7 @@ export type CreateCompletionRerankConfig = {
|
|
|
528
528
|
*/
|
|
529
529
|
export type CreateCompletionAgenticRagConfig = {
|
|
530
530
|
/**
|
|
531
|
-
* The name of the model for the Agent to use. Refer to the [model list](https://docs.orq.ai/docs/
|
|
531
|
+
* The name of the model for the Agent to use. Refer to the [model list](https://docs.orq.ai/docs/ai-gateway/supported-models#chat-models).
|
|
532
532
|
*/
|
|
533
533
|
model: string;
|
|
534
534
|
};
|
|
@@ -547,7 +547,7 @@ export type CreateCompletionKnowledgeBases = {
|
|
|
547
547
|
*/
|
|
548
548
|
searchType?: CreateCompletionSearchType | null | undefined;
|
|
549
549
|
/**
|
|
550
|
-
* The metadata filter to apply to the search. Check the [Searching a Knowledge Base](https://docs.orq.ai/docs/knowledge
|
|
550
|
+
* The metadata filter to apply to the search. Check the [Searching a Knowledge Base](https://docs.orq.ai/docs/ai-studio/ai-engineering/knowledge-bases#search-a-knowledge-base) for more information.
|
|
551
551
|
*/
|
|
552
552
|
filterBy?: CreateCompletionFilterByAnd | CreateCompletionFilterByOr | {
|
|
553
553
|
[k: string]:
|
|
@@ -138,7 +138,7 @@ export const CreateDatasetResponseBody$inboundSchema: z.ZodType<
|
|
|
138
138
|
created: z.string().datetime({ offset: true }).transform(v => new Date(v))
|
|
139
139
|
.optional(),
|
|
140
140
|
updated: z.string().datetime({ offset: true }).default(
|
|
141
|
-
"2026-09-
|
|
141
|
+
"2026-09-14T08:33:02.935Z",
|
|
142
142
|
).transform(v => new Date(v)),
|
|
143
143
|
}).transform((v) => {
|
|
144
144
|
return remap$(v, {
|
|
@@ -2739,7 +2739,7 @@ export const Evaluations4$inboundSchema: z.ZodType<
|
|
|
2739
2739
|
explanation: z.string().optional(),
|
|
2740
2740
|
reviewed_by_id: z.string(),
|
|
2741
2741
|
reviewed_at: z.string().datetime({ offset: true }).default(
|
|
2742
|
-
"2026-09-
|
|
2742
|
+
"2026-09-14T08:33:11.983Z",
|
|
2743
2743
|
).transform(v => new Date(v)),
|
|
2744
2744
|
type: z.literal("string_array"),
|
|
2745
2745
|
values: z.array(z.string()),
|
|
@@ -2829,7 +2829,7 @@ export const CreateDatasetItemEvaluations3$inboundSchema: z.ZodType<
|
|
|
2829
2829
|
explanation: z.string().optional(),
|
|
2830
2830
|
reviewed_by_id: z.string(),
|
|
2831
2831
|
reviewed_at: z.string().datetime({ offset: true }).default(
|
|
2832
|
-
"2026-09-
|
|
2832
|
+
"2026-09-14T08:33:11.983Z",
|
|
2833
2833
|
).transform(v => new Date(v)),
|
|
2834
2834
|
type: z.literal("boolean"),
|
|
2835
2835
|
value: z.boolean(),
|
|
@@ -2914,7 +2914,7 @@ export const Evaluations2$inboundSchema: z.ZodType<
|
|
|
2914
2914
|
explanation: z.string().optional(),
|
|
2915
2915
|
reviewed_by_id: z.string(),
|
|
2916
2916
|
reviewed_at: z.string().datetime({ offset: true }).default(
|
|
2917
|
-
"2026-09-
|
|
2917
|
+
"2026-09-14T08:33:11.983Z",
|
|
2918
2918
|
).transform(v => new Date(v)),
|
|
2919
2919
|
type: z.literal("number"),
|
|
2920
2920
|
value: z.number(),
|
|
@@ -3000,7 +3000,7 @@ export const Evaluations1$inboundSchema: z.ZodType<
|
|
|
3000
3000
|
explanation: z.string().optional(),
|
|
3001
3001
|
reviewed_by_id: z.string(),
|
|
3002
3002
|
reviewed_at: z.string().datetime({ offset: true }).default(
|
|
3003
|
-
"2026-09-
|
|
3003
|
+
"2026-09-14T08:33:11.982Z",
|
|
3004
3004
|
).transform(v => new Date(v)),
|
|
3005
3005
|
type: z.literal("string"),
|
|
3006
3006
|
value: z.string(),
|
|
@@ -3087,7 +3087,7 @@ export const ResponseBody$inboundSchema: z.ZodType<
|
|
|
3087
3087
|
created: z.string().datetime({ offset: true }).transform(v => new Date(v))
|
|
3088
3088
|
.optional(),
|
|
3089
3089
|
updated: z.string().datetime({ offset: true }).default(
|
|
3090
|
-
"2026-09-
|
|
3090
|
+
"2026-09-14T08:33:02.935Z",
|
|
3091
3091
|
).transform(v => new Date(v)),
|
|
3092
3092
|
}).transform((v) => {
|
|
3093
3093
|
return remap$(v, {
|
|
@@ -266,7 +266,7 @@ export type CreateImageEditOrq = {
|
|
|
266
266
|
|
|
267
267
|
export type CreateImageEditRequestBody = {
|
|
268
268
|
/**
|
|
269
|
-
* The model to use for image edit. [Check models](https://docs.orq.ai/docs/ai-gateway
|
|
269
|
+
* The model to use for image edit. [Check models](https://docs.orq.ai/docs/ai-gateway/supported-models#image-models)
|
|
270
270
|
*/
|
|
271
271
|
model: string;
|
|
272
272
|
/**
|
|
@@ -792,7 +792,7 @@ export type PromptInput = {
|
|
|
792
792
|
| CreatePromptMessagesToolMessage
|
|
793
793
|
>;
|
|
794
794
|
/**
|
|
795
|
-
* Model ID used to generate the response, like `openai/gpt-4o` or `anthropic/claude-3-5-sonnet-20241022`. For private models, use format: `{workspaceKey}@{provider}/{model}`. The full list of models can be found at https://docs.orq.ai/docs/ai-gateway
|
|
795
|
+
* Model ID used to generate the response, like `openai/gpt-4o` or `anthropic/claude-3-5-sonnet-20241022`. For private models, use format: `{workspaceKey}@{provider}/{model}`. The full list of models can be found at https://docs.orq.ai/docs/ai-gateway/supported-models. Only chat models are supported.
|
|
796
796
|
*/
|
|
797
797
|
model?: string | undefined;
|
|
798
798
|
/**
|
|
@@ -1573,7 +1573,7 @@ export const ResponseBodyCodeExecutionTool$inboundSchema: z.ZodType<
|
|
|
1573
1573
|
z.ZodTypeDef,
|
|
1574
1574
|
unknown
|
|
1575
1575
|
> = z.object({
|
|
1576
|
-
_id: z.string().default("
|
|
1576
|
+
_id: z.string().default("tool_01M2FGS088JXPFYVTC0CMXVK4N"),
|
|
1577
1577
|
path: z.string(),
|
|
1578
1578
|
key: z.string(),
|
|
1579
1579
|
display_name: z.string().optional(),
|
|
@@ -1759,7 +1759,7 @@ export const ResponseBodyHTTPTool$inboundSchema: z.ZodType<
|
|
|
1759
1759
|
z.ZodTypeDef,
|
|
1760
1760
|
unknown
|
|
1761
1761
|
> = z.object({
|
|
1762
|
-
_id: z.string().default("
|
|
1762
|
+
_id: z.string().default("tool_01M2FGS0874G6AVWPPKG24XQYC"),
|
|
1763
1763
|
path: z.string(),
|
|
1764
1764
|
key: z.string(),
|
|
1765
1765
|
display_name: z.string().optional(),
|
|
@@ -1852,7 +1852,7 @@ export const ResponseBodyJSONSchemaTool$inboundSchema: z.ZodType<
|
|
|
1852
1852
|
z.ZodTypeDef,
|
|
1853
1853
|
unknown
|
|
1854
1854
|
> = z.object({
|
|
1855
|
-
_id: z.string().default("
|
|
1855
|
+
_id: z.string().default("tool_01M2FGS086SF7Y53S2MM1GA83P"),
|
|
1856
1856
|
path: z.string(),
|
|
1857
1857
|
key: z.string(),
|
|
1858
1858
|
display_name: z.string().optional(),
|
|
@@ -1953,7 +1953,7 @@ export const ResponseBodyFunctionTool$inboundSchema: z.ZodType<
|
|
|
1953
1953
|
z.ZodTypeDef,
|
|
1954
1954
|
unknown
|
|
1955
1955
|
> = z.object({
|
|
1956
|
-
_id: z.string().default("
|
|
1956
|
+
_id: z.string().default("tool_01M2FGS086Q236PG8R5TA7S94C"),
|
|
1957
1957
|
path: z.string(),
|
|
1958
1958
|
key: z.string(),
|
|
1959
1959
|
display_name: z.string().optional(),
|