`parseAsType` API gives an error for valid Json value while converting to an expected type

[SasinduDilshara]

Problem

The following code gives the following error

import ballerina/data.jsondata;
import ballerina/io;
json v = {
  "id": "xxx",
  "object": "response",
  "created_at": 1771847449,
  "status": "completed",
  "background": false,
  "billing": {
    "payer": "developer"
  },
  "completed_at": 1771847494,
  "error": null,
  "frequency_penalty": 0.0,
  "incomplete_details": null,
  "instructions": null,
  "max_output_tokens": 16384,
  "max_tool_calls": null,
  "model": "gpt-5-mini-2025-08-07",
  "output": [
    {
      "id": "xxx",
      "type": "reasoning",
      "summary": []
    },
    {
      "id": "xxx",
      "type": "code_interpreter_call",
      "status": "completed",
      "code": "# The following string contains the Python code used for all steps.\n# We'll print the code first, then execute it so you can see both the code and the results.\n\ncode = r\"\"\"\n# 1. Generate the first 30 Fibonacci numbers (using F1 = 1, F2 = 1)\ndef generate_fibonacci(n):\n    if n <= 0:\n        return []\n    if n == 1:\n        return [1]\n    fibs = [1, 1]\n    for _ in range(2, n):\n        fibs.append(fibs[-1] + fibs[-2])\n    return fibs\n\n# 2. For each consecutive pair, calculate their ratio and compare to phi\nfrom math import sqrt\n\nphi = (1 + sqrt(5)) / 2\n\n# 3. Primality test for small integers\ndef is_prime(num):\n    if num <= 1:\n        return False\n    if num <= 3:\n        return True\n    if num % 2 == 0:\n        return False\n    r = int(num**0.5)\n    for i in range(3, r+1, 2):\n        if num % i == 0:\n            return False\n    return True\n\n# 4. Sum of even Fibonacci numbers among the first n\ndef sum_even_fibs(fibs):\n    return sum(x for x in fibs if x % 2 == 0)\n\n# 5. Verify identity: sum of first n Fibonacci numbers = F(n+2) - 1\n# (Using 1-indexed F1=1... so F(n+2) corresponds to fibs[n+1] in 0-indexed list)\n\n# Generate first 30 Fibonacci numbers\nn_total = 30\nfibs = generate_fibonacci(n_total)\n\n# Display results\nprint(\"1) First 30 Fibonacci numbers (F1 = 1, F2 = 1):\")\nprint(fibs)\nprint()\n\n# Ratios and convergence to phi\nprint(\"2) Ratios F(n+1)/F(n) for n = 1..29 and difference to phi:\")\nprint(f\"{'n':>2} {'F(n)':>10} {'F(n+1)':>10} {'Ratio':>18} {'|Ratio - phi|':>18}\")\nfor i in range(len(fibs)-1):\n    a = fibs[i]\n    b = fibs[i+1]\n    ratio = b / a\n    diff = abs(ratio - phi)\n    print(f\"{i+1:2d} {a:10d} {b:10d} {ratio:18.12f} {diff:18.12f}\")\nprint()\nprint(f\"Reference phi = (1 + sqrt(5)) / 2 = {phi:.12f}\")\nprint()\n\n# Prime Fibonacci numbers among first 30\nprime_fibs = [x for x in fibs if is_prime(x)]\nprint(\"3) Fibonacci numbers among the first 30 that are prime:\")\nprint(prime_fibs)\nprint()\n\n# Sum of even Fibonacci numbers in the first 30\nsum_even = sum_even_fibs(fibs)\nprint(\"4) Sum of all even Fibonacci numbers among the first 30:\")\nprint(sum_even)\nprint()\n\n# 5) Verify identity for n = 10, 20, 30\nprint(\"5) Verify sum_{k=1..n} F(k) = F(n+2) - 1 for n = 10, 20, 30\")\nfor n in [10, 20, 30]:\n    sum_first_n = sum(fibs[:n])\n    # F(n+2) is fibs[n+1] (0-indexed)\n    fnp2 = generate_fibonacci(n+2)[-1]  # safe way to get F(n+2)\n    rhs = fnp2 - 1\n    holds = (sum_first_n == rhs)\n    print(f\"n = {n}: sum(F1..F{n}) = {sum_first_n}, F({n+2}) - 1 = {rhs} -> holds: {holds}\")\n\"\"\"\n\nprint(\"=== Python code used ===\")\nprint(code)\nprint(\"=== Output ===\")\nexec(code)",
      "container_id": "cntr_699c3f1d93d08190aa2505fbdd08e00909b7a43cf5b4fc32",
      "outputs": null
    },
    {
      "id": "xxx",
      "type": "message",
      "status": "completed",
      "content": [
        {
          "type": "output_text",
          "annotations": [],
          "logprobs": [],
          "text": "I ran the Python code (shown above) and produced the requested calculations. Summary of the results:\n\n- Definition used: Fibonacci sequence with F1 = 1, F2 = 1 (so the list begins 1, 1, 2, 3, ...).\n\n1) First 30 Fibonacci numbers:\n[1, 1, 2, 3, 5, 8, 13, 21, 34, 55, 89, 144, 233, 377, 610, 987, 1597, 2584, 4181, 6765, 10946, 17711, 28657, 46368, 75025, 121393, 196418, 317811, 514229, 832040]\n\n2) Ratios F(n+1)/F(n) and convergence to phi:\nI printed the ratio for n = 1..29 (showing F(n), F(n+1), the ratio, and |ratio - phi|). The ratios converge to phi = (1 + sqrt(5)) / 2 ≈ 1.618033988750. Example values (ratio, |difference|):\n- n=1: ratio = 1.000000000000, |diff| = 0.618033988750\n- n=5: ratio = 1.600000000000, |diff| = 0.018033988750\n- n=10: ratio = 1.618181818182, |diff| = 0.000147829432\n- n=20: ratio = 1.618033998522, |diff| = 0.000000009772\n- n=29: ratio = 1.618033988748, |diff| = 0.000000000002\n\nThis shows clear convergence toward phi.\n\n3) Fibonacci numbers among the first 30 that are prime:\n[2, 3, 5, 13, 89, 233, 1597, 28657, 514229]\n\n4) Sum of all even Fibonacci numbers in the first 30:\n1089154\n\n5) Verification of the identity sum_{k=1..n} F(k) = F(n+2) - 1 for n = 10, 20, 30:\n- n = 10: sum = 143, F(12) - 1 = 143 -> holds: True\n- n = 20: sum = 17710, F(22) - 1 = 17710 -> holds: True\n- n = 30: sum = 2178308, F(32) - 1 = 2178308 -> holds: True\n\nThe full Python code used and the exact printed outputs are included above. If you want the code saved to a file (e.g., .py) or want me to run variants (different Fibonacci start values, more terms, or additional visualizations), tell me and I'll produce them."
        }
      ],
      "role": "assistant"
    }
  ],
  "parallel_tool_calls": true,
  "presence_penalty": 0.0,
  "previous_response_id": null,
  "prompt_cache_key": null,
  "prompt_cache_retention": null,
  "reasoning": {
    "effort": "medium",
    "summary": null
  },
  "safety_identifier": null,
  "service_tier": "default",
  "store": true,
  "temperature": 1.0,
  "text": {
    "format": {
      "type": "text"
    },
    "verbosity": "medium"
  },
  "tool_choice": "auto",
  "tools": [
    {
      "type": "code_interpreter",
      "container": {
        "type": "auto"
      }
    }
  ],
  "top_logprobs": 0,
  "top_p": 1.0,
  "truncation": "disabled",
  "usage": {
    "input_tokens": 5001,
    "input_tokens_details": {
      "cached_tokens": 0
    },
    "output_tokens": 2856,
    "output_tokens_details": {
      "reasoning_tokens": 1280
    },
    "total_tokens": 7857
  },
  "user": null,
  "metadata": {}
};

public function main() returns error? {
    Response r = check jsondata:parseAsType(v);
    io:println("Parsed response object: ", r);
}

error: required field 'encrypted_content' not present in JSON

Proposed Solution

Fix the bug in the parseAsType to allow parsing union types

Alternatives

No response

Version

No response

[SasinduDilshara]

Types

// AUTO-GENERATED FILE. DO NOT MODIFY.
// This file is auto-generated by the Ballerina OpenAPI tool.

// Copyright (c) 2024, WSO2 LLC. (http://www.wso2.com).
//
// WSO2 LLC. licenses this file to you under the Apache License,
// Version 2.0 (the "License"); you may not use this file except
// in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied.  See the License for the
// specific language governing permissions and limitations
// under the License.

import ballerina/constraint;

public type ResponseProperties record {
    # The unique ID of the previous response to the model. Use this to
    # create multi-turn conversations. Learn more about
    # [conversation state](/docs/guides/conversation-state). Cannot be used in conjunction with `conversation`.
    string? previous_response_id?;
    ModelIdsResponses model?;
    # **gpt-5 and o-series models only**
    # 
    # Configuration options for
    # [reasoning models](https://platform.openai.com/docs/guides/reasoning).
    Reasoning reasoning?;
    # Whether to run the model response in the background.
    # [Learn more](/docs/guides/background).
    boolean? background = false;
    # An upper bound for the number of tokens that can be generated for a response, including visible output tokens and [reasoning tokens](/docs/guides/reasoning).
    int? max_output_tokens?;
    # The maximum number of total calls to built-in tools that can be processed in a response. This maximum number applies across all built-in tool calls, not per individual tool. Any further attempts to call a tool by the model will be ignored.
    int? max_tool_calls?;
    # Configuration options for a text response from the model. Can be plain
    # text or structured JSON data. Learn more:
    # - [Text inputs and outputs](/docs/guides/text)
    # - [Structured Outputs](/docs/guides/structured-outputs)
    ResponseTextParam text?;
    # An array of tools the model may call while generating a response. You
    # can specify which tool to use by setting the `tool_choice` parameter.
    # 
    # We support the following categories of tools:
    # - **Built-in tools**: Tools that are provided by OpenAI that extend the
    #   model's capabilities, like [web search](/docs/guides/tools-web-search)
    #   or [file search](/docs/guides/tools-file-search). Learn more about
    #   [built-in tools](/docs/guides/tools).
    # - **MCP Tools**: Integrations with third-party systems via custom MCP servers
    #   or predefined connectors such as Google Drive and SharePoint. Learn more about
    #   [MCP Tools](/docs/guides/tools-connectors-mcp).
    # - **Function calls (custom tools)**: Functions that are defined by you,
    #   enabling the model to call your own code with strongly typed arguments
    #   and outputs. Learn more about
    #   [function calling](/docs/guides/function-calling). You can also use
    #   custom tools to call your own code.
    ToolsArray tools?;
    # How the model should select which tool (or tools) to use when generating
    # a response. See the `tools` parameter to see how to specify which tools
    # the model can call.
    ToolChoiceParam tool_choice?;
    # Reference to a prompt template and its variables.
    # [Learn more](/docs/guides/text?api-mode=responses#reusable-prompts).
    Prompt? prompt?;
    # The truncation strategy to use for the model response.
    # - `auto`: If the input to this Response exceeds
    #   the model's context window size, the model will truncate the
    #   response to fit the context window by dropping items from the beginning of the conversation.
    # - `disabled` (default): If the input size will exceed the context window
    #   size for a model, the request will fail with a 400 error.
    "auto"|"disabled"? truncation = "disabled";
};

# A description of the chain of thought used by a reasoning model while generating
# a response. Be sure to include these items in your `input` to the Responses API
# for subsequent turns of a conversation if you are manually
# [managing context](/docs/guides/conversation-state).
public type ReasoningItem record {
    # The type of the object. Always `reasoning`.
    "reasoning" 'type;
    # The unique identifier of the reasoning content.
    string id;
    # The encrypted content of the reasoning item - populated when a response is
    # generated with `reasoning.encrypted_content` in the `include` parameter.
    string? encrypted_content?;
    # Reasoning summary content.
    SummaryTextContent[] summary;
    # Reasoning text content.
    ReasoningTextContent[] content?;
    # The status of the item. One of `in_progress`, `completed`, or
    # `incomplete`. Populated when items are returned via API.
    "in_progress"|"completed"|"incomplete" status?;
};

public type ApplyPatchCallStatus "in_progress"|"completed";

# Execute a shell command on the server.
public type LocalShellExecAction record {
    # The type of the local shell action. Always `exec`.
    "exec" 'type = "exec";
    # The command to run.
    string[] command;
    # Optional timeout in milliseconds for the command.
    int? timeout_ms?;
    # Optional working directory to run the command in.
    string? working_directory?;
    # Environment variables to set for the command.
    record {|string...;|} env;
    # Optional user to run the command as.
    string? user?;
};

# The streamed output emitted by an apply patch tool call.
public type ApplyPatchToolCallOutputItemParam record {
    # The type of the item. Always `apply_patch_call_output`.
    "apply_patch_call_output" 'type = "apply_patch_call_output";
    # The unique ID of the apply patch tool call output. Populated when this item is returned via API.
    string? id?;
    # The unique ID of the apply patch tool call generated by the model.
    @constraint:String {maxLength: 64, minLength: 1}
    string call_id;
    # Outcome values reported for apply_patch tool call outputs.
    ApplyPatchCallOutputStatusParam status;
    # Optional human-readable log text from the apply patch tool (e.g., patch results or errors).
    string? output?;
};

# A citation to a file.
public type FileCitationBody record {
    # The type of the file citation. Always `file_citation`.
    "file_citation" 'type = "file_citation";
    # The ID of the file.
    string file_id;
    # The index of the file in the list of files.
    int index;
    # The filename of the file cited.
    string filename;
};

# Constrains the verbosity of the model's response. Lower values will result in
# more concise responses, while higher values will result in more verbose responses.
# Currently supported values are `low`, `medium`, and `high`.
public type Verbosity "low"|"medium"|"high"?;

public type ApplyPatchCallOutputStatus "completed"|"failed";

# A tool call representing a request to create, delete, or update files using diff patches.
public type ApplyPatchToolCallItemParam record {
    # The type of the item. Always `apply_patch_call`.
    "apply_patch_call" 'type = "apply_patch_call";
    # The unique ID of the apply patch tool call. Populated when this item is returned via API.
    string? id?;
    # The unique ID of the apply patch tool call generated by the model.
    @constraint:String {maxLength: 64, minLength: 1}
    string call_id;
    # Status values reported for apply_patch tool calls.
    ApplyPatchCallStatusParam status;
    # One of the create_file, delete_file, or update_file operations supplied to the apply_patch tool.
    ApplyPatchOperationParam operation;
};

public type LocalEnvironmentParam record {
    # Use a local computer environment.
    "local" 'type = "local";
    # An optional list of skills.
    @constraint:Array {maxLength: 200}
    LocalSkillParam[] skills?;
};

# Controls which (if any) tool is called by the model.
# 
# `none` means the model will not call any tool and instead generates a message.
# 
# `auto` means the model can pick between generating a message or calling one or
# more tools.
# 
# `required` means the model must call one or more tools.
public type ToolChoiceOptions "none"|"auto"|"required";

public type FunctionCallItemStatus "in_progress"|"completed"|"incomplete";

# Indicates that the shell commands finished and returned an exit code.
public type FunctionShellCallOutputExitOutcomeParam record {
    # The outcome type. Always `exit`.
    "exit" 'type = "exit";
    # The exit code returned by the shell process.
    int exit_code;
};

# An array of tools the model may call while generating a response. You
# can specify which tool to use by setting the `tool_choice` parameter.
# 
# We support the following categories of tools:
# - **Built-in tools**: Tools that are provided by OpenAI that extend the
#   model's capabilities, like [web search](/docs/guides/tools-web-search)
#   or [file search](/docs/guides/tools-file-search). Learn more about
#   [built-in tools](/docs/guides/tools).
# - **MCP Tools**: Integrations with third-party systems via custom MCP servers
#   or predefined connectors such as Google Drive and SharePoint. Learn more about
#   [MCP Tools](/docs/guides/tools-connectors-mcp).
# - **Function calls (custom tools)**: Functions that are defined by you,
#   enabling the model to call your own code with strongly typed arguments
#   and outputs. Learn more about
#   [function calling](/docs/guides/function-calling). You can also use
#   custom tools to call your own code.
public type ToolsArray Tool[];

# An action to type in text.
public type TypeParam record {
    # Specifies the event type. For a type action, this property is always set to `type`.
    "type" 'type = "type";
    # The text to type.
    string text;
};

# A citation for a container file used to generate a model response.
public type ContainerFileCitationBody record {
    # The type of the container file citation. Always `container_file_citation`.
    "container_file_citation" 'type = "container_file_citation";
    # The ID of the container file.
    string container_id;
    # The ID of the file.
    string file_id;
    # The index of the first character of the container file citation in the message.
    int start_index;
    # The index of the last character of the container file citation in the message.
    int end_index;
    # The filename of the container file cited.
    string filename;
};

# A computer screenshot image used with the computer use tool.
public type ComputerScreenshotImage record {
    # Specifies the event type. For a computer screenshot, this property is 
    # always set to `computer_screenshot`.
    "computer_screenshot" 'type = "computer_screenshot";
    # The URL of the screenshot image.
    string image_url?;
    # The identifier of an uploaded file that contains the screenshot.
    string file_id?;
};

# A tool call to a computer use tool. See the
# [computer use guide](/docs/guides/tools-computer-use) for more information.
public type ComputerToolCall record {
    # The type of the computer call. Always `computer_call`.
    "computer_call" 'type = "computer_call";
    # The unique ID of the computer call.
    string id;
    # An identifier used when responding to the tool call with output.
    string call_id;
    ComputerAction action;
    # The pending safety checks for the computer call.
    ComputerCallSafetyCheckParam[] pending_safety_checks;
    # The status of the item. One of `in_progress`, `completed`, or
    # `incomplete`. Populated when items are returned via API.
    "in_progress"|"completed"|"incomplete" status;
};

public type OutputItem OutputMessage|FileSearchToolCall|FunctionToolCall|WebSearchToolCall|ComputerToolCall|ReasoningItem|CompactionBody|CodeInterpreterToolCall|LocalShellToolCall|FunctionShellCall|FunctionShellCallOutput|ApplyPatchToolCall|ApplyPatchToolCallOutput|MCPToolCall|MCPListTools|MCPApprovalRequest|CustomToolCall;
// public type OutputItem OutputMessage|FileSearchToolCall|FunctionToolCall|WebSearchToolCall|ComputerToolCall|ReasoningItem|CompactionBody|ImageGenToolCall|CodeInterpreterToolCall|LocalShellToolCall|FunctionShellCall|FunctionShellCallOutput|ApplyPatchToolCall|ApplyPatchToolCallOutput|MCPToolCall|MCPListTools|MCPApprovalRequest|CustomToolCall;

# A filter used to compare a specified attribute key to a given value using a defined comparison operation.
public type ComparisonFilter record {|
    # 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" 'type = "eq";
    # The key to compare against the value.
    string 'key;
    # The value to compare against the attribute key; supports string, number, or boolean types.
    string|decimal|boolean|(string|decimal)[] value;
|};

# A custom tool that processes input using a specified format. Learn more about   [custom tools](/docs/guides/function-calling#custom-tools)
public type CustomToolParam record {
    # The type of the custom tool. Always `custom`.
    "custom" 'type = "custom";
    # The name of the custom tool, used to identify it in tool calls.
    string name;
    # Optional description of the custom tool, used to provide more context.
    string description?;
    # The input format for the custom tool. Default is unconstrained text.
    CustomTextFormatParam|CustomGrammarFormatParam format?;
};

# An invocation of a tool on an MCP server.
public type MCPToolCall record {
    # The type of the item. Always `mcp_call`.
    "mcp_call" 'type;
    # The unique ID of the tool call.
    string id;
    # The label of the MCP server running the tool.
    string server_label;
    # The name of the tool that was run.
    string name;
    # A JSON string of the arguments passed to the tool.
    string arguments;
    # The output from the tool call.
    string? output?;
    # The error from the tool call, if any.
    string? 'error?;
    MCPToolCallStatus status?;
    # Unique identifier for the MCP tool call approval request.
    # Include this value in a subsequent `mcp_approval_response` input to approve or reject the corresponding tool call.
    string? approval_request_id?;
};

# Details about why the response is incomplete.
public type Response_incomplete_details record {
    # The reason why the response is incomplete.
    "max_output_tokens"|"content_filter" reason?;
};

public type ContainerNetworkPolicyAllowlistParam record {
    # Allow outbound network access only to specified domains. Always `allowlist`.
    "allowlist" 'type = "allowlist";
    # A list of allowed domains when type is `allowlist`.
    @constraint:Array {minLength: 1}
    string[] allowed_domains;
    # Optional domain-scoped secrets for allowlisted domains.
    @constraint:Array {minLength: 1}
    ContainerNetworkPolicyDomainSecretParam[] domain_secrets?;
};

# Forces the model to call the apply_patch tool when executing a tool call.
public type SpecificApplyPatchParam record {
    # The tool to call. Always `apply_patch`.
    "apply_patch" 'type = "apply_patch";
};

# A mouse move action.
public type MoveParam record {
    # Specifies the event type. For a move action, this property is always set to `move`.
    "move" 'type = "move";
    # The x-coordinate to move to.
    int x;
    # The y-coordinate to move to.
    int y;
};

# **gpt-5 and o-series models only**
# 
# Configuration options for
# [reasoning models](https://platform.openai.com/docs/guides/reasoning).
public type Reasoning record {
    # Constrains effort on reasoning for
    # [reasoning models](https://platform.openai.com/docs/guides/reasoning).
    # 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`.
    ReasoningEffort? effort?;
    # 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"? summary?;
    # **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`.
    # 
    # # Deprecated
    @deprecated
    "auto"|"concise"|"detailed"? generate_summary?;
};

# A message input to the model with a role indicating instruction following
# hierarchy. Instructions given with the `developer` or `system` role take
# precedence over instructions given with the `user` role.
public type InputMessage record {
    # The type of the message input. Always set to `message`.
    "message" 'type?;
    # The role of the message input. One of `user`, `system`, or `developer`.
    "user"|"system"|"developer" role;
    # The status of item. One of `in_progress`, `completed`, or
    # `incomplete`. Populated when items are returned via API.
    "in_progress"|"completed"|"incomplete" status?;
    # A list of one or many input items to the model, containing different content 
    # types.
    InputMessageContentList content;
};

public type RankerVersionType "auto"|"default-2024-11-15";

# Inline skill payload
public type InlineSkillSourceParam record {
    # The type of the inline skill source. Must be `base64`.
    "base64" 'type = "base64";
    # The media type of the inline skill payload. Must be `application/zip`.
    "application/zip" media_type = "application/zip";
    # Base64-encoded skill zip bundle.
    @constraint:String {maxLength: 70254592, minLength: 1}
    string data;
};

# A response to an MCP approval request.
public type MCPApprovalResponse record {
    # The type of the item. Always `mcp_approval_response`.
    "mcp_approval_response" 'type;
    # The unique ID of the approval response
    string? id?;
    # The ID of the approval request being answered.
    string approval_request_id;
    # Whether the request was approved.
    boolean approve;
    # Optional reason for the decision.
    string? reason?;
};

# Control how much effort the model will exert to match the style and features, especially facial features, of input images. This parameter is only supported for `gpt-image-1` and `gpt-image-1.5` and later models, unsupported for `gpt-image-1-mini`. Supports `high` and `low`. Defaults to `low`.
public type InputFidelity "high"|"low";

# A tool call to run a function. See the 
# [function calling guide](/docs/guides/function-calling) for more information.
public type FunctionToolCall record {
    # The unique ID of the function tool call.
    string id?;
    # The type of the function tool call. Always `function_call`.
    "function_call" 'type;
    # The unique ID of the function tool call generated by the model.
    string call_id;
    # The name of the function to run.
    string name;
    # A JSON string of the arguments to pass to the function.
    string arguments;
    # The status of the item. One of `in_progress`, `completed`, or
    # `incomplete`. Populated when items are returned via API.
    "in_progress"|"completed"|"incomplete" status?;
};

public type FunctionAndCustomToolCallOutput InputTextContent|InputImageContent|InputFileContent;

# The output of a function tool call.
public type FunctionCallOutputItemParam record {
    # The unique ID of the function tool call output. Populated when this item is returned via API.
    string? id?;
    # The unique ID of the function tool call generated by the model.
    @constraint:String {maxLength: 64, minLength: 1}
    string call_id;
    # The type of the function tool call output. Always `function_call_output`.
    "function_call_output" 'type = "function_call_output";
    # Text, image, or file output of the function tool call.
    string|(InputTextContentParam|InputImageContentParamAutoParam|InputFileContentParam)[] output;
    FunctionCallItemStatus status?;
};

# Give the model access to additional tools via remote Model Context Protocol
# (MCP) servers. [Learn more about MCP](/docs/guides/tools-remote-mcp).
public type MCPTool record {
    # The type of the MCP tool. Always `mcp`.
    "mcp" 'type;
    # A label for this MCP server, used to identify it in tool calls.
    string server_label;
    # The URL for the MCP server. One of `server_url` or `connector_id` must be
    # provided.
    string server_url?;
    # Identifier for service connectors, like those available in ChatGPT. One of
    # `server_url` or `connector_id` must be provided. Learn more about service
    # connectors [here](/docs/guides/tools-remote-mcp#connectors).
    # 
    # Currently supported `connector_id` values are:
    # 
    # - Dropbox: `connector_dropbox`
    # - Gmail: `connector_gmail`
    # - Google Calendar: `connector_googlecalendar`
    # - Google Drive: `connector_googledrive`
    # - Microsoft Teams: `connector_microsoftteams`
    # - Outlook Calendar: `connector_outlookcalendar`
    # - Outlook Email: `connector_outlookemail`
    # - SharePoint: `connector_sharepoint`
    "connector_dropbox"|"connector_gmail"|"connector_googlecalendar"|"connector_googledrive"|"connector_microsoftteams"|"connector_outlookcalendar"|"connector_outlookemail"|"connector_sharepoint" connector_id?;
    # An OAuth access token that can be used with a remote MCP server, either
    # with a custom MCP server URL or a service connector. Your application
    # must handle the OAuth authorization flow and provide the token here.
    string authorization?;
    # Optional description of the MCP server, used to provide more context.
    string server_description?;
    # Optional HTTP headers to send to the MCP server. Use for authentication
    # or other purposes.
    record {|string...;|}? headers?;
    # List of allowed tool names or a filter object.
    string[]|MCPToolFilter? allowed_tools?;
    # Specify which of the MCP server's tools require approval.
    record {|MCPToolFilter always?; MCPToolFilter 'never?;|}|"always"|"never"? require_approval = "always";
};

# A screenshot action.
public type ScreenshotParam record {
    # Specifies the event type. For a screenshot action, this property is always set to `screenshot`.
    "screenshot" 'type = "screenshot";
};

# A tool that searches for relevant content from uploaded files. Learn more about the [file search tool](https://platform.openai.com/docs/guides/tools-file-search).
public type FileSearchTool record {
    # The type of the file search tool. Always `file_search`.
    "file_search" 'type = "file_search";
    # The IDs of the vector stores to search.
    string[] vector_store_ids;
    # The maximum number of results to return. This number should be between 1 and 50 inclusive.
    int max_num_results?;
    RankingOptions ranking_options?;
    Filters filters?;
};

public type ContainerReferenceParam record {
    # References a container created with the /v1/containers endpoint
    "container_reference" 'type = "container_reference";
    # The ID of the referenced container.
    string container_id;
};

# The top log probability of a token.
public type TopLogProb record {
    string token;
    decimal logprob;
    int[] bytes;
};

public type ClickButtonType "left"|"right"|"wheel"|"back"|"forward";

# A detailed breakdown of the output tokens.
public type Batch_usage_output_tokens_details record {
    # The number of reasoning tokens.
    int reasoning_tokens;
};

public type ContainerMemoryLimit "1g"|"4g"|"16g"|"64g";

public type GrammarSyntax1 "lark"|"regex";

# A text output from the model.
public type OutputTextContent record {
    # The type of the output text. Always `output_text`.
    "output_text" 'type = "output_text";
    # The text output from the model.
    string text;
    # The annotations of the text output.
    Annotation[] annotations;
    LogProb[] logprobs;
};

public type ContainerNetworkPolicyDomainSecretParam record {
    # The domain associated with the secret.
    @constraint:String {minLength: 1}
    string domain;
    # The name of the secret to inject for the domain.
    @constraint:String {minLength: 1}
    string name;
    # The secret value to inject for the domain.
    @constraint:String {maxLength: 10485760, minLength: 1}
    string value;
};

# Filters for the search.
public type WebSearchTool_filters record {
    # Allowed domains for the search. If not provided, all domains are allowed.
    # Subdomains of the provided domains are allowed as well.
    # 
    # Example: `["pubmed.ncbi.nlm.nih.gov"]`
    string[]? allowed_domains = [];
};

# Reasoning text from the model.
public type ReasoningTextContent record {
    # The type of the reasoning text. Always `reasoning_text`.
    "reasoning_text" 'type = "reasoning_text";
    # The reasoning text from the model.
    string text;
};

# The results of a web search tool call. See the
# [web search guide](/docs/guides/tools-web-search) for more information.
public type WebSearchToolCall record {
    # The unique ID of the web search tool call.
    string id;
    # The type of the web search tool call. Always `web_search_call`.
    "web_search_call" 'type;
    # The status of the web search tool call.
    "in_progress"|"searching"|"completed"|"failed" status;
    # An object describing the specific action taken in this web search call.
    # Includes details on how the model used the web (search, open_page, find_in_page).
    WebSearchActionSearch|WebSearchActionOpenPage|WebSearchActionFind action;
};

public type FileSearchToolCall_results record {
    # The unique ID of the file.
    string file_id?;
    # The text that was retrieved from the file.
    string text?;
    # The name of the file.
    string filename?;
    # 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, booleans, or numbers.
    VectorStoreFileAttributes? attributes?;
    # The relevance score of the file - a value between 0 and 1.
    float score?;
};

# An image input to the model. Learn about [image inputs](/docs/guides/vision).
public type InputImageContent record {
    # The type of the input item. Always `input_image`.
    "input_image" 'type = "input_image";
    # The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL.
    string? image_url?;
    # The ID of the file to be sent to the model.
    string? file_id?;
    ImageDetail detail;
};

# Specifies the processing type used for serving the request.
#   - If set to 'auto', then the request will be processed with the service tier configured in the Project settings. Unless otherwise configured, the Project will use 'default'.
#   - If set to 'default', then the request will be processed with the standard pricing and performance for the selected model.
#   - If set to '[flex](/docs/guides/flex-processing)' or '[priority](https://openai.com/api-priority-processing/)', then the request will be processed with the corresponding service tier.
#   - When not set, the default behavior is 'auto'.
# 
#   When the `service_tier` parameter is set, the response body will include the `service_tier` value based on the processing mode actually used to serve the request. This response value may be different from the value set in the parameter.
public type ServiceTier "auto"|"default"|"flex"|"scale"|"priority"?;

public type ImageGenActionEnum "generate"|"edit"|"auto";

# A message input to the model with a role indicating instruction following
# hierarchy. Instructions given with the `developer` or `system` role take
# precedence over instructions given with the `user` role. Messages with the
# `assistant` role are presumed to have been generated by the model in previous
# interactions.
public type EasyInputMessage record {
    # The role of the message input. One of `user`, `assistant`, `system`, or
    # `developer`.
    "user"|"assistant"|"system"|"developer" role;
    # Text, image, or audio input to the model, used to generate a response.
    # Can also contain previous assistant responses.
    string|InputMessageContentList content;
    # The type of the message input. Always `message`.
    "message" 'type?;
};

# A tool available on an MCP server.
public type MCPListToolsTool record {
    # The name of the tool.
    string name;
    # The description of the tool.
    string? description?;
    # The JSON schema describing the tool's input.
    record {} input_schema;
    # Additional annotations about the tool.
    record {}? annotations?;
};

# Represents token usage details including input tokens, output tokens,
# a breakdown of output tokens, and the total tokens used.
public type ResponseUsage record {
    # The number of input tokens.
    int input_tokens;
    # A detailed breakdown of the input tokens.
    ResponseUsage_input_tokens_details input_tokens_details;
    # The number of output tokens.
    int output_tokens;
    # A detailed breakdown of the output tokens.
    Batch_usage_output_tokens_details output_tokens_details;
    # The total number of tokens used.
    int total_tokens;
};

# 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, booleans, or numbers.
public type VectorStoreFileAttributes record {
};

# Configuration options for a text response from the model. Can be plain
# text or structured JSON data. Learn more:
# - [Text inputs and outputs](/docs/guides/text)
# - [Structured Outputs](/docs/guides/structured-outputs)
public type ResponseTextParam record {
    # An object specifying the format that the model must output.
    # 
    # Configuring `{ "type": "json_schema" }` enables Structured Outputs, 
    # which ensures the model will match your supplied JSON schema. Learn more in the 
    # [Structured Outputs guide](/docs/guides/structured-outputs).
    # 
    # The default format is `{ "type": "text" }` with no additional options.
    # 
    # **Not recommended for gpt-4o and newer models:**
    # 
    # Setting to `{ "type": "json_object" }` enables the older JSON mode, which
    # ensures the message the model generates is valid JSON. Using `json_schema`
    # is preferred for models that support it.
    TextResponseFormatConfiguration format?;
    # Constrains the verbosity of the model's response. Lower values will result in
    # more concise responses, while higher values will result in more verbose responses.
    # Currently supported values are `low`, `medium`, and `high`.
    Verbosity? verbosity?;
};

# Combine multiple filters using `and` or `or`.
public type CompoundFilter record {|
    # Type of operation: `and` or `or`.
    "and"|"or" 'type;
    # Array of filters to combine. Items can be `ComparisonFilter` or `CompoundFilter`.
    (anydata)[] filters;
|};

# Optional map of values to substitute in for variables in your
# prompt. The substitution values can either be strings, or other
# Response input types like images or files.
public type ResponsePromptVariables record {
};

# Instruction for updating an existing file via the apply_patch tool.
public type ApplyPatchUpdateFileOperationParam record {
    # The operation type. Always `update_file`.
    "update_file" 'type = "update_file";
    # Path of the file to update relative to the workspace root.
    @constraint:String {minLength: 1}
    string path;
    # Unified diff content to apply to the existing file.
    @constraint:String {maxLength: 10485760}
    string diff;
};

# Commands and limits describing how to run the shell tool call.
public type FunctionShellActionParam record {
    # Ordered shell commands for the execution environment to run.
    string[] commands;
    # Maximum wall-clock time in milliseconds to allow the shell commands to run.
    int? timeout_ms?;
    # Maximum number of UTF-8 characters to capture from combined stdout and stderr output.
    int? max_output_length?;
};

# How the model should select which tool (or tools) to use when generating
# a response. See the `tools` parameter to see how to specify which tools
# the model can call.
public type ToolChoiceParam ToolChoiceOptions|ToolChoiceAllowed|ToolChoiceTypes|ToolChoiceFunction|ToolChoiceMCP|ToolChoiceCustom|SpecificApplyPatchParam|SpecificFunctionShellParam;

public type ComputerAction ClickParam|DoubleClickAction|DragParam|KeyPressAction|MoveParam|ScreenshotParam|ScrollParam|TypeParam|WaitParam;

# Instruction describing how to create a file via the apply_patch tool.
public type ApplyPatchCreateFileOperation record {
    # Create a new file with the provided diff.
    "create_file" 'type = "create_file";
    # Path of the file to create.
    string path;
    # Diff to apply.
    string diff;
};

# Constrains the tools available to the model to a pre-defined set.
public type ToolChoiceAllowed record {
    # Allowed tool configuration type. Always `allowed_tools`.
    "allowed_tools" 'type;
    # Constrains the tools available to the model to a pre-defined set.
    # 
    # `auto` allows the model to pick from among the allowed tools and generate a
    # message.
    # 
    # `required` requires the model to call one or more of the allowed tools.
    "auto"|"required" mode;
    # A list of tool definitions that the model should be allowed to call.
    # 
    # For the Responses API, the list of tool definitions might look like:
    # ```json
    # [
    #   { "type": "function", "name": "get_weather" },
    #   { "type": "mcp", "server_label": "deepwiki" },
    #   { "type": "image_generation" }
    # ]
    # ```
    record {}[] tools;
};

# Forces the model to call the shell tool when a tool call is required.
public type SpecificFunctionShellParam record {
    # The tool to call. Always `shell`.
    "shell" 'type = "shell";
};

# Indicates that the model should use a built-in tool to generate a response.
# [Learn more about built-in tools](/docs/guides/tools).
public type ToolChoiceTypes record {
    # The type of hosted tool the model should to use. Learn more about
    # [built-in tools](/docs/guides/tools).
    # 
    # Allowed values are:
    # - `file_search`
    # - `web_search_preview`
    # - `computer_use_preview`
    # - `code_interpreter`
    # - `image_generation`
    "file_search"|"web_search_preview"|"computer_use_preview"|"web_search_preview_2025_03_11"|"image_generation"|"code_interpreter" 'type;
};

# A tool that allows the model to execute shell commands in a local environment.
public type LocalShellToolParam record {
    # The type of the local shell tool. Always `local_shell`.
    "local_shell" 'type = "local_shell";
};

# Allows the assistant to create, delete, or update files using unified diffs.
public type ApplyPatchToolParam record {
    # The type of the tool. Always `apply_patch`.
    "apply_patch" 'type = "apply_patch";
};

# A wait action.
public type WaitParam record {
    # Specifies the event type. For a wait action, this property is always set to `wait`.
    "wait" 'type = "wait";
};

# Constrains effort on reasoning for
# [reasoning models](https://platform.openai.com/docs/guides/reasoning).
# 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`.
public type ReasoningEffort "none"|"minimal"|"low"|"medium"|"high"|"xhigh"?;

# Reference to a prompt template and its variables.
# [Learn more](/docs/guides/text?api-mode=responses#reusable-prompts).
public type Prompt record {
    # The unique identifier of the prompt template to use.
    string id;
    # Optional version of the prompt template.
    string? version?;
    # Optional map of values to substitute in for variables in your
    # prompt. The substitution values can either be strings, or other
    # Response input types like images or files.
    ResponsePromptVariables? variables?;
};

# A grammar defined by the user.
public type CustomGrammarFormatParam record {
    # Grammar format. Always `grammar`.
    "grammar" 'type = "grammar";
    GrammarSyntax1 syntax;
    # The grammar definition.
    string definition;
};

# The output emitted by an apply patch tool call.
public type ApplyPatchToolCallOutput record {
    # The type of the item. Always `apply_patch_call_output`.
    "apply_patch_call_output" 'type = "apply_patch_call_output";
    # The unique ID of the apply patch tool call output. Populated when this item is returned via API.
    string id;
    # The unique ID of the apply patch tool call generated by the model.
    string call_id;
    ApplyPatchCallOutputStatus status;
    # Optional textual output returned by the apply patch tool.
    string? output?;
    # The ID of the entity that created this tool call output.
    string created_by?;
};

public type Filters ComparisonFilter|CompoundFilter;

# A click action.
public type ClickParam record {
    # Specifies the event type. For a click action, this property is always `click`.
    "click" 'type = "click";
    ClickButtonType button;
    # The x-coordinate where the click occurred.
    int x;
    # The y-coordinate where the click occurred.
    int y;
};

# An internal identifier for an item to reference.
public type ItemReferenceParam record {
    # The type of item to reference. Always `item_reference`.
    "item_reference"? 'type = "item_reference";
    # The ID of the item to reference.
    string id;
};

public type MCPToolCallStatus "in_progress"|"completed"|"incomplete"|"calling"|"failed";

# A list of one or many input items to the model, containing different content 
# types.
public type InputMessageContentList InputContent[];

public type SearchContextSize "low"|"medium"|"high";

public type RankingOptions record {
    RankerVersionType ranker?;
    # The score threshold for the file search, a number between 0 and 1. Numbers closer to 1 will attempt to return only the most relevant results, but may return fewer results.
    decimal score_threshold?;
    HybridSearchOptions hybrid_search?;
};

# A path to a file.
public type FilePath record {
    # The type of the file path. Always `file_path`.
    "file_path" 'type;
    # The ID of the file.
    string file_id;
    # The index of the file in the list of files.
    int index;
};

# Default response format. Used to generate text responses.
public type ResponseFormatText record {
    # The type of response format being defined. Always `text`.
    "text" 'type;
};

# A tool that generates images using the GPT image models.
public type ImageGenTool record {
    # The type of the image generation tool. Always `image_generation`.
    "image_generation" 'type;
    string|"gpt-image-1"|"gpt-image-1-mini"|"gpt-image-1.5" model?;
    # The quality of the generated image. One of `low`, `medium`, `high`,
    # or `auto`. Default: `auto`.
    "low"|"medium"|"high"|"auto" quality = "auto";
    # The size of the generated image. One of `1024x1024`, `1024x1536`,
    # `1536x1024`, or `auto`. Default: `auto`.
    "1024x1024"|"1024x1536"|"1536x1024"|"auto" size = "auto";
    # The output format of the generated image. One of `png`, `webp`, or
    # `jpeg`. Default: `png`.
    "png"|"webp"|"jpeg" output_format = "png";
    # Compression level for the output image. Default: 100.
    @constraint:Int {minValue: 0, maxValue: 100}
    int output_compression = 100;
    # Moderation level for the generated image. Default: `auto`.
    "auto"|"low" moderation = "auto";
    # Background type for the generated image. One of `transparent`,
    # `opaque`, or `auto`. Default: `auto`.
    "transparent"|"opaque"|"auto" background = "auto";
    # Control how much effort the model will exert to match the style and features, especially facial features, of input images. This parameter is only supported for `gpt-image-1` and `gpt-image-1.5` and later models, unsupported for `gpt-image-1-mini`. Supports `high` and `low`. Defaults to `low`.
    InputFidelity input_fidelity?;
    # Optional mask for inpainting. Contains `image_url`
    # (string, optional) and `file_id` (string, optional).
    ImageGenTool_input_image_mask input_image_mask?;
    # Number of partial images to generate in streaming mode, from 0 (default value) to 3.
    @constraint:Int {minValue: 0, maxValue: 3}
    int partial_images = 0;
    ImageGenActionEnum action?;
};

public type LocalSkillParam record {
    # The name of the skill.
    string name;
    # The description of the skill.
    string description;
    # The path to the directory containing the skill.
    string path;
};

# An x/y coordinate pair, e.g. `{ x: 100, y: 200 }`.
public type CoordParam record {
    # The x-coordinate.
    int x;
    # The y-coordinate.
    int y;
};

# This tool searches the web for relevant results to use in a response. Learn more about the [web search tool](https://platform.openai.com/docs/guides/tools-web-search).
public type WebSearchPreviewTool record {
    # The type of the web search tool. One of `web_search_preview` or `web_search_preview_2025_03_11`.
    "web_search_preview"|"web_search_preview_2025_03_11" 'type = "web_search_preview";
    ApproximateLocation user_location?;
    SearchContextSize search_context_size?;
};

# An error object returned when the model fails to generate a Response.
public type ResponseError record {
    # The error code for the response.
    ResponseErrorCode code;
    # A human-readable description of the error.
    string message;
};

# A scroll action.
public type ScrollParam record {
    # Specifies the event type. For a scroll action, this property is always set to `scroll`.
    "scroll" 'type = "scroll";
    # The x-coordinate where the scroll occurred.
    int x;
    # The y-coordinate where the scroll occurred.
    int y;
    # The horizontal scroll distance.
    int scroll_x;
    # The vertical scroll distance.
    int scroll_y;
};

public type DetailEnum "low"|"high"|"auto";

public type InputContent InputTextContent|InputImageContent|InputFileContent;

# Instruction describing how to update a file via the apply_patch tool.
public type ApplyPatchUpdateFileOperation record {
    # Update an existing file with the provided diff.
    "update_file" 'type = "update_file";
    # Path of the file to update.
    string path;
    # Diff to apply.
    string diff;
};

# Instruction for deleting an existing file via the apply_patch tool.
public type ApplyPatchDeleteFileOperationParam record {
    # The operation type. Always `delete_file`.
    "delete_file" 'type = "delete_file";
    # Path of the file to delete relative to the workspace root.
    @constraint:String {minLength: 1}
    string path;
};

# A tool that allows the model to execute shell commands.
public type FunctionShellToolParam record {
    # The type of the shell tool. Always `shell`.
    "shell" 'type = "shell";
    ContainerAutoParam|LocalEnvironmentParam|ContainerReferenceParam? environment?;
};

# Indicates that the shell commands finished and returned an exit code.
public type FunctionShellCallOutputExitOutcome record {
    # The outcome type. Always `exit`.
    "exit" 'type = "exit";
    # Exit code from the shell process.
    int exit_code;
};

# Indicates that the shell call exceeded its configured time limit.
public type FunctionShellCallOutputTimeoutOutcomeParam record {
    # The outcome type. Always `timeout`.
    "timeout" 'type = "timeout";
};

# Use this option to force the model to call a specific tool on a remote MCP server.
public type ToolChoiceMCP record {
    # For MCP tools, the type is always `mcp`.
    "mcp" 'type;
    # The label of the MCP server to use.
    string server_label;
    # The name of the tool to call on the server.
    string? name?;
};

# JSON Schema response format. Used to generate structured JSON responses.
# Learn more about [Structured Outputs](/docs/guides/structured-outputs).
public type TextResponseFormatJsonSchema record {
    # The type of response format being defined. Always `json_schema`.
    "json_schema" 'type;
    # A description of what the response format is for, used by the model to
    # determine how to respond in the format.
    string description?;
    # 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.
    string name;
    # The schema for the response format, described as a JSON Schema object.
    # Learn how to build JSON schemas [here](https://json-schema.org/).
    ResponseFormatJsonSchemaSchema schema;
    # 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](/docs/guides/structured-outputs).
    boolean? strict = false;
};

# A tool call that executes one or more shell commands in a managed environment.
public type FunctionShellCall record {
    # The type of the item. Always `shell_call`.
    "shell_call" 'type = "shell_call";
    # The unique ID of the shell tool call. Populated when this item is returned via API.
    string id;
    # The unique ID of the shell tool call generated by the model.
    string call_id;
    # Execute a shell command.
    FunctionShellAction action;
    LocalShellCallStatus status;
    LocalEnvironmentResource|ContainerReferenceResource? environment;
    # The ID of the entity that created this tool call.
    string created_by?;
};

# 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.
public type ResponseFormatJsonObject record {
    # The type of response format being defined. Always `json_object`.
    "json_object" 'type;
};

# Use this option to force the model to call a specific function.
public type ToolChoiceFunction record {
    # For function calling, the type is always `function`.
    "function" 'type;
    # The name of the function to call.
    string name;
};

# An output message from the model.
public type OutputMessage record {
    # The unique ID of the output message.
    string id;
    # The type of the output message. Always `message`.
    "message" 'type;
    # The role of the output message. Always `assistant`.
    "assistant" role;
    # The content of the output message.
    OutputMessageContent[] content;
    # The status of the message input. One of `in_progress`, `completed`, or
    # `incomplete`. Populated when input items are returned via API.
    "in_progress"|"completed"|"incomplete" status;
};

# Defines a function in your own code the model can choose to call. Learn more about [function calling](https://platform.openai.com/docs/guides/function-calling).
public type FunctionTool record {
    # The type of the function tool. Always `function`.
    "function" 'type = "function";
    # The name of the function to call.
    string name;
    # A description of the function. Used by the model to determine whether or not to call the function.
    string? description?;
    # A JSON schema object describing the parameters of the function.
    record {}? parameters;
    # Whether to enforce strict parameter validation. Default `true`.
    boolean? strict;
};

# The output of a custom tool call from your code, being sent back to the model.
public type CustomToolCallOutput record {
    # The type of the custom tool call output. Always `custom_tool_call_output`.
    "custom_tool_call_output" 'type;
    # The unique ID of the custom tool call output in the OpenAI platform.
    string id?;
    # The call ID, used to map this custom tool call output to a custom tool call.
    string call_id;
    # The output from the custom tool call generated by your code.
    # Can be a string or an list of output content.
    string|FunctionAndCustomToolCallOutput[] output;
};

public type OutputMessageContent OutputTextContent|RefusalContent;

# Action type "find_in_page": Searches for a pattern within a loaded page.
public type WebSearchActionFind record {
    # The action type.
    "find_in_page" 'type;
    # The URL of the page searched for the pattern.
    string url;
    # The pattern or text to search for within the page.
    string pattern;
};

# A tool call to run code.
public type CodeInterpreterToolCall record {
    # The type of the code interpreter tool call. Always `code_interpreter_call`.
    "code_interpreter_call" 'type = "code_interpreter_call";
    # The unique ID of the code interpreter tool call.
    string id;
    # The status of the code interpreter tool call. Valid values are `in_progress`, `completed`, `incomplete`, `interpreting`, and `failed`.
    "in_progress"|"completed"|"incomplete"|"interpreting"|"failed" status;
    # The ID of the container used to run the code.
    string container_id;
    # The code to run, or null if not available.
    string? code;
    # The outputs generated by the code interpreter, such as logs or images.
    # Can be null if no outputs are available.
    (CodeInterpreterOutputLogs|CodeInterpreterOutputImage)[]? outputs;
};

# Instruction for creating a new file via the apply_patch tool.
public type ApplyPatchCreateFileOperationParam record {
    # The operation type. Always `create_file`.
    "create_file" 'type = "create_file";
    # Path of the file to create relative to the workspace root.
    @constraint:String {minLength: 1}
    string path;
    # Unified diff content to apply when creating the file.
    @constraint:String {maxLength: 10485760}
    string diff;
};

# Unconstrained free-form text.
public type CustomTextFormatParam record {
    # Unconstrained text format. Always `text`.
    "text" 'type = "text";
};

# A text input to the model.
public type InputTextContent record {
    # The type of the input item. Always `input_text`.
    "input_text" 'type = "input_text";
    # The text input to the model.
    string text;
};

# The image output from the code interpreter.
public type CodeInterpreterOutputImage record {
    # The type of the output. Always `image`.
    "image" 'type = "image";
    # The URL of the image output from the code interpreter.
    string url;
};

public type Conversation\-2 record {
    string id;
};

public type InputItem EasyInputMessage|Item|ItemReferenceParam;

public type ModelResponseProperties record {
    # 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.
    Metadata? metadata?;
    # An integer between 0 and 20 specifying the number of most likely tokens to
    # return at each token position, each with an associated log probability.
    int? top_logprobs?;
    # What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.
    # We generally recommend altering this or `top_p` but not both.
    decimal? temperature = 1;
    # An alternative to sampling with temperature, called nucleus sampling,
    # where the model considers the results of the tokens with top_p probability
    # mass. So 0.1 means only the tokens comprising the top 10% probability mass
    # are considered.
    # 
    # We generally recommend altering this or `temperature` but not both.
    decimal? top_p = 1;
    # This field is being replaced by `safety_identifier` and `prompt_cache_key`. Use `prompt_cache_key` instead to maintain caching optimizations.
    # A stable identifier for your end-users.
    # Used to boost cache hit rates by better bucketing similar requests and  to help OpenAI detect and prevent abuse. [Learn more](/docs/guides/safety-best-practices#safety-identifiers).
    # 
    # # Deprecated
    @deprecated
    string user?;
    # A stable identifier used to help detect users of your application that may be violating OpenAI's usage policies.
    # The IDs should be a string that uniquely identifies each user. We recommend hashing their username or email address, in order to avoid sending us any identifying information. [Learn more](/docs/guides/safety-best-practices#safety-identifiers).
    string safety_identifier?;
    # Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the `user` field. [Learn more](/docs/guides/prompt-caching).
    string prompt_cache_key?;
    # Specifies the processing type used for serving the request.
    #   - If set to 'auto', then the request will be processed with the service tier configured in the Project settings. Unless otherwise configured, the Project will use 'default'.
    #   - If set to 'default', then the request will be processed with the standard pricing and performance for the selected model.
    #   - If set to '[flex](/docs/guides/flex-processing)' or '[priority](https://openai.com/api-priority-processing/)', then the request will be processed with the corresponding service tier.
    #   - When not set, the default behavior is 'auto'.
    # 
    #   When the `service_tier` parameter is set, the response body will include the `service_tier` value based on the processing mode actually used to serve the request. This response value may be different from the value set in the parameter.
    ServiceTier? service_tier?;
    # The retention policy for the prompt cache. Set to `24h` to enable extended prompt caching, which keeps cached prefixes active for longer, up to a maximum of 24 hours. [Learn more](/docs/guides/prompt-caching#prompt-cache-retention).
    "in-memory"|"24h"? prompt_cache_retention?;
};

public type HybridSearchOptions record {
    # The weight of the embedding in the reciprocal ranking fusion.
    decimal embedding_weight;
    # The weight of the text in the reciprocal ranking fusion.
    decimal text_weight;
};

# A file input to the model.
public type InputFileContentParam record {
    # The type of the input item. Always `input_file`.
    "input_file" 'type = "input_file";
    # The ID of the file to be sent to the model.
    string? file_id?;
    # The name of the file to be sent to the model.
    string? filename?;
    # The base64-encoded data of the file to be sent to the model.
    string? file_data?;
    # The URL of the file to be sent to the model.
    string? file_url?;
};

# A tool that runs Python code to help generate a response to a prompt.
public type CodeInterpreterTool record {
    # The type of the code interpreter tool. Always `code_interpreter`.
    "code_interpreter" 'type;
    # The code interpreter container. Can be a container ID or an object that
    # specifies uploaded file IDs to make available to your code, along with an
    # optional `memory_limit` setting.
    string|AutoCodeInterpreterToolParam container;
};

# The schema for the response format, described as a JSON Schema object.
# Learn how to build JSON schemas [here](https://json-schema.org/).
public type ResponseFormatJsonSchemaSchema record {
};

public type LocalShellCallOutputStatusEnum "in_progress"|"completed"|"incomplete";

public type Web\ search\ source record {
    "url" 'type;
    string url;
};

# The output of a shell tool call that was emitted.
public type FunctionShellCallOutput record {
    # The type of the shell call output. Always `shell_call_output`.
    "shell_call_output" 'type = "shell_call_output";
    # The unique ID of the shell call output. Populated when this item is returned via API.
    string id;
    # The unique ID of the shell tool call generated by the model.
    string call_id;
    LocalShellCallOutputStatusEnum status;
    # An array of shell call output contents
    FunctionShellCallOutputContent[] output;
    # The maximum length of the shell command output. This is generated by the model and should be passed back with the raw output.
    int? max_output_length;
    # The identifier of the actor that created the item.
    string created_by?;
};

# Instruction describing how to delete a file via the apply_patch tool.
public type ApplyPatchDeleteFileOperation record {
    # Delete the specified file.
    "delete_file" 'type = "delete_file";
    # Path of the file to delete.
    string path;
};

# A request for human approval of a tool invocation.
public type MCPApprovalRequest record {
    # The type of the item. Always `mcp_approval_request`.
    "mcp_approval_request" 'type;
    # The unique ID of the approval request.
    string id;
    # The label of the MCP server making the request.
    string server_label;
    # The name of the tool to run.
    string name;
    # A JSON string of arguments for the tool.
    string arguments;
};

public type LocalShellCallStatus "in_progress"|"completed"|"incomplete";

# A collection of keypresses the model would like to perform.
public type KeyPressAction record {
    # Specifies the event type. For a keypress action, this property is always set to `keypress`.
    "keypress" 'type = "keypress";
    # The combination of keys the model is requesting to be pressed. This is an array of strings, each representing a key.
    string[] keys;
};

# An annotation that applies to a span of output text.
public type Annotation FileCitationBody|UrlCitationBody|ContainerFileCitationBody|FilePath;

# A compaction item generated by the [`v1/responses/compact` API](/docs/api-reference/responses/compact).
public type CompactionBody record {
    # The type of the item. Always `compaction`.
    "compaction" 'type = "compaction";
    # The unique ID of the compaction item.
    string id;
    # The encrypted content that was produced by compaction.
    string encrypted_content;
    # The identifier of the actor that created the item.
    string created_by?;
};

# Represents a container created with /v1/containers.
public type ContainerReferenceResource record {
    # The environment type. Always `container_reference`.
    "container_reference" 'type = "container_reference";
    string container_id;
};

# A tool that can be used to generate a response.
public type Tool FunctionTool|FileSearchTool|ComputerUsePreviewTool|WebSearchTool|MCPTool|CodeInterpreterTool|ImageGenTool|LocalShellToolParam|FunctionShellToolParam|CustomToolParam|WebSearchPreviewTool|ApplyPatchToolParam;

public type SkillReferenceParam record {
    # References a skill created with the /v1/skills endpoint.
    "skill_reference" 'type = "skill_reference";
    # The ID of the referenced skill.
    @constraint:String {maxLength: 64, minLength: 1}
    string skill_id;
    # Optional skill version. Use a positive integer or 'latest'. Omit for default.
    string version?;
};

# A summary text from the model.
public type SummaryTextContent record {
    # The type of the object. Always `summary_text`.
    "summary_text" 'type = "summary_text";
    # A summary of the reasoning output from the model so far.
    string text;
};

# Action type "open_page" - Opens a specific URL from search results.
public type WebSearchActionOpenPage record {
    # The action type.
    "open_page" 'type;
    # The URL opened by the model.
    string? url?;
};

# Configuration for a code interpreter container. Optionally specify the IDs of the files to run the code on.
public type AutoCodeInterpreterToolParam record {
    # Always `auto`.
    "auto" 'type = "auto";
    # An optional list of uploaded files to make available to your code.
    @constraint:Array {maxLength: 50}
    string[] file_ids?;
    ContainerMemoryLimit memory_limit?;
    # Network access policy for the container.
    ContainerNetworkPolicyDisabledParam|ContainerNetworkPolicyAllowlistParam network_policy?;
};

public type ComputerEnvironment "windows"|"mac"|"linux"|"ubuntu"|"browser";

# A tool call that applies file diffs by creating, deleting, or updating files.
public type ApplyPatchToolCall record {
    # The type of the item. Always `apply_patch_call`.
    "apply_patch_call" 'type = "apply_patch_call";
    # The unique ID of the apply patch tool call. Populated when this item is returned via API.
    string id;
    # The unique ID of the apply patch tool call generated by the model.
    string call_id;
    ApplyPatchCallStatus status;
    # One of the create_file, delete_file, or update_file operations applied via apply_patch.
    ApplyPatchCreateFileOperation|ApplyPatchDeleteFileOperation|ApplyPatchUpdateFileOperation operation;
    # The ID of the entity that created this tool call.
    string created_by?;
};

# Search the Internet for sources related to the prompt. Learn more about the
# [web search tool](/docs/guides/tools-web-search).
public type WebSearchTool record {
    # The type of the web search tool. One of `web_search` or `web_search_2025_08_26`.
    "web_search"|"web_search_2025_08_26" 'type = "web_search";
    # Filters for the search.
    WebSearchTool_filters? filters?;
    # The approximate location of the user.
    WebSearchApproximateLocation? user_location?;
    # High level guidance for the amount of context window space to use for the search. One of `low`, `medium`, or `high`. `medium` is the default.
    "low"|"medium"|"high" search_context_size = "medium";
};

# Status values reported for apply_patch tool calls.
public type ApplyPatchCallStatusParam "in_progress"|"completed";

# Optional mask for inpainting. Contains `image_url`
# (string, optional) and `file_id` (string, optional).
public type ImageGenTool_input_image_mask record {|
    # Base64-encoded mask image.
    string image_url?;
    # File ID for the mask image.
    string file_id?;
|};

# An image input to the model. Learn about [image inputs](/docs/guides/vision)
public type InputImageContentParamAutoParam record {
    # The type of the input item. Always `input_image`.
    "input_image" 'type = "input_image";
    # The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL.
    string? image_url?;
    # The ID of the file to be sent to the model.
    string? file_id?;
    DetailEnum detail?;
};

# 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.
public type Metadata record {|
    string...;
|};

# The results of a file search tool call. See the
# [file search guide](/docs/guides/tools-file-search) for more information.
public type FileSearchToolCall record {
    # The unique ID of the file search tool call.
    string id;
    # The type of the file search tool call. Always `file_search_call`.
    "file_search_call" 'type;
    # The status of the file search tool call. One of `in_progress`,
    # `searching`, `incomplete` or `failed`,
    "in_progress"|"searching"|"completed"|"incomplete"|"failed" status;
    # The queries used to search for files.
    string[] queries;
    # The results of the file search tool call.
    FileSearchToolCall_results[]? results?;
};

# The logs output from the code interpreter.
public type CodeInterpreterOutputLogs record {
    # The type of the output. Always `logs`.
    "logs" 'type = "logs";
    # The logs output from the code interpreter.
    string logs;
};

# Outcome values reported for apply_patch tool call outputs.
public type ApplyPatchCallOutputStatusParam "completed"|"failed";

# A citation for a web resource used to generate a model response.
public type UrlCitationBody record {
    # The type of the URL citation. Always `url_citation`.
    "url_citation" 'type = "url_citation";
    # The URL of the web resource.
    string url;
    # The index of the first character of the URL citation in the message.
    int start_index;
    # The index of the last character of the URL citation in the message.
    int end_index;
    # The title of the web resource.
    string title;
};

# A compaction item generated by the [`v1/responses/compact` API](/docs/api-reference/responses/compact).
public type CompactionSummaryItemParam record {
    # The ID of the compaction item.
    string? id?;
    # The type of the item. Always `compaction`.
    "compaction" 'type = "compaction";
    # The encrypted content of the compaction summary.
    @constraint:String {maxLength: 10485760}
    string encrypted_content;
};

# Execute a shell command.
public type FunctionShellAction record {
    string[] commands;
    # Optional timeout in milliseconds for the commands.
    int? timeout_ms;
    # Optional maximum number of characters to return from each command.
    int? max_output_length;
};

# A double click action.
public type DoubleClickAction record {
    # Specifies the event type. For a double click action, this property is always set to `double_click`.
    "double_click" 'type = "double_click";
    # The x-coordinate where the double click occurred.
    int x;
    # The y-coordinate where the double click occurred.
    int y;
};

# A list of tools available on an MCP server.
public type MCPListTools record {
    # The type of the item. Always `mcp_list_tools`.
    "mcp_list_tools" 'type;
    # The unique ID of the list.
    string id;
    # The label of the MCP server.
    string server_label;
    # The tools available on the server.
    MCPListToolsTool[] tools;
    # Error message if the server could not list tools.
    string? 'error?;
};

# The output of a computer tool call.
public type ComputerCallOutputItemParam record {
    # The ID of the computer tool call output.
    string? id?;
    # The ID of the computer tool call that produced the output.
    @constraint:String {maxLength: 64, minLength: 1}
    string call_id;
    # The type of the computer tool call output. Always `computer_call_output`.
    "computer_call_output" 'type = "computer_call_output";
    # A computer screenshot image used with the computer use tool.
    ComputerScreenshotImage output;
    # The safety checks reported by the API that have been acknowledged by the developer.
    ComputerCallSafetyCheckParam[]? acknowledged_safety_checks?;
    FunctionCallItemStatus status?;
};

# Action type "search" - Performs a web search query.
public type WebSearchActionSearch record {
    # The action type.
    "search" 'type;
    # [DEPRECATED] The search query.
    string query;
    # The search queries.
    string[] queries?;
    # The sources used in the search.
    Web\ search\ source[] sources?;
};

# A file input to the model.
public type InputFileContent record {
    # The type of the input item. Always `input_file`.
    "input_file" 'type = "input_file";
    # The ID of the file to be sent to the model.
    string? file_id?;
    # The name of the file to be sent to the model.
    string filename?;
    # The URL of the file to be sent to the model.
    string file_url?;
    # The content of the file to be sent to the model.
    string file_data?;
};

# Indicates that the shell call exceeded its configured time limit.
public type FunctionShellCallOutputTimeoutOutcome record {
    # The outcome type. Always `timeout`.
    "timeout" 'type = "timeout";
};

public type InlineSkillParam record {
    # Defines an inline skill for this request.
    "inline" 'type = "inline";
    # The name of the skill.
    string name;
    # The description of the skill.
    string description;
    # Inline skill payload
    InlineSkillSourceParam 'source;
};

# Status values reported for shell tool calls.
public type FunctionShellCallItemStatus "in_progress"|"completed"|"incomplete";

# A tool call to run a command on the local shell.
public type LocalShellToolCall record {
    # The type of the local shell call. Always `local_shell_call`.
    "local_shell_call" 'type;
    # The unique ID of the local shell call.
    string id;
    # The unique ID of the local shell tool call generated by the model.
    string call_id;
    # Execute a shell command on the server.
    LocalShellExecAction action;
    # The status of the local shell call.
    "in_progress"|"completed"|"incomplete" status;
};

# The output of a local shell tool call.
public type LocalShellToolCallOutput record {
    # The type of the local shell tool call output. Always `local_shell_call_output`.
    "local_shell_call_output" 'type;
    # The unique ID of the local shell tool call generated by the model.
    string id;
    # A JSON string of the output of the local shell tool call.
    string output;
    # The status of the item. One of `in_progress`, `completed`, or `incomplete`.
    "in_progress"|"completed"|"incomplete"? status?;
};

# An object specifying the format that the model must output.
# 
# Configuring `{ "type": "json_schema" }` enables Structured Outputs, 
# which ensures the model will match your supplied JSON schema. Learn more in the 
# [Structured Outputs guide](/docs/guides/structured-outputs).
# 
# The default format is `{ "type": "text" }` with no additional options.
# 
# **Not recommended for gpt-4o and newer models:**
# 
# Setting to `{ "type": "json_object" }` enables the older JSON mode, which
# ensures the message the model generates is valid JSON. Using `json_schema`
# is preferred for models that support it.
public type TextResponseFormatConfiguration ResponseFormatText|TextResponseFormatJsonSchema|ResponseFormatJsonObject;

# A pending safety check for the computer call.
public type ComputerCallSafetyCheckParam record {
    # The ID of the pending safety check.
    string id;
    # The type of the pending safety check.
    string? code?;
    # Details about the pending safety check.
    string? message?;
};

# Use this option to force the model to call a specific custom tool.
public type ToolChoiceCustom record {
    # For custom tool calling, the type is always `custom`.
    "custom" 'type;
    # The name of the custom tool to call.
    string name;
};

# One of the create_file, delete_file, or update_file operations supplied to the apply_patch tool.
public type ApplyPatchOperationParam ApplyPatchCreateFileOperationParam|ApplyPatchDeleteFileOperationParam|ApplyPatchUpdateFileOperationParam;

# The log probability of a token.
public type LogProb record {
    string token;
    decimal logprob;
    int[] bytes;
    TopLogProb[] top_logprobs;
};

# A detailed breakdown of the input tokens.
public type ResponseUsage_input_tokens_details record {
    # The number of tokens that were retrieved from the cache. 
    # [More on prompt caching](/docs/guides/prompt-caching).
    int cached_tokens;
};

# Content item used to generate a response.
public type Item InputMessage|OutputMessage|FileSearchToolCall|ComputerToolCall|ComputerCallOutputItemParam|WebSearchToolCall|FunctionToolCall|FunctionCallOutputItemParam|ReasoningItem|CompactionSummaryItemParam|ImageGenToolCall|CodeInterpreterToolCall|LocalShellToolCall|LocalShellToolCallOutput|FunctionShellCallItemParam|FunctionShellCallOutputItemParam|ApplyPatchToolCallItemParam|ApplyPatchToolCallOutputItemParam|MCPListTools|MCPApprovalRequest|MCPApprovalResponse|MCPToolCall|CustomToolCallOutput|CustomToolCall;

# The streamed output items emitted by a shell tool call.
public type FunctionShellCallOutputItemParam record {
    # The unique ID of the shell tool call output. Populated when this item is returned via API.
    string? id?;
    # The unique ID of the shell tool call generated by the model.
    @constraint:String {maxLength: 64, minLength: 1}
    string call_id;
    # The type of the item. Always `shell_call_output`.
    "shell_call_output" 'type = "shell_call_output";
    # Captured chunks of stdout and stderr output, along with their associated outcomes.
    FunctionShellCallOutputContentParam[] output;
    # Status values reported for shell tool calls.
    FunctionShellCallItemStatus status?;
    # The maximum number of UTF-8 characters captured for this shell call's combined output.
    int? max_output_length?;
};

# A filter object to specify which tools are allowed.
public type MCPToolFilter record {|
    # List of allowed tool names.
    string[] tool_names?;
    # Indicates whether or not a tool modifies data or is read-only. If an
    # MCP server is [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),
    # it will match this filter.
    boolean read_only?;
|};

# A tool that controls a virtual computer. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use).
public type ComputerUsePreviewTool record {
    # The type of the computer use tool. Always `computer_use_preview`.
    "computer_use_preview" 'type = "computer_use_preview";
    ComputerEnvironment environment;
    # The width of the computer display.
    int display_width;
    # The height of the computer display.
    int display_height;
};

public type ApproximateLocation record {
    # The type of location approximation. Always `approximate`.
    "approximate" 'type = "approximate";
    # The two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1) of the user, e.g. `US`.
    string? country?;
    # Free text input for the region of the user, e.g. `California`.
    string? region?;
    # Free text input for the city of the user, e.g. `San Francisco`.
    string? city?;
    # The [IANA timezone](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`.
    string? timezone?;
};

public type ContainerAutoParam record {
    # Automatically creates a container for this request
    "container_auto" 'type = "container_auto";
    # An optional list of uploaded files to make available to your code.
    @constraint:Array {maxLength: 50}
    string[] file_ids?;
    ContainerMemoryLimit memory_limit?;
    # Network access policy for the container.
    ContainerNetworkPolicyDisabledParam|ContainerNetworkPolicyAllowlistParam network_policy?;
    # An optional list of skills referenced by id or inline data.
    @constraint:Array {maxLength: 200}
    (SkillReferenceParam|InlineSkillParam)[] skills?;
};

# The content of a shell tool call output that was emitted.
public type FunctionShellCallOutputContent record {
    # The standard output that was captured.
    string stdout;
    # The standard error output that was captured.
    string stderr;
    # Represents either an exit outcome (with an exit code) or a timeout outcome for a shell call output chunk.
    FunctionShellCallOutputTimeoutOutcome|FunctionShellCallOutputExitOutcome outcome;
    # The identifier of the actor that created the item.
    string created_by?;
};

# Represents the use of a local environment to perform shell actions.
public type LocalEnvironmentResource record {
    # The environment type. Always `local`.
    "local" 'type = "local";
};

# A call to a custom tool created by the model.
public type CustomToolCall record {
    # The type of the custom tool call. Always `custom_tool_call`.
    "custom_tool_call" 'type;
    # The unique ID of the custom tool call in the OpenAI platform.
    string id?;
    # An identifier used to map this custom tool call to a tool call output.
    string call_id;
    # The name of the custom tool being called.
    string name;
    # The input for the custom tool call generated by the model.
    string input;
};

public type ModelIdsResponses ModelIdsShared|"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";

# A tool representing a request to execute one or more shell commands.
public type FunctionShellCallItemParam record {
    # The unique ID of the shell tool call. Populated when this item is returned via API.
    string? id?;
    # The unique ID of the shell tool call generated by the model.
    @constraint:String {maxLength: 64, minLength: 1}
    string call_id;
    # The type of the item. Always `shell_call`.
    "shell_call" 'type = "shell_call";
    # Commands and limits describing how to run the shell tool call.
    FunctionShellActionParam action;
    # Status values reported for shell tool calls.
    FunctionShellCallItemStatus status?;
    # The environment to execute the shell commands in.
    LocalEnvironmentParam|ContainerReferenceParam? environment?;
};

# The exit or timeout outcome associated with this shell call.
public type FunctionShellCallOutputOutcomeParam FunctionShellCallOutputTimeoutOutcomeParam|FunctionShellCallOutputExitOutcomeParam;

# Captured stdout and stderr for a portion of a shell tool call output.
public type FunctionShellCallOutputContentParam record {
    # Captured stdout output for the shell call.
    @constraint:String {maxLength: 10485760}
    string stdout;
    # Captured stderr output for the shell call.
    @constraint:String {maxLength: 10485760}
    string stderr;
    # The exit or timeout outcome associated with this shell call.
    FunctionShellCallOutputOutcomeParam outcome;
};

# A refusal from the model.
public type RefusalContent record {
    # The type of the refusal. Always `refusal`.
    "refusal" 'type = "refusal";
    # The refusal explanation from the model.
    string refusal;
};

public type ContainerNetworkPolicyDisabledParam record {
    # Disable outbound network access. Always `disabled`.
    "disabled" 'type = "disabled";
};

# A drag action.
public type DragParam record {
    # Specifies the event type. For a drag action, this property is always set to `drag`.
    "drag" 'type = "drag";
    # An array of coordinates representing the path of the drag action. Coordinates will appear as an array of objects, eg
    # ```
    # [
    #   { x: 100, y: 200 },
    #   { x: 200, y: 300 }
    # ]
    # ```
    CoordParam[] path;
};

# An image generation request made by the model.
public type ImageGenToolCall record {
    # The type of the image generation call. Always `image_generation_call`.
    "image_generation_call" 'type;
    # The unique ID of the image generation call.
    string id;
    # The status of the image generation call.
    "in_progress"|"completed"|"generating"|"failed" status;
    # The generated image encoded in base64.
    string? result;
};

# A text input to the model.
public type InputTextContentParam record {
    # The type of the input item. Always `input_text`.
    "input_text" 'type = "input_text";
    # The text input to the model.
    @constraint:String {maxLength: 10485760}
    string text;
};

public type ModelIdsShared string|"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";

public type ImageDetail "low"|"high"|"auto";

# The error code for the response.
public type ResponseErrorCode "server_error"|"rate_limit_exceeded"|"invalid_prompt"|"vector_store_timeout"|"invalid_image"|"invalid_image_format"|"invalid_base64_image"|"invalid_image_url"|"image_too_large"|"image_too_small"|"image_parse_error"|"image_content_policy_violation"|"invalid_image_mode"|"image_file_too_large"|"unsupported_image_media_type"|"empty_image_file"|"failed_to_download_image"|"image_file_not_found";

# The approximate location of the user.
public type WebSearchApproximateLocation record {
    # The type of location approximation. Always `approximate`.
    "approximate" 'type = "approximate";
    # The two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1) of the user, e.g. `US`.
    string? country?;
    # Free text input for the region of the user, e.g. `California`.
    string? region?;
    # Free text input for the city of the user, e.g. `San Francisco`.
    string? city?;
    # The [IANA timezone](https://timeapi.io/documentation/iana-timezones) of the user, e.g. `America/Los_Angeles`.
    string? timezone?;
};

public type Response record {
    *ModelResponseProperties;
    *ResponseProperties;
    # Unique identifier for this Response.
    string id;
    # The object type of this resource - always set to `response`.
    "response" 'object;
    # The status of the response generation. One of `completed`, `failed`,
    # `in_progress`, `cancelled`, `queued`, or `incomplete`.
    "completed"|"failed"|"in_progress"|"cancelled"|"queued"|"incomplete" status?;
    # Unix timestamp (in seconds) of when this Response was created.
    decimal created_at;
    # Unix timestamp (in seconds) of when this Response was completed.
    # Only present when the status is `completed`.
    decimal? completed_at?;
    # An error object returned when the model fails to generate a Response.
    ResponseError? 'error;
    # Details about why the response is incomplete.
    Response_incomplete_details? incomplete_details;
    # An array of content items generated by the model.
    # 
    # - The length and order of items in the `output` array is dependent
    #   on the model's response.
    # - Rather than accessing the first item in the `output` array and
    #   assuming it's an `assistant` message with the content generated by
    #   the model, you might consider using the `output_text` property where
    #   supported in SDKs.
    OutputItem[] output;
    # A system (or developer) message inserted into the model's context.
    # 
    # When using along with `previous_response_id`, the instructions from a previous
    # response will not be carried over to the next response. This makes it simple
    # to swap out system (or developer) messages in new responses.
    string|InputItem[]? instructions;
    # SDK-only convenience property that contains the aggregated text output
    # from all `output_text` items in the `output` array, if any are present.
    # Supported in the Python and JavaScript SDKs.
    string? output_text?;
    # Represents token usage details including input tokens, output tokens,
    # a breakdown of output tokens, and the total tokens used.
    ResponseUsage usage?;
    # Whether to allow the model to run tool calls in parallel.
    boolean parallel_tool_calls = true;
    # The conversation that this response belonged to. Input items and output items from this response were automatically added to this conversation.
    Conversation\-2 conversation?;
    # 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.
    Metadata? metadata;
    ModelIdsResponses model;
    # What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.
    # We generally recommend altering this or `top_p` but not both.
    decimal? temperature = 1;
    # How the model should select which tool (or tools) to use when generating
    # a response. See the `tools` parameter to see how to specify which tools
    # the model can call.
    ToolChoiceParam tool_choice;
    # An array of tools the model may call while generating a response. You
    # can specify which tool to use by setting the `tool_choice` parameter.
    # 
    # We support the following categories of tools:
    # - **Built-in tools**: Tools that are provided by OpenAI that extend the
    #   model's capabilities, like [web search](/docs/guides/tools-web-search)
    #   or [file search](/docs/guides/tools-file-search). Learn more about
    #   [built-in tools](/docs/guides/tools).
    # - **MCP Tools**: Integrations with third-party systems via custom MCP servers
    #   or predefined connectors such as Google Drive and SharePoint. Learn more about
    #   [MCP Tools](/docs/guides/tools-connectors-mcp).
    # - **Function calls (custom tools)**: Functions that are defined by you,
    #   enabling the model to call your own code with strongly typed arguments
    #   and outputs. Learn more about
    #   [function calling](/docs/guides/function-calling). You can also use
    #   custom tools to call your own code.
    ToolsArray tools;
    # An alternative to sampling with temperature, called nucleus sampling,
    # where the model considers the results of the tokens with top_p probability
    # mass. So 0.1 means only the tokens comprising the top 10% probability mass
    # are considered.
    # 
    # We generally recommend altering this or `temperature` but not both.
    decimal? top_p = 1;
};