1// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
  2
  3package webhooks
  4
  5import (
  6	"github.com/openai/openai-go/internal/apierror"
  7	"github.com/openai/openai-go/packages/param"
  8	"github.com/openai/openai-go/shared"
  9)
 10
 11// aliased to make [param.APIUnion] private when embedding
 12type paramUnion = param.APIUnion
 13
 14// aliased to make [param.APIObject] private when embedding
 15type paramObj = param.APIObject
 16
 17type Error = apierror.Error
 18
 19// This is an alias to an internal type.
 20type ChatModel = shared.ChatModel
 21
 22// Equals "gpt-4.1"
 23const ChatModelGPT4_1 = shared.ChatModelGPT4_1
 24
 25// Equals "gpt-4.1-mini"
 26const ChatModelGPT4_1Mini = shared.ChatModelGPT4_1Mini
 27
 28// Equals "gpt-4.1-nano"
 29const ChatModelGPT4_1Nano = shared.ChatModelGPT4_1Nano
 30
 31// Equals "gpt-4.1-2025-04-14"
 32const ChatModelGPT4_1_2025_04_14 = shared.ChatModelGPT4_1_2025_04_14
 33
 34// Equals "gpt-4.1-mini-2025-04-14"
 35const ChatModelGPT4_1Mini2025_04_14 = shared.ChatModelGPT4_1Mini2025_04_14
 36
 37// Equals "gpt-4.1-nano-2025-04-14"
 38const ChatModelGPT4_1Nano2025_04_14 = shared.ChatModelGPT4_1Nano2025_04_14
 39
 40// Equals "o4-mini"
 41const ChatModelO4Mini = shared.ChatModelO4Mini
 42
 43// Equals "o4-mini-2025-04-16"
 44const ChatModelO4Mini2025_04_16 = shared.ChatModelO4Mini2025_04_16
 45
 46// Equals "o3"
 47const ChatModelO3 = shared.ChatModelO3
 48
 49// Equals "o3-2025-04-16"
 50const ChatModelO3_2025_04_16 = shared.ChatModelO3_2025_04_16
 51
 52// Equals "o3-mini"
 53const ChatModelO3Mini = shared.ChatModelO3Mini
 54
 55// Equals "o3-mini-2025-01-31"
 56const ChatModelO3Mini2025_01_31 = shared.ChatModelO3Mini2025_01_31
 57
 58// Equals "o1"
 59const ChatModelO1 = shared.ChatModelO1
 60
 61// Equals "o1-2024-12-17"
 62const ChatModelO1_2024_12_17 = shared.ChatModelO1_2024_12_17
 63
 64// Equals "o1-preview"
 65const ChatModelO1Preview = shared.ChatModelO1Preview
 66
 67// Equals "o1-preview-2024-09-12"
 68const ChatModelO1Preview2024_09_12 = shared.ChatModelO1Preview2024_09_12
 69
 70// Equals "o1-mini"
 71const ChatModelO1Mini = shared.ChatModelO1Mini
 72
 73// Equals "o1-mini-2024-09-12"
 74const ChatModelO1Mini2024_09_12 = shared.ChatModelO1Mini2024_09_12
 75
 76// Equals "gpt-4o"
 77const ChatModelGPT4o = shared.ChatModelGPT4o
 78
 79// Equals "gpt-4o-2024-11-20"
 80const ChatModelGPT4o2024_11_20 = shared.ChatModelGPT4o2024_11_20
 81
 82// Equals "gpt-4o-2024-08-06"
 83const ChatModelGPT4o2024_08_06 = shared.ChatModelGPT4o2024_08_06
 84
 85// Equals "gpt-4o-2024-05-13"
 86const ChatModelGPT4o2024_05_13 = shared.ChatModelGPT4o2024_05_13
 87
 88// Equals "gpt-4o-audio-preview"
 89const ChatModelGPT4oAudioPreview = shared.ChatModelGPT4oAudioPreview
 90
 91// Equals "gpt-4o-audio-preview-2024-10-01"
 92const ChatModelGPT4oAudioPreview2024_10_01 = shared.ChatModelGPT4oAudioPreview2024_10_01
 93
 94// Equals "gpt-4o-audio-preview-2024-12-17"
 95const ChatModelGPT4oAudioPreview2024_12_17 = shared.ChatModelGPT4oAudioPreview2024_12_17
 96
 97// Equals "gpt-4o-audio-preview-2025-06-03"
 98const ChatModelGPT4oAudioPreview2025_06_03 = shared.ChatModelGPT4oAudioPreview2025_06_03
 99
100// Equals "gpt-4o-mini-audio-preview"
101const ChatModelGPT4oMiniAudioPreview = shared.ChatModelGPT4oMiniAudioPreview
102
103// Equals "gpt-4o-mini-audio-preview-2024-12-17"
104const ChatModelGPT4oMiniAudioPreview2024_12_17 = shared.ChatModelGPT4oMiniAudioPreview2024_12_17
105
106// Equals "gpt-4o-search-preview"
107const ChatModelGPT4oSearchPreview = shared.ChatModelGPT4oSearchPreview
108
109// Equals "gpt-4o-mini-search-preview"
110const ChatModelGPT4oMiniSearchPreview = shared.ChatModelGPT4oMiniSearchPreview
111
112// Equals "gpt-4o-search-preview-2025-03-11"
113const ChatModelGPT4oSearchPreview2025_03_11 = shared.ChatModelGPT4oSearchPreview2025_03_11
114
115// Equals "gpt-4o-mini-search-preview-2025-03-11"
116const ChatModelGPT4oMiniSearchPreview2025_03_11 = shared.ChatModelGPT4oMiniSearchPreview2025_03_11
117
118// Equals "chatgpt-4o-latest"
119const ChatModelChatgpt4oLatest = shared.ChatModelChatgpt4oLatest
120
121// Equals "codex-mini-latest"
122const ChatModelCodexMiniLatest = shared.ChatModelCodexMiniLatest
123
124// Equals "gpt-4o-mini"
125const ChatModelGPT4oMini = shared.ChatModelGPT4oMini
126
127// Equals "gpt-4o-mini-2024-07-18"
128const ChatModelGPT4oMini2024_07_18 = shared.ChatModelGPT4oMini2024_07_18
129
130// Equals "gpt-4-turbo"
131const ChatModelGPT4Turbo = shared.ChatModelGPT4Turbo
132
133// Equals "gpt-4-turbo-2024-04-09"
134const ChatModelGPT4Turbo2024_04_09 = shared.ChatModelGPT4Turbo2024_04_09
135
136// Equals "gpt-4-0125-preview"
137const ChatModelGPT4_0125Preview = shared.ChatModelGPT4_0125Preview
138
139// Equals "gpt-4-turbo-preview"
140const ChatModelGPT4TurboPreview = shared.ChatModelGPT4TurboPreview
141
142// Equals "gpt-4-1106-preview"
143const ChatModelGPT4_1106Preview = shared.ChatModelGPT4_1106Preview
144
145// Equals "gpt-4-vision-preview"
146const ChatModelGPT4VisionPreview = shared.ChatModelGPT4VisionPreview
147
148// Equals "gpt-4"
149const ChatModelGPT4 = shared.ChatModelGPT4
150
151// Equals "gpt-4-0314"
152const ChatModelGPT4_0314 = shared.ChatModelGPT4_0314
153
154// Equals "gpt-4-0613"
155const ChatModelGPT4_0613 = shared.ChatModelGPT4_0613
156
157// Equals "gpt-4-32k"
158const ChatModelGPT4_32k = shared.ChatModelGPT4_32k
159
160// Equals "gpt-4-32k-0314"
161const ChatModelGPT4_32k0314 = shared.ChatModelGPT4_32k0314
162
163// Equals "gpt-4-32k-0613"
164const ChatModelGPT4_32k0613 = shared.ChatModelGPT4_32k0613
165
166// Equals "gpt-3.5-turbo"
167const ChatModelGPT3_5Turbo = shared.ChatModelGPT3_5Turbo
168
169// Equals "gpt-3.5-turbo-16k"
170const ChatModelGPT3_5Turbo16k = shared.ChatModelGPT3_5Turbo16k
171
172// Equals "gpt-3.5-turbo-0301"
173const ChatModelGPT3_5Turbo0301 = shared.ChatModelGPT3_5Turbo0301
174
175// Equals "gpt-3.5-turbo-0613"
176const ChatModelGPT3_5Turbo0613 = shared.ChatModelGPT3_5Turbo0613
177
178// Equals "gpt-3.5-turbo-1106"
179const ChatModelGPT3_5Turbo1106 = shared.ChatModelGPT3_5Turbo1106
180
181// Equals "gpt-3.5-turbo-0125"
182const ChatModelGPT3_5Turbo0125 = shared.ChatModelGPT3_5Turbo0125
183
184// Equals "gpt-3.5-turbo-16k-0613"
185const ChatModelGPT3_5Turbo16k0613 = shared.ChatModelGPT3_5Turbo16k0613
186
187// A filter used to compare a specified attribute key to a given value using a
188// defined comparison operation.
189//
190// This is an alias to an internal type.
191type ComparisonFilter = shared.ComparisonFilter
192
193// Specifies the comparison operator: `eq`, `ne`, `gt`, `gte`, `lt`, `lte`.
194//
195// - `eq`: equals
196// - `ne`: not equal
197// - `gt`: greater than
198// - `gte`: greater than or equal
199// - `lt`: less than
200// - `lte`: less than or equal
201//
202// This is an alias to an internal type.
203type ComparisonFilterType = shared.ComparisonFilterType
204
205// Equals "eq"
206const ComparisonFilterTypeEq = shared.ComparisonFilterTypeEq
207
208// Equals "ne"
209const ComparisonFilterTypeNe = shared.ComparisonFilterTypeNe
210
211// Equals "gt"
212const ComparisonFilterTypeGt = shared.ComparisonFilterTypeGt
213
214// Equals "gte"
215const ComparisonFilterTypeGte = shared.ComparisonFilterTypeGte
216
217// Equals "lt"
218const ComparisonFilterTypeLt = shared.ComparisonFilterTypeLt
219
220// Equals "lte"
221const ComparisonFilterTypeLte = shared.ComparisonFilterTypeLte
222
223// The value to compare against the attribute key; supports string, number, or
224// boolean types.
225//
226// This is an alias to an internal type.
227type ComparisonFilterValueUnion = shared.ComparisonFilterValueUnion
228
229// A filter used to compare a specified attribute key to a given value using a
230// defined comparison operation.
231//
232// This is an alias to an internal type.
233type ComparisonFilterParam = shared.ComparisonFilterParam
234
235// The value to compare against the attribute key; supports string, number, or
236// boolean types.
237//
238// This is an alias to an internal type.
239type ComparisonFilterValueUnionParam = shared.ComparisonFilterValueUnionParam
240
241// Combine multiple filters using `and` or `or`.
242//
243// This is an alias to an internal type.
244type CompoundFilter = shared.CompoundFilter
245
246// Type of operation: `and` or `or`.
247//
248// This is an alias to an internal type.
249type CompoundFilterType = shared.CompoundFilterType
250
251// Equals "and"
252const CompoundFilterTypeAnd = shared.CompoundFilterTypeAnd
253
254// Equals "or"
255const CompoundFilterTypeOr = shared.CompoundFilterTypeOr
256
257// Combine multiple filters using `and` or `or`.
258//
259// This is an alias to an internal type.
260type CompoundFilterParam = shared.CompoundFilterParam
261
262// This is an alias to an internal type.
263type ErrorObject = shared.ErrorObject
264
265// This is an alias to an internal type.
266type FunctionDefinition = shared.FunctionDefinition
267
268// This is an alias to an internal type.
269type FunctionDefinitionParam = shared.FunctionDefinitionParam
270
271// The parameters the functions accepts, described as a JSON Schema object. See the
272// [guide](https://platform.openai.com/docs/guides/function-calling) for examples,
273// and the
274// [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for
275// documentation about the format.
276//
277// Omitting `parameters` defines a function with an empty parameter list.
278//
279// This is an alias to an internal type.
280type FunctionParameters = shared.FunctionParameters
281
282// Set of 16 key-value pairs that can be attached to an object. This can be useful
283// for storing additional information about the object in a structured format, and
284// querying for objects via API or the dashboard.
285//
286// Keys are strings with a maximum length of 64 characters. Values are strings with
287// a maximum length of 512 characters.
288//
289// This is an alias to an internal type.
290type Metadata = shared.Metadata
291
292// **o-series models only**
293//
294// Configuration options for
295// [reasoning models](https://platform.openai.com/docs/guides/reasoning).
296//
297// This is an alias to an internal type.
298type Reasoning = shared.Reasoning
299
300// **Deprecated:** use `summary` instead.
301//
302// A summary of the reasoning performed by the model. This can be useful for
303// debugging and understanding the model's reasoning process. One of `auto`,
304// `concise`, or `detailed`.
305//
306// This is an alias to an internal type.
307type ReasoningGenerateSummary = shared.ReasoningGenerateSummary
308
309// Equals "auto"
310const ReasoningGenerateSummaryAuto = shared.ReasoningGenerateSummaryAuto
311
312// Equals "concise"
313const ReasoningGenerateSummaryConcise = shared.ReasoningGenerateSummaryConcise
314
315// Equals "detailed"
316const ReasoningGenerateSummaryDetailed = shared.ReasoningGenerateSummaryDetailed
317
318// A summary of the reasoning performed by the model. This can be useful for
319// debugging and understanding the model's reasoning process. One of `auto`,
320// `concise`, or `detailed`.
321//
322// This is an alias to an internal type.
323type ReasoningSummary = shared.ReasoningSummary
324
325// Equals "auto"
326const ReasoningSummaryAuto = shared.ReasoningSummaryAuto
327
328// Equals "concise"
329const ReasoningSummaryConcise = shared.ReasoningSummaryConcise
330
331// Equals "detailed"
332const ReasoningSummaryDetailed = shared.ReasoningSummaryDetailed
333
334// **o-series models only**
335//
336// Configuration options for
337// [reasoning models](https://platform.openai.com/docs/guides/reasoning).
338//
339// This is an alias to an internal type.
340type ReasoningParam = shared.ReasoningParam
341
342// **o-series models only**
343//
344// Constrains effort on reasoning for
345// [reasoning models](https://platform.openai.com/docs/guides/reasoning). Currently
346// supported values are `low`, `medium`, and `high`. Reducing reasoning effort can
347// result in faster responses and fewer tokens used on reasoning in a response.
348//
349// This is an alias to an internal type.
350type ReasoningEffort = shared.ReasoningEffort
351
352// Equals "low"
353const ReasoningEffortLow = shared.ReasoningEffortLow
354
355// Equals "medium"
356const ReasoningEffortMedium = shared.ReasoningEffortMedium
357
358// Equals "high"
359const ReasoningEffortHigh = shared.ReasoningEffortHigh
360
361// JSON object response format. An older method of generating JSON responses. Using
362// `json_schema` is recommended for models that support it. Note that the model
363// will not generate JSON without a system or user message instructing it to do so.
364//
365// This is an alias to an internal type.
366type ResponseFormatJSONObject = shared.ResponseFormatJSONObject
367
368// JSON object response format. An older method of generating JSON responses. Using
369// `json_schema` is recommended for models that support it. Note that the model
370// will not generate JSON without a system or user message instructing it to do so.
371//
372// This is an alias to an internal type.
373type ResponseFormatJSONObjectParam = shared.ResponseFormatJSONObjectParam
374
375// JSON Schema response format. Used to generate structured JSON responses. Learn
376// more about
377// [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs).
378//
379// This is an alias to an internal type.
380type ResponseFormatJSONSchema = shared.ResponseFormatJSONSchema
381
382// Structured Outputs configuration options, including a JSON Schema.
383//
384// This is an alias to an internal type.
385type ResponseFormatJSONSchemaJSONSchema = shared.ResponseFormatJSONSchemaJSONSchema
386
387// JSON Schema response format. Used to generate structured JSON responses. Learn
388// more about
389// [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs).
390//
391// This is an alias to an internal type.
392type ResponseFormatJSONSchemaParam = shared.ResponseFormatJSONSchemaParam
393
394// Structured Outputs configuration options, including a JSON Schema.
395//
396// This is an alias to an internal type.
397type ResponseFormatJSONSchemaJSONSchemaParam = shared.ResponseFormatJSONSchemaJSONSchemaParam
398
399// Default response format. Used to generate text responses.
400//
401// This is an alias to an internal type.
402type ResponseFormatText = shared.ResponseFormatText
403
404// Default response format. Used to generate text responses.
405//
406// This is an alias to an internal type.
407type ResponseFormatTextParam = shared.ResponseFormatTextParam
408
409// This is an alias to an internal type.
410type ResponsesModel = shared.ResponsesModel
411
412// Equals "o1-pro"
413const ResponsesModelO1Pro = shared.ResponsesModelO1Pro
414
415// Equals "o1-pro-2025-03-19"
416const ResponsesModelO1Pro2025_03_19 = shared.ResponsesModelO1Pro2025_03_19
417
418// Equals "o3-pro"
419const ResponsesModelO3Pro = shared.ResponsesModelO3Pro
420
421// Equals "o3-pro-2025-06-10"
422const ResponsesModelO3Pro2025_06_10 = shared.ResponsesModelO3Pro2025_06_10
423
424// Equals "o3-deep-research"
425const ResponsesModelO3DeepResearch = shared.ResponsesModelO3DeepResearch
426
427// Equals "o3-deep-research-2025-06-26"
428const ResponsesModelO3DeepResearch2025_06_26 = shared.ResponsesModelO3DeepResearch2025_06_26
429
430// Equals "o4-mini-deep-research"
431const ResponsesModelO4MiniDeepResearch = shared.ResponsesModelO4MiniDeepResearch
432
433// Equals "o4-mini-deep-research-2025-06-26"
434const ResponsesModelO4MiniDeepResearch2025_06_26 = shared.ResponsesModelO4MiniDeepResearch2025_06_26
435
436// Equals "computer-use-preview"
437const ResponsesModelComputerUsePreview = shared.ResponsesModelComputerUsePreview
438
439// Equals "computer-use-preview-2025-03-11"
440const ResponsesModelComputerUsePreview2025_03_11 = shared.ResponsesModelComputerUsePreview2025_03_11