Shared

Domain Types

All Models

class AllModels: A class that can be one of several variants.union
- String
- enum ChatModel:
  - GPT_5_4("gpt-5.4")
  - GPT_5_4_MINI("gpt-5.4-mini")
  - GPT_5_4_NANO("gpt-5.4-nano")
  - GPT_5_4_MINI_2026_03_17("gpt-5.4-mini-2026-03-17")
  - GPT_5_4_NANO_2026_03_17("gpt-5.4-nano-2026-03-17")
  - GPT_5_3_CHAT_LATEST("gpt-5.3-chat-latest")
  - GPT_5_2("gpt-5.2")
  - GPT_5_2_2025_12_11("gpt-5.2-2025-12-11")
  - GPT_5_2_CHAT_LATEST("gpt-5.2-chat-latest")
  - GPT_5_2_PRO("gpt-5.2-pro")
  - GPT_5_2_PRO_2025_12_11("gpt-5.2-pro-2025-12-11")
  - GPT_5_1("gpt-5.1")
  - GPT_5_1_2025_11_13("gpt-5.1-2025-11-13")
  - GPT_5_1_CODEX("gpt-5.1-codex")
  - GPT_5_1_MINI("gpt-5.1-mini")
  - GPT_5_1_CHAT_LATEST("gpt-5.1-chat-latest")
  - GPT_5("gpt-5")
  - GPT_5_MINI("gpt-5-mini")
  - GPT_5_NANO("gpt-5-nano")
  - GPT_5_2025_08_07("gpt-5-2025-08-07")
  - GPT_5_MINI_2025_08_07("gpt-5-mini-2025-08-07")
  - GPT_5_NANO_2025_08_07("gpt-5-nano-2025-08-07")
  - GPT_5_CHAT_LATEST("gpt-5-chat-latest")
  - GPT_4_1("gpt-4.1")
  - GPT_4_1_MINI("gpt-4.1-mini")
  - GPT_4_1_NANO("gpt-4.1-nano")
  - GPT_4_1_2025_04_14("gpt-4.1-2025-04-14")
  - GPT_4_1_MINI_2025_04_14("gpt-4.1-mini-2025-04-14")
  - GPT_4_1_NANO_2025_04_14("gpt-4.1-nano-2025-04-14")
  - O4_MINI("o4-mini")
  - O4_MINI_2025_04_16("o4-mini-2025-04-16")
  - O3("o3")
  - O3_2025_04_16("o3-2025-04-16")
  - O3_MINI("o3-mini")
  - O3_MINI_2025_01_31("o3-mini-2025-01-31")
  - O1("o1")
  - O1_2024_12_17("o1-2024-12-17")
  - O1_PREVIEW("o1-preview")
  - O1_PREVIEW_2024_09_12("o1-preview-2024-09-12")
  - O1_MINI("o1-mini")
  - O1_MINI_2024_09_12("o1-mini-2024-09-12")
  - GPT_4O("gpt-4o")
  - GPT_4O_2024_11_20("gpt-4o-2024-11-20")
  - GPT_4O_2024_08_06("gpt-4o-2024-08-06")
  - GPT_4O_2024_05_13("gpt-4o-2024-05-13")
  - GPT_4O_AUDIO_PREVIEW("gpt-4o-audio-preview")
  - GPT_4O_AUDIO_PREVIEW_2024_10_01("gpt-4o-audio-preview-2024-10-01")
  - GPT_4O_AUDIO_PREVIEW_2024_12_17("gpt-4o-audio-preview-2024-12-17")
  - GPT_4O_AUDIO_PREVIEW_2025_06_03("gpt-4o-audio-preview-2025-06-03")
  - GPT_4O_MINI_AUDIO_PREVIEW("gpt-4o-mini-audio-preview")
  - GPT_4O_MINI_AUDIO_PREVIEW_2024_12_17("gpt-4o-mini-audio-preview-2024-12-17")
  - GPT_4O_SEARCH_PREVIEW("gpt-4o-search-preview")
  - GPT_4O_MINI_SEARCH_PREVIEW("gpt-4o-mini-search-preview")
  - GPT_4O_SEARCH_PREVIEW_2025_03_11("gpt-4o-search-preview-2025-03-11")
  - GPT_4O_MINI_SEARCH_PREVIEW_2025_03_11("gpt-4o-mini-search-preview-2025-03-11")
  - CHATGPT_4O_LATEST("chatgpt-4o-latest")
  - CODEX_MINI_LATEST("codex-mini-latest")
  - GPT_4O_MINI("gpt-4o-mini")
  - GPT_4O_MINI_2024_07_18("gpt-4o-mini-2024-07-18")
  - GPT_4_TURBO("gpt-4-turbo")
  - GPT_4_TURBO_2024_04_09("gpt-4-turbo-2024-04-09")
  - GPT_4_0125_PREVIEW("gpt-4-0125-preview")
  - GPT_4_TURBO_PREVIEW("gpt-4-turbo-preview")
  - GPT_4_1106_PREVIEW("gpt-4-1106-preview")
  - GPT_4_VISION_PREVIEW("gpt-4-vision-preview")
  - GPT_4("gpt-4")
  - GPT_4_0314("gpt-4-0314")
  - GPT_4_0613("gpt-4-0613")
  - GPT_4_32K("gpt-4-32k")
  - GPT_4_32K_0314("gpt-4-32k-0314")
  - GPT_4_32K_0613("gpt-4-32k-0613")
  - GPT_3_5_TURBO("gpt-3.5-turbo")
  - GPT_3_5_TURBO_16K("gpt-3.5-turbo-16k")
  - GPT_3_5_TURBO_0301("gpt-3.5-turbo-0301")
  - GPT_3_5_TURBO_0613("gpt-3.5-turbo-0613")
  - GPT_3_5_TURBO_1106("gpt-3.5-turbo-1106")
  - GPT_3_5_TURBO_0125("gpt-3.5-turbo-0125")
  - GPT_3_5_TURBO_16K_0613("gpt-3.5-turbo-16k-0613")
- ResponsesOnlyModel
  - O1_PRO("o1-pro")
  - O1_PRO_2025_03_19("o1-pro-2025-03-19")
  - O3_PRO("o3-pro")
  - O3_PRO_2025_06_10("o3-pro-2025-06-10")
  - O3_DEEP_RESEARCH("o3-deep-research")
  - O3_DEEP_RESEARCH_2025_06_26("o3-deep-research-2025-06-26")
  - O4_MINI_DEEP_RESEARCH("o4-mini-deep-research")
  - O4_MINI_DEEP_RESEARCH_2025_06_26("o4-mini-deep-research-2025-06-26")
  - COMPUTER_USE_PREVIEW("computer-use-preview")
  - COMPUTER_USE_PREVIEW_2025_03_11("computer-use-preview-2025-03-11")
  - GPT_5_CODEX("gpt-5-codex")
  - GPT_5_PRO("gpt-5-pro")
  - GPT_5_PRO_2025_10_06("gpt-5-pro-2025-10-06")
  - GPT_5_1_CODEX_MAX("gpt-5.1-codex-max")

Chat Model

enum ChatModel:
- GPT_5_4("gpt-5.4")
- GPT_5_4_MINI("gpt-5.4-mini")
- GPT_5_4_NANO("gpt-5.4-nano")
- GPT_5_4_MINI_2026_03_17("gpt-5.4-mini-2026-03-17")
- GPT_5_4_NANO_2026_03_17("gpt-5.4-nano-2026-03-17")
- GPT_5_3_CHAT_LATEST("gpt-5.3-chat-latest")
- GPT_5_2("gpt-5.2")
- GPT_5_2_2025_12_11("gpt-5.2-2025-12-11")
- GPT_5_2_CHAT_LATEST("gpt-5.2-chat-latest")
- GPT_5_2_PRO("gpt-5.2-pro")
- GPT_5_2_PRO_2025_12_11("gpt-5.2-pro-2025-12-11")
- GPT_5_1("gpt-5.1")
- GPT_5_1_2025_11_13("gpt-5.1-2025-11-13")
- GPT_5_1_CODEX("gpt-5.1-codex")
- GPT_5_1_MINI("gpt-5.1-mini")
- GPT_5_1_CHAT_LATEST("gpt-5.1-chat-latest")
- GPT_5("gpt-5")
- GPT_5_MINI("gpt-5-mini")
- GPT_5_NANO("gpt-5-nano")
- GPT_5_2025_08_07("gpt-5-2025-08-07")
- GPT_5_MINI_2025_08_07("gpt-5-mini-2025-08-07")
- GPT_5_NANO_2025_08_07("gpt-5-nano-2025-08-07")
- GPT_5_CHAT_LATEST("gpt-5-chat-latest")
- GPT_4_1("gpt-4.1")
- GPT_4_1_MINI("gpt-4.1-mini")
- GPT_4_1_NANO("gpt-4.1-nano")
- GPT_4_1_2025_04_14("gpt-4.1-2025-04-14")
- GPT_4_1_MINI_2025_04_14("gpt-4.1-mini-2025-04-14")
- GPT_4_1_NANO_2025_04_14("gpt-4.1-nano-2025-04-14")
- O4_MINI("o4-mini")
- O4_MINI_2025_04_16("o4-mini-2025-04-16")
- O3("o3")
- O3_2025_04_16("o3-2025-04-16")
- O3_MINI("o3-mini")
- O3_MINI_2025_01_31("o3-mini-2025-01-31")
- O1("o1")
- O1_2024_12_17("o1-2024-12-17")
- O1_PREVIEW("o1-preview")
- O1_PREVIEW_2024_09_12("o1-preview-2024-09-12")
- O1_MINI("o1-mini")
- O1_MINI_2024_09_12("o1-mini-2024-09-12")
- GPT_4O("gpt-4o")
- GPT_4O_2024_11_20("gpt-4o-2024-11-20")
- GPT_4O_2024_08_06("gpt-4o-2024-08-06")
- GPT_4O_2024_05_13("gpt-4o-2024-05-13")
- GPT_4O_AUDIO_PREVIEW("gpt-4o-audio-preview")
- GPT_4O_AUDIO_PREVIEW_2024_10_01("gpt-4o-audio-preview-2024-10-01")
- GPT_4O_AUDIO_PREVIEW_2024_12_17("gpt-4o-audio-preview-2024-12-17")
- GPT_4O_AUDIO_PREVIEW_2025_06_03("gpt-4o-audio-preview-2025-06-03")
- GPT_4O_MINI_AUDIO_PREVIEW("gpt-4o-mini-audio-preview")
- GPT_4O_MINI_AUDIO_PREVIEW_2024_12_17("gpt-4o-mini-audio-preview-2024-12-17")
- GPT_4O_SEARCH_PREVIEW("gpt-4o-search-preview")
- GPT_4O_MINI_SEARCH_PREVIEW("gpt-4o-mini-search-preview")
- GPT_4O_SEARCH_PREVIEW_2025_03_11("gpt-4o-search-preview-2025-03-11")
- GPT_4O_MINI_SEARCH_PREVIEW_2025_03_11("gpt-4o-mini-search-preview-2025-03-11")
- CHATGPT_4O_LATEST("chatgpt-4o-latest")
- CODEX_MINI_LATEST("codex-mini-latest")
- GPT_4O_MINI("gpt-4o-mini")
- GPT_4O_MINI_2024_07_18("gpt-4o-mini-2024-07-18")
- GPT_4_TURBO("gpt-4-turbo")
- GPT_4_TURBO_2024_04_09("gpt-4-turbo-2024-04-09")
- GPT_4_0125_PREVIEW("gpt-4-0125-preview")
- GPT_4_TURBO_PREVIEW("gpt-4-turbo-preview")
- GPT_4_1106_PREVIEW("gpt-4-1106-preview")
- GPT_4_VISION_PREVIEW("gpt-4-vision-preview")
- GPT_4("gpt-4")
- GPT_4_0314("gpt-4-0314")
- GPT_4_0613("gpt-4-0613")
- GPT_4_32K("gpt-4-32k")
- GPT_4_32K_0314("gpt-4-32k-0314")
- GPT_4_32K_0613("gpt-4-32k-0613")
- GPT_3_5_TURBO("gpt-3.5-turbo")
- GPT_3_5_TURBO_16K("gpt-3.5-turbo-16k")
- GPT_3_5_TURBO_0301("gpt-3.5-turbo-0301")
- GPT_3_5_TURBO_0613("gpt-3.5-turbo-0613")
- GPT_3_5_TURBO_1106("gpt-3.5-turbo-1106")
- GPT_3_5_TURBO_0125("gpt-3.5-turbo-0125")
- GPT_3_5_TURBO_16K_0613("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.
- String key
  
  The key to compare against the value.
- Type type
  
  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("eq")
  - NE("ne")
  - GT("gt")
  - GTE("gte")
  - LT("lt")
  - LTE("lte")
  - IN("in")
  - NIN("nin")
- Value value
  
  The value to compare against the attribute key; supports string, number, or boolean types.
  - String
  - double
  - boolean
  - List<ComparisonFilterValueItem>
    - String
    - double

Compound Filter

class CompoundFilter:

Combine multiple filters using and or or.
- List<Filter> filters
  
  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.
    - String key
      
      The key to compare against the value.
    - Type type
      
      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("eq")
      - NE("ne")
      - GT("gt")
      - GTE("gte")
      - LT("lt")
      - LTE("lte")
      - IN("in")
      - NIN("nin")
    - Value value
      
      The value to compare against the attribute key; supports string, number, or boolean types.
      - String
      - double
      - boolean
      - List<ComparisonFilterValueItem>
        
        String
        
        double
  - JsonValue
- Type type
  
  Type of operation: and or or.
  - AND("and")
  - OR("or")

Custom Tool Input Format

class CustomToolInputFormat: A class that can be one of several variants.union

The input format for the custom tool. Default is unconstrained text.
- JsonValue;
  - JsonValue; type "text"constant
    
    Unconstrained text format. Always text.
    - TEXT("text")
- Grammar
  - String definition
    
    The grammar definition.
  - Syntax syntax
    
    The syntax of the grammar definition. One of lark or regex.
    - LARK("lark")
    - REGEX("regex")
  - JsonValue; type "grammar"constant
    
    Grammar format. Always grammar.
    - GRAMMAR("grammar")

Error Object

class ErrorObject:
- Optional<String> code
- String message
- Optional<String> param
- String type

Function Definition

class FunctionDefinition:
- String name
  
  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.
- Optional<String> description
  
  A description of what the function does, used by the model to choose when and how to call the function.
- Optional<FunctionParameters> parameters
  
  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.
- Optional<Boolean> strict
  
  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

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

OAuth Error Code

enum OAuthErrorCode:
- INVALID_GRANT("invalid_grant")
- INVALID_SUBJECT_TOKEN("invalid_subject_token")

Reasoning

class Reasoning:

gpt-5 and o-series models only

Configuration options for reasoning models.
- Optional<ReasoningEffort> effort
  
  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("none")
  - MINIMAL("minimal")
  - LOW("low")
  - MEDIUM("medium")
  - HIGH("high")
  - XHIGH("xhigh")
- Optional<GenerateSummary> generateSummary
  
  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("auto")
  - CONCISE("concise")
  - DETAILED("detailed")
- Optional<Summary> summary
  
  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("auto")
  - CONCISE("concise")
  - DETAILED("detailed")

Reasoning Effort

enum 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("none")
- MINIMAL("minimal")
- LOW("low")
- MEDIUM("medium")
- HIGH("high")
- XHIGH("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.
- JsonValue; type "json_object"constant
  
  The type of response format being defined. Always json_object.
  - 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.
- JsonSchema jsonSchema
  
  Structured Outputs configuration options, including a JSON Schema.
  - String name
    
    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.
  - Optional<String> description
    
    A description of what the response format is for, used by the model to determine how to respond in the format.
  - Optional<Schema> schema
    
    The schema for the response format, described as a JSON Schema object. Learn how to build JSON schemas here.
  - Optional<Boolean> strict
    
    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.
- JsonValue; type "json_schema"constant
  
  The type of response format being defined. Always json_schema.
  - JSON_SCHEMA("json_schema")

Response Format Text

class ResponseFormatText:

Default response format. Used to generate text responses.
- JsonValue; type "text"constant
  
  The type of response format being defined. Always text.
  - 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.
- String grammar
  
  The custom grammar for the model to follow.
- JsonValue; type "grammar"constant
  
  The type of response format being defined. Always grammar.
  - GRAMMAR("grammar")

Response Format Text Python

class ResponseFormatTextPython:

Configure the model to generate valid Python code. See the custom grammars guide for more details.
- JsonValue; type "python"constant
  
  The type of response format being defined. Always python.
  - PYTHON("python")

Responses Model

class ResponsesModel: A class that can be one of several variants.union
- String
- enum ChatModel:
  - GPT_5_4("gpt-5.4")
  - GPT_5_4_MINI("gpt-5.4-mini")
  - GPT_5_4_NANO("gpt-5.4-nano")
  - GPT_5_4_MINI_2026_03_17("gpt-5.4-mini-2026-03-17")
  - GPT_5_4_NANO_2026_03_17("gpt-5.4-nano-2026-03-17")
  - GPT_5_3_CHAT_LATEST("gpt-5.3-chat-latest")
  - GPT_5_2("gpt-5.2")
  - GPT_5_2_2025_12_11("gpt-5.2-2025-12-11")
  - GPT_5_2_CHAT_LATEST("gpt-5.2-chat-latest")
  - GPT_5_2_PRO("gpt-5.2-pro")
  - GPT_5_2_PRO_2025_12_11("gpt-5.2-pro-2025-12-11")
  - GPT_5_1("gpt-5.1")
  - GPT_5_1_2025_11_13("gpt-5.1-2025-11-13")
  - GPT_5_1_CODEX("gpt-5.1-codex")
  - GPT_5_1_MINI("gpt-5.1-mini")
  - GPT_5_1_CHAT_LATEST("gpt-5.1-chat-latest")
  - GPT_5("gpt-5")
  - GPT_5_MINI("gpt-5-mini")
  - GPT_5_NANO("gpt-5-nano")
  - GPT_5_2025_08_07("gpt-5-2025-08-07")
  - GPT_5_MINI_2025_08_07("gpt-5-mini-2025-08-07")
  - GPT_5_NANO_2025_08_07("gpt-5-nano-2025-08-07")
  - GPT_5_CHAT_LATEST("gpt-5-chat-latest")
  - GPT_4_1("gpt-4.1")
  - GPT_4_1_MINI("gpt-4.1-mini")
  - GPT_4_1_NANO("gpt-4.1-nano")
  - GPT_4_1_2025_04_14("gpt-4.1-2025-04-14")
  - GPT_4_1_MINI_2025_04_14("gpt-4.1-mini-2025-04-14")
  - GPT_4_1_NANO_2025_04_14("gpt-4.1-nano-2025-04-14")
  - O4_MINI("o4-mini")
  - O4_MINI_2025_04_16("o4-mini-2025-04-16")
  - O3("o3")
  - O3_2025_04_16("o3-2025-04-16")
  - O3_MINI("o3-mini")
  - O3_MINI_2025_01_31("o3-mini-2025-01-31")
  - O1("o1")
  - O1_2024_12_17("o1-2024-12-17")
  - O1_PREVIEW("o1-preview")
  - O1_PREVIEW_2024_09_12("o1-preview-2024-09-12")
  - O1_MINI("o1-mini")
  - O1_MINI_2024_09_12("o1-mini-2024-09-12")
  - GPT_4O("gpt-4o")
  - GPT_4O_2024_11_20("gpt-4o-2024-11-20")
  - GPT_4O_2024_08_06("gpt-4o-2024-08-06")
  - GPT_4O_2024_05_13("gpt-4o-2024-05-13")
  - GPT_4O_AUDIO_PREVIEW("gpt-4o-audio-preview")
  - GPT_4O_AUDIO_PREVIEW_2024_10_01("gpt-4o-audio-preview-2024-10-01")
  - GPT_4O_AUDIO_PREVIEW_2024_12_17("gpt-4o-audio-preview-2024-12-17")
  - GPT_4O_AUDIO_PREVIEW_2025_06_03("gpt-4o-audio-preview-2025-06-03")
  - GPT_4O_MINI_AUDIO_PREVIEW("gpt-4o-mini-audio-preview")
  - GPT_4O_MINI_AUDIO_PREVIEW_2024_12_17("gpt-4o-mini-audio-preview-2024-12-17")
  - GPT_4O_SEARCH_PREVIEW("gpt-4o-search-preview")
  - GPT_4O_MINI_SEARCH_PREVIEW("gpt-4o-mini-search-preview")
  - GPT_4O_SEARCH_PREVIEW_2025_03_11("gpt-4o-search-preview-2025-03-11")
  - GPT_4O_MINI_SEARCH_PREVIEW_2025_03_11("gpt-4o-mini-search-preview-2025-03-11")
  - CHATGPT_4O_LATEST("chatgpt-4o-latest")
  - CODEX_MINI_LATEST("codex-mini-latest")
  - GPT_4O_MINI("gpt-4o-mini")
  - GPT_4O_MINI_2024_07_18("gpt-4o-mini-2024-07-18")
  - GPT_4_TURBO("gpt-4-turbo")
  - GPT_4_TURBO_2024_04_09("gpt-4-turbo-2024-04-09")
  - GPT_4_0125_PREVIEW("gpt-4-0125-preview")
  - GPT_4_TURBO_PREVIEW("gpt-4-turbo-preview")
  - GPT_4_1106_PREVIEW("gpt-4-1106-preview")
  - GPT_4_VISION_PREVIEW("gpt-4-vision-preview")
  - GPT_4("gpt-4")
  - GPT_4_0314("gpt-4-0314")
  - GPT_4_0613("gpt-4-0613")
  - GPT_4_32K("gpt-4-32k")
  - GPT_4_32K_0314("gpt-4-32k-0314")
  - GPT_4_32K_0613("gpt-4-32k-0613")
  - GPT_3_5_TURBO("gpt-3.5-turbo")
  - GPT_3_5_TURBO_16K("gpt-3.5-turbo-16k")
  - GPT_3_5_TURBO_0301("gpt-3.5-turbo-0301")
  - GPT_3_5_TURBO_0613("gpt-3.5-turbo-0613")
  - GPT_3_5_TURBO_1106("gpt-3.5-turbo-1106")
  - GPT_3_5_TURBO_0125("gpt-3.5-turbo-0125")
  - GPT_3_5_TURBO_16K_0613("gpt-3.5-turbo-16k-0613")
- ResponsesOnlyModel
  - O1_PRO("o1-pro")
  - O1_PRO_2025_03_19("o1-pro-2025-03-19")
  - O3_PRO("o3-pro")
  - O3_PRO_2025_06_10("o3-pro-2025-06-10")
  - O3_DEEP_RESEARCH("o3-deep-research")
  - O3_DEEP_RESEARCH_2025_06_26("o3-deep-research-2025-06-26")
  - O4_MINI_DEEP_RESEARCH("o4-mini-deep-research")
  - O4_MINI_DEEP_RESEARCH_2025_06_26("o4-mini-deep-research-2025-06-26")
  - COMPUTER_USE_PREVIEW("computer-use-preview")
  - COMPUTER_USE_PREVIEW_2025_03_11("computer-use-preview-2025-03-11")
  - GPT_5_CODEX("gpt-5-codex")
  - GPT_5_PRO("gpt-5-pro")
  - GPT_5_PRO_2025_10_06("gpt-5-pro-2025-10-06")
  - GPT_5_1_CODEX_MAX("gpt-5.1-codex-max")

java/resources/$shared/index.md +949 −0 created

1# Shared

3## Domain Types

5### All Models

7- `class AllModels: A class that can be one of several variants.union`

9 - `String`

11 - `enum ChatModel:`

13 - `GPT_5_4("gpt-5.4")`

15 - `GPT_5_4_MINI("gpt-5.4-mini")`

17 - `GPT_5_4_NANO("gpt-5.4-nano")`

19 - `GPT_5_4_MINI_2026_03_17("gpt-5.4-mini-2026-03-17")`

21 - `GPT_5_4_NANO_2026_03_17("gpt-5.4-nano-2026-03-17")`

23 - `GPT_5_3_CHAT_LATEST("gpt-5.3-chat-latest")`

25 - `GPT_5_2("gpt-5.2")`

27 - `GPT_5_2_2025_12_11("gpt-5.2-2025-12-11")`

29 - `GPT_5_2_CHAT_LATEST("gpt-5.2-chat-latest")`

31 - `GPT_5_2_PRO("gpt-5.2-pro")`

33 - `GPT_5_2_PRO_2025_12_11("gpt-5.2-pro-2025-12-11")`

35 - `GPT_5_1("gpt-5.1")`

37 - `GPT_5_1_2025_11_13("gpt-5.1-2025-11-13")`

39 - `GPT_5_1_CODEX("gpt-5.1-codex")`

41 - `GPT_5_1_MINI("gpt-5.1-mini")`

43 - `GPT_5_1_CHAT_LATEST("gpt-5.1-chat-latest")`

45 - `GPT_5("gpt-5")`

47 - `GPT_5_MINI("gpt-5-mini")`

49 - `GPT_5_NANO("gpt-5-nano")`

51 - `GPT_5_2025_08_07("gpt-5-2025-08-07")`

53 - `GPT_5_MINI_2025_08_07("gpt-5-mini-2025-08-07")`

55 - `GPT_5_NANO_2025_08_07("gpt-5-nano-2025-08-07")`

57 - `GPT_5_CHAT_LATEST("gpt-5-chat-latest")`

59 - `GPT_4_1("gpt-4.1")`

61 - `GPT_4_1_MINI("gpt-4.1-mini")`

63 - `GPT_4_1_NANO("gpt-4.1-nano")`

65 - `GPT_4_1_2025_04_14("gpt-4.1-2025-04-14")`

67 - `GPT_4_1_MINI_2025_04_14("gpt-4.1-mini-2025-04-14")`

69 - `GPT_4_1_NANO_2025_04_14("gpt-4.1-nano-2025-04-14")`

71 - `O4_MINI("o4-mini")`

73 - `O4_MINI_2025_04_16("o4-mini-2025-04-16")`

75 - `O3("o3")`

77 - `O3_2025_04_16("o3-2025-04-16")`

79 - `O3_MINI("o3-mini")`

81 - `O3_MINI_2025_01_31("o3-mini-2025-01-31")`

83 - `O1("o1")`

85 - `O1_2024_12_17("o1-2024-12-17")`

87 - `O1_PREVIEW("o1-preview")`

89 - `O1_PREVIEW_2024_09_12("o1-preview-2024-09-12")`

91 - `O1_MINI("o1-mini")`

93 - `O1_MINI_2024_09_12("o1-mini-2024-09-12")`

95 - `GPT_4O("gpt-4o")`

97 - `GPT_4O_2024_11_20("gpt-4o-2024-11-20")`

99 - `GPT_4O_2024_08_06("gpt-4o-2024-08-06")`

100

101 - `GPT_4O_2024_05_13("gpt-4o-2024-05-13")`

102

103 - `GPT_4O_AUDIO_PREVIEW("gpt-4o-audio-preview")`

104

105 - `GPT_4O_AUDIO_PREVIEW_2024_10_01("gpt-4o-audio-preview-2024-10-01")`

106

107 - `GPT_4O_AUDIO_PREVIEW_2024_12_17("gpt-4o-audio-preview-2024-12-17")`

108

109 - `GPT_4O_AUDIO_PREVIEW_2025_06_03("gpt-4o-audio-preview-2025-06-03")`

110

111 - `GPT_4O_MINI_AUDIO_PREVIEW("gpt-4o-mini-audio-preview")`

112

113 - `GPT_4O_MINI_AUDIO_PREVIEW_2024_12_17("gpt-4o-mini-audio-preview-2024-12-17")`

114

115 - `GPT_4O_SEARCH_PREVIEW("gpt-4o-search-preview")`

116

117 - `GPT_4O_MINI_SEARCH_PREVIEW("gpt-4o-mini-search-preview")`

118

119 - `GPT_4O_SEARCH_PREVIEW_2025_03_11("gpt-4o-search-preview-2025-03-11")`

120

121 - `GPT_4O_MINI_SEARCH_PREVIEW_2025_03_11("gpt-4o-mini-search-preview-2025-03-11")`

122

123 - `CHATGPT_4O_LATEST("chatgpt-4o-latest")`

124

125 - `CODEX_MINI_LATEST("codex-mini-latest")`

126

127 - `GPT_4O_MINI("gpt-4o-mini")`

128

129 - `GPT_4O_MINI_2024_07_18("gpt-4o-mini-2024-07-18")`

130

131 - `GPT_4_TURBO("gpt-4-turbo")`

132

133 - `GPT_4_TURBO_2024_04_09("gpt-4-turbo-2024-04-09")`

134

135 - `GPT_4_0125_PREVIEW("gpt-4-0125-preview")`

136

137 - `GPT_4_TURBO_PREVIEW("gpt-4-turbo-preview")`

138

139 - `GPT_4_1106_PREVIEW("gpt-4-1106-preview")`

140

141 - `GPT_4_VISION_PREVIEW("gpt-4-vision-preview")`

142

143 - `GPT_4("gpt-4")`

144

145 - `GPT_4_0314("gpt-4-0314")`

146

147 - `GPT_4_0613("gpt-4-0613")`

148

149 - `GPT_4_32K("gpt-4-32k")`

150

151 - `GPT_4_32K_0314("gpt-4-32k-0314")`

152

153 - `GPT_4_32K_0613("gpt-4-32k-0613")`

154

155 - `GPT_3_5_TURBO("gpt-3.5-turbo")`

156

157 - `GPT_3_5_TURBO_16K("gpt-3.5-turbo-16k")`

158

159 - `GPT_3_5_TURBO_0301("gpt-3.5-turbo-0301")`

160

161 - `GPT_3_5_TURBO_0613("gpt-3.5-turbo-0613")`

162

163 - `GPT_3_5_TURBO_1106("gpt-3.5-turbo-1106")`

164

165 - `GPT_3_5_TURBO_0125("gpt-3.5-turbo-0125")`

166

167 - `GPT_3_5_TURBO_16K_0613("gpt-3.5-turbo-16k-0613")`

168

169 - `ResponsesOnlyModel`

170

171 - `O1_PRO("o1-pro")`

172

173 - `O1_PRO_2025_03_19("o1-pro-2025-03-19")`

174

175 - `O3_PRO("o3-pro")`

176

177 - `O3_PRO_2025_06_10("o3-pro-2025-06-10")`

178

179 - `O3_DEEP_RESEARCH("o3-deep-research")`

180

181 - `O3_DEEP_RESEARCH_2025_06_26("o3-deep-research-2025-06-26")`

182

183 - `O4_MINI_DEEP_RESEARCH("o4-mini-deep-research")`

184

185 - `O4_MINI_DEEP_RESEARCH_2025_06_26("o4-mini-deep-research-2025-06-26")`

186

187 - `COMPUTER_USE_PREVIEW("computer-use-preview")`

188

189 - `COMPUTER_USE_PREVIEW_2025_03_11("computer-use-preview-2025-03-11")`

190

191 - `GPT_5_CODEX("gpt-5-codex")`

192

193 - `GPT_5_PRO("gpt-5-pro")`

194

195 - `GPT_5_PRO_2025_10_06("gpt-5-pro-2025-10-06")`

196

197 - `GPT_5_1_CODEX_MAX("gpt-5.1-codex-max")`

198

199### Chat Model

200

201- `enum ChatModel:`

202

203 - `GPT_5_4("gpt-5.4")`

204

205 - `GPT_5_4_MINI("gpt-5.4-mini")`

206

207 - `GPT_5_4_NANO("gpt-5.4-nano")`

208

209 - `GPT_5_4_MINI_2026_03_17("gpt-5.4-mini-2026-03-17")`

210

211 - `GPT_5_4_NANO_2026_03_17("gpt-5.4-nano-2026-03-17")`

212

213 - `GPT_5_3_CHAT_LATEST("gpt-5.3-chat-latest")`

214

215 - `GPT_5_2("gpt-5.2")`

216

217 - `GPT_5_2_2025_12_11("gpt-5.2-2025-12-11")`

218

219 - `GPT_5_2_CHAT_LATEST("gpt-5.2-chat-latest")`

220

221 - `GPT_5_2_PRO("gpt-5.2-pro")`

222

223 - `GPT_5_2_PRO_2025_12_11("gpt-5.2-pro-2025-12-11")`

224

225 - `GPT_5_1("gpt-5.1")`

226

227 - `GPT_5_1_2025_11_13("gpt-5.1-2025-11-13")`

228

229 - `GPT_5_1_CODEX("gpt-5.1-codex")`

230

231 - `GPT_5_1_MINI("gpt-5.1-mini")`

232

233 - `GPT_5_1_CHAT_LATEST("gpt-5.1-chat-latest")`

234

235 - `GPT_5("gpt-5")`

236

237 - `GPT_5_MINI("gpt-5-mini")`

238

239 - `GPT_5_NANO("gpt-5-nano")`

240

241 - `GPT_5_2025_08_07("gpt-5-2025-08-07")`

242

243 - `GPT_5_MINI_2025_08_07("gpt-5-mini-2025-08-07")`

244

245 - `GPT_5_NANO_2025_08_07("gpt-5-nano-2025-08-07")`

246

247 - `GPT_5_CHAT_LATEST("gpt-5-chat-latest")`

248

249 - `GPT_4_1("gpt-4.1")`

250

251 - `GPT_4_1_MINI("gpt-4.1-mini")`

252

253 - `GPT_4_1_NANO("gpt-4.1-nano")`

254

255 - `GPT_4_1_2025_04_14("gpt-4.1-2025-04-14")`

256

257 - `GPT_4_1_MINI_2025_04_14("gpt-4.1-mini-2025-04-14")`

258

259 - `GPT_4_1_NANO_2025_04_14("gpt-4.1-nano-2025-04-14")`

260

261 - `O4_MINI("o4-mini")`

262

263 - `O4_MINI_2025_04_16("o4-mini-2025-04-16")`

264

265 - `O3("o3")`

266

267 - `O3_2025_04_16("o3-2025-04-16")`

268

269 - `O3_MINI("o3-mini")`

270

271 - `O3_MINI_2025_01_31("o3-mini-2025-01-31")`

272

273 - `O1("o1")`

274

275 - `O1_2024_12_17("o1-2024-12-17")`

276

277 - `O1_PREVIEW("o1-preview")`

278

279 - `O1_PREVIEW_2024_09_12("o1-preview-2024-09-12")`

280

281 - `O1_MINI("o1-mini")`

282

283 - `O1_MINI_2024_09_12("o1-mini-2024-09-12")`

284

285 - `GPT_4O("gpt-4o")`

286

287 - `GPT_4O_2024_11_20("gpt-4o-2024-11-20")`

288

289 - `GPT_4O_2024_08_06("gpt-4o-2024-08-06")`

290

291 - `GPT_4O_2024_05_13("gpt-4o-2024-05-13")`

292

293 - `GPT_4O_AUDIO_PREVIEW("gpt-4o-audio-preview")`

294

295 - `GPT_4O_AUDIO_PREVIEW_2024_10_01("gpt-4o-audio-preview-2024-10-01")`

296

297 - `GPT_4O_AUDIO_PREVIEW_2024_12_17("gpt-4o-audio-preview-2024-12-17")`

298

299 - `GPT_4O_AUDIO_PREVIEW_2025_06_03("gpt-4o-audio-preview-2025-06-03")`

300

301 - `GPT_4O_MINI_AUDIO_PREVIEW("gpt-4o-mini-audio-preview")`

302

303 - `GPT_4O_MINI_AUDIO_PREVIEW_2024_12_17("gpt-4o-mini-audio-preview-2024-12-17")`

304

305 - `GPT_4O_SEARCH_PREVIEW("gpt-4o-search-preview")`

306

307 - `GPT_4O_MINI_SEARCH_PREVIEW("gpt-4o-mini-search-preview")`

308

309 - `GPT_4O_SEARCH_PREVIEW_2025_03_11("gpt-4o-search-preview-2025-03-11")`

310

311 - `GPT_4O_MINI_SEARCH_PREVIEW_2025_03_11("gpt-4o-mini-search-preview-2025-03-11")`

312

313 - `CHATGPT_4O_LATEST("chatgpt-4o-latest")`

314

315 - `CODEX_MINI_LATEST("codex-mini-latest")`

316

317 - `GPT_4O_MINI("gpt-4o-mini")`

318

319 - `GPT_4O_MINI_2024_07_18("gpt-4o-mini-2024-07-18")`

320

321 - `GPT_4_TURBO("gpt-4-turbo")`

322

323 - `GPT_4_TURBO_2024_04_09("gpt-4-turbo-2024-04-09")`

324

325 - `GPT_4_0125_PREVIEW("gpt-4-0125-preview")`

326

327 - `GPT_4_TURBO_PREVIEW("gpt-4-turbo-preview")`

328

329 - `GPT_4_1106_PREVIEW("gpt-4-1106-preview")`

330

331 - `GPT_4_VISION_PREVIEW("gpt-4-vision-preview")`

332

333 - `GPT_4("gpt-4")`

334

335 - `GPT_4_0314("gpt-4-0314")`

336

337 - `GPT_4_0613("gpt-4-0613")`

338

339 - `GPT_4_32K("gpt-4-32k")`

340

341 - `GPT_4_32K_0314("gpt-4-32k-0314")`

342

343 - `GPT_4_32K_0613("gpt-4-32k-0613")`

344

345 - `GPT_3_5_TURBO("gpt-3.5-turbo")`

346

347 - `GPT_3_5_TURBO_16K("gpt-3.5-turbo-16k")`

348

349 - `GPT_3_5_TURBO_0301("gpt-3.5-turbo-0301")`

350

351 - `GPT_3_5_TURBO_0613("gpt-3.5-turbo-0613")`

352

353 - `GPT_3_5_TURBO_1106("gpt-3.5-turbo-1106")`

354

355 - `GPT_3_5_TURBO_0125("gpt-3.5-turbo-0125")`

356

357 - `GPT_3_5_TURBO_16K_0613("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 - `String key`

366

367 The key to compare against the value.

368

369 - `Type type`

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("eq")`

383

384 - `NE("ne")`

385

386 - `GT("gt")`

387

388 - `GTE("gte")`

389

390 - `LT("lt")`

391

392 - `LTE("lte")`

393

394 - `IN("in")`

395

396 - `NIN("nin")`

397

398 - `Value value`

399

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

401

402 - `String`

403

404 - `double`

405

406 - `boolean`

407

408 - `List<ComparisonFilterValueItem>`

409

410 - `String`

411

412 - `double`

413

414### Compound Filter

415

416- `class CompoundFilter:`

417

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

419

420 - `List<Filter> filters`

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 - `String key`

429

430 The key to compare against the value.

431

432 - `Type type`

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("eq")`

446

447 - `NE("ne")`

448

449 - `GT("gt")`

450

451 - `GTE("gte")`

452

453 - `LT("lt")`

454

455 - `LTE("lte")`

456

457 - `IN("in")`

458

459 - `NIN("nin")`

460

461 - `Value value`

462

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

464

465 - `String`

466

467 - `double`

468

469 - `boolean`

470

471 - `List<ComparisonFilterValueItem>`

472

473 - `String`

474

475 - `double`

476

477 - `JsonValue`

478

479 - `Type type`

480

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

482

483 - `AND("and")`

484

485 - `OR("or")`

486

487### Custom Tool Input Format

488

489- `class CustomToolInputFormat: A class that can be one of several variants.union`

490

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

492

493 - `JsonValue;`

494

495 - `JsonValue; type "text"constant`

496

497 Unconstrained text format. Always `text`.

498

499 - `TEXT("text")`

500

501 - `Grammar`

502

503 - `String definition`

504

505 The grammar definition.

506

507 - `Syntax syntax`

508

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

510

511 - `LARK("lark")`

512

513 - `REGEX("regex")`

514

515 - `JsonValue; type "grammar"constant`

516

517 Grammar format. Always `grammar`.

518

519 - `GRAMMAR("grammar")`

520

521### Error Object

522

523- `class ErrorObject:`

524

525 - `Optional<String> code`

526

527 - `String message`

528

529 - `Optional<String> param`

530

531 - `String type`

532

533### Function Definition

534

535- `class FunctionDefinition:`

536

537 - `String name`

538

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

540

541 - `Optional<String> description`

542

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

544

545 - `Optional<FunctionParameters> parameters`

546

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

548

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

550

551 - `Optional<Boolean> strict`

552

553 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).

554

555### Function Parameters

556

557- `class FunctionParameters:`

558

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

560

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

562

563### OAuth Error Code

564

565- `enum OAuthErrorCode:`

566

567 - `INVALID_GRANT("invalid_grant")`

568

569 - `INVALID_SUBJECT_TOKEN("invalid_subject_token")`

570

571### Reasoning

572

573- `class Reasoning:`

574

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

576

577 Configuration options for

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

579

580 - `Optional<ReasoningEffort> effort`

581

582 Constrains effort on reasoning for

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

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

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

586 on reasoning in a response.

587

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

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

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

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

592

593 - `NONE("none")`

594

595 - `MINIMAL("minimal")`

596

597 - `LOW("low")`

598

599 - `MEDIUM("medium")`

600

601 - `HIGH("high")`

602

603 - `XHIGH("xhigh")`

604

605 - `Optional<GenerateSummary> generateSummary`

606

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

608

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

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

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

612

613 - `AUTO("auto")`

614

615 - `CONCISE("concise")`

616

617 - `DETAILED("detailed")`

618

619 - `Optional<Summary> summary`

620

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

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

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

624

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

626

627 - `AUTO("auto")`

628

629 - `CONCISE("concise")`

630

631 - `DETAILED("detailed")`

632

633### Reasoning Effort

634

635- `enum ReasoningEffort:`

636

637 Constrains effort on reasoning for

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

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

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

641 on reasoning in a response.

642

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

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

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

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

647

648 - `NONE("none")`

649

650 - `MINIMAL("minimal")`

651

652 - `LOW("low")`

653

654 - `MEDIUM("medium")`

655

656 - `HIGH("high")`

657

658 - `XHIGH("xhigh")`

659

660### Response Format JSON Object

661

662- `class ResponseFormatJsonObject:`

663

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

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

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

667 to do so.

668

669 - `JsonValue; type "json_object"constant`

670

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

672

673 - `JSON_OBJECT("json_object")`

674

675### Response Format JSON Schema

676

677- `class ResponseFormatJsonSchema:`

678

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

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

681

682 - `JsonSchema jsonSchema`

683

684 Structured Outputs configuration options, including a JSON Schema.

685

686 - `String name`

687

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

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

690

691 - `Optional<String> description`

692

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

694 determine how to respond in the format.

695

696 - `Optional<Schema> schema`

697

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

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

700

701 - `Optional<Boolean> strict`

702

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

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

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

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

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

708

709 - `JsonValue; type "json_schema"constant`

710

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

712

713 - `JSON_SCHEMA("json_schema")`

714

715### Response Format Text

716

717- `class ResponseFormatText:`

718

719 Default response format. Used to generate text responses.

720

721 - `JsonValue; type "text"constant`

722

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

724

725 - `TEXT("text")`

726

727### Response Format Text Grammar

728

729- `class ResponseFormatTextGrammar:`

730

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

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

733

734 - `String grammar`

735

736 The custom grammar for the model to follow.

737

738 - `JsonValue; type "grammar"constant`

739

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

741

742 - `GRAMMAR("grammar")`

743

744### Response Format Text Python

745

746- `class ResponseFormatTextPython:`

747

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

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

750

751 - `JsonValue; type "python"constant`

752

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

754

755 - `PYTHON("python")`

756

757### Responses Model

758

759- `class ResponsesModel: A class that can be one of several variants.union`

760

761 - `String`

762

763 - `enum ChatModel:`

764

765 - `GPT_5_4("gpt-5.4")`

766

767 - `GPT_5_4_MINI("gpt-5.4-mini")`

768

769 - `GPT_5_4_NANO("gpt-5.4-nano")`

770

771 - `GPT_5_4_MINI_2026_03_17("gpt-5.4-mini-2026-03-17")`

772

773 - `GPT_5_4_NANO_2026_03_17("gpt-5.4-nano-2026-03-17")`

774

775 - `GPT_5_3_CHAT_LATEST("gpt-5.3-chat-latest")`

776

777 - `GPT_5_2("gpt-5.2")`

778

779 - `GPT_5_2_2025_12_11("gpt-5.2-2025-12-11")`

780

781 - `GPT_5_2_CHAT_LATEST("gpt-5.2-chat-latest")`

782

783 - `GPT_5_2_PRO("gpt-5.2-pro")`

784

785 - `GPT_5_2_PRO_2025_12_11("gpt-5.2-pro-2025-12-11")`

786

787 - `GPT_5_1("gpt-5.1")`

788

789 - `GPT_5_1_2025_11_13("gpt-5.1-2025-11-13")`

790

791 - `GPT_5_1_CODEX("gpt-5.1-codex")`

792

793 - `GPT_5_1_MINI("gpt-5.1-mini")`

794

795 - `GPT_5_1_CHAT_LATEST("gpt-5.1-chat-latest")`

796

797 - `GPT_5("gpt-5")`

798

799 - `GPT_5_MINI("gpt-5-mini")`

800

801 - `GPT_5_NANO("gpt-5-nano")`

802

803 - `GPT_5_2025_08_07("gpt-5-2025-08-07")`

804

805 - `GPT_5_MINI_2025_08_07("gpt-5-mini-2025-08-07")`

806

807 - `GPT_5_NANO_2025_08_07("gpt-5-nano-2025-08-07")`

808

809 - `GPT_5_CHAT_LATEST("gpt-5-chat-latest")`

810

811 - `GPT_4_1("gpt-4.1")`

812

813 - `GPT_4_1_MINI("gpt-4.1-mini")`

814

815 - `GPT_4_1_NANO("gpt-4.1-nano")`

816

817 - `GPT_4_1_2025_04_14("gpt-4.1-2025-04-14")`

818

819 - `GPT_4_1_MINI_2025_04_14("gpt-4.1-mini-2025-04-14")`

820

821 - `GPT_4_1_NANO_2025_04_14("gpt-4.1-nano-2025-04-14")`

822

823 - `O4_MINI("o4-mini")`

824

825 - `O4_MINI_2025_04_16("o4-mini-2025-04-16")`

826

827 - `O3("o3")`

828

829 - `O3_2025_04_16("o3-2025-04-16")`

830

831 - `O3_MINI("o3-mini")`

832

833 - `O3_MINI_2025_01_31("o3-mini-2025-01-31")`

834

835 - `O1("o1")`

836

837 - `O1_2024_12_17("o1-2024-12-17")`

838

839 - `O1_PREVIEW("o1-preview")`

840

841 - `O1_PREVIEW_2024_09_12("o1-preview-2024-09-12")`

842

843 - `O1_MINI("o1-mini")`

844

845 - `O1_MINI_2024_09_12("o1-mini-2024-09-12")`

846

847 - `GPT_4O("gpt-4o")`

848

849 - `GPT_4O_2024_11_20("gpt-4o-2024-11-20")`

850

851 - `GPT_4O_2024_08_06("gpt-4o-2024-08-06")`

852

853 - `GPT_4O_2024_05_13("gpt-4o-2024-05-13")`

854

855 - `GPT_4O_AUDIO_PREVIEW("gpt-4o-audio-preview")`

856

857 - `GPT_4O_AUDIO_PREVIEW_2024_10_01("gpt-4o-audio-preview-2024-10-01")`

858

859 - `GPT_4O_AUDIO_PREVIEW_2024_12_17("gpt-4o-audio-preview-2024-12-17")`

860

861 - `GPT_4O_AUDIO_PREVIEW_2025_06_03("gpt-4o-audio-preview-2025-06-03")`

862

863 - `GPT_4O_MINI_AUDIO_PREVIEW("gpt-4o-mini-audio-preview")`

864

865 - `GPT_4O_MINI_AUDIO_PREVIEW_2024_12_17("gpt-4o-mini-audio-preview-2024-12-17")`

866

867 - `GPT_4O_SEARCH_PREVIEW("gpt-4o-search-preview")`

868

869 - `GPT_4O_MINI_SEARCH_PREVIEW("gpt-4o-mini-search-preview")`

870

871 - `GPT_4O_SEARCH_PREVIEW_2025_03_11("gpt-4o-search-preview-2025-03-11")`

872

873 - `GPT_4O_MINI_SEARCH_PREVIEW_2025_03_11("gpt-4o-mini-search-preview-2025-03-11")`

874

875 - `CHATGPT_4O_LATEST("chatgpt-4o-latest")`

876

877 - `CODEX_MINI_LATEST("codex-mini-latest")`

878

879 - `GPT_4O_MINI("gpt-4o-mini")`

880

881 - `GPT_4O_MINI_2024_07_18("gpt-4o-mini-2024-07-18")`

882

883 - `GPT_4_TURBO("gpt-4-turbo")`

884

885 - `GPT_4_TURBO_2024_04_09("gpt-4-turbo-2024-04-09")`

886

887 - `GPT_4_0125_PREVIEW("gpt-4-0125-preview")`

888

889 - `GPT_4_TURBO_PREVIEW("gpt-4-turbo-preview")`

890

891 - `GPT_4_1106_PREVIEW("gpt-4-1106-preview")`

892

893 - `GPT_4_VISION_PREVIEW("gpt-4-vision-preview")`

894

895 - `GPT_4("gpt-4")`

896

897 - `GPT_4_0314("gpt-4-0314")`

898

899 - `GPT_4_0613("gpt-4-0613")`

900

901 - `GPT_4_32K("gpt-4-32k")`

902

903 - `GPT_4_32K_0314("gpt-4-32k-0314")`

904

905 - `GPT_4_32K_0613("gpt-4-32k-0613")`

906

907 - `GPT_3_5_TURBO("gpt-3.5-turbo")`

908

909 - `GPT_3_5_TURBO_16K("gpt-3.5-turbo-16k")`

910

911 - `GPT_3_5_TURBO_0301("gpt-3.5-turbo-0301")`

912

913 - `GPT_3_5_TURBO_0613("gpt-3.5-turbo-0613")`

914

915 - `GPT_3_5_TURBO_1106("gpt-3.5-turbo-1106")`

916

917 - `GPT_3_5_TURBO_0125("gpt-3.5-turbo-0125")`

918

919 - `GPT_3_5_TURBO_16K_0613("gpt-3.5-turbo-16k-0613")`

920

921 - `ResponsesOnlyModel`

922

923 - `O1_PRO("o1-pro")`

924

925 - `O1_PRO_2025_03_19("o1-pro-2025-03-19")`

926

927 - `O3_PRO("o3-pro")`

928

929 - `O3_PRO_2025_06_10("o3-pro-2025-06-10")`

930

931 - `O3_DEEP_RESEARCH("o3-deep-research")`

932

933 - `O3_DEEP_RESEARCH_2025_06_26("o3-deep-research-2025-06-26")`

934

935 - `O4_MINI_DEEP_RESEARCH("o4-mini-deep-research")`

936

937 - `O4_MINI_DEEP_RESEARCH_2025_06_26("o4-mini-deep-research-2025-06-26")`

938

939 - `COMPUTER_USE_PREVIEW("computer-use-preview")`

940

941 - `COMPUTER_USE_PREVIEW_2025_03_11("computer-use-preview-2025-03-11")`

942

943 - `GPT_5_CODEX("gpt-5-codex")`

944

945 - `GPT_5_PRO("gpt-5-pro")`

946

947 - `GPT_5_PRO_2025_10_06("gpt-5-pro-2025-10-06")`

948

949 - `GPT_5_1_CODEX_MAX("gpt-5.1-codex-max")`