openai 0.50.0 → 0.52.0

data/lib/openai/models/video.rb

@@ -65,10 +65,11 @@ module OpenAI
       required :remixed_from_video_id, String, nil?: true
 
       # @!attribute seconds
-      #   Duration of the generated clip in seconds.
+      #   Duration of the generated clip in seconds. For extensions, this is the stitched
+      #   total duration.
       #
-      #   @return [Symbol, OpenAI::Models::VideoSeconds]
-      required :seconds, enum: -> { OpenAI::VideoSeconds }
+      #   @return [String, Symbol, OpenAI::Models::VideoSeconds]
+      required :seconds, union: -> { OpenAI::Video::Seconds }
 
       # @!attribute size
       #   The resolution of the generated video.
@@ -83,6 +84,9 @@ module OpenAI
       required :status, enum: -> { OpenAI::Video::Status }
 
       # @!method initialize(id:, completed_at:, created_at:, error:, expires_at:, model:, progress:, prompt:, remixed_from_video_id:, seconds:, size:, status:, object: :video)
+      #   Some parameter documentations has been truncated, see {OpenAI::Models::Video}
+      #   for more details.
+      #
       #   Structured information describing a generated video job.
       #
       #   @param id [String] Unique identifier for the video job.
@@ -103,7 +107,7 @@ module OpenAI
       #
       #   @param remixed_from_video_id [String, nil] Identifier of the source video if this video is a remix.
       #
-      #   @param seconds [Symbol, OpenAI::Models::VideoSeconds] Duration of the generated clip in seconds.
+      #   @param seconds [String, Symbol, OpenAI::Models::VideoSeconds] Duration of the generated clip in seconds. For extensions, this is the stitched
       #
       #   @param size [Symbol, OpenAI::Models::VideoSize] The resolution of the generated video.
       #
@@ -111,6 +115,22 @@ module OpenAI
       #
       #   @param object [Symbol, :video] The object type, which is always `video`.
 
+      # Duration of the generated clip in seconds. For extensions, this is the stitched
+      # total duration.
+      #
+      # @see OpenAI::Models::Video#seconds
+      module Seconds
+        extend OpenAI::Internal::Type::Union
+
+        variant String
+
+        # Duration of the generated clip in seconds. For extensions, this is the stitched total duration.
+        variant enum: -> { OpenAI::VideoSeconds }
+
+        # @!method self.variants
+        #   @return [Array(String, Symbol, OpenAI::Models::VideoSeconds)]
+      end
+
       # Current lifecycle status of the video job.
       #
       # @see OpenAI::Models::Video#status

data/lib/openai/models/video_create_params.rb

@@ -14,7 +14,7 @@ module OpenAI
       required :prompt, String
 
       # @!attribute input_reference
-      #   Optional image reference that guides generation.
+      #   Optional multipart reference asset that guides generation.
       #
       #   @return [Pathname, StringIO, IO, String, OpenAI::FilePart, nil]
       optional :input_reference, OpenAI::Internal::Type::FileInput
@@ -45,7 +45,7 @@ module OpenAI
       #
       #   @param prompt [String] Text prompt that describes the video to generate.
       #
-      #   @param input_reference [Pathname, StringIO, IO, String, OpenAI::FilePart] Optional image reference that guides generation.
+      #   @param input_reference [Pathname, StringIO, IO, String, OpenAI::FilePart] Optional multipart reference asset that guides generation.
       #
       #   @param model [String, Symbol, OpenAI::Models::VideoModel] The video generation model to use (allowed values: sora-2, sora-2-pro). Defaults
       #

data/lib/openai/models/video_delete_params.rb

@@ -7,7 +7,13 @@ module OpenAI
       extend OpenAI::Internal::Type::RequestParameters::Converter
       include OpenAI::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute video_id
+      #
+      #   @return [String]
+      required :video_id, String
+
+      # @!method initialize(video_id:, request_options: {})
+      #   @param video_id [String]
       #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/openai/models/video_download_content_params.rb

@@ -7,13 +7,20 @@ module OpenAI
       extend OpenAI::Internal::Type::RequestParameters::Converter
       include OpenAI::Internal::Type::RequestParameters
 
+      # @!attribute video_id
+      #
+      #   @return [String]
+      required :video_id, String
+
       # @!attribute variant
       #   Which downloadable asset to return. Defaults to the MP4 video.
       #
       #   @return [Symbol, OpenAI::Models::VideoDownloadContentParams::Variant, nil]
       optional :variant, enum: -> { OpenAI::VideoDownloadContentParams::Variant }
 
-      # @!method initialize(variant: nil, request_options: {})
+      # @!method initialize(video_id:, variant: nil, request_options: {})
+      #   @param video_id [String]
+      #
       #   @param variant [Symbol, OpenAI::Models::VideoDownloadContentParams::Variant] Which downloadable asset to return. Defaults to the MP4 video.
       #
       #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]

data/lib/openai/models/video_remix_params.rb

@@ -7,13 +7,20 @@ module OpenAI
       extend OpenAI::Internal::Type::RequestParameters::Converter
       include OpenAI::Internal::Type::RequestParameters
 
+      # @!attribute video_id
+      #
+      #   @return [String]
+      required :video_id, String
+
       # @!attribute prompt
       #   Updated text prompt that directs the remix generation.
       #
       #   @return [String]
       required :prompt, String
 
-      # @!method initialize(prompt:, request_options: {})
+      # @!method initialize(video_id:, prompt:, request_options: {})
+      #   @param video_id [String]
+      #
       #   @param prompt [String] Updated text prompt that directs the remix generation.
       #
       #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]

data/lib/openai/models/video_retrieve_params.rb

@@ -7,7 +7,13 @@ module OpenAI
       extend OpenAI::Internal::Type::RequestParameters::Converter
       include OpenAI::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute video_id
+      #
+      #   @return [String]
+      required :video_id, String
+
+      # @!method initialize(video_id:, request_options: {})
+      #   @param video_id [String]
       #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/openai/resources/audio/speech.rb

@@ -3,6 +3,7 @@
 module OpenAI
   module Resources
     class Audio
+      # Turn audio into text or text into audio.
       class Speech
         # Some parameter documentations has been truncated, see
         # {OpenAI::Models::Audio::SpeechCreateParams} for more details.

data/lib/openai/resources/audio/transcriptions.rb

@@ -3,6 +3,7 @@
 module OpenAI
   module Resources
     class Audio
+      # Turn audio into text or text into audio.
       class Transcriptions
         # See {OpenAI::Resources::Audio::Transcriptions#create_streaming} for streaming
         # counterpart.

data/lib/openai/resources/audio/translations.rb

@@ -3,6 +3,7 @@
 module OpenAI
   module Resources
     class Audio
+      # Turn audio into text or text into audio.
       class Translations
         # Some parameter documentations has been truncated, see
         # {OpenAI::Models::Audio::TranslationCreateParams} for more details.

data/lib/openai/resources/audio.rb

@@ -3,12 +3,15 @@
 module OpenAI
   module Resources
     class Audio
+      # Turn audio into text or text into audio.
       # @return [OpenAI::Resources::Audio::Transcriptions]
       attr_reader :transcriptions
 
+      # Turn audio into text or text into audio.
       # @return [OpenAI::Resources::Audio::Translations]
       attr_reader :translations
 
+      # Turn audio into text or text into audio.
       # @return [OpenAI::Resources::Audio::Speech]
       attr_reader :speech
 

data/lib/openai/resources/batches.rb

@@ -2,6 +2,7 @@
 
 module OpenAI
   module Resources
+    # Create large batches of API requests to run asynchronously.
     class Batches
       # Some parameter documentations has been truncated, see
       # {OpenAI::Models::BatchCreateParams} for more details.
@@ -68,10 +69,11 @@ module OpenAI
       # @see OpenAI::Models::BatchListParams
       def list(params = {})
         parsed, options = OpenAI::BatchListParams.dump_request(params)
+        query = OpenAI::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: "batches",
-          query: parsed,
+          query: query,
           page: OpenAI::Internal::CursorPage,
           model: OpenAI::Batch,
           options: options

data/lib/openai/resources/beta/assistants.rb

@@ -3,6 +3,7 @@
 module OpenAI
   module Resources
     class Beta
+      # Build Assistants that can call models and use tools.
       class Assistants
         # @deprecated
         #
@@ -146,10 +147,11 @@ module OpenAI
         # @see OpenAI::Models::Beta::AssistantListParams
         def list(params = {})
           parsed, options = OpenAI::Beta::AssistantListParams.dump_request(params)
+          query = OpenAI::Internal::Util.encode_query_params(parsed)
           @client.request(
             method: :get,
             path: "assistants",
-            query: parsed,
+            query: query,
             page: OpenAI::Internal::CursorPage,
             model: OpenAI::Beta::Assistant,
             options: {extra_headers: {"OpenAI-Beta" => "assistants=v2"}, **options}

data/lib/openai/resources/beta/chatkit/threads.rb

@@ -49,10 +49,11 @@ module OpenAI
           # @see OpenAI::Models::Beta::ChatKit::ThreadListParams
           def list(params = {})
             parsed, options = OpenAI::Beta::ChatKit::ThreadListParams.dump_request(params)
+            query = OpenAI::Internal::Util.encode_query_params(parsed)
             @client.request(
               method: :get,
               path: "chatkit/threads",
-              query: parsed,
+              query: query,
               page: OpenAI::Internal::ConversationCursorPage,
               model: OpenAI::Beta::ChatKit::ChatKitThread,
               options: {extra_headers: {"OpenAI-Beta" => "chatkit_beta=v1"}, **options}
@@ -103,10 +104,11 @@ module OpenAI
           # @see OpenAI::Models::Beta::ChatKit::ThreadListItemsParams
           def list_items(thread_id, params = {})
             parsed, options = OpenAI::Beta::ChatKit::ThreadListItemsParams.dump_request(params)
+            query = OpenAI::Internal::Util.encode_query_params(parsed)
             @client.request(
               method: :get,
               path: ["chatkit/threads/%1$s/items", thread_id],
-              query: parsed,
+              query: query,
               page: OpenAI::Internal::ConversationCursorPage,
               model: OpenAI::Beta::ChatKit::ChatKitThreadItemList::Data,
               options: {extra_headers: {"OpenAI-Beta" => "chatkit_beta=v1"}, **options}

data/lib/openai/resources/beta/threads/messages.rb

@@ -5,6 +5,8 @@ module OpenAI
     class Beta
       class Threads
         # @deprecated The Assistants API is deprecated in favor of the Responses API
+        #
+        # Build Assistants that can call models and use tools.
         class Messages
           # @deprecated The Assistants API is deprecated in favor of the Responses API
           #
@@ -136,10 +138,11 @@ module OpenAI
           # @see OpenAI::Models::Beta::Threads::MessageListParams
           def list(thread_id, params = {})
             parsed, options = OpenAI::Beta::Threads::MessageListParams.dump_request(params)
+            query = OpenAI::Internal::Util.encode_query_params(parsed)
             @client.request(
               method: :get,
               path: ["threads/%1$s/messages", thread_id],
-              query: parsed,
+              query: query,
               page: OpenAI::Internal::CursorPage,
               model: OpenAI::Beta::Threads::Message,
               options: {extra_headers: {"OpenAI-Beta" => "assistants=v2"}, **options}

data/lib/openai/resources/beta/threads/runs/steps.rb

@@ -6,6 +6,8 @@ module OpenAI
       class Threads
         class Runs
           # @deprecated The Assistants API is deprecated in favor of the Responses API
+          #
+          # Build Assistants that can call models and use tools.
           class Steps
             # @deprecated The Assistants API is deprecated in favor of the Responses API
             #
@@ -31,6 +33,7 @@ module OpenAI
             # @see OpenAI::Models::Beta::Threads::Runs::StepRetrieveParams
             def retrieve(step_id, params)
               parsed, options = OpenAI::Beta::Threads::Runs::StepRetrieveParams.dump_request(params)
+              query = OpenAI::Internal::Util.encode_query_params(parsed)
               thread_id =
                 parsed.delete(:thread_id) do
                   raise ArgumentError.new("missing required path argument #{_1}")
@@ -42,7 +45,7 @@ module OpenAI
               @client.request(
                 method: :get,
                 path: ["threads/%1$s/runs/%2$s/steps/%3$s", thread_id, run_id, step_id],
-                query: parsed,
+                query: query,
                 model: OpenAI::Beta::Threads::Runs::RunStep,
                 options: {extra_headers: {"OpenAI-Beta" => "assistants=v2"}, **options}
               )
@@ -78,6 +81,7 @@ module OpenAI
             # @see OpenAI::Models::Beta::Threads::Runs::StepListParams
             def list(run_id, params)
               parsed, options = OpenAI::Beta::Threads::Runs::StepListParams.dump_request(params)
+              query = OpenAI::Internal::Util.encode_query_params(parsed)
               thread_id =
                 parsed.delete(:thread_id) do
                   raise ArgumentError.new("missing required path argument #{_1}")
@@ -85,7 +89,7 @@ module OpenAI
               @client.request(
                 method: :get,
                 path: ["threads/%1$s/runs/%2$s/steps", thread_id, run_id],
-                query: parsed,
+                query: query,
                 page: OpenAI::Internal::CursorPage,
                 model: OpenAI::Beta::Threads::Runs::RunStep,
                 options: {extra_headers: {"OpenAI-Beta" => "assistants=v2"}, **options}

data/lib/openai/resources/beta/threads/runs.rb

@@ -5,7 +5,10 @@ module OpenAI
     class Beta
       class Threads
         # @deprecated The Assistants API is deprecated in favor of the Responses API
+        #
+        # Build Assistants that can call models and use tools.
         class Runs
+          # Build Assistants that can call models and use tools.
           # @return [OpenAI::Resources::Beta::Threads::Runs::Steps]
           attr_reader :steps
 
@@ -63,16 +66,17 @@ module OpenAI
           #
           # @see OpenAI::Models::Beta::Threads::RunCreateParams
           def create(thread_id, params)
+            query_params = [:include]
             parsed, options = OpenAI::Beta::Threads::RunCreateParams.dump_request(params)
+            query = OpenAI::Internal::Util.encode_query_params(parsed.slice(*query_params))
             if parsed[:stream]
               message = "Please use `#create_stream_raw` for the streaming use case."
               raise ArgumentError.new(message)
             end
-            query_params = [:include]
             @client.request(
               method: :post,
               path: ["threads/%1$s/runs", thread_id],
-              query: parsed.slice(*query_params),
+              query: query,
               body: parsed.except(*query_params),
               model: OpenAI::Beta::Threads::Run,
               options: {extra_headers: {"OpenAI-Beta" => "assistants=v2"}, **options}
@@ -133,17 +137,18 @@ module OpenAI
           #
           # @see OpenAI::Models::Beta::Threads::RunCreateParams
           def create_stream_raw(thread_id, params)
+            query_params = [:include]
             parsed, options = OpenAI::Beta::Threads::RunCreateParams.dump_request(params)
+            query = OpenAI::Internal::Util.encode_query_params(parsed.slice(*query_params))
             unless parsed.fetch(:stream, true)
               message = "Please use `#create` for the non-streaming use case."
               raise ArgumentError.new(message)
             end
             parsed.store(:stream, true)
-            query_params = [:include]
             @client.request(
               method: :post,
               path: ["threads/%1$s/runs", thread_id],
-              query: parsed.slice(*query_params),
+              query: query,
               headers: {"accept" => "text/event-stream"},
               body: parsed.except(*query_params),
               stream: OpenAI::Internal::Stream,
@@ -245,10 +250,11 @@ module OpenAI
           # @see OpenAI::Models::Beta::Threads::RunListParams
           def list(thread_id, params = {})
             parsed, options = OpenAI::Beta::Threads::RunListParams.dump_request(params)
+            query = OpenAI::Internal::Util.encode_query_params(parsed)
             @client.request(
               method: :get,
               path: ["threads/%1$s/runs", thread_id],
-              query: parsed,
+              query: query,
               page: OpenAI::Internal::CursorPage,
               model: OpenAI::Beta::Threads::Run,
               options: {extra_headers: {"OpenAI-Beta" => "assistants=v2"}, **options}

data/lib/openai/resources/beta/threads.rb

@@ -4,10 +4,14 @@ module OpenAI
   module Resources
     class Beta
       # @deprecated The Assistants API is deprecated in favor of the Responses API
+      #
+      # Build Assistants that can call models and use tools.
       class Threads
+        # Build Assistants that can call models and use tools.
         # @return [OpenAI::Resources::Beta::Threads::Runs]
         attr_reader :runs
 
+        # Build Assistants that can call models and use tools.
         # @return [OpenAI::Resources::Beta::Threads::Messages]
         attr_reader :messages
 

data/lib/openai/resources/beta.rb

@@ -6,9 +6,11 @@ module OpenAI
       # @return [OpenAI::Resources::Beta::ChatKit]
       attr_reader :chatkit
 
+      # Build Assistants that can call models and use tools.
       # @return [OpenAI::Resources::Beta::Assistants]
       attr_reader :assistants
 
+      # Build Assistants that can call models and use tools.
       # @return [OpenAI::Resources::Beta::Threads]
       attr_reader :threads
 

data/lib/openai/resources/chat/completions/messages.rb

@@ -4,6 +4,8 @@ module OpenAI
   module Resources
     class Chat
       class Completions
+        # Given a list of messages comprising a conversation, the model will return a
+        # response.
         class Messages
           # Some parameter documentations has been truncated, see
           # {OpenAI::Models::Chat::Completions::MessageListParams} for more details.
@@ -28,10 +30,11 @@ module OpenAI
           # @see OpenAI::Models::Chat::Completions::MessageListParams
           def list(completion_id, params = {})
             parsed, options = OpenAI::Chat::Completions::MessageListParams.dump_request(params)
+            query = OpenAI::Internal::Util.encode_query_params(parsed)
             @client.request(
               method: :get,
               path: ["chat/completions/%1$s/messages", completion_id],
-              query: parsed,
+              query: query,
               page: OpenAI::Internal::CursorPage,
               model: OpenAI::Chat::ChatCompletionStoreMessage,
               options: options

data/lib/openai/resources/chat/completions.rb

@@ -3,7 +3,11 @@
 module OpenAI
   module Resources
     class Chat
+      # Given a list of messages comprising a conversation, the model will return a
+      # response.
       class Completions
+        # Given a list of messages comprising a conversation, the model will return a
+        # response.
         # @return [OpenAI::Resources::Chat::Completions::Messages]
         attr_reader :messages
 
@@ -451,10 +455,11 @@ module OpenAI
         # @see OpenAI::Models::Chat::CompletionListParams
         def list(params = {})
           parsed, options = OpenAI::Chat::CompletionListParams.dump_request(params)
+          query = OpenAI::Internal::Util.encode_query_params(parsed)
           @client.request(
             method: :get,
             path: "chat/completions",
-            query: parsed,
+            query: query,
             page: OpenAI::Internal::CursorPage,
             model: OpenAI::Chat::ChatCompletion,
             options: options

data/lib/openai/resources/chat.rb

@@ -3,6 +3,8 @@
 module OpenAI
   module Resources
     class Chat
+      # Given a list of messages comprising a conversation, the model will return a
+      # response.
       # @return [OpenAI::Resources::Chat::Completions]
       attr_reader :completions
 

data/lib/openai/resources/completions.rb

@@ -2,6 +2,8 @@
 
 module OpenAI
   module Resources
+    # Given a prompt, the model will return one or more predicted completions, and can
+    # also return the probabilities of alternative tokens at each position.
     class Completions
       # See {OpenAI::Resources::Completions#create_streaming} for streaming counterpart.
       #

data/lib/openai/resources/containers/files.rb

@@ -86,10 +86,11 @@ module OpenAI
         # @see OpenAI::Models::Containers::FileListParams
         def list(container_id, params = {})
           parsed, options = OpenAI::Containers::FileListParams.dump_request(params)
+          query = OpenAI::Internal::Util.encode_query_params(parsed)
           @client.request(
             method: :get,
             path: ["containers/%1$s/files", container_id],
-            query: parsed,
+            query: query,
             page: OpenAI::Internal::CursorPage,
             model: OpenAI::Models::Containers::FileListResponse,
             options: options

data/lib/openai/resources/containers.rb

@@ -79,10 +79,11 @@ module OpenAI
       # @see OpenAI::Models::ContainerListParams
       def list(params = {})
         parsed, options = OpenAI::ContainerListParams.dump_request(params)
+        query = OpenAI::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: "containers",
-          query: parsed,
+          query: query,
           page: OpenAI::Internal::CursorPage,
           model: OpenAI::Models::ContainerListResponse,
           options: options

data/lib/openai/resources/conversations/items.rb

@@ -3,6 +3,7 @@
 module OpenAI
   module Resources
     class Conversations
+      # Manage conversations and conversation items.
       class Items
         # Some parameter documentations has been truncated, see
         # {OpenAI::Models::Conversations::ItemCreateParams} for more details.
@@ -13,7 +14,7 @@ module OpenAI
         #
         # @param conversation_id [String] Path param: The ID of the conversation to add the item to.
         #
-        # @param items [Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItemParam, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ShellCall, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::ItemReference>] Body param: The items to add to the conversation. You may add up to 20 items at
+        # @param items [Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseInputItem::ToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItemParam, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItemParam, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ShellCall, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::ItemReference>] Body param: The items to add to the conversation. You may add up to 20 items at
         #
         # @param include [Array<Symbol, OpenAI::Models::Responses::ResponseIncludable>] Query param: Additional fields to include in the response. See the `include`
         #
@@ -23,12 +24,13 @@ module OpenAI
         #
         # @see OpenAI::Models::Conversations::ItemCreateParams
         def create(conversation_id, params)
-          parsed, options = OpenAI::Conversations::ItemCreateParams.dump_request(params)
           query_params = [:include]
+          parsed, options = OpenAI::Conversations::ItemCreateParams.dump_request(params)
+          query = OpenAI::Internal::Util.encode_query_params(parsed.slice(*query_params))
           @client.request(
             method: :post,
             path: ["conversations/%1$s/items", conversation_id],
-            query: parsed.slice(*query_params),
+            query: query,
             body: parsed.except(*query_params),
             model: OpenAI::Conversations::ConversationItemList,
             options: options
@@ -50,11 +52,12 @@ module OpenAI
         #
         # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [OpenAI::Models::Conversations::Message, OpenAI::Models::Responses::ResponseFunctionToolCallItem, OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Conversations::ConversationItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseComputerToolCallOutputItem, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Conversations::ConversationItem::LocalShellCall, OpenAI::Models::Conversations::ConversationItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseFunctionShellToolCall, OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput, OpenAI::Models::Responses::ResponseApplyPatchToolCall, OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput, OpenAI::Models::Conversations::ConversationItem::McpListTools, OpenAI::Models::Conversations::ConversationItem::McpApprovalRequest, OpenAI::Models::Conversations::ConversationItem::McpApprovalResponse, OpenAI::Models::Conversations::ConversationItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput]
+        # @return [OpenAI::Models::Conversations::Message, OpenAI::Models::Responses::ResponseFunctionToolCallItem, OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Conversations::ConversationItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseComputerToolCallOutputItem, OpenAI::Models::Responses::ResponseToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItem, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Conversations::ConversationItem::LocalShellCall, OpenAI::Models::Conversations::ConversationItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseFunctionShellToolCall, OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput, OpenAI::Models::Responses::ResponseApplyPatchToolCall, OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput, OpenAI::Models::Conversations::ConversationItem::McpListTools, OpenAI::Models::Conversations::ConversationItem::McpApprovalRequest, OpenAI::Models::Conversations::ConversationItem::McpApprovalResponse, OpenAI::Models::Conversations::ConversationItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput]
         #
         # @see OpenAI::Models::Conversations::ItemRetrieveParams
         def retrieve(item_id, params)
           parsed, options = OpenAI::Conversations::ItemRetrieveParams.dump_request(params)
+          query = OpenAI::Internal::Util.encode_query_params(parsed)
           conversation_id =
             parsed.delete(:conversation_id) do
               raise ArgumentError.new("missing required path argument #{_1}")
@@ -62,7 +65,7 @@ module OpenAI
           @client.request(
             method: :get,
             path: ["conversations/%1$s/items/%2$s", conversation_id, item_id],
-            query: parsed,
+            query: query,
             model: OpenAI::Conversations::ConversationItem,
             options: options
           )
@@ -87,15 +90,16 @@ module OpenAI
         #
         # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [OpenAI::Internal::ConversationCursorPage<OpenAI::Models::Conversations::Message, OpenAI::Models::Responses::ResponseFunctionToolCallItem, OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Conversations::ConversationItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseComputerToolCallOutputItem, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Conversations::ConversationItem::LocalShellCall, OpenAI::Models::Conversations::ConversationItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseFunctionShellToolCall, OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput, OpenAI::Models::Responses::ResponseApplyPatchToolCall, OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput, OpenAI::Models::Conversations::ConversationItem::McpListTools, OpenAI::Models::Conversations::ConversationItem::McpApprovalRequest, OpenAI::Models::Conversations::ConversationItem::McpApprovalResponse, OpenAI::Models::Conversations::ConversationItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput>]
+        # @return [OpenAI::Internal::ConversationCursorPage<OpenAI::Models::Conversations::Message, OpenAI::Models::Responses::ResponseFunctionToolCallItem, OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Conversations::ConversationItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseComputerToolCallOutputItem, OpenAI::Models::Responses::ResponseToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItem, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Conversations::ConversationItem::LocalShellCall, OpenAI::Models::Conversations::ConversationItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseFunctionShellToolCall, OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput, OpenAI::Models::Responses::ResponseApplyPatchToolCall, OpenAI::Models::Responses::ResponseApplyPatchToolCallOutput, OpenAI::Models::Conversations::ConversationItem::McpListTools, OpenAI::Models::Conversations::ConversationItem::McpApprovalRequest, OpenAI::Models::Conversations::ConversationItem::McpApprovalResponse, OpenAI::Models::Conversations::ConversationItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput>]
         #
         # @see OpenAI::Models::Conversations::ItemListParams
         def list(conversation_id, params = {})
           parsed, options = OpenAI::Conversations::ItemListParams.dump_request(params)
+          query = OpenAI::Internal::Util.encode_query_params(parsed)
           @client.request(
             method: :get,
             path: ["conversations/%1$s/items", conversation_id],
-            query: parsed,
+            query: query,
             page: OpenAI::Internal::ConversationCursorPage,
             model: OpenAI::Conversations::ConversationItem,
             options: options

data/lib/openai/resources/conversations.rb

@@ -2,7 +2,9 @@
 
 module OpenAI
   module Resources
+    # Manage conversations and conversation items.
     class Conversations
+      # Manage conversations and conversation items.
       # @return [OpenAI::Resources::Conversations::Items]
       attr_reader :items
 
@@ -13,7 +15,7 @@ module OpenAI
       #
       # @overload create(items: nil, metadata: nil, request_options: {})
       #
-      # @param items [Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItemParam, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ShellCall, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::ItemReference>, nil] Initial items to include in the conversation context. You may add up to 20 items
+      # @param items [Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseInputItem::ToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItemParam, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItemParam, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ShellCall, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::ItemReference>, nil] Initial items to include in the conversation context. You may add up to 20 items
       #
       # @param metadata [Hash{Symbol=>String}, nil] Set of 16 key-value pairs that can be attached to an object. This can be
       #

data/lib/openai/resources/embeddings.rb

@@ -2,6 +2,8 @@
 
 module OpenAI
   module Resources
+    # Get a vector representation of a given input that can be easily consumed by
+    # machine learning models and algorithms.
     class Embeddings
       # Some parameter documentations has been truncated, see
       # {OpenAI::Models::EmbeddingCreateParams} for more details.