@orq-ai/node 4.0.4 → 4.0.6

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.
Files changed (170) hide show
  1. package/bin/mcp-server.js +213 -213
  2. package/bin/mcp-server.js.map +36 -36
  3. package/examples/package-lock.json +1 -1
  4. package/jsr.json +1 -1
  5. package/lib/config.d.ts +2 -2
  6. package/lib/config.js +2 -2
  7. package/mcp-server/mcp-server.js +1 -1
  8. package/mcp-server/server.js +1 -1
  9. package/models/operations/createbudget.js +2 -2
  10. package/models/operations/createcontact.js +2 -2
  11. package/models/operations/createdataset.js +2 -2
  12. package/models/operations/createdatasetitem.js +8 -8
  13. package/models/operations/createdatasource.js +2 -2
  14. package/models/operations/createeval.js +28 -28
  15. package/models/operations/createtool.js +12 -12
  16. package/models/operations/fileget.js +2 -2
  17. package/models/operations/filelist.js +2 -2
  18. package/models/operations/fileupload.js +2 -2
  19. package/models/operations/getalltools.js +12 -12
  20. package/models/operations/getbudget.js +2 -2
  21. package/models/operations/getevals.js +28 -28
  22. package/models/operations/listbudgets.js +2 -2
  23. package/models/operations/listcontacts.js +2 -2
  24. package/models/operations/listdatasetdatapoints.js +8 -8
  25. package/models/operations/listdatasets.js +2 -2
  26. package/models/operations/listdatasources.js +2 -2
  27. package/models/operations/retrievecontact.js +2 -2
  28. package/models/operations/retrievedatapoint.js +8 -8
  29. package/models/operations/retrievedataset.js +2 -2
  30. package/models/operations/retrievedatasource.js +2 -2
  31. package/models/operations/retrievetool.js +12 -12
  32. package/models/operations/runagent.js +2 -2
  33. package/models/operations/streamrunagent.js +2 -2
  34. package/models/operations/updatebudget.js +2 -2
  35. package/models/operations/updatecontact.js +2 -2
  36. package/models/operations/updatedatapoint.js +8 -8
  37. package/models/operations/updatedataset.js +2 -2
  38. package/models/operations/updatedatasource.js +2 -2
  39. package/models/operations/updateeval.js +28 -28
  40. package/models/operations/updatetool.js +14 -14
  41. package/package.json +1 -1
  42. package/packages/orq-rc/README.md +38 -47
  43. package/packages/orq-rc/docs/sdks/agents/README.md +230 -529
  44. package/packages/orq-rc/docs/sdks/responses/README.md +60 -65
  45. package/packages/orq-rc/examples/package-lock.json +1 -1
  46. package/packages/orq-rc/jsr.json +1 -1
  47. package/packages/orq-rc/package-lock.json +2 -2
  48. package/packages/orq-rc/package.json +1 -1
  49. package/packages/orq-rc/src/funcs/agentsCreate.ts +16 -14
  50. package/packages/orq-rc/src/funcs/agentsDelete.ts +10 -6
  51. package/packages/orq-rc/src/funcs/agentsInvoke.ts +16 -6
  52. package/packages/orq-rc/src/funcs/agentsList.ts +18 -6
  53. package/packages/orq-rc/src/funcs/agentsResponsesCreate.ts +23 -12
  54. package/packages/orq-rc/src/funcs/agentsRetrieve.ts +21 -16
  55. package/packages/orq-rc/src/funcs/agentsRun.ts +4 -2
  56. package/packages/orq-rc/src/funcs/agentsStream.ts +16 -6
  57. package/packages/orq-rc/src/funcs/agentsStreamRun.ts +4 -2
  58. package/packages/orq-rc/src/funcs/agentsUpdate.ts +14 -6
  59. package/packages/orq-rc/src/lib/config.ts +2 -2
  60. package/packages/orq-rc/src/mcp-server/mcp-server.ts +1 -1
  61. package/packages/orq-rc/src/mcp-server/server.ts +1 -9
  62. package/packages/orq-rc/src/mcp-server/tools/agentsCreate.ts +3 -3
  63. package/packages/orq-rc/src/mcp-server/tools/agentsDelete.ts +5 -5
  64. package/packages/orq-rc/src/mcp-server/tools/agentsInvoke.ts +7 -4
  65. package/packages/orq-rc/src/mcp-server/tools/agentsList.ts +9 -5
  66. package/packages/orq-rc/src/mcp-server/tools/agentsResponsesCreate.ts +8 -4
  67. package/packages/orq-rc/src/mcp-server/tools/agentsRetrieve.ts +5 -5
  68. package/packages/orq-rc/src/mcp-server/tools/agentsRun.ts +2 -2
  69. package/packages/orq-rc/src/mcp-server/tools/agentsStream.ts +7 -4
  70. package/packages/orq-rc/src/mcp-server/tools/agentsStreamRun.ts +2 -2
  71. package/packages/orq-rc/src/mcp-server/tools/agentsUpdate.ts +8 -4
  72. package/packages/orq-rc/src/models/errors/createagentrequest.ts +67 -0
  73. package/packages/orq-rc/src/models/errors/deleteagent.ts +2 -2
  74. package/packages/orq-rc/src/models/errors/index.ts +2 -3
  75. package/packages/orq-rc/src/models/errors/{listagenttasks.ts → retrieveagentrequest.ts} +15 -15
  76. package/packages/orq-rc/src/models/errors/updateagent.ts +2 -2
  77. package/packages/orq-rc/src/models/operations/{createagent.ts → createagentrequest.ts} +1643 -1485
  78. package/packages/orq-rc/src/models/operations/{createagentresponse.ts → createagentresponserequest.ts} +141 -127
  79. package/packages/orq-rc/src/models/operations/createbudget.ts +2 -2
  80. package/packages/orq-rc/src/models/operations/createcontact.ts +2 -2
  81. package/packages/orq-rc/src/models/operations/createdataset.ts +2 -2
  82. package/packages/orq-rc/src/models/operations/createdatasetitem.ts +8 -8
  83. package/packages/orq-rc/src/models/operations/createdatasource.ts +2 -2
  84. package/packages/orq-rc/src/models/operations/createeval.ts +28 -28
  85. package/packages/orq-rc/src/models/operations/createprompt.ts +4 -4
  86. package/packages/orq-rc/src/models/operations/createtool.ts +12 -12
  87. package/packages/orq-rc/src/models/operations/fileget.ts +2 -2
  88. package/packages/orq-rc/src/models/operations/filelist.ts +2 -2
  89. package/packages/orq-rc/src/models/operations/fileupload.ts +2 -2
  90. package/packages/orq-rc/src/models/operations/getalltools.ts +12 -12
  91. package/packages/orq-rc/src/models/operations/getbudget.ts +2 -2
  92. package/packages/orq-rc/src/models/operations/getevals.ts +28 -28
  93. package/packages/orq-rc/src/models/operations/index.ts +3 -7
  94. package/packages/orq-rc/src/models/operations/invokeagent.ts +153 -190
  95. package/packages/orq-rc/src/models/operations/listagents.ts +9 -21
  96. package/packages/orq-rc/src/models/operations/listbudgets.ts +2 -2
  97. package/packages/orq-rc/src/models/operations/listcontacts.ts +2 -2
  98. package/packages/orq-rc/src/models/operations/listdatasetdatapoints.ts +8 -8
  99. package/packages/orq-rc/src/models/operations/listdatasets.ts +2 -2
  100. package/packages/orq-rc/src/models/operations/listdatasources.ts +2 -2
  101. package/packages/orq-rc/src/models/operations/retrieveagentrequest.ts +3741 -0
  102. package/packages/orq-rc/src/models/operations/retrievecontact.ts +2 -2
  103. package/packages/orq-rc/src/models/operations/retrievedatapoint.ts +8 -8
  104. package/packages/orq-rc/src/models/operations/retrievedataset.ts +2 -2
  105. package/packages/orq-rc/src/models/operations/retrievedatasource.ts +2 -2
  106. package/packages/orq-rc/src/models/operations/retrievetool.ts +12 -12
  107. package/packages/orq-rc/src/models/operations/runagent.ts +53 -57
  108. package/packages/orq-rc/src/models/operations/streamagent.ts +1 -1
  109. package/packages/orq-rc/src/models/operations/streamrunagent.ts +68 -82
  110. package/packages/orq-rc/src/models/operations/updateagent.ts +17 -17
  111. package/packages/orq-rc/src/models/operations/updatebudget.ts +2 -2
  112. package/packages/orq-rc/src/models/operations/updatecontact.ts +2 -2
  113. package/packages/orq-rc/src/models/operations/updatedatapoint.ts +8 -8
  114. package/packages/orq-rc/src/models/operations/updatedataset.ts +2 -2
  115. package/packages/orq-rc/src/models/operations/updatedatasource.ts +2 -2
  116. package/packages/orq-rc/src/models/operations/updateeval.ts +28 -28
  117. package/packages/orq-rc/src/models/operations/updateprompt.ts +4 -4
  118. package/packages/orq-rc/src/models/operations/updatetool.ts +14 -14
  119. package/packages/orq-rc/src/sdk/agents.ts +51 -99
  120. package/packages/orq-rc/src/sdk/responses.ts +7 -5
  121. package/src/lib/config.ts +2 -2
  122. package/src/mcp-server/mcp-server.ts +1 -1
  123. package/src/mcp-server/server.ts +1 -1
  124. package/src/models/operations/createbudget.ts +2 -2
  125. package/src/models/operations/createcontact.ts +2 -2
  126. package/src/models/operations/createdataset.ts +2 -2
  127. package/src/models/operations/createdatasetitem.ts +8 -8
  128. package/src/models/operations/createdatasource.ts +2 -2
  129. package/src/models/operations/createeval.ts +28 -28
  130. package/src/models/operations/createtool.ts +12 -12
  131. package/src/models/operations/fileget.ts +2 -2
  132. package/src/models/operations/filelist.ts +2 -2
  133. package/src/models/operations/fileupload.ts +2 -2
  134. package/src/models/operations/getalltools.ts +12 -12
  135. package/src/models/operations/getbudget.ts +2 -2
  136. package/src/models/operations/getevals.ts +28 -28
  137. package/src/models/operations/listbudgets.ts +2 -2
  138. package/src/models/operations/listcontacts.ts +2 -2
  139. package/src/models/operations/listdatasetdatapoints.ts +8 -8
  140. package/src/models/operations/listdatasets.ts +2 -2
  141. package/src/models/operations/listdatasources.ts +2 -2
  142. package/src/models/operations/retrievecontact.ts +2 -2
  143. package/src/models/operations/retrievedatapoint.ts +8 -8
  144. package/src/models/operations/retrievedataset.ts +2 -2
  145. package/src/models/operations/retrievedatasource.ts +2 -2
  146. package/src/models/operations/retrievetool.ts +12 -12
  147. package/src/models/operations/runagent.ts +2 -2
  148. package/src/models/operations/streamrunagent.ts +2 -2
  149. package/src/models/operations/updatebudget.ts +2 -2
  150. package/src/models/operations/updatecontact.ts +2 -2
  151. package/src/models/operations/updatedatapoint.ts +8 -8
  152. package/src/models/operations/updatedataset.ts +2 -2
  153. package/src/models/operations/updatedatasource.ts +2 -2
  154. package/src/models/operations/updateeval.ts +28 -28
  155. package/src/models/operations/updatetool.ts +14 -14
  156. package/packages/orq-rc/src/funcs/agentsListActions.ts +0 -169
  157. package/packages/orq-rc/src/funcs/agentsListTasks.ts +0 -183
  158. package/packages/orq-rc/src/funcs/agentsRetrieveAction.ts +0 -173
  159. package/packages/orq-rc/src/funcs/agentsRetrieveTask.ts +0 -179
  160. package/packages/orq-rc/src/mcp-server/tools/agentsListActions.ts +0 -35
  161. package/packages/orq-rc/src/mcp-server/tools/agentsListTasks.ts +0 -37
  162. package/packages/orq-rc/src/mcp-server/tools/agentsRetrieveAction.ts +0 -35
  163. package/packages/orq-rc/src/mcp-server/tools/agentsRetrieveTask.ts +0 -37
  164. package/packages/orq-rc/src/models/errors/createagent.ts +0 -67
  165. package/packages/orq-rc/src/models/errors/getagent.ts +0 -67
  166. package/packages/orq-rc/src/models/operations/getagent.ts +0 -3480
  167. package/packages/orq-rc/src/models/operations/getagenttask.ts +0 -2389
  168. package/packages/orq-rc/src/models/operations/listactions.ts +0 -427
  169. package/packages/orq-rc/src/models/operations/listagenttasks.ts +0 -2614
  170. package/packages/orq-rc/src/models/operations/retrieveaction.ts +0 -354
@@ -1,3480 +0,0 @@
1
- /*
2
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
- */
4
-
5
- import * as z from "zod/v3";
6
- import { remap as remap$ } from "../../lib/primitives.js";
7
- import { safeParse } from "../../lib/schemas.js";
8
- import { ClosedEnum } from "../../types/enums.js";
9
- import { Result as SafeParseResult } from "../../types/fp.js";
10
- import { SDKValidationError } from "../errors/sdkvalidationerror.js";
11
-
12
- export type GetAgentRequest = {
13
- /**
14
- * The unique key of the agent to retrieve
15
- */
16
- agentKey: string;
17
- };
18
-
19
- /**
20
- * The status of the agent. `Live` is the latest version of the agent. `Draft` is a version that is not yet published. `Pending` is a version that is pending approval. `Published` is a version that was live and has been replaced by a new version.
21
- */
22
- export const GetAgentStatus = {
23
- Live: "live",
24
- Draft: "draft",
25
- Pending: "pending",
26
- Published: "published",
27
- } as const;
28
- /**
29
- * The status of the agent. `Live` is the latest version of the agent. `Draft` is a version that is not yet published. `Pending` is a version that is pending approval. `Published` is a version that was live and has been replaced by a new version.
30
- */
31
- export type GetAgentStatus = ClosedEnum<typeof GetAgentStatus>;
32
-
33
- /**
34
- * 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.
35
- */
36
- export const GetAgentToolApprovalRequired = {
37
- All: "all",
38
- RespectTool: "respect_tool",
39
- None: "none",
40
- } as const;
41
- /**
42
- * 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.
43
- */
44
- export type GetAgentToolApprovalRequired = ClosedEnum<
45
- typeof GetAgentToolApprovalRequired
46
- >;
47
-
48
- export type GetAgentConditions = {
49
- /**
50
- * The argument of the tool call to evaluate
51
- */
52
- condition: string;
53
- /**
54
- * The operator to use
55
- */
56
- operator: string;
57
- /**
58
- * The value to compare against
59
- */
60
- value: string;
61
- };
62
-
63
- export type GetAgentTools = {
64
- /**
65
- * The id of the resource
66
- */
67
- id: string;
68
- /**
69
- * Optional tool key for custom tools
70
- */
71
- key?: string | undefined;
72
- actionType: string;
73
- displayName?: string | undefined;
74
- /**
75
- * Optional tool description
76
- */
77
- description?: string | undefined;
78
- requiresApproval?: boolean | undefined;
79
- /**
80
- * Nested tool ID for MCP tools (identifies specific tool within MCP server)
81
- */
82
- toolId?: string | undefined;
83
- conditions?: Array<GetAgentConditions> | undefined;
84
- /**
85
- * Tool execution timeout in seconds (default: 2 minutes, max: 10 minutes)
86
- */
87
- timeout?: number | undefined;
88
- };
89
-
90
- /**
91
- * Determines whether the evaluator runs on the agent input (user message) or output (agent response).
92
- */
93
- export const GetAgentExecuteOn = {
94
- Input: "input",
95
- Output: "output",
96
- } as const;
97
- /**
98
- * Determines whether the evaluator runs on the agent input (user message) or output (agent response).
99
- */
100
- export type GetAgentExecuteOn = ClosedEnum<typeof GetAgentExecuteOn>;
101
-
102
- export type GetAgentEvaluators = {
103
- /**
104
- * Unique key or identifier of the evaluator
105
- */
106
- id: string;
107
- /**
108
- * The percentage of executions to evaluate with this evaluator (1-100). For example, a value of 50 means the evaluator will run on approximately half of the executions.
109
- */
110
- sampleRate?: number | undefined;
111
- /**
112
- * Determines whether the evaluator runs on the agent input (user message) or output (agent response).
113
- */
114
- executeOn: GetAgentExecuteOn;
115
- };
116
-
117
- /**
118
- * Determines whether the evaluator runs on the agent input (user message) or output (agent response).
119
- */
120
- export const GetAgentAgentsExecuteOn = {
121
- Input: "input",
122
- Output: "output",
123
- } as const;
124
- /**
125
- * Determines whether the evaluator runs on the agent input (user message) or output (agent response).
126
- */
127
- export type GetAgentAgentsExecuteOn = ClosedEnum<
128
- typeof GetAgentAgentsExecuteOn
129
- >;
130
-
131
- export type GetAgentGuardrails = {
132
- /**
133
- * Unique key or identifier of the evaluator
134
- */
135
- id: string;
136
- /**
137
- * The percentage of executions to evaluate with this evaluator (1-100). For example, a value of 50 means the evaluator will run on approximately half of the executions.
138
- */
139
- sampleRate?: number | undefined;
140
- /**
141
- * Determines whether the evaluator runs on the agent input (user message) or output (agent response).
142
- */
143
- executeOn: GetAgentAgentsExecuteOn;
144
- };
145
-
146
- export type GetAgentSettings = {
147
- /**
148
- * Maximum iterations(llm calls) before the agent will stop executing.
149
- */
150
- maxIterations?: number | undefined;
151
- /**
152
- * 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.
153
- */
154
- maxExecutionTime?: number | undefined;
155
- /**
156
- * 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.
157
- */
158
- toolApprovalRequired?: GetAgentToolApprovalRequired | undefined;
159
- tools?: Array<GetAgentTools> | undefined;
160
- /**
161
- * Configuration for an evaluator applied to the agent
162
- */
163
- evaluators?: Array<GetAgentEvaluators> | undefined;
164
- /**
165
- * Configuration for a guardrail applied to the agent
166
- */
167
- guardrails?: Array<GetAgentGuardrails> | undefined;
168
- };
169
-
170
- /**
171
- * The voice the model uses to respond. Supported voices are alloy, echo, fable, onyx, nova, and shimmer.
172
- */
173
- export const GetAgentVoice = {
174
- Alloy: "alloy",
175
- Echo: "echo",
176
- Fable: "fable",
177
- Onyx: "onyx",
178
- Nova: "nova",
179
- Shimmer: "shimmer",
180
- } as const;
181
- /**
182
- * The voice the model uses to respond. Supported voices are alloy, echo, fable, onyx, nova, and shimmer.
183
- */
184
- export type GetAgentVoice = ClosedEnum<typeof GetAgentVoice>;
185
-
186
- /**
187
- * Specifies the output audio format. Must be one of wav, mp3, flac, opus, or pcm16.
188
- */
189
- export const GetAgentFormat = {
190
- Wav: "wav",
191
- Mp3: "mp3",
192
- Flac: "flac",
193
- Opus: "opus",
194
- Pcm16: "pcm16",
195
- } as const;
196
- /**
197
- * Specifies the output audio format. Must be one of wav, mp3, flac, opus, or pcm16.
198
- */
199
- export type GetAgentFormat = ClosedEnum<typeof GetAgentFormat>;
200
-
201
- /**
202
- * Parameters for audio output. Required when audio output is requested with modalities: ["audio"]. Learn more.
203
- */
204
- export type GetAgentAudio = {
205
- /**
206
- * The voice the model uses to respond. Supported voices are alloy, echo, fable, onyx, nova, and shimmer.
207
- */
208
- voice: GetAgentVoice;
209
- /**
210
- * Specifies the output audio format. Must be one of wav, mp3, flac, opus, or pcm16.
211
- */
212
- format: GetAgentFormat;
213
- };
214
-
215
- export const GetAgentResponseFormatAgentsResponseType = {
216
- JsonSchema: "json_schema",
217
- } as const;
218
- export type GetAgentResponseFormatAgentsResponseType = ClosedEnum<
219
- typeof GetAgentResponseFormatAgentsResponseType
220
- >;
221
-
222
- export type GetAgentResponseFormatJsonSchema = {
223
- /**
224
- * A description of what the response format is for, used by the model to determine how to respond in the format.
225
- */
226
- description?: string | undefined;
227
- /**
228
- * 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.
229
- */
230
- name: string;
231
- /**
232
- * The schema for the response format, described as a JSON Schema object.
233
- */
234
- schema?: any | undefined;
235
- /**
236
- * 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.
237
- */
238
- strict?: boolean | null | undefined;
239
- };
240
-
241
- /**
242
- * @remarks
243
- *
244
- * JSON Schema response format. Used to generate structured JSON responses
245
- */
246
- export type GetAgentResponseFormatAgentsJSONSchema = {
247
- type: GetAgentResponseFormatAgentsResponseType;
248
- jsonSchema: GetAgentResponseFormatJsonSchema;
249
- };
250
-
251
- export const GetAgentResponseFormatAgentsType = {
252
- JsonObject: "json_object",
253
- } as const;
254
- export type GetAgentResponseFormatAgentsType = ClosedEnum<
255
- typeof GetAgentResponseFormatAgentsType
256
- >;
257
-
258
- /**
259
- * @remarks
260
- *
261
- * JSON object response format. An older method of generating JSON responses. Using `json_schema` is recommended for models that support it. Note that the model will not generate JSON without a system or user message instructing it to do so.
262
- */
263
- export type GetAgentResponseFormatJSONObject = {
264
- type: GetAgentResponseFormatAgentsType;
265
- };
266
-
267
- export const GetAgentResponseFormatType = {
268
- Text: "text",
269
- } as const;
270
- export type GetAgentResponseFormatType = ClosedEnum<
271
- typeof GetAgentResponseFormatType
272
- >;
273
-
274
- /**
275
- * @remarks
276
- *
277
- * Default response format. Used to generate text responses
278
- */
279
- export type GetAgentResponseFormatText = {
280
- type: GetAgentResponseFormatType;
281
- };
282
-
283
- /**
284
- * An object specifying the format that the model must output
285
- */
286
- export type GetAgentResponseFormat =
287
- | GetAgentResponseFormatAgentsJSONSchema
288
- | GetAgentResponseFormatText
289
- | GetAgentResponseFormatJSONObject;
290
-
291
- /**
292
- * Up to 4 sequences where the API will stop generating further tokens.
293
- */
294
- export type GetAgentStop = string | Array<string>;
295
-
296
- /**
297
- * Options for streaming response. Only set this when you set stream: true.
298
- */
299
- export type GetAgentStreamOptions = {
300
- /**
301
- * 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.
302
- */
303
- includeUsage?: boolean | undefined;
304
- };
305
-
306
- /**
307
- * Enables or disables the thinking mode capability
308
- */
309
- export const GetAgentType = {
310
- Enabled: "enabled",
311
- Disabled: "disabled",
312
- } as const;
313
- /**
314
- * Enables or disables the thinking mode capability
315
- */
316
- export type GetAgentType = ClosedEnum<typeof GetAgentType>;
317
-
318
- /**
319
- * The level of reasoning the model should use. This setting is supported only by `gemini-3` models. If budget_tokens is specified and `thinking_level` is available, `budget_tokens` will be ignored.
320
- */
321
- export const GetAgentThinkingLevel = {
322
- Low: "low",
323
- High: "high",
324
- } as const;
325
- /**
326
- * The level of reasoning the model should use. This setting is supported only by `gemini-3` models. If budget_tokens is specified and `thinking_level` is available, `budget_tokens` will be ignored.
327
- */
328
- export type GetAgentThinkingLevel = ClosedEnum<typeof GetAgentThinkingLevel>;
329
-
330
- export type GetAgentThinking = {
331
- /**
332
- * Enables or disables the thinking mode capability
333
- */
334
- type: GetAgentType;
335
- /**
336
- * 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`.
337
- */
338
- budgetTokens: number;
339
- /**
340
- * The level of reasoning the model should use. This setting is supported only by `gemini-3` models. If budget_tokens is specified and `thinking_level` is available, `budget_tokens` will be ignored.
341
- */
342
- thinkingLevel?: GetAgentThinkingLevel | undefined;
343
- };
344
-
345
- /**
346
- * The type of the tool. Currently, only function is supported.
347
- */
348
- export const GetAgentToolChoiceType = {
349
- Function: "function",
350
- } as const;
351
- /**
352
- * The type of the tool. Currently, only function is supported.
353
- */
354
- export type GetAgentToolChoiceType = ClosedEnum<typeof GetAgentToolChoiceType>;
355
-
356
- export type GetAgentToolChoiceFunction = {
357
- /**
358
- * The name of the function to call.
359
- */
360
- name?: string | undefined;
361
- };
362
-
363
- export type GetAgentToolChoice2 = {
364
- /**
365
- * The type of the tool. Currently, only function is supported.
366
- */
367
- type?: GetAgentToolChoiceType | undefined;
368
- function: GetAgentToolChoiceFunction;
369
- };
370
-
371
- export const GetAgentToolChoice1 = {
372
- None: "none",
373
- Auto: "auto",
374
- Required: "required",
375
- } as const;
376
- export type GetAgentToolChoice1 = ClosedEnum<typeof GetAgentToolChoice1>;
377
-
378
- /**
379
- * Controls which (if any) tool is called by the model.
380
- */
381
- export type GetAgentToolChoice = GetAgentToolChoice2 | GetAgentToolChoice1;
382
-
383
- export const GetAgentModalities = {
384
- Text: "text",
385
- Audio: "audio",
386
- } as const;
387
- export type GetAgentModalities = ClosedEnum<typeof GetAgentModalities>;
388
-
389
- /**
390
- * Model behavior parameters (snake_case) stored as part of the agent configuration. These become the default parameters used when the agent is executed. Commonly used: temperature (0-1, controls randomness), max_completion_tokens (response length), top_p (nucleus sampling). Advanced: frequency_penalty, presence_penalty, response_format (JSON/structured output), reasoning_effort (for o1/thinking models), seed (reproducibility), stop sequences. Model-specific support varies. Runtime parameters in agent execution requests can override these defaults.
391
- */
392
- export type GetAgentParameters = {
393
- /**
394
- * Parameters for audio output. Required when audio output is requested with modalities: ["audio"]. Learn more.
395
- */
396
- audio?: GetAgentAudio | null | undefined;
397
- /**
398
- * 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.
399
- */
400
- frequencyPenalty?: number | null | undefined;
401
- /**
402
- * `[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.
403
- *
404
- * @remarks
405
- *
406
- * This value is now `deprecated` in favor of `max_completion_tokens`, and is not compatible with o1 series models.
407
- */
408
- maxTokens?: number | null | undefined;
409
- /**
410
- * An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and reasoning tokens
411
- */
412
- maxCompletionTokens?: number | null | undefined;
413
- /**
414
- * 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.
415
- */
416
- logprobs?: boolean | null | undefined;
417
- /**
418
- * 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.
419
- */
420
- topLogprobs?: number | null | undefined;
421
- /**
422
- * 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.
423
- */
424
- n?: number | null | undefined;
425
- /**
426
- * 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.
427
- */
428
- presencePenalty?: number | null | undefined;
429
- /**
430
- * An object specifying the format that the model must output
431
- */
432
- responseFormat?:
433
- | GetAgentResponseFormatAgentsJSONSchema
434
- | GetAgentResponseFormatText
435
- | GetAgentResponseFormatJSONObject
436
- | undefined;
437
- /**
438
- * Constrains effort on reasoning for reasoning models. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.
439
- */
440
- reasoningEffort?: string | undefined;
441
- /**
442
- * Adjusts response verbosity. Lower levels yield shorter answers.
443
- */
444
- verbosity?: string | undefined;
445
- /**
446
- * 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.
447
- */
448
- seed?: number | null | undefined;
449
- /**
450
- * Up to 4 sequences where the API will stop generating further tokens.
451
- */
452
- stop?: string | Array<string> | null | undefined;
453
- /**
454
- * Options for streaming response. Only set this when you set stream: true.
455
- */
456
- streamOptions?: GetAgentStreamOptions | null | undefined;
457
- thinking?: GetAgentThinking | undefined;
458
- /**
459
- * 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.
460
- */
461
- temperature?: number | null | undefined;
462
- /**
463
- * An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass.
464
- */
465
- topP?: number | null | undefined;
466
- /**
467
- * Limits the model to consider only the top k most likely tokens at each step.
468
- */
469
- topK?: number | null | undefined;
470
- /**
471
- * Controls which (if any) tool is called by the model.
472
- */
473
- toolChoice?: GetAgentToolChoice2 | GetAgentToolChoice1 | undefined;
474
- /**
475
- * Whether to enable parallel function calling during tool use.
476
- */
477
- parallelToolCalls?: boolean | undefined;
478
- /**
479
- * 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"].
480
- */
481
- modalities?: Array<GetAgentModalities> | null | undefined;
482
- };
483
-
484
- /**
485
- * Retry configuration for model requests. Allows customizing retry count (1-5) and HTTP status codes that trigger retries. Default codes: [429]. Common codes: 500 (internal error), 429 (rate limit), 502/503/504 (gateway errors).
486
- */
487
- export type GetAgentRetry = {
488
- /**
489
- * Number of retry attempts (1-5)
490
- */
491
- count?: number | undefined;
492
- /**
493
- * HTTP status codes that trigger retry logic
494
- */
495
- onCodes?: Array<number> | undefined;
496
- };
497
-
498
- /**
499
- * The voice the model uses to respond. Supported voices are alloy, echo, fable, onyx, nova, and shimmer.
500
- */
501
- export const GetAgentFallbackModelConfigurationVoice = {
502
- Alloy: "alloy",
503
- Echo: "echo",
504
- Fable: "fable",
505
- Onyx: "onyx",
506
- Nova: "nova",
507
- Shimmer: "shimmer",
508
- } as const;
509
- /**
510
- * The voice the model uses to respond. Supported voices are alloy, echo, fable, onyx, nova, and shimmer.
511
- */
512
- export type GetAgentFallbackModelConfigurationVoice = ClosedEnum<
513
- typeof GetAgentFallbackModelConfigurationVoice
514
- >;
515
-
516
- /**
517
- * Specifies the output audio format. Must be one of wav, mp3, flac, opus, or pcm16.
518
- */
519
- export const GetAgentFallbackModelConfigurationFormat = {
520
- Wav: "wav",
521
- Mp3: "mp3",
522
- Flac: "flac",
523
- Opus: "opus",
524
- Pcm16: "pcm16",
525
- } as const;
526
- /**
527
- * Specifies the output audio format. Must be one of wav, mp3, flac, opus, or pcm16.
528
- */
529
- export type GetAgentFallbackModelConfigurationFormat = ClosedEnum<
530
- typeof GetAgentFallbackModelConfigurationFormat
531
- >;
532
-
533
- /**
534
- * Parameters for audio output. Required when audio output is requested with modalities: ["audio"]. Learn more.
535
- */
536
- export type GetAgentFallbackModelConfigurationAudio = {
537
- /**
538
- * The voice the model uses to respond. Supported voices are alloy, echo, fable, onyx, nova, and shimmer.
539
- */
540
- voice: GetAgentFallbackModelConfigurationVoice;
541
- /**
542
- * Specifies the output audio format. Must be one of wav, mp3, flac, opus, or pcm16.
543
- */
544
- format: GetAgentFallbackModelConfigurationFormat;
545
- };
546
-
547
- export const GetAgentResponseFormatAgentsResponse200ApplicationJSONResponseBodyType =
548
- {
549
- JsonSchema: "json_schema",
550
- } as const;
551
- export type GetAgentResponseFormatAgentsResponse200ApplicationJSONResponseBodyType =
552
- ClosedEnum<
553
- typeof GetAgentResponseFormatAgentsResponse200ApplicationJSONResponseBodyType
554
- >;
555
-
556
- export type GetAgentResponseFormatAgentsResponseJsonSchema = {
557
- /**
558
- * A description of what the response format is for, used by the model to determine how to respond in the format.
559
- */
560
- description?: string | undefined;
561
- /**
562
- * 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.
563
- */
564
- name: string;
565
- /**
566
- * The schema for the response format, described as a JSON Schema object.
567
- */
568
- schema?: any | undefined;
569
- /**
570
- * 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.
571
- */
572
- strict?: boolean | null | undefined;
573
- };
574
-
575
- /**
576
- * @remarks
577
- *
578
- * JSON Schema response format. Used to generate structured JSON responses
579
- */
580
- export type GetAgentResponseFormatAgentsResponse200JSONSchema = {
581
- type: GetAgentResponseFormatAgentsResponse200ApplicationJSONResponseBodyType;
582
- jsonSchema: GetAgentResponseFormatAgentsResponseJsonSchema;
583
- };
584
-
585
- export const GetAgentResponseFormatAgentsResponse200ApplicationJSONType = {
586
- JsonObject: "json_object",
587
- } as const;
588
- export type GetAgentResponseFormatAgentsResponse200ApplicationJSONType =
589
- ClosedEnum<typeof GetAgentResponseFormatAgentsResponse200ApplicationJSONType>;
590
-
591
- /**
592
- * @remarks
593
- *
594
- * JSON object response format. An older method of generating JSON responses. Using `json_schema` is recommended for models that support it. Note that the model will not generate JSON without a system or user message instructing it to do so.
595
- */
596
- export type GetAgentResponseFormatAgentsJSONObject = {
597
- type: GetAgentResponseFormatAgentsResponse200ApplicationJSONType;
598
- };
599
-
600
- export const GetAgentResponseFormatAgentsResponse200Type = {
601
- Text: "text",
602
- } as const;
603
- export type GetAgentResponseFormatAgentsResponse200Type = ClosedEnum<
604
- typeof GetAgentResponseFormatAgentsResponse200Type
605
- >;
606
-
607
- /**
608
- * @remarks
609
- *
610
- * Default response format. Used to generate text responses
611
- */
612
- export type GetAgentResponseFormatAgentsText = {
613
- type: GetAgentResponseFormatAgentsResponse200Type;
614
- };
615
-
616
- /**
617
- * An object specifying the format that the model must output
618
- */
619
- export type GetAgentFallbackModelConfigurationResponseFormat =
620
- | GetAgentResponseFormatAgentsResponse200JSONSchema
621
- | GetAgentResponseFormatAgentsText
622
- | GetAgentResponseFormatAgentsJSONObject;
623
-
624
- /**
625
- * Up to 4 sequences where the API will stop generating further tokens.
626
- */
627
- export type GetAgentFallbackModelConfigurationStop = string | Array<string>;
628
-
629
- /**
630
- * Options for streaming response. Only set this when you set stream: true.
631
- */
632
- export type GetAgentFallbackModelConfigurationStreamOptions = {
633
- /**
634
- * 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.
635
- */
636
- includeUsage?: boolean | undefined;
637
- };
638
-
639
- /**
640
- * Enables or disables the thinking mode capability
641
- */
642
- export const GetAgentFallbackModelConfigurationType = {
643
- Enabled: "enabled",
644
- Disabled: "disabled",
645
- } as const;
646
- /**
647
- * Enables or disables the thinking mode capability
648
- */
649
- export type GetAgentFallbackModelConfigurationType = ClosedEnum<
650
- typeof GetAgentFallbackModelConfigurationType
651
- >;
652
-
653
- /**
654
- * The level of reasoning the model should use. This setting is supported only by `gemini-3` models. If budget_tokens is specified and `thinking_level` is available, `budget_tokens` will be ignored.
655
- */
656
- export const GetAgentFallbackModelConfigurationThinkingLevel = {
657
- Low: "low",
658
- High: "high",
659
- } as const;
660
- /**
661
- * The level of reasoning the model should use. This setting is supported only by `gemini-3` models. If budget_tokens is specified and `thinking_level` is available, `budget_tokens` will be ignored.
662
- */
663
- export type GetAgentFallbackModelConfigurationThinkingLevel = ClosedEnum<
664
- typeof GetAgentFallbackModelConfigurationThinkingLevel
665
- >;
666
-
667
- export type GetAgentFallbackModelConfigurationThinking = {
668
- /**
669
- * Enables or disables the thinking mode capability
670
- */
671
- type: GetAgentFallbackModelConfigurationType;
672
- /**
673
- * 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`.
674
- */
675
- budgetTokens: number;
676
- /**
677
- * The level of reasoning the model should use. This setting is supported only by `gemini-3` models. If budget_tokens is specified and `thinking_level` is available, `budget_tokens` will be ignored.
678
- */
679
- thinkingLevel?: GetAgentFallbackModelConfigurationThinkingLevel | undefined;
680
- };
681
-
682
- /**
683
- * The type of the tool. Currently, only function is supported.
684
- */
685
- export const GetAgentToolChoiceAgentsType = {
686
- Function: "function",
687
- } as const;
688
- /**
689
- * The type of the tool. Currently, only function is supported.
690
- */
691
- export type GetAgentToolChoiceAgentsType = ClosedEnum<
692
- typeof GetAgentToolChoiceAgentsType
693
- >;
694
-
695
- export type GetAgentToolChoiceAgentsFunction = {
696
- /**
697
- * The name of the function to call.
698
- */
699
- name?: string | undefined;
700
- };
701
-
702
- export type GetAgentToolChoiceAgents2 = {
703
- /**
704
- * The type of the tool. Currently, only function is supported.
705
- */
706
- type?: GetAgentToolChoiceAgentsType | undefined;
707
- function: GetAgentToolChoiceAgentsFunction;
708
- };
709
-
710
- export const GetAgentToolChoiceAgents1 = {
711
- None: "none",
712
- Auto: "auto",
713
- Required: "required",
714
- } as const;
715
- export type GetAgentToolChoiceAgents1 = ClosedEnum<
716
- typeof GetAgentToolChoiceAgents1
717
- >;
718
-
719
- /**
720
- * Controls which (if any) tool is called by the model.
721
- */
722
- export type GetAgentFallbackModelConfigurationToolChoice =
723
- | GetAgentToolChoiceAgents2
724
- | GetAgentToolChoiceAgents1;
725
-
726
- export const GetAgentFallbackModelConfigurationModalities = {
727
- Text: "text",
728
- Audio: "audio",
729
- } as const;
730
- export type GetAgentFallbackModelConfigurationModalities = ClosedEnum<
731
- typeof GetAgentFallbackModelConfigurationModalities
732
- >;
733
-
734
- /**
735
- * Optional model parameters specific to this fallback model. Overrides primary model parameters if this fallback is used.
736
- */
737
- export type GetAgentFallbackModelConfigurationParameters = {
738
- /**
739
- * Parameters for audio output. Required when audio output is requested with modalities: ["audio"]. Learn more.
740
- */
741
- audio?: GetAgentFallbackModelConfigurationAudio | null | undefined;
742
- /**
743
- * 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.
744
- */
745
- frequencyPenalty?: number | null | undefined;
746
- /**
747
- * `[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.
748
- *
749
- * @remarks
750
- *
751
- * This value is now `deprecated` in favor of `max_completion_tokens`, and is not compatible with o1 series models.
752
- */
753
- maxTokens?: number | null | undefined;
754
- /**
755
- * An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and reasoning tokens
756
- */
757
- maxCompletionTokens?: number | null | undefined;
758
- /**
759
- * 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.
760
- */
761
- logprobs?: boolean | null | undefined;
762
- /**
763
- * 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.
764
- */
765
- topLogprobs?: number | null | undefined;
766
- /**
767
- * 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.
768
- */
769
- n?: number | null | undefined;
770
- /**
771
- * 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.
772
- */
773
- presencePenalty?: number | null | undefined;
774
- /**
775
- * An object specifying the format that the model must output
776
- */
777
- responseFormat?:
778
- | GetAgentResponseFormatAgentsResponse200JSONSchema
779
- | GetAgentResponseFormatAgentsText
780
- | GetAgentResponseFormatAgentsJSONObject
781
- | undefined;
782
- /**
783
- * Constrains effort on reasoning for reasoning models. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.
784
- */
785
- reasoningEffort?: string | undefined;
786
- /**
787
- * Adjusts response verbosity. Lower levels yield shorter answers.
788
- */
789
- verbosity?: string | undefined;
790
- /**
791
- * 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.
792
- */
793
- seed?: number | null | undefined;
794
- /**
795
- * Up to 4 sequences where the API will stop generating further tokens.
796
- */
797
- stop?: string | Array<string> | null | undefined;
798
- /**
799
- * Options for streaming response. Only set this when you set stream: true.
800
- */
801
- streamOptions?:
802
- | GetAgentFallbackModelConfigurationStreamOptions
803
- | null
804
- | undefined;
805
- thinking?: GetAgentFallbackModelConfigurationThinking | undefined;
806
- /**
807
- * 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.
808
- */
809
- temperature?: number | null | undefined;
810
- /**
811
- * An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass.
812
- */
813
- topP?: number | null | undefined;
814
- /**
815
- * Limits the model to consider only the top k most likely tokens at each step.
816
- */
817
- topK?: number | null | undefined;
818
- /**
819
- * Controls which (if any) tool is called by the model.
820
- */
821
- toolChoice?:
822
- | GetAgentToolChoiceAgents2
823
- | GetAgentToolChoiceAgents1
824
- | undefined;
825
- /**
826
- * Whether to enable parallel function calling during tool use.
827
- */
828
- parallelToolCalls?: boolean | undefined;
829
- /**
830
- * 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"].
831
- */
832
- modalities?:
833
- | Array<GetAgentFallbackModelConfigurationModalities>
834
- | null
835
- | undefined;
836
- };
837
-
838
- /**
839
- * Fallback model configuration with optional parameters.
840
- */
841
- export type GetAgentFallbackModelConfiguration2 = {
842
- /**
843
- * A fallback model ID string. Must support tool calling.
844
- */
845
- id: string;
846
- /**
847
- * Optional model parameters specific to this fallback model. Overrides primary model parameters if this fallback is used.
848
- */
849
- parameters?: GetAgentFallbackModelConfigurationParameters | undefined;
850
- };
851
-
852
- /**
853
- * Fallback model for automatic failover when primary model request fails. Supports optional parameter overrides. Can be a simple model ID string or a configuration object with model-specific parameters. Fallbacks are tried in order.
854
- */
855
- export type GetAgentFallbackModelConfiguration =
856
- | GetAgentFallbackModelConfiguration2
857
- | string;
858
-
859
- export type GetAgentModel = {
860
- /**
861
- * The database ID of the primary model
862
- */
863
- id: string;
864
- /**
865
- * Optional integration ID for custom model configurations
866
- */
867
- integrationId?: string | null | undefined;
868
- /**
869
- * Model behavior parameters (snake_case) stored as part of the agent configuration. These become the default parameters used when the agent is executed. Commonly used: temperature (0-1, controls randomness), max_completion_tokens (response length), top_p (nucleus sampling). Advanced: frequency_penalty, presence_penalty, response_format (JSON/structured output), reasoning_effort (for o1/thinking models), seed (reproducibility), stop sequences. Model-specific support varies. Runtime parameters in agent execution requests can override these defaults.
870
- */
871
- parameters?: GetAgentParameters | undefined;
872
- /**
873
- * Retry configuration for model requests. Allows customizing retry count (1-5) and HTTP status codes that trigger retries. Default codes: [429]. Common codes: 500 (internal error), 429 (rate limit), 502/503/504 (gateway errors).
874
- */
875
- retry?: GetAgentRetry | undefined;
876
- /**
877
- * Optional array of fallback models (string IDs or config objects) that will be used automatically in order if the primary model fails
878
- */
879
- fallbackModels?:
880
- | Array<GetAgentFallbackModelConfiguration2 | string>
881
- | null
882
- | undefined;
883
- };
884
-
885
- export type GetAgentTeamOfAgents = {
886
- /**
887
- * The unique key of the agent within the workspace
888
- */
889
- key: string;
890
- /**
891
- * 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.
892
- */
893
- role?: string | undefined;
894
- };
895
-
896
- export type GetAgentMetrics = {
897
- totalCost?: number | undefined;
898
- };
899
-
900
- export type GetAgentKnowledgeBases = {
901
- /**
902
- * Unique identifier of the knowledge base to search
903
- */
904
- knowledgeId: string;
905
- };
906
-
907
- /**
908
- * Agent retrieved successfully
909
- */
910
- export type GetAgentResponseBody = {
911
- id: string;
912
- key: string;
913
- displayName: string;
914
- workspaceId: string;
915
- projectId: string;
916
- createdById?: string | null | undefined;
917
- updatedById?: string | null | undefined;
918
- created?: string | undefined;
919
- updated?: string | undefined;
920
- role: string;
921
- description: string;
922
- systemPrompt?: string | undefined;
923
- instructions: string;
924
- /**
925
- * The status of the agent. `Live` is the latest version of the agent. `Draft` is a version that is not yet published. `Pending` is a version that is pending approval. `Published` is a version that was live and has been replaced by a new version.
926
- */
927
- status: GetAgentStatus;
928
- settings?: GetAgentSettings | undefined;
929
- model: GetAgentModel;
930
- versionHash?: string | undefined;
931
- /**
932
- * Entity storage path in the format: `project/folder/subfolder/...`
933
- *
934
- * @remarks
935
- *
936
- * The first element identifies the project, followed by nested folders (auto-created as needed).
937
- *
938
- * With project-based API keys, the first element is treated as a folder name, as the project is predetermined by the API key.
939
- */
940
- path: string;
941
- /**
942
- * Array of memory store identifiers. Accepts both memory store IDs and keys.
943
- */
944
- memoryStores: Array<string>;
945
- /**
946
- * The agents that are accessible to this orchestrator. The main agent can hand off to these agents to perform tasks.
947
- */
948
- teamOfAgents: Array<GetAgentTeamOfAgents>;
949
- metrics?: GetAgentMetrics | undefined;
950
- /**
951
- * Extracted variables from agent instructions
952
- */
953
- variables?: { [k: string]: any } | undefined;
954
- /**
955
- * Agent knowledge bases reference
956
- */
957
- knowledgeBases?: Array<GetAgentKnowledgeBases> | undefined;
958
- };
959
-
960
- /** @internal */
961
- export const GetAgentRequest$inboundSchema: z.ZodType<
962
- GetAgentRequest,
963
- z.ZodTypeDef,
964
- unknown
965
- > = z.object({
966
- agent_key: z.string(),
967
- }).transform((v) => {
968
- return remap$(v, {
969
- "agent_key": "agentKey",
970
- });
971
- });
972
- /** @internal */
973
- export type GetAgentRequest$Outbound = {
974
- agent_key: string;
975
- };
976
-
977
- /** @internal */
978
- export const GetAgentRequest$outboundSchema: z.ZodType<
979
- GetAgentRequest$Outbound,
980
- z.ZodTypeDef,
981
- GetAgentRequest
982
- > = z.object({
983
- agentKey: z.string(),
984
- }).transform((v) => {
985
- return remap$(v, {
986
- agentKey: "agent_key",
987
- });
988
- });
989
-
990
- export function getAgentRequestToJSON(
991
- getAgentRequest: GetAgentRequest,
992
- ): string {
993
- return JSON.stringify(GetAgentRequest$outboundSchema.parse(getAgentRequest));
994
- }
995
- export function getAgentRequestFromJSON(
996
- jsonString: string,
997
- ): SafeParseResult<GetAgentRequest, SDKValidationError> {
998
- return safeParse(
999
- jsonString,
1000
- (x) => GetAgentRequest$inboundSchema.parse(JSON.parse(x)),
1001
- `Failed to parse 'GetAgentRequest' from JSON`,
1002
- );
1003
- }
1004
-
1005
- /** @internal */
1006
- export const GetAgentStatus$inboundSchema: z.ZodNativeEnum<
1007
- typeof GetAgentStatus
1008
- > = z.nativeEnum(GetAgentStatus);
1009
- /** @internal */
1010
- export const GetAgentStatus$outboundSchema: z.ZodNativeEnum<
1011
- typeof GetAgentStatus
1012
- > = GetAgentStatus$inboundSchema;
1013
-
1014
- /** @internal */
1015
- export const GetAgentToolApprovalRequired$inboundSchema: z.ZodNativeEnum<
1016
- typeof GetAgentToolApprovalRequired
1017
- > = z.nativeEnum(GetAgentToolApprovalRequired);
1018
- /** @internal */
1019
- export const GetAgentToolApprovalRequired$outboundSchema: z.ZodNativeEnum<
1020
- typeof GetAgentToolApprovalRequired
1021
- > = GetAgentToolApprovalRequired$inboundSchema;
1022
-
1023
- /** @internal */
1024
- export const GetAgentConditions$inboundSchema: z.ZodType<
1025
- GetAgentConditions,
1026
- z.ZodTypeDef,
1027
- unknown
1028
- > = z.object({
1029
- condition: z.string(),
1030
- operator: z.string(),
1031
- value: z.string(),
1032
- });
1033
- /** @internal */
1034
- export type GetAgentConditions$Outbound = {
1035
- condition: string;
1036
- operator: string;
1037
- value: string;
1038
- };
1039
-
1040
- /** @internal */
1041
- export const GetAgentConditions$outboundSchema: z.ZodType<
1042
- GetAgentConditions$Outbound,
1043
- z.ZodTypeDef,
1044
- GetAgentConditions
1045
- > = z.object({
1046
- condition: z.string(),
1047
- operator: z.string(),
1048
- value: z.string(),
1049
- });
1050
-
1051
- export function getAgentConditionsToJSON(
1052
- getAgentConditions: GetAgentConditions,
1053
- ): string {
1054
- return JSON.stringify(
1055
- GetAgentConditions$outboundSchema.parse(getAgentConditions),
1056
- );
1057
- }
1058
- export function getAgentConditionsFromJSON(
1059
- jsonString: string,
1060
- ): SafeParseResult<GetAgentConditions, SDKValidationError> {
1061
- return safeParse(
1062
- jsonString,
1063
- (x) => GetAgentConditions$inboundSchema.parse(JSON.parse(x)),
1064
- `Failed to parse 'GetAgentConditions' from JSON`,
1065
- );
1066
- }
1067
-
1068
- /** @internal */
1069
- export const GetAgentTools$inboundSchema: z.ZodType<
1070
- GetAgentTools,
1071
- z.ZodTypeDef,
1072
- unknown
1073
- > = z.object({
1074
- id: z.string(),
1075
- key: z.string().optional(),
1076
- action_type: z.string(),
1077
- display_name: z.string().optional(),
1078
- description: z.string().optional(),
1079
- requires_approval: z.boolean().default(false),
1080
- tool_id: z.string().optional(),
1081
- conditions: z.array(z.lazy(() => GetAgentConditions$inboundSchema))
1082
- .optional(),
1083
- timeout: z.number().default(120),
1084
- }).transform((v) => {
1085
- return remap$(v, {
1086
- "action_type": "actionType",
1087
- "display_name": "displayName",
1088
- "requires_approval": "requiresApproval",
1089
- "tool_id": "toolId",
1090
- });
1091
- });
1092
- /** @internal */
1093
- export type GetAgentTools$Outbound = {
1094
- id: string;
1095
- key?: string | undefined;
1096
- action_type: string;
1097
- display_name?: string | undefined;
1098
- description?: string | undefined;
1099
- requires_approval: boolean;
1100
- tool_id?: string | undefined;
1101
- conditions?: Array<GetAgentConditions$Outbound> | undefined;
1102
- timeout: number;
1103
- };
1104
-
1105
- /** @internal */
1106
- export const GetAgentTools$outboundSchema: z.ZodType<
1107
- GetAgentTools$Outbound,
1108
- z.ZodTypeDef,
1109
- GetAgentTools
1110
- > = z.object({
1111
- id: z.string(),
1112
- key: z.string().optional(),
1113
- actionType: z.string(),
1114
- displayName: z.string().optional(),
1115
- description: z.string().optional(),
1116
- requiresApproval: z.boolean().default(false),
1117
- toolId: z.string().optional(),
1118
- conditions: z.array(z.lazy(() => GetAgentConditions$outboundSchema))
1119
- .optional(),
1120
- timeout: z.number().default(120),
1121
- }).transform((v) => {
1122
- return remap$(v, {
1123
- actionType: "action_type",
1124
- displayName: "display_name",
1125
- requiresApproval: "requires_approval",
1126
- toolId: "tool_id",
1127
- });
1128
- });
1129
-
1130
- export function getAgentToolsToJSON(getAgentTools: GetAgentTools): string {
1131
- return JSON.stringify(GetAgentTools$outboundSchema.parse(getAgentTools));
1132
- }
1133
- export function getAgentToolsFromJSON(
1134
- jsonString: string,
1135
- ): SafeParseResult<GetAgentTools, SDKValidationError> {
1136
- return safeParse(
1137
- jsonString,
1138
- (x) => GetAgentTools$inboundSchema.parse(JSON.parse(x)),
1139
- `Failed to parse 'GetAgentTools' from JSON`,
1140
- );
1141
- }
1142
-
1143
- /** @internal */
1144
- export const GetAgentExecuteOn$inboundSchema: z.ZodNativeEnum<
1145
- typeof GetAgentExecuteOn
1146
- > = z.nativeEnum(GetAgentExecuteOn);
1147
- /** @internal */
1148
- export const GetAgentExecuteOn$outboundSchema: z.ZodNativeEnum<
1149
- typeof GetAgentExecuteOn
1150
- > = GetAgentExecuteOn$inboundSchema;
1151
-
1152
- /** @internal */
1153
- export const GetAgentEvaluators$inboundSchema: z.ZodType<
1154
- GetAgentEvaluators,
1155
- z.ZodTypeDef,
1156
- unknown
1157
- > = z.object({
1158
- id: z.string(),
1159
- sample_rate: z.number().default(50),
1160
- execute_on: GetAgentExecuteOn$inboundSchema,
1161
- }).transform((v) => {
1162
- return remap$(v, {
1163
- "sample_rate": "sampleRate",
1164
- "execute_on": "executeOn",
1165
- });
1166
- });
1167
- /** @internal */
1168
- export type GetAgentEvaluators$Outbound = {
1169
- id: string;
1170
- sample_rate: number;
1171
- execute_on: string;
1172
- };
1173
-
1174
- /** @internal */
1175
- export const GetAgentEvaluators$outboundSchema: z.ZodType<
1176
- GetAgentEvaluators$Outbound,
1177
- z.ZodTypeDef,
1178
- GetAgentEvaluators
1179
- > = z.object({
1180
- id: z.string(),
1181
- sampleRate: z.number().default(50),
1182
- executeOn: GetAgentExecuteOn$outboundSchema,
1183
- }).transform((v) => {
1184
- return remap$(v, {
1185
- sampleRate: "sample_rate",
1186
- executeOn: "execute_on",
1187
- });
1188
- });
1189
-
1190
- export function getAgentEvaluatorsToJSON(
1191
- getAgentEvaluators: GetAgentEvaluators,
1192
- ): string {
1193
- return JSON.stringify(
1194
- GetAgentEvaluators$outboundSchema.parse(getAgentEvaluators),
1195
- );
1196
- }
1197
- export function getAgentEvaluatorsFromJSON(
1198
- jsonString: string,
1199
- ): SafeParseResult<GetAgentEvaluators, SDKValidationError> {
1200
- return safeParse(
1201
- jsonString,
1202
- (x) => GetAgentEvaluators$inboundSchema.parse(JSON.parse(x)),
1203
- `Failed to parse 'GetAgentEvaluators' from JSON`,
1204
- );
1205
- }
1206
-
1207
- /** @internal */
1208
- export const GetAgentAgentsExecuteOn$inboundSchema: z.ZodNativeEnum<
1209
- typeof GetAgentAgentsExecuteOn
1210
- > = z.nativeEnum(GetAgentAgentsExecuteOn);
1211
- /** @internal */
1212
- export const GetAgentAgentsExecuteOn$outboundSchema: z.ZodNativeEnum<
1213
- typeof GetAgentAgentsExecuteOn
1214
- > = GetAgentAgentsExecuteOn$inboundSchema;
1215
-
1216
- /** @internal */
1217
- export const GetAgentGuardrails$inboundSchema: z.ZodType<
1218
- GetAgentGuardrails,
1219
- z.ZodTypeDef,
1220
- unknown
1221
- > = z.object({
1222
- id: z.string(),
1223
- sample_rate: z.number().default(50),
1224
- execute_on: GetAgentAgentsExecuteOn$inboundSchema,
1225
- }).transform((v) => {
1226
- return remap$(v, {
1227
- "sample_rate": "sampleRate",
1228
- "execute_on": "executeOn",
1229
- });
1230
- });
1231
- /** @internal */
1232
- export type GetAgentGuardrails$Outbound = {
1233
- id: string;
1234
- sample_rate: number;
1235
- execute_on: string;
1236
- };
1237
-
1238
- /** @internal */
1239
- export const GetAgentGuardrails$outboundSchema: z.ZodType<
1240
- GetAgentGuardrails$Outbound,
1241
- z.ZodTypeDef,
1242
- GetAgentGuardrails
1243
- > = z.object({
1244
- id: z.string(),
1245
- sampleRate: z.number().default(50),
1246
- executeOn: GetAgentAgentsExecuteOn$outboundSchema,
1247
- }).transform((v) => {
1248
- return remap$(v, {
1249
- sampleRate: "sample_rate",
1250
- executeOn: "execute_on",
1251
- });
1252
- });
1253
-
1254
- export function getAgentGuardrailsToJSON(
1255
- getAgentGuardrails: GetAgentGuardrails,
1256
- ): string {
1257
- return JSON.stringify(
1258
- GetAgentGuardrails$outboundSchema.parse(getAgentGuardrails),
1259
- );
1260
- }
1261
- export function getAgentGuardrailsFromJSON(
1262
- jsonString: string,
1263
- ): SafeParseResult<GetAgentGuardrails, SDKValidationError> {
1264
- return safeParse(
1265
- jsonString,
1266
- (x) => GetAgentGuardrails$inboundSchema.parse(JSON.parse(x)),
1267
- `Failed to parse 'GetAgentGuardrails' from JSON`,
1268
- );
1269
- }
1270
-
1271
- /** @internal */
1272
- export const GetAgentSettings$inboundSchema: z.ZodType<
1273
- GetAgentSettings,
1274
- z.ZodTypeDef,
1275
- unknown
1276
- > = z.object({
1277
- max_iterations: z.number().int().default(100),
1278
- max_execution_time: z.number().int().default(300),
1279
- tool_approval_required: GetAgentToolApprovalRequired$inboundSchema.default(
1280
- "respect_tool",
1281
- ),
1282
- tools: z.array(z.lazy(() => GetAgentTools$inboundSchema)).optional(),
1283
- evaluators: z.array(z.lazy(() => GetAgentEvaluators$inboundSchema))
1284
- .optional(),
1285
- guardrails: z.array(z.lazy(() => GetAgentGuardrails$inboundSchema))
1286
- .optional(),
1287
- }).transform((v) => {
1288
- return remap$(v, {
1289
- "max_iterations": "maxIterations",
1290
- "max_execution_time": "maxExecutionTime",
1291
- "tool_approval_required": "toolApprovalRequired",
1292
- });
1293
- });
1294
- /** @internal */
1295
- export type GetAgentSettings$Outbound = {
1296
- max_iterations: number;
1297
- max_execution_time: number;
1298
- tool_approval_required: string;
1299
- tools?: Array<GetAgentTools$Outbound> | undefined;
1300
- evaluators?: Array<GetAgentEvaluators$Outbound> | undefined;
1301
- guardrails?: Array<GetAgentGuardrails$Outbound> | undefined;
1302
- };
1303
-
1304
- /** @internal */
1305
- export const GetAgentSettings$outboundSchema: z.ZodType<
1306
- GetAgentSettings$Outbound,
1307
- z.ZodTypeDef,
1308
- GetAgentSettings
1309
- > = z.object({
1310
- maxIterations: z.number().int().default(100),
1311
- maxExecutionTime: z.number().int().default(300),
1312
- toolApprovalRequired: GetAgentToolApprovalRequired$outboundSchema.default(
1313
- "respect_tool",
1314
- ),
1315
- tools: z.array(z.lazy(() => GetAgentTools$outboundSchema)).optional(),
1316
- evaluators: z.array(z.lazy(() => GetAgentEvaluators$outboundSchema))
1317
- .optional(),
1318
- guardrails: z.array(z.lazy(() => GetAgentGuardrails$outboundSchema))
1319
- .optional(),
1320
- }).transform((v) => {
1321
- return remap$(v, {
1322
- maxIterations: "max_iterations",
1323
- maxExecutionTime: "max_execution_time",
1324
- toolApprovalRequired: "tool_approval_required",
1325
- });
1326
- });
1327
-
1328
- export function getAgentSettingsToJSON(
1329
- getAgentSettings: GetAgentSettings,
1330
- ): string {
1331
- return JSON.stringify(
1332
- GetAgentSettings$outboundSchema.parse(getAgentSettings),
1333
- );
1334
- }
1335
- export function getAgentSettingsFromJSON(
1336
- jsonString: string,
1337
- ): SafeParseResult<GetAgentSettings, SDKValidationError> {
1338
- return safeParse(
1339
- jsonString,
1340
- (x) => GetAgentSettings$inboundSchema.parse(JSON.parse(x)),
1341
- `Failed to parse 'GetAgentSettings' from JSON`,
1342
- );
1343
- }
1344
-
1345
- /** @internal */
1346
- export const GetAgentVoice$inboundSchema: z.ZodNativeEnum<
1347
- typeof GetAgentVoice
1348
- > = z.nativeEnum(GetAgentVoice);
1349
- /** @internal */
1350
- export const GetAgentVoice$outboundSchema: z.ZodNativeEnum<
1351
- typeof GetAgentVoice
1352
- > = GetAgentVoice$inboundSchema;
1353
-
1354
- /** @internal */
1355
- export const GetAgentFormat$inboundSchema: z.ZodNativeEnum<
1356
- typeof GetAgentFormat
1357
- > = z.nativeEnum(GetAgentFormat);
1358
- /** @internal */
1359
- export const GetAgentFormat$outboundSchema: z.ZodNativeEnum<
1360
- typeof GetAgentFormat
1361
- > = GetAgentFormat$inboundSchema;
1362
-
1363
- /** @internal */
1364
- export const GetAgentAudio$inboundSchema: z.ZodType<
1365
- GetAgentAudio,
1366
- z.ZodTypeDef,
1367
- unknown
1368
- > = z.object({
1369
- voice: GetAgentVoice$inboundSchema,
1370
- format: GetAgentFormat$inboundSchema,
1371
- });
1372
- /** @internal */
1373
- export type GetAgentAudio$Outbound = {
1374
- voice: string;
1375
- format: string;
1376
- };
1377
-
1378
- /** @internal */
1379
- export const GetAgentAudio$outboundSchema: z.ZodType<
1380
- GetAgentAudio$Outbound,
1381
- z.ZodTypeDef,
1382
- GetAgentAudio
1383
- > = z.object({
1384
- voice: GetAgentVoice$outboundSchema,
1385
- format: GetAgentFormat$outboundSchema,
1386
- });
1387
-
1388
- export function getAgentAudioToJSON(getAgentAudio: GetAgentAudio): string {
1389
- return JSON.stringify(GetAgentAudio$outboundSchema.parse(getAgentAudio));
1390
- }
1391
- export function getAgentAudioFromJSON(
1392
- jsonString: string,
1393
- ): SafeParseResult<GetAgentAudio, SDKValidationError> {
1394
- return safeParse(
1395
- jsonString,
1396
- (x) => GetAgentAudio$inboundSchema.parse(JSON.parse(x)),
1397
- `Failed to parse 'GetAgentAudio' from JSON`,
1398
- );
1399
- }
1400
-
1401
- /** @internal */
1402
- export const GetAgentResponseFormatAgentsResponseType$inboundSchema:
1403
- z.ZodNativeEnum<typeof GetAgentResponseFormatAgentsResponseType> = z
1404
- .nativeEnum(GetAgentResponseFormatAgentsResponseType);
1405
- /** @internal */
1406
- export const GetAgentResponseFormatAgentsResponseType$outboundSchema:
1407
- z.ZodNativeEnum<typeof GetAgentResponseFormatAgentsResponseType> =
1408
- GetAgentResponseFormatAgentsResponseType$inboundSchema;
1409
-
1410
- /** @internal */
1411
- export const GetAgentResponseFormatJsonSchema$inboundSchema: z.ZodType<
1412
- GetAgentResponseFormatJsonSchema,
1413
- z.ZodTypeDef,
1414
- unknown
1415
- > = z.object({
1416
- description: z.string().optional(),
1417
- name: z.string(),
1418
- schema: z.any().optional(),
1419
- strict: z.nullable(z.boolean()).optional(),
1420
- });
1421
- /** @internal */
1422
- export type GetAgentResponseFormatJsonSchema$Outbound = {
1423
- description?: string | undefined;
1424
- name: string;
1425
- schema?: any | undefined;
1426
- strict?: boolean | null | undefined;
1427
- };
1428
-
1429
- /** @internal */
1430
- export const GetAgentResponseFormatJsonSchema$outboundSchema: z.ZodType<
1431
- GetAgentResponseFormatJsonSchema$Outbound,
1432
- z.ZodTypeDef,
1433
- GetAgentResponseFormatJsonSchema
1434
- > = z.object({
1435
- description: z.string().optional(),
1436
- name: z.string(),
1437
- schema: z.any().optional(),
1438
- strict: z.nullable(z.boolean()).optional(),
1439
- });
1440
-
1441
- export function getAgentResponseFormatJsonSchemaToJSON(
1442
- getAgentResponseFormatJsonSchema: GetAgentResponseFormatJsonSchema,
1443
- ): string {
1444
- return JSON.stringify(
1445
- GetAgentResponseFormatJsonSchema$outboundSchema.parse(
1446
- getAgentResponseFormatJsonSchema,
1447
- ),
1448
- );
1449
- }
1450
- export function getAgentResponseFormatJsonSchemaFromJSON(
1451
- jsonString: string,
1452
- ): SafeParseResult<GetAgentResponseFormatJsonSchema, SDKValidationError> {
1453
- return safeParse(
1454
- jsonString,
1455
- (x) => GetAgentResponseFormatJsonSchema$inboundSchema.parse(JSON.parse(x)),
1456
- `Failed to parse 'GetAgentResponseFormatJsonSchema' from JSON`,
1457
- );
1458
- }
1459
-
1460
- /** @internal */
1461
- export const GetAgentResponseFormatAgentsJSONSchema$inboundSchema: z.ZodType<
1462
- GetAgentResponseFormatAgentsJSONSchema,
1463
- z.ZodTypeDef,
1464
- unknown
1465
- > = z.object({
1466
- type: GetAgentResponseFormatAgentsResponseType$inboundSchema,
1467
- json_schema: z.lazy(() => GetAgentResponseFormatJsonSchema$inboundSchema),
1468
- }).transform((v) => {
1469
- return remap$(v, {
1470
- "json_schema": "jsonSchema",
1471
- });
1472
- });
1473
- /** @internal */
1474
- export type GetAgentResponseFormatAgentsJSONSchema$Outbound = {
1475
- type: string;
1476
- json_schema: GetAgentResponseFormatJsonSchema$Outbound;
1477
- };
1478
-
1479
- /** @internal */
1480
- export const GetAgentResponseFormatAgentsJSONSchema$outboundSchema: z.ZodType<
1481
- GetAgentResponseFormatAgentsJSONSchema$Outbound,
1482
- z.ZodTypeDef,
1483
- GetAgentResponseFormatAgentsJSONSchema
1484
- > = z.object({
1485
- type: GetAgentResponseFormatAgentsResponseType$outboundSchema,
1486
- jsonSchema: z.lazy(() => GetAgentResponseFormatJsonSchema$outboundSchema),
1487
- }).transform((v) => {
1488
- return remap$(v, {
1489
- jsonSchema: "json_schema",
1490
- });
1491
- });
1492
-
1493
- export function getAgentResponseFormatAgentsJSONSchemaToJSON(
1494
- getAgentResponseFormatAgentsJSONSchema:
1495
- GetAgentResponseFormatAgentsJSONSchema,
1496
- ): string {
1497
- return JSON.stringify(
1498
- GetAgentResponseFormatAgentsJSONSchema$outboundSchema.parse(
1499
- getAgentResponseFormatAgentsJSONSchema,
1500
- ),
1501
- );
1502
- }
1503
- export function getAgentResponseFormatAgentsJSONSchemaFromJSON(
1504
- jsonString: string,
1505
- ): SafeParseResult<GetAgentResponseFormatAgentsJSONSchema, SDKValidationError> {
1506
- return safeParse(
1507
- jsonString,
1508
- (x) =>
1509
- GetAgentResponseFormatAgentsJSONSchema$inboundSchema.parse(JSON.parse(x)),
1510
- `Failed to parse 'GetAgentResponseFormatAgentsJSONSchema' from JSON`,
1511
- );
1512
- }
1513
-
1514
- /** @internal */
1515
- export const GetAgentResponseFormatAgentsType$inboundSchema: z.ZodNativeEnum<
1516
- typeof GetAgentResponseFormatAgentsType
1517
- > = z.nativeEnum(GetAgentResponseFormatAgentsType);
1518
- /** @internal */
1519
- export const GetAgentResponseFormatAgentsType$outboundSchema: z.ZodNativeEnum<
1520
- typeof GetAgentResponseFormatAgentsType
1521
- > = GetAgentResponseFormatAgentsType$inboundSchema;
1522
-
1523
- /** @internal */
1524
- export const GetAgentResponseFormatJSONObject$inboundSchema: z.ZodType<
1525
- GetAgentResponseFormatJSONObject,
1526
- z.ZodTypeDef,
1527
- unknown
1528
- > = z.object({
1529
- type: GetAgentResponseFormatAgentsType$inboundSchema,
1530
- });
1531
- /** @internal */
1532
- export type GetAgentResponseFormatJSONObject$Outbound = {
1533
- type: string;
1534
- };
1535
-
1536
- /** @internal */
1537
- export const GetAgentResponseFormatJSONObject$outboundSchema: z.ZodType<
1538
- GetAgentResponseFormatJSONObject$Outbound,
1539
- z.ZodTypeDef,
1540
- GetAgentResponseFormatJSONObject
1541
- > = z.object({
1542
- type: GetAgentResponseFormatAgentsType$outboundSchema,
1543
- });
1544
-
1545
- export function getAgentResponseFormatJSONObjectToJSON(
1546
- getAgentResponseFormatJSONObject: GetAgentResponseFormatJSONObject,
1547
- ): string {
1548
- return JSON.stringify(
1549
- GetAgentResponseFormatJSONObject$outboundSchema.parse(
1550
- getAgentResponseFormatJSONObject,
1551
- ),
1552
- );
1553
- }
1554
- export function getAgentResponseFormatJSONObjectFromJSON(
1555
- jsonString: string,
1556
- ): SafeParseResult<GetAgentResponseFormatJSONObject, SDKValidationError> {
1557
- return safeParse(
1558
- jsonString,
1559
- (x) => GetAgentResponseFormatJSONObject$inboundSchema.parse(JSON.parse(x)),
1560
- `Failed to parse 'GetAgentResponseFormatJSONObject' from JSON`,
1561
- );
1562
- }
1563
-
1564
- /** @internal */
1565
- export const GetAgentResponseFormatType$inboundSchema: z.ZodNativeEnum<
1566
- typeof GetAgentResponseFormatType
1567
- > = z.nativeEnum(GetAgentResponseFormatType);
1568
- /** @internal */
1569
- export const GetAgentResponseFormatType$outboundSchema: z.ZodNativeEnum<
1570
- typeof GetAgentResponseFormatType
1571
- > = GetAgentResponseFormatType$inboundSchema;
1572
-
1573
- /** @internal */
1574
- export const GetAgentResponseFormatText$inboundSchema: z.ZodType<
1575
- GetAgentResponseFormatText,
1576
- z.ZodTypeDef,
1577
- unknown
1578
- > = z.object({
1579
- type: GetAgentResponseFormatType$inboundSchema,
1580
- });
1581
- /** @internal */
1582
- export type GetAgentResponseFormatText$Outbound = {
1583
- type: string;
1584
- };
1585
-
1586
- /** @internal */
1587
- export const GetAgentResponseFormatText$outboundSchema: z.ZodType<
1588
- GetAgentResponseFormatText$Outbound,
1589
- z.ZodTypeDef,
1590
- GetAgentResponseFormatText
1591
- > = z.object({
1592
- type: GetAgentResponseFormatType$outboundSchema,
1593
- });
1594
-
1595
- export function getAgentResponseFormatTextToJSON(
1596
- getAgentResponseFormatText: GetAgentResponseFormatText,
1597
- ): string {
1598
- return JSON.stringify(
1599
- GetAgentResponseFormatText$outboundSchema.parse(getAgentResponseFormatText),
1600
- );
1601
- }
1602
- export function getAgentResponseFormatTextFromJSON(
1603
- jsonString: string,
1604
- ): SafeParseResult<GetAgentResponseFormatText, SDKValidationError> {
1605
- return safeParse(
1606
- jsonString,
1607
- (x) => GetAgentResponseFormatText$inboundSchema.parse(JSON.parse(x)),
1608
- `Failed to parse 'GetAgentResponseFormatText' from JSON`,
1609
- );
1610
- }
1611
-
1612
- /** @internal */
1613
- export const GetAgentResponseFormat$inboundSchema: z.ZodType<
1614
- GetAgentResponseFormat,
1615
- z.ZodTypeDef,
1616
- unknown
1617
- > = z.union([
1618
- z.lazy(() => GetAgentResponseFormatAgentsJSONSchema$inboundSchema),
1619
- z.lazy(() => GetAgentResponseFormatText$inboundSchema),
1620
- z.lazy(() => GetAgentResponseFormatJSONObject$inboundSchema),
1621
- ]);
1622
- /** @internal */
1623
- export type GetAgentResponseFormat$Outbound =
1624
- | GetAgentResponseFormatAgentsJSONSchema$Outbound
1625
- | GetAgentResponseFormatText$Outbound
1626
- | GetAgentResponseFormatJSONObject$Outbound;
1627
-
1628
- /** @internal */
1629
- export const GetAgentResponseFormat$outboundSchema: z.ZodType<
1630
- GetAgentResponseFormat$Outbound,
1631
- z.ZodTypeDef,
1632
- GetAgentResponseFormat
1633
- > = z.union([
1634
- z.lazy(() => GetAgentResponseFormatAgentsJSONSchema$outboundSchema),
1635
- z.lazy(() => GetAgentResponseFormatText$outboundSchema),
1636
- z.lazy(() => GetAgentResponseFormatJSONObject$outboundSchema),
1637
- ]);
1638
-
1639
- export function getAgentResponseFormatToJSON(
1640
- getAgentResponseFormat: GetAgentResponseFormat,
1641
- ): string {
1642
- return JSON.stringify(
1643
- GetAgentResponseFormat$outboundSchema.parse(getAgentResponseFormat),
1644
- );
1645
- }
1646
- export function getAgentResponseFormatFromJSON(
1647
- jsonString: string,
1648
- ): SafeParseResult<GetAgentResponseFormat, SDKValidationError> {
1649
- return safeParse(
1650
- jsonString,
1651
- (x) => GetAgentResponseFormat$inboundSchema.parse(JSON.parse(x)),
1652
- `Failed to parse 'GetAgentResponseFormat' from JSON`,
1653
- );
1654
- }
1655
-
1656
- /** @internal */
1657
- export const GetAgentStop$inboundSchema: z.ZodType<
1658
- GetAgentStop,
1659
- z.ZodTypeDef,
1660
- unknown
1661
- > = z.union([z.string(), z.array(z.string())]);
1662
- /** @internal */
1663
- export type GetAgentStop$Outbound = string | Array<string>;
1664
-
1665
- /** @internal */
1666
- export const GetAgentStop$outboundSchema: z.ZodType<
1667
- GetAgentStop$Outbound,
1668
- z.ZodTypeDef,
1669
- GetAgentStop
1670
- > = z.union([z.string(), z.array(z.string())]);
1671
-
1672
- export function getAgentStopToJSON(getAgentStop: GetAgentStop): string {
1673
- return JSON.stringify(GetAgentStop$outboundSchema.parse(getAgentStop));
1674
- }
1675
- export function getAgentStopFromJSON(
1676
- jsonString: string,
1677
- ): SafeParseResult<GetAgentStop, SDKValidationError> {
1678
- return safeParse(
1679
- jsonString,
1680
- (x) => GetAgentStop$inboundSchema.parse(JSON.parse(x)),
1681
- `Failed to parse 'GetAgentStop' from JSON`,
1682
- );
1683
- }
1684
-
1685
- /** @internal */
1686
- export const GetAgentStreamOptions$inboundSchema: z.ZodType<
1687
- GetAgentStreamOptions,
1688
- z.ZodTypeDef,
1689
- unknown
1690
- > = z.object({
1691
- include_usage: z.boolean().optional(),
1692
- }).transform((v) => {
1693
- return remap$(v, {
1694
- "include_usage": "includeUsage",
1695
- });
1696
- });
1697
- /** @internal */
1698
- export type GetAgentStreamOptions$Outbound = {
1699
- include_usage?: boolean | undefined;
1700
- };
1701
-
1702
- /** @internal */
1703
- export const GetAgentStreamOptions$outboundSchema: z.ZodType<
1704
- GetAgentStreamOptions$Outbound,
1705
- z.ZodTypeDef,
1706
- GetAgentStreamOptions
1707
- > = z.object({
1708
- includeUsage: z.boolean().optional(),
1709
- }).transform((v) => {
1710
- return remap$(v, {
1711
- includeUsage: "include_usage",
1712
- });
1713
- });
1714
-
1715
- export function getAgentStreamOptionsToJSON(
1716
- getAgentStreamOptions: GetAgentStreamOptions,
1717
- ): string {
1718
- return JSON.stringify(
1719
- GetAgentStreamOptions$outboundSchema.parse(getAgentStreamOptions),
1720
- );
1721
- }
1722
- export function getAgentStreamOptionsFromJSON(
1723
- jsonString: string,
1724
- ): SafeParseResult<GetAgentStreamOptions, SDKValidationError> {
1725
- return safeParse(
1726
- jsonString,
1727
- (x) => GetAgentStreamOptions$inboundSchema.parse(JSON.parse(x)),
1728
- `Failed to parse 'GetAgentStreamOptions' from JSON`,
1729
- );
1730
- }
1731
-
1732
- /** @internal */
1733
- export const GetAgentType$inboundSchema: z.ZodNativeEnum<typeof GetAgentType> =
1734
- z.nativeEnum(GetAgentType);
1735
- /** @internal */
1736
- export const GetAgentType$outboundSchema: z.ZodNativeEnum<typeof GetAgentType> =
1737
- GetAgentType$inboundSchema;
1738
-
1739
- /** @internal */
1740
- export const GetAgentThinkingLevel$inboundSchema: z.ZodNativeEnum<
1741
- typeof GetAgentThinkingLevel
1742
- > = z.nativeEnum(GetAgentThinkingLevel);
1743
- /** @internal */
1744
- export const GetAgentThinkingLevel$outboundSchema: z.ZodNativeEnum<
1745
- typeof GetAgentThinkingLevel
1746
- > = GetAgentThinkingLevel$inboundSchema;
1747
-
1748
- /** @internal */
1749
- export const GetAgentThinking$inboundSchema: z.ZodType<
1750
- GetAgentThinking,
1751
- z.ZodTypeDef,
1752
- unknown
1753
- > = z.object({
1754
- type: GetAgentType$inboundSchema,
1755
- budget_tokens: z.number(),
1756
- thinking_level: GetAgentThinkingLevel$inboundSchema.optional(),
1757
- }).transform((v) => {
1758
- return remap$(v, {
1759
- "budget_tokens": "budgetTokens",
1760
- "thinking_level": "thinkingLevel",
1761
- });
1762
- });
1763
- /** @internal */
1764
- export type GetAgentThinking$Outbound = {
1765
- type: string;
1766
- budget_tokens: number;
1767
- thinking_level?: string | undefined;
1768
- };
1769
-
1770
- /** @internal */
1771
- export const GetAgentThinking$outboundSchema: z.ZodType<
1772
- GetAgentThinking$Outbound,
1773
- z.ZodTypeDef,
1774
- GetAgentThinking
1775
- > = z.object({
1776
- type: GetAgentType$outboundSchema,
1777
- budgetTokens: z.number(),
1778
- thinkingLevel: GetAgentThinkingLevel$outboundSchema.optional(),
1779
- }).transform((v) => {
1780
- return remap$(v, {
1781
- budgetTokens: "budget_tokens",
1782
- thinkingLevel: "thinking_level",
1783
- });
1784
- });
1785
-
1786
- export function getAgentThinkingToJSON(
1787
- getAgentThinking: GetAgentThinking,
1788
- ): string {
1789
- return JSON.stringify(
1790
- GetAgentThinking$outboundSchema.parse(getAgentThinking),
1791
- );
1792
- }
1793
- export function getAgentThinkingFromJSON(
1794
- jsonString: string,
1795
- ): SafeParseResult<GetAgentThinking, SDKValidationError> {
1796
- return safeParse(
1797
- jsonString,
1798
- (x) => GetAgentThinking$inboundSchema.parse(JSON.parse(x)),
1799
- `Failed to parse 'GetAgentThinking' from JSON`,
1800
- );
1801
- }
1802
-
1803
- /** @internal */
1804
- export const GetAgentToolChoiceType$inboundSchema: z.ZodNativeEnum<
1805
- typeof GetAgentToolChoiceType
1806
- > = z.nativeEnum(GetAgentToolChoiceType);
1807
- /** @internal */
1808
- export const GetAgentToolChoiceType$outboundSchema: z.ZodNativeEnum<
1809
- typeof GetAgentToolChoiceType
1810
- > = GetAgentToolChoiceType$inboundSchema;
1811
-
1812
- /** @internal */
1813
- export const GetAgentToolChoiceFunction$inboundSchema: z.ZodType<
1814
- GetAgentToolChoiceFunction,
1815
- z.ZodTypeDef,
1816
- unknown
1817
- > = z.object({
1818
- name: z.string().optional(),
1819
- });
1820
- /** @internal */
1821
- export type GetAgentToolChoiceFunction$Outbound = {
1822
- name?: string | undefined;
1823
- };
1824
-
1825
- /** @internal */
1826
- export const GetAgentToolChoiceFunction$outboundSchema: z.ZodType<
1827
- GetAgentToolChoiceFunction$Outbound,
1828
- z.ZodTypeDef,
1829
- GetAgentToolChoiceFunction
1830
- > = z.object({
1831
- name: z.string().optional(),
1832
- });
1833
-
1834
- export function getAgentToolChoiceFunctionToJSON(
1835
- getAgentToolChoiceFunction: GetAgentToolChoiceFunction,
1836
- ): string {
1837
- return JSON.stringify(
1838
- GetAgentToolChoiceFunction$outboundSchema.parse(getAgentToolChoiceFunction),
1839
- );
1840
- }
1841
- export function getAgentToolChoiceFunctionFromJSON(
1842
- jsonString: string,
1843
- ): SafeParseResult<GetAgentToolChoiceFunction, SDKValidationError> {
1844
- return safeParse(
1845
- jsonString,
1846
- (x) => GetAgentToolChoiceFunction$inboundSchema.parse(JSON.parse(x)),
1847
- `Failed to parse 'GetAgentToolChoiceFunction' from JSON`,
1848
- );
1849
- }
1850
-
1851
- /** @internal */
1852
- export const GetAgentToolChoice2$inboundSchema: z.ZodType<
1853
- GetAgentToolChoice2,
1854
- z.ZodTypeDef,
1855
- unknown
1856
- > = z.object({
1857
- type: GetAgentToolChoiceType$inboundSchema.optional(),
1858
- function: z.lazy(() => GetAgentToolChoiceFunction$inboundSchema),
1859
- });
1860
- /** @internal */
1861
- export type GetAgentToolChoice2$Outbound = {
1862
- type?: string | undefined;
1863
- function: GetAgentToolChoiceFunction$Outbound;
1864
- };
1865
-
1866
- /** @internal */
1867
- export const GetAgentToolChoice2$outboundSchema: z.ZodType<
1868
- GetAgentToolChoice2$Outbound,
1869
- z.ZodTypeDef,
1870
- GetAgentToolChoice2
1871
- > = z.object({
1872
- type: GetAgentToolChoiceType$outboundSchema.optional(),
1873
- function: z.lazy(() => GetAgentToolChoiceFunction$outboundSchema),
1874
- });
1875
-
1876
- export function getAgentToolChoice2ToJSON(
1877
- getAgentToolChoice2: GetAgentToolChoice2,
1878
- ): string {
1879
- return JSON.stringify(
1880
- GetAgentToolChoice2$outboundSchema.parse(getAgentToolChoice2),
1881
- );
1882
- }
1883
- export function getAgentToolChoice2FromJSON(
1884
- jsonString: string,
1885
- ): SafeParseResult<GetAgentToolChoice2, SDKValidationError> {
1886
- return safeParse(
1887
- jsonString,
1888
- (x) => GetAgentToolChoice2$inboundSchema.parse(JSON.parse(x)),
1889
- `Failed to parse 'GetAgentToolChoice2' from JSON`,
1890
- );
1891
- }
1892
-
1893
- /** @internal */
1894
- export const GetAgentToolChoice1$inboundSchema: z.ZodNativeEnum<
1895
- typeof GetAgentToolChoice1
1896
- > = z.nativeEnum(GetAgentToolChoice1);
1897
- /** @internal */
1898
- export const GetAgentToolChoice1$outboundSchema: z.ZodNativeEnum<
1899
- typeof GetAgentToolChoice1
1900
- > = GetAgentToolChoice1$inboundSchema;
1901
-
1902
- /** @internal */
1903
- export const GetAgentToolChoice$inboundSchema: z.ZodType<
1904
- GetAgentToolChoice,
1905
- z.ZodTypeDef,
1906
- unknown
1907
- > = z.union([
1908
- z.lazy(() => GetAgentToolChoice2$inboundSchema),
1909
- GetAgentToolChoice1$inboundSchema,
1910
- ]);
1911
- /** @internal */
1912
- export type GetAgentToolChoice$Outbound = GetAgentToolChoice2$Outbound | string;
1913
-
1914
- /** @internal */
1915
- export const GetAgentToolChoice$outboundSchema: z.ZodType<
1916
- GetAgentToolChoice$Outbound,
1917
- z.ZodTypeDef,
1918
- GetAgentToolChoice
1919
- > = z.union([
1920
- z.lazy(() => GetAgentToolChoice2$outboundSchema),
1921
- GetAgentToolChoice1$outboundSchema,
1922
- ]);
1923
-
1924
- export function getAgentToolChoiceToJSON(
1925
- getAgentToolChoice: GetAgentToolChoice,
1926
- ): string {
1927
- return JSON.stringify(
1928
- GetAgentToolChoice$outboundSchema.parse(getAgentToolChoice),
1929
- );
1930
- }
1931
- export function getAgentToolChoiceFromJSON(
1932
- jsonString: string,
1933
- ): SafeParseResult<GetAgentToolChoice, SDKValidationError> {
1934
- return safeParse(
1935
- jsonString,
1936
- (x) => GetAgentToolChoice$inboundSchema.parse(JSON.parse(x)),
1937
- `Failed to parse 'GetAgentToolChoice' from JSON`,
1938
- );
1939
- }
1940
-
1941
- /** @internal */
1942
- export const GetAgentModalities$inboundSchema: z.ZodNativeEnum<
1943
- typeof GetAgentModalities
1944
- > = z.nativeEnum(GetAgentModalities);
1945
- /** @internal */
1946
- export const GetAgentModalities$outboundSchema: z.ZodNativeEnum<
1947
- typeof GetAgentModalities
1948
- > = GetAgentModalities$inboundSchema;
1949
-
1950
- /** @internal */
1951
- export const GetAgentParameters$inboundSchema: z.ZodType<
1952
- GetAgentParameters,
1953
- z.ZodTypeDef,
1954
- unknown
1955
- > = z.object({
1956
- audio: z.nullable(z.lazy(() => GetAgentAudio$inboundSchema)).optional(),
1957
- frequency_penalty: z.nullable(z.number()).optional(),
1958
- max_tokens: z.nullable(z.number().int()).optional(),
1959
- max_completion_tokens: z.nullable(z.number().int()).optional(),
1960
- logprobs: z.nullable(z.boolean()).optional(),
1961
- top_logprobs: z.nullable(z.number().int()).optional(),
1962
- n: z.nullable(z.number().int()).optional(),
1963
- presence_penalty: z.nullable(z.number()).optional(),
1964
- response_format: z.union([
1965
- z.lazy(() => GetAgentResponseFormatAgentsJSONSchema$inboundSchema),
1966
- z.lazy(() => GetAgentResponseFormatText$inboundSchema),
1967
- z.lazy(() => GetAgentResponseFormatJSONObject$inboundSchema),
1968
- ]).optional(),
1969
- reasoning_effort: z.string().optional(),
1970
- verbosity: z.string().optional(),
1971
- seed: z.nullable(z.number()).optional(),
1972
- stop: z.nullable(z.union([z.string(), z.array(z.string())])).optional(),
1973
- stream_options: z.nullable(z.lazy(() => GetAgentStreamOptions$inboundSchema))
1974
- .optional(),
1975
- thinking: z.lazy(() => GetAgentThinking$inboundSchema).optional(),
1976
- temperature: z.nullable(z.number()).optional(),
1977
- top_p: z.nullable(z.number()).optional(),
1978
- top_k: z.nullable(z.number()).optional(),
1979
- tool_choice: z.union([
1980
- z.lazy(() => GetAgentToolChoice2$inboundSchema),
1981
- GetAgentToolChoice1$inboundSchema,
1982
- ]).optional(),
1983
- parallel_tool_calls: z.boolean().optional(),
1984
- modalities: z.nullable(z.array(GetAgentModalities$inboundSchema)).optional(),
1985
- }).transform((v) => {
1986
- return remap$(v, {
1987
- "frequency_penalty": "frequencyPenalty",
1988
- "max_tokens": "maxTokens",
1989
- "max_completion_tokens": "maxCompletionTokens",
1990
- "top_logprobs": "topLogprobs",
1991
- "presence_penalty": "presencePenalty",
1992
- "response_format": "responseFormat",
1993
- "reasoning_effort": "reasoningEffort",
1994
- "stream_options": "streamOptions",
1995
- "top_p": "topP",
1996
- "top_k": "topK",
1997
- "tool_choice": "toolChoice",
1998
- "parallel_tool_calls": "parallelToolCalls",
1999
- });
2000
- });
2001
- /** @internal */
2002
- export type GetAgentParameters$Outbound = {
2003
- audio?: GetAgentAudio$Outbound | null | undefined;
2004
- frequency_penalty?: number | null | undefined;
2005
- max_tokens?: number | null | undefined;
2006
- max_completion_tokens?: number | null | undefined;
2007
- logprobs?: boolean | null | undefined;
2008
- top_logprobs?: number | null | undefined;
2009
- n?: number | null | undefined;
2010
- presence_penalty?: number | null | undefined;
2011
- response_format?:
2012
- | GetAgentResponseFormatAgentsJSONSchema$Outbound
2013
- | GetAgentResponseFormatText$Outbound
2014
- | GetAgentResponseFormatJSONObject$Outbound
2015
- | undefined;
2016
- reasoning_effort?: string | undefined;
2017
- verbosity?: string | undefined;
2018
- seed?: number | null | undefined;
2019
- stop?: string | Array<string> | null | undefined;
2020
- stream_options?: GetAgentStreamOptions$Outbound | null | undefined;
2021
- thinking?: GetAgentThinking$Outbound | undefined;
2022
- temperature?: number | null | undefined;
2023
- top_p?: number | null | undefined;
2024
- top_k?: number | null | undefined;
2025
- tool_choice?: GetAgentToolChoice2$Outbound | string | undefined;
2026
- parallel_tool_calls?: boolean | undefined;
2027
- modalities?: Array<string> | null | undefined;
2028
- };
2029
-
2030
- /** @internal */
2031
- export const GetAgentParameters$outboundSchema: z.ZodType<
2032
- GetAgentParameters$Outbound,
2033
- z.ZodTypeDef,
2034
- GetAgentParameters
2035
- > = z.object({
2036
- audio: z.nullable(z.lazy(() => GetAgentAudio$outboundSchema)).optional(),
2037
- frequencyPenalty: z.nullable(z.number()).optional(),
2038
- maxTokens: z.nullable(z.number().int()).optional(),
2039
- maxCompletionTokens: z.nullable(z.number().int()).optional(),
2040
- logprobs: z.nullable(z.boolean()).optional(),
2041
- topLogprobs: z.nullable(z.number().int()).optional(),
2042
- n: z.nullable(z.number().int()).optional(),
2043
- presencePenalty: z.nullable(z.number()).optional(),
2044
- responseFormat: z.union([
2045
- z.lazy(() => GetAgentResponseFormatAgentsJSONSchema$outboundSchema),
2046
- z.lazy(() => GetAgentResponseFormatText$outboundSchema),
2047
- z.lazy(() => GetAgentResponseFormatJSONObject$outboundSchema),
2048
- ]).optional(),
2049
- reasoningEffort: z.string().optional(),
2050
- verbosity: z.string().optional(),
2051
- seed: z.nullable(z.number()).optional(),
2052
- stop: z.nullable(z.union([z.string(), z.array(z.string())])).optional(),
2053
- streamOptions: z.nullable(z.lazy(() => GetAgentStreamOptions$outboundSchema))
2054
- .optional(),
2055
- thinking: z.lazy(() => GetAgentThinking$outboundSchema).optional(),
2056
- temperature: z.nullable(z.number()).optional(),
2057
- topP: z.nullable(z.number()).optional(),
2058
- topK: z.nullable(z.number()).optional(),
2059
- toolChoice: z.union([
2060
- z.lazy(() => GetAgentToolChoice2$outboundSchema),
2061
- GetAgentToolChoice1$outboundSchema,
2062
- ]).optional(),
2063
- parallelToolCalls: z.boolean().optional(),
2064
- modalities: z.nullable(z.array(GetAgentModalities$outboundSchema)).optional(),
2065
- }).transform((v) => {
2066
- return remap$(v, {
2067
- frequencyPenalty: "frequency_penalty",
2068
- maxTokens: "max_tokens",
2069
- maxCompletionTokens: "max_completion_tokens",
2070
- topLogprobs: "top_logprobs",
2071
- presencePenalty: "presence_penalty",
2072
- responseFormat: "response_format",
2073
- reasoningEffort: "reasoning_effort",
2074
- streamOptions: "stream_options",
2075
- topP: "top_p",
2076
- topK: "top_k",
2077
- toolChoice: "tool_choice",
2078
- parallelToolCalls: "parallel_tool_calls",
2079
- });
2080
- });
2081
-
2082
- export function getAgentParametersToJSON(
2083
- getAgentParameters: GetAgentParameters,
2084
- ): string {
2085
- return JSON.stringify(
2086
- GetAgentParameters$outboundSchema.parse(getAgentParameters),
2087
- );
2088
- }
2089
- export function getAgentParametersFromJSON(
2090
- jsonString: string,
2091
- ): SafeParseResult<GetAgentParameters, SDKValidationError> {
2092
- return safeParse(
2093
- jsonString,
2094
- (x) => GetAgentParameters$inboundSchema.parse(JSON.parse(x)),
2095
- `Failed to parse 'GetAgentParameters' from JSON`,
2096
- );
2097
- }
2098
-
2099
- /** @internal */
2100
- export const GetAgentRetry$inboundSchema: z.ZodType<
2101
- GetAgentRetry,
2102
- z.ZodTypeDef,
2103
- unknown
2104
- > = z.object({
2105
- count: z.number().default(3),
2106
- on_codes: z.array(z.number()).optional(),
2107
- }).transform((v) => {
2108
- return remap$(v, {
2109
- "on_codes": "onCodes",
2110
- });
2111
- });
2112
- /** @internal */
2113
- export type GetAgentRetry$Outbound = {
2114
- count: number;
2115
- on_codes?: Array<number> | undefined;
2116
- };
2117
-
2118
- /** @internal */
2119
- export const GetAgentRetry$outboundSchema: z.ZodType<
2120
- GetAgentRetry$Outbound,
2121
- z.ZodTypeDef,
2122
- GetAgentRetry
2123
- > = z.object({
2124
- count: z.number().default(3),
2125
- onCodes: z.array(z.number()).optional(),
2126
- }).transform((v) => {
2127
- return remap$(v, {
2128
- onCodes: "on_codes",
2129
- });
2130
- });
2131
-
2132
- export function getAgentRetryToJSON(getAgentRetry: GetAgentRetry): string {
2133
- return JSON.stringify(GetAgentRetry$outboundSchema.parse(getAgentRetry));
2134
- }
2135
- export function getAgentRetryFromJSON(
2136
- jsonString: string,
2137
- ): SafeParseResult<GetAgentRetry, SDKValidationError> {
2138
- return safeParse(
2139
- jsonString,
2140
- (x) => GetAgentRetry$inboundSchema.parse(JSON.parse(x)),
2141
- `Failed to parse 'GetAgentRetry' from JSON`,
2142
- );
2143
- }
2144
-
2145
- /** @internal */
2146
- export const GetAgentFallbackModelConfigurationVoice$inboundSchema:
2147
- z.ZodNativeEnum<typeof GetAgentFallbackModelConfigurationVoice> = z
2148
- .nativeEnum(GetAgentFallbackModelConfigurationVoice);
2149
- /** @internal */
2150
- export const GetAgentFallbackModelConfigurationVoice$outboundSchema:
2151
- z.ZodNativeEnum<typeof GetAgentFallbackModelConfigurationVoice> =
2152
- GetAgentFallbackModelConfigurationVoice$inboundSchema;
2153
-
2154
- /** @internal */
2155
- export const GetAgentFallbackModelConfigurationFormat$inboundSchema:
2156
- z.ZodNativeEnum<typeof GetAgentFallbackModelConfigurationFormat> = z
2157
- .nativeEnum(GetAgentFallbackModelConfigurationFormat);
2158
- /** @internal */
2159
- export const GetAgentFallbackModelConfigurationFormat$outboundSchema:
2160
- z.ZodNativeEnum<typeof GetAgentFallbackModelConfigurationFormat> =
2161
- GetAgentFallbackModelConfigurationFormat$inboundSchema;
2162
-
2163
- /** @internal */
2164
- export const GetAgentFallbackModelConfigurationAudio$inboundSchema: z.ZodType<
2165
- GetAgentFallbackModelConfigurationAudio,
2166
- z.ZodTypeDef,
2167
- unknown
2168
- > = z.object({
2169
- voice: GetAgentFallbackModelConfigurationVoice$inboundSchema,
2170
- format: GetAgentFallbackModelConfigurationFormat$inboundSchema,
2171
- });
2172
- /** @internal */
2173
- export type GetAgentFallbackModelConfigurationAudio$Outbound = {
2174
- voice: string;
2175
- format: string;
2176
- };
2177
-
2178
- /** @internal */
2179
- export const GetAgentFallbackModelConfigurationAudio$outboundSchema: z.ZodType<
2180
- GetAgentFallbackModelConfigurationAudio$Outbound,
2181
- z.ZodTypeDef,
2182
- GetAgentFallbackModelConfigurationAudio
2183
- > = z.object({
2184
- voice: GetAgentFallbackModelConfigurationVoice$outboundSchema,
2185
- format: GetAgentFallbackModelConfigurationFormat$outboundSchema,
2186
- });
2187
-
2188
- export function getAgentFallbackModelConfigurationAudioToJSON(
2189
- getAgentFallbackModelConfigurationAudio:
2190
- GetAgentFallbackModelConfigurationAudio,
2191
- ): string {
2192
- return JSON.stringify(
2193
- GetAgentFallbackModelConfigurationAudio$outboundSchema.parse(
2194
- getAgentFallbackModelConfigurationAudio,
2195
- ),
2196
- );
2197
- }
2198
- export function getAgentFallbackModelConfigurationAudioFromJSON(
2199
- jsonString: string,
2200
- ): SafeParseResult<
2201
- GetAgentFallbackModelConfigurationAudio,
2202
- SDKValidationError
2203
- > {
2204
- return safeParse(
2205
- jsonString,
2206
- (x) =>
2207
- GetAgentFallbackModelConfigurationAudio$inboundSchema.parse(
2208
- JSON.parse(x),
2209
- ),
2210
- `Failed to parse 'GetAgentFallbackModelConfigurationAudio' from JSON`,
2211
- );
2212
- }
2213
-
2214
- /** @internal */
2215
- export const GetAgentResponseFormatAgentsResponse200ApplicationJSONResponseBodyType$inboundSchema:
2216
- z.ZodNativeEnum<
2217
- typeof GetAgentResponseFormatAgentsResponse200ApplicationJSONResponseBodyType
2218
- > = z.nativeEnum(
2219
- GetAgentResponseFormatAgentsResponse200ApplicationJSONResponseBodyType,
2220
- );
2221
- /** @internal */
2222
- export const GetAgentResponseFormatAgentsResponse200ApplicationJSONResponseBodyType$outboundSchema:
2223
- z.ZodNativeEnum<
2224
- typeof GetAgentResponseFormatAgentsResponse200ApplicationJSONResponseBodyType
2225
- > =
2226
- GetAgentResponseFormatAgentsResponse200ApplicationJSONResponseBodyType$inboundSchema;
2227
-
2228
- /** @internal */
2229
- export const GetAgentResponseFormatAgentsResponseJsonSchema$inboundSchema:
2230
- z.ZodType<
2231
- GetAgentResponseFormatAgentsResponseJsonSchema,
2232
- z.ZodTypeDef,
2233
- unknown
2234
- > = z.object({
2235
- description: z.string().optional(),
2236
- name: z.string(),
2237
- schema: z.any().optional(),
2238
- strict: z.nullable(z.boolean()).optional(),
2239
- });
2240
- /** @internal */
2241
- export type GetAgentResponseFormatAgentsResponseJsonSchema$Outbound = {
2242
- description?: string | undefined;
2243
- name: string;
2244
- schema?: any | undefined;
2245
- strict?: boolean | null | undefined;
2246
- };
2247
-
2248
- /** @internal */
2249
- export const GetAgentResponseFormatAgentsResponseJsonSchema$outboundSchema:
2250
- z.ZodType<
2251
- GetAgentResponseFormatAgentsResponseJsonSchema$Outbound,
2252
- z.ZodTypeDef,
2253
- GetAgentResponseFormatAgentsResponseJsonSchema
2254
- > = z.object({
2255
- description: z.string().optional(),
2256
- name: z.string(),
2257
- schema: z.any().optional(),
2258
- strict: z.nullable(z.boolean()).optional(),
2259
- });
2260
-
2261
- export function getAgentResponseFormatAgentsResponseJsonSchemaToJSON(
2262
- getAgentResponseFormatAgentsResponseJsonSchema:
2263
- GetAgentResponseFormatAgentsResponseJsonSchema,
2264
- ): string {
2265
- return JSON.stringify(
2266
- GetAgentResponseFormatAgentsResponseJsonSchema$outboundSchema.parse(
2267
- getAgentResponseFormatAgentsResponseJsonSchema,
2268
- ),
2269
- );
2270
- }
2271
- export function getAgentResponseFormatAgentsResponseJsonSchemaFromJSON(
2272
- jsonString: string,
2273
- ): SafeParseResult<
2274
- GetAgentResponseFormatAgentsResponseJsonSchema,
2275
- SDKValidationError
2276
- > {
2277
- return safeParse(
2278
- jsonString,
2279
- (x) =>
2280
- GetAgentResponseFormatAgentsResponseJsonSchema$inboundSchema.parse(
2281
- JSON.parse(x),
2282
- ),
2283
- `Failed to parse 'GetAgentResponseFormatAgentsResponseJsonSchema' from JSON`,
2284
- );
2285
- }
2286
-
2287
- /** @internal */
2288
- export const GetAgentResponseFormatAgentsResponse200JSONSchema$inboundSchema:
2289
- z.ZodType<
2290
- GetAgentResponseFormatAgentsResponse200JSONSchema,
2291
- z.ZodTypeDef,
2292
- unknown
2293
- > = z.object({
2294
- type:
2295
- GetAgentResponseFormatAgentsResponse200ApplicationJSONResponseBodyType$inboundSchema,
2296
- json_schema: z.lazy(() =>
2297
- GetAgentResponseFormatAgentsResponseJsonSchema$inboundSchema
2298
- ),
2299
- }).transform((v) => {
2300
- return remap$(v, {
2301
- "json_schema": "jsonSchema",
2302
- });
2303
- });
2304
- /** @internal */
2305
- export type GetAgentResponseFormatAgentsResponse200JSONSchema$Outbound = {
2306
- type: string;
2307
- json_schema: GetAgentResponseFormatAgentsResponseJsonSchema$Outbound;
2308
- };
2309
-
2310
- /** @internal */
2311
- export const GetAgentResponseFormatAgentsResponse200JSONSchema$outboundSchema:
2312
- z.ZodType<
2313
- GetAgentResponseFormatAgentsResponse200JSONSchema$Outbound,
2314
- z.ZodTypeDef,
2315
- GetAgentResponseFormatAgentsResponse200JSONSchema
2316
- > = z.object({
2317
- type:
2318
- GetAgentResponseFormatAgentsResponse200ApplicationJSONResponseBodyType$outboundSchema,
2319
- jsonSchema: z.lazy(() =>
2320
- GetAgentResponseFormatAgentsResponseJsonSchema$outboundSchema
2321
- ),
2322
- }).transform((v) => {
2323
- return remap$(v, {
2324
- jsonSchema: "json_schema",
2325
- });
2326
- });
2327
-
2328
- export function getAgentResponseFormatAgentsResponse200JSONSchemaToJSON(
2329
- getAgentResponseFormatAgentsResponse200JSONSchema:
2330
- GetAgentResponseFormatAgentsResponse200JSONSchema,
2331
- ): string {
2332
- return JSON.stringify(
2333
- GetAgentResponseFormatAgentsResponse200JSONSchema$outboundSchema.parse(
2334
- getAgentResponseFormatAgentsResponse200JSONSchema,
2335
- ),
2336
- );
2337
- }
2338
- export function getAgentResponseFormatAgentsResponse200JSONSchemaFromJSON(
2339
- jsonString: string,
2340
- ): SafeParseResult<
2341
- GetAgentResponseFormatAgentsResponse200JSONSchema,
2342
- SDKValidationError
2343
- > {
2344
- return safeParse(
2345
- jsonString,
2346
- (x) =>
2347
- GetAgentResponseFormatAgentsResponse200JSONSchema$inboundSchema.parse(
2348
- JSON.parse(x),
2349
- ),
2350
- `Failed to parse 'GetAgentResponseFormatAgentsResponse200JSONSchema' from JSON`,
2351
- );
2352
- }
2353
-
2354
- /** @internal */
2355
- export const GetAgentResponseFormatAgentsResponse200ApplicationJSONType$inboundSchema:
2356
- z.ZodNativeEnum<
2357
- typeof GetAgentResponseFormatAgentsResponse200ApplicationJSONType
2358
- > = z.nativeEnum(GetAgentResponseFormatAgentsResponse200ApplicationJSONType);
2359
- /** @internal */
2360
- export const GetAgentResponseFormatAgentsResponse200ApplicationJSONType$outboundSchema:
2361
- z.ZodNativeEnum<
2362
- typeof GetAgentResponseFormatAgentsResponse200ApplicationJSONType
2363
- > = GetAgentResponseFormatAgentsResponse200ApplicationJSONType$inboundSchema;
2364
-
2365
- /** @internal */
2366
- export const GetAgentResponseFormatAgentsJSONObject$inboundSchema: z.ZodType<
2367
- GetAgentResponseFormatAgentsJSONObject,
2368
- z.ZodTypeDef,
2369
- unknown
2370
- > = z.object({
2371
- type:
2372
- GetAgentResponseFormatAgentsResponse200ApplicationJSONType$inboundSchema,
2373
- });
2374
- /** @internal */
2375
- export type GetAgentResponseFormatAgentsJSONObject$Outbound = {
2376
- type: string;
2377
- };
2378
-
2379
- /** @internal */
2380
- export const GetAgentResponseFormatAgentsJSONObject$outboundSchema: z.ZodType<
2381
- GetAgentResponseFormatAgentsJSONObject$Outbound,
2382
- z.ZodTypeDef,
2383
- GetAgentResponseFormatAgentsJSONObject
2384
- > = z.object({
2385
- type:
2386
- GetAgentResponseFormatAgentsResponse200ApplicationJSONType$outboundSchema,
2387
- });
2388
-
2389
- export function getAgentResponseFormatAgentsJSONObjectToJSON(
2390
- getAgentResponseFormatAgentsJSONObject:
2391
- GetAgentResponseFormatAgentsJSONObject,
2392
- ): string {
2393
- return JSON.stringify(
2394
- GetAgentResponseFormatAgentsJSONObject$outboundSchema.parse(
2395
- getAgentResponseFormatAgentsJSONObject,
2396
- ),
2397
- );
2398
- }
2399
- export function getAgentResponseFormatAgentsJSONObjectFromJSON(
2400
- jsonString: string,
2401
- ): SafeParseResult<GetAgentResponseFormatAgentsJSONObject, SDKValidationError> {
2402
- return safeParse(
2403
- jsonString,
2404
- (x) =>
2405
- GetAgentResponseFormatAgentsJSONObject$inboundSchema.parse(JSON.parse(x)),
2406
- `Failed to parse 'GetAgentResponseFormatAgentsJSONObject' from JSON`,
2407
- );
2408
- }
2409
-
2410
- /** @internal */
2411
- export const GetAgentResponseFormatAgentsResponse200Type$inboundSchema:
2412
- z.ZodNativeEnum<typeof GetAgentResponseFormatAgentsResponse200Type> = z
2413
- .nativeEnum(GetAgentResponseFormatAgentsResponse200Type);
2414
- /** @internal */
2415
- export const GetAgentResponseFormatAgentsResponse200Type$outboundSchema:
2416
- z.ZodNativeEnum<typeof GetAgentResponseFormatAgentsResponse200Type> =
2417
- GetAgentResponseFormatAgentsResponse200Type$inboundSchema;
2418
-
2419
- /** @internal */
2420
- export const GetAgentResponseFormatAgentsText$inboundSchema: z.ZodType<
2421
- GetAgentResponseFormatAgentsText,
2422
- z.ZodTypeDef,
2423
- unknown
2424
- > = z.object({
2425
- type: GetAgentResponseFormatAgentsResponse200Type$inboundSchema,
2426
- });
2427
- /** @internal */
2428
- export type GetAgentResponseFormatAgentsText$Outbound = {
2429
- type: string;
2430
- };
2431
-
2432
- /** @internal */
2433
- export const GetAgentResponseFormatAgentsText$outboundSchema: z.ZodType<
2434
- GetAgentResponseFormatAgentsText$Outbound,
2435
- z.ZodTypeDef,
2436
- GetAgentResponseFormatAgentsText
2437
- > = z.object({
2438
- type: GetAgentResponseFormatAgentsResponse200Type$outboundSchema,
2439
- });
2440
-
2441
- export function getAgentResponseFormatAgentsTextToJSON(
2442
- getAgentResponseFormatAgentsText: GetAgentResponseFormatAgentsText,
2443
- ): string {
2444
- return JSON.stringify(
2445
- GetAgentResponseFormatAgentsText$outboundSchema.parse(
2446
- getAgentResponseFormatAgentsText,
2447
- ),
2448
- );
2449
- }
2450
- export function getAgentResponseFormatAgentsTextFromJSON(
2451
- jsonString: string,
2452
- ): SafeParseResult<GetAgentResponseFormatAgentsText, SDKValidationError> {
2453
- return safeParse(
2454
- jsonString,
2455
- (x) => GetAgentResponseFormatAgentsText$inboundSchema.parse(JSON.parse(x)),
2456
- `Failed to parse 'GetAgentResponseFormatAgentsText' from JSON`,
2457
- );
2458
- }
2459
-
2460
- /** @internal */
2461
- export const GetAgentFallbackModelConfigurationResponseFormat$inboundSchema:
2462
- z.ZodType<
2463
- GetAgentFallbackModelConfigurationResponseFormat,
2464
- z.ZodTypeDef,
2465
- unknown
2466
- > = z.union([
2467
- z.lazy(() =>
2468
- GetAgentResponseFormatAgentsResponse200JSONSchema$inboundSchema
2469
- ),
2470
- z.lazy(() => GetAgentResponseFormatAgentsText$inboundSchema),
2471
- z.lazy(() => GetAgentResponseFormatAgentsJSONObject$inboundSchema),
2472
- ]);
2473
- /** @internal */
2474
- export type GetAgentFallbackModelConfigurationResponseFormat$Outbound =
2475
- | GetAgentResponseFormatAgentsResponse200JSONSchema$Outbound
2476
- | GetAgentResponseFormatAgentsText$Outbound
2477
- | GetAgentResponseFormatAgentsJSONObject$Outbound;
2478
-
2479
- /** @internal */
2480
- export const GetAgentFallbackModelConfigurationResponseFormat$outboundSchema:
2481
- z.ZodType<
2482
- GetAgentFallbackModelConfigurationResponseFormat$Outbound,
2483
- z.ZodTypeDef,
2484
- GetAgentFallbackModelConfigurationResponseFormat
2485
- > = z.union([
2486
- z.lazy(() =>
2487
- GetAgentResponseFormatAgentsResponse200JSONSchema$outboundSchema
2488
- ),
2489
- z.lazy(() => GetAgentResponseFormatAgentsText$outboundSchema),
2490
- z.lazy(() => GetAgentResponseFormatAgentsJSONObject$outboundSchema),
2491
- ]);
2492
-
2493
- export function getAgentFallbackModelConfigurationResponseFormatToJSON(
2494
- getAgentFallbackModelConfigurationResponseFormat:
2495
- GetAgentFallbackModelConfigurationResponseFormat,
2496
- ): string {
2497
- return JSON.stringify(
2498
- GetAgentFallbackModelConfigurationResponseFormat$outboundSchema.parse(
2499
- getAgentFallbackModelConfigurationResponseFormat,
2500
- ),
2501
- );
2502
- }
2503
- export function getAgentFallbackModelConfigurationResponseFormatFromJSON(
2504
- jsonString: string,
2505
- ): SafeParseResult<
2506
- GetAgentFallbackModelConfigurationResponseFormat,
2507
- SDKValidationError
2508
- > {
2509
- return safeParse(
2510
- jsonString,
2511
- (x) =>
2512
- GetAgentFallbackModelConfigurationResponseFormat$inboundSchema.parse(
2513
- JSON.parse(x),
2514
- ),
2515
- `Failed to parse 'GetAgentFallbackModelConfigurationResponseFormat' from JSON`,
2516
- );
2517
- }
2518
-
2519
- /** @internal */
2520
- export const GetAgentFallbackModelConfigurationStop$inboundSchema: z.ZodType<
2521
- GetAgentFallbackModelConfigurationStop,
2522
- z.ZodTypeDef,
2523
- unknown
2524
- > = z.union([z.string(), z.array(z.string())]);
2525
- /** @internal */
2526
- export type GetAgentFallbackModelConfigurationStop$Outbound =
2527
- | string
2528
- | Array<string>;
2529
-
2530
- /** @internal */
2531
- export const GetAgentFallbackModelConfigurationStop$outboundSchema: z.ZodType<
2532
- GetAgentFallbackModelConfigurationStop$Outbound,
2533
- z.ZodTypeDef,
2534
- GetAgentFallbackModelConfigurationStop
2535
- > = z.union([z.string(), z.array(z.string())]);
2536
-
2537
- export function getAgentFallbackModelConfigurationStopToJSON(
2538
- getAgentFallbackModelConfigurationStop:
2539
- GetAgentFallbackModelConfigurationStop,
2540
- ): string {
2541
- return JSON.stringify(
2542
- GetAgentFallbackModelConfigurationStop$outboundSchema.parse(
2543
- getAgentFallbackModelConfigurationStop,
2544
- ),
2545
- );
2546
- }
2547
- export function getAgentFallbackModelConfigurationStopFromJSON(
2548
- jsonString: string,
2549
- ): SafeParseResult<GetAgentFallbackModelConfigurationStop, SDKValidationError> {
2550
- return safeParse(
2551
- jsonString,
2552
- (x) =>
2553
- GetAgentFallbackModelConfigurationStop$inboundSchema.parse(JSON.parse(x)),
2554
- `Failed to parse 'GetAgentFallbackModelConfigurationStop' from JSON`,
2555
- );
2556
- }
2557
-
2558
- /** @internal */
2559
- export const GetAgentFallbackModelConfigurationStreamOptions$inboundSchema:
2560
- z.ZodType<
2561
- GetAgentFallbackModelConfigurationStreamOptions,
2562
- z.ZodTypeDef,
2563
- unknown
2564
- > = z.object({
2565
- include_usage: z.boolean().optional(),
2566
- }).transform((v) => {
2567
- return remap$(v, {
2568
- "include_usage": "includeUsage",
2569
- });
2570
- });
2571
- /** @internal */
2572
- export type GetAgentFallbackModelConfigurationStreamOptions$Outbound = {
2573
- include_usage?: boolean | undefined;
2574
- };
2575
-
2576
- /** @internal */
2577
- export const GetAgentFallbackModelConfigurationStreamOptions$outboundSchema:
2578
- z.ZodType<
2579
- GetAgentFallbackModelConfigurationStreamOptions$Outbound,
2580
- z.ZodTypeDef,
2581
- GetAgentFallbackModelConfigurationStreamOptions
2582
- > = z.object({
2583
- includeUsage: z.boolean().optional(),
2584
- }).transform((v) => {
2585
- return remap$(v, {
2586
- includeUsage: "include_usage",
2587
- });
2588
- });
2589
-
2590
- export function getAgentFallbackModelConfigurationStreamOptionsToJSON(
2591
- getAgentFallbackModelConfigurationStreamOptions:
2592
- GetAgentFallbackModelConfigurationStreamOptions,
2593
- ): string {
2594
- return JSON.stringify(
2595
- GetAgentFallbackModelConfigurationStreamOptions$outboundSchema.parse(
2596
- getAgentFallbackModelConfigurationStreamOptions,
2597
- ),
2598
- );
2599
- }
2600
- export function getAgentFallbackModelConfigurationStreamOptionsFromJSON(
2601
- jsonString: string,
2602
- ): SafeParseResult<
2603
- GetAgentFallbackModelConfigurationStreamOptions,
2604
- SDKValidationError
2605
- > {
2606
- return safeParse(
2607
- jsonString,
2608
- (x) =>
2609
- GetAgentFallbackModelConfigurationStreamOptions$inboundSchema.parse(
2610
- JSON.parse(x),
2611
- ),
2612
- `Failed to parse 'GetAgentFallbackModelConfigurationStreamOptions' from JSON`,
2613
- );
2614
- }
2615
-
2616
- /** @internal */
2617
- export const GetAgentFallbackModelConfigurationType$inboundSchema:
2618
- z.ZodNativeEnum<typeof GetAgentFallbackModelConfigurationType> = z.nativeEnum(
2619
- GetAgentFallbackModelConfigurationType,
2620
- );
2621
- /** @internal */
2622
- export const GetAgentFallbackModelConfigurationType$outboundSchema:
2623
- z.ZodNativeEnum<typeof GetAgentFallbackModelConfigurationType> =
2624
- GetAgentFallbackModelConfigurationType$inboundSchema;
2625
-
2626
- /** @internal */
2627
- export const GetAgentFallbackModelConfigurationThinkingLevel$inboundSchema:
2628
- z.ZodNativeEnum<typeof GetAgentFallbackModelConfigurationThinkingLevel> = z
2629
- .nativeEnum(GetAgentFallbackModelConfigurationThinkingLevel);
2630
- /** @internal */
2631
- export const GetAgentFallbackModelConfigurationThinkingLevel$outboundSchema:
2632
- z.ZodNativeEnum<typeof GetAgentFallbackModelConfigurationThinkingLevel> =
2633
- GetAgentFallbackModelConfigurationThinkingLevel$inboundSchema;
2634
-
2635
- /** @internal */
2636
- export const GetAgentFallbackModelConfigurationThinking$inboundSchema:
2637
- z.ZodType<GetAgentFallbackModelConfigurationThinking, z.ZodTypeDef, unknown> =
2638
- z.object({
2639
- type: GetAgentFallbackModelConfigurationType$inboundSchema,
2640
- budget_tokens: z.number(),
2641
- thinking_level:
2642
- GetAgentFallbackModelConfigurationThinkingLevel$inboundSchema
2643
- .optional(),
2644
- }).transform((v) => {
2645
- return remap$(v, {
2646
- "budget_tokens": "budgetTokens",
2647
- "thinking_level": "thinkingLevel",
2648
- });
2649
- });
2650
- /** @internal */
2651
- export type GetAgentFallbackModelConfigurationThinking$Outbound = {
2652
- type: string;
2653
- budget_tokens: number;
2654
- thinking_level?: string | undefined;
2655
- };
2656
-
2657
- /** @internal */
2658
- export const GetAgentFallbackModelConfigurationThinking$outboundSchema:
2659
- z.ZodType<
2660
- GetAgentFallbackModelConfigurationThinking$Outbound,
2661
- z.ZodTypeDef,
2662
- GetAgentFallbackModelConfigurationThinking
2663
- > = z.object({
2664
- type: GetAgentFallbackModelConfigurationType$outboundSchema,
2665
- budgetTokens: z.number(),
2666
- thinkingLevel:
2667
- GetAgentFallbackModelConfigurationThinkingLevel$outboundSchema.optional(),
2668
- }).transform((v) => {
2669
- return remap$(v, {
2670
- budgetTokens: "budget_tokens",
2671
- thinkingLevel: "thinking_level",
2672
- });
2673
- });
2674
-
2675
- export function getAgentFallbackModelConfigurationThinkingToJSON(
2676
- getAgentFallbackModelConfigurationThinking:
2677
- GetAgentFallbackModelConfigurationThinking,
2678
- ): string {
2679
- return JSON.stringify(
2680
- GetAgentFallbackModelConfigurationThinking$outboundSchema.parse(
2681
- getAgentFallbackModelConfigurationThinking,
2682
- ),
2683
- );
2684
- }
2685
- export function getAgentFallbackModelConfigurationThinkingFromJSON(
2686
- jsonString: string,
2687
- ): SafeParseResult<
2688
- GetAgentFallbackModelConfigurationThinking,
2689
- SDKValidationError
2690
- > {
2691
- return safeParse(
2692
- jsonString,
2693
- (x) =>
2694
- GetAgentFallbackModelConfigurationThinking$inboundSchema.parse(
2695
- JSON.parse(x),
2696
- ),
2697
- `Failed to parse 'GetAgentFallbackModelConfigurationThinking' from JSON`,
2698
- );
2699
- }
2700
-
2701
- /** @internal */
2702
- export const GetAgentToolChoiceAgentsType$inboundSchema: z.ZodNativeEnum<
2703
- typeof GetAgentToolChoiceAgentsType
2704
- > = z.nativeEnum(GetAgentToolChoiceAgentsType);
2705
- /** @internal */
2706
- export const GetAgentToolChoiceAgentsType$outboundSchema: z.ZodNativeEnum<
2707
- typeof GetAgentToolChoiceAgentsType
2708
- > = GetAgentToolChoiceAgentsType$inboundSchema;
2709
-
2710
- /** @internal */
2711
- export const GetAgentToolChoiceAgentsFunction$inboundSchema: z.ZodType<
2712
- GetAgentToolChoiceAgentsFunction,
2713
- z.ZodTypeDef,
2714
- unknown
2715
- > = z.object({
2716
- name: z.string().optional(),
2717
- });
2718
- /** @internal */
2719
- export type GetAgentToolChoiceAgentsFunction$Outbound = {
2720
- name?: string | undefined;
2721
- };
2722
-
2723
- /** @internal */
2724
- export const GetAgentToolChoiceAgentsFunction$outboundSchema: z.ZodType<
2725
- GetAgentToolChoiceAgentsFunction$Outbound,
2726
- z.ZodTypeDef,
2727
- GetAgentToolChoiceAgentsFunction
2728
- > = z.object({
2729
- name: z.string().optional(),
2730
- });
2731
-
2732
- export function getAgentToolChoiceAgentsFunctionToJSON(
2733
- getAgentToolChoiceAgentsFunction: GetAgentToolChoiceAgentsFunction,
2734
- ): string {
2735
- return JSON.stringify(
2736
- GetAgentToolChoiceAgentsFunction$outboundSchema.parse(
2737
- getAgentToolChoiceAgentsFunction,
2738
- ),
2739
- );
2740
- }
2741
- export function getAgentToolChoiceAgentsFunctionFromJSON(
2742
- jsonString: string,
2743
- ): SafeParseResult<GetAgentToolChoiceAgentsFunction, SDKValidationError> {
2744
- return safeParse(
2745
- jsonString,
2746
- (x) => GetAgentToolChoiceAgentsFunction$inboundSchema.parse(JSON.parse(x)),
2747
- `Failed to parse 'GetAgentToolChoiceAgentsFunction' from JSON`,
2748
- );
2749
- }
2750
-
2751
- /** @internal */
2752
- export const GetAgentToolChoiceAgents2$inboundSchema: z.ZodType<
2753
- GetAgentToolChoiceAgents2,
2754
- z.ZodTypeDef,
2755
- unknown
2756
- > = z.object({
2757
- type: GetAgentToolChoiceAgentsType$inboundSchema.optional(),
2758
- function: z.lazy(() => GetAgentToolChoiceAgentsFunction$inboundSchema),
2759
- });
2760
- /** @internal */
2761
- export type GetAgentToolChoiceAgents2$Outbound = {
2762
- type?: string | undefined;
2763
- function: GetAgentToolChoiceAgentsFunction$Outbound;
2764
- };
2765
-
2766
- /** @internal */
2767
- export const GetAgentToolChoiceAgents2$outboundSchema: z.ZodType<
2768
- GetAgentToolChoiceAgents2$Outbound,
2769
- z.ZodTypeDef,
2770
- GetAgentToolChoiceAgents2
2771
- > = z.object({
2772
- type: GetAgentToolChoiceAgentsType$outboundSchema.optional(),
2773
- function: z.lazy(() => GetAgentToolChoiceAgentsFunction$outboundSchema),
2774
- });
2775
-
2776
- export function getAgentToolChoiceAgents2ToJSON(
2777
- getAgentToolChoiceAgents2: GetAgentToolChoiceAgents2,
2778
- ): string {
2779
- return JSON.stringify(
2780
- GetAgentToolChoiceAgents2$outboundSchema.parse(getAgentToolChoiceAgents2),
2781
- );
2782
- }
2783
- export function getAgentToolChoiceAgents2FromJSON(
2784
- jsonString: string,
2785
- ): SafeParseResult<GetAgentToolChoiceAgents2, SDKValidationError> {
2786
- return safeParse(
2787
- jsonString,
2788
- (x) => GetAgentToolChoiceAgents2$inboundSchema.parse(JSON.parse(x)),
2789
- `Failed to parse 'GetAgentToolChoiceAgents2' from JSON`,
2790
- );
2791
- }
2792
-
2793
- /** @internal */
2794
- export const GetAgentToolChoiceAgents1$inboundSchema: z.ZodNativeEnum<
2795
- typeof GetAgentToolChoiceAgents1
2796
- > = z.nativeEnum(GetAgentToolChoiceAgents1);
2797
- /** @internal */
2798
- export const GetAgentToolChoiceAgents1$outboundSchema: z.ZodNativeEnum<
2799
- typeof GetAgentToolChoiceAgents1
2800
- > = GetAgentToolChoiceAgents1$inboundSchema;
2801
-
2802
- /** @internal */
2803
- export const GetAgentFallbackModelConfigurationToolChoice$inboundSchema:
2804
- z.ZodType<
2805
- GetAgentFallbackModelConfigurationToolChoice,
2806
- z.ZodTypeDef,
2807
- unknown
2808
- > = z.union([
2809
- z.lazy(() => GetAgentToolChoiceAgents2$inboundSchema),
2810
- GetAgentToolChoiceAgents1$inboundSchema,
2811
- ]);
2812
- /** @internal */
2813
- export type GetAgentFallbackModelConfigurationToolChoice$Outbound =
2814
- | GetAgentToolChoiceAgents2$Outbound
2815
- | string;
2816
-
2817
- /** @internal */
2818
- export const GetAgentFallbackModelConfigurationToolChoice$outboundSchema:
2819
- z.ZodType<
2820
- GetAgentFallbackModelConfigurationToolChoice$Outbound,
2821
- z.ZodTypeDef,
2822
- GetAgentFallbackModelConfigurationToolChoice
2823
- > = z.union([
2824
- z.lazy(() => GetAgentToolChoiceAgents2$outboundSchema),
2825
- GetAgentToolChoiceAgents1$outboundSchema,
2826
- ]);
2827
-
2828
- export function getAgentFallbackModelConfigurationToolChoiceToJSON(
2829
- getAgentFallbackModelConfigurationToolChoice:
2830
- GetAgentFallbackModelConfigurationToolChoice,
2831
- ): string {
2832
- return JSON.stringify(
2833
- GetAgentFallbackModelConfigurationToolChoice$outboundSchema.parse(
2834
- getAgentFallbackModelConfigurationToolChoice,
2835
- ),
2836
- );
2837
- }
2838
- export function getAgentFallbackModelConfigurationToolChoiceFromJSON(
2839
- jsonString: string,
2840
- ): SafeParseResult<
2841
- GetAgentFallbackModelConfigurationToolChoice,
2842
- SDKValidationError
2843
- > {
2844
- return safeParse(
2845
- jsonString,
2846
- (x) =>
2847
- GetAgentFallbackModelConfigurationToolChoice$inboundSchema.parse(
2848
- JSON.parse(x),
2849
- ),
2850
- `Failed to parse 'GetAgentFallbackModelConfigurationToolChoice' from JSON`,
2851
- );
2852
- }
2853
-
2854
- /** @internal */
2855
- export const GetAgentFallbackModelConfigurationModalities$inboundSchema:
2856
- z.ZodNativeEnum<typeof GetAgentFallbackModelConfigurationModalities> = z
2857
- .nativeEnum(GetAgentFallbackModelConfigurationModalities);
2858
- /** @internal */
2859
- export const GetAgentFallbackModelConfigurationModalities$outboundSchema:
2860
- z.ZodNativeEnum<typeof GetAgentFallbackModelConfigurationModalities> =
2861
- GetAgentFallbackModelConfigurationModalities$inboundSchema;
2862
-
2863
- /** @internal */
2864
- export const GetAgentFallbackModelConfigurationParameters$inboundSchema:
2865
- z.ZodType<
2866
- GetAgentFallbackModelConfigurationParameters,
2867
- z.ZodTypeDef,
2868
- unknown
2869
- > = z.object({
2870
- audio: z.nullable(
2871
- z.lazy(() => GetAgentFallbackModelConfigurationAudio$inboundSchema),
2872
- ).optional(),
2873
- frequency_penalty: z.nullable(z.number()).optional(),
2874
- max_tokens: z.nullable(z.number().int()).optional(),
2875
- max_completion_tokens: z.nullable(z.number().int()).optional(),
2876
- logprobs: z.nullable(z.boolean()).optional(),
2877
- top_logprobs: z.nullable(z.number().int()).optional(),
2878
- n: z.nullable(z.number().int()).optional(),
2879
- presence_penalty: z.nullable(z.number()).optional(),
2880
- response_format: z.union([
2881
- z.lazy(() =>
2882
- GetAgentResponseFormatAgentsResponse200JSONSchema$inboundSchema
2883
- ),
2884
- z.lazy(() => GetAgentResponseFormatAgentsText$inboundSchema),
2885
- z.lazy(() => GetAgentResponseFormatAgentsJSONObject$inboundSchema),
2886
- ]).optional(),
2887
- reasoning_effort: z.string().optional(),
2888
- verbosity: z.string().optional(),
2889
- seed: z.nullable(z.number()).optional(),
2890
- stop: z.nullable(z.union([z.string(), z.array(z.string())])).optional(),
2891
- stream_options: z.nullable(
2892
- z.lazy(() =>
2893
- GetAgentFallbackModelConfigurationStreamOptions$inboundSchema
2894
- ),
2895
- ).optional(),
2896
- thinking: z.lazy(() =>
2897
- GetAgentFallbackModelConfigurationThinking$inboundSchema
2898
- ).optional(),
2899
- temperature: z.nullable(z.number()).optional(),
2900
- top_p: z.nullable(z.number()).optional(),
2901
- top_k: z.nullable(z.number()).optional(),
2902
- tool_choice: z.union([
2903
- z.lazy(() => GetAgentToolChoiceAgents2$inboundSchema),
2904
- GetAgentToolChoiceAgents1$inboundSchema,
2905
- ]).optional(),
2906
- parallel_tool_calls: z.boolean().optional(),
2907
- modalities: z.nullable(
2908
- z.array(GetAgentFallbackModelConfigurationModalities$inboundSchema),
2909
- ).optional(),
2910
- }).transform((v) => {
2911
- return remap$(v, {
2912
- "frequency_penalty": "frequencyPenalty",
2913
- "max_tokens": "maxTokens",
2914
- "max_completion_tokens": "maxCompletionTokens",
2915
- "top_logprobs": "topLogprobs",
2916
- "presence_penalty": "presencePenalty",
2917
- "response_format": "responseFormat",
2918
- "reasoning_effort": "reasoningEffort",
2919
- "stream_options": "streamOptions",
2920
- "top_p": "topP",
2921
- "top_k": "topK",
2922
- "tool_choice": "toolChoice",
2923
- "parallel_tool_calls": "parallelToolCalls",
2924
- });
2925
- });
2926
- /** @internal */
2927
- export type GetAgentFallbackModelConfigurationParameters$Outbound = {
2928
- audio?: GetAgentFallbackModelConfigurationAudio$Outbound | null | undefined;
2929
- frequency_penalty?: number | null | undefined;
2930
- max_tokens?: number | null | undefined;
2931
- max_completion_tokens?: number | null | undefined;
2932
- logprobs?: boolean | null | undefined;
2933
- top_logprobs?: number | null | undefined;
2934
- n?: number | null | undefined;
2935
- presence_penalty?: number | null | undefined;
2936
- response_format?:
2937
- | GetAgentResponseFormatAgentsResponse200JSONSchema$Outbound
2938
- | GetAgentResponseFormatAgentsText$Outbound
2939
- | GetAgentResponseFormatAgentsJSONObject$Outbound
2940
- | undefined;
2941
- reasoning_effort?: string | undefined;
2942
- verbosity?: string | undefined;
2943
- seed?: number | null | undefined;
2944
- stop?: string | Array<string> | null | undefined;
2945
- stream_options?:
2946
- | GetAgentFallbackModelConfigurationStreamOptions$Outbound
2947
- | null
2948
- | undefined;
2949
- thinking?: GetAgentFallbackModelConfigurationThinking$Outbound | undefined;
2950
- temperature?: number | null | undefined;
2951
- top_p?: number | null | undefined;
2952
- top_k?: number | null | undefined;
2953
- tool_choice?: GetAgentToolChoiceAgents2$Outbound | string | undefined;
2954
- parallel_tool_calls?: boolean | undefined;
2955
- modalities?: Array<string> | null | undefined;
2956
- };
2957
-
2958
- /** @internal */
2959
- export const GetAgentFallbackModelConfigurationParameters$outboundSchema:
2960
- z.ZodType<
2961
- GetAgentFallbackModelConfigurationParameters$Outbound,
2962
- z.ZodTypeDef,
2963
- GetAgentFallbackModelConfigurationParameters
2964
- > = z.object({
2965
- audio: z.nullable(
2966
- z.lazy(() => GetAgentFallbackModelConfigurationAudio$outboundSchema),
2967
- ).optional(),
2968
- frequencyPenalty: z.nullable(z.number()).optional(),
2969
- maxTokens: z.nullable(z.number().int()).optional(),
2970
- maxCompletionTokens: z.nullable(z.number().int()).optional(),
2971
- logprobs: z.nullable(z.boolean()).optional(),
2972
- topLogprobs: z.nullable(z.number().int()).optional(),
2973
- n: z.nullable(z.number().int()).optional(),
2974
- presencePenalty: z.nullable(z.number()).optional(),
2975
- responseFormat: z.union([
2976
- z.lazy(() =>
2977
- GetAgentResponseFormatAgentsResponse200JSONSchema$outboundSchema
2978
- ),
2979
- z.lazy(() => GetAgentResponseFormatAgentsText$outboundSchema),
2980
- z.lazy(() => GetAgentResponseFormatAgentsJSONObject$outboundSchema),
2981
- ]).optional(),
2982
- reasoningEffort: z.string().optional(),
2983
- verbosity: z.string().optional(),
2984
- seed: z.nullable(z.number()).optional(),
2985
- stop: z.nullable(z.union([z.string(), z.array(z.string())])).optional(),
2986
- streamOptions: z.nullable(
2987
- z.lazy(() =>
2988
- GetAgentFallbackModelConfigurationStreamOptions$outboundSchema
2989
- ),
2990
- ).optional(),
2991
- thinking: z.lazy(() =>
2992
- GetAgentFallbackModelConfigurationThinking$outboundSchema
2993
- ).optional(),
2994
- temperature: z.nullable(z.number()).optional(),
2995
- topP: z.nullable(z.number()).optional(),
2996
- topK: z.nullable(z.number()).optional(),
2997
- toolChoice: z.union([
2998
- z.lazy(() => GetAgentToolChoiceAgents2$outboundSchema),
2999
- GetAgentToolChoiceAgents1$outboundSchema,
3000
- ]).optional(),
3001
- parallelToolCalls: z.boolean().optional(),
3002
- modalities: z.nullable(
3003
- z.array(GetAgentFallbackModelConfigurationModalities$outboundSchema),
3004
- ).optional(),
3005
- }).transform((v) => {
3006
- return remap$(v, {
3007
- frequencyPenalty: "frequency_penalty",
3008
- maxTokens: "max_tokens",
3009
- maxCompletionTokens: "max_completion_tokens",
3010
- topLogprobs: "top_logprobs",
3011
- presencePenalty: "presence_penalty",
3012
- responseFormat: "response_format",
3013
- reasoningEffort: "reasoning_effort",
3014
- streamOptions: "stream_options",
3015
- topP: "top_p",
3016
- topK: "top_k",
3017
- toolChoice: "tool_choice",
3018
- parallelToolCalls: "parallel_tool_calls",
3019
- });
3020
- });
3021
-
3022
- export function getAgentFallbackModelConfigurationParametersToJSON(
3023
- getAgentFallbackModelConfigurationParameters:
3024
- GetAgentFallbackModelConfigurationParameters,
3025
- ): string {
3026
- return JSON.stringify(
3027
- GetAgentFallbackModelConfigurationParameters$outboundSchema.parse(
3028
- getAgentFallbackModelConfigurationParameters,
3029
- ),
3030
- );
3031
- }
3032
- export function getAgentFallbackModelConfigurationParametersFromJSON(
3033
- jsonString: string,
3034
- ): SafeParseResult<
3035
- GetAgentFallbackModelConfigurationParameters,
3036
- SDKValidationError
3037
- > {
3038
- return safeParse(
3039
- jsonString,
3040
- (x) =>
3041
- GetAgentFallbackModelConfigurationParameters$inboundSchema.parse(
3042
- JSON.parse(x),
3043
- ),
3044
- `Failed to parse 'GetAgentFallbackModelConfigurationParameters' from JSON`,
3045
- );
3046
- }
3047
-
3048
- /** @internal */
3049
- export const GetAgentFallbackModelConfiguration2$inboundSchema: z.ZodType<
3050
- GetAgentFallbackModelConfiguration2,
3051
- z.ZodTypeDef,
3052
- unknown
3053
- > = z.object({
3054
- id: z.string(),
3055
- parameters: z.lazy(() =>
3056
- GetAgentFallbackModelConfigurationParameters$inboundSchema
3057
- ).optional(),
3058
- });
3059
- /** @internal */
3060
- export type GetAgentFallbackModelConfiguration2$Outbound = {
3061
- id: string;
3062
- parameters?:
3063
- | GetAgentFallbackModelConfigurationParameters$Outbound
3064
- | undefined;
3065
- };
3066
-
3067
- /** @internal */
3068
- export const GetAgentFallbackModelConfiguration2$outboundSchema: z.ZodType<
3069
- GetAgentFallbackModelConfiguration2$Outbound,
3070
- z.ZodTypeDef,
3071
- GetAgentFallbackModelConfiguration2
3072
- > = z.object({
3073
- id: z.string(),
3074
- parameters: z.lazy(() =>
3075
- GetAgentFallbackModelConfigurationParameters$outboundSchema
3076
- ).optional(),
3077
- });
3078
-
3079
- export function getAgentFallbackModelConfiguration2ToJSON(
3080
- getAgentFallbackModelConfiguration2: GetAgentFallbackModelConfiguration2,
3081
- ): string {
3082
- return JSON.stringify(
3083
- GetAgentFallbackModelConfiguration2$outboundSchema.parse(
3084
- getAgentFallbackModelConfiguration2,
3085
- ),
3086
- );
3087
- }
3088
- export function getAgentFallbackModelConfiguration2FromJSON(
3089
- jsonString: string,
3090
- ): SafeParseResult<GetAgentFallbackModelConfiguration2, SDKValidationError> {
3091
- return safeParse(
3092
- jsonString,
3093
- (x) =>
3094
- GetAgentFallbackModelConfiguration2$inboundSchema.parse(JSON.parse(x)),
3095
- `Failed to parse 'GetAgentFallbackModelConfiguration2' from JSON`,
3096
- );
3097
- }
3098
-
3099
- /** @internal */
3100
- export const GetAgentFallbackModelConfiguration$inboundSchema: z.ZodType<
3101
- GetAgentFallbackModelConfiguration,
3102
- z.ZodTypeDef,
3103
- unknown
3104
- > = z.union([
3105
- z.lazy(() => GetAgentFallbackModelConfiguration2$inboundSchema),
3106
- z.string(),
3107
- ]);
3108
- /** @internal */
3109
- export type GetAgentFallbackModelConfiguration$Outbound =
3110
- | GetAgentFallbackModelConfiguration2$Outbound
3111
- | string;
3112
-
3113
- /** @internal */
3114
- export const GetAgentFallbackModelConfiguration$outboundSchema: z.ZodType<
3115
- GetAgentFallbackModelConfiguration$Outbound,
3116
- z.ZodTypeDef,
3117
- GetAgentFallbackModelConfiguration
3118
- > = z.union([
3119
- z.lazy(() => GetAgentFallbackModelConfiguration2$outboundSchema),
3120
- z.string(),
3121
- ]);
3122
-
3123
- export function getAgentFallbackModelConfigurationToJSON(
3124
- getAgentFallbackModelConfiguration: GetAgentFallbackModelConfiguration,
3125
- ): string {
3126
- return JSON.stringify(
3127
- GetAgentFallbackModelConfiguration$outboundSchema.parse(
3128
- getAgentFallbackModelConfiguration,
3129
- ),
3130
- );
3131
- }
3132
- export function getAgentFallbackModelConfigurationFromJSON(
3133
- jsonString: string,
3134
- ): SafeParseResult<GetAgentFallbackModelConfiguration, SDKValidationError> {
3135
- return safeParse(
3136
- jsonString,
3137
- (x) =>
3138
- GetAgentFallbackModelConfiguration$inboundSchema.parse(JSON.parse(x)),
3139
- `Failed to parse 'GetAgentFallbackModelConfiguration' from JSON`,
3140
- );
3141
- }
3142
-
3143
- /** @internal */
3144
- export const GetAgentModel$inboundSchema: z.ZodType<
3145
- GetAgentModel,
3146
- z.ZodTypeDef,
3147
- unknown
3148
- > = z.object({
3149
- id: z.string(),
3150
- integration_id: z.nullable(z.string()).optional(),
3151
- parameters: z.lazy(() => GetAgentParameters$inboundSchema).optional(),
3152
- retry: z.lazy(() => GetAgentRetry$inboundSchema).optional(),
3153
- fallback_models: z.nullable(
3154
- z.array(z.union([
3155
- z.lazy(() => GetAgentFallbackModelConfiguration2$inboundSchema),
3156
- z.string(),
3157
- ])),
3158
- ).optional(),
3159
- }).transform((v) => {
3160
- return remap$(v, {
3161
- "integration_id": "integrationId",
3162
- "fallback_models": "fallbackModels",
3163
- });
3164
- });
3165
- /** @internal */
3166
- export type GetAgentModel$Outbound = {
3167
- id: string;
3168
- integration_id?: string | null | undefined;
3169
- parameters?: GetAgentParameters$Outbound | undefined;
3170
- retry?: GetAgentRetry$Outbound | undefined;
3171
- fallback_models?:
3172
- | Array<GetAgentFallbackModelConfiguration2$Outbound | string>
3173
- | null
3174
- | undefined;
3175
- };
3176
-
3177
- /** @internal */
3178
- export const GetAgentModel$outboundSchema: z.ZodType<
3179
- GetAgentModel$Outbound,
3180
- z.ZodTypeDef,
3181
- GetAgentModel
3182
- > = z.object({
3183
- id: z.string(),
3184
- integrationId: z.nullable(z.string()).optional(),
3185
- parameters: z.lazy(() => GetAgentParameters$outboundSchema).optional(),
3186
- retry: z.lazy(() => GetAgentRetry$outboundSchema).optional(),
3187
- fallbackModels: z.nullable(
3188
- z.array(z.union([
3189
- z.lazy(() => GetAgentFallbackModelConfiguration2$outboundSchema),
3190
- z.string(),
3191
- ])),
3192
- ).optional(),
3193
- }).transform((v) => {
3194
- return remap$(v, {
3195
- integrationId: "integration_id",
3196
- fallbackModels: "fallback_models",
3197
- });
3198
- });
3199
-
3200
- export function getAgentModelToJSON(getAgentModel: GetAgentModel): string {
3201
- return JSON.stringify(GetAgentModel$outboundSchema.parse(getAgentModel));
3202
- }
3203
- export function getAgentModelFromJSON(
3204
- jsonString: string,
3205
- ): SafeParseResult<GetAgentModel, SDKValidationError> {
3206
- return safeParse(
3207
- jsonString,
3208
- (x) => GetAgentModel$inboundSchema.parse(JSON.parse(x)),
3209
- `Failed to parse 'GetAgentModel' from JSON`,
3210
- );
3211
- }
3212
-
3213
- /** @internal */
3214
- export const GetAgentTeamOfAgents$inboundSchema: z.ZodType<
3215
- GetAgentTeamOfAgents,
3216
- z.ZodTypeDef,
3217
- unknown
3218
- > = z.object({
3219
- key: z.string(),
3220
- role: z.string().optional(),
3221
- });
3222
- /** @internal */
3223
- export type GetAgentTeamOfAgents$Outbound = {
3224
- key: string;
3225
- role?: string | undefined;
3226
- };
3227
-
3228
- /** @internal */
3229
- export const GetAgentTeamOfAgents$outboundSchema: z.ZodType<
3230
- GetAgentTeamOfAgents$Outbound,
3231
- z.ZodTypeDef,
3232
- GetAgentTeamOfAgents
3233
- > = z.object({
3234
- key: z.string(),
3235
- role: z.string().optional(),
3236
- });
3237
-
3238
- export function getAgentTeamOfAgentsToJSON(
3239
- getAgentTeamOfAgents: GetAgentTeamOfAgents,
3240
- ): string {
3241
- return JSON.stringify(
3242
- GetAgentTeamOfAgents$outboundSchema.parse(getAgentTeamOfAgents),
3243
- );
3244
- }
3245
- export function getAgentTeamOfAgentsFromJSON(
3246
- jsonString: string,
3247
- ): SafeParseResult<GetAgentTeamOfAgents, SDKValidationError> {
3248
- return safeParse(
3249
- jsonString,
3250
- (x) => GetAgentTeamOfAgents$inboundSchema.parse(JSON.parse(x)),
3251
- `Failed to parse 'GetAgentTeamOfAgents' from JSON`,
3252
- );
3253
- }
3254
-
3255
- /** @internal */
3256
- export const GetAgentMetrics$inboundSchema: z.ZodType<
3257
- GetAgentMetrics,
3258
- z.ZodTypeDef,
3259
- unknown
3260
- > = z.object({
3261
- total_cost: z.number().default(0),
3262
- }).transform((v) => {
3263
- return remap$(v, {
3264
- "total_cost": "totalCost",
3265
- });
3266
- });
3267
- /** @internal */
3268
- export type GetAgentMetrics$Outbound = {
3269
- total_cost: number;
3270
- };
3271
-
3272
- /** @internal */
3273
- export const GetAgentMetrics$outboundSchema: z.ZodType<
3274
- GetAgentMetrics$Outbound,
3275
- z.ZodTypeDef,
3276
- GetAgentMetrics
3277
- > = z.object({
3278
- totalCost: z.number().default(0),
3279
- }).transform((v) => {
3280
- return remap$(v, {
3281
- totalCost: "total_cost",
3282
- });
3283
- });
3284
-
3285
- export function getAgentMetricsToJSON(
3286
- getAgentMetrics: GetAgentMetrics,
3287
- ): string {
3288
- return JSON.stringify(GetAgentMetrics$outboundSchema.parse(getAgentMetrics));
3289
- }
3290
- export function getAgentMetricsFromJSON(
3291
- jsonString: string,
3292
- ): SafeParseResult<GetAgentMetrics, SDKValidationError> {
3293
- return safeParse(
3294
- jsonString,
3295
- (x) => GetAgentMetrics$inboundSchema.parse(JSON.parse(x)),
3296
- `Failed to parse 'GetAgentMetrics' from JSON`,
3297
- );
3298
- }
3299
-
3300
- /** @internal */
3301
- export const GetAgentKnowledgeBases$inboundSchema: z.ZodType<
3302
- GetAgentKnowledgeBases,
3303
- z.ZodTypeDef,
3304
- unknown
3305
- > = z.object({
3306
- knowledge_id: z.string(),
3307
- }).transform((v) => {
3308
- return remap$(v, {
3309
- "knowledge_id": "knowledgeId",
3310
- });
3311
- });
3312
- /** @internal */
3313
- export type GetAgentKnowledgeBases$Outbound = {
3314
- knowledge_id: string;
3315
- };
3316
-
3317
- /** @internal */
3318
- export const GetAgentKnowledgeBases$outboundSchema: z.ZodType<
3319
- GetAgentKnowledgeBases$Outbound,
3320
- z.ZodTypeDef,
3321
- GetAgentKnowledgeBases
3322
- > = z.object({
3323
- knowledgeId: z.string(),
3324
- }).transform((v) => {
3325
- return remap$(v, {
3326
- knowledgeId: "knowledge_id",
3327
- });
3328
- });
3329
-
3330
- export function getAgentKnowledgeBasesToJSON(
3331
- getAgentKnowledgeBases: GetAgentKnowledgeBases,
3332
- ): string {
3333
- return JSON.stringify(
3334
- GetAgentKnowledgeBases$outboundSchema.parse(getAgentKnowledgeBases),
3335
- );
3336
- }
3337
- export function getAgentKnowledgeBasesFromJSON(
3338
- jsonString: string,
3339
- ): SafeParseResult<GetAgentKnowledgeBases, SDKValidationError> {
3340
- return safeParse(
3341
- jsonString,
3342
- (x) => GetAgentKnowledgeBases$inboundSchema.parse(JSON.parse(x)),
3343
- `Failed to parse 'GetAgentKnowledgeBases' from JSON`,
3344
- );
3345
- }
3346
-
3347
- /** @internal */
3348
- export const GetAgentResponseBody$inboundSchema: z.ZodType<
3349
- GetAgentResponseBody,
3350
- z.ZodTypeDef,
3351
- unknown
3352
- > = z.object({
3353
- _id: z.string(),
3354
- key: z.string(),
3355
- display_name: z.string(),
3356
- workspace_id: z.string(),
3357
- project_id: z.string(),
3358
- created_by_id: z.nullable(z.string()).optional(),
3359
- updated_by_id: z.nullable(z.string()).optional(),
3360
- created: z.string().optional(),
3361
- updated: z.string().optional(),
3362
- role: z.string(),
3363
- description: z.string(),
3364
- system_prompt: z.string().optional(),
3365
- instructions: z.string(),
3366
- status: GetAgentStatus$inboundSchema,
3367
- settings: z.lazy(() => GetAgentSettings$inboundSchema).optional(),
3368
- model: z.lazy(() => GetAgentModel$inboundSchema),
3369
- version_hash: z.string().optional(),
3370
- path: z.string(),
3371
- memory_stores: z.array(z.string()),
3372
- team_of_agents: z.array(z.lazy(() => GetAgentTeamOfAgents$inboundSchema)),
3373
- metrics: z.lazy(() => GetAgentMetrics$inboundSchema).optional(),
3374
- variables: z.record(z.any()).optional(),
3375
- knowledge_bases: z.array(z.lazy(() => GetAgentKnowledgeBases$inboundSchema))
3376
- .optional(),
3377
- }).transform((v) => {
3378
- return remap$(v, {
3379
- "_id": "id",
3380
- "display_name": "displayName",
3381
- "workspace_id": "workspaceId",
3382
- "project_id": "projectId",
3383
- "created_by_id": "createdById",
3384
- "updated_by_id": "updatedById",
3385
- "system_prompt": "systemPrompt",
3386
- "version_hash": "versionHash",
3387
- "memory_stores": "memoryStores",
3388
- "team_of_agents": "teamOfAgents",
3389
- "knowledge_bases": "knowledgeBases",
3390
- });
3391
- });
3392
- /** @internal */
3393
- export type GetAgentResponseBody$Outbound = {
3394
- _id: string;
3395
- key: string;
3396
- display_name: string;
3397
- workspace_id: string;
3398
- project_id: string;
3399
- created_by_id?: string | null | undefined;
3400
- updated_by_id?: string | null | undefined;
3401
- created?: string | undefined;
3402
- updated?: string | undefined;
3403
- role: string;
3404
- description: string;
3405
- system_prompt?: string | undefined;
3406
- instructions: string;
3407
- status: string;
3408
- settings?: GetAgentSettings$Outbound | undefined;
3409
- model: GetAgentModel$Outbound;
3410
- version_hash?: string | undefined;
3411
- path: string;
3412
- memory_stores: Array<string>;
3413
- team_of_agents: Array<GetAgentTeamOfAgents$Outbound>;
3414
- metrics?: GetAgentMetrics$Outbound | undefined;
3415
- variables?: { [k: string]: any } | undefined;
3416
- knowledge_bases?: Array<GetAgentKnowledgeBases$Outbound> | undefined;
3417
- };
3418
-
3419
- /** @internal */
3420
- export const GetAgentResponseBody$outboundSchema: z.ZodType<
3421
- GetAgentResponseBody$Outbound,
3422
- z.ZodTypeDef,
3423
- GetAgentResponseBody
3424
- > = z.object({
3425
- id: z.string(),
3426
- key: z.string(),
3427
- displayName: z.string(),
3428
- workspaceId: z.string(),
3429
- projectId: z.string(),
3430
- createdById: z.nullable(z.string()).optional(),
3431
- updatedById: z.nullable(z.string()).optional(),
3432
- created: z.string().optional(),
3433
- updated: z.string().optional(),
3434
- role: z.string(),
3435
- description: z.string(),
3436
- systemPrompt: z.string().optional(),
3437
- instructions: z.string(),
3438
- status: GetAgentStatus$outboundSchema,
3439
- settings: z.lazy(() => GetAgentSettings$outboundSchema).optional(),
3440
- model: z.lazy(() => GetAgentModel$outboundSchema),
3441
- versionHash: z.string().optional(),
3442
- path: z.string(),
3443
- memoryStores: z.array(z.string()),
3444
- teamOfAgents: z.array(z.lazy(() => GetAgentTeamOfAgents$outboundSchema)),
3445
- metrics: z.lazy(() => GetAgentMetrics$outboundSchema).optional(),
3446
- variables: z.record(z.any()).optional(),
3447
- knowledgeBases: z.array(z.lazy(() => GetAgentKnowledgeBases$outboundSchema))
3448
- .optional(),
3449
- }).transform((v) => {
3450
- return remap$(v, {
3451
- id: "_id",
3452
- displayName: "display_name",
3453
- workspaceId: "workspace_id",
3454
- projectId: "project_id",
3455
- createdById: "created_by_id",
3456
- updatedById: "updated_by_id",
3457
- systemPrompt: "system_prompt",
3458
- versionHash: "version_hash",
3459
- memoryStores: "memory_stores",
3460
- teamOfAgents: "team_of_agents",
3461
- knowledgeBases: "knowledge_bases",
3462
- });
3463
- });
3464
-
3465
- export function getAgentResponseBodyToJSON(
3466
- getAgentResponseBody: GetAgentResponseBody,
3467
- ): string {
3468
- return JSON.stringify(
3469
- GetAgentResponseBody$outboundSchema.parse(getAgentResponseBody),
3470
- );
3471
- }
3472
- export function getAgentResponseBodyFromJSON(
3473
- jsonString: string,
3474
- ): SafeParseResult<GetAgentResponseBody, SDKValidationError> {
3475
- return safeParse(
3476
- jsonString,
3477
- (x) => GetAgentResponseBody$inboundSchema.parse(JSON.parse(x)),
3478
- `Failed to parse 'GetAgentResponseBody' from JSON`,
3479
- );
3480
- }