llama-stack-client 0.6.1 → 0.7.1
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/.github/workflows/ci.yml +16 -10
- package/.gitignore +1 -0
- package/.release-please-manifest.json +1 -1
- package/.stats.yml +4 -4
- package/CHANGELOG.md +80 -0
- package/CONTRIBUTING.md +2 -2
- package/README.md +22 -0
- package/api.md +1 -71
- package/dist/CHANGELOG.md +80 -0
- package/dist/README.md +22 -0
- package/dist/core.d.ts +1 -1
- package/dist/core.d.ts.map +1 -1
- package/dist/core.js +8 -17
- package/dist/core.js.map +1 -1
- package/dist/core.mjs +8 -17
- package/dist/core.mjs.map +1 -1
- package/dist/index.d.mts +51 -12
- package/dist/index.d.ts +51 -12
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +50 -11
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +50 -11
- package/dist/index.mjs.map +1 -1
- package/dist/internal/utils/query.d.ts +2 -0
- package/dist/internal/utils/query.d.ts.map +1 -0
- package/dist/{resources/alpha/post-training/post-training.js → internal/utils/query.js} +6 -24
- package/dist/internal/utils/query.js.map +1 -0
- package/dist/{resources/alpha/post-training.mjs → internal/utils/query.mjs} +5 -2
- package/dist/internal/utils/query.mjs.map +1 -0
- package/dist/package.json +1 -1
- package/dist/resources/alpha/alpha.d.ts +0 -4
- package/dist/resources/alpha/alpha.d.ts.map +1 -1
- package/dist/resources/alpha/alpha.js +0 -4
- package/dist/resources/alpha/alpha.js.map +1 -1
- package/dist/resources/alpha/alpha.mjs +0 -4
- package/dist/resources/alpha/alpha.mjs.map +1 -1
- package/dist/resources/alpha/eval/eval.d.ts +3 -0
- package/dist/resources/alpha/eval/eval.d.ts.map +1 -1
- package/dist/resources/alpha/eval/eval.js +3 -0
- package/dist/resources/alpha/eval/eval.js.map +1 -1
- package/dist/resources/alpha/eval/eval.mjs +3 -0
- package/dist/resources/alpha/eval/eval.mjs.map +1 -1
- package/dist/resources/alpha/eval/jobs.d.ts +3 -0
- package/dist/resources/alpha/eval/jobs.d.ts.map +1 -1
- package/dist/resources/alpha/eval/jobs.js +3 -0
- package/dist/resources/alpha/eval/jobs.js.map +1 -1
- package/dist/resources/alpha/eval/jobs.mjs +3 -0
- package/dist/resources/alpha/eval/jobs.mjs.map +1 -1
- package/dist/resources/alpha/index.d.ts +0 -1
- package/dist/resources/alpha/index.d.ts.map +1 -1
- package/dist/resources/alpha/index.js +1 -3
- package/dist/resources/alpha/index.js.map +1 -1
- package/dist/resources/alpha/index.mjs +0 -1
- package/dist/resources/alpha/index.mjs.map +1 -1
- package/dist/resources/alpha/inference.d.ts +8 -0
- package/dist/resources/alpha/inference.d.ts.map +1 -1
- package/dist/resources/alpha/inference.js +8 -0
- package/dist/resources/alpha/inference.js.map +1 -1
- package/dist/resources/alpha/inference.mjs +8 -0
- package/dist/resources/alpha/inference.mjs.map +1 -1
- package/dist/resources/batches.d.ts +8 -0
- package/dist/resources/batches.d.ts.map +1 -1
- package/dist/resources/batches.js +8 -0
- package/dist/resources/batches.js.map +1 -1
- package/dist/resources/batches.mjs +8 -0
- package/dist/resources/batches.mjs.map +1 -1
- package/dist/resources/beta/datasets.d.ts +4 -8
- package/dist/resources/beta/datasets.d.ts.map +1 -1
- package/dist/resources/chat/chat.d.ts +34 -32
- package/dist/resources/chat/chat.d.ts.map +1 -1
- package/dist/resources/chat/chat.js.map +1 -1
- package/dist/resources/chat/chat.mjs.map +1 -1
- package/dist/resources/chat/completions.d.ts +321 -713
- package/dist/resources/chat/completions.d.ts.map +1 -1
- package/dist/resources/chat/completions.js +8 -0
- package/dist/resources/chat/completions.js.map +1 -1
- package/dist/resources/chat/completions.mjs +8 -0
- package/dist/resources/chat/completions.mjs.map +1 -1
- package/dist/resources/completions.d.ts +10 -4
- package/dist/resources/completions.d.ts.map +1 -1
- package/dist/resources/completions.js +8 -0
- package/dist/resources/completions.js.map +1 -1
- package/dist/resources/completions.mjs +8 -0
- package/dist/resources/completions.mjs.map +1 -1
- package/dist/resources/conversations/conversations.d.ts +95 -2
- package/dist/resources/conversations/conversations.d.ts.map +1 -1
- package/dist/resources/conversations/conversations.js +3 -0
- package/dist/resources/conversations/conversations.js.map +1 -1
- package/dist/resources/conversations/conversations.mjs +3 -0
- package/dist/resources/conversations/conversations.mjs.map +1 -1
- package/dist/resources/conversations/items.d.ts +371 -8
- package/dist/resources/conversations/items.d.ts.map +1 -1
- package/dist/resources/conversations/items.js +3 -0
- package/dist/resources/conversations/items.js.map +1 -1
- package/dist/resources/conversations/items.mjs +3 -0
- package/dist/resources/conversations/items.mjs.map +1 -1
- package/dist/resources/embeddings.d.ts +8 -0
- package/dist/resources/embeddings.d.ts.map +1 -1
- package/dist/resources/embeddings.js +8 -0
- package/dist/resources/embeddings.js.map +1 -1
- package/dist/resources/embeddings.mjs +8 -0
- package/dist/resources/embeddings.mjs.map +1 -1
- package/dist/resources/files.d.ts +11 -8
- package/dist/resources/files.d.ts.map +1 -1
- package/dist/resources/files.js +3 -0
- package/dist/resources/files.js.map +1 -1
- package/dist/resources/files.mjs +3 -0
- package/dist/resources/files.mjs.map +1 -1
- package/dist/resources/index.d.ts +1 -4
- package/dist/resources/index.d.ts.map +1 -1
- package/dist/resources/index.js +1 -7
- package/dist/resources/index.js.map +1 -1
- package/dist/resources/index.mjs +0 -3
- package/dist/resources/index.mjs.map +1 -1
- package/dist/resources/inspect.d.ts +3 -0
- package/dist/resources/inspect.d.ts.map +1 -1
- package/dist/resources/inspect.js +3 -0
- package/dist/resources/inspect.js.map +1 -1
- package/dist/resources/inspect.mjs +3 -0
- package/dist/resources/inspect.mjs.map +1 -1
- package/dist/resources/models/index.d.ts +1 -1
- package/dist/resources/models/index.d.ts.map +1 -1
- package/dist/resources/models/index.js.map +1 -1
- package/dist/resources/models/index.mjs.map +1 -1
- package/dist/resources/models/models.d.ts +7 -65
- package/dist/resources/models/models.d.ts.map +1 -1
- package/dist/resources/models/models.js +0 -19
- package/dist/resources/models/models.js.map +1 -1
- package/dist/resources/models/models.mjs +0 -19
- package/dist/resources/models/models.mjs.map +1 -1
- package/dist/resources/moderations.d.ts +3 -0
- package/dist/resources/moderations.d.ts.map +1 -1
- package/dist/resources/moderations.js +3 -0
- package/dist/resources/moderations.js.map +1 -1
- package/dist/resources/moderations.mjs +3 -0
- package/dist/resources/moderations.mjs.map +1 -1
- package/dist/resources/prompts/prompts.d.ts +3 -0
- package/dist/resources/prompts/prompts.d.ts.map +1 -1
- package/dist/resources/prompts/prompts.js +3 -0
- package/dist/resources/prompts/prompts.js.map +1 -1
- package/dist/resources/prompts/prompts.mjs +3 -0
- package/dist/resources/prompts/prompts.mjs.map +1 -1
- package/dist/resources/prompts/versions.d.ts +3 -0
- package/dist/resources/prompts/versions.d.ts.map +1 -1
- package/dist/resources/prompts/versions.js +3 -0
- package/dist/resources/prompts/versions.js.map +1 -1
- package/dist/resources/prompts/versions.mjs +3 -0
- package/dist/resources/prompts/versions.mjs.map +1 -1
- package/dist/resources/providers.d.ts +3 -0
- package/dist/resources/providers.d.ts.map +1 -1
- package/dist/resources/providers.js +3 -0
- package/dist/resources/providers.js.map +1 -1
- package/dist/resources/providers.mjs +3 -0
- package/dist/resources/providers.mjs.map +1 -1
- package/dist/resources/responses/input-items.d.ts +102 -3
- package/dist/resources/responses/input-items.d.ts.map +1 -1
- package/dist/resources/responses/responses.d.ts +582 -11
- package/dist/resources/responses/responses.d.ts.map +1 -1
- package/dist/resources/responses/responses.js.map +1 -1
- package/dist/resources/responses/responses.mjs.map +1 -1
- package/dist/resources/routes.d.ts +3 -0
- package/dist/resources/routes.d.ts.map +1 -1
- package/dist/resources/routes.js +3 -0
- package/dist/resources/routes.js.map +1 -1
- package/dist/resources/routes.mjs +3 -0
- package/dist/resources/routes.mjs.map +1 -1
- package/dist/resources/safety.d.ts +14 -11
- package/dist/resources/safety.d.ts.map +1 -1
- package/dist/resources/safety.js +3 -0
- package/dist/resources/safety.js.map +1 -1
- package/dist/resources/safety.mjs +3 -0
- package/dist/resources/safety.mjs.map +1 -1
- package/dist/resources/vector-io.d.ts +4 -4
- package/dist/resources/vector-stores/file-batches.d.ts +49 -1
- package/dist/resources/vector-stores/file-batches.d.ts.map +1 -1
- package/dist/resources/vector-stores/file-batches.js.map +1 -1
- package/dist/resources/vector-stores/file-batches.mjs.map +1 -1
- package/dist/resources/vector-stores/files.d.ts +100 -4
- package/dist/resources/vector-stores/files.d.ts.map +1 -1
- package/dist/resources/vector-stores/files.js.map +1 -1
- package/dist/resources/vector-stores/files.mjs.map +1 -1
- package/dist/resources/vector-stores/vector-stores.d.ts +51 -3
- package/dist/resources/vector-stores/vector-stores.d.ts.map +1 -1
- package/dist/resources/vector-stores/vector-stores.js.map +1 -1
- package/dist/resources/vector-stores/vector-stores.mjs.map +1 -1
- package/dist/src/core.ts +10 -21
- package/dist/src/index.ts +51 -48
- package/{src/resources/alpha/post-training.ts → dist/src/internal/utils/query.ts} +5 -1
- package/dist/src/resources/alpha/alpha.ts +0 -20
- package/dist/src/resources/alpha/eval/eval.ts +3 -0
- package/dist/src/resources/alpha/eval/jobs.ts +3 -0
- package/dist/src/resources/alpha/index.ts +0 -8
- package/dist/src/resources/alpha/inference.ts +8 -0
- package/dist/src/resources/batches.ts +8 -0
- package/dist/src/resources/beta/datasets.ts +4 -9
- package/dist/src/resources/chat/chat.ts +36 -33
- package/dist/src/resources/chat/completions.ts +307 -811
- package/dist/src/resources/completions.ts +10 -4
- package/dist/src/resources/conversations/conversations.ts +121 -1
- package/dist/src/resources/conversations/items.ts +477 -6
- package/dist/src/resources/embeddings.ts +8 -0
- package/dist/src/resources/files.ts +12 -9
- package/dist/src/resources/index.ts +0 -18
- package/dist/src/resources/inspect.ts +3 -0
- package/dist/src/resources/models/index.ts +0 -2
- package/dist/src/resources/models/models.ts +7 -82
- package/dist/src/resources/moderations.ts +3 -0
- package/dist/src/resources/prompts/prompts.ts +3 -0
- package/dist/src/resources/prompts/versions.ts +3 -0
- package/dist/src/resources/providers.ts +3 -0
- package/dist/src/resources/responses/input-items.ts +128 -2
- package/dist/src/resources/responses/responses.ts +706 -7
- package/dist/src/resources/routes.ts +3 -0
- package/dist/src/resources/safety.ts +15 -12
- package/dist/src/resources/vector-io.ts +4 -4
- package/dist/src/resources/vector-stores/file-batches.ts +57 -0
- package/dist/src/resources/vector-stores/files.ts +117 -3
- package/dist/src/resources/vector-stores/vector-stores.ts +59 -2
- package/dist/src/streaming.ts +24 -6
- package/dist/src/version.ts +1 -1
- package/dist/streaming.d.ts.map +1 -1
- package/dist/streaming.js +21 -6
- package/dist/streaming.js.map +1 -1
- package/dist/streaming.mjs +21 -6
- package/dist/streaming.mjs.map +1 -1
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/dist/version.mjs +1 -1
- package/package.json +1 -1
- package/scripts/mock +21 -10
- package/scripts/test +8 -8
- package/src/core.ts +10 -21
- package/src/index.ts +51 -48
- package/{dist/src/resources/alpha/post-training.ts → src/internal/utils/query.ts} +5 -1
- package/src/resources/alpha/alpha.ts +0 -20
- package/src/resources/alpha/eval/eval.ts +3 -0
- package/src/resources/alpha/eval/jobs.ts +3 -0
- package/src/resources/alpha/index.ts +0 -8
- package/src/resources/alpha/inference.ts +8 -0
- package/src/resources/batches.ts +8 -0
- package/src/resources/beta/datasets.ts +4 -9
- package/src/resources/chat/chat.ts +36 -33
- package/src/resources/chat/completions.ts +307 -811
- package/src/resources/completions.ts +10 -4
- package/src/resources/conversations/conversations.ts +121 -1
- package/src/resources/conversations/items.ts +477 -6
- package/src/resources/embeddings.ts +8 -0
- package/src/resources/files.ts +12 -9
- package/src/resources/index.ts +0 -18
- package/src/resources/inspect.ts +3 -0
- package/src/resources/models/index.ts +0 -2
- package/src/resources/models/models.ts +7 -82
- package/src/resources/moderations.ts +3 -0
- package/src/resources/prompts/prompts.ts +3 -0
- package/src/resources/prompts/versions.ts +3 -0
- package/src/resources/providers.ts +3 -0
- package/src/resources/responses/input-items.ts +128 -2
- package/src/resources/responses/responses.ts +706 -7
- package/src/resources/routes.ts +3 -0
- package/src/resources/safety.ts +15 -12
- package/src/resources/vector-io.ts +4 -4
- package/src/resources/vector-stores/file-batches.ts +57 -0
- package/src/resources/vector-stores/files.ts +117 -3
- package/src/resources/vector-stores/vector-stores.ts +59 -2
- package/src/streaming.ts +24 -6
- package/src/version.ts +1 -1
- package/tests/api-resources/beta/datasets.test.ts +4 -10
- package/tests/api-resources/chat/completions.test.ts +2 -0
- package/tests/api-resources/files.test.ts +2 -2
- package/tests/api-resources/models/models.test.ts +0 -39
- package/tests/api-resources/responses/responses.test.ts +10 -1
- package/tests/api-resources/vector-stores/file-batches.test.ts +1 -1
- package/tests/api-resources/vector-stores/files.test.ts +1 -1
- package/tests/api-resources/vector-stores/vector-stores.test.ts +1 -1
- package/tests/stringifyQuery.test.ts +2 -4
- package/dist/resources/alpha/post-training/index.d.ts +0 -3
- package/dist/resources/alpha/post-training/index.d.ts.map +0 -1
- package/dist/resources/alpha/post-training/index.js +0 -15
- package/dist/resources/alpha/post-training/index.js.map +0 -1
- package/dist/resources/alpha/post-training/index.mjs +0 -10
- package/dist/resources/alpha/post-training/index.mjs.map +0 -1
- package/dist/resources/alpha/post-training/job.d.ts +0 -104
- package/dist/resources/alpha/post-training/job.d.ts.map +0 -1
- package/dist/resources/alpha/post-training/job.js +0 -42
- package/dist/resources/alpha/post-training/job.js.map +0 -1
- package/dist/resources/alpha/post-training/job.mjs +0 -38
- package/dist/resources/alpha/post-training/job.mjs.map +0 -1
- package/dist/resources/alpha/post-training/post-training.d.ts +0 -269
- package/dist/resources/alpha/post-training/post-training.d.ts.map +0 -1
- package/dist/resources/alpha/post-training/post-training.js.map +0 -1
- package/dist/resources/alpha/post-training/post-training.mjs +0 -30
- package/dist/resources/alpha/post-training/post-training.mjs.map +0 -1
- package/dist/resources/alpha/post-training.d.ts +0 -2
- package/dist/resources/alpha/post-training.d.ts.map +0 -1
- package/dist/resources/alpha/post-training.js +0 -25
- package/dist/resources/alpha/post-training.js.map +0 -1
- package/dist/resources/alpha/post-training.mjs.map +0 -1
- package/dist/resources/tool-runtime.d.ts +0 -152
- package/dist/resources/tool-runtime.d.ts.map +0 -1
- package/dist/resources/tool-runtime.js +0 -30
- package/dist/resources/tool-runtime.js.map +0 -1
- package/dist/resources/tool-runtime.mjs +0 -26
- package/dist/resources/tool-runtime.mjs.map +0 -1
- package/dist/resources/toolgroups.d.ts +0 -91
- package/dist/resources/toolgroups.d.ts.map +0 -1
- package/dist/resources/toolgroups.js +0 -54
- package/dist/resources/toolgroups.js.map +0 -1
- package/dist/resources/toolgroups.mjs +0 -50
- package/dist/resources/toolgroups.mjs.map +0 -1
- package/dist/resources/tools.d.ts +0 -26
- package/dist/resources/tools.d.ts.map +0 -1
- package/dist/resources/tools.js +0 -30
- package/dist/resources/tools.js.map +0 -1
- package/dist/resources/tools.mjs +0 -26
- package/dist/resources/tools.mjs.map +0 -1
- package/dist/src/resources/alpha/post-training/index.ts +0 -17
- package/dist/src/resources/alpha/post-training/job.ts +0 -161
- package/dist/src/resources/alpha/post-training/post-training.ts +0 -385
- package/dist/src/resources/tool-runtime.ts +0 -217
- package/dist/src/resources/toolgroups.ts +0 -135
- package/dist/src/resources/tools.ts +0 -52
- package/src/resources/alpha/post-training/index.ts +0 -17
- package/src/resources/alpha/post-training/job.ts +0 -161
- package/src/resources/alpha/post-training/post-training.ts +0 -385
- package/src/resources/tool-runtime.ts +0 -217
- package/src/resources/toolgroups.ts +0 -135
- package/src/resources/tools.ts +0 -52
- package/tests/api-resources/alpha/post-training/job.test.ts +0 -86
- package/tests/api-resources/alpha/post-training/post-training.test.ts +0 -134
- package/tests/api-resources/tool-runtime.test.ts +0 -68
- package/tests/api-resources/toolgroups.test.ts +0 -91
- package/tests/api-resources/tools.test.ts +0 -57
|
@@ -37,14 +37,20 @@ export interface ResponseObject {
|
|
|
37
37
|
id: string;
|
|
38
38
|
created_at: number;
|
|
39
39
|
model: string;
|
|
40
|
-
output: Array<ResponseObject.OpenAIResponseMessageOutput | ResponseObject.OpenAIResponseOutputMessageWebSearchToolCall | ResponseObject.OpenAIResponseOutputMessageFileSearchToolCall | ResponseObject.OpenAIResponseOutputMessageFunctionToolCall | ResponseObject.OpenAIResponseOutputMessageMcpCall | ResponseObject.OpenAIResponseOutputMessageMcpListTools | ResponseObject.OpenAIResponseMcpApprovalRequest>;
|
|
40
|
+
output: Array<ResponseObject.OpenAIResponseMessageOutput | ResponseObject.OpenAIResponseOutputMessageWebSearchToolCall | ResponseObject.OpenAIResponseOutputMessageFileSearchToolCall | ResponseObject.OpenAIResponseOutputMessageFunctionToolCall | ResponseObject.OpenAIResponseOutputMessageMcpCall | ResponseObject.OpenAIResponseOutputMessageMcpListTools | ResponseObject.OpenAIResponseMcpApprovalRequest | ResponseObject.OpenAIResponseOutputMessageReasoningItem>;
|
|
41
41
|
status: string;
|
|
42
42
|
store: boolean;
|
|
43
|
+
background?: boolean;
|
|
43
44
|
completed_at?: number | null;
|
|
44
45
|
/**
|
|
45
46
|
* Error details for failed OpenAI response requests.
|
|
46
47
|
*/
|
|
47
48
|
error?: ResponseObject.Error | null;
|
|
49
|
+
frequency_penalty?: number | null;
|
|
50
|
+
/**
|
|
51
|
+
* Details explaining why a response was incomplete.
|
|
52
|
+
*/
|
|
53
|
+
incomplete_details?: ResponseObject.IncompleteDetails | null;
|
|
48
54
|
instructions?: string | null;
|
|
49
55
|
max_output_tokens?: number | null;
|
|
50
56
|
max_tool_calls?: number | null;
|
|
@@ -53,11 +59,13 @@ export interface ResponseObject {
|
|
|
53
59
|
} | null;
|
|
54
60
|
object?: 'response';
|
|
55
61
|
parallel_tool_calls?: boolean | null;
|
|
62
|
+
presence_penalty?: number | null;
|
|
56
63
|
previous_response_id?: string | null;
|
|
57
64
|
/**
|
|
58
65
|
* OpenAI compatible Prompt object that is used in OpenAI responses.
|
|
59
66
|
*/
|
|
60
67
|
prompt?: ResponseObject.Prompt | null;
|
|
68
|
+
prompt_cache_key?: string | null;
|
|
61
69
|
/**
|
|
62
70
|
* Configuration for reasoning effort in OpenAI responses.
|
|
63
71
|
*
|
|
@@ -65,16 +73,18 @@ export interface ResponseObject {
|
|
|
65
73
|
*/
|
|
66
74
|
reasoning?: ResponseObject.Reasoning | null;
|
|
67
75
|
safety_identifier?: string | null;
|
|
76
|
+
service_tier?: string | null;
|
|
68
77
|
temperature?: number | null;
|
|
69
78
|
/**
|
|
70
79
|
* Text response configuration for OpenAI responses.
|
|
71
80
|
*/
|
|
72
81
|
text?: ResponseObject.Text;
|
|
73
82
|
/**
|
|
74
|
-
*
|
|
83
|
+
* Enumeration of simple tool choice modes for response generation.
|
|
75
84
|
*/
|
|
76
85
|
tool_choice?: 'auto' | 'required' | 'none' | ResponseObject.OpenAIResponseInputToolChoiceAllowedTools | ResponseObject.OpenAIResponseInputToolChoiceFileSearch | ResponseObject.OpenAIResponseInputToolChoiceWebSearch | ResponseObject.OpenAIResponseInputToolChoiceFunctionTool | ResponseObject.OpenAIResponseInputToolChoiceMcpTool | ResponseObject.OpenAIResponseInputToolChoiceCustomTool | null;
|
|
77
86
|
tools?: Array<ResponseObject.OpenAIResponseInputToolWebSearch | ResponseObject.OpenAIResponseInputToolFileSearch | ResponseObject.OpenAIResponseInputToolFunction | ResponseObject.OpenAIResponseToolMcp> | null;
|
|
87
|
+
top_logprobs?: number | null;
|
|
78
88
|
top_p?: number | null;
|
|
79
89
|
truncation?: string | null;
|
|
80
90
|
/**
|
|
@@ -122,6 +132,9 @@ export declare namespace ResponseObject {
|
|
|
122
132
|
filename?: string | null;
|
|
123
133
|
type?: 'input_file';
|
|
124
134
|
}
|
|
135
|
+
/**
|
|
136
|
+
* Text content within an output message of an OpenAI response.
|
|
137
|
+
*/
|
|
125
138
|
interface OpenAIResponseOutputMessageContentOutputTextOutput {
|
|
126
139
|
text: string;
|
|
127
140
|
annotations?: Array<OpenAIResponseOutputMessageContentOutputTextOutput.OpenAIResponseAnnotationFileCitation | OpenAIResponseOutputMessageContentOutputTextOutput.OpenAIResponseAnnotationCitation | OpenAIResponseOutputMessageContentOutputTextOutput.OpenAIResponseAnnotationContainerFileCitation | OpenAIResponseOutputMessageContentOutputTextOutput.OpenAIResponseAnnotationFilePath>;
|
|
@@ -148,6 +161,9 @@ export declare namespace ResponseObject {
|
|
|
148
161
|
url: string;
|
|
149
162
|
type?: 'url_citation';
|
|
150
163
|
}
|
|
164
|
+
/**
|
|
165
|
+
* Container file citation annotation referencing a file within a container.
|
|
166
|
+
*/
|
|
151
167
|
interface OpenAIResponseAnnotationContainerFileCitation {
|
|
152
168
|
container_id: string;
|
|
153
169
|
end_index: number;
|
|
@@ -156,6 +172,9 @@ export declare namespace ResponseObject {
|
|
|
156
172
|
start_index: number;
|
|
157
173
|
type?: 'container_file_citation';
|
|
158
174
|
}
|
|
175
|
+
/**
|
|
176
|
+
* File path annotation referencing a generated file in response content.
|
|
177
|
+
*/
|
|
159
178
|
interface OpenAIResponseAnnotationFilePath {
|
|
160
179
|
file_id: string;
|
|
161
180
|
index: number;
|
|
@@ -298,6 +317,59 @@ export declare namespace ResponseObject {
|
|
|
298
317
|
server_label: string;
|
|
299
318
|
type?: 'mcp_approval_request';
|
|
300
319
|
}
|
|
320
|
+
/**
|
|
321
|
+
* Reasoning output from the model, representing the model's thinking process.
|
|
322
|
+
*/
|
|
323
|
+
interface OpenAIResponseOutputMessageReasoningItem {
|
|
324
|
+
/**
|
|
325
|
+
* Unique identifier for the reasoning output item.
|
|
326
|
+
*/
|
|
327
|
+
id: string;
|
|
328
|
+
/**
|
|
329
|
+
* Summary of the reasoning output.
|
|
330
|
+
*/
|
|
331
|
+
summary: Array<OpenAIResponseOutputMessageReasoningItem.Summary>;
|
|
332
|
+
/**
|
|
333
|
+
* The reasoning content from the model.
|
|
334
|
+
*/
|
|
335
|
+
content?: Array<OpenAIResponseOutputMessageReasoningItem.Content> | null;
|
|
336
|
+
/**
|
|
337
|
+
* The status of the reasoning output.
|
|
338
|
+
*/
|
|
339
|
+
status?: 'in_progress' | 'completed' | 'incomplete' | null;
|
|
340
|
+
/**
|
|
341
|
+
* The type identifier, always 'reasoning'.
|
|
342
|
+
*/
|
|
343
|
+
type?: 'reasoning';
|
|
344
|
+
}
|
|
345
|
+
namespace OpenAIResponseOutputMessageReasoningItem {
|
|
346
|
+
/**
|
|
347
|
+
* A summary of reasoning output from the model.
|
|
348
|
+
*/
|
|
349
|
+
interface Summary {
|
|
350
|
+
/**
|
|
351
|
+
* The summary text of the reasoning output.
|
|
352
|
+
*/
|
|
353
|
+
text: string;
|
|
354
|
+
/**
|
|
355
|
+
* The type identifier, always 'summary_text'.
|
|
356
|
+
*/
|
|
357
|
+
type?: 'summary_text';
|
|
358
|
+
}
|
|
359
|
+
/**
|
|
360
|
+
* Reasoning text from the model.
|
|
361
|
+
*/
|
|
362
|
+
interface Content {
|
|
363
|
+
/**
|
|
364
|
+
* The reasoning text content from the model.
|
|
365
|
+
*/
|
|
366
|
+
text: string;
|
|
367
|
+
/**
|
|
368
|
+
* The type identifier, always 'reasoning_text'.
|
|
369
|
+
*/
|
|
370
|
+
type?: 'reasoning_text';
|
|
371
|
+
}
|
|
372
|
+
}
|
|
301
373
|
/**
|
|
302
374
|
* Error details for failed OpenAI response requests.
|
|
303
375
|
*/
|
|
@@ -305,6 +377,12 @@ export declare namespace ResponseObject {
|
|
|
305
377
|
code: string;
|
|
306
378
|
message: string;
|
|
307
379
|
}
|
|
380
|
+
/**
|
|
381
|
+
* Details explaining why a response was incomplete.
|
|
382
|
+
*/
|
|
383
|
+
interface IncompleteDetails {
|
|
384
|
+
reason: string;
|
|
385
|
+
}
|
|
308
386
|
/**
|
|
309
387
|
* OpenAI compatible Prompt object that is used in OpenAI responses.
|
|
310
388
|
*/
|
|
@@ -350,6 +428,10 @@ export declare namespace ResponseObject {
|
|
|
350
428
|
*/
|
|
351
429
|
interface Reasoning {
|
|
352
430
|
effort?: 'none' | 'minimal' | 'low' | 'medium' | 'high' | 'xhigh' | null;
|
|
431
|
+
/**
|
|
432
|
+
* Summary mode for reasoning output. One of 'auto', 'concise', or 'detailed'.
|
|
433
|
+
*/
|
|
434
|
+
summary?: 'auto' | 'concise' | 'detailed' | null;
|
|
353
435
|
}
|
|
354
436
|
/**
|
|
355
437
|
* Text response configuration for OpenAI responses.
|
|
@@ -575,6 +657,7 @@ export declare namespace ResponseObjectStream {
|
|
|
575
657
|
* Complete OpenAI response object containing generation results and metadata.
|
|
576
658
|
*/
|
|
577
659
|
response: ResponsesAPI.ResponseObject;
|
|
660
|
+
sequence_number: number;
|
|
578
661
|
type?: 'response.created';
|
|
579
662
|
}
|
|
580
663
|
/**
|
|
@@ -597,7 +680,7 @@ export declare namespace ResponseObjectStream {
|
|
|
597
680
|
* under one type because the Responses API gives them all the same "type" value,
|
|
598
681
|
* and there is no way to tell them apart in certain scenarios.
|
|
599
682
|
*/
|
|
600
|
-
item: OpenAIResponseObjectStreamResponseOutputItemAdded.OpenAIResponseMessage | OpenAIResponseObjectStreamResponseOutputItemAdded.OpenAIResponseOutputMessageWebSearchToolCall | OpenAIResponseObjectStreamResponseOutputItemAdded.OpenAIResponseOutputMessageFileSearchToolCall | OpenAIResponseObjectStreamResponseOutputItemAdded.OpenAIResponseOutputMessageFunctionToolCall | OpenAIResponseObjectStreamResponseOutputItemAdded.OpenAIResponseOutputMessageMcpCall | OpenAIResponseObjectStreamResponseOutputItemAdded.OpenAIResponseOutputMessageMcpListTools | OpenAIResponseObjectStreamResponseOutputItemAdded.OpenAIResponseMcpApprovalRequest;
|
|
683
|
+
item: OpenAIResponseObjectStreamResponseOutputItemAdded.OpenAIResponseMessage | OpenAIResponseObjectStreamResponseOutputItemAdded.OpenAIResponseOutputMessageWebSearchToolCall | OpenAIResponseObjectStreamResponseOutputItemAdded.OpenAIResponseOutputMessageFileSearchToolCall | OpenAIResponseObjectStreamResponseOutputItemAdded.OpenAIResponseOutputMessageFunctionToolCall | OpenAIResponseObjectStreamResponseOutputItemAdded.OpenAIResponseOutputMessageMcpCall | OpenAIResponseObjectStreamResponseOutputItemAdded.OpenAIResponseOutputMessageMcpListTools | OpenAIResponseObjectStreamResponseOutputItemAdded.OpenAIResponseMcpApprovalRequest | OpenAIResponseObjectStreamResponseOutputItemAdded.OpenAIResponseOutputMessageReasoningItem;
|
|
601
684
|
output_index: number;
|
|
602
685
|
response_id: string;
|
|
603
686
|
sequence_number: number;
|
|
@@ -643,6 +726,9 @@ export declare namespace ResponseObjectStream {
|
|
|
643
726
|
filename?: string | null;
|
|
644
727
|
type?: 'input_file';
|
|
645
728
|
}
|
|
729
|
+
/**
|
|
730
|
+
* Text content within an output message of an OpenAI response.
|
|
731
|
+
*/
|
|
646
732
|
interface OpenAIResponseOutputMessageContentOutputText {
|
|
647
733
|
text: string;
|
|
648
734
|
annotations?: Array<OpenAIResponseOutputMessageContentOutputText.OpenAIResponseAnnotationFileCitation | OpenAIResponseOutputMessageContentOutputText.OpenAIResponseAnnotationCitation | OpenAIResponseOutputMessageContentOutputText.OpenAIResponseAnnotationContainerFileCitation | OpenAIResponseOutputMessageContentOutputText.OpenAIResponseAnnotationFilePath>;
|
|
@@ -669,6 +755,9 @@ export declare namespace ResponseObjectStream {
|
|
|
669
755
|
url: string;
|
|
670
756
|
type?: 'url_citation';
|
|
671
757
|
}
|
|
758
|
+
/**
|
|
759
|
+
* Container file citation annotation referencing a file within a container.
|
|
760
|
+
*/
|
|
672
761
|
interface OpenAIResponseAnnotationContainerFileCitation {
|
|
673
762
|
container_id: string;
|
|
674
763
|
end_index: number;
|
|
@@ -677,6 +766,9 @@ export declare namespace ResponseObjectStream {
|
|
|
677
766
|
start_index: number;
|
|
678
767
|
type?: 'container_file_citation';
|
|
679
768
|
}
|
|
769
|
+
/**
|
|
770
|
+
* File path annotation referencing a generated file in response content.
|
|
771
|
+
*/
|
|
680
772
|
interface OpenAIResponseAnnotationFilePath {
|
|
681
773
|
file_id: string;
|
|
682
774
|
index: number;
|
|
@@ -819,6 +911,59 @@ export declare namespace ResponseObjectStream {
|
|
|
819
911
|
server_label: string;
|
|
820
912
|
type?: 'mcp_approval_request';
|
|
821
913
|
}
|
|
914
|
+
/**
|
|
915
|
+
* Reasoning output from the model, representing the model's thinking process.
|
|
916
|
+
*/
|
|
917
|
+
interface OpenAIResponseOutputMessageReasoningItem {
|
|
918
|
+
/**
|
|
919
|
+
* Unique identifier for the reasoning output item.
|
|
920
|
+
*/
|
|
921
|
+
id: string;
|
|
922
|
+
/**
|
|
923
|
+
* Summary of the reasoning output.
|
|
924
|
+
*/
|
|
925
|
+
summary: Array<OpenAIResponseOutputMessageReasoningItem.Summary>;
|
|
926
|
+
/**
|
|
927
|
+
* The reasoning content from the model.
|
|
928
|
+
*/
|
|
929
|
+
content?: Array<OpenAIResponseOutputMessageReasoningItem.Content> | null;
|
|
930
|
+
/**
|
|
931
|
+
* The status of the reasoning output.
|
|
932
|
+
*/
|
|
933
|
+
status?: 'in_progress' | 'completed' | 'incomplete' | null;
|
|
934
|
+
/**
|
|
935
|
+
* The type identifier, always 'reasoning'.
|
|
936
|
+
*/
|
|
937
|
+
type?: 'reasoning';
|
|
938
|
+
}
|
|
939
|
+
namespace OpenAIResponseOutputMessageReasoningItem {
|
|
940
|
+
/**
|
|
941
|
+
* A summary of reasoning output from the model.
|
|
942
|
+
*/
|
|
943
|
+
interface Summary {
|
|
944
|
+
/**
|
|
945
|
+
* The summary text of the reasoning output.
|
|
946
|
+
*/
|
|
947
|
+
text: string;
|
|
948
|
+
/**
|
|
949
|
+
* The type identifier, always 'summary_text'.
|
|
950
|
+
*/
|
|
951
|
+
type?: 'summary_text';
|
|
952
|
+
}
|
|
953
|
+
/**
|
|
954
|
+
* Reasoning text from the model.
|
|
955
|
+
*/
|
|
956
|
+
interface Content {
|
|
957
|
+
/**
|
|
958
|
+
* The reasoning text content from the model.
|
|
959
|
+
*/
|
|
960
|
+
text: string;
|
|
961
|
+
/**
|
|
962
|
+
* The type identifier, always 'reasoning_text'.
|
|
963
|
+
*/
|
|
964
|
+
type?: 'reasoning_text';
|
|
965
|
+
}
|
|
966
|
+
}
|
|
822
967
|
}
|
|
823
968
|
/**
|
|
824
969
|
* Streaming event for when an output item is completed.
|
|
@@ -829,7 +974,7 @@ export declare namespace ResponseObjectStream {
|
|
|
829
974
|
* under one type because the Responses API gives them all the same "type" value,
|
|
830
975
|
* and there is no way to tell them apart in certain scenarios.
|
|
831
976
|
*/
|
|
832
|
-
item: OpenAIResponseObjectStreamResponseOutputItemDone.OpenAIResponseMessage | OpenAIResponseObjectStreamResponseOutputItemDone.OpenAIResponseOutputMessageWebSearchToolCall | OpenAIResponseObjectStreamResponseOutputItemDone.OpenAIResponseOutputMessageFileSearchToolCall | OpenAIResponseObjectStreamResponseOutputItemDone.OpenAIResponseOutputMessageFunctionToolCall | OpenAIResponseObjectStreamResponseOutputItemDone.OpenAIResponseOutputMessageMcpCall | OpenAIResponseObjectStreamResponseOutputItemDone.OpenAIResponseOutputMessageMcpListTools | OpenAIResponseObjectStreamResponseOutputItemDone.OpenAIResponseMcpApprovalRequest;
|
|
977
|
+
item: OpenAIResponseObjectStreamResponseOutputItemDone.OpenAIResponseMessage | OpenAIResponseObjectStreamResponseOutputItemDone.OpenAIResponseOutputMessageWebSearchToolCall | OpenAIResponseObjectStreamResponseOutputItemDone.OpenAIResponseOutputMessageFileSearchToolCall | OpenAIResponseObjectStreamResponseOutputItemDone.OpenAIResponseOutputMessageFunctionToolCall | OpenAIResponseObjectStreamResponseOutputItemDone.OpenAIResponseOutputMessageMcpCall | OpenAIResponseObjectStreamResponseOutputItemDone.OpenAIResponseOutputMessageMcpListTools | OpenAIResponseObjectStreamResponseOutputItemDone.OpenAIResponseMcpApprovalRequest | OpenAIResponseObjectStreamResponseOutputItemDone.OpenAIResponseOutputMessageReasoningItem;
|
|
833
978
|
output_index: number;
|
|
834
979
|
response_id: string;
|
|
835
980
|
sequence_number: number;
|
|
@@ -875,6 +1020,9 @@ export declare namespace ResponseObjectStream {
|
|
|
875
1020
|
filename?: string | null;
|
|
876
1021
|
type?: 'input_file';
|
|
877
1022
|
}
|
|
1023
|
+
/**
|
|
1024
|
+
* Text content within an output message of an OpenAI response.
|
|
1025
|
+
*/
|
|
878
1026
|
interface OpenAIResponseOutputMessageContentOutputText {
|
|
879
1027
|
text: string;
|
|
880
1028
|
annotations?: Array<OpenAIResponseOutputMessageContentOutputText.OpenAIResponseAnnotationFileCitation | OpenAIResponseOutputMessageContentOutputText.OpenAIResponseAnnotationCitation | OpenAIResponseOutputMessageContentOutputText.OpenAIResponseAnnotationContainerFileCitation | OpenAIResponseOutputMessageContentOutputText.OpenAIResponseAnnotationFilePath>;
|
|
@@ -901,6 +1049,9 @@ export declare namespace ResponseObjectStream {
|
|
|
901
1049
|
url: string;
|
|
902
1050
|
type?: 'url_citation';
|
|
903
1051
|
}
|
|
1052
|
+
/**
|
|
1053
|
+
* Container file citation annotation referencing a file within a container.
|
|
1054
|
+
*/
|
|
904
1055
|
interface OpenAIResponseAnnotationContainerFileCitation {
|
|
905
1056
|
container_id: string;
|
|
906
1057
|
end_index: number;
|
|
@@ -909,6 +1060,9 @@ export declare namespace ResponseObjectStream {
|
|
|
909
1060
|
start_index: number;
|
|
910
1061
|
type?: 'container_file_citation';
|
|
911
1062
|
}
|
|
1063
|
+
/**
|
|
1064
|
+
* File path annotation referencing a generated file in response content.
|
|
1065
|
+
*/
|
|
912
1066
|
interface OpenAIResponseAnnotationFilePath {
|
|
913
1067
|
file_id: string;
|
|
914
1068
|
index: number;
|
|
@@ -1051,6 +1205,59 @@ export declare namespace ResponseObjectStream {
|
|
|
1051
1205
|
server_label: string;
|
|
1052
1206
|
type?: 'mcp_approval_request';
|
|
1053
1207
|
}
|
|
1208
|
+
/**
|
|
1209
|
+
* Reasoning output from the model, representing the model's thinking process.
|
|
1210
|
+
*/
|
|
1211
|
+
interface OpenAIResponseOutputMessageReasoningItem {
|
|
1212
|
+
/**
|
|
1213
|
+
* Unique identifier for the reasoning output item.
|
|
1214
|
+
*/
|
|
1215
|
+
id: string;
|
|
1216
|
+
/**
|
|
1217
|
+
* Summary of the reasoning output.
|
|
1218
|
+
*/
|
|
1219
|
+
summary: Array<OpenAIResponseOutputMessageReasoningItem.Summary>;
|
|
1220
|
+
/**
|
|
1221
|
+
* The reasoning content from the model.
|
|
1222
|
+
*/
|
|
1223
|
+
content?: Array<OpenAIResponseOutputMessageReasoningItem.Content> | null;
|
|
1224
|
+
/**
|
|
1225
|
+
* The status of the reasoning output.
|
|
1226
|
+
*/
|
|
1227
|
+
status?: 'in_progress' | 'completed' | 'incomplete' | null;
|
|
1228
|
+
/**
|
|
1229
|
+
* The type identifier, always 'reasoning'.
|
|
1230
|
+
*/
|
|
1231
|
+
type?: 'reasoning';
|
|
1232
|
+
}
|
|
1233
|
+
namespace OpenAIResponseOutputMessageReasoningItem {
|
|
1234
|
+
/**
|
|
1235
|
+
* A summary of reasoning output from the model.
|
|
1236
|
+
*/
|
|
1237
|
+
interface Summary {
|
|
1238
|
+
/**
|
|
1239
|
+
* The summary text of the reasoning output.
|
|
1240
|
+
*/
|
|
1241
|
+
text: string;
|
|
1242
|
+
/**
|
|
1243
|
+
* The type identifier, always 'summary_text'.
|
|
1244
|
+
*/
|
|
1245
|
+
type?: 'summary_text';
|
|
1246
|
+
}
|
|
1247
|
+
/**
|
|
1248
|
+
* Reasoning text from the model.
|
|
1249
|
+
*/
|
|
1250
|
+
interface Content {
|
|
1251
|
+
/**
|
|
1252
|
+
* The reasoning text content from the model.
|
|
1253
|
+
*/
|
|
1254
|
+
text: string;
|
|
1255
|
+
/**
|
|
1256
|
+
* The type identifier, always 'reasoning_text'.
|
|
1257
|
+
*/
|
|
1258
|
+
type?: 'reasoning_text';
|
|
1259
|
+
}
|
|
1260
|
+
}
|
|
1054
1261
|
}
|
|
1055
1262
|
/**
|
|
1056
1263
|
* Streaming event for incremental text content updates.
|
|
@@ -1148,6 +1355,9 @@ export declare namespace ResponseObjectStream {
|
|
|
1148
1355
|
sequence_number: number;
|
|
1149
1356
|
type?: 'response.web_search_call.in_progress';
|
|
1150
1357
|
}
|
|
1358
|
+
/**
|
|
1359
|
+
* Streaming event for web search calls currently searching.
|
|
1360
|
+
*/
|
|
1151
1361
|
interface OpenAIResponseObjectStreamResponseWebSearchCallSearching {
|
|
1152
1362
|
item_id: string;
|
|
1153
1363
|
output_index: number;
|
|
@@ -1163,18 +1373,30 @@ export declare namespace ResponseObjectStream {
|
|
|
1163
1373
|
sequence_number: number;
|
|
1164
1374
|
type?: 'response.web_search_call.completed';
|
|
1165
1375
|
}
|
|
1376
|
+
/**
|
|
1377
|
+
* Streaming event for MCP list tools operation in progress.
|
|
1378
|
+
*/
|
|
1166
1379
|
interface OpenAIResponseObjectStreamResponseMcpListToolsInProgress {
|
|
1167
1380
|
sequence_number: number;
|
|
1168
1381
|
type?: 'response.mcp_list_tools.in_progress';
|
|
1169
1382
|
}
|
|
1383
|
+
/**
|
|
1384
|
+
* Streaming event for a failed MCP list tools operation.
|
|
1385
|
+
*/
|
|
1170
1386
|
interface OpenAIResponseObjectStreamResponseMcpListToolsFailed {
|
|
1171
1387
|
sequence_number: number;
|
|
1172
1388
|
type?: 'response.mcp_list_tools.failed';
|
|
1173
1389
|
}
|
|
1390
|
+
/**
|
|
1391
|
+
* Streaming event for a completed MCP list tools operation.
|
|
1392
|
+
*/
|
|
1174
1393
|
interface OpenAIResponseObjectStreamResponseMcpListToolsCompleted {
|
|
1175
1394
|
sequence_number: number;
|
|
1176
1395
|
type?: 'response.mcp_list_tools.completed';
|
|
1177
1396
|
}
|
|
1397
|
+
/**
|
|
1398
|
+
* Streaming event for incremental MCP call argument updates.
|
|
1399
|
+
*/
|
|
1178
1400
|
interface OpenAIResponseObjectStreamResponseMcpCallArgumentsDelta {
|
|
1179
1401
|
delta: string;
|
|
1180
1402
|
item_id: string;
|
|
@@ -1182,6 +1404,9 @@ export declare namespace ResponseObjectStream {
|
|
|
1182
1404
|
sequence_number: number;
|
|
1183
1405
|
type?: 'response.mcp_call.arguments.delta';
|
|
1184
1406
|
}
|
|
1407
|
+
/**
|
|
1408
|
+
* Streaming event for completed MCP call arguments.
|
|
1409
|
+
*/
|
|
1185
1410
|
interface OpenAIResponseObjectStreamResponseMcpCallArgumentsDone {
|
|
1186
1411
|
arguments: string;
|
|
1187
1412
|
item_id: string;
|
|
@@ -1257,6 +1482,9 @@ export declare namespace ResponseObjectStream {
|
|
|
1257
1482
|
url: string;
|
|
1258
1483
|
type?: 'url_citation';
|
|
1259
1484
|
}
|
|
1485
|
+
/**
|
|
1486
|
+
* Container file citation annotation referencing a file within a container.
|
|
1487
|
+
*/
|
|
1260
1488
|
interface OpenAIResponseAnnotationContainerFileCitation {
|
|
1261
1489
|
container_id: string;
|
|
1262
1490
|
end_index: number;
|
|
@@ -1265,6 +1493,9 @@ export declare namespace ResponseObjectStream {
|
|
|
1265
1493
|
start_index: number;
|
|
1266
1494
|
type?: 'container_file_citation';
|
|
1267
1495
|
}
|
|
1496
|
+
/**
|
|
1497
|
+
* File path annotation referencing a generated file in response content.
|
|
1498
|
+
*/
|
|
1268
1499
|
interface OpenAIResponseAnnotationFilePath {
|
|
1269
1500
|
file_id: string;
|
|
1270
1501
|
index: number;
|
|
@@ -1373,6 +1604,9 @@ export declare namespace ResponseObjectStream {
|
|
|
1373
1604
|
url: string;
|
|
1374
1605
|
type?: 'url_citation';
|
|
1375
1606
|
}
|
|
1607
|
+
/**
|
|
1608
|
+
* Container file citation annotation referencing a file within a container.
|
|
1609
|
+
*/
|
|
1376
1610
|
interface OpenAIResponseAnnotationContainerFileCitation {
|
|
1377
1611
|
container_id: string;
|
|
1378
1612
|
end_index: number;
|
|
@@ -1381,6 +1615,9 @@ export declare namespace ResponseObjectStream {
|
|
|
1381
1615
|
start_index: number;
|
|
1382
1616
|
type?: 'container_file_citation';
|
|
1383
1617
|
}
|
|
1618
|
+
/**
|
|
1619
|
+
* File path annotation referencing a generated file in response content.
|
|
1620
|
+
*/
|
|
1384
1621
|
interface OpenAIResponseAnnotationFilePath {
|
|
1385
1622
|
file_id: string;
|
|
1386
1623
|
index: number;
|
|
@@ -1591,6 +1828,9 @@ export declare namespace ResponseObjectStream {
|
|
|
1591
1828
|
url: string;
|
|
1592
1829
|
type?: 'url_citation';
|
|
1593
1830
|
}
|
|
1831
|
+
/**
|
|
1832
|
+
* Container file citation annotation referencing a file within a container.
|
|
1833
|
+
*/
|
|
1594
1834
|
interface OpenAIResponseAnnotationContainerFileCitation {
|
|
1595
1835
|
container_id: string;
|
|
1596
1836
|
end_index: number;
|
|
@@ -1599,6 +1839,9 @@ export declare namespace ResponseObjectStream {
|
|
|
1599
1839
|
start_index: number;
|
|
1600
1840
|
type?: 'container_file_citation';
|
|
1601
1841
|
}
|
|
1842
|
+
/**
|
|
1843
|
+
* File path annotation referencing a generated file in response content.
|
|
1844
|
+
*/
|
|
1602
1845
|
interface OpenAIResponseAnnotationFilePath {
|
|
1603
1846
|
file_id: string;
|
|
1604
1847
|
index: number;
|
|
@@ -1662,6 +1905,7 @@ export declare namespace ResponseObjectStream {
|
|
|
1662
1905
|
* Complete OpenAI response object containing generation results and metadata.
|
|
1663
1906
|
*/
|
|
1664
1907
|
response: ResponsesAPI.ResponseObject;
|
|
1908
|
+
sequence_number: number;
|
|
1665
1909
|
type?: 'response.completed';
|
|
1666
1910
|
}
|
|
1667
1911
|
}
|
|
@@ -1671,16 +1915,22 @@ export declare namespace ResponseObjectStream {
|
|
|
1671
1915
|
export interface ResponseListResponse {
|
|
1672
1916
|
id: string;
|
|
1673
1917
|
created_at: number;
|
|
1674
|
-
input: Array<ResponseListResponse.OpenAIResponseMessageOutput | ResponseListResponse.OpenAIResponseOutputMessageWebSearchToolCall | ResponseListResponse.OpenAIResponseOutputMessageFileSearchToolCall | ResponseListResponse.OpenAIResponseOutputMessageFunctionToolCall | ResponseListResponse.OpenAIResponseOutputMessageMcpCall | ResponseListResponse.OpenAIResponseOutputMessageMcpListTools | ResponseListResponse.OpenAIResponseMcpApprovalRequest | ResponseListResponse.OpenAIResponseInputFunctionToolCallOutput | ResponseListResponse.OpenAIResponseMcpApprovalResponse | ResponseListResponse.OpenAIResponseMessageOutput>;
|
|
1918
|
+
input: Array<ResponseListResponse.OpenAIResponseMessageOutput | ResponseListResponse.OpenAIResponseOutputMessageWebSearchToolCall | ResponseListResponse.OpenAIResponseOutputMessageFileSearchToolCall | ResponseListResponse.OpenAIResponseOutputMessageFunctionToolCall | ResponseListResponse.OpenAIResponseOutputMessageMcpCall | ResponseListResponse.OpenAIResponseOutputMessageMcpListTools | ResponseListResponse.OpenAIResponseMcpApprovalRequest | ResponseListResponse.OpenAIResponseOutputMessageReasoningItem | ResponseListResponse.OpenAIResponseInputFunctionToolCallOutput | ResponseListResponse.OpenAIResponseMcpApprovalResponse | ResponseListResponse.OpenAIResponseMessageOutput>;
|
|
1675
1919
|
model: string;
|
|
1676
|
-
output: Array<ResponseListResponse.OpenAIResponseMessageOutput | ResponseListResponse.OpenAIResponseOutputMessageWebSearchToolCall | ResponseListResponse.OpenAIResponseOutputMessageFileSearchToolCall | ResponseListResponse.OpenAIResponseOutputMessageFunctionToolCall | ResponseListResponse.OpenAIResponseOutputMessageMcpCall | ResponseListResponse.OpenAIResponseOutputMessageMcpListTools | ResponseListResponse.OpenAIResponseMcpApprovalRequest>;
|
|
1920
|
+
output: Array<ResponseListResponse.OpenAIResponseMessageOutput | ResponseListResponse.OpenAIResponseOutputMessageWebSearchToolCall | ResponseListResponse.OpenAIResponseOutputMessageFileSearchToolCall | ResponseListResponse.OpenAIResponseOutputMessageFunctionToolCall | ResponseListResponse.OpenAIResponseOutputMessageMcpCall | ResponseListResponse.OpenAIResponseOutputMessageMcpListTools | ResponseListResponse.OpenAIResponseMcpApprovalRequest | ResponseListResponse.OpenAIResponseOutputMessageReasoningItem>;
|
|
1677
1921
|
status: string;
|
|
1678
1922
|
store: boolean;
|
|
1923
|
+
background?: boolean;
|
|
1679
1924
|
completed_at?: number | null;
|
|
1680
1925
|
/**
|
|
1681
1926
|
* Error details for failed OpenAI response requests.
|
|
1682
1927
|
*/
|
|
1683
1928
|
error?: ResponseListResponse.Error | null;
|
|
1929
|
+
frequency_penalty?: number | null;
|
|
1930
|
+
/**
|
|
1931
|
+
* Details explaining why a response was incomplete.
|
|
1932
|
+
*/
|
|
1933
|
+
incomplete_details?: ResponseListResponse.IncompleteDetails | null;
|
|
1684
1934
|
instructions?: string | null;
|
|
1685
1935
|
max_output_tokens?: number | null;
|
|
1686
1936
|
max_tool_calls?: number | null;
|
|
@@ -1689,11 +1939,13 @@ export interface ResponseListResponse {
|
|
|
1689
1939
|
} | null;
|
|
1690
1940
|
object?: 'response';
|
|
1691
1941
|
parallel_tool_calls?: boolean | null;
|
|
1942
|
+
presence_penalty?: number | null;
|
|
1692
1943
|
previous_response_id?: string | null;
|
|
1693
1944
|
/**
|
|
1694
1945
|
* OpenAI compatible Prompt object that is used in OpenAI responses.
|
|
1695
1946
|
*/
|
|
1696
1947
|
prompt?: ResponseListResponse.Prompt | null;
|
|
1948
|
+
prompt_cache_key?: string | null;
|
|
1697
1949
|
/**
|
|
1698
1950
|
* Configuration for reasoning effort in OpenAI responses.
|
|
1699
1951
|
*
|
|
@@ -1701,16 +1953,18 @@ export interface ResponseListResponse {
|
|
|
1701
1953
|
*/
|
|
1702
1954
|
reasoning?: ResponseListResponse.Reasoning | null;
|
|
1703
1955
|
safety_identifier?: string | null;
|
|
1956
|
+
service_tier?: string | null;
|
|
1704
1957
|
temperature?: number | null;
|
|
1705
1958
|
/**
|
|
1706
1959
|
* Text response configuration for OpenAI responses.
|
|
1707
1960
|
*/
|
|
1708
1961
|
text?: ResponseListResponse.Text;
|
|
1709
1962
|
/**
|
|
1710
|
-
*
|
|
1963
|
+
* Enumeration of simple tool choice modes for response generation.
|
|
1711
1964
|
*/
|
|
1712
1965
|
tool_choice?: 'auto' | 'required' | 'none' | ResponseListResponse.OpenAIResponseInputToolChoiceAllowedTools | ResponseListResponse.OpenAIResponseInputToolChoiceFileSearch | ResponseListResponse.OpenAIResponseInputToolChoiceWebSearch | ResponseListResponse.OpenAIResponseInputToolChoiceFunctionTool | ResponseListResponse.OpenAIResponseInputToolChoiceMcpTool | ResponseListResponse.OpenAIResponseInputToolChoiceCustomTool | null;
|
|
1713
1966
|
tools?: Array<ResponseListResponse.OpenAIResponseInputToolWebSearch | ResponseListResponse.OpenAIResponseInputToolFileSearch | ResponseListResponse.OpenAIResponseInputToolFunction | ResponseListResponse.OpenAIResponseToolMcp> | null;
|
|
1967
|
+
top_logprobs?: number | null;
|
|
1714
1968
|
top_p?: number | null;
|
|
1715
1969
|
truncation?: string | null;
|
|
1716
1970
|
/**
|
|
@@ -1758,6 +2012,9 @@ export declare namespace ResponseListResponse {
|
|
|
1758
2012
|
filename?: string | null;
|
|
1759
2013
|
type?: 'input_file';
|
|
1760
2014
|
}
|
|
2015
|
+
/**
|
|
2016
|
+
* Text content within an output message of an OpenAI response.
|
|
2017
|
+
*/
|
|
1761
2018
|
interface OpenAIResponseOutputMessageContentOutputTextOutput {
|
|
1762
2019
|
text: string;
|
|
1763
2020
|
annotations?: Array<OpenAIResponseOutputMessageContentOutputTextOutput.OpenAIResponseAnnotationFileCitation | OpenAIResponseOutputMessageContentOutputTextOutput.OpenAIResponseAnnotationCitation | OpenAIResponseOutputMessageContentOutputTextOutput.OpenAIResponseAnnotationContainerFileCitation | OpenAIResponseOutputMessageContentOutputTextOutput.OpenAIResponseAnnotationFilePath>;
|
|
@@ -1784,6 +2041,9 @@ export declare namespace ResponseListResponse {
|
|
|
1784
2041
|
url: string;
|
|
1785
2042
|
type?: 'url_citation';
|
|
1786
2043
|
}
|
|
2044
|
+
/**
|
|
2045
|
+
* Container file citation annotation referencing a file within a container.
|
|
2046
|
+
*/
|
|
1787
2047
|
interface OpenAIResponseAnnotationContainerFileCitation {
|
|
1788
2048
|
container_id: string;
|
|
1789
2049
|
end_index: number;
|
|
@@ -1792,6 +2052,9 @@ export declare namespace ResponseListResponse {
|
|
|
1792
2052
|
start_index: number;
|
|
1793
2053
|
type?: 'container_file_citation';
|
|
1794
2054
|
}
|
|
2055
|
+
/**
|
|
2056
|
+
* File path annotation referencing a generated file in response content.
|
|
2057
|
+
*/
|
|
1795
2058
|
interface OpenAIResponseAnnotationFilePath {
|
|
1796
2059
|
file_id: string;
|
|
1797
2060
|
index: number;
|
|
@@ -1934,17 +2197,98 @@ export declare namespace ResponseListResponse {
|
|
|
1934
2197
|
server_label: string;
|
|
1935
2198
|
type?: 'mcp_approval_request';
|
|
1936
2199
|
}
|
|
2200
|
+
/**
|
|
2201
|
+
* Reasoning output from the model, representing the model's thinking process.
|
|
2202
|
+
*/
|
|
2203
|
+
interface OpenAIResponseOutputMessageReasoningItem {
|
|
2204
|
+
/**
|
|
2205
|
+
* Unique identifier for the reasoning output item.
|
|
2206
|
+
*/
|
|
2207
|
+
id: string;
|
|
2208
|
+
/**
|
|
2209
|
+
* Summary of the reasoning output.
|
|
2210
|
+
*/
|
|
2211
|
+
summary: Array<OpenAIResponseOutputMessageReasoningItem.Summary>;
|
|
2212
|
+
/**
|
|
2213
|
+
* The reasoning content from the model.
|
|
2214
|
+
*/
|
|
2215
|
+
content?: Array<OpenAIResponseOutputMessageReasoningItem.Content> | null;
|
|
2216
|
+
/**
|
|
2217
|
+
* The status of the reasoning output.
|
|
2218
|
+
*/
|
|
2219
|
+
status?: 'in_progress' | 'completed' | 'incomplete' | null;
|
|
2220
|
+
/**
|
|
2221
|
+
* The type identifier, always 'reasoning'.
|
|
2222
|
+
*/
|
|
2223
|
+
type?: 'reasoning';
|
|
2224
|
+
}
|
|
2225
|
+
namespace OpenAIResponseOutputMessageReasoningItem {
|
|
2226
|
+
/**
|
|
2227
|
+
* A summary of reasoning output from the model.
|
|
2228
|
+
*/
|
|
2229
|
+
interface Summary {
|
|
2230
|
+
/**
|
|
2231
|
+
* The summary text of the reasoning output.
|
|
2232
|
+
*/
|
|
2233
|
+
text: string;
|
|
2234
|
+
/**
|
|
2235
|
+
* The type identifier, always 'summary_text'.
|
|
2236
|
+
*/
|
|
2237
|
+
type?: 'summary_text';
|
|
2238
|
+
}
|
|
2239
|
+
/**
|
|
2240
|
+
* Reasoning text from the model.
|
|
2241
|
+
*/
|
|
2242
|
+
interface Content {
|
|
2243
|
+
/**
|
|
2244
|
+
* The reasoning text content from the model.
|
|
2245
|
+
*/
|
|
2246
|
+
text: string;
|
|
2247
|
+
/**
|
|
2248
|
+
* The type identifier, always 'reasoning_text'.
|
|
2249
|
+
*/
|
|
2250
|
+
type?: 'reasoning_text';
|
|
2251
|
+
}
|
|
2252
|
+
}
|
|
1937
2253
|
/**
|
|
1938
2254
|
* This represents the output of a function call that gets passed back to the
|
|
1939
2255
|
* model.
|
|
1940
2256
|
*/
|
|
1941
2257
|
interface OpenAIResponseInputFunctionToolCallOutput {
|
|
1942
2258
|
call_id: string;
|
|
1943
|
-
output: string
|
|
2259
|
+
output: string | Array<OpenAIResponseInputFunctionToolCallOutput.OpenAIResponseInputMessageContentText | OpenAIResponseInputFunctionToolCallOutput.OpenAIResponseInputMessageContentImage | OpenAIResponseInputFunctionToolCallOutput.OpenAIResponseInputMessageContentFile>;
|
|
1944
2260
|
id?: string | null;
|
|
1945
2261
|
status?: string | null;
|
|
1946
2262
|
type?: 'function_call_output';
|
|
1947
2263
|
}
|
|
2264
|
+
namespace OpenAIResponseInputFunctionToolCallOutput {
|
|
2265
|
+
/**
|
|
2266
|
+
* Text content for input messages in OpenAI response format.
|
|
2267
|
+
*/
|
|
2268
|
+
interface OpenAIResponseInputMessageContentText {
|
|
2269
|
+
text: string;
|
|
2270
|
+
type?: 'input_text';
|
|
2271
|
+
}
|
|
2272
|
+
/**
|
|
2273
|
+
* Image content for input messages in OpenAI response format.
|
|
2274
|
+
*/
|
|
2275
|
+
interface OpenAIResponseInputMessageContentImage {
|
|
2276
|
+
detail?: 'low' | 'high' | 'auto';
|
|
2277
|
+
file_id?: string | null;
|
|
2278
|
+
image_url?: string | null;
|
|
2279
|
+
type?: 'input_image';
|
|
2280
|
+
}
|
|
2281
|
+
/**
|
|
2282
|
+
* File content for input messages in OpenAI response format.
|
|
2283
|
+
*/
|
|
2284
|
+
interface OpenAIResponseInputMessageContentFile {
|
|
2285
|
+
file_data?: string | null;
|
|
2286
|
+
file_id?: string | null;
|
|
2287
|
+
file_url?: string | null;
|
|
2288
|
+
filename?: string | null;
|
|
2289
|
+
type?: 'input_file';
|
|
2290
|
+
}
|
|
2291
|
+
}
|
|
1948
2292
|
/**
|
|
1949
2293
|
* A response to an MCP approval request.
|
|
1950
2294
|
*/
|
|
@@ -1994,6 +2338,9 @@ export declare namespace ResponseListResponse {
|
|
|
1994
2338
|
filename?: string | null;
|
|
1995
2339
|
type?: 'input_file';
|
|
1996
2340
|
}
|
|
2341
|
+
/**
|
|
2342
|
+
* Text content within an output message of an OpenAI response.
|
|
2343
|
+
*/
|
|
1997
2344
|
interface OpenAIResponseOutputMessageContentOutputTextOutput {
|
|
1998
2345
|
text: string;
|
|
1999
2346
|
annotations?: Array<OpenAIResponseOutputMessageContentOutputTextOutput.OpenAIResponseAnnotationFileCitation | OpenAIResponseOutputMessageContentOutputTextOutput.OpenAIResponseAnnotationCitation | OpenAIResponseOutputMessageContentOutputTextOutput.OpenAIResponseAnnotationContainerFileCitation | OpenAIResponseOutputMessageContentOutputTextOutput.OpenAIResponseAnnotationFilePath>;
|
|
@@ -2020,6 +2367,9 @@ export declare namespace ResponseListResponse {
|
|
|
2020
2367
|
url: string;
|
|
2021
2368
|
type?: 'url_citation';
|
|
2022
2369
|
}
|
|
2370
|
+
/**
|
|
2371
|
+
* Container file citation annotation referencing a file within a container.
|
|
2372
|
+
*/
|
|
2023
2373
|
interface OpenAIResponseAnnotationContainerFileCitation {
|
|
2024
2374
|
container_id: string;
|
|
2025
2375
|
end_index: number;
|
|
@@ -2028,6 +2378,9 @@ export declare namespace ResponseListResponse {
|
|
|
2028
2378
|
start_index: number;
|
|
2029
2379
|
type?: 'container_file_citation';
|
|
2030
2380
|
}
|
|
2381
|
+
/**
|
|
2382
|
+
* File path annotation referencing a generated file in response content.
|
|
2383
|
+
*/
|
|
2031
2384
|
interface OpenAIResponseAnnotationFilePath {
|
|
2032
2385
|
file_id: string;
|
|
2033
2386
|
index: number;
|
|
@@ -2123,6 +2476,9 @@ export declare namespace ResponseListResponse {
|
|
|
2123
2476
|
filename?: string | null;
|
|
2124
2477
|
type?: 'input_file';
|
|
2125
2478
|
}
|
|
2479
|
+
/**
|
|
2480
|
+
* Text content within an output message of an OpenAI response.
|
|
2481
|
+
*/
|
|
2126
2482
|
interface OpenAIResponseOutputMessageContentOutputTextOutput {
|
|
2127
2483
|
text: string;
|
|
2128
2484
|
annotations?: Array<OpenAIResponseOutputMessageContentOutputTextOutput.OpenAIResponseAnnotationFileCitation | OpenAIResponseOutputMessageContentOutputTextOutput.OpenAIResponseAnnotationCitation | OpenAIResponseOutputMessageContentOutputTextOutput.OpenAIResponseAnnotationContainerFileCitation | OpenAIResponseOutputMessageContentOutputTextOutput.OpenAIResponseAnnotationFilePath>;
|
|
@@ -2149,6 +2505,9 @@ export declare namespace ResponseListResponse {
|
|
|
2149
2505
|
url: string;
|
|
2150
2506
|
type?: 'url_citation';
|
|
2151
2507
|
}
|
|
2508
|
+
/**
|
|
2509
|
+
* Container file citation annotation referencing a file within a container.
|
|
2510
|
+
*/
|
|
2152
2511
|
interface OpenAIResponseAnnotationContainerFileCitation {
|
|
2153
2512
|
container_id: string;
|
|
2154
2513
|
end_index: number;
|
|
@@ -2157,6 +2516,9 @@ export declare namespace ResponseListResponse {
|
|
|
2157
2516
|
start_index: number;
|
|
2158
2517
|
type?: 'container_file_citation';
|
|
2159
2518
|
}
|
|
2519
|
+
/**
|
|
2520
|
+
* File path annotation referencing a generated file in response content.
|
|
2521
|
+
*/
|
|
2160
2522
|
interface OpenAIResponseAnnotationFilePath {
|
|
2161
2523
|
file_id: string;
|
|
2162
2524
|
index: number;
|
|
@@ -2299,6 +2661,59 @@ export declare namespace ResponseListResponse {
|
|
|
2299
2661
|
server_label: string;
|
|
2300
2662
|
type?: 'mcp_approval_request';
|
|
2301
2663
|
}
|
|
2664
|
+
/**
|
|
2665
|
+
* Reasoning output from the model, representing the model's thinking process.
|
|
2666
|
+
*/
|
|
2667
|
+
interface OpenAIResponseOutputMessageReasoningItem {
|
|
2668
|
+
/**
|
|
2669
|
+
* Unique identifier for the reasoning output item.
|
|
2670
|
+
*/
|
|
2671
|
+
id: string;
|
|
2672
|
+
/**
|
|
2673
|
+
* Summary of the reasoning output.
|
|
2674
|
+
*/
|
|
2675
|
+
summary: Array<OpenAIResponseOutputMessageReasoningItem.Summary>;
|
|
2676
|
+
/**
|
|
2677
|
+
* The reasoning content from the model.
|
|
2678
|
+
*/
|
|
2679
|
+
content?: Array<OpenAIResponseOutputMessageReasoningItem.Content> | null;
|
|
2680
|
+
/**
|
|
2681
|
+
* The status of the reasoning output.
|
|
2682
|
+
*/
|
|
2683
|
+
status?: 'in_progress' | 'completed' | 'incomplete' | null;
|
|
2684
|
+
/**
|
|
2685
|
+
* The type identifier, always 'reasoning'.
|
|
2686
|
+
*/
|
|
2687
|
+
type?: 'reasoning';
|
|
2688
|
+
}
|
|
2689
|
+
namespace OpenAIResponseOutputMessageReasoningItem {
|
|
2690
|
+
/**
|
|
2691
|
+
* A summary of reasoning output from the model.
|
|
2692
|
+
*/
|
|
2693
|
+
interface Summary {
|
|
2694
|
+
/**
|
|
2695
|
+
* The summary text of the reasoning output.
|
|
2696
|
+
*/
|
|
2697
|
+
text: string;
|
|
2698
|
+
/**
|
|
2699
|
+
* The type identifier, always 'summary_text'.
|
|
2700
|
+
*/
|
|
2701
|
+
type?: 'summary_text';
|
|
2702
|
+
}
|
|
2703
|
+
/**
|
|
2704
|
+
* Reasoning text from the model.
|
|
2705
|
+
*/
|
|
2706
|
+
interface Content {
|
|
2707
|
+
/**
|
|
2708
|
+
* The reasoning text content from the model.
|
|
2709
|
+
*/
|
|
2710
|
+
text: string;
|
|
2711
|
+
/**
|
|
2712
|
+
* The type identifier, always 'reasoning_text'.
|
|
2713
|
+
*/
|
|
2714
|
+
type?: 'reasoning_text';
|
|
2715
|
+
}
|
|
2716
|
+
}
|
|
2302
2717
|
/**
|
|
2303
2718
|
* Error details for failed OpenAI response requests.
|
|
2304
2719
|
*/
|
|
@@ -2306,6 +2721,12 @@ export declare namespace ResponseListResponse {
|
|
|
2306
2721
|
code: string;
|
|
2307
2722
|
message: string;
|
|
2308
2723
|
}
|
|
2724
|
+
/**
|
|
2725
|
+
* Details explaining why a response was incomplete.
|
|
2726
|
+
*/
|
|
2727
|
+
interface IncompleteDetails {
|
|
2728
|
+
reason: string;
|
|
2729
|
+
}
|
|
2309
2730
|
/**
|
|
2310
2731
|
* OpenAI compatible Prompt object that is used in OpenAI responses.
|
|
2311
2732
|
*/
|
|
@@ -2351,6 +2772,10 @@ export declare namespace ResponseListResponse {
|
|
|
2351
2772
|
*/
|
|
2352
2773
|
interface Reasoning {
|
|
2353
2774
|
effort?: 'none' | 'minimal' | 'low' | 'medium' | 'high' | 'xhigh' | null;
|
|
2775
|
+
/**
|
|
2776
|
+
* Summary mode for reasoning output. One of 'auto', 'concise', or 'detailed'.
|
|
2777
|
+
*/
|
|
2778
|
+
summary?: 'auto' | 'concise' | 'detailed' | null;
|
|
2354
2779
|
}
|
|
2355
2780
|
/**
|
|
2356
2781
|
* Text response configuration for OpenAI responses.
|
|
@@ -2576,15 +3001,24 @@ export interface ResponseCreateParamsBase {
|
|
|
2576
3001
|
/**
|
|
2577
3002
|
* Input message(s) to create the response.
|
|
2578
3003
|
*/
|
|
2579
|
-
input: string | Array<ResponseCreateParams.OpenAIResponseMessageInput | ResponseCreateParams.OpenAIResponseOutputMessageWebSearchToolCall | ResponseCreateParams.OpenAIResponseOutputMessageFileSearchToolCall | ResponseCreateParams.OpenAIResponseOutputMessageFunctionToolCall | ResponseCreateParams.OpenAIResponseOutputMessageMcpCall | ResponseCreateParams.OpenAIResponseOutputMessageMcpListTools | ResponseCreateParams.OpenAIResponseMcpApprovalRequest | ResponseCreateParams.OpenAIResponseInputFunctionToolCallOutput | ResponseCreateParams.OpenAIResponseMcpApprovalResponse>;
|
|
3004
|
+
input: string | Array<ResponseCreateParams.OpenAIResponseMessageInput | ResponseCreateParams.OpenAIResponseOutputMessageWebSearchToolCall | ResponseCreateParams.OpenAIResponseOutputMessageFileSearchToolCall | ResponseCreateParams.OpenAIResponseOutputMessageFunctionToolCall | ResponseCreateParams.OpenAIResponseOutputMessageMcpCall | ResponseCreateParams.OpenAIResponseOutputMessageMcpListTools | ResponseCreateParams.OpenAIResponseMcpApprovalRequest | ResponseCreateParams.OpenAIResponseOutputMessageReasoningItem | ResponseCreateParams.OpenAIResponseInputFunctionToolCallOutput | ResponseCreateParams.OpenAIResponseMcpApprovalResponse>;
|
|
2580
3005
|
/**
|
|
2581
3006
|
* The underlying LLM used for completions.
|
|
2582
3007
|
*/
|
|
2583
3008
|
model: string;
|
|
3009
|
+
/**
|
|
3010
|
+
* Whether to run the model response in the background. When true, returns
|
|
3011
|
+
* immediately with status 'queued'.
|
|
3012
|
+
*/
|
|
3013
|
+
background?: boolean;
|
|
2584
3014
|
/**
|
|
2585
3015
|
* Optional ID of a conversation to add the response to.
|
|
2586
3016
|
*/
|
|
2587
3017
|
conversation?: string | null;
|
|
3018
|
+
/**
|
|
3019
|
+
* Penalizes new tokens based on their frequency in the text so far.
|
|
3020
|
+
*/
|
|
3021
|
+
frequency_penalty?: number | null;
|
|
2588
3022
|
/**
|
|
2589
3023
|
* List of guardrails to apply during response generation.
|
|
2590
3024
|
*/
|
|
@@ -2619,6 +3053,10 @@ export interface ResponseCreateParamsBase {
|
|
|
2619
3053
|
* Whether to enable parallel tool calls.
|
|
2620
3054
|
*/
|
|
2621
3055
|
parallel_tool_calls?: boolean | null;
|
|
3056
|
+
/**
|
|
3057
|
+
* Penalizes new tokens based on whether they appear in the text so far.
|
|
3058
|
+
*/
|
|
3059
|
+
presence_penalty?: number | null;
|
|
2622
3060
|
/**
|
|
2623
3061
|
* Optional ID of a previous response to continue from.
|
|
2624
3062
|
*/
|
|
@@ -2627,6 +3065,10 @@ export interface ResponseCreateParamsBase {
|
|
|
2627
3065
|
* OpenAI compatible Prompt object that is used in OpenAI responses.
|
|
2628
3066
|
*/
|
|
2629
3067
|
prompt?: ResponseCreateParams.Prompt | null;
|
|
3068
|
+
/**
|
|
3069
|
+
* A key to use when reading from or writing to the prompt cache.
|
|
3070
|
+
*/
|
|
3071
|
+
prompt_cache_key?: string | null;
|
|
2630
3072
|
/**
|
|
2631
3073
|
* Configuration for reasoning effort in OpenAI responses.
|
|
2632
3074
|
*
|
|
@@ -2637,6 +3079,10 @@ export interface ResponseCreateParamsBase {
|
|
|
2637
3079
|
* A stable identifier used for safety monitoring and abuse detection.
|
|
2638
3080
|
*/
|
|
2639
3081
|
safety_identifier?: string | null;
|
|
3082
|
+
/**
|
|
3083
|
+
* The service tier for the request.
|
|
3084
|
+
*/
|
|
3085
|
+
service_tier?: 'auto' | 'default' | 'flex' | 'priority' | null;
|
|
2640
3086
|
/**
|
|
2641
3087
|
* Whether to store the response in the database.
|
|
2642
3088
|
*/
|
|
@@ -2645,6 +3091,10 @@ export interface ResponseCreateParamsBase {
|
|
|
2645
3091
|
* Whether to stream the response.
|
|
2646
3092
|
*/
|
|
2647
3093
|
stream?: boolean | null;
|
|
3094
|
+
/**
|
|
3095
|
+
* Options that control streamed response behavior.
|
|
3096
|
+
*/
|
|
3097
|
+
stream_options?: ResponseCreateParams.StreamOptions | null;
|
|
2648
3098
|
/**
|
|
2649
3099
|
* Sampling temperature.
|
|
2650
3100
|
*/
|
|
@@ -2661,6 +3111,22 @@ export interface ResponseCreateParamsBase {
|
|
|
2661
3111
|
* List of tools available to the model.
|
|
2662
3112
|
*/
|
|
2663
3113
|
tools?: Array<ResponseCreateParams.OpenAIResponseInputToolWebSearch | ResponseCreateParams.OpenAIResponseInputToolFileSearch | ResponseCreateParams.OpenAIResponseInputToolFunction | ResponseCreateParams.OpenAIResponseInputToolMcp> | null;
|
|
3114
|
+
/**
|
|
3115
|
+
* The number of most likely tokens to return at each position, along with their
|
|
3116
|
+
* log probabilities.
|
|
3117
|
+
*/
|
|
3118
|
+
top_logprobs?: number | null;
|
|
3119
|
+
/**
|
|
3120
|
+
* Nucleus sampling parameter that controls response diversity (lower values
|
|
3121
|
+
* increase focus).
|
|
3122
|
+
*/
|
|
3123
|
+
top_p?: number | null;
|
|
3124
|
+
/**
|
|
3125
|
+
* Controls how the service truncates input when it exceeds the model context
|
|
3126
|
+
* window.
|
|
3127
|
+
*/
|
|
3128
|
+
truncation?: 'auto' | 'disabled' | null;
|
|
3129
|
+
[k: string]: unknown;
|
|
2664
3130
|
}
|
|
2665
3131
|
export declare namespace ResponseCreateParams {
|
|
2666
3132
|
/**
|
|
@@ -2702,6 +3168,9 @@ export declare namespace ResponseCreateParams {
|
|
|
2702
3168
|
filename?: string | null;
|
|
2703
3169
|
type?: 'input_file';
|
|
2704
3170
|
}
|
|
3171
|
+
/**
|
|
3172
|
+
* Text content within an output message of an OpenAI response.
|
|
3173
|
+
*/
|
|
2705
3174
|
interface OpenAIResponseOutputMessageContentOutputTextInput {
|
|
2706
3175
|
text: string;
|
|
2707
3176
|
annotations?: Array<OpenAIResponseOutputMessageContentOutputTextInput.OpenAIResponseAnnotationFileCitation | OpenAIResponseOutputMessageContentOutputTextInput.OpenAIResponseAnnotationCitation | OpenAIResponseOutputMessageContentOutputTextInput.OpenAIResponseAnnotationContainerFileCitation | OpenAIResponseOutputMessageContentOutputTextInput.OpenAIResponseAnnotationFilePath>;
|
|
@@ -2728,6 +3197,9 @@ export declare namespace ResponseCreateParams {
|
|
|
2728
3197
|
url: string;
|
|
2729
3198
|
type?: 'url_citation';
|
|
2730
3199
|
}
|
|
3200
|
+
/**
|
|
3201
|
+
* Container file citation annotation referencing a file within a container.
|
|
3202
|
+
*/
|
|
2731
3203
|
interface OpenAIResponseAnnotationContainerFileCitation {
|
|
2732
3204
|
container_id: string;
|
|
2733
3205
|
end_index: number;
|
|
@@ -2736,6 +3208,9 @@ export declare namespace ResponseCreateParams {
|
|
|
2736
3208
|
start_index: number;
|
|
2737
3209
|
type?: 'container_file_citation';
|
|
2738
3210
|
}
|
|
3211
|
+
/**
|
|
3212
|
+
* File path annotation referencing a generated file in response content.
|
|
3213
|
+
*/
|
|
2739
3214
|
interface OpenAIResponseAnnotationFilePath {
|
|
2740
3215
|
file_id: string;
|
|
2741
3216
|
index: number;
|
|
@@ -2878,17 +3353,98 @@ export declare namespace ResponseCreateParams {
|
|
|
2878
3353
|
server_label: string;
|
|
2879
3354
|
type?: 'mcp_approval_request';
|
|
2880
3355
|
}
|
|
3356
|
+
/**
|
|
3357
|
+
* Reasoning output from the model, representing the model's thinking process.
|
|
3358
|
+
*/
|
|
3359
|
+
interface OpenAIResponseOutputMessageReasoningItem {
|
|
3360
|
+
/**
|
|
3361
|
+
* Unique identifier for the reasoning output item.
|
|
3362
|
+
*/
|
|
3363
|
+
id: string;
|
|
3364
|
+
/**
|
|
3365
|
+
* Summary of the reasoning output.
|
|
3366
|
+
*/
|
|
3367
|
+
summary: Array<OpenAIResponseOutputMessageReasoningItem.Summary>;
|
|
3368
|
+
/**
|
|
3369
|
+
* The reasoning content from the model.
|
|
3370
|
+
*/
|
|
3371
|
+
content?: Array<OpenAIResponseOutputMessageReasoningItem.Content> | null;
|
|
3372
|
+
/**
|
|
3373
|
+
* The status of the reasoning output.
|
|
3374
|
+
*/
|
|
3375
|
+
status?: 'in_progress' | 'completed' | 'incomplete' | null;
|
|
3376
|
+
/**
|
|
3377
|
+
* The type identifier, always 'reasoning'.
|
|
3378
|
+
*/
|
|
3379
|
+
type?: 'reasoning';
|
|
3380
|
+
}
|
|
3381
|
+
namespace OpenAIResponseOutputMessageReasoningItem {
|
|
3382
|
+
/**
|
|
3383
|
+
* A summary of reasoning output from the model.
|
|
3384
|
+
*/
|
|
3385
|
+
interface Summary {
|
|
3386
|
+
/**
|
|
3387
|
+
* The summary text of the reasoning output.
|
|
3388
|
+
*/
|
|
3389
|
+
text: string;
|
|
3390
|
+
/**
|
|
3391
|
+
* The type identifier, always 'summary_text'.
|
|
3392
|
+
*/
|
|
3393
|
+
type?: 'summary_text';
|
|
3394
|
+
}
|
|
3395
|
+
/**
|
|
3396
|
+
* Reasoning text from the model.
|
|
3397
|
+
*/
|
|
3398
|
+
interface Content {
|
|
3399
|
+
/**
|
|
3400
|
+
* The reasoning text content from the model.
|
|
3401
|
+
*/
|
|
3402
|
+
text: string;
|
|
3403
|
+
/**
|
|
3404
|
+
* The type identifier, always 'reasoning_text'.
|
|
3405
|
+
*/
|
|
3406
|
+
type?: 'reasoning_text';
|
|
3407
|
+
}
|
|
3408
|
+
}
|
|
2881
3409
|
/**
|
|
2882
3410
|
* This represents the output of a function call that gets passed back to the
|
|
2883
3411
|
* model.
|
|
2884
3412
|
*/
|
|
2885
3413
|
interface OpenAIResponseInputFunctionToolCallOutput {
|
|
2886
3414
|
call_id: string;
|
|
2887
|
-
output: string
|
|
3415
|
+
output: string | Array<OpenAIResponseInputFunctionToolCallOutput.OpenAIResponseInputMessageContentText | OpenAIResponseInputFunctionToolCallOutput.OpenAIResponseInputMessageContentImage | OpenAIResponseInputFunctionToolCallOutput.OpenAIResponseInputMessageContentFile>;
|
|
2888
3416
|
id?: string | null;
|
|
2889
3417
|
status?: string | null;
|
|
2890
3418
|
type?: 'function_call_output';
|
|
2891
3419
|
}
|
|
3420
|
+
namespace OpenAIResponseInputFunctionToolCallOutput {
|
|
3421
|
+
/**
|
|
3422
|
+
* Text content for input messages in OpenAI response format.
|
|
3423
|
+
*/
|
|
3424
|
+
interface OpenAIResponseInputMessageContentText {
|
|
3425
|
+
text: string;
|
|
3426
|
+
type?: 'input_text';
|
|
3427
|
+
}
|
|
3428
|
+
/**
|
|
3429
|
+
* Image content for input messages in OpenAI response format.
|
|
3430
|
+
*/
|
|
3431
|
+
interface OpenAIResponseInputMessageContentImage {
|
|
3432
|
+
detail?: 'low' | 'high' | 'auto';
|
|
3433
|
+
file_id?: string | null;
|
|
3434
|
+
image_url?: string | null;
|
|
3435
|
+
type?: 'input_image';
|
|
3436
|
+
}
|
|
3437
|
+
/**
|
|
3438
|
+
* File content for input messages in OpenAI response format.
|
|
3439
|
+
*/
|
|
3440
|
+
interface OpenAIResponseInputMessageContentFile {
|
|
3441
|
+
file_data?: string | null;
|
|
3442
|
+
file_id?: string | null;
|
|
3443
|
+
file_url?: string | null;
|
|
3444
|
+
filename?: string | null;
|
|
3445
|
+
type?: 'input_file';
|
|
3446
|
+
}
|
|
3447
|
+
}
|
|
2892
3448
|
/**
|
|
2893
3449
|
* A response to an MCP approval request.
|
|
2894
3450
|
*/
|
|
@@ -2950,6 +3506,19 @@ export declare namespace ResponseCreateParams {
|
|
|
2950
3506
|
*/
|
|
2951
3507
|
interface Reasoning {
|
|
2952
3508
|
effort?: 'none' | 'minimal' | 'low' | 'medium' | 'high' | 'xhigh' | null;
|
|
3509
|
+
/**
|
|
3510
|
+
* Summary mode for reasoning output. One of 'auto', 'concise', or 'detailed'.
|
|
3511
|
+
*/
|
|
3512
|
+
summary?: 'auto' | 'concise' | 'detailed' | null;
|
|
3513
|
+
}
|
|
3514
|
+
/**
|
|
3515
|
+
* Options that control streamed response behavior.
|
|
3516
|
+
*/
|
|
3517
|
+
interface StreamOptions {
|
|
3518
|
+
/**
|
|
3519
|
+
* Whether to obfuscate sensitive information in streamed output.
|
|
3520
|
+
*/
|
|
3521
|
+
include_obfuscation?: boolean;
|
|
2953
3522
|
}
|
|
2954
3523
|
/**
|
|
2955
3524
|
* Text response configuration for OpenAI responses.
|
|
@@ -3156,12 +3725,14 @@ export interface ResponseCreateParamsNonStreaming extends ResponseCreateParamsBa
|
|
|
3156
3725
|
* Whether to stream the response.
|
|
3157
3726
|
*/
|
|
3158
3727
|
stream?: false | null;
|
|
3728
|
+
[k: string]: unknown;
|
|
3159
3729
|
}
|
|
3160
3730
|
export interface ResponseCreateParamsStreaming extends ResponseCreateParamsBase {
|
|
3161
3731
|
/**
|
|
3162
3732
|
* Whether to stream the response.
|
|
3163
3733
|
*/
|
|
3164
3734
|
stream: true;
|
|
3735
|
+
[k: string]: unknown;
|
|
3165
3736
|
}
|
|
3166
3737
|
export interface ResponseListParams extends OpenAICursorPageParams {
|
|
3167
3738
|
/**
|
|
@@ -3169,7 +3740,7 @@ export interface ResponseListParams extends OpenAICursorPageParams {
|
|
|
3169
3740
|
*/
|
|
3170
3741
|
model?: string | null;
|
|
3171
3742
|
/**
|
|
3172
|
-
*
|
|
3743
|
+
* The order to sort responses by when sorted by created_at ('asc' or 'desc').
|
|
3173
3744
|
*/
|
|
3174
3745
|
order?: 'asc' | 'desc' | null;
|
|
3175
3746
|
}
|