RubyGems - openai - Versions diffs - 0.92.0 → 0.94.0 - Mend

openai 0.92.0 → 0.94.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (1311) hide show

data/sig/openai/models/beta/chatkit/session_create_params.rbs CHANGED Viewed

@@ -16,28 +16,51 @@ module OpenAI
           extend OpenAI::Internal::Type::RequestParameters::Converter
           include OpenAI::Internal::Type::RequestParameters
+          # A free-form string that identifies your end user; ensures this Session can
+          # access other objects that have the same `user` scope.
           attr_accessor user: String
+          # Workflow that powers the session.
           attr_accessor workflow: OpenAI::Beta::ChatKit::ChatSessionWorkflowParam
+          # Optional overrides for ChatKit runtime configuration features
           attr_reader chatkit_configuration: OpenAI::Beta::ChatKit::ChatSessionChatKitConfigurationParam?
+          # Optional overrides for ChatKit runtime configuration features
           def chatkit_configuration=: (
             OpenAI::Beta::ChatKit::ChatSessionChatKitConfigurationParam
           ) -> OpenAI::Beta::ChatKit::ChatSessionChatKitConfigurationParam
+          # Optional override for session expiration timing in seconds from creation.
+          # Defaults to 10 minutes.
           attr_reader expires_after: OpenAI::Beta::ChatKit::ChatSessionExpiresAfterParam?
+          # Optional override for session expiration timing in seconds from creation.
+          # Defaults to 10 minutes.
           def expires_after=: (
             OpenAI::Beta::ChatKit::ChatSessionExpiresAfterParam
           ) -> OpenAI::Beta::ChatKit::ChatSessionExpiresAfterParam
+          # Optional override for per-minute request limits. When omitted, defaults to 10.
           attr_reader rate_limits: OpenAI::Beta::ChatKit::ChatSessionRateLimitsParam?
+          # Optional override for per-minute request limits. When omitted, defaults to 10.
           def rate_limits=: (
             OpenAI::Beta::ChatKit::ChatSessionRateLimitsParam
           ) -> OpenAI::Beta::ChatKit::ChatSessionRateLimitsParam
+          # @param user
+          #   A free-form string that identifies your end user; ensures this Session can
+          #   access other objects that have the same `user` scope.
+          # @param workflow
+          #   Workflow that powers the session.
+          # @param chatkit_configuration
+          #   Optional overrides for ChatKit runtime configuration features
+          # @param expires_after
+          #   Optional override for session expiration timing in seconds from creation.
+          #   Defaults to 10 minutes.
+          # @param rate_limits
+          #   Optional override for per-minute request limits. When omitted, defaults to 10.
           def initialize: (
             user: String,
             workflow: OpenAI::Beta::ChatKit::ChatSessionWorkflowParam,

data/sig/openai/models/beta/chatkit/thread_delete_response.rbs CHANGED Viewed

@@ -6,12 +6,21 @@ module OpenAI
           { id: String, deleted: bool, ?object: :"chatkit.thread.deleted" }
         class ThreadDeleteResponse < OpenAI::Internal::Type::BaseModel
+          # Identifier of the deleted thread.
           attr_accessor id: String
+          # Indicates that the thread has been deleted.
           attr_accessor deleted: bool
+          # Type discriminator that is always `chatkit.thread.deleted`.
           attr_accessor object: :"chatkit.thread.deleted"
+          # @param id
+          #   Identifier of the deleted thread.
+          # @param deleted
+          #   Indicates that the thread has been deleted.
+          # @param object
+          #   Type discriminator that is always `chatkit.thread.deleted`.
           def initialize: (
             id: String,
             deleted: bool,

data/sig/openai/models/beta/chatkit/thread_list_items_params.rbs CHANGED Viewed

@@ -18,24 +18,46 @@ module OpenAI
           attr_accessor thread_id: String
+          # List items created after this thread item ID. Defaults to null for the first
+          # page.
           attr_reader after: String?
+          # List items created after this thread item ID. Defaults to null for the first
+          # page.
           def after=: (String) -> String
+          # List items created before this thread item ID. Defaults to null for the newest
+          # results.
           attr_reader before: String?
+          # List items created before this thread item ID. Defaults to null for the newest
+          # results.
           def before=: (String) -> String
+          # Maximum number of thread items to return. Defaults to 20.
           attr_reader limit: Integer?
+          # Maximum number of thread items to return. Defaults to 20.
           def limit=: (Integer) -> Integer
+          # Sort order for results by creation time. Defaults to `desc`.
           attr_reader order: OpenAI::Models::Beta::ChatKit::ThreadListItemsParams::order?
+          # Sort order for results by creation time. Defaults to `desc`.
           def order=: (
             OpenAI::Models::Beta::ChatKit::ThreadListItemsParams::order
           ) -> OpenAI::Models::Beta::ChatKit::ThreadListItemsParams::order
+          # @param after
+          #   List items created after this thread item ID. Defaults to null for the first
+          #   page.
+          # @param before
+          #   List items created before this thread item ID. Defaults to null for the newest
+          #   results.
+          # @param limit
+          #   Maximum number of thread items to return. Defaults to 20.
+          # @param order
+          #   Sort order for results by creation time. Defaults to `desc`.
           def initialize: (
             thread_id: String,
             ?after: String,

data/sig/openai/models/beta/chatkit/thread_list_params.rbs CHANGED Viewed

@@ -16,28 +16,57 @@ module OpenAI
           extend OpenAI::Internal::Type::RequestParameters::Converter
           include OpenAI::Internal::Type::RequestParameters
+          # List items created after this thread item ID. Defaults to null for the first
+          # page.
           attr_reader after: String?
+          # List items created after this thread item ID. Defaults to null for the first
+          # page.
           def after=: (String) -> String
+          # List items created before this thread item ID. Defaults to null for the newest
+          # results.
           attr_reader before: String?
+          # List items created before this thread item ID. Defaults to null for the newest
+          # results.
           def before=: (String) -> String
+          # Maximum number of thread items to return. Defaults to 20.
           attr_reader limit: Integer?
+          # Maximum number of thread items to return. Defaults to 20.
           def limit=: (Integer) -> Integer
+          # Sort order for results by creation time. Defaults to `desc`.
           attr_reader order: OpenAI::Models::Beta::ChatKit::ThreadListParams::order?
+          # Sort order for results by creation time. Defaults to `desc`.
           def order=: (
             OpenAI::Models::Beta::ChatKit::ThreadListParams::order
           ) -> OpenAI::Models::Beta::ChatKit::ThreadListParams::order
+          # Filter threads that belong to this user identifier. Defaults to null to return
+          # all users.
           attr_reader user: String?
+          # Filter threads that belong to this user identifier. Defaults to null to return
+          # all users.
           def user=: (String) -> String
+          # @param after
+          #   List items created after this thread item ID. Defaults to null for the first
+          #   page.
+          # @param before
+          #   List items created before this thread item ID. Defaults to null for the newest
+          #   results.
+          # @param limit
+          #   Maximum number of thread items to return. Defaults to 20.
+          # @param order
+          #   Sort order for results by creation time. Defaults to `desc`.
+          # @param user
+          #   Filter threads that belong to this user identifier. Defaults to null to return
+          #   all users.
           def initialize: (
             ?after: String,
             ?before: String,

data/sig/openai/models/beta/chatkit_workflow.rbs CHANGED Viewed

@@ -10,14 +10,30 @@ module OpenAI
         }
       class ChatKitWorkflow < OpenAI::Internal::Type::BaseModel
+        # Identifier of the workflow backing the session.
         attr_accessor id: String
+        # State variable key-value pairs applied when invoking the workflow. Defaults to
+        # null when no overrides were provided.
         attr_accessor state_variables: ::Hash[Symbol, OpenAI::Models::Beta::ChatKitWorkflow::state_variable]?
+        # Tracing settings applied to the workflow.
         attr_accessor tracing: OpenAI::Beta::ChatKitWorkflow::Tracing
+        # Specific workflow version used for the session. Defaults to null when using the
+        # latest deployment.
         attr_accessor version: String?
+        # @param id
+        #   Identifier of the workflow backing the session.
+        # @param state_variables
+        #   State variable key-value pairs applied when invoking the workflow. Defaults to
+        #   null when no overrides were provided.
+        # @param tracing
+        #   Tracing settings applied to the workflow.
+        # @param version
+        #   Specific workflow version used for the session. Defaults to null when using the
+        #   latest deployment.
         def initialize: (
           id: String,
           state_variables: ::Hash[Symbol, OpenAI::Models::Beta::ChatKitWorkflow::state_variable]?,
@@ -43,8 +59,11 @@ module OpenAI
         type tracing = { enabled: bool }
         class Tracing < OpenAI::Internal::Type::BaseModel
+          # Indicates whether tracing is enabled.
           attr_accessor enabled: bool
+          # @param enabled
+          #   Indicates whether tracing is enabled.
           def initialize: (enabled: bool) -> void
           def to_hash: -> { enabled: bool }

data/sig/openai/models/beta/code_interpreter_tool.rbs CHANGED Viewed

@@ -4,8 +4,11 @@ module OpenAI
       type code_interpreter_tool = { ?type: :code_interpreter }
       class CodeInterpreterTool < OpenAI::Internal::Type::BaseModel
+        # The type of tool being defined: `code_interpreter`
         attr_accessor type: :code_interpreter
+        # @param type
+        #   The type of tool being defined: `code_interpreter`
         def initialize: (?type: :code_interpreter) -> void
         def to_hash: -> { ?type: :code_interpreter }

data/sig/openai/models/beta/environment.rbs CHANGED Viewed

@@ -12,8 +12,11 @@ module OpenAI
         type none = { ?type: :none }
         class None < OpenAI::Internal::Type::BaseModel
+          # The type of the object. Always `none`.
           attr_accessor type: :none
+          # @param type
+          #   The type of the object. Always `none`.
           def initialize: (?type: :none) -> void
           def to_hash: -> { ?type: :none }
@@ -32,22 +35,46 @@ module OpenAI
           }
         class OpenAIHosted < OpenAI::Internal::Type::BaseModel
+          # The public ID of the environment.
           attr_accessor id: String
+          # Directories that contain capabilities exposed to the agent.
           attr_accessor capability_directories: ::Array[String]
+          # Files available in the environment, excluding their contents.
           attr_accessor files: ::Array[OpenAI::Models::Beta::hosted_environment_file]
+          # The effective network access policy for the environment.
           attr_accessor network: OpenAI::Beta::Environment::OpenAIHosted::Network
+          # Packages installed in the environment.
           attr_accessor packages: OpenAI::Beta::Environment::OpenAIHosted::Packages
+          # Plugins installed in the environment, excluding their archive contents.
           attr_accessor plugins: ::Array[OpenAI::Beta::HostedPlugin]
+          # Skills installed in the environment, excluding their archive contents.
           attr_accessor skills: ::Array[OpenAI::Models::Beta::hosted_skill]
+          # The type of the object. Always `openai_hosted`.
           attr_accessor type: :openai_hosted
+          # @param id
+          #   The public ID of the environment.
+          # @param capability_directories
+          #   Directories that contain capabilities exposed to the agent.
+          # @param files
+          #   Files available in the environment, excluding their contents.
+          # @param network
+          #   The effective network access policy for the environment.
+          # @param packages
+          #   Packages installed in the environment.
+          # @param plugins
+          #   Plugins installed in the environment, excluding their archive contents.
+          # @param skills
+          #   Skills installed in the environment, excluding their archive contents.
+          # @param type
+          #   The type of the object. Always `openai_hosted`.
           def initialize: (
             id: String,
             capability_directories: ::Array[String],
@@ -77,10 +104,16 @@ module OpenAI
             }
           class Network < OpenAI::Internal::Type::BaseModel
+            # The environment's network access mode.
             attr_accessor access: OpenAI::Models::Beta::Environment::OpenAIHosted::Network::access
+            # Domains the environment may access when network access is restricted.
             attr_accessor allowed_domains: ::Array[String]
+            # @param access
+            #   The environment's network access mode.
+            # @param allowed_domains
+            #   Domains the environment may access when network access is restricted.
             def initialize: (
               access: OpenAI::Models::Beta::Environment::OpenAIHosted::Network::access,
               allowed_domains: ::Array[String]
@@ -117,12 +150,21 @@ module OpenAI
             }
           class Packages < OpenAI::Internal::Type::BaseModel
+            # npm packages installed globally in the environment.
             attr_accessor npm: ::Array[String]
+            # Python packages installed in the environment.
             attr_accessor python: ::Array[String]
+            # System packages installed in the environment.
             attr_accessor system_: ::Array[String]
+            # @param npm
+            #   npm packages installed globally in the environment.
+            # @param python
+            #   Python packages installed in the environment.
+            # @param system_
+            #   System packages installed in the environment.
             def initialize: (
               npm: ::Array[String],
               python: ::Array[String],
@@ -147,16 +189,33 @@ module OpenAI
           }
         class SelfHosted < OpenAI::Internal::Type::BaseModel
+          # The public ID of the environment.
           attr_accessor id: String
+          # Directories that contain capabilities exposed to the agent.
           attr_accessor capability_directories: ::Array[String]
+          # Pass this URL unchanged to `codex exec-server --remote` when connecting this
+          # environment.
           attr_accessor remote_url: String
+          # The type of the object. Always `self_hosted`.
           attr_accessor type: :self_hosted
+          # The absolute project directory inside the environment. Defaults to `/workspace`.
           attr_accessor workspace_directory: String
+          # @param id
+          #   The public ID of the environment.
+          # @param capability_directories
+          #   Directories that contain capabilities exposed to the agent.
+          # @param remote_url
+          #   Pass this URL unchanged to `codex exec-server --remote` when connecting this
+          #   environment.
+          # @param workspace_directory
+          #   The absolute project directory inside the environment. Defaults to `/workspace`.
+          # @param type
+          #   The type of the object. Always `self_hosted`.
           def initialize: (
             id: String,
             capability_directories: ::Array[String],

data/sig/openai/models/beta/environment_param.rbs CHANGED Viewed

@@ -12,8 +12,11 @@ module OpenAI
         type none = { ?type: :none }
         class None < OpenAI::Internal::Type::BaseModel
+          # The type of the object. Always `none`.
           attr_accessor type: :none
+          # @param type
+          #   The type of the object. Always `none`.
           def initialize: (?type: :none) -> void
           def to_hash: -> { ?type: :none }
@@ -34,28 +37,68 @@ module OpenAI
           }
         class OpenAIHosted < OpenAI::Internal::Type::BaseModel
+          # The type of the object. Always `openai_hosted`.
           attr_accessor type: :openai_hosted
+          # Directories that contain capabilities exposed to the agent. Defaults to an empty
+          # list.
           attr_accessor capability_directories: ::Array[String]?
+          # Environment variables made available to the agent.
           attr_accessor env: ::Hash[Symbol, String]?
+          # A reusable hosted template applied before inline session configuration. Omitted
+          # fields inherit the template; network overrides cannot broaden its policy.
           attr_reader environment_template_id: String?
+          # A reusable hosted template applied before inline session configuration. Omitted
+          # fields inherit the template; network overrides cannot broaden its policy.
           def environment_template_id=: (String) -> String
+          # Files available before the agent starts. Defaults to an empty list.
           attr_accessor files: ::Array[OpenAI::Models::Beta::hosted_environment_file_param]?
+          # Network access policy for the environment. Defaults to disabled for GA requests
+          # and enabled for alpha/beta requests.
           attr_accessor network: OpenAI::Beta::EnvironmentParam::OpenAIHosted::Network?
+          # Packages to install in the environment. Defaults to empty package lists.
           attr_accessor packages: OpenAI::Beta::EnvironmentParam::OpenAIHosted::Packages?
+          # Plugins provided as inline ZIP archives. Defaults to an empty list.
           attr_accessor plugins: ::Array[OpenAI::Beta::HostedPluginParam]?
+          # Ordered, confidential setup commands. Command bodies are never returned.
           attr_accessor setup_commands: ::Array[OpenAI::Beta::SetupCommandParam]?
+          # Skills referenced by ID or provided as inline ZIP archives. Defaults to an empty
+          # list.
           attr_accessor skills: ::Array[OpenAI::Models::Beta::hosted_skill_param]?
+          # @param capability_directories
+          #   Directories that contain capabilities exposed to the agent. Defaults to an empty
+          #   list.
+          # @param env
+          #   Environment variables made available to the agent.
+          # @param environment_template_id
+          #   A reusable hosted template applied before inline session configuration. Omitted
+          #   fields inherit the template; network overrides cannot broaden its policy.
+          # @param files
+          #   Files available before the agent starts. Defaults to an empty list.
+          # @param network
+          #   Network access policy for the environment. Defaults to disabled for GA requests
+          #   and enabled for alpha/beta requests.
+          # @param packages
+          #   Packages to install in the environment. Defaults to empty package lists.
+          # @param plugins
+          #   Plugins provided as inline ZIP archives. Defaults to an empty list.
+          # @param setup_commands
+          #   Ordered, confidential setup commands. Command bodies are never returned.
+          # @param skills
+          #   Skills referenced by ID or provided as inline ZIP archives. Defaults to an empty
+          #   list.
+          # @param type
+          #   The type of the object. Always `openai_hosted`.
           def initialize: (
             ?capability_directories: ::Array[String]?,
             ?env: ::Hash[Symbol, String]?,
@@ -89,10 +132,16 @@ module OpenAI
             }
           class Network < OpenAI::Internal::Type::BaseModel
+            # The environment's network access mode.
             attr_accessor access: OpenAI::Models::Beta::EnvironmentParam::OpenAIHosted::Network::access
+            # Domains the environment may access when network access is restricted.
             attr_accessor allowed_domains: ::Array[String]?
+            # @param access
+            #   The environment's network access mode.
+            # @param allowed_domains
+            #   Domains the environment may access when network access is restricted.
             def initialize: (
               access: OpenAI::Models::Beta::EnvironmentParam::OpenAIHosted::Network::access,
               ?allowed_domains: ::Array[String]?
@@ -108,7 +157,7 @@ module OpenAI
             module Access
               extend OpenAI::Internal::Type::Enum
-              # Allows unrestricted network access, matching an omitted network policy.
+              # Allows unrestricted network access.
               ENABLED: :enabled
               # Disables network access.
@@ -129,12 +178,21 @@ module OpenAI
             }
           class Packages < OpenAI::Internal::Type::BaseModel
+            # npm packages to install globally. Defaults to an empty list.
             attr_accessor npm: ::Array[String]?
+            # Python packages to install. Defaults to an empty list.
             attr_accessor python: ::Array[String]?
+            # System packages to install. Defaults to an empty list.
             attr_accessor system_: ::Array[String]?
+            # @param npm
+            #   npm packages to install globally. Defaults to an empty list.
+            # @param python
+            #   Python packages to install. Defaults to an empty list.
+            # @param system_
+            #   System packages to install. Defaults to an empty list.
             def initialize: (
               ?npm: ::Array[String]?,
               ?python: ::Array[String]?,
@@ -157,12 +215,23 @@ module OpenAI
           }
         class SelfHosted < OpenAI::Internal::Type::BaseModel
+          # The type of the object. Always `self_hosted`.
           attr_accessor type: :self_hosted
+          # Absolute project directory inside the self-hosted environment.
           attr_accessor workspace_directory: String
+          # Directories that contain capabilities exposed to the agent. Defaults to an empty
+          # list.
           attr_accessor capability_directories: ::Array[String]?
+          # @param workspace_directory
+          #   Absolute project directory inside the self-hosted environment.
+          # @param capability_directories
+          #   Directories that contain capabilities exposed to the agent. Defaults to an empty
+          #   list.
+          # @param type
+          #   The type of the object. Always `self_hosted`.
           def initialize: (
             workspace_directory: String,
             ?capability_directories: ::Array[String]?,

data/sig/openai/models/beta/file_search_tool.rbs CHANGED Viewed

@@ -8,14 +8,21 @@ module OpenAI
         }
       class FileSearchTool < OpenAI::Internal::Type::BaseModel
+        # The type of tool being defined: `file_search`
         attr_accessor type: :file_search
+        # Overrides for the file search tool.
         attr_reader file_search: OpenAI::Beta::FileSearchTool::FileSearch?
+        # Overrides for the file search tool.
         def file_search=: (
           OpenAI::Beta::FileSearchTool::FileSearch
         ) -> OpenAI::Beta::FileSearchTool::FileSearch
+        # @param file_search
+        #   Overrides for the file search tool.
+        # @param type
+        #   The type of tool being defined: `file_search`
         def initialize: (
           ?file_search: OpenAI::Beta::FileSearchTool::FileSearch,
           ?type: :file_search
@@ -33,16 +40,60 @@ module OpenAI
           }
         class FileSearch < OpenAI::Internal::Type::BaseModel
+          # The maximum number of results the file search tool should output. The default is
+          # 20 for `gpt-4*` models and 5 for `gpt-3.5-turbo`. This number should be between
+          # 1 and 50 inclusive.
+          #
+          # Note that the file search tool may output fewer than `max_num_results` results.
+          # See the
+          # [file search tool documentation](https://developers.openai.com/api/docs/guides/tools-file-search#retrieval-customization)
+          # for more information.
           attr_reader max_num_results: Integer?
+          # The maximum number of results the file search tool should output. The default is
+          # 20 for `gpt-4*` models and 5 for `gpt-3.5-turbo`. This number should be between
+          # 1 and 50 inclusive.
+          #
+          # Note that the file search tool may output fewer than `max_num_results` results.
+          # See the
+          # [file search tool documentation](https://developers.openai.com/api/docs/guides/tools-file-search#retrieval-customization)
+          # for more information.
           def max_num_results=: (Integer) -> Integer
+          # The ranking options for the file search. If not specified, the file search tool
+          # will use the `auto` ranker and a score_threshold of 0.
+          #
+          # See the
+          # [file search tool documentation](https://developers.openai.com/api/docs/guides/tools-file-search#retrieval-customization)
+          # for more information.
           attr_reader ranking_options: OpenAI::Beta::FileSearchTool::FileSearch::RankingOptions?
+          # The ranking options for the file search. If not specified, the file search tool
+          # will use the `auto` ranker and a score_threshold of 0.
+          #
+          # See the
+          # [file search tool documentation](https://developers.openai.com/api/docs/guides/tools-file-search#retrieval-customization)
+          # for more information.
           def ranking_options=: (
             OpenAI::Beta::FileSearchTool::FileSearch::RankingOptions
           ) -> OpenAI::Beta::FileSearchTool::FileSearch::RankingOptions
+          # @param max_num_results
+          #   The maximum number of results the file search tool should output. The default is
+          #   20 for `gpt-4*` models and 5 for `gpt-3.5-turbo`. This number should be between
+          #   1 and 50 inclusive.
+          #
+          #   Note that the file search tool may output fewer than `max_num_results` results.
+          #   See the
+          #   [file search tool documentation](https://developers.openai.com/api/docs/guides/tools-file-search#retrieval-customization)
+          #   for more information.
+          # @param ranking_options
+          #   The ranking options for the file search. If not specified, the file search tool
+          #   will use the `auto` ranker and a score_threshold of 0.
+          #
+          #   See the
+          #   [file search tool documentation](https://developers.openai.com/api/docs/guides/tools-file-search#retrieval-customization)
+          #   for more information.
           def initialize: (
             ?max_num_results: Integer,
             ?ranking_options: OpenAI::Beta::FileSearchTool::FileSearch::RankingOptions
@@ -60,14 +111,26 @@ module OpenAI
             }
           class RankingOptions < OpenAI::Internal::Type::BaseModel
+            # The score threshold for the file search. All values must be a floating point
+            # number between 0 and 1.
             attr_accessor score_threshold: Float
+            # The ranker to use for the file search. If not specified will use the `auto`
+            # ranker.
             attr_reader ranker: OpenAI::Models::Beta::FileSearchTool::FileSearch::RankingOptions::ranker?
+            # The ranker to use for the file search. If not specified will use the `auto`
+            # ranker.
             def ranker=: (
               OpenAI::Models::Beta::FileSearchTool::FileSearch::RankingOptions::ranker
             ) -> OpenAI::Models::Beta::FileSearchTool::FileSearch::RankingOptions::ranker
+            # @param score_threshold
+            #   The score threshold for the file search. All values must be a floating point
+            #   number between 0 and 1.
+            # @param ranker
+            #   The ranker to use for the file search. If not specified will use the `auto`
+            #   ranker.
             def initialize: (
               score_threshold: Float,
               ?ranker: OpenAI::Models::Beta::FileSearchTool::FileSearch::RankingOptions::ranker

data/sig/openai/models/beta/function_tool.rbs CHANGED Viewed

@@ -7,8 +7,11 @@ module OpenAI
       class FunctionTool < OpenAI::Internal::Type::BaseModel
         attr_accessor function: OpenAI::FunctionDefinition
+        # The type of tool being defined: `function`
         attr_accessor type: :function
+        # @param type
+        #   The type of tool being defined: `function`
         def initialize: (
           function: OpenAI::FunctionDefinition,
           ?type: :function

data/sig/openai/models/beta/hosted_environment_file.rbs CHANGED Viewed

@@ -12,14 +12,26 @@ module OpenAI
           { id: String, path: String, size_bytes: Integer, ?type: :inline }
         class Inline < OpenAI::Internal::Type::BaseModel
+          # The session-scoped ID of the file in the execution environment.
           attr_accessor id: String
+          # The file's absolute path inside the environment.
           attr_accessor path: String
+          # The decoded file size in bytes.
           attr_accessor size_bytes: Integer
+          # The type of the object. Always `inline`.
           attr_accessor type: :inline
+          # @param id
+          #   The session-scoped ID of the file in the execution environment.
+          # @param path
+          #   The file's absolute path inside the environment.
+          # @param size_bytes
+          #   The decoded file size in bytes.
+          # @param type
+          #   The type of the object. Always `inline`.
           def initialize: (
             id: String,
             path: String,