resources/$shared/index.md +0 −796 deleted
File Deleted View Diff
1# Shared
2
3## Domain Types
4
5### All Models
6
7- `AllModels = string or "gpt-5.4" or "gpt-5.4-mini" or "gpt-5.4-nano" or 75 more or "o1-pro" or "o1-pro-2025-03-19" or "o3-pro" or 11 more`
8
9 - `string`
10
11 - `"gpt-5.4" or "gpt-5.4-mini" or "gpt-5.4-nano" or 75 more`
12
13 - `"gpt-5.4"`
14
15 - `"gpt-5.4-mini"`
16
17 - `"gpt-5.4-nano"`
18
19 - `"gpt-5.4-mini-2026-03-17"`
20
21 - `"gpt-5.4-nano-2026-03-17"`
22
23 - `"gpt-5.3-chat-latest"`
24
25 - `"gpt-5.2"`
26
27 - `"gpt-5.2-2025-12-11"`
28
29 - `"gpt-5.2-chat-latest"`
30
31 - `"gpt-5.2-pro"`
32
33 - `"gpt-5.2-pro-2025-12-11"`
34
35 - `"gpt-5.1"`
36
37 - `"gpt-5.1-2025-11-13"`
38
39 - `"gpt-5.1-codex"`
40
41 - `"gpt-5.1-mini"`
42
43 - `"gpt-5.1-chat-latest"`
44
45 - `"gpt-5"`
46
47 - `"gpt-5-mini"`
48
49 - `"gpt-5-nano"`
50
51 - `"gpt-5-2025-08-07"`
52
53 - `"gpt-5-mini-2025-08-07"`
54
55 - `"gpt-5-nano-2025-08-07"`
56
57 - `"gpt-5-chat-latest"`
58
59 - `"gpt-4.1"`
60
61 - `"gpt-4.1-mini"`
62
63 - `"gpt-4.1-nano"`
64
65 - `"gpt-4.1-2025-04-14"`
66
67 - `"gpt-4.1-mini-2025-04-14"`
68
69 - `"gpt-4.1-nano-2025-04-14"`
70
71 - `"o4-mini"`
72
73 - `"o4-mini-2025-04-16"`
74
75 - `"o3"`
76
77 - `"o3-2025-04-16"`
78
79 - `"o3-mini"`
80
81 - `"o3-mini-2025-01-31"`
82
83 - `"o1"`
84
85 - `"o1-2024-12-17"`
86
87 - `"o1-preview"`
88
89 - `"o1-preview-2024-09-12"`
90
91 - `"o1-mini"`
92
93 - `"o1-mini-2024-09-12"`
94
95 - `"gpt-4o"`
96
97 - `"gpt-4o-2024-11-20"`
98
99 - `"gpt-4o-2024-08-06"`
100
101 - `"gpt-4o-2024-05-13"`
102
103 - `"gpt-4o-audio-preview"`
104
105 - `"gpt-4o-audio-preview-2024-10-01"`
106
107 - `"gpt-4o-audio-preview-2024-12-17"`
108
109 - `"gpt-4o-audio-preview-2025-06-03"`
110
111 - `"gpt-4o-mini-audio-preview"`
112
113 - `"gpt-4o-mini-audio-preview-2024-12-17"`
114
115 - `"gpt-4o-search-preview"`
116
117 - `"gpt-4o-mini-search-preview"`
118
119 - `"gpt-4o-search-preview-2025-03-11"`
120
121 - `"gpt-4o-mini-search-preview-2025-03-11"`
122
123 - `"chatgpt-4o-latest"`
124
125 - `"codex-mini-latest"`
126
127 - `"gpt-4o-mini"`
128
129 - `"gpt-4o-mini-2024-07-18"`
130
131 - `"gpt-4-turbo"`
132
133 - `"gpt-4-turbo-2024-04-09"`
134
135 - `"gpt-4-0125-preview"`
136
137 - `"gpt-4-turbo-preview"`
138
139 - `"gpt-4-1106-preview"`
140
141 - `"gpt-4-vision-preview"`
142
143 - `"gpt-4"`
144
145 - `"gpt-4-0314"`
146
147 - `"gpt-4-0613"`
148
149 - `"gpt-4-32k"`
150
151 - `"gpt-4-32k-0314"`
152
153 - `"gpt-4-32k-0613"`
154
155 - `"gpt-3.5-turbo"`
156
157 - `"gpt-3.5-turbo-16k"`
158
159 - `"gpt-3.5-turbo-0301"`
160
161 - `"gpt-3.5-turbo-0613"`
162
163 - `"gpt-3.5-turbo-1106"`
164
165 - `"gpt-3.5-turbo-0125"`
166
167 - `"gpt-3.5-turbo-16k-0613"`
168
169 - `ResponsesOnlyModel = "o1-pro" or "o1-pro-2025-03-19" or "o3-pro" or 11 more`
170
171 - `"o1-pro"`
172
173 - `"o1-pro-2025-03-19"`
174
175 - `"o3-pro"`
176
177 - `"o3-pro-2025-06-10"`
178
179 - `"o3-deep-research"`
180
181 - `"o3-deep-research-2025-06-26"`
182
183 - `"o4-mini-deep-research"`
184
185 - `"o4-mini-deep-research-2025-06-26"`
186
187 - `"computer-use-preview"`
188
189 - `"computer-use-preview-2025-03-11"`
190
191 - `"gpt-5-codex"`
192
193 - `"gpt-5-pro"`
194
195 - `"gpt-5-pro-2025-10-06"`
196
197 - `"gpt-5.1-codex-max"`
198
199### Comparison Filter
200
201- `ComparisonFilter object { key, type, value }`
202
203 A filter used to compare a specified attribute key to a given value using a defined comparison operation.
204
205 - `key: string`
206
207 The key to compare against the value.
208
209 - `type: "eq" or "ne" or "gt" or 5 more`
210
211 Specifies the comparison operator: `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `in`, `nin`.
212
213 - `eq`: equals
214 - `ne`: not equal
215 - `gt`: greater than
216 - `gte`: greater than or equal
217 - `lt`: less than
218 - `lte`: less than or equal
219 - `in`: in
220 - `nin`: not in
221
222 - `"eq"`
223
224 - `"ne"`
225
226 - `"gt"`
227
228 - `"gte"`
229
230 - `"lt"`
231
232 - `"lte"`
233
234 - `"in"`
235
236 - `"nin"`
237
238 - `value: string or number or boolean or array of string or number`
239
240 The value to compare against the attribute key; supports string, number, or boolean types.
241
242 - `string`
243
244 - `number`
245
246 - `boolean`
247
248 - `array of string or number`
249
250 - `string`
251
252 - `number`
253
254### Compound Filter
255
256- `CompoundFilter object { filters, type }`
257
258 Combine multiple filters using `and` or `or`.
259
260 - `filters: array of ComparisonFilter or unknown`
261
262 Array of filters to combine. Items can be `ComparisonFilter` or `CompoundFilter`.
263
264 - `ComparisonFilter object { key, type, value }`
265
266 A filter used to compare a specified attribute key to a given value using a defined comparison operation.
267
268 - `key: string`
269
270 The key to compare against the value.
271
272 - `type: "eq" or "ne" or "gt" or 5 more`
273
274 Specifies the comparison operator: `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `in`, `nin`.
275
276 - `eq`: equals
277 - `ne`: not equal
278 - `gt`: greater than
279 - `gte`: greater than or equal
280 - `lt`: less than
281 - `lte`: less than or equal
282 - `in`: in
283 - `nin`: not in
284
285 - `"eq"`
286
287 - `"ne"`
288
289 - `"gt"`
290
291 - `"gte"`
292
293 - `"lt"`
294
295 - `"lte"`
296
297 - `"in"`
298
299 - `"nin"`
300
301 - `value: string or number or boolean or array of string or number`
302
303 The value to compare against the attribute key; supports string, number, or boolean types.
304
305 - `string`
306
307 - `number`
308
309 - `boolean`
310
311 - `array of string or number`
312
313 - `string`
314
315 - `number`
316
317 - `unknown`
318
319 - `type: "and" or "or"`
320
321 Type of operation: `and` or `or`.
322
323 - `"and"`
324
325 - `"or"`
326
327### Custom Tool Input Format
328
329- `CustomToolInputFormat = object { type } or object { definition, syntax, type }`
330
331 The input format for the custom tool. Default is unconstrained text.
332
333 - `Text object { type }`
334
335 Unconstrained free-form text.
336
337 - `type: "text"`
338
339 Unconstrained text format. Always `text`.
340
341 - `"text"`
342
343 - `Grammar object { definition, syntax, type }`
344
345 A grammar defined by the user.
346
347 - `definition: string`
348
349 The grammar definition.
350
351 - `syntax: "lark" or "regex"`
352
353 The syntax of the grammar definition. One of `lark` or `regex`.
354
355 - `"lark"`
356
357 - `"regex"`
358
359 - `type: "grammar"`
360
361 Grammar format. Always `grammar`.
362
363 - `"grammar"`
364
365### Error Object
366
367- `ErrorObject object { code, message, param, type }`
368
369 - `code: string`
370
371 - `message: string`
372
373 - `param: string`
374
375 - `type: string`
376
377### Function Definition
378
379- `FunctionDefinition object { name, description, parameters, strict }`
380
381 - `name: string`
382
383 The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.
384
385 - `description: optional string`
386
387 A description of what the function does, used by the model to choose when and how to call the function.
388
389 - `parameters: optional FunctionParameters`
390
391 The parameters the functions accepts, described as a JSON Schema object. See the [guide](/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format.
392
393 Omitting `parameters` defines a function with an empty parameter list.
394
395 - `strict: optional boolean`
396
397 Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the `parameters` field. Only a subset of JSON Schema is supported when `strict` is `true`. Learn more about Structured Outputs in the [function calling guide](/docs/guides/function-calling).
398
399### Function Parameters
400
401- `FunctionParameters = map[unknown]`
402
403 The parameters the functions accepts, described as a JSON Schema object. See the [guide](/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format.
404
405 Omitting `parameters` defines a function with an empty parameter list.
406
407### Metadata
408
409- `Metadata = map[string]`
410
411 Set of 16 key-value pairs that can be attached to an object. This can be
412 useful for storing additional information about the object in a structured
413 format, and querying for objects via API or the dashboard.
414
415 Keys are strings with a maximum length of 64 characters. Values are strings
416 with a maximum length of 512 characters.
417
418### Reasoning
419
420- `Reasoning object { effort, generate_summary, summary }`
421
422 **gpt-5 and o-series models only**
423
424 Configuration options for
425 [reasoning models](https://platform.openai.com/docs/guides/reasoning).
426
427 - `effort: optional ReasoningEffort`
428
429 Constrains effort on reasoning for
430 [reasoning models](https://platform.openai.com/docs/guides/reasoning).
431 Currently supported values are `none`, `minimal`, `low`, `medium`, `high`, and `xhigh`. Reducing
432 reasoning effort can result in faster responses and fewer tokens used
433 on reasoning in a response.
434
435 - `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.
436 - All models before `gpt-5.1` default to `medium` reasoning effort, and do not support `none`.
437 - The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort.
438 - `xhigh` is supported for all models after `gpt-5.1-codex-max`.
439
440 - `"none"`
441
442 - `"minimal"`
443
444 - `"low"`
445
446 - `"medium"`
447
448 - `"high"`
449
450 - `"xhigh"`
451
452 - `generate_summary: optional "auto" or "concise" or "detailed"`
453
454 **Deprecated:** use `summary` instead.
455
456 A summary of the reasoning performed by the model. This can be
457 useful for debugging and understanding the model's reasoning process.
458 One of `auto`, `concise`, or `detailed`.
459
460 - `"auto"`
461
462 - `"concise"`
463
464 - `"detailed"`
465
466 - `summary: optional "auto" or "concise" or "detailed"`
467
468 A summary of the reasoning performed by the model. This can be
469 useful for debugging and understanding the model's reasoning process.
470 One of `auto`, `concise`, or `detailed`.
471
472 `concise` is supported for `computer-use-preview` models and all reasoning models after `gpt-5`.
473
474 - `"auto"`
475
476 - `"concise"`
477
478 - `"detailed"`
479
480### Reasoning Effort
481
482- `ReasoningEffort = "none" or "minimal" or "low" or 3 more`
483
484 Constrains effort on reasoning for
485 [reasoning models](https://platform.openai.com/docs/guides/reasoning).
486 Currently supported values are `none`, `minimal`, `low`, `medium`, `high`, and `xhigh`. Reducing
487 reasoning effort can result in faster responses and fewer tokens used
488 on reasoning in a response.
489
490 - `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.
491 - All models before `gpt-5.1` default to `medium` reasoning effort, and do not support `none`.
492 - The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort.
493 - `xhigh` is supported for all models after `gpt-5.1-codex-max`.
494
495 - `"none"`
496
497 - `"minimal"`
498
499 - `"low"`
500
501 - `"medium"`
502
503 - `"high"`
504
505 - `"xhigh"`
506
507### Response Format JSON Object
508
509- `ResponseFormatJSONObject object { type }`
510
511 JSON object response format. An older method of generating JSON responses.
512 Using `json_schema` is recommended for models that support it. Note that the
513 model will not generate JSON without a system or user message instructing it
514 to do so.
515
516 - `type: "json_object"`
517
518 The type of response format being defined. Always `json_object`.
519
520 - `"json_object"`
521
522### Response Format JSON Schema
523
524- `ResponseFormatJSONSchema object { json_schema, type }`
525
526 JSON Schema response format. Used to generate structured JSON responses.
527 Learn more about [Structured Outputs](/docs/guides/structured-outputs).
528
529 - `json_schema: object { name, description, schema, strict }`
530
531 Structured Outputs configuration options, including a JSON Schema.
532
533 - `name: string`
534
535 The name of the response format. Must be a-z, A-Z, 0-9, or contain
536 underscores and dashes, with a maximum length of 64.
537
538 - `description: optional string`
539
540 A description of what the response format is for, used by the model to
541 determine how to respond in the format.
542
543 - `schema: optional map[unknown]`
544
545 The schema for the response format, described as a JSON Schema object.
546 Learn how to build JSON schemas [here](https://json-schema.org/).
547
548 - `strict: optional boolean`
549
550 Whether to enable strict schema adherence when generating the output.
551 If set to true, the model will always follow the exact schema defined
552 in the `schema` field. Only a subset of JSON Schema is supported when
553 `strict` is `true`. To learn more, read the [Structured Outputs
554 guide](/docs/guides/structured-outputs).
555
556 - `type: "json_schema"`
557
558 The type of response format being defined. Always `json_schema`.
559
560 - `"json_schema"`
561
562### Response Format Text
563
564- `ResponseFormatText object { type }`
565
566 Default response format. Used to generate text responses.
567
568 - `type: "text"`
569
570 The type of response format being defined. Always `text`.
571
572 - `"text"`
573
574### Response Format Text Grammar
575
576- `ResponseFormatTextGrammar object { grammar, type }`
577
578 A custom grammar for the model to follow when generating text.
579 Learn more in the [custom grammars guide](/docs/guides/custom-grammars).
580
581 - `grammar: string`
582
583 The custom grammar for the model to follow.
584
585 - `type: "grammar"`
586
587 The type of response format being defined. Always `grammar`.
588
589 - `"grammar"`
590
591### Response Format Text Python
592
593- `ResponseFormatTextPython object { type }`
594
595 Configure the model to generate valid Python code. See the
596 [custom grammars guide](/docs/guides/custom-grammars) for more details.
597
598 - `type: "python"`
599
600 The type of response format being defined. Always `python`.
601
602 - `"python"`
603
604### Responses Model
605
606- `ResponsesModel = string or "gpt-5.4" or "gpt-5.4-mini" or "gpt-5.4-nano" or 75 more or "o1-pro" or "o1-pro-2025-03-19" or "o3-pro" or 11 more`
607
608 - `string`
609
610 - `"gpt-5.4" or "gpt-5.4-mini" or "gpt-5.4-nano" or 75 more`
611
612 - `"gpt-5.4"`
613
614 - `"gpt-5.4-mini"`
615
616 - `"gpt-5.4-nano"`
617
618 - `"gpt-5.4-mini-2026-03-17"`
619
620 - `"gpt-5.4-nano-2026-03-17"`
621
622 - `"gpt-5.3-chat-latest"`
623
624 - `"gpt-5.2"`
625
626 - `"gpt-5.2-2025-12-11"`
627
628 - `"gpt-5.2-chat-latest"`
629
630 - `"gpt-5.2-pro"`
631
632 - `"gpt-5.2-pro-2025-12-11"`
633
634 - `"gpt-5.1"`
635
636 - `"gpt-5.1-2025-11-13"`
637
638 - `"gpt-5.1-codex"`
639
640 - `"gpt-5.1-mini"`
641
642 - `"gpt-5.1-chat-latest"`
643
644 - `"gpt-5"`
645
646 - `"gpt-5-mini"`
647
648 - `"gpt-5-nano"`
649
650 - `"gpt-5-2025-08-07"`
651
652 - `"gpt-5-mini-2025-08-07"`
653
654 - `"gpt-5-nano-2025-08-07"`
655
656 - `"gpt-5-chat-latest"`
657
658 - `"gpt-4.1"`
659
660 - `"gpt-4.1-mini"`
661
662 - `"gpt-4.1-nano"`
663
664 - `"gpt-4.1-2025-04-14"`
665
666 - `"gpt-4.1-mini-2025-04-14"`
667
668 - `"gpt-4.1-nano-2025-04-14"`
669
670 - `"o4-mini"`
671
672 - `"o4-mini-2025-04-16"`
673
674 - `"o3"`
675
676 - `"o3-2025-04-16"`
677
678 - `"o3-mini"`
679
680 - `"o3-mini-2025-01-31"`
681
682 - `"o1"`
683
684 - `"o1-2024-12-17"`
685
686 - `"o1-preview"`
687
688 - `"o1-preview-2024-09-12"`
689
690 - `"o1-mini"`
691
692 - `"o1-mini-2024-09-12"`
693
694 - `"gpt-4o"`
695
696 - `"gpt-4o-2024-11-20"`
697
698 - `"gpt-4o-2024-08-06"`
699
700 - `"gpt-4o-2024-05-13"`
701
702 - `"gpt-4o-audio-preview"`
703
704 - `"gpt-4o-audio-preview-2024-10-01"`
705
706 - `"gpt-4o-audio-preview-2024-12-17"`
707
708 - `"gpt-4o-audio-preview-2025-06-03"`
709
710 - `"gpt-4o-mini-audio-preview"`
711
712 - `"gpt-4o-mini-audio-preview-2024-12-17"`
713
714 - `"gpt-4o-search-preview"`
715
716 - `"gpt-4o-mini-search-preview"`
717
718 - `"gpt-4o-search-preview-2025-03-11"`
719
720 - `"gpt-4o-mini-search-preview-2025-03-11"`
721
722 - `"chatgpt-4o-latest"`
723
724 - `"codex-mini-latest"`
725
726 - `"gpt-4o-mini"`
727
728 - `"gpt-4o-mini-2024-07-18"`
729
730 - `"gpt-4-turbo"`
731
732 - `"gpt-4-turbo-2024-04-09"`
733
734 - `"gpt-4-0125-preview"`
735
736 - `"gpt-4-turbo-preview"`
737
738 - `"gpt-4-1106-preview"`
739
740 - `"gpt-4-vision-preview"`
741
742 - `"gpt-4"`
743
744 - `"gpt-4-0314"`
745
746 - `"gpt-4-0613"`
747
748 - `"gpt-4-32k"`
749
750 - `"gpt-4-32k-0314"`
751
752 - `"gpt-4-32k-0613"`
753
754 - `"gpt-3.5-turbo"`
755
756 - `"gpt-3.5-turbo-16k"`
757
758 - `"gpt-3.5-turbo-0301"`
759
760 - `"gpt-3.5-turbo-0613"`
761
762 - `"gpt-3.5-turbo-1106"`
763
764 - `"gpt-3.5-turbo-0125"`
765
766 - `"gpt-3.5-turbo-16k-0613"`
767
768 - `ResponsesOnlyModel = "o1-pro" or "o1-pro-2025-03-19" or "o3-pro" or 11 more`
769
770 - `"o1-pro"`
771
772 - `"o1-pro-2025-03-19"`
773
774 - `"o3-pro"`
775
776 - `"o3-pro-2025-06-10"`
777
778 - `"o3-deep-research"`
779
780 - `"o3-deep-research-2025-06-26"`
781
782 - `"o4-mini-deep-research"`
783
784 - `"o4-mini-deep-research-2025-06-26"`
785
786 - `"computer-use-preview"`
787
788 - `"computer-use-preview-2025-03-11"`
789
790 - `"gpt-5-codex"`
791
792 - `"gpt-5-pro"`
793
794 - `"gpt-5-pro-2025-10-06"`
795
796 - `"gpt-5.1-codex-max"`