openai 0.92.0 → 0.94.0

data/sig/openai/models/chat/chat_completion_chunk.rbs

@@ -18,30 +18,136 @@ module OpenAI
         }
 
       class ChatCompletionChunk < OpenAI::Internal::Type::BaseModel
+        # A unique identifier for the chat completion. Each chunk has the same ID.
         attr_accessor id: String
 
+        # A list of chat completion choices. Can contain more than one elements if `n` is
+        # greater than 1. Can also be empty for the last chunk if you set
+        # `stream_options: {"include_usage": true}`.
         attr_accessor choices: ::Array[OpenAI::Chat::ChatCompletionChunk::Choice]
 
+        # The Unix timestamp (in seconds) of when the chat completion was created. Each
+        # chunk has the same timestamp.
         attr_accessor created: Integer
 
+        # The model to generate the completion.
         attr_accessor model: String
 
+        # The object type, which is always `chat.completion.chunk`.
         attr_accessor object: :"chat.completion.chunk"
 
+        # Moderation results for the request input and generated output. Present on the
+        # moderation chunk when moderated completions are requested.
         attr_accessor moderation: OpenAI::Chat::ChatCompletionChunk::Moderation?
 
+        # An obfuscation string added to normalize the size of streamed chunks as a
+        # mitigation to certain side-channel attacks. The field is included by default and
+        # omitted when `stream_options.include_obfuscation` is `false`.
         attr_reader obfuscation: String?
 
+        # An obfuscation string added to normalize the size of streamed chunks as a
+        # mitigation to certain side-channel attacks. The field is included by default and
+        # omitted when `stream_options.include_obfuscation` is `false`.
         def obfuscation=: (String) -> String
 
+        # 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](https://developers.openai.com/api/docs/guides/flex-processing)', then
+        #   the request will be processed with the Flex Processing service tier.
+        # - To opt-in to
+        #   [Fast mode](https://developers.openai.com/api/docs/guides/fast-mode) at the
+        #   request level, include the `service_tier=fast` or `service_tier=priority`
+        #   parameter for Responses or Chat Completions. The response will show
+        #   `service_tier=priority` regardless of if you specify `service_tier=fast` or
+        #   `priority` in your request.
+        # - 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.
         attr_accessor service_tier: OpenAI::Models::Chat::ChatCompletionChunk::service_tier?
 
+        # This fingerprint represents the backend configuration that the model runs with.
+        # Can be used in conjunction with the `seed` request parameter to understand when
+        # backend changes have been made that might impact determinism.
         attr_reader system_fingerprint: String?
 
+        # This fingerprint represents the backend configuration that the model runs with.
+        # Can be used in conjunction with the `seed` request parameter to understand when
+        # backend changes have been made that might impact determinism.
         def system_fingerprint=: (String) -> String
 
+        # An optional field that will only be present when you set
+        # `stream_options: {"include_usage": true}` in your request. When present, it
+        # contains a null value **except for the last chunk** which contains the token
+        # usage statistics for the entire request.
+        #
+        # **NOTE:** If the stream is interrupted or cancelled, you may not receive the
+        # final usage chunk which contains the total token usage for the request.
         attr_accessor usage: OpenAI::CompletionUsage?
 
+        # @param id
+        #   A unique identifier for the chat completion. Each chunk has the same ID.
+        # @param choices
+        #   A list of chat completion choices. Can contain more than one elements if `n` is
+        #   greater than 1. Can also be empty for the last chunk if you set
+        #   `stream_options: {"include_usage": true}`.
+        # @param created
+        #   The Unix timestamp (in seconds) of when the chat completion was created. Each
+        #   chunk has the same timestamp.
+        # @param model
+        #   The model to generate the completion.
+        # @param moderation
+        #   Moderation results for the request input and generated output. Present on the
+        #   moderation chunk when moderated completions are requested.
+        # @param obfuscation
+        #   An obfuscation string added to normalize the size of streamed chunks as a
+        #   mitigation to certain side-channel attacks. The field is included by default and
+        #   omitted when `stream_options.include_obfuscation` is `false`.
+        # @param service_tier
+        #   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](https://developers.openai.com/api/docs/guides/flex-processing)', then
+        #     the request will be processed with the Flex Processing service tier.
+        #   - To opt-in to
+        #     [Fast mode](https://developers.openai.com/api/docs/guides/fast-mode) at the
+        #     request level, include the `service_tier=fast` or `service_tier=priority`
+        #     parameter for Responses or Chat Completions. The response will show
+        #     `service_tier=priority` regardless of if you specify `service_tier=fast` or
+        #     `priority` in your request.
+        #   - 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.
+        # @param system_fingerprint
+        #   This fingerprint represents the backend configuration that the model runs with.
+        #   Can be used in conjunction with the `seed` request parameter to understand when
+        #   backend changes have been made that might impact determinism.
+        # @param usage
+        #   An optional field that will only be present when you set
+        #   `stream_options: {"include_usage": true}` in your request. When present, it
+        #   contains a null value **except for the last chunk** which contains the token
+        #   usage statistics for the entire request.
+        #
+        #   **NOTE:** If the stream is interrupted or cancelled, you may not receive the
+        #   final usage chunk which contains the total token usage for the request.
+        # @param object
+        #   The object type, which is always `chat.completion.chunk`.
         def initialize: (
           id: String,
           choices: ::Array[OpenAI::Chat::ChatCompletionChunk::Choice],
@@ -77,14 +183,36 @@ module OpenAI
           }
 
         class Choice < OpenAI::Internal::Type::BaseModel
+          # A chat completion delta generated by streamed model responses.
           attr_accessor delta: OpenAI::Chat::ChatCompletionChunk::Choice::Delta
 
+          # The reason the model stopped generating tokens. This will be `stop` if the model
+          # hit a natural stop point or a provided stop sequence, `length` if the maximum
+          # number of tokens specified in the request was reached, `content_filter` if
+          # content was omitted due to a flag from our content filters, `tool_calls` if the
+          # model called a tool, or `function_call` (deprecated) if the model called a
+          # function.
           attr_accessor finish_reason: OpenAI::Models::Chat::ChatCompletionChunk::Choice::finish_reason?
 
+          # The index of the choice in the list of choices.
           attr_accessor index: Integer
 
+          # Log probability information for the choice.
           attr_accessor logprobs: OpenAI::Chat::ChatCompletionChunk::Choice::Logprobs?
 
+          # @param delta
+          #   A chat completion delta generated by streamed model responses.
+          # @param finish_reason
+          #   The reason the model stopped generating tokens. This will be `stop` if the model
+          #   hit a natural stop point or a provided stop sequence, `length` if the maximum
+          #   number of tokens specified in the request was reached, `content_filter` if
+          #   content was omitted due to a flag from our content filters, `tool_calls` if the
+          #   model called a tool, or `function_call` (deprecated) if the model called a
+          #   function.
+          # @param index
+          #   The index of the choice in the list of choices.
+          # @param logprobs
+          #   Log probability information for the choice.
           def initialize: (
             delta: OpenAI::Chat::ChatCompletionChunk::Choice::Delta,
             finish_reason: OpenAI::Models::Chat::ChatCompletionChunk::Choice::finish_reason?,
@@ -109,18 +237,26 @@ module OpenAI
             }
 
           class Delta < OpenAI::Internal::Type::BaseModel
+            # The contents of the chunk message.
             attr_accessor content: String?
 
+            # Deprecated and replaced by `tool_calls`. The name and arguments of a function
+            # that should be called, as generated by the model.
             attr_reader function_call: OpenAI::Chat::ChatCompletionChunk::Choice::Delta::FunctionCall?
 
+            # Deprecated and replaced by `tool_calls`. The name and arguments of a function
+            # that should be called, as generated by the model.
             def function_call=: (
               OpenAI::Chat::ChatCompletionChunk::Choice::Delta::FunctionCall
             ) -> OpenAI::Chat::ChatCompletionChunk::Choice::Delta::FunctionCall
 
+            # The refusal message generated by the model.
             attr_accessor refusal: String?
 
+            # The role of the author of this message.
             attr_reader role: OpenAI::Models::Chat::ChatCompletionChunk::Choice::Delta::role?
 
+            # The role of the author of this message.
             def role=: (
               OpenAI::Models::Chat::ChatCompletionChunk::Choice::Delta::role
             ) -> OpenAI::Models::Chat::ChatCompletionChunk::Choice::Delta::role
@@ -131,6 +267,15 @@ module OpenAI
               ::Array[OpenAI::Chat::ChatCompletionChunk::Choice::Delta::ToolCall]
             ) -> ::Array[OpenAI::Chat::ChatCompletionChunk::Choice::Delta::ToolCall]
 
+            # @param content
+            #   The contents of the chunk message.
+            # @param function_call
+            #   Deprecated and replaced by `tool_calls`. The name and arguments of a function
+            #   that should be called, as generated by the model.
+            # @param refusal
+            #   The refusal message generated by the model.
+            # @param role
+            #   The role of the author of this message.
             def initialize: (
               ?content: String?,
               ?function_call: OpenAI::Chat::ChatCompletionChunk::Choice::Delta::FunctionCall,
@@ -150,14 +295,31 @@ module OpenAI
             type function_call = { ?arguments: String, ?name: String }
 
             class FunctionCall < OpenAI::Internal::Type::BaseModel
+              # The arguments to call the function with, as generated by the model in JSON
+              # format. Note that the model does not always generate valid JSON, and may
+              # hallucinate parameters not defined by your function schema. Validate the
+              # arguments in your code before calling your function.
               attr_reader arguments: String?
 
+              # The arguments to call the function with, as generated by the model in JSON
+              # format. Note that the model does not always generate valid JSON, and may
+              # hallucinate parameters not defined by your function schema. Validate the
+              # arguments in your code before calling your function.
               def arguments=: (String) -> String
 
+              # The name of the function to call.
               attr_reader name: String?
 
+              # The name of the function to call.
               def name=: (String) -> String
 
+              # @param arguments
+              #   The arguments to call the function with, as generated by the model in JSON
+              #   format. Note that the model does not always generate valid JSON, and may
+              #   hallucinate parameters not defined by your function schema. Validate the
+              #   arguments in your code before calling your function.
+              # @param name
+              #   The name of the function to call.
               def initialize: (?arguments: String, ?name: String) -> void
 
               def to_hash: -> { ?arguments: String, ?name: String }
@@ -188,8 +350,10 @@ module OpenAI
             class ToolCall < OpenAI::Internal::Type::BaseModel
               attr_accessor index: Integer
 
+              # The ID of the tool call.
               attr_reader id: String?
 
+              # The ID of the tool call.
               def id=: (String) -> String
 
               attr_reader function: OpenAI::Chat::ChatCompletionChunk::Choice::Delta::ToolCall::Function?
@@ -198,12 +362,18 @@ module OpenAI
                 OpenAI::Chat::ChatCompletionChunk::Choice::Delta::ToolCall::Function
               ) -> OpenAI::Chat::ChatCompletionChunk::Choice::Delta::ToolCall::Function
 
+              # The type of the tool. Currently, only `function` is supported.
               attr_reader type: OpenAI::Models::Chat::ChatCompletionChunk::Choice::Delta::ToolCall::type_?
 
+              # The type of the tool. Currently, only `function` is supported.
               def type=: (
                 OpenAI::Models::Chat::ChatCompletionChunk::Choice::Delta::ToolCall::type_
               ) -> OpenAI::Models::Chat::ChatCompletionChunk::Choice::Delta::ToolCall::type_
 
+              # @param id
+              #   The ID of the tool call.
+              # @param type
+              #   The type of the tool. Currently, only `function` is supported.
               def initialize: (
                 index: Integer,
                 ?id: String,
@@ -221,14 +391,31 @@ module OpenAI
               type function = { ?arguments: String, ?name: String }
 
               class Function < OpenAI::Internal::Type::BaseModel
+                # The arguments to call the function with, as generated by the model in JSON
+                # format. Note that the model does not always generate valid JSON, and may
+                # hallucinate parameters not defined by your function schema. Validate the
+                # arguments in your code before calling your function.
                 attr_reader arguments: String?
 
+                # The arguments to call the function with, as generated by the model in JSON
+                # format. Note that the model does not always generate valid JSON, and may
+                # hallucinate parameters not defined by your function schema. Validate the
+                # arguments in your code before calling your function.
                 def arguments=: (String) -> String
 
+                # The name of the function to call.
                 attr_reader name: String?
 
+                # The name of the function to call.
                 def name=: (String) -> String
 
+                # @param arguments
+                #   The arguments to call the function with, as generated by the model in JSON
+                #   format. Note that the model does not always generate valid JSON, and may
+                #   hallucinate parameters not defined by your function schema. Validate the
+                #   arguments in your code before calling your function.
+                # @param name
+                #   The name of the function to call.
                 def initialize: (?arguments: String, ?name: String) -> void
 
                 def to_hash: -> { ?arguments: String, ?name: String }
@@ -268,10 +455,16 @@ module OpenAI
             }
 
           class Logprobs < OpenAI::Internal::Type::BaseModel
+            # A list of message content tokens with log probability information.
             attr_accessor content: ::Array[OpenAI::Chat::ChatCompletionTokenLogprob]?
 
+            # A list of message refusal tokens with log probability information.
             attr_accessor refusal: ::Array[OpenAI::Chat::ChatCompletionTokenLogprob]?
 
+            # @param content
+            #   A list of message content tokens with log probability information.
+            # @param refusal
+            #   A list of message refusal tokens with log probability information.
             def initialize: (
               content: ::Array[OpenAI::Chat::ChatCompletionTokenLogprob]?,
               refusal: ::Array[OpenAI::Chat::ChatCompletionTokenLogprob]?
@@ -291,10 +484,16 @@ module OpenAI
           }
 
         class Moderation < OpenAI::Internal::Type::BaseModel
+          # Moderation for the request input.
           attr_accessor input: OpenAI::Models::Chat::ChatCompletionChunk::Moderation::input
 
+          # Moderation for the generated output.
           attr_accessor output: OpenAI::Models::Chat::ChatCompletionChunk::Moderation::output
 
+          # @param input
+          #   Moderation for the request input.
+          # @param output
+          #   Moderation for the generated output.
           def initialize: (
             input: OpenAI::Models::Chat::ChatCompletionChunk::Moderation::input,
             output: OpenAI::Models::Chat::ChatCompletionChunk::Moderation::output
@@ -320,12 +519,21 @@ module OpenAI
               }
 
             class ModerationResults < OpenAI::Internal::Type::BaseModel
+              # The moderation model used to generate the results.
               attr_accessor model: String
 
+              # A list of moderation results.
               attr_accessor results: ::Array[OpenAI::Chat::ChatCompletionChunk::Moderation::Input::ModerationResults::Result]
 
+              # The object type, which is always `moderation_results`.
               attr_accessor type: :moderation_results
 
+              # @param model
+              #   The moderation model used to generate the results.
+              # @param results
+              #   A list of moderation results.
+              # @param type
+              #   The object type, which is always `moderation_results`.
               def initialize: (
                 model: String,
                 results: ::Array[OpenAI::Chat::ChatCompletionChunk::Moderation::Input::ModerationResults::Result],
@@ -349,18 +557,40 @@ module OpenAI
                 }
 
               class Result < OpenAI::Internal::Type::BaseModel
+                # A dictionary of moderation categories to booleans, True if the input is flagged
+                # under this category.
                 attr_accessor categories: ::Hash[Symbol, bool]
 
+                # Which modalities of input are reflected by the score for each category.
                 attr_accessor category_applied_input_types: ::Hash[Symbol, ::Array[OpenAI::Models::Chat::ChatCompletionChunk::Moderation::Input::ModerationResults::Result::category_applied_input_type]]
 
+                # A dictionary of moderation categories to scores.
                 attr_accessor category_scores: ::Hash[Symbol, Float]
 
+                # A boolean indicating whether the content was flagged by any category.
                 attr_accessor flagged: bool
 
+                # The moderation model that produced this result.
                 attr_accessor model: String
 
+                # The object type, which was always `moderation_result` for successful moderation
+                # results.
                 attr_accessor type: :moderation_result
 
+                # @param categories
+                #   A dictionary of moderation categories to booleans, True if the input is flagged
+                #   under this category.
+                # @param category_applied_input_types
+                #   Which modalities of input are reflected by the score for each category.
+                # @param category_scores
+                #   A dictionary of moderation categories to scores.
+                # @param flagged
+                #   A boolean indicating whether the content was flagged by any category.
+                # @param model
+                #   The moderation model that produced this result.
+                # @param type
+                #   The object type, which was always `moderation_result` for successful moderation
+                #   results.
                 def initialize: (
                   categories: ::Hash[Symbol, bool],
                   category_applied_input_types: ::Hash[Symbol, ::Array[OpenAI::Models::Chat::ChatCompletionChunk::Moderation::Input::ModerationResults::Result::category_applied_input_type]],
@@ -395,12 +625,21 @@ module OpenAI
             type error = { code: String, message: String, ?type: :error }
 
             class Error < OpenAI::Internal::Type::BaseModel
+              # The error code.
               attr_accessor code: String
 
+              # The error message.
               attr_accessor message: String
 
+              # The object type, which is always `error`.
               attr_accessor type: :error
 
+              # @param code
+              #   The error code.
+              # @param message
+              #   The error message.
+              # @param type
+              #   The object type, which is always `error`.
               def initialize: (
                 code: String,
                 message: String,
@@ -428,12 +667,21 @@ module OpenAI
               }
 
             class ModerationResults < OpenAI::Internal::Type::BaseModel
+              # The moderation model used to generate the results.
               attr_accessor model: String
 
+              # A list of moderation results.
               attr_accessor results: ::Array[OpenAI::Chat::ChatCompletionChunk::Moderation::Output::ModerationResults::Result]
 
+              # The object type, which is always `moderation_results`.
               attr_accessor type: :moderation_results
 
+              # @param model
+              #   The moderation model used to generate the results.
+              # @param results
+              #   A list of moderation results.
+              # @param type
+              #   The object type, which is always `moderation_results`.
               def initialize: (
                 model: String,
                 results: ::Array[OpenAI::Chat::ChatCompletionChunk::Moderation::Output::ModerationResults::Result],
@@ -457,18 +705,40 @@ module OpenAI
                 }
 
               class Result < OpenAI::Internal::Type::BaseModel
+                # A dictionary of moderation categories to booleans, True if the input is flagged
+                # under this category.
                 attr_accessor categories: ::Hash[Symbol, bool]
 
+                # Which modalities of input are reflected by the score for each category.
                 attr_accessor category_applied_input_types: ::Hash[Symbol, ::Array[OpenAI::Models::Chat::ChatCompletionChunk::Moderation::Output::ModerationResults::Result::category_applied_input_type]]
 
+                # A dictionary of moderation categories to scores.
                 attr_accessor category_scores: ::Hash[Symbol, Float]
 
+                # A boolean indicating whether the content was flagged by any category.
                 attr_accessor flagged: bool
 
+                # The moderation model that produced this result.
                 attr_accessor model: String
 
+                # The object type, which was always `moderation_result` for successful moderation
+                # results.
                 attr_accessor type: :moderation_result
 
+                # @param categories
+                #   A dictionary of moderation categories to booleans, True if the input is flagged
+                #   under this category.
+                # @param category_applied_input_types
+                #   Which modalities of input are reflected by the score for each category.
+                # @param category_scores
+                #   A dictionary of moderation categories to scores.
+                # @param flagged
+                #   A boolean indicating whether the content was flagged by any category.
+                # @param model
+                #   The moderation model that produced this result.
+                # @param type
+                #   The object type, which was always `moderation_result` for successful moderation
+                #   results.
                 def initialize: (
                   categories: ::Hash[Symbol, bool],
                   category_applied_input_types: ::Hash[Symbol, ::Array[OpenAI::Models::Chat::ChatCompletionChunk::Moderation::Output::ModerationResults::Result::category_applied_input_type]],
@@ -503,12 +773,21 @@ module OpenAI
             type error = { code: String, message: String, ?type: :error }
 
             class Error < OpenAI::Internal::Type::BaseModel
+              # The error code.
               attr_accessor code: String
 
+              # The error message.
               attr_accessor message: String
 
+              # The object type, which is always `error`.
               attr_accessor type: :error
 
+              # @param code
+              #   The error code.
+              # @param message
+              #   The error message.
+              # @param type
+              #   The object type, which is always `error`.
               def initialize: (
                 code: String,
                 message: String,

data/sig/openai/models/chat/chat_completion_content_part.rbs

@@ -22,14 +22,27 @@ module OpenAI
         class File < OpenAI::Internal::Type::BaseModel
           attr_accessor file: OpenAI::Chat::ChatCompletionContentPart::File::File
 
+          # The type of the content part. Always `file`.
           attr_accessor type: :file
 
+          # Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
+          # from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
+          # token block.
           attr_reader prompt_cache_breakpoint: OpenAI::Chat::ChatCompletionContentPart::File::PromptCacheBreakpoint?
 
+          # Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
+          # from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
+          # token block.
           def prompt_cache_breakpoint=: (
             OpenAI::Chat::ChatCompletionContentPart::File::PromptCacheBreakpoint
           ) -> OpenAI::Chat::ChatCompletionContentPart::File::PromptCacheBreakpoint
 
+          # @param prompt_cache_breakpoint
+          #   Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
+          #   from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
+          #   token block.
+          # @param type
+          #   The type of the content part. Always `file`.
           def initialize: (
             file: OpenAI::Chat::ChatCompletionContentPart::File::File,
             ?prompt_cache_breakpoint: OpenAI::Chat::ChatCompletionContentPart::File::PromptCacheBreakpoint,
@@ -46,18 +59,33 @@ module OpenAI
             { ?file_data: String, ?file_id: String, ?filename: String }
 
           class File < OpenAI::Internal::Type::BaseModel
+            # The base64 encoded file data, used when passing the file to the model as a
+            # string.
             attr_reader file_data: String?
 
+            # The base64 encoded file data, used when passing the file to the model as a
+            # string.
             def file_data=: (String) -> String
 
+            # The ID of an uploaded file to use as input.
             attr_reader file_id: String?
 
+            # The ID of an uploaded file to use as input.
             def file_id=: (String) -> String
 
+            # The name of the file, used when passing the file to the model as a string.
             attr_reader filename: String?
 
+            # The name of the file, used when passing the file to the model as a string.
             def filename=: (String) -> String
 
+            # @param file_data
+            #   The base64 encoded file data, used when passing the file to the model as a
+            #   string.
+            # @param file_id
+            #   The ID of an uploaded file to use as input.
+            # @param filename
+            #   The name of the file, used when passing the file to the model as a string.
             def initialize: (
               ?file_data: String,
               ?file_id: String,
@@ -74,8 +102,11 @@ module OpenAI
           type prompt_cache_breakpoint = { ?mode: :explicit }
 
           class PromptCacheBreakpoint < OpenAI::Internal::Type::BaseModel
+            # The breakpoint mode. Always `explicit`.
             attr_accessor mode: :explicit
 
+            # @param mode
+            #   The breakpoint mode. Always `explicit`.
             def initialize: (?mode: :explicit) -> void
 
             def to_hash: -> { ?mode: :explicit }

data/sig/openai/models/chat/chat_completion_content_part_image.rbs

@@ -13,14 +13,27 @@ module OpenAI
       class ChatCompletionContentPartImage < OpenAI::Internal::Type::BaseModel
         attr_accessor image_url: OpenAI::Chat::ChatCompletionContentPartImage::ImageURL
 
+        # The type of the content part.
         attr_accessor type: :image_url
 
+        # Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
+        # from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
+        # token block.
         attr_reader prompt_cache_breakpoint: OpenAI::Chat::ChatCompletionContentPartImage::PromptCacheBreakpoint?
 
+        # Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
+        # from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
+        # token block.
         def prompt_cache_breakpoint=: (
           OpenAI::Chat::ChatCompletionContentPartImage::PromptCacheBreakpoint
         ) -> OpenAI::Chat::ChatCompletionContentPartImage::PromptCacheBreakpoint
 
+        # @param prompt_cache_breakpoint
+        #   Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
+        #   from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
+        #   token block.
+        # @param type
+        #   The type of the content part.
         def initialize: (
           image_url: OpenAI::Chat::ChatCompletionContentPartImage::ImageURL,
           ?prompt_cache_breakpoint: OpenAI::Chat::ChatCompletionContentPartImage::PromptCacheBreakpoint,
@@ -40,14 +53,24 @@ module OpenAI
           }
 
         class ImageURL < OpenAI::Internal::Type::BaseModel
+          # Either a URL of the image or the base64 encoded image data.
           attr_accessor url: String
 
+          # Specifies the detail level of the image. Learn more in the
+          # [Vision guide](https://developers.openai.com/api/docs/guides/images-vision#choose-an-image-detail-level).
           attr_reader detail: OpenAI::Models::Chat::ChatCompletionContentPartImage::ImageURL::detail?
 
+          # Specifies the detail level of the image. Learn more in the
+          # [Vision guide](https://developers.openai.com/api/docs/guides/images-vision#choose-an-image-detail-level).
           def detail=: (
             OpenAI::Models::Chat::ChatCompletionContentPartImage::ImageURL::detail
           ) -> OpenAI::Models::Chat::ChatCompletionContentPartImage::ImageURL::detail
 
+          # @param url
+          #   Either a URL of the image or the base64 encoded image data.
+          # @param detail
+          #   Specifies the detail level of the image. Learn more in the
+          #   [Vision guide](https://developers.openai.com/api/docs/guides/images-vision#choose-an-image-detail-level).
           def initialize: (
             url: String,
             ?detail: OpenAI::Models::Chat::ChatCompletionContentPartImage::ImageURL::detail
@@ -74,8 +97,11 @@ module OpenAI
         type prompt_cache_breakpoint = { ?mode: :explicit }
 
         class PromptCacheBreakpoint < OpenAI::Internal::Type::BaseModel
+          # The breakpoint mode. Always `explicit`.
           attr_accessor mode: :explicit
 
+          # @param mode
+          #   The breakpoint mode. Always `explicit`.
           def initialize: (?mode: :explicit) -> void
 
           def to_hash: -> { ?mode: :explicit }