@orq-ai/node 4.2.0-rc.44 → 4.2.0-rc.46
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 +4770 -1625
- 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 +3 -3
- package/lib/config.js +3 -3
- 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 +3 -3
- 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
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import * as z from "zod/v3";
|
|
2
2
|
import { ClosedEnum } from "../../types/enums.js";
|
|
3
3
|
import { Result as SafeParseResult } from "../../types/fp.js";
|
|
4
|
+
import * as components from "../components/index.js";
|
|
4
5
|
import { SDKValidationError } from "../errors/sdkvalidationerror.js";
|
|
5
6
|
export type GetPromptVersionRequest = {
|
|
6
7
|
/**
|
|
@@ -65,25 +66,25 @@ export declare const GetPromptVersionResponseFormat4: {
|
|
|
65
66
|
readonly Pcm: "pcm";
|
|
66
67
|
};
|
|
67
68
|
export type GetPromptVersionResponseFormat4 = ClosedEnum<typeof GetPromptVersionResponseFormat4>;
|
|
68
|
-
export declare const
|
|
69
|
+
export declare const GetPromptVersionResponseFormatPromptsResponse200ApplicationJSONResponseBodyType: {
|
|
69
70
|
readonly Text: "text";
|
|
70
71
|
};
|
|
71
|
-
export type
|
|
72
|
+
export type GetPromptVersionResponseFormatPromptsResponse200ApplicationJSONResponseBodyType = ClosedEnum<typeof GetPromptVersionResponseFormatPromptsResponse200ApplicationJSONResponseBodyType>;
|
|
72
73
|
export type GetPromptVersionResponseFormat3 = {
|
|
73
|
-
type:
|
|
74
|
+
type: GetPromptVersionResponseFormatPromptsResponse200ApplicationJSONResponseBodyType;
|
|
74
75
|
};
|
|
75
|
-
export declare const
|
|
76
|
+
export declare const GetPromptVersionResponseFormatPromptsResponse200ApplicationJSONType: {
|
|
76
77
|
readonly JsonObject: "json_object";
|
|
77
78
|
};
|
|
78
|
-
export type
|
|
79
|
+
export type GetPromptVersionResponseFormatPromptsResponse200ApplicationJSONType = ClosedEnum<typeof GetPromptVersionResponseFormatPromptsResponse200ApplicationJSONType>;
|
|
79
80
|
export type GetPromptVersionResponseFormat2 = {
|
|
80
|
-
type:
|
|
81
|
+
type: GetPromptVersionResponseFormatPromptsResponse200ApplicationJSONType;
|
|
81
82
|
};
|
|
82
|
-
export declare const
|
|
83
|
+
export declare const GetPromptVersionResponseFormatPromptsResponse200Type: {
|
|
83
84
|
readonly JsonSchema: "json_schema";
|
|
84
85
|
};
|
|
85
|
-
export type
|
|
86
|
-
export type
|
|
86
|
+
export type GetPromptVersionResponseFormatPromptsResponse200Type = ClosedEnum<typeof GetPromptVersionResponseFormatPromptsResponse200Type>;
|
|
87
|
+
export type GetPromptVersionResponseFormatPromptsResponseJsonSchema = {
|
|
87
88
|
name: string;
|
|
88
89
|
description?: string | undefined;
|
|
89
90
|
strict?: boolean | undefined;
|
|
@@ -92,9 +93,9 @@ export type GetPromptVersionResponseFormatJsonSchema = {
|
|
|
92
93
|
};
|
|
93
94
|
};
|
|
94
95
|
export type GetPromptVersionResponseFormat1 = {
|
|
95
|
-
type:
|
|
96
|
+
type: GetPromptVersionResponseFormatPromptsResponse200Type;
|
|
96
97
|
displayName?: string | undefined;
|
|
97
|
-
jsonSchema:
|
|
98
|
+
jsonSchema: GetPromptVersionResponseFormatPromptsResponseJsonSchema;
|
|
98
99
|
};
|
|
99
100
|
/**
|
|
100
101
|
* An object specifying the format that the model must output.
|
|
@@ -107,7 +108,7 @@ export type GetPromptVersionResponseFormat1 = {
|
|
|
107
108
|
*
|
|
108
109
|
* 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.
|
|
109
110
|
*/
|
|
110
|
-
export type
|
|
111
|
+
export type GetPromptVersionPromptsResponseFormat = GetPromptVersionResponseFormat1 | GetPromptVersionResponseFormat2 | GetPromptVersionResponseFormat3 | GetPromptVersionResponseFormat4 | GetPromptVersionResponseFormat5 | GetPromptVersionResponseFormat6;
|
|
111
112
|
/**
|
|
112
113
|
* The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider
|
|
113
114
|
*/
|
|
@@ -133,7 +134,7 @@ export type GetPromptVersionEncodingFormat = ClosedEnum<typeof GetPromptVersionE
|
|
|
133
134
|
/**
|
|
134
135
|
* Constrains effort on reasoning for reasoning models. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.
|
|
135
136
|
*/
|
|
136
|
-
export declare const
|
|
137
|
+
export declare const GetPromptVersionPromptsReasoningEffort: {
|
|
137
138
|
readonly None: "none";
|
|
138
139
|
readonly Disable: "disable";
|
|
139
140
|
readonly Minimal: "minimal";
|
|
@@ -144,7 +145,7 @@ export declare const GetPromptVersionReasoningEffort: {
|
|
|
144
145
|
/**
|
|
145
146
|
* Constrains effort on reasoning for reasoning models. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.
|
|
146
147
|
*/
|
|
147
|
-
export type
|
|
148
|
+
export type GetPromptVersionPromptsReasoningEffort = ClosedEnum<typeof GetPromptVersionPromptsReasoningEffort>;
|
|
148
149
|
/**
|
|
149
150
|
* Controls the verbosity of the model output.
|
|
150
151
|
*/
|
|
@@ -243,7 +244,7 @@ export type GetPromptVersionModelParameters = {
|
|
|
243
244
|
/**
|
|
244
245
|
* Constrains effort on reasoning for reasoning models. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.
|
|
245
246
|
*/
|
|
246
|
-
reasoningEffort?:
|
|
247
|
+
reasoningEffort?: GetPromptVersionPromptsReasoningEffort | undefined;
|
|
247
248
|
/**
|
|
248
249
|
* 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`
|
|
249
250
|
*/
|
|
@@ -391,11 +392,13 @@ export type GetPromptVersionMessages = {
|
|
|
391
392
|
toolCallId?: string | null | undefined;
|
|
392
393
|
};
|
|
393
394
|
/**
|
|
394
|
-
* A list of messages compatible with the openAI schema
|
|
395
|
+
* [DEPRECATED] Use the `prompt` property instead. A list of messages compatible with the openAI schema.
|
|
396
|
+
*
|
|
397
|
+
* @deprecated class: This will be removed in a future release, please migrate away from it as soon as possible.
|
|
395
398
|
*/
|
|
396
399
|
export type GetPromptVersionPromptConfig = {
|
|
397
400
|
stream?: boolean | undefined;
|
|
398
|
-
model?: string | undefined;
|
|
401
|
+
model?: string | null | undefined;
|
|
399
402
|
/**
|
|
400
403
|
* The id of the resource
|
|
401
404
|
*/
|
|
@@ -408,7 +411,7 @@ export type GetPromptVersionPromptConfig = {
|
|
|
408
411
|
* Model Parameters: Not all parameters apply to every model
|
|
409
412
|
*/
|
|
410
413
|
modelParameters?: GetPromptVersionModelParameters | undefined;
|
|
411
|
-
provider?: GetPromptVersionProvider | undefined;
|
|
414
|
+
provider?: GetPromptVersionProvider | null | undefined;
|
|
412
415
|
/**
|
|
413
416
|
* The ID of the integration to use
|
|
414
417
|
*/
|
|
@@ -416,6 +419,586 @@ export type GetPromptVersionPromptConfig = {
|
|
|
416
419
|
version?: string | undefined;
|
|
417
420
|
messages: Array<GetPromptVersionMessages>;
|
|
418
421
|
};
|
|
422
|
+
/**
|
|
423
|
+
* The voice the model uses to respond. Supported voices are alloy, echo, fable, onyx, nova, and shimmer.
|
|
424
|
+
*/
|
|
425
|
+
export declare const GetPromptVersionVoice: {
|
|
426
|
+
readonly Alloy: "alloy";
|
|
427
|
+
readonly Echo: "echo";
|
|
428
|
+
readonly Fable: "fable";
|
|
429
|
+
readonly Onyx: "onyx";
|
|
430
|
+
readonly Nova: "nova";
|
|
431
|
+
readonly Shimmer: "shimmer";
|
|
432
|
+
};
|
|
433
|
+
/**
|
|
434
|
+
* The voice the model uses to respond. Supported voices are alloy, echo, fable, onyx, nova, and shimmer.
|
|
435
|
+
*/
|
|
436
|
+
export type GetPromptVersionVoice = ClosedEnum<typeof GetPromptVersionVoice>;
|
|
437
|
+
/**
|
|
438
|
+
* Specifies the output audio format. Must be one of wav, mp3, flac, opus, or pcm16.
|
|
439
|
+
*/
|
|
440
|
+
export declare const GetPromptVersionPromptsFormat: {
|
|
441
|
+
readonly Wav: "wav";
|
|
442
|
+
readonly Mp3: "mp3";
|
|
443
|
+
readonly Flac: "flac";
|
|
444
|
+
readonly Opus: "opus";
|
|
445
|
+
readonly Pcm16: "pcm16";
|
|
446
|
+
};
|
|
447
|
+
/**
|
|
448
|
+
* Specifies the output audio format. Must be one of wav, mp3, flac, opus, or pcm16.
|
|
449
|
+
*/
|
|
450
|
+
export type GetPromptVersionPromptsFormat = ClosedEnum<typeof GetPromptVersionPromptsFormat>;
|
|
451
|
+
/**
|
|
452
|
+
* Parameters for audio output. Required when audio output is requested with modalities: ["audio"]. Learn more.
|
|
453
|
+
*/
|
|
454
|
+
export type GetPromptVersionAudio = {
|
|
455
|
+
/**
|
|
456
|
+
* The voice the model uses to respond. Supported voices are alloy, echo, fable, onyx, nova, and shimmer.
|
|
457
|
+
*/
|
|
458
|
+
voice: GetPromptVersionVoice;
|
|
459
|
+
/**
|
|
460
|
+
* Specifies the output audio format. Must be one of wav, mp3, flac, opus, or pcm16.
|
|
461
|
+
*/
|
|
462
|
+
format: GetPromptVersionPromptsFormat;
|
|
463
|
+
};
|
|
464
|
+
export type GetPromptVersionResponseFormatJsonSchema = {
|
|
465
|
+
/**
|
|
466
|
+
* A description of what the response format is for, used by the model to determine how to respond in the format.
|
|
467
|
+
*/
|
|
468
|
+
description?: string | undefined;
|
|
469
|
+
/**
|
|
470
|
+
* 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.
|
|
471
|
+
*/
|
|
472
|
+
name: string;
|
|
473
|
+
/**
|
|
474
|
+
* The schema for the response format, described as a JSON Schema object.
|
|
475
|
+
*/
|
|
476
|
+
schema?: any | undefined;
|
|
477
|
+
/**
|
|
478
|
+
* 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.
|
|
479
|
+
*/
|
|
480
|
+
strict?: boolean | undefined;
|
|
481
|
+
};
|
|
482
|
+
/**
|
|
483
|
+
* @remarks
|
|
484
|
+
*
|
|
485
|
+
* JSON Schema response format. Used to generate structured JSON responses
|
|
486
|
+
*/
|
|
487
|
+
export type GetPromptVersionResponseFormatPromptsJSONSchema = {
|
|
488
|
+
type: "json_schema";
|
|
489
|
+
jsonSchema: GetPromptVersionResponseFormatJsonSchema;
|
|
490
|
+
};
|
|
491
|
+
/**
|
|
492
|
+
* @remarks
|
|
493
|
+
*
|
|
494
|
+
* 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.
|
|
495
|
+
*/
|
|
496
|
+
export type GetPromptVersionResponseFormatJSONObject = {
|
|
497
|
+
type: "json_object";
|
|
498
|
+
};
|
|
499
|
+
/**
|
|
500
|
+
* @remarks
|
|
501
|
+
*
|
|
502
|
+
* Default response format. Used to generate text responses
|
|
503
|
+
*/
|
|
504
|
+
export type GetPromptVersionResponseFormatText = {
|
|
505
|
+
type: "text";
|
|
506
|
+
};
|
|
507
|
+
/**
|
|
508
|
+
* An object specifying the format that the model must output
|
|
509
|
+
*/
|
|
510
|
+
export type GetPromptVersionResponseFormat = GetPromptVersionResponseFormatText | GetPromptVersionResponseFormatJSONObject | GetPromptVersionResponseFormatPromptsJSONSchema;
|
|
511
|
+
/**
|
|
512
|
+
* 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.
|
|
513
|
+
*
|
|
514
|
+
* @remarks
|
|
515
|
+
*
|
|
516
|
+
* - `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.
|
|
517
|
+
* - All models before `gpt-5.1` default to `medium` reasoning effort, and do not support `none`.
|
|
518
|
+
* - The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort.
|
|
519
|
+
* - `xhigh` is currently only supported for `gpt-5.1-codex-max`.
|
|
520
|
+
*
|
|
521
|
+
* Any of "none", "minimal", "low", "medium", "high", "xhigh".
|
|
522
|
+
*/
|
|
523
|
+
export declare const GetPromptVersionReasoningEffort: {
|
|
524
|
+
readonly None: "none";
|
|
525
|
+
readonly Minimal: "minimal";
|
|
526
|
+
readonly Low: "low";
|
|
527
|
+
readonly Medium: "medium";
|
|
528
|
+
readonly High: "high";
|
|
529
|
+
readonly Xhigh: "xhigh";
|
|
530
|
+
};
|
|
531
|
+
/**
|
|
532
|
+
* 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.
|
|
533
|
+
*
|
|
534
|
+
* @remarks
|
|
535
|
+
*
|
|
536
|
+
* - `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.
|
|
537
|
+
* - All models before `gpt-5.1` default to `medium` reasoning effort, and do not support `none`.
|
|
538
|
+
* - The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort.
|
|
539
|
+
* - `xhigh` is currently only supported for `gpt-5.1-codex-max`.
|
|
540
|
+
*
|
|
541
|
+
* Any of "none", "minimal", "low", "medium", "high", "xhigh".
|
|
542
|
+
*/
|
|
543
|
+
export type GetPromptVersionReasoningEffort = ClosedEnum<typeof GetPromptVersionReasoningEffort>;
|
|
544
|
+
/**
|
|
545
|
+
* Up to 4 sequences where the API will stop generating further tokens.
|
|
546
|
+
*/
|
|
547
|
+
export type GetPromptVersionStop = string | Array<string>;
|
|
548
|
+
/**
|
|
549
|
+
* Options for streaming response. Only set this when you set stream: true.
|
|
550
|
+
*/
|
|
551
|
+
export type GetPromptVersionStreamOptions = {
|
|
552
|
+
/**
|
|
553
|
+
* 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.
|
|
554
|
+
*/
|
|
555
|
+
includeUsage?: boolean | undefined;
|
|
556
|
+
};
|
|
557
|
+
export type GetPromptVersionThinking = components.ThinkingConfigDisabledSchema | components.ThinkingConfigEnabledSchema;
|
|
558
|
+
/**
|
|
559
|
+
* The type of the tool. Currently, only function is supported.
|
|
560
|
+
*/
|
|
561
|
+
export declare const GetPromptVersionToolChoiceType: {
|
|
562
|
+
readonly Function: "function";
|
|
563
|
+
};
|
|
564
|
+
/**
|
|
565
|
+
* The type of the tool. Currently, only function is supported.
|
|
566
|
+
*/
|
|
567
|
+
export type GetPromptVersionToolChoiceType = ClosedEnum<typeof GetPromptVersionToolChoiceType>;
|
|
568
|
+
export type GetPromptVersionToolChoiceFunction = {
|
|
569
|
+
/**
|
|
570
|
+
* The name of the function to call.
|
|
571
|
+
*/
|
|
572
|
+
name: string;
|
|
573
|
+
};
|
|
574
|
+
export type GetPromptVersionToolChoice2 = {
|
|
575
|
+
/**
|
|
576
|
+
* The type of the tool. Currently, only function is supported.
|
|
577
|
+
*/
|
|
578
|
+
type?: GetPromptVersionToolChoiceType | undefined;
|
|
579
|
+
function: GetPromptVersionToolChoiceFunction;
|
|
580
|
+
};
|
|
581
|
+
export declare const GetPromptVersionToolChoice1: {
|
|
582
|
+
readonly None: "none";
|
|
583
|
+
readonly Auto: "auto";
|
|
584
|
+
readonly Required: "required";
|
|
585
|
+
};
|
|
586
|
+
export type GetPromptVersionToolChoice1 = ClosedEnum<typeof GetPromptVersionToolChoice1>;
|
|
587
|
+
/**
|
|
588
|
+
* Controls which (if any) tool is called by the model.
|
|
589
|
+
*/
|
|
590
|
+
export type GetPromptVersionToolChoice = GetPromptVersionToolChoice2 | GetPromptVersionToolChoice1;
|
|
591
|
+
export declare const GetPromptVersionModalities: {
|
|
592
|
+
readonly Text: "text";
|
|
593
|
+
readonly Audio: "audio";
|
|
594
|
+
};
|
|
595
|
+
export type GetPromptVersionModalities = ClosedEnum<typeof GetPromptVersionModalities>;
|
|
596
|
+
/**
|
|
597
|
+
* The key of the guardrail.
|
|
598
|
+
*/
|
|
599
|
+
export declare const GetPromptVersionId1: {
|
|
600
|
+
readonly OrqPiiDetection: "orq_pii_detection";
|
|
601
|
+
readonly OrqSexualModeration: "orq_sexual_moderation";
|
|
602
|
+
readonly OrqHarmfulModeration: "orq_harmful_moderation";
|
|
603
|
+
};
|
|
604
|
+
/**
|
|
605
|
+
* The key of the guardrail.
|
|
606
|
+
*/
|
|
607
|
+
export type GetPromptVersionId1 = ClosedEnum<typeof GetPromptVersionId1>;
|
|
608
|
+
export type GetPromptVersionId = GetPromptVersionId1 | string;
|
|
609
|
+
/**
|
|
610
|
+
* Determines whether the guardrail runs on the input (user message) or output (model response).
|
|
611
|
+
*/
|
|
612
|
+
export declare const GetPromptVersionExecuteOn: {
|
|
613
|
+
readonly Input: "input";
|
|
614
|
+
readonly Output: "output";
|
|
615
|
+
};
|
|
616
|
+
/**
|
|
617
|
+
* Determines whether the guardrail runs on the input (user message) or output (model response).
|
|
618
|
+
*/
|
|
619
|
+
export type GetPromptVersionExecuteOn = ClosedEnum<typeof GetPromptVersionExecuteOn>;
|
|
620
|
+
export type GetPromptVersionGuardrails = {
|
|
621
|
+
id: GetPromptVersionId1 | string;
|
|
622
|
+
/**
|
|
623
|
+
* Determines whether the guardrail runs on the input (user message) or output (model response).
|
|
624
|
+
*/
|
|
625
|
+
executeOn: GetPromptVersionExecuteOn;
|
|
626
|
+
};
|
|
627
|
+
export type GetPromptVersionContentPromptsResponse2002 = components.TextContentPartSchema;
|
|
628
|
+
/**
|
|
629
|
+
* The contents of the tool message.
|
|
630
|
+
*/
|
|
631
|
+
export type GetPromptVersionMessagesPromptsResponse200Content = string | Array<components.TextContentPartSchema>;
|
|
632
|
+
/**
|
|
633
|
+
* Create a cache control breakpoint at this content block. Accepts only the value "ephemeral".
|
|
634
|
+
*/
|
|
635
|
+
export declare const GetPromptVersionMessagesPromptsType: {
|
|
636
|
+
readonly Ephemeral: "ephemeral";
|
|
637
|
+
};
|
|
638
|
+
/**
|
|
639
|
+
* Create a cache control breakpoint at this content block. Accepts only the value "ephemeral".
|
|
640
|
+
*/
|
|
641
|
+
export type GetPromptVersionMessagesPromptsType = ClosedEnum<typeof GetPromptVersionMessagesPromptsType>;
|
|
642
|
+
/**
|
|
643
|
+
* The time-to-live for the cache control breakpoint. This may be one of the following values:
|
|
644
|
+
*
|
|
645
|
+
* @remarks
|
|
646
|
+
*
|
|
647
|
+
* - `5m`: 5 minutes
|
|
648
|
+
* - `1h`: 1 hour
|
|
649
|
+
*
|
|
650
|
+
* Defaults to `5m`. Only supported by `Anthropic` Claude models.
|
|
651
|
+
*/
|
|
652
|
+
export declare const GetPromptVersionMessagesTtl: {
|
|
653
|
+
readonly Fivem: "5m";
|
|
654
|
+
readonly Oneh: "1h";
|
|
655
|
+
};
|
|
656
|
+
/**
|
|
657
|
+
* The time-to-live for the cache control breakpoint. This may be one of the following values:
|
|
658
|
+
*
|
|
659
|
+
* @remarks
|
|
660
|
+
*
|
|
661
|
+
* - `5m`: 5 minutes
|
|
662
|
+
* - `1h`: 1 hour
|
|
663
|
+
*
|
|
664
|
+
* Defaults to `5m`. Only supported by `Anthropic` Claude models.
|
|
665
|
+
*/
|
|
666
|
+
export type GetPromptVersionMessagesTtl = ClosedEnum<typeof GetPromptVersionMessagesTtl>;
|
|
667
|
+
export type GetPromptVersionMessagesCacheControl = {
|
|
668
|
+
/**
|
|
669
|
+
* Create a cache control breakpoint at this content block. Accepts only the value "ephemeral".
|
|
670
|
+
*/
|
|
671
|
+
type: GetPromptVersionMessagesPromptsType;
|
|
672
|
+
/**
|
|
673
|
+
* The time-to-live for the cache control breakpoint. This may be one of the following values:
|
|
674
|
+
*
|
|
675
|
+
* @remarks
|
|
676
|
+
*
|
|
677
|
+
* - `5m`: 5 minutes
|
|
678
|
+
* - `1h`: 1 hour
|
|
679
|
+
*
|
|
680
|
+
* Defaults to `5m`. Only supported by `Anthropic` Claude models.
|
|
681
|
+
*/
|
|
682
|
+
ttl?: GetPromptVersionMessagesTtl | undefined;
|
|
683
|
+
};
|
|
684
|
+
export type GetPromptVersionMessagesToolMessage = {
|
|
685
|
+
/**
|
|
686
|
+
* The role of the messages author, in this case tool.
|
|
687
|
+
*/
|
|
688
|
+
role: "tool";
|
|
689
|
+
/**
|
|
690
|
+
* The contents of the tool message.
|
|
691
|
+
*/
|
|
692
|
+
content: string | Array<components.TextContentPartSchema>;
|
|
693
|
+
/**
|
|
694
|
+
* Tool call that this message is responding to.
|
|
695
|
+
*/
|
|
696
|
+
toolCallId: string | null;
|
|
697
|
+
cacheControl?: GetPromptVersionMessagesCacheControl | undefined;
|
|
698
|
+
};
|
|
699
|
+
export type GetPromptVersionContentPromptsResponse2 = (components.TextContentPartSchema & {
|
|
700
|
+
type: "text";
|
|
701
|
+
}) | components.RefusalPartSchema | components.ReasoningPartSchema | components.RedactedReasoningPartSchema;
|
|
702
|
+
/**
|
|
703
|
+
* The contents of the assistant message. Required unless `tool_calls` or `function_call` is specified.
|
|
704
|
+
*/
|
|
705
|
+
export type GetPromptVersionMessagesPromptsResponseContent = string | Array<(components.TextContentPartSchema & {
|
|
706
|
+
type: "text";
|
|
707
|
+
}) | components.RefusalPartSchema | components.ReasoningPartSchema | components.RedactedReasoningPartSchema>;
|
|
708
|
+
/**
|
|
709
|
+
* Data about a previous audio response from the model.
|
|
710
|
+
*/
|
|
711
|
+
export type GetPromptVersionMessagesAudio = {
|
|
712
|
+
/**
|
|
713
|
+
* Unique identifier for a previous audio response from the model.
|
|
714
|
+
*/
|
|
715
|
+
id: string;
|
|
716
|
+
};
|
|
717
|
+
/**
|
|
718
|
+
* The type of the tool. Currently, only `function` is supported.
|
|
719
|
+
*/
|
|
720
|
+
export declare const GetPromptVersionMessagesType: {
|
|
721
|
+
readonly Function: "function";
|
|
722
|
+
};
|
|
723
|
+
/**
|
|
724
|
+
* The type of the tool. Currently, only `function` is supported.
|
|
725
|
+
*/
|
|
726
|
+
export type GetPromptVersionMessagesType = ClosedEnum<typeof GetPromptVersionMessagesType>;
|
|
727
|
+
export type GetPromptVersionMessagesFunction = {
|
|
728
|
+
/**
|
|
729
|
+
* The name of the function to call.
|
|
730
|
+
*/
|
|
731
|
+
name?: string | undefined;
|
|
732
|
+
/**
|
|
733
|
+
* 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.
|
|
734
|
+
*/
|
|
735
|
+
arguments?: string | undefined;
|
|
736
|
+
};
|
|
737
|
+
export type GetPromptVersionMessagesToolCalls = {
|
|
738
|
+
/**
|
|
739
|
+
* The ID of the tool call.
|
|
740
|
+
*/
|
|
741
|
+
id: string;
|
|
742
|
+
/**
|
|
743
|
+
* The type of the tool. Currently, only `function` is supported.
|
|
744
|
+
*/
|
|
745
|
+
type: GetPromptVersionMessagesType;
|
|
746
|
+
function: GetPromptVersionMessagesFunction;
|
|
747
|
+
/**
|
|
748
|
+
* Encrypted representation of the model internal reasoning state during function calling. Required by Gemini 3 models when continuing a conversation after a tool call.
|
|
749
|
+
*/
|
|
750
|
+
thoughtSignature?: string | undefined;
|
|
751
|
+
};
|
|
752
|
+
export type GetPromptVersionMessagesAssistantMessage = {
|
|
753
|
+
/**
|
|
754
|
+
* The contents of the assistant message. Required unless `tool_calls` or `function_call` is specified.
|
|
755
|
+
*/
|
|
756
|
+
content?: string | Array<(components.TextContentPartSchema & {
|
|
757
|
+
type: "text";
|
|
758
|
+
}) | components.RefusalPartSchema | components.ReasoningPartSchema | components.RedactedReasoningPartSchema> | null | undefined;
|
|
759
|
+
/**
|
|
760
|
+
* The refusal message by the assistant.
|
|
761
|
+
*/
|
|
762
|
+
refusal?: string | null | undefined;
|
|
763
|
+
/**
|
|
764
|
+
* The role of the messages author, in this case `assistant`.
|
|
765
|
+
*/
|
|
766
|
+
role: "assistant";
|
|
767
|
+
/**
|
|
768
|
+
* An optional name for the participant. Provides the model information to differentiate between participants of the same role.
|
|
769
|
+
*/
|
|
770
|
+
name?: string | undefined;
|
|
771
|
+
/**
|
|
772
|
+
* Data about a previous audio response from the model.
|
|
773
|
+
*/
|
|
774
|
+
audio?: GetPromptVersionMessagesAudio | null | undefined;
|
|
775
|
+
/**
|
|
776
|
+
* The tool calls generated by the model, such as function calls.
|
|
777
|
+
*/
|
|
778
|
+
toolCalls?: Array<GetPromptVersionMessagesToolCalls> | undefined;
|
|
779
|
+
};
|
|
780
|
+
/**
|
|
781
|
+
* Create a cache control breakpoint at this content block. Accepts only the value "ephemeral".
|
|
782
|
+
*/
|
|
783
|
+
export declare const GetPromptVersion2PromptsResponse200ApplicationJSONType: {
|
|
784
|
+
readonly Ephemeral: "ephemeral";
|
|
785
|
+
};
|
|
786
|
+
/**
|
|
787
|
+
* Create a cache control breakpoint at this content block. Accepts only the value "ephemeral".
|
|
788
|
+
*/
|
|
789
|
+
export type GetPromptVersion2PromptsResponse200ApplicationJSONType = ClosedEnum<typeof GetPromptVersion2PromptsResponse200ApplicationJSONType>;
|
|
790
|
+
/**
|
|
791
|
+
* The time-to-live for the cache control breakpoint. This may be one of the following values:
|
|
792
|
+
*
|
|
793
|
+
* @remarks
|
|
794
|
+
*
|
|
795
|
+
* - `5m`: 5 minutes
|
|
796
|
+
* - `1h`: 1 hour
|
|
797
|
+
*
|
|
798
|
+
* Defaults to `5m`. Only supported by `Anthropic` Claude models.
|
|
799
|
+
*/
|
|
800
|
+
export declare const GetPromptVersion2Ttl: {
|
|
801
|
+
readonly Fivem: "5m";
|
|
802
|
+
readonly Oneh: "1h";
|
|
803
|
+
};
|
|
804
|
+
/**
|
|
805
|
+
* The time-to-live for the cache control breakpoint. This may be one of the following values:
|
|
806
|
+
*
|
|
807
|
+
* @remarks
|
|
808
|
+
*
|
|
809
|
+
* - `5m`: 5 minutes
|
|
810
|
+
* - `1h`: 1 hour
|
|
811
|
+
*
|
|
812
|
+
* Defaults to `5m`. Only supported by `Anthropic` Claude models.
|
|
813
|
+
*/
|
|
814
|
+
export type GetPromptVersion2Ttl = ClosedEnum<typeof GetPromptVersion2Ttl>;
|
|
815
|
+
export type GetPromptVersion2CacheControl = {
|
|
816
|
+
/**
|
|
817
|
+
* Create a cache control breakpoint at this content block. Accepts only the value "ephemeral".
|
|
818
|
+
*/
|
|
819
|
+
type: GetPromptVersion2PromptsResponse200ApplicationJSONType;
|
|
820
|
+
/**
|
|
821
|
+
* The time-to-live for the cache control breakpoint. This may be one of the following values:
|
|
822
|
+
*
|
|
823
|
+
* @remarks
|
|
824
|
+
*
|
|
825
|
+
* - `5m`: 5 minutes
|
|
826
|
+
* - `1h`: 1 hour
|
|
827
|
+
*
|
|
828
|
+
* Defaults to `5m`. Only supported by `Anthropic` Claude models.
|
|
829
|
+
*/
|
|
830
|
+
ttl?: GetPromptVersion2Ttl | undefined;
|
|
831
|
+
};
|
|
832
|
+
export type GetPromptVersion24 = {
|
|
833
|
+
/**
|
|
834
|
+
* The type of the content part. Always `file`.
|
|
835
|
+
*/
|
|
836
|
+
type: "file";
|
|
837
|
+
cacheControl?: GetPromptVersion2CacheControl | undefined;
|
|
838
|
+
/**
|
|
839
|
+
* File data for the content part. Must contain either file_data or uri, but not both.
|
|
840
|
+
*/
|
|
841
|
+
file: components.FileContentPartSchema;
|
|
842
|
+
};
|
|
843
|
+
export type GetPromptVersionContentPrompts2 = (components.TextContentPartSchema & {
|
|
844
|
+
type: "text";
|
|
845
|
+
}) | components.ImageContentPartSchema | components.AudioContentPartSchema | GetPromptVersion24;
|
|
846
|
+
/**
|
|
847
|
+
* The contents of the user message.
|
|
848
|
+
*/
|
|
849
|
+
export type GetPromptVersionMessagesPromptsContent = string | Array<(components.TextContentPartSchema & {
|
|
850
|
+
type: "text";
|
|
851
|
+
}) | components.ImageContentPartSchema | components.AudioContentPartSchema | GetPromptVersion24>;
|
|
852
|
+
export type GetPromptVersionMessagesUserMessage = {
|
|
853
|
+
/**
|
|
854
|
+
* The role of the messages author, in this case `user`.
|
|
855
|
+
*/
|
|
856
|
+
role: "user";
|
|
857
|
+
/**
|
|
858
|
+
* An optional name for the participant. Provides the model information to differentiate between participants of the same role.
|
|
859
|
+
*/
|
|
860
|
+
name?: string | undefined;
|
|
861
|
+
/**
|
|
862
|
+
* The contents of the user message.
|
|
863
|
+
*/
|
|
864
|
+
content: string | Array<(components.TextContentPartSchema & {
|
|
865
|
+
type: "text";
|
|
866
|
+
}) | components.ImageContentPartSchema | components.AudioContentPartSchema | GetPromptVersion24>;
|
|
867
|
+
};
|
|
868
|
+
/**
|
|
869
|
+
* The contents of the system message.
|
|
870
|
+
*/
|
|
871
|
+
export type GetPromptVersionMessagesContent = string | Array<components.TextContentPartSchema>;
|
|
872
|
+
/**
|
|
873
|
+
* Developer-provided instructions that the model should follow, regardless of messages sent by the user.
|
|
874
|
+
*/
|
|
875
|
+
export type GetPromptVersionMessagesSystemMessage = {
|
|
876
|
+
/**
|
|
877
|
+
* The role of the messages author, in this case `system`.
|
|
878
|
+
*/
|
|
879
|
+
role: "system";
|
|
880
|
+
/**
|
|
881
|
+
* The contents of the system message.
|
|
882
|
+
*/
|
|
883
|
+
content: string | Array<components.TextContentPartSchema>;
|
|
884
|
+
/**
|
|
885
|
+
* An optional name for the participant. Provides the model information to differentiate between participants of the same role.
|
|
886
|
+
*/
|
|
887
|
+
name?: string | undefined;
|
|
888
|
+
};
|
|
889
|
+
export type GetPromptVersionPromptsMessages = GetPromptVersionMessagesSystemMessage | GetPromptVersionMessagesUserMessage | GetPromptVersionMessagesAssistantMessage | GetPromptVersionMessagesToolMessage;
|
|
890
|
+
/**
|
|
891
|
+
* Prompt configuration with model and messages. Use this instead of prompt_config.
|
|
892
|
+
*/
|
|
893
|
+
export type GetPromptVersionPromptField = {
|
|
894
|
+
/**
|
|
895
|
+
* Parameters for audio output. Required when audio output is requested with modalities: ["audio"]. Learn more.
|
|
896
|
+
*/
|
|
897
|
+
audio?: GetPromptVersionAudio | null | undefined;
|
|
898
|
+
/**
|
|
899
|
+
* 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.
|
|
900
|
+
*/
|
|
901
|
+
frequencyPenalty?: number | null | undefined;
|
|
902
|
+
/**
|
|
903
|
+
* `[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.
|
|
904
|
+
*
|
|
905
|
+
* @remarks
|
|
906
|
+
*
|
|
907
|
+
* This value is now `deprecated` in favor of `max_completion_tokens`, and is not compatible with o1 series models.
|
|
908
|
+
*/
|
|
909
|
+
maxTokens?: number | null | undefined;
|
|
910
|
+
/**
|
|
911
|
+
* An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and reasoning tokens
|
|
912
|
+
*/
|
|
913
|
+
maxCompletionTokens?: number | null | undefined;
|
|
914
|
+
/**
|
|
915
|
+
* 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.
|
|
916
|
+
*/
|
|
917
|
+
logprobs?: boolean | null | undefined;
|
|
918
|
+
/**
|
|
919
|
+
* 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.
|
|
920
|
+
*/
|
|
921
|
+
topLogprobs?: number | null | undefined;
|
|
922
|
+
/**
|
|
923
|
+
* 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.
|
|
924
|
+
*/
|
|
925
|
+
n?: number | null | undefined;
|
|
926
|
+
/**
|
|
927
|
+
* 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.
|
|
928
|
+
*/
|
|
929
|
+
presencePenalty?: number | null | undefined;
|
|
930
|
+
/**
|
|
931
|
+
* An object specifying the format that the model must output
|
|
932
|
+
*/
|
|
933
|
+
responseFormat?: GetPromptVersionResponseFormatText | GetPromptVersionResponseFormatJSONObject | GetPromptVersionResponseFormatPromptsJSONSchema | undefined;
|
|
934
|
+
/**
|
|
935
|
+
* 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.
|
|
936
|
+
*
|
|
937
|
+
* @remarks
|
|
938
|
+
*
|
|
939
|
+
* - `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.
|
|
940
|
+
* - All models before `gpt-5.1` default to `medium` reasoning effort, and do not support `none`.
|
|
941
|
+
* - The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort.
|
|
942
|
+
* - `xhigh` is currently only supported for `gpt-5.1-codex-max`.
|
|
943
|
+
*
|
|
944
|
+
* Any of "none", "minimal", "low", "medium", "high", "xhigh".
|
|
945
|
+
*/
|
|
946
|
+
reasoningEffort?: GetPromptVersionReasoningEffort | undefined;
|
|
947
|
+
/**
|
|
948
|
+
* Adjusts response verbosity. Lower levels yield shorter answers.
|
|
949
|
+
*/
|
|
950
|
+
verbosity?: string | undefined;
|
|
951
|
+
/**
|
|
952
|
+
* 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.
|
|
953
|
+
*/
|
|
954
|
+
seed?: number | null | undefined;
|
|
955
|
+
/**
|
|
956
|
+
* Up to 4 sequences where the API will stop generating further tokens.
|
|
957
|
+
*/
|
|
958
|
+
stop?: string | Array<string> | null | undefined;
|
|
959
|
+
/**
|
|
960
|
+
* Options for streaming response. Only set this when you set stream: true.
|
|
961
|
+
*/
|
|
962
|
+
streamOptions?: GetPromptVersionStreamOptions | null | undefined;
|
|
963
|
+
thinking?: components.ThinkingConfigDisabledSchema | components.ThinkingConfigEnabledSchema | undefined;
|
|
964
|
+
/**
|
|
965
|
+
* 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.
|
|
966
|
+
*/
|
|
967
|
+
temperature?: number | null | undefined;
|
|
968
|
+
/**
|
|
969
|
+
* An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass.
|
|
970
|
+
*/
|
|
971
|
+
topP?: number | null | undefined;
|
|
972
|
+
/**
|
|
973
|
+
* Limits the model to consider only the top k most likely tokens at each step.
|
|
974
|
+
*/
|
|
975
|
+
topK?: number | null | undefined;
|
|
976
|
+
/**
|
|
977
|
+
* Controls which (if any) tool is called by the model.
|
|
978
|
+
*/
|
|
979
|
+
toolChoice?: GetPromptVersionToolChoice2 | GetPromptVersionToolChoice1 | undefined;
|
|
980
|
+
/**
|
|
981
|
+
* Whether to enable parallel function calling during tool use.
|
|
982
|
+
*/
|
|
983
|
+
parallelToolCalls?: boolean | undefined;
|
|
984
|
+
/**
|
|
985
|
+
* 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"].
|
|
986
|
+
*/
|
|
987
|
+
modalities?: Array<GetPromptVersionModalities> | null | undefined;
|
|
988
|
+
/**
|
|
989
|
+
* A list of guardrails to apply to the request.
|
|
990
|
+
*/
|
|
991
|
+
guardrails?: Array<GetPromptVersionGuardrails> | undefined;
|
|
992
|
+
/**
|
|
993
|
+
* Array of messages that make up the conversation. Each message has a role (system, user, assistant, or tool) and content.
|
|
994
|
+
*/
|
|
995
|
+
messages?: Array<GetPromptVersionMessagesSystemMessage | GetPromptVersionMessagesUserMessage | GetPromptVersionMessagesAssistantMessage | GetPromptVersionMessagesToolMessage> | undefined;
|
|
996
|
+
/**
|
|
997
|
+
* 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}`.
|
|
998
|
+
*/
|
|
999
|
+
model?: string | null | undefined;
|
|
1000
|
+
version?: string | undefined;
|
|
1001
|
+
};
|
|
419
1002
|
export declare const GetPromptVersionUseCases: {
|
|
420
1003
|
readonly AgentsSimulations: "Agents simulations";
|
|
421
1004
|
readonly Agents: "Agents";
|
|
@@ -477,9 +1060,15 @@ export type GetPromptVersionResponseBody = {
|
|
|
477
1060
|
*/
|
|
478
1061
|
description?: string | null | undefined;
|
|
479
1062
|
/**
|
|
480
|
-
* A list of messages compatible with the openAI schema
|
|
1063
|
+
* [DEPRECATED] Use the `prompt` property instead. A list of messages compatible with the openAI schema.
|
|
1064
|
+
*
|
|
1065
|
+
* @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
|
|
1066
|
+
*/
|
|
1067
|
+
promptConfig?: GetPromptVersionPromptConfig | undefined;
|
|
1068
|
+
/**
|
|
1069
|
+
* Prompt configuration with model and messages. Use this instead of prompt_config.
|
|
481
1070
|
*/
|
|
482
|
-
|
|
1071
|
+
prompt: GetPromptVersionPromptField;
|
|
483
1072
|
metadata?: GetPromptVersionMetadata | undefined;
|
|
484
1073
|
timestamp: string;
|
|
485
1074
|
};
|
|
@@ -515,9 +1104,9 @@ export declare const GetPromptVersionResponseFormat4$inboundSchema: z.ZodNativeE
|
|
|
515
1104
|
/** @internal */
|
|
516
1105
|
export declare const GetPromptVersionResponseFormat4$outboundSchema: z.ZodNativeEnum<typeof GetPromptVersionResponseFormat4>;
|
|
517
1106
|
/** @internal */
|
|
518
|
-
export declare const
|
|
1107
|
+
export declare const GetPromptVersionResponseFormatPromptsResponse200ApplicationJSONResponseBodyType$inboundSchema: z.ZodNativeEnum<typeof GetPromptVersionResponseFormatPromptsResponse200ApplicationJSONResponseBodyType>;
|
|
519
1108
|
/** @internal */
|
|
520
|
-
export declare const
|
|
1109
|
+
export declare const GetPromptVersionResponseFormatPromptsResponse200ApplicationJSONResponseBodyType$outboundSchema: z.ZodNativeEnum<typeof GetPromptVersionResponseFormatPromptsResponse200ApplicationJSONResponseBodyType>;
|
|
521
1110
|
/** @internal */
|
|
522
1111
|
export declare const GetPromptVersionResponseFormat3$inboundSchema: z.ZodType<GetPromptVersionResponseFormat3, z.ZodTypeDef, unknown>;
|
|
523
1112
|
/** @internal */
|
|
@@ -529,9 +1118,9 @@ export declare const GetPromptVersionResponseFormat3$outboundSchema: z.ZodType<G
|
|
|
529
1118
|
export declare function getPromptVersionResponseFormat3ToJSON(getPromptVersionResponseFormat3: GetPromptVersionResponseFormat3): string;
|
|
530
1119
|
export declare function getPromptVersionResponseFormat3FromJSON(jsonString: string): SafeParseResult<GetPromptVersionResponseFormat3, SDKValidationError>;
|
|
531
1120
|
/** @internal */
|
|
532
|
-
export declare const
|
|
1121
|
+
export declare const GetPromptVersionResponseFormatPromptsResponse200ApplicationJSONType$inboundSchema: z.ZodNativeEnum<typeof GetPromptVersionResponseFormatPromptsResponse200ApplicationJSONType>;
|
|
533
1122
|
/** @internal */
|
|
534
|
-
export declare const
|
|
1123
|
+
export declare const GetPromptVersionResponseFormatPromptsResponse200ApplicationJSONType$outboundSchema: z.ZodNativeEnum<typeof GetPromptVersionResponseFormatPromptsResponse200ApplicationJSONType>;
|
|
535
1124
|
/** @internal */
|
|
536
1125
|
export declare const GetPromptVersionResponseFormat2$inboundSchema: z.ZodType<GetPromptVersionResponseFormat2, z.ZodTypeDef, unknown>;
|
|
537
1126
|
/** @internal */
|
|
@@ -543,13 +1132,13 @@ export declare const GetPromptVersionResponseFormat2$outboundSchema: z.ZodType<G
|
|
|
543
1132
|
export declare function getPromptVersionResponseFormat2ToJSON(getPromptVersionResponseFormat2: GetPromptVersionResponseFormat2): string;
|
|
544
1133
|
export declare function getPromptVersionResponseFormat2FromJSON(jsonString: string): SafeParseResult<GetPromptVersionResponseFormat2, SDKValidationError>;
|
|
545
1134
|
/** @internal */
|
|
546
|
-
export declare const
|
|
1135
|
+
export declare const GetPromptVersionResponseFormatPromptsResponse200Type$inboundSchema: z.ZodNativeEnum<typeof GetPromptVersionResponseFormatPromptsResponse200Type>;
|
|
547
1136
|
/** @internal */
|
|
548
|
-
export declare const
|
|
1137
|
+
export declare const GetPromptVersionResponseFormatPromptsResponse200Type$outboundSchema: z.ZodNativeEnum<typeof GetPromptVersionResponseFormatPromptsResponse200Type>;
|
|
549
1138
|
/** @internal */
|
|
550
|
-
export declare const
|
|
1139
|
+
export declare const GetPromptVersionResponseFormatPromptsResponseJsonSchema$inboundSchema: z.ZodType<GetPromptVersionResponseFormatPromptsResponseJsonSchema, z.ZodTypeDef, unknown>;
|
|
551
1140
|
/** @internal */
|
|
552
|
-
export type
|
|
1141
|
+
export type GetPromptVersionResponseFormatPromptsResponseJsonSchema$Outbound = {
|
|
553
1142
|
name: string;
|
|
554
1143
|
description?: string | undefined;
|
|
555
1144
|
strict?: boolean | undefined;
|
|
@@ -558,29 +1147,29 @@ export type GetPromptVersionResponseFormatJsonSchema$Outbound = {
|
|
|
558
1147
|
};
|
|
559
1148
|
};
|
|
560
1149
|
/** @internal */
|
|
561
|
-
export declare const
|
|
562
|
-
export declare function
|
|
563
|
-
export declare function
|
|
1150
|
+
export declare const GetPromptVersionResponseFormatPromptsResponseJsonSchema$outboundSchema: z.ZodType<GetPromptVersionResponseFormatPromptsResponseJsonSchema$Outbound, z.ZodTypeDef, GetPromptVersionResponseFormatPromptsResponseJsonSchema>;
|
|
1151
|
+
export declare function getPromptVersionResponseFormatPromptsResponseJsonSchemaToJSON(getPromptVersionResponseFormatPromptsResponseJsonSchema: GetPromptVersionResponseFormatPromptsResponseJsonSchema): string;
|
|
1152
|
+
export declare function getPromptVersionResponseFormatPromptsResponseJsonSchemaFromJSON(jsonString: string): SafeParseResult<GetPromptVersionResponseFormatPromptsResponseJsonSchema, SDKValidationError>;
|
|
564
1153
|
/** @internal */
|
|
565
1154
|
export declare const GetPromptVersionResponseFormat1$inboundSchema: z.ZodType<GetPromptVersionResponseFormat1, z.ZodTypeDef, unknown>;
|
|
566
1155
|
/** @internal */
|
|
567
1156
|
export type GetPromptVersionResponseFormat1$Outbound = {
|
|
568
1157
|
type: string;
|
|
569
1158
|
display_name?: string | undefined;
|
|
570
|
-
json_schema:
|
|
1159
|
+
json_schema: GetPromptVersionResponseFormatPromptsResponseJsonSchema$Outbound;
|
|
571
1160
|
};
|
|
572
1161
|
/** @internal */
|
|
573
1162
|
export declare const GetPromptVersionResponseFormat1$outboundSchema: z.ZodType<GetPromptVersionResponseFormat1$Outbound, z.ZodTypeDef, GetPromptVersionResponseFormat1>;
|
|
574
1163
|
export declare function getPromptVersionResponseFormat1ToJSON(getPromptVersionResponseFormat1: GetPromptVersionResponseFormat1): string;
|
|
575
1164
|
export declare function getPromptVersionResponseFormat1FromJSON(jsonString: string): SafeParseResult<GetPromptVersionResponseFormat1, SDKValidationError>;
|
|
576
1165
|
/** @internal */
|
|
577
|
-
export declare const
|
|
1166
|
+
export declare const GetPromptVersionPromptsResponseFormat$inboundSchema: z.ZodType<GetPromptVersionPromptsResponseFormat, z.ZodTypeDef, unknown>;
|
|
578
1167
|
/** @internal */
|
|
579
|
-
export type
|
|
1168
|
+
export type GetPromptVersionPromptsResponseFormat$Outbound = GetPromptVersionResponseFormat1$Outbound | GetPromptVersionResponseFormat2$Outbound | GetPromptVersionResponseFormat3$Outbound | string | string | string;
|
|
580
1169
|
/** @internal */
|
|
581
|
-
export declare const
|
|
582
|
-
export declare function
|
|
583
|
-
export declare function
|
|
1170
|
+
export declare const GetPromptVersionPromptsResponseFormat$outboundSchema: z.ZodType<GetPromptVersionPromptsResponseFormat$Outbound, z.ZodTypeDef, GetPromptVersionPromptsResponseFormat>;
|
|
1171
|
+
export declare function getPromptVersionPromptsResponseFormatToJSON(getPromptVersionPromptsResponseFormat: GetPromptVersionPromptsResponseFormat): string;
|
|
1172
|
+
export declare function getPromptVersionPromptsResponseFormatFromJSON(jsonString: string): SafeParseResult<GetPromptVersionPromptsResponseFormat, SDKValidationError>;
|
|
584
1173
|
/** @internal */
|
|
585
1174
|
export declare const GetPromptVersionPhotoRealVersion$inboundSchema: z.ZodNativeEnum<typeof GetPromptVersionPhotoRealVersion>;
|
|
586
1175
|
/** @internal */
|
|
@@ -590,9 +1179,9 @@ export declare const GetPromptVersionEncodingFormat$inboundSchema: z.ZodNativeEn
|
|
|
590
1179
|
/** @internal */
|
|
591
1180
|
export declare const GetPromptVersionEncodingFormat$outboundSchema: z.ZodNativeEnum<typeof GetPromptVersionEncodingFormat>;
|
|
592
1181
|
/** @internal */
|
|
593
|
-
export declare const
|
|
1182
|
+
export declare const GetPromptVersionPromptsReasoningEffort$inboundSchema: z.ZodNativeEnum<typeof GetPromptVersionPromptsReasoningEffort>;
|
|
594
1183
|
/** @internal */
|
|
595
|
-
export declare const
|
|
1184
|
+
export declare const GetPromptVersionPromptsReasoningEffort$outboundSchema: z.ZodNativeEnum<typeof GetPromptVersionPromptsReasoningEffort>;
|
|
596
1185
|
/** @internal */
|
|
597
1186
|
export declare const GetPromptVersionVerbosity$inboundSchema: z.ZodNativeEnum<typeof GetPromptVersionVerbosity>;
|
|
598
1187
|
/** @internal */
|
|
@@ -757,11 +1346,11 @@ export declare const GetPromptVersionPromptConfig$inboundSchema: z.ZodType<GetPr
|
|
|
757
1346
|
/** @internal */
|
|
758
1347
|
export type GetPromptVersionPromptConfig$Outbound = {
|
|
759
1348
|
stream?: boolean | undefined;
|
|
760
|
-
model?: string | undefined;
|
|
1349
|
+
model?: string | null | undefined;
|
|
761
1350
|
model_db_id?: string | null | undefined;
|
|
762
1351
|
model_type?: string | null | undefined;
|
|
763
1352
|
model_parameters?: GetPromptVersionModelParameters$Outbound | undefined;
|
|
764
|
-
provider?: string | undefined;
|
|
1353
|
+
provider?: string | null | undefined;
|
|
765
1354
|
integration_id?: string | null | undefined;
|
|
766
1355
|
version?: string | undefined;
|
|
767
1356
|
messages: Array<GetPromptVersionMessages$Outbound>;
|
|
@@ -771,6 +1360,425 @@ export declare const GetPromptVersionPromptConfig$outboundSchema: z.ZodType<GetP
|
|
|
771
1360
|
export declare function getPromptVersionPromptConfigToJSON(getPromptVersionPromptConfig: GetPromptVersionPromptConfig): string;
|
|
772
1361
|
export declare function getPromptVersionPromptConfigFromJSON(jsonString: string): SafeParseResult<GetPromptVersionPromptConfig, SDKValidationError>;
|
|
773
1362
|
/** @internal */
|
|
1363
|
+
export declare const GetPromptVersionVoice$inboundSchema: z.ZodNativeEnum<typeof GetPromptVersionVoice>;
|
|
1364
|
+
/** @internal */
|
|
1365
|
+
export declare const GetPromptVersionVoice$outboundSchema: z.ZodNativeEnum<typeof GetPromptVersionVoice>;
|
|
1366
|
+
/** @internal */
|
|
1367
|
+
export declare const GetPromptVersionPromptsFormat$inboundSchema: z.ZodNativeEnum<typeof GetPromptVersionPromptsFormat>;
|
|
1368
|
+
/** @internal */
|
|
1369
|
+
export declare const GetPromptVersionPromptsFormat$outboundSchema: z.ZodNativeEnum<typeof GetPromptVersionPromptsFormat>;
|
|
1370
|
+
/** @internal */
|
|
1371
|
+
export declare const GetPromptVersionAudio$inboundSchema: z.ZodType<GetPromptVersionAudio, z.ZodTypeDef, unknown>;
|
|
1372
|
+
/** @internal */
|
|
1373
|
+
export type GetPromptVersionAudio$Outbound = {
|
|
1374
|
+
voice: string;
|
|
1375
|
+
format: string;
|
|
1376
|
+
};
|
|
1377
|
+
/** @internal */
|
|
1378
|
+
export declare const GetPromptVersionAudio$outboundSchema: z.ZodType<GetPromptVersionAudio$Outbound, z.ZodTypeDef, GetPromptVersionAudio>;
|
|
1379
|
+
export declare function getPromptVersionAudioToJSON(getPromptVersionAudio: GetPromptVersionAudio): string;
|
|
1380
|
+
export declare function getPromptVersionAudioFromJSON(jsonString: string): SafeParseResult<GetPromptVersionAudio, SDKValidationError>;
|
|
1381
|
+
/** @internal */
|
|
1382
|
+
export declare const GetPromptVersionResponseFormatJsonSchema$inboundSchema: z.ZodType<GetPromptVersionResponseFormatJsonSchema, z.ZodTypeDef, unknown>;
|
|
1383
|
+
/** @internal */
|
|
1384
|
+
export type GetPromptVersionResponseFormatJsonSchema$Outbound = {
|
|
1385
|
+
description?: string | undefined;
|
|
1386
|
+
name: string;
|
|
1387
|
+
schema?: any | undefined;
|
|
1388
|
+
strict: boolean;
|
|
1389
|
+
};
|
|
1390
|
+
/** @internal */
|
|
1391
|
+
export declare const GetPromptVersionResponseFormatJsonSchema$outboundSchema: z.ZodType<GetPromptVersionResponseFormatJsonSchema$Outbound, z.ZodTypeDef, GetPromptVersionResponseFormatJsonSchema>;
|
|
1392
|
+
export declare function getPromptVersionResponseFormatJsonSchemaToJSON(getPromptVersionResponseFormatJsonSchema: GetPromptVersionResponseFormatJsonSchema): string;
|
|
1393
|
+
export declare function getPromptVersionResponseFormatJsonSchemaFromJSON(jsonString: string): SafeParseResult<GetPromptVersionResponseFormatJsonSchema, SDKValidationError>;
|
|
1394
|
+
/** @internal */
|
|
1395
|
+
export declare const GetPromptVersionResponseFormatPromptsJSONSchema$inboundSchema: z.ZodType<GetPromptVersionResponseFormatPromptsJSONSchema, z.ZodTypeDef, unknown>;
|
|
1396
|
+
/** @internal */
|
|
1397
|
+
export type GetPromptVersionResponseFormatPromptsJSONSchema$Outbound = {
|
|
1398
|
+
type: "json_schema";
|
|
1399
|
+
json_schema: GetPromptVersionResponseFormatJsonSchema$Outbound;
|
|
1400
|
+
};
|
|
1401
|
+
/** @internal */
|
|
1402
|
+
export declare const GetPromptVersionResponseFormatPromptsJSONSchema$outboundSchema: z.ZodType<GetPromptVersionResponseFormatPromptsJSONSchema$Outbound, z.ZodTypeDef, GetPromptVersionResponseFormatPromptsJSONSchema>;
|
|
1403
|
+
export declare function getPromptVersionResponseFormatPromptsJSONSchemaToJSON(getPromptVersionResponseFormatPromptsJSONSchema: GetPromptVersionResponseFormatPromptsJSONSchema): string;
|
|
1404
|
+
export declare function getPromptVersionResponseFormatPromptsJSONSchemaFromJSON(jsonString: string): SafeParseResult<GetPromptVersionResponseFormatPromptsJSONSchema, SDKValidationError>;
|
|
1405
|
+
/** @internal */
|
|
1406
|
+
export declare const GetPromptVersionResponseFormatJSONObject$inboundSchema: z.ZodType<GetPromptVersionResponseFormatJSONObject, z.ZodTypeDef, unknown>;
|
|
1407
|
+
/** @internal */
|
|
1408
|
+
export type GetPromptVersionResponseFormatJSONObject$Outbound = {
|
|
1409
|
+
type: "json_object";
|
|
1410
|
+
};
|
|
1411
|
+
/** @internal */
|
|
1412
|
+
export declare const GetPromptVersionResponseFormatJSONObject$outboundSchema: z.ZodType<GetPromptVersionResponseFormatJSONObject$Outbound, z.ZodTypeDef, GetPromptVersionResponseFormatJSONObject>;
|
|
1413
|
+
export declare function getPromptVersionResponseFormatJSONObjectToJSON(getPromptVersionResponseFormatJSONObject: GetPromptVersionResponseFormatJSONObject): string;
|
|
1414
|
+
export declare function getPromptVersionResponseFormatJSONObjectFromJSON(jsonString: string): SafeParseResult<GetPromptVersionResponseFormatJSONObject, SDKValidationError>;
|
|
1415
|
+
/** @internal */
|
|
1416
|
+
export declare const GetPromptVersionResponseFormatText$inboundSchema: z.ZodType<GetPromptVersionResponseFormatText, z.ZodTypeDef, unknown>;
|
|
1417
|
+
/** @internal */
|
|
1418
|
+
export type GetPromptVersionResponseFormatText$Outbound = {
|
|
1419
|
+
type: "text";
|
|
1420
|
+
};
|
|
1421
|
+
/** @internal */
|
|
1422
|
+
export declare const GetPromptVersionResponseFormatText$outboundSchema: z.ZodType<GetPromptVersionResponseFormatText$Outbound, z.ZodTypeDef, GetPromptVersionResponseFormatText>;
|
|
1423
|
+
export declare function getPromptVersionResponseFormatTextToJSON(getPromptVersionResponseFormatText: GetPromptVersionResponseFormatText): string;
|
|
1424
|
+
export declare function getPromptVersionResponseFormatTextFromJSON(jsonString: string): SafeParseResult<GetPromptVersionResponseFormatText, SDKValidationError>;
|
|
1425
|
+
/** @internal */
|
|
1426
|
+
export declare const GetPromptVersionResponseFormat$inboundSchema: z.ZodType<GetPromptVersionResponseFormat, z.ZodTypeDef, unknown>;
|
|
1427
|
+
/** @internal */
|
|
1428
|
+
export type GetPromptVersionResponseFormat$Outbound = GetPromptVersionResponseFormatText$Outbound | GetPromptVersionResponseFormatJSONObject$Outbound | GetPromptVersionResponseFormatPromptsJSONSchema$Outbound;
|
|
1429
|
+
/** @internal */
|
|
1430
|
+
export declare const GetPromptVersionResponseFormat$outboundSchema: z.ZodType<GetPromptVersionResponseFormat$Outbound, z.ZodTypeDef, GetPromptVersionResponseFormat>;
|
|
1431
|
+
export declare function getPromptVersionResponseFormatToJSON(getPromptVersionResponseFormat: GetPromptVersionResponseFormat): string;
|
|
1432
|
+
export declare function getPromptVersionResponseFormatFromJSON(jsonString: string): SafeParseResult<GetPromptVersionResponseFormat, SDKValidationError>;
|
|
1433
|
+
/** @internal */
|
|
1434
|
+
export declare const GetPromptVersionReasoningEffort$inboundSchema: z.ZodNativeEnum<typeof GetPromptVersionReasoningEffort>;
|
|
1435
|
+
/** @internal */
|
|
1436
|
+
export declare const GetPromptVersionReasoningEffort$outboundSchema: z.ZodNativeEnum<typeof GetPromptVersionReasoningEffort>;
|
|
1437
|
+
/** @internal */
|
|
1438
|
+
export declare const GetPromptVersionStop$inboundSchema: z.ZodType<GetPromptVersionStop, z.ZodTypeDef, unknown>;
|
|
1439
|
+
/** @internal */
|
|
1440
|
+
export type GetPromptVersionStop$Outbound = string | Array<string>;
|
|
1441
|
+
/** @internal */
|
|
1442
|
+
export declare const GetPromptVersionStop$outboundSchema: z.ZodType<GetPromptVersionStop$Outbound, z.ZodTypeDef, GetPromptVersionStop>;
|
|
1443
|
+
export declare function getPromptVersionStopToJSON(getPromptVersionStop: GetPromptVersionStop): string;
|
|
1444
|
+
export declare function getPromptVersionStopFromJSON(jsonString: string): SafeParseResult<GetPromptVersionStop, SDKValidationError>;
|
|
1445
|
+
/** @internal */
|
|
1446
|
+
export declare const GetPromptVersionStreamOptions$inboundSchema: z.ZodType<GetPromptVersionStreamOptions, z.ZodTypeDef, unknown>;
|
|
1447
|
+
/** @internal */
|
|
1448
|
+
export type GetPromptVersionStreamOptions$Outbound = {
|
|
1449
|
+
include_usage?: boolean | undefined;
|
|
1450
|
+
};
|
|
1451
|
+
/** @internal */
|
|
1452
|
+
export declare const GetPromptVersionStreamOptions$outboundSchema: z.ZodType<GetPromptVersionStreamOptions$Outbound, z.ZodTypeDef, GetPromptVersionStreamOptions>;
|
|
1453
|
+
export declare function getPromptVersionStreamOptionsToJSON(getPromptVersionStreamOptions: GetPromptVersionStreamOptions): string;
|
|
1454
|
+
export declare function getPromptVersionStreamOptionsFromJSON(jsonString: string): SafeParseResult<GetPromptVersionStreamOptions, SDKValidationError>;
|
|
1455
|
+
/** @internal */
|
|
1456
|
+
export declare const GetPromptVersionThinking$inboundSchema: z.ZodType<GetPromptVersionThinking, z.ZodTypeDef, unknown>;
|
|
1457
|
+
/** @internal */
|
|
1458
|
+
export type GetPromptVersionThinking$Outbound = components.ThinkingConfigDisabledSchema$Outbound | components.ThinkingConfigEnabledSchema$Outbound;
|
|
1459
|
+
/** @internal */
|
|
1460
|
+
export declare const GetPromptVersionThinking$outboundSchema: z.ZodType<GetPromptVersionThinking$Outbound, z.ZodTypeDef, GetPromptVersionThinking>;
|
|
1461
|
+
export declare function getPromptVersionThinkingToJSON(getPromptVersionThinking: GetPromptVersionThinking): string;
|
|
1462
|
+
export declare function getPromptVersionThinkingFromJSON(jsonString: string): SafeParseResult<GetPromptVersionThinking, SDKValidationError>;
|
|
1463
|
+
/** @internal */
|
|
1464
|
+
export declare const GetPromptVersionToolChoiceType$inboundSchema: z.ZodNativeEnum<typeof GetPromptVersionToolChoiceType>;
|
|
1465
|
+
/** @internal */
|
|
1466
|
+
export declare const GetPromptVersionToolChoiceType$outboundSchema: z.ZodNativeEnum<typeof GetPromptVersionToolChoiceType>;
|
|
1467
|
+
/** @internal */
|
|
1468
|
+
export declare const GetPromptVersionToolChoiceFunction$inboundSchema: z.ZodType<GetPromptVersionToolChoiceFunction, z.ZodTypeDef, unknown>;
|
|
1469
|
+
/** @internal */
|
|
1470
|
+
export type GetPromptVersionToolChoiceFunction$Outbound = {
|
|
1471
|
+
name: string;
|
|
1472
|
+
};
|
|
1473
|
+
/** @internal */
|
|
1474
|
+
export declare const GetPromptVersionToolChoiceFunction$outboundSchema: z.ZodType<GetPromptVersionToolChoiceFunction$Outbound, z.ZodTypeDef, GetPromptVersionToolChoiceFunction>;
|
|
1475
|
+
export declare function getPromptVersionToolChoiceFunctionToJSON(getPromptVersionToolChoiceFunction: GetPromptVersionToolChoiceFunction): string;
|
|
1476
|
+
export declare function getPromptVersionToolChoiceFunctionFromJSON(jsonString: string): SafeParseResult<GetPromptVersionToolChoiceFunction, SDKValidationError>;
|
|
1477
|
+
/** @internal */
|
|
1478
|
+
export declare const GetPromptVersionToolChoice2$inboundSchema: z.ZodType<GetPromptVersionToolChoice2, z.ZodTypeDef, unknown>;
|
|
1479
|
+
/** @internal */
|
|
1480
|
+
export type GetPromptVersionToolChoice2$Outbound = {
|
|
1481
|
+
type?: string | undefined;
|
|
1482
|
+
function: GetPromptVersionToolChoiceFunction$Outbound;
|
|
1483
|
+
};
|
|
1484
|
+
/** @internal */
|
|
1485
|
+
export declare const GetPromptVersionToolChoice2$outboundSchema: z.ZodType<GetPromptVersionToolChoice2$Outbound, z.ZodTypeDef, GetPromptVersionToolChoice2>;
|
|
1486
|
+
export declare function getPromptVersionToolChoice2ToJSON(getPromptVersionToolChoice2: GetPromptVersionToolChoice2): string;
|
|
1487
|
+
export declare function getPromptVersionToolChoice2FromJSON(jsonString: string): SafeParseResult<GetPromptVersionToolChoice2, SDKValidationError>;
|
|
1488
|
+
/** @internal */
|
|
1489
|
+
export declare const GetPromptVersionToolChoice1$inboundSchema: z.ZodNativeEnum<typeof GetPromptVersionToolChoice1>;
|
|
1490
|
+
/** @internal */
|
|
1491
|
+
export declare const GetPromptVersionToolChoice1$outboundSchema: z.ZodNativeEnum<typeof GetPromptVersionToolChoice1>;
|
|
1492
|
+
/** @internal */
|
|
1493
|
+
export declare const GetPromptVersionToolChoice$inboundSchema: z.ZodType<GetPromptVersionToolChoice, z.ZodTypeDef, unknown>;
|
|
1494
|
+
/** @internal */
|
|
1495
|
+
export type GetPromptVersionToolChoice$Outbound = GetPromptVersionToolChoice2$Outbound | string;
|
|
1496
|
+
/** @internal */
|
|
1497
|
+
export declare const GetPromptVersionToolChoice$outboundSchema: z.ZodType<GetPromptVersionToolChoice$Outbound, z.ZodTypeDef, GetPromptVersionToolChoice>;
|
|
1498
|
+
export declare function getPromptVersionToolChoiceToJSON(getPromptVersionToolChoice: GetPromptVersionToolChoice): string;
|
|
1499
|
+
export declare function getPromptVersionToolChoiceFromJSON(jsonString: string): SafeParseResult<GetPromptVersionToolChoice, SDKValidationError>;
|
|
1500
|
+
/** @internal */
|
|
1501
|
+
export declare const GetPromptVersionModalities$inboundSchema: z.ZodNativeEnum<typeof GetPromptVersionModalities>;
|
|
1502
|
+
/** @internal */
|
|
1503
|
+
export declare const GetPromptVersionModalities$outboundSchema: z.ZodNativeEnum<typeof GetPromptVersionModalities>;
|
|
1504
|
+
/** @internal */
|
|
1505
|
+
export declare const GetPromptVersionId1$inboundSchema: z.ZodNativeEnum<typeof GetPromptVersionId1>;
|
|
1506
|
+
/** @internal */
|
|
1507
|
+
export declare const GetPromptVersionId1$outboundSchema: z.ZodNativeEnum<typeof GetPromptVersionId1>;
|
|
1508
|
+
/** @internal */
|
|
1509
|
+
export declare const GetPromptVersionId$inboundSchema: z.ZodType<GetPromptVersionId, z.ZodTypeDef, unknown>;
|
|
1510
|
+
/** @internal */
|
|
1511
|
+
export type GetPromptVersionId$Outbound = string | string;
|
|
1512
|
+
/** @internal */
|
|
1513
|
+
export declare const GetPromptVersionId$outboundSchema: z.ZodType<GetPromptVersionId$Outbound, z.ZodTypeDef, GetPromptVersionId>;
|
|
1514
|
+
export declare function getPromptVersionIdToJSON(getPromptVersionId: GetPromptVersionId): string;
|
|
1515
|
+
export declare function getPromptVersionIdFromJSON(jsonString: string): SafeParseResult<GetPromptVersionId, SDKValidationError>;
|
|
1516
|
+
/** @internal */
|
|
1517
|
+
export declare const GetPromptVersionExecuteOn$inboundSchema: z.ZodNativeEnum<typeof GetPromptVersionExecuteOn>;
|
|
1518
|
+
/** @internal */
|
|
1519
|
+
export declare const GetPromptVersionExecuteOn$outboundSchema: z.ZodNativeEnum<typeof GetPromptVersionExecuteOn>;
|
|
1520
|
+
/** @internal */
|
|
1521
|
+
export declare const GetPromptVersionGuardrails$inboundSchema: z.ZodType<GetPromptVersionGuardrails, z.ZodTypeDef, unknown>;
|
|
1522
|
+
/** @internal */
|
|
1523
|
+
export type GetPromptVersionGuardrails$Outbound = {
|
|
1524
|
+
id: string | string;
|
|
1525
|
+
execute_on: string;
|
|
1526
|
+
};
|
|
1527
|
+
/** @internal */
|
|
1528
|
+
export declare const GetPromptVersionGuardrails$outboundSchema: z.ZodType<GetPromptVersionGuardrails$Outbound, z.ZodTypeDef, GetPromptVersionGuardrails>;
|
|
1529
|
+
export declare function getPromptVersionGuardrailsToJSON(getPromptVersionGuardrails: GetPromptVersionGuardrails): string;
|
|
1530
|
+
export declare function getPromptVersionGuardrailsFromJSON(jsonString: string): SafeParseResult<GetPromptVersionGuardrails, SDKValidationError>;
|
|
1531
|
+
/** @internal */
|
|
1532
|
+
export declare const GetPromptVersionContentPromptsResponse2002$inboundSchema: z.ZodType<GetPromptVersionContentPromptsResponse2002, z.ZodTypeDef, unknown>;
|
|
1533
|
+
/** @internal */
|
|
1534
|
+
export type GetPromptVersionContentPromptsResponse2002$Outbound = components.TextContentPartSchema$Outbound;
|
|
1535
|
+
/** @internal */
|
|
1536
|
+
export declare const GetPromptVersionContentPromptsResponse2002$outboundSchema: z.ZodType<GetPromptVersionContentPromptsResponse2002$Outbound, z.ZodTypeDef, GetPromptVersionContentPromptsResponse2002>;
|
|
1537
|
+
export declare function getPromptVersionContentPromptsResponse2002ToJSON(getPromptVersionContentPromptsResponse2002: GetPromptVersionContentPromptsResponse2002): string;
|
|
1538
|
+
export declare function getPromptVersionContentPromptsResponse2002FromJSON(jsonString: string): SafeParseResult<GetPromptVersionContentPromptsResponse2002, SDKValidationError>;
|
|
1539
|
+
/** @internal */
|
|
1540
|
+
export declare const GetPromptVersionMessagesPromptsResponse200Content$inboundSchema: z.ZodType<GetPromptVersionMessagesPromptsResponse200Content, z.ZodTypeDef, unknown>;
|
|
1541
|
+
/** @internal */
|
|
1542
|
+
export type GetPromptVersionMessagesPromptsResponse200Content$Outbound = string | Array<components.TextContentPartSchema$Outbound>;
|
|
1543
|
+
/** @internal */
|
|
1544
|
+
export declare const GetPromptVersionMessagesPromptsResponse200Content$outboundSchema: z.ZodType<GetPromptVersionMessagesPromptsResponse200Content$Outbound, z.ZodTypeDef, GetPromptVersionMessagesPromptsResponse200Content>;
|
|
1545
|
+
export declare function getPromptVersionMessagesPromptsResponse200ContentToJSON(getPromptVersionMessagesPromptsResponse200Content: GetPromptVersionMessagesPromptsResponse200Content): string;
|
|
1546
|
+
export declare function getPromptVersionMessagesPromptsResponse200ContentFromJSON(jsonString: string): SafeParseResult<GetPromptVersionMessagesPromptsResponse200Content, SDKValidationError>;
|
|
1547
|
+
/** @internal */
|
|
1548
|
+
export declare const GetPromptVersionMessagesPromptsType$inboundSchema: z.ZodNativeEnum<typeof GetPromptVersionMessagesPromptsType>;
|
|
1549
|
+
/** @internal */
|
|
1550
|
+
export declare const GetPromptVersionMessagesPromptsType$outboundSchema: z.ZodNativeEnum<typeof GetPromptVersionMessagesPromptsType>;
|
|
1551
|
+
/** @internal */
|
|
1552
|
+
export declare const GetPromptVersionMessagesTtl$inboundSchema: z.ZodNativeEnum<typeof GetPromptVersionMessagesTtl>;
|
|
1553
|
+
/** @internal */
|
|
1554
|
+
export declare const GetPromptVersionMessagesTtl$outboundSchema: z.ZodNativeEnum<typeof GetPromptVersionMessagesTtl>;
|
|
1555
|
+
/** @internal */
|
|
1556
|
+
export declare const GetPromptVersionMessagesCacheControl$inboundSchema: z.ZodType<GetPromptVersionMessagesCacheControl, z.ZodTypeDef, unknown>;
|
|
1557
|
+
/** @internal */
|
|
1558
|
+
export type GetPromptVersionMessagesCacheControl$Outbound = {
|
|
1559
|
+
type: string;
|
|
1560
|
+
ttl: string;
|
|
1561
|
+
};
|
|
1562
|
+
/** @internal */
|
|
1563
|
+
export declare const GetPromptVersionMessagesCacheControl$outboundSchema: z.ZodType<GetPromptVersionMessagesCacheControl$Outbound, z.ZodTypeDef, GetPromptVersionMessagesCacheControl>;
|
|
1564
|
+
export declare function getPromptVersionMessagesCacheControlToJSON(getPromptVersionMessagesCacheControl: GetPromptVersionMessagesCacheControl): string;
|
|
1565
|
+
export declare function getPromptVersionMessagesCacheControlFromJSON(jsonString: string): SafeParseResult<GetPromptVersionMessagesCacheControl, SDKValidationError>;
|
|
1566
|
+
/** @internal */
|
|
1567
|
+
export declare const GetPromptVersionMessagesToolMessage$inboundSchema: z.ZodType<GetPromptVersionMessagesToolMessage, z.ZodTypeDef, unknown>;
|
|
1568
|
+
/** @internal */
|
|
1569
|
+
export type GetPromptVersionMessagesToolMessage$Outbound = {
|
|
1570
|
+
role: "tool";
|
|
1571
|
+
content: string | Array<components.TextContentPartSchema$Outbound>;
|
|
1572
|
+
tool_call_id: string | null;
|
|
1573
|
+
cache_control?: GetPromptVersionMessagesCacheControl$Outbound | undefined;
|
|
1574
|
+
};
|
|
1575
|
+
/** @internal */
|
|
1576
|
+
export declare const GetPromptVersionMessagesToolMessage$outboundSchema: z.ZodType<GetPromptVersionMessagesToolMessage$Outbound, z.ZodTypeDef, GetPromptVersionMessagesToolMessage>;
|
|
1577
|
+
export declare function getPromptVersionMessagesToolMessageToJSON(getPromptVersionMessagesToolMessage: GetPromptVersionMessagesToolMessage): string;
|
|
1578
|
+
export declare function getPromptVersionMessagesToolMessageFromJSON(jsonString: string): SafeParseResult<GetPromptVersionMessagesToolMessage, SDKValidationError>;
|
|
1579
|
+
/** @internal */
|
|
1580
|
+
export declare const GetPromptVersionContentPromptsResponse2$inboundSchema: z.ZodType<GetPromptVersionContentPromptsResponse2, z.ZodTypeDef, unknown>;
|
|
1581
|
+
/** @internal */
|
|
1582
|
+
export type GetPromptVersionContentPromptsResponse2$Outbound = (components.TextContentPartSchema$Outbound & {
|
|
1583
|
+
type: "text";
|
|
1584
|
+
}) | components.RefusalPartSchema$Outbound | components.ReasoningPartSchema$Outbound | components.RedactedReasoningPartSchema$Outbound;
|
|
1585
|
+
/** @internal */
|
|
1586
|
+
export declare const GetPromptVersionContentPromptsResponse2$outboundSchema: z.ZodType<GetPromptVersionContentPromptsResponse2$Outbound, z.ZodTypeDef, GetPromptVersionContentPromptsResponse2>;
|
|
1587
|
+
export declare function getPromptVersionContentPromptsResponse2ToJSON(getPromptVersionContentPromptsResponse2: GetPromptVersionContentPromptsResponse2): string;
|
|
1588
|
+
export declare function getPromptVersionContentPromptsResponse2FromJSON(jsonString: string): SafeParseResult<GetPromptVersionContentPromptsResponse2, SDKValidationError>;
|
|
1589
|
+
/** @internal */
|
|
1590
|
+
export declare const GetPromptVersionMessagesPromptsResponseContent$inboundSchema: z.ZodType<GetPromptVersionMessagesPromptsResponseContent, z.ZodTypeDef, unknown>;
|
|
1591
|
+
/** @internal */
|
|
1592
|
+
export type GetPromptVersionMessagesPromptsResponseContent$Outbound = string | Array<(components.TextContentPartSchema$Outbound & {
|
|
1593
|
+
type: "text";
|
|
1594
|
+
}) | components.RefusalPartSchema$Outbound | components.ReasoningPartSchema$Outbound | components.RedactedReasoningPartSchema$Outbound>;
|
|
1595
|
+
/** @internal */
|
|
1596
|
+
export declare const GetPromptVersionMessagesPromptsResponseContent$outboundSchema: z.ZodType<GetPromptVersionMessagesPromptsResponseContent$Outbound, z.ZodTypeDef, GetPromptVersionMessagesPromptsResponseContent>;
|
|
1597
|
+
export declare function getPromptVersionMessagesPromptsResponseContentToJSON(getPromptVersionMessagesPromptsResponseContent: GetPromptVersionMessagesPromptsResponseContent): string;
|
|
1598
|
+
export declare function getPromptVersionMessagesPromptsResponseContentFromJSON(jsonString: string): SafeParseResult<GetPromptVersionMessagesPromptsResponseContent, SDKValidationError>;
|
|
1599
|
+
/** @internal */
|
|
1600
|
+
export declare const GetPromptVersionMessagesAudio$inboundSchema: z.ZodType<GetPromptVersionMessagesAudio, z.ZodTypeDef, unknown>;
|
|
1601
|
+
/** @internal */
|
|
1602
|
+
export type GetPromptVersionMessagesAudio$Outbound = {
|
|
1603
|
+
id: string;
|
|
1604
|
+
};
|
|
1605
|
+
/** @internal */
|
|
1606
|
+
export declare const GetPromptVersionMessagesAudio$outboundSchema: z.ZodType<GetPromptVersionMessagesAudio$Outbound, z.ZodTypeDef, GetPromptVersionMessagesAudio>;
|
|
1607
|
+
export declare function getPromptVersionMessagesAudioToJSON(getPromptVersionMessagesAudio: GetPromptVersionMessagesAudio): string;
|
|
1608
|
+
export declare function getPromptVersionMessagesAudioFromJSON(jsonString: string): SafeParseResult<GetPromptVersionMessagesAudio, SDKValidationError>;
|
|
1609
|
+
/** @internal */
|
|
1610
|
+
export declare const GetPromptVersionMessagesType$inboundSchema: z.ZodNativeEnum<typeof GetPromptVersionMessagesType>;
|
|
1611
|
+
/** @internal */
|
|
1612
|
+
export declare const GetPromptVersionMessagesType$outboundSchema: z.ZodNativeEnum<typeof GetPromptVersionMessagesType>;
|
|
1613
|
+
/** @internal */
|
|
1614
|
+
export declare const GetPromptVersionMessagesFunction$inboundSchema: z.ZodType<GetPromptVersionMessagesFunction, z.ZodTypeDef, unknown>;
|
|
1615
|
+
/** @internal */
|
|
1616
|
+
export type GetPromptVersionMessagesFunction$Outbound = {
|
|
1617
|
+
name?: string | undefined;
|
|
1618
|
+
arguments?: string | undefined;
|
|
1619
|
+
};
|
|
1620
|
+
/** @internal */
|
|
1621
|
+
export declare const GetPromptVersionMessagesFunction$outboundSchema: z.ZodType<GetPromptVersionMessagesFunction$Outbound, z.ZodTypeDef, GetPromptVersionMessagesFunction>;
|
|
1622
|
+
export declare function getPromptVersionMessagesFunctionToJSON(getPromptVersionMessagesFunction: GetPromptVersionMessagesFunction): string;
|
|
1623
|
+
export declare function getPromptVersionMessagesFunctionFromJSON(jsonString: string): SafeParseResult<GetPromptVersionMessagesFunction, SDKValidationError>;
|
|
1624
|
+
/** @internal */
|
|
1625
|
+
export declare const GetPromptVersionMessagesToolCalls$inboundSchema: z.ZodType<GetPromptVersionMessagesToolCalls, z.ZodTypeDef, unknown>;
|
|
1626
|
+
/** @internal */
|
|
1627
|
+
export type GetPromptVersionMessagesToolCalls$Outbound = {
|
|
1628
|
+
id: string;
|
|
1629
|
+
type: string;
|
|
1630
|
+
function: GetPromptVersionMessagesFunction$Outbound;
|
|
1631
|
+
thought_signature?: string | undefined;
|
|
1632
|
+
};
|
|
1633
|
+
/** @internal */
|
|
1634
|
+
export declare const GetPromptVersionMessagesToolCalls$outboundSchema: z.ZodType<GetPromptVersionMessagesToolCalls$Outbound, z.ZodTypeDef, GetPromptVersionMessagesToolCalls>;
|
|
1635
|
+
export declare function getPromptVersionMessagesToolCallsToJSON(getPromptVersionMessagesToolCalls: GetPromptVersionMessagesToolCalls): string;
|
|
1636
|
+
export declare function getPromptVersionMessagesToolCallsFromJSON(jsonString: string): SafeParseResult<GetPromptVersionMessagesToolCalls, SDKValidationError>;
|
|
1637
|
+
/** @internal */
|
|
1638
|
+
export declare const GetPromptVersionMessagesAssistantMessage$inboundSchema: z.ZodType<GetPromptVersionMessagesAssistantMessage, z.ZodTypeDef, unknown>;
|
|
1639
|
+
/** @internal */
|
|
1640
|
+
export type GetPromptVersionMessagesAssistantMessage$Outbound = {
|
|
1641
|
+
content?: string | Array<(components.TextContentPartSchema$Outbound & {
|
|
1642
|
+
type: "text";
|
|
1643
|
+
}) | components.RefusalPartSchema$Outbound | components.ReasoningPartSchema$Outbound | components.RedactedReasoningPartSchema$Outbound> | null | undefined;
|
|
1644
|
+
refusal?: string | null | undefined;
|
|
1645
|
+
role: "assistant";
|
|
1646
|
+
name?: string | undefined;
|
|
1647
|
+
audio?: GetPromptVersionMessagesAudio$Outbound | null | undefined;
|
|
1648
|
+
tool_calls?: Array<GetPromptVersionMessagesToolCalls$Outbound> | undefined;
|
|
1649
|
+
};
|
|
1650
|
+
/** @internal */
|
|
1651
|
+
export declare const GetPromptVersionMessagesAssistantMessage$outboundSchema: z.ZodType<GetPromptVersionMessagesAssistantMessage$Outbound, z.ZodTypeDef, GetPromptVersionMessagesAssistantMessage>;
|
|
1652
|
+
export declare function getPromptVersionMessagesAssistantMessageToJSON(getPromptVersionMessagesAssistantMessage: GetPromptVersionMessagesAssistantMessage): string;
|
|
1653
|
+
export declare function getPromptVersionMessagesAssistantMessageFromJSON(jsonString: string): SafeParseResult<GetPromptVersionMessagesAssistantMessage, SDKValidationError>;
|
|
1654
|
+
/** @internal */
|
|
1655
|
+
export declare const GetPromptVersion2PromptsResponse200ApplicationJSONType$inboundSchema: z.ZodNativeEnum<typeof GetPromptVersion2PromptsResponse200ApplicationJSONType>;
|
|
1656
|
+
/** @internal */
|
|
1657
|
+
export declare const GetPromptVersion2PromptsResponse200ApplicationJSONType$outboundSchema: z.ZodNativeEnum<typeof GetPromptVersion2PromptsResponse200ApplicationJSONType>;
|
|
1658
|
+
/** @internal */
|
|
1659
|
+
export declare const GetPromptVersion2Ttl$inboundSchema: z.ZodNativeEnum<typeof GetPromptVersion2Ttl>;
|
|
1660
|
+
/** @internal */
|
|
1661
|
+
export declare const GetPromptVersion2Ttl$outboundSchema: z.ZodNativeEnum<typeof GetPromptVersion2Ttl>;
|
|
1662
|
+
/** @internal */
|
|
1663
|
+
export declare const GetPromptVersion2CacheControl$inboundSchema: z.ZodType<GetPromptVersion2CacheControl, z.ZodTypeDef, unknown>;
|
|
1664
|
+
/** @internal */
|
|
1665
|
+
export type GetPromptVersion2CacheControl$Outbound = {
|
|
1666
|
+
type: string;
|
|
1667
|
+
ttl: string;
|
|
1668
|
+
};
|
|
1669
|
+
/** @internal */
|
|
1670
|
+
export declare const GetPromptVersion2CacheControl$outboundSchema: z.ZodType<GetPromptVersion2CacheControl$Outbound, z.ZodTypeDef, GetPromptVersion2CacheControl>;
|
|
1671
|
+
export declare function getPromptVersion2CacheControlToJSON(getPromptVersion2CacheControl: GetPromptVersion2CacheControl): string;
|
|
1672
|
+
export declare function getPromptVersion2CacheControlFromJSON(jsonString: string): SafeParseResult<GetPromptVersion2CacheControl, SDKValidationError>;
|
|
1673
|
+
/** @internal */
|
|
1674
|
+
export declare const GetPromptVersion24$inboundSchema: z.ZodType<GetPromptVersion24, z.ZodTypeDef, unknown>;
|
|
1675
|
+
/** @internal */
|
|
1676
|
+
export type GetPromptVersion24$Outbound = {
|
|
1677
|
+
type: "file";
|
|
1678
|
+
cache_control?: GetPromptVersion2CacheControl$Outbound | undefined;
|
|
1679
|
+
file: components.FileContentPartSchema$Outbound;
|
|
1680
|
+
};
|
|
1681
|
+
/** @internal */
|
|
1682
|
+
export declare const GetPromptVersion24$outboundSchema: z.ZodType<GetPromptVersion24$Outbound, z.ZodTypeDef, GetPromptVersion24>;
|
|
1683
|
+
export declare function getPromptVersion24ToJSON(getPromptVersion24: GetPromptVersion24): string;
|
|
1684
|
+
export declare function getPromptVersion24FromJSON(jsonString: string): SafeParseResult<GetPromptVersion24, SDKValidationError>;
|
|
1685
|
+
/** @internal */
|
|
1686
|
+
export declare const GetPromptVersionContentPrompts2$inboundSchema: z.ZodType<GetPromptVersionContentPrompts2, z.ZodTypeDef, unknown>;
|
|
1687
|
+
/** @internal */
|
|
1688
|
+
export type GetPromptVersionContentPrompts2$Outbound = (components.TextContentPartSchema$Outbound & {
|
|
1689
|
+
type: "text";
|
|
1690
|
+
}) | components.ImageContentPartSchema$Outbound | components.AudioContentPartSchema$Outbound | GetPromptVersion24$Outbound;
|
|
1691
|
+
/** @internal */
|
|
1692
|
+
export declare const GetPromptVersionContentPrompts2$outboundSchema: z.ZodType<GetPromptVersionContentPrompts2$Outbound, z.ZodTypeDef, GetPromptVersionContentPrompts2>;
|
|
1693
|
+
export declare function getPromptVersionContentPrompts2ToJSON(getPromptVersionContentPrompts2: GetPromptVersionContentPrompts2): string;
|
|
1694
|
+
export declare function getPromptVersionContentPrompts2FromJSON(jsonString: string): SafeParseResult<GetPromptVersionContentPrompts2, SDKValidationError>;
|
|
1695
|
+
/** @internal */
|
|
1696
|
+
export declare const GetPromptVersionMessagesPromptsContent$inboundSchema: z.ZodType<GetPromptVersionMessagesPromptsContent, z.ZodTypeDef, unknown>;
|
|
1697
|
+
/** @internal */
|
|
1698
|
+
export type GetPromptVersionMessagesPromptsContent$Outbound = string | Array<(components.TextContentPartSchema$Outbound & {
|
|
1699
|
+
type: "text";
|
|
1700
|
+
}) | components.ImageContentPartSchema$Outbound | components.AudioContentPartSchema$Outbound | GetPromptVersion24$Outbound>;
|
|
1701
|
+
/** @internal */
|
|
1702
|
+
export declare const GetPromptVersionMessagesPromptsContent$outboundSchema: z.ZodType<GetPromptVersionMessagesPromptsContent$Outbound, z.ZodTypeDef, GetPromptVersionMessagesPromptsContent>;
|
|
1703
|
+
export declare function getPromptVersionMessagesPromptsContentToJSON(getPromptVersionMessagesPromptsContent: GetPromptVersionMessagesPromptsContent): string;
|
|
1704
|
+
export declare function getPromptVersionMessagesPromptsContentFromJSON(jsonString: string): SafeParseResult<GetPromptVersionMessagesPromptsContent, SDKValidationError>;
|
|
1705
|
+
/** @internal */
|
|
1706
|
+
export declare const GetPromptVersionMessagesUserMessage$inboundSchema: z.ZodType<GetPromptVersionMessagesUserMessage, z.ZodTypeDef, unknown>;
|
|
1707
|
+
/** @internal */
|
|
1708
|
+
export type GetPromptVersionMessagesUserMessage$Outbound = {
|
|
1709
|
+
role: "user";
|
|
1710
|
+
name?: string | undefined;
|
|
1711
|
+
content: string | Array<(components.TextContentPartSchema$Outbound & {
|
|
1712
|
+
type: "text";
|
|
1713
|
+
}) | components.ImageContentPartSchema$Outbound | components.AudioContentPartSchema$Outbound | GetPromptVersion24$Outbound>;
|
|
1714
|
+
};
|
|
1715
|
+
/** @internal */
|
|
1716
|
+
export declare const GetPromptVersionMessagesUserMessage$outboundSchema: z.ZodType<GetPromptVersionMessagesUserMessage$Outbound, z.ZodTypeDef, GetPromptVersionMessagesUserMessage>;
|
|
1717
|
+
export declare function getPromptVersionMessagesUserMessageToJSON(getPromptVersionMessagesUserMessage: GetPromptVersionMessagesUserMessage): string;
|
|
1718
|
+
export declare function getPromptVersionMessagesUserMessageFromJSON(jsonString: string): SafeParseResult<GetPromptVersionMessagesUserMessage, SDKValidationError>;
|
|
1719
|
+
/** @internal */
|
|
1720
|
+
export declare const GetPromptVersionMessagesContent$inboundSchema: z.ZodType<GetPromptVersionMessagesContent, z.ZodTypeDef, unknown>;
|
|
1721
|
+
/** @internal */
|
|
1722
|
+
export type GetPromptVersionMessagesContent$Outbound = string | Array<components.TextContentPartSchema$Outbound>;
|
|
1723
|
+
/** @internal */
|
|
1724
|
+
export declare const GetPromptVersionMessagesContent$outboundSchema: z.ZodType<GetPromptVersionMessagesContent$Outbound, z.ZodTypeDef, GetPromptVersionMessagesContent>;
|
|
1725
|
+
export declare function getPromptVersionMessagesContentToJSON(getPromptVersionMessagesContent: GetPromptVersionMessagesContent): string;
|
|
1726
|
+
export declare function getPromptVersionMessagesContentFromJSON(jsonString: string): SafeParseResult<GetPromptVersionMessagesContent, SDKValidationError>;
|
|
1727
|
+
/** @internal */
|
|
1728
|
+
export declare const GetPromptVersionMessagesSystemMessage$inboundSchema: z.ZodType<GetPromptVersionMessagesSystemMessage, z.ZodTypeDef, unknown>;
|
|
1729
|
+
/** @internal */
|
|
1730
|
+
export type GetPromptVersionMessagesSystemMessage$Outbound = {
|
|
1731
|
+
role: "system";
|
|
1732
|
+
content: string | Array<components.TextContentPartSchema$Outbound>;
|
|
1733
|
+
name?: string | undefined;
|
|
1734
|
+
};
|
|
1735
|
+
/** @internal */
|
|
1736
|
+
export declare const GetPromptVersionMessagesSystemMessage$outboundSchema: z.ZodType<GetPromptVersionMessagesSystemMessage$Outbound, z.ZodTypeDef, GetPromptVersionMessagesSystemMessage>;
|
|
1737
|
+
export declare function getPromptVersionMessagesSystemMessageToJSON(getPromptVersionMessagesSystemMessage: GetPromptVersionMessagesSystemMessage): string;
|
|
1738
|
+
export declare function getPromptVersionMessagesSystemMessageFromJSON(jsonString: string): SafeParseResult<GetPromptVersionMessagesSystemMessage, SDKValidationError>;
|
|
1739
|
+
/** @internal */
|
|
1740
|
+
export declare const GetPromptVersionPromptsMessages$inboundSchema: z.ZodType<GetPromptVersionPromptsMessages, z.ZodTypeDef, unknown>;
|
|
1741
|
+
/** @internal */
|
|
1742
|
+
export type GetPromptVersionPromptsMessages$Outbound = GetPromptVersionMessagesSystemMessage$Outbound | GetPromptVersionMessagesUserMessage$Outbound | GetPromptVersionMessagesAssistantMessage$Outbound | GetPromptVersionMessagesToolMessage$Outbound;
|
|
1743
|
+
/** @internal */
|
|
1744
|
+
export declare const GetPromptVersionPromptsMessages$outboundSchema: z.ZodType<GetPromptVersionPromptsMessages$Outbound, z.ZodTypeDef, GetPromptVersionPromptsMessages>;
|
|
1745
|
+
export declare function getPromptVersionPromptsMessagesToJSON(getPromptVersionPromptsMessages: GetPromptVersionPromptsMessages): string;
|
|
1746
|
+
export declare function getPromptVersionPromptsMessagesFromJSON(jsonString: string): SafeParseResult<GetPromptVersionPromptsMessages, SDKValidationError>;
|
|
1747
|
+
/** @internal */
|
|
1748
|
+
export declare const GetPromptVersionPromptField$inboundSchema: z.ZodType<GetPromptVersionPromptField, z.ZodTypeDef, unknown>;
|
|
1749
|
+
/** @internal */
|
|
1750
|
+
export type GetPromptVersionPromptField$Outbound = {
|
|
1751
|
+
audio?: GetPromptVersionAudio$Outbound | null | undefined;
|
|
1752
|
+
frequency_penalty?: number | null | undefined;
|
|
1753
|
+
max_tokens?: number | null | undefined;
|
|
1754
|
+
max_completion_tokens?: number | null | undefined;
|
|
1755
|
+
logprobs?: boolean | null | undefined;
|
|
1756
|
+
top_logprobs?: number | null | undefined;
|
|
1757
|
+
n?: number | null | undefined;
|
|
1758
|
+
presence_penalty?: number | null | undefined;
|
|
1759
|
+
response_format?: GetPromptVersionResponseFormatText$Outbound | GetPromptVersionResponseFormatJSONObject$Outbound | GetPromptVersionResponseFormatPromptsJSONSchema$Outbound | undefined;
|
|
1760
|
+
reasoning_effort?: string | undefined;
|
|
1761
|
+
verbosity?: string | undefined;
|
|
1762
|
+
seed?: number | null | undefined;
|
|
1763
|
+
stop?: string | Array<string> | null | undefined;
|
|
1764
|
+
stream_options?: GetPromptVersionStreamOptions$Outbound | null | undefined;
|
|
1765
|
+
thinking?: components.ThinkingConfigDisabledSchema$Outbound | components.ThinkingConfigEnabledSchema$Outbound | undefined;
|
|
1766
|
+
temperature?: number | null | undefined;
|
|
1767
|
+
top_p?: number | null | undefined;
|
|
1768
|
+
top_k?: number | null | undefined;
|
|
1769
|
+
tool_choice?: GetPromptVersionToolChoice2$Outbound | string | undefined;
|
|
1770
|
+
parallel_tool_calls?: boolean | undefined;
|
|
1771
|
+
modalities?: Array<string> | null | undefined;
|
|
1772
|
+
guardrails?: Array<GetPromptVersionGuardrails$Outbound> | undefined;
|
|
1773
|
+
messages?: Array<GetPromptVersionMessagesSystemMessage$Outbound | GetPromptVersionMessagesUserMessage$Outbound | GetPromptVersionMessagesAssistantMessage$Outbound | GetPromptVersionMessagesToolMessage$Outbound> | undefined;
|
|
1774
|
+
model?: string | null | undefined;
|
|
1775
|
+
version?: string | undefined;
|
|
1776
|
+
};
|
|
1777
|
+
/** @internal */
|
|
1778
|
+
export declare const GetPromptVersionPromptField$outboundSchema: z.ZodType<GetPromptVersionPromptField$Outbound, z.ZodTypeDef, GetPromptVersionPromptField>;
|
|
1779
|
+
export declare function getPromptVersionPromptFieldToJSON(getPromptVersionPromptField: GetPromptVersionPromptField): string;
|
|
1780
|
+
export declare function getPromptVersionPromptFieldFromJSON(jsonString: string): SafeParseResult<GetPromptVersionPromptField, SDKValidationError>;
|
|
1781
|
+
/** @internal */
|
|
774
1782
|
export declare const GetPromptVersionUseCases$inboundSchema: z.ZodNativeEnum<typeof GetPromptVersionUseCases>;
|
|
775
1783
|
/** @internal */
|
|
776
1784
|
export declare const GetPromptVersionUseCases$outboundSchema: z.ZodNativeEnum<typeof GetPromptVersionUseCases>;
|
|
@@ -797,7 +1805,8 @@ export type GetPromptVersionResponseBody$Outbound = {
|
|
|
797
1805
|
created_by_id?: string | null | undefined;
|
|
798
1806
|
updated_by_id?: string | null | undefined;
|
|
799
1807
|
description?: string | null | undefined;
|
|
800
|
-
prompt_config
|
|
1808
|
+
prompt_config?: GetPromptVersionPromptConfig$Outbound | undefined;
|
|
1809
|
+
prompt: GetPromptVersionPromptField$Outbound;
|
|
801
1810
|
metadata?: GetPromptVersionMetadata$Outbound | undefined;
|
|
802
1811
|
timestamp: string;
|
|
803
1812
|
};
|