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

openai 0.92.0 → 0.93.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/container_create_params.rbs CHANGED Viewed

@@ -15,36 +15,59 @@ module OpenAI
       extend OpenAI::Internal::Type::RequestParameters::Converter
       include OpenAI::Internal::Type::RequestParameters
+      # Name of the container to create.
       attr_accessor name: String
+      # Container expiration time in seconds relative to the 'anchor' time.
       attr_reader expires_after: OpenAI::ContainerCreateParams::ExpiresAfter?
+      # Container expiration time in seconds relative to the 'anchor' time.
       def expires_after=: (
         OpenAI::ContainerCreateParams::ExpiresAfter
       ) -> OpenAI::ContainerCreateParams::ExpiresAfter
+      # IDs of files to copy to the container.
       attr_reader file_ids: ::Array[String]?
+      # IDs of files to copy to the container.
       def file_ids=: (::Array[String]) -> ::Array[String]
+      # Optional memory limit for the container. Defaults to "1g".
       attr_reader memory_limit: OpenAI::Models::ContainerCreateParams::memory_limit?
+      # Optional memory limit for the container. Defaults to "1g".
       def memory_limit=: (
         OpenAI::Models::ContainerCreateParams::memory_limit
       ) -> OpenAI::Models::ContainerCreateParams::memory_limit
+      # Network access policy for the container.
       attr_reader network_policy: OpenAI::Models::ContainerCreateParams::network_policy?
+      # Network access policy for the container.
       def network_policy=: (
         OpenAI::Models::ContainerCreateParams::network_policy
       ) -> OpenAI::Models::ContainerCreateParams::network_policy
+      # An optional list of skills referenced by id or inline data.
       attr_reader skills: ::Array[OpenAI::Models::ContainerCreateParams::skill]?
+      # An optional list of skills referenced by id or inline data.
       def skills=: (
         ::Array[OpenAI::Models::ContainerCreateParams::skill]
       ) -> ::Array[OpenAI::Models::ContainerCreateParams::skill]
+      # @param name
+      #   Name of the container to create.
+      # @param expires_after
+      #   Container expiration time in seconds relative to the 'anchor' time.
+      # @param file_ids
+      #   IDs of files to copy to the container.
+      # @param memory_limit
+      #   Optional memory limit for the container. Defaults to "1g".
+      # @param network_policy
+      #   Network access policy for the container.
+      # @param skills
+      #   An optional list of skills referenced by id or inline data.
       def initialize: (
         name: String,
         ?expires_after: OpenAI::ContainerCreateParams::ExpiresAfter,
@@ -72,10 +95,15 @@ module OpenAI
         }
       class ExpiresAfter < OpenAI::Internal::Type::BaseModel
+        # Time anchor for the expiration time. Currently only 'last_active_at' is
+        # supported.
         attr_accessor anchor: OpenAI::Models::ContainerCreateParams::ExpiresAfter::anchor
         attr_accessor minutes: Integer
+        # @param anchor
+        #   Time anchor for the expiration time. Currently only 'last_active_at' is
+        #   supported.
         def initialize: (
           anchor: OpenAI::Models::ContainerCreateParams::ExpiresAfter::anchor,
           minutes: Integer

data/sig/openai/models/container_create_response.rbs CHANGED Viewed

@@ -14,38 +14,75 @@ module OpenAI
       }
     class ContainerCreateResponse < OpenAI::Internal::Type::BaseModel
+      # Unique identifier for the container.
       attr_accessor id: String
+      # Unix timestamp (in seconds) when the container was created.
       attr_accessor created_at: Integer
+      # Name of the container.
       attr_accessor name: String
+      # The type of this object.
       attr_accessor object: String
+      # Status of the container (e.g., active, deleted).
       attr_accessor status: String
+      # The container will expire after this time period. The anchor is the reference
+      # point for the expiration. The minutes is the number of minutes after the anchor
+      # before the container expires.
       attr_reader expires_after: OpenAI::Models::ContainerCreateResponse::ExpiresAfter?
+      # The container will expire after this time period. The anchor is the reference
+      # point for the expiration. The minutes is the number of minutes after the anchor
+      # before the container expires.
       def expires_after=: (
         OpenAI::Models::ContainerCreateResponse::ExpiresAfter
       ) -> OpenAI::Models::ContainerCreateResponse::ExpiresAfter
+      # Unix timestamp (in seconds) when the container was last active.
       attr_reader last_active_at: Integer?
+      # Unix timestamp (in seconds) when the container was last active.
       def last_active_at=: (Integer) -> Integer
+      # The memory limit configured for the container.
       attr_reader memory_limit: OpenAI::Models::ContainerCreateResponse::memory_limit?
+      # The memory limit configured for the container.
       def memory_limit=: (
         OpenAI::Models::ContainerCreateResponse::memory_limit
       ) -> OpenAI::Models::ContainerCreateResponse::memory_limit
+      # Network access policy for the container.
       attr_reader network_policy: OpenAI::Models::ContainerCreateResponse::NetworkPolicy?
+      # Network access policy for the container.
       def network_policy=: (
         OpenAI::Models::ContainerCreateResponse::NetworkPolicy
       ) -> OpenAI::Models::ContainerCreateResponse::NetworkPolicy
+      # @param id
+      #   Unique identifier for the container.
+      # @param created_at
+      #   Unix timestamp (in seconds) when the container was created.
+      # @param name
+      #   Name of the container.
+      # @param object
+      #   The type of this object.
+      # @param status
+      #   Status of the container (e.g., active, deleted).
+      # @param expires_after
+      #   The container will expire after this time period. The anchor is the reference
+      #   point for the expiration. The minutes is the number of minutes after the anchor
+      #   before the container expires.
+      # @param last_active_at
+      #   Unix timestamp (in seconds) when the container was last active.
+      # @param memory_limit
+      #   The memory limit configured for the container.
+      # @param network_policy
+      #   Network access policy for the container.
       def initialize: (
         id: String,
         created_at: Integer,
@@ -77,16 +114,24 @@ module OpenAI
         }
       class ExpiresAfter < OpenAI::Internal::Type::BaseModel
+        # The reference point for the expiration.
         attr_reader anchor: OpenAI::Models::ContainerCreateResponse::ExpiresAfter::anchor?
+        # The reference point for the expiration.
         def anchor=: (
           OpenAI::Models::ContainerCreateResponse::ExpiresAfter::anchor
         ) -> OpenAI::Models::ContainerCreateResponse::ExpiresAfter::anchor
+        # The number of minutes after the anchor before the container expires.
         attr_reader minutes: Integer?
+        # The number of minutes after the anchor before the container expires.
         def minutes=: (Integer) -> Integer
+        # @param anchor
+        #   The reference point for the expiration.
+        # @param minutes
+        #   The number of minutes after the anchor before the container expires.
         def initialize: (
           ?anchor: OpenAI::Models::ContainerCreateResponse::ExpiresAfter::anchor,
           ?minutes: Integer
@@ -128,12 +173,19 @@ module OpenAI
         }
       class NetworkPolicy < OpenAI::Internal::Type::BaseModel
+        # The network policy mode.
         attr_accessor type: OpenAI::Models::ContainerCreateResponse::NetworkPolicy::type_
+        # Allowed outbound domains when `type` is `allowlist`.
         attr_reader allowed_domains: ::Array[String]?
+        # Allowed outbound domains when `type` is `allowlist`.
         def allowed_domains=: (::Array[String]) -> ::Array[String]
+        # @param type
+        #   The network policy mode.
+        # @param allowed_domains
+        #   Allowed outbound domains when `type` is `allowlist`.
         def initialize: (
           type: OpenAI::Models::ContainerCreateResponse::NetworkPolicy::type_,
           ?allowed_domains: ::Array[String]

data/sig/openai/models/container_list_params.rbs CHANGED Viewed

@@ -13,24 +13,55 @@ module OpenAI
       extend OpenAI::Internal::Type::RequestParameters::Converter
       include OpenAI::Internal::Type::RequestParameters
+      # 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 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
+      # Filter results by container name.
       attr_reader name: String?
+      # Filter results by container name.
       def name=: (String) -> String
+      # Sort order by the `created_at` timestamp of the objects. `asc` for ascending
+      # order and `desc` for descending order.
       attr_reader order: OpenAI::Models::ContainerListParams::order?
+      # Sort order by the `created_at` timestamp of the objects. `asc` for ascending
+      # order and `desc` for descending order.
       def order=: (
         OpenAI::Models::ContainerListParams::order
       ) -> OpenAI::Models::ContainerListParams::order
+      # @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 limit
+      #   A limit on the number of objects to be returned. Limit can range between 1 and
+      #   100, and the default is 20.
+      # @param name
+      #   Filter results by container name.
+      # @param order
+      #   Sort order by the `created_at` timestamp of the objects. `asc` for ascending
+      #   order and `desc` for descending order.
       def initialize: (
         ?after: String,
         ?limit: Integer,

data/sig/openai/models/container_list_response.rbs CHANGED Viewed

@@ -14,38 +14,75 @@ module OpenAI
       }
     class ContainerListResponse < OpenAI::Internal::Type::BaseModel
+      # Unique identifier for the container.
       attr_accessor id: String
+      # Unix timestamp (in seconds) when the container was created.
       attr_accessor created_at: Integer
+      # Name of the container.
       attr_accessor name: String
+      # The type of this object.
       attr_accessor object: String
+      # Status of the container (e.g., active, deleted).
       attr_accessor status: String
+      # The container will expire after this time period. The anchor is the reference
+      # point for the expiration. The minutes is the number of minutes after the anchor
+      # before the container expires.
       attr_reader expires_after: OpenAI::Models::ContainerListResponse::ExpiresAfter?
+      # The container will expire after this time period. The anchor is the reference
+      # point for the expiration. The minutes is the number of minutes after the anchor
+      # before the container expires.
       def expires_after=: (
         OpenAI::Models::ContainerListResponse::ExpiresAfter
       ) -> OpenAI::Models::ContainerListResponse::ExpiresAfter
+      # Unix timestamp (in seconds) when the container was last active.
       attr_reader last_active_at: Integer?
+      # Unix timestamp (in seconds) when the container was last active.
       def last_active_at=: (Integer) -> Integer
+      # The memory limit configured for the container.
       attr_reader memory_limit: OpenAI::Models::ContainerListResponse::memory_limit?
+      # The memory limit configured for the container.
       def memory_limit=: (
         OpenAI::Models::ContainerListResponse::memory_limit
       ) -> OpenAI::Models::ContainerListResponse::memory_limit
+      # Network access policy for the container.
       attr_reader network_policy: OpenAI::Models::ContainerListResponse::NetworkPolicy?
+      # Network access policy for the container.
       def network_policy=: (
         OpenAI::Models::ContainerListResponse::NetworkPolicy
       ) -> OpenAI::Models::ContainerListResponse::NetworkPolicy
+      # @param id
+      #   Unique identifier for the container.
+      # @param created_at
+      #   Unix timestamp (in seconds) when the container was created.
+      # @param name
+      #   Name of the container.
+      # @param object
+      #   The type of this object.
+      # @param status
+      #   Status of the container (e.g., active, deleted).
+      # @param expires_after
+      #   The container will expire after this time period. The anchor is the reference
+      #   point for the expiration. The minutes is the number of minutes after the anchor
+      #   before the container expires.
+      # @param last_active_at
+      #   Unix timestamp (in seconds) when the container was last active.
+      # @param memory_limit
+      #   The memory limit configured for the container.
+      # @param network_policy
+      #   Network access policy for the container.
       def initialize: (
         id: String,
         created_at: Integer,
@@ -77,16 +114,24 @@ module OpenAI
         }
       class ExpiresAfter < OpenAI::Internal::Type::BaseModel
+        # The reference point for the expiration.
         attr_reader anchor: OpenAI::Models::ContainerListResponse::ExpiresAfter::anchor?
+        # The reference point for the expiration.
         def anchor=: (
           OpenAI::Models::ContainerListResponse::ExpiresAfter::anchor
         ) -> OpenAI::Models::ContainerListResponse::ExpiresAfter::anchor
+        # The number of minutes after the anchor before the container expires.
         attr_reader minutes: Integer?
+        # The number of minutes after the anchor before the container expires.
         def minutes=: (Integer) -> Integer
+        # @param anchor
+        #   The reference point for the expiration.
+        # @param minutes
+        #   The number of minutes after the anchor before the container expires.
         def initialize: (
           ?anchor: OpenAI::Models::ContainerListResponse::ExpiresAfter::anchor,
           ?minutes: Integer
@@ -128,12 +173,19 @@ module OpenAI
         }
       class NetworkPolicy < OpenAI::Internal::Type::BaseModel
+        # The network policy mode.
         attr_accessor type: OpenAI::Models::ContainerListResponse::NetworkPolicy::type_
+        # Allowed outbound domains when `type` is `allowlist`.
         attr_reader allowed_domains: ::Array[String]?
+        # Allowed outbound domains when `type` is `allowlist`.
         def allowed_domains=: (::Array[String]) -> ::Array[String]
+        # @param type
+        #   The network policy mode.
+        # @param allowed_domains
+        #   Allowed outbound domains when `type` is `allowlist`.
         def initialize: (
           type: OpenAI::Models::ContainerListResponse::NetworkPolicy::type_,
           ?allowed_domains: ::Array[String]

data/sig/openai/models/container_retrieve_response.rbs CHANGED Viewed

@@ -14,38 +14,75 @@ module OpenAI
       }
     class ContainerRetrieveResponse < OpenAI::Internal::Type::BaseModel
+      # Unique identifier for the container.
       attr_accessor id: String
+      # Unix timestamp (in seconds) when the container was created.
       attr_accessor created_at: Integer
+      # Name of the container.
       attr_accessor name: String
+      # The type of this object.
       attr_accessor object: String
+      # Status of the container (e.g., active, deleted).
       attr_accessor status: String
+      # The container will expire after this time period. The anchor is the reference
+      # point for the expiration. The minutes is the number of minutes after the anchor
+      # before the container expires.
       attr_reader expires_after: OpenAI::Models::ContainerRetrieveResponse::ExpiresAfter?
+      # The container will expire after this time period. The anchor is the reference
+      # point for the expiration. The minutes is the number of minutes after the anchor
+      # before the container expires.
       def expires_after=: (
         OpenAI::Models::ContainerRetrieveResponse::ExpiresAfter
       ) -> OpenAI::Models::ContainerRetrieveResponse::ExpiresAfter
+      # Unix timestamp (in seconds) when the container was last active.
       attr_reader last_active_at: Integer?
+      # Unix timestamp (in seconds) when the container was last active.
       def last_active_at=: (Integer) -> Integer
+      # The memory limit configured for the container.
       attr_reader memory_limit: OpenAI::Models::ContainerRetrieveResponse::memory_limit?
+      # The memory limit configured for the container.
       def memory_limit=: (
         OpenAI::Models::ContainerRetrieveResponse::memory_limit
       ) -> OpenAI::Models::ContainerRetrieveResponse::memory_limit
+      # Network access policy for the container.
       attr_reader network_policy: OpenAI::Models::ContainerRetrieveResponse::NetworkPolicy?
+      # Network access policy for the container.
       def network_policy=: (
         OpenAI::Models::ContainerRetrieveResponse::NetworkPolicy
       ) -> OpenAI::Models::ContainerRetrieveResponse::NetworkPolicy
+      # @param id
+      #   Unique identifier for the container.
+      # @param created_at
+      #   Unix timestamp (in seconds) when the container was created.
+      # @param name
+      #   Name of the container.
+      # @param object
+      #   The type of this object.
+      # @param status
+      #   Status of the container (e.g., active, deleted).
+      # @param expires_after
+      #   The container will expire after this time period. The anchor is the reference
+      #   point for the expiration. The minutes is the number of minutes after the anchor
+      #   before the container expires.
+      # @param last_active_at
+      #   Unix timestamp (in seconds) when the container was last active.
+      # @param memory_limit
+      #   The memory limit configured for the container.
+      # @param network_policy
+      #   Network access policy for the container.
       def initialize: (
         id: String,
         created_at: Integer,
@@ -77,16 +114,24 @@ module OpenAI
         }
       class ExpiresAfter < OpenAI::Internal::Type::BaseModel
+        # The reference point for the expiration.
         attr_reader anchor: OpenAI::Models::ContainerRetrieveResponse::ExpiresAfter::anchor?
+        # The reference point for the expiration.
         def anchor=: (
           OpenAI::Models::ContainerRetrieveResponse::ExpiresAfter::anchor
         ) -> OpenAI::Models::ContainerRetrieveResponse::ExpiresAfter::anchor
+        # The number of minutes after the anchor before the container expires.
         attr_reader minutes: Integer?
+        # The number of minutes after the anchor before the container expires.
         def minutes=: (Integer) -> Integer
+        # @param anchor
+        #   The reference point for the expiration.
+        # @param minutes
+        #   The number of minutes after the anchor before the container expires.
         def initialize: (
           ?anchor: OpenAI::Models::ContainerRetrieveResponse::ExpiresAfter::anchor,
           ?minutes: Integer
@@ -128,12 +173,19 @@ module OpenAI
         }
       class NetworkPolicy < OpenAI::Internal::Type::BaseModel
+        # The network policy mode.
         attr_accessor type: OpenAI::Models::ContainerRetrieveResponse::NetworkPolicy::type_
+        # Allowed outbound domains when `type` is `allowlist`.
         attr_reader allowed_domains: ::Array[String]?
+        # Allowed outbound domains when `type` is `allowlist`.
         def allowed_domains=: (::Array[String]) -> ::Array[String]
+        # @param type
+        #   The network policy mode.
+        # @param allowed_domains
+        #   Allowed outbound domains when `type` is `allowlist`.
         def initialize: (
           type: OpenAI::Models::ContainerRetrieveResponse::NetworkPolicy::type_,
           ?allowed_domains: ::Array[String]

data/sig/openai/models/containers/file_create_params.rbs CHANGED Viewed

@@ -15,16 +15,36 @@ module OpenAI
         attr_accessor container_id: String
+        # The File object (not file name) to be uploaded.
+        #
+        # `String`, `StringIO`, and pathless `IO` inputs are sent with generic upload
+        # metadata. Use `OpenAI::FilePart` when you need to override the filename or
+        # content type.
         attr_reader file: OpenAI::Internal::file_input?
+        # The File object (not file name) to be uploaded.
+        #
+        # `String`, `StringIO`, and pathless `IO` inputs are sent with generic upload
+        # metadata. Use `OpenAI::FilePart` when you need to override the filename or
+        # content type.
         def file=: (
           OpenAI::Internal::file_input
         ) -> OpenAI::Internal::file_input
+        # Name of the file to create.
         attr_reader file_id: String?
+        # Name of the file to create.
         def file_id=: (String) -> String
+        # @param file
+        #   The File object (not file name) to be uploaded.
+        #
+        #   `String`, `StringIO`, and pathless `IO` inputs are sent with generic upload
+        #   metadata. Use `OpenAI::FilePart` when you need to override the filename or
+        #   content type.
+        # @param file_id
+        #   Name of the file to create.
         def initialize: (
           container_id: String,
           ?file: OpenAI::Internal::file_input,

data/sig/openai/models/containers/file_create_response.rbs CHANGED Viewed

@@ -13,20 +13,41 @@ module OpenAI
         }
       class FileCreateResponse < OpenAI::Internal::Type::BaseModel
+        # Unique identifier for the file.
         attr_accessor id: String
+        # Size of the file in bytes.
         attr_accessor bytes: Integer
+        # The container this file belongs to.
         attr_accessor container_id: String
+        # Unix timestamp (in seconds) when the file was created.
         attr_accessor created_at: Integer
+        # The type of this object (`container.file`).
         attr_accessor object: :"container.file"
+        # Path of the file in the container.
         attr_accessor path: String
+        # Source of the file (e.g., `user`, `assistant`).
         attr_accessor source: String
+        # @param id
+        #   Unique identifier for the file.
+        # @param bytes
+        #   Size of the file in bytes.
+        # @param container_id
+        #   The container this file belongs to.
+        # @param created_at
+        #   Unix timestamp (in seconds) when the file was created.
+        # @param path
+        #   Path of the file in the container.
+        # @param source
+        #   Source of the file (e.g., `user`, `assistant`).
+        # @param object
+        #   The type of this object (`container.file`).
         def initialize: (
           id: String,
           bytes: Integer,

data/sig/openai/models/containers/file_list_params.rbs CHANGED Viewed

@@ -16,20 +16,47 @@ module OpenAI
         attr_accessor container_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 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::Containers::FileListParams::order?
+        # Sort order by the `created_at` timestamp of the objects. `asc` for ascending
+        # order and `desc` for descending order.
         def order=: (
           OpenAI::Models::Containers::FileListParams::order
         ) -> OpenAI::Models::Containers::FileListParams::order
+        # @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 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.
         def initialize: (
           container_id: String,
           ?after: String,

data/sig/openai/models/containers/file_list_response.rbs CHANGED Viewed

@@ -13,20 +13,41 @@ module OpenAI
         }
       class FileListResponse < OpenAI::Internal::Type::BaseModel
+        # Unique identifier for the file.
         attr_accessor id: String
+        # Size of the file in bytes.
         attr_accessor bytes: Integer
+        # The container this file belongs to.
         attr_accessor container_id: String
+        # Unix timestamp (in seconds) when the file was created.
         attr_accessor created_at: Integer
+        # The type of this object (`container.file`).
         attr_accessor object: :"container.file"
+        # Path of the file in the container.
         attr_accessor path: String
+        # Source of the file (e.g., `user`, `assistant`).
         attr_accessor source: String
+        # @param id
+        #   Unique identifier for the file.
+        # @param bytes
+        #   Size of the file in bytes.
+        # @param container_id
+        #   The container this file belongs to.
+        # @param created_at
+        #   Unix timestamp (in seconds) when the file was created.
+        # @param path
+        #   Path of the file in the container.
+        # @param source
+        #   Source of the file (e.g., `user`, `assistant`).
+        # @param object
+        #   The type of this object (`container.file`).
         def initialize: (
           id: String,
           bytes: Integer,