openai 0.92.0 → 0.94.0

data/sig/openai/models/beta/threads/image_url.rbs

@@ -9,14 +9,26 @@ module OpenAI
           }
 
         class ImageURL < OpenAI::Internal::Type::BaseModel
+          # The external URL of the image, must be a supported image types: jpeg, jpg, png,
+          # gif, webp.
           attr_accessor url: String
 
+          # Specifies the detail level of the image. `low` uses fewer tokens, you can opt in
+          # to high resolution using `high`. Default value is `auto`
           attr_reader detail: OpenAI::Models::Beta::Threads::ImageURL::detail?
 
+          # Specifies the detail level of the image. `low` uses fewer tokens, you can opt in
+          # to high resolution using `high`. Default value is `auto`
           def detail=: (
             OpenAI::Models::Beta::Threads::ImageURL::detail
           ) -> OpenAI::Models::Beta::Threads::ImageURL::detail
 
+          # @param url
+          #   The external URL of the image, must be a supported image types: jpeg, jpg, png,
+          #   gif, webp.
+          # @param detail
+          #   Specifies the detail level of the image. `low` uses fewer tokens, you can opt in
+          #   to high resolution using `high`. Default value is `auto`
           def initialize: (
             url: String,
             ?detail: OpenAI::Models::Beta::Threads::ImageURL::detail

data/sig/openai/models/beta/threads/image_url_content_block.rbs

@@ -8,8 +8,11 @@ module OpenAI
         class ImageURLContentBlock < OpenAI::Internal::Type::BaseModel
           attr_accessor image_url: OpenAI::Beta::Threads::ImageURL
 
+          # The type of the content part.
           attr_accessor type: :image_url
 
+          # @param type
+          #   The type of the content part.
           def initialize: (
             image_url: OpenAI::Beta::Threads::ImageURL,
             ?type: :image_url

data/sig/openai/models/beta/threads/image_url_delta.rbs

@@ -9,16 +9,30 @@ module OpenAI
           }
 
         class ImageURLDelta < OpenAI::Internal::Type::BaseModel
+          # Specifies the detail level of the image. `low` uses fewer tokens, you can opt in
+          # to high resolution using `high`.
           attr_reader detail: OpenAI::Models::Beta::Threads::ImageURLDelta::detail?
 
+          # Specifies the detail level of the image. `low` uses fewer tokens, you can opt in
+          # to high resolution using `high`.
           def detail=: (
             OpenAI::Models::Beta::Threads::ImageURLDelta::detail
           ) -> OpenAI::Models::Beta::Threads::ImageURLDelta::detail
 
+          # The URL of the image, must be a supported image types: jpeg, jpg, png, gif,
+          # webp.
           attr_reader url: String?
 
+          # The URL of the image, must be a supported image types: jpeg, jpg, png, gif,
+          # webp.
           def url=: (String) -> String
 
+          # @param detail
+          #   Specifies the detail level of the image. `low` uses fewer tokens, you can opt in
+          #   to high resolution using `high`.
+          # @param url
+          #   The URL of the image, must be a supported image types: jpeg, jpg, png, gif,
+          #   webp.
           def initialize: (
             ?detail: OpenAI::Models::Beta::Threads::ImageURLDelta::detail,
             ?url: String

data/sig/openai/models/beta/threads/image_url_delta_block.rbs

@@ -10,8 +10,10 @@ module OpenAI
           }
 
         class ImageURLDeltaBlock < OpenAI::Internal::Type::BaseModel
+          # The index of the content part in the message.
           attr_accessor index: Integer
 
+          # Always `image_url`.
           attr_accessor type: :image_url
 
           attr_reader image_url: OpenAI::Beta::Threads::ImageURLDelta?
@@ -20,6 +22,10 @@ module OpenAI
             OpenAI::Beta::Threads::ImageURLDelta
           ) -> OpenAI::Beta::Threads::ImageURLDelta
 
+          # @param index
+          #   The index of the content part in the message.
+          # @param type
+          #   Always `image_url`.
           def initialize: (
             index: Integer,
             ?image_url: OpenAI::Beta::Threads::ImageURLDelta,

data/sig/openai/models/beta/threads/message.rbs

@@ -21,34 +21,98 @@ module OpenAI
           }
 
         class Message < OpenAI::Internal::Type::BaseModel
+          # The identifier, which can be referenced in API endpoints.
           attr_accessor id: String
 
+          # If applicable, the ID of the
+          # [assistant](https://developers.openai.com/api/docs/assistants/migration) that
+          # authored this message.
           attr_accessor assistant_id: String?
 
+          # A list of files attached to the message, and the tools they were added to.
           attr_accessor attachments: ::Array[OpenAI::Beta::Threads::Message::Attachment]?
 
+          # The Unix timestamp (in seconds) for when the message was completed.
           attr_accessor completed_at: Integer?
 
+          # The content of the message in array of text and/or images.
           attr_accessor content: ::Array[OpenAI::Models::Beta::Threads::message_content]
 
+          # The Unix timestamp (in seconds) for when the message was created.
           attr_accessor created_at: Integer
 
+          # The Unix timestamp (in seconds) for when the message was marked as incomplete.
           attr_accessor incomplete_at: Integer?
 
+          # On an incomplete message, details about why the message is incomplete.
           attr_accessor incomplete_details: OpenAI::Beta::Threads::Message::IncompleteDetails?
 
+          # Set of 16 key-value pairs that can be attached to an object. This can be useful
+          # for storing additional information about the object in a structured format, and
+          # querying for objects via API or the dashboard.
+          #
+          # Keys are strings with a maximum length of 64 characters. Values are strings with
+          # a maximum length of 512 characters.
           attr_accessor metadata: OpenAI::Models::metadata?
 
+          # The object type, which is always `thread.message`.
           attr_accessor object: :"thread.message"
 
+          # The entity that produced the message. One of `user` or `assistant`.
           attr_accessor role: OpenAI::Models::Beta::Threads::Message::role
 
+          # The ID of the [run](https://developers.openai.com/api/docs/assistants/migration)
+          # associated with the creation of this message. Value is `null` when messages are
+          # created manually using the create message or create thread endpoints.
           attr_accessor run_id: String?
 
+          # The status of the message, which can be either `in_progress`, `incomplete`, or
+          # `completed`.
           attr_accessor status: OpenAI::Models::Beta::Threads::Message::status
 
+          # The [thread](https://developers.openai.com/api/docs/assistants/migration) ID
+          # that this message belongs to.
           attr_accessor thread_id: String
 
+          # @param id
+          #   The identifier, which can be referenced in API endpoints.
+          # @param assistant_id
+          #   If applicable, the ID of the
+          #   [assistant](https://developers.openai.com/api/docs/assistants/migration) that
+          #   authored this message.
+          # @param attachments
+          #   A list of files attached to the message, and the tools they were added to.
+          # @param completed_at
+          #   The Unix timestamp (in seconds) for when the message was completed.
+          # @param content
+          #   The content of the message in array of text and/or images.
+          # @param created_at
+          #   The Unix timestamp (in seconds) for when the message was created.
+          # @param incomplete_at
+          #   The Unix timestamp (in seconds) for when the message was marked as incomplete.
+          # @param incomplete_details
+          #   On an incomplete message, details about why the message is incomplete.
+          # @param metadata
+          #   Set of 16 key-value pairs that can be attached to an object. This can be useful
+          #   for storing additional information about the object in a structured format, and
+          #   querying for objects via API or the dashboard.
+          #
+          #   Keys are strings with a maximum length of 64 characters. Values are strings with
+          #   a maximum length of 512 characters.
+          # @param role
+          #   The entity that produced the message. One of `user` or `assistant`.
+          # @param run_id
+          #   The ID of the [run](https://developers.openai.com/api/docs/assistants/migration)
+          #   associated with the creation of this message. Value is `null` when messages are
+          #   created manually using the create message or create thread endpoints.
+          # @param status
+          #   The status of the message, which can be either `in_progress`, `incomplete`, or
+          #   `completed`.
+          # @param thread_id
+          #   The [thread](https://developers.openai.com/api/docs/assistants/migration) ID
+          #   that this message belongs to.
+          # @param object
+          #   The object type, which is always `thread.message`.
           def initialize: (
             id: String,
             assistant_id: String?,
@@ -90,16 +154,24 @@ module OpenAI
             }
 
           class Attachment < OpenAI::Internal::Type::BaseModel
+            # The ID of the file to attach to the message.
             attr_reader file_id: String?
 
+            # The ID of the file to attach to the message.
             def file_id=: (String) -> String
 
+            # The tools to add this file to.
             attr_reader tools: ::Array[OpenAI::Models::Beta::Threads::Message::Attachment::tool]?
 
+            # The tools to add this file to.
             def tools=: (
               ::Array[OpenAI::Models::Beta::Threads::Message::Attachment::tool]
             ) -> ::Array[OpenAI::Models::Beta::Threads::Message::Attachment::tool]
 
+            # @param file_id
+            #   The ID of the file to attach to the message.
+            # @param tools
+            #   The tools to add this file to.
             def initialize: (
               ?file_id: String,
               ?tools: ::Array[OpenAI::Models::Beta::Threads::Message::Attachment::tool]
@@ -121,8 +193,11 @@ module OpenAI
                 { ?type: :file_search }
 
               class AssistantToolsFileSearchTypeOnly < OpenAI::Internal::Type::BaseModel
+                # The type of tool being defined: `file_search`
                 attr_accessor type: :file_search
 
+                # @param type
+                #   The type of tool being defined: `file_search`
                 def initialize: (?type: :file_search) -> void
 
                 def to_hash: -> { ?type: :file_search }
@@ -138,8 +213,11 @@ module OpenAI
             }
 
           class IncompleteDetails < OpenAI::Internal::Type::BaseModel
+            # The reason the message is incomplete.
             attr_accessor reason: OpenAI::Models::Beta::Threads::Message::IncompleteDetails::reason
 
+            # @param reason
+            #   The reason the message is incomplete.
             def initialize: (
               reason: OpenAI::Models::Beta::Threads::Message::IncompleteDetails::reason
             ) -> void

data/sig/openai/models/beta/threads/message_create_params.rbs

@@ -18,14 +18,46 @@ module OpenAI
 
           attr_accessor thread_id: String
 
+          # The text contents of the message.
           attr_accessor content: OpenAI::Models::Beta::Threads::MessageCreateParams::content
 
+          # The role of the entity that is creating the message. Allowed values include:
+          #
+          # - `user`: Indicates the message is sent by an actual user and should be used in
+          #   most cases to represent user-generated messages.
+          # - `assistant`: Indicates the message is generated by the assistant. Use this
+          #   value to insert messages from the assistant into the conversation.
           attr_accessor role: OpenAI::Models::Beta::Threads::MessageCreateParams::role
 
+          # A list of files attached to the message, and the tools they should be added to.
           attr_accessor attachments: ::Array[OpenAI::Beta::Threads::MessageCreateParams::Attachment]?
 
+          # Set of 16 key-value pairs that can be attached to an object. This can be useful
+          # for storing additional information about the object in a structured format, and
+          # querying for objects via API or the dashboard.
+          #
+          # Keys are strings with a maximum length of 64 characters. Values are strings with
+          # a maximum length of 512 characters.
           attr_accessor metadata: OpenAI::Models::metadata?
 
+          # @param content
+          #   The text contents of the message.
+          # @param role
+          #   The role of the entity that is creating the message. Allowed values include:
+          #
+          #   - `user`: Indicates the message is sent by an actual user and should be used in
+          #     most cases to represent user-generated messages.
+          #   - `assistant`: Indicates the message is generated by the assistant. Use this
+          #     value to insert messages from the assistant into the conversation.
+          # @param attachments
+          #   A list of files attached to the message, and the tools they should be added to.
+          # @param metadata
+          #   Set of 16 key-value pairs that can be attached to an object. This can be useful
+          #   for storing additional information about the object in a structured format, and
+          #   querying for objects via API or the dashboard.
+          #
+          #   Keys are strings with a maximum length of 64 characters. Values are strings with
+          #   a maximum length of 512 characters.
           def initialize: (
             thread_id: String,
             content: OpenAI::Models::Beta::Threads::MessageCreateParams::content,
@@ -74,16 +106,24 @@ module OpenAI
             }
 
           class Attachment < OpenAI::Internal::Type::BaseModel
+            # The ID of the file to attach to the message.
             attr_reader file_id: String?
 
+            # The ID of the file to attach to the message.
             def file_id=: (String) -> String
 
+            # The tools to add this file to.
             attr_reader tools: ::Array[OpenAI::Models::Beta::Threads::MessageCreateParams::Attachment::tool]?
 
+            # The tools to add this file to.
             def tools=: (
               ::Array[OpenAI::Models::Beta::Threads::MessageCreateParams::Attachment::tool]
             ) -> ::Array[OpenAI::Models::Beta::Threads::MessageCreateParams::Attachment::tool]
 
+            # @param file_id
+            #   The ID of the file to attach to the message.
+            # @param tools
+            #   The tools to add this file to.
             def initialize: (
               ?file_id: String,
               ?tools: ::Array[OpenAI::Models::Beta::Threads::MessageCreateParams::Attachment::tool]
@@ -104,8 +144,11 @@ module OpenAI
               type file_search = { ?type: :file_search }
 
               class FileSearch < OpenAI::Internal::Type::BaseModel
+                # The type of tool being defined: `file_search`
                 attr_accessor type: :file_search
 
+                # @param type
+                #   The type of tool being defined: `file_search`
                 def initialize: (?type: :file_search) -> void
 
                 def to_hash: -> { ?type: :file_search }

data/sig/openai/models/beta/threads/message_delta.rbs

@@ -9,18 +9,26 @@ module OpenAI
           }
 
         class MessageDelta < OpenAI::Internal::Type::BaseModel
+          # The content of the message in array of text and/or images.
           attr_reader content: ::Array[OpenAI::Models::Beta::Threads::message_content_delta]?
 
+          # The content of the message in array of text and/or images.
           def content=: (
             ::Array[OpenAI::Models::Beta::Threads::message_content_delta]
           ) -> ::Array[OpenAI::Models::Beta::Threads::message_content_delta]
 
+          # The entity that produced the message. One of `user` or `assistant`.
           attr_reader role: OpenAI::Models::Beta::Threads::MessageDelta::role?
 
+          # The entity that produced the message. One of `user` or `assistant`.
           def role=: (
             OpenAI::Models::Beta::Threads::MessageDelta::role
           ) -> OpenAI::Models::Beta::Threads::MessageDelta::role
 
+          # @param content
+          #   The content of the message in array of text and/or images.
+          # @param role
+          #   The entity that produced the message. One of `user` or `assistant`.
           def initialize: (
             ?content: ::Array[OpenAI::Models::Beta::Threads::message_content_delta],
             ?role: OpenAI::Models::Beta::Threads::MessageDelta::role

data/sig/openai/models/beta/threads/message_delta_event.rbs

@@ -10,12 +10,21 @@ module OpenAI
           }
 
         class MessageDeltaEvent < OpenAI::Internal::Type::BaseModel
+          # The identifier of the message, which can be referenced in API endpoints.
           attr_accessor id: String
 
+          # The delta containing the fields that have changed on the Message.
           attr_accessor delta: OpenAI::Beta::Threads::MessageDelta
 
+          # The object type, which is always `thread.message.delta`.
           attr_accessor object: :"thread.message.delta"
 
+          # @param id
+          #   The identifier of the message, which can be referenced in API endpoints.
+          # @param delta
+          #   The delta containing the fields that have changed on the Message.
+          # @param object
+          #   The object type, which is always `thread.message.delta`.
           def initialize: (
             id: String,
             delta: OpenAI::Beta::Threads::MessageDelta,

data/sig/openai/models/beta/threads/message_list_params.rbs

@@ -19,28 +19,72 @@ module OpenAI
 
           attr_accessor thread_id: String
 
+          # A cursor for use in pagination. `after` is an object ID that defines your place
+          # in the list. For instance, if you make a list request and receive 100 objects,
+          # ending with obj_foo, your subsequent call can include after=obj_foo in order to
+          # fetch the next page of the list.
           attr_reader after: String?
 
+          # A cursor for use in pagination. `after` is an object ID that defines your place
+          # in the list. For instance, if you make a list request and receive 100 objects,
+          # ending with obj_foo, your subsequent call can include after=obj_foo in order to
+          # fetch the next page of the list.
           def after=: (String) -> String
 
+          # A cursor for use in pagination. `before` is an object ID that defines your place
+          # in the list. For instance, if you make a list request and receive 100 objects,
+          # starting with obj_foo, your subsequent call can include before=obj_foo in order
+          # to fetch the previous page of the list.
           attr_reader before: String?
 
+          # A cursor for use in pagination. `before` is an object ID that defines your place
+          # in the list. For instance, if you make a list request and receive 100 objects,
+          # starting with obj_foo, your subsequent call can include before=obj_foo in order
+          # to fetch the previous page of the list.
           def before=: (String) -> String
 
+          # A limit on the number of objects to be returned. Limit can range between 1 and
+          # 100, and the default is 20.
           attr_reader limit: Integer?
 
+          # A limit on the number of objects to be returned. Limit can range between 1 and
+          # 100, and the default is 20.
           def limit=: (Integer) -> Integer
 
+          # Sort order by the `created_at` timestamp of the objects. `asc` for ascending
+          # order and `desc` for descending order.
           attr_reader order: OpenAI::Models::Beta::Threads::MessageListParams::order?
 
+          # Sort order by the `created_at` timestamp of the objects. `asc` for ascending
+          # order and `desc` for descending order.
           def order=: (
             OpenAI::Models::Beta::Threads::MessageListParams::order
           ) -> OpenAI::Models::Beta::Threads::MessageListParams::order
 
+          # Filter messages by the run ID that generated them.
           attr_reader run_id: String?
 
+          # Filter messages by the run ID that generated them.
           def run_id=: (String) -> String
 
+          # @param after
+          #   A cursor for use in pagination. `after` is an object ID that defines your place
+          #   in the list. For instance, if you make a list request and receive 100 objects,
+          #   ending with obj_foo, your subsequent call can include after=obj_foo in order to
+          #   fetch the next page of the list.
+          # @param before
+          #   A cursor for use in pagination. `before` is an object ID that defines your place
+          #   in the list. For instance, if you make a list request and receive 100 objects,
+          #   starting with obj_foo, your subsequent call can include before=obj_foo in order
+          #   to fetch the previous page of the list.
+          # @param limit
+          #   A limit on the number of objects to be returned. Limit can range between 1 and
+          #   100, and the default is 20.
+          # @param order
+          #   Sort order by the `created_at` timestamp of the objects. `asc` for ascending
+          #   order and `desc` for descending order.
+          # @param run_id
+          #   Filter messages by the run ID that generated them.
           def initialize: (
             thread_id: String,
             ?after: String,

data/sig/openai/models/beta/threads/message_update_params.rbs

@@ -18,8 +18,21 @@ module OpenAI
 
           attr_accessor message_id: String
 
+          # Set of 16 key-value pairs that can be attached to an object. This can be useful
+          # for storing additional information about the object in a structured format, and
+          # querying for objects via API or the dashboard.
+          #
+          # Keys are strings with a maximum length of 64 characters. Values are strings with
+          # a maximum length of 512 characters.
           attr_accessor metadata: OpenAI::Models::metadata?
 
+          # @param metadata
+          #   Set of 16 key-value pairs that can be attached to an object. This can be useful
+          #   for storing additional information about the object in a structured format, and
+          #   querying for objects via API or the dashboard.
+          #
+          #   Keys are strings with a maximum length of 64 characters. Values are strings with
+          #   a maximum length of 512 characters.
           def initialize: (
             thread_id: String,
             message_id: String,

data/sig/openai/models/beta/threads/refusal_content_block.rbs

@@ -7,8 +7,11 @@ module OpenAI
         class RefusalContentBlock < OpenAI::Internal::Type::BaseModel
           attr_accessor refusal: String
 
+          # Always `refusal`.
           attr_accessor type: :refusal
 
+          # @param type
+          #   Always `refusal`.
           def initialize: (refusal: String, ?type: :refusal) -> void
 
           def to_hash: -> { refusal: String, ?type: :refusal }

data/sig/openai/models/beta/threads/refusal_delta_block.rbs

@@ -6,14 +6,20 @@ module OpenAI
           { index: Integer, ?type: :refusal, ?refusal: String }
 
         class RefusalDeltaBlock < OpenAI::Internal::Type::BaseModel
+          # The index of the refusal part in the message.
           attr_accessor index: Integer
 
+          # Always `refusal`.
           attr_accessor type: :refusal
 
           attr_reader refusal: String?
 
           def refusal=: (String) -> String
 
+          # @param index
+          #   The index of the refusal part in the message.
+          # @param type
+          #   Always `refusal`.
           def initialize: (
             index: Integer,
             ?refusal: String,

data/sig/openai/models/beta/threads/required_action_function_tool_call.rbs

@@ -10,12 +10,29 @@ module OpenAI
           }
 
         class RequiredActionFunctionToolCall < OpenAI::Internal::Type::BaseModel
+          # The ID of the tool call. This ID must be referenced when you submit the tool
+          # outputs in using the
+          # [Submit tool outputs to run](https://developers.openai.com/api/docs/assistants/migration)
+          # endpoint.
           attr_accessor id: String
 
+          # The function definition.
           attr_accessor function: OpenAI::Beta::Threads::RequiredActionFunctionToolCall::Function
 
+          # The type of tool call the output is required for. For now, this is always
+          # `function`.
           attr_accessor type: :function
 
+          # @param id
+          #   The ID of the tool call. This ID must be referenced when you submit the tool
+          #   outputs in using the
+          #   [Submit tool outputs to run](https://developers.openai.com/api/docs/assistants/migration)
+          #   endpoint.
+          # @param function
+          #   The function definition.
+          # @param type
+          #   The type of tool call the output is required for. For now, this is always
+          #   `function`.
           def initialize: (
             id: String,
             function: OpenAI::Beta::Threads::RequiredActionFunctionToolCall::Function,
@@ -31,10 +48,16 @@ module OpenAI
           type function = { arguments: String, name: String }
 
           class Function < OpenAI::Internal::Type::BaseModel
+            # The arguments that the model expects you to pass to the function.
             attr_accessor arguments: String
 
+            # The name of the function.
             attr_accessor name: String
 
+            # @param arguments
+            #   The arguments that the model expects you to pass to the function.
+            # @param name
+            #   The name of the function.
             def initialize: (arguments: String, name: String) -> void
 
             def to_hash: -> { arguments: String, name: String }