@orq-ai/node 4.0.0-rc.5 → 4.0.0-rc.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/bin/mcp-server.js +7487 -543
- package/bin/mcp-server.js.map +52 -52
- package/examples/package-lock.json +1 -1
- package/jsr.json +1 -1
- package/lib/config.d.ts +2 -2
- package/lib/config.js +2 -2
- package/mcp-server/mcp-server.js +1 -1
- package/mcp-server/server.js +1 -1
- package/models/operations/createagent.d.ts +4141 -865
- package/models/operations/createagent.d.ts.map +1 -1
- package/models/operations/createagent.js +3767 -768
- package/models/operations/createagent.js.map +1 -1
- package/models/operations/createbudget.js +2 -2
- package/models/operations/createcontact.js +2 -2
- package/models/operations/createdataset.js +2 -2
- package/models/operations/createdatasetitem.js +8 -8
- package/models/operations/createdatasource.js +2 -2
- package/models/operations/createeval.js +28 -28
- package/models/operations/creatememorystore.d.ts +42 -42
- package/models/operations/creatememorystore.d.ts.map +1 -1
- package/models/operations/creatememorystore.js +61 -63
- package/models/operations/creatememorystore.js.map +1 -1
- package/models/operations/createprompt.d.ts +263 -263
- package/models/operations/createprompt.d.ts.map +1 -1
- package/models/operations/createprompt.js +345 -345
- package/models/operations/createprompt.js.map +1 -1
- package/models/operations/createtool.js +10 -10
- package/models/operations/deploymentgetconfig.d.ts +19 -19
- package/models/operations/deploymentgetconfig.d.ts.map +1 -1
- package/models/operations/deploymentgetconfig.js +22 -22
- package/models/operations/deploymentgetconfig.js.map +1 -1
- package/models/operations/deployments.d.ts +4 -4
- package/models/operations/deployments.d.ts.map +1 -1
- package/models/operations/deployments.js +4 -4
- package/models/operations/deployments.js.map +1 -1
- package/models/operations/duplicatetool.js +10 -10
- package/models/operations/fileget.js +2 -2
- package/models/operations/filelist.js +2 -2
- package/models/operations/fileupload.js +2 -2
- package/models/operations/getagent.d.ts +1614 -11
- package/models/operations/getagent.d.ts.map +1 -1
- package/models/operations/getagent.js +1475 -9
- package/models/operations/getagent.js.map +1 -1
- package/models/operations/getallprompts.d.ts +4 -4
- package/models/operations/getallprompts.d.ts.map +1 -1
- package/models/operations/getallprompts.js +4 -4
- package/models/operations/getallprompts.js.map +1 -1
- package/models/operations/getalltools.js +10 -10
- package/models/operations/getbudget.js +2 -2
- package/models/operations/getevals.js +28 -28
- package/models/operations/getoneprompt.d.ts +4 -4
- package/models/operations/getoneprompt.d.ts.map +1 -1
- package/models/operations/getoneprompt.js +4 -4
- package/models/operations/getoneprompt.js.map +1 -1
- package/models/operations/getpromptversion.d.ts +4 -4
- package/models/operations/getpromptversion.d.ts.map +1 -1
- package/models/operations/getpromptversion.js +4 -4
- package/models/operations/getpromptversion.js.map +1 -1
- package/models/operations/listagents.d.ts +1614 -11
- package/models/operations/listagents.d.ts.map +1 -1
- package/models/operations/listagents.js +1481 -9
- package/models/operations/listagents.js.map +1 -1
- package/models/operations/listagenttasks.d.ts +1614 -11
- package/models/operations/listagenttasks.d.ts.map +1 -1
- package/models/operations/listagenttasks.js +1479 -9
- package/models/operations/listagenttasks.js.map +1 -1
- package/models/operations/listbudgets.js +2 -2
- package/models/operations/listcontacts.js +2 -2
- package/models/operations/listdatasetdatapoints.js +8 -8
- package/models/operations/listdatasets.js +2 -2
- package/models/operations/listdatasources.js +2 -2
- package/models/operations/listpromptversions.d.ts +4 -4
- package/models/operations/listpromptversions.d.ts.map +1 -1
- package/models/operations/listpromptversions.js +4 -4
- package/models/operations/listpromptversions.js.map +1 -1
- package/models/operations/retrievecontact.js +2 -2
- package/models/operations/retrievedatapoint.js +8 -8
- package/models/operations/retrievedataset.js +2 -2
- package/models/operations/retrievedatasource.js +2 -2
- package/models/operations/retrievetool.js +10 -10
- package/models/operations/runagent.d.ts +2176 -503
- package/models/operations/runagent.d.ts.map +1 -1
- package/models/operations/runagent.js +1534 -9
- package/models/operations/runagent.js.map +1 -1
- package/models/operations/streamrunagent.d.ts +2128 -455
- package/models/operations/streamrunagent.d.ts.map +1 -1
- package/models/operations/streamrunagent.js +1630 -89
- package/models/operations/streamrunagent.js.map +1 -1
- package/models/operations/updateagent.d.ts +4129 -853
- package/models/operations/updateagent.d.ts.map +1 -1
- package/models/operations/updateagent.js +3837 -825
- package/models/operations/updateagent.js.map +1 -1
- package/models/operations/updatebudget.js +2 -2
- package/models/operations/updatecontact.js +2 -2
- package/models/operations/updatedatapoint.js +8 -8
- package/models/operations/updatedataset.js +2 -2
- package/models/operations/updatedatasource.js +2 -2
- package/models/operations/updateeval.js +28 -28
- package/models/operations/updateprompt.d.ts +8 -8
- package/models/operations/updateprompt.d.ts.map +1 -1
- package/models/operations/updateprompt.js +8 -8
- package/models/operations/updateprompt.js.map +1 -1
- package/models/operations/updatetool.js +10 -10
- package/package.json +1 -1
- package/src/lib/config.ts +2 -2
- package/src/mcp-server/mcp-server.ts +1 -1
- package/src/mcp-server/server.ts +1 -1
- package/src/models/operations/createagent.ts +7853 -1626
- package/src/models/operations/createbudget.ts +2 -2
- package/src/models/operations/createcontact.ts +2 -2
- package/src/models/operations/createdataset.ts +2 -2
- package/src/models/operations/createdatasetitem.ts +8 -8
- package/src/models/operations/createdatasource.ts +2 -2
- package/src/models/operations/createeval.ts +28 -28
- package/src/models/operations/creatememorystore.ts +120 -103
- package/src/models/operations/createprompt.ts +742 -621
- package/src/models/operations/createtool.ts +10 -10
- package/src/models/operations/deploymentgetconfig.ts +60 -44
- package/src/models/operations/deployments.ts +25 -20
- package/src/models/operations/duplicatetool.ts +10 -10
- 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/getagent.ts +3274 -246
- package/src/models/operations/getallprompts.ts +30 -20
- package/src/models/operations/getalltools.ts +10 -10
- package/src/models/operations/getbudget.ts +2 -2
- package/src/models/operations/getevals.ts +28 -28
- package/src/models/operations/getoneprompt.ts +28 -20
- package/src/models/operations/getpromptversion.ts +30 -20
- package/src/models/operations/listagents.ts +3351 -270
- package/src/models/operations/listagenttasks.ts +3347 -180
- package/src/models/operations/listbudgets.ts +2 -2
- package/src/models/operations/listcontacts.ts +2 -2
- package/src/models/operations/listdatasetdatapoints.ts +8 -8
- package/src/models/operations/listdatasets.ts +2 -2
- package/src/models/operations/listdatasources.ts +2 -2
- package/src/models/operations/listpromptversions.ts +30 -20
- package/src/models/operations/retrievecontact.ts +2 -2
- package/src/models/operations/retrievedatapoint.ts +8 -8
- package/src/models/operations/retrievedataset.ts +2 -2
- package/src/models/operations/retrievedatasource.ts +2 -2
- package/src/models/operations/retrievetool.ts +10 -10
- package/src/models/operations/runagent.ts +3799 -610
- package/src/models/operations/streamrunagent.ts +3945 -605
- package/src/models/operations/updateagent.ts +8331 -1757
- package/src/models/operations/updatebudget.ts +2 -2
- package/src/models/operations/updatecontact.ts +2 -2
- package/src/models/operations/updatedatapoint.ts +8 -8
- package/src/models/operations/updatedataset.ts +2 -2
- package/src/models/operations/updatedatasource.ts +2 -2
- package/src/models/operations/updateeval.ts +28 -28
- package/src/models/operations/updateprompt.ts +58 -40
- package/src/models/operations/updatetool.ts +10 -10
|
@@ -3,752 +3,2425 @@ import { ClosedEnum } from "../../types/enums.js";
|
|
|
3
3
|
import { Result as SafeParseResult } from "../../types/fp.js";
|
|
4
4
|
import { SDKValidationError } from "../errors/sdkvalidationerror.js";
|
|
5
5
|
/**
|
|
6
|
-
*
|
|
6
|
+
* The voice the model uses to respond. Supported voices are alloy, echo, fable, onyx, nova, and shimmer.
|
|
7
7
|
*/
|
|
8
|
-
export declare const
|
|
9
|
-
readonly
|
|
8
|
+
export declare const RunAgentModelVoice: {
|
|
9
|
+
readonly Alloy: "alloy";
|
|
10
|
+
readonly Echo: "echo";
|
|
11
|
+
readonly Fable: "fable";
|
|
12
|
+
readonly Onyx: "onyx";
|
|
13
|
+
readonly Nova: "nova";
|
|
14
|
+
readonly Shimmer: "shimmer";
|
|
10
15
|
};
|
|
11
16
|
/**
|
|
12
|
-
*
|
|
17
|
+
* The voice the model uses to respond. Supported voices are alloy, echo, fable, onyx, nova, and shimmer.
|
|
13
18
|
*/
|
|
14
|
-
export type
|
|
19
|
+
export type RunAgentModelVoice = ClosedEnum<typeof RunAgentModelVoice>;
|
|
15
20
|
/**
|
|
16
|
-
*
|
|
21
|
+
* Specifies the output audio format. Must be one of wav, mp3, flac, opus, or pcm16.
|
|
17
22
|
*/
|
|
18
|
-
export declare const
|
|
19
|
-
readonly
|
|
23
|
+
export declare const RunAgentModelFormat: {
|
|
24
|
+
readonly Wav: "wav";
|
|
25
|
+
readonly Mp3: "mp3";
|
|
26
|
+
readonly Flac: "flac";
|
|
27
|
+
readonly Opus: "opus";
|
|
28
|
+
readonly Pcm16: "pcm16";
|
|
20
29
|
};
|
|
21
30
|
/**
|
|
22
|
-
*
|
|
23
|
-
*/
|
|
24
|
-
export type RunAgentRoleUserMessage = ClosedEnum<typeof RunAgentRoleUserMessage>;
|
|
25
|
-
/**
|
|
26
|
-
* Message role (user or tool for continuing executions)
|
|
31
|
+
* Specifies the output audio format. Must be one of wav, mp3, flac, opus, or pcm16.
|
|
27
32
|
*/
|
|
28
|
-
export type
|
|
29
|
-
export declare const RunAgentPublicMessagePartAgentsRequestKind: {
|
|
30
|
-
readonly ToolResult: "tool_result";
|
|
31
|
-
};
|
|
32
|
-
export type RunAgentPublicMessagePartAgentsRequestKind = ClosedEnum<typeof RunAgentPublicMessagePartAgentsRequestKind>;
|
|
33
|
+
export type RunAgentModelFormat = ClosedEnum<typeof RunAgentModelFormat>;
|
|
33
34
|
/**
|
|
34
|
-
*
|
|
35
|
+
* Parameters for audio output. Required when audio output is requested with modalities: ["audio"]. Learn more.
|
|
35
36
|
*/
|
|
36
|
-
export type
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
37
|
+
export type RunAgentModelAudio = {
|
|
38
|
+
/**
|
|
39
|
+
* The voice the model uses to respond. Supported voices are alloy, echo, fable, onyx, nova, and shimmer.
|
|
40
|
+
*/
|
|
41
|
+
voice: RunAgentModelVoice;
|
|
42
|
+
/**
|
|
43
|
+
* Specifies the output audio format. Must be one of wav, mp3, flac, opus, or pcm16.
|
|
44
|
+
*/
|
|
45
|
+
format: RunAgentModelFormat;
|
|
43
46
|
};
|
|
44
|
-
export declare const
|
|
45
|
-
readonly
|
|
47
|
+
export declare const RunAgentResponseFormatAgentsRequestType: {
|
|
48
|
+
readonly JsonSchema: "json_schema";
|
|
46
49
|
};
|
|
47
|
-
export type
|
|
48
|
-
|
|
49
|
-
* File in URI format. Check in the model's documentation for the supported mime types for the URI format
|
|
50
|
-
*/
|
|
51
|
-
export type FileFileInURIFormat = {
|
|
50
|
+
export type RunAgentResponseFormatAgentsRequestType = ClosedEnum<typeof RunAgentResponseFormatAgentsRequestType>;
|
|
51
|
+
export type RunAgentResponseFormatJsonSchema = {
|
|
52
52
|
/**
|
|
53
|
-
*
|
|
53
|
+
* A description of what the response format is for, used by the model to determine how to respond in the format.
|
|
54
54
|
*/
|
|
55
|
-
|
|
55
|
+
description?: string | undefined;
|
|
56
56
|
/**
|
|
57
|
-
*
|
|
57
|
+
* The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.
|
|
58
58
|
*/
|
|
59
|
-
|
|
59
|
+
name: string;
|
|
60
60
|
/**
|
|
61
|
-
*
|
|
61
|
+
* The schema for the response format, described as a JSON Schema object.
|
|
62
62
|
*/
|
|
63
|
-
|
|
63
|
+
schema?: any | undefined;
|
|
64
|
+
/**
|
|
65
|
+
* Whether to enable strict schema adherence when generating the output. If set to true, the model will always follow the exact schema defined in the schema field. Only a subset of JSON Schema is supported when strict is true.
|
|
66
|
+
*/
|
|
67
|
+
strict?: boolean | undefined;
|
|
68
|
+
};
|
|
69
|
+
export type RunAgentResponseFormat3 = {
|
|
70
|
+
type: RunAgentResponseFormatAgentsRequestType;
|
|
71
|
+
jsonSchema: RunAgentResponseFormatJsonSchema;
|
|
72
|
+
};
|
|
73
|
+
export declare const RunAgentResponseFormatAgentsType: {
|
|
74
|
+
readonly JsonObject: "json_object";
|
|
75
|
+
};
|
|
76
|
+
export type RunAgentResponseFormatAgentsType = ClosedEnum<typeof RunAgentResponseFormatAgentsType>;
|
|
77
|
+
export type RunAgentResponseFormat2 = {
|
|
78
|
+
type: RunAgentResponseFormatAgentsType;
|
|
79
|
+
};
|
|
80
|
+
export declare const RunAgentResponseFormatType: {
|
|
81
|
+
readonly Text: "text";
|
|
82
|
+
};
|
|
83
|
+
export type RunAgentResponseFormatType = ClosedEnum<typeof RunAgentResponseFormatType>;
|
|
84
|
+
export type RunAgentResponseFormat1 = {
|
|
85
|
+
type: RunAgentResponseFormatType;
|
|
64
86
|
};
|
|
65
87
|
/**
|
|
66
|
-
*
|
|
88
|
+
* An object specifying the format that the model must output
|
|
67
89
|
*/
|
|
68
|
-
export type
|
|
90
|
+
export type RunAgentModelResponseFormat = RunAgentResponseFormat3 | RunAgentResponseFormat1 | RunAgentResponseFormat2;
|
|
91
|
+
/**
|
|
92
|
+
* Up to 4 sequences where the API will stop generating further tokens.
|
|
93
|
+
*/
|
|
94
|
+
export type RunAgentModelStop = string | Array<string>;
|
|
95
|
+
/**
|
|
96
|
+
* Options for streaming response. Only set this when you set stream: true.
|
|
97
|
+
*/
|
|
98
|
+
export type RunAgentModelStreamOptions = {
|
|
69
99
|
/**
|
|
70
|
-
*
|
|
100
|
+
* If set, an additional chunk will be streamed before the data: [DONE] message. The usage field on this chunk shows the token usage statistics for the entire request, and the choices field will always be an empty array. All other chunks will also include a usage field, but with a null value.
|
|
71
101
|
*/
|
|
72
|
-
|
|
102
|
+
includeUsage?: boolean | undefined;
|
|
103
|
+
};
|
|
104
|
+
/**
|
|
105
|
+
* Enables or disables the thinking mode capability
|
|
106
|
+
*/
|
|
107
|
+
export declare const RunAgentModelType: {
|
|
108
|
+
readonly Enabled: "enabled";
|
|
109
|
+
readonly Disabled: "disabled";
|
|
110
|
+
};
|
|
111
|
+
/**
|
|
112
|
+
* Enables or disables the thinking mode capability
|
|
113
|
+
*/
|
|
114
|
+
export type RunAgentModelType = ClosedEnum<typeof RunAgentModelType>;
|
|
115
|
+
export type RunAgentModelThinking = {
|
|
73
116
|
/**
|
|
74
|
-
*
|
|
117
|
+
* Enables or disables the thinking mode capability
|
|
75
118
|
*/
|
|
76
|
-
|
|
119
|
+
type: RunAgentModelType;
|
|
77
120
|
/**
|
|
78
|
-
*
|
|
121
|
+
* Determines how many tokens the model can use for its internal reasoning process. Larger budgets can enable more thorough analysis for complex problems, improving response quality. Must be ≥1024 and less than `max_tokens`.
|
|
79
122
|
*/
|
|
80
|
-
|
|
123
|
+
budgetTokens: number;
|
|
81
124
|
};
|
|
82
|
-
export type RunAgentPublicMessagePartFile = FileBinaryFormat | FileFileInURIFormat;
|
|
83
125
|
/**
|
|
84
|
-
*
|
|
126
|
+
* The type of the tool. Currently, only function is supported.
|
|
85
127
|
*/
|
|
86
|
-
export
|
|
87
|
-
|
|
88
|
-
file: FileBinaryFormat | FileFileInURIFormat;
|
|
89
|
-
metadata?: {
|
|
90
|
-
[k: string]: any;
|
|
91
|
-
} | undefined;
|
|
92
|
-
};
|
|
93
|
-
export declare const RunAgentPublicMessagePartKind: {
|
|
94
|
-
readonly Text: "text";
|
|
128
|
+
export declare const RunAgentToolChoiceType: {
|
|
129
|
+
readonly Function: "function";
|
|
95
130
|
};
|
|
96
|
-
export type RunAgentPublicMessagePartKind = ClosedEnum<typeof RunAgentPublicMessagePartKind>;
|
|
97
131
|
/**
|
|
98
|
-
*
|
|
132
|
+
* The type of the tool. Currently, only function is supported.
|
|
99
133
|
*/
|
|
100
|
-
export type
|
|
101
|
-
|
|
102
|
-
|
|
134
|
+
export type RunAgentToolChoiceType = ClosedEnum<typeof RunAgentToolChoiceType>;
|
|
135
|
+
export type RunAgentToolChoiceFunction = {
|
|
136
|
+
/**
|
|
137
|
+
* The name of the function to call.
|
|
138
|
+
*/
|
|
139
|
+
name?: string | undefined;
|
|
140
|
+
};
|
|
141
|
+
export type RunAgentToolChoice2 = {
|
|
142
|
+
/**
|
|
143
|
+
* The type of the tool. Currently, only function is supported.
|
|
144
|
+
*/
|
|
145
|
+
type?: RunAgentToolChoiceType | undefined;
|
|
146
|
+
function: RunAgentToolChoiceFunction;
|
|
147
|
+
};
|
|
148
|
+
export declare const RunAgentToolChoice1: {
|
|
149
|
+
readonly None: "none";
|
|
150
|
+
readonly Auto: "auto";
|
|
151
|
+
readonly Required: "required";
|
|
103
152
|
};
|
|
153
|
+
export type RunAgentToolChoice1 = ClosedEnum<typeof RunAgentToolChoice1>;
|
|
104
154
|
/**
|
|
105
|
-
*
|
|
155
|
+
* Controls which (if any) tool is called by the model.
|
|
106
156
|
*/
|
|
107
|
-
export type
|
|
157
|
+
export type RunAgentModelToolChoice = RunAgentToolChoice2 | RunAgentToolChoice1;
|
|
158
|
+
export declare const RunAgentModelModalities: {
|
|
159
|
+
readonly Text: "text";
|
|
160
|
+
readonly Audio: "audio";
|
|
161
|
+
};
|
|
162
|
+
export type RunAgentModelModalities = ClosedEnum<typeof RunAgentModelModalities>;
|
|
108
163
|
/**
|
|
109
|
-
*
|
|
164
|
+
* This tool searches the web for relevant results to use in a response. Learn more about the web search tool.
|
|
110
165
|
*/
|
|
111
|
-
export type
|
|
166
|
+
export type RunAgentModelWebSearchOptions = {
|
|
112
167
|
/**
|
|
113
|
-
*
|
|
168
|
+
* Whether to enable web search for this request.
|
|
114
169
|
*/
|
|
115
|
-
|
|
170
|
+
enabled?: boolean | undefined;
|
|
171
|
+
};
|
|
172
|
+
/**
|
|
173
|
+
* Model parameters to customize behavior (snake_case). Common: temperature (0-1, controls randomness), max_tokens (response length). Advanced: top_p (nucleus sampling), frequency_penalty, presence_penalty, response_format, reasoning_effort. Not all parameters work with all models.
|
|
174
|
+
*/
|
|
175
|
+
export type RunAgentModelParameters = {
|
|
116
176
|
/**
|
|
117
|
-
*
|
|
177
|
+
* Parameters for audio output. Required when audio output is requested with modalities: ["audio"]. Learn more.
|
|
118
178
|
*/
|
|
119
|
-
|
|
179
|
+
audio?: RunAgentModelAudio | null | undefined;
|
|
120
180
|
/**
|
|
121
|
-
*
|
|
181
|
+
* Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim.
|
|
122
182
|
*/
|
|
123
|
-
|
|
124
|
-
};
|
|
125
|
-
/**
|
|
126
|
-
* Information about the contact making the request. If the contact does not exist, it will be created automatically.
|
|
127
|
-
*/
|
|
128
|
-
export type RunAgentContact = {
|
|
183
|
+
frequencyPenalty?: number | null | undefined;
|
|
129
184
|
/**
|
|
130
|
-
*
|
|
185
|
+
* `[Deprecated]`. The maximum number of tokens that can be generated in the chat completion. This value can be used to control costs for text generated via API.
|
|
186
|
+
*
|
|
187
|
+
* @remarks
|
|
188
|
+
*
|
|
189
|
+
* This value is now `deprecated` in favor of `max_completion_tokens`, and is not compatible with o1 series models.
|
|
131
190
|
*/
|
|
132
|
-
|
|
191
|
+
maxTokens?: number | null | undefined;
|
|
133
192
|
/**
|
|
134
|
-
*
|
|
193
|
+
* An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and reasoning tokens
|
|
135
194
|
*/
|
|
136
|
-
|
|
195
|
+
maxCompletionTokens?: number | null | undefined;
|
|
137
196
|
/**
|
|
138
|
-
*
|
|
197
|
+
* Whether to return log probabilities of the output tokens or not. If true, returns the log probabilities of each output token returned in the content of message.
|
|
139
198
|
*/
|
|
140
|
-
|
|
199
|
+
logprobs?: boolean | null | undefined;
|
|
141
200
|
/**
|
|
142
|
-
*
|
|
201
|
+
* An integer between 0 and 20 specifying the number of most likely tokens to return at each token position, each with an associated log probability. logprobs must be set to true if this parameter is used.
|
|
143
202
|
*/
|
|
144
|
-
|
|
145
|
-
[k: string]: any;
|
|
146
|
-
}> | undefined;
|
|
203
|
+
topLogprobs?: number | null | undefined;
|
|
147
204
|
/**
|
|
148
|
-
*
|
|
205
|
+
* How many chat completion choices to generate for each input message. Note that you will be charged based on the number of generated tokens across all of the choices. Keep n as 1 to minimize costs.
|
|
149
206
|
*/
|
|
150
|
-
|
|
207
|
+
n?: number | null | undefined;
|
|
151
208
|
/**
|
|
152
|
-
*
|
|
209
|
+
* Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics.
|
|
153
210
|
*/
|
|
154
|
-
|
|
155
|
-
};
|
|
156
|
-
/**
|
|
157
|
-
* Thread information to group related requests
|
|
158
|
-
*/
|
|
159
|
-
export type RunAgentThread = {
|
|
211
|
+
presencePenalty?: number | null | undefined;
|
|
160
212
|
/**
|
|
161
|
-
*
|
|
213
|
+
* An object specifying the format that the model must output
|
|
162
214
|
*/
|
|
163
|
-
|
|
215
|
+
responseFormat?: RunAgentResponseFormat3 | RunAgentResponseFormat1 | RunAgentResponseFormat2 | undefined;
|
|
164
216
|
/**
|
|
165
|
-
*
|
|
217
|
+
* Constrains effort on reasoning for reasoning models. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.
|
|
166
218
|
*/
|
|
167
|
-
|
|
168
|
-
};
|
|
169
|
-
/**
|
|
170
|
-
* Memory configuration for the agent execution. Used to associate memory stores with specific entities like users or sessions.
|
|
171
|
-
*/
|
|
172
|
-
export type RunAgentMemory = {
|
|
219
|
+
reasoningEffort?: string | undefined;
|
|
173
220
|
/**
|
|
174
|
-
*
|
|
221
|
+
* Adjusts response verbosity. Lower levels yield shorter answers.
|
|
175
222
|
*/
|
|
176
|
-
|
|
177
|
-
};
|
|
178
|
-
export type RunAgentKnowledgeBases = {
|
|
223
|
+
verbosity?: string | undefined;
|
|
179
224
|
/**
|
|
180
|
-
*
|
|
225
|
+
* If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same seed and parameters should return the same result.
|
|
181
226
|
*/
|
|
182
|
-
|
|
183
|
-
};
|
|
184
|
-
export type RunAgentTeamOfAgents = {
|
|
227
|
+
seed?: number | null | undefined;
|
|
185
228
|
/**
|
|
186
|
-
*
|
|
229
|
+
* Up to 4 sequences where the API will stop generating further tokens.
|
|
187
230
|
*/
|
|
188
|
-
|
|
231
|
+
stop?: string | Array<string> | null | undefined;
|
|
189
232
|
/**
|
|
190
|
-
*
|
|
233
|
+
* Options for streaming response. Only set this when you set stream: true.
|
|
191
234
|
*/
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
export declare const RunAgentAgentToolInputRunAgentsRequestRequestBodySettingsTools14Type: {
|
|
195
|
-
readonly Function: "function";
|
|
196
|
-
};
|
|
197
|
-
export type RunAgentAgentToolInputRunAgentsRequestRequestBodySettingsTools14Type = ClosedEnum<typeof RunAgentAgentToolInputRunAgentsRequestRequestBodySettingsTools14Type>;
|
|
198
|
-
export type AgentToolInputRunFunction = {
|
|
235
|
+
streamOptions?: RunAgentModelStreamOptions | null | undefined;
|
|
236
|
+
thinking?: RunAgentModelThinking | undefined;
|
|
199
237
|
/**
|
|
200
|
-
*
|
|
238
|
+
* What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.
|
|
201
239
|
*/
|
|
202
|
-
|
|
240
|
+
temperature?: number | null | undefined;
|
|
203
241
|
/**
|
|
204
|
-
*
|
|
242
|
+
* An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass.
|
|
205
243
|
*/
|
|
206
|
-
|
|
244
|
+
topP?: number | null | undefined;
|
|
207
245
|
/**
|
|
208
|
-
*
|
|
246
|
+
* Limits the model to consider only the top k most likely tokens at each step.
|
|
209
247
|
*/
|
|
210
|
-
|
|
248
|
+
topK?: number | null | undefined;
|
|
211
249
|
/**
|
|
212
|
-
*
|
|
250
|
+
* Controls which (if any) tool is called by the model.
|
|
213
251
|
*/
|
|
214
|
-
|
|
215
|
-
[k: string]: any;
|
|
216
|
-
} | undefined;
|
|
217
|
-
};
|
|
218
|
-
/**
|
|
219
|
-
* Function tool with inline definition for on-the-fly creation in run endpoint
|
|
220
|
-
*/
|
|
221
|
-
export type FunctionToolRun = {
|
|
222
|
-
type: RunAgentAgentToolInputRunAgentsRequestRequestBodySettingsTools14Type;
|
|
252
|
+
toolChoice?: RunAgentToolChoice2 | RunAgentToolChoice1 | undefined;
|
|
223
253
|
/**
|
|
224
|
-
*
|
|
254
|
+
* Whether to enable parallel function calling during tool use.
|
|
225
255
|
*/
|
|
226
|
-
|
|
227
|
-
id?: string | undefined;
|
|
228
|
-
displayName?: string | undefined;
|
|
229
|
-
description?: string | undefined;
|
|
230
|
-
function: AgentToolInputRunFunction;
|
|
231
|
-
requiresApproval?: boolean | undefined;
|
|
232
|
-
};
|
|
233
|
-
export declare const RunAgentAgentToolInputRunAgentsRequestRequestBodySettingsTools13Type: {
|
|
234
|
-
readonly Code: "code";
|
|
235
|
-
};
|
|
236
|
-
export type RunAgentAgentToolInputRunAgentsRequestRequestBodySettingsTools13Type = ClosedEnum<typeof RunAgentAgentToolInputRunAgentsRequestRequestBodySettingsTools13Type>;
|
|
237
|
-
export declare const Language: {
|
|
238
|
-
readonly Python: "python";
|
|
239
|
-
};
|
|
240
|
-
export type Language = ClosedEnum<typeof Language>;
|
|
241
|
-
export type CodeTool = {
|
|
256
|
+
parallelToolCalls?: boolean | undefined;
|
|
242
257
|
/**
|
|
243
|
-
*
|
|
258
|
+
* Output types that you would like the model to generate. Most models are capable of generating text, which is the default: ["text"]. The gpt-4o-audio-preview model can also be used to generate audio. To request that this model generate both text and audio responses, you can use: ["text", "audio"].
|
|
244
259
|
*/
|
|
245
|
-
|
|
246
|
-
[k: string]: any;
|
|
247
|
-
} | undefined;
|
|
248
|
-
language: Language;
|
|
260
|
+
modalities?: Array<RunAgentModelModalities> | null | undefined;
|
|
249
261
|
/**
|
|
250
|
-
*
|
|
262
|
+
* This tool searches the web for relevant results to use in a response. Learn more about the web search tool.
|
|
251
263
|
*/
|
|
252
|
-
|
|
264
|
+
webSearchOptions?: RunAgentModelWebSearchOptions | undefined;
|
|
253
265
|
};
|
|
254
266
|
/**
|
|
255
|
-
*
|
|
267
|
+
* Model configuration with parameters
|
|
256
268
|
*/
|
|
257
|
-
export type
|
|
258
|
-
type: RunAgentAgentToolInputRunAgentsRequestRequestBodySettingsTools13Type;
|
|
269
|
+
export type RunAgentModel2 = {
|
|
259
270
|
/**
|
|
260
|
-
*
|
|
271
|
+
* Model ID or provider/model string
|
|
261
272
|
*/
|
|
262
|
-
|
|
263
|
-
id?: string | undefined;
|
|
264
|
-
displayName?: string | undefined;
|
|
273
|
+
id: string;
|
|
265
274
|
/**
|
|
266
|
-
*
|
|
275
|
+
* Optional integration ID for custom configurations
|
|
267
276
|
*/
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
277
|
+
integrationId?: string | null | undefined;
|
|
278
|
+
/**
|
|
279
|
+
* Model parameters to customize behavior (snake_case). Common: temperature (0-1, controls randomness), max_tokens (response length). Advanced: top_p (nucleus sampling), frequency_penalty, presence_penalty, response_format, reasoning_effort. Not all parameters work with all models.
|
|
280
|
+
*/
|
|
281
|
+
parameters?: RunAgentModelParameters | undefined;
|
|
271
282
|
};
|
|
272
|
-
|
|
273
|
-
|
|
283
|
+
/**
|
|
284
|
+
* The language model that powers the agent. Can be a simple string (e.g., "openai/gpt-4o") or an object with model ID and parameters. The model must support tool calling capabilities.
|
|
285
|
+
*/
|
|
286
|
+
export type RunAgentModel = RunAgentModel2 | string;
|
|
287
|
+
/**
|
|
288
|
+
* The voice the model uses to respond. Supported voices are alloy, echo, fable, onyx, nova, and shimmer.
|
|
289
|
+
*/
|
|
290
|
+
export declare const RunAgentFallbackModelsVoice: {
|
|
291
|
+
readonly Alloy: "alloy";
|
|
292
|
+
readonly Echo: "echo";
|
|
293
|
+
readonly Fable: "fable";
|
|
294
|
+
readonly Onyx: "onyx";
|
|
295
|
+
readonly Nova: "nova";
|
|
296
|
+
readonly Shimmer: "shimmer";
|
|
274
297
|
};
|
|
275
|
-
export type RunAgentAgentToolInputRunAgentsRequestRequestBodySettingsTools12Type = ClosedEnum<typeof RunAgentAgentToolInputRunAgentsRequestRequestBodySettingsTools12Type>;
|
|
276
298
|
/**
|
|
277
|
-
* The
|
|
299
|
+
* The voice the model uses to respond. Supported voices are alloy, echo, fable, onyx, nova, and shimmer.
|
|
278
300
|
*/
|
|
279
|
-
export
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
|
|
301
|
+
export type RunAgentFallbackModelsVoice = ClosedEnum<typeof RunAgentFallbackModelsVoice>;
|
|
302
|
+
/**
|
|
303
|
+
* Specifies the output audio format. Must be one of wav, mp3, flac, opus, or pcm16.
|
|
304
|
+
*/
|
|
305
|
+
export declare const RunAgentFallbackModelsFormat: {
|
|
306
|
+
readonly Wav: "wav";
|
|
307
|
+
readonly Mp3: "mp3";
|
|
308
|
+
readonly Flac: "flac";
|
|
309
|
+
readonly Opus: "opus";
|
|
310
|
+
readonly Pcm16: "pcm16";
|
|
284
311
|
};
|
|
285
312
|
/**
|
|
286
|
-
*
|
|
313
|
+
* Specifies the output audio format. Must be one of wav, mp3, flac, opus, or pcm16.
|
|
287
314
|
*/
|
|
288
|
-
export type
|
|
315
|
+
export type RunAgentFallbackModelsFormat = ClosedEnum<typeof RunAgentFallbackModelsFormat>;
|
|
289
316
|
/**
|
|
290
|
-
*
|
|
317
|
+
* Parameters for audio output. Required when audio output is requested with modalities: ["audio"]. Learn more.
|
|
291
318
|
*/
|
|
292
|
-
export type
|
|
319
|
+
export type RunAgentFallbackModelsAudio = {
|
|
293
320
|
/**
|
|
294
|
-
* The
|
|
321
|
+
* The voice the model uses to respond. Supported voices are alloy, echo, fable, onyx, nova, and shimmer.
|
|
295
322
|
*/
|
|
296
|
-
|
|
323
|
+
voice: RunAgentFallbackModelsVoice;
|
|
297
324
|
/**
|
|
298
|
-
*
|
|
325
|
+
* Specifies the output audio format. Must be one of wav, mp3, flac, opus, or pcm16.
|
|
299
326
|
*/
|
|
300
|
-
|
|
327
|
+
format: RunAgentFallbackModelsFormat;
|
|
328
|
+
};
|
|
329
|
+
export declare const RunAgentResponseFormatAgentsRequestRequestBodyFallbackModels2Type: {
|
|
330
|
+
readonly JsonSchema: "json_schema";
|
|
331
|
+
};
|
|
332
|
+
export type RunAgentResponseFormatAgentsRequestRequestBodyFallbackModels2Type = ClosedEnum<typeof RunAgentResponseFormatAgentsRequestRequestBodyFallbackModels2Type>;
|
|
333
|
+
export type RunAgentResponseFormatAgentsJsonSchema = {
|
|
301
334
|
/**
|
|
302
|
-
*
|
|
335
|
+
* A description of what the response format is for, used by the model to determine how to respond in the format.
|
|
303
336
|
*/
|
|
304
|
-
|
|
305
|
-
[k: string]: string;
|
|
306
|
-
} | undefined;
|
|
337
|
+
description?: string | undefined;
|
|
307
338
|
/**
|
|
308
|
-
* The
|
|
339
|
+
* The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.
|
|
309
340
|
*/
|
|
310
|
-
|
|
311
|
-
[k: string]: any;
|
|
312
|
-
} | undefined;
|
|
313
|
-
};
|
|
314
|
-
/**
|
|
315
|
-
* The type of the argument.
|
|
316
|
-
*/
|
|
317
|
-
export declare const RunAgentAgentToolInputRunAgentsRequestRequestBodySettingsTools12HttpType: {
|
|
318
|
-
readonly String: "string";
|
|
319
|
-
readonly Number: "number";
|
|
320
|
-
readonly Boolean: "boolean";
|
|
321
|
-
};
|
|
322
|
-
/**
|
|
323
|
-
* The type of the argument.
|
|
324
|
-
*/
|
|
325
|
-
export type RunAgentAgentToolInputRunAgentsRequestRequestBodySettingsTools12HttpType = ClosedEnum<typeof RunAgentAgentToolInputRunAgentsRequestRequestBodySettingsTools12HttpType>;
|
|
326
|
-
/**
|
|
327
|
-
* The default value of the argument.
|
|
328
|
-
*/
|
|
329
|
-
export type DefaultValue = string | number | boolean;
|
|
330
|
-
export type Arguments = {
|
|
331
|
-
/**
|
|
332
|
-
* The type of the argument.
|
|
333
|
-
*/
|
|
334
|
-
type: RunAgentAgentToolInputRunAgentsRequestRequestBodySettingsTools12HttpType;
|
|
335
|
-
/**
|
|
336
|
-
* A description of the argument.
|
|
337
|
-
*/
|
|
338
|
-
description: string;
|
|
341
|
+
name: string;
|
|
339
342
|
/**
|
|
340
|
-
*
|
|
343
|
+
* The schema for the response format, described as a JSON Schema object.
|
|
341
344
|
*/
|
|
342
|
-
|
|
345
|
+
schema?: any | undefined;
|
|
343
346
|
/**
|
|
344
|
-
*
|
|
347
|
+
* Whether to enable strict schema adherence when generating the output. If set to true, the model will always follow the exact schema defined in the schema field. Only a subset of JSON Schema is supported when strict is true.
|
|
345
348
|
*/
|
|
346
|
-
|
|
349
|
+
strict?: boolean | undefined;
|
|
347
350
|
};
|
|
348
|
-
export type
|
|
349
|
-
|
|
350
|
-
|
|
351
|
-
*/
|
|
352
|
-
blueprint: Blueprint;
|
|
353
|
-
/**
|
|
354
|
-
* The arguments to send with the request. The keys will be used to replace the placeholders in the `blueprint` field.
|
|
355
|
-
*/
|
|
356
|
-
arguments?: {
|
|
357
|
-
[k: string]: Arguments;
|
|
358
|
-
} | undefined;
|
|
351
|
+
export type RunAgentResponseFormatAgents3 = {
|
|
352
|
+
type: RunAgentResponseFormatAgentsRequestRequestBodyFallbackModels2Type;
|
|
353
|
+
jsonSchema: RunAgentResponseFormatAgentsJsonSchema;
|
|
359
354
|
};
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
*/
|
|
363
|
-
export type HTTPToolRun = {
|
|
364
|
-
type: RunAgentAgentToolInputRunAgentsRequestRequestBodySettingsTools12Type;
|
|
365
|
-
/**
|
|
366
|
-
* Unique key of the tool as it will be displayed in the UI
|
|
367
|
-
*/
|
|
368
|
-
key: string;
|
|
369
|
-
id?: string | undefined;
|
|
370
|
-
displayName?: string | undefined;
|
|
371
|
-
/**
|
|
372
|
-
* A description of the tool, used by the model to choose when and how to call the tool. We do recommend using the `description` field as accurate as possible to give enough context to the model to make the right decision.
|
|
373
|
-
*/
|
|
374
|
-
description: string;
|
|
375
|
-
http: Http;
|
|
376
|
-
requiresApproval?: boolean | undefined;
|
|
355
|
+
export declare const RunAgentResponseFormatAgentsRequestRequestBodyFallbackModelsType: {
|
|
356
|
+
readonly JsonObject: "json_object";
|
|
377
357
|
};
|
|
378
|
-
export
|
|
379
|
-
|
|
358
|
+
export type RunAgentResponseFormatAgentsRequestRequestBodyFallbackModelsType = ClosedEnum<typeof RunAgentResponseFormatAgentsRequestRequestBodyFallbackModelsType>;
|
|
359
|
+
export type RunAgentResponseFormatAgents2 = {
|
|
360
|
+
type: RunAgentResponseFormatAgentsRequestRequestBodyFallbackModelsType;
|
|
380
361
|
};
|
|
381
|
-
export
|
|
382
|
-
|
|
383
|
-
* Returns the current date and time
|
|
384
|
-
*/
|
|
385
|
-
export type AgentToolInputRunCurrentDateTool = {
|
|
386
|
-
type: RunAgentAgentToolInputRunAgentsRequestRequestBodySettingsTools11Type;
|
|
387
|
-
/**
|
|
388
|
-
* Whether this tool requires approval before execution
|
|
389
|
-
*/
|
|
390
|
-
requiresApproval?: boolean | undefined;
|
|
362
|
+
export declare const RunAgentResponseFormatAgentsRequestRequestBodyType: {
|
|
363
|
+
readonly Text: "text";
|
|
391
364
|
};
|
|
392
|
-
export
|
|
393
|
-
|
|
365
|
+
export type RunAgentResponseFormatAgentsRequestRequestBodyType = ClosedEnum<typeof RunAgentResponseFormatAgentsRequestRequestBodyType>;
|
|
366
|
+
export type RunAgentResponseFormatAgents1 = {
|
|
367
|
+
type: RunAgentResponseFormatAgentsRequestRequestBodyType;
|
|
394
368
|
};
|
|
395
|
-
export type RunAgentAgentToolInputRunAgentsRequestRequestBodySettingsTools10Type = ClosedEnum<typeof RunAgentAgentToolInputRunAgentsRequestRequestBodySettingsTools10Type>;
|
|
396
369
|
/**
|
|
397
|
-
*
|
|
370
|
+
* An object specifying the format that the model must output
|
|
398
371
|
*/
|
|
399
|
-
export type
|
|
400
|
-
type: RunAgentAgentToolInputRunAgentsRequestRequestBodySettingsTools10Type;
|
|
401
|
-
/**
|
|
402
|
-
* Whether this tool requires approval before execution
|
|
403
|
-
*/
|
|
404
|
-
requiresApproval?: boolean | undefined;
|
|
405
|
-
};
|
|
406
|
-
export declare const RunAgentAgentToolInputRunAgentsRequestRequestBodySettingsTools9Type: {
|
|
407
|
-
readonly RetrieveKnowledgeBases: "retrieve_knowledge_bases";
|
|
408
|
-
};
|
|
409
|
-
export type RunAgentAgentToolInputRunAgentsRequestRequestBodySettingsTools9Type = ClosedEnum<typeof RunAgentAgentToolInputRunAgentsRequestRequestBodySettingsTools9Type>;
|
|
372
|
+
export type RunAgentFallbackModelsResponseFormat = RunAgentResponseFormatAgents3 | RunAgentResponseFormatAgents1 | RunAgentResponseFormatAgents2;
|
|
410
373
|
/**
|
|
411
|
-
*
|
|
374
|
+
* Up to 4 sequences where the API will stop generating further tokens.
|
|
412
375
|
*/
|
|
413
|
-
export type
|
|
414
|
-
type: RunAgentAgentToolInputRunAgentsRequestRequestBodySettingsTools9Type;
|
|
415
|
-
/**
|
|
416
|
-
* Whether this tool requires approval before execution
|
|
417
|
-
*/
|
|
418
|
-
requiresApproval?: boolean | undefined;
|
|
419
|
-
};
|
|
420
|
-
export declare const RunAgentAgentToolInputRunAgentsRequestRequestBodySettingsTools8Type: {
|
|
421
|
-
readonly DeleteMemoryDocument: "delete_memory_document";
|
|
422
|
-
};
|
|
423
|
-
export type RunAgentAgentToolInputRunAgentsRequestRequestBodySettingsTools8Type = ClosedEnum<typeof RunAgentAgentToolInputRunAgentsRequestRequestBodySettingsTools8Type>;
|
|
376
|
+
export type RunAgentFallbackModelsStop = string | Array<string>;
|
|
424
377
|
/**
|
|
425
|
-
*
|
|
378
|
+
* Options for streaming response. Only set this when you set stream: true.
|
|
426
379
|
*/
|
|
427
|
-
export type
|
|
428
|
-
type: RunAgentAgentToolInputRunAgentsRequestRequestBodySettingsTools8Type;
|
|
380
|
+
export type RunAgentFallbackModelsStreamOptions = {
|
|
429
381
|
/**
|
|
430
|
-
*
|
|
382
|
+
* If set, an additional chunk will be streamed before the data: [DONE] message. The usage field on this chunk shows the token usage statistics for the entire request, and the choices field will always be an empty array. All other chunks will also include a usage field, but with a null value.
|
|
431
383
|
*/
|
|
432
|
-
|
|
433
|
-
};
|
|
434
|
-
export declare const RunAgentAgentToolInputRunAgentsRequestRequestBodySettingsToolsType: {
|
|
435
|
-
readonly RetrieveMemoryStores: "retrieve_memory_stores";
|
|
384
|
+
includeUsage?: boolean | undefined;
|
|
436
385
|
};
|
|
437
|
-
export type RunAgentAgentToolInputRunAgentsRequestRequestBodySettingsToolsType = ClosedEnum<typeof RunAgentAgentToolInputRunAgentsRequestRequestBodySettingsToolsType>;
|
|
438
386
|
/**
|
|
439
|
-
*
|
|
387
|
+
* Enables or disables the thinking mode capability
|
|
440
388
|
*/
|
|
441
|
-
export
|
|
442
|
-
|
|
443
|
-
|
|
444
|
-
* Whether this tool requires approval before execution
|
|
445
|
-
*/
|
|
446
|
-
requiresApproval?: boolean | undefined;
|
|
447
|
-
};
|
|
448
|
-
export declare const RunAgentAgentToolInputRunAgentsRequestRequestBodySettingsType: {
|
|
449
|
-
readonly WriteMemoryStore: "write_memory_store";
|
|
389
|
+
export declare const RunAgentFallbackModelsType: {
|
|
390
|
+
readonly Enabled: "enabled";
|
|
391
|
+
readonly Disabled: "disabled";
|
|
450
392
|
};
|
|
451
|
-
export type RunAgentAgentToolInputRunAgentsRequestRequestBodySettingsType = ClosedEnum<typeof RunAgentAgentToolInputRunAgentsRequestRequestBodySettingsType>;
|
|
452
393
|
/**
|
|
453
|
-
*
|
|
394
|
+
* Enables or disables the thinking mode capability
|
|
454
395
|
*/
|
|
455
|
-
export type
|
|
456
|
-
|
|
396
|
+
export type RunAgentFallbackModelsType = ClosedEnum<typeof RunAgentFallbackModelsType>;
|
|
397
|
+
export type RunAgentFallbackModelsThinking = {
|
|
457
398
|
/**
|
|
458
|
-
*
|
|
399
|
+
* Enables or disables the thinking mode capability
|
|
459
400
|
*/
|
|
460
|
-
|
|
461
|
-
};
|
|
462
|
-
export declare const RunAgentAgentToolInputRunAgentsRequestRequestBodyType: {
|
|
463
|
-
readonly QueryMemoryStore: "query_memory_store";
|
|
464
|
-
};
|
|
465
|
-
export type RunAgentAgentToolInputRunAgentsRequestRequestBodyType = ClosedEnum<typeof RunAgentAgentToolInputRunAgentsRequestRequestBodyType>;
|
|
466
|
-
/**
|
|
467
|
-
* Queries agent memory stores for context
|
|
468
|
-
*/
|
|
469
|
-
export type AgentToolInputRunQueryMemoryStoreTool = {
|
|
470
|
-
type: RunAgentAgentToolInputRunAgentsRequestRequestBodyType;
|
|
401
|
+
type: RunAgentFallbackModelsType;
|
|
471
402
|
/**
|
|
472
|
-
*
|
|
403
|
+
* Determines how many tokens the model can use for its internal reasoning process. Larger budgets can enable more thorough analysis for complex problems, improving response quality. Must be ≥1024 and less than `max_tokens`.
|
|
473
404
|
*/
|
|
474
|
-
|
|
475
|
-
};
|
|
476
|
-
export declare const RunAgentAgentToolInputRunAgentsRequestType: {
|
|
477
|
-
readonly RetrieveAgents: "retrieve_agents";
|
|
405
|
+
budgetTokens: number;
|
|
478
406
|
};
|
|
479
|
-
export type RunAgentAgentToolInputRunAgentsRequestType = ClosedEnum<typeof RunAgentAgentToolInputRunAgentsRequestType>;
|
|
480
407
|
/**
|
|
481
|
-
*
|
|
408
|
+
* The type of the tool. Currently, only function is supported.
|
|
482
409
|
*/
|
|
483
|
-
export
|
|
484
|
-
|
|
485
|
-
/**
|
|
486
|
-
* Whether this tool requires approval before execution
|
|
487
|
-
*/
|
|
488
|
-
requiresApproval?: boolean | undefined;
|
|
489
|
-
};
|
|
490
|
-
export declare const RunAgentAgentToolInputRunAgentsType: {
|
|
491
|
-
readonly CallSubAgent: "call_sub_agent";
|
|
410
|
+
export declare const RunAgentToolChoiceAgentsType: {
|
|
411
|
+
readonly Function: "function";
|
|
492
412
|
};
|
|
493
|
-
export type RunAgentAgentToolInputRunAgentsType = ClosedEnum<typeof RunAgentAgentToolInputRunAgentsType>;
|
|
494
413
|
/**
|
|
495
|
-
*
|
|
414
|
+
* The type of the tool. Currently, only function is supported.
|
|
496
415
|
*/
|
|
497
|
-
export type
|
|
498
|
-
|
|
416
|
+
export type RunAgentToolChoiceAgentsType = ClosedEnum<typeof RunAgentToolChoiceAgentsType>;
|
|
417
|
+
export type RunAgentToolChoiceAgentsFunction = {
|
|
499
418
|
/**
|
|
500
|
-
*
|
|
419
|
+
* The name of the function to call.
|
|
501
420
|
*/
|
|
502
|
-
|
|
503
|
-
};
|
|
504
|
-
export declare const RunAgentAgentToolInputRunType: {
|
|
505
|
-
readonly WebScraper: "web_scraper";
|
|
421
|
+
name?: string | undefined;
|
|
506
422
|
};
|
|
507
|
-
export type
|
|
508
|
-
/**
|
|
509
|
-
* Scrapes and extracts content from web pages
|
|
510
|
-
*/
|
|
511
|
-
export type AgentToolInputRunWebScraperTool = {
|
|
512
|
-
type: RunAgentAgentToolInputRunType;
|
|
423
|
+
export type RunAgentToolChoiceAgents2 = {
|
|
513
424
|
/**
|
|
514
|
-
*
|
|
425
|
+
* The type of the tool. Currently, only function is supported.
|
|
515
426
|
*/
|
|
516
|
-
|
|
427
|
+
type?: RunAgentToolChoiceAgentsType | undefined;
|
|
428
|
+
function: RunAgentToolChoiceAgentsFunction;
|
|
517
429
|
};
|
|
518
|
-
export declare const
|
|
519
|
-
readonly
|
|
430
|
+
export declare const RunAgentToolChoiceAgents1: {
|
|
431
|
+
readonly None: "none";
|
|
432
|
+
readonly Auto: "auto";
|
|
433
|
+
readonly Required: "required";
|
|
520
434
|
};
|
|
521
|
-
export type
|
|
435
|
+
export type RunAgentToolChoiceAgents1 = ClosedEnum<typeof RunAgentToolChoiceAgents1>;
|
|
522
436
|
/**
|
|
523
|
-
*
|
|
437
|
+
* Controls which (if any) tool is called by the model.
|
|
524
438
|
*/
|
|
525
|
-
export type
|
|
526
|
-
|
|
527
|
-
|
|
528
|
-
|
|
529
|
-
*/
|
|
530
|
-
requiresApproval?: boolean | undefined;
|
|
439
|
+
export type RunAgentFallbackModelsToolChoice = RunAgentToolChoiceAgents2 | RunAgentToolChoiceAgents1;
|
|
440
|
+
export declare const RunAgentFallbackModelsModalities: {
|
|
441
|
+
readonly Text: "text";
|
|
442
|
+
readonly Audio: "audio";
|
|
531
443
|
};
|
|
444
|
+
export type RunAgentFallbackModelsModalities = ClosedEnum<typeof RunAgentFallbackModelsModalities>;
|
|
532
445
|
/**
|
|
533
|
-
*
|
|
534
|
-
*/
|
|
535
|
-
export type AgentToolInputRun = HTTPToolRun | CodeToolRun | FunctionToolRun | AgentToolInputRunGoogleSearchTool | AgentToolInputRunWebScraperTool | AgentToolInputRunCallSubAgentTool | AgentToolInputRunRetrieveAgentsTool | AgentToolInputRunQueryMemoryStoreTool | AgentToolInputRunWriteMemoryStoreTool | AgentToolInputRunRetrieveMemoryStoresTool | AgentToolInputRunDeleteMemoryDocumentTool | AgentToolInputRunRetrieveKnowledgeBasesTool | AgentToolInputRunQueryKnowledgeBaseTool | AgentToolInputRunCurrentDateTool;
|
|
536
|
-
/**
|
|
537
|
-
* If all, the agent will require approval for all tools. If respect_tool, the agent will require approval for tools that have the requires_approval flag set to true. If none, the agent will not require approval for any tools.
|
|
446
|
+
* This tool searches the web for relevant results to use in a response. Learn more about the web search tool.
|
|
538
447
|
*/
|
|
539
|
-
export
|
|
540
|
-
|
|
541
|
-
|
|
542
|
-
|
|
448
|
+
export type RunAgentFallbackModelsWebSearchOptions = {
|
|
449
|
+
/**
|
|
450
|
+
* Whether to enable web search for this request.
|
|
451
|
+
*/
|
|
452
|
+
enabled?: boolean | undefined;
|
|
543
453
|
};
|
|
544
|
-
|
|
545
|
-
* If all, the agent will require approval for all tools. If respect_tool, the agent will require approval for tools that have the requires_approval flag set to true. If none, the agent will not require approval for any tools.
|
|
546
|
-
*/
|
|
547
|
-
export type RunAgentToolApprovalRequired = ClosedEnum<typeof RunAgentToolApprovalRequired>;
|
|
548
|
-
export type RunAgentSettings = {
|
|
454
|
+
export type RunAgentFallbackModelsParameters = {
|
|
549
455
|
/**
|
|
550
|
-
*
|
|
456
|
+
* Parameters for audio output. Required when audio output is requested with modalities: ["audio"]. Learn more.
|
|
551
457
|
*/
|
|
552
|
-
|
|
458
|
+
audio?: RunAgentFallbackModelsAudio | null | undefined;
|
|
553
459
|
/**
|
|
554
|
-
*
|
|
460
|
+
* Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim.
|
|
555
461
|
*/
|
|
556
|
-
|
|
462
|
+
frequencyPenalty?: number | null | undefined;
|
|
557
463
|
/**
|
|
558
|
-
*
|
|
464
|
+
* `[Deprecated]`. The maximum number of tokens that can be generated in the chat completion. This value can be used to control costs for text generated via API.
|
|
465
|
+
*
|
|
466
|
+
* @remarks
|
|
467
|
+
*
|
|
468
|
+
* This value is now `deprecated` in favor of `max_completion_tokens`, and is not compatible with o1 series models.
|
|
559
469
|
*/
|
|
560
|
-
|
|
470
|
+
maxTokens?: number | null | undefined;
|
|
561
471
|
/**
|
|
562
|
-
*
|
|
472
|
+
* An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and reasoning tokens
|
|
563
473
|
*/
|
|
564
|
-
|
|
565
|
-
};
|
|
566
|
-
export type RunAgentRequestBody = {
|
|
474
|
+
maxCompletionTokens?: number | null | undefined;
|
|
567
475
|
/**
|
|
568
|
-
*
|
|
476
|
+
* Whether to return log probabilities of the output tokens or not. If true, returns the log probabilities of each output token returned in the content of message.
|
|
569
477
|
*/
|
|
570
|
-
|
|
478
|
+
logprobs?: boolean | null | undefined;
|
|
571
479
|
/**
|
|
572
|
-
*
|
|
480
|
+
* An integer between 0 and 20 specifying the number of most likely tokens to return at each token position, each with an associated log probability. logprobs must be set to true if this parameter is used.
|
|
573
481
|
*/
|
|
574
|
-
|
|
482
|
+
topLogprobs?: number | null | undefined;
|
|
575
483
|
/**
|
|
576
|
-
*
|
|
484
|
+
* How many chat completion choices to generate for each input message. Note that you will be charged based on the number of generated tokens across all of the choices. Keep n as 1 to minimize costs.
|
|
577
485
|
*/
|
|
578
|
-
|
|
486
|
+
n?: number | null | undefined;
|
|
579
487
|
/**
|
|
580
|
-
*
|
|
488
|
+
* Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics.
|
|
581
489
|
*/
|
|
582
|
-
|
|
490
|
+
presencePenalty?: number | null | undefined;
|
|
583
491
|
/**
|
|
584
|
-
*
|
|
492
|
+
* An object specifying the format that the model must output
|
|
585
493
|
*/
|
|
586
|
-
|
|
494
|
+
responseFormat?: RunAgentResponseFormatAgents3 | RunAgentResponseFormatAgents1 | RunAgentResponseFormatAgents2 | undefined;
|
|
587
495
|
/**
|
|
588
|
-
*
|
|
496
|
+
* Constrains effort on reasoning for reasoning models. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.
|
|
589
497
|
*/
|
|
590
|
-
|
|
498
|
+
reasoningEffort?: string | undefined;
|
|
591
499
|
/**
|
|
592
|
-
*
|
|
500
|
+
* Adjusts response verbosity. Lower levels yield shorter answers.
|
|
593
501
|
*/
|
|
594
|
-
|
|
502
|
+
verbosity?: string | undefined;
|
|
595
503
|
/**
|
|
596
|
-
*
|
|
504
|
+
* If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same seed and parameters should return the same result.
|
|
597
505
|
*/
|
|
598
|
-
|
|
599
|
-
[k: string]: any;
|
|
600
|
-
} | undefined;
|
|
506
|
+
seed?: number | null | undefined;
|
|
601
507
|
/**
|
|
602
|
-
*
|
|
508
|
+
* Up to 4 sequences where the API will stop generating further tokens.
|
|
603
509
|
*/
|
|
604
|
-
|
|
510
|
+
stop?: string | Array<string> | null | undefined;
|
|
605
511
|
/**
|
|
606
|
-
*
|
|
512
|
+
* Options for streaming response. Only set this when you set stream: true.
|
|
607
513
|
*/
|
|
608
|
-
|
|
514
|
+
streamOptions?: RunAgentFallbackModelsStreamOptions | null | undefined;
|
|
515
|
+
thinking?: RunAgentFallbackModelsThinking | undefined;
|
|
609
516
|
/**
|
|
610
|
-
*
|
|
517
|
+
* What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.
|
|
611
518
|
*/
|
|
612
|
-
|
|
519
|
+
temperature?: number | null | undefined;
|
|
613
520
|
/**
|
|
614
|
-
*
|
|
615
|
-
*
|
|
616
|
-
* @remarks
|
|
617
|
-
*
|
|
618
|
-
* The first element identifies the project, followed by nested folders (auto-created as needed).
|
|
619
|
-
*
|
|
620
|
-
* With project-based API keys, the first element is treated as a folder name, as the project is predetermined by the API key.
|
|
521
|
+
* An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass.
|
|
621
522
|
*/
|
|
622
|
-
|
|
523
|
+
topP?: number | null | undefined;
|
|
623
524
|
/**
|
|
624
|
-
*
|
|
525
|
+
* Limits the model to consider only the top k most likely tokens at each step.
|
|
625
526
|
*/
|
|
626
|
-
|
|
527
|
+
topK?: number | null | undefined;
|
|
627
528
|
/**
|
|
628
|
-
*
|
|
529
|
+
* Controls which (if any) tool is called by the model.
|
|
629
530
|
*/
|
|
630
|
-
|
|
531
|
+
toolChoice?: RunAgentToolChoiceAgents2 | RunAgentToolChoiceAgents1 | undefined;
|
|
631
532
|
/**
|
|
632
|
-
*
|
|
533
|
+
* Whether to enable parallel function calling during tool use.
|
|
633
534
|
*/
|
|
634
|
-
|
|
535
|
+
parallelToolCalls?: boolean | undefined;
|
|
635
536
|
/**
|
|
636
|
-
*
|
|
537
|
+
* Output types that you would like the model to generate. Most models are capable of generating text, which is the default: ["text"]. The gpt-4o-audio-preview model can also be used to generate audio. To request that this model generate both text and audio responses, you can use: ["text", "audio"].
|
|
637
538
|
*/
|
|
638
|
-
|
|
539
|
+
modalities?: Array<RunAgentFallbackModelsModalities> | null | undefined;
|
|
639
540
|
/**
|
|
640
|
-
*
|
|
541
|
+
* This tool searches the web for relevant results to use in a response. Learn more about the web search tool.
|
|
641
542
|
*/
|
|
642
|
-
|
|
643
|
-
|
|
543
|
+
webSearchOptions?: RunAgentFallbackModelsWebSearchOptions | undefined;
|
|
544
|
+
};
|
|
545
|
+
export type RunAgentFallbackModels2 = {
|
|
644
546
|
/**
|
|
645
|
-
*
|
|
547
|
+
* Fallback model ID
|
|
646
548
|
*/
|
|
647
|
-
|
|
648
|
-
|
|
649
|
-
|
|
549
|
+
id: string;
|
|
550
|
+
integrationId?: string | null | undefined;
|
|
551
|
+
parameters?: RunAgentFallbackModelsParameters | undefined;
|
|
650
552
|
};
|
|
553
|
+
export type RunAgentFallbackModels = RunAgentFallbackModels2 | string;
|
|
651
554
|
/**
|
|
652
|
-
*
|
|
555
|
+
* Tool message
|
|
653
556
|
*/
|
|
654
|
-
export declare const
|
|
655
|
-
readonly
|
|
557
|
+
export declare const RunAgentRoleToolMessage: {
|
|
558
|
+
readonly Tool: "tool";
|
|
656
559
|
};
|
|
657
560
|
/**
|
|
658
|
-
*
|
|
561
|
+
* Tool message
|
|
659
562
|
*/
|
|
660
|
-
export type
|
|
563
|
+
export type RunAgentRoleToolMessage = ClosedEnum<typeof RunAgentRoleToolMessage>;
|
|
661
564
|
/**
|
|
662
|
-
*
|
|
565
|
+
* User message
|
|
663
566
|
*/
|
|
664
|
-
export declare const
|
|
665
|
-
readonly
|
|
666
|
-
readonly Working: "working";
|
|
667
|
-
readonly InputRequired: "input-required";
|
|
668
|
-
readonly Completed: "completed";
|
|
669
|
-
readonly Failed: "failed";
|
|
670
|
-
readonly Canceled: "canceled";
|
|
671
|
-
readonly Rejected: "rejected";
|
|
672
|
-
readonly AuthRequired: "auth-required";
|
|
673
|
-
readonly Unknown: "unknown";
|
|
567
|
+
export declare const RunAgentRoleUserMessage: {
|
|
568
|
+
readonly User: "user";
|
|
674
569
|
};
|
|
675
570
|
/**
|
|
676
|
-
*
|
|
571
|
+
* User message
|
|
677
572
|
*/
|
|
678
|
-
export type
|
|
679
|
-
|
|
680
|
-
|
|
573
|
+
export type RunAgentRoleUserMessage = ClosedEnum<typeof RunAgentRoleUserMessage>;
|
|
574
|
+
/**
|
|
575
|
+
* Message role (user or tool for continuing executions)
|
|
576
|
+
*/
|
|
577
|
+
export type RunAgentRole = RunAgentRoleUserMessage | RunAgentRoleToolMessage;
|
|
578
|
+
export declare const RunAgentPublicMessagePartAgentsRequestKind: {
|
|
579
|
+
readonly ToolResult: "tool_result";
|
|
681
580
|
};
|
|
682
|
-
export type
|
|
581
|
+
export type RunAgentPublicMessagePartAgentsRequestKind = ClosedEnum<typeof RunAgentPublicMessagePartAgentsRequestKind>;
|
|
683
582
|
/**
|
|
684
|
-
*
|
|
583
|
+
* Tool execution result part. Use this ONLY when providing results for a pending tool call from the agent. The tool_call_id must match the ID from the agent's tool call request.
|
|
685
584
|
*/
|
|
686
|
-
export
|
|
687
|
-
|
|
688
|
-
|
|
689
|
-
|
|
690
|
-
|
|
585
|
+
export type PublicMessagePartToolResultPart = {
|
|
586
|
+
kind: RunAgentPublicMessagePartAgentsRequestKind;
|
|
587
|
+
toolCallId: string;
|
|
588
|
+
result?: any | undefined;
|
|
589
|
+
metadata?: {
|
|
590
|
+
[k: string]: any;
|
|
591
|
+
} | undefined;
|
|
592
|
+
};
|
|
593
|
+
export declare const RunAgentPublicMessagePartAgentsKind: {
|
|
594
|
+
readonly File: "file";
|
|
691
595
|
};
|
|
596
|
+
export type RunAgentPublicMessagePartAgentsKind = ClosedEnum<typeof RunAgentPublicMessagePartAgentsKind>;
|
|
692
597
|
/**
|
|
693
|
-
*
|
|
598
|
+
* File in URI format. Check in the model's documentation for the supported mime types for the URI format
|
|
694
599
|
*/
|
|
695
|
-
export type
|
|
600
|
+
export type FileFileInURIFormat = {
|
|
601
|
+
/**
|
|
602
|
+
* URL for the File content
|
|
603
|
+
*/
|
|
604
|
+
uri: string;
|
|
605
|
+
/**
|
|
606
|
+
* Optional mimeType for the file
|
|
607
|
+
*/
|
|
608
|
+
mimeType?: string | undefined;
|
|
609
|
+
/**
|
|
610
|
+
* Optional name for the file
|
|
611
|
+
*/
|
|
612
|
+
name?: string | undefined;
|
|
613
|
+
};
|
|
696
614
|
/**
|
|
697
|
-
*
|
|
615
|
+
* Binary in base64 format. Check in the model's documentation for the supported mime types for the binary format.
|
|
698
616
|
*/
|
|
699
|
-
export type
|
|
700
|
-
kind: RunAgentAgentsKind;
|
|
701
|
-
messageId: string;
|
|
617
|
+
export type FileBinaryFormat = {
|
|
702
618
|
/**
|
|
703
|
-
*
|
|
619
|
+
* base64 encoded content of the file
|
|
704
620
|
*/
|
|
705
|
-
|
|
706
|
-
|
|
621
|
+
bytes: string;
|
|
622
|
+
/**
|
|
623
|
+
* Optional mimeType for the file
|
|
624
|
+
*/
|
|
625
|
+
mimeType?: string | undefined;
|
|
626
|
+
/**
|
|
627
|
+
* Optional name for the file
|
|
628
|
+
*/
|
|
629
|
+
name?: string | undefined;
|
|
707
630
|
};
|
|
631
|
+
export type RunAgentPublicMessagePartFile = FileBinaryFormat | FileFileInURIFormat;
|
|
708
632
|
/**
|
|
709
|
-
*
|
|
633
|
+
* File attachment part. Use this to send files (images, documents, etc.) to the agent for processing.
|
|
710
634
|
*/
|
|
711
|
-
export type
|
|
635
|
+
export type PublicMessagePartFilePart = {
|
|
636
|
+
kind: RunAgentPublicMessagePartAgentsKind;
|
|
637
|
+
file: FileBinaryFormat | FileFileInURIFormat;
|
|
638
|
+
metadata?: {
|
|
639
|
+
[k: string]: any;
|
|
640
|
+
} | undefined;
|
|
641
|
+
};
|
|
642
|
+
export declare const RunAgentPublicMessagePartKind: {
|
|
643
|
+
readonly Text: "text";
|
|
644
|
+
};
|
|
645
|
+
export type RunAgentPublicMessagePartKind = ClosedEnum<typeof RunAgentPublicMessagePartKind>;
|
|
646
|
+
/**
|
|
647
|
+
* Text content part. Use this to send text messages to the agent.
|
|
648
|
+
*/
|
|
649
|
+
export type PublicMessagePartTextPart = {
|
|
650
|
+
kind: RunAgentPublicMessagePartKind;
|
|
651
|
+
text: string;
|
|
652
|
+
};
|
|
653
|
+
/**
|
|
654
|
+
* Message part that can be provided by users. Use "text" for regular messages, "file" for attachments, or "tool_result" when responding to tool call requests.
|
|
655
|
+
*/
|
|
656
|
+
export type RunAgentPublicMessagePart = PublicMessagePartTextPart | PublicMessagePartFilePart | PublicMessagePartToolResultPart;
|
|
657
|
+
/**
|
|
658
|
+
* The A2A format message containing the task for the agent to perform.
|
|
659
|
+
*/
|
|
660
|
+
export type RunAgentMessage = {
|
|
712
661
|
/**
|
|
713
|
-
*
|
|
662
|
+
* Optional A2A message ID in ULID format
|
|
714
663
|
*/
|
|
715
|
-
|
|
664
|
+
messageId?: string | undefined;
|
|
716
665
|
/**
|
|
717
|
-
*
|
|
666
|
+
* Message role (user or tool for continuing executions)
|
|
718
667
|
*/
|
|
719
|
-
|
|
668
|
+
role: RunAgentRoleUserMessage | RunAgentRoleToolMessage;
|
|
720
669
|
/**
|
|
721
|
-
*
|
|
670
|
+
* A2A message parts (text, file, or tool_result only)
|
|
722
671
|
*/
|
|
723
|
-
|
|
672
|
+
parts: Array<PublicMessagePartTextPart | PublicMessagePartFilePart | PublicMessagePartToolResultPart>;
|
|
724
673
|
};
|
|
725
674
|
/**
|
|
726
|
-
*
|
|
675
|
+
* Information about the contact making the request. If the contact does not exist, it will be created automatically.
|
|
727
676
|
*/
|
|
728
|
-
export type
|
|
677
|
+
export type RunAgentContact = {
|
|
729
678
|
/**
|
|
730
|
-
*
|
|
679
|
+
* Unique identifier for the contact
|
|
731
680
|
*/
|
|
732
681
|
id: string;
|
|
733
682
|
/**
|
|
734
|
-
*
|
|
683
|
+
* Display name of the contact
|
|
735
684
|
*/
|
|
736
|
-
|
|
685
|
+
displayName?: string | undefined;
|
|
737
686
|
/**
|
|
738
|
-
*
|
|
687
|
+
* Email address of the contact
|
|
739
688
|
*/
|
|
740
|
-
|
|
689
|
+
email?: string | undefined;
|
|
741
690
|
/**
|
|
742
|
-
*
|
|
691
|
+
* A hash of key/value pairs containing any other data about the contact
|
|
743
692
|
*/
|
|
744
|
-
|
|
693
|
+
metadata?: Array<{
|
|
694
|
+
[k: string]: any;
|
|
695
|
+
}> | undefined;
|
|
745
696
|
/**
|
|
746
|
-
*
|
|
697
|
+
* URL to the contact's avatar or logo
|
|
747
698
|
*/
|
|
748
|
-
|
|
699
|
+
logoUrl?: string | undefined;
|
|
700
|
+
/**
|
|
701
|
+
* A list of tags associated with the contact
|
|
702
|
+
*/
|
|
703
|
+
tags?: Array<string> | undefined;
|
|
704
|
+
};
|
|
705
|
+
/**
|
|
706
|
+
* Thread information to group related requests
|
|
707
|
+
*/
|
|
708
|
+
export type RunAgentThread = {
|
|
709
|
+
/**
|
|
710
|
+
* Unique thread identifier to group related invocations.
|
|
711
|
+
*/
|
|
712
|
+
id: string;
|
|
713
|
+
/**
|
|
714
|
+
* Optional tags to differentiate or categorize threads
|
|
715
|
+
*/
|
|
716
|
+
tags?: Array<string> | undefined;
|
|
717
|
+
};
|
|
718
|
+
/**
|
|
719
|
+
* Memory configuration for the agent execution. Used to associate memory stores with specific entities like users or sessions.
|
|
720
|
+
*/
|
|
721
|
+
export type RunAgentMemory = {
|
|
722
|
+
/**
|
|
723
|
+
* An entity ID used to link memory stores to a specific user, session, or conversation. This ID is used to isolate and retrieve memories specific to the entity across agent executions.
|
|
724
|
+
*/
|
|
725
|
+
entityId: string;
|
|
726
|
+
};
|
|
727
|
+
export type RunAgentKnowledgeBases = {
|
|
728
|
+
/**
|
|
729
|
+
* Unique identifier of the knowledge base to search
|
|
730
|
+
*/
|
|
731
|
+
knowledgeId: string;
|
|
732
|
+
};
|
|
733
|
+
export type RunAgentTeamOfAgents = {
|
|
734
|
+
/**
|
|
735
|
+
* The unique key of the agent within the workspace
|
|
736
|
+
*/
|
|
737
|
+
key: string;
|
|
738
|
+
/**
|
|
739
|
+
* The role of the agent in this context. This is used to give extra information to the leader to help it decide which agent to hand off to.
|
|
740
|
+
*/
|
|
741
|
+
role?: string | undefined;
|
|
742
|
+
};
|
|
743
|
+
export declare const RunAgentAgentToolInputRunAgentsRequestRequestBodySettingsTools14Type: {
|
|
744
|
+
readonly Function: "function";
|
|
745
|
+
};
|
|
746
|
+
export type RunAgentAgentToolInputRunAgentsRequestRequestBodySettingsTools14Type = ClosedEnum<typeof RunAgentAgentToolInputRunAgentsRequestRequestBodySettingsTools14Type>;
|
|
747
|
+
export type AgentToolInputRunFunction = {
|
|
748
|
+
/**
|
|
749
|
+
* The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.
|
|
750
|
+
*/
|
|
751
|
+
name: string;
|
|
752
|
+
/**
|
|
753
|
+
* A description of what the function does, used by the model to choose when and how to call the function.
|
|
754
|
+
*/
|
|
755
|
+
description?: string | undefined;
|
|
756
|
+
/**
|
|
757
|
+
* Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the `parameters` field. Only a subset of JSON Schema is supported when `strict` is `true`. Currently only compatible with `OpenAI` models.
|
|
758
|
+
*/
|
|
759
|
+
strict?: boolean | undefined;
|
|
760
|
+
/**
|
|
761
|
+
* The parameters the functions accepts, described as a JSON Schema object. See the `OpenAI` [guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format.
|
|
762
|
+
*/
|
|
763
|
+
parameters?: {
|
|
764
|
+
[k: string]: any;
|
|
765
|
+
} | undefined;
|
|
766
|
+
};
|
|
767
|
+
/**
|
|
768
|
+
* Function tool with inline definition for on-the-fly creation in run endpoint
|
|
769
|
+
*/
|
|
770
|
+
export type FunctionToolRun = {
|
|
771
|
+
type: RunAgentAgentToolInputRunAgentsRequestRequestBodySettingsTools14Type;
|
|
772
|
+
/**
|
|
773
|
+
* Unique key of the tool as it will be displayed in the UI
|
|
774
|
+
*/
|
|
775
|
+
key: string;
|
|
776
|
+
id?: string | undefined;
|
|
777
|
+
displayName?: string | undefined;
|
|
778
|
+
description?: string | undefined;
|
|
779
|
+
function: AgentToolInputRunFunction;
|
|
780
|
+
requiresApproval?: boolean | undefined;
|
|
781
|
+
};
|
|
782
|
+
export declare const RunAgentAgentToolInputRunAgentsRequestRequestBodySettingsTools13Type: {
|
|
783
|
+
readonly Code: "code";
|
|
784
|
+
};
|
|
785
|
+
export type RunAgentAgentToolInputRunAgentsRequestRequestBodySettingsTools13Type = ClosedEnum<typeof RunAgentAgentToolInputRunAgentsRequestRequestBodySettingsTools13Type>;
|
|
786
|
+
export declare const Language: {
|
|
787
|
+
readonly Python: "python";
|
|
788
|
+
};
|
|
789
|
+
export type Language = ClosedEnum<typeof Language>;
|
|
790
|
+
export type CodeTool = {
|
|
791
|
+
/**
|
|
792
|
+
* The parameters the functions accepts, described as a JSON Schema object. See the `OpenAI` [guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format.
|
|
793
|
+
*/
|
|
794
|
+
parameters?: {
|
|
749
795
|
[k: string]: any;
|
|
750
796
|
} | undefined;
|
|
797
|
+
language: Language;
|
|
798
|
+
/**
|
|
799
|
+
* The code to execute.
|
|
800
|
+
*/
|
|
801
|
+
code: string;
|
|
751
802
|
};
|
|
803
|
+
/**
|
|
804
|
+
* Code execution tool with inline definition for on-the-fly creation in run endpoint
|
|
805
|
+
*/
|
|
806
|
+
export type CodeToolRun = {
|
|
807
|
+
type: RunAgentAgentToolInputRunAgentsRequestRequestBodySettingsTools13Type;
|
|
808
|
+
/**
|
|
809
|
+
* Unique key of the tool as it will be displayed in the UI
|
|
810
|
+
*/
|
|
811
|
+
key: string;
|
|
812
|
+
id?: string | undefined;
|
|
813
|
+
displayName?: string | undefined;
|
|
814
|
+
/**
|
|
815
|
+
* A description of the tool, used by the model to choose when and how to call the tool. We do recommend using the `description` field as accurate as possible to give enough context to the model to make the right decision.
|
|
816
|
+
*/
|
|
817
|
+
description: string;
|
|
818
|
+
codeTool: CodeTool;
|
|
819
|
+
requiresApproval?: boolean | undefined;
|
|
820
|
+
};
|
|
821
|
+
export declare const RunAgentAgentToolInputRunAgentsRequestRequestBodySettingsTools12Type: {
|
|
822
|
+
readonly Http: "http";
|
|
823
|
+
};
|
|
824
|
+
export type RunAgentAgentToolInputRunAgentsRequestRequestBodySettingsTools12Type = ClosedEnum<typeof RunAgentAgentToolInputRunAgentsRequestRequestBodySettingsTools12Type>;
|
|
825
|
+
/**
|
|
826
|
+
* The HTTP method to use.
|
|
827
|
+
*/
|
|
828
|
+
export declare const Method: {
|
|
829
|
+
readonly Get: "GET";
|
|
830
|
+
readonly Post: "POST";
|
|
831
|
+
readonly Put: "PUT";
|
|
832
|
+
readonly Delete: "DELETE";
|
|
833
|
+
};
|
|
834
|
+
/**
|
|
835
|
+
* The HTTP method to use.
|
|
836
|
+
*/
|
|
837
|
+
export type Method = ClosedEnum<typeof Method>;
|
|
838
|
+
/**
|
|
839
|
+
* The blueprint for the HTTP request. The `arguments` field will be used to replace the placeholders in the `url`, `headers`, `body`, and `arguments` fields.
|
|
840
|
+
*/
|
|
841
|
+
export type Blueprint = {
|
|
842
|
+
/**
|
|
843
|
+
* The URL to send the request to.
|
|
844
|
+
*/
|
|
845
|
+
url: string;
|
|
846
|
+
/**
|
|
847
|
+
* The HTTP method to use.
|
|
848
|
+
*/
|
|
849
|
+
method: Method;
|
|
850
|
+
/**
|
|
851
|
+
* The headers to send with the request.
|
|
852
|
+
*/
|
|
853
|
+
headers?: {
|
|
854
|
+
[k: string]: string;
|
|
855
|
+
} | undefined;
|
|
856
|
+
/**
|
|
857
|
+
* The body to send with the request.
|
|
858
|
+
*/
|
|
859
|
+
body?: {
|
|
860
|
+
[k: string]: any;
|
|
861
|
+
} | undefined;
|
|
862
|
+
};
|
|
863
|
+
/**
|
|
864
|
+
* The type of the argument.
|
|
865
|
+
*/
|
|
866
|
+
export declare const RunAgentAgentToolInputRunAgentsRequestRequestBodySettingsTools12HttpType: {
|
|
867
|
+
readonly String: "string";
|
|
868
|
+
readonly Number: "number";
|
|
869
|
+
readonly Boolean: "boolean";
|
|
870
|
+
};
|
|
871
|
+
/**
|
|
872
|
+
* The type of the argument.
|
|
873
|
+
*/
|
|
874
|
+
export type RunAgentAgentToolInputRunAgentsRequestRequestBodySettingsTools12HttpType = ClosedEnum<typeof RunAgentAgentToolInputRunAgentsRequestRequestBodySettingsTools12HttpType>;
|
|
875
|
+
/**
|
|
876
|
+
* The default value of the argument.
|
|
877
|
+
*/
|
|
878
|
+
export type DefaultValue = string | number | boolean;
|
|
879
|
+
export type Arguments = {
|
|
880
|
+
/**
|
|
881
|
+
* The type of the argument.
|
|
882
|
+
*/
|
|
883
|
+
type: RunAgentAgentToolInputRunAgentsRequestRequestBodySettingsTools12HttpType;
|
|
884
|
+
/**
|
|
885
|
+
* A description of the argument.
|
|
886
|
+
*/
|
|
887
|
+
description: string;
|
|
888
|
+
/**
|
|
889
|
+
* Whether to send the argument to the model. If set to false, the argument will not be sent to the model and needs to be provided by the user or it will be left blank.
|
|
890
|
+
*/
|
|
891
|
+
sendToModel?: boolean | undefined;
|
|
892
|
+
/**
|
|
893
|
+
* The default value of the argument.
|
|
894
|
+
*/
|
|
895
|
+
defaultValue?: string | number | boolean | undefined;
|
|
896
|
+
};
|
|
897
|
+
export type Http = {
|
|
898
|
+
/**
|
|
899
|
+
* The blueprint for the HTTP request. The `arguments` field will be used to replace the placeholders in the `url`, `headers`, `body`, and `arguments` fields.
|
|
900
|
+
*/
|
|
901
|
+
blueprint: Blueprint;
|
|
902
|
+
/**
|
|
903
|
+
* The arguments to send with the request. The keys will be used to replace the placeholders in the `blueprint` field.
|
|
904
|
+
*/
|
|
905
|
+
arguments?: {
|
|
906
|
+
[k: string]: Arguments;
|
|
907
|
+
} | undefined;
|
|
908
|
+
};
|
|
909
|
+
/**
|
|
910
|
+
* HTTP tool with inline definition for on-the-fly creation in run endpoint
|
|
911
|
+
*/
|
|
912
|
+
export type HTTPToolRun = {
|
|
913
|
+
type: RunAgentAgentToolInputRunAgentsRequestRequestBodySettingsTools12Type;
|
|
914
|
+
/**
|
|
915
|
+
* Unique key of the tool as it will be displayed in the UI
|
|
916
|
+
*/
|
|
917
|
+
key: string;
|
|
918
|
+
id?: string | undefined;
|
|
919
|
+
displayName?: string | undefined;
|
|
920
|
+
/**
|
|
921
|
+
* A description of the tool, used by the model to choose when and how to call the tool. We do recommend using the `description` field as accurate as possible to give enough context to the model to make the right decision.
|
|
922
|
+
*/
|
|
923
|
+
description: string;
|
|
924
|
+
http: Http;
|
|
925
|
+
requiresApproval?: boolean | undefined;
|
|
926
|
+
};
|
|
927
|
+
export declare const RunAgentAgentToolInputRunAgentsRequestRequestBodySettingsTools11Type: {
|
|
928
|
+
readonly CurrentDate: "current_date";
|
|
929
|
+
};
|
|
930
|
+
export type RunAgentAgentToolInputRunAgentsRequestRequestBodySettingsTools11Type = ClosedEnum<typeof RunAgentAgentToolInputRunAgentsRequestRequestBodySettingsTools11Type>;
|
|
931
|
+
/**
|
|
932
|
+
* Returns the current date and time
|
|
933
|
+
*/
|
|
934
|
+
export type AgentToolInputRunCurrentDateTool = {
|
|
935
|
+
type: RunAgentAgentToolInputRunAgentsRequestRequestBodySettingsTools11Type;
|
|
936
|
+
/**
|
|
937
|
+
* Whether this tool requires approval before execution
|
|
938
|
+
*/
|
|
939
|
+
requiresApproval?: boolean | undefined;
|
|
940
|
+
};
|
|
941
|
+
export declare const RunAgentAgentToolInputRunAgentsRequestRequestBodySettingsTools10Type: {
|
|
942
|
+
readonly QueryKnowledgeBase: "query_knowledge_base";
|
|
943
|
+
};
|
|
944
|
+
export type RunAgentAgentToolInputRunAgentsRequestRequestBodySettingsTools10Type = ClosedEnum<typeof RunAgentAgentToolInputRunAgentsRequestRequestBodySettingsTools10Type>;
|
|
945
|
+
/**
|
|
946
|
+
* Queries knowledge bases for information
|
|
947
|
+
*/
|
|
948
|
+
export type AgentToolInputRunQueryKnowledgeBaseTool = {
|
|
949
|
+
type: RunAgentAgentToolInputRunAgentsRequestRequestBodySettingsTools10Type;
|
|
950
|
+
/**
|
|
951
|
+
* Whether this tool requires approval before execution
|
|
952
|
+
*/
|
|
953
|
+
requiresApproval?: boolean | undefined;
|
|
954
|
+
};
|
|
955
|
+
export declare const RunAgentAgentToolInputRunAgentsRequestRequestBodySettingsTools9Type: {
|
|
956
|
+
readonly RetrieveKnowledgeBases: "retrieve_knowledge_bases";
|
|
957
|
+
};
|
|
958
|
+
export type RunAgentAgentToolInputRunAgentsRequestRequestBodySettingsTools9Type = ClosedEnum<typeof RunAgentAgentToolInputRunAgentsRequestRequestBodySettingsTools9Type>;
|
|
959
|
+
/**
|
|
960
|
+
* Lists available knowledge bases
|
|
961
|
+
*/
|
|
962
|
+
export type AgentToolInputRunRetrieveKnowledgeBasesTool = {
|
|
963
|
+
type: RunAgentAgentToolInputRunAgentsRequestRequestBodySettingsTools9Type;
|
|
964
|
+
/**
|
|
965
|
+
* Whether this tool requires approval before execution
|
|
966
|
+
*/
|
|
967
|
+
requiresApproval?: boolean | undefined;
|
|
968
|
+
};
|
|
969
|
+
export declare const RunAgentAgentToolInputRunAgentsRequestRequestBodySettingsTools8Type: {
|
|
970
|
+
readonly DeleteMemoryDocument: "delete_memory_document";
|
|
971
|
+
};
|
|
972
|
+
export type RunAgentAgentToolInputRunAgentsRequestRequestBodySettingsTools8Type = ClosedEnum<typeof RunAgentAgentToolInputRunAgentsRequestRequestBodySettingsTools8Type>;
|
|
973
|
+
/**
|
|
974
|
+
* Deletes documents from memory stores
|
|
975
|
+
*/
|
|
976
|
+
export type AgentToolInputRunDeleteMemoryDocumentTool = {
|
|
977
|
+
type: RunAgentAgentToolInputRunAgentsRequestRequestBodySettingsTools8Type;
|
|
978
|
+
/**
|
|
979
|
+
* Whether this tool requires approval before execution
|
|
980
|
+
*/
|
|
981
|
+
requiresApproval?: boolean | undefined;
|
|
982
|
+
};
|
|
983
|
+
export declare const RunAgentAgentToolInputRunAgentsRequestRequestBodySettingsToolsType: {
|
|
984
|
+
readonly RetrieveMemoryStores: "retrieve_memory_stores";
|
|
985
|
+
};
|
|
986
|
+
export type RunAgentAgentToolInputRunAgentsRequestRequestBodySettingsToolsType = ClosedEnum<typeof RunAgentAgentToolInputRunAgentsRequestRequestBodySettingsToolsType>;
|
|
987
|
+
/**
|
|
988
|
+
* Lists available memory stores
|
|
989
|
+
*/
|
|
990
|
+
export type AgentToolInputRunRetrieveMemoryStoresTool = {
|
|
991
|
+
type: RunAgentAgentToolInputRunAgentsRequestRequestBodySettingsToolsType;
|
|
992
|
+
/**
|
|
993
|
+
* Whether this tool requires approval before execution
|
|
994
|
+
*/
|
|
995
|
+
requiresApproval?: boolean | undefined;
|
|
996
|
+
};
|
|
997
|
+
export declare const RunAgentAgentToolInputRunAgentsRequestRequestBodySettingsType: {
|
|
998
|
+
readonly WriteMemoryStore: "write_memory_store";
|
|
999
|
+
};
|
|
1000
|
+
export type RunAgentAgentToolInputRunAgentsRequestRequestBodySettingsType = ClosedEnum<typeof RunAgentAgentToolInputRunAgentsRequestRequestBodySettingsType>;
|
|
1001
|
+
/**
|
|
1002
|
+
* Writes information to agent memory stores
|
|
1003
|
+
*/
|
|
1004
|
+
export type AgentToolInputRunWriteMemoryStoreTool = {
|
|
1005
|
+
type: RunAgentAgentToolInputRunAgentsRequestRequestBodySettingsType;
|
|
1006
|
+
/**
|
|
1007
|
+
* Whether this tool requires approval before execution
|
|
1008
|
+
*/
|
|
1009
|
+
requiresApproval?: boolean | undefined;
|
|
1010
|
+
};
|
|
1011
|
+
export declare const RunAgentAgentToolInputRunAgentsRequestRequestBodyType: {
|
|
1012
|
+
readonly QueryMemoryStore: "query_memory_store";
|
|
1013
|
+
};
|
|
1014
|
+
export type RunAgentAgentToolInputRunAgentsRequestRequestBodyType = ClosedEnum<typeof RunAgentAgentToolInputRunAgentsRequestRequestBodyType>;
|
|
1015
|
+
/**
|
|
1016
|
+
* Queries agent memory stores for context
|
|
1017
|
+
*/
|
|
1018
|
+
export type AgentToolInputRunQueryMemoryStoreTool = {
|
|
1019
|
+
type: RunAgentAgentToolInputRunAgentsRequestRequestBodyType;
|
|
1020
|
+
/**
|
|
1021
|
+
* Whether this tool requires approval before execution
|
|
1022
|
+
*/
|
|
1023
|
+
requiresApproval?: boolean | undefined;
|
|
1024
|
+
};
|
|
1025
|
+
export declare const RunAgentAgentToolInputRunAgentsRequestType: {
|
|
1026
|
+
readonly RetrieveAgents: "retrieve_agents";
|
|
1027
|
+
};
|
|
1028
|
+
export type RunAgentAgentToolInputRunAgentsRequestType = ClosedEnum<typeof RunAgentAgentToolInputRunAgentsRequestType>;
|
|
1029
|
+
/**
|
|
1030
|
+
* Retrieves available agents in the system
|
|
1031
|
+
*/
|
|
1032
|
+
export type AgentToolInputRunRetrieveAgentsTool = {
|
|
1033
|
+
type: RunAgentAgentToolInputRunAgentsRequestType;
|
|
1034
|
+
/**
|
|
1035
|
+
* Whether this tool requires approval before execution
|
|
1036
|
+
*/
|
|
1037
|
+
requiresApproval?: boolean | undefined;
|
|
1038
|
+
};
|
|
1039
|
+
export declare const RunAgentAgentToolInputRunAgentsType: {
|
|
1040
|
+
readonly CallSubAgent: "call_sub_agent";
|
|
1041
|
+
};
|
|
1042
|
+
export type RunAgentAgentToolInputRunAgentsType = ClosedEnum<typeof RunAgentAgentToolInputRunAgentsType>;
|
|
1043
|
+
/**
|
|
1044
|
+
* Delegates tasks to specialized sub-agents
|
|
1045
|
+
*/
|
|
1046
|
+
export type AgentToolInputRunCallSubAgentTool = {
|
|
1047
|
+
type: RunAgentAgentToolInputRunAgentsType;
|
|
1048
|
+
/**
|
|
1049
|
+
* Whether this tool requires approval before execution
|
|
1050
|
+
*/
|
|
1051
|
+
requiresApproval?: boolean | undefined;
|
|
1052
|
+
};
|
|
1053
|
+
export declare const RunAgentAgentToolInputRunType: {
|
|
1054
|
+
readonly WebScraper: "web_scraper";
|
|
1055
|
+
};
|
|
1056
|
+
export type RunAgentAgentToolInputRunType = ClosedEnum<typeof RunAgentAgentToolInputRunType>;
|
|
1057
|
+
/**
|
|
1058
|
+
* Scrapes and extracts content from web pages
|
|
1059
|
+
*/
|
|
1060
|
+
export type AgentToolInputRunWebScraperTool = {
|
|
1061
|
+
type: RunAgentAgentToolInputRunType;
|
|
1062
|
+
/**
|
|
1063
|
+
* Whether this tool requires approval before execution
|
|
1064
|
+
*/
|
|
1065
|
+
requiresApproval?: boolean | undefined;
|
|
1066
|
+
};
|
|
1067
|
+
export declare const AgentToolInputRunType: {
|
|
1068
|
+
readonly GoogleSearch: "google_search";
|
|
1069
|
+
};
|
|
1070
|
+
export type AgentToolInputRunType = ClosedEnum<typeof AgentToolInputRunType>;
|
|
1071
|
+
/**
|
|
1072
|
+
* Performs Google searches to retrieve web content
|
|
1073
|
+
*/
|
|
1074
|
+
export type AgentToolInputRunGoogleSearchTool = {
|
|
1075
|
+
type: AgentToolInputRunType;
|
|
1076
|
+
/**
|
|
1077
|
+
* Whether this tool requires approval before execution
|
|
1078
|
+
*/
|
|
1079
|
+
requiresApproval?: boolean | undefined;
|
|
1080
|
+
};
|
|
1081
|
+
/**
|
|
1082
|
+
* Tool configuration for agent run operations. Built-in tools only require a type and requires_approval, while custom tools (HTTP, Code, Function) support full inline definitions for on-the-fly creation.
|
|
1083
|
+
*/
|
|
1084
|
+
export type AgentToolInputRun = HTTPToolRun | CodeToolRun | FunctionToolRun | AgentToolInputRunGoogleSearchTool | AgentToolInputRunWebScraperTool | AgentToolInputRunCallSubAgentTool | AgentToolInputRunRetrieveAgentsTool | AgentToolInputRunQueryMemoryStoreTool | AgentToolInputRunWriteMemoryStoreTool | AgentToolInputRunRetrieveMemoryStoresTool | AgentToolInputRunDeleteMemoryDocumentTool | AgentToolInputRunRetrieveKnowledgeBasesTool | AgentToolInputRunQueryKnowledgeBaseTool | AgentToolInputRunCurrentDateTool;
|
|
1085
|
+
/**
|
|
1086
|
+
* If all, the agent will require approval for all tools. If respect_tool, the agent will require approval for tools that have the requires_approval flag set to true. If none, the agent will not require approval for any tools.
|
|
1087
|
+
*/
|
|
1088
|
+
export declare const RunAgentToolApprovalRequired: {
|
|
1089
|
+
readonly All: "all";
|
|
1090
|
+
readonly RespectTool: "respect_tool";
|
|
1091
|
+
readonly None: "none";
|
|
1092
|
+
};
|
|
1093
|
+
/**
|
|
1094
|
+
* If all, the agent will require approval for all tools. If respect_tool, the agent will require approval for tools that have the requires_approval flag set to true. If none, the agent will not require approval for any tools.
|
|
1095
|
+
*/
|
|
1096
|
+
export type RunAgentToolApprovalRequired = ClosedEnum<typeof RunAgentToolApprovalRequired>;
|
|
1097
|
+
export type RunAgentSettings = {
|
|
1098
|
+
/**
|
|
1099
|
+
* Tools available to the agent
|
|
1100
|
+
*/
|
|
1101
|
+
tools?: Array<HTTPToolRun | CodeToolRun | FunctionToolRun | AgentToolInputRunGoogleSearchTool | AgentToolInputRunWebScraperTool | AgentToolInputRunCallSubAgentTool | AgentToolInputRunRetrieveAgentsTool | AgentToolInputRunQueryMemoryStoreTool | AgentToolInputRunWriteMemoryStoreTool | AgentToolInputRunRetrieveMemoryStoresTool | AgentToolInputRunDeleteMemoryDocumentTool | AgentToolInputRunRetrieveKnowledgeBasesTool | AgentToolInputRunQueryKnowledgeBaseTool | AgentToolInputRunCurrentDateTool> | undefined;
|
|
1102
|
+
/**
|
|
1103
|
+
* If all, the agent will require approval for all tools. If respect_tool, the agent will require approval for tools that have the requires_approval flag set to true. If none, the agent will not require approval for any tools.
|
|
1104
|
+
*/
|
|
1105
|
+
toolApprovalRequired?: RunAgentToolApprovalRequired | undefined;
|
|
1106
|
+
/**
|
|
1107
|
+
* Maximum iterations(llm calls) before the agent will stop executing.
|
|
1108
|
+
*/
|
|
1109
|
+
maxIterations?: number | undefined;
|
|
1110
|
+
/**
|
|
1111
|
+
* Maximum time (in seconds) for the agent thinking process. This does not include the time for tool calls and sub agent calls. It will be loosely enforced, the in progress LLM calls will not be terminated and the last assistant message will be returned.
|
|
1112
|
+
*/
|
|
1113
|
+
maxExecutionTime?: number | undefined;
|
|
1114
|
+
};
|
|
1115
|
+
export type RunAgentRequestBody = {
|
|
1116
|
+
/**
|
|
1117
|
+
* A unique identifier for the agent. This key must be unique within the same workspace and cannot be reused. When executing the agent, this key determines if the agent already exists. If the agent version differs, a new version is created at the end of the execution, except for the task. All agent parameters are evaluated to decide if a new version is needed.
|
|
1118
|
+
*/
|
|
1119
|
+
key: string;
|
|
1120
|
+
/**
|
|
1121
|
+
* Optional task ID to continue an existing agent execution. When provided, the agent will continue the conversation from the existing task state. The task must be in an inactive state to continue.
|
|
1122
|
+
*/
|
|
1123
|
+
taskId?: string | undefined;
|
|
1124
|
+
/**
|
|
1125
|
+
* The language model that powers the agent. Can be a simple string (e.g., "openai/gpt-4o") or an object with model ID and parameters. The model must support tool calling capabilities.
|
|
1126
|
+
*/
|
|
1127
|
+
model: RunAgentModel2 | string;
|
|
1128
|
+
/**
|
|
1129
|
+
* Optional array of fallback models (string IDs or config objects) to use when the primary model fails. Models are tried in order. All models must support tool calling capabilities.
|
|
1130
|
+
*/
|
|
1131
|
+
fallbackModels?: Array<RunAgentFallbackModels2 | string> | undefined;
|
|
1132
|
+
/**
|
|
1133
|
+
* Specifies the agent's function and area of expertise.
|
|
1134
|
+
*/
|
|
1135
|
+
role: string;
|
|
1136
|
+
/**
|
|
1137
|
+
* Provides context and purpose for the agent. Combined with the system prompt template to generate the agent's instructions.
|
|
1138
|
+
*/
|
|
1139
|
+
instructions: string;
|
|
1140
|
+
/**
|
|
1141
|
+
* The A2A format message containing the task for the agent to perform.
|
|
1142
|
+
*/
|
|
1143
|
+
message: RunAgentMessage;
|
|
1144
|
+
/**
|
|
1145
|
+
* Optional variables for template replacement in system prompt, instructions, and messages
|
|
1146
|
+
*/
|
|
1147
|
+
variables?: {
|
|
1148
|
+
[k: string]: any;
|
|
1149
|
+
} | undefined;
|
|
1150
|
+
/**
|
|
1151
|
+
* Information about the contact making the request. If the contact does not exist, it will be created automatically.
|
|
1152
|
+
*/
|
|
1153
|
+
contact?: RunAgentContact | undefined;
|
|
1154
|
+
/**
|
|
1155
|
+
* Thread information to group related requests
|
|
1156
|
+
*/
|
|
1157
|
+
thread?: RunAgentThread | undefined;
|
|
1158
|
+
/**
|
|
1159
|
+
* Memory configuration for the agent execution. Used to associate memory stores with specific entities like users or sessions.
|
|
1160
|
+
*/
|
|
1161
|
+
memory?: RunAgentMemory | undefined;
|
|
1162
|
+
/**
|
|
1163
|
+
* Entity storage path in the format: `project/folder/subfolder/...`
|
|
1164
|
+
*
|
|
1165
|
+
* @remarks
|
|
1166
|
+
*
|
|
1167
|
+
* The first element identifies the project, followed by nested folders (auto-created as needed).
|
|
1168
|
+
*
|
|
1169
|
+
* With project-based API keys, the first element is treated as a folder name, as the project is predetermined by the API key.
|
|
1170
|
+
*/
|
|
1171
|
+
path: string;
|
|
1172
|
+
/**
|
|
1173
|
+
* A brief summary of the agent's purpose.
|
|
1174
|
+
*/
|
|
1175
|
+
description?: string | undefined;
|
|
1176
|
+
/**
|
|
1177
|
+
* A custom system prompt template for the agent. If omitted, the default template is used.
|
|
1178
|
+
*/
|
|
1179
|
+
systemPrompt?: string | undefined;
|
|
1180
|
+
/**
|
|
1181
|
+
* The list of keys of the memory stores that are accessible to the agent.
|
|
1182
|
+
*/
|
|
1183
|
+
memoryStores?: Array<string> | undefined;
|
|
1184
|
+
/**
|
|
1185
|
+
* Knowledge base configurations for the agent to access
|
|
1186
|
+
*/
|
|
1187
|
+
knowledgeBases?: Array<RunAgentKnowledgeBases> | undefined;
|
|
1188
|
+
/**
|
|
1189
|
+
* The agents that are accessible to this orchestrator. The main agent can hand off to these agents to perform tasks.
|
|
1190
|
+
*/
|
|
1191
|
+
teamOfAgents?: Array<RunAgentTeamOfAgents> | undefined;
|
|
1192
|
+
settings: RunAgentSettings;
|
|
1193
|
+
/**
|
|
1194
|
+
* Optional metadata for the agent run as key-value pairs that will be included in traces
|
|
1195
|
+
*/
|
|
1196
|
+
metadata?: {
|
|
1197
|
+
[k: string]: any;
|
|
1198
|
+
} | undefined;
|
|
1199
|
+
};
|
|
1200
|
+
/**
|
|
1201
|
+
* A2A entity type
|
|
1202
|
+
*/
|
|
1203
|
+
export declare const RunAgentKind: {
|
|
1204
|
+
readonly Task: "task";
|
|
1205
|
+
};
|
|
1206
|
+
/**
|
|
1207
|
+
* A2A entity type
|
|
1208
|
+
*/
|
|
1209
|
+
export type RunAgentKind = ClosedEnum<typeof RunAgentKind>;
|
|
1210
|
+
/**
|
|
1211
|
+
* Current task state
|
|
1212
|
+
*/
|
|
1213
|
+
export declare const RunAgentState: {
|
|
1214
|
+
readonly Submitted: "submitted";
|
|
1215
|
+
readonly Working: "working";
|
|
1216
|
+
readonly InputRequired: "input-required";
|
|
1217
|
+
readonly Completed: "completed";
|
|
1218
|
+
readonly Failed: "failed";
|
|
1219
|
+
readonly Canceled: "canceled";
|
|
1220
|
+
readonly Rejected: "rejected";
|
|
1221
|
+
readonly AuthRequired: "auth-required";
|
|
1222
|
+
readonly Unknown: "unknown";
|
|
1223
|
+
};
|
|
1224
|
+
/**
|
|
1225
|
+
* Current task state
|
|
1226
|
+
*/
|
|
1227
|
+
export type RunAgentState = ClosedEnum<typeof RunAgentState>;
|
|
1228
|
+
export declare const RunAgentAgentsKind: {
|
|
1229
|
+
readonly Message: "message";
|
|
1230
|
+
};
|
|
1231
|
+
export type RunAgentAgentsKind = ClosedEnum<typeof RunAgentAgentsKind>;
|
|
1232
|
+
/**
|
|
1233
|
+
* Extended A2A message role
|
|
1234
|
+
*/
|
|
1235
|
+
export declare const RunAgentAgentsRole: {
|
|
1236
|
+
readonly User: "user";
|
|
1237
|
+
readonly Agent: "agent";
|
|
1238
|
+
readonly Tool: "tool";
|
|
1239
|
+
readonly System: "system";
|
|
1240
|
+
};
|
|
1241
|
+
/**
|
|
1242
|
+
* Extended A2A message role
|
|
1243
|
+
*/
|
|
1244
|
+
export type RunAgentAgentsRole = ClosedEnum<typeof RunAgentAgentsRole>;
|
|
1245
|
+
/**
|
|
1246
|
+
* Optional status message
|
|
1247
|
+
*/
|
|
1248
|
+
export type RunAgentAgentsMessage = {
|
|
1249
|
+
kind: RunAgentAgentsKind;
|
|
1250
|
+
messageId: string;
|
|
1251
|
+
/**
|
|
1252
|
+
* Extended A2A message role
|
|
1253
|
+
*/
|
|
1254
|
+
role: RunAgentAgentsRole;
|
|
1255
|
+
parts: Array<any>;
|
|
1256
|
+
};
|
|
1257
|
+
/**
|
|
1258
|
+
* Task status information
|
|
1259
|
+
*/
|
|
1260
|
+
export type RunAgentStatus = {
|
|
1261
|
+
/**
|
|
1262
|
+
* Current task state
|
|
1263
|
+
*/
|
|
1264
|
+
state: RunAgentState;
|
|
1265
|
+
/**
|
|
1266
|
+
* ISO timestamp of status update
|
|
1267
|
+
*/
|
|
1268
|
+
timestamp?: string | undefined;
|
|
1269
|
+
/**
|
|
1270
|
+
* Optional status message
|
|
1271
|
+
*/
|
|
1272
|
+
message?: RunAgentAgentsMessage | undefined;
|
|
1273
|
+
};
|
|
1274
|
+
/**
|
|
1275
|
+
* A2A Task response format
|
|
1276
|
+
*/
|
|
1277
|
+
export type RunAgentResponseBody = {
|
|
1278
|
+
/**
|
|
1279
|
+
* The ID of the created agent execution task
|
|
1280
|
+
*/
|
|
1281
|
+
id: string;
|
|
1282
|
+
/**
|
|
1283
|
+
* The correlation ID for this execution
|
|
1284
|
+
*/
|
|
1285
|
+
contextId: string;
|
|
1286
|
+
/**
|
|
1287
|
+
* A2A entity type
|
|
1288
|
+
*/
|
|
1289
|
+
kind: RunAgentKind;
|
|
1290
|
+
/**
|
|
1291
|
+
* Task status information
|
|
1292
|
+
*/
|
|
1293
|
+
status: RunAgentStatus;
|
|
1294
|
+
/**
|
|
1295
|
+
* Task metadata containing workspace_id and trace_id for feedback
|
|
1296
|
+
*/
|
|
1297
|
+
metadata?: {
|
|
1298
|
+
[k: string]: any;
|
|
1299
|
+
} | undefined;
|
|
1300
|
+
};
|
|
1301
|
+
/** @internal */
|
|
1302
|
+
export declare const RunAgentModelVoice$inboundSchema: z.ZodNativeEnum<typeof RunAgentModelVoice>;
|
|
1303
|
+
/** @internal */
|
|
1304
|
+
export declare const RunAgentModelVoice$outboundSchema: z.ZodNativeEnum<typeof RunAgentModelVoice>;
|
|
1305
|
+
/**
|
|
1306
|
+
* @internal
|
|
1307
|
+
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
|
|
1308
|
+
*/
|
|
1309
|
+
export declare namespace RunAgentModelVoice$ {
|
|
1310
|
+
/** @deprecated use `RunAgentModelVoice$inboundSchema` instead. */
|
|
1311
|
+
const inboundSchema: z.ZodNativeEnum<{
|
|
1312
|
+
readonly Alloy: "alloy";
|
|
1313
|
+
readonly Echo: "echo";
|
|
1314
|
+
readonly Fable: "fable";
|
|
1315
|
+
readonly Onyx: "onyx";
|
|
1316
|
+
readonly Nova: "nova";
|
|
1317
|
+
readonly Shimmer: "shimmer";
|
|
1318
|
+
}>;
|
|
1319
|
+
/** @deprecated use `RunAgentModelVoice$outboundSchema` instead. */
|
|
1320
|
+
const outboundSchema: z.ZodNativeEnum<{
|
|
1321
|
+
readonly Alloy: "alloy";
|
|
1322
|
+
readonly Echo: "echo";
|
|
1323
|
+
readonly Fable: "fable";
|
|
1324
|
+
readonly Onyx: "onyx";
|
|
1325
|
+
readonly Nova: "nova";
|
|
1326
|
+
readonly Shimmer: "shimmer";
|
|
1327
|
+
}>;
|
|
1328
|
+
}
|
|
1329
|
+
/** @internal */
|
|
1330
|
+
export declare const RunAgentModelFormat$inboundSchema: z.ZodNativeEnum<typeof RunAgentModelFormat>;
|
|
1331
|
+
/** @internal */
|
|
1332
|
+
export declare const RunAgentModelFormat$outboundSchema: z.ZodNativeEnum<typeof RunAgentModelFormat>;
|
|
1333
|
+
/**
|
|
1334
|
+
* @internal
|
|
1335
|
+
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
|
|
1336
|
+
*/
|
|
1337
|
+
export declare namespace RunAgentModelFormat$ {
|
|
1338
|
+
/** @deprecated use `RunAgentModelFormat$inboundSchema` instead. */
|
|
1339
|
+
const inboundSchema: z.ZodNativeEnum<{
|
|
1340
|
+
readonly Wav: "wav";
|
|
1341
|
+
readonly Mp3: "mp3";
|
|
1342
|
+
readonly Flac: "flac";
|
|
1343
|
+
readonly Opus: "opus";
|
|
1344
|
+
readonly Pcm16: "pcm16";
|
|
1345
|
+
}>;
|
|
1346
|
+
/** @deprecated use `RunAgentModelFormat$outboundSchema` instead. */
|
|
1347
|
+
const outboundSchema: z.ZodNativeEnum<{
|
|
1348
|
+
readonly Wav: "wav";
|
|
1349
|
+
readonly Mp3: "mp3";
|
|
1350
|
+
readonly Flac: "flac";
|
|
1351
|
+
readonly Opus: "opus";
|
|
1352
|
+
readonly Pcm16: "pcm16";
|
|
1353
|
+
}>;
|
|
1354
|
+
}
|
|
1355
|
+
/** @internal */
|
|
1356
|
+
export declare const RunAgentModelAudio$inboundSchema: z.ZodType<RunAgentModelAudio, z.ZodTypeDef, unknown>;
|
|
1357
|
+
/** @internal */
|
|
1358
|
+
export type RunAgentModelAudio$Outbound = {
|
|
1359
|
+
voice: string;
|
|
1360
|
+
format: string;
|
|
1361
|
+
};
|
|
1362
|
+
/** @internal */
|
|
1363
|
+
export declare const RunAgentModelAudio$outboundSchema: z.ZodType<RunAgentModelAudio$Outbound, z.ZodTypeDef, RunAgentModelAudio>;
|
|
1364
|
+
/**
|
|
1365
|
+
* @internal
|
|
1366
|
+
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
|
|
1367
|
+
*/
|
|
1368
|
+
export declare namespace RunAgentModelAudio$ {
|
|
1369
|
+
/** @deprecated use `RunAgentModelAudio$inboundSchema` instead. */
|
|
1370
|
+
const inboundSchema: z.ZodType<RunAgentModelAudio, z.ZodTypeDef, unknown>;
|
|
1371
|
+
/** @deprecated use `RunAgentModelAudio$outboundSchema` instead. */
|
|
1372
|
+
const outboundSchema: z.ZodType<RunAgentModelAudio$Outbound, z.ZodTypeDef, RunAgentModelAudio>;
|
|
1373
|
+
/** @deprecated use `RunAgentModelAudio$Outbound` instead. */
|
|
1374
|
+
type Outbound = RunAgentModelAudio$Outbound;
|
|
1375
|
+
}
|
|
1376
|
+
export declare function runAgentModelAudioToJSON(runAgentModelAudio: RunAgentModelAudio): string;
|
|
1377
|
+
export declare function runAgentModelAudioFromJSON(jsonString: string): SafeParseResult<RunAgentModelAudio, SDKValidationError>;
|
|
1378
|
+
/** @internal */
|
|
1379
|
+
export declare const RunAgentResponseFormatAgentsRequestType$inboundSchema: z.ZodNativeEnum<typeof RunAgentResponseFormatAgentsRequestType>;
|
|
1380
|
+
/** @internal */
|
|
1381
|
+
export declare const RunAgentResponseFormatAgentsRequestType$outboundSchema: z.ZodNativeEnum<typeof RunAgentResponseFormatAgentsRequestType>;
|
|
1382
|
+
/**
|
|
1383
|
+
* @internal
|
|
1384
|
+
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
|
|
1385
|
+
*/
|
|
1386
|
+
export declare namespace RunAgentResponseFormatAgentsRequestType$ {
|
|
1387
|
+
/** @deprecated use `RunAgentResponseFormatAgentsRequestType$inboundSchema` instead. */
|
|
1388
|
+
const inboundSchema: z.ZodNativeEnum<{
|
|
1389
|
+
readonly JsonSchema: "json_schema";
|
|
1390
|
+
}>;
|
|
1391
|
+
/** @deprecated use `RunAgentResponseFormatAgentsRequestType$outboundSchema` instead. */
|
|
1392
|
+
const outboundSchema: z.ZodNativeEnum<{
|
|
1393
|
+
readonly JsonSchema: "json_schema";
|
|
1394
|
+
}>;
|
|
1395
|
+
}
|
|
1396
|
+
/** @internal */
|
|
1397
|
+
export declare const RunAgentResponseFormatJsonSchema$inboundSchema: z.ZodType<RunAgentResponseFormatJsonSchema, z.ZodTypeDef, unknown>;
|
|
1398
|
+
/** @internal */
|
|
1399
|
+
export type RunAgentResponseFormatJsonSchema$Outbound = {
|
|
1400
|
+
description?: string | undefined;
|
|
1401
|
+
name: string;
|
|
1402
|
+
schema?: any | undefined;
|
|
1403
|
+
strict?: boolean | undefined;
|
|
1404
|
+
};
|
|
1405
|
+
/** @internal */
|
|
1406
|
+
export declare const RunAgentResponseFormatJsonSchema$outboundSchema: z.ZodType<RunAgentResponseFormatJsonSchema$Outbound, z.ZodTypeDef, RunAgentResponseFormatJsonSchema>;
|
|
1407
|
+
/**
|
|
1408
|
+
* @internal
|
|
1409
|
+
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
|
|
1410
|
+
*/
|
|
1411
|
+
export declare namespace RunAgentResponseFormatJsonSchema$ {
|
|
1412
|
+
/** @deprecated use `RunAgentResponseFormatJsonSchema$inboundSchema` instead. */
|
|
1413
|
+
const inboundSchema: z.ZodType<RunAgentResponseFormatJsonSchema, z.ZodTypeDef, unknown>;
|
|
1414
|
+
/** @deprecated use `RunAgentResponseFormatJsonSchema$outboundSchema` instead. */
|
|
1415
|
+
const outboundSchema: z.ZodType<RunAgentResponseFormatJsonSchema$Outbound, z.ZodTypeDef, RunAgentResponseFormatJsonSchema>;
|
|
1416
|
+
/** @deprecated use `RunAgentResponseFormatJsonSchema$Outbound` instead. */
|
|
1417
|
+
type Outbound = RunAgentResponseFormatJsonSchema$Outbound;
|
|
1418
|
+
}
|
|
1419
|
+
export declare function runAgentResponseFormatJsonSchemaToJSON(runAgentResponseFormatJsonSchema: RunAgentResponseFormatJsonSchema): string;
|
|
1420
|
+
export declare function runAgentResponseFormatJsonSchemaFromJSON(jsonString: string): SafeParseResult<RunAgentResponseFormatJsonSchema, SDKValidationError>;
|
|
1421
|
+
/** @internal */
|
|
1422
|
+
export declare const RunAgentResponseFormat3$inboundSchema: z.ZodType<RunAgentResponseFormat3, z.ZodTypeDef, unknown>;
|
|
1423
|
+
/** @internal */
|
|
1424
|
+
export type RunAgentResponseFormat3$Outbound = {
|
|
1425
|
+
type: string;
|
|
1426
|
+
json_schema: RunAgentResponseFormatJsonSchema$Outbound;
|
|
1427
|
+
};
|
|
1428
|
+
/** @internal */
|
|
1429
|
+
export declare const RunAgentResponseFormat3$outboundSchema: z.ZodType<RunAgentResponseFormat3$Outbound, z.ZodTypeDef, RunAgentResponseFormat3>;
|
|
1430
|
+
/**
|
|
1431
|
+
* @internal
|
|
1432
|
+
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
|
|
1433
|
+
*/
|
|
1434
|
+
export declare namespace RunAgentResponseFormat3$ {
|
|
1435
|
+
/** @deprecated use `RunAgentResponseFormat3$inboundSchema` instead. */
|
|
1436
|
+
const inboundSchema: z.ZodType<RunAgentResponseFormat3, z.ZodTypeDef, unknown>;
|
|
1437
|
+
/** @deprecated use `RunAgentResponseFormat3$outboundSchema` instead. */
|
|
1438
|
+
const outboundSchema: z.ZodType<RunAgentResponseFormat3$Outbound, z.ZodTypeDef, RunAgentResponseFormat3>;
|
|
1439
|
+
/** @deprecated use `RunAgentResponseFormat3$Outbound` instead. */
|
|
1440
|
+
type Outbound = RunAgentResponseFormat3$Outbound;
|
|
1441
|
+
}
|
|
1442
|
+
export declare function runAgentResponseFormat3ToJSON(runAgentResponseFormat3: RunAgentResponseFormat3): string;
|
|
1443
|
+
export declare function runAgentResponseFormat3FromJSON(jsonString: string): SafeParseResult<RunAgentResponseFormat3, SDKValidationError>;
|
|
1444
|
+
/** @internal */
|
|
1445
|
+
export declare const RunAgentResponseFormatAgentsType$inboundSchema: z.ZodNativeEnum<typeof RunAgentResponseFormatAgentsType>;
|
|
1446
|
+
/** @internal */
|
|
1447
|
+
export declare const RunAgentResponseFormatAgentsType$outboundSchema: z.ZodNativeEnum<typeof RunAgentResponseFormatAgentsType>;
|
|
1448
|
+
/**
|
|
1449
|
+
* @internal
|
|
1450
|
+
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
|
|
1451
|
+
*/
|
|
1452
|
+
export declare namespace RunAgentResponseFormatAgentsType$ {
|
|
1453
|
+
/** @deprecated use `RunAgentResponseFormatAgentsType$inboundSchema` instead. */
|
|
1454
|
+
const inboundSchema: z.ZodNativeEnum<{
|
|
1455
|
+
readonly JsonObject: "json_object";
|
|
1456
|
+
}>;
|
|
1457
|
+
/** @deprecated use `RunAgentResponseFormatAgentsType$outboundSchema` instead. */
|
|
1458
|
+
const outboundSchema: z.ZodNativeEnum<{
|
|
1459
|
+
readonly JsonObject: "json_object";
|
|
1460
|
+
}>;
|
|
1461
|
+
}
|
|
1462
|
+
/** @internal */
|
|
1463
|
+
export declare const RunAgentResponseFormat2$inboundSchema: z.ZodType<RunAgentResponseFormat2, z.ZodTypeDef, unknown>;
|
|
1464
|
+
/** @internal */
|
|
1465
|
+
export type RunAgentResponseFormat2$Outbound = {
|
|
1466
|
+
type: string;
|
|
1467
|
+
};
|
|
1468
|
+
/** @internal */
|
|
1469
|
+
export declare const RunAgentResponseFormat2$outboundSchema: z.ZodType<RunAgentResponseFormat2$Outbound, z.ZodTypeDef, RunAgentResponseFormat2>;
|
|
1470
|
+
/**
|
|
1471
|
+
* @internal
|
|
1472
|
+
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
|
|
1473
|
+
*/
|
|
1474
|
+
export declare namespace RunAgentResponseFormat2$ {
|
|
1475
|
+
/** @deprecated use `RunAgentResponseFormat2$inboundSchema` instead. */
|
|
1476
|
+
const inboundSchema: z.ZodType<RunAgentResponseFormat2, z.ZodTypeDef, unknown>;
|
|
1477
|
+
/** @deprecated use `RunAgentResponseFormat2$outboundSchema` instead. */
|
|
1478
|
+
const outboundSchema: z.ZodType<RunAgentResponseFormat2$Outbound, z.ZodTypeDef, RunAgentResponseFormat2>;
|
|
1479
|
+
/** @deprecated use `RunAgentResponseFormat2$Outbound` instead. */
|
|
1480
|
+
type Outbound = RunAgentResponseFormat2$Outbound;
|
|
1481
|
+
}
|
|
1482
|
+
export declare function runAgentResponseFormat2ToJSON(runAgentResponseFormat2: RunAgentResponseFormat2): string;
|
|
1483
|
+
export declare function runAgentResponseFormat2FromJSON(jsonString: string): SafeParseResult<RunAgentResponseFormat2, SDKValidationError>;
|
|
1484
|
+
/** @internal */
|
|
1485
|
+
export declare const RunAgentResponseFormatType$inboundSchema: z.ZodNativeEnum<typeof RunAgentResponseFormatType>;
|
|
1486
|
+
/** @internal */
|
|
1487
|
+
export declare const RunAgentResponseFormatType$outboundSchema: z.ZodNativeEnum<typeof RunAgentResponseFormatType>;
|
|
1488
|
+
/**
|
|
1489
|
+
* @internal
|
|
1490
|
+
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
|
|
1491
|
+
*/
|
|
1492
|
+
export declare namespace RunAgentResponseFormatType$ {
|
|
1493
|
+
/** @deprecated use `RunAgentResponseFormatType$inboundSchema` instead. */
|
|
1494
|
+
const inboundSchema: z.ZodNativeEnum<{
|
|
1495
|
+
readonly Text: "text";
|
|
1496
|
+
}>;
|
|
1497
|
+
/** @deprecated use `RunAgentResponseFormatType$outboundSchema` instead. */
|
|
1498
|
+
const outboundSchema: z.ZodNativeEnum<{
|
|
1499
|
+
readonly Text: "text";
|
|
1500
|
+
}>;
|
|
1501
|
+
}
|
|
1502
|
+
/** @internal */
|
|
1503
|
+
export declare const RunAgentResponseFormat1$inboundSchema: z.ZodType<RunAgentResponseFormat1, z.ZodTypeDef, unknown>;
|
|
1504
|
+
/** @internal */
|
|
1505
|
+
export type RunAgentResponseFormat1$Outbound = {
|
|
1506
|
+
type: string;
|
|
1507
|
+
};
|
|
1508
|
+
/** @internal */
|
|
1509
|
+
export declare const RunAgentResponseFormat1$outboundSchema: z.ZodType<RunAgentResponseFormat1$Outbound, z.ZodTypeDef, RunAgentResponseFormat1>;
|
|
1510
|
+
/**
|
|
1511
|
+
* @internal
|
|
1512
|
+
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
|
|
1513
|
+
*/
|
|
1514
|
+
export declare namespace RunAgentResponseFormat1$ {
|
|
1515
|
+
/** @deprecated use `RunAgentResponseFormat1$inboundSchema` instead. */
|
|
1516
|
+
const inboundSchema: z.ZodType<RunAgentResponseFormat1, z.ZodTypeDef, unknown>;
|
|
1517
|
+
/** @deprecated use `RunAgentResponseFormat1$outboundSchema` instead. */
|
|
1518
|
+
const outboundSchema: z.ZodType<RunAgentResponseFormat1$Outbound, z.ZodTypeDef, RunAgentResponseFormat1>;
|
|
1519
|
+
/** @deprecated use `RunAgentResponseFormat1$Outbound` instead. */
|
|
1520
|
+
type Outbound = RunAgentResponseFormat1$Outbound;
|
|
1521
|
+
}
|
|
1522
|
+
export declare function runAgentResponseFormat1ToJSON(runAgentResponseFormat1: RunAgentResponseFormat1): string;
|
|
1523
|
+
export declare function runAgentResponseFormat1FromJSON(jsonString: string): SafeParseResult<RunAgentResponseFormat1, SDKValidationError>;
|
|
1524
|
+
/** @internal */
|
|
1525
|
+
export declare const RunAgentModelResponseFormat$inboundSchema: z.ZodType<RunAgentModelResponseFormat, z.ZodTypeDef, unknown>;
|
|
1526
|
+
/** @internal */
|
|
1527
|
+
export type RunAgentModelResponseFormat$Outbound = RunAgentResponseFormat3$Outbound | RunAgentResponseFormat1$Outbound | RunAgentResponseFormat2$Outbound;
|
|
1528
|
+
/** @internal */
|
|
1529
|
+
export declare const RunAgentModelResponseFormat$outboundSchema: z.ZodType<RunAgentModelResponseFormat$Outbound, z.ZodTypeDef, RunAgentModelResponseFormat>;
|
|
1530
|
+
/**
|
|
1531
|
+
* @internal
|
|
1532
|
+
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
|
|
1533
|
+
*/
|
|
1534
|
+
export declare namespace RunAgentModelResponseFormat$ {
|
|
1535
|
+
/** @deprecated use `RunAgentModelResponseFormat$inboundSchema` instead. */
|
|
1536
|
+
const inboundSchema: z.ZodType<RunAgentModelResponseFormat, z.ZodTypeDef, unknown>;
|
|
1537
|
+
/** @deprecated use `RunAgentModelResponseFormat$outboundSchema` instead. */
|
|
1538
|
+
const outboundSchema: z.ZodType<RunAgentModelResponseFormat$Outbound, z.ZodTypeDef, RunAgentModelResponseFormat>;
|
|
1539
|
+
/** @deprecated use `RunAgentModelResponseFormat$Outbound` instead. */
|
|
1540
|
+
type Outbound = RunAgentModelResponseFormat$Outbound;
|
|
1541
|
+
}
|
|
1542
|
+
export declare function runAgentModelResponseFormatToJSON(runAgentModelResponseFormat: RunAgentModelResponseFormat): string;
|
|
1543
|
+
export declare function runAgentModelResponseFormatFromJSON(jsonString: string): SafeParseResult<RunAgentModelResponseFormat, SDKValidationError>;
|
|
1544
|
+
/** @internal */
|
|
1545
|
+
export declare const RunAgentModelStop$inboundSchema: z.ZodType<RunAgentModelStop, z.ZodTypeDef, unknown>;
|
|
1546
|
+
/** @internal */
|
|
1547
|
+
export type RunAgentModelStop$Outbound = string | Array<string>;
|
|
1548
|
+
/** @internal */
|
|
1549
|
+
export declare const RunAgentModelStop$outboundSchema: z.ZodType<RunAgentModelStop$Outbound, z.ZodTypeDef, RunAgentModelStop>;
|
|
1550
|
+
/**
|
|
1551
|
+
* @internal
|
|
1552
|
+
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
|
|
1553
|
+
*/
|
|
1554
|
+
export declare namespace RunAgentModelStop$ {
|
|
1555
|
+
/** @deprecated use `RunAgentModelStop$inboundSchema` instead. */
|
|
1556
|
+
const inboundSchema: z.ZodType<RunAgentModelStop, z.ZodTypeDef, unknown>;
|
|
1557
|
+
/** @deprecated use `RunAgentModelStop$outboundSchema` instead. */
|
|
1558
|
+
const outboundSchema: z.ZodType<RunAgentModelStop$Outbound, z.ZodTypeDef, RunAgentModelStop>;
|
|
1559
|
+
/** @deprecated use `RunAgentModelStop$Outbound` instead. */
|
|
1560
|
+
type Outbound = RunAgentModelStop$Outbound;
|
|
1561
|
+
}
|
|
1562
|
+
export declare function runAgentModelStopToJSON(runAgentModelStop: RunAgentModelStop): string;
|
|
1563
|
+
export declare function runAgentModelStopFromJSON(jsonString: string): SafeParseResult<RunAgentModelStop, SDKValidationError>;
|
|
1564
|
+
/** @internal */
|
|
1565
|
+
export declare const RunAgentModelStreamOptions$inboundSchema: z.ZodType<RunAgentModelStreamOptions, z.ZodTypeDef, unknown>;
|
|
1566
|
+
/** @internal */
|
|
1567
|
+
export type RunAgentModelStreamOptions$Outbound = {
|
|
1568
|
+
include_usage?: boolean | undefined;
|
|
1569
|
+
};
|
|
1570
|
+
/** @internal */
|
|
1571
|
+
export declare const RunAgentModelStreamOptions$outboundSchema: z.ZodType<RunAgentModelStreamOptions$Outbound, z.ZodTypeDef, RunAgentModelStreamOptions>;
|
|
1572
|
+
/**
|
|
1573
|
+
* @internal
|
|
1574
|
+
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
|
|
1575
|
+
*/
|
|
1576
|
+
export declare namespace RunAgentModelStreamOptions$ {
|
|
1577
|
+
/** @deprecated use `RunAgentModelStreamOptions$inboundSchema` instead. */
|
|
1578
|
+
const inboundSchema: z.ZodType<RunAgentModelStreamOptions, z.ZodTypeDef, unknown>;
|
|
1579
|
+
/** @deprecated use `RunAgentModelStreamOptions$outboundSchema` instead. */
|
|
1580
|
+
const outboundSchema: z.ZodType<RunAgentModelStreamOptions$Outbound, z.ZodTypeDef, RunAgentModelStreamOptions>;
|
|
1581
|
+
/** @deprecated use `RunAgentModelStreamOptions$Outbound` instead. */
|
|
1582
|
+
type Outbound = RunAgentModelStreamOptions$Outbound;
|
|
1583
|
+
}
|
|
1584
|
+
export declare function runAgentModelStreamOptionsToJSON(runAgentModelStreamOptions: RunAgentModelStreamOptions): string;
|
|
1585
|
+
export declare function runAgentModelStreamOptionsFromJSON(jsonString: string): SafeParseResult<RunAgentModelStreamOptions, SDKValidationError>;
|
|
1586
|
+
/** @internal */
|
|
1587
|
+
export declare const RunAgentModelType$inboundSchema: z.ZodNativeEnum<typeof RunAgentModelType>;
|
|
1588
|
+
/** @internal */
|
|
1589
|
+
export declare const RunAgentModelType$outboundSchema: z.ZodNativeEnum<typeof RunAgentModelType>;
|
|
1590
|
+
/**
|
|
1591
|
+
* @internal
|
|
1592
|
+
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
|
|
1593
|
+
*/
|
|
1594
|
+
export declare namespace RunAgentModelType$ {
|
|
1595
|
+
/** @deprecated use `RunAgentModelType$inboundSchema` instead. */
|
|
1596
|
+
const inboundSchema: z.ZodNativeEnum<{
|
|
1597
|
+
readonly Enabled: "enabled";
|
|
1598
|
+
readonly Disabled: "disabled";
|
|
1599
|
+
}>;
|
|
1600
|
+
/** @deprecated use `RunAgentModelType$outboundSchema` instead. */
|
|
1601
|
+
const outboundSchema: z.ZodNativeEnum<{
|
|
1602
|
+
readonly Enabled: "enabled";
|
|
1603
|
+
readonly Disabled: "disabled";
|
|
1604
|
+
}>;
|
|
1605
|
+
}
|
|
1606
|
+
/** @internal */
|
|
1607
|
+
export declare const RunAgentModelThinking$inboundSchema: z.ZodType<RunAgentModelThinking, z.ZodTypeDef, unknown>;
|
|
1608
|
+
/** @internal */
|
|
1609
|
+
export type RunAgentModelThinking$Outbound = {
|
|
1610
|
+
type: string;
|
|
1611
|
+
budget_tokens: number;
|
|
1612
|
+
};
|
|
1613
|
+
/** @internal */
|
|
1614
|
+
export declare const RunAgentModelThinking$outboundSchema: z.ZodType<RunAgentModelThinking$Outbound, z.ZodTypeDef, RunAgentModelThinking>;
|
|
1615
|
+
/**
|
|
1616
|
+
* @internal
|
|
1617
|
+
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
|
|
1618
|
+
*/
|
|
1619
|
+
export declare namespace RunAgentModelThinking$ {
|
|
1620
|
+
/** @deprecated use `RunAgentModelThinking$inboundSchema` instead. */
|
|
1621
|
+
const inboundSchema: z.ZodType<RunAgentModelThinking, z.ZodTypeDef, unknown>;
|
|
1622
|
+
/** @deprecated use `RunAgentModelThinking$outboundSchema` instead. */
|
|
1623
|
+
const outboundSchema: z.ZodType<RunAgentModelThinking$Outbound, z.ZodTypeDef, RunAgentModelThinking>;
|
|
1624
|
+
/** @deprecated use `RunAgentModelThinking$Outbound` instead. */
|
|
1625
|
+
type Outbound = RunAgentModelThinking$Outbound;
|
|
1626
|
+
}
|
|
1627
|
+
export declare function runAgentModelThinkingToJSON(runAgentModelThinking: RunAgentModelThinking): string;
|
|
1628
|
+
export declare function runAgentModelThinkingFromJSON(jsonString: string): SafeParseResult<RunAgentModelThinking, SDKValidationError>;
|
|
1629
|
+
/** @internal */
|
|
1630
|
+
export declare const RunAgentToolChoiceType$inboundSchema: z.ZodNativeEnum<typeof RunAgentToolChoiceType>;
|
|
1631
|
+
/** @internal */
|
|
1632
|
+
export declare const RunAgentToolChoiceType$outboundSchema: z.ZodNativeEnum<typeof RunAgentToolChoiceType>;
|
|
1633
|
+
/**
|
|
1634
|
+
* @internal
|
|
1635
|
+
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
|
|
1636
|
+
*/
|
|
1637
|
+
export declare namespace RunAgentToolChoiceType$ {
|
|
1638
|
+
/** @deprecated use `RunAgentToolChoiceType$inboundSchema` instead. */
|
|
1639
|
+
const inboundSchema: z.ZodNativeEnum<{
|
|
1640
|
+
readonly Function: "function";
|
|
1641
|
+
}>;
|
|
1642
|
+
/** @deprecated use `RunAgentToolChoiceType$outboundSchema` instead. */
|
|
1643
|
+
const outboundSchema: z.ZodNativeEnum<{
|
|
1644
|
+
readonly Function: "function";
|
|
1645
|
+
}>;
|
|
1646
|
+
}
|
|
1647
|
+
/** @internal */
|
|
1648
|
+
export declare const RunAgentToolChoiceFunction$inboundSchema: z.ZodType<RunAgentToolChoiceFunction, z.ZodTypeDef, unknown>;
|
|
1649
|
+
/** @internal */
|
|
1650
|
+
export type RunAgentToolChoiceFunction$Outbound = {
|
|
1651
|
+
name?: string | undefined;
|
|
1652
|
+
};
|
|
1653
|
+
/** @internal */
|
|
1654
|
+
export declare const RunAgentToolChoiceFunction$outboundSchema: z.ZodType<RunAgentToolChoiceFunction$Outbound, z.ZodTypeDef, RunAgentToolChoiceFunction>;
|
|
1655
|
+
/**
|
|
1656
|
+
* @internal
|
|
1657
|
+
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
|
|
1658
|
+
*/
|
|
1659
|
+
export declare namespace RunAgentToolChoiceFunction$ {
|
|
1660
|
+
/** @deprecated use `RunAgentToolChoiceFunction$inboundSchema` instead. */
|
|
1661
|
+
const inboundSchema: z.ZodType<RunAgentToolChoiceFunction, z.ZodTypeDef, unknown>;
|
|
1662
|
+
/** @deprecated use `RunAgentToolChoiceFunction$outboundSchema` instead. */
|
|
1663
|
+
const outboundSchema: z.ZodType<RunAgentToolChoiceFunction$Outbound, z.ZodTypeDef, RunAgentToolChoiceFunction>;
|
|
1664
|
+
/** @deprecated use `RunAgentToolChoiceFunction$Outbound` instead. */
|
|
1665
|
+
type Outbound = RunAgentToolChoiceFunction$Outbound;
|
|
1666
|
+
}
|
|
1667
|
+
export declare function runAgentToolChoiceFunctionToJSON(runAgentToolChoiceFunction: RunAgentToolChoiceFunction): string;
|
|
1668
|
+
export declare function runAgentToolChoiceFunctionFromJSON(jsonString: string): SafeParseResult<RunAgentToolChoiceFunction, SDKValidationError>;
|
|
1669
|
+
/** @internal */
|
|
1670
|
+
export declare const RunAgentToolChoice2$inboundSchema: z.ZodType<RunAgentToolChoice2, z.ZodTypeDef, unknown>;
|
|
1671
|
+
/** @internal */
|
|
1672
|
+
export type RunAgentToolChoice2$Outbound = {
|
|
1673
|
+
type?: string | undefined;
|
|
1674
|
+
function: RunAgentToolChoiceFunction$Outbound;
|
|
1675
|
+
};
|
|
1676
|
+
/** @internal */
|
|
1677
|
+
export declare const RunAgentToolChoice2$outboundSchema: z.ZodType<RunAgentToolChoice2$Outbound, z.ZodTypeDef, RunAgentToolChoice2>;
|
|
1678
|
+
/**
|
|
1679
|
+
* @internal
|
|
1680
|
+
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
|
|
1681
|
+
*/
|
|
1682
|
+
export declare namespace RunAgentToolChoice2$ {
|
|
1683
|
+
/** @deprecated use `RunAgentToolChoice2$inboundSchema` instead. */
|
|
1684
|
+
const inboundSchema: z.ZodType<RunAgentToolChoice2, z.ZodTypeDef, unknown>;
|
|
1685
|
+
/** @deprecated use `RunAgentToolChoice2$outboundSchema` instead. */
|
|
1686
|
+
const outboundSchema: z.ZodType<RunAgentToolChoice2$Outbound, z.ZodTypeDef, RunAgentToolChoice2>;
|
|
1687
|
+
/** @deprecated use `RunAgentToolChoice2$Outbound` instead. */
|
|
1688
|
+
type Outbound = RunAgentToolChoice2$Outbound;
|
|
1689
|
+
}
|
|
1690
|
+
export declare function runAgentToolChoice2ToJSON(runAgentToolChoice2: RunAgentToolChoice2): string;
|
|
1691
|
+
export declare function runAgentToolChoice2FromJSON(jsonString: string): SafeParseResult<RunAgentToolChoice2, SDKValidationError>;
|
|
1692
|
+
/** @internal */
|
|
1693
|
+
export declare const RunAgentToolChoice1$inboundSchema: z.ZodNativeEnum<typeof RunAgentToolChoice1>;
|
|
1694
|
+
/** @internal */
|
|
1695
|
+
export declare const RunAgentToolChoice1$outboundSchema: z.ZodNativeEnum<typeof RunAgentToolChoice1>;
|
|
1696
|
+
/**
|
|
1697
|
+
* @internal
|
|
1698
|
+
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
|
|
1699
|
+
*/
|
|
1700
|
+
export declare namespace RunAgentToolChoice1$ {
|
|
1701
|
+
/** @deprecated use `RunAgentToolChoice1$inboundSchema` instead. */
|
|
1702
|
+
const inboundSchema: z.ZodNativeEnum<{
|
|
1703
|
+
readonly None: "none";
|
|
1704
|
+
readonly Auto: "auto";
|
|
1705
|
+
readonly Required: "required";
|
|
1706
|
+
}>;
|
|
1707
|
+
/** @deprecated use `RunAgentToolChoice1$outboundSchema` instead. */
|
|
1708
|
+
const outboundSchema: z.ZodNativeEnum<{
|
|
1709
|
+
readonly None: "none";
|
|
1710
|
+
readonly Auto: "auto";
|
|
1711
|
+
readonly Required: "required";
|
|
1712
|
+
}>;
|
|
1713
|
+
}
|
|
1714
|
+
/** @internal */
|
|
1715
|
+
export declare const RunAgentModelToolChoice$inboundSchema: z.ZodType<RunAgentModelToolChoice, z.ZodTypeDef, unknown>;
|
|
1716
|
+
/** @internal */
|
|
1717
|
+
export type RunAgentModelToolChoice$Outbound = RunAgentToolChoice2$Outbound | string;
|
|
1718
|
+
/** @internal */
|
|
1719
|
+
export declare const RunAgentModelToolChoice$outboundSchema: z.ZodType<RunAgentModelToolChoice$Outbound, z.ZodTypeDef, RunAgentModelToolChoice>;
|
|
1720
|
+
/**
|
|
1721
|
+
* @internal
|
|
1722
|
+
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
|
|
1723
|
+
*/
|
|
1724
|
+
export declare namespace RunAgentModelToolChoice$ {
|
|
1725
|
+
/** @deprecated use `RunAgentModelToolChoice$inboundSchema` instead. */
|
|
1726
|
+
const inboundSchema: z.ZodType<RunAgentModelToolChoice, z.ZodTypeDef, unknown>;
|
|
1727
|
+
/** @deprecated use `RunAgentModelToolChoice$outboundSchema` instead. */
|
|
1728
|
+
const outboundSchema: z.ZodType<RunAgentModelToolChoice$Outbound, z.ZodTypeDef, RunAgentModelToolChoice>;
|
|
1729
|
+
/** @deprecated use `RunAgentModelToolChoice$Outbound` instead. */
|
|
1730
|
+
type Outbound = RunAgentModelToolChoice$Outbound;
|
|
1731
|
+
}
|
|
1732
|
+
export declare function runAgentModelToolChoiceToJSON(runAgentModelToolChoice: RunAgentModelToolChoice): string;
|
|
1733
|
+
export declare function runAgentModelToolChoiceFromJSON(jsonString: string): SafeParseResult<RunAgentModelToolChoice, SDKValidationError>;
|
|
1734
|
+
/** @internal */
|
|
1735
|
+
export declare const RunAgentModelModalities$inboundSchema: z.ZodNativeEnum<typeof RunAgentModelModalities>;
|
|
1736
|
+
/** @internal */
|
|
1737
|
+
export declare const RunAgentModelModalities$outboundSchema: z.ZodNativeEnum<typeof RunAgentModelModalities>;
|
|
1738
|
+
/**
|
|
1739
|
+
* @internal
|
|
1740
|
+
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
|
|
1741
|
+
*/
|
|
1742
|
+
export declare namespace RunAgentModelModalities$ {
|
|
1743
|
+
/** @deprecated use `RunAgentModelModalities$inboundSchema` instead. */
|
|
1744
|
+
const inboundSchema: z.ZodNativeEnum<{
|
|
1745
|
+
readonly Text: "text";
|
|
1746
|
+
readonly Audio: "audio";
|
|
1747
|
+
}>;
|
|
1748
|
+
/** @deprecated use `RunAgentModelModalities$outboundSchema` instead. */
|
|
1749
|
+
const outboundSchema: z.ZodNativeEnum<{
|
|
1750
|
+
readonly Text: "text";
|
|
1751
|
+
readonly Audio: "audio";
|
|
1752
|
+
}>;
|
|
1753
|
+
}
|
|
1754
|
+
/** @internal */
|
|
1755
|
+
export declare const RunAgentModelWebSearchOptions$inboundSchema: z.ZodType<RunAgentModelWebSearchOptions, z.ZodTypeDef, unknown>;
|
|
1756
|
+
/** @internal */
|
|
1757
|
+
export type RunAgentModelWebSearchOptions$Outbound = {
|
|
1758
|
+
enabled?: boolean | undefined;
|
|
1759
|
+
};
|
|
1760
|
+
/** @internal */
|
|
1761
|
+
export declare const RunAgentModelWebSearchOptions$outboundSchema: z.ZodType<RunAgentModelWebSearchOptions$Outbound, z.ZodTypeDef, RunAgentModelWebSearchOptions>;
|
|
1762
|
+
/**
|
|
1763
|
+
* @internal
|
|
1764
|
+
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
|
|
1765
|
+
*/
|
|
1766
|
+
export declare namespace RunAgentModelWebSearchOptions$ {
|
|
1767
|
+
/** @deprecated use `RunAgentModelWebSearchOptions$inboundSchema` instead. */
|
|
1768
|
+
const inboundSchema: z.ZodType<RunAgentModelWebSearchOptions, z.ZodTypeDef, unknown>;
|
|
1769
|
+
/** @deprecated use `RunAgentModelWebSearchOptions$outboundSchema` instead. */
|
|
1770
|
+
const outboundSchema: z.ZodType<RunAgentModelWebSearchOptions$Outbound, z.ZodTypeDef, RunAgentModelWebSearchOptions>;
|
|
1771
|
+
/** @deprecated use `RunAgentModelWebSearchOptions$Outbound` instead. */
|
|
1772
|
+
type Outbound = RunAgentModelWebSearchOptions$Outbound;
|
|
1773
|
+
}
|
|
1774
|
+
export declare function runAgentModelWebSearchOptionsToJSON(runAgentModelWebSearchOptions: RunAgentModelWebSearchOptions): string;
|
|
1775
|
+
export declare function runAgentModelWebSearchOptionsFromJSON(jsonString: string): SafeParseResult<RunAgentModelWebSearchOptions, SDKValidationError>;
|
|
1776
|
+
/** @internal */
|
|
1777
|
+
export declare const RunAgentModelParameters$inboundSchema: z.ZodType<RunAgentModelParameters, z.ZodTypeDef, unknown>;
|
|
1778
|
+
/** @internal */
|
|
1779
|
+
export type RunAgentModelParameters$Outbound = {
|
|
1780
|
+
audio?: RunAgentModelAudio$Outbound | null | undefined;
|
|
1781
|
+
frequency_penalty?: number | null | undefined;
|
|
1782
|
+
max_tokens?: number | null | undefined;
|
|
1783
|
+
max_completion_tokens?: number | null | undefined;
|
|
1784
|
+
logprobs?: boolean | null | undefined;
|
|
1785
|
+
top_logprobs?: number | null | undefined;
|
|
1786
|
+
n?: number | null | undefined;
|
|
1787
|
+
presence_penalty?: number | null | undefined;
|
|
1788
|
+
response_format?: RunAgentResponseFormat3$Outbound | RunAgentResponseFormat1$Outbound | RunAgentResponseFormat2$Outbound | undefined;
|
|
1789
|
+
reasoning_effort?: string | undefined;
|
|
1790
|
+
verbosity?: string | undefined;
|
|
1791
|
+
seed?: number | null | undefined;
|
|
1792
|
+
stop?: string | Array<string> | null | undefined;
|
|
1793
|
+
stream_options?: RunAgentModelStreamOptions$Outbound | null | undefined;
|
|
1794
|
+
thinking?: RunAgentModelThinking$Outbound | undefined;
|
|
1795
|
+
temperature?: number | null | undefined;
|
|
1796
|
+
top_p?: number | null | undefined;
|
|
1797
|
+
top_k?: number | null | undefined;
|
|
1798
|
+
tool_choice?: RunAgentToolChoice2$Outbound | string | undefined;
|
|
1799
|
+
parallel_tool_calls?: boolean | undefined;
|
|
1800
|
+
modalities?: Array<string> | null | undefined;
|
|
1801
|
+
web_search_options?: RunAgentModelWebSearchOptions$Outbound | undefined;
|
|
1802
|
+
};
|
|
1803
|
+
/** @internal */
|
|
1804
|
+
export declare const RunAgentModelParameters$outboundSchema: z.ZodType<RunAgentModelParameters$Outbound, z.ZodTypeDef, RunAgentModelParameters>;
|
|
1805
|
+
/**
|
|
1806
|
+
* @internal
|
|
1807
|
+
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
|
|
1808
|
+
*/
|
|
1809
|
+
export declare namespace RunAgentModelParameters$ {
|
|
1810
|
+
/** @deprecated use `RunAgentModelParameters$inboundSchema` instead. */
|
|
1811
|
+
const inboundSchema: z.ZodType<RunAgentModelParameters, z.ZodTypeDef, unknown>;
|
|
1812
|
+
/** @deprecated use `RunAgentModelParameters$outboundSchema` instead. */
|
|
1813
|
+
const outboundSchema: z.ZodType<RunAgentModelParameters$Outbound, z.ZodTypeDef, RunAgentModelParameters>;
|
|
1814
|
+
/** @deprecated use `RunAgentModelParameters$Outbound` instead. */
|
|
1815
|
+
type Outbound = RunAgentModelParameters$Outbound;
|
|
1816
|
+
}
|
|
1817
|
+
export declare function runAgentModelParametersToJSON(runAgentModelParameters: RunAgentModelParameters): string;
|
|
1818
|
+
export declare function runAgentModelParametersFromJSON(jsonString: string): SafeParseResult<RunAgentModelParameters, SDKValidationError>;
|
|
1819
|
+
/** @internal */
|
|
1820
|
+
export declare const RunAgentModel2$inboundSchema: z.ZodType<RunAgentModel2, z.ZodTypeDef, unknown>;
|
|
1821
|
+
/** @internal */
|
|
1822
|
+
export type RunAgentModel2$Outbound = {
|
|
1823
|
+
id: string;
|
|
1824
|
+
integration_id?: string | null | undefined;
|
|
1825
|
+
parameters?: RunAgentModelParameters$Outbound | undefined;
|
|
1826
|
+
};
|
|
1827
|
+
/** @internal */
|
|
1828
|
+
export declare const RunAgentModel2$outboundSchema: z.ZodType<RunAgentModel2$Outbound, z.ZodTypeDef, RunAgentModel2>;
|
|
1829
|
+
/**
|
|
1830
|
+
* @internal
|
|
1831
|
+
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
|
|
1832
|
+
*/
|
|
1833
|
+
export declare namespace RunAgentModel2$ {
|
|
1834
|
+
/** @deprecated use `RunAgentModel2$inboundSchema` instead. */
|
|
1835
|
+
const inboundSchema: z.ZodType<RunAgentModel2, z.ZodTypeDef, unknown>;
|
|
1836
|
+
/** @deprecated use `RunAgentModel2$outboundSchema` instead. */
|
|
1837
|
+
const outboundSchema: z.ZodType<RunAgentModel2$Outbound, z.ZodTypeDef, RunAgentModel2>;
|
|
1838
|
+
/** @deprecated use `RunAgentModel2$Outbound` instead. */
|
|
1839
|
+
type Outbound = RunAgentModel2$Outbound;
|
|
1840
|
+
}
|
|
1841
|
+
export declare function runAgentModel2ToJSON(runAgentModel2: RunAgentModel2): string;
|
|
1842
|
+
export declare function runAgentModel2FromJSON(jsonString: string): SafeParseResult<RunAgentModel2, SDKValidationError>;
|
|
1843
|
+
/** @internal */
|
|
1844
|
+
export declare const RunAgentModel$inboundSchema: z.ZodType<RunAgentModel, z.ZodTypeDef, unknown>;
|
|
1845
|
+
/** @internal */
|
|
1846
|
+
export type RunAgentModel$Outbound = RunAgentModel2$Outbound | string;
|
|
1847
|
+
/** @internal */
|
|
1848
|
+
export declare const RunAgentModel$outboundSchema: z.ZodType<RunAgentModel$Outbound, z.ZodTypeDef, RunAgentModel>;
|
|
1849
|
+
/**
|
|
1850
|
+
* @internal
|
|
1851
|
+
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
|
|
1852
|
+
*/
|
|
1853
|
+
export declare namespace RunAgentModel$ {
|
|
1854
|
+
/** @deprecated use `RunAgentModel$inboundSchema` instead. */
|
|
1855
|
+
const inboundSchema: z.ZodType<RunAgentModel, z.ZodTypeDef, unknown>;
|
|
1856
|
+
/** @deprecated use `RunAgentModel$outboundSchema` instead. */
|
|
1857
|
+
const outboundSchema: z.ZodType<RunAgentModel$Outbound, z.ZodTypeDef, RunAgentModel>;
|
|
1858
|
+
/** @deprecated use `RunAgentModel$Outbound` instead. */
|
|
1859
|
+
type Outbound = RunAgentModel$Outbound;
|
|
1860
|
+
}
|
|
1861
|
+
export declare function runAgentModelToJSON(runAgentModel: RunAgentModel): string;
|
|
1862
|
+
export declare function runAgentModelFromJSON(jsonString: string): SafeParseResult<RunAgentModel, SDKValidationError>;
|
|
1863
|
+
/** @internal */
|
|
1864
|
+
export declare const RunAgentFallbackModelsVoice$inboundSchema: z.ZodNativeEnum<typeof RunAgentFallbackModelsVoice>;
|
|
1865
|
+
/** @internal */
|
|
1866
|
+
export declare const RunAgentFallbackModelsVoice$outboundSchema: z.ZodNativeEnum<typeof RunAgentFallbackModelsVoice>;
|
|
1867
|
+
/**
|
|
1868
|
+
* @internal
|
|
1869
|
+
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
|
|
1870
|
+
*/
|
|
1871
|
+
export declare namespace RunAgentFallbackModelsVoice$ {
|
|
1872
|
+
/** @deprecated use `RunAgentFallbackModelsVoice$inboundSchema` instead. */
|
|
1873
|
+
const inboundSchema: z.ZodNativeEnum<{
|
|
1874
|
+
readonly Alloy: "alloy";
|
|
1875
|
+
readonly Echo: "echo";
|
|
1876
|
+
readonly Fable: "fable";
|
|
1877
|
+
readonly Onyx: "onyx";
|
|
1878
|
+
readonly Nova: "nova";
|
|
1879
|
+
readonly Shimmer: "shimmer";
|
|
1880
|
+
}>;
|
|
1881
|
+
/** @deprecated use `RunAgentFallbackModelsVoice$outboundSchema` instead. */
|
|
1882
|
+
const outboundSchema: z.ZodNativeEnum<{
|
|
1883
|
+
readonly Alloy: "alloy";
|
|
1884
|
+
readonly Echo: "echo";
|
|
1885
|
+
readonly Fable: "fable";
|
|
1886
|
+
readonly Onyx: "onyx";
|
|
1887
|
+
readonly Nova: "nova";
|
|
1888
|
+
readonly Shimmer: "shimmer";
|
|
1889
|
+
}>;
|
|
1890
|
+
}
|
|
1891
|
+
/** @internal */
|
|
1892
|
+
export declare const RunAgentFallbackModelsFormat$inboundSchema: z.ZodNativeEnum<typeof RunAgentFallbackModelsFormat>;
|
|
1893
|
+
/** @internal */
|
|
1894
|
+
export declare const RunAgentFallbackModelsFormat$outboundSchema: z.ZodNativeEnum<typeof RunAgentFallbackModelsFormat>;
|
|
1895
|
+
/**
|
|
1896
|
+
* @internal
|
|
1897
|
+
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
|
|
1898
|
+
*/
|
|
1899
|
+
export declare namespace RunAgentFallbackModelsFormat$ {
|
|
1900
|
+
/** @deprecated use `RunAgentFallbackModelsFormat$inboundSchema` instead. */
|
|
1901
|
+
const inboundSchema: z.ZodNativeEnum<{
|
|
1902
|
+
readonly Wav: "wav";
|
|
1903
|
+
readonly Mp3: "mp3";
|
|
1904
|
+
readonly Flac: "flac";
|
|
1905
|
+
readonly Opus: "opus";
|
|
1906
|
+
readonly Pcm16: "pcm16";
|
|
1907
|
+
}>;
|
|
1908
|
+
/** @deprecated use `RunAgentFallbackModelsFormat$outboundSchema` instead. */
|
|
1909
|
+
const outboundSchema: z.ZodNativeEnum<{
|
|
1910
|
+
readonly Wav: "wav";
|
|
1911
|
+
readonly Mp3: "mp3";
|
|
1912
|
+
readonly Flac: "flac";
|
|
1913
|
+
readonly Opus: "opus";
|
|
1914
|
+
readonly Pcm16: "pcm16";
|
|
1915
|
+
}>;
|
|
1916
|
+
}
|
|
1917
|
+
/** @internal */
|
|
1918
|
+
export declare const RunAgentFallbackModelsAudio$inboundSchema: z.ZodType<RunAgentFallbackModelsAudio, z.ZodTypeDef, unknown>;
|
|
1919
|
+
/** @internal */
|
|
1920
|
+
export type RunAgentFallbackModelsAudio$Outbound = {
|
|
1921
|
+
voice: string;
|
|
1922
|
+
format: string;
|
|
1923
|
+
};
|
|
1924
|
+
/** @internal */
|
|
1925
|
+
export declare const RunAgentFallbackModelsAudio$outboundSchema: z.ZodType<RunAgentFallbackModelsAudio$Outbound, z.ZodTypeDef, RunAgentFallbackModelsAudio>;
|
|
1926
|
+
/**
|
|
1927
|
+
* @internal
|
|
1928
|
+
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
|
|
1929
|
+
*/
|
|
1930
|
+
export declare namespace RunAgentFallbackModelsAudio$ {
|
|
1931
|
+
/** @deprecated use `RunAgentFallbackModelsAudio$inboundSchema` instead. */
|
|
1932
|
+
const inboundSchema: z.ZodType<RunAgentFallbackModelsAudio, z.ZodTypeDef, unknown>;
|
|
1933
|
+
/** @deprecated use `RunAgentFallbackModelsAudio$outboundSchema` instead. */
|
|
1934
|
+
const outboundSchema: z.ZodType<RunAgentFallbackModelsAudio$Outbound, z.ZodTypeDef, RunAgentFallbackModelsAudio>;
|
|
1935
|
+
/** @deprecated use `RunAgentFallbackModelsAudio$Outbound` instead. */
|
|
1936
|
+
type Outbound = RunAgentFallbackModelsAudio$Outbound;
|
|
1937
|
+
}
|
|
1938
|
+
export declare function runAgentFallbackModelsAudioToJSON(runAgentFallbackModelsAudio: RunAgentFallbackModelsAudio): string;
|
|
1939
|
+
export declare function runAgentFallbackModelsAudioFromJSON(jsonString: string): SafeParseResult<RunAgentFallbackModelsAudio, SDKValidationError>;
|
|
1940
|
+
/** @internal */
|
|
1941
|
+
export declare const RunAgentResponseFormatAgentsRequestRequestBodyFallbackModels2Type$inboundSchema: z.ZodNativeEnum<typeof RunAgentResponseFormatAgentsRequestRequestBodyFallbackModels2Type>;
|
|
1942
|
+
/** @internal */
|
|
1943
|
+
export declare const RunAgentResponseFormatAgentsRequestRequestBodyFallbackModels2Type$outboundSchema: z.ZodNativeEnum<typeof RunAgentResponseFormatAgentsRequestRequestBodyFallbackModels2Type>;
|
|
1944
|
+
/**
|
|
1945
|
+
* @internal
|
|
1946
|
+
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
|
|
1947
|
+
*/
|
|
1948
|
+
export declare namespace RunAgentResponseFormatAgentsRequestRequestBodyFallbackModels2Type$ {
|
|
1949
|
+
/** @deprecated use `RunAgentResponseFormatAgentsRequestRequestBodyFallbackModels2Type$inboundSchema` instead. */
|
|
1950
|
+
const inboundSchema: z.ZodNativeEnum<{
|
|
1951
|
+
readonly JsonSchema: "json_schema";
|
|
1952
|
+
}>;
|
|
1953
|
+
/** @deprecated use `RunAgentResponseFormatAgentsRequestRequestBodyFallbackModels2Type$outboundSchema` instead. */
|
|
1954
|
+
const outboundSchema: z.ZodNativeEnum<{
|
|
1955
|
+
readonly JsonSchema: "json_schema";
|
|
1956
|
+
}>;
|
|
1957
|
+
}
|
|
1958
|
+
/** @internal */
|
|
1959
|
+
export declare const RunAgentResponseFormatAgentsJsonSchema$inboundSchema: z.ZodType<RunAgentResponseFormatAgentsJsonSchema, z.ZodTypeDef, unknown>;
|
|
1960
|
+
/** @internal */
|
|
1961
|
+
export type RunAgentResponseFormatAgentsJsonSchema$Outbound = {
|
|
1962
|
+
description?: string | undefined;
|
|
1963
|
+
name: string;
|
|
1964
|
+
schema?: any | undefined;
|
|
1965
|
+
strict?: boolean | undefined;
|
|
1966
|
+
};
|
|
1967
|
+
/** @internal */
|
|
1968
|
+
export declare const RunAgentResponseFormatAgentsJsonSchema$outboundSchema: z.ZodType<RunAgentResponseFormatAgentsJsonSchema$Outbound, z.ZodTypeDef, RunAgentResponseFormatAgentsJsonSchema>;
|
|
1969
|
+
/**
|
|
1970
|
+
* @internal
|
|
1971
|
+
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
|
|
1972
|
+
*/
|
|
1973
|
+
export declare namespace RunAgentResponseFormatAgentsJsonSchema$ {
|
|
1974
|
+
/** @deprecated use `RunAgentResponseFormatAgentsJsonSchema$inboundSchema` instead. */
|
|
1975
|
+
const inboundSchema: z.ZodType<RunAgentResponseFormatAgentsJsonSchema, z.ZodTypeDef, unknown>;
|
|
1976
|
+
/** @deprecated use `RunAgentResponseFormatAgentsJsonSchema$outboundSchema` instead. */
|
|
1977
|
+
const outboundSchema: z.ZodType<RunAgentResponseFormatAgentsJsonSchema$Outbound, z.ZodTypeDef, RunAgentResponseFormatAgentsJsonSchema>;
|
|
1978
|
+
/** @deprecated use `RunAgentResponseFormatAgentsJsonSchema$Outbound` instead. */
|
|
1979
|
+
type Outbound = RunAgentResponseFormatAgentsJsonSchema$Outbound;
|
|
1980
|
+
}
|
|
1981
|
+
export declare function runAgentResponseFormatAgentsJsonSchemaToJSON(runAgentResponseFormatAgentsJsonSchema: RunAgentResponseFormatAgentsJsonSchema): string;
|
|
1982
|
+
export declare function runAgentResponseFormatAgentsJsonSchemaFromJSON(jsonString: string): SafeParseResult<RunAgentResponseFormatAgentsJsonSchema, SDKValidationError>;
|
|
1983
|
+
/** @internal */
|
|
1984
|
+
export declare const RunAgentResponseFormatAgents3$inboundSchema: z.ZodType<RunAgentResponseFormatAgents3, z.ZodTypeDef, unknown>;
|
|
1985
|
+
/** @internal */
|
|
1986
|
+
export type RunAgentResponseFormatAgents3$Outbound = {
|
|
1987
|
+
type: string;
|
|
1988
|
+
json_schema: RunAgentResponseFormatAgentsJsonSchema$Outbound;
|
|
1989
|
+
};
|
|
1990
|
+
/** @internal */
|
|
1991
|
+
export declare const RunAgentResponseFormatAgents3$outboundSchema: z.ZodType<RunAgentResponseFormatAgents3$Outbound, z.ZodTypeDef, RunAgentResponseFormatAgents3>;
|
|
1992
|
+
/**
|
|
1993
|
+
* @internal
|
|
1994
|
+
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
|
|
1995
|
+
*/
|
|
1996
|
+
export declare namespace RunAgentResponseFormatAgents3$ {
|
|
1997
|
+
/** @deprecated use `RunAgentResponseFormatAgents3$inboundSchema` instead. */
|
|
1998
|
+
const inboundSchema: z.ZodType<RunAgentResponseFormatAgents3, z.ZodTypeDef, unknown>;
|
|
1999
|
+
/** @deprecated use `RunAgentResponseFormatAgents3$outboundSchema` instead. */
|
|
2000
|
+
const outboundSchema: z.ZodType<RunAgentResponseFormatAgents3$Outbound, z.ZodTypeDef, RunAgentResponseFormatAgents3>;
|
|
2001
|
+
/** @deprecated use `RunAgentResponseFormatAgents3$Outbound` instead. */
|
|
2002
|
+
type Outbound = RunAgentResponseFormatAgents3$Outbound;
|
|
2003
|
+
}
|
|
2004
|
+
export declare function runAgentResponseFormatAgents3ToJSON(runAgentResponseFormatAgents3: RunAgentResponseFormatAgents3): string;
|
|
2005
|
+
export declare function runAgentResponseFormatAgents3FromJSON(jsonString: string): SafeParseResult<RunAgentResponseFormatAgents3, SDKValidationError>;
|
|
2006
|
+
/** @internal */
|
|
2007
|
+
export declare const RunAgentResponseFormatAgentsRequestRequestBodyFallbackModelsType$inboundSchema: z.ZodNativeEnum<typeof RunAgentResponseFormatAgentsRequestRequestBodyFallbackModelsType>;
|
|
2008
|
+
/** @internal */
|
|
2009
|
+
export declare const RunAgentResponseFormatAgentsRequestRequestBodyFallbackModelsType$outboundSchema: z.ZodNativeEnum<typeof RunAgentResponseFormatAgentsRequestRequestBodyFallbackModelsType>;
|
|
2010
|
+
/**
|
|
2011
|
+
* @internal
|
|
2012
|
+
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
|
|
2013
|
+
*/
|
|
2014
|
+
export declare namespace RunAgentResponseFormatAgentsRequestRequestBodyFallbackModelsType$ {
|
|
2015
|
+
/** @deprecated use `RunAgentResponseFormatAgentsRequestRequestBodyFallbackModelsType$inboundSchema` instead. */
|
|
2016
|
+
const inboundSchema: z.ZodNativeEnum<{
|
|
2017
|
+
readonly JsonObject: "json_object";
|
|
2018
|
+
}>;
|
|
2019
|
+
/** @deprecated use `RunAgentResponseFormatAgentsRequestRequestBodyFallbackModelsType$outboundSchema` instead. */
|
|
2020
|
+
const outboundSchema: z.ZodNativeEnum<{
|
|
2021
|
+
readonly JsonObject: "json_object";
|
|
2022
|
+
}>;
|
|
2023
|
+
}
|
|
2024
|
+
/** @internal */
|
|
2025
|
+
export declare const RunAgentResponseFormatAgents2$inboundSchema: z.ZodType<RunAgentResponseFormatAgents2, z.ZodTypeDef, unknown>;
|
|
2026
|
+
/** @internal */
|
|
2027
|
+
export type RunAgentResponseFormatAgents2$Outbound = {
|
|
2028
|
+
type: string;
|
|
2029
|
+
};
|
|
2030
|
+
/** @internal */
|
|
2031
|
+
export declare const RunAgentResponseFormatAgents2$outboundSchema: z.ZodType<RunAgentResponseFormatAgents2$Outbound, z.ZodTypeDef, RunAgentResponseFormatAgents2>;
|
|
2032
|
+
/**
|
|
2033
|
+
* @internal
|
|
2034
|
+
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
|
|
2035
|
+
*/
|
|
2036
|
+
export declare namespace RunAgentResponseFormatAgents2$ {
|
|
2037
|
+
/** @deprecated use `RunAgentResponseFormatAgents2$inboundSchema` instead. */
|
|
2038
|
+
const inboundSchema: z.ZodType<RunAgentResponseFormatAgents2, z.ZodTypeDef, unknown>;
|
|
2039
|
+
/** @deprecated use `RunAgentResponseFormatAgents2$outboundSchema` instead. */
|
|
2040
|
+
const outboundSchema: z.ZodType<RunAgentResponseFormatAgents2$Outbound, z.ZodTypeDef, RunAgentResponseFormatAgents2>;
|
|
2041
|
+
/** @deprecated use `RunAgentResponseFormatAgents2$Outbound` instead. */
|
|
2042
|
+
type Outbound = RunAgentResponseFormatAgents2$Outbound;
|
|
2043
|
+
}
|
|
2044
|
+
export declare function runAgentResponseFormatAgents2ToJSON(runAgentResponseFormatAgents2: RunAgentResponseFormatAgents2): string;
|
|
2045
|
+
export declare function runAgentResponseFormatAgents2FromJSON(jsonString: string): SafeParseResult<RunAgentResponseFormatAgents2, SDKValidationError>;
|
|
2046
|
+
/** @internal */
|
|
2047
|
+
export declare const RunAgentResponseFormatAgentsRequestRequestBodyType$inboundSchema: z.ZodNativeEnum<typeof RunAgentResponseFormatAgentsRequestRequestBodyType>;
|
|
2048
|
+
/** @internal */
|
|
2049
|
+
export declare const RunAgentResponseFormatAgentsRequestRequestBodyType$outboundSchema: z.ZodNativeEnum<typeof RunAgentResponseFormatAgentsRequestRequestBodyType>;
|
|
2050
|
+
/**
|
|
2051
|
+
* @internal
|
|
2052
|
+
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
|
|
2053
|
+
*/
|
|
2054
|
+
export declare namespace RunAgentResponseFormatAgentsRequestRequestBodyType$ {
|
|
2055
|
+
/** @deprecated use `RunAgentResponseFormatAgentsRequestRequestBodyType$inboundSchema` instead. */
|
|
2056
|
+
const inboundSchema: z.ZodNativeEnum<{
|
|
2057
|
+
readonly Text: "text";
|
|
2058
|
+
}>;
|
|
2059
|
+
/** @deprecated use `RunAgentResponseFormatAgentsRequestRequestBodyType$outboundSchema` instead. */
|
|
2060
|
+
const outboundSchema: z.ZodNativeEnum<{
|
|
2061
|
+
readonly Text: "text";
|
|
2062
|
+
}>;
|
|
2063
|
+
}
|
|
2064
|
+
/** @internal */
|
|
2065
|
+
export declare const RunAgentResponseFormatAgents1$inboundSchema: z.ZodType<RunAgentResponseFormatAgents1, z.ZodTypeDef, unknown>;
|
|
2066
|
+
/** @internal */
|
|
2067
|
+
export type RunAgentResponseFormatAgents1$Outbound = {
|
|
2068
|
+
type: string;
|
|
2069
|
+
};
|
|
2070
|
+
/** @internal */
|
|
2071
|
+
export declare const RunAgentResponseFormatAgents1$outboundSchema: z.ZodType<RunAgentResponseFormatAgents1$Outbound, z.ZodTypeDef, RunAgentResponseFormatAgents1>;
|
|
2072
|
+
/**
|
|
2073
|
+
* @internal
|
|
2074
|
+
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
|
|
2075
|
+
*/
|
|
2076
|
+
export declare namespace RunAgentResponseFormatAgents1$ {
|
|
2077
|
+
/** @deprecated use `RunAgentResponseFormatAgents1$inboundSchema` instead. */
|
|
2078
|
+
const inboundSchema: z.ZodType<RunAgentResponseFormatAgents1, z.ZodTypeDef, unknown>;
|
|
2079
|
+
/** @deprecated use `RunAgentResponseFormatAgents1$outboundSchema` instead. */
|
|
2080
|
+
const outboundSchema: z.ZodType<RunAgentResponseFormatAgents1$Outbound, z.ZodTypeDef, RunAgentResponseFormatAgents1>;
|
|
2081
|
+
/** @deprecated use `RunAgentResponseFormatAgents1$Outbound` instead. */
|
|
2082
|
+
type Outbound = RunAgentResponseFormatAgents1$Outbound;
|
|
2083
|
+
}
|
|
2084
|
+
export declare function runAgentResponseFormatAgents1ToJSON(runAgentResponseFormatAgents1: RunAgentResponseFormatAgents1): string;
|
|
2085
|
+
export declare function runAgentResponseFormatAgents1FromJSON(jsonString: string): SafeParseResult<RunAgentResponseFormatAgents1, SDKValidationError>;
|
|
2086
|
+
/** @internal */
|
|
2087
|
+
export declare const RunAgentFallbackModelsResponseFormat$inboundSchema: z.ZodType<RunAgentFallbackModelsResponseFormat, z.ZodTypeDef, unknown>;
|
|
2088
|
+
/** @internal */
|
|
2089
|
+
export type RunAgentFallbackModelsResponseFormat$Outbound = RunAgentResponseFormatAgents3$Outbound | RunAgentResponseFormatAgents1$Outbound | RunAgentResponseFormatAgents2$Outbound;
|
|
2090
|
+
/** @internal */
|
|
2091
|
+
export declare const RunAgentFallbackModelsResponseFormat$outboundSchema: z.ZodType<RunAgentFallbackModelsResponseFormat$Outbound, z.ZodTypeDef, RunAgentFallbackModelsResponseFormat>;
|
|
2092
|
+
/**
|
|
2093
|
+
* @internal
|
|
2094
|
+
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
|
|
2095
|
+
*/
|
|
2096
|
+
export declare namespace RunAgentFallbackModelsResponseFormat$ {
|
|
2097
|
+
/** @deprecated use `RunAgentFallbackModelsResponseFormat$inboundSchema` instead. */
|
|
2098
|
+
const inboundSchema: z.ZodType<RunAgentFallbackModelsResponseFormat, z.ZodTypeDef, unknown>;
|
|
2099
|
+
/** @deprecated use `RunAgentFallbackModelsResponseFormat$outboundSchema` instead. */
|
|
2100
|
+
const outboundSchema: z.ZodType<RunAgentFallbackModelsResponseFormat$Outbound, z.ZodTypeDef, RunAgentFallbackModelsResponseFormat>;
|
|
2101
|
+
/** @deprecated use `RunAgentFallbackModelsResponseFormat$Outbound` instead. */
|
|
2102
|
+
type Outbound = RunAgentFallbackModelsResponseFormat$Outbound;
|
|
2103
|
+
}
|
|
2104
|
+
export declare function runAgentFallbackModelsResponseFormatToJSON(runAgentFallbackModelsResponseFormat: RunAgentFallbackModelsResponseFormat): string;
|
|
2105
|
+
export declare function runAgentFallbackModelsResponseFormatFromJSON(jsonString: string): SafeParseResult<RunAgentFallbackModelsResponseFormat, SDKValidationError>;
|
|
2106
|
+
/** @internal */
|
|
2107
|
+
export declare const RunAgentFallbackModelsStop$inboundSchema: z.ZodType<RunAgentFallbackModelsStop, z.ZodTypeDef, unknown>;
|
|
2108
|
+
/** @internal */
|
|
2109
|
+
export type RunAgentFallbackModelsStop$Outbound = string | Array<string>;
|
|
2110
|
+
/** @internal */
|
|
2111
|
+
export declare const RunAgentFallbackModelsStop$outboundSchema: z.ZodType<RunAgentFallbackModelsStop$Outbound, z.ZodTypeDef, RunAgentFallbackModelsStop>;
|
|
2112
|
+
/**
|
|
2113
|
+
* @internal
|
|
2114
|
+
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
|
|
2115
|
+
*/
|
|
2116
|
+
export declare namespace RunAgentFallbackModelsStop$ {
|
|
2117
|
+
/** @deprecated use `RunAgentFallbackModelsStop$inboundSchema` instead. */
|
|
2118
|
+
const inboundSchema: z.ZodType<RunAgentFallbackModelsStop, z.ZodTypeDef, unknown>;
|
|
2119
|
+
/** @deprecated use `RunAgentFallbackModelsStop$outboundSchema` instead. */
|
|
2120
|
+
const outboundSchema: z.ZodType<RunAgentFallbackModelsStop$Outbound, z.ZodTypeDef, RunAgentFallbackModelsStop>;
|
|
2121
|
+
/** @deprecated use `RunAgentFallbackModelsStop$Outbound` instead. */
|
|
2122
|
+
type Outbound = RunAgentFallbackModelsStop$Outbound;
|
|
2123
|
+
}
|
|
2124
|
+
export declare function runAgentFallbackModelsStopToJSON(runAgentFallbackModelsStop: RunAgentFallbackModelsStop): string;
|
|
2125
|
+
export declare function runAgentFallbackModelsStopFromJSON(jsonString: string): SafeParseResult<RunAgentFallbackModelsStop, SDKValidationError>;
|
|
2126
|
+
/** @internal */
|
|
2127
|
+
export declare const RunAgentFallbackModelsStreamOptions$inboundSchema: z.ZodType<RunAgentFallbackModelsStreamOptions, z.ZodTypeDef, unknown>;
|
|
2128
|
+
/** @internal */
|
|
2129
|
+
export type RunAgentFallbackModelsStreamOptions$Outbound = {
|
|
2130
|
+
include_usage?: boolean | undefined;
|
|
2131
|
+
};
|
|
2132
|
+
/** @internal */
|
|
2133
|
+
export declare const RunAgentFallbackModelsStreamOptions$outboundSchema: z.ZodType<RunAgentFallbackModelsStreamOptions$Outbound, z.ZodTypeDef, RunAgentFallbackModelsStreamOptions>;
|
|
2134
|
+
/**
|
|
2135
|
+
* @internal
|
|
2136
|
+
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
|
|
2137
|
+
*/
|
|
2138
|
+
export declare namespace RunAgentFallbackModelsStreamOptions$ {
|
|
2139
|
+
/** @deprecated use `RunAgentFallbackModelsStreamOptions$inboundSchema` instead. */
|
|
2140
|
+
const inboundSchema: z.ZodType<RunAgentFallbackModelsStreamOptions, z.ZodTypeDef, unknown>;
|
|
2141
|
+
/** @deprecated use `RunAgentFallbackModelsStreamOptions$outboundSchema` instead. */
|
|
2142
|
+
const outboundSchema: z.ZodType<RunAgentFallbackModelsStreamOptions$Outbound, z.ZodTypeDef, RunAgentFallbackModelsStreamOptions>;
|
|
2143
|
+
/** @deprecated use `RunAgentFallbackModelsStreamOptions$Outbound` instead. */
|
|
2144
|
+
type Outbound = RunAgentFallbackModelsStreamOptions$Outbound;
|
|
2145
|
+
}
|
|
2146
|
+
export declare function runAgentFallbackModelsStreamOptionsToJSON(runAgentFallbackModelsStreamOptions: RunAgentFallbackModelsStreamOptions): string;
|
|
2147
|
+
export declare function runAgentFallbackModelsStreamOptionsFromJSON(jsonString: string): SafeParseResult<RunAgentFallbackModelsStreamOptions, SDKValidationError>;
|
|
2148
|
+
/** @internal */
|
|
2149
|
+
export declare const RunAgentFallbackModelsType$inboundSchema: z.ZodNativeEnum<typeof RunAgentFallbackModelsType>;
|
|
2150
|
+
/** @internal */
|
|
2151
|
+
export declare const RunAgentFallbackModelsType$outboundSchema: z.ZodNativeEnum<typeof RunAgentFallbackModelsType>;
|
|
2152
|
+
/**
|
|
2153
|
+
* @internal
|
|
2154
|
+
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
|
|
2155
|
+
*/
|
|
2156
|
+
export declare namespace RunAgentFallbackModelsType$ {
|
|
2157
|
+
/** @deprecated use `RunAgentFallbackModelsType$inboundSchema` instead. */
|
|
2158
|
+
const inboundSchema: z.ZodNativeEnum<{
|
|
2159
|
+
readonly Enabled: "enabled";
|
|
2160
|
+
readonly Disabled: "disabled";
|
|
2161
|
+
}>;
|
|
2162
|
+
/** @deprecated use `RunAgentFallbackModelsType$outboundSchema` instead. */
|
|
2163
|
+
const outboundSchema: z.ZodNativeEnum<{
|
|
2164
|
+
readonly Enabled: "enabled";
|
|
2165
|
+
readonly Disabled: "disabled";
|
|
2166
|
+
}>;
|
|
2167
|
+
}
|
|
2168
|
+
/** @internal */
|
|
2169
|
+
export declare const RunAgentFallbackModelsThinking$inboundSchema: z.ZodType<RunAgentFallbackModelsThinking, z.ZodTypeDef, unknown>;
|
|
2170
|
+
/** @internal */
|
|
2171
|
+
export type RunAgentFallbackModelsThinking$Outbound = {
|
|
2172
|
+
type: string;
|
|
2173
|
+
budget_tokens: number;
|
|
2174
|
+
};
|
|
2175
|
+
/** @internal */
|
|
2176
|
+
export declare const RunAgentFallbackModelsThinking$outboundSchema: z.ZodType<RunAgentFallbackModelsThinking$Outbound, z.ZodTypeDef, RunAgentFallbackModelsThinking>;
|
|
2177
|
+
/**
|
|
2178
|
+
* @internal
|
|
2179
|
+
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
|
|
2180
|
+
*/
|
|
2181
|
+
export declare namespace RunAgentFallbackModelsThinking$ {
|
|
2182
|
+
/** @deprecated use `RunAgentFallbackModelsThinking$inboundSchema` instead. */
|
|
2183
|
+
const inboundSchema: z.ZodType<RunAgentFallbackModelsThinking, z.ZodTypeDef, unknown>;
|
|
2184
|
+
/** @deprecated use `RunAgentFallbackModelsThinking$outboundSchema` instead. */
|
|
2185
|
+
const outboundSchema: z.ZodType<RunAgentFallbackModelsThinking$Outbound, z.ZodTypeDef, RunAgentFallbackModelsThinking>;
|
|
2186
|
+
/** @deprecated use `RunAgentFallbackModelsThinking$Outbound` instead. */
|
|
2187
|
+
type Outbound = RunAgentFallbackModelsThinking$Outbound;
|
|
2188
|
+
}
|
|
2189
|
+
export declare function runAgentFallbackModelsThinkingToJSON(runAgentFallbackModelsThinking: RunAgentFallbackModelsThinking): string;
|
|
2190
|
+
export declare function runAgentFallbackModelsThinkingFromJSON(jsonString: string): SafeParseResult<RunAgentFallbackModelsThinking, SDKValidationError>;
|
|
2191
|
+
/** @internal */
|
|
2192
|
+
export declare const RunAgentToolChoiceAgentsType$inboundSchema: z.ZodNativeEnum<typeof RunAgentToolChoiceAgentsType>;
|
|
2193
|
+
/** @internal */
|
|
2194
|
+
export declare const RunAgentToolChoiceAgentsType$outboundSchema: z.ZodNativeEnum<typeof RunAgentToolChoiceAgentsType>;
|
|
2195
|
+
/**
|
|
2196
|
+
* @internal
|
|
2197
|
+
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
|
|
2198
|
+
*/
|
|
2199
|
+
export declare namespace RunAgentToolChoiceAgentsType$ {
|
|
2200
|
+
/** @deprecated use `RunAgentToolChoiceAgentsType$inboundSchema` instead. */
|
|
2201
|
+
const inboundSchema: z.ZodNativeEnum<{
|
|
2202
|
+
readonly Function: "function";
|
|
2203
|
+
}>;
|
|
2204
|
+
/** @deprecated use `RunAgentToolChoiceAgentsType$outboundSchema` instead. */
|
|
2205
|
+
const outboundSchema: z.ZodNativeEnum<{
|
|
2206
|
+
readonly Function: "function";
|
|
2207
|
+
}>;
|
|
2208
|
+
}
|
|
2209
|
+
/** @internal */
|
|
2210
|
+
export declare const RunAgentToolChoiceAgentsFunction$inboundSchema: z.ZodType<RunAgentToolChoiceAgentsFunction, z.ZodTypeDef, unknown>;
|
|
2211
|
+
/** @internal */
|
|
2212
|
+
export type RunAgentToolChoiceAgentsFunction$Outbound = {
|
|
2213
|
+
name?: string | undefined;
|
|
2214
|
+
};
|
|
2215
|
+
/** @internal */
|
|
2216
|
+
export declare const RunAgentToolChoiceAgentsFunction$outboundSchema: z.ZodType<RunAgentToolChoiceAgentsFunction$Outbound, z.ZodTypeDef, RunAgentToolChoiceAgentsFunction>;
|
|
2217
|
+
/**
|
|
2218
|
+
* @internal
|
|
2219
|
+
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
|
|
2220
|
+
*/
|
|
2221
|
+
export declare namespace RunAgentToolChoiceAgentsFunction$ {
|
|
2222
|
+
/** @deprecated use `RunAgentToolChoiceAgentsFunction$inboundSchema` instead. */
|
|
2223
|
+
const inboundSchema: z.ZodType<RunAgentToolChoiceAgentsFunction, z.ZodTypeDef, unknown>;
|
|
2224
|
+
/** @deprecated use `RunAgentToolChoiceAgentsFunction$outboundSchema` instead. */
|
|
2225
|
+
const outboundSchema: z.ZodType<RunAgentToolChoiceAgentsFunction$Outbound, z.ZodTypeDef, RunAgentToolChoiceAgentsFunction>;
|
|
2226
|
+
/** @deprecated use `RunAgentToolChoiceAgentsFunction$Outbound` instead. */
|
|
2227
|
+
type Outbound = RunAgentToolChoiceAgentsFunction$Outbound;
|
|
2228
|
+
}
|
|
2229
|
+
export declare function runAgentToolChoiceAgentsFunctionToJSON(runAgentToolChoiceAgentsFunction: RunAgentToolChoiceAgentsFunction): string;
|
|
2230
|
+
export declare function runAgentToolChoiceAgentsFunctionFromJSON(jsonString: string): SafeParseResult<RunAgentToolChoiceAgentsFunction, SDKValidationError>;
|
|
2231
|
+
/** @internal */
|
|
2232
|
+
export declare const RunAgentToolChoiceAgents2$inboundSchema: z.ZodType<RunAgentToolChoiceAgents2, z.ZodTypeDef, unknown>;
|
|
2233
|
+
/** @internal */
|
|
2234
|
+
export type RunAgentToolChoiceAgents2$Outbound = {
|
|
2235
|
+
type?: string | undefined;
|
|
2236
|
+
function: RunAgentToolChoiceAgentsFunction$Outbound;
|
|
2237
|
+
};
|
|
2238
|
+
/** @internal */
|
|
2239
|
+
export declare const RunAgentToolChoiceAgents2$outboundSchema: z.ZodType<RunAgentToolChoiceAgents2$Outbound, z.ZodTypeDef, RunAgentToolChoiceAgents2>;
|
|
2240
|
+
/**
|
|
2241
|
+
* @internal
|
|
2242
|
+
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
|
|
2243
|
+
*/
|
|
2244
|
+
export declare namespace RunAgentToolChoiceAgents2$ {
|
|
2245
|
+
/** @deprecated use `RunAgentToolChoiceAgents2$inboundSchema` instead. */
|
|
2246
|
+
const inboundSchema: z.ZodType<RunAgentToolChoiceAgents2, z.ZodTypeDef, unknown>;
|
|
2247
|
+
/** @deprecated use `RunAgentToolChoiceAgents2$outboundSchema` instead. */
|
|
2248
|
+
const outboundSchema: z.ZodType<RunAgentToolChoiceAgents2$Outbound, z.ZodTypeDef, RunAgentToolChoiceAgents2>;
|
|
2249
|
+
/** @deprecated use `RunAgentToolChoiceAgents2$Outbound` instead. */
|
|
2250
|
+
type Outbound = RunAgentToolChoiceAgents2$Outbound;
|
|
2251
|
+
}
|
|
2252
|
+
export declare function runAgentToolChoiceAgents2ToJSON(runAgentToolChoiceAgents2: RunAgentToolChoiceAgents2): string;
|
|
2253
|
+
export declare function runAgentToolChoiceAgents2FromJSON(jsonString: string): SafeParseResult<RunAgentToolChoiceAgents2, SDKValidationError>;
|
|
2254
|
+
/** @internal */
|
|
2255
|
+
export declare const RunAgentToolChoiceAgents1$inboundSchema: z.ZodNativeEnum<typeof RunAgentToolChoiceAgents1>;
|
|
2256
|
+
/** @internal */
|
|
2257
|
+
export declare const RunAgentToolChoiceAgents1$outboundSchema: z.ZodNativeEnum<typeof RunAgentToolChoiceAgents1>;
|
|
2258
|
+
/**
|
|
2259
|
+
* @internal
|
|
2260
|
+
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
|
|
2261
|
+
*/
|
|
2262
|
+
export declare namespace RunAgentToolChoiceAgents1$ {
|
|
2263
|
+
/** @deprecated use `RunAgentToolChoiceAgents1$inboundSchema` instead. */
|
|
2264
|
+
const inboundSchema: z.ZodNativeEnum<{
|
|
2265
|
+
readonly None: "none";
|
|
2266
|
+
readonly Auto: "auto";
|
|
2267
|
+
readonly Required: "required";
|
|
2268
|
+
}>;
|
|
2269
|
+
/** @deprecated use `RunAgentToolChoiceAgents1$outboundSchema` instead. */
|
|
2270
|
+
const outboundSchema: z.ZodNativeEnum<{
|
|
2271
|
+
readonly None: "none";
|
|
2272
|
+
readonly Auto: "auto";
|
|
2273
|
+
readonly Required: "required";
|
|
2274
|
+
}>;
|
|
2275
|
+
}
|
|
2276
|
+
/** @internal */
|
|
2277
|
+
export declare const RunAgentFallbackModelsToolChoice$inboundSchema: z.ZodType<RunAgentFallbackModelsToolChoice, z.ZodTypeDef, unknown>;
|
|
2278
|
+
/** @internal */
|
|
2279
|
+
export type RunAgentFallbackModelsToolChoice$Outbound = RunAgentToolChoiceAgents2$Outbound | string;
|
|
2280
|
+
/** @internal */
|
|
2281
|
+
export declare const RunAgentFallbackModelsToolChoice$outboundSchema: z.ZodType<RunAgentFallbackModelsToolChoice$Outbound, z.ZodTypeDef, RunAgentFallbackModelsToolChoice>;
|
|
2282
|
+
/**
|
|
2283
|
+
* @internal
|
|
2284
|
+
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
|
|
2285
|
+
*/
|
|
2286
|
+
export declare namespace RunAgentFallbackModelsToolChoice$ {
|
|
2287
|
+
/** @deprecated use `RunAgentFallbackModelsToolChoice$inboundSchema` instead. */
|
|
2288
|
+
const inboundSchema: z.ZodType<RunAgentFallbackModelsToolChoice, z.ZodTypeDef, unknown>;
|
|
2289
|
+
/** @deprecated use `RunAgentFallbackModelsToolChoice$outboundSchema` instead. */
|
|
2290
|
+
const outboundSchema: z.ZodType<RunAgentFallbackModelsToolChoice$Outbound, z.ZodTypeDef, RunAgentFallbackModelsToolChoice>;
|
|
2291
|
+
/** @deprecated use `RunAgentFallbackModelsToolChoice$Outbound` instead. */
|
|
2292
|
+
type Outbound = RunAgentFallbackModelsToolChoice$Outbound;
|
|
2293
|
+
}
|
|
2294
|
+
export declare function runAgentFallbackModelsToolChoiceToJSON(runAgentFallbackModelsToolChoice: RunAgentFallbackModelsToolChoice): string;
|
|
2295
|
+
export declare function runAgentFallbackModelsToolChoiceFromJSON(jsonString: string): SafeParseResult<RunAgentFallbackModelsToolChoice, SDKValidationError>;
|
|
2296
|
+
/** @internal */
|
|
2297
|
+
export declare const RunAgentFallbackModelsModalities$inboundSchema: z.ZodNativeEnum<typeof RunAgentFallbackModelsModalities>;
|
|
2298
|
+
/** @internal */
|
|
2299
|
+
export declare const RunAgentFallbackModelsModalities$outboundSchema: z.ZodNativeEnum<typeof RunAgentFallbackModelsModalities>;
|
|
2300
|
+
/**
|
|
2301
|
+
* @internal
|
|
2302
|
+
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
|
|
2303
|
+
*/
|
|
2304
|
+
export declare namespace RunAgentFallbackModelsModalities$ {
|
|
2305
|
+
/** @deprecated use `RunAgentFallbackModelsModalities$inboundSchema` instead. */
|
|
2306
|
+
const inboundSchema: z.ZodNativeEnum<{
|
|
2307
|
+
readonly Text: "text";
|
|
2308
|
+
readonly Audio: "audio";
|
|
2309
|
+
}>;
|
|
2310
|
+
/** @deprecated use `RunAgentFallbackModelsModalities$outboundSchema` instead. */
|
|
2311
|
+
const outboundSchema: z.ZodNativeEnum<{
|
|
2312
|
+
readonly Text: "text";
|
|
2313
|
+
readonly Audio: "audio";
|
|
2314
|
+
}>;
|
|
2315
|
+
}
|
|
2316
|
+
/** @internal */
|
|
2317
|
+
export declare const RunAgentFallbackModelsWebSearchOptions$inboundSchema: z.ZodType<RunAgentFallbackModelsWebSearchOptions, z.ZodTypeDef, unknown>;
|
|
2318
|
+
/** @internal */
|
|
2319
|
+
export type RunAgentFallbackModelsWebSearchOptions$Outbound = {
|
|
2320
|
+
enabled?: boolean | undefined;
|
|
2321
|
+
};
|
|
2322
|
+
/** @internal */
|
|
2323
|
+
export declare const RunAgentFallbackModelsWebSearchOptions$outboundSchema: z.ZodType<RunAgentFallbackModelsWebSearchOptions$Outbound, z.ZodTypeDef, RunAgentFallbackModelsWebSearchOptions>;
|
|
2324
|
+
/**
|
|
2325
|
+
* @internal
|
|
2326
|
+
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
|
|
2327
|
+
*/
|
|
2328
|
+
export declare namespace RunAgentFallbackModelsWebSearchOptions$ {
|
|
2329
|
+
/** @deprecated use `RunAgentFallbackModelsWebSearchOptions$inboundSchema` instead. */
|
|
2330
|
+
const inboundSchema: z.ZodType<RunAgentFallbackModelsWebSearchOptions, z.ZodTypeDef, unknown>;
|
|
2331
|
+
/** @deprecated use `RunAgentFallbackModelsWebSearchOptions$outboundSchema` instead. */
|
|
2332
|
+
const outboundSchema: z.ZodType<RunAgentFallbackModelsWebSearchOptions$Outbound, z.ZodTypeDef, RunAgentFallbackModelsWebSearchOptions>;
|
|
2333
|
+
/** @deprecated use `RunAgentFallbackModelsWebSearchOptions$Outbound` instead. */
|
|
2334
|
+
type Outbound = RunAgentFallbackModelsWebSearchOptions$Outbound;
|
|
2335
|
+
}
|
|
2336
|
+
export declare function runAgentFallbackModelsWebSearchOptionsToJSON(runAgentFallbackModelsWebSearchOptions: RunAgentFallbackModelsWebSearchOptions): string;
|
|
2337
|
+
export declare function runAgentFallbackModelsWebSearchOptionsFromJSON(jsonString: string): SafeParseResult<RunAgentFallbackModelsWebSearchOptions, SDKValidationError>;
|
|
2338
|
+
/** @internal */
|
|
2339
|
+
export declare const RunAgentFallbackModelsParameters$inboundSchema: z.ZodType<RunAgentFallbackModelsParameters, z.ZodTypeDef, unknown>;
|
|
2340
|
+
/** @internal */
|
|
2341
|
+
export type RunAgentFallbackModelsParameters$Outbound = {
|
|
2342
|
+
audio?: RunAgentFallbackModelsAudio$Outbound | null | undefined;
|
|
2343
|
+
frequency_penalty?: number | null | undefined;
|
|
2344
|
+
max_tokens?: number | null | undefined;
|
|
2345
|
+
max_completion_tokens?: number | null | undefined;
|
|
2346
|
+
logprobs?: boolean | null | undefined;
|
|
2347
|
+
top_logprobs?: number | null | undefined;
|
|
2348
|
+
n?: number | null | undefined;
|
|
2349
|
+
presence_penalty?: number | null | undefined;
|
|
2350
|
+
response_format?: RunAgentResponseFormatAgents3$Outbound | RunAgentResponseFormatAgents1$Outbound | RunAgentResponseFormatAgents2$Outbound | undefined;
|
|
2351
|
+
reasoning_effort?: string | undefined;
|
|
2352
|
+
verbosity?: string | undefined;
|
|
2353
|
+
seed?: number | null | undefined;
|
|
2354
|
+
stop?: string | Array<string> | null | undefined;
|
|
2355
|
+
stream_options?: RunAgentFallbackModelsStreamOptions$Outbound | null | undefined;
|
|
2356
|
+
thinking?: RunAgentFallbackModelsThinking$Outbound | undefined;
|
|
2357
|
+
temperature?: number | null | undefined;
|
|
2358
|
+
top_p?: number | null | undefined;
|
|
2359
|
+
top_k?: number | null | undefined;
|
|
2360
|
+
tool_choice?: RunAgentToolChoiceAgents2$Outbound | string | undefined;
|
|
2361
|
+
parallel_tool_calls?: boolean | undefined;
|
|
2362
|
+
modalities?: Array<string> | null | undefined;
|
|
2363
|
+
web_search_options?: RunAgentFallbackModelsWebSearchOptions$Outbound | undefined;
|
|
2364
|
+
};
|
|
2365
|
+
/** @internal */
|
|
2366
|
+
export declare const RunAgentFallbackModelsParameters$outboundSchema: z.ZodType<RunAgentFallbackModelsParameters$Outbound, z.ZodTypeDef, RunAgentFallbackModelsParameters>;
|
|
2367
|
+
/**
|
|
2368
|
+
* @internal
|
|
2369
|
+
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
|
|
2370
|
+
*/
|
|
2371
|
+
export declare namespace RunAgentFallbackModelsParameters$ {
|
|
2372
|
+
/** @deprecated use `RunAgentFallbackModelsParameters$inboundSchema` instead. */
|
|
2373
|
+
const inboundSchema: z.ZodType<RunAgentFallbackModelsParameters, z.ZodTypeDef, unknown>;
|
|
2374
|
+
/** @deprecated use `RunAgentFallbackModelsParameters$outboundSchema` instead. */
|
|
2375
|
+
const outboundSchema: z.ZodType<RunAgentFallbackModelsParameters$Outbound, z.ZodTypeDef, RunAgentFallbackModelsParameters>;
|
|
2376
|
+
/** @deprecated use `RunAgentFallbackModelsParameters$Outbound` instead. */
|
|
2377
|
+
type Outbound = RunAgentFallbackModelsParameters$Outbound;
|
|
2378
|
+
}
|
|
2379
|
+
export declare function runAgentFallbackModelsParametersToJSON(runAgentFallbackModelsParameters: RunAgentFallbackModelsParameters): string;
|
|
2380
|
+
export declare function runAgentFallbackModelsParametersFromJSON(jsonString: string): SafeParseResult<RunAgentFallbackModelsParameters, SDKValidationError>;
|
|
2381
|
+
/** @internal */
|
|
2382
|
+
export declare const RunAgentFallbackModels2$inboundSchema: z.ZodType<RunAgentFallbackModels2, z.ZodTypeDef, unknown>;
|
|
2383
|
+
/** @internal */
|
|
2384
|
+
export type RunAgentFallbackModels2$Outbound = {
|
|
2385
|
+
id: string;
|
|
2386
|
+
integration_id?: string | null | undefined;
|
|
2387
|
+
parameters?: RunAgentFallbackModelsParameters$Outbound | undefined;
|
|
2388
|
+
};
|
|
2389
|
+
/** @internal */
|
|
2390
|
+
export declare const RunAgentFallbackModels2$outboundSchema: z.ZodType<RunAgentFallbackModels2$Outbound, z.ZodTypeDef, RunAgentFallbackModels2>;
|
|
2391
|
+
/**
|
|
2392
|
+
* @internal
|
|
2393
|
+
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
|
|
2394
|
+
*/
|
|
2395
|
+
export declare namespace RunAgentFallbackModels2$ {
|
|
2396
|
+
/** @deprecated use `RunAgentFallbackModels2$inboundSchema` instead. */
|
|
2397
|
+
const inboundSchema: z.ZodType<RunAgentFallbackModels2, z.ZodTypeDef, unknown>;
|
|
2398
|
+
/** @deprecated use `RunAgentFallbackModels2$outboundSchema` instead. */
|
|
2399
|
+
const outboundSchema: z.ZodType<RunAgentFallbackModels2$Outbound, z.ZodTypeDef, RunAgentFallbackModels2>;
|
|
2400
|
+
/** @deprecated use `RunAgentFallbackModels2$Outbound` instead. */
|
|
2401
|
+
type Outbound = RunAgentFallbackModels2$Outbound;
|
|
2402
|
+
}
|
|
2403
|
+
export declare function runAgentFallbackModels2ToJSON(runAgentFallbackModels2: RunAgentFallbackModels2): string;
|
|
2404
|
+
export declare function runAgentFallbackModels2FromJSON(jsonString: string): SafeParseResult<RunAgentFallbackModels2, SDKValidationError>;
|
|
2405
|
+
/** @internal */
|
|
2406
|
+
export declare const RunAgentFallbackModels$inboundSchema: z.ZodType<RunAgentFallbackModels, z.ZodTypeDef, unknown>;
|
|
2407
|
+
/** @internal */
|
|
2408
|
+
export type RunAgentFallbackModels$Outbound = RunAgentFallbackModels2$Outbound | string;
|
|
2409
|
+
/** @internal */
|
|
2410
|
+
export declare const RunAgentFallbackModels$outboundSchema: z.ZodType<RunAgentFallbackModels$Outbound, z.ZodTypeDef, RunAgentFallbackModels>;
|
|
2411
|
+
/**
|
|
2412
|
+
* @internal
|
|
2413
|
+
* @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
|
|
2414
|
+
*/
|
|
2415
|
+
export declare namespace RunAgentFallbackModels$ {
|
|
2416
|
+
/** @deprecated use `RunAgentFallbackModels$inboundSchema` instead. */
|
|
2417
|
+
const inboundSchema: z.ZodType<RunAgentFallbackModels, z.ZodTypeDef, unknown>;
|
|
2418
|
+
/** @deprecated use `RunAgentFallbackModels$outboundSchema` instead. */
|
|
2419
|
+
const outboundSchema: z.ZodType<RunAgentFallbackModels$Outbound, z.ZodTypeDef, RunAgentFallbackModels>;
|
|
2420
|
+
/** @deprecated use `RunAgentFallbackModels$Outbound` instead. */
|
|
2421
|
+
type Outbound = RunAgentFallbackModels$Outbound;
|
|
2422
|
+
}
|
|
2423
|
+
export declare function runAgentFallbackModelsToJSON(runAgentFallbackModels: RunAgentFallbackModels): string;
|
|
2424
|
+
export declare function runAgentFallbackModelsFromJSON(jsonString: string): SafeParseResult<RunAgentFallbackModels, SDKValidationError>;
|
|
752
2425
|
/** @internal */
|
|
753
2426
|
export declare const RunAgentRoleToolMessage$inboundSchema: z.ZodNativeEnum<typeof RunAgentRoleToolMessage>;
|
|
754
2427
|
/** @internal */
|
|
@@ -2044,8 +3717,8 @@ export declare const RunAgentRequestBody$inboundSchema: z.ZodType<RunAgentReques
|
|
|
2044
3717
|
export type RunAgentRequestBody$Outbound = {
|
|
2045
3718
|
key: string;
|
|
2046
3719
|
task_id?: string | undefined;
|
|
2047
|
-
model: string;
|
|
2048
|
-
fallback_models?: Array<string> | undefined;
|
|
3720
|
+
model: RunAgentModel2$Outbound | string;
|
|
3721
|
+
fallback_models?: Array<RunAgentFallbackModels2$Outbound | string> | undefined;
|
|
2049
3722
|
role: string;
|
|
2050
3723
|
instructions: string;
|
|
2051
3724
|
message: RunAgentMessage$Outbound;
|