Shared

Domain Types

All Models

AllModels = String | ChatModel | :"o1-pro" | :"o1-pro-2025-03-19" | :"o3-pro" | 11 more
- String = String
- ChatModel = :"gpt-5.4" | :"gpt-5.4-mini" | :"gpt-5.4-nano" | 75 more
  - :"gpt-5.4"
  - :"gpt-5.4-mini"
  - :"gpt-5.4-nano"
  - :"gpt-5.4-mini-2026-03-17"
  - :"gpt-5.4-nano-2026-03-17"
  - :"gpt-5.3-chat-latest"
  - :"gpt-5.2"
  - :"gpt-5.2-2025-12-11"
  - :"gpt-5.2-chat-latest"
  - :"gpt-5.2-pro"
  - :"gpt-5.2-pro-2025-12-11"
  - :"gpt-5.1"
  - :"gpt-5.1-2025-11-13"
  - :"gpt-5.1-codex"
  - :"gpt-5.1-mini"
  - :"gpt-5.1-chat-latest"
  - :"gpt-5"
  - :"gpt-5-mini"
  - :"gpt-5-nano"
  - :"gpt-5-2025-08-07"
  - :"gpt-5-mini-2025-08-07"
  - :"gpt-5-nano-2025-08-07"
  - :"gpt-5-chat-latest"
  - :"gpt-4.1"
  - :"gpt-4.1-mini"
  - :"gpt-4.1-nano"
  - :"gpt-4.1-2025-04-14"
  - :"gpt-4.1-mini-2025-04-14"
  - :"gpt-4.1-nano-2025-04-14"
  - :"o4-mini"
  - :"o4-mini-2025-04-16"
  - :o3
  - :"o3-2025-04-16"
  - :"o3-mini"
  - :"o3-mini-2025-01-31"
  - :o1
  - :"o1-2024-12-17"
  - :"o1-preview"
  - :"o1-preview-2024-09-12"
  - :"o1-mini"
  - :"o1-mini-2024-09-12"
  - :"gpt-4o"
  - :"gpt-4o-2024-11-20"
  - :"gpt-4o-2024-08-06"
  - :"gpt-4o-2024-05-13"
  - :"gpt-4o-audio-preview"
  - :"gpt-4o-audio-preview-2024-10-01"
  - :"gpt-4o-audio-preview-2024-12-17"
  - :"gpt-4o-audio-preview-2025-06-03"
  - :"gpt-4o-mini-audio-preview"
  - :"gpt-4o-mini-audio-preview-2024-12-17"
  - :"gpt-4o-search-preview"
  - :"gpt-4o-mini-search-preview"
  - :"gpt-4o-search-preview-2025-03-11"
  - :"gpt-4o-mini-search-preview-2025-03-11"
  - :"chatgpt-4o-latest"
  - :"codex-mini-latest"
  - :"gpt-4o-mini"
  - :"gpt-4o-mini-2024-07-18"
  - :"gpt-4-turbo"
  - :"gpt-4-turbo-2024-04-09"
  - :"gpt-4-0125-preview"
  - :"gpt-4-turbo-preview"
  - :"gpt-4-1106-preview"
  - :"gpt-4-vision-preview"
  - :"gpt-4"
  - :"gpt-4-0314"
  - :"gpt-4-0613"
  - :"gpt-4-32k"
  - :"gpt-4-32k-0314"
  - :"gpt-4-32k-0613"
  - :"gpt-3.5-turbo"
  - :"gpt-3.5-turbo-16k"
  - :"gpt-3.5-turbo-0301"
  - :"gpt-3.5-turbo-0613"
  - :"gpt-3.5-turbo-1106"
  - :"gpt-3.5-turbo-0125"
  - :"gpt-3.5-turbo-16k-0613"
- ResponsesOnlyModel = :"o1-pro" | :"o1-pro-2025-03-19" | :"o3-pro" | 11 more
  - :"o1-pro"
  - :"o1-pro-2025-03-19"
  - :"o3-pro"
  - :"o3-pro-2025-06-10"
  - :"o3-deep-research"
  - :"o3-deep-research-2025-06-26"
  - :"o4-mini-deep-research"
  - :"o4-mini-deep-research-2025-06-26"
  - :"computer-use-preview"
  - :"computer-use-preview-2025-03-11"
  - :"gpt-5-codex"
  - :"gpt-5-pro"
  - :"gpt-5-pro-2025-10-06"
  - :"gpt-5.1-codex-max"

Chat Model

ChatModel = :"gpt-5.4" | :"gpt-5.4-mini" | :"gpt-5.4-nano" | 75 more
- :"gpt-5.4"
- :"gpt-5.4-mini"
- :"gpt-5.4-nano"
- :"gpt-5.4-mini-2026-03-17"
- :"gpt-5.4-nano-2026-03-17"
- :"gpt-5.3-chat-latest"
- :"gpt-5.2"
- :"gpt-5.2-2025-12-11"
- :"gpt-5.2-chat-latest"
- :"gpt-5.2-pro"
- :"gpt-5.2-pro-2025-12-11"
- :"gpt-5.1"
- :"gpt-5.1-2025-11-13"
- :"gpt-5.1-codex"
- :"gpt-5.1-mini"
- :"gpt-5.1-chat-latest"
- :"gpt-5"
- :"gpt-5-mini"
- :"gpt-5-nano"
- :"gpt-5-2025-08-07"
- :"gpt-5-mini-2025-08-07"
- :"gpt-5-nano-2025-08-07"
- :"gpt-5-chat-latest"
- :"gpt-4.1"
- :"gpt-4.1-mini"
- :"gpt-4.1-nano"
- :"gpt-4.1-2025-04-14"
- :"gpt-4.1-mini-2025-04-14"
- :"gpt-4.1-nano-2025-04-14"
- :"o4-mini"
- :"o4-mini-2025-04-16"
- :o3
- :"o3-2025-04-16"
- :"o3-mini"
- :"o3-mini-2025-01-31"
- :o1
- :"o1-2024-12-17"
- :"o1-preview"
- :"o1-preview-2024-09-12"
- :"o1-mini"
- :"o1-mini-2024-09-12"
- :"gpt-4o"
- :"gpt-4o-2024-11-20"
- :"gpt-4o-2024-08-06"
- :"gpt-4o-2024-05-13"
- :"gpt-4o-audio-preview"
- :"gpt-4o-audio-preview-2024-10-01"
- :"gpt-4o-audio-preview-2024-12-17"
- :"gpt-4o-audio-preview-2025-06-03"
- :"gpt-4o-mini-audio-preview"
- :"gpt-4o-mini-audio-preview-2024-12-17"
- :"gpt-4o-search-preview"
- :"gpt-4o-mini-search-preview"
- :"gpt-4o-search-preview-2025-03-11"
- :"gpt-4o-mini-search-preview-2025-03-11"
- :"chatgpt-4o-latest"
- :"codex-mini-latest"
- :"gpt-4o-mini"
- :"gpt-4o-mini-2024-07-18"
- :"gpt-4-turbo"
- :"gpt-4-turbo-2024-04-09"
- :"gpt-4-0125-preview"
- :"gpt-4-turbo-preview"
- :"gpt-4-1106-preview"
- :"gpt-4-vision-preview"
- :"gpt-4"
- :"gpt-4-0314"
- :"gpt-4-0613"
- :"gpt-4-32k"
- :"gpt-4-32k-0314"
- :"gpt-4-32k-0613"
- :"gpt-3.5-turbo"
- :"gpt-3.5-turbo-16k"
- :"gpt-3.5-turbo-0301"
- :"gpt-3.5-turbo-0613"
- :"gpt-3.5-turbo-1106"
- :"gpt-3.5-turbo-0125"
- :"gpt-3.5-turbo-16k-0613"

Comparison Filter

class ComparisonFilter

A filter used to compare a specified attribute key to a given value using a defined comparison operation.
- key: String
  
  The key to compare against the value.
- type: :eq | :ne | :gt | 5 more
  
  Specifies the comparison operator: eq, ne, gt, gte, lt, lte, in, nin.
  - eq: equals
  - ne: not equal
  - gt: greater than
  - gte: greater than or equal
  - lt: less than
  - lte: less than or equal
  - in: in
  - nin: not in
  - :eq
  - :ne
  - :gt
  - :gte
  - :lt
  - :lte
  - :in
  - :nin
- value: String | Float | bool | Array[String | Float]
  
  The value to compare against the attribute key; supports string, number, or boolean types.
  - String = String
  - Float = Float
  - UnionMember2 = bool
  - UnionMember3 = Array[String | Float]
    - String = String
    - Float = Float

Compound Filter

class CompoundFilter

Combine multiple filters using and or or.
- filters: Array[ComparisonFilter | untyped]
  
  Array of filters to combine. Items can be ComparisonFilter or CompoundFilter.
  - class ComparisonFilter
    
    A filter used to compare a specified attribute key to a given value using a defined comparison operation.
    - key: String
      
      The key to compare against the value.
    - type: :eq | :ne | :gt | 5 more
      
      Specifies the comparison operator: eq, ne, gt, gte, lt, lte, in, nin.
      - eq: equals
      - ne: not equal
      - gt: greater than
      - gte: greater than or equal
      - lt: less than
      - lte: less than or equal
      - in: in
      - nin: not in
      - :eq
      - :ne
      - :gt
      - :gte
      - :lt
      - :lte
      - :in
      - :nin
    - value: String | Float | bool | Array[String | Float]
      
      The value to compare against the attribute key; supports string, number, or boolean types.
      - String = String
      - Float = Float
      - UnionMember2 = bool
      - UnionMember3 = Array[String | Float]
        
        String = String
        
        Float = Float
  - UnionMember1 = untyped
- type: :and | :or
  
  Type of operation: and or or.
  - :and
  - :or

Custom Tool Input Format

CustomToolInputFormat = Text{ type} | Grammar{ definition, syntax, type}

The input format for the custom tool. Default is unconstrained text.
- class Text
  
  Unconstrained free-form text.
  - type: :text
    
    Unconstrained text format. Always text.
    - :text
- class Grammar
  
  A grammar defined by the user.
  - definition: String
    
    The grammar definition.
  - syntax: :lark | :regex
    
    The syntax of the grammar definition. One of lark or regex.
    - :lark
    - :regex
  - type: :grammar
    
    Grammar format. Always grammar.
    - :grammar

Error Object

class ErrorObject
- code: String
- message: String
- param: String
- type: String

Function Definition

class FunctionDefinition
- name: String
  
  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.
- description: String
  
  A description of what the function does, used by the model to choose when and how to call the function.
- parameters: FunctionParameters
  
  The parameters the functions accepts, described as a JSON Schema object. See the guide for examples, and the JSON Schema reference for documentation about the format.
  
  Omitting parameters defines a function with an empty parameter list.
- strict: bool
  
  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.

Function Parameters

FunctionParameters = Hash[Symbol, untyped]

The parameters the functions accepts, described as a JSON Schema object. See the guide for examples, and the JSON Schema reference for documentation about the format.

Omitting parameters defines a function with an empty parameter list.

Metadata

Metadata = Hash[Symbol, String]

Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.

Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.

OAuth Error Code

OAuthErrorCode = :invalid_grant | :invalid_subject_token | String
- OAuthErrorCode = :invalid_grant | :invalid_subject_token
  - :invalid_grant
  - :invalid_subject_token
- String = String

Reasoning

class Reasoning

gpt-5 and o-series models only

Configuration options for reasoning models.
- context: :auto | :current_turn | :all_turns
  
  Controls which reasoning items are rendered back to the model on later turns. When returned on a response, this is the effective reasoning context mode used for the response.
  - :auto
  - :current_turn
  - :all_turns
- effort: ReasoningEffort
  
  Constrains effort on reasoning for reasoning models. Currently supported values are none, minimal, low, medium, high, and xhigh. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.
  - 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.
  - All models before gpt-5.1 default to medium reasoning effort, and do not support none.
  - The gpt-5-pro model defaults to (and only supports) high reasoning effort.
  - xhigh is supported for all models after gpt-5.1-codex-max.
  - :none
  - :minimal
  - :low
  - :medium
  - :high
  - :xhigh
- generate_summary: :auto | :concise | :detailed
  
  Deprecated: use summary instead.
  
  A summary of the reasoning performed by the model. This can be useful for debugging and understanding the model's reasoning process. One of auto, concise, or detailed.
  - :auto
  - :concise
  - :detailed
- summary: :auto | :concise | :detailed
  
  A summary of the reasoning performed by the model. This can be useful for debugging and understanding the model's reasoning process. One of auto, concise, or detailed.
  
  concise is supported for computer-use-preview models and all reasoning models after gpt-5.
  - :auto
  - :concise
  - :detailed

Reasoning Effort

ReasoningEffort = :none | :minimal | :low | 3 more

Constrains effort on reasoning for reasoning models. Currently supported values are none, minimal, low, medium, high, and xhigh. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.
- 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.
- All models before gpt-5.1 default to medium reasoning effort, and do not support none.
- The gpt-5-pro model defaults to (and only supports) high reasoning effort.
- xhigh is supported for all models after gpt-5.1-codex-max.
- :none
- :minimal
- :low
- :medium
- :high
- :xhigh

Response Format JSON Object

class ResponseFormatJSONObject

JSON object response format. An older method of generating JSON responses. Using json_schema is recommended for models that support it. Note that the model will not generate JSON without a system or user message instructing it to do so.
- type: :json_object
  
  The type of response format being defined. Always json_object.
  - :json_object

Response Format JSON Schema

class ResponseFormatJSONSchema

JSON Schema response format. Used to generate structured JSON responses. Learn more about Structured Outputs.
- json_schema: JSONSchema{ name, description, schema, strict}
  
  Structured Outputs configuration options, including a JSON Schema.
  - name: String
    
    The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.
  - description: String
    
    A description of what the response format is for, used by the model to determine how to respond in the format.
  - schema: Hash[Symbol, untyped]
    
    The schema for the response format, described as a JSON Schema object. Learn how to build JSON schemas here.
  - strict: bool
    
    Whether to enable strict schema adherence when generating the output. If set to true, the model will always follow the exact schema defined in the schema field. Only a subset of JSON Schema is supported when strict is true. To learn more, read the Structured Outputs guide.
- type: :json_schema
  
  The type of response format being defined. Always json_schema.
  - :json_schema

Response Format Text

class ResponseFormatText

Default response format. Used to generate text responses.
- type: :text
  
  The type of response format being defined. Always text.
  - :text

Response Format Text Grammar

class ResponseFormatTextGrammar

A custom grammar for the model to follow when generating text. Learn more in the custom grammars guide.
- grammar: String
  
  The custom grammar for the model to follow.
- type: :grammar
  
  The type of response format being defined. Always grammar.
  - :grammar

Response Format Text Python

class ResponseFormatTextPython

Configure the model to generate valid Python code. See the custom grammars guide for more details.
- type: :python
  
  The type of response format being defined. Always python.
  - :python

Responses Model

ResponsesModel = String | ChatModel | :"o1-pro" | :"o1-pro-2025-03-19" | :"o3-pro" | 11 more
- String = String
- ChatModel = :"gpt-5.4" | :"gpt-5.4-mini" | :"gpt-5.4-nano" | 75 more
  - :"gpt-5.4"
  - :"gpt-5.4-mini"
  - :"gpt-5.4-nano"
  - :"gpt-5.4-mini-2026-03-17"
  - :"gpt-5.4-nano-2026-03-17"
  - :"gpt-5.3-chat-latest"
  - :"gpt-5.2"
  - :"gpt-5.2-2025-12-11"
  - :"gpt-5.2-chat-latest"
  - :"gpt-5.2-pro"
  - :"gpt-5.2-pro-2025-12-11"
  - :"gpt-5.1"
  - :"gpt-5.1-2025-11-13"
  - :"gpt-5.1-codex"
  - :"gpt-5.1-mini"
  - :"gpt-5.1-chat-latest"
  - :"gpt-5"
  - :"gpt-5-mini"
  - :"gpt-5-nano"
  - :"gpt-5-2025-08-07"
  - :"gpt-5-mini-2025-08-07"
  - :"gpt-5-nano-2025-08-07"
  - :"gpt-5-chat-latest"
  - :"gpt-4.1"
  - :"gpt-4.1-mini"
  - :"gpt-4.1-nano"
  - :"gpt-4.1-2025-04-14"
  - :"gpt-4.1-mini-2025-04-14"
  - :"gpt-4.1-nano-2025-04-14"
  - :"o4-mini"
  - :"o4-mini-2025-04-16"
  - :o3
  - :"o3-2025-04-16"
  - :"o3-mini"
  - :"o3-mini-2025-01-31"
  - :o1
  - :"o1-2024-12-17"
  - :"o1-preview"
  - :"o1-preview-2024-09-12"
  - :"o1-mini"
  - :"o1-mini-2024-09-12"
  - :"gpt-4o"
  - :"gpt-4o-2024-11-20"
  - :"gpt-4o-2024-08-06"
  - :"gpt-4o-2024-05-13"
  - :"gpt-4o-audio-preview"
  - :"gpt-4o-audio-preview-2024-10-01"
  - :"gpt-4o-audio-preview-2024-12-17"
  - :"gpt-4o-audio-preview-2025-06-03"
  - :"gpt-4o-mini-audio-preview"
  - :"gpt-4o-mini-audio-preview-2024-12-17"
  - :"gpt-4o-search-preview"
  - :"gpt-4o-mini-search-preview"
  - :"gpt-4o-search-preview-2025-03-11"
  - :"gpt-4o-mini-search-preview-2025-03-11"
  - :"chatgpt-4o-latest"
  - :"codex-mini-latest"
  - :"gpt-4o-mini"
  - :"gpt-4o-mini-2024-07-18"
  - :"gpt-4-turbo"
  - :"gpt-4-turbo-2024-04-09"
  - :"gpt-4-0125-preview"
  - :"gpt-4-turbo-preview"
  - :"gpt-4-1106-preview"
  - :"gpt-4-vision-preview"
  - :"gpt-4"
  - :"gpt-4-0314"
  - :"gpt-4-0613"
  - :"gpt-4-32k"
  - :"gpt-4-32k-0314"
  - :"gpt-4-32k-0613"
  - :"gpt-3.5-turbo"
  - :"gpt-3.5-turbo-16k"
  - :"gpt-3.5-turbo-0301"
  - :"gpt-3.5-turbo-0613"
  - :"gpt-3.5-turbo-1106"
  - :"gpt-3.5-turbo-0125"
  - :"gpt-3.5-turbo-16k-0613"
- ResponsesOnlyModel = :"o1-pro" | :"o1-pro-2025-03-19" | :"o3-pro" | 11 more
  - :"o1-pro"
  - :"o1-pro-2025-03-19"
  - :"o3-pro"
  - :"o3-pro-2025-06-10"
  - :"o3-deep-research"
  - :"o3-deep-research-2025-06-26"
  - :"o4-mini-deep-research"
  - :"o4-mini-deep-research-2025-06-26"
  - :"computer-use-preview"
  - :"computer-use-preview-2025-03-11"
  - :"gpt-5-codex"
  - :"gpt-5-pro"
  - :"gpt-5-pro-2025-10-06"
  - :"gpt-5.1-codex-max"

ruby/resources/$shared/index.md +980 −0 created

1# Shared

3## Domain Types

5### All Models

9 - `String = String`

11 - `ChatModel = :"gpt-5.4" | :"gpt-5.4-mini" | :"gpt-5.4-nano" | 75 more`

13 - `:"gpt-5.4"`

15 - `:"gpt-5.4-mini"`

17 - `:"gpt-5.4-nano"`

19 - `:"gpt-5.4-mini-2026-03-17"`

21 - `:"gpt-5.4-nano-2026-03-17"`

23 - `:"gpt-5.3-chat-latest"`

25 - `:"gpt-5.2"`

27 - `:"gpt-5.2-2025-12-11"`

29 - `:"gpt-5.2-chat-latest"`

31 - `:"gpt-5.2-pro"`

33 - `:"gpt-5.2-pro-2025-12-11"`

35 - `:"gpt-5.1"`

37 - `:"gpt-5.1-2025-11-13"`

39 - `:"gpt-5.1-codex"`

41 - `:"gpt-5.1-mini"`

43 - `:"gpt-5.1-chat-latest"`

45 - `:"gpt-5"`

47 - `:"gpt-5-mini"`

49 - `:"gpt-5-nano"`

51 - `:"gpt-5-2025-08-07"`

53 - `:"gpt-5-mini-2025-08-07"`

55 - `:"gpt-5-nano-2025-08-07"`

57 - `:"gpt-5-chat-latest"`

59 - `:"gpt-4.1"`

61 - `:"gpt-4.1-mini"`

63 - `:"gpt-4.1-nano"`

65 - `:"gpt-4.1-2025-04-14"`

67 - `:"gpt-4.1-mini-2025-04-14"`

69 - `:"gpt-4.1-nano-2025-04-14"`

71 - `:"o4-mini"`

73 - `:"o4-mini-2025-04-16"`

75 - `:o3`

77 - `:"o3-2025-04-16"`

79 - `:"o3-mini"`

81 - `:"o3-mini-2025-01-31"`

83 - `:o1`

85 - `:"o1-2024-12-17"`

87 - `:"o1-preview"`

89 - `:"o1-preview-2024-09-12"`

91 - `:"o1-mini"`

93 - `:"o1-mini-2024-09-12"`

95 - `:"gpt-4o"`

97 - `:"gpt-4o-2024-11-20"`

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" | :"o1-pro-2025-03-19" | :"o3-pro" | 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### Chat Model

200

201- `ChatModel = :"gpt-5.4" | :"gpt-5.4-mini" | :"gpt-5.4-nano" | 75 more`

202

203 - `:"gpt-5.4"`

204

205 - `:"gpt-5.4-mini"`

206

207 - `:"gpt-5.4-nano"`

208

209 - `:"gpt-5.4-mini-2026-03-17"`

210

211 - `:"gpt-5.4-nano-2026-03-17"`

212

213 - `:"gpt-5.3-chat-latest"`

214

215 - `:"gpt-5.2"`

216

217 - `:"gpt-5.2-2025-12-11"`

218

219 - `:"gpt-5.2-chat-latest"`

220

221 - `:"gpt-5.2-pro"`

222

223 - `:"gpt-5.2-pro-2025-12-11"`

224

225 - `:"gpt-5.1"`

226

227 - `:"gpt-5.1-2025-11-13"`

228

229 - `:"gpt-5.1-codex"`

230

231 - `:"gpt-5.1-mini"`

232

233 - `:"gpt-5.1-chat-latest"`

234

235 - `:"gpt-5"`

236

237 - `:"gpt-5-mini"`

238

239 - `:"gpt-5-nano"`

240

241 - `:"gpt-5-2025-08-07"`

242

243 - `:"gpt-5-mini-2025-08-07"`

244

245 - `:"gpt-5-nano-2025-08-07"`

246

247 - `:"gpt-5-chat-latest"`

248

249 - `:"gpt-4.1"`

250

251 - `:"gpt-4.1-mini"`

252

253 - `:"gpt-4.1-nano"`

254

255 - `:"gpt-4.1-2025-04-14"`

256

257 - `:"gpt-4.1-mini-2025-04-14"`

258

259 - `:"gpt-4.1-nano-2025-04-14"`

260

261 - `:"o4-mini"`

262

263 - `:"o4-mini-2025-04-16"`

264

265 - `:o3`

266

267 - `:"o3-2025-04-16"`

268

269 - `:"o3-mini"`

270

271 - `:"o3-mini-2025-01-31"`

272

273 - `:o1`

274

275 - `:"o1-2024-12-17"`

276

277 - `:"o1-preview"`

278

279 - `:"o1-preview-2024-09-12"`

280

281 - `:"o1-mini"`

282

283 - `:"o1-mini-2024-09-12"`

284

285 - `:"gpt-4o"`

286

287 - `:"gpt-4o-2024-11-20"`

288

289 - `:"gpt-4o-2024-08-06"`

290

291 - `:"gpt-4o-2024-05-13"`

292

293 - `:"gpt-4o-audio-preview"`

294

295 - `:"gpt-4o-audio-preview-2024-10-01"`

296

297 - `:"gpt-4o-audio-preview-2024-12-17"`

298

299 - `:"gpt-4o-audio-preview-2025-06-03"`

300

301 - `:"gpt-4o-mini-audio-preview"`

302

303 - `:"gpt-4o-mini-audio-preview-2024-12-17"`

304

305 - `:"gpt-4o-search-preview"`

306

307 - `:"gpt-4o-mini-search-preview"`

308

309 - `:"gpt-4o-search-preview-2025-03-11"`

310

311 - `:"gpt-4o-mini-search-preview-2025-03-11"`

312

313 - `:"chatgpt-4o-latest"`

314

315 - `:"codex-mini-latest"`

316

317 - `:"gpt-4o-mini"`

318

319 - `:"gpt-4o-mini-2024-07-18"`

320

321 - `:"gpt-4-turbo"`

322

323 - `:"gpt-4-turbo-2024-04-09"`

324

325 - `:"gpt-4-0125-preview"`

326

327 - `:"gpt-4-turbo-preview"`

328

329 - `:"gpt-4-1106-preview"`

330

331 - `:"gpt-4-vision-preview"`

332

333 - `:"gpt-4"`

334

335 - `:"gpt-4-0314"`

336

337 - `:"gpt-4-0613"`

338

339 - `:"gpt-4-32k"`

340

341 - `:"gpt-4-32k-0314"`

342

343 - `:"gpt-4-32k-0613"`

344

345 - `:"gpt-3.5-turbo"`

346

347 - `:"gpt-3.5-turbo-16k"`

348

349 - `:"gpt-3.5-turbo-0301"`

350

351 - `:"gpt-3.5-turbo-0613"`

352

353 - `:"gpt-3.5-turbo-1106"`

354

355 - `:"gpt-3.5-turbo-0125"`

356

357 - `:"gpt-3.5-turbo-16k-0613"`

358

359### Comparison Filter

360

361- `class ComparisonFilter`

362

363 A filter used to compare a specified attribute key to a given value using a defined comparison operation.

364

365 - `key: String`

366

367 The key to compare against the value.

368

369 - `type: :eq | :ne | :gt | 5 more`

370

371 Specifies the comparison operator: `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `in`, `nin`.

372

373 - `eq`: equals

374 - `ne`: not equal

375 - `gt`: greater than

376 - `gte`: greater than or equal

377 - `lt`: less than

378 - `lte`: less than or equal

379 - `in`: in

380 - `nin`: not in

381

382 - `:eq`

383

384 - `:ne`

385

386 - `:gt`

387

388 - `:gte`

389

390 - `:lt`

391

392 - `:lte`

393

394 - `:in`

395

396 - `:nin`

397

398 - `value: String | Float | bool | Array[String | Float]`

399

400 The value to compare against the attribute key; supports string, number, or boolean types.

401

402 - `String = String`

403

404 - `Float = Float`

405

406 - `UnionMember2 = bool`

407

408 - `UnionMember3 = Array[String | Float]`

409

410 - `String = String`

411

412 - `Float = Float`

413

414### Compound Filter

415

416- `class CompoundFilter`

417

418 Combine multiple filters using `and` or `or`.

419

420 - `filters: Array[ComparisonFilter | untyped]`

421

422 Array of filters to combine. Items can be `ComparisonFilter` or `CompoundFilter`.

423

424 - `class ComparisonFilter`

425

426 A filter used to compare a specified attribute key to a given value using a defined comparison operation.

427

428 - `key: String`

429

430 The key to compare against the value.

431

432 - `type: :eq | :ne | :gt | 5 more`

433

434 Specifies the comparison operator: `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `in`, `nin`.

435

436 - `eq`: equals

437 - `ne`: not equal

438 - `gt`: greater than

439 - `gte`: greater than or equal

440 - `lt`: less than

441 - `lte`: less than or equal

442 - `in`: in

443 - `nin`: not in

444

445 - `:eq`

446

447 - `:ne`

448

449 - `:gt`

450

451 - `:gte`

452

453 - `:lt`

454

455 - `:lte`

456

457 - `:in`

458

459 - `:nin`

460

461 - `value: String | Float | bool | Array[String | Float]`

462

463 The value to compare against the attribute key; supports string, number, or boolean types.

464

465 - `String = String`

466

467 - `Float = Float`

468

469 - `UnionMember2 = bool`

470

471 - `UnionMember3 = Array[String | Float]`

472

473 - `String = String`

474

475 - `Float = Float`

476

477 - `UnionMember1 = untyped`

478

479 - `type: :and | :or`

480

481 Type of operation: `and` or `or`.

482

483 - `:and`

484

485 - `:or`

486

487### Custom Tool Input Format

488

489- `CustomToolInputFormat = Text{ type} | Grammar{ definition, syntax, type}`

490

491 The input format for the custom tool. Default is unconstrained text.

492

493 - `class Text`

494

495 Unconstrained free-form text.

496

497 - `type: :text`

498

499 Unconstrained text format. Always `text`.

500

501 - `:text`

502

503 - `class Grammar`

504

505 A grammar defined by the user.

506

507 - `definition: String`

508

509 The grammar definition.

510

511 - `syntax: :lark | :regex`

512

513 The syntax of the grammar definition. One of `lark` or `regex`.

514

515 - `:lark`

516

517 - `:regex`

518

519 - `type: :grammar`

520

521 Grammar format. Always `grammar`.

522

523 - `:grammar`

524

525### Error Object

526

527- `class ErrorObject`

528

529 - `code: String`

530

531 - `message: String`

532

533 - `param: String`

534

535 - `type: String`

536

537### Function Definition

538

539- `class FunctionDefinition`

540

541 - `name: String`

542

543 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.

544

545 - `description: String`

546

547 A description of what the function does, used by the model to choose when and how to call the function.

548

549 - `parameters: FunctionParameters`

550

551 The parameters the functions accepts, described as a JSON Schema object. See the [guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format.

552

553 Omitting `parameters` defines a function with an empty parameter list.

554

555 - `strict: bool`

556

557 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](https://platform.openai.com/docs/guides/function-calling).

558

559### Function Parameters

560

561- `FunctionParameters = Hash[Symbol, untyped]`

562

563 The parameters the functions accepts, described as a JSON Schema object. See the [guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format.

564

565 Omitting `parameters` defines a function with an empty parameter list.

566

567### Metadata

568

569- `Metadata = Hash[Symbol, String]`

570

571 Set of 16 key-value pairs that can be attached to an object. This can be

572 useful for storing additional information about the object in a structured

573 format, and querying for objects via API or the dashboard.

574

575 Keys are strings with a maximum length of 64 characters. Values are strings

576 with a maximum length of 512 characters.

577

578### OAuth Error Code

579

580- `OAuthErrorCode = :invalid_grant | :invalid_subject_token | String`

581

582 - `OAuthErrorCode = :invalid_grant | :invalid_subject_token`

583

584 - `:invalid_grant`

585

586 - `:invalid_subject_token`

587

588 - `String = String`

589

590### Reasoning

591

592- `class Reasoning`

593

594 **gpt-5 and o-series models only**

595

596 Configuration options for

597 [reasoning models](https://platform.openai.com/docs/guides/reasoning).

598

599 - `context: :auto | :current_turn | :all_turns`

600

601 Controls which reasoning items are rendered back to the model on later turns.

602 When returned on a response, this is the effective reasoning context mode

603 used for the response.

604

605 - `:auto`

606

607 - `:current_turn`

608

609 - `:all_turns`

610

611 - `effort: ReasoningEffort`

612

613 Constrains effort on reasoning for

614 [reasoning models](https://platform.openai.com/docs/guides/reasoning).

615 Currently supported values are `none`, `minimal`, `low`, `medium`, `high`, and `xhigh`. Reducing

616 reasoning effort can result in faster responses and fewer tokens used

617 on reasoning in a response.

618

619 - `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.

620 - All models before `gpt-5.1` default to `medium` reasoning effort, and do not support `none`.

621 - The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort.

622 - `xhigh` is supported for all models after `gpt-5.1-codex-max`.

623

624 - `:none`

625

626 - `:minimal`

627

628 - `:low`

629

630 - `:medium`

631

632 - `:high`

633

634 - `:xhigh`

635

636 - `generate_summary: :auto | :concise | :detailed`

637

638 **Deprecated:** use `summary` instead.

639

640 A summary of the reasoning performed by the model. This can be

641 useful for debugging and understanding the model's reasoning process.

642 One of `auto`, `concise`, or `detailed`.

643

644 - `:auto`

645

646 - `:concise`

647

648 - `:detailed`

649

650 - `summary: :auto | :concise | :detailed`

651

652 A summary of the reasoning performed by the model. This can be

653 useful for debugging and understanding the model's reasoning process.

654 One of `auto`, `concise`, or `detailed`.

655

656 `concise` is supported for `computer-use-preview` models and all reasoning models after `gpt-5`.

657

658 - `:auto`

659

660 - `:concise`

661

662 - `:detailed`

663

664### Reasoning Effort

665

666- `ReasoningEffort = :none | :minimal | :low | 3 more`

667

668 Constrains effort on reasoning for

669 [reasoning models](https://platform.openai.com/docs/guides/reasoning).

670 Currently supported values are `none`, `minimal`, `low`, `medium`, `high`, and `xhigh`. Reducing

671 reasoning effort can result in faster responses and fewer tokens used

672 on reasoning in a response.

673

674 - `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.

675 - All models before `gpt-5.1` default to `medium` reasoning effort, and do not support `none`.

676 - The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort.

677 - `xhigh` is supported for all models after `gpt-5.1-codex-max`.

678

679 - `:none`

680

681 - `:minimal`

682

683 - `:low`

684

685 - `:medium`

686

687 - `:high`

688

689 - `:xhigh`

690

691### Response Format JSON Object

692

693- `class ResponseFormatJSONObject`

694

695 JSON object response format. An older method of generating JSON responses.

696 Using `json_schema` is recommended for models that support it. Note that the

697 model will not generate JSON without a system or user message instructing it

698 to do so.

699

700 - `type: :json_object`

701

702 The type of response format being defined. Always `json_object`.

703

704 - `:json_object`

705

706### Response Format JSON Schema

707

708- `class ResponseFormatJSONSchema`

709

710 JSON Schema response format. Used to generate structured JSON responses.

711 Learn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs).

712

713 - `json_schema: JSONSchema{ name, description, schema, strict}`

714

715 Structured Outputs configuration options, including a JSON Schema.

716

717 - `name: String`

718

719 The name of the response format. Must be a-z, A-Z, 0-9, or contain

720 underscores and dashes, with a maximum length of 64.

721

722 - `description: String`

723

724 A description of what the response format is for, used by the model to

725 determine how to respond in the format.

726

727 - `schema: Hash[Symbol, untyped]`

728

729 The schema for the response format, described as a JSON Schema object.

730 Learn how to build JSON schemas [here](https://json-schema.org/).

731

732 - `strict: bool`

733

734 Whether to enable strict schema adherence when generating the output.

735 If set to true, the model will always follow the exact schema defined

736 in the `schema` field. Only a subset of JSON Schema is supported when

737 `strict` is `true`. To learn more, read the [Structured Outputs

738 guide](https://platform.openai.com/docs/guides/structured-outputs).

739

740 - `type: :json_schema`

741

742 The type of response format being defined. Always `json_schema`.

743

744 - `:json_schema`

745

746### Response Format Text

747

748- `class ResponseFormatText`

749

750 Default response format. Used to generate text responses.

751

752 - `type: :text`

753

754 The type of response format being defined. Always `text`.

755

756 - `:text`

757

758### Response Format Text Grammar

759

760- `class ResponseFormatTextGrammar`

761

762 A custom grammar for the model to follow when generating text.

763 Learn more in the [custom grammars guide](https://platform.openai.com/docs/guides/custom-grammars).

764

765 - `grammar: String`

766

767 The custom grammar for the model to follow.

768

769 - `type: :grammar`

770

771 The type of response format being defined. Always `grammar`.

772

773 - `:grammar`

774

775### Response Format Text Python

776

777- `class ResponseFormatTextPython`

778

779 Configure the model to generate valid Python code. See the

780 [custom grammars guide](https://platform.openai.com/docs/guides/custom-grammars) for more details.

781

782 - `type: :python`

783

784 The type of response format being defined. Always `python`.

785

786 - `:python`

787

788### Responses Model

789

791

792 - `String = String`

793

794 - `ChatModel = :"gpt-5.4" | :"gpt-5.4-mini" | :"gpt-5.4-nano" | 75 more`

795

796 - `:"gpt-5.4"`

797

798 - `:"gpt-5.4-mini"`

799

800 - `:"gpt-5.4-nano"`

801

802 - `:"gpt-5.4-mini-2026-03-17"`

803

804 - `:"gpt-5.4-nano-2026-03-17"`

805

806 - `:"gpt-5.3-chat-latest"`

807

808 - `:"gpt-5.2"`

809

810 - `:"gpt-5.2-2025-12-11"`

811

812 - `:"gpt-5.2-chat-latest"`

813

814 - `:"gpt-5.2-pro"`

815

816 - `:"gpt-5.2-pro-2025-12-11"`

817

818 - `:"gpt-5.1"`

819

820 - `:"gpt-5.1-2025-11-13"`

821

822 - `:"gpt-5.1-codex"`

823

824 - `:"gpt-5.1-mini"`

825

826 - `:"gpt-5.1-chat-latest"`

827

828 - `:"gpt-5"`

829

830 - `:"gpt-5-mini"`

831

832 - `:"gpt-5-nano"`

833

834 - `:"gpt-5-2025-08-07"`

835

836 - `:"gpt-5-mini-2025-08-07"`

837

838 - `:"gpt-5-nano-2025-08-07"`

839

840 - `:"gpt-5-chat-latest"`

841

842 - `:"gpt-4.1"`

843

844 - `:"gpt-4.1-mini"`

845

846 - `:"gpt-4.1-nano"`

847

848 - `:"gpt-4.1-2025-04-14"`

849

850 - `:"gpt-4.1-mini-2025-04-14"`

851

852 - `:"gpt-4.1-nano-2025-04-14"`

853

854 - `:"o4-mini"`

855

856 - `:"o4-mini-2025-04-16"`

857

858 - `:o3`

859

860 - `:"o3-2025-04-16"`

861

862 - `:"o3-mini"`

863

864 - `:"o3-mini-2025-01-31"`

865

866 - `:o1`

867

868 - `:"o1-2024-12-17"`

869

870 - `:"o1-preview"`

871

872 - `:"o1-preview-2024-09-12"`

873

874 - `:"o1-mini"`

875

876 - `:"o1-mini-2024-09-12"`

877

878 - `:"gpt-4o"`

879

880 - `:"gpt-4o-2024-11-20"`

881

882 - `:"gpt-4o-2024-08-06"`

883

884 - `:"gpt-4o-2024-05-13"`

885

886 - `:"gpt-4o-audio-preview"`

887

888 - `:"gpt-4o-audio-preview-2024-10-01"`

889

890 - `:"gpt-4o-audio-preview-2024-12-17"`

891

892 - `:"gpt-4o-audio-preview-2025-06-03"`

893

894 - `:"gpt-4o-mini-audio-preview"`

895

896 - `:"gpt-4o-mini-audio-preview-2024-12-17"`

897

898 - `:"gpt-4o-search-preview"`

899

900 - `:"gpt-4o-mini-search-preview"`

901

902 - `:"gpt-4o-search-preview-2025-03-11"`

903

904 - `:"gpt-4o-mini-search-preview-2025-03-11"`

905

906 - `:"chatgpt-4o-latest"`

907

908 - `:"codex-mini-latest"`

909

910 - `:"gpt-4o-mini"`

911

912 - `:"gpt-4o-mini-2024-07-18"`

913

914 - `:"gpt-4-turbo"`

915

916 - `:"gpt-4-turbo-2024-04-09"`

917

918 - `:"gpt-4-0125-preview"`

919

920 - `:"gpt-4-turbo-preview"`

921

922 - `:"gpt-4-1106-preview"`

923

924 - `:"gpt-4-vision-preview"`

925

926 - `:"gpt-4"`

927

928 - `:"gpt-4-0314"`

929

930 - `:"gpt-4-0613"`

931

932 - `:"gpt-4-32k"`

933

934 - `:"gpt-4-32k-0314"`

935

936 - `:"gpt-4-32k-0613"`

937

938 - `:"gpt-3.5-turbo"`

939

940 - `:"gpt-3.5-turbo-16k"`

941

942 - `:"gpt-3.5-turbo-0301"`

943

944 - `:"gpt-3.5-turbo-0613"`

945

946 - `:"gpt-3.5-turbo-1106"`

947

948 - `:"gpt-3.5-turbo-0125"`

949

950 - `:"gpt-3.5-turbo-16k-0613"`

951

952 - `ResponsesOnlyModel = :"o1-pro" | :"o1-pro-2025-03-19" | :"o3-pro" | 11 more`

953

954 - `:"o1-pro"`

955

956 - `:"o1-pro-2025-03-19"`

957

958 - `:"o3-pro"`

959

960 - `:"o3-pro-2025-06-10"`

961

962 - `:"o3-deep-research"`

963

964 - `:"o3-deep-research-2025-06-26"`

965

966 - `:"o4-mini-deep-research"`

967

968 - `:"o4-mini-deep-research-2025-06-26"`

969

970 - `:"computer-use-preview"`

971

972 - `:"computer-use-preview-2025-03-11"`

973

974 - `:"gpt-5-codex"`

975

976 - `:"gpt-5-pro"`

977

978 - `:"gpt-5-pro-2025-10-06"`

979

980 - `:"gpt-5.1-codex-max"`