openai 0.87.0 → 0.89.0

data/lib/openai/resources/live/sessions.rb

@@ -0,0 +1,180 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Resources
+    class Live
+      class Sessions
+        # Accept an incoming SIP call with Live startup configuration.
+        #
+        # @overload accept(session_id, session:, request_options: {})
+        #
+        # @param session_id [String]
+        #   Opaque Live session identifier from the creation response or incoming-call
+        #   webhook. Preserve the returned value unchanged, including its prefix.
+        #
+        # @param session [OpenAI::Models::Live::SessionAcceptParams::Session]
+        #   Model and startup configuration for the Live session that answers the incoming
+        #   SIP call.
+        #
+        # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [nil]
+        #
+        # @see OpenAI::Models::Live::SessionAcceptParams
+        def accept(session_id, params)
+          parsed, options = OpenAI::Live::SessionAcceptParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: ["live/sessions/%1$s/accept", session_id],
+            body: parsed,
+            model: NilClass,
+            security: {bearer_auth: true},
+            options: options
+          )
+        end
+
+        # Get Live session content
+        #
+        # @overload download_recording(session_id, request_options: {})
+        #
+        # @param session_id [String]
+        #   The ID of the stored Live session to download. Use the session ID returned when
+        #   the session started with storage enabled.
+        #
+        # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [StringIO]
+        #
+        # @see OpenAI::Models::Live::SessionDownloadRecordingParams
+        def download_recording(session_id, params = {})
+          @client.request(
+            method: :get,
+            path: ["live/sessions/%1$s/content", session_id],
+            headers: {"accept" => "application/binary"},
+            model: StringIO,
+            security: {bearer_auth: true},
+            options: params[:request_options]
+          )
+        end
+
+        # Fork a stored Live session onto a new WebRTC connection.
+        #
+        # @overload fork(session_id, transport:, session: nil, request_options: {})
+        #
+        # @param session_id [String]
+        #   The ID of the stored Live session to fork.
+        #
+        # @param transport [OpenAI::Models::Live::SessionForkParams::Transport]
+        #   WebRTC transport with an SDP offer for the new connection to the forked session.
+        #
+        # @param session [OpenAI::Models::Live::MediaSessionForkConfig]
+        #   Optional configuration overrides for the new Live session. Omit this object or
+        #   send an empty object to inherit the stored session's settings.
+        #
+        # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [OpenAI::Models::Live::SessionForkResponse]
+        #
+        # @see OpenAI::Models::Live::SessionForkParams
+        def fork(session_id, params)
+          parsed, options = OpenAI::Live::SessionForkParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: ["live/sessions/%1$s/fork", session_id],
+            body: parsed,
+            model: OpenAI::Models::Live::SessionForkResponse,
+            security: {bearer_auth: true},
+            options: options
+          )
+        end
+
+        # Hang up a Live session.
+        #
+        # @overload hangup(session_id, request_options: {})
+        #
+        # @param session_id [String]
+        #   Opaque Live session identifier from the creation response or incoming-call
+        #   webhook. Preserve the returned value unchanged, including its prefix.
+        #
+        # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [nil]
+        #
+        # @see OpenAI::Models::Live::SessionHangupParams
+        def hangup(session_id, params = {})
+          @client.request(
+            method: :post,
+            path: ["live/sessions/%1$s/hangup", session_id],
+            model: NilClass,
+            security: {bearer_auth: true},
+            options: params[:request_options]
+          )
+        end
+
+        # Transfer a Live SIP call to another destination.
+        #
+        # @overload refer(session_id, target_uri:, request_options: {})
+        #
+        # @param session_id [String]
+        #   Opaque Live session identifier from the creation response or incoming-call
+        #   webhook. Preserve the returned value unchanged, including its prefix.
+        #
+        # @param target_uri [String]
+        #   Nonblank URI for the SIP Refer-To header, such as tel:+14155550123 or
+        #   sip:agent@example.com.
+        #
+        # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [nil]
+        #
+        # @see OpenAI::Models::Live::SessionReferParams
+        def refer(session_id, params)
+          parsed, options = OpenAI::Live::SessionReferParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: ["live/sessions/%1$s/refer", session_id],
+            body: parsed,
+            model: NilClass,
+            security: {bearer_auth: true},
+            options: options
+          )
+        end
+
+        # Reject an incoming SIP call.
+        #
+        # @overload reject(session_id, status_code:, request_options: {})
+        #
+        # @param session_id [String]
+        #   Opaque Live session identifier from the creation response or incoming-call
+        #   webhook. Preserve the returned value unchanged, including its prefix.
+        #
+        # @param status_code [Integer]
+        #   SIP rejection status sent to the caller. This field is required.
+        #
+        # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [nil]
+        #
+        # @see OpenAI::Models::Live::SessionRejectParams
+        def reject(session_id, params)
+          parsed, options = OpenAI::Live::SessionRejectParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: ["live/sessions/%1$s/reject", session_id],
+            body: parsed,
+            model: NilClass,
+            security: {bearer_auth: true},
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [OpenAI::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/openai/resources/live/sideband.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Resources
+    class Live
+      class Sideband
+        # @api private
+        #
+        # @param client [OpenAI::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/openai/resources/live.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Resources
+    class Live
+      # @return [OpenAI::Resources::Live::Sideband]
+      attr_reader :sideband
+
+      # @return [OpenAI::Resources::Live::Forks]
+      attr_reader :forks
+
+      # @return [OpenAI::Resources::Live::Sessions]
+      attr_reader :sessions
+
+      # Create a Live WebRTC session. Start with the
+      # [Live prompting guide](https://developers.openai.com/api/docs/guides/live-prompting).
+      #
+      # @overload create(session:, transport:, request_options: {})
+      #
+      # @param session [OpenAI::Models::Live::MediaSessionConfig]
+      #   Startup configuration for the Live session.
+      #
+      # @param transport [OpenAI::Models::Live::LiveCreateParams::Transport]
+      #   WebRTC transport with the browser's SDP offer.
+      #
+      # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [OpenAI::Models::Live::LiveCreateResponse]
+      #
+      # @see OpenAI::Models::Live::LiveCreateParams
+      def create(params)
+        parsed, options = OpenAI::Live::LiveCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "live/sessions",
+          body: parsed,
+          model: OpenAI::Models::Live::LiveCreateResponse,
+          security: {bearer_auth: true},
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [OpenAI::Client]
+      def initialize(client:)
+        @client = client
+        @sideband = OpenAI::Resources::Live::Sideband.new(client: client)
+        @forks = OpenAI::Resources::Live::Forks.new(client: client)
+        @sessions = OpenAI::Resources::Live::Sessions.new(client: client)
+      end
+    end
+  end
+end

data/lib/openai/resources/models.rb

@@ -9,7 +9,8 @@ module OpenAI
       #
       # @overload retrieve(model, request_options: {})
       #
-      # @param model [String] The ID of the model to use for this request
+      # @param model [String]
+      #   The ID of the model to use for this request
       #
       # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -52,7 +53,8 @@ module OpenAI
       #
       # @overload delete(model, request_options: {})
       #
-      # @param model [String] The model to delete
+      # @param model [String]
+      #   The model to delete
       #
       # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
       #

data/lib/openai/resources/moderations.rb

@@ -5,17 +5,21 @@ module OpenAI
     # Given text and/or image inputs, classifies if those inputs are potentially
     # harmful.
     class Moderations
-      # Some parameter documentations has been truncated, see
-      # {OpenAI::Models::ModerationCreateParams} for more details.
-      #
       # Classifies if text and/or image inputs are potentially harmful. Learn more in
-      # the [moderation guide](https://platform.openai.com/docs/guides/moderation).
+      # the
+      # [moderation guide](https://developers.openai.com/api/docs/guides/moderation).
       #
       # @overload create(input:, model: nil, request_options: {})
       #
-      # @param input [String, Array<String>, Array<OpenAI::Models::ModerationImageURLInput, OpenAI::Models::ModerationTextInput>] Input (or inputs) to classify. Can be a single string, an array of strings, or
+      # @param input [String, Array<String>, Array<OpenAI::Models::ModerationImageURLInput, OpenAI::Models::ModerationTextInput>]
+      #   Input (or inputs) to classify. Can be a single string, an array of strings, or
+      #   an array of multi-modal input objects similar to other models.
       #
-      # @param model [String, Symbol, OpenAI::Models::ModerationModel] The content moderation model you would like to use. Learn more in
+      # @param model [String, Symbol, OpenAI::Models::ModerationModel]
+      #   The content moderation model you would like to use. Learn more in
+      #   [the moderation guide](https://developers.openai.com/api/docs/guides/moderation),
+      #   and learn about available models
+      #   [here](https://developers.openai.com/api/docs/guides/moderation).
       #
       # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
       #

data/lib/openai/resources/realtime/calls.rb

@@ -9,9 +9,11 @@ module OpenAI
         #
         # @overload create(sdp:, session: nil, request_options: {})
         #
-        # @param sdp [String] WebRTC Session Description Protocol (SDP) offer generated by the caller.
+        # @param sdp [String]
+        #   WebRTC Session Description Protocol (SDP) offer generated by the caller.
         #
-        # @param session [OpenAI::Models::Realtime::RealtimeSessionCreateRequest] Realtime session object configuration.
+        # @param session [OpenAI::Models::Realtime::RealtimeSessionCreateRequest]
+        #   Realtime session object configuration.
         #
         # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
         #
@@ -58,43 +60,101 @@ module OpenAI
           )
         end
 
-        # Some parameter documentations has been truncated, see
-        # {OpenAI::Models::Realtime::CallAcceptParams} for more details.
-        #
         # Accept an incoming SIP call and configure the realtime session that will handle
         # it.
         #
         # @overload accept(call_id, audio: nil, include: nil, instructions: nil, max_output_tokens: nil, model: nil, output_modalities: nil, parallel_tool_calls: nil, prompt: nil, reasoning: nil, tool_choice: nil, tools: nil, tracing: nil, truncation: nil, type: :realtime, request_options: {})
         #
-        # @param call_id [String] The identifier for the call provided in the
-        #
-        # @param audio [OpenAI::Models::Realtime::RealtimeAudioConfig] Configuration for input and output audio.
-        #
-        # @param include [Array<Symbol, OpenAI::Models::Realtime::RealtimeSessionCreateRequest::Include>] Additional fields to include in server outputs.
-        #
-        # @param instructions [String] The default system instructions (i.e. system message) prepended to model calls.
-        #
-        # @param max_output_tokens [Integer, Symbol, :inf] Maximum number of output tokens for a single assistant response,
-        #
-        # @param model [String, Symbol, OpenAI::Models::Realtime::RealtimeSessionCreateRequest::Model] The Realtime model used for this session.
-        #
-        # @param output_modalities [Array<Symbol, OpenAI::Models::Realtime::RealtimeSessionCreateRequest::OutputModality>] The set of modalities the model can respond with. It defaults to `["audio"]`, in
-        #
-        # @param parallel_tool_calls [Boolean] Whether the model may call multiple tools in parallel. Only supported by
-        #
-        # @param prompt [OpenAI::Models::Responses::ResponsePrompt, nil] Reference to a prompt template and its variables.
-        #
-        # @param reasoning [OpenAI::Models::Realtime::RealtimeReasoning] Configuration for reasoning-capable Realtime models such as `gpt-realtime-2`.
-        #
-        # @param tool_choice [Symbol, OpenAI::Models::Responses::ToolChoiceOptions, OpenAI::Models::Responses::ToolChoiceFunction, OpenAI::Models::Responses::ToolChoiceMcp] How the model chooses tools. Provide one of the string modes or force a specific
-        #
-        # @param tools [Array<OpenAI::Models::Realtime::RealtimeFunctionTool, OpenAI::Models::Realtime::RealtimeToolsConfigUnion::Mcp>] Tools available to the model.
-        #
-        # @param tracing [Symbol, :auto, OpenAI::Models::Realtime::RealtimeTracingConfig::TracingConfiguration, nil] Realtime API can write session traces to the [Traces Dashboard](https://platform
-        #
-        # @param truncation [Symbol, OpenAI::Models::Realtime::RealtimeTruncation::RealtimeTruncationStrategy, OpenAI::Models::Realtime::RealtimeTruncationRetentionRatio] When the number of tokens in a conversation exceeds the model's input token limi
-        #
-        # @param type [Symbol, :realtime] The type of session to create. Always `realtime` for the Realtime API.
+        # @param call_id [String]
+        #   The identifier for the call provided in the
+        #   [`realtime.call.incoming`](https://developers.openai.com/api/reference/resources/webhooks#realtime.call.incoming)
+        #   webhook.
+        #
+        # @param audio [OpenAI::Models::Realtime::RealtimeAudioConfig]
+        #   Configuration for input and output audio.
+        #
+        # @param include [Array<Symbol, OpenAI::Models::Realtime::RealtimeSessionCreateRequest::Include>]
+        #   Additional fields to include in server outputs.
+        #
+        #   `item.input_audio_transcription.logprobs`: Include logprobs for input audio
+        #   transcription.
+        #
+        # @param instructions [String]
+        #   The default system instructions (i.e. system message) prepended to model calls.
+        #   This field allows the client to guide the model on desired responses. The model
+        #   can be instructed on response content and format, (e.g. "be extremely succinct",
+        #   "act friendly", "here are examples of good responses") and on audio behavior
+        #   (e.g. "talk quickly", "inject emotion into your voice", "laugh frequently"). The
+        #   instructions are not guaranteed to be followed by the model, but they provide
+        #   guidance to the model on the desired behavior.
+        #
+        #   Note that the server sets default instructions which will be used if this field
+        #   is not set and are visible in the `session.created` event at the start of the
+        #   session.
+        #
+        # @param max_output_tokens [Integer, Symbol, :inf]
+        #   Maximum number of output tokens for a single assistant response, inclusive of
+        #   tool calls. Provide an integer between 1 and 4096 to limit output tokens, or
+        #   `inf` for the maximum available tokens for a given model. Defaults to `inf`.
+        #
+        # @param model [String, Symbol, OpenAI::Models::Realtime::RealtimeSessionCreateRequest::Model]
+        #   The Realtime model used for this session.
+        #
+        # @param output_modalities [Array<Symbol, OpenAI::Models::Realtime::RealtimeSessionCreateRequest::OutputModality>]
+        #   The set of modalities the model can respond with. It defaults to `["audio"]`,
+        #   indicating that the model will respond with audio plus a transcript. `["text"]`
+        #   can be used to make the model respond with text only. It is not possible to
+        #   request both `text` and `audio` at the same time.
+        #
+        # @param parallel_tool_calls [Boolean]
+        #   Whether the model may call multiple tools in parallel. Only supported by
+        #   reasoning Realtime models such as `gpt-realtime-2`.
+        #
+        # @param prompt [OpenAI::Models::Responses::ResponsePrompt, nil]
+        #   Reference to a prompt template and its variables.
+        #   [Learn more](https://developers.openai.com/api/docs/guides/text?api-mode=responses#version-prompts-in-code).
+        #
+        # @param reasoning [OpenAI::Models::Realtime::RealtimeReasoning]
+        #   Configuration for reasoning-capable Realtime models such as `gpt-realtime-2`.
+        #
+        # @param tool_choice [Symbol, OpenAI::Models::Responses::ToolChoiceOptions, OpenAI::Models::Responses::ToolChoiceFunction, OpenAI::Models::Responses::ToolChoiceMcp]
+        #   How the model chooses tools. Provide one of the string modes or force a specific
+        #   function/MCP tool.
+        #
+        # @param tools [Array<OpenAI::Models::Realtime::RealtimeFunctionTool, OpenAI::Models::Realtime::RealtimeToolsConfigUnion::Mcp>]
+        #   Tools available to the model.
+        #
+        # @param tracing [Symbol, :auto, OpenAI::Models::Realtime::RealtimeTracingConfig::TracingConfiguration, nil]
+        #   Realtime API can write session traces to the
+        #   [Traces Dashboard](https://platform.openai.com/logs?api=traces). Set to null to
+        #   disable tracing. Once tracing is enabled for a session, the configuration cannot
+        #   be modified.
+        #
+        #   `auto` will create a trace for the session with default values for the workflow
+        #   name, group id, and metadata.
+        #
+        # @param truncation [Symbol, OpenAI::Models::Realtime::RealtimeTruncation::RealtimeTruncationStrategy, OpenAI::Models::Realtime::RealtimeTruncationRetentionRatio]
+        #   When the number of tokens in a conversation exceeds the model's input token
+        #   limit, the conversation be truncated, meaning messages (starting from the
+        #   oldest) will not be included in the model's context. A 32k context model with
+        #   4,096 max output tokens can only include 28,224 tokens in the context before
+        #   truncation occurs.
+        #
+        #   Clients can configure truncation behavior to truncate with a lower max token
+        #   limit, which is an effective way to control token usage and cost.
+        #
+        #   Truncation will reduce the number of cached tokens on the next turn (busting the
+        #   cache), since messages are dropped from the beginning of the context. However,
+        #   clients can also configure truncation to retain messages up to a fraction of the
+        #   maximum context size, which will reduce the need for future truncations and thus
+        #   improve the cache rate.
+        #
+        #   Truncation can be disabled entirely, which means the server will never truncate
+        #   but would instead return an error if the conversation exceeds the model's input
+        #   token limit.
+        #
+        # @param type [Symbol, :realtime]
+        #   The type of session to create. Always `realtime` for the Realtime API.
         #
         # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
         #
@@ -113,14 +173,16 @@ module OpenAI
           )
         end
 
-        # Some parameter documentations has been truncated, see
-        # {OpenAI::Models::Realtime::CallHangupParams} for more details.
-        #
         # End an active Realtime API call, whether it was initiated over SIP or WebRTC.
         #
         # @overload hangup(call_id, request_options: {})
         #
-        # @param call_id [String] The identifier for the call. For SIP calls, use the value provided in the
+        # @param call_id [String]
+        #   The identifier for the call. For SIP calls, use the value provided in the
+        #   [`realtime.call.incoming`](https://developers.openai.com/api/reference/resources/webhooks#realtime.call.incoming)
+        #   webhook. For WebRTC sessions, reuse the call ID returned in the `Location`
+        #   header when creating the call with
+        #   [`POST /v1/realtime/calls`](https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/create).
         #
         # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
         #
@@ -137,16 +199,18 @@ module OpenAI
           )
         end
 
-        # Some parameter documentations has been truncated, see
-        # {OpenAI::Models::Realtime::CallReferParams} for more details.
-        #
         # Transfer an active SIP call to a new destination using the SIP REFER verb.
         #
         # @overload refer(call_id, target_uri:, request_options: {})
         #
-        # @param call_id [String] The identifier for the call provided in the
+        # @param call_id [String]
+        #   The identifier for the call provided in the
+        #   [`realtime.call.incoming`](https://developers.openai.com/api/reference/resources/webhooks#realtime.call.incoming)
+        #   webhook.
         #
-        # @param target_uri [String] URI that should appear in the SIP Refer-To header. Supports values like
+        # @param target_uri [String]
+        #   URI that should appear in the SIP Refer-To header. Supports values like
+        #   `tel:+14155550123` or `sip:agent@example.com`.
         #
         # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
         #
@@ -165,16 +229,18 @@ module OpenAI
           )
         end
 
-        # Some parameter documentations has been truncated, see
-        # {OpenAI::Models::Realtime::CallRejectParams} for more details.
-        #
         # Decline an incoming SIP call by returning a SIP status code to the caller.
         #
         # @overload reject(call_id, status_code: nil, request_options: {})
         #
-        # @param call_id [String] The identifier for the call provided in the
+        # @param call_id [String]
+        #   The identifier for the call provided in the
+        #   [`realtime.call.incoming`](https://developers.openai.com/api/reference/resources/webhooks#realtime.call.incoming)
+        #   webhook.
         #
-        # @param status_code [Integer] SIP response code to send back to the caller. Defaults to `603` (Decline)
+        # @param status_code [Integer]
+        #   SIP response code to send back to the caller. Defaults to `603` (Decline) when
+        #   omitted.
         #
         # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
         #

data/lib/openai/resources/realtime/client_secrets.rb

@@ -4,9 +4,6 @@ module OpenAI
   module Resources
     class Realtime
       class ClientSecrets
-        # Some parameter documentations has been truncated, see
-        # {OpenAI::Models::Realtime::ClientSecretCreateParams} for more details.
-        #
         # Create a Realtime client secret with an associated session configuration.
         #
         # Client secrets are short-lived tokens that can be passed to a client app, such
@@ -18,16 +15,22 @@ module OpenAI
         # will be applied to any sessions created using that client secret, but these can
         # also be overridden by the client connection.
         #
-        # [Learn more about authentication with client secrets over WebRTC](https://platform.openai.com/docs/guides/realtime-webrtc).
+        # [Learn more about authentication with client secrets over WebRTC](https://developers.openai.com/api/docs/guides/realtime-webrtc).
         #
         # Returns the created client secret and the effective session object. The client
         # secret is a string that looks like `ek_1234`.
         #
         # @overload create(expires_after: nil, session: nil, request_options: {})
         #
-        # @param expires_after [OpenAI::Models::Realtime::ClientSecretCreateParams::ExpiresAfter] Configuration for the client secret expiration. Expiration refers to the time af
+        # @param expires_after [OpenAI::Models::Realtime::ClientSecretCreateParams::ExpiresAfter]
+        #   Configuration for the client secret expiration. Expiration refers to the time
+        #   after which a client secret will no longer be valid for creating sessions. The
+        #   session itself may continue after that time once started. A secret can be used
+        #   to create multiple sessions until it expires.
         #
-        # @param session [OpenAI::Models::Realtime::RealtimeSessionCreateRequest, OpenAI::Models::Realtime::RealtimeTranscriptionSessionCreateRequest] Session configuration to use for the client secret. Choose either a realtime
+        # @param session [OpenAI::Models::Realtime::RealtimeSessionCreateRequest, OpenAI::Models::Realtime::RealtimeTranscriptionSessionCreateRequest]
+        #   Session configuration to use for the client secret. Choose either a realtime
+        #   session or a transcription session.
         #
         # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
         #

data/lib/openai/resources/responses/input_items.rb

@@ -4,22 +4,29 @@ module OpenAI
   module Resources
     class Responses
       class InputItems
-        # Some parameter documentations has been truncated, see
-        # {OpenAI::Models::Responses::InputItemListParams} for more details.
-        #
         # Returns a list of input items for a given response.
         #
         # @overload list(response_id, after: nil, include: nil, limit: nil, order: nil, request_options: {})
         #
-        # @param response_id [String] The ID of the response to retrieve input items for.
+        # @param response_id [String]
+        #   The ID of the response to retrieve input items for.
+        #
+        # @param after [String]
+        #   An item ID to list items after, used in pagination.
         #
-        # @param after [String] An item ID to list items after, used in pagination.
+        # @param include [Array<Symbol, OpenAI::Models::Responses::ResponseIncludable>]
+        #   Additional fields to include in the response. See the `include` parameter for
+        #   Response creation above for more information.
         #
-        # @param include [Array<Symbol, OpenAI::Models::Responses::ResponseIncludable>] Additional fields to include in the response. See the `include`
+        # @param limit [Integer]
+        #   A limit on the number of objects to be returned. Limit can range between 1 and
+        #   100, and the default is 20.
         #
-        # @param limit [Integer] A limit on the number of objects to be returned. Limit can range between
+        # @param order [Symbol, OpenAI::Models::Responses::InputItemListParams::Order]
+        #   The order to return the input items in. Default is `desc`.
         #
-        # @param order [Symbol, OpenAI::Models::Responses::InputItemListParams::Order] The order to return the input items in. Default is `desc`.
+        #   - `asc`: Return the input items in ascending order.
+        #   - `desc`: Return the input items in descending order.
         #
         # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
         #