@orq-ai/node 4.2.0-rc.43 → 4.2.0-rc.45
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -1
- package/bin/mcp-server.js +4769 -1624
- package/bin/mcp-server.js.map +57 -56
- package/examples/package-lock.json +1 -1
- package/funcs/promptsDelete.d.ts +2 -1
- package/funcs/promptsDelete.d.ts.map +1 -1
- package/funcs/promptsDelete.js +7 -3
- package/funcs/promptsDelete.js.map +1 -1
- package/jsr.json +1 -1
- package/lib/config.d.ts +2 -2
- package/lib/config.js +2 -2
- package/mcp-server/mcp-server.js +1 -1
- package/mcp-server/server.js +1 -1
- package/models/components/conversationresponse.js +2 -2
- package/models/components/conversationwithmessagesresponse.js +2 -2
- package/models/components/partdoneevent.js +2 -2
- package/models/components/reasoningpart.js +2 -2
- package/models/errors/deleteprompt.d.ts +29 -0
- package/models/errors/deleteprompt.d.ts.map +1 -0
- package/models/errors/deleteprompt.js +74 -0
- package/models/errors/deleteprompt.js.map +1 -0
- package/models/errors/index.d.ts +1 -0
- package/models/errors/index.d.ts.map +1 -1
- package/models/errors/index.js +1 -0
- package/models/errors/index.js.map +1 -1
- package/models/operations/createcontact.js +2 -2
- package/models/operations/createconversation.js +2 -2
- package/models/operations/createconversationresponse.js +4 -4
- package/models/operations/createdataset.js +2 -2
- package/models/operations/createdatasetitem.js +8 -8
- package/models/operations/createdatasource.js +2 -2
- package/models/operations/createeval.d.ts +16 -16
- package/models/operations/createeval.d.ts.map +1 -1
- package/models/operations/createeval.js +56 -53
- package/models/operations/createeval.js.map +1 -1
- package/models/operations/createidentity.js +2 -2
- package/models/operations/createprompt.d.ts +1746 -976
- package/models/operations/createprompt.d.ts.map +1 -1
- package/models/operations/createprompt.js +2032 -1282
- package/models/operations/createprompt.js.map +1 -1
- package/models/operations/createtool.js +12 -12
- package/models/operations/deploymentgetconfig.d.ts +88 -88
- package/models/operations/deploymentgetconfig.d.ts.map +1 -1
- package/models/operations/deploymentgetconfig.js +131 -130
- package/models/operations/deploymentgetconfig.js.map +1 -1
- package/models/operations/deploymentinvoke.d.ts +5 -5
- package/models/operations/deploymentinvoke.d.ts.map +1 -1
- package/models/operations/deploymentinvoke.js +7 -6
- package/models/operations/deploymentinvoke.js.map +1 -1
- package/models/operations/fileget.js +2 -2
- package/models/operations/filelist.js +2 -2
- package/models/operations/fileupload.js +2 -2
- package/models/operations/generateconversationname.js +2 -2
- package/models/operations/getallprompts.d.ts +1051 -42
- package/models/operations/getallprompts.d.ts.map +1 -1
- package/models/operations/getallprompts.js +1069 -48
- package/models/operations/getallprompts.js.map +1 -1
- package/models/operations/getalltools.js +12 -12
- package/models/operations/getevals.js +28 -28
- package/models/operations/getoneprompt.d.ts +1051 -42
- package/models/operations/getoneprompt.d.ts.map +1 -1
- package/models/operations/getoneprompt.js +1071 -47
- package/models/operations/getoneprompt.js.map +1 -1
- package/models/operations/getpromptversion.d.ts +1051 -42
- package/models/operations/getpromptversion.d.ts.map +1 -1
- package/models/operations/getpromptversion.js +1070 -48
- package/models/operations/getpromptversion.js.map +1 -1
- package/models/operations/listcontacts.js +2 -2
- package/models/operations/listdatasetdatapoints.js +8 -8
- package/models/operations/listdatasets.js +2 -2
- package/models/operations/listdatasources.js +2 -2
- package/models/operations/listidentities.js +2 -2
- package/models/operations/listpromptversions.d.ts +1051 -42
- package/models/operations/listpromptversions.d.ts.map +1 -1
- package/models/operations/listpromptversions.js +1070 -47
- package/models/operations/listpromptversions.js.map +1 -1
- package/models/operations/retrievecontact.js +2 -2
- package/models/operations/retrievedatapoint.js +8 -8
- package/models/operations/retrievedataset.js +2 -2
- package/models/operations/retrievedatasource.js +2 -2
- package/models/operations/retrieveidentity.js +2 -2
- package/models/operations/retrievetool.js +12 -12
- package/models/operations/runagent.js +2 -2
- package/models/operations/streamrunagent.js +2 -2
- package/models/operations/updatecontact.js +2 -2
- package/models/operations/updateconversation.js +2 -2
- package/models/operations/updatedatapoint.js +8 -8
- package/models/operations/updatedataset.js +2 -2
- package/models/operations/updatedatasource.js +2 -2
- package/models/operations/updateeval.js +28 -28
- package/models/operations/updateidentity.js +2 -2
- package/models/operations/updateprompt.d.ts +2112 -1413
- package/models/operations/updateprompt.d.ts.map +1 -1
- package/models/operations/updateprompt.js +2200 -1525
- package/models/operations/updateprompt.js.map +1 -1
- package/models/operations/updatetool.js +14 -14
- package/package.json +1 -1
- package/src/funcs/promptsDelete.ts +12 -3
- package/src/lib/config.ts +2 -2
- package/src/mcp-server/mcp-server.ts +1 -1
- package/src/mcp-server/server.ts +1 -1
- package/src/models/components/conversationresponse.ts +2 -2
- package/src/models/components/conversationwithmessagesresponse.ts +2 -2
- package/src/models/components/partdoneevent.ts +2 -2
- package/src/models/components/reasoningpart.ts +2 -2
- package/src/models/errors/deleteprompt.ts +67 -0
- package/src/models/errors/index.ts +1 -0
- package/src/models/operations/createcontact.ts +2 -2
- package/src/models/operations/createconversation.ts +2 -2
- package/src/models/operations/createconversationresponse.ts +4 -4
- package/src/models/operations/createdataset.ts +2 -2
- package/src/models/operations/createdatasetitem.ts +8 -8
- package/src/models/operations/createdatasource.ts +2 -2
- package/src/models/operations/createeval.ts +76 -96
- package/src/models/operations/createidentity.ts +2 -2
- package/src/models/operations/createprompt.ts +5179 -3019
- package/src/models/operations/createtool.ts +12 -12
- package/src/models/operations/deploymentgetconfig.ts +252 -337
- package/src/models/operations/deploymentinvoke.ts +9 -13
- package/src/models/operations/fileget.ts +2 -2
- package/src/models/operations/filelist.ts +2 -2
- package/src/models/operations/fileupload.ts +2 -2
- package/src/models/operations/generateconversationname.ts +2 -2
- package/src/models/operations/getallprompts.ts +3543 -850
- package/src/models/operations/getalltools.ts +12 -12
- package/src/models/operations/getevals.ts +28 -28
- package/src/models/operations/getoneprompt.ts +3463 -786
- package/src/models/operations/getpromptversion.ts +3579 -835
- package/src/models/operations/listcontacts.ts +2 -2
- package/src/models/operations/listdatasetdatapoints.ts +8 -8
- package/src/models/operations/listdatasets.ts +2 -2
- package/src/models/operations/listdatasources.ts +2 -2
- package/src/models/operations/listidentities.ts +2 -2
- package/src/models/operations/listpromptversions.ts +3644 -864
- package/src/models/operations/retrievecontact.ts +2 -2
- package/src/models/operations/retrievedatapoint.ts +8 -8
- package/src/models/operations/retrievedataset.ts +2 -2
- package/src/models/operations/retrievedatasource.ts +2 -2
- package/src/models/operations/retrieveidentity.ts +2 -2
- package/src/models/operations/retrievetool.ts +12 -12
- package/src/models/operations/runagent.ts +2 -2
- package/src/models/operations/streamrunagent.ts +2 -2
- package/src/models/operations/updatecontact.ts +2 -2
- package/src/models/operations/updateconversation.ts +2 -2
- package/src/models/operations/updatedatapoint.ts +8 -8
- package/src/models/operations/updatedataset.ts +2 -2
- package/src/models/operations/updatedatasource.ts +2 -2
- package/src/models/operations/updateeval.ts +28 -28
- package/src/models/operations/updateidentity.ts +2 -2
- package/src/models/operations/updateprompt.ts +5281 -3301
- package/src/models/operations/updatetool.ts +14 -14
|
@@ -52,690 +52,584 @@ export type CreatePromptMetadata = {
|
|
|
52
52
|
*/
|
|
53
53
|
language?: CreatePromptLanguage | null | undefined;
|
|
54
54
|
};
|
|
55
|
+
export type CreatePromptContentPromptsRequest2 = components.TextContentPartSchema;
|
|
55
56
|
/**
|
|
56
|
-
* The
|
|
57
|
+
* The contents of the tool message.
|
|
57
58
|
*/
|
|
58
|
-
export
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
readonly
|
|
64
|
-
readonly Prompt: "prompt";
|
|
65
|
-
readonly Correction: "correction";
|
|
66
|
-
readonly ExpectedOutput: "expected_output";
|
|
59
|
+
export type CreatePromptMessagesPromptsRequestRequestBodyContent = string | Array<components.TextContentPartSchema>;
|
|
60
|
+
/**
|
|
61
|
+
* Create a cache control breakpoint at this content block. Accepts only the value "ephemeral".
|
|
62
|
+
*/
|
|
63
|
+
export declare const CreatePromptMessagesPromptsType: {
|
|
64
|
+
readonly Ephemeral: "ephemeral";
|
|
67
65
|
};
|
|
68
66
|
/**
|
|
69
|
-
*
|
|
67
|
+
* Create a cache control breakpoint at this content block. Accepts only the value "ephemeral".
|
|
70
68
|
*/
|
|
71
|
-
export type
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
69
|
+
export type CreatePromptMessagesPromptsType = ClosedEnum<typeof CreatePromptMessagesPromptsType>;
|
|
70
|
+
/**
|
|
71
|
+
* The time-to-live for the cache control breakpoint. This may be one of the following values:
|
|
72
|
+
*
|
|
73
|
+
* @remarks
|
|
74
|
+
*
|
|
75
|
+
* - `5m`: 5 minutes
|
|
76
|
+
* - `1h`: 1 hour
|
|
77
|
+
*
|
|
78
|
+
* Defaults to `5m`. Only supported by `Anthropic` Claude models.
|
|
79
|
+
*/
|
|
80
|
+
export declare const CreatePromptMessagesTtl: {
|
|
81
|
+
readonly Fivem: "5m";
|
|
82
|
+
readonly Oneh: "1h";
|
|
83
|
+
};
|
|
84
|
+
/**
|
|
85
|
+
* The time-to-live for the cache control breakpoint. This may be one of the following values:
|
|
86
|
+
*
|
|
87
|
+
* @remarks
|
|
88
|
+
*
|
|
89
|
+
* - `5m`: 5 minutes
|
|
90
|
+
* - `1h`: 1 hour
|
|
91
|
+
*
|
|
92
|
+
* Defaults to `5m`. Only supported by `Anthropic` Claude models.
|
|
93
|
+
*/
|
|
94
|
+
export type CreatePromptMessagesTtl = ClosedEnum<typeof CreatePromptMessagesTtl>;
|
|
95
|
+
export type CreatePromptMessagesCacheControl = {
|
|
81
96
|
/**
|
|
82
|
-
*
|
|
97
|
+
* Create a cache control breakpoint at this content block. Accepts only the value "ephemeral".
|
|
83
98
|
*/
|
|
84
|
-
|
|
99
|
+
type: CreatePromptMessagesPromptsType;
|
|
85
100
|
/**
|
|
86
|
-
* The
|
|
101
|
+
* The time-to-live for the cache control breakpoint. This may be one of the following values:
|
|
102
|
+
*
|
|
103
|
+
* @remarks
|
|
104
|
+
*
|
|
105
|
+
* - `5m`: 5 minutes
|
|
106
|
+
* - `1h`: 1 hour
|
|
107
|
+
*
|
|
108
|
+
* Defaults to `5m`. Only supported by `Anthropic` Claude models.
|
|
87
109
|
*/
|
|
88
|
-
|
|
110
|
+
ttl?: CreatePromptMessagesTtl | undefined;
|
|
89
111
|
};
|
|
90
|
-
export type
|
|
112
|
+
export type CreatePromptMessagesToolMessage = {
|
|
91
113
|
/**
|
|
92
|
-
* The
|
|
114
|
+
* The role of the messages author, in this case tool.
|
|
93
115
|
*/
|
|
94
|
-
|
|
95
|
-
file: TwoFile;
|
|
96
|
-
};
|
|
97
|
-
export type TwoImageUrl = {
|
|
116
|
+
role: "tool";
|
|
98
117
|
/**
|
|
99
|
-
*
|
|
118
|
+
* The contents of the tool message.
|
|
100
119
|
*/
|
|
101
|
-
|
|
120
|
+
content: string | Array<components.TextContentPartSchema>;
|
|
102
121
|
/**
|
|
103
|
-
*
|
|
122
|
+
* Tool call that this message is responding to.
|
|
104
123
|
*/
|
|
105
|
-
|
|
124
|
+
toolCallId: string | null;
|
|
125
|
+
cacheControl?: CreatePromptMessagesCacheControl | undefined;
|
|
106
126
|
};
|
|
127
|
+
export type CreatePromptContentPrompts2 = (components.TextContentPartSchema & {
|
|
128
|
+
type: "text";
|
|
129
|
+
}) | components.RefusalPartSchema | components.ReasoningPartSchema | components.RedactedReasoningPartSchema;
|
|
107
130
|
/**
|
|
108
|
-
* The
|
|
131
|
+
* The contents of the assistant message. Required unless `tool_calls` or `function_call` is specified.
|
|
109
132
|
*/
|
|
110
|
-
export type
|
|
111
|
-
type: "
|
|
112
|
-
|
|
113
|
-
};
|
|
133
|
+
export type CreatePromptMessagesPromptsRequestContent = string | Array<(components.TextContentPartSchema & {
|
|
134
|
+
type: "text";
|
|
135
|
+
}) | components.RefusalPartSchema | components.ReasoningPartSchema | components.RedactedReasoningPartSchema>;
|
|
114
136
|
/**
|
|
115
|
-
*
|
|
137
|
+
* Data about a previous audio response from the model.
|
|
116
138
|
*/
|
|
117
|
-
export type
|
|
118
|
-
|
|
119
|
-
|
|
139
|
+
export type CreatePromptMessagesAudio = {
|
|
140
|
+
/**
|
|
141
|
+
* Unique identifier for a previous audio response from the model.
|
|
142
|
+
*/
|
|
143
|
+
id: string;
|
|
120
144
|
};
|
|
121
|
-
export type CreatePromptContent2 = Two1 | CreatePrompt22 | Two3;
|
|
122
145
|
/**
|
|
123
|
-
* The
|
|
146
|
+
* The type of the tool. Currently, only `function` is supported.
|
|
124
147
|
*/
|
|
125
|
-
export
|
|
126
|
-
export declare const CreatePromptType: {
|
|
148
|
+
export declare const CreatePromptMessagesType: {
|
|
127
149
|
readonly Function: "function";
|
|
128
150
|
};
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
151
|
+
/**
|
|
152
|
+
* The type of the tool. Currently, only `function` is supported.
|
|
153
|
+
*/
|
|
154
|
+
export type CreatePromptMessagesType = ClosedEnum<typeof CreatePromptMessagesType>;
|
|
155
|
+
export type CreatePromptMessagesFunction = {
|
|
132
156
|
/**
|
|
133
|
-
*
|
|
157
|
+
* The name of the function to call.
|
|
134
158
|
*/
|
|
135
|
-
|
|
159
|
+
name?: string | undefined;
|
|
160
|
+
/**
|
|
161
|
+
* The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function.
|
|
162
|
+
*/
|
|
163
|
+
arguments?: string | undefined;
|
|
136
164
|
};
|
|
137
|
-
export type
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
165
|
+
export type CreatePromptMessagesToolCalls = {
|
|
166
|
+
/**
|
|
167
|
+
* The ID of the tool call.
|
|
168
|
+
*/
|
|
169
|
+
id: string;
|
|
170
|
+
/**
|
|
171
|
+
* The type of the tool. Currently, only `function` is supported.
|
|
172
|
+
*/
|
|
173
|
+
type: CreatePromptMessagesType;
|
|
174
|
+
function: CreatePromptMessagesFunction;
|
|
175
|
+
/**
|
|
176
|
+
* Encrypted representation of the model internal reasoning state during function calling. Required by Gemini 3 models when continuing a conversation after a tool call.
|
|
177
|
+
*/
|
|
178
|
+
thoughtSignature?: string | undefined;
|
|
142
179
|
};
|
|
143
|
-
export type
|
|
180
|
+
export type CreatePromptMessagesAssistantMessage = {
|
|
144
181
|
/**
|
|
145
|
-
* The
|
|
182
|
+
* The contents of the assistant message. Required unless `tool_calls` or `function_call` is specified.
|
|
146
183
|
*/
|
|
147
|
-
|
|
184
|
+
content?: string | Array<(components.TextContentPartSchema & {
|
|
185
|
+
type: "text";
|
|
186
|
+
}) | components.RefusalPartSchema | components.ReasoningPartSchema | components.RedactedReasoningPartSchema> | null | undefined;
|
|
148
187
|
/**
|
|
149
|
-
* The
|
|
188
|
+
* The refusal message by the assistant.
|
|
150
189
|
*/
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
190
|
+
refusal?: string | null | undefined;
|
|
191
|
+
/**
|
|
192
|
+
* The role of the messages author, in this case `assistant`.
|
|
193
|
+
*/
|
|
194
|
+
role: "assistant";
|
|
195
|
+
/**
|
|
196
|
+
* An optional name for the participant. Provides the model information to differentiate between participants of the same role.
|
|
197
|
+
*/
|
|
198
|
+
name?: string | undefined;
|
|
199
|
+
/**
|
|
200
|
+
* Data about a previous audio response from the model.
|
|
201
|
+
*/
|
|
202
|
+
audio?: CreatePromptMessagesAudio | null | undefined;
|
|
203
|
+
/**
|
|
204
|
+
* The tool calls generated by the model, such as function calls.
|
|
205
|
+
*/
|
|
206
|
+
toolCalls?: Array<CreatePromptMessagesToolCalls> | undefined;
|
|
154
207
|
};
|
|
155
208
|
/**
|
|
156
|
-
*
|
|
209
|
+
* Create a cache control breakpoint at this content block. Accepts only the value "ephemeral".
|
|
157
210
|
*/
|
|
158
|
-
export declare const
|
|
159
|
-
readonly
|
|
160
|
-
readonly B64Json: "b64_json";
|
|
161
|
-
readonly Text: "text";
|
|
162
|
-
readonly JsonObject: "json_object";
|
|
211
|
+
export declare const CreatePrompt2PromptsType: {
|
|
212
|
+
readonly Ephemeral: "ephemeral";
|
|
163
213
|
};
|
|
164
214
|
/**
|
|
165
|
-
*
|
|
215
|
+
* Create a cache control breakpoint at this content block. Accepts only the value "ephemeral".
|
|
166
216
|
*/
|
|
167
|
-
export type
|
|
168
|
-
export declare const Six: {
|
|
169
|
-
readonly Json: "json";
|
|
170
|
-
readonly Text: "text";
|
|
171
|
-
readonly Srt: "srt";
|
|
172
|
-
readonly VerboseJson: "verbose_json";
|
|
173
|
-
readonly Vtt: "vtt";
|
|
174
|
-
};
|
|
175
|
-
export type Six = ClosedEnum<typeof Six>;
|
|
176
|
-
export declare const Five: {
|
|
177
|
-
readonly Url: "url";
|
|
178
|
-
readonly Base64Json: "base64_json";
|
|
179
|
-
};
|
|
180
|
-
export type Five = ClosedEnum<typeof Five>;
|
|
181
|
-
export declare const ResponseFormat4: {
|
|
182
|
-
readonly Mp3: "mp3";
|
|
183
|
-
readonly Opus: "opus";
|
|
184
|
-
readonly Aac: "aac";
|
|
185
|
-
readonly Flac: "flac";
|
|
186
|
-
readonly Wav: "wav";
|
|
187
|
-
readonly Pcm: "pcm";
|
|
188
|
-
};
|
|
189
|
-
export type ResponseFormat4 = ClosedEnum<typeof ResponseFormat4>;
|
|
190
|
-
export declare const CreatePromptResponseFormatPromptsRequestType: {
|
|
191
|
-
readonly Text: "text";
|
|
192
|
-
};
|
|
193
|
-
export type CreatePromptResponseFormatPromptsRequestType = ClosedEnum<typeof CreatePromptResponseFormatPromptsRequestType>;
|
|
194
|
-
export type ResponseFormat3 = {
|
|
195
|
-
type: CreatePromptResponseFormatPromptsRequestType;
|
|
196
|
-
};
|
|
197
|
-
export declare const CreatePromptResponseFormatPromptsType: {
|
|
198
|
-
readonly JsonObject: "json_object";
|
|
199
|
-
};
|
|
200
|
-
export type CreatePromptResponseFormatPromptsType = ClosedEnum<typeof CreatePromptResponseFormatPromptsType>;
|
|
201
|
-
export type ResponseFormat2 = {
|
|
202
|
-
type: CreatePromptResponseFormatPromptsType;
|
|
203
|
-
};
|
|
204
|
-
export declare const CreatePromptResponseFormatType: {
|
|
205
|
-
readonly JsonSchema: "json_schema";
|
|
206
|
-
};
|
|
207
|
-
export type CreatePromptResponseFormatType = ClosedEnum<typeof CreatePromptResponseFormatType>;
|
|
208
|
-
export type CreatePromptResponseFormatJsonSchema = {
|
|
209
|
-
name: string;
|
|
210
|
-
description?: string | undefined;
|
|
211
|
-
strict?: boolean | undefined;
|
|
212
|
-
schema: {
|
|
213
|
-
[k: string]: any;
|
|
214
|
-
};
|
|
215
|
-
};
|
|
216
|
-
export type ResponseFormat1 = {
|
|
217
|
-
type: CreatePromptResponseFormatType;
|
|
218
|
-
displayName?: string | undefined;
|
|
219
|
-
jsonSchema: CreatePromptResponseFormatJsonSchema;
|
|
220
|
-
};
|
|
217
|
+
export type CreatePrompt2PromptsType = ClosedEnum<typeof CreatePrompt2PromptsType>;
|
|
221
218
|
/**
|
|
222
|
-
*
|
|
219
|
+
* The time-to-live for the cache control breakpoint. This may be one of the following values:
|
|
223
220
|
*
|
|
224
221
|
* @remarks
|
|
225
222
|
*
|
|
226
|
-
*
|
|
227
|
-
*
|
|
228
|
-
* Setting to `{ "type": "json_object" }` enables JSON mode, which ensures the message the model generates is valid JSON.
|
|
223
|
+
* - `5m`: 5 minutes
|
|
224
|
+
* - `1h`: 1 hour
|
|
229
225
|
*
|
|
230
|
-
*
|
|
231
|
-
*/
|
|
232
|
-
export type CreatePromptResponseFormat = ResponseFormat1 | ResponseFormat2 | ResponseFormat3 | ResponseFormat4 | Five | Six;
|
|
233
|
-
/**
|
|
234
|
-
* The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider
|
|
235
|
-
*/
|
|
236
|
-
export declare const PhotoRealVersion: {
|
|
237
|
-
readonly V1: "v1";
|
|
238
|
-
readonly V2: "v2";
|
|
239
|
-
};
|
|
240
|
-
/**
|
|
241
|
-
* The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider
|
|
242
|
-
*/
|
|
243
|
-
export type PhotoRealVersion = ClosedEnum<typeof PhotoRealVersion>;
|
|
244
|
-
/**
|
|
245
|
-
* The format to return the embeddings
|
|
226
|
+
* Defaults to `5m`. Only supported by `Anthropic` Claude models.
|
|
246
227
|
*/
|
|
247
|
-
export declare const
|
|
248
|
-
readonly
|
|
249
|
-
readonly
|
|
228
|
+
export declare const CreatePrompt2Ttl: {
|
|
229
|
+
readonly Fivem: "5m";
|
|
230
|
+
readonly Oneh: "1h";
|
|
250
231
|
};
|
|
251
232
|
/**
|
|
252
|
-
* The
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
*
|
|
233
|
+
* The time-to-live for the cache control breakpoint. This may be one of the following values:
|
|
234
|
+
*
|
|
235
|
+
* @remarks
|
|
236
|
+
*
|
|
237
|
+
* - `5m`: 5 minutes
|
|
238
|
+
* - `1h`: 1 hour
|
|
239
|
+
*
|
|
240
|
+
* Defaults to `5m`. Only supported by `Anthropic` Claude models.
|
|
257
241
|
*/
|
|
258
|
-
export
|
|
259
|
-
|
|
260
|
-
readonly Disable: "disable";
|
|
261
|
-
readonly Minimal: "minimal";
|
|
262
|
-
readonly Low: "low";
|
|
263
|
-
readonly Medium: "medium";
|
|
264
|
-
readonly High: "high";
|
|
265
|
-
};
|
|
266
|
-
/**
|
|
267
|
-
* Constrains effort on reasoning for reasoning models. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.
|
|
268
|
-
*/
|
|
269
|
-
export type CreatePromptReasoningEffort = ClosedEnum<typeof CreatePromptReasoningEffort>;
|
|
270
|
-
/**
|
|
271
|
-
* Controls the verbosity of the model output.
|
|
272
|
-
*/
|
|
273
|
-
export declare const Verbosity: {
|
|
274
|
-
readonly Low: "low";
|
|
275
|
-
readonly Medium: "medium";
|
|
276
|
-
readonly High: "high";
|
|
277
|
-
};
|
|
278
|
-
/**
|
|
279
|
-
* Controls the verbosity of the model output.
|
|
280
|
-
*/
|
|
281
|
-
export type Verbosity = ClosedEnum<typeof Verbosity>;
|
|
282
|
-
/**
|
|
283
|
-
* The level of thinking to use for the model. Only supported by `Google AI`
|
|
284
|
-
*/
|
|
285
|
-
export declare const ThinkingLevel: {
|
|
286
|
-
readonly Low: "low";
|
|
287
|
-
readonly High: "high";
|
|
288
|
-
};
|
|
289
|
-
/**
|
|
290
|
-
* The level of thinking to use for the model. Only supported by `Google AI`
|
|
291
|
-
*/
|
|
292
|
-
export type ThinkingLevel = ClosedEnum<typeof ThinkingLevel>;
|
|
293
|
-
/**
|
|
294
|
-
* Optional model parameters like temperature and maxTokens.
|
|
295
|
-
*/
|
|
296
|
-
export type ModelParameters = {
|
|
297
|
-
/**
|
|
298
|
-
* Only supported on `chat` and `completion` models.
|
|
299
|
-
*/
|
|
300
|
-
temperature?: number | undefined;
|
|
301
|
-
/**
|
|
302
|
-
* Only supported on `chat` and `completion` models.
|
|
303
|
-
*/
|
|
304
|
-
maxTokens?: number | undefined;
|
|
305
|
-
/**
|
|
306
|
-
* Only supported on `chat` and `completion` models.
|
|
307
|
-
*/
|
|
308
|
-
topK?: number | undefined;
|
|
242
|
+
export type CreatePrompt2Ttl = ClosedEnum<typeof CreatePrompt2Ttl>;
|
|
243
|
+
export type CreatePrompt2CacheControl = {
|
|
309
244
|
/**
|
|
310
|
-
*
|
|
245
|
+
* Create a cache control breakpoint at this content block. Accepts only the value "ephemeral".
|
|
311
246
|
*/
|
|
312
|
-
|
|
247
|
+
type: CreatePrompt2PromptsType;
|
|
313
248
|
/**
|
|
314
|
-
*
|
|
249
|
+
* The time-to-live for the cache control breakpoint. This may be one of the following values:
|
|
250
|
+
*
|
|
251
|
+
* @remarks
|
|
252
|
+
*
|
|
253
|
+
* - `5m`: 5 minutes
|
|
254
|
+
* - `1h`: 1 hour
|
|
255
|
+
*
|
|
256
|
+
* Defaults to `5m`. Only supported by `Anthropic` Claude models.
|
|
315
257
|
*/
|
|
316
|
-
|
|
258
|
+
ttl?: CreatePrompt2Ttl | undefined;
|
|
259
|
+
};
|
|
260
|
+
export type CreatePrompt24 = {
|
|
317
261
|
/**
|
|
318
|
-
*
|
|
262
|
+
* The type of the content part. Always `file`.
|
|
319
263
|
*/
|
|
320
|
-
|
|
264
|
+
type: "file";
|
|
265
|
+
cacheControl?: CreatePrompt2CacheControl | undefined;
|
|
321
266
|
/**
|
|
322
|
-
*
|
|
267
|
+
* File data for the content part. Must contain either file_data or uri, but not both.
|
|
323
268
|
*/
|
|
324
|
-
|
|
269
|
+
file: components.FileContentPartSchema;
|
|
270
|
+
};
|
|
271
|
+
export type CreatePromptContent2 = (components.TextContentPartSchema & {
|
|
272
|
+
type: "text";
|
|
273
|
+
}) | components.ImageContentPartSchema | components.AudioContentPartSchema | CreatePrompt24;
|
|
274
|
+
/**
|
|
275
|
+
* The contents of the user message.
|
|
276
|
+
*/
|
|
277
|
+
export type CreatePromptMessagesPromptsContent = string | Array<(components.TextContentPartSchema & {
|
|
278
|
+
type: "text";
|
|
279
|
+
}) | components.ImageContentPartSchema | components.AudioContentPartSchema | CreatePrompt24>;
|
|
280
|
+
export type CreatePromptMessagesUserMessage = {
|
|
325
281
|
/**
|
|
326
|
-
*
|
|
282
|
+
* The role of the messages author, in this case `user`.
|
|
327
283
|
*/
|
|
328
|
-
|
|
284
|
+
role: "user";
|
|
329
285
|
/**
|
|
330
|
-
*
|
|
286
|
+
* An optional name for the participant. Provides the model information to differentiate between participants of the same role.
|
|
331
287
|
*/
|
|
332
|
-
|
|
288
|
+
name?: string | undefined;
|
|
333
289
|
/**
|
|
334
|
-
*
|
|
290
|
+
* The contents of the user message.
|
|
335
291
|
*/
|
|
336
|
-
|
|
292
|
+
content: string | Array<(components.TextContentPartSchema & {
|
|
293
|
+
type: "text";
|
|
294
|
+
}) | components.ImageContentPartSchema | components.AudioContentPartSchema | CreatePrompt24>;
|
|
295
|
+
};
|
|
296
|
+
/**
|
|
297
|
+
* The contents of the system message.
|
|
298
|
+
*/
|
|
299
|
+
export type CreatePromptMessagesContent = string | Array<components.TextContentPartSchema>;
|
|
300
|
+
/**
|
|
301
|
+
* Developer-provided instructions that the model should follow, regardless of messages sent by the user.
|
|
302
|
+
*/
|
|
303
|
+
export type CreatePromptMessagesSystemMessage = {
|
|
337
304
|
/**
|
|
338
|
-
*
|
|
305
|
+
* The role of the messages author, in this case `system`.
|
|
339
306
|
*/
|
|
340
|
-
|
|
307
|
+
role: "system";
|
|
341
308
|
/**
|
|
342
|
-
*
|
|
309
|
+
* The contents of the system message.
|
|
343
310
|
*/
|
|
344
|
-
|
|
311
|
+
content: string | Array<components.TextContentPartSchema>;
|
|
345
312
|
/**
|
|
346
|
-
* An
|
|
347
|
-
*
|
|
348
|
-
* @remarks
|
|
349
|
-
*
|
|
350
|
-
* Setting to `{ "type": "json_schema", "json_schema": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema
|
|
351
|
-
*
|
|
352
|
-
* Setting to `{ "type": "json_object" }` enables JSON mode, which ensures the message the model generates is valid JSON.
|
|
353
|
-
*
|
|
354
|
-
* Important: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly "stuck" request. Also note that the message content may be partially cut off if finish_reason="length", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length.
|
|
313
|
+
* An optional name for the participant. Provides the model information to differentiate between participants of the same role.
|
|
355
314
|
*/
|
|
356
|
-
|
|
315
|
+
name?: string | undefined;
|
|
316
|
+
};
|
|
317
|
+
export type CreatePromptMessages = CreatePromptMessagesSystemMessage | CreatePromptMessagesUserMessage | CreatePromptMessagesAssistantMessage | CreatePromptMessagesToolMessage;
|
|
318
|
+
/**
|
|
319
|
+
* The voice the model uses to respond. Supported voices are alloy, echo, fable, onyx, nova, and shimmer.
|
|
320
|
+
*/
|
|
321
|
+
export declare const CreatePromptVoice: {
|
|
322
|
+
readonly Alloy: "alloy";
|
|
323
|
+
readonly Echo: "echo";
|
|
324
|
+
readonly Fable: "fable";
|
|
325
|
+
readonly Onyx: "onyx";
|
|
326
|
+
readonly Nova: "nova";
|
|
327
|
+
readonly Shimmer: "shimmer";
|
|
328
|
+
};
|
|
329
|
+
/**
|
|
330
|
+
* The voice the model uses to respond. Supported voices are alloy, echo, fable, onyx, nova, and shimmer.
|
|
331
|
+
*/
|
|
332
|
+
export type CreatePromptVoice = ClosedEnum<typeof CreatePromptVoice>;
|
|
333
|
+
/**
|
|
334
|
+
* Specifies the output audio format. Must be one of wav, mp3, flac, opus, or pcm16.
|
|
335
|
+
*/
|
|
336
|
+
export declare const CreatePromptFormat: {
|
|
337
|
+
readonly Wav: "wav";
|
|
338
|
+
readonly Mp3: "mp3";
|
|
339
|
+
readonly Flac: "flac";
|
|
340
|
+
readonly Opus: "opus";
|
|
341
|
+
readonly Pcm16: "pcm16";
|
|
342
|
+
};
|
|
343
|
+
/**
|
|
344
|
+
* Specifies the output audio format. Must be one of wav, mp3, flac, opus, or pcm16.
|
|
345
|
+
*/
|
|
346
|
+
export type CreatePromptFormat = ClosedEnum<typeof CreatePromptFormat>;
|
|
347
|
+
/**
|
|
348
|
+
* Parameters for audio output. Required when audio output is requested with modalities: ["audio"]. Learn more.
|
|
349
|
+
*/
|
|
350
|
+
export type CreatePromptAudio = {
|
|
357
351
|
/**
|
|
358
|
-
* The
|
|
352
|
+
* The voice the model uses to respond. Supported voices are alloy, echo, fable, onyx, nova, and shimmer.
|
|
359
353
|
*/
|
|
360
|
-
|
|
354
|
+
voice: CreatePromptVoice;
|
|
361
355
|
/**
|
|
362
|
-
*
|
|
356
|
+
* Specifies the output audio format. Must be one of wav, mp3, flac, opus, or pcm16.
|
|
363
357
|
*/
|
|
364
|
-
|
|
358
|
+
format: CreatePromptFormat;
|
|
359
|
+
};
|
|
360
|
+
export type CreatePromptResponseFormatPromptsJsonSchema = {
|
|
365
361
|
/**
|
|
366
|
-
*
|
|
362
|
+
* A description of what the response format is for, used by the model to determine how to respond in the format.
|
|
367
363
|
*/
|
|
368
|
-
|
|
364
|
+
description?: string | undefined;
|
|
369
365
|
/**
|
|
370
|
-
*
|
|
366
|
+
* 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.
|
|
371
367
|
*/
|
|
372
|
-
|
|
368
|
+
name: string;
|
|
373
369
|
/**
|
|
374
|
-
*
|
|
370
|
+
* The schema for the response format, described as a JSON Schema object.
|
|
375
371
|
*/
|
|
376
|
-
|
|
372
|
+
schema?: any | undefined;
|
|
377
373
|
/**
|
|
378
|
-
*
|
|
374
|
+
* 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.
|
|
379
375
|
*/
|
|
380
|
-
|
|
376
|
+
strict?: boolean | undefined;
|
|
381
377
|
};
|
|
382
378
|
/**
|
|
383
|
-
*
|
|
379
|
+
* @remarks
|
|
384
380
|
*
|
|
385
|
-
*
|
|
381
|
+
* JSON Schema response format. Used to generate structured JSON responses
|
|
386
382
|
*/
|
|
387
|
-
export type
|
|
388
|
-
|
|
389
|
-
|
|
390
|
-
*/
|
|
391
|
-
model?: string | undefined;
|
|
392
|
-
/**
|
|
393
|
-
* Array of messages that make up the conversation.
|
|
394
|
-
*/
|
|
395
|
-
messages: Array<CreatePromptMessages>;
|
|
396
|
-
/**
|
|
397
|
-
* Optional model parameters like temperature and maxTokens.
|
|
398
|
-
*/
|
|
399
|
-
modelParameters?: ModelParameters | undefined;
|
|
383
|
+
export type CreatePromptResponseFormatJSONSchema = {
|
|
384
|
+
type: "json_schema";
|
|
385
|
+
jsonSchema: CreatePromptResponseFormatPromptsJsonSchema;
|
|
400
386
|
};
|
|
401
|
-
export type CreatePromptContentPromptsRequestRequestBody2 = components.TextContentPartSchema;
|
|
402
387
|
/**
|
|
403
|
-
*
|
|
388
|
+
* @remarks
|
|
389
|
+
*
|
|
390
|
+
* 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.
|
|
404
391
|
*/
|
|
405
|
-
export type
|
|
392
|
+
export type CreatePromptResponseFormatJSONObject = {
|
|
393
|
+
type: "json_object";
|
|
394
|
+
};
|
|
406
395
|
/**
|
|
407
|
-
*
|
|
396
|
+
* @remarks
|
|
397
|
+
*
|
|
398
|
+
* Default response format. Used to generate text responses
|
|
408
399
|
*/
|
|
409
|
-
export
|
|
410
|
-
|
|
400
|
+
export type CreatePromptResponseFormatText = {
|
|
401
|
+
type: "text";
|
|
411
402
|
};
|
|
412
403
|
/**
|
|
413
|
-
*
|
|
404
|
+
* An object specifying the format that the model must output
|
|
414
405
|
*/
|
|
415
|
-
export type
|
|
406
|
+
export type CreatePromptResponseFormat = CreatePromptResponseFormatText | CreatePromptResponseFormatJSONObject | CreatePromptResponseFormatJSONSchema;
|
|
416
407
|
/**
|
|
417
|
-
*
|
|
408
|
+
* Constrains effort on reasoning for [reasoning models](https://platform.openai.com/docs/guides/reasoning). Currently supported values are `none`, `minimal`, `low`, `medium`, `high`, and `xhigh`. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.
|
|
418
409
|
*
|
|
419
410
|
* @remarks
|
|
420
411
|
*
|
|
421
|
-
* - `
|
|
422
|
-
* - `
|
|
412
|
+
* - `gpt-5.1` defaults to `none`, which does not perform reasoning. The supported reasoning values for `gpt-5.1` are `none`, `low`, `medium`, and `high`. Tool calls are supported for all reasoning values in gpt-5.1.
|
|
413
|
+
* - All models before `gpt-5.1` default to `medium` reasoning effort, and do not support `none`.
|
|
414
|
+
* - The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort.
|
|
415
|
+
* - `xhigh` is currently only supported for `gpt-5.1-codex-max`.
|
|
423
416
|
*
|
|
424
|
-
*
|
|
417
|
+
* Any of "none", "minimal", "low", "medium", "high", "xhigh".
|
|
425
418
|
*/
|
|
426
|
-
export declare const
|
|
427
|
-
readonly
|
|
428
|
-
readonly
|
|
419
|
+
export declare const CreatePromptReasoningEffort: {
|
|
420
|
+
readonly None: "none";
|
|
421
|
+
readonly Minimal: "minimal";
|
|
422
|
+
readonly Low: "low";
|
|
423
|
+
readonly Medium: "medium";
|
|
424
|
+
readonly High: "high";
|
|
425
|
+
readonly Xhigh: "xhigh";
|
|
429
426
|
};
|
|
430
427
|
/**
|
|
431
|
-
*
|
|
428
|
+
* Constrains effort on reasoning for [reasoning models](https://platform.openai.com/docs/guides/reasoning). Currently supported values are `none`, `minimal`, `low`, `medium`, `high`, and `xhigh`. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.
|
|
432
429
|
*
|
|
433
430
|
* @remarks
|
|
434
431
|
*
|
|
435
|
-
* - `
|
|
436
|
-
* - `
|
|
432
|
+
* - `gpt-5.1` defaults to `none`, which does not perform reasoning. The supported reasoning values for `gpt-5.1` are `none`, `low`, `medium`, and `high`. Tool calls are supported for all reasoning values in gpt-5.1.
|
|
433
|
+
* - All models before `gpt-5.1` default to `medium` reasoning effort, and do not support `none`.
|
|
434
|
+
* - The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort.
|
|
435
|
+
* - `xhigh` is currently only supported for `gpt-5.1-codex-max`.
|
|
437
436
|
*
|
|
438
|
-
*
|
|
437
|
+
* Any of "none", "minimal", "low", "medium", "high", "xhigh".
|
|
439
438
|
*/
|
|
440
|
-
export type
|
|
441
|
-
export type CreatePromptMessagesCacheControl = {
|
|
442
|
-
/**
|
|
443
|
-
* Create a cache control breakpoint at this content block. Accepts only the value "ephemeral".
|
|
444
|
-
*/
|
|
445
|
-
type: CreatePromptMessagesPromptsType;
|
|
446
|
-
/**
|
|
447
|
-
* The time-to-live for the cache control breakpoint. This may be one of the following values:
|
|
448
|
-
*
|
|
449
|
-
* @remarks
|
|
450
|
-
*
|
|
451
|
-
* - `5m`: 5 minutes
|
|
452
|
-
* - `1h`: 1 hour
|
|
453
|
-
*
|
|
454
|
-
* Defaults to `5m`. Only supported by `Anthropic` Claude models.
|
|
455
|
-
*/
|
|
456
|
-
ttl?: CreatePromptMessagesTtl | undefined;
|
|
457
|
-
};
|
|
458
|
-
export type CreatePromptMessagesToolMessage = {
|
|
459
|
-
/**
|
|
460
|
-
* The role of the messages author, in this case tool.
|
|
461
|
-
*/
|
|
462
|
-
role: "tool";
|
|
463
|
-
/**
|
|
464
|
-
* The contents of the tool message.
|
|
465
|
-
*/
|
|
466
|
-
content: string | Array<components.TextContentPartSchema>;
|
|
467
|
-
/**
|
|
468
|
-
* Tool call that this message is responding to.
|
|
469
|
-
*/
|
|
470
|
-
toolCallId: string | null;
|
|
471
|
-
cacheControl?: CreatePromptMessagesCacheControl | undefined;
|
|
472
|
-
};
|
|
473
|
-
export type CreatePromptContentPromptsRequest2 = (components.TextContentPartSchema & {
|
|
474
|
-
type: "text";
|
|
475
|
-
}) | components.RefusalPartSchema | components.ReasoningPartSchema | components.RedactedReasoningPartSchema;
|
|
439
|
+
export type CreatePromptReasoningEffort = ClosedEnum<typeof CreatePromptReasoningEffort>;
|
|
476
440
|
/**
|
|
477
|
-
*
|
|
441
|
+
* Up to 4 sequences where the API will stop generating further tokens.
|
|
478
442
|
*/
|
|
479
|
-
export type
|
|
480
|
-
type: "text";
|
|
481
|
-
}) | components.RefusalPartSchema | components.ReasoningPartSchema | components.RedactedReasoningPartSchema>;
|
|
443
|
+
export type CreatePromptStop = string | Array<string>;
|
|
482
444
|
/**
|
|
483
|
-
*
|
|
445
|
+
* Options for streaming response. Only set this when you set stream: true.
|
|
484
446
|
*/
|
|
485
|
-
export type
|
|
447
|
+
export type CreatePromptStreamOptions = {
|
|
486
448
|
/**
|
|
487
|
-
*
|
|
449
|
+
* 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.
|
|
488
450
|
*/
|
|
489
|
-
|
|
451
|
+
includeUsage?: boolean | undefined;
|
|
490
452
|
};
|
|
453
|
+
export type CreatePromptThinking = components.ThinkingConfigDisabledSchema | components.ThinkingConfigEnabledSchema;
|
|
491
454
|
/**
|
|
492
|
-
* The type of the tool. Currently, only
|
|
455
|
+
* The type of the tool. Currently, only function is supported.
|
|
493
456
|
*/
|
|
494
|
-
export declare const
|
|
457
|
+
export declare const CreatePromptToolChoiceType: {
|
|
495
458
|
readonly Function: "function";
|
|
496
459
|
};
|
|
497
460
|
/**
|
|
498
|
-
* The type of the tool. Currently, only
|
|
461
|
+
* The type of the tool. Currently, only function is supported.
|
|
499
462
|
*/
|
|
500
|
-
export type
|
|
501
|
-
export type
|
|
463
|
+
export type CreatePromptToolChoiceType = ClosedEnum<typeof CreatePromptToolChoiceType>;
|
|
464
|
+
export type CreatePromptToolChoiceFunction = {
|
|
502
465
|
/**
|
|
503
466
|
* The name of the function to call.
|
|
504
467
|
*/
|
|
505
|
-
name
|
|
506
|
-
/**
|
|
507
|
-
* The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function.
|
|
508
|
-
*/
|
|
509
|
-
arguments?: string | undefined;
|
|
468
|
+
name: string;
|
|
510
469
|
};
|
|
511
|
-
export type
|
|
512
|
-
/**
|
|
513
|
-
* The ID of the tool call.
|
|
514
|
-
*/
|
|
515
|
-
id: string;
|
|
516
|
-
/**
|
|
517
|
-
* The type of the tool. Currently, only `function` is supported.
|
|
518
|
-
*/
|
|
519
|
-
type: CreatePromptMessagesType;
|
|
520
|
-
function: CreatePromptMessagesFunction;
|
|
470
|
+
export type CreatePromptToolChoice2 = {
|
|
521
471
|
/**
|
|
522
|
-
*
|
|
472
|
+
* The type of the tool. Currently, only function is supported.
|
|
523
473
|
*/
|
|
524
|
-
|
|
474
|
+
type?: CreatePromptToolChoiceType | undefined;
|
|
475
|
+
function: CreatePromptToolChoiceFunction;
|
|
525
476
|
};
|
|
526
|
-
export
|
|
527
|
-
|
|
528
|
-
|
|
529
|
-
|
|
530
|
-
content?: string | Array<(components.TextContentPartSchema & {
|
|
531
|
-
type: "text";
|
|
532
|
-
}) | components.RefusalPartSchema | components.ReasoningPartSchema | components.RedactedReasoningPartSchema> | null | undefined;
|
|
533
|
-
/**
|
|
534
|
-
* The refusal message by the assistant.
|
|
535
|
-
*/
|
|
536
|
-
refusal?: string | null | undefined;
|
|
537
|
-
/**
|
|
538
|
-
* The role of the messages author, in this case `assistant`.
|
|
539
|
-
*/
|
|
540
|
-
role: "assistant";
|
|
541
|
-
/**
|
|
542
|
-
* An optional name for the participant. Provides the model information to differentiate between participants of the same role.
|
|
543
|
-
*/
|
|
544
|
-
name?: string | undefined;
|
|
545
|
-
/**
|
|
546
|
-
* Data about a previous audio response from the model.
|
|
547
|
-
*/
|
|
548
|
-
audio?: CreatePromptMessagesAudio | null | undefined;
|
|
549
|
-
/**
|
|
550
|
-
* The tool calls generated by the model, such as function calls.
|
|
551
|
-
*/
|
|
552
|
-
toolCalls?: Array<CreatePromptMessagesToolCalls> | undefined;
|
|
477
|
+
export declare const CreatePromptToolChoice1: {
|
|
478
|
+
readonly None: "none";
|
|
479
|
+
readonly Auto: "auto";
|
|
480
|
+
readonly Required: "required";
|
|
553
481
|
};
|
|
482
|
+
export type CreatePromptToolChoice1 = ClosedEnum<typeof CreatePromptToolChoice1>;
|
|
554
483
|
/**
|
|
555
|
-
*
|
|
484
|
+
* Controls which (if any) tool is called by the model.
|
|
556
485
|
*/
|
|
557
|
-
export
|
|
558
|
-
|
|
486
|
+
export type CreatePromptToolChoice = CreatePromptToolChoice2 | CreatePromptToolChoice1;
|
|
487
|
+
export declare const CreatePromptModalities: {
|
|
488
|
+
readonly Text: "text";
|
|
489
|
+
readonly Audio: "audio";
|
|
559
490
|
};
|
|
491
|
+
export type CreatePromptModalities = ClosedEnum<typeof CreatePromptModalities>;
|
|
560
492
|
/**
|
|
561
|
-
*
|
|
493
|
+
* The key of the guardrail.
|
|
562
494
|
*/
|
|
563
|
-
export
|
|
495
|
+
export declare const CreatePromptId1: {
|
|
496
|
+
readonly OrqPiiDetection: "orq_pii_detection";
|
|
497
|
+
readonly OrqSexualModeration: "orq_sexual_moderation";
|
|
498
|
+
readonly OrqHarmfulModeration: "orq_harmful_moderation";
|
|
499
|
+
};
|
|
564
500
|
/**
|
|
565
|
-
* The
|
|
566
|
-
*
|
|
567
|
-
* @remarks
|
|
568
|
-
*
|
|
569
|
-
* - `5m`: 5 minutes
|
|
570
|
-
* - `1h`: 1 hour
|
|
571
|
-
*
|
|
572
|
-
* Defaults to `5m`. Only supported by `Anthropic` Claude models.
|
|
501
|
+
* The key of the guardrail.
|
|
573
502
|
*/
|
|
574
|
-
export
|
|
575
|
-
|
|
576
|
-
|
|
503
|
+
export type CreatePromptId1 = ClosedEnum<typeof CreatePromptId1>;
|
|
504
|
+
export type CreatePromptId = CreatePromptId1 | string;
|
|
505
|
+
/**
|
|
506
|
+
* Determines whether the guardrail runs on the input (user message) or output (model response).
|
|
507
|
+
*/
|
|
508
|
+
export declare const CreatePromptExecuteOn: {
|
|
509
|
+
readonly Input: "input";
|
|
510
|
+
readonly Output: "output";
|
|
577
511
|
};
|
|
578
512
|
/**
|
|
579
|
-
*
|
|
580
|
-
*
|
|
581
|
-
* @remarks
|
|
582
|
-
*
|
|
583
|
-
* - `5m`: 5 minutes
|
|
584
|
-
* - `1h`: 1 hour
|
|
585
|
-
*
|
|
586
|
-
* Defaults to `5m`. Only supported by `Anthropic` Claude models.
|
|
513
|
+
* Determines whether the guardrail runs on the input (user message) or output (model response).
|
|
587
514
|
*/
|
|
588
|
-
export type
|
|
589
|
-
export type
|
|
515
|
+
export type CreatePromptExecuteOn = ClosedEnum<typeof CreatePromptExecuteOn>;
|
|
516
|
+
export type CreatePromptGuardrails = {
|
|
517
|
+
id: CreatePromptId1 | string;
|
|
590
518
|
/**
|
|
591
|
-
*
|
|
519
|
+
* Determines whether the guardrail runs on the input (user message) or output (model response).
|
|
592
520
|
*/
|
|
593
|
-
|
|
521
|
+
executeOn: CreatePromptExecuteOn;
|
|
522
|
+
};
|
|
523
|
+
/**
|
|
524
|
+
* Prompt configuration with model and messages.
|
|
525
|
+
*/
|
|
526
|
+
export type PromptInput = {
|
|
594
527
|
/**
|
|
595
|
-
*
|
|
528
|
+
* Array of messages that make up the conversation. Each message has a role (system, user, assistant, or tool) and content.
|
|
529
|
+
*/
|
|
530
|
+
messages: Array<CreatePromptMessagesSystemMessage | CreatePromptMessagesUserMessage | CreatePromptMessagesAssistantMessage | CreatePromptMessagesToolMessage>;
|
|
531
|
+
/**
|
|
532
|
+
* Model ID used to generate the response, like `openai/gpt-4o` or `anthropic/claude-3-5-sonnet-20241022`. For private models, use format: `{workspaceKey}@{provider}/{model}`. The full list of models can be found at https://docs.orq.ai/docs/ai-gateway-supported-models. Only chat models are supported.
|
|
533
|
+
*/
|
|
534
|
+
model?: string | undefined;
|
|
535
|
+
/**
|
|
536
|
+
* Parameters for audio output. Required when audio output is requested with modalities: ["audio"]. Learn more.
|
|
537
|
+
*/
|
|
538
|
+
audio?: CreatePromptAudio | null | undefined;
|
|
539
|
+
/**
|
|
540
|
+
* 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.
|
|
541
|
+
*/
|
|
542
|
+
frequencyPenalty?: number | null | undefined;
|
|
543
|
+
/**
|
|
544
|
+
* `[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.
|
|
596
545
|
*
|
|
597
546
|
* @remarks
|
|
598
547
|
*
|
|
599
|
-
*
|
|
600
|
-
* - `1h`: 1 hour
|
|
601
|
-
*
|
|
602
|
-
* Defaults to `5m`. Only supported by `Anthropic` Claude models.
|
|
548
|
+
* This value is now `deprecated` in favor of `max_completion_tokens`, and is not compatible with o1 series models.
|
|
603
549
|
*/
|
|
604
|
-
|
|
605
|
-
};
|
|
606
|
-
export type CreatePrompt24 = {
|
|
550
|
+
maxTokens?: number | null | undefined;
|
|
607
551
|
/**
|
|
608
|
-
*
|
|
552
|
+
* An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and reasoning tokens
|
|
609
553
|
*/
|
|
610
|
-
|
|
611
|
-
cacheControl?: CreatePrompt2CacheControl | undefined;
|
|
554
|
+
maxCompletionTokens?: number | null | undefined;
|
|
612
555
|
/**
|
|
613
|
-
*
|
|
556
|
+
* 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.
|
|
614
557
|
*/
|
|
615
|
-
|
|
616
|
-
};
|
|
617
|
-
export type CreatePromptContentPrompts2 = (components.TextContentPartSchema & {
|
|
618
|
-
type: "text";
|
|
619
|
-
}) | components.ImageContentPartSchema | components.AudioContentPartSchema | CreatePrompt24;
|
|
620
|
-
/**
|
|
621
|
-
* The contents of the user message.
|
|
622
|
-
*/
|
|
623
|
-
export type CreatePromptMessagesPromptsContent = string | Array<(components.TextContentPartSchema & {
|
|
624
|
-
type: "text";
|
|
625
|
-
}) | components.ImageContentPartSchema | components.AudioContentPartSchema | CreatePrompt24>;
|
|
626
|
-
export type CreatePromptMessagesUserMessage = {
|
|
558
|
+
logprobs?: boolean | null | undefined;
|
|
627
559
|
/**
|
|
628
|
-
*
|
|
560
|
+
* 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.
|
|
629
561
|
*/
|
|
630
|
-
|
|
562
|
+
topLogprobs?: number | null | undefined;
|
|
631
563
|
/**
|
|
632
|
-
*
|
|
564
|
+
* 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.
|
|
633
565
|
*/
|
|
634
|
-
|
|
566
|
+
n?: number | null | undefined;
|
|
635
567
|
/**
|
|
636
|
-
*
|
|
568
|
+
* 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.
|
|
637
569
|
*/
|
|
638
|
-
|
|
639
|
-
type: "text";
|
|
640
|
-
}) | components.ImageContentPartSchema | components.AudioContentPartSchema | CreatePrompt24>;
|
|
641
|
-
};
|
|
642
|
-
/**
|
|
643
|
-
* The contents of the system message.
|
|
644
|
-
*/
|
|
645
|
-
export type CreatePromptMessagesContent = string | Array<components.TextContentPartSchema>;
|
|
646
|
-
/**
|
|
647
|
-
* Developer-provided instructions that the model should follow, regardless of messages sent by the user.
|
|
648
|
-
*/
|
|
649
|
-
export type CreatePromptMessagesSystemMessage = {
|
|
570
|
+
presencePenalty?: number | null | undefined;
|
|
650
571
|
/**
|
|
651
|
-
*
|
|
572
|
+
* An object specifying the format that the model must output
|
|
652
573
|
*/
|
|
653
|
-
|
|
574
|
+
responseFormat?: CreatePromptResponseFormatText | CreatePromptResponseFormatJSONObject | CreatePromptResponseFormatJSONSchema | undefined;
|
|
654
575
|
/**
|
|
655
|
-
*
|
|
576
|
+
* Constrains effort on reasoning for [reasoning models](https://platform.openai.com/docs/guides/reasoning). Currently supported values are `none`, `minimal`, `low`, `medium`, `high`, and `xhigh`. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.
|
|
577
|
+
*
|
|
578
|
+
* @remarks
|
|
579
|
+
*
|
|
580
|
+
* - `gpt-5.1` defaults to `none`, which does not perform reasoning. The supported reasoning values for `gpt-5.1` are `none`, `low`, `medium`, and `high`. Tool calls are supported for all reasoning values in gpt-5.1.
|
|
581
|
+
* - All models before `gpt-5.1` default to `medium` reasoning effort, and do not support `none`.
|
|
582
|
+
* - The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort.
|
|
583
|
+
* - `xhigh` is currently only supported for `gpt-5.1-codex-max`.
|
|
584
|
+
*
|
|
585
|
+
* Any of "none", "minimal", "low", "medium", "high", "xhigh".
|
|
656
586
|
*/
|
|
657
|
-
|
|
587
|
+
reasoningEffort?: CreatePromptReasoningEffort | undefined;
|
|
658
588
|
/**
|
|
659
|
-
*
|
|
589
|
+
* Adjusts response verbosity. Lower levels yield shorter answers.
|
|
660
590
|
*/
|
|
661
|
-
|
|
662
|
-
};
|
|
663
|
-
export type CreatePromptPromptsMessages = CreatePromptMessagesSystemMessage | CreatePromptMessagesUserMessage | CreatePromptMessagesAssistantMessage | CreatePromptMessagesToolMessage;
|
|
664
|
-
export type CreatePromptResponseFormatPromptsRequestJsonSchema = {
|
|
591
|
+
verbosity?: string | undefined;
|
|
665
592
|
/**
|
|
666
|
-
*
|
|
593
|
+
* 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.
|
|
667
594
|
*/
|
|
668
|
-
|
|
595
|
+
seed?: number | null | undefined;
|
|
669
596
|
/**
|
|
670
|
-
*
|
|
597
|
+
* Up to 4 sequences where the API will stop generating further tokens.
|
|
671
598
|
*/
|
|
672
|
-
|
|
599
|
+
stop?: string | Array<string> | null | undefined;
|
|
673
600
|
/**
|
|
674
|
-
*
|
|
601
|
+
* Options for streaming response. Only set this when you set stream: true.
|
|
675
602
|
*/
|
|
676
|
-
|
|
603
|
+
streamOptions?: CreatePromptStreamOptions | null | undefined;
|
|
604
|
+
thinking?: components.ThinkingConfigDisabledSchema | components.ThinkingConfigEnabledSchema | undefined;
|
|
677
605
|
/**
|
|
678
|
-
*
|
|
606
|
+
* 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.
|
|
679
607
|
*/
|
|
680
|
-
|
|
681
|
-
};
|
|
682
|
-
/**
|
|
683
|
-
* @remarks
|
|
684
|
-
*
|
|
685
|
-
* JSON Schema response format. Used to generate structured JSON responses
|
|
686
|
-
*/
|
|
687
|
-
export type CreatePromptResponseFormatPromptsJSONSchema = {
|
|
688
|
-
type: "json_schema";
|
|
689
|
-
jsonSchema: CreatePromptResponseFormatPromptsRequestJsonSchema;
|
|
690
|
-
};
|
|
691
|
-
/**
|
|
692
|
-
* @remarks
|
|
693
|
-
*
|
|
694
|
-
* 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.
|
|
695
|
-
*/
|
|
696
|
-
export type CreatePromptResponseFormatJSONObject = {
|
|
697
|
-
type: "json_object";
|
|
698
|
-
};
|
|
699
|
-
/**
|
|
700
|
-
* @remarks
|
|
701
|
-
*
|
|
702
|
-
* Default response format. Used to generate text responses
|
|
703
|
-
*/
|
|
704
|
-
export type CreatePromptResponseFormatText = {
|
|
705
|
-
type: "text";
|
|
706
|
-
};
|
|
707
|
-
/**
|
|
708
|
-
* An object specifying the format that the model must output
|
|
709
|
-
*/
|
|
710
|
-
export type CreatePromptPromptsResponseFormat = CreatePromptResponseFormatText | CreatePromptResponseFormatJSONObject | CreatePromptResponseFormatPromptsJSONSchema;
|
|
711
|
-
/**
|
|
712
|
-
* Prompt configuration with model and messages. Either this field or `prompt_config` must be provided.
|
|
713
|
-
*/
|
|
714
|
-
export type PromptInput = {
|
|
608
|
+
temperature?: number | null | undefined;
|
|
715
609
|
/**
|
|
716
|
-
*
|
|
610
|
+
* An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass.
|
|
717
611
|
*/
|
|
718
|
-
|
|
612
|
+
topP?: number | null | undefined;
|
|
719
613
|
/**
|
|
720
|
-
*
|
|
614
|
+
* Limits the model to consider only the top k most likely tokens at each step.
|
|
721
615
|
*/
|
|
722
|
-
|
|
616
|
+
topK?: number | null | undefined;
|
|
723
617
|
/**
|
|
724
|
-
*
|
|
618
|
+
* Controls which (if any) tool is called by the model.
|
|
725
619
|
*/
|
|
726
|
-
|
|
620
|
+
toolChoice?: CreatePromptToolChoice2 | CreatePromptToolChoice1 | undefined;
|
|
727
621
|
/**
|
|
728
|
-
*
|
|
729
|
-
*
|
|
730
|
-
* @remarks
|
|
731
|
-
*
|
|
732
|
-
* This value is now `deprecated` in favor of `max_completion_tokens`, and is not compatible with o1 series models.
|
|
622
|
+
* Whether to enable parallel function calling during tool use.
|
|
733
623
|
*/
|
|
734
|
-
|
|
624
|
+
parallelToolCalls?: boolean | undefined;
|
|
735
625
|
/**
|
|
736
|
-
*
|
|
626
|
+
* 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"].
|
|
627
|
+
*/
|
|
628
|
+
modalities?: Array<CreatePromptModalities> | null | undefined;
|
|
629
|
+
/**
|
|
630
|
+
* A list of guardrails to apply to the request.
|
|
737
631
|
*/
|
|
738
|
-
|
|
632
|
+
guardrails?: Array<CreatePromptGuardrails> | undefined;
|
|
739
633
|
};
|
|
740
634
|
export type CreatePromptRequestBody = {
|
|
741
635
|
/**
|
|
@@ -748,13 +642,7 @@ export type CreatePromptRequestBody = {
|
|
|
748
642
|
description?: string | null | undefined;
|
|
749
643
|
metadata?: CreatePromptMetadata | undefined;
|
|
750
644
|
/**
|
|
751
|
-
*
|
|
752
|
-
*
|
|
753
|
-
* @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
|
|
754
|
-
*/
|
|
755
|
-
promptConfig?: PromptConfiguration | undefined;
|
|
756
|
-
/**
|
|
757
|
-
* Prompt configuration with model and messages. Either this field or `prompt_config` must be provided.
|
|
645
|
+
* Prompt configuration with model and messages.
|
|
758
646
|
*/
|
|
759
647
|
prompt?: PromptInput | undefined;
|
|
760
648
|
/**
|
|
@@ -768,14 +656,14 @@ export type CreatePromptRequestBody = {
|
|
|
768
656
|
*/
|
|
769
657
|
path: string;
|
|
770
658
|
};
|
|
771
|
-
export declare const
|
|
659
|
+
export declare const CreatePromptType: {
|
|
772
660
|
readonly Prompt: "prompt";
|
|
773
661
|
};
|
|
774
|
-
export type
|
|
662
|
+
export type CreatePromptType = ClosedEnum<typeof CreatePromptType>;
|
|
775
663
|
/**
|
|
776
664
|
* The modality of the model
|
|
777
665
|
*/
|
|
778
|
-
export declare const
|
|
666
|
+
export declare const ModelType: {
|
|
779
667
|
readonly Chat: "chat";
|
|
780
668
|
readonly Completion: "completion";
|
|
781
669
|
readonly Embedding: "embedding";
|
|
@@ -789,7 +677,7 @@ export declare const CreatePromptModelType: {
|
|
|
789
677
|
/**
|
|
790
678
|
* The modality of the model
|
|
791
679
|
*/
|
|
792
|
-
export type
|
|
680
|
+
export type ModelType = ClosedEnum<typeof ModelType>;
|
|
793
681
|
/**
|
|
794
682
|
* Only supported on `image` models.
|
|
795
683
|
*/
|
|
@@ -825,25 +713,25 @@ export declare const CreatePromptResponseFormat4: {
|
|
|
825
713
|
readonly Pcm: "pcm";
|
|
826
714
|
};
|
|
827
715
|
export type CreatePromptResponseFormat4 = ClosedEnum<typeof CreatePromptResponseFormat4>;
|
|
828
|
-
export declare const
|
|
716
|
+
export declare const CreatePromptResponseFormatPromptsResponse200ApplicationJSONResponseBodyPromptConfigModelParametersType: {
|
|
829
717
|
readonly Text: "text";
|
|
830
718
|
};
|
|
831
|
-
export type
|
|
719
|
+
export type CreatePromptResponseFormatPromptsResponse200ApplicationJSONResponseBodyPromptConfigModelParametersType = ClosedEnum<typeof CreatePromptResponseFormatPromptsResponse200ApplicationJSONResponseBodyPromptConfigModelParametersType>;
|
|
832
720
|
export type CreatePromptResponseFormat3 = {
|
|
833
|
-
type:
|
|
721
|
+
type: CreatePromptResponseFormatPromptsResponse200ApplicationJSONResponseBodyPromptConfigModelParametersType;
|
|
834
722
|
};
|
|
835
|
-
export declare const
|
|
723
|
+
export declare const CreatePromptResponseFormatPromptsResponse200ApplicationJSONResponseBodyPromptConfigType: {
|
|
836
724
|
readonly JsonObject: "json_object";
|
|
837
725
|
};
|
|
838
|
-
export type
|
|
726
|
+
export type CreatePromptResponseFormatPromptsResponse200ApplicationJSONResponseBodyPromptConfigType = ClosedEnum<typeof CreatePromptResponseFormatPromptsResponse200ApplicationJSONResponseBodyPromptConfigType>;
|
|
839
727
|
export type CreatePromptResponseFormat2 = {
|
|
840
|
-
type:
|
|
728
|
+
type: CreatePromptResponseFormatPromptsResponse200ApplicationJSONResponseBodyPromptConfigType;
|
|
841
729
|
};
|
|
842
|
-
export declare const
|
|
730
|
+
export declare const CreatePromptResponseFormatPromptsResponse200ApplicationJSONResponseBodyType: {
|
|
843
731
|
readonly JsonSchema: "json_schema";
|
|
844
732
|
};
|
|
845
|
-
export type
|
|
846
|
-
export type
|
|
733
|
+
export type CreatePromptResponseFormatPromptsResponse200ApplicationJSONResponseBodyType = ClosedEnum<typeof CreatePromptResponseFormatPromptsResponse200ApplicationJSONResponseBodyType>;
|
|
734
|
+
export type CreatePromptResponseFormatPromptsResponse200ApplicationJSONJSONSchema = {
|
|
847
735
|
name: string;
|
|
848
736
|
description?: string | undefined;
|
|
849
737
|
strict?: boolean | undefined;
|
|
@@ -852,9 +740,9 @@ export type CreatePromptResponseFormatPromptsResponseJsonSchema = {
|
|
|
852
740
|
};
|
|
853
741
|
};
|
|
854
742
|
export type CreatePromptResponseFormat1 = {
|
|
855
|
-
type:
|
|
743
|
+
type: CreatePromptResponseFormatPromptsResponse200ApplicationJSONResponseBodyType;
|
|
856
744
|
displayName?: string | undefined;
|
|
857
|
-
jsonSchema:
|
|
745
|
+
jsonSchema: CreatePromptResponseFormatPromptsResponse200ApplicationJSONJSONSchema;
|
|
858
746
|
};
|
|
859
747
|
/**
|
|
860
748
|
* An object specifying the format that the model must output.
|
|
@@ -893,7 +781,7 @@ export type CreatePromptEncodingFormat = ClosedEnum<typeof CreatePromptEncodingF
|
|
|
893
781
|
/**
|
|
894
782
|
* Constrains effort on reasoning for reasoning models. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.
|
|
895
783
|
*/
|
|
896
|
-
export declare const
|
|
784
|
+
export declare const CreatePromptPromptsResponseReasoningEffort: {
|
|
897
785
|
readonly None: "none";
|
|
898
786
|
readonly Disable: "disable";
|
|
899
787
|
readonly Minimal: "minimal";
|
|
@@ -904,7 +792,7 @@ export declare const CreatePromptPromptsReasoningEffort: {
|
|
|
904
792
|
/**
|
|
905
793
|
* Constrains effort on reasoning for reasoning models. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.
|
|
906
794
|
*/
|
|
907
|
-
export type
|
|
795
|
+
export type CreatePromptPromptsResponseReasoningEffort = ClosedEnum<typeof CreatePromptPromptsResponseReasoningEffort>;
|
|
908
796
|
/**
|
|
909
797
|
* Controls the verbosity of the model output.
|
|
910
798
|
*/
|
|
@@ -931,7 +819,7 @@ export type CreatePromptThinkingLevel = ClosedEnum<typeof CreatePromptThinkingLe
|
|
|
931
819
|
/**
|
|
932
820
|
* Model Parameters: Not all parameters apply to every model
|
|
933
821
|
*/
|
|
934
|
-
export type
|
|
822
|
+
export type ModelParameters = {
|
|
935
823
|
/**
|
|
936
824
|
* Only supported on `chat` and `completion` models.
|
|
937
825
|
*/
|
|
@@ -1003,7 +891,7 @@ export type CreatePromptModelParameters = {
|
|
|
1003
891
|
/**
|
|
1004
892
|
* Constrains effort on reasoning for reasoning models. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.
|
|
1005
893
|
*/
|
|
1006
|
-
reasoningEffort?:
|
|
894
|
+
reasoningEffort?: CreatePromptPromptsResponseReasoningEffort | undefined;
|
|
1007
895
|
/**
|
|
1008
896
|
* Gives the model enhanced reasoning capabilities for complex tasks. A value of 0 disables thinking. The minimum budget tokens for thinking are 1024. The Budget Tokens should never exceed the Max Tokens parameter. Only supported by `Anthropic`
|
|
1009
897
|
*/
|
|
@@ -1049,7 +937,7 @@ export type CreatePromptProvider = ClosedEnum<typeof CreatePromptProvider>;
|
|
|
1049
937
|
/**
|
|
1050
938
|
* The role of the prompt message
|
|
1051
939
|
*/
|
|
1052
|
-
export declare const
|
|
940
|
+
export declare const CreatePromptRole: {
|
|
1053
941
|
readonly System: "system";
|
|
1054
942
|
readonly Assistant: "assistant";
|
|
1055
943
|
readonly User: "user";
|
|
@@ -1062,7 +950,7 @@ export declare const CreatePromptPromptsRole: {
|
|
|
1062
950
|
/**
|
|
1063
951
|
* The role of the prompt message
|
|
1064
952
|
*/
|
|
1065
|
-
export type
|
|
953
|
+
export type CreatePromptRole = ClosedEnum<typeof CreatePromptRole>;
|
|
1066
954
|
export type CreatePrompt2File = {
|
|
1067
955
|
/**
|
|
1068
956
|
* The file data as a data URI string in the format 'data:<mime-type>;base64,<base64-encoded-data>'. Example: 'data:image/png;base64,iVBORw0KGgoAAAANS...'
|
|
@@ -1105,7 +993,7 @@ export type CreatePrompt2ImageUrl = {
|
|
|
1105
993
|
/**
|
|
1106
994
|
* The image part of the prompt message. Only supported with vision models.
|
|
1107
995
|
*/
|
|
1108
|
-
export type
|
|
996
|
+
export type CreatePrompt22 = {
|
|
1109
997
|
type: "image_url";
|
|
1110
998
|
imageUrl: CreatePrompt2ImageUrl;
|
|
1111
999
|
};
|
|
@@ -1116,46 +1004,48 @@ export type CreatePrompt21 = {
|
|
|
1116
1004
|
type: "text";
|
|
1117
1005
|
text: string;
|
|
1118
1006
|
};
|
|
1119
|
-
export type CreatePromptContentPromptsResponse2 = CreatePrompt21 |
|
|
1007
|
+
export type CreatePromptContentPromptsResponse2 = CreatePrompt21 | CreatePrompt22 | CreatePrompt23;
|
|
1120
1008
|
/**
|
|
1121
1009
|
* The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. Can be null for tool messages in certain scenarios.
|
|
1122
1010
|
*/
|
|
1123
|
-
export type
|
|
1124
|
-
export declare const
|
|
1011
|
+
export type CreatePromptContent = string | Array<CreatePrompt21 | CreatePrompt22 | CreatePrompt23>;
|
|
1012
|
+
export declare const CreatePromptPromptsType: {
|
|
1125
1013
|
readonly Function: "function";
|
|
1126
1014
|
};
|
|
1127
|
-
export type
|
|
1128
|
-
export type
|
|
1015
|
+
export type CreatePromptPromptsType = ClosedEnum<typeof CreatePromptPromptsType>;
|
|
1016
|
+
export type CreatePromptFunction = {
|
|
1129
1017
|
name: string;
|
|
1130
1018
|
/**
|
|
1131
1019
|
* JSON string arguments for the functions
|
|
1132
1020
|
*/
|
|
1133
1021
|
arguments: string;
|
|
1134
1022
|
};
|
|
1135
|
-
export type
|
|
1023
|
+
export type CreatePromptToolCalls = {
|
|
1136
1024
|
id?: string | undefined;
|
|
1137
1025
|
index?: number | undefined;
|
|
1138
|
-
type:
|
|
1139
|
-
function:
|
|
1026
|
+
type: CreatePromptPromptsType;
|
|
1027
|
+
function: CreatePromptFunction;
|
|
1140
1028
|
};
|
|
1141
|
-
export type
|
|
1029
|
+
export type CreatePromptPromptsMessages = {
|
|
1142
1030
|
/**
|
|
1143
1031
|
* The role of the prompt message
|
|
1144
1032
|
*/
|
|
1145
|
-
role:
|
|
1033
|
+
role: CreatePromptRole;
|
|
1146
1034
|
/**
|
|
1147
1035
|
* The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. Can be null for tool messages in certain scenarios.
|
|
1148
1036
|
*/
|
|
1149
|
-
content: string | Array<CreatePrompt21 |
|
|
1150
|
-
toolCalls?: Array<
|
|
1037
|
+
content: string | Array<CreatePrompt21 | CreatePrompt22 | CreatePrompt23> | null;
|
|
1038
|
+
toolCalls?: Array<CreatePromptToolCalls> | undefined;
|
|
1151
1039
|
toolCallId?: string | null | undefined;
|
|
1152
1040
|
};
|
|
1153
1041
|
/**
|
|
1154
|
-
* A list of messages compatible with the openAI schema
|
|
1042
|
+
* [DEPRECATED] Use the `prompt` property instead. A list of messages compatible with the openAI schema.
|
|
1043
|
+
*
|
|
1044
|
+
* @deprecated class: This will be removed in a future release, please migrate away from it as soon as possible.
|
|
1155
1045
|
*/
|
|
1156
|
-
export type
|
|
1046
|
+
export type PromptConfig = {
|
|
1157
1047
|
stream?: boolean | undefined;
|
|
1158
|
-
model?: string | undefined;
|
|
1048
|
+
model?: string | null | undefined;
|
|
1159
1049
|
/**
|
|
1160
1050
|
* The id of the resource
|
|
1161
1051
|
*/
|
|
@@ -1163,382 +1053,707 @@ export type CreatePromptPromptConfig = {
|
|
|
1163
1053
|
/**
|
|
1164
1054
|
* The modality of the model
|
|
1165
1055
|
*/
|
|
1166
|
-
modelType?:
|
|
1056
|
+
modelType?: ModelType | null | undefined;
|
|
1167
1057
|
/**
|
|
1168
1058
|
* Model Parameters: Not all parameters apply to every model
|
|
1169
1059
|
*/
|
|
1170
|
-
modelParameters?:
|
|
1171
|
-
provider?: CreatePromptProvider | undefined;
|
|
1060
|
+
modelParameters?: ModelParameters | undefined;
|
|
1061
|
+
provider?: CreatePromptProvider | null | undefined;
|
|
1172
1062
|
/**
|
|
1173
1063
|
* The ID of the integration to use
|
|
1174
1064
|
*/
|
|
1175
1065
|
integrationId?: string | null | undefined;
|
|
1176
1066
|
version?: string | undefined;
|
|
1177
|
-
messages: Array<
|
|
1067
|
+
messages: Array<CreatePromptPromptsMessages>;
|
|
1178
1068
|
};
|
|
1179
|
-
|
|
1180
|
-
|
|
1181
|
-
|
|
1182
|
-
|
|
1183
|
-
readonly
|
|
1184
|
-
readonly
|
|
1185
|
-
readonly
|
|
1186
|
-
readonly
|
|
1187
|
-
readonly
|
|
1188
|
-
readonly
|
|
1189
|
-
readonly DocumentsQA: "Documents QA";
|
|
1190
|
-
readonly Evaluation: "Evaluation";
|
|
1191
|
-
readonly Extraction: "Extraction";
|
|
1192
|
-
readonly MultiModal: "Multi-modal";
|
|
1193
|
-
readonly SelfChecking: "Self-checking";
|
|
1194
|
-
readonly SentimentAnalysis: "Sentiment analysis";
|
|
1195
|
-
readonly Sql: "SQL";
|
|
1196
|
-
readonly Summarization: "Summarization";
|
|
1197
|
-
readonly Tagging: "Tagging";
|
|
1198
|
-
readonly TranslationDocument: "Translation (document)";
|
|
1199
|
-
readonly TranslationSentences: "Translation (sentences)";
|
|
1069
|
+
/**
|
|
1070
|
+
* The voice the model uses to respond. Supported voices are alloy, echo, fable, onyx, nova, and shimmer.
|
|
1071
|
+
*/
|
|
1072
|
+
export declare const CreatePromptPromptsVoice: {
|
|
1073
|
+
readonly Alloy: "alloy";
|
|
1074
|
+
readonly Echo: "echo";
|
|
1075
|
+
readonly Fable: "fable";
|
|
1076
|
+
readonly Onyx: "onyx";
|
|
1077
|
+
readonly Nova: "nova";
|
|
1078
|
+
readonly Shimmer: "shimmer";
|
|
1200
1079
|
};
|
|
1201
|
-
export type CreatePromptUseCases = ClosedEnum<typeof CreatePromptUseCases>;
|
|
1202
1080
|
/**
|
|
1203
|
-
* The
|
|
1081
|
+
* The voice the model uses to respond. Supported voices are alloy, echo, fable, onyx, nova, and shimmer.
|
|
1204
1082
|
*/
|
|
1205
|
-
export
|
|
1206
|
-
|
|
1207
|
-
|
|
1208
|
-
|
|
1209
|
-
|
|
1210
|
-
readonly
|
|
1211
|
-
readonly
|
|
1212
|
-
readonly
|
|
1083
|
+
export type CreatePromptPromptsVoice = ClosedEnum<typeof CreatePromptPromptsVoice>;
|
|
1084
|
+
/**
|
|
1085
|
+
* Specifies the output audio format. Must be one of wav, mp3, flac, opus, or pcm16.
|
|
1086
|
+
*/
|
|
1087
|
+
export declare const CreatePromptPromptsResponse200Format: {
|
|
1088
|
+
readonly Wav: "wav";
|
|
1089
|
+
readonly Mp3: "mp3";
|
|
1090
|
+
readonly Flac: "flac";
|
|
1091
|
+
readonly Opus: "opus";
|
|
1092
|
+
readonly Pcm16: "pcm16";
|
|
1213
1093
|
};
|
|
1214
1094
|
/**
|
|
1215
|
-
*
|
|
1095
|
+
* Specifies the output audio format. Must be one of wav, mp3, flac, opus, or pcm16.
|
|
1216
1096
|
*/
|
|
1217
|
-
export type
|
|
1218
|
-
|
|
1097
|
+
export type CreatePromptPromptsResponse200Format = ClosedEnum<typeof CreatePromptPromptsResponse200Format>;
|
|
1098
|
+
/**
|
|
1099
|
+
* Parameters for audio output. Required when audio output is requested with modalities: ["audio"]. Learn more.
|
|
1100
|
+
*/
|
|
1101
|
+
export type CreatePromptPromptsAudio = {
|
|
1219
1102
|
/**
|
|
1220
|
-
*
|
|
1103
|
+
* The voice the model uses to respond. Supported voices are alloy, echo, fable, onyx, nova, and shimmer.
|
|
1221
1104
|
*/
|
|
1222
|
-
|
|
1105
|
+
voice: CreatePromptPromptsVoice;
|
|
1223
1106
|
/**
|
|
1224
|
-
*
|
|
1107
|
+
* Specifies the output audio format. Must be one of wav, mp3, flac, opus, or pcm16.
|
|
1225
1108
|
*/
|
|
1226
|
-
|
|
1109
|
+
format: CreatePromptPromptsResponse200Format;
|
|
1227
1110
|
};
|
|
1228
|
-
|
|
1229
|
-
* A prompt entity with configuration, metadata, and versioning.
|
|
1230
|
-
*/
|
|
1231
|
-
export type CreatePromptPrompt = {
|
|
1232
|
-
id: string;
|
|
1233
|
-
type: CreatePromptPromptsType;
|
|
1234
|
-
owner: string;
|
|
1235
|
-
domainId: string;
|
|
1236
|
-
created: string;
|
|
1237
|
-
updated: string;
|
|
1238
|
-
createdById?: string | null | undefined;
|
|
1239
|
-
updatedById?: string | null | undefined;
|
|
1111
|
+
export type CreatePromptResponseFormatPromptsResponseJsonSchema = {
|
|
1240
1112
|
/**
|
|
1241
|
-
*
|
|
1113
|
+
* A description of what the response format is for, used by the model to determine how to respond in the format.
|
|
1242
1114
|
*/
|
|
1243
|
-
|
|
1115
|
+
description?: string | undefined;
|
|
1244
1116
|
/**
|
|
1245
|
-
* The
|
|
1117
|
+
* 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.
|
|
1246
1118
|
*/
|
|
1247
|
-
|
|
1119
|
+
name: string;
|
|
1248
1120
|
/**
|
|
1249
|
-
*
|
|
1121
|
+
* The schema for the response format, described as a JSON Schema object.
|
|
1250
1122
|
*/
|
|
1251
|
-
|
|
1252
|
-
|
|
1123
|
+
schema?: any | undefined;
|
|
1124
|
+
/**
|
|
1125
|
+
* 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.
|
|
1126
|
+
*/
|
|
1127
|
+
strict?: boolean | undefined;
|
|
1253
1128
|
};
|
|
1254
|
-
/**
|
|
1255
|
-
|
|
1256
|
-
|
|
1257
|
-
|
|
1258
|
-
|
|
1259
|
-
export
|
|
1260
|
-
|
|
1261
|
-
|
|
1262
|
-
/** @internal */
|
|
1263
|
-
export declare const CreatePromptMetadata$inboundSchema: z.ZodType<CreatePromptMetadata, z.ZodTypeDef, unknown>;
|
|
1264
|
-
/** @internal */
|
|
1265
|
-
export type CreatePromptMetadata$Outbound = {
|
|
1266
|
-
use_cases?: Array<string> | undefined;
|
|
1267
|
-
language?: string | null | undefined;
|
|
1129
|
+
/**
|
|
1130
|
+
* @remarks
|
|
1131
|
+
*
|
|
1132
|
+
* JSON Schema response format. Used to generate structured JSON responses
|
|
1133
|
+
*/
|
|
1134
|
+
export type CreatePromptResponseFormatPromptsResponse200JSONSchema = {
|
|
1135
|
+
type: "json_schema";
|
|
1136
|
+
jsonSchema: CreatePromptResponseFormatPromptsResponseJsonSchema;
|
|
1268
1137
|
};
|
|
1269
|
-
/**
|
|
1270
|
-
|
|
1271
|
-
|
|
1272
|
-
|
|
1273
|
-
|
|
1274
|
-
export
|
|
1275
|
-
|
|
1276
|
-
export declare const CreatePromptRole$outboundSchema: z.ZodNativeEnum<typeof CreatePromptRole>;
|
|
1277
|
-
/** @internal */
|
|
1278
|
-
export declare const TwoFile$inboundSchema: z.ZodType<TwoFile, z.ZodTypeDef, unknown>;
|
|
1279
|
-
/** @internal */
|
|
1280
|
-
export type TwoFile$Outbound = {
|
|
1281
|
-
file_data?: string | undefined;
|
|
1282
|
-
uri?: string | undefined;
|
|
1283
|
-
mimeType?: string | undefined;
|
|
1284
|
-
filename?: string | undefined;
|
|
1138
|
+
/**
|
|
1139
|
+
* @remarks
|
|
1140
|
+
*
|
|
1141
|
+
* 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.
|
|
1142
|
+
*/
|
|
1143
|
+
export type CreatePromptResponseFormatPromptsJSONObject = {
|
|
1144
|
+
type: "json_object";
|
|
1285
1145
|
};
|
|
1286
|
-
/**
|
|
1287
|
-
|
|
1288
|
-
|
|
1289
|
-
|
|
1290
|
-
|
|
1291
|
-
export
|
|
1292
|
-
|
|
1293
|
-
export type Two3$Outbound = {
|
|
1294
|
-
type: "file";
|
|
1295
|
-
file: TwoFile$Outbound;
|
|
1146
|
+
/**
|
|
1147
|
+
* @remarks
|
|
1148
|
+
*
|
|
1149
|
+
* Default response format. Used to generate text responses
|
|
1150
|
+
*/
|
|
1151
|
+
export type CreatePromptResponseFormatPromptsText = {
|
|
1152
|
+
type: "text";
|
|
1296
1153
|
};
|
|
1297
|
-
/**
|
|
1298
|
-
|
|
1299
|
-
|
|
1300
|
-
export
|
|
1301
|
-
/**
|
|
1302
|
-
|
|
1303
|
-
|
|
1304
|
-
|
|
1305
|
-
|
|
1306
|
-
|
|
1154
|
+
/**
|
|
1155
|
+
* An object specifying the format that the model must output
|
|
1156
|
+
*/
|
|
1157
|
+
export type CreatePromptPromptsResponseFormat = CreatePromptResponseFormatPromptsText | CreatePromptResponseFormatPromptsJSONObject | CreatePromptResponseFormatPromptsResponse200JSONSchema;
|
|
1158
|
+
/**
|
|
1159
|
+
* Constrains effort on reasoning for [reasoning models](https://platform.openai.com/docs/guides/reasoning). Currently supported values are `none`, `minimal`, `low`, `medium`, `high`, and `xhigh`. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.
|
|
1160
|
+
*
|
|
1161
|
+
* @remarks
|
|
1162
|
+
*
|
|
1163
|
+
* - `gpt-5.1` defaults to `none`, which does not perform reasoning. The supported reasoning values for `gpt-5.1` are `none`, `low`, `medium`, and `high`. Tool calls are supported for all reasoning values in gpt-5.1.
|
|
1164
|
+
* - All models before `gpt-5.1` default to `medium` reasoning effort, and do not support `none`.
|
|
1165
|
+
* - The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort.
|
|
1166
|
+
* - `xhigh` is currently only supported for `gpt-5.1-codex-max`.
|
|
1167
|
+
*
|
|
1168
|
+
* Any of "none", "minimal", "low", "medium", "high", "xhigh".
|
|
1169
|
+
*/
|
|
1170
|
+
export declare const CreatePromptPromptsReasoningEffort: {
|
|
1171
|
+
readonly None: "none";
|
|
1172
|
+
readonly Minimal: "minimal";
|
|
1173
|
+
readonly Low: "low";
|
|
1174
|
+
readonly Medium: "medium";
|
|
1175
|
+
readonly High: "high";
|
|
1176
|
+
readonly Xhigh: "xhigh";
|
|
1307
1177
|
};
|
|
1308
|
-
/**
|
|
1309
|
-
|
|
1310
|
-
|
|
1311
|
-
|
|
1312
|
-
|
|
1313
|
-
|
|
1314
|
-
|
|
1315
|
-
|
|
1316
|
-
|
|
1317
|
-
|
|
1178
|
+
/**
|
|
1179
|
+
* Constrains effort on reasoning for [reasoning models](https://platform.openai.com/docs/guides/reasoning). Currently supported values are `none`, `minimal`, `low`, `medium`, `high`, and `xhigh`. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.
|
|
1180
|
+
*
|
|
1181
|
+
* @remarks
|
|
1182
|
+
*
|
|
1183
|
+
* - `gpt-5.1` defaults to `none`, which does not perform reasoning. The supported reasoning values for `gpt-5.1` are `none`, `low`, `medium`, and `high`. Tool calls are supported for all reasoning values in gpt-5.1.
|
|
1184
|
+
* - All models before `gpt-5.1` default to `medium` reasoning effort, and do not support `none`.
|
|
1185
|
+
* - The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort.
|
|
1186
|
+
* - `xhigh` is currently only supported for `gpt-5.1-codex-max`.
|
|
1187
|
+
*
|
|
1188
|
+
* Any of "none", "minimal", "low", "medium", "high", "xhigh".
|
|
1189
|
+
*/
|
|
1190
|
+
export type CreatePromptPromptsReasoningEffort = ClosedEnum<typeof CreatePromptPromptsReasoningEffort>;
|
|
1191
|
+
/**
|
|
1192
|
+
* Up to 4 sequences where the API will stop generating further tokens.
|
|
1193
|
+
*/
|
|
1194
|
+
export type CreatePromptPromptsStop = string | Array<string>;
|
|
1195
|
+
/**
|
|
1196
|
+
* Options for streaming response. Only set this when you set stream: true.
|
|
1197
|
+
*/
|
|
1198
|
+
export type CreatePromptPromptsStreamOptions = {
|
|
1199
|
+
/**
|
|
1200
|
+
* 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.
|
|
1201
|
+
*/
|
|
1202
|
+
includeUsage?: boolean | undefined;
|
|
1318
1203
|
};
|
|
1319
|
-
|
|
1320
|
-
|
|
1321
|
-
|
|
1322
|
-
|
|
1323
|
-
|
|
1324
|
-
|
|
1325
|
-
/** @internal */
|
|
1326
|
-
export type Two1$Outbound = {
|
|
1327
|
-
type: "text";
|
|
1328
|
-
text: string;
|
|
1204
|
+
export type CreatePromptPromptsThinking = components.ThinkingConfigDisabledSchema | components.ThinkingConfigEnabledSchema;
|
|
1205
|
+
/**
|
|
1206
|
+
* The type of the tool. Currently, only function is supported.
|
|
1207
|
+
*/
|
|
1208
|
+
export declare const CreatePromptToolChoicePromptsType: {
|
|
1209
|
+
readonly Function: "function";
|
|
1329
1210
|
};
|
|
1330
|
-
/**
|
|
1331
|
-
|
|
1332
|
-
|
|
1333
|
-
export
|
|
1334
|
-
|
|
1335
|
-
|
|
1336
|
-
|
|
1337
|
-
|
|
1338
|
-
/** @internal */
|
|
1339
|
-
export declare const CreatePromptContent2$outboundSchema: z.ZodType<CreatePromptContent2$Outbound, z.ZodTypeDef, CreatePromptContent2>;
|
|
1340
|
-
export declare function createPromptContent2ToJSON(createPromptContent2: CreatePromptContent2): string;
|
|
1341
|
-
export declare function createPromptContent2FromJSON(jsonString: string): SafeParseResult<CreatePromptContent2, SDKValidationError>;
|
|
1342
|
-
/** @internal */
|
|
1343
|
-
export declare const CreatePromptContent$inboundSchema: z.ZodType<CreatePromptContent, z.ZodTypeDef, unknown>;
|
|
1344
|
-
/** @internal */
|
|
1345
|
-
export type CreatePromptContent$Outbound = string | Array<Two1$Outbound | CreatePrompt22$Outbound | Two3$Outbound>;
|
|
1346
|
-
/** @internal */
|
|
1347
|
-
export declare const CreatePromptContent$outboundSchema: z.ZodType<CreatePromptContent$Outbound, z.ZodTypeDef, CreatePromptContent>;
|
|
1348
|
-
export declare function createPromptContentToJSON(createPromptContent: CreatePromptContent): string;
|
|
1349
|
-
export declare function createPromptContentFromJSON(jsonString: string): SafeParseResult<CreatePromptContent, SDKValidationError>;
|
|
1350
|
-
/** @internal */
|
|
1351
|
-
export declare const CreatePromptType$inboundSchema: z.ZodNativeEnum<typeof CreatePromptType>;
|
|
1352
|
-
/** @internal */
|
|
1353
|
-
export declare const CreatePromptType$outboundSchema: z.ZodNativeEnum<typeof CreatePromptType>;
|
|
1354
|
-
/** @internal */
|
|
1355
|
-
export declare const CreatePromptFunction$inboundSchema: z.ZodType<CreatePromptFunction, z.ZodTypeDef, unknown>;
|
|
1356
|
-
/** @internal */
|
|
1357
|
-
export type CreatePromptFunction$Outbound = {
|
|
1211
|
+
/**
|
|
1212
|
+
* The type of the tool. Currently, only function is supported.
|
|
1213
|
+
*/
|
|
1214
|
+
export type CreatePromptToolChoicePromptsType = ClosedEnum<typeof CreatePromptToolChoicePromptsType>;
|
|
1215
|
+
export type CreatePromptToolChoicePromptsFunction = {
|
|
1216
|
+
/**
|
|
1217
|
+
* The name of the function to call.
|
|
1218
|
+
*/
|
|
1358
1219
|
name: string;
|
|
1359
|
-
arguments: string;
|
|
1360
1220
|
};
|
|
1361
|
-
|
|
1362
|
-
|
|
1363
|
-
|
|
1364
|
-
|
|
1365
|
-
|
|
1366
|
-
|
|
1367
|
-
/** @internal */
|
|
1368
|
-
export type CreatePromptToolCalls$Outbound = {
|
|
1369
|
-
id?: string | undefined;
|
|
1370
|
-
index?: number | undefined;
|
|
1371
|
-
type: string;
|
|
1372
|
-
function: CreatePromptFunction$Outbound;
|
|
1221
|
+
export type CreatePromptToolChoicePrompts2 = {
|
|
1222
|
+
/**
|
|
1223
|
+
* The type of the tool. Currently, only function is supported.
|
|
1224
|
+
*/
|
|
1225
|
+
type?: CreatePromptToolChoicePromptsType | undefined;
|
|
1226
|
+
function: CreatePromptToolChoicePromptsFunction;
|
|
1373
1227
|
};
|
|
1374
|
-
|
|
1375
|
-
|
|
1376
|
-
|
|
1377
|
-
|
|
1378
|
-
/** @internal */
|
|
1379
|
-
export declare const CreatePromptMessages$inboundSchema: z.ZodType<CreatePromptMessages, z.ZodTypeDef, unknown>;
|
|
1380
|
-
/** @internal */
|
|
1381
|
-
export type CreatePromptMessages$Outbound = {
|
|
1382
|
-
role: string;
|
|
1383
|
-
content: string | Array<Two1$Outbound | CreatePrompt22$Outbound | Two3$Outbound> | null;
|
|
1384
|
-
tool_calls?: Array<CreatePromptToolCalls$Outbound> | undefined;
|
|
1385
|
-
tool_call_id?: string | null | undefined;
|
|
1228
|
+
export declare const CreatePromptToolChoicePrompts1: {
|
|
1229
|
+
readonly None: "none";
|
|
1230
|
+
readonly Auto: "auto";
|
|
1231
|
+
readonly Required: "required";
|
|
1386
1232
|
};
|
|
1387
|
-
|
|
1388
|
-
|
|
1389
|
-
|
|
1390
|
-
|
|
1391
|
-
|
|
1392
|
-
export declare const
|
|
1393
|
-
|
|
1394
|
-
|
|
1395
|
-
|
|
1396
|
-
export
|
|
1397
|
-
/**
|
|
1398
|
-
|
|
1399
|
-
|
|
1400
|
-
export declare const
|
|
1401
|
-
|
|
1402
|
-
|
|
1403
|
-
|
|
1404
|
-
|
|
1405
|
-
/**
|
|
1406
|
-
|
|
1407
|
-
|
|
1408
|
-
export
|
|
1409
|
-
|
|
1410
|
-
|
|
1411
|
-
|
|
1412
|
-
|
|
1413
|
-
|
|
1414
|
-
|
|
1415
|
-
|
|
1233
|
+
export type CreatePromptToolChoicePrompts1 = ClosedEnum<typeof CreatePromptToolChoicePrompts1>;
|
|
1234
|
+
/**
|
|
1235
|
+
* Controls which (if any) tool is called by the model.
|
|
1236
|
+
*/
|
|
1237
|
+
export type CreatePromptPromptsToolChoice = CreatePromptToolChoicePrompts2 | CreatePromptToolChoicePrompts1;
|
|
1238
|
+
export declare const CreatePromptPromptsModalities: {
|
|
1239
|
+
readonly Text: "text";
|
|
1240
|
+
readonly Audio: "audio";
|
|
1241
|
+
};
|
|
1242
|
+
export type CreatePromptPromptsModalities = ClosedEnum<typeof CreatePromptPromptsModalities>;
|
|
1243
|
+
/**
|
|
1244
|
+
* The key of the guardrail.
|
|
1245
|
+
*/
|
|
1246
|
+
export declare const CreatePromptIdPrompts1: {
|
|
1247
|
+
readonly OrqPiiDetection: "orq_pii_detection";
|
|
1248
|
+
readonly OrqSexualModeration: "orq_sexual_moderation";
|
|
1249
|
+
readonly OrqHarmfulModeration: "orq_harmful_moderation";
|
|
1250
|
+
};
|
|
1251
|
+
/**
|
|
1252
|
+
* The key of the guardrail.
|
|
1253
|
+
*/
|
|
1254
|
+
export type CreatePromptIdPrompts1 = ClosedEnum<typeof CreatePromptIdPrompts1>;
|
|
1255
|
+
export type CreatePromptPromptsId = CreatePromptIdPrompts1 | string;
|
|
1256
|
+
/**
|
|
1257
|
+
* Determines whether the guardrail runs on the input (user message) or output (model response).
|
|
1258
|
+
*/
|
|
1259
|
+
export declare const CreatePromptPromptsExecuteOn: {
|
|
1260
|
+
readonly Input: "input";
|
|
1261
|
+
readonly Output: "output";
|
|
1262
|
+
};
|
|
1263
|
+
/**
|
|
1264
|
+
* Determines whether the guardrail runs on the input (user message) or output (model response).
|
|
1265
|
+
*/
|
|
1266
|
+
export type CreatePromptPromptsExecuteOn = ClosedEnum<typeof CreatePromptPromptsExecuteOn>;
|
|
1267
|
+
export type CreatePromptPromptsGuardrails = {
|
|
1268
|
+
id: CreatePromptIdPrompts1 | string;
|
|
1269
|
+
/**
|
|
1270
|
+
* Determines whether the guardrail runs on the input (user message) or output (model response).
|
|
1271
|
+
*/
|
|
1272
|
+
executeOn: CreatePromptPromptsExecuteOn;
|
|
1273
|
+
};
|
|
1274
|
+
export type CreatePromptContentPromptsResponse200ApplicationJSONResponseBody2 = components.TextContentPartSchema;
|
|
1275
|
+
/**
|
|
1276
|
+
* The contents of the tool message.
|
|
1277
|
+
*/
|
|
1278
|
+
export type CreatePromptMessagesPromptsResponse200ApplicationJSONResponseBodyContent = string | Array<components.TextContentPartSchema>;
|
|
1279
|
+
/**
|
|
1280
|
+
* Create a cache control breakpoint at this content block. Accepts only the value "ephemeral".
|
|
1281
|
+
*/
|
|
1282
|
+
export declare const CreatePromptMessagesPromptsResponse200Type: {
|
|
1283
|
+
readonly Ephemeral: "ephemeral";
|
|
1284
|
+
};
|
|
1285
|
+
/**
|
|
1286
|
+
* Create a cache control breakpoint at this content block. Accepts only the value "ephemeral".
|
|
1287
|
+
*/
|
|
1288
|
+
export type CreatePromptMessagesPromptsResponse200Type = ClosedEnum<typeof CreatePromptMessagesPromptsResponse200Type>;
|
|
1289
|
+
/**
|
|
1290
|
+
* The time-to-live for the cache control breakpoint. This may be one of the following values:
|
|
1291
|
+
*
|
|
1292
|
+
* @remarks
|
|
1293
|
+
*
|
|
1294
|
+
* - `5m`: 5 minutes
|
|
1295
|
+
* - `1h`: 1 hour
|
|
1296
|
+
*
|
|
1297
|
+
* Defaults to `5m`. Only supported by `Anthropic` Claude models.
|
|
1298
|
+
*/
|
|
1299
|
+
export declare const CreatePromptMessagesPromptsTtl: {
|
|
1300
|
+
readonly Fivem: "5m";
|
|
1301
|
+
readonly Oneh: "1h";
|
|
1302
|
+
};
|
|
1303
|
+
/**
|
|
1304
|
+
* The time-to-live for the cache control breakpoint. This may be one of the following values:
|
|
1305
|
+
*
|
|
1306
|
+
* @remarks
|
|
1307
|
+
*
|
|
1308
|
+
* - `5m`: 5 minutes
|
|
1309
|
+
* - `1h`: 1 hour
|
|
1310
|
+
*
|
|
1311
|
+
* Defaults to `5m`. Only supported by `Anthropic` Claude models.
|
|
1312
|
+
*/
|
|
1313
|
+
export type CreatePromptMessagesPromptsTtl = ClosedEnum<typeof CreatePromptMessagesPromptsTtl>;
|
|
1314
|
+
export type CreatePromptMessagesPromptsCacheControl = {
|
|
1315
|
+
/**
|
|
1316
|
+
* Create a cache control breakpoint at this content block. Accepts only the value "ephemeral".
|
|
1317
|
+
*/
|
|
1318
|
+
type: CreatePromptMessagesPromptsResponse200Type;
|
|
1319
|
+
/**
|
|
1320
|
+
* The time-to-live for the cache control breakpoint. This may be one of the following values:
|
|
1321
|
+
*
|
|
1322
|
+
* @remarks
|
|
1323
|
+
*
|
|
1324
|
+
* - `5m`: 5 minutes
|
|
1325
|
+
* - `1h`: 1 hour
|
|
1326
|
+
*
|
|
1327
|
+
* Defaults to `5m`. Only supported by `Anthropic` Claude models.
|
|
1328
|
+
*/
|
|
1329
|
+
ttl?: CreatePromptMessagesPromptsTtl | undefined;
|
|
1330
|
+
};
|
|
1331
|
+
export type CreatePromptMessagesPromptsToolMessage = {
|
|
1332
|
+
/**
|
|
1333
|
+
* The role of the messages author, in this case tool.
|
|
1334
|
+
*/
|
|
1335
|
+
role: "tool";
|
|
1336
|
+
/**
|
|
1337
|
+
* The contents of the tool message.
|
|
1338
|
+
*/
|
|
1339
|
+
content: string | Array<components.TextContentPartSchema>;
|
|
1340
|
+
/**
|
|
1341
|
+
* Tool call that this message is responding to.
|
|
1342
|
+
*/
|
|
1343
|
+
toolCallId: string | null;
|
|
1344
|
+
cacheControl?: CreatePromptMessagesPromptsCacheControl | undefined;
|
|
1345
|
+
};
|
|
1346
|
+
export type CreatePromptContentPromptsResponse200ApplicationJson2 = (components.TextContentPartSchema & {
|
|
1347
|
+
type: "text";
|
|
1348
|
+
}) | components.RefusalPartSchema | components.ReasoningPartSchema | components.RedactedReasoningPartSchema;
|
|
1349
|
+
/**
|
|
1350
|
+
* The contents of the assistant message. Required unless `tool_calls` or `function_call` is specified.
|
|
1351
|
+
*/
|
|
1352
|
+
export type CreatePromptMessagesPromptsResponse200ApplicationJSONContent = string | Array<(components.TextContentPartSchema & {
|
|
1353
|
+
type: "text";
|
|
1354
|
+
}) | components.RefusalPartSchema | components.ReasoningPartSchema | components.RedactedReasoningPartSchema>;
|
|
1355
|
+
/**
|
|
1356
|
+
* Data about a previous audio response from the model.
|
|
1357
|
+
*/
|
|
1358
|
+
export type CreatePromptMessagesPromptsAudio = {
|
|
1359
|
+
/**
|
|
1360
|
+
* Unique identifier for a previous audio response from the model.
|
|
1361
|
+
*/
|
|
1362
|
+
id: string;
|
|
1363
|
+
};
|
|
1364
|
+
/**
|
|
1365
|
+
* The type of the tool. Currently, only `function` is supported.
|
|
1366
|
+
*/
|
|
1367
|
+
export declare const CreatePromptMessagesPromptsResponseType: {
|
|
1368
|
+
readonly Function: "function";
|
|
1369
|
+
};
|
|
1370
|
+
/**
|
|
1371
|
+
* The type of the tool. Currently, only `function` is supported.
|
|
1372
|
+
*/
|
|
1373
|
+
export type CreatePromptMessagesPromptsResponseType = ClosedEnum<typeof CreatePromptMessagesPromptsResponseType>;
|
|
1374
|
+
export type CreatePromptMessagesPromptsFunction = {
|
|
1375
|
+
/**
|
|
1376
|
+
* The name of the function to call.
|
|
1377
|
+
*/
|
|
1378
|
+
name?: string | undefined;
|
|
1379
|
+
/**
|
|
1380
|
+
* The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function.
|
|
1381
|
+
*/
|
|
1382
|
+
arguments?: string | undefined;
|
|
1383
|
+
};
|
|
1384
|
+
export type CreatePromptMessagesPromptsToolCalls = {
|
|
1385
|
+
/**
|
|
1386
|
+
* The ID of the tool call.
|
|
1387
|
+
*/
|
|
1388
|
+
id: string;
|
|
1389
|
+
/**
|
|
1390
|
+
* The type of the tool. Currently, only `function` is supported.
|
|
1391
|
+
*/
|
|
1392
|
+
type: CreatePromptMessagesPromptsResponseType;
|
|
1393
|
+
function: CreatePromptMessagesPromptsFunction;
|
|
1394
|
+
/**
|
|
1395
|
+
* Encrypted representation of the model internal reasoning state during function calling. Required by Gemini 3 models when continuing a conversation after a tool call.
|
|
1396
|
+
*/
|
|
1397
|
+
thoughtSignature?: string | undefined;
|
|
1398
|
+
};
|
|
1399
|
+
export type CreatePromptMessagesPromptsAssistantMessage = {
|
|
1400
|
+
/**
|
|
1401
|
+
* The contents of the assistant message. Required unless `tool_calls` or `function_call` is specified.
|
|
1402
|
+
*/
|
|
1403
|
+
content?: string | Array<(components.TextContentPartSchema & {
|
|
1404
|
+
type: "text";
|
|
1405
|
+
}) | components.RefusalPartSchema | components.ReasoningPartSchema | components.RedactedReasoningPartSchema> | null | undefined;
|
|
1406
|
+
/**
|
|
1407
|
+
* The refusal message by the assistant.
|
|
1408
|
+
*/
|
|
1409
|
+
refusal?: string | null | undefined;
|
|
1410
|
+
/**
|
|
1411
|
+
* The role of the messages author, in this case `assistant`.
|
|
1412
|
+
*/
|
|
1413
|
+
role: "assistant";
|
|
1414
|
+
/**
|
|
1415
|
+
* An optional name for the participant. Provides the model information to differentiate between participants of the same role.
|
|
1416
|
+
*/
|
|
1417
|
+
name?: string | undefined;
|
|
1418
|
+
/**
|
|
1419
|
+
* Data about a previous audio response from the model.
|
|
1420
|
+
*/
|
|
1421
|
+
audio?: CreatePromptMessagesPromptsAudio | null | undefined;
|
|
1422
|
+
/**
|
|
1423
|
+
* The tool calls generated by the model, such as function calls.
|
|
1424
|
+
*/
|
|
1425
|
+
toolCalls?: Array<CreatePromptMessagesPromptsToolCalls> | undefined;
|
|
1426
|
+
};
|
|
1427
|
+
/**
|
|
1428
|
+
* Create a cache control breakpoint at this content block. Accepts only the value "ephemeral".
|
|
1429
|
+
*/
|
|
1430
|
+
export declare const CreatePrompt2PromptsResponse200ApplicationJSONResponseBodyPromptType: {
|
|
1431
|
+
readonly Ephemeral: "ephemeral";
|
|
1432
|
+
};
|
|
1433
|
+
/**
|
|
1434
|
+
* Create a cache control breakpoint at this content block. Accepts only the value "ephemeral".
|
|
1435
|
+
*/
|
|
1436
|
+
export type CreatePrompt2PromptsResponse200ApplicationJSONResponseBodyPromptType = ClosedEnum<typeof CreatePrompt2PromptsResponse200ApplicationJSONResponseBodyPromptType>;
|
|
1437
|
+
/**
|
|
1438
|
+
* The time-to-live for the cache control breakpoint. This may be one of the following values:
|
|
1439
|
+
*
|
|
1440
|
+
* @remarks
|
|
1441
|
+
*
|
|
1442
|
+
* - `5m`: 5 minutes
|
|
1443
|
+
* - `1h`: 1 hour
|
|
1444
|
+
*
|
|
1445
|
+
* Defaults to `5m`. Only supported by `Anthropic` Claude models.
|
|
1446
|
+
*/
|
|
1447
|
+
export declare const CreatePrompt2PromptsTtl: {
|
|
1448
|
+
readonly Fivem: "5m";
|
|
1449
|
+
readonly Oneh: "1h";
|
|
1450
|
+
};
|
|
1451
|
+
/**
|
|
1452
|
+
* The time-to-live for the cache control breakpoint. This may be one of the following values:
|
|
1453
|
+
*
|
|
1454
|
+
* @remarks
|
|
1455
|
+
*
|
|
1456
|
+
* - `5m`: 5 minutes
|
|
1457
|
+
* - `1h`: 1 hour
|
|
1458
|
+
*
|
|
1459
|
+
* Defaults to `5m`. Only supported by `Anthropic` Claude models.
|
|
1460
|
+
*/
|
|
1461
|
+
export type CreatePrompt2PromptsTtl = ClosedEnum<typeof CreatePrompt2PromptsTtl>;
|
|
1462
|
+
export type CreatePrompt2PromptsCacheControl = {
|
|
1463
|
+
/**
|
|
1464
|
+
* Create a cache control breakpoint at this content block. Accepts only the value "ephemeral".
|
|
1465
|
+
*/
|
|
1466
|
+
type: CreatePrompt2PromptsResponse200ApplicationJSONResponseBodyPromptType;
|
|
1467
|
+
/**
|
|
1468
|
+
* The time-to-live for the cache control breakpoint. This may be one of the following values:
|
|
1469
|
+
*
|
|
1470
|
+
* @remarks
|
|
1471
|
+
*
|
|
1472
|
+
* - `5m`: 5 minutes
|
|
1473
|
+
* - `1h`: 1 hour
|
|
1474
|
+
*
|
|
1475
|
+
* Defaults to `5m`. Only supported by `Anthropic` Claude models.
|
|
1476
|
+
*/
|
|
1477
|
+
ttl?: CreatePrompt2PromptsTtl | undefined;
|
|
1478
|
+
};
|
|
1479
|
+
export type CreatePrompt2Prompts4 = {
|
|
1480
|
+
/**
|
|
1481
|
+
* The type of the content part. Always `file`.
|
|
1482
|
+
*/
|
|
1483
|
+
type: "file";
|
|
1484
|
+
cacheControl?: CreatePrompt2PromptsCacheControl | undefined;
|
|
1485
|
+
/**
|
|
1486
|
+
* File data for the content part. Must contain either file_data or uri, but not both.
|
|
1487
|
+
*/
|
|
1488
|
+
file: components.FileContentPartSchema;
|
|
1489
|
+
};
|
|
1490
|
+
export type CreatePromptContentPromptsResponse2002 = (components.TextContentPartSchema & {
|
|
1491
|
+
type: "text";
|
|
1492
|
+
}) | components.ImageContentPartSchema | components.AudioContentPartSchema | CreatePrompt2Prompts4;
|
|
1493
|
+
/**
|
|
1494
|
+
* The contents of the user message.
|
|
1495
|
+
*/
|
|
1496
|
+
export type CreatePromptMessagesPromptsResponse200Content = string | Array<(components.TextContentPartSchema & {
|
|
1497
|
+
type: "text";
|
|
1498
|
+
}) | components.ImageContentPartSchema | components.AudioContentPartSchema | CreatePrompt2Prompts4>;
|
|
1499
|
+
export type CreatePromptMessagesPromptsUserMessage = {
|
|
1500
|
+
/**
|
|
1501
|
+
* The role of the messages author, in this case `user`.
|
|
1502
|
+
*/
|
|
1503
|
+
role: "user";
|
|
1504
|
+
/**
|
|
1505
|
+
* An optional name for the participant. Provides the model information to differentiate between participants of the same role.
|
|
1506
|
+
*/
|
|
1507
|
+
name?: string | undefined;
|
|
1508
|
+
/**
|
|
1509
|
+
* The contents of the user message.
|
|
1510
|
+
*/
|
|
1511
|
+
content: string | Array<(components.TextContentPartSchema & {
|
|
1512
|
+
type: "text";
|
|
1513
|
+
}) | components.ImageContentPartSchema | components.AudioContentPartSchema | CreatePrompt2Prompts4>;
|
|
1514
|
+
};
|
|
1515
|
+
/**
|
|
1516
|
+
* The contents of the system message.
|
|
1517
|
+
*/
|
|
1518
|
+
export type CreatePromptMessagesPromptsResponseContent = string | Array<components.TextContentPartSchema>;
|
|
1519
|
+
/**
|
|
1520
|
+
* Developer-provided instructions that the model should follow, regardless of messages sent by the user.
|
|
1521
|
+
*/
|
|
1522
|
+
export type CreatePromptMessagesPromptsSystemMessage = {
|
|
1523
|
+
/**
|
|
1524
|
+
* The role of the messages author, in this case `system`.
|
|
1525
|
+
*/
|
|
1526
|
+
role: "system";
|
|
1527
|
+
/**
|
|
1528
|
+
* The contents of the system message.
|
|
1529
|
+
*/
|
|
1530
|
+
content: string | Array<components.TextContentPartSchema>;
|
|
1531
|
+
/**
|
|
1532
|
+
* An optional name for the participant. Provides the model information to differentiate between participants of the same role.
|
|
1533
|
+
*/
|
|
1534
|
+
name?: string | undefined;
|
|
1535
|
+
};
|
|
1536
|
+
export type CreatePromptPromptsResponseMessages = CreatePromptMessagesPromptsSystemMessage | CreatePromptMessagesPromptsUserMessage | CreatePromptMessagesPromptsAssistantMessage | CreatePromptMessagesPromptsToolMessage;
|
|
1537
|
+
/**
|
|
1538
|
+
* Prompt configuration with model and messages. Use this instead of prompt_config.
|
|
1539
|
+
*/
|
|
1540
|
+
export type PromptField = {
|
|
1541
|
+
/**
|
|
1542
|
+
* Parameters for audio output. Required when audio output is requested with modalities: ["audio"]. Learn more.
|
|
1543
|
+
*/
|
|
1544
|
+
audio?: CreatePromptPromptsAudio | null | undefined;
|
|
1545
|
+
/**
|
|
1546
|
+
* 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.
|
|
1547
|
+
*/
|
|
1548
|
+
frequencyPenalty?: number | null | undefined;
|
|
1549
|
+
/**
|
|
1550
|
+
* `[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.
|
|
1551
|
+
*
|
|
1552
|
+
* @remarks
|
|
1553
|
+
*
|
|
1554
|
+
* This value is now `deprecated` in favor of `max_completion_tokens`, and is not compatible with o1 series models.
|
|
1555
|
+
*/
|
|
1556
|
+
maxTokens?: number | null | undefined;
|
|
1557
|
+
/**
|
|
1558
|
+
* An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and reasoning tokens
|
|
1559
|
+
*/
|
|
1560
|
+
maxCompletionTokens?: number | null | undefined;
|
|
1561
|
+
/**
|
|
1562
|
+
* 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.
|
|
1563
|
+
*/
|
|
1564
|
+
logprobs?: boolean | null | undefined;
|
|
1565
|
+
/**
|
|
1566
|
+
* 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.
|
|
1567
|
+
*/
|
|
1568
|
+
topLogprobs?: number | null | undefined;
|
|
1569
|
+
/**
|
|
1570
|
+
* 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.
|
|
1571
|
+
*/
|
|
1572
|
+
n?: number | null | undefined;
|
|
1573
|
+
/**
|
|
1574
|
+
* 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.
|
|
1575
|
+
*/
|
|
1576
|
+
presencePenalty?: number | null | undefined;
|
|
1577
|
+
/**
|
|
1578
|
+
* An object specifying the format that the model must output
|
|
1579
|
+
*/
|
|
1580
|
+
responseFormat?: CreatePromptResponseFormatPromptsText | CreatePromptResponseFormatPromptsJSONObject | CreatePromptResponseFormatPromptsResponse200JSONSchema | undefined;
|
|
1581
|
+
/**
|
|
1582
|
+
* Constrains effort on reasoning for [reasoning models](https://platform.openai.com/docs/guides/reasoning). Currently supported values are `none`, `minimal`, `low`, `medium`, `high`, and `xhigh`. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.
|
|
1583
|
+
*
|
|
1584
|
+
* @remarks
|
|
1585
|
+
*
|
|
1586
|
+
* - `gpt-5.1` defaults to `none`, which does not perform reasoning. The supported reasoning values for `gpt-5.1` are `none`, `low`, `medium`, and `high`. Tool calls are supported for all reasoning values in gpt-5.1.
|
|
1587
|
+
* - All models before `gpt-5.1` default to `medium` reasoning effort, and do not support `none`.
|
|
1588
|
+
* - The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort.
|
|
1589
|
+
* - `xhigh` is currently only supported for `gpt-5.1-codex-max`.
|
|
1590
|
+
*
|
|
1591
|
+
* Any of "none", "minimal", "low", "medium", "high", "xhigh".
|
|
1592
|
+
*/
|
|
1593
|
+
reasoningEffort?: CreatePromptPromptsReasoningEffort | undefined;
|
|
1594
|
+
/**
|
|
1595
|
+
* Adjusts response verbosity. Lower levels yield shorter answers.
|
|
1596
|
+
*/
|
|
1597
|
+
verbosity?: string | undefined;
|
|
1598
|
+
/**
|
|
1599
|
+
* 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.
|
|
1600
|
+
*/
|
|
1601
|
+
seed?: number | null | undefined;
|
|
1602
|
+
/**
|
|
1603
|
+
* Up to 4 sequences where the API will stop generating further tokens.
|
|
1604
|
+
*/
|
|
1605
|
+
stop?: string | Array<string> | null | undefined;
|
|
1606
|
+
/**
|
|
1607
|
+
* Options for streaming response. Only set this when you set stream: true.
|
|
1608
|
+
*/
|
|
1609
|
+
streamOptions?: CreatePromptPromptsStreamOptions | null | undefined;
|
|
1610
|
+
thinking?: components.ThinkingConfigDisabledSchema | components.ThinkingConfigEnabledSchema | undefined;
|
|
1611
|
+
/**
|
|
1612
|
+
* 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.
|
|
1613
|
+
*/
|
|
1614
|
+
temperature?: number | null | undefined;
|
|
1615
|
+
/**
|
|
1616
|
+
* An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass.
|
|
1617
|
+
*/
|
|
1618
|
+
topP?: number | null | undefined;
|
|
1619
|
+
/**
|
|
1620
|
+
* Limits the model to consider only the top k most likely tokens at each step.
|
|
1621
|
+
*/
|
|
1622
|
+
topK?: number | null | undefined;
|
|
1623
|
+
/**
|
|
1624
|
+
* Controls which (if any) tool is called by the model.
|
|
1625
|
+
*/
|
|
1626
|
+
toolChoice?: CreatePromptToolChoicePrompts2 | CreatePromptToolChoicePrompts1 | undefined;
|
|
1627
|
+
/**
|
|
1628
|
+
* Whether to enable parallel function calling during tool use.
|
|
1629
|
+
*/
|
|
1630
|
+
parallelToolCalls?: boolean | undefined;
|
|
1631
|
+
/**
|
|
1632
|
+
* 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"].
|
|
1633
|
+
*/
|
|
1634
|
+
modalities?: Array<CreatePromptPromptsModalities> | null | undefined;
|
|
1635
|
+
/**
|
|
1636
|
+
* A list of guardrails to apply to the request.
|
|
1637
|
+
*/
|
|
1638
|
+
guardrails?: Array<CreatePromptPromptsGuardrails> | undefined;
|
|
1639
|
+
/**
|
|
1640
|
+
* Array of messages that make up the conversation. Each message has a role (system, user, assistant, or tool) and content.
|
|
1641
|
+
*/
|
|
1642
|
+
messages?: Array<CreatePromptMessagesPromptsSystemMessage | CreatePromptMessagesPromptsUserMessage | CreatePromptMessagesPromptsAssistantMessage | CreatePromptMessagesPromptsToolMessage> | undefined;
|
|
1643
|
+
/**
|
|
1644
|
+
* Model ID used to generate the response, like `openai/gpt-4o` or `anthropic/claude-3-5-sonnet-20241022`. For private models, use format: `{workspaceKey}@{provider}/{model}`.
|
|
1645
|
+
*/
|
|
1646
|
+
model?: string | null | undefined;
|
|
1647
|
+
version?: string | undefined;
|
|
1416
1648
|
};
|
|
1417
|
-
|
|
1418
|
-
|
|
1419
|
-
|
|
1420
|
-
|
|
1421
|
-
|
|
1422
|
-
|
|
1423
|
-
|
|
1424
|
-
|
|
1425
|
-
|
|
1426
|
-
|
|
1427
|
-
|
|
1428
|
-
|
|
1429
|
-
|
|
1649
|
+
export declare const CreatePromptUseCases: {
|
|
1650
|
+
readonly AgentsSimulations: "Agents simulations";
|
|
1651
|
+
readonly Agents: "Agents";
|
|
1652
|
+
readonly APIInteraction: "API interaction";
|
|
1653
|
+
readonly AutonomousAgents: "Autonomous Agents";
|
|
1654
|
+
readonly Chatbots: "Chatbots";
|
|
1655
|
+
readonly Classification: "Classification";
|
|
1656
|
+
readonly CodeUnderstanding: "Code understanding";
|
|
1657
|
+
readonly CodeWriting: "Code writing";
|
|
1658
|
+
readonly Conversation: "Conversation";
|
|
1659
|
+
readonly DocumentsQA: "Documents QA";
|
|
1660
|
+
readonly Evaluation: "Evaluation";
|
|
1661
|
+
readonly Extraction: "Extraction";
|
|
1662
|
+
readonly MultiModal: "Multi-modal";
|
|
1663
|
+
readonly SelfChecking: "Self-checking";
|
|
1664
|
+
readonly SentimentAnalysis: "Sentiment analysis";
|
|
1665
|
+
readonly Sql: "SQL";
|
|
1666
|
+
readonly Summarization: "Summarization";
|
|
1667
|
+
readonly Tagging: "Tagging";
|
|
1668
|
+
readonly TranslationDocument: "Translation (document)";
|
|
1669
|
+
readonly TranslationSentences: "Translation (sentences)";
|
|
1430
1670
|
};
|
|
1431
|
-
|
|
1432
|
-
|
|
1433
|
-
|
|
1434
|
-
|
|
1435
|
-
|
|
1436
|
-
|
|
1437
|
-
|
|
1438
|
-
|
|
1439
|
-
|
|
1440
|
-
|
|
1441
|
-
|
|
1442
|
-
|
|
1443
|
-
name: string;
|
|
1444
|
-
description?: string | undefined;
|
|
1445
|
-
strict?: boolean | undefined;
|
|
1446
|
-
schema: {
|
|
1447
|
-
[k: string]: any;
|
|
1448
|
-
};
|
|
1671
|
+
export type CreatePromptUseCases = ClosedEnum<typeof CreatePromptUseCases>;
|
|
1672
|
+
/**
|
|
1673
|
+
* The language that the prompt is written in. Use this field to categorize the prompt for your own purpose
|
|
1674
|
+
*/
|
|
1675
|
+
export declare const CreatePromptPromptsLanguage: {
|
|
1676
|
+
readonly Chinese: "Chinese";
|
|
1677
|
+
readonly Dutch: "Dutch";
|
|
1678
|
+
readonly English: "English";
|
|
1679
|
+
readonly French: "French";
|
|
1680
|
+
readonly German: "German";
|
|
1681
|
+
readonly Russian: "Russian";
|
|
1682
|
+
readonly Spanish: "Spanish";
|
|
1449
1683
|
};
|
|
1450
|
-
/**
|
|
1451
|
-
|
|
1452
|
-
|
|
1453
|
-
export
|
|
1454
|
-
|
|
1455
|
-
|
|
1456
|
-
|
|
1457
|
-
|
|
1458
|
-
|
|
1459
|
-
|
|
1460
|
-
|
|
1684
|
+
/**
|
|
1685
|
+
* The language that the prompt is written in. Use this field to categorize the prompt for your own purpose
|
|
1686
|
+
*/
|
|
1687
|
+
export type CreatePromptPromptsLanguage = ClosedEnum<typeof CreatePromptPromptsLanguage>;
|
|
1688
|
+
export type CreatePromptPromptsMetadata = {
|
|
1689
|
+
/**
|
|
1690
|
+
* A list of use cases that the prompt is meant to be used for. Use this field to categorize the prompt for your own purpose
|
|
1691
|
+
*/
|
|
1692
|
+
useCases?: Array<CreatePromptUseCases> | undefined;
|
|
1693
|
+
/**
|
|
1694
|
+
* The language that the prompt is written in. Use this field to categorize the prompt for your own purpose
|
|
1695
|
+
*/
|
|
1696
|
+
language?: CreatePromptPromptsLanguage | null | undefined;
|
|
1697
|
+
};
|
|
1698
|
+
/**
|
|
1699
|
+
* A prompt entity with configuration, metadata, and versioning.
|
|
1700
|
+
*/
|
|
1701
|
+
export type CreatePromptPrompt = {
|
|
1702
|
+
id: string;
|
|
1703
|
+
type: CreatePromptType;
|
|
1704
|
+
owner: string;
|
|
1705
|
+
domainId: string;
|
|
1706
|
+
created: string;
|
|
1707
|
+
updated: string;
|
|
1708
|
+
createdById?: string | null | undefined;
|
|
1709
|
+
updatedById?: string | null | undefined;
|
|
1710
|
+
/**
|
|
1711
|
+
* The prompt’s name, meant to be displayable in the UI.
|
|
1712
|
+
*/
|
|
1713
|
+
displayName: string;
|
|
1714
|
+
/**
|
|
1715
|
+
* The prompt’s description, meant to be displayable in the UI. Use this field to optionally store a long form explanation of the prompt for your own purpose
|
|
1716
|
+
*/
|
|
1717
|
+
description?: string | null | undefined;
|
|
1718
|
+
/**
|
|
1719
|
+
* [DEPRECATED] Use the `prompt` property instead. A list of messages compatible with the openAI schema.
|
|
1720
|
+
*
|
|
1721
|
+
* @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
|
|
1722
|
+
*/
|
|
1723
|
+
promptConfig?: PromptConfig | undefined;
|
|
1724
|
+
/**
|
|
1725
|
+
* Prompt configuration with model and messages. Use this instead of prompt_config.
|
|
1726
|
+
*/
|
|
1727
|
+
prompt: PromptField;
|
|
1728
|
+
metadata?: CreatePromptPromptsMetadata | undefined;
|
|
1461
1729
|
};
|
|
1462
1730
|
/** @internal */
|
|
1463
|
-
export declare const
|
|
1464
|
-
export declare function responseFormat1ToJSON(responseFormat1: ResponseFormat1): string;
|
|
1465
|
-
export declare function responseFormat1FromJSON(jsonString: string): SafeParseResult<ResponseFormat1, SDKValidationError>;
|
|
1466
|
-
/** @internal */
|
|
1467
|
-
export declare const CreatePromptResponseFormat$inboundSchema: z.ZodType<CreatePromptResponseFormat, z.ZodTypeDef, unknown>;
|
|
1468
|
-
/** @internal */
|
|
1469
|
-
export type CreatePromptResponseFormat$Outbound = ResponseFormat1$Outbound | ResponseFormat2$Outbound | ResponseFormat3$Outbound | string | string | string;
|
|
1470
|
-
/** @internal */
|
|
1471
|
-
export declare const CreatePromptResponseFormat$outboundSchema: z.ZodType<CreatePromptResponseFormat$Outbound, z.ZodTypeDef, CreatePromptResponseFormat>;
|
|
1472
|
-
export declare function createPromptResponseFormatToJSON(createPromptResponseFormat: CreatePromptResponseFormat): string;
|
|
1473
|
-
export declare function createPromptResponseFormatFromJSON(jsonString: string): SafeParseResult<CreatePromptResponseFormat, SDKValidationError>;
|
|
1474
|
-
/** @internal */
|
|
1475
|
-
export declare const PhotoRealVersion$inboundSchema: z.ZodNativeEnum<typeof PhotoRealVersion>;
|
|
1476
|
-
/** @internal */
|
|
1477
|
-
export declare const PhotoRealVersion$outboundSchema: z.ZodNativeEnum<typeof PhotoRealVersion>;
|
|
1478
|
-
/** @internal */
|
|
1479
|
-
export declare const EncodingFormat$inboundSchema: z.ZodNativeEnum<typeof EncodingFormat>;
|
|
1480
|
-
/** @internal */
|
|
1481
|
-
export declare const EncodingFormat$outboundSchema: z.ZodNativeEnum<typeof EncodingFormat>;
|
|
1482
|
-
/** @internal */
|
|
1483
|
-
export declare const CreatePromptReasoningEffort$inboundSchema: z.ZodNativeEnum<typeof CreatePromptReasoningEffort>;
|
|
1484
|
-
/** @internal */
|
|
1485
|
-
export declare const CreatePromptReasoningEffort$outboundSchema: z.ZodNativeEnum<typeof CreatePromptReasoningEffort>;
|
|
1486
|
-
/** @internal */
|
|
1487
|
-
export declare const Verbosity$inboundSchema: z.ZodNativeEnum<typeof Verbosity>;
|
|
1488
|
-
/** @internal */
|
|
1489
|
-
export declare const Verbosity$outboundSchema: z.ZodNativeEnum<typeof Verbosity>;
|
|
1490
|
-
/** @internal */
|
|
1491
|
-
export declare const ThinkingLevel$inboundSchema: z.ZodNativeEnum<typeof ThinkingLevel>;
|
|
1492
|
-
/** @internal */
|
|
1493
|
-
export declare const ThinkingLevel$outboundSchema: z.ZodNativeEnum<typeof ThinkingLevel>;
|
|
1731
|
+
export declare const UseCases$inboundSchema: z.ZodNativeEnum<typeof UseCases>;
|
|
1494
1732
|
/** @internal */
|
|
1495
|
-
export declare const
|
|
1733
|
+
export declare const UseCases$outboundSchema: z.ZodNativeEnum<typeof UseCases>;
|
|
1496
1734
|
/** @internal */
|
|
1497
|
-
export
|
|
1498
|
-
temperature?: number | undefined;
|
|
1499
|
-
maxTokens?: number | undefined;
|
|
1500
|
-
topK?: number | undefined;
|
|
1501
|
-
topP?: number | undefined;
|
|
1502
|
-
frequencyPenalty?: number | undefined;
|
|
1503
|
-
presencePenalty?: number | undefined;
|
|
1504
|
-
numImages?: number | undefined;
|
|
1505
|
-
seed?: number | undefined;
|
|
1506
|
-
format?: string | undefined;
|
|
1507
|
-
dimensions?: string | undefined;
|
|
1508
|
-
quality?: string | undefined;
|
|
1509
|
-
style?: string | undefined;
|
|
1510
|
-
responseFormat?: ResponseFormat1$Outbound | ResponseFormat2$Outbound | ResponseFormat3$Outbound | string | string | string | null | undefined;
|
|
1511
|
-
photoRealVersion?: string | undefined;
|
|
1512
|
-
encoding_format?: string | undefined;
|
|
1513
|
-
reasoningEffort?: string | undefined;
|
|
1514
|
-
budgetTokens?: number | undefined;
|
|
1515
|
-
verbosity?: string | undefined;
|
|
1516
|
-
thinkingLevel?: string | undefined;
|
|
1517
|
-
};
|
|
1735
|
+
export declare const CreatePromptLanguage$inboundSchema: z.ZodNativeEnum<typeof CreatePromptLanguage>;
|
|
1518
1736
|
/** @internal */
|
|
1519
|
-
export declare const
|
|
1520
|
-
export declare function modelParametersToJSON(modelParameters: ModelParameters): string;
|
|
1521
|
-
export declare function modelParametersFromJSON(jsonString: string): SafeParseResult<ModelParameters, SDKValidationError>;
|
|
1737
|
+
export declare const CreatePromptLanguage$outboundSchema: z.ZodNativeEnum<typeof CreatePromptLanguage>;
|
|
1522
1738
|
/** @internal */
|
|
1523
|
-
export declare const
|
|
1739
|
+
export declare const CreatePromptMetadata$inboundSchema: z.ZodType<CreatePromptMetadata, z.ZodTypeDef, unknown>;
|
|
1524
1740
|
/** @internal */
|
|
1525
|
-
export type
|
|
1526
|
-
|
|
1527
|
-
|
|
1528
|
-
model_parameters?: ModelParameters$Outbound | undefined;
|
|
1741
|
+
export type CreatePromptMetadata$Outbound = {
|
|
1742
|
+
use_cases?: Array<string> | undefined;
|
|
1743
|
+
language?: string | null | undefined;
|
|
1529
1744
|
};
|
|
1530
1745
|
/** @internal */
|
|
1531
|
-
export declare const
|
|
1532
|
-
export declare function
|
|
1533
|
-
export declare function
|
|
1746
|
+
export declare const CreatePromptMetadata$outboundSchema: z.ZodType<CreatePromptMetadata$Outbound, z.ZodTypeDef, CreatePromptMetadata>;
|
|
1747
|
+
export declare function createPromptMetadataToJSON(createPromptMetadata: CreatePromptMetadata): string;
|
|
1748
|
+
export declare function createPromptMetadataFromJSON(jsonString: string): SafeParseResult<CreatePromptMetadata, SDKValidationError>;
|
|
1534
1749
|
/** @internal */
|
|
1535
|
-
export declare const
|
|
1750
|
+
export declare const CreatePromptContentPromptsRequest2$inboundSchema: z.ZodType<CreatePromptContentPromptsRequest2, z.ZodTypeDef, unknown>;
|
|
1536
1751
|
/** @internal */
|
|
1537
|
-
export type
|
|
1752
|
+
export type CreatePromptContentPromptsRequest2$Outbound = components.TextContentPartSchema$Outbound;
|
|
1538
1753
|
/** @internal */
|
|
1539
|
-
export declare const
|
|
1540
|
-
export declare function
|
|
1541
|
-
export declare function
|
|
1754
|
+
export declare const CreatePromptContentPromptsRequest2$outboundSchema: z.ZodType<CreatePromptContentPromptsRequest2$Outbound, z.ZodTypeDef, CreatePromptContentPromptsRequest2>;
|
|
1755
|
+
export declare function createPromptContentPromptsRequest2ToJSON(createPromptContentPromptsRequest2: CreatePromptContentPromptsRequest2): string;
|
|
1756
|
+
export declare function createPromptContentPromptsRequest2FromJSON(jsonString: string): SafeParseResult<CreatePromptContentPromptsRequest2, SDKValidationError>;
|
|
1542
1757
|
/** @internal */
|
|
1543
1758
|
export declare const CreatePromptMessagesPromptsRequestRequestBodyContent$inboundSchema: z.ZodType<CreatePromptMessagesPromptsRequestRequestBodyContent, z.ZodTypeDef, unknown>;
|
|
1544
1759
|
/** @internal */
|
|
@@ -1580,15 +1795,15 @@ export declare const CreatePromptMessagesToolMessage$outboundSchema: z.ZodType<C
|
|
|
1580
1795
|
export declare function createPromptMessagesToolMessageToJSON(createPromptMessagesToolMessage: CreatePromptMessagesToolMessage): string;
|
|
1581
1796
|
export declare function createPromptMessagesToolMessageFromJSON(jsonString: string): SafeParseResult<CreatePromptMessagesToolMessage, SDKValidationError>;
|
|
1582
1797
|
/** @internal */
|
|
1583
|
-
export declare const
|
|
1798
|
+
export declare const CreatePromptContentPrompts2$inboundSchema: z.ZodType<CreatePromptContentPrompts2, z.ZodTypeDef, unknown>;
|
|
1584
1799
|
/** @internal */
|
|
1585
|
-
export type
|
|
1800
|
+
export type CreatePromptContentPrompts2$Outbound = (components.TextContentPartSchema$Outbound & {
|
|
1586
1801
|
type: "text";
|
|
1587
1802
|
}) | components.RefusalPartSchema$Outbound | components.ReasoningPartSchema$Outbound | components.RedactedReasoningPartSchema$Outbound;
|
|
1588
1803
|
/** @internal */
|
|
1589
|
-
export declare const
|
|
1590
|
-
export declare function
|
|
1591
|
-
export declare function
|
|
1804
|
+
export declare const CreatePromptContentPrompts2$outboundSchema: z.ZodType<CreatePromptContentPrompts2$Outbound, z.ZodTypeDef, CreatePromptContentPrompts2>;
|
|
1805
|
+
export declare function createPromptContentPrompts2ToJSON(createPromptContentPrompts2: CreatePromptContentPrompts2): string;
|
|
1806
|
+
export declare function createPromptContentPrompts2FromJSON(jsonString: string): SafeParseResult<CreatePromptContentPrompts2, SDKValidationError>;
|
|
1592
1807
|
/** @internal */
|
|
1593
1808
|
export declare const CreatePromptMessagesPromptsRequestContent$inboundSchema: z.ZodType<CreatePromptMessagesPromptsRequestContent, z.ZodTypeDef, unknown>;
|
|
1594
1809
|
/** @internal */
|
|
@@ -1655,9 +1870,9 @@ export declare const CreatePromptMessagesAssistantMessage$outboundSchema: z.ZodT
|
|
|
1655
1870
|
export declare function createPromptMessagesAssistantMessageToJSON(createPromptMessagesAssistantMessage: CreatePromptMessagesAssistantMessage): string;
|
|
1656
1871
|
export declare function createPromptMessagesAssistantMessageFromJSON(jsonString: string): SafeParseResult<CreatePromptMessagesAssistantMessage, SDKValidationError>;
|
|
1657
1872
|
/** @internal */
|
|
1658
|
-
export declare const
|
|
1873
|
+
export declare const CreatePrompt2PromptsType$inboundSchema: z.ZodNativeEnum<typeof CreatePrompt2PromptsType>;
|
|
1659
1874
|
/** @internal */
|
|
1660
|
-
export declare const
|
|
1875
|
+
export declare const CreatePrompt2PromptsType$outboundSchema: z.ZodNativeEnum<typeof CreatePrompt2PromptsType>;
|
|
1661
1876
|
/** @internal */
|
|
1662
1877
|
export declare const CreatePrompt2Ttl$inboundSchema: z.ZodNativeEnum<typeof CreatePrompt2Ttl>;
|
|
1663
1878
|
/** @internal */
|
|
@@ -1686,15 +1901,15 @@ export declare const CreatePrompt24$outboundSchema: z.ZodType<CreatePrompt24$Out
|
|
|
1686
1901
|
export declare function createPrompt24ToJSON(createPrompt24: CreatePrompt24): string;
|
|
1687
1902
|
export declare function createPrompt24FromJSON(jsonString: string): SafeParseResult<CreatePrompt24, SDKValidationError>;
|
|
1688
1903
|
/** @internal */
|
|
1689
|
-
export declare const
|
|
1904
|
+
export declare const CreatePromptContent2$inboundSchema: z.ZodType<CreatePromptContent2, z.ZodTypeDef, unknown>;
|
|
1690
1905
|
/** @internal */
|
|
1691
|
-
export type
|
|
1906
|
+
export type CreatePromptContent2$Outbound = (components.TextContentPartSchema$Outbound & {
|
|
1692
1907
|
type: "text";
|
|
1693
1908
|
}) | components.ImageContentPartSchema$Outbound | components.AudioContentPartSchema$Outbound | CreatePrompt24$Outbound;
|
|
1694
1909
|
/** @internal */
|
|
1695
|
-
export declare const
|
|
1696
|
-
export declare function
|
|
1697
|
-
export declare function
|
|
1910
|
+
export declare const CreatePromptContent2$outboundSchema: z.ZodType<CreatePromptContent2$Outbound, z.ZodTypeDef, CreatePromptContent2>;
|
|
1911
|
+
export declare function createPromptContent2ToJSON(createPromptContent2: CreatePromptContent2): string;
|
|
1912
|
+
export declare function createPromptContent2FromJSON(jsonString: string): SafeParseResult<CreatePromptContent2, SDKValidationError>;
|
|
1698
1913
|
/** @internal */
|
|
1699
1914
|
export declare const CreatePromptMessagesPromptsContent$inboundSchema: z.ZodType<CreatePromptMessagesPromptsContent, z.ZodTypeDef, unknown>;
|
|
1700
1915
|
/** @internal */
|
|
@@ -1740,37 +1955,56 @@ export declare const CreatePromptMessagesSystemMessage$outboundSchema: z.ZodType
|
|
|
1740
1955
|
export declare function createPromptMessagesSystemMessageToJSON(createPromptMessagesSystemMessage: CreatePromptMessagesSystemMessage): string;
|
|
1741
1956
|
export declare function createPromptMessagesSystemMessageFromJSON(jsonString: string): SafeParseResult<CreatePromptMessagesSystemMessage, SDKValidationError>;
|
|
1742
1957
|
/** @internal */
|
|
1743
|
-
export declare const
|
|
1958
|
+
export declare const CreatePromptMessages$inboundSchema: z.ZodType<CreatePromptMessages, z.ZodTypeDef, unknown>;
|
|
1744
1959
|
/** @internal */
|
|
1745
|
-
export type
|
|
1960
|
+
export type CreatePromptMessages$Outbound = CreatePromptMessagesSystemMessage$Outbound | CreatePromptMessagesUserMessage$Outbound | CreatePromptMessagesAssistantMessage$Outbound | CreatePromptMessagesToolMessage$Outbound;
|
|
1746
1961
|
/** @internal */
|
|
1747
|
-
export declare const
|
|
1748
|
-
export declare function
|
|
1749
|
-
export declare function
|
|
1962
|
+
export declare const CreatePromptMessages$outboundSchema: z.ZodType<CreatePromptMessages$Outbound, z.ZodTypeDef, CreatePromptMessages>;
|
|
1963
|
+
export declare function createPromptMessagesToJSON(createPromptMessages: CreatePromptMessages): string;
|
|
1964
|
+
export declare function createPromptMessagesFromJSON(jsonString: string): SafeParseResult<CreatePromptMessages, SDKValidationError>;
|
|
1965
|
+
/** @internal */
|
|
1966
|
+
export declare const CreatePromptVoice$inboundSchema: z.ZodNativeEnum<typeof CreatePromptVoice>;
|
|
1967
|
+
/** @internal */
|
|
1968
|
+
export declare const CreatePromptVoice$outboundSchema: z.ZodNativeEnum<typeof CreatePromptVoice>;
|
|
1969
|
+
/** @internal */
|
|
1970
|
+
export declare const CreatePromptFormat$inboundSchema: z.ZodNativeEnum<typeof CreatePromptFormat>;
|
|
1971
|
+
/** @internal */
|
|
1972
|
+
export declare const CreatePromptFormat$outboundSchema: z.ZodNativeEnum<typeof CreatePromptFormat>;
|
|
1973
|
+
/** @internal */
|
|
1974
|
+
export declare const CreatePromptAudio$inboundSchema: z.ZodType<CreatePromptAudio, z.ZodTypeDef, unknown>;
|
|
1750
1975
|
/** @internal */
|
|
1751
|
-
export
|
|
1976
|
+
export type CreatePromptAudio$Outbound = {
|
|
1977
|
+
voice: string;
|
|
1978
|
+
format: string;
|
|
1979
|
+
};
|
|
1980
|
+
/** @internal */
|
|
1981
|
+
export declare const CreatePromptAudio$outboundSchema: z.ZodType<CreatePromptAudio$Outbound, z.ZodTypeDef, CreatePromptAudio>;
|
|
1982
|
+
export declare function createPromptAudioToJSON(createPromptAudio: CreatePromptAudio): string;
|
|
1983
|
+
export declare function createPromptAudioFromJSON(jsonString: string): SafeParseResult<CreatePromptAudio, SDKValidationError>;
|
|
1752
1984
|
/** @internal */
|
|
1753
|
-
export
|
|
1985
|
+
export declare const CreatePromptResponseFormatPromptsJsonSchema$inboundSchema: z.ZodType<CreatePromptResponseFormatPromptsJsonSchema, z.ZodTypeDef, unknown>;
|
|
1986
|
+
/** @internal */
|
|
1987
|
+
export type CreatePromptResponseFormatPromptsJsonSchema$Outbound = {
|
|
1754
1988
|
description?: string | undefined;
|
|
1755
1989
|
name: string;
|
|
1756
1990
|
schema?: any | undefined;
|
|
1757
1991
|
strict: boolean;
|
|
1758
1992
|
};
|
|
1759
1993
|
/** @internal */
|
|
1760
|
-
export declare const
|
|
1761
|
-
export declare function
|
|
1762
|
-
export declare function
|
|
1994
|
+
export declare const CreatePromptResponseFormatPromptsJsonSchema$outboundSchema: z.ZodType<CreatePromptResponseFormatPromptsJsonSchema$Outbound, z.ZodTypeDef, CreatePromptResponseFormatPromptsJsonSchema>;
|
|
1995
|
+
export declare function createPromptResponseFormatPromptsJsonSchemaToJSON(createPromptResponseFormatPromptsJsonSchema: CreatePromptResponseFormatPromptsJsonSchema): string;
|
|
1996
|
+
export declare function createPromptResponseFormatPromptsJsonSchemaFromJSON(jsonString: string): SafeParseResult<CreatePromptResponseFormatPromptsJsonSchema, SDKValidationError>;
|
|
1763
1997
|
/** @internal */
|
|
1764
|
-
export declare const
|
|
1998
|
+
export declare const CreatePromptResponseFormatJSONSchema$inboundSchema: z.ZodType<CreatePromptResponseFormatJSONSchema, z.ZodTypeDef, unknown>;
|
|
1765
1999
|
/** @internal */
|
|
1766
|
-
export type
|
|
2000
|
+
export type CreatePromptResponseFormatJSONSchema$Outbound = {
|
|
1767
2001
|
type: "json_schema";
|
|
1768
|
-
json_schema:
|
|
2002
|
+
json_schema: CreatePromptResponseFormatPromptsJsonSchema$Outbound;
|
|
1769
2003
|
};
|
|
1770
2004
|
/** @internal */
|
|
1771
|
-
export declare const
|
|
1772
|
-
export declare function
|
|
1773
|
-
export declare function
|
|
2005
|
+
export declare const CreatePromptResponseFormatJSONSchema$outboundSchema: z.ZodType<CreatePromptResponseFormatJSONSchema$Outbound, z.ZodTypeDef, CreatePromptResponseFormatJSONSchema>;
|
|
2006
|
+
export declare function createPromptResponseFormatJSONSchemaToJSON(createPromptResponseFormatJSONSchema: CreatePromptResponseFormatJSONSchema): string;
|
|
2007
|
+
export declare function createPromptResponseFormatJSONSchemaFromJSON(jsonString: string): SafeParseResult<CreatePromptResponseFormatJSONSchema, SDKValidationError>;
|
|
1774
2008
|
/** @internal */
|
|
1775
2009
|
export declare const CreatePromptResponseFormatJSONObject$inboundSchema: z.ZodType<CreatePromptResponseFormatJSONObject, z.ZodTypeDef, unknown>;
|
|
1776
2010
|
/** @internal */
|
|
@@ -1792,22 +2026,139 @@ export declare const CreatePromptResponseFormatText$outboundSchema: z.ZodType<Cr
|
|
|
1792
2026
|
export declare function createPromptResponseFormatTextToJSON(createPromptResponseFormatText: CreatePromptResponseFormatText): string;
|
|
1793
2027
|
export declare function createPromptResponseFormatTextFromJSON(jsonString: string): SafeParseResult<CreatePromptResponseFormatText, SDKValidationError>;
|
|
1794
2028
|
/** @internal */
|
|
1795
|
-
export declare const
|
|
2029
|
+
export declare const CreatePromptResponseFormat$inboundSchema: z.ZodType<CreatePromptResponseFormat, z.ZodTypeDef, unknown>;
|
|
1796
2030
|
/** @internal */
|
|
1797
|
-
export type
|
|
2031
|
+
export type CreatePromptResponseFormat$Outbound = CreatePromptResponseFormatText$Outbound | CreatePromptResponseFormatJSONObject$Outbound | CreatePromptResponseFormatJSONSchema$Outbound;
|
|
1798
2032
|
/** @internal */
|
|
1799
|
-
export declare const
|
|
1800
|
-
export declare function
|
|
1801
|
-
export declare function
|
|
2033
|
+
export declare const CreatePromptResponseFormat$outboundSchema: z.ZodType<CreatePromptResponseFormat$Outbound, z.ZodTypeDef, CreatePromptResponseFormat>;
|
|
2034
|
+
export declare function createPromptResponseFormatToJSON(createPromptResponseFormat: CreatePromptResponseFormat): string;
|
|
2035
|
+
export declare function createPromptResponseFormatFromJSON(jsonString: string): SafeParseResult<CreatePromptResponseFormat, SDKValidationError>;
|
|
2036
|
+
/** @internal */
|
|
2037
|
+
export declare const CreatePromptReasoningEffort$inboundSchema: z.ZodNativeEnum<typeof CreatePromptReasoningEffort>;
|
|
2038
|
+
/** @internal */
|
|
2039
|
+
export declare const CreatePromptReasoningEffort$outboundSchema: z.ZodNativeEnum<typeof CreatePromptReasoningEffort>;
|
|
2040
|
+
/** @internal */
|
|
2041
|
+
export declare const CreatePromptStop$inboundSchema: z.ZodType<CreatePromptStop, z.ZodTypeDef, unknown>;
|
|
2042
|
+
/** @internal */
|
|
2043
|
+
export type CreatePromptStop$Outbound = string | Array<string>;
|
|
2044
|
+
/** @internal */
|
|
2045
|
+
export declare const CreatePromptStop$outboundSchema: z.ZodType<CreatePromptStop$Outbound, z.ZodTypeDef, CreatePromptStop>;
|
|
2046
|
+
export declare function createPromptStopToJSON(createPromptStop: CreatePromptStop): string;
|
|
2047
|
+
export declare function createPromptStopFromJSON(jsonString: string): SafeParseResult<CreatePromptStop, SDKValidationError>;
|
|
2048
|
+
/** @internal */
|
|
2049
|
+
export declare const CreatePromptStreamOptions$inboundSchema: z.ZodType<CreatePromptStreamOptions, z.ZodTypeDef, unknown>;
|
|
2050
|
+
/** @internal */
|
|
2051
|
+
export type CreatePromptStreamOptions$Outbound = {
|
|
2052
|
+
include_usage?: boolean | undefined;
|
|
2053
|
+
};
|
|
2054
|
+
/** @internal */
|
|
2055
|
+
export declare const CreatePromptStreamOptions$outboundSchema: z.ZodType<CreatePromptStreamOptions$Outbound, z.ZodTypeDef, CreatePromptStreamOptions>;
|
|
2056
|
+
export declare function createPromptStreamOptionsToJSON(createPromptStreamOptions: CreatePromptStreamOptions): string;
|
|
2057
|
+
export declare function createPromptStreamOptionsFromJSON(jsonString: string): SafeParseResult<CreatePromptStreamOptions, SDKValidationError>;
|
|
2058
|
+
/** @internal */
|
|
2059
|
+
export declare const CreatePromptThinking$inboundSchema: z.ZodType<CreatePromptThinking, z.ZodTypeDef, unknown>;
|
|
2060
|
+
/** @internal */
|
|
2061
|
+
export type CreatePromptThinking$Outbound = components.ThinkingConfigDisabledSchema$Outbound | components.ThinkingConfigEnabledSchema$Outbound;
|
|
2062
|
+
/** @internal */
|
|
2063
|
+
export declare const CreatePromptThinking$outboundSchema: z.ZodType<CreatePromptThinking$Outbound, z.ZodTypeDef, CreatePromptThinking>;
|
|
2064
|
+
export declare function createPromptThinkingToJSON(createPromptThinking: CreatePromptThinking): string;
|
|
2065
|
+
export declare function createPromptThinkingFromJSON(jsonString: string): SafeParseResult<CreatePromptThinking, SDKValidationError>;
|
|
2066
|
+
/** @internal */
|
|
2067
|
+
export declare const CreatePromptToolChoiceType$inboundSchema: z.ZodNativeEnum<typeof CreatePromptToolChoiceType>;
|
|
2068
|
+
/** @internal */
|
|
2069
|
+
export declare const CreatePromptToolChoiceType$outboundSchema: z.ZodNativeEnum<typeof CreatePromptToolChoiceType>;
|
|
2070
|
+
/** @internal */
|
|
2071
|
+
export declare const CreatePromptToolChoiceFunction$inboundSchema: z.ZodType<CreatePromptToolChoiceFunction, z.ZodTypeDef, unknown>;
|
|
2072
|
+
/** @internal */
|
|
2073
|
+
export type CreatePromptToolChoiceFunction$Outbound = {
|
|
2074
|
+
name: string;
|
|
2075
|
+
};
|
|
2076
|
+
/** @internal */
|
|
2077
|
+
export declare const CreatePromptToolChoiceFunction$outboundSchema: z.ZodType<CreatePromptToolChoiceFunction$Outbound, z.ZodTypeDef, CreatePromptToolChoiceFunction>;
|
|
2078
|
+
export declare function createPromptToolChoiceFunctionToJSON(createPromptToolChoiceFunction: CreatePromptToolChoiceFunction): string;
|
|
2079
|
+
export declare function createPromptToolChoiceFunctionFromJSON(jsonString: string): SafeParseResult<CreatePromptToolChoiceFunction, SDKValidationError>;
|
|
2080
|
+
/** @internal */
|
|
2081
|
+
export declare const CreatePromptToolChoice2$inboundSchema: z.ZodType<CreatePromptToolChoice2, z.ZodTypeDef, unknown>;
|
|
2082
|
+
/** @internal */
|
|
2083
|
+
export type CreatePromptToolChoice2$Outbound = {
|
|
2084
|
+
type?: string | undefined;
|
|
2085
|
+
function: CreatePromptToolChoiceFunction$Outbound;
|
|
2086
|
+
};
|
|
2087
|
+
/** @internal */
|
|
2088
|
+
export declare const CreatePromptToolChoice2$outboundSchema: z.ZodType<CreatePromptToolChoice2$Outbound, z.ZodTypeDef, CreatePromptToolChoice2>;
|
|
2089
|
+
export declare function createPromptToolChoice2ToJSON(createPromptToolChoice2: CreatePromptToolChoice2): string;
|
|
2090
|
+
export declare function createPromptToolChoice2FromJSON(jsonString: string): SafeParseResult<CreatePromptToolChoice2, SDKValidationError>;
|
|
2091
|
+
/** @internal */
|
|
2092
|
+
export declare const CreatePromptToolChoice1$inboundSchema: z.ZodNativeEnum<typeof CreatePromptToolChoice1>;
|
|
2093
|
+
/** @internal */
|
|
2094
|
+
export declare const CreatePromptToolChoice1$outboundSchema: z.ZodNativeEnum<typeof CreatePromptToolChoice1>;
|
|
2095
|
+
/** @internal */
|
|
2096
|
+
export declare const CreatePromptToolChoice$inboundSchema: z.ZodType<CreatePromptToolChoice, z.ZodTypeDef, unknown>;
|
|
2097
|
+
/** @internal */
|
|
2098
|
+
export type CreatePromptToolChoice$Outbound = CreatePromptToolChoice2$Outbound | string;
|
|
2099
|
+
/** @internal */
|
|
2100
|
+
export declare const CreatePromptToolChoice$outboundSchema: z.ZodType<CreatePromptToolChoice$Outbound, z.ZodTypeDef, CreatePromptToolChoice>;
|
|
2101
|
+
export declare function createPromptToolChoiceToJSON(createPromptToolChoice: CreatePromptToolChoice): string;
|
|
2102
|
+
export declare function createPromptToolChoiceFromJSON(jsonString: string): SafeParseResult<CreatePromptToolChoice, SDKValidationError>;
|
|
2103
|
+
/** @internal */
|
|
2104
|
+
export declare const CreatePromptModalities$inboundSchema: z.ZodNativeEnum<typeof CreatePromptModalities>;
|
|
2105
|
+
/** @internal */
|
|
2106
|
+
export declare const CreatePromptModalities$outboundSchema: z.ZodNativeEnum<typeof CreatePromptModalities>;
|
|
2107
|
+
/** @internal */
|
|
2108
|
+
export declare const CreatePromptId1$inboundSchema: z.ZodNativeEnum<typeof CreatePromptId1>;
|
|
2109
|
+
/** @internal */
|
|
2110
|
+
export declare const CreatePromptId1$outboundSchema: z.ZodNativeEnum<typeof CreatePromptId1>;
|
|
2111
|
+
/** @internal */
|
|
2112
|
+
export declare const CreatePromptId$inboundSchema: z.ZodType<CreatePromptId, z.ZodTypeDef, unknown>;
|
|
2113
|
+
/** @internal */
|
|
2114
|
+
export type CreatePromptId$Outbound = string | string;
|
|
2115
|
+
/** @internal */
|
|
2116
|
+
export declare const CreatePromptId$outboundSchema: z.ZodType<CreatePromptId$Outbound, z.ZodTypeDef, CreatePromptId>;
|
|
2117
|
+
export declare function createPromptIdToJSON(createPromptId: CreatePromptId): string;
|
|
2118
|
+
export declare function createPromptIdFromJSON(jsonString: string): SafeParseResult<CreatePromptId, SDKValidationError>;
|
|
2119
|
+
/** @internal */
|
|
2120
|
+
export declare const CreatePromptExecuteOn$inboundSchema: z.ZodNativeEnum<typeof CreatePromptExecuteOn>;
|
|
2121
|
+
/** @internal */
|
|
2122
|
+
export declare const CreatePromptExecuteOn$outboundSchema: z.ZodNativeEnum<typeof CreatePromptExecuteOn>;
|
|
2123
|
+
/** @internal */
|
|
2124
|
+
export declare const CreatePromptGuardrails$inboundSchema: z.ZodType<CreatePromptGuardrails, z.ZodTypeDef, unknown>;
|
|
2125
|
+
/** @internal */
|
|
2126
|
+
export type CreatePromptGuardrails$Outbound = {
|
|
2127
|
+
id: string | string;
|
|
2128
|
+
execute_on: string;
|
|
2129
|
+
};
|
|
2130
|
+
/** @internal */
|
|
2131
|
+
export declare const CreatePromptGuardrails$outboundSchema: z.ZodType<CreatePromptGuardrails$Outbound, z.ZodTypeDef, CreatePromptGuardrails>;
|
|
2132
|
+
export declare function createPromptGuardrailsToJSON(createPromptGuardrails: CreatePromptGuardrails): string;
|
|
2133
|
+
export declare function createPromptGuardrailsFromJSON(jsonString: string): SafeParseResult<CreatePromptGuardrails, SDKValidationError>;
|
|
1802
2134
|
/** @internal */
|
|
1803
2135
|
export declare const PromptInput$inboundSchema: z.ZodType<PromptInput, z.ZodTypeDef, unknown>;
|
|
1804
2136
|
/** @internal */
|
|
1805
2137
|
export type PromptInput$Outbound = {
|
|
1806
2138
|
messages: Array<CreatePromptMessagesSystemMessage$Outbound | CreatePromptMessagesUserMessage$Outbound | CreatePromptMessagesAssistantMessage$Outbound | CreatePromptMessagesToolMessage$Outbound>;
|
|
1807
2139
|
model?: string | undefined;
|
|
1808
|
-
|
|
2140
|
+
audio?: CreatePromptAudio$Outbound | null | undefined;
|
|
2141
|
+
frequency_penalty?: number | null | undefined;
|
|
1809
2142
|
max_tokens?: number | null | undefined;
|
|
1810
|
-
|
|
2143
|
+
max_completion_tokens?: number | null | undefined;
|
|
2144
|
+
logprobs?: boolean | null | undefined;
|
|
2145
|
+
top_logprobs?: number | null | undefined;
|
|
2146
|
+
n?: number | null | undefined;
|
|
2147
|
+
presence_penalty?: number | null | undefined;
|
|
2148
|
+
response_format?: CreatePromptResponseFormatText$Outbound | CreatePromptResponseFormatJSONObject$Outbound | CreatePromptResponseFormatJSONSchema$Outbound | undefined;
|
|
2149
|
+
reasoning_effort?: string | undefined;
|
|
2150
|
+
verbosity?: string | undefined;
|
|
2151
|
+
seed?: number | null | undefined;
|
|
2152
|
+
stop?: string | Array<string> | null | undefined;
|
|
2153
|
+
stream_options?: CreatePromptStreamOptions$Outbound | null | undefined;
|
|
2154
|
+
thinking?: components.ThinkingConfigDisabledSchema$Outbound | components.ThinkingConfigEnabledSchema$Outbound | undefined;
|
|
2155
|
+
temperature?: number | null | undefined;
|
|
2156
|
+
top_p?: number | null | undefined;
|
|
2157
|
+
top_k?: number | null | undefined;
|
|
2158
|
+
tool_choice?: CreatePromptToolChoice2$Outbound | string | undefined;
|
|
2159
|
+
parallel_tool_calls?: boolean | undefined;
|
|
2160
|
+
modalities?: Array<string> | null | undefined;
|
|
2161
|
+
guardrails?: Array<CreatePromptGuardrails$Outbound> | undefined;
|
|
1811
2162
|
};
|
|
1812
2163
|
/** @internal */
|
|
1813
2164
|
export declare const PromptInput$outboundSchema: z.ZodType<PromptInput$Outbound, z.ZodTypeDef, PromptInput>;
|
|
@@ -1820,7 +2171,6 @@ export type CreatePromptRequestBody$Outbound = {
|
|
|
1820
2171
|
display_name: string;
|
|
1821
2172
|
description?: string | null | undefined;
|
|
1822
2173
|
metadata?: CreatePromptMetadata$Outbound | undefined;
|
|
1823
|
-
prompt_config?: PromptConfiguration$Outbound | undefined;
|
|
1824
2174
|
prompt?: PromptInput$Outbound | undefined;
|
|
1825
2175
|
path: string;
|
|
1826
2176
|
};
|
|
@@ -1829,13 +2179,13 @@ export declare const CreatePromptRequestBody$outboundSchema: z.ZodType<CreatePro
|
|
|
1829
2179
|
export declare function createPromptRequestBodyToJSON(createPromptRequestBody: CreatePromptRequestBody): string;
|
|
1830
2180
|
export declare function createPromptRequestBodyFromJSON(jsonString: string): SafeParseResult<CreatePromptRequestBody, SDKValidationError>;
|
|
1831
2181
|
/** @internal */
|
|
1832
|
-
export declare const
|
|
2182
|
+
export declare const CreatePromptType$inboundSchema: z.ZodNativeEnum<typeof CreatePromptType>;
|
|
1833
2183
|
/** @internal */
|
|
1834
|
-
export declare const
|
|
2184
|
+
export declare const CreatePromptType$outboundSchema: z.ZodNativeEnum<typeof CreatePromptType>;
|
|
1835
2185
|
/** @internal */
|
|
1836
|
-
export declare const
|
|
2186
|
+
export declare const ModelType$inboundSchema: z.ZodNativeEnum<typeof ModelType>;
|
|
1837
2187
|
/** @internal */
|
|
1838
|
-
export declare const
|
|
2188
|
+
export declare const ModelType$outboundSchema: z.ZodNativeEnum<typeof ModelType>;
|
|
1839
2189
|
/** @internal */
|
|
1840
2190
|
export declare const CreatePromptPromptsFormat$inboundSchema: z.ZodNativeEnum<typeof CreatePromptPromptsFormat>;
|
|
1841
2191
|
/** @internal */
|
|
@@ -1853,9 +2203,9 @@ export declare const CreatePromptResponseFormat4$inboundSchema: z.ZodNativeEnum<
|
|
|
1853
2203
|
/** @internal */
|
|
1854
2204
|
export declare const CreatePromptResponseFormat4$outboundSchema: z.ZodNativeEnum<typeof CreatePromptResponseFormat4>;
|
|
1855
2205
|
/** @internal */
|
|
1856
|
-
export declare const
|
|
2206
|
+
export declare const CreatePromptResponseFormatPromptsResponse200ApplicationJSONResponseBodyPromptConfigModelParametersType$inboundSchema: z.ZodNativeEnum<typeof CreatePromptResponseFormatPromptsResponse200ApplicationJSONResponseBodyPromptConfigModelParametersType>;
|
|
1857
2207
|
/** @internal */
|
|
1858
|
-
export declare const
|
|
2208
|
+
export declare const CreatePromptResponseFormatPromptsResponse200ApplicationJSONResponseBodyPromptConfigModelParametersType$outboundSchema: z.ZodNativeEnum<typeof CreatePromptResponseFormatPromptsResponse200ApplicationJSONResponseBodyPromptConfigModelParametersType>;
|
|
1859
2209
|
/** @internal */
|
|
1860
2210
|
export declare const CreatePromptResponseFormat3$inboundSchema: z.ZodType<CreatePromptResponseFormat3, z.ZodTypeDef, unknown>;
|
|
1861
2211
|
/** @internal */
|
|
@@ -1867,9 +2217,9 @@ export declare const CreatePromptResponseFormat3$outboundSchema: z.ZodType<Creat
|
|
|
1867
2217
|
export declare function createPromptResponseFormat3ToJSON(createPromptResponseFormat3: CreatePromptResponseFormat3): string;
|
|
1868
2218
|
export declare function createPromptResponseFormat3FromJSON(jsonString: string): SafeParseResult<CreatePromptResponseFormat3, SDKValidationError>;
|
|
1869
2219
|
/** @internal */
|
|
1870
|
-
export declare const
|
|
2220
|
+
export declare const CreatePromptResponseFormatPromptsResponse200ApplicationJSONResponseBodyPromptConfigType$inboundSchema: z.ZodNativeEnum<typeof CreatePromptResponseFormatPromptsResponse200ApplicationJSONResponseBodyPromptConfigType>;
|
|
1871
2221
|
/** @internal */
|
|
1872
|
-
export declare const
|
|
2222
|
+
export declare const CreatePromptResponseFormatPromptsResponse200ApplicationJSONResponseBodyPromptConfigType$outboundSchema: z.ZodNativeEnum<typeof CreatePromptResponseFormatPromptsResponse200ApplicationJSONResponseBodyPromptConfigType>;
|
|
1873
2223
|
/** @internal */
|
|
1874
2224
|
export declare const CreatePromptResponseFormat2$inboundSchema: z.ZodType<CreatePromptResponseFormat2, z.ZodTypeDef, unknown>;
|
|
1875
2225
|
/** @internal */
|
|
@@ -1881,13 +2231,13 @@ export declare const CreatePromptResponseFormat2$outboundSchema: z.ZodType<Creat
|
|
|
1881
2231
|
export declare function createPromptResponseFormat2ToJSON(createPromptResponseFormat2: CreatePromptResponseFormat2): string;
|
|
1882
2232
|
export declare function createPromptResponseFormat2FromJSON(jsonString: string): SafeParseResult<CreatePromptResponseFormat2, SDKValidationError>;
|
|
1883
2233
|
/** @internal */
|
|
1884
|
-
export declare const
|
|
2234
|
+
export declare const CreatePromptResponseFormatPromptsResponse200ApplicationJSONResponseBodyType$inboundSchema: z.ZodNativeEnum<typeof CreatePromptResponseFormatPromptsResponse200ApplicationJSONResponseBodyType>;
|
|
1885
2235
|
/** @internal */
|
|
1886
|
-
export declare const
|
|
2236
|
+
export declare const CreatePromptResponseFormatPromptsResponse200ApplicationJSONResponseBodyType$outboundSchema: z.ZodNativeEnum<typeof CreatePromptResponseFormatPromptsResponse200ApplicationJSONResponseBodyType>;
|
|
1887
2237
|
/** @internal */
|
|
1888
|
-
export declare const
|
|
2238
|
+
export declare const CreatePromptResponseFormatPromptsResponse200ApplicationJSONJSONSchema$inboundSchema: z.ZodType<CreatePromptResponseFormatPromptsResponse200ApplicationJSONJSONSchema, z.ZodTypeDef, unknown>;
|
|
1889
2239
|
/** @internal */
|
|
1890
|
-
export type
|
|
2240
|
+
export type CreatePromptResponseFormatPromptsResponse200ApplicationJSONJSONSchema$Outbound = {
|
|
1891
2241
|
name: string;
|
|
1892
2242
|
description?: string | undefined;
|
|
1893
2243
|
strict?: boolean | undefined;
|
|
@@ -1896,16 +2246,16 @@ export type CreatePromptResponseFormatPromptsResponseJsonSchema$Outbound = {
|
|
|
1896
2246
|
};
|
|
1897
2247
|
};
|
|
1898
2248
|
/** @internal */
|
|
1899
|
-
export declare const
|
|
1900
|
-
export declare function
|
|
1901
|
-
export declare function
|
|
2249
|
+
export declare const CreatePromptResponseFormatPromptsResponse200ApplicationJSONJSONSchema$outboundSchema: z.ZodType<CreatePromptResponseFormatPromptsResponse200ApplicationJSONJSONSchema$Outbound, z.ZodTypeDef, CreatePromptResponseFormatPromptsResponse200ApplicationJSONJSONSchema>;
|
|
2250
|
+
export declare function createPromptResponseFormatPromptsResponse200ApplicationJSONJSONSchemaToJSON(createPromptResponseFormatPromptsResponse200ApplicationJSONJSONSchema: CreatePromptResponseFormatPromptsResponse200ApplicationJSONJSONSchema): string;
|
|
2251
|
+
export declare function createPromptResponseFormatPromptsResponse200ApplicationJSONJSONSchemaFromJSON(jsonString: string): SafeParseResult<CreatePromptResponseFormatPromptsResponse200ApplicationJSONJSONSchema, SDKValidationError>;
|
|
1902
2252
|
/** @internal */
|
|
1903
2253
|
export declare const CreatePromptResponseFormat1$inboundSchema: z.ZodType<CreatePromptResponseFormat1, z.ZodTypeDef, unknown>;
|
|
1904
2254
|
/** @internal */
|
|
1905
2255
|
export type CreatePromptResponseFormat1$Outbound = {
|
|
1906
2256
|
type: string;
|
|
1907
2257
|
display_name?: string | undefined;
|
|
1908
|
-
json_schema:
|
|
2258
|
+
json_schema: CreatePromptResponseFormatPromptsResponse200ApplicationJSONJSONSchema$Outbound;
|
|
1909
2259
|
};
|
|
1910
2260
|
/** @internal */
|
|
1911
2261
|
export declare const CreatePromptResponseFormat1$outboundSchema: z.ZodType<CreatePromptResponseFormat1$Outbound, z.ZodTypeDef, CreatePromptResponseFormat1>;
|
|
@@ -1928,9 +2278,9 @@ export declare const CreatePromptEncodingFormat$inboundSchema: z.ZodNativeEnum<t
|
|
|
1928
2278
|
/** @internal */
|
|
1929
2279
|
export declare const CreatePromptEncodingFormat$outboundSchema: z.ZodNativeEnum<typeof CreatePromptEncodingFormat>;
|
|
1930
2280
|
/** @internal */
|
|
1931
|
-
export declare const
|
|
2281
|
+
export declare const CreatePromptPromptsResponseReasoningEffort$inboundSchema: z.ZodNativeEnum<typeof CreatePromptPromptsResponseReasoningEffort>;
|
|
1932
2282
|
/** @internal */
|
|
1933
|
-
export declare const
|
|
2283
|
+
export declare const CreatePromptPromptsResponseReasoningEffort$outboundSchema: z.ZodNativeEnum<typeof CreatePromptPromptsResponseReasoningEffort>;
|
|
1934
2284
|
/** @internal */
|
|
1935
2285
|
export declare const CreatePromptVerbosity$inboundSchema: z.ZodNativeEnum<typeof CreatePromptVerbosity>;
|
|
1936
2286
|
/** @internal */
|
|
@@ -1940,9 +2290,9 @@ export declare const CreatePromptThinkingLevel$inboundSchema: z.ZodNativeEnum<ty
|
|
|
1940
2290
|
/** @internal */
|
|
1941
2291
|
export declare const CreatePromptThinkingLevel$outboundSchema: z.ZodNativeEnum<typeof CreatePromptThinkingLevel>;
|
|
1942
2292
|
/** @internal */
|
|
1943
|
-
export declare const
|
|
2293
|
+
export declare const ModelParameters$inboundSchema: z.ZodType<ModelParameters, z.ZodTypeDef, unknown>;
|
|
1944
2294
|
/** @internal */
|
|
1945
|
-
export type
|
|
2295
|
+
export type ModelParameters$Outbound = {
|
|
1946
2296
|
temperature?: number | undefined;
|
|
1947
2297
|
maxTokens?: number | undefined;
|
|
1948
2298
|
topK?: number | undefined;
|
|
@@ -1964,17 +2314,17 @@ export type CreatePromptModelParameters$Outbound = {
|
|
|
1964
2314
|
thinkingLevel?: string | undefined;
|
|
1965
2315
|
};
|
|
1966
2316
|
/** @internal */
|
|
1967
|
-
export declare const
|
|
1968
|
-
export declare function
|
|
1969
|
-
export declare function
|
|
2317
|
+
export declare const ModelParameters$outboundSchema: z.ZodType<ModelParameters$Outbound, z.ZodTypeDef, ModelParameters>;
|
|
2318
|
+
export declare function modelParametersToJSON(modelParameters: ModelParameters): string;
|
|
2319
|
+
export declare function modelParametersFromJSON(jsonString: string): SafeParseResult<ModelParameters, SDKValidationError>;
|
|
1970
2320
|
/** @internal */
|
|
1971
2321
|
export declare const CreatePromptProvider$inboundSchema: z.ZodNativeEnum<typeof CreatePromptProvider>;
|
|
1972
2322
|
/** @internal */
|
|
1973
2323
|
export declare const CreatePromptProvider$outboundSchema: z.ZodNativeEnum<typeof CreatePromptProvider>;
|
|
1974
2324
|
/** @internal */
|
|
1975
|
-
export declare const
|
|
2325
|
+
export declare const CreatePromptRole$inboundSchema: z.ZodNativeEnum<typeof CreatePromptRole>;
|
|
1976
2326
|
/** @internal */
|
|
1977
|
-
export declare const
|
|
2327
|
+
export declare const CreatePromptRole$outboundSchema: z.ZodNativeEnum<typeof CreatePromptRole>;
|
|
1978
2328
|
/** @internal */
|
|
1979
2329
|
export declare const CreatePrompt2File$inboundSchema: z.ZodType<CreatePrompt2File, z.ZodTypeDef, unknown>;
|
|
1980
2330
|
/** @internal */
|
|
@@ -2012,16 +2362,16 @@ export declare const CreatePrompt2ImageUrl$outboundSchema: z.ZodType<CreatePromp
|
|
|
2012
2362
|
export declare function createPrompt2ImageUrlToJSON(createPrompt2ImageUrl: CreatePrompt2ImageUrl): string;
|
|
2013
2363
|
export declare function createPrompt2ImageUrlFromJSON(jsonString: string): SafeParseResult<CreatePrompt2ImageUrl, SDKValidationError>;
|
|
2014
2364
|
/** @internal */
|
|
2015
|
-
export declare const
|
|
2365
|
+
export declare const CreatePrompt22$inboundSchema: z.ZodType<CreatePrompt22, z.ZodTypeDef, unknown>;
|
|
2016
2366
|
/** @internal */
|
|
2017
|
-
export type
|
|
2367
|
+
export type CreatePrompt22$Outbound = {
|
|
2018
2368
|
type: "image_url";
|
|
2019
2369
|
image_url: CreatePrompt2ImageUrl$Outbound;
|
|
2020
2370
|
};
|
|
2021
2371
|
/** @internal */
|
|
2022
|
-
export declare const
|
|
2023
|
-
export declare function
|
|
2024
|
-
export declare function
|
|
2372
|
+
export declare const CreatePrompt22$outboundSchema: z.ZodType<CreatePrompt22$Outbound, z.ZodTypeDef, CreatePrompt22>;
|
|
2373
|
+
export declare function createPrompt22ToJSON(createPrompt22: CreatePrompt22): string;
|
|
2374
|
+
export declare function createPrompt22FromJSON(jsonString: string): SafeParseResult<CreatePrompt22, SDKValidationError>;
|
|
2025
2375
|
/** @internal */
|
|
2026
2376
|
export declare const CreatePrompt21$inboundSchema: z.ZodType<CreatePrompt21, z.ZodTypeDef, unknown>;
|
|
2027
2377
|
/** @internal */
|
|
@@ -2036,78 +2386,497 @@ export declare function createPrompt21FromJSON(jsonString: string): SafeParseRes
|
|
|
2036
2386
|
/** @internal */
|
|
2037
2387
|
export declare const CreatePromptContentPromptsResponse2$inboundSchema: z.ZodType<CreatePromptContentPromptsResponse2, z.ZodTypeDef, unknown>;
|
|
2038
2388
|
/** @internal */
|
|
2039
|
-
export type CreatePromptContentPromptsResponse2$Outbound = CreatePrompt21$Outbound |
|
|
2389
|
+
export type CreatePromptContentPromptsResponse2$Outbound = CreatePrompt21$Outbound | CreatePrompt22$Outbound | CreatePrompt23$Outbound;
|
|
2040
2390
|
/** @internal */
|
|
2041
2391
|
export declare const CreatePromptContentPromptsResponse2$outboundSchema: z.ZodType<CreatePromptContentPromptsResponse2$Outbound, z.ZodTypeDef, CreatePromptContentPromptsResponse2>;
|
|
2042
2392
|
export declare function createPromptContentPromptsResponse2ToJSON(createPromptContentPromptsResponse2: CreatePromptContentPromptsResponse2): string;
|
|
2043
2393
|
export declare function createPromptContentPromptsResponse2FromJSON(jsonString: string): SafeParseResult<CreatePromptContentPromptsResponse2, SDKValidationError>;
|
|
2044
2394
|
/** @internal */
|
|
2045
|
-
export declare const
|
|
2395
|
+
export declare const CreatePromptContent$inboundSchema: z.ZodType<CreatePromptContent, z.ZodTypeDef, unknown>;
|
|
2046
2396
|
/** @internal */
|
|
2047
|
-
export type
|
|
2397
|
+
export type CreatePromptContent$Outbound = string | Array<CreatePrompt21$Outbound | CreatePrompt22$Outbound | CreatePrompt23$Outbound>;
|
|
2048
2398
|
/** @internal */
|
|
2049
|
-
export declare const
|
|
2050
|
-
export declare function
|
|
2051
|
-
export declare function
|
|
2399
|
+
export declare const CreatePromptContent$outboundSchema: z.ZodType<CreatePromptContent$Outbound, z.ZodTypeDef, CreatePromptContent>;
|
|
2400
|
+
export declare function createPromptContentToJSON(createPromptContent: CreatePromptContent): string;
|
|
2401
|
+
export declare function createPromptContentFromJSON(jsonString: string): SafeParseResult<CreatePromptContent, SDKValidationError>;
|
|
2052
2402
|
/** @internal */
|
|
2053
|
-
export declare const
|
|
2403
|
+
export declare const CreatePromptPromptsType$inboundSchema: z.ZodNativeEnum<typeof CreatePromptPromptsType>;
|
|
2054
2404
|
/** @internal */
|
|
2055
|
-
export declare const
|
|
2405
|
+
export declare const CreatePromptPromptsType$outboundSchema: z.ZodNativeEnum<typeof CreatePromptPromptsType>;
|
|
2056
2406
|
/** @internal */
|
|
2057
|
-
export declare const
|
|
2407
|
+
export declare const CreatePromptFunction$inboundSchema: z.ZodType<CreatePromptFunction, z.ZodTypeDef, unknown>;
|
|
2058
2408
|
/** @internal */
|
|
2059
|
-
export type
|
|
2409
|
+
export type CreatePromptFunction$Outbound = {
|
|
2060
2410
|
name: string;
|
|
2061
2411
|
arguments: string;
|
|
2062
2412
|
};
|
|
2063
2413
|
/** @internal */
|
|
2064
|
-
export declare const
|
|
2065
|
-
export declare function
|
|
2066
|
-
export declare function
|
|
2414
|
+
export declare const CreatePromptFunction$outboundSchema: z.ZodType<CreatePromptFunction$Outbound, z.ZodTypeDef, CreatePromptFunction>;
|
|
2415
|
+
export declare function createPromptFunctionToJSON(createPromptFunction: CreatePromptFunction): string;
|
|
2416
|
+
export declare function createPromptFunctionFromJSON(jsonString: string): SafeParseResult<CreatePromptFunction, SDKValidationError>;
|
|
2067
2417
|
/** @internal */
|
|
2068
|
-
export declare const
|
|
2418
|
+
export declare const CreatePromptToolCalls$inboundSchema: z.ZodType<CreatePromptToolCalls, z.ZodTypeDef, unknown>;
|
|
2069
2419
|
/** @internal */
|
|
2070
|
-
export type
|
|
2420
|
+
export type CreatePromptToolCalls$Outbound = {
|
|
2071
2421
|
id?: string | undefined;
|
|
2072
2422
|
index?: number | undefined;
|
|
2073
2423
|
type: string;
|
|
2074
|
-
function:
|
|
2424
|
+
function: CreatePromptFunction$Outbound;
|
|
2075
2425
|
};
|
|
2076
2426
|
/** @internal */
|
|
2077
|
-
export declare const
|
|
2078
|
-
export declare function
|
|
2079
|
-
export declare function
|
|
2427
|
+
export declare const CreatePromptToolCalls$outboundSchema: z.ZodType<CreatePromptToolCalls$Outbound, z.ZodTypeDef, CreatePromptToolCalls>;
|
|
2428
|
+
export declare function createPromptToolCallsToJSON(createPromptToolCalls: CreatePromptToolCalls): string;
|
|
2429
|
+
export declare function createPromptToolCallsFromJSON(jsonString: string): SafeParseResult<CreatePromptToolCalls, SDKValidationError>;
|
|
2080
2430
|
/** @internal */
|
|
2081
|
-
export declare const
|
|
2431
|
+
export declare const CreatePromptPromptsMessages$inboundSchema: z.ZodType<CreatePromptPromptsMessages, z.ZodTypeDef, unknown>;
|
|
2082
2432
|
/** @internal */
|
|
2083
|
-
export type
|
|
2433
|
+
export type CreatePromptPromptsMessages$Outbound = {
|
|
2084
2434
|
role: string;
|
|
2085
|
-
content: string | Array<CreatePrompt21$Outbound |
|
|
2086
|
-
tool_calls?: Array<
|
|
2435
|
+
content: string | Array<CreatePrompt21$Outbound | CreatePrompt22$Outbound | CreatePrompt23$Outbound> | null;
|
|
2436
|
+
tool_calls?: Array<CreatePromptToolCalls$Outbound> | undefined;
|
|
2087
2437
|
tool_call_id?: string | null | undefined;
|
|
2088
2438
|
};
|
|
2089
2439
|
/** @internal */
|
|
2090
|
-
export declare const
|
|
2091
|
-
export declare function
|
|
2092
|
-
export declare function
|
|
2440
|
+
export declare const CreatePromptPromptsMessages$outboundSchema: z.ZodType<CreatePromptPromptsMessages$Outbound, z.ZodTypeDef, CreatePromptPromptsMessages>;
|
|
2441
|
+
export declare function createPromptPromptsMessagesToJSON(createPromptPromptsMessages: CreatePromptPromptsMessages): string;
|
|
2442
|
+
export declare function createPromptPromptsMessagesFromJSON(jsonString: string): SafeParseResult<CreatePromptPromptsMessages, SDKValidationError>;
|
|
2093
2443
|
/** @internal */
|
|
2094
|
-
export declare const
|
|
2444
|
+
export declare const PromptConfig$inboundSchema: z.ZodType<PromptConfig, z.ZodTypeDef, unknown>;
|
|
2095
2445
|
/** @internal */
|
|
2096
|
-
export type
|
|
2446
|
+
export type PromptConfig$Outbound = {
|
|
2097
2447
|
stream?: boolean | undefined;
|
|
2098
|
-
model?: string | undefined;
|
|
2448
|
+
model?: string | null | undefined;
|
|
2099
2449
|
model_db_id?: string | null | undefined;
|
|
2100
2450
|
model_type?: string | null | undefined;
|
|
2101
|
-
model_parameters?:
|
|
2102
|
-
provider?: string | undefined;
|
|
2451
|
+
model_parameters?: ModelParameters$Outbound | undefined;
|
|
2452
|
+
provider?: string | null | undefined;
|
|
2103
2453
|
integration_id?: string | null | undefined;
|
|
2104
2454
|
version?: string | undefined;
|
|
2105
|
-
messages: Array<
|
|
2455
|
+
messages: Array<CreatePromptPromptsMessages$Outbound>;
|
|
2456
|
+
};
|
|
2457
|
+
/** @internal */
|
|
2458
|
+
export declare const PromptConfig$outboundSchema: z.ZodType<PromptConfig$Outbound, z.ZodTypeDef, PromptConfig>;
|
|
2459
|
+
export declare function promptConfigToJSON(promptConfig: PromptConfig): string;
|
|
2460
|
+
export declare function promptConfigFromJSON(jsonString: string): SafeParseResult<PromptConfig, SDKValidationError>;
|
|
2461
|
+
/** @internal */
|
|
2462
|
+
export declare const CreatePromptPromptsVoice$inboundSchema: z.ZodNativeEnum<typeof CreatePromptPromptsVoice>;
|
|
2463
|
+
/** @internal */
|
|
2464
|
+
export declare const CreatePromptPromptsVoice$outboundSchema: z.ZodNativeEnum<typeof CreatePromptPromptsVoice>;
|
|
2465
|
+
/** @internal */
|
|
2466
|
+
export declare const CreatePromptPromptsResponse200Format$inboundSchema: z.ZodNativeEnum<typeof CreatePromptPromptsResponse200Format>;
|
|
2467
|
+
/** @internal */
|
|
2468
|
+
export declare const CreatePromptPromptsResponse200Format$outboundSchema: z.ZodNativeEnum<typeof CreatePromptPromptsResponse200Format>;
|
|
2469
|
+
/** @internal */
|
|
2470
|
+
export declare const CreatePromptPromptsAudio$inboundSchema: z.ZodType<CreatePromptPromptsAudio, z.ZodTypeDef, unknown>;
|
|
2471
|
+
/** @internal */
|
|
2472
|
+
export type CreatePromptPromptsAudio$Outbound = {
|
|
2473
|
+
voice: string;
|
|
2474
|
+
format: string;
|
|
2475
|
+
};
|
|
2476
|
+
/** @internal */
|
|
2477
|
+
export declare const CreatePromptPromptsAudio$outboundSchema: z.ZodType<CreatePromptPromptsAudio$Outbound, z.ZodTypeDef, CreatePromptPromptsAudio>;
|
|
2478
|
+
export declare function createPromptPromptsAudioToJSON(createPromptPromptsAudio: CreatePromptPromptsAudio): string;
|
|
2479
|
+
export declare function createPromptPromptsAudioFromJSON(jsonString: string): SafeParseResult<CreatePromptPromptsAudio, SDKValidationError>;
|
|
2480
|
+
/** @internal */
|
|
2481
|
+
export declare const CreatePromptResponseFormatPromptsResponseJsonSchema$inboundSchema: z.ZodType<CreatePromptResponseFormatPromptsResponseJsonSchema, z.ZodTypeDef, unknown>;
|
|
2482
|
+
/** @internal */
|
|
2483
|
+
export type CreatePromptResponseFormatPromptsResponseJsonSchema$Outbound = {
|
|
2484
|
+
description?: string | undefined;
|
|
2485
|
+
name: string;
|
|
2486
|
+
schema?: any | undefined;
|
|
2487
|
+
strict: boolean;
|
|
2488
|
+
};
|
|
2489
|
+
/** @internal */
|
|
2490
|
+
export declare const CreatePromptResponseFormatPromptsResponseJsonSchema$outboundSchema: z.ZodType<CreatePromptResponseFormatPromptsResponseJsonSchema$Outbound, z.ZodTypeDef, CreatePromptResponseFormatPromptsResponseJsonSchema>;
|
|
2491
|
+
export declare function createPromptResponseFormatPromptsResponseJsonSchemaToJSON(createPromptResponseFormatPromptsResponseJsonSchema: CreatePromptResponseFormatPromptsResponseJsonSchema): string;
|
|
2492
|
+
export declare function createPromptResponseFormatPromptsResponseJsonSchemaFromJSON(jsonString: string): SafeParseResult<CreatePromptResponseFormatPromptsResponseJsonSchema, SDKValidationError>;
|
|
2493
|
+
/** @internal */
|
|
2494
|
+
export declare const CreatePromptResponseFormatPromptsResponse200JSONSchema$inboundSchema: z.ZodType<CreatePromptResponseFormatPromptsResponse200JSONSchema, z.ZodTypeDef, unknown>;
|
|
2495
|
+
/** @internal */
|
|
2496
|
+
export type CreatePromptResponseFormatPromptsResponse200JSONSchema$Outbound = {
|
|
2497
|
+
type: "json_schema";
|
|
2498
|
+
json_schema: CreatePromptResponseFormatPromptsResponseJsonSchema$Outbound;
|
|
2499
|
+
};
|
|
2500
|
+
/** @internal */
|
|
2501
|
+
export declare const CreatePromptResponseFormatPromptsResponse200JSONSchema$outboundSchema: z.ZodType<CreatePromptResponseFormatPromptsResponse200JSONSchema$Outbound, z.ZodTypeDef, CreatePromptResponseFormatPromptsResponse200JSONSchema>;
|
|
2502
|
+
export declare function createPromptResponseFormatPromptsResponse200JSONSchemaToJSON(createPromptResponseFormatPromptsResponse200JSONSchema: CreatePromptResponseFormatPromptsResponse200JSONSchema): string;
|
|
2503
|
+
export declare function createPromptResponseFormatPromptsResponse200JSONSchemaFromJSON(jsonString: string): SafeParseResult<CreatePromptResponseFormatPromptsResponse200JSONSchema, SDKValidationError>;
|
|
2504
|
+
/** @internal */
|
|
2505
|
+
export declare const CreatePromptResponseFormatPromptsJSONObject$inboundSchema: z.ZodType<CreatePromptResponseFormatPromptsJSONObject, z.ZodTypeDef, unknown>;
|
|
2506
|
+
/** @internal */
|
|
2507
|
+
export type CreatePromptResponseFormatPromptsJSONObject$Outbound = {
|
|
2508
|
+
type: "json_object";
|
|
2509
|
+
};
|
|
2510
|
+
/** @internal */
|
|
2511
|
+
export declare const CreatePromptResponseFormatPromptsJSONObject$outboundSchema: z.ZodType<CreatePromptResponseFormatPromptsJSONObject$Outbound, z.ZodTypeDef, CreatePromptResponseFormatPromptsJSONObject>;
|
|
2512
|
+
export declare function createPromptResponseFormatPromptsJSONObjectToJSON(createPromptResponseFormatPromptsJSONObject: CreatePromptResponseFormatPromptsJSONObject): string;
|
|
2513
|
+
export declare function createPromptResponseFormatPromptsJSONObjectFromJSON(jsonString: string): SafeParseResult<CreatePromptResponseFormatPromptsJSONObject, SDKValidationError>;
|
|
2514
|
+
/** @internal */
|
|
2515
|
+
export declare const CreatePromptResponseFormatPromptsText$inboundSchema: z.ZodType<CreatePromptResponseFormatPromptsText, z.ZodTypeDef, unknown>;
|
|
2516
|
+
/** @internal */
|
|
2517
|
+
export type CreatePromptResponseFormatPromptsText$Outbound = {
|
|
2518
|
+
type: "text";
|
|
2519
|
+
};
|
|
2520
|
+
/** @internal */
|
|
2521
|
+
export declare const CreatePromptResponseFormatPromptsText$outboundSchema: z.ZodType<CreatePromptResponseFormatPromptsText$Outbound, z.ZodTypeDef, CreatePromptResponseFormatPromptsText>;
|
|
2522
|
+
export declare function createPromptResponseFormatPromptsTextToJSON(createPromptResponseFormatPromptsText: CreatePromptResponseFormatPromptsText): string;
|
|
2523
|
+
export declare function createPromptResponseFormatPromptsTextFromJSON(jsonString: string): SafeParseResult<CreatePromptResponseFormatPromptsText, SDKValidationError>;
|
|
2524
|
+
/** @internal */
|
|
2525
|
+
export declare const CreatePromptPromptsResponseFormat$inboundSchema: z.ZodType<CreatePromptPromptsResponseFormat, z.ZodTypeDef, unknown>;
|
|
2526
|
+
/** @internal */
|
|
2527
|
+
export type CreatePromptPromptsResponseFormat$Outbound = CreatePromptResponseFormatPromptsText$Outbound | CreatePromptResponseFormatPromptsJSONObject$Outbound | CreatePromptResponseFormatPromptsResponse200JSONSchema$Outbound;
|
|
2528
|
+
/** @internal */
|
|
2529
|
+
export declare const CreatePromptPromptsResponseFormat$outboundSchema: z.ZodType<CreatePromptPromptsResponseFormat$Outbound, z.ZodTypeDef, CreatePromptPromptsResponseFormat>;
|
|
2530
|
+
export declare function createPromptPromptsResponseFormatToJSON(createPromptPromptsResponseFormat: CreatePromptPromptsResponseFormat): string;
|
|
2531
|
+
export declare function createPromptPromptsResponseFormatFromJSON(jsonString: string): SafeParseResult<CreatePromptPromptsResponseFormat, SDKValidationError>;
|
|
2532
|
+
/** @internal */
|
|
2533
|
+
export declare const CreatePromptPromptsReasoningEffort$inboundSchema: z.ZodNativeEnum<typeof CreatePromptPromptsReasoningEffort>;
|
|
2534
|
+
/** @internal */
|
|
2535
|
+
export declare const CreatePromptPromptsReasoningEffort$outboundSchema: z.ZodNativeEnum<typeof CreatePromptPromptsReasoningEffort>;
|
|
2536
|
+
/** @internal */
|
|
2537
|
+
export declare const CreatePromptPromptsStop$inboundSchema: z.ZodType<CreatePromptPromptsStop, z.ZodTypeDef, unknown>;
|
|
2538
|
+
/** @internal */
|
|
2539
|
+
export type CreatePromptPromptsStop$Outbound = string | Array<string>;
|
|
2540
|
+
/** @internal */
|
|
2541
|
+
export declare const CreatePromptPromptsStop$outboundSchema: z.ZodType<CreatePromptPromptsStop$Outbound, z.ZodTypeDef, CreatePromptPromptsStop>;
|
|
2542
|
+
export declare function createPromptPromptsStopToJSON(createPromptPromptsStop: CreatePromptPromptsStop): string;
|
|
2543
|
+
export declare function createPromptPromptsStopFromJSON(jsonString: string): SafeParseResult<CreatePromptPromptsStop, SDKValidationError>;
|
|
2544
|
+
/** @internal */
|
|
2545
|
+
export declare const CreatePromptPromptsStreamOptions$inboundSchema: z.ZodType<CreatePromptPromptsStreamOptions, z.ZodTypeDef, unknown>;
|
|
2546
|
+
/** @internal */
|
|
2547
|
+
export type CreatePromptPromptsStreamOptions$Outbound = {
|
|
2548
|
+
include_usage?: boolean | undefined;
|
|
2549
|
+
};
|
|
2550
|
+
/** @internal */
|
|
2551
|
+
export declare const CreatePromptPromptsStreamOptions$outboundSchema: z.ZodType<CreatePromptPromptsStreamOptions$Outbound, z.ZodTypeDef, CreatePromptPromptsStreamOptions>;
|
|
2552
|
+
export declare function createPromptPromptsStreamOptionsToJSON(createPromptPromptsStreamOptions: CreatePromptPromptsStreamOptions): string;
|
|
2553
|
+
export declare function createPromptPromptsStreamOptionsFromJSON(jsonString: string): SafeParseResult<CreatePromptPromptsStreamOptions, SDKValidationError>;
|
|
2554
|
+
/** @internal */
|
|
2555
|
+
export declare const CreatePromptPromptsThinking$inboundSchema: z.ZodType<CreatePromptPromptsThinking, z.ZodTypeDef, unknown>;
|
|
2556
|
+
/** @internal */
|
|
2557
|
+
export type CreatePromptPromptsThinking$Outbound = components.ThinkingConfigDisabledSchema$Outbound | components.ThinkingConfigEnabledSchema$Outbound;
|
|
2558
|
+
/** @internal */
|
|
2559
|
+
export declare const CreatePromptPromptsThinking$outboundSchema: z.ZodType<CreatePromptPromptsThinking$Outbound, z.ZodTypeDef, CreatePromptPromptsThinking>;
|
|
2560
|
+
export declare function createPromptPromptsThinkingToJSON(createPromptPromptsThinking: CreatePromptPromptsThinking): string;
|
|
2561
|
+
export declare function createPromptPromptsThinkingFromJSON(jsonString: string): SafeParseResult<CreatePromptPromptsThinking, SDKValidationError>;
|
|
2562
|
+
/** @internal */
|
|
2563
|
+
export declare const CreatePromptToolChoicePromptsType$inboundSchema: z.ZodNativeEnum<typeof CreatePromptToolChoicePromptsType>;
|
|
2564
|
+
/** @internal */
|
|
2565
|
+
export declare const CreatePromptToolChoicePromptsType$outboundSchema: z.ZodNativeEnum<typeof CreatePromptToolChoicePromptsType>;
|
|
2566
|
+
/** @internal */
|
|
2567
|
+
export declare const CreatePromptToolChoicePromptsFunction$inboundSchema: z.ZodType<CreatePromptToolChoicePromptsFunction, z.ZodTypeDef, unknown>;
|
|
2568
|
+
/** @internal */
|
|
2569
|
+
export type CreatePromptToolChoicePromptsFunction$Outbound = {
|
|
2570
|
+
name: string;
|
|
2571
|
+
};
|
|
2572
|
+
/** @internal */
|
|
2573
|
+
export declare const CreatePromptToolChoicePromptsFunction$outboundSchema: z.ZodType<CreatePromptToolChoicePromptsFunction$Outbound, z.ZodTypeDef, CreatePromptToolChoicePromptsFunction>;
|
|
2574
|
+
export declare function createPromptToolChoicePromptsFunctionToJSON(createPromptToolChoicePromptsFunction: CreatePromptToolChoicePromptsFunction): string;
|
|
2575
|
+
export declare function createPromptToolChoicePromptsFunctionFromJSON(jsonString: string): SafeParseResult<CreatePromptToolChoicePromptsFunction, SDKValidationError>;
|
|
2576
|
+
/** @internal */
|
|
2577
|
+
export declare const CreatePromptToolChoicePrompts2$inboundSchema: z.ZodType<CreatePromptToolChoicePrompts2, z.ZodTypeDef, unknown>;
|
|
2578
|
+
/** @internal */
|
|
2579
|
+
export type CreatePromptToolChoicePrompts2$Outbound = {
|
|
2580
|
+
type?: string | undefined;
|
|
2581
|
+
function: CreatePromptToolChoicePromptsFunction$Outbound;
|
|
2582
|
+
};
|
|
2583
|
+
/** @internal */
|
|
2584
|
+
export declare const CreatePromptToolChoicePrompts2$outboundSchema: z.ZodType<CreatePromptToolChoicePrompts2$Outbound, z.ZodTypeDef, CreatePromptToolChoicePrompts2>;
|
|
2585
|
+
export declare function createPromptToolChoicePrompts2ToJSON(createPromptToolChoicePrompts2: CreatePromptToolChoicePrompts2): string;
|
|
2586
|
+
export declare function createPromptToolChoicePrompts2FromJSON(jsonString: string): SafeParseResult<CreatePromptToolChoicePrompts2, SDKValidationError>;
|
|
2587
|
+
/** @internal */
|
|
2588
|
+
export declare const CreatePromptToolChoicePrompts1$inboundSchema: z.ZodNativeEnum<typeof CreatePromptToolChoicePrompts1>;
|
|
2589
|
+
/** @internal */
|
|
2590
|
+
export declare const CreatePromptToolChoicePrompts1$outboundSchema: z.ZodNativeEnum<typeof CreatePromptToolChoicePrompts1>;
|
|
2591
|
+
/** @internal */
|
|
2592
|
+
export declare const CreatePromptPromptsToolChoice$inboundSchema: z.ZodType<CreatePromptPromptsToolChoice, z.ZodTypeDef, unknown>;
|
|
2593
|
+
/** @internal */
|
|
2594
|
+
export type CreatePromptPromptsToolChoice$Outbound = CreatePromptToolChoicePrompts2$Outbound | string;
|
|
2595
|
+
/** @internal */
|
|
2596
|
+
export declare const CreatePromptPromptsToolChoice$outboundSchema: z.ZodType<CreatePromptPromptsToolChoice$Outbound, z.ZodTypeDef, CreatePromptPromptsToolChoice>;
|
|
2597
|
+
export declare function createPromptPromptsToolChoiceToJSON(createPromptPromptsToolChoice: CreatePromptPromptsToolChoice): string;
|
|
2598
|
+
export declare function createPromptPromptsToolChoiceFromJSON(jsonString: string): SafeParseResult<CreatePromptPromptsToolChoice, SDKValidationError>;
|
|
2599
|
+
/** @internal */
|
|
2600
|
+
export declare const CreatePromptPromptsModalities$inboundSchema: z.ZodNativeEnum<typeof CreatePromptPromptsModalities>;
|
|
2601
|
+
/** @internal */
|
|
2602
|
+
export declare const CreatePromptPromptsModalities$outboundSchema: z.ZodNativeEnum<typeof CreatePromptPromptsModalities>;
|
|
2603
|
+
/** @internal */
|
|
2604
|
+
export declare const CreatePromptIdPrompts1$inboundSchema: z.ZodNativeEnum<typeof CreatePromptIdPrompts1>;
|
|
2605
|
+
/** @internal */
|
|
2606
|
+
export declare const CreatePromptIdPrompts1$outboundSchema: z.ZodNativeEnum<typeof CreatePromptIdPrompts1>;
|
|
2607
|
+
/** @internal */
|
|
2608
|
+
export declare const CreatePromptPromptsId$inboundSchema: z.ZodType<CreatePromptPromptsId, z.ZodTypeDef, unknown>;
|
|
2609
|
+
/** @internal */
|
|
2610
|
+
export type CreatePromptPromptsId$Outbound = string | string;
|
|
2611
|
+
/** @internal */
|
|
2612
|
+
export declare const CreatePromptPromptsId$outboundSchema: z.ZodType<CreatePromptPromptsId$Outbound, z.ZodTypeDef, CreatePromptPromptsId>;
|
|
2613
|
+
export declare function createPromptPromptsIdToJSON(createPromptPromptsId: CreatePromptPromptsId): string;
|
|
2614
|
+
export declare function createPromptPromptsIdFromJSON(jsonString: string): SafeParseResult<CreatePromptPromptsId, SDKValidationError>;
|
|
2615
|
+
/** @internal */
|
|
2616
|
+
export declare const CreatePromptPromptsExecuteOn$inboundSchema: z.ZodNativeEnum<typeof CreatePromptPromptsExecuteOn>;
|
|
2617
|
+
/** @internal */
|
|
2618
|
+
export declare const CreatePromptPromptsExecuteOn$outboundSchema: z.ZodNativeEnum<typeof CreatePromptPromptsExecuteOn>;
|
|
2619
|
+
/** @internal */
|
|
2620
|
+
export declare const CreatePromptPromptsGuardrails$inboundSchema: z.ZodType<CreatePromptPromptsGuardrails, z.ZodTypeDef, unknown>;
|
|
2621
|
+
/** @internal */
|
|
2622
|
+
export type CreatePromptPromptsGuardrails$Outbound = {
|
|
2623
|
+
id: string | string;
|
|
2624
|
+
execute_on: string;
|
|
2625
|
+
};
|
|
2626
|
+
/** @internal */
|
|
2627
|
+
export declare const CreatePromptPromptsGuardrails$outboundSchema: z.ZodType<CreatePromptPromptsGuardrails$Outbound, z.ZodTypeDef, CreatePromptPromptsGuardrails>;
|
|
2628
|
+
export declare function createPromptPromptsGuardrailsToJSON(createPromptPromptsGuardrails: CreatePromptPromptsGuardrails): string;
|
|
2629
|
+
export declare function createPromptPromptsGuardrailsFromJSON(jsonString: string): SafeParseResult<CreatePromptPromptsGuardrails, SDKValidationError>;
|
|
2630
|
+
/** @internal */
|
|
2631
|
+
export declare const CreatePromptContentPromptsResponse200ApplicationJSONResponseBody2$inboundSchema: z.ZodType<CreatePromptContentPromptsResponse200ApplicationJSONResponseBody2, z.ZodTypeDef, unknown>;
|
|
2632
|
+
/** @internal */
|
|
2633
|
+
export type CreatePromptContentPromptsResponse200ApplicationJSONResponseBody2$Outbound = components.TextContentPartSchema$Outbound;
|
|
2634
|
+
/** @internal */
|
|
2635
|
+
export declare const CreatePromptContentPromptsResponse200ApplicationJSONResponseBody2$outboundSchema: z.ZodType<CreatePromptContentPromptsResponse200ApplicationJSONResponseBody2$Outbound, z.ZodTypeDef, CreatePromptContentPromptsResponse200ApplicationJSONResponseBody2>;
|
|
2636
|
+
export declare function createPromptContentPromptsResponse200ApplicationJSONResponseBody2ToJSON(createPromptContentPromptsResponse200ApplicationJSONResponseBody2: CreatePromptContentPromptsResponse200ApplicationJSONResponseBody2): string;
|
|
2637
|
+
export declare function createPromptContentPromptsResponse200ApplicationJSONResponseBody2FromJSON(jsonString: string): SafeParseResult<CreatePromptContentPromptsResponse200ApplicationJSONResponseBody2, SDKValidationError>;
|
|
2638
|
+
/** @internal */
|
|
2639
|
+
export declare const CreatePromptMessagesPromptsResponse200ApplicationJSONResponseBodyContent$inboundSchema: z.ZodType<CreatePromptMessagesPromptsResponse200ApplicationJSONResponseBodyContent, z.ZodTypeDef, unknown>;
|
|
2640
|
+
/** @internal */
|
|
2641
|
+
export type CreatePromptMessagesPromptsResponse200ApplicationJSONResponseBodyContent$Outbound = string | Array<components.TextContentPartSchema$Outbound>;
|
|
2642
|
+
/** @internal */
|
|
2643
|
+
export declare const CreatePromptMessagesPromptsResponse200ApplicationJSONResponseBodyContent$outboundSchema: z.ZodType<CreatePromptMessagesPromptsResponse200ApplicationJSONResponseBodyContent$Outbound, z.ZodTypeDef, CreatePromptMessagesPromptsResponse200ApplicationJSONResponseBodyContent>;
|
|
2644
|
+
export declare function createPromptMessagesPromptsResponse200ApplicationJSONResponseBodyContentToJSON(createPromptMessagesPromptsResponse200ApplicationJSONResponseBodyContent: CreatePromptMessagesPromptsResponse200ApplicationJSONResponseBodyContent): string;
|
|
2645
|
+
export declare function createPromptMessagesPromptsResponse200ApplicationJSONResponseBodyContentFromJSON(jsonString: string): SafeParseResult<CreatePromptMessagesPromptsResponse200ApplicationJSONResponseBodyContent, SDKValidationError>;
|
|
2646
|
+
/** @internal */
|
|
2647
|
+
export declare const CreatePromptMessagesPromptsResponse200Type$inboundSchema: z.ZodNativeEnum<typeof CreatePromptMessagesPromptsResponse200Type>;
|
|
2648
|
+
/** @internal */
|
|
2649
|
+
export declare const CreatePromptMessagesPromptsResponse200Type$outboundSchema: z.ZodNativeEnum<typeof CreatePromptMessagesPromptsResponse200Type>;
|
|
2650
|
+
/** @internal */
|
|
2651
|
+
export declare const CreatePromptMessagesPromptsTtl$inboundSchema: z.ZodNativeEnum<typeof CreatePromptMessagesPromptsTtl>;
|
|
2652
|
+
/** @internal */
|
|
2653
|
+
export declare const CreatePromptMessagesPromptsTtl$outboundSchema: z.ZodNativeEnum<typeof CreatePromptMessagesPromptsTtl>;
|
|
2654
|
+
/** @internal */
|
|
2655
|
+
export declare const CreatePromptMessagesPromptsCacheControl$inboundSchema: z.ZodType<CreatePromptMessagesPromptsCacheControl, z.ZodTypeDef, unknown>;
|
|
2656
|
+
/** @internal */
|
|
2657
|
+
export type CreatePromptMessagesPromptsCacheControl$Outbound = {
|
|
2658
|
+
type: string;
|
|
2659
|
+
ttl: string;
|
|
2660
|
+
};
|
|
2661
|
+
/** @internal */
|
|
2662
|
+
export declare const CreatePromptMessagesPromptsCacheControl$outboundSchema: z.ZodType<CreatePromptMessagesPromptsCacheControl$Outbound, z.ZodTypeDef, CreatePromptMessagesPromptsCacheControl>;
|
|
2663
|
+
export declare function createPromptMessagesPromptsCacheControlToJSON(createPromptMessagesPromptsCacheControl: CreatePromptMessagesPromptsCacheControl): string;
|
|
2664
|
+
export declare function createPromptMessagesPromptsCacheControlFromJSON(jsonString: string): SafeParseResult<CreatePromptMessagesPromptsCacheControl, SDKValidationError>;
|
|
2665
|
+
/** @internal */
|
|
2666
|
+
export declare const CreatePromptMessagesPromptsToolMessage$inboundSchema: z.ZodType<CreatePromptMessagesPromptsToolMessage, z.ZodTypeDef, unknown>;
|
|
2667
|
+
/** @internal */
|
|
2668
|
+
export type CreatePromptMessagesPromptsToolMessage$Outbound = {
|
|
2669
|
+
role: "tool";
|
|
2670
|
+
content: string | Array<components.TextContentPartSchema$Outbound>;
|
|
2671
|
+
tool_call_id: string | null;
|
|
2672
|
+
cache_control?: CreatePromptMessagesPromptsCacheControl$Outbound | undefined;
|
|
2673
|
+
};
|
|
2674
|
+
/** @internal */
|
|
2675
|
+
export declare const CreatePromptMessagesPromptsToolMessage$outboundSchema: z.ZodType<CreatePromptMessagesPromptsToolMessage$Outbound, z.ZodTypeDef, CreatePromptMessagesPromptsToolMessage>;
|
|
2676
|
+
export declare function createPromptMessagesPromptsToolMessageToJSON(createPromptMessagesPromptsToolMessage: CreatePromptMessagesPromptsToolMessage): string;
|
|
2677
|
+
export declare function createPromptMessagesPromptsToolMessageFromJSON(jsonString: string): SafeParseResult<CreatePromptMessagesPromptsToolMessage, SDKValidationError>;
|
|
2678
|
+
/** @internal */
|
|
2679
|
+
export declare const CreatePromptContentPromptsResponse200ApplicationJson2$inboundSchema: z.ZodType<CreatePromptContentPromptsResponse200ApplicationJson2, z.ZodTypeDef, unknown>;
|
|
2680
|
+
/** @internal */
|
|
2681
|
+
export type CreatePromptContentPromptsResponse200ApplicationJson2$Outbound = (components.TextContentPartSchema$Outbound & {
|
|
2682
|
+
type: "text";
|
|
2683
|
+
}) | components.RefusalPartSchema$Outbound | components.ReasoningPartSchema$Outbound | components.RedactedReasoningPartSchema$Outbound;
|
|
2684
|
+
/** @internal */
|
|
2685
|
+
export declare const CreatePromptContentPromptsResponse200ApplicationJson2$outboundSchema: z.ZodType<CreatePromptContentPromptsResponse200ApplicationJson2$Outbound, z.ZodTypeDef, CreatePromptContentPromptsResponse200ApplicationJson2>;
|
|
2686
|
+
export declare function createPromptContentPromptsResponse200ApplicationJSON2ToJSON(createPromptContentPromptsResponse200ApplicationJson2: CreatePromptContentPromptsResponse200ApplicationJson2): string;
|
|
2687
|
+
export declare function createPromptContentPromptsResponse200ApplicationJSON2FromJSON(jsonString: string): SafeParseResult<CreatePromptContentPromptsResponse200ApplicationJson2, SDKValidationError>;
|
|
2688
|
+
/** @internal */
|
|
2689
|
+
export declare const CreatePromptMessagesPromptsResponse200ApplicationJSONContent$inboundSchema: z.ZodType<CreatePromptMessagesPromptsResponse200ApplicationJSONContent, z.ZodTypeDef, unknown>;
|
|
2690
|
+
/** @internal */
|
|
2691
|
+
export type CreatePromptMessagesPromptsResponse200ApplicationJSONContent$Outbound = string | Array<(components.TextContentPartSchema$Outbound & {
|
|
2692
|
+
type: "text";
|
|
2693
|
+
}) | components.RefusalPartSchema$Outbound | components.ReasoningPartSchema$Outbound | components.RedactedReasoningPartSchema$Outbound>;
|
|
2694
|
+
/** @internal */
|
|
2695
|
+
export declare const CreatePromptMessagesPromptsResponse200ApplicationJSONContent$outboundSchema: z.ZodType<CreatePromptMessagesPromptsResponse200ApplicationJSONContent$Outbound, z.ZodTypeDef, CreatePromptMessagesPromptsResponse200ApplicationJSONContent>;
|
|
2696
|
+
export declare function createPromptMessagesPromptsResponse200ApplicationJSONContentToJSON(createPromptMessagesPromptsResponse200ApplicationJSONContent: CreatePromptMessagesPromptsResponse200ApplicationJSONContent): string;
|
|
2697
|
+
export declare function createPromptMessagesPromptsResponse200ApplicationJSONContentFromJSON(jsonString: string): SafeParseResult<CreatePromptMessagesPromptsResponse200ApplicationJSONContent, SDKValidationError>;
|
|
2698
|
+
/** @internal */
|
|
2699
|
+
export declare const CreatePromptMessagesPromptsAudio$inboundSchema: z.ZodType<CreatePromptMessagesPromptsAudio, z.ZodTypeDef, unknown>;
|
|
2700
|
+
/** @internal */
|
|
2701
|
+
export type CreatePromptMessagesPromptsAudio$Outbound = {
|
|
2702
|
+
id: string;
|
|
2703
|
+
};
|
|
2704
|
+
/** @internal */
|
|
2705
|
+
export declare const CreatePromptMessagesPromptsAudio$outboundSchema: z.ZodType<CreatePromptMessagesPromptsAudio$Outbound, z.ZodTypeDef, CreatePromptMessagesPromptsAudio>;
|
|
2706
|
+
export declare function createPromptMessagesPromptsAudioToJSON(createPromptMessagesPromptsAudio: CreatePromptMessagesPromptsAudio): string;
|
|
2707
|
+
export declare function createPromptMessagesPromptsAudioFromJSON(jsonString: string): SafeParseResult<CreatePromptMessagesPromptsAudio, SDKValidationError>;
|
|
2708
|
+
/** @internal */
|
|
2709
|
+
export declare const CreatePromptMessagesPromptsResponseType$inboundSchema: z.ZodNativeEnum<typeof CreatePromptMessagesPromptsResponseType>;
|
|
2710
|
+
/** @internal */
|
|
2711
|
+
export declare const CreatePromptMessagesPromptsResponseType$outboundSchema: z.ZodNativeEnum<typeof CreatePromptMessagesPromptsResponseType>;
|
|
2712
|
+
/** @internal */
|
|
2713
|
+
export declare const CreatePromptMessagesPromptsFunction$inboundSchema: z.ZodType<CreatePromptMessagesPromptsFunction, z.ZodTypeDef, unknown>;
|
|
2714
|
+
/** @internal */
|
|
2715
|
+
export type CreatePromptMessagesPromptsFunction$Outbound = {
|
|
2716
|
+
name?: string | undefined;
|
|
2717
|
+
arguments?: string | undefined;
|
|
2718
|
+
};
|
|
2719
|
+
/** @internal */
|
|
2720
|
+
export declare const CreatePromptMessagesPromptsFunction$outboundSchema: z.ZodType<CreatePromptMessagesPromptsFunction$Outbound, z.ZodTypeDef, CreatePromptMessagesPromptsFunction>;
|
|
2721
|
+
export declare function createPromptMessagesPromptsFunctionToJSON(createPromptMessagesPromptsFunction: CreatePromptMessagesPromptsFunction): string;
|
|
2722
|
+
export declare function createPromptMessagesPromptsFunctionFromJSON(jsonString: string): SafeParseResult<CreatePromptMessagesPromptsFunction, SDKValidationError>;
|
|
2723
|
+
/** @internal */
|
|
2724
|
+
export declare const CreatePromptMessagesPromptsToolCalls$inboundSchema: z.ZodType<CreatePromptMessagesPromptsToolCalls, z.ZodTypeDef, unknown>;
|
|
2725
|
+
/** @internal */
|
|
2726
|
+
export type CreatePromptMessagesPromptsToolCalls$Outbound = {
|
|
2727
|
+
id: string;
|
|
2728
|
+
type: string;
|
|
2729
|
+
function: CreatePromptMessagesPromptsFunction$Outbound;
|
|
2730
|
+
thought_signature?: string | undefined;
|
|
2731
|
+
};
|
|
2732
|
+
/** @internal */
|
|
2733
|
+
export declare const CreatePromptMessagesPromptsToolCalls$outboundSchema: z.ZodType<CreatePromptMessagesPromptsToolCalls$Outbound, z.ZodTypeDef, CreatePromptMessagesPromptsToolCalls>;
|
|
2734
|
+
export declare function createPromptMessagesPromptsToolCallsToJSON(createPromptMessagesPromptsToolCalls: CreatePromptMessagesPromptsToolCalls): string;
|
|
2735
|
+
export declare function createPromptMessagesPromptsToolCallsFromJSON(jsonString: string): SafeParseResult<CreatePromptMessagesPromptsToolCalls, SDKValidationError>;
|
|
2736
|
+
/** @internal */
|
|
2737
|
+
export declare const CreatePromptMessagesPromptsAssistantMessage$inboundSchema: z.ZodType<CreatePromptMessagesPromptsAssistantMessage, z.ZodTypeDef, unknown>;
|
|
2738
|
+
/** @internal */
|
|
2739
|
+
export type CreatePromptMessagesPromptsAssistantMessage$Outbound = {
|
|
2740
|
+
content?: string | Array<(components.TextContentPartSchema$Outbound & {
|
|
2741
|
+
type: "text";
|
|
2742
|
+
}) | components.RefusalPartSchema$Outbound | components.ReasoningPartSchema$Outbound | components.RedactedReasoningPartSchema$Outbound> | null | undefined;
|
|
2743
|
+
refusal?: string | null | undefined;
|
|
2744
|
+
role: "assistant";
|
|
2745
|
+
name?: string | undefined;
|
|
2746
|
+
audio?: CreatePromptMessagesPromptsAudio$Outbound | null | undefined;
|
|
2747
|
+
tool_calls?: Array<CreatePromptMessagesPromptsToolCalls$Outbound> | undefined;
|
|
2748
|
+
};
|
|
2749
|
+
/** @internal */
|
|
2750
|
+
export declare const CreatePromptMessagesPromptsAssistantMessage$outboundSchema: z.ZodType<CreatePromptMessagesPromptsAssistantMessage$Outbound, z.ZodTypeDef, CreatePromptMessagesPromptsAssistantMessage>;
|
|
2751
|
+
export declare function createPromptMessagesPromptsAssistantMessageToJSON(createPromptMessagesPromptsAssistantMessage: CreatePromptMessagesPromptsAssistantMessage): string;
|
|
2752
|
+
export declare function createPromptMessagesPromptsAssistantMessageFromJSON(jsonString: string): SafeParseResult<CreatePromptMessagesPromptsAssistantMessage, SDKValidationError>;
|
|
2753
|
+
/** @internal */
|
|
2754
|
+
export declare const CreatePrompt2PromptsResponse200ApplicationJSONResponseBodyPromptType$inboundSchema: z.ZodNativeEnum<typeof CreatePrompt2PromptsResponse200ApplicationJSONResponseBodyPromptType>;
|
|
2755
|
+
/** @internal */
|
|
2756
|
+
export declare const CreatePrompt2PromptsResponse200ApplicationJSONResponseBodyPromptType$outboundSchema: z.ZodNativeEnum<typeof CreatePrompt2PromptsResponse200ApplicationJSONResponseBodyPromptType>;
|
|
2757
|
+
/** @internal */
|
|
2758
|
+
export declare const CreatePrompt2PromptsTtl$inboundSchema: z.ZodNativeEnum<typeof CreatePrompt2PromptsTtl>;
|
|
2759
|
+
/** @internal */
|
|
2760
|
+
export declare const CreatePrompt2PromptsTtl$outboundSchema: z.ZodNativeEnum<typeof CreatePrompt2PromptsTtl>;
|
|
2761
|
+
/** @internal */
|
|
2762
|
+
export declare const CreatePrompt2PromptsCacheControl$inboundSchema: z.ZodType<CreatePrompt2PromptsCacheControl, z.ZodTypeDef, unknown>;
|
|
2763
|
+
/** @internal */
|
|
2764
|
+
export type CreatePrompt2PromptsCacheControl$Outbound = {
|
|
2765
|
+
type: string;
|
|
2766
|
+
ttl: string;
|
|
2767
|
+
};
|
|
2768
|
+
/** @internal */
|
|
2769
|
+
export declare const CreatePrompt2PromptsCacheControl$outboundSchema: z.ZodType<CreatePrompt2PromptsCacheControl$Outbound, z.ZodTypeDef, CreatePrompt2PromptsCacheControl>;
|
|
2770
|
+
export declare function createPrompt2PromptsCacheControlToJSON(createPrompt2PromptsCacheControl: CreatePrompt2PromptsCacheControl): string;
|
|
2771
|
+
export declare function createPrompt2PromptsCacheControlFromJSON(jsonString: string): SafeParseResult<CreatePrompt2PromptsCacheControl, SDKValidationError>;
|
|
2772
|
+
/** @internal */
|
|
2773
|
+
export declare const CreatePrompt2Prompts4$inboundSchema: z.ZodType<CreatePrompt2Prompts4, z.ZodTypeDef, unknown>;
|
|
2774
|
+
/** @internal */
|
|
2775
|
+
export type CreatePrompt2Prompts4$Outbound = {
|
|
2776
|
+
type: "file";
|
|
2777
|
+
cache_control?: CreatePrompt2PromptsCacheControl$Outbound | undefined;
|
|
2778
|
+
file: components.FileContentPartSchema$Outbound;
|
|
2779
|
+
};
|
|
2780
|
+
/** @internal */
|
|
2781
|
+
export declare const CreatePrompt2Prompts4$outboundSchema: z.ZodType<CreatePrompt2Prompts4$Outbound, z.ZodTypeDef, CreatePrompt2Prompts4>;
|
|
2782
|
+
export declare function createPrompt2Prompts4ToJSON(createPrompt2Prompts4: CreatePrompt2Prompts4): string;
|
|
2783
|
+
export declare function createPrompt2Prompts4FromJSON(jsonString: string): SafeParseResult<CreatePrompt2Prompts4, SDKValidationError>;
|
|
2784
|
+
/** @internal */
|
|
2785
|
+
export declare const CreatePromptContentPromptsResponse2002$inboundSchema: z.ZodType<CreatePromptContentPromptsResponse2002, z.ZodTypeDef, unknown>;
|
|
2786
|
+
/** @internal */
|
|
2787
|
+
export type CreatePromptContentPromptsResponse2002$Outbound = (components.TextContentPartSchema$Outbound & {
|
|
2788
|
+
type: "text";
|
|
2789
|
+
}) | components.ImageContentPartSchema$Outbound | components.AudioContentPartSchema$Outbound | CreatePrompt2Prompts4$Outbound;
|
|
2790
|
+
/** @internal */
|
|
2791
|
+
export declare const CreatePromptContentPromptsResponse2002$outboundSchema: z.ZodType<CreatePromptContentPromptsResponse2002$Outbound, z.ZodTypeDef, CreatePromptContentPromptsResponse2002>;
|
|
2792
|
+
export declare function createPromptContentPromptsResponse2002ToJSON(createPromptContentPromptsResponse2002: CreatePromptContentPromptsResponse2002): string;
|
|
2793
|
+
export declare function createPromptContentPromptsResponse2002FromJSON(jsonString: string): SafeParseResult<CreatePromptContentPromptsResponse2002, SDKValidationError>;
|
|
2794
|
+
/** @internal */
|
|
2795
|
+
export declare const CreatePromptMessagesPromptsResponse200Content$inboundSchema: z.ZodType<CreatePromptMessagesPromptsResponse200Content, z.ZodTypeDef, unknown>;
|
|
2796
|
+
/** @internal */
|
|
2797
|
+
export type CreatePromptMessagesPromptsResponse200Content$Outbound = string | Array<(components.TextContentPartSchema$Outbound & {
|
|
2798
|
+
type: "text";
|
|
2799
|
+
}) | components.ImageContentPartSchema$Outbound | components.AudioContentPartSchema$Outbound | CreatePrompt2Prompts4$Outbound>;
|
|
2800
|
+
/** @internal */
|
|
2801
|
+
export declare const CreatePromptMessagesPromptsResponse200Content$outboundSchema: z.ZodType<CreatePromptMessagesPromptsResponse200Content$Outbound, z.ZodTypeDef, CreatePromptMessagesPromptsResponse200Content>;
|
|
2802
|
+
export declare function createPromptMessagesPromptsResponse200ContentToJSON(createPromptMessagesPromptsResponse200Content: CreatePromptMessagesPromptsResponse200Content): string;
|
|
2803
|
+
export declare function createPromptMessagesPromptsResponse200ContentFromJSON(jsonString: string): SafeParseResult<CreatePromptMessagesPromptsResponse200Content, SDKValidationError>;
|
|
2804
|
+
/** @internal */
|
|
2805
|
+
export declare const CreatePromptMessagesPromptsUserMessage$inboundSchema: z.ZodType<CreatePromptMessagesPromptsUserMessage, z.ZodTypeDef, unknown>;
|
|
2806
|
+
/** @internal */
|
|
2807
|
+
export type CreatePromptMessagesPromptsUserMessage$Outbound = {
|
|
2808
|
+
role: "user";
|
|
2809
|
+
name?: string | undefined;
|
|
2810
|
+
content: string | Array<(components.TextContentPartSchema$Outbound & {
|
|
2811
|
+
type: "text";
|
|
2812
|
+
}) | components.ImageContentPartSchema$Outbound | components.AudioContentPartSchema$Outbound | CreatePrompt2Prompts4$Outbound>;
|
|
2813
|
+
};
|
|
2814
|
+
/** @internal */
|
|
2815
|
+
export declare const CreatePromptMessagesPromptsUserMessage$outboundSchema: z.ZodType<CreatePromptMessagesPromptsUserMessage$Outbound, z.ZodTypeDef, CreatePromptMessagesPromptsUserMessage>;
|
|
2816
|
+
export declare function createPromptMessagesPromptsUserMessageToJSON(createPromptMessagesPromptsUserMessage: CreatePromptMessagesPromptsUserMessage): string;
|
|
2817
|
+
export declare function createPromptMessagesPromptsUserMessageFromJSON(jsonString: string): SafeParseResult<CreatePromptMessagesPromptsUserMessage, SDKValidationError>;
|
|
2818
|
+
/** @internal */
|
|
2819
|
+
export declare const CreatePromptMessagesPromptsResponseContent$inboundSchema: z.ZodType<CreatePromptMessagesPromptsResponseContent, z.ZodTypeDef, unknown>;
|
|
2820
|
+
/** @internal */
|
|
2821
|
+
export type CreatePromptMessagesPromptsResponseContent$Outbound = string | Array<components.TextContentPartSchema$Outbound>;
|
|
2822
|
+
/** @internal */
|
|
2823
|
+
export declare const CreatePromptMessagesPromptsResponseContent$outboundSchema: z.ZodType<CreatePromptMessagesPromptsResponseContent$Outbound, z.ZodTypeDef, CreatePromptMessagesPromptsResponseContent>;
|
|
2824
|
+
export declare function createPromptMessagesPromptsResponseContentToJSON(createPromptMessagesPromptsResponseContent: CreatePromptMessagesPromptsResponseContent): string;
|
|
2825
|
+
export declare function createPromptMessagesPromptsResponseContentFromJSON(jsonString: string): SafeParseResult<CreatePromptMessagesPromptsResponseContent, SDKValidationError>;
|
|
2826
|
+
/** @internal */
|
|
2827
|
+
export declare const CreatePromptMessagesPromptsSystemMessage$inboundSchema: z.ZodType<CreatePromptMessagesPromptsSystemMessage, z.ZodTypeDef, unknown>;
|
|
2828
|
+
/** @internal */
|
|
2829
|
+
export type CreatePromptMessagesPromptsSystemMessage$Outbound = {
|
|
2830
|
+
role: "system";
|
|
2831
|
+
content: string | Array<components.TextContentPartSchema$Outbound>;
|
|
2832
|
+
name?: string | undefined;
|
|
2833
|
+
};
|
|
2834
|
+
/** @internal */
|
|
2835
|
+
export declare const CreatePromptMessagesPromptsSystemMessage$outboundSchema: z.ZodType<CreatePromptMessagesPromptsSystemMessage$Outbound, z.ZodTypeDef, CreatePromptMessagesPromptsSystemMessage>;
|
|
2836
|
+
export declare function createPromptMessagesPromptsSystemMessageToJSON(createPromptMessagesPromptsSystemMessage: CreatePromptMessagesPromptsSystemMessage): string;
|
|
2837
|
+
export declare function createPromptMessagesPromptsSystemMessageFromJSON(jsonString: string): SafeParseResult<CreatePromptMessagesPromptsSystemMessage, SDKValidationError>;
|
|
2838
|
+
/** @internal */
|
|
2839
|
+
export declare const CreatePromptPromptsResponseMessages$inboundSchema: z.ZodType<CreatePromptPromptsResponseMessages, z.ZodTypeDef, unknown>;
|
|
2840
|
+
/** @internal */
|
|
2841
|
+
export type CreatePromptPromptsResponseMessages$Outbound = CreatePromptMessagesPromptsSystemMessage$Outbound | CreatePromptMessagesPromptsUserMessage$Outbound | CreatePromptMessagesPromptsAssistantMessage$Outbound | CreatePromptMessagesPromptsToolMessage$Outbound;
|
|
2842
|
+
/** @internal */
|
|
2843
|
+
export declare const CreatePromptPromptsResponseMessages$outboundSchema: z.ZodType<CreatePromptPromptsResponseMessages$Outbound, z.ZodTypeDef, CreatePromptPromptsResponseMessages>;
|
|
2844
|
+
export declare function createPromptPromptsResponseMessagesToJSON(createPromptPromptsResponseMessages: CreatePromptPromptsResponseMessages): string;
|
|
2845
|
+
export declare function createPromptPromptsResponseMessagesFromJSON(jsonString: string): SafeParseResult<CreatePromptPromptsResponseMessages, SDKValidationError>;
|
|
2846
|
+
/** @internal */
|
|
2847
|
+
export declare const PromptField$inboundSchema: z.ZodType<PromptField, z.ZodTypeDef, unknown>;
|
|
2848
|
+
/** @internal */
|
|
2849
|
+
export type PromptField$Outbound = {
|
|
2850
|
+
audio?: CreatePromptPromptsAudio$Outbound | null | undefined;
|
|
2851
|
+
frequency_penalty?: number | null | undefined;
|
|
2852
|
+
max_tokens?: number | null | undefined;
|
|
2853
|
+
max_completion_tokens?: number | null | undefined;
|
|
2854
|
+
logprobs?: boolean | null | undefined;
|
|
2855
|
+
top_logprobs?: number | null | undefined;
|
|
2856
|
+
n?: number | null | undefined;
|
|
2857
|
+
presence_penalty?: number | null | undefined;
|
|
2858
|
+
response_format?: CreatePromptResponseFormatPromptsText$Outbound | CreatePromptResponseFormatPromptsJSONObject$Outbound | CreatePromptResponseFormatPromptsResponse200JSONSchema$Outbound | undefined;
|
|
2859
|
+
reasoning_effort?: string | undefined;
|
|
2860
|
+
verbosity?: string | undefined;
|
|
2861
|
+
seed?: number | null | undefined;
|
|
2862
|
+
stop?: string | Array<string> | null | undefined;
|
|
2863
|
+
stream_options?: CreatePromptPromptsStreamOptions$Outbound | null | undefined;
|
|
2864
|
+
thinking?: components.ThinkingConfigDisabledSchema$Outbound | components.ThinkingConfigEnabledSchema$Outbound | undefined;
|
|
2865
|
+
temperature?: number | null | undefined;
|
|
2866
|
+
top_p?: number | null | undefined;
|
|
2867
|
+
top_k?: number | null | undefined;
|
|
2868
|
+
tool_choice?: CreatePromptToolChoicePrompts2$Outbound | string | undefined;
|
|
2869
|
+
parallel_tool_calls?: boolean | undefined;
|
|
2870
|
+
modalities?: Array<string> | null | undefined;
|
|
2871
|
+
guardrails?: Array<CreatePromptPromptsGuardrails$Outbound> | undefined;
|
|
2872
|
+
messages?: Array<CreatePromptMessagesPromptsSystemMessage$Outbound | CreatePromptMessagesPromptsUserMessage$Outbound | CreatePromptMessagesPromptsAssistantMessage$Outbound | CreatePromptMessagesPromptsToolMessage$Outbound> | undefined;
|
|
2873
|
+
model?: string | null | undefined;
|
|
2874
|
+
version?: string | undefined;
|
|
2106
2875
|
};
|
|
2107
2876
|
/** @internal */
|
|
2108
|
-
export declare const
|
|
2109
|
-
export declare function
|
|
2110
|
-
export declare function
|
|
2877
|
+
export declare const PromptField$outboundSchema: z.ZodType<PromptField$Outbound, z.ZodTypeDef, PromptField>;
|
|
2878
|
+
export declare function promptFieldToJSON(promptField: PromptField): string;
|
|
2879
|
+
export declare function promptFieldFromJSON(jsonString: string): SafeParseResult<PromptField, SDKValidationError>;
|
|
2111
2880
|
/** @internal */
|
|
2112
2881
|
export declare const CreatePromptUseCases$inboundSchema: z.ZodNativeEnum<typeof CreatePromptUseCases>;
|
|
2113
2882
|
/** @internal */
|
|
@@ -2141,7 +2910,8 @@ export type CreatePromptPrompt$Outbound = {
|
|
|
2141
2910
|
updated_by_id?: string | null | undefined;
|
|
2142
2911
|
display_name: string;
|
|
2143
2912
|
description?: string | null | undefined;
|
|
2144
|
-
prompt_config
|
|
2913
|
+
prompt_config?: PromptConfig$Outbound | undefined;
|
|
2914
|
+
prompt: PromptField$Outbound;
|
|
2145
2915
|
metadata?: CreatePromptPromptsMetadata$Outbound | undefined;
|
|
2146
2916
|
};
|
|
2147
2917
|
/** @internal */
|