openai 0.92.0 → 0.93.0

data/sig/openai/models/skills/skill_version.rbs

@@ -15,20 +15,41 @@ module OpenAI
         }
 
       class SkillVersion < OpenAI::Internal::Type::BaseModel
+        # Unique identifier for the skill version.
         attr_accessor id: String
 
+        # Unix timestamp (seconds) for when the version was created.
         attr_accessor created_at: Integer
 
+        # Description of the skill version.
         attr_accessor description: String
 
+        # Name of the skill version.
         attr_accessor name: String
 
+        # The object type, which is `skill.version`.
         attr_accessor object: :"skill.version"
 
+        # Identifier of the skill for this version.
         attr_accessor skill_id: String
 
+        # Version number for this skill.
         attr_accessor version: String
 
+        # @param id
+        #   Unique identifier for the skill version.
+        # @param created_at
+        #   Unix timestamp (seconds) for when the version was created.
+        # @param description
+        #   Description of the skill version.
+        # @param name
+        #   Name of the skill version.
+        # @param skill_id
+        #   Identifier of the skill for this version.
+        # @param version
+        #   Version number for this skill.
+        # @param object
+        #   The object type, which is `skill.version`.
         def initialize: (
           id: String,
           created_at: Integer,

data/sig/openai/models/skills/skill_version_list.rbs

@@ -13,16 +13,31 @@ module OpenAI
         }
 
       class SkillVersionList < OpenAI::Internal::Type::BaseModel
+        # A list of items
         attr_accessor data: ::Array[OpenAI::Skills::SkillVersion]
 
+        # The ID of the first item in the list.
         attr_accessor first_id: String?
 
+        # Whether there are more items available.
         attr_accessor has_more: bool
 
+        # The ID of the last item in the list.
         attr_accessor last_id: String?
 
+        # The type of object returned, must be `list`.
         attr_accessor object: :list
 
+        # @param data
+        #   A list of items
+        # @param first_id
+        #   The ID of the first item in the list.
+        # @param has_more
+        #   Whether there are more items available.
+        # @param last_id
+        #   The ID of the last item in the list.
+        # @param object
+        #   The type of object returned, must be `list`.
         def initialize: (
           data: ::Array[OpenAI::Skills::SkillVersion],
           first_id: String?,

data/sig/openai/models/skills/version_create_params.rbs

@@ -15,16 +15,36 @@ module OpenAI
 
         attr_accessor skill_id: String
 
+        # Whether to set this version as the default.
         attr_reader default: bool?
 
+        # Whether to set this version as the default.
         def default=: (bool) -> bool
 
+        # Skill files to upload (directory upload) or a single zip file.
+        #
+        # `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 files: OpenAI::Models::Skills::VersionCreateParams::files?
 
+        # Skill files to upload (directory upload) or a single zip file.
+        #
+        # `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 files=: (
           OpenAI::Models::Skills::VersionCreateParams::files
         ) -> OpenAI::Models::Skills::VersionCreateParams::files
 
+        # @param default
+        #   Whether to set this version as the default.
+        # @param files
+        #   Skill files to upload (directory upload) or a single zip file.
+        #
+        #   `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 initialize: (
           skill_id: String,
           ?default: bool,

data/sig/openai/models/skills/version_delete_params.rbs

@@ -14,8 +14,11 @@ module OpenAI
 
         attr_accessor skill_id: String
 
+        # The skill version number.
         attr_accessor version: String
 
+        # @param version
+        #   The skill version number.
         def initialize: (
           skill_id: String,
           version: String,

data/sig/openai/models/skills/version_list_params.rbs

@@ -16,20 +16,32 @@ module OpenAI
 
         attr_accessor skill_id: String
 
+        # The skill version ID to start after.
         attr_reader after: String?
 
+        # The skill version ID to start after.
         def after=: (String) -> String
 
+        # Number of versions to retrieve.
         attr_reader limit: Integer?
 
+        # Number of versions to retrieve.
         def limit=: (Integer) -> Integer
 
+        # Sort order of results by version number.
         attr_reader order: OpenAI::Models::Skills::VersionListParams::order?
 
+        # Sort order of results by version number.
         def order=: (
           OpenAI::Models::Skills::VersionListParams::order
         ) -> OpenAI::Models::Skills::VersionListParams::order
 
+        # @param after
+        #   The skill version ID to start after.
+        # @param limit
+        #   Number of versions to retrieve.
+        # @param order
+        #   Sort order of results by version number.
         def initialize: (
           skill_id: String,
           ?after: String,

data/sig/openai/models/skills/version_retrieve_params.rbs

@@ -14,8 +14,11 @@ module OpenAI
 
         attr_accessor skill_id: String
 
+        # The version number to retrieve.
         attr_accessor version: String
 
+        # @param version
+        #   The version number to retrieve.
         def initialize: (
           skill_id: String,
           version: String,

data/sig/openai/models/skills/versions/content_retrieve_params.rbs

@@ -15,8 +15,11 @@ module OpenAI
 
           attr_accessor skill_id: String
 
+          # The skill version number.
           attr_accessor version: String
 
+          # @param version
+          #   The skill version number.
           def initialize: (
             skill_id: String,
             version: String,

data/sig/openai/models/static_file_chunking_strategy.rbs

@@ -4,10 +4,22 @@ module OpenAI
       { chunk_overlap_tokens: Integer, max_chunk_size_tokens: Integer }
 
     class StaticFileChunkingStrategy < OpenAI::Internal::Type::BaseModel
+      # The number of tokens that overlap between chunks. The default value is `400`.
+      #
+      # Note that the overlap must not exceed half of `max_chunk_size_tokens`.
       attr_accessor chunk_overlap_tokens: Integer
 
+      # The maximum number of tokens in each chunk. The default value is `800`. The
+      # minimum value is `100` and the maximum value is `4096`.
       attr_accessor max_chunk_size_tokens: Integer
 
+      # @param chunk_overlap_tokens
+      #   The number of tokens that overlap between chunks. The default value is `400`.
+      #
+      #   Note that the overlap must not exceed half of `max_chunk_size_tokens`.
+      # @param max_chunk_size_tokens
+      #   The maximum number of tokens in each chunk. The default value is `800`. The
+      #   minimum value is `100` and the maximum value is `4096`.
       def initialize: (
         chunk_overlap_tokens: Integer,
         max_chunk_size_tokens: Integer

data/sig/openai/models/static_file_chunking_strategy_object.rbs

@@ -6,8 +6,11 @@ module OpenAI
     class StaticFileChunkingStrategyObject < OpenAI::Internal::Type::BaseModel
       attr_accessor static: OpenAI::StaticFileChunkingStrategy
 
+      # Always `static`.
       attr_accessor type: :static
 
+      # @param type
+      #   Always `static`.
       def initialize: (
         static: OpenAI::StaticFileChunkingStrategy,
         ?type: :static

data/sig/openai/models/static_file_chunking_strategy_object_param.rbs

@@ -6,8 +6,11 @@ module OpenAI
     class StaticFileChunkingStrategyObjectParam < OpenAI::Internal::Type::BaseModel
       attr_accessor static: OpenAI::StaticFileChunkingStrategy
 
+      # Always `static`.
       attr_accessor type: :static
 
+      # @param type
+      #   Always `static`.
       def initialize: (
         static: OpenAI::StaticFileChunkingStrategy,
         ?type: :static

data/sig/openai/models/upload.rbs

@@ -14,24 +14,55 @@ module OpenAI
       }
 
     class Upload < OpenAI::Internal::Type::BaseModel
+      # The Upload unique identifier, which can be referenced in API endpoints.
       attr_accessor id: String
 
+      # The intended number of bytes to be uploaded.
       attr_accessor bytes: Integer
 
+      # The Unix timestamp (in seconds) for when the Upload was created.
       attr_accessor created_at: Integer
 
+      # The Unix timestamp (in seconds) for when the Upload will expire.
       attr_accessor expires_at: Integer
 
+      # The name of the file to be uploaded.
       attr_accessor filename: String
 
+      # The object type, which is always "upload".
       attr_accessor object: :upload
 
+      # The intended purpose of the file.
+      # [Please refer here](https://developers.openai.com/api/reference/resources/files#%28resource%29%20files%20%3E%20%28model%29%20file_object%20%3E%20%28schema%29%20%3E%20%28property%29%20purpose)
+      # for acceptable values.
       attr_accessor purpose: String
 
+      # The status of the Upload.
       attr_accessor status: OpenAI::Models::Upload::status
 
+      # The `File` object represents a document that has been uploaded to OpenAI.
       attr_accessor file: OpenAI::FileObject?
 
+      # @param id
+      #   The Upload unique identifier, which can be referenced in API endpoints.
+      # @param bytes
+      #   The intended number of bytes to be uploaded.
+      # @param created_at
+      #   The Unix timestamp (in seconds) for when the Upload was created.
+      # @param expires_at
+      #   The Unix timestamp (in seconds) for when the Upload will expire.
+      # @param filename
+      #   The name of the file to be uploaded.
+      # @param purpose
+      #   The intended purpose of the file.
+      #   [Please refer here](https://developers.openai.com/api/reference/resources/files#%28resource%29%20files%20%3E%20%28model%29%20file_object%20%3E%20%28schema%29%20%3E%20%28property%29%20purpose)
+      #   for acceptable values.
+      # @param status
+      #   The status of the Upload.
+      # @param file
+      #   The `File` object represents a document that has been uploaded to OpenAI.
+      # @param object
+      #   The object type, which is always "upload".
       def initialize: (
         id: String,
         bytes: Integer,

data/sig/openai/models/upload_complete_params.rbs

@@ -14,12 +14,22 @@ module OpenAI
 
       attr_accessor upload_id: String
 
+      # The ordered list of Part IDs.
       attr_accessor part_ids: ::Array[String]
 
+      # The optional md5 checksum for the file contents to verify if the bytes uploaded
+      # matches what you expect.
       attr_reader md5: String?
 
+      # The optional md5 checksum for the file contents to verify if the bytes uploaded
+      # matches what you expect.
       def md5=: (String) -> String
 
+      # @param part_ids
+      #   The ordered list of Part IDs.
+      # @param md5
+      #   The optional md5 checksum for the file contents to verify if the bytes uploaded
+      #   matches what you expect.
       def initialize: (
         upload_id: String,
         part_ids: ::Array[String],

data/sig/openai/models/upload_create_params.rbs

@@ -14,20 +14,51 @@ module OpenAI
       extend OpenAI::Internal::Type::RequestParameters::Converter
       include OpenAI::Internal::Type::RequestParameters
 
+      # The number of bytes in the file you are uploading.
       attr_accessor bytes: Integer
 
+      # The name of the file to upload.
       attr_accessor filename: String
 
+      # The MIME type of the file.
+      #
+      # This must fall within the supported MIME types for your file purpose. See the
+      # supported MIME types for assistants and vision.
       attr_accessor mime_type: String
 
+      # The intended purpose of the uploaded file.
+      #
+      # See the
+      # [documentation on File purposes](https://developers.openai.com/api/reference/resources/files/methods/create#%28resource%29%20files%20%3E%20%28method%29%20create%20%3E%20%28params%29%200%20%3E%20%28param%29%20purpose%20%3E%20%28schema%29).
       attr_accessor purpose: OpenAI::Models::file_purpose
 
+      # The expiration policy for a file. By default, files with `purpose=batch` expire
+      # after 30 days and all other files are persisted until they are manually deleted.
       attr_reader expires_after: OpenAI::UploadCreateParams::ExpiresAfter?
 
+      # The expiration policy for a file. By default, files with `purpose=batch` expire
+      # after 30 days and all other files are persisted until they are manually deleted.
       def expires_after=: (
         OpenAI::UploadCreateParams::ExpiresAfter
       ) -> OpenAI::UploadCreateParams::ExpiresAfter
 
+      # @param bytes
+      #   The number of bytes in the file you are uploading.
+      # @param filename
+      #   The name of the file to upload.
+      # @param mime_type
+      #   The MIME type of the file.
+      #
+      #   This must fall within the supported MIME types for your file purpose. See the
+      #   supported MIME types for assistants and vision.
+      # @param purpose
+      #   The intended purpose of the uploaded file.
+      #
+      #   See the
+      #   [documentation on File purposes](https://developers.openai.com/api/reference/resources/files/methods/create#%28resource%29%20files%20%3E%20%28method%29%20create%20%3E%20%28params%29%200%20%3E%20%28param%29%20purpose%20%3E%20%28schema%29).
+      # @param expires_after
+      #   The expiration policy for a file. By default, files with `purpose=batch` expire
+      #   after 30 days and all other files are persisted until they are manually deleted.
       def initialize: (
         bytes: Integer,
         filename: String,
@@ -49,10 +80,20 @@ module OpenAI
       type expires_after = { ?anchor: :created_at, seconds: Integer }
 
       class ExpiresAfter < OpenAI::Internal::Type::BaseModel
+        # Anchor timestamp after which the expiration policy applies. Supported anchors:
+        # `created_at`.
         attr_accessor anchor: :created_at
 
+        # The number of seconds after the anchor time that the file will expire. Must be
+        # between 3600 (1 hour) and 2592000 (30 days).
         attr_accessor seconds: Integer
 
+        # @param seconds
+        #   The number of seconds after the anchor time that the file will expire. Must be
+        #   between 3600 (1 hour) and 2592000 (30 days).
+        # @param anchor
+        #   Anchor timestamp after which the expiration policy applies. Supported anchors:
+        #   `created_at`.
         def initialize: (seconds: Integer, ?anchor: :created_at) -> void
 
         def to_hash: -> { ?anchor: :created_at, seconds: Integer }

data/sig/openai/models/uploads/part_create_params.rbs

@@ -14,8 +14,19 @@ module OpenAI
 
         attr_accessor upload_id: String
 
+        # The chunk of bytes for this Part.
+        #
+        # `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_accessor data: OpenAI::Internal::file_input
 
+        # @param data
+        #   The chunk of bytes for this Part.
+        #
+        #   `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 initialize: (
           upload_id: String,
           data: OpenAI::Internal::file_input,

data/sig/openai/models/uploads/upload_part.rbs

@@ -12,14 +12,26 @@ module OpenAI
         }
 
       class UploadPart < OpenAI::Internal::Type::BaseModel
+        # The upload Part unique identifier, which can be referenced in API endpoints.
         attr_accessor id: String
 
+        # The Unix timestamp (in seconds) for when the Part was created.
         attr_accessor created_at: Integer
 
+        # The object type, which is always `upload.part`.
         attr_accessor object: :"upload.part"
 
+        # The ID of the Upload object that this Part was added to.
         attr_accessor upload_id: String
 
+        # @param id
+        #   The upload Part unique identifier, which can be referenced in API endpoints.
+        # @param created_at
+        #   The Unix timestamp (in seconds) for when the Part was created.
+        # @param upload_id
+        #   The ID of the Upload object that this Part was added to.
+        # @param object
+        #   The object type, which is always `upload.part`.
         def initialize: (
           id: String,
           created_at: Integer,

data/sig/openai/models/vector_store.rbs

@@ -16,32 +16,77 @@ module OpenAI
       }
 
     class VectorStore < OpenAI::Internal::Type::BaseModel
+      # The identifier, which can be referenced in API endpoints.
       attr_accessor id: String
 
+      # The Unix timestamp (in seconds) for when the vector store was created.
       attr_accessor created_at: Integer
 
       attr_accessor file_counts: OpenAI::VectorStore::FileCounts
 
+      # The Unix timestamp (in seconds) for when the vector store was last active.
       attr_accessor last_active_at: Integer?
 
+      # 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 name of the vector store.
       attr_accessor name: String
 
+      # The object type, which is always `vector_store`.
       attr_accessor object: :vector_store
 
+      # The status of the vector store, which can be either `expired`, `in_progress`, or
+      # `completed`. A status of `completed` indicates that the vector store is ready
+      # for use.
       attr_accessor status: OpenAI::Models::VectorStore::status
 
+      # The total number of bytes used by the files in the vector store.
       attr_accessor usage_bytes: Integer
 
+      # The expiration policy for a vector store.
       attr_reader expires_after: OpenAI::VectorStore::ExpiresAfter?
 
+      # The expiration policy for a vector store.
       def expires_after=: (
         OpenAI::VectorStore::ExpiresAfter
       ) -> OpenAI::VectorStore::ExpiresAfter
 
+      # The Unix timestamp (in seconds) for when the vector store will expire.
       attr_accessor expires_at: Integer?
 
+      # @param id
+      #   The identifier, which can be referenced in API endpoints.
+      # @param created_at
+      #   The Unix timestamp (in seconds) for when the vector store was created.
+      # @param last_active_at
+      #   The Unix timestamp (in seconds) for when the vector store was last active.
+      # @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 name
+      #   The name of the vector store.
+      # @param status
+      #   The status of the vector store, which can be either `expired`, `in_progress`, or
+      #   `completed`. A status of `completed` indicates that the vector store is ready
+      #   for use.
+      # @param usage_bytes
+      #   The total number of bytes used by the files in the vector store.
+      # @param expires_after
+      #   The expiration policy for a vector store.
+      # @param expires_at
+      #   The Unix timestamp (in seconds) for when the vector store will expire.
+      # @param object
+      #   The object type, which is always `vector_store`.
       def initialize: (
         id: String,
         created_at: Integer,
@@ -80,16 +125,31 @@ module OpenAI
         }
 
       class FileCounts < OpenAI::Internal::Type::BaseModel
+        # The number of files that were cancelled.
         attr_accessor cancelled: Integer
 
+        # The number of files that have been successfully processed.
         attr_accessor completed: Integer
 
+        # The number of files that have failed to process.
         attr_accessor failed: Integer
 
+        # The number of files that are currently being processed.
         attr_accessor in_progress: Integer
 
+        # The total number of files.
         attr_accessor total: Integer
 
+        # @param cancelled
+        #   The number of files that were cancelled.
+        # @param completed
+        #   The number of files that have been successfully processed.
+        # @param failed
+        #   The number of files that have failed to process.
+        # @param in_progress
+        #   The number of files that are currently being processed.
+        # @param total
+        #   The total number of files.
         def initialize: (
           cancelled: Integer,
           completed: Integer,
@@ -122,10 +182,18 @@ module OpenAI
       type expires_after = { ?anchor: :last_active_at, days: Integer }
 
       class ExpiresAfter < OpenAI::Internal::Type::BaseModel
+        # Anchor timestamp after which the expiration policy applies. Supported anchors:
+        # `last_active_at`.
         attr_accessor anchor: :last_active_at
 
+        # The number of days after the anchor time that the vector store will expire.
         attr_accessor days: Integer
 
+        # @param days
+        #   The number of days after the anchor time that the vector store will expire.
+        # @param anchor
+        #   Anchor timestamp after which the expiration policy applies. Supported anchors:
+        #   `last_active_at`.
         def initialize: (days: Integer, ?anchor: :last_active_at) -> void
 
         def to_hash: -> { ?anchor: :last_active_at, days: Integer }

data/sig/openai/models/vector_store_create_params.rbs

@@ -15,32 +15,77 @@ module OpenAI
       extend OpenAI::Internal::Type::RequestParameters::Converter
       include OpenAI::Internal::Type::RequestParameters
 
+      # The chunking strategy used to chunk the file(s). If not set, will use the `auto`
+      # strategy. Only applicable if `file_ids` is non-empty.
       attr_reader chunking_strategy: OpenAI::Models::file_chunking_strategy_param?
 
+      # The chunking strategy used to chunk the file(s). If not set, will use the `auto`
+      # strategy. Only applicable if `file_ids` is non-empty.
       def chunking_strategy=: (
         OpenAI::Models::file_chunking_strategy_param
       ) -> OpenAI::Models::file_chunking_strategy_param
 
+      # A description for the vector store. Can be used to describe the vector store's
+      # purpose.
       attr_reader description: String?
 
+      # A description for the vector store. Can be used to describe the vector store's
+      # purpose.
       def description=: (String) -> String
 
+      # The expiration policy for a vector store.
       attr_reader expires_after: OpenAI::VectorStoreCreateParams::ExpiresAfter?
 
+      # The expiration policy for a vector store.
       def expires_after=: (
         OpenAI::VectorStoreCreateParams::ExpiresAfter
       ) -> OpenAI::VectorStoreCreateParams::ExpiresAfter
 
+      # A list of [File](https://developers.openai.com/api/reference/resources/files)
+      # IDs that the vector store should use. Useful for tools like `file_search` that
+      # can access files.
       attr_reader file_ids: ::Array[String]?
 
+      # A list of [File](https://developers.openai.com/api/reference/resources/files)
+      # IDs that the vector store should use. Useful for tools like `file_search` that
+      # can access files.
       def file_ids=: (::Array[String]) -> ::Array[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?
 
+      # The name of the vector store.
       attr_reader name: String?
 
+      # The name of the vector store.
       def name=: (String) -> String
 
+      # @param chunking_strategy
+      #   The chunking strategy used to chunk the file(s). If not set, will use the `auto`
+      #   strategy. Only applicable if `file_ids` is non-empty.
+      # @param description
+      #   A description for the vector store. Can be used to describe the vector store's
+      #   purpose.
+      # @param expires_after
+      #   The expiration policy for a vector store.
+      # @param file_ids
+      #   A list of [File](https://developers.openai.com/api/reference/resources/files)
+      #   IDs that the vector store should use. Useful for tools like `file_search` that
+      #   can access files.
+      # @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 name
+      #   The name of the vector store.
       def initialize: (
         ?chunking_strategy: OpenAI::Models::file_chunking_strategy_param,
         ?description: String,
@@ -64,10 +109,18 @@ module OpenAI
       type expires_after = { ?anchor: :last_active_at, days: Integer }
 
       class ExpiresAfter < OpenAI::Internal::Type::BaseModel
+        # Anchor timestamp after which the expiration policy applies. Supported anchors:
+        # `last_active_at`.
         attr_accessor anchor: :last_active_at
 
+        # The number of days after the anchor time that the vector store will expire.
         attr_accessor days: Integer
 
+        # @param days
+        #   The number of days after the anchor time that the vector store will expire.
+        # @param anchor
+        #   Anchor timestamp after which the expiration policy applies. Supported anchors:
+        #   `last_active_at`.
         def initialize: (days: Integer, ?anchor: :last_active_at) -> void
 
         def to_hash: -> { ?anchor: :last_active_at, days: Integer }